Skip to content

Modern Docker Management, Designed for Everyone

fix: clear / check for default jwt secret

Kyle Mendellae914bdced85
diff --git a/backend/internal/services/auth_service.go b/backend/internal/services/auth_service.go
index 2752106d8..f01b76ae7 100644
--- a/backend/internal/services/auth_service.go
+++ b/backend/internal/services/auth_service.go
@@ -82,12 +82,15 @@ type AuthService struct {
}
func NewAuthService(userService *UserService, settingsService *SettingsService, eventService *EventService, sessionService *SessionService, jwtSecret string, cfg *config.Config) *AuthService {
+ // Production managers must supply an explicit, non-default JWT_SECRET (fail
+ // closed, mirroring the ENCRYPTION_KEY guard). Dev and agent mode auto-generate.
+ requireExplicitSecret := cfg.Environment == config.AppEnvironmentProduction && !cfg.AgentMode
return &AuthService{
userService: userService,
settingsService: settingsService,
eventService: eventService,
sessionService: sessionService,
- jwtSecret: jwtclaims.CheckOrGenerateJwtSecret(jwtSecret),
+ jwtSecret: jwtclaims.CheckOrGenerateJwtSecret(jwtSecret, requireExplicitSecret),
refreshExpiry: cfg.JWTRefreshExpiry,
config: cfg,
tokenCache: cache.NewTTL[verifiedTokenEntry](15 * time.Second),
diff --git a/backend/pkg/utils/jwtclaims/jwt.go b/backend/pkg/utils/jwtclaims/jwt.go
index 9b0bb992f..64a00b390 100644
--- a/backend/pkg/utils/jwtclaims/jwt.go
+++ b/backend/pkg/utils/jwtclaims/jwt.go
@@ -83,19 +83,45 @@ func GetStringSliceClaim(m map[string]any, key string) []string {
return nil
}
-// CheckOrGenerateJwtSecret verifies a secret exists or generates a random one
-func CheckOrGenerateJwtSecret(jwtSecret string) []byte {
- var secretBytes []byte
- if jwtSecret != "" {
- secretBytes = []byte(jwtSecret)
- return secretBytes
- } else {
- secretBytes = make([]byte, 32)
+const (
+ // KnownInsecureJWTSecret is the placeholder shipped in config.go's struct
+ // tag; it must never sign real tokens. Keep in sync with the `default:` tag
+ // on Config.JWTSecret.
+ KnownInsecureJWTSecret = "default-jwt-secret-change-me"
+ // MinJWTSecretLength matches the 32-byte floor enforced for ENCRYPTION_KEY.
+ MinJWTSecretLength = 32
+)
+
+// CheckOrGenerateJwtSecret returns the HMAC signing key for JWTs.
+//
+// When requireExplicit is true (production manager), a real secret is mandatory:
+// an empty, default, or too-short JWT_SECRET panics at startup — mirroring the
+// ENCRYPTION_KEY guard in libarcane/crypto. Otherwise (development / agent mode)
+// a random per-boot key is generated when none (or only the public default) is
+// configured, so the public default never becomes a live signing key.
+func CheckOrGenerateJwtSecret(jwtSecret string, requireExplicit bool) []byte {
+ isDefault := jwtSecret == "" || jwtSecret == KnownInsecureJWTSecret
+
+ if requireExplicit {
+ if isDefault {
+ panic("JWT_SECRET is required in production. Set JWT_SECRET to a unique " +
+ "random value of at least 32 characters (e.g. `openssl rand -base64 32`).")
+ }
+ if len(jwtSecret) < MinJWTSecretLength {
+ panic(fmt.Sprintf("JWT_SECRET must be at least %d characters (got %d).",
+ MinJWTSecretLength, len(jwtSecret)))
+ }
+ return []byte(jwtSecret)
+ }
+
+ if isDefault {
+ secretBytes := make([]byte, 32)
if _, err := rand.Read(secretBytes); err != nil {
panic(fmt.Errorf("failed to generate random JWT secret: %w", err))
}
+ return secretBytes
}
- return secretBytes
+ return []byte(jwtSecret)
}
// ParseJWTClaims decodes and unmarshals the payload part of a JWT
diff --git a/backend/pkg/utils/jwtclaims/jwt_test.go b/backend/pkg/utils/jwtclaims/jwt_test.go
new file mode 100644
index 000000000..eb6a3ed5a
--- /dev/null
+++ b/backend/pkg/utils/jwtclaims/jwt_test.go
@@ -0,0 +1,23 @@
+package jwtclaims
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+)
+
+func TestCheckOrGenerateJwtSecret(t *testing.T) {
+ // Production (requireExplicit) must reject empty, the public default, and short secrets.
+ assert.Panics(t, func() { CheckOrGenerateJwtSecret("", true) })
+ assert.Panics(t, func() { CheckOrGenerateJwtSecret(KnownInsecureJWTSecret, true) })
+ assert.Panics(t, func() { CheckOrGenerateJwtSecret("too-short", true) })
+
+ // Production accepts a real secret verbatim.
+ good := "a-sufficiently-long-jwt-secret-value-1234" // >= 32 chars
+ assert.Equal(t, []byte(good), CheckOrGenerateJwtSecret(good, true))
+
+ // Development / agent mode replaces the public default with a random key.
+ got := CheckOrGenerateJwtSecret(KnownInsecureJWTSecret, false)
+ assert.Len(t, got, 32)
+ assert.NotEqual(t, []byte(KnownInsecureJWTSecret), got)
+}
diff --git a/docker/examples/compose.basic.yaml b/docker/examples/compose.basic.yaml
index 8b84d82c0..46dc9ab2f 100644
--- a/docker/examples/compose.basic.yaml
+++ b/docker/examples/compose.basic.yaml
@@ -10,8 +10,8 @@ services:
- /host/path/to/projects:/app/data/projects
- /host/path/to/builds:/builds
environment:
- - ENCRYPTION_KEY=xxxxxxxxxxxxxxxxxxxxxx
- - JWT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxx
+ - ENCRYPTION_KEY=replace_me_with_a_random_32_char_value
+ - JWT_SECRET=replace_me_with_a_random_32_char_value
# Optional: run Arcane as a specific host UID/GID instead of the default runtime user.
# When using the mounted Docker socket, Arcane will map the socket group automatically.
# - PUID=1000
diff --git a/docker/examples/compose.proxy.yaml b/docker/examples/compose.proxy.yaml
index 8c5793c11..de8c8ff35 100644
--- a/docker/examples/compose.proxy.yaml
+++ b/docker/examples/compose.proxy.yaml
@@ -45,8 +45,8 @@ services:
volumes:
- arcane-data:/app/data
environment:
- - ENCRYPTION_KEY=xxxxxxxxxxxxxxxxxxxxxx
- - JWT_SECRET=xxxxxxxxxxxxxxxxxxxxxx
+ - ENCRYPTION_KEY=replace_me_with_a_random_32_char_value
+ - JWT_SECRET=replace_me_with_a_random_32_char_value
# Optional: run Arcane as a specific host UID/GID instead of the default runtime user.
# With DOCKER_HOST over TCP, no Unix socket group mapping is needed.
# - PUID=1000