diff --git a/backend/internal/config/config.go b/backend/internal/config/config.go index 944e0f84..5dc6ad19 100644 --- a/backend/internal/config/config.go +++ b/backend/internal/config/config.go @@ -19,7 +19,9 @@ const ( RunModeSimple = "simple" ) -const DefaultCSPPolicy = "default-src 'self'; script-src 'self' https://challenges.cloudflare.com; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; img-src 'self' data: https:; font-src 'self' data: https://fonts.gstatic.com; connect-src 'self' https:; frame-src https://challenges.cloudflare.com; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" +// DefaultCSPPolicy is the default Content-Security-Policy with nonce support +// __CSP_NONCE__ will be replaced with actual nonce at request time by the SecurityHeaders middleware +const DefaultCSPPolicy = "default-src 'self'; script-src 'self' __CSP_NONCE__ https://challenges.cloudflare.com https://static.cloudflareinsights.com; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; img-src 'self' data: https:; font-src 'self' data: https://fonts.gstatic.com; connect-src 'self' https:; frame-src https://challenges.cloudflare.com; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" // 连接池隔离策略常量 // 用于控制上游 HTTP 连接池的隔离粒度,影响连接复用和资源消耗 diff --git a/backend/internal/server/middleware/security_headers.go b/backend/internal/server/middleware/security_headers.go index 9fca0cd3..92ecc150 100644 --- a/backend/internal/server/middleware/security_headers.go +++ b/backend/internal/server/middleware/security_headers.go @@ -1,12 +1,38 @@ package middleware import ( + "crypto/rand" + "encoding/base64" "strings" "github.com/Wei-Shaw/sub2api/internal/config" "github.com/gin-gonic/gin" ) +const ( + // CSPNonceKey is the context key for storing the CSP nonce + CSPNonceKey = "csp_nonce" + // NonceTemplate is the placeholder in CSP policy for nonce + NonceTemplate = "__CSP_NONCE__" +) + +// GenerateNonce generates a cryptographically secure random nonce +func GenerateNonce() string { + b := make([]byte, 16) + _, _ = rand.Read(b) + return base64.StdEncoding.EncodeToString(b) +} + +// GetNonceFromContext retrieves the CSP nonce from gin context +func GetNonceFromContext(c *gin.Context) string { + if nonce, exists := c.Get(CSPNonceKey); exists { + if s, ok := nonce.(string); ok { + return s + } + } + return "" +} + // SecurityHeaders sets baseline security headers for all responses. func SecurityHeaders(cfg config.CSPConfig) gin.HandlerFunc { policy := strings.TrimSpace(cfg.Policy) @@ -18,8 +44,15 @@ func SecurityHeaders(cfg config.CSPConfig) gin.HandlerFunc { c.Header("X-Content-Type-Options", "nosniff") c.Header("X-Frame-Options", "DENY") c.Header("Referrer-Policy", "strict-origin-when-cross-origin") + if cfg.Enabled { - c.Header("Content-Security-Policy", policy) + // Generate nonce for this request + nonce := GenerateNonce() + c.Set(CSPNonceKey, nonce) + + // Replace nonce placeholder in policy + finalPolicy := strings.ReplaceAll(policy, NonceTemplate, "'nonce-"+nonce+"'") + c.Header("Content-Security-Policy", finalPolicy) } c.Next() } diff --git a/backend/internal/server/middleware/security_headers_test.go b/backend/internal/server/middleware/security_headers_test.go new file mode 100644 index 00000000..c84c9b25 --- /dev/null +++ b/backend/internal/server/middleware/security_headers_test.go @@ -0,0 +1,285 @@ +package middleware + +import ( + "encoding/base64" + "net/http" + "net/http/httptest" + "strings" + "testing" + + "github.com/Wei-Shaw/sub2api/internal/config" + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func init() { + gin.SetMode(gin.TestMode) +} + +func TestGenerateNonce(t *testing.T) { + t.Run("generates_valid_base64_string", func(t *testing.T) { + nonce := GenerateNonce() + + // Should be valid base64 + decoded, err := base64.StdEncoding.DecodeString(nonce) + require.NoError(t, err) + + // Should decode to 16 bytes + assert.Len(t, decoded, 16) + }) + + t.Run("generates_unique_nonces", func(t *testing.T) { + nonces := make(map[string]bool) + for i := 0; i < 100; i++ { + nonce := GenerateNonce() + assert.False(t, nonces[nonce], "nonce should be unique") + nonces[nonce] = true + } + }) + + t.Run("nonce_has_expected_length", func(t *testing.T) { + nonce := GenerateNonce() + // 16 bytes -> 24 chars in base64 (with padding) + assert.Len(t, nonce, 24) + }) +} + +func TestGetNonceFromContext(t *testing.T) { + t.Run("returns_nonce_when_present", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + + expectedNonce := "test-nonce-123" + c.Set(CSPNonceKey, expectedNonce) + + nonce := GetNonceFromContext(c) + assert.Equal(t, expectedNonce, nonce) + }) + + t.Run("returns_empty_string_when_not_present", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + + nonce := GetNonceFromContext(c) + assert.Empty(t, nonce) + }) + + t.Run("returns_empty_for_wrong_type", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + + // Set a non-string value + c.Set(CSPNonceKey, 12345) + + // Should return empty string for wrong type (safe type assertion) + nonce := GetNonceFromContext(c) + assert.Empty(t, nonce) + }) +} + +func TestSecurityHeaders(t *testing.T) { + t.Run("sets_basic_security_headers", func(t *testing.T) { + cfg := config.CSPConfig{Enabled: false} + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + assert.Equal(t, "nosniff", w.Header().Get("X-Content-Type-Options")) + assert.Equal(t, "DENY", w.Header().Get("X-Frame-Options")) + assert.Equal(t, "strict-origin-when-cross-origin", w.Header().Get("Referrer-Policy")) + }) + + t.Run("csp_disabled_no_csp_header", func(t *testing.T) { + cfg := config.CSPConfig{Enabled: false} + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + assert.Empty(t, w.Header().Get("Content-Security-Policy")) + }) + + t.Run("csp_enabled_sets_csp_header", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "default-src 'self'", + } + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + csp := w.Header().Get("Content-Security-Policy") + assert.NotEmpty(t, csp) + assert.Equal(t, "default-src 'self'", csp) + }) + + t.Run("csp_enabled_with_nonce_placeholder", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "script-src 'self' __CSP_NONCE__", + } + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + csp := w.Header().Get("Content-Security-Policy") + assert.NotEmpty(t, csp) + assert.NotContains(t, csp, "__CSP_NONCE__", "placeholder should be replaced") + assert.Contains(t, csp, "'nonce-", "should contain nonce directive") + + // Verify nonce is stored in context + nonce := GetNonceFromContext(c) + assert.NotEmpty(t, nonce) + assert.Contains(t, csp, "'nonce-"+nonce+"'") + }) + + t.Run("uses_default_policy_when_empty", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "", + } + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + csp := w.Header().Get("Content-Security-Policy") + assert.NotEmpty(t, csp) + // Default policy should contain these elements + assert.Contains(t, csp, "default-src 'self'") + }) + + t.Run("uses_default_policy_when_whitespace_only", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: " \t\n ", + } + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + csp := w.Header().Get("Content-Security-Policy") + assert.NotEmpty(t, csp) + assert.Contains(t, csp, "default-src 'self'") + }) + + t.Run("multiple_nonce_placeholders_replaced", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "script-src __CSP_NONCE__; style-src __CSP_NONCE__", + } + middleware := SecurityHeaders(cfg) + + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + csp := w.Header().Get("Content-Security-Policy") + nonce := GetNonceFromContext(c) + + // Count occurrences of the nonce + count := strings.Count(csp, "'nonce-"+nonce+"'") + assert.Equal(t, 2, count, "both placeholders should be replaced with same nonce") + }) + + t.Run("calls_next_handler", func(t *testing.T) { + cfg := config.CSPConfig{Enabled: true, Policy: "default-src 'self'"} + middleware := SecurityHeaders(cfg) + + nextCalled := false + router := gin.New() + router.Use(middleware) + router.GET("/test", func(c *gin.Context) { + nextCalled = true + c.Status(http.StatusOK) + }) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/test", nil) + router.ServeHTTP(w, req) + + assert.True(t, nextCalled, "next handler should be called") + assert.Equal(t, http.StatusOK, w.Code) + }) + + t.Run("nonce_unique_per_request", func(t *testing.T) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "script-src __CSP_NONCE__", + } + middleware := SecurityHeaders(cfg) + + nonces := make(map[string]bool) + for i := 0; i < 10; i++ { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + + middleware(c) + + nonce := GetNonceFromContext(c) + assert.False(t, nonces[nonce], "nonce should be unique per request") + nonces[nonce] = true + } + }) +} + +func TestCSPNonceKey(t *testing.T) { + t.Run("constant_value", func(t *testing.T) { + assert.Equal(t, "csp_nonce", CSPNonceKey) + }) +} + +func TestNonceTemplate(t *testing.T) { + t.Run("constant_value", func(t *testing.T) { + assert.Equal(t, "__CSP_NONCE__", NonceTemplate) + }) +} + +// Benchmark tests +func BenchmarkGenerateNonce(b *testing.B) { + for i := 0; i < b.N; i++ { + GenerateNonce() + } +} + +func BenchmarkSecurityHeadersMiddleware(b *testing.B) { + cfg := config.CSPConfig{ + Enabled: true, + Policy: "script-src 'self' __CSP_NONCE__", + } + middleware := SecurityHeaders(cfg) + + b.ResetTimer() + for i := 0; i < b.N; i++ { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + middleware(c) + } +} diff --git a/backend/internal/web/embed_on.go b/backend/internal/web/embed_on.go index 35697fbb..7f37d59c 100644 --- a/backend/internal/web/embed_on.go +++ b/backend/internal/web/embed_on.go @@ -13,9 +13,15 @@ import ( "strings" "time" + "github.com/Wei-Shaw/sub2api/internal/server/middleware" "github.com/gin-gonic/gin" ) +const ( + // NonceHTMLPlaceholder is the placeholder for nonce in HTML script tags + NonceHTMLPlaceholder = "__CSP_NONCE_VALUE__" +) + //go:embed all:dist var frontendFS embed.FS @@ -115,6 +121,9 @@ func (s *FrontendServer) fileExists(path string) bool { } func (s *FrontendServer) serveIndexHTML(c *gin.Context) { + // Get nonce from context (generated by SecurityHeaders middleware) + nonce := middleware.GetNonceFromContext(c) + // Check cache first cached := s.cache.Get() if cached != nil { @@ -125,9 +134,12 @@ func (s *FrontendServer) serveIndexHTML(c *gin.Context) { return } + // Replace nonce placeholder with actual nonce before serving + content := replaceNoncePlaceholder(cached.Content, nonce) + c.Header("ETag", cached.ETag) c.Header("Cache-Control", "no-cache") // Must revalidate - c.Data(http.StatusOK, "text/html; charset=utf-8", cached.Content) + c.Data(http.StatusOK, "text/html; charset=utf-8", content) c.Abort() return } @@ -155,24 +167,33 @@ func (s *FrontendServer) serveIndexHTML(c *gin.Context) { rendered := s.injectSettings(settingsJSON) s.cache.Set(rendered, settingsJSON) + // Replace nonce placeholder with actual nonce before serving + content := replaceNoncePlaceholder(rendered, nonce) + cached = s.cache.Get() if cached != nil { c.Header("ETag", cached.ETag) } c.Header("Cache-Control", "no-cache") - c.Data(http.StatusOK, "text/html; charset=utf-8", rendered) + c.Data(http.StatusOK, "text/html; charset=utf-8", content) c.Abort() } func (s *FrontendServer) injectSettings(settingsJSON []byte) []byte { - // Create the script tag to inject - script := []byte(``) + // Create the script tag to inject with nonce placeholder + // The placeholder will be replaced with actual nonce at request time + script := []byte(``) // Inject before headClose := []byte("") return bytes.Replace(s.baseHTML, headClose, append(script, headClose...), 1) } +// replaceNoncePlaceholder replaces the nonce placeholder with actual nonce value +func replaceNoncePlaceholder(html []byte, nonce string) []byte { + return bytes.ReplaceAll(html, []byte(NonceHTMLPlaceholder), []byte(nonce)) +} + // ServeEmbeddedFrontend returns a middleware for serving embedded frontend // This is the legacy function for backward compatibility when no settings provider is available func ServeEmbeddedFrontend() gin.HandlerFunc { diff --git a/backend/internal/web/embed_test.go b/backend/internal/web/embed_test.go new file mode 100644 index 00000000..50f5a323 --- /dev/null +++ b/backend/internal/web/embed_test.go @@ -0,0 +1,660 @@ +//go:build embed + +package web + +import ( + "bytes" + "context" + "net/http" + "net/http/httptest" + "strings" + "testing" + + "github.com/Wei-Shaw/sub2api/internal/server/middleware" + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func init() { + gin.SetMode(gin.TestMode) +} + +func TestReplaceNoncePlaceholder(t *testing.T) { + t.Run("replaces_single_placeholder", func(t *testing.T) { + html := []byte(``) + nonce := "abc123xyz" + + result := replaceNoncePlaceholder(html, nonce) + + expected := `` + assert.Equal(t, expected, string(result)) + }) + + t.Run("replaces_multiple_placeholders", func(t *testing.T) { + html := []byte(``) + nonce := "nonce123" + + result := replaceNoncePlaceholder(html, nonce) + + assert.Equal(t, 2, strings.Count(string(result), `nonce="nonce123"`)) + assert.NotContains(t, string(result), NonceHTMLPlaceholder) + }) + + t.Run("handles_empty_nonce", func(t *testing.T) { + html := []byte(``) + nonce := "" + + result := replaceNoncePlaceholder(html, nonce) + + assert.Equal(t, ``, string(result)) + }) + + t.Run("no_placeholder_returns_unchanged", func(t *testing.T) { + html := []byte(``) + nonce := "abc123" + + result := replaceNoncePlaceholder(html, nonce) + + assert.Equal(t, string(html), string(result)) + }) + + t.Run("handles_empty_html", func(t *testing.T) { + html := []byte(``) + nonce := "abc123" + + result := replaceNoncePlaceholder(html, nonce) + + assert.Empty(t, result) + }) +} + +func TestNonceHTMLPlaceholder(t *testing.T) { + t.Run("constant_value", func(t *testing.T) { + assert.Equal(t, "__CSP_NONCE_VALUE__", NonceHTMLPlaceholder) + }) +} + +// mockSettingsProvider implements PublicSettingsProvider for testing +type mockSettingsProvider struct { + settings any + err error + called int +} + +func (m *mockSettingsProvider) GetPublicSettingsForInjection(ctx context.Context) (any, error) { + m.called++ + return m.settings, m.err +} + +func TestFrontendServer_InjectSettings(t *testing.T) { + t.Run("injects_settings_with_nonce_placeholder", func(t *testing.T) { + provider := &mockSettingsProvider{ + settings: map[string]string{"key": "value"}, + } + + server, err := NewFrontendServer(provider) + require.NoError(t, err) + + settingsJSON := []byte(`{"test":"data"}`) + result := server.injectSettings(settingsJSON) + + // Should contain the script with nonce placeholder + assert.Contains(t, string(result), ``) + }) + + t.Run("injects_before_head_close", func(t *testing.T) { + provider := &mockSettingsProvider{ + settings: map[string]string{"key": "value"}, + } + + server, err := NewFrontendServer(provider) + require.NoError(t, err) + + settingsJSON := []byte(`{}`) + result := server.injectSettings(settingsJSON) + + // Script should be injected before + headCloseIndex := bytes.Index(result, []byte("")) + scriptIndex := bytes.Index(result, []byte(``) + nonce := "abcdefghijklmnop123456==" + + b.ResetTimer() + for i := 0; i < b.N; i++ { + replaceNoncePlaceholder(html, nonce) + } +} + +func BenchmarkFrontendServerServeIndexHTML(b *testing.B) { + provider := &mockSettingsProvider{ + settings: map[string]string{"test": "value"}, + } + + server, _ := NewFrontendServer(provider) + + b.ResetTimer() + for i := 0; i < b.N; i++ { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = httptest.NewRequest(http.MethodGet, "/", nil) + c.Set(middleware.CSPNonceKey, "test-nonce") + + server.serveIndexHTML(c) + } +} diff --git a/deploy/config.example.yaml b/deploy/config.example.yaml index ce2439f4..9e85d1ff 100644 --- a/deploy/config.example.yaml +++ b/deploy/config.example.yaml @@ -97,7 +97,9 @@ security: enabled: true # Default CSP policy (override if you host assets on other domains) # 默认 CSP 策略(如果静态资源托管在其他域名,请自行覆盖) - policy: "default-src 'self'; script-src 'self' https://challenges.cloudflare.com; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; img-src 'self' data: https:; font-src 'self' data: https://fonts.gstatic.com; connect-src 'self' https:; frame-src https://challenges.cloudflare.com; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" + # Note: __CSP_NONCE__ will be replaced with 'nonce-xxx' at request time for inline script security + # 注意:__CSP_NONCE__ 会在请求时被替换为 'nonce-xxx',用于内联脚本安全 + policy: "default-src 'self'; script-src 'self' __CSP_NONCE__ https://challenges.cloudflare.com https://static.cloudflareinsights.com; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; img-src 'self' data: https:; font-src 'self' data: https://fonts.gstatic.com; connect-src 'self' https:; frame-src https://challenges.cloudflare.com; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" proxy_probe: # Allow skipping TLS verification for proxy probe (debug only) # 允许代理探测时跳过 TLS 证书验证(仅用于调试)