sun
d22e5f0801
修一个前置缺口:RequireAdmin 此前在凭证列表为空时直接放行(len(keys)==0 -> next.ServeHTTP),导致未配置凭证的部署上管理接口完全裸奔,并且会让后续给 /metrics、/health 套该中间件的加固形同虚设。现改为拒绝(401)并记录明确日志。 新增可选独立管理凭证 admin_key,取值优先级 admin_key(DB) > auth_key(DB) > OPENAI_TTS_API_KEY(env)。middleware.ValidateAPIKey(业务侧 /v1/audio/speech)保持只看 auth_key,于是配置 admin_key 后业务调用方持有的 key 无法访问管理接口,权限隔离成立;不配置则回退 auth_key,老部署行为不变。新增 PUT /api/admin/settings/admin-key 与旧前缀别名,凭证只写不读(GET /api/settings 仅回打码值与来源)。 normal 模式下管理凭证为空时启动期 fail-fast:RequireAdmin 改为拒绝后,若此处不拦,服务会正常起来但 /dashboard 与全部 /api/admin/* 都是 401,等于把自己锁在门外。启动摘要同时打印管理凭证来源(admin_key / auth_key / 未配置)。 验证:新增 middleware/admin_auth_test.go 覆盖空凭证拒绝、正确/错误/缺前缀/空白 token、OPTIONS 放行,以及权限隔离的两个场景(配了 admin_key 时业务 key 401;回退模式下业务 key 200)。go build / go vet / go test ./... -count=1 全绿。
176 lines
7.4 KiB
Go
176 lines
7.4 KiB
Go
package router
|
|
|
|
import (
|
|
_ "embed"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/gorilla/mux"
|
|
"github.com/volcano-tts/tts-api/controller"
|
|
"github.com/volcano-tts/tts-api/installer"
|
|
"github.com/volcano-tts/tts-api/metrics"
|
|
"github.com/volcano-tts/tts-api/middleware"
|
|
)
|
|
|
|
//go:embed health.html
|
|
var dashboardHTML []byte
|
|
|
|
//go:embed setup.html
|
|
var setupHTML []byte
|
|
|
|
//go:embed admin.html
|
|
var adminHTML []byte
|
|
|
|
//go:embed admin-login.html
|
|
var adminLoginHTML []byte
|
|
|
|
//go:embed admin-voices.html
|
|
var adminVoicesHTML []byte
|
|
|
|
//go:embed admin-settings.html
|
|
var adminSettingsHTML []byte
|
|
|
|
//go:embed admin.css
|
|
var adminCSS []byte
|
|
|
|
//go:embed admin-shell.js
|
|
var adminShellJS []byte
|
|
|
|
// Setup 返回主路由。
|
|
// 中间件顺序(由外向内):
|
|
// SecurityHeaders → InstallGuard → RateLimit → ConcurrencyLimit → Logger → handler
|
|
// 关键: InstallGuard 必须在 RateLimit 之前,避免安装模式被限流计数污染。
|
|
//
|
|
// /admin 和 /api/admin/* 都加 RequireAdmin;InstallGuard 不预先放行(让安装模式下
|
|
// 自动 302 跳 /setup,体验一致)。
|
|
func Setup() *mux.Router {
|
|
r := mux.NewRouter()
|
|
|
|
r.Use(middleware.SecurityHeaders)
|
|
r.Use(middleware.InstallGuard(installer.GetMode))
|
|
r.Use(middleware.RateLimitWithMetrics)
|
|
r.Use(middleware.ConcurrencyLimitWithMetrics)
|
|
r.Use(middleware.Logger)
|
|
|
|
// mux 路由未匹配时 NotFoundHandler 单独处理(不走 r.Use() 中间件链);
|
|
// 安装模式 + 浏览器访问任意未注册路径 → 302 跳 /setup。
|
|
r.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
|
if installer.GetMode() == installer.ModeSetup && acceptsHTML(req.Header.Get("Accept")) {
|
|
http.Redirect(w, req, "/setup", http.StatusFound)
|
|
return
|
|
}
|
|
http.NotFound(w, req)
|
|
})
|
|
|
|
// 安装相关路由(InstallGuard 已在 setup 模式放行;完成后由 controller 二次校验 404)
|
|
// /setup 页面本身:装完后必须不可用,否则用户敲 /setup 还会看到安装表单,容易误以为要重装。
|
|
r.HandleFunc("/setup", func(w http.ResponseWriter, req *http.Request) {
|
|
if installer.GetMode() == installer.ModeNormal {
|
|
http.Redirect(w, req, "/admin", http.StatusFound)
|
|
return
|
|
}
|
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
|
_, _ = w.Write(setupHTML)
|
|
}).Methods("GET")
|
|
r.HandleFunc("/api/setup/status", controller.SetupStatusHandler).Methods("GET")
|
|
r.HandleFunc("/api/setup/prefill", controller.SetupPrefillHandler).Methods("GET")
|
|
r.HandleFunc("/api/setup", controller.SetupSubmitHandler).Methods("POST")
|
|
|
|
// /admin 管理后台(M2);HTML 本身公开,鉴权由前端 JS 拦截
|
|
// (sessionStorage 没 key 就显示登录页;有 key 调 /api/admin/overview 触发 401 跳登录)
|
|
// API 端点(/api/admin/* /api/voices*)才需要 RequireAdmin。
|
|
//
|
|
// 拆分后 admin.html / admin-login.html / admin-voices.html / admin-settings.html
|
|
// 各自独立,URL 路由切换;共享 admin.css + admin-shell.js 由 adminStatic 提供。
|
|
r.HandleFunc("/admin", serveAdmin(adminHTML)).Methods("GET")
|
|
r.HandleFunc("/admin/login", serveAdmin(adminLoginHTML)).Methods("GET")
|
|
r.HandleFunc("/admin/voices", serveAdmin(adminVoicesHTML)).Methods("GET")
|
|
r.HandleFunc("/admin/settings", serveAdmin(adminSettingsHTML)).Methods("GET")
|
|
// admin 静态资源
|
|
r.HandleFunc("/admin/admin.css", func(w http.ResponseWriter, _ *http.Request) {
|
|
w.Header().Set("Content-Type", "text/css; charset=utf-8")
|
|
_, _ = w.Write(adminCSS)
|
|
}).Methods("GET")
|
|
r.HandleFunc("/admin/admin-shell.js", func(w http.ResponseWriter, _ *http.Request) {
|
|
w.Header().Set("Content-Type", "application/javascript; charset=utf-8")
|
|
_, _ = w.Write(adminShellJS)
|
|
}).Methods("GET")
|
|
|
|
// /api/admin/overview (鉴权)
|
|
r.Handle("/api/admin/overview", middleware.RequireAdmin(http.HandlerFunc(controller.AdminOverviewHandler))).Methods("GET")
|
|
// /api/admin/metrics (鉴权);返 Prometheus 文本
|
|
r.Handle("/api/admin/metrics", middleware.RequireAdmin(http.HandlerFunc(controller.AdminMetricsHandler))).Methods("GET")
|
|
|
|
// /api/voices 音色 CRUD (鉴权)
|
|
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoicesListHandler))).Methods("GET")
|
|
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceCreateHandler))).Methods("POST")
|
|
r.Handle("/api/voices/{name}", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceDeleteHandler))).Methods("DELETE")
|
|
r.Handle("/api/voices/{name}/toggle", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceToggleHandler))).Methods("PATCH")
|
|
|
|
// /api/settings 全局设置 (鉴权) — M3
|
|
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsGetHandler))).Methods("GET")
|
|
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsUpdateHandler))).Methods("PUT")
|
|
r.Handle("/api/settings/api-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAPIKeyHandler))).Methods("PUT")
|
|
r.Handle("/api/settings/auth-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAuthKeyHandler))).Methods("PUT")
|
|
// v0.3.0: 管理凭证(admin_key)独立配置端点。
|
|
// 同时注册新旧两个路径:/api/admin/settings/admin-key 是阶段 3 分层后的正式路径,
|
|
// /api/settings/admin-key 属于旧前缀,保留为别名(与阶段 3 的别名策略一致)。
|
|
r.Handle("/api/admin/settings/admin-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAdminKeyHandler))).Methods("PUT")
|
|
r.Handle("/api/settings/admin-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAdminKeyHandler))).Methods("PUT")
|
|
r.Handle("/api/settings/cors", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsCORSHandler))).Methods("PUT")
|
|
|
|
// 业务路由
|
|
r.HandleFunc("/v1/audio/speech", controller.OpenaiTTSHandler).Methods("POST", "OPTIONS")
|
|
r.HandleFunc("/health", controller.HealthHandler).Methods("GET")
|
|
r.HandleFunc("/dashboard", func(w http.ResponseWriter, req *http.Request) {
|
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
|
_, _ = w.Write(dashboardHTML)
|
|
}).Methods("GET")
|
|
r.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
|
// 安装模式下,根路径跳 /setup
|
|
if installer.GetMode() == installer.ModeSetup {
|
|
http.Redirect(w, req, "/setup", http.StatusFound)
|
|
return
|
|
}
|
|
// 正常模式:跳 /admin(M2 之后优先于 /dashboard)
|
|
http.Redirect(w, req, "/admin", http.StatusFound)
|
|
}).Methods("GET")
|
|
|
|
// /metrics 不做鉴权(对齐 /health 策略),但仍然走 RateLimit / ConcurrencyLimit。
|
|
// Prometheus 抓取不带 Origin,因此经过 CORS 中间件时会直接 pass-through。
|
|
r.Handle("/metrics", metrics.Meter.Handler()).Methods("GET")
|
|
|
|
return r
|
|
}
|
|
|
|
// acceptsHTML 在 router 包内复刻,middleware 包的版本未导出。
|
|
// 用途:NotFoundHandler 判断浏览器 Accept。
|
|
func acceptsHTML(accept string) bool {
|
|
if accept == "" {
|
|
return false
|
|
}
|
|
for _, part := range strings.Split(accept, ",") {
|
|
mt := strings.TrimSpace(part)
|
|
if mt == "" {
|
|
continue
|
|
}
|
|
if idx := strings.Index(mt, ";"); idx >= 0 {
|
|
mt = strings.TrimSpace(mt[:idx])
|
|
}
|
|
mt = strings.ToLower(mt)
|
|
if mt == "text/html" || mt == "text/*" {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// serveAdmin 返回一个把 embed 的 HTML bytes 以 text/html 写出的 handler。
|
|
// 抽出来只为让 /admin/voices 等多条路由的注册保持单行,避免重复 4 段。
|
|
func serveAdmin(body []byte) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, _ *http.Request) {
|
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
|
_, _ = w.Write(body)
|
|
}
|
|
}
|