mirror of
https://github.com/bestnite/sub2clash.git
synced 2025-11-03 20:30:35 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
be656cca57
|
|||
|
23a85f573b
|
|||
|
fce75baed4
|
|||
| f5686561f9 |
4
.github/workflows/docker.yml
vendored
4
.github/workflows/docker.yml
vendored
@@ -45,7 +45,7 @@ jobs:
|
|||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
- name: Build and push
|
- name: Build and push
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v6
|
||||||
with:
|
with:
|
||||||
build-args: |
|
build-args: |
|
||||||
"version=${{ github.ref_name }}"
|
"version=${{ github.ref_name }}"
|
||||||
@@ -53,3 +53,5 @@ jobs:
|
|||||||
tags: ${{ steps.meta.outputs.tags }}
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
||||||
|
file: Containerfile
|
||||||
|
|
||||||
|
|||||||
11
.github/workflows/release.yml
vendored
11
.github/workflows/release.yml
vendored
@@ -13,13 +13,18 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v5
|
||||||
|
|
||||||
|
- name: Install UPX
|
||||||
|
uses: crazy-max/ghaction-upx@v3
|
||||||
|
with:
|
||||||
|
install-only: true
|
||||||
|
|
||||||
- name: Run GoReleaser
|
- name: Run GoReleaser
|
||||||
uses: goreleaser/goreleaser-action@v5
|
uses: goreleaser/goreleaser-action@v6
|
||||||
with:
|
with:
|
||||||
distribution: goreleaser
|
distribution: goreleaser
|
||||||
version: latest
|
version: latest
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
version: 2
|
||||||
project_name: sub2clash
|
project_name: sub2clash
|
||||||
builds:
|
builds:
|
||||||
- env:
|
- env:
|
||||||
@@ -9,19 +10,15 @@ builds:
|
|||||||
goarch:
|
goarch:
|
||||||
- amd64
|
- amd64
|
||||||
- arm64
|
- arm64
|
||||||
- arm
|
|
||||||
- "386"
|
- "386"
|
||||||
goarm:
|
|
||||||
- "6"
|
|
||||||
- "7"
|
|
||||||
ldflags:
|
ldflags:
|
||||||
- -s -w -X sub2clash/constant.Version={{ .Version }}
|
- -s -w -X github.com/bestnite/sub2clash/constant.Version={{ .Version }}
|
||||||
flags:
|
flags:
|
||||||
- -trimpath
|
- -trimpath
|
||||||
archives:
|
archives:
|
||||||
- format: tar.gz
|
- formats: ["tar.gz"]
|
||||||
format_overrides:
|
format_overrides:
|
||||||
- format: zip
|
- formats: ["zip"]
|
||||||
goos: windows
|
goos: windows
|
||||||
wrap_in_directory: true
|
wrap_in_directory: true
|
||||||
files:
|
files:
|
||||||
@@ -30,3 +27,19 @@ archives:
|
|||||||
- templates
|
- templates
|
||||||
release:
|
release:
|
||||||
draft: true
|
draft: true
|
||||||
|
upx:
|
||||||
|
- enabled: true
|
||||||
|
compress: best
|
||||||
|
nfpms:
|
||||||
|
- id: sub2clash
|
||||||
|
homepage: https://github.com/bestnite/sub2clash
|
||||||
|
maintainer: Nite <admin@nite07.com>
|
||||||
|
license: "MIT"
|
||||||
|
formats:
|
||||||
|
- apk
|
||||||
|
- deb
|
||||||
|
- rpm
|
||||||
|
- termux.deb
|
||||||
|
- archlinux
|
||||||
|
provides:
|
||||||
|
- sub2clash
|
||||||
|
|||||||
74
API.md
74
API.md
@@ -1,74 +0,0 @@
|
|||||||
# `GET /convert/:config`
|
|
||||||
|
|
||||||
获取 Clash/Clash.Meta 配置链接
|
|
||||||
|
|
||||||
| Path 参数 | 类型 | 说明 |
|
|
||||||
| --------- | ------ | ---------------------------------------------- |
|
|
||||||
| config | string | Base64 URL Safe 编码后的 JSON 字符串,格式如下 |
|
|
||||||
|
|
||||||
## `config` JSON 结构
|
|
||||||
|
|
||||||
| Query 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
|
||||||
| ------------------ | ----------------- | ------------------------ | --------- | --------------------------------------------------------------------------------- |
|
|
||||||
| clashType | int | 是 | 1 | 配置文件类型 (1: Clash, 2: Clash.Meta) |
|
|
||||||
| subscriptions | []string | sub/proxy 至少有一项存在 | - | 订阅链接,可以在链接结尾加上`#名称`,来给订阅中的节点加上统一前缀(可以输入多个) |
|
|
||||||
| proxies | []string | sub/proxy 至少有一项存在 | - | 节点分享链接(可以输入多个) |
|
|
||||||
| refresh | bool | 否 | `false` | 强制刷新配置(默认缓存 5 分钟) |
|
|
||||||
| template | string | 否 | - | 外部模板链接或内部模板名称 |
|
|
||||||
| ruleProviders | []RuleProvider | 否 | - | 规则 |
|
|
||||||
| rules | []Rule | 否 | - | 规则 |
|
|
||||||
| autoTest | bool | 否 | `false` | 国家策略组是否自动测速 |
|
|
||||||
| lazy | bool | 否 | `false` | 自动测速是否启用 lazy |
|
|
||||||
| sort | string | 否 | `nameasc` | 国家策略组排序策略,可选值 `nameasc`、`namedesc`、`sizeasc`、`sizedesc` |
|
|
||||||
| replace | map[string]string | 否 | - | 通过正则表达式重命名节点 |
|
|
||||||
| remove | string | 否 | - | 通过正则表达式删除节点 |
|
|
||||||
| nodeList | bool | 否 | `false` | 只输出节点 |
|
|
||||||
| ignoreCountryGroup | bool | 否 | `false` | 是否忽略国家分组 |
|
|
||||||
| userAgent | string | 否 | - | 订阅 user-agent |
|
|
||||||
| useUDP | bool | 否 | `false` | 是否使用 UDP |
|
|
||||||
|
|
||||||
### `RuleProvider` 结构
|
|
||||||
|
|
||||||
| 字段 | 类型 | 说明 |
|
|
||||||
| -------- | ------ | ---------------------------------------------------------------- |
|
|
||||||
| behavior | string | rule-set 的 behavior |
|
|
||||||
| url | string | rule-set 的 url |
|
|
||||||
| group | string | 该规则集使用的策略组名 |
|
|
||||||
| prepend | bool | 如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部 |
|
|
||||||
| name | string | 该 rule-provider 的名称,不能重复 |
|
|
||||||
|
|
||||||
### `Rule` 结构
|
|
||||||
|
|
||||||
| 字段 | 类型 | 说明 |
|
|
||||||
| ------- | ------ | ---------------------------------------------------------------- |
|
|
||||||
| rule | string | 规则 |
|
|
||||||
| prepend | bool | 如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部 |
|
|
||||||
|
|
||||||
# `POST /short`
|
|
||||||
|
|
||||||
获取短链,Content-Type 为 `application/json`
|
|
||||||
具体参考使用可以参考 [api\templates\index.html](api/static/index.html)
|
|
||||||
|
|
||||||
| Body 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
|
||||||
| --------- | ------ | -------- | ------ | ------------------------- |
|
|
||||||
| url | string | 是 | - | 需要转换的 Query 参数部分 |
|
|
||||||
| password | string | 否 | - | 短链密码 |
|
|
||||||
|
|
||||||
# `GET /s/:hash`
|
|
||||||
|
|
||||||
短链跳转
|
|
||||||
`hash` 为动态路由参数,可以通过 `/short` 接口获取
|
|
||||||
|
|
||||||
| Query 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
|
||||||
| ---------- | ------ | -------- | ------ | -------- |
|
|
||||||
| password | string | 否 | - | 短链密码 |
|
|
||||||
|
|
||||||
# `PUT /short`
|
|
||||||
|
|
||||||
更新短链,Content-Type 为 `application/json`
|
|
||||||
|
|
||||||
| Body 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
|
||||||
| --------- | ------ | -------- | ------ | ------------------------- |
|
|
||||||
| url | string | 是 | - | 需要转换的 Query 参数部分 |
|
|
||||||
| password | string | 否 | - | 短链密码 |
|
|
||||||
| hash | string | 是 | - | 短链 hash |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
FROM golang:1.21-alpine as builder
|
FROM golang:1.25 as builder
|
||||||
LABEL authors="nite07"
|
LABEL authors="nite07"
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY . .
|
COPY . .
|
||||||
75
README.md
75
README.md
@@ -59,7 +59,80 @@
|
|||||||
|
|
||||||
### API
|
### API
|
||||||
|
|
||||||
[API 文档](./API.md)
|
#### `GET /convert/:config`
|
||||||
|
|
||||||
|
获取 Clash/Clash.Meta 配置链接
|
||||||
|
|
||||||
|
| Path 参数 | 类型 | 说明 |
|
||||||
|
| --------- | ------ | ---------------------------------------------- |
|
||||||
|
| config | string | Base64 URL Safe 编码后的 JSON 字符串,格式如下 |
|
||||||
|
|
||||||
|
##### `config` JSON 结构
|
||||||
|
|
||||||
|
| Query 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
||||||
|
| ------------------ | ----------------- | ------------------------ | --------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| clashType | int | 是 | 1 | 配置文件类型 (1: Clash, 2: Clash.Meta) |
|
||||||
|
| subscriptions | []string | sub/proxy 至少有一项存在 | - | 订阅链接(v2ray 或 clash 格式),可以在链接结尾加上`#名称`,来给订阅中的节点加上统一前缀(可以输入多个) |
|
||||||
|
| proxies | []string | sub/proxy 至少有一项存在 | - | 节点分享链接(可以输入多个) |
|
||||||
|
| refresh | bool | 否 | `false` | 强制刷新配置(默认缓存 5 分钟) |
|
||||||
|
| template | string | 否 | - | 外部模板链接或内部模板名称 |
|
||||||
|
| ruleProviders | []RuleProvider | 否 | - | 规则 |
|
||||||
|
| rules | []Rule | 否 | - | 规则 |
|
||||||
|
| autoTest | bool | 否 | `false` | 国家策略组是否自动测速 |
|
||||||
|
| lazy | bool | 否 | `false` | 自动测速是否启用 lazy |
|
||||||
|
| sort | string | 否 | `nameasc` | 国家策略组排序策略,可选值 `nameasc`、`namedesc`、`sizeasc`、`sizedesc` |
|
||||||
|
| replace | map[string]string | 否 | - | 通过正则表达式重命名节点 |
|
||||||
|
| remove | string | 否 | - | 通过正则表达式删除节点 |
|
||||||
|
| nodeList | bool | 否 | `false` | 只输出节点 |
|
||||||
|
| ignoreCountryGroup | bool | 否 | `false` | 是否忽略国家分组 |
|
||||||
|
| userAgent | string | 否 | - | 订阅 user-agent |
|
||||||
|
| useUDP | bool | 否 | `false` | 是否使用 UDP |
|
||||||
|
|
||||||
|
###### `RuleProvider` 结构
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
| -------- | ------ | ---------------------------------------------------------------- |
|
||||||
|
| behavior | string | rule-set 的 behavior |
|
||||||
|
| url | string | rule-set 的 url |
|
||||||
|
| group | string | 该规则集使用的策略组名 |
|
||||||
|
| prepend | bool | 如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部 |
|
||||||
|
| name | string | 该 rule-provider 的名称,不能重复 |
|
||||||
|
|
||||||
|
###### `Rule` 结构
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
| ------- | ------ | ---------------------------------------------------------------- |
|
||||||
|
| rule | string | 规则 |
|
||||||
|
| prepend | bool | 如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部 |
|
||||||
|
|
||||||
|
#### `POST /short`
|
||||||
|
|
||||||
|
获取短链,Content-Type 为 `application/json`
|
||||||
|
具体参考使用可以参考 [api\templates\index.html](api/static/index.html)
|
||||||
|
|
||||||
|
| Body 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
||||||
|
| --------- | ------ | -------- | ------ | ------------------------- |
|
||||||
|
| url | string | 是 | - | 需要转换的 Query 参数部分 |
|
||||||
|
| password | string | 否 | - | 短链密码 |
|
||||||
|
|
||||||
|
#### `GET /s/:hash`
|
||||||
|
|
||||||
|
短链跳转
|
||||||
|
`hash` 为动态路由参数,可以通过 `/short` 接口获取
|
||||||
|
|
||||||
|
| Query 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
||||||
|
| ---------- | ------ | -------- | ------ | -------- |
|
||||||
|
| password | string | 否 | - | 短链密码 |
|
||||||
|
|
||||||
|
#### `PUT /short`
|
||||||
|
|
||||||
|
更新短链,Content-Type 为 `application/json`
|
||||||
|
|
||||||
|
| Body 参数 | 类型 | 是否必须 | 默认值 | 说明 |
|
||||||
|
| --------- | ------ | -------- | ------ | ------------------------- |
|
||||||
|
| url | string | 是 | - | 需要转换的 Query 参数部分 |
|
||||||
|
| password | string | 否 | - | 短链密码 |
|
||||||
|
| hash | string | 是 | - | 短链 hash |
|
||||||
|
|
||||||
### 模板
|
### 模板
|
||||||
|
|
||||||
|
|||||||
@@ -133,8 +133,8 @@ func NewTemplateLoadError(template string, cause error) *CommonError {
|
|||||||
return NewError(ErrTemplateLoad, fmt.Sprintf("failed to load template: %s", template), cause)
|
return NewError(ErrTemplateLoad, fmt.Sprintf("failed to load template: %s", template), cause)
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewTemplateParseError(cause error) *CommonError {
|
func NewTemplateParseError(data []byte, cause error) *CommonError {
|
||||||
return NewError(ErrTemplateParse, "failed to parse template", cause)
|
return NewError(ErrTemplateParse, fmt.Sprintf("failed to parse template: %s", data), cause)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Subscription errors
|
// Subscription errors
|
||||||
@@ -142,8 +142,8 @@ func NewSubscriptionLoadError(url string, cause error) *CommonError {
|
|||||||
return NewError(ErrSubscriptionLoad, fmt.Sprintf("failed to load subscription: %s", url), cause)
|
return NewError(ErrSubscriptionLoad, fmt.Sprintf("failed to load subscription: %s", url), cause)
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewSubscriptionParseError(cause error) *CommonError {
|
func NewSubscriptionParseError(data []byte, cause error) *CommonError {
|
||||||
return NewError(ErrSubscriptionParse, "failed to parse subscription", cause)
|
return NewError(ErrSubscriptionParse, fmt.Sprintf("failed to parse subscription: %s", string(data)), cause)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Regex errors
|
// Regex errors
|
||||||
|
|||||||
@@ -129,22 +129,22 @@ func BuildSub(clashType model.ClashType, query model.ConvertConfig, template str
|
|||||||
err = yaml.Unmarshal(templateBytes, &temp)
|
err = yaml.Unmarshal(templateBytes, &temp)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Logger.Debug("parse template failed", zap.Error(err))
|
logger.Logger.Debug("parse template failed", zap.Error(err))
|
||||||
return nil, NewTemplateParseError(err)
|
return nil, NewTemplateParseError(templateBytes, err)
|
||||||
}
|
}
|
||||||
var proxyList []P.Proxy
|
var proxyList []P.Proxy
|
||||||
|
|
||||||
for i := range query.Subs {
|
for i := range query.Subs {
|
||||||
data, err := LoadSubscription(query.Subs[i], query.Refresh, query.UserAgent, cacheExpire, retryTimes)
|
data, err := LoadSubscription(query.Subs[i], query.Refresh, query.UserAgent, cacheExpire, retryTimes)
|
||||||
subName := ""
|
|
||||||
if strings.Contains(query.Subs[i], "#") {
|
|
||||||
subName = query.Subs[i][strings.LastIndex(query.Subs[i], "#")+1:]
|
|
||||||
}
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Logger.Debug(
|
logger.Logger.Debug(
|
||||||
"load subscription failed", zap.String("url", query.Subs[i]), zap.Error(err),
|
"load subscription failed", zap.String("url", query.Subs[i]), zap.Error(err),
|
||||||
)
|
)
|
||||||
return nil, NewSubscriptionLoadError(query.Subs[i], err)
|
return nil, NewSubscriptionLoadError(query.Subs[i], err)
|
||||||
}
|
}
|
||||||
|
subName := ""
|
||||||
|
if strings.Contains(query.Subs[i], "#") {
|
||||||
|
subName = query.Subs[i][strings.LastIndex(query.Subs[i], "#")+1:]
|
||||||
|
}
|
||||||
|
|
||||||
err = yaml.Unmarshal(data, &sub)
|
err = yaml.Unmarshal(data, &sub)
|
||||||
var newProxies []P.Proxy
|
var newProxies []P.Proxy
|
||||||
@@ -161,14 +161,14 @@ func BuildSub(clashType model.ClashType, query model.ConvertConfig, template str
|
|||||||
}
|
}
|
||||||
newProxies = p
|
newProxies = p
|
||||||
} else {
|
} else {
|
||||||
base64, err := utils.DecodeBase64(string(data), true)
|
base64, err := utils.DecodeBase64(string(data), false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Logger.Debug(
|
logger.Logger.Debug(
|
||||||
"parse subscription failed", zap.String("url", query.Subs[i]),
|
"parse subscription failed", zap.String("url", query.Subs[i]),
|
||||||
zap.String("data", string(data)),
|
zap.String("data", string(data)),
|
||||||
zap.Error(err),
|
zap.Error(err),
|
||||||
)
|
)
|
||||||
return nil, NewSubscriptionParseError(err)
|
return nil, NewSubscriptionParseError(data, err)
|
||||||
}
|
}
|
||||||
p, err := parser.ParseProxies(parser.ParseConfig{UseUDP: query.UseUDP}, strings.Split(base64, "\n")...)
|
p, err := parser.ParseProxies(parser.ParseConfig{UseUDP: query.UseUDP}, strings.Split(base64, "\n")...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -3,11 +3,27 @@ package common
|
|||||||
import (
|
import (
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
func LoadTemplate(templatePath string) ([]byte, error) {
|
const templatesDir = "templates"
|
||||||
if _, err := os.Stat(templatePath); err == nil {
|
|
||||||
file, err := os.Open(templatePath)
|
// LoadTemplate 只读取运行目录下的 templates 目录,防止其他文件内容泄漏
|
||||||
|
func LoadTemplate(templateName string) ([]byte, error) {
|
||||||
|
// 清理路径,防止目录遍历攻击
|
||||||
|
cleanTemplateName := filepath.Clean(templateName)
|
||||||
|
|
||||||
|
// 检查是否尝试访问父目录
|
||||||
|
if strings.HasPrefix(cleanTemplateName, "..") || strings.Contains(cleanTemplateName, string(filepath.Separator)+".."+string(filepath.Separator)) {
|
||||||
|
return nil, NewFileNotFoundError(templateName) // 拒绝包含父目录的路径
|
||||||
|
}
|
||||||
|
|
||||||
|
// 构建完整路径,确保只从 templates 目录读取
|
||||||
|
fullPath := filepath.Join(templatesDir, cleanTemplateName)
|
||||||
|
|
||||||
|
if _, err := os.Stat(fullPath); err == nil {
|
||||||
|
file, err := os.Open(fullPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -22,5 +38,5 @@ func LoadTemplate(templatePath string) ([]byte, error) {
|
|||||||
}
|
}
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
return nil, NewFileNotFoundError(templatePath)
|
return nil, NewFileNotFoundError(templateName)
|
||||||
}
|
}
|
||||||
|
|||||||
4
go.mod
4
go.mod
@@ -1,8 +1,6 @@
|
|||||||
module github.com/bestnite/sub2clash
|
module github.com/bestnite/sub2clash
|
||||||
|
|
||||||
go 1.21.0
|
go 1.25
|
||||||
|
|
||||||
toolchain go1.24.3
|
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/gin-gonic/gin v1.10.1
|
github.com/gin-gonic/gin v1.10.1
|
||||||
|
|||||||
@@ -89,7 +89,7 @@
|
|||||||
<!-- Template -->
|
<!-- Template -->
|
||||||
<div class="form-group mb-3">
|
<div class="form-group mb-3">
|
||||||
<label for="template">模板链接或名称:</label>
|
<label for="template">模板链接或名称:</label>
|
||||||
<input class="form-control" id="template" name="template" placeholder="输入外部模板链接或内部模板名称(可选)" type="text" />
|
<input class="form-control" id="template" name="template" placeholder="输入模板链接(可选)" type="text" />
|
||||||
</div>
|
</div>
|
||||||
<!-- Subscription Link -->
|
<!-- Subscription Link -->
|
||||||
<div class="form-group mb-3">
|
<div class="form-group mb-3">
|
||||||
|
|||||||
Reference in New Issue
Block a user