refactor: 重构配置结构,解耦热词、统一认证、移除 TLS 开关

- 新增 ASRConfig,热词从 doubao 提升为 provider 无关配置
- 移除 SecurityConfig,token 移入 ServerConfig
- 移除 tls_auto 配置项,TLS 始终启用(getUserMedia 要求 HTTPS)
- validate() 改为基于 provider 白名单验证,增加 resource_id 校验
- 简化 main.go:移除 scheme 变量和 HTTP 降级分支
- 更新 config.example.yaml 为新结构并修正环境变量前缀
This commit is contained in:
2026-03-02 04:36:22 +08:00
parent 0720505ef6
commit 48c8444b3f
3 changed files with 81 additions and 70 deletions

View File

@@ -1,22 +1,22 @@
# VoicePaste config # VoicePaste config
# Environment variables override these values (prefix: none, direct mapping) # Environment variables override these values (prefix: VOICEPASTE_)
# 火山引擎豆包 ASR 配置 # ASR 通用配置
doubao: asr:
app_id: "" # env: DOUBAO_APP_ID provider: doubao # env: VOICEPASTE_ASR_PROVIDER — ASR 引擎(目前支持: doubao
access_token: "" # env: DOUBAO_ACCESS_TOKEN hotwords: # 可选:热词列表,提升特定词汇识别准确率
resource_id: "volc.seedasr.sauc.duration" # env: DOUBAO_RESOURCE_ID
hotwords: # 可选:本地热词列表
# - 张三 # - 张三
# - 李四 # - 李四
# - VoicePaste # - VoicePaste
# - 人工智能 # - 人工智能
# 火山引擎豆包 ASR 凭证
doubao:
app_id: "" # env: VOICEPASTE_DOUBAO_APP_ID
access_token: "" # env: VOICEPASTE_DOUBAO_ACCESS_TOKEN
resource_id: "volc.seedasr.sauc.duration" # env: VOICEPASTE_DOUBAO_RESOURCE_ID
# 服务配置 # 服务配置
server: server:
port: 8443 # env: PORT port: 8443 # env: VOICEPASTE_SERVER_PORT
tls_auto: true # env: TLS_AUTO — 自动 TLS (AnyIP + 自签名降级) token: "" # env: VOICEPASTE_SERVER_TOKEN — 留空则不需要认证;填写后访问需携带 token 参数
# 安全配置
security:
token: "" # 留空则不需要认证;填写后访问需携带 token 参数

View File

@@ -7,45 +7,48 @@ import (
"strings" "strings"
"sync" "sync"
"sync/atomic" "sync/atomic"
"github.com/fsnotify/fsnotify" "github.com/fsnotify/fsnotify"
"github.com/spf13/viper" "github.com/spf13/viper"
) )
// DoubaoConfig holds 火山引擎豆包 ASR credentials. // ASRConfig holds ASR settings independent of any specific provider.
type DoubaoConfig struct { type ASRConfig struct {
AppID string `mapstructure:"app_id"` Provider string `mapstructure:"provider"`
AccessToken string `mapstructure:"access_token"` Hotwords []string `mapstructure:"hotwords"` // 通用热词列表
ResourceID string `mapstructure:"resource_id"`
Hotwords []string `mapstructure:"hotwords"` // 本地热词列表
} }
// SecurityConfig holds authentication settings. // DoubaoConfig holds 火山引擎豆包 ASR credentials.
type SecurityConfig struct { type DoubaoConfig struct {
Token string `mapstructure:"token"` AppID string `mapstructure:"app_id"`
AccessToken string `mapstructure:"access_token"`
ResourceID string `mapstructure:"resource_id"`
} }
// ServerConfig holds server settings. // ServerConfig holds server settings.
type ServerConfig struct { type ServerConfig struct {
Port int `mapstructure:"port"` Port int `mapstructure:"port"`
TLSAuto bool `mapstructure:"tls_auto"` Token string `mapstructure:"token"`
} }
// Config is the top-level configuration. // Config is the top-level configuration.
type Config struct { type Config struct {
Doubao DoubaoConfig `mapstructure:"doubao"` ASR ASRConfig `mapstructure:"asr"`
Server ServerConfig `mapstructure:"server"` Doubao DoubaoConfig `mapstructure:"doubao"`
Security SecurityConfig `mapstructure:"security"` Server ServerConfig `mapstructure:"server"`
} }
// defaults returns a Config with default values. // defaults returns a Config with default values.
func defaults() Config { func defaults() Config {
return Config{ return Config{
ASR: ASRConfig{
Provider: "doubao",
},
Doubao: DoubaoConfig{ Doubao: DoubaoConfig{
ResourceID: "volc.seedasr.sauc.duration", ResourceID: "volc.seedasr.sauc.duration",
}, },
Server: ServerConfig{ Server: ServerConfig{
Port: 8443, Port: 8443,
TLSAuto: true,
}, },
} }
} }
@@ -70,9 +73,9 @@ func Load(path string) (Config, error) {
// Set defaults // Set defaults
def := defaults() def := defaults()
v.SetDefault("asr.provider", def.ASR.Provider)
v.SetDefault("doubao.resource_id", def.Doubao.ResourceID) v.SetDefault("doubao.resource_id", def.Doubao.ResourceID)
v.SetDefault("server.port", def.Server.Port) v.SetDefault("server.port", def.Server.Port)
v.SetDefault("server.tls_auto", def.Server.TLSAuto)
// Allow env var overrides (e.g., VOICEPASTE_DOUBAO_APP_ID) // Allow env var overrides (e.g., VOICEPASTE_DOUBAO_APP_ID)
v.SetEnvPrefix("voicepaste") v.SetEnvPrefix("voicepaste")
@@ -98,13 +101,23 @@ func Load(path string) (Config, error) {
store(cfg) store(cfg)
return cfg, nil return cfg, nil
} }
// validate checks required fields.
// validate checks required fields based on the configured ASR provider.
func validate(cfg Config) error { func validate(cfg Config) error {
if cfg.Doubao.AppID == "" { provider := strings.TrimSpace(strings.ToLower(cfg.ASR.Provider))
return fmt.Errorf("doubao.app_id is required") switch provider {
} case "doubao":
if cfg.Doubao.AccessToken == "" { if cfg.Doubao.AppID == "" {
return fmt.Errorf("doubao.access_token is required") return fmt.Errorf("doubao.app_id is required when asr.provider is \"doubao\"")
}
if cfg.Doubao.AccessToken == "" {
return fmt.Errorf("doubao.access_token is required when asr.provider is \"doubao\"")
}
if cfg.Doubao.ResourceID == "" {
return fmt.Errorf("doubao.resource_id is required when asr.provider is \"doubao\"")
}
default:
return fmt.Errorf("unsupported asr.provider: %q (supported: doubao)", cfg.ASR.Provider)
} }
return nil return nil
} }
@@ -170,9 +183,9 @@ func WatchAndReload(path string) func() {
v.SetConfigType("yaml") v.SetConfigType("yaml")
// Set defaults // Set defaults
def := defaults() def := defaults()
v.SetDefault("asr.provider", def.ASR.Provider)
v.SetDefault("doubao.resource_id", def.Doubao.ResourceID) v.SetDefault("doubao.resource_id", def.Doubao.ResourceID)
v.SetDefault("server.port", def.Server.Port) v.SetDefault("server.port", def.Server.Port)
v.SetDefault("server.tls_auto", def.Server.TLSAuto)
v.SetEnvPrefix("voicepaste") v.SetEnvPrefix("voicepaste")
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_")) v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
v.AutomaticEnv() v.AutomaticEnv()
@@ -247,8 +260,8 @@ func Get() Config {
if v := global.Load(); v != nil { if v := global.Load(); v != nil {
cfg := v.(Config) cfg := v.(Config)
// Deep copy hotwords slice to prevent external modifications // Deep copy hotwords slice to prevent external modifications
if cfg.Doubao.Hotwords != nil { if cfg.ASR.Hotwords != nil {
cfg.Doubao.Hotwords = append([]string(nil), cfg.Doubao.Hotwords...) cfg.ASR.Hotwords = append([]string(nil), cfg.ASR.Hotwords...)
} }
return cfg return cfg
} }
@@ -259,8 +272,8 @@ func Get() Config {
// Deep copies slices to ensure immutability. // Deep copies slices to ensure immutability.
func store(cfg Config) { func store(cfg Config) {
// Deep copy hotwords to prevent external modifications // Deep copy hotwords to prevent external modifications
if cfg.Doubao.Hotwords != nil { if cfg.ASR.Hotwords != nil {
cfg.Doubao.Hotwords = append([]string(nil), cfg.Doubao.Hotwords...) cfg.ASR.Hotwords = append([]string(nil), cfg.ASR.Hotwords...)
} }
global.Store(cfg) global.Store(cfg)
} }

56
main.go
View File

@@ -9,6 +9,7 @@ import (
"os" "os"
"os/signal" "os/signal"
"syscall" "syscall"
"github.com/imbytecat/voicepaste/internal/asr" "github.com/imbytecat/voicepaste/internal/asr"
"github.com/imbytecat/voicepaste/internal/config" "github.com/imbytecat/voicepaste/internal/config"
"github.com/imbytecat/voicepaste/internal/paste" "github.com/imbytecat/voicepaste/internal/paste"
@@ -34,8 +35,8 @@ func main() {
initClipboard() initClipboard()
lanIPs := mustDetectLANIPs() lanIPs := mustDetectLANIPs()
lanIP := lanIPs[0] lanIP := lanIPs[0]
tlsResult, scheme := setupTLS(cfg, lanIP) tlsResult := mustSetupTLS(lanIP)
printBanner(cfg, tlsResult, lanIPs, scheme) printBanner(cfg, tlsResult, lanIPs)
srv := createServer(cfg, lanIP, tlsResult) srv := createServer(cfg, lanIP, tlsResult)
runWithGracefulShutdown(srv) runWithGracefulShutdown(srv)
} }
@@ -70,59 +71,56 @@ func mustDetectLANIPs() []string {
return lanIPs return lanIPs
} }
func setupTLS(cfg config.Config, lanIP string) (*vpTLS.Result, string) { func mustSetupTLS(lanIP string) *vpTLS.Result {
if !cfg.Server.TLSAuto {
return nil, "http"
}
tlsResult, err := vpTLS.GetTLSConfig(lanIP) tlsResult, err := vpTLS.GetTLSConfig(lanIP)
if err != nil { if err != nil {
slog.Error("TLS setup failed", "error", err) slog.Error("TLS setup failed", "error", err)
os.Exit(1) os.Exit(1)
} }
return tlsResult, "https" return tlsResult
} }
func printBanner(cfg config.Config, tlsResult *vpTLS.Result, lanIPs []string, scheme string) { func printBanner(cfg config.Config, tlsResult *vpTLS.Result, lanIPs []string) {
fmt.Println() fmt.Println()
fmt.Println("╔══════════════════════════════════════╗") fmt.Println("╔══════════════════════════════════════╗")
fmt.Println("║ VoicePaste 就绪 ║") fmt.Println("║ VoicePaste 就绪 ║")
fmt.Println("╚══════════════════════════════════════╝") fmt.Println("╚══════════════════════════════════════╝")
fmt.Println() fmt.Println()
printAddresses(cfg, tlsResult, lanIPs, scheme) printAddresses(cfg, tlsResult, lanIPs)
printCertInfo(tlsResult, cfg.Server.TLSAuto) printCertInfo(tlsResult)
printAuthInfo(cfg.Security.Token) printAuthInfo(cfg.Server.Token)
fmt.Println() fmt.Println()
fmt.Println(" 在手机浏览器中打开上方地址") fmt.Println(" 在手机浏览器中打开上方地址")
fmt.Println(" 按 Ctrl+C 停止服务") fmt.Println(" 按 Ctrl+C 停止服务")
fmt.Println() fmt.Println()
} }
func printAddresses(cfg config.Config, tlsResult *vpTLS.Result, lanIPs []string, scheme string) { func printAddresses(cfg config.Config, tlsResult *vpTLS.Result, lanIPs []string) {
token := cfg.Security.Token token := cfg.Server.Token
if len(lanIPs) == 1 { if len(lanIPs) == 1 {
host := lanIP(tlsResult, lanIPs[0]) host := lanIPHost(tlsResult, lanIPs[0])
fmt.Printf(" 地址: %s\n", buildURL(scheme, host, cfg.Server.Port, token)) fmt.Printf(" 地址: %s\n", buildURL(host, cfg.Server.Port, token))
return return
} }
fmt.Println(" 地址:") fmt.Println(" 地址:")
for _, ip := range lanIPs { for _, ip := range lanIPs {
host := lanIP(tlsResult, ip) host := lanIPHost(tlsResult, ip)
fmt.Printf(" - %s\n", buildURL(scheme, host, cfg.Server.Port, token)) fmt.Printf(" - %s\n", buildURL(host, cfg.Server.Port, token))
} }
} }
func lanIP(tlsResult *vpTLS.Result, ip string) string { func lanIPHost(tlsResult *vpTLS.Result, ip string) string {
if tlsResult != nil { if tlsResult != nil {
return vpTLS.AnyIPHost(ip) return vpTLS.AnyIPHost(ip)
} }
return ip return ip
} }
func printCertInfo(tlsResult *vpTLS.Result, tlsAuto bool) { func printCertInfo(tlsResult *vpTLS.Result) {
if tlsResult != nil { if tlsResult != nil {
fmt.Println(" 证书: AnyIP浏览器信任") fmt.Println(" 证书: AnyIP浏览器信任")
} else if tlsAuto { } else {
fmt.Println(" 证书: 配置错误TLS 启用但未获取证书)") fmt.Println(" 证书: 获取失败")
} }
} }
@@ -140,22 +138,21 @@ func createServer(cfg config.Config, lanIP string, tlsResult *vpTLS.Result) *ser
if tlsResult != nil { if tlsResult != nil {
tlsConfig = tlsResult.Config tlsConfig = tlsResult.Config
} }
srv := server.New(cfg.Security.Token, lanIP, webContent, tlsConfig) srv := server.New(cfg.Server.Token, lanIP, webContent, tlsConfig)
asrFactory := buildASRFactory() asrFactory := buildASRFactory()
wsHandler := ws.NewHandler(cfg.Security.Token, paste.Paste, asrFactory) wsHandler := ws.NewHandler(cfg.Server.Token, paste.Paste, asrFactory)
wsHandler.Register(srv.App()) wsHandler.Register(srv.App())
return srv return srv
} }
func buildASRFactory() func(chan<- ws.ServerMsg) (func([]byte), func(), error) { func buildASRFactory() func(chan<- ws.ServerMsg) (func([]byte), func(), error) {
return func(resultCh chan<- ws.ServerMsg) (func([]byte), func(), error) { return func(resultCh chan<- ws.ServerMsg) (func([]byte), func(), error) {
// Read latest config on each new connection
cfg := config.Get() cfg := config.Get()
asrCfg := asr.Config{ asrCfg := asr.Config{
AppID: cfg.Doubao.AppID, AppID: cfg.Doubao.AppID,
AccessToken: cfg.Doubao.AccessToken, AccessToken: cfg.Doubao.AccessToken,
ResourceID: cfg.Doubao.ResourceID, ResourceID: cfg.Doubao.ResourceID,
Hotwords: cfg.Doubao.Hotwords, Hotwords: cfg.ASR.Hotwords,
} }
client, err := asr.Dial(asrCfg, resultCh) client, err := asr.Dial(asrCfg, resultCh)
if err != nil { if err != nil {
@@ -186,9 +183,10 @@ func runWithGracefulShutdown(srv *server.Server) {
os.Exit(1) os.Exit(1)
} }
} }
func buildURL(scheme, host string, port int, token string) string {
func buildURL(host string, port int, token string) string {
if token != "" { if token != "" {
return fmt.Sprintf("%s://%s:%d/?token=%s", scheme, host, port, token) return fmt.Sprintf("https://%s:%d/?token=%s", host, port, token)
} }
return fmt.Sprintf("%s://%s:%d/", scheme, host, port) return fmt.Sprintf("https://%s:%d/", host, port)
} }