diff --git a/cmd/api/config/config.go b/cmd/api/config/config.go index 95fa7a676..7ddbee1c4 100644 --- a/cmd/api/config/config.go +++ b/cmd/api/config/config.go @@ -2,6 +2,7 @@ package config import ( "encoding/json" + "errors" "fmt" "net/netip" "os" @@ -12,6 +13,7 @@ import ( "time" "github.com/c2h5oh/datasize" + "github.com/kernel/hypeman/lib/jwtauth" "github.com/kernel/hypeman/lib/snapshot" "github.com/knadh/koanf/parsers/yaml" "github.com/knadh/koanf/providers/env" @@ -582,6 +584,12 @@ func Load(configPath string) (*Config, error) { } cfg.expandPathFields() + // Empty is allowed here (the server fails later); a shipped placeholder is + // never acceptable, so refuse to start with a key anyone can read. + if cfg.JwtSecret != "" && jwtauth.IsWeakSecret(cfg.JwtSecret) { + return nil, errors.New("jwt_secret is a published placeholder, not a secret; set a unique random value (openssl rand -hex 32)") + } + return &cfg, nil } @@ -611,8 +619,8 @@ func expandHomePath(path string) string { // Returns an error if any configuration value is invalid. func (c *Config) Validate() error { for i, secret := range c.JwtVerificationSecrets { - if secret == "" { - return fmt.Errorf("jwt_verification_secrets entry %d must not be empty", i) + if jwtauth.IsWeakSecret(secret) { + return fmt.Errorf("jwt_verification_secrets entry %d must not be empty or a value published in the examples; set a unique random value or drop it", i) } } if c.MacOSOnly && (runtime.GOOS != "darwin" || runtime.GOARCH != "arm64" || c.Hypervisor.Default != "vz") { diff --git a/cmd/api/config/jwt_test.go b/cmd/api/config/jwt_test.go index 7a2242ecb..881006427 100644 --- a/cmd/api/config/jwt_test.go +++ b/cmd/api/config/jwt_test.go @@ -50,8 +50,22 @@ func TestLoadJWTVerificationSecretsRejectsInvalidEnv(t *testing.T) { } } -func TestValidateJWTVerificationSecretsRejectsEmptyEntry(t *testing.T) { - cfg := defaultConfig() - cfg.JwtVerificationSecrets = []string{"old", ""} - require.ErrorContains(t, cfg.Validate(), "entry 1 must not be empty") +func TestValidateJWTVerificationSecretsRejectsUnusableEntry(t *testing.T) { + for _, tc := range []struct { + name string + secrets []string + want string + }{ + {"empty", []string{"old", ""}, "entry 1 must not be empty"}, + {"single published placeholder", []string{"dev-secret-change-me"}, "entry 0"}, + {"placeholder after a real key", []string{"old", "secret"}, "entry 1"}, + } { + t.Run(tc.name, func(t *testing.T) { + cfg := defaultConfig() + cfg.JwtVerificationSecrets = tc.secrets + err := cfg.Validate() + require.ErrorContains(t, err, tc.want) + assert.NotContains(t, err.Error(), "dev-secret-change-me") + }) + } } diff --git a/lib/jwtauth/verifier.go b/lib/jwtauth/verifier.go index 464d2edb3..0cfaab490 100644 --- a/lib/jwtauth/verifier.go +++ b/lib/jwtauth/verifier.go @@ -5,6 +5,7 @@ import ( "context" "errors" "fmt" + "strings" "github.com/golang-jwt/jwt/v5" "go.opentelemetry.io/otel/attribute" @@ -18,14 +19,34 @@ type Verifier struct { validations metric.Int64Counter } +// weakSecrets are placeholders published in the example configs; tokens signed +// with one are forgeable by anyone who has read the repository. +var weakSecrets = map[string]struct{}{ + "dev-secret-change-me": {}, + "change-me": {}, + "changeme": {}, + "your-secret-here": {}, + "jwt-secret": {}, + "secret": {}, + "password": {}, +} + +// IsWeakSecret reports whether secret is empty or a published placeholder. +func IsWeakSecret(secret string) bool { + _, weak := weakSecrets[strings.ToLower(strings.TrimSpace(secret))] + return secret == "" || weak +} + func NewVerifier(signingSecret string, verificationSecrets []string, meter metric.Meter) (*Verifier, error) { - if signingSecret == "" { - return nil, errors.New("JWT_SECRET must be set") + if IsWeakSecret(signingSecret) { + return nil, errors.New("JWT_SECRET must be a unique random value; the configured secret is empty or published in the examples") } keys := [][]byte{[]byte(signingSecret)} for i, secret := range verificationSecrets { - if secret == "" { - return nil, fmt.Errorf("jwt_verification_secrets entry %d must not be empty", i) + // Every fallback key is tried for every token, so a value published in the + // examples would let anyone who read the repository mint accepted tokens. + if IsWeakSecret(secret) { + return nil, fmt.Errorf("jwt_verification_secrets entry %d must not be empty or a value published in the examples; a published value cannot be a verification key", i) } keys = append(keys, []byte(secret)) } diff --git a/lib/jwtauth/verifier_test.go b/lib/jwtauth/verifier_test.go index 0b282cb66..1b5d316c8 100644 --- a/lib/jwtauth/verifier_test.go +++ b/lib/jwtauth/verifier_test.go @@ -134,3 +134,26 @@ func TestVerifierMetricsConcurrent(t *testing.T) { } assert.Equal(t, map[string]int64{"primary": 10, "fallback": 10}, counts) } + +func TestVerifierRejectsPublishedPlaceholderVerificationSecrets(t *testing.T) { + for _, placeholder := range []string{"dev-secret-change-me", "secret", " Change-Me ", "jwt-secret"} { + verifier, err := NewVerifier("a-unique-random-primary", []string{"old", placeholder}, noop.NewMeterProvider().Meter("test")) + require.Nil(t, verifier) + require.Error(t, err) + assert.Contains(t, err.Error(), "entry 1") + assert.NotContains(t, err.Error(), "dev-secret-change-me") + } +} + +func TestVerifierAcceptsStrongVerificationSecret(t *testing.T) { + verifier, err := NewVerifier("a-unique-random-primary", []string{"9f3c1d7e5b2a4c60"}, noop.NewMeterProvider().Meter("test")) + require.NoError(t, err) + token, err := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ + "sub": "user", "exp": time.Now().Add(time.Hour).Unix(), + }).SignedString([]byte("9f3c1d7e5b2a4c60")) + require.NoError(t, err) + claims := jwt.MapClaims{} + _, err = verifier.ParseWithClaims(context.Background(), token, claims) + require.NoError(t, err) + assert.Equal(t, "user", claims["sub"]) +}