chore: bump version to 2.4.0

Author: SunBK201

README.md

@@ -66,10 +66,12 @@ UA3F 是一个 HTTP Header 重写工具，作为一个 HTTP、SOCKS5、TPROXY、
 
 ## 使用
 
-UA3F 支持 LuCI Web 页面，可以打开 Services -> UA3F 进行相关配置。
+UA3F 支持 OpenWrt LuCI Web 页面，可以打开 Services -> UA3F 进行相关配置。
 
 快速使用教程详见：[猴子也能看懂的 UA3F 使用教程](https://sunbk201public.notion.site/UA3F-2a21f32cbb4b80669e04ec1f053d0333)
 
+UA3F 支持 yaml 文件进行配置，通过 `-c` 参数指定配置文件路径， 通过 `-g` 参数生成模板配置文件，配置文件示例见 [docs/config.yaml](docs/config.yaml)
+
 设备与系统信息正则表达式参考：
 
 ```regex
@@ -94,6 +96,8 @@ sudo -u shellcrash /usr/bin/ua3f
 
 相关命令行启动参数:
 
+- `-c <config path>`: 自定义配置文件路径
+- `-g`: 在当前目录生成模板配置文件 config.yaml
 - `-m <mode>`: 服务模式，支持 HTTP、SOCKS5、TPROXY、REDIRECT，默认 SOCKS5
 - `-b <bind addr>`: 自定义绑定监听地址，默认 127.0.0.1
 - `-p <port>`: 端口号，默认 1080

README_EN.md

@@ -59,10 +59,12 @@ Three deployment methods are available:
 
 ## Usage
 
-UA3F supports LuCI Web interface. Navigate to Services -> UA3F for configuration.
+UA3F supports OpenWrt LuCI Web interface. Navigate to Services -> UA3F for configuration.
 
 For detailed tutorial, please visit: [UA3F User Guide](https://sunbk201public.notion.site/UA3F-2a21f32cbb4b80669e04ec1f053d0333)
 
+UA3F supports configuration via a YAML file. You can specify the configuration file path using the `-c` option, and generate a template configuration file using the `-g` option. An example configuration file can be found at [docs/config.yaml](docs/config.yaml).
+
 Device and system information regex reference:
 
 ```regex
@@ -87,6 +89,8 @@ sudo -u shellcrash /usr/bin/ua3f
 
 Command line parameters:
 
+- `-c <config path>`: Custom configuration file path
+- `-g`: Generate a template configuration file config.yaml in the current directory
 - `-m <mode>`: Server mode. Supports HTTP, SOCKS5, TPROXY, REDIRECT. Default: SOCKS5
 - `-b <bind addr>`: Custom bind address. Default: 127.0.0.1
 - `-p <port>`: Port number. Default: 1080

openwrt/Makefile

@@ -1,7 +1,7 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=UA3F
-PKG_VERSION:=2.3.0
+PKG_VERSION:=2.4.0
 PKG_RELEASE:=1
 
 # PKG_SOURCE:=$(PKG_NAME)-$(PKG_VERSION).tar.gz

openwrt/files/luci/view/ua3f/version.htm

@@ -1,6 +1,6 @@
 <span style="display: inline-flex;">
     <a href="https://github.com/SunBK201/UA3F" target="_blank">
-        Version: <span id="ua3f-current-version">2.3.0</span>
+        Version: <span id="ua3f-current-version">2.4.0</span>
     </a>
     <span id="ua3f-update-status" style="margin-left: 10px;"></span>
 </span>

scripts/build.sh

@@ -8,7 +8,7 @@
 set -e
 
 project_name="ua3f"
-release_version="2.3.0"
+release_version="2.4.0"
 target=main.go
 
 LINUX_ARCHS="amd64 arm arm64 mipsle mips64 riscv64 386 mipsle-softfloat mipsle-hardfloat armv7 armv8"

scripts/ipkg/CONTROL/control

@@ -1,5 +1,5 @@
 Package: ua3f
-Version: 2.3.0-1
+Version: 2.4.0-1
 Depends: luci-compat, ipset, iptables, iptables-mod-tproxy, iptables-mod-extra, iptables-mod-ipopt, iptables-mod-nfqueue, iptables-mod-conntrack-extra, kmod-nf-conntrack-netlink
 Source: /feed/openwrt
 SourceName: UA3F

scripts/ipkg/CONTROL/control-e

@@ -1,5 +1,5 @@
 Package: ua3f
-Version: 2.3.0-1
+Version: 2.4.0-1
 Depends: luci-compat, ipset, iptables, iptables-mod-tproxy, iptables-mod-extra, iptables-mod-ipopt, iptables-mod-nfqueue, iptables-mod-conntrack-extra, kmod-nf-conntrack-netlink
 Source: /feed/openwrt
 SourceName: UA3F

src/internal/config/config.go

@@ -50,7 +50,7 @@ type Config struct {
 	Desync DesyncConfig `yaml:"desync"`
 
 	Rules     []Rule `yaml:"rules" validate:"dive"`
-	RulesJson string
+	RulesJson string `yaml:"rules_json,omitempty"`
 }
 
 type DesyncConfig struct {
@@ -62,7 +62,7 @@ type DesyncConfig struct {
 }
 
 type Rule struct {
-	Enabled bool `json:"enabled" yaml:"enabled"`
+	Enabled bool `json:"enabled,omitempty" yaml:"enabled,omitempty"`
 
 	Type string `json:"type" yaml:"type" validate:"required,oneof=HEADER-KEYWORD HEADER-REGEX DEST-PORT IP-CIDR SRC-IP DOMAIN-SUFFIX DOMAIN-KEYWORD DOMAIN FINAL"`
 
@@ -90,6 +90,7 @@ func Parse() (*Config, bool, error) {
 		rewriteMode      string
 		rulesJson        string
 		showVer          bool
+		genConfig        bool
 		ttl              bool
 		ipid             bool
 		tcpTimestamp     bool
@@ -112,6 +113,7 @@ func Parse() (*Config, bool, error) {
 	flag.StringVar(&rewriteMode, "x", "", "Rewrite mode: GLOBAL, DIRECT, RULE")
 	flag.StringVar(&rulesJson, "z", "", "Rules JSON string")
 	flag.BoolVar(&showVer, "v", false, "Show version")
+	flag.BoolVar(&genConfig, "g", false, "Generate template config file")
 	flag.BoolVar(&ttl, "ttl", false, "Set TTL")
 	flag.BoolVar(&ipid, "ipid", false, "Set IP ID")
 	flag.BoolVar(&tcpTimestamp, "tcpts", false, "Delete TCP Timestamp")
@@ -123,6 +125,19 @@ func Parse() (*Config, bool, error) {
 	flag.UintVar(&injectTTL, "desync-inject-ttl", 0, "Desync inject TTL")
 	flag.Parse()
 
+	if genConfig {
+		_, err := GenerateTemplateConfig(true)
+		if err != nil {
+			return nil, false, fmt.Errorf("failed to generate template config: %w", err)
+		}
+		fmt.Println("Template config file 'config.yaml' generated successfully.")
+		return nil, false, nil
+	}
+
+	if showVer {
+		return nil, true, nil
+	}
+
 	// Track which CLI flags were explicitly set
 	cliSet := make(map[string]bool)
 	flag.Visit(func(f *flag.Flag) {

src/internal/config/template.go

@@ -0,0 +1,57 @@
+package config
+
+import (
+	"fmt"
+	"os"
+
+	"go.yaml.in/yaml/v3"
+)
+
+func GenerateTemplateConfig(writeToFile bool) (Config, error) {
+	cfg := Config{
+		ServerMode:  "SOCKS5",
+		BindAddress: "127.0.0.1",
+		Port:        1080,
+
+		LogLevel: "info",
+
+		RewriteMode: "GLOBAL",
+
+		UserAgent:               "FFF",
+		UserAgentRegex:          "",
+		UserAgentPartialReplace: false,
+
+		TTL:              false,
+		IPID:             false,
+		TCPTimeStamp:     false,
+		TCPInitialWindow: false,
+
+		Desync: DesyncConfig{
+			Reorder:        false,
+			ReorderBytes:   8,
+			ReorderPackets: 1500,
+			Inject:         false,
+			InjectTTL:      3,
+		},
+
+		Rules: []Rule{
+			{
+				Type:          "FINAL",
+				Action:        "REPLACE",
+				RewriteHeader: "User-Agent",
+				RewriteValue:  "FFF",
+			},
+		},
+	}
+
+	if writeToFile {
+		data, err := yaml.Marshal(&cfg)
+		if err != nil {
+			return Config{}, fmt.Errorf("failed to marshal template config to YAML: %w", err)
+		}
+		if err := os.WriteFile("config.yaml", data, 0644); err != nil {
+			return Config{}, fmt.Errorf("failed to write template config to file: %w", err)
+		}
+	}
+	return cfg, nil
+}

src/main.go

@@ -27,13 +27,17 @@ func main() {
 		return
 	}
 
-	log.SetLogConf(cfg.LogLevel)
-
 	if showVer {
 		fmt.Printf("UA3F version %s\n", appVersion)
 		return
 	}
 
+	if cfg == nil {
+		return
+	}
+
+	log.SetLogConf(cfg.LogLevel)
+
 	log.LogHeader(appVersion, cfg)
 
 	if err := daemon.DaemonSetup(cfg); err != nil {