Refactor encryption key handling: auto-generate if not provided, update README and tests

This commit is contained in:
2025-10-11 21:18:24 +02:00
parent d40321685e
commit 62605b3689
6 changed files with 170 additions and 32 deletions

View File

@@ -9,12 +9,14 @@ import (
)
const (
// JWTKeyBytes is the size of the JWT signing key in bytes (256 bits)
JWTKeyBytes = 32
// KeyBytes is the size of keys in bytes (256 bits)
KeyBytes = 32
// JWTKeyFile is the filename for the JWT signing key
JWTKeyFile = "jwt_signing_key"
// JWTKeyPerm is the file permission for the JWT signing key (owner read/write only)
JWTKeyPerm = 0600
// EncryptionKeyFile is the filename for the encryption key
EncryptionKeyFile = "encryption_key"
// KeyPerm is the file permission for secret keys (owner read/write only)
KeyPerm = 0600
)
// EnsureJWTSigningKey ensures a JWT signing key exists in the secrets directory.
@@ -55,12 +57,12 @@ func EnsureJWTSigningKey(secretsDir string) (string, error) {
}
// Write the key to the file with restrictive permissions
if err := os.WriteFile(keyPath, []byte(key), JWTKeyPerm); err != nil {
if err := os.WriteFile(keyPath, []byte(key), KeyPerm); err != nil {
return "", fmt.Errorf("failed to write JWT signing key: %w", err)
}
// Double-check permissions (some systems might ignore mode in WriteFile)
if err := os.Chmod(keyPath, JWTKeyPerm); err != nil {
if err := os.Chmod(keyPath, KeyPerm); err != nil {
return "", fmt.Errorf("failed to set JWT signing key permissions: %w", err)
}
@@ -70,7 +72,70 @@ func EnsureJWTSigningKey(secretsDir string) (string, error) {
// generateJWTSigningKey generates a cryptographically secure random signing key
func generateJWTSigningKey() (string, error) {
keyBytes := make([]byte, JWTKeyBytes)
keyBytes := make([]byte, KeyBytes)
if _, err := rand.Read(keyBytes); err != nil {
return "", fmt.Errorf("failed to generate random bytes: %w", err)
}
// Encode to base64 for easy storage and handling
key := base64.StdEncoding.EncodeToString(keyBytes)
return key, nil
}
// EnsureEncryptionKey ensures an encryption key exists in the secrets directory.
// If no key exists, it generates and stores a new one with restrictive permissions.
// Returns the base64-encoded encryption key.
func EnsureEncryptionKey(secretsDir string) (string, error) {
log := getLogger()
// Ensure the secrets directory exists with restrictive permissions
if err := os.MkdirAll(secretsDir, 0700); err != nil {
return "", fmt.Errorf("failed to create secrets directory: %w", err)
}
keyPath := filepath.Join(secretsDir, EncryptionKeyFile)
// Check if the key file already exists
if _, err := os.Stat(keyPath); err == nil {
// Key file exists, read it
keyBytes, err := os.ReadFile(keyPath)
if err != nil {
return "", fmt.Errorf("failed to read encryption key: %w", err)
}
key := string(keyBytes)
if key == "" {
return "", fmt.Errorf("encryption key file is empty")
}
log.Debug("loaded existing encryption key from file")
return key, nil
}
// Key file doesn't exist, generate a new key
log.Info("generating new encryption key")
key, err := generateEncryptionKey()
if err != nil {
return "", fmt.Errorf("failed to generate encryption key: %w", err)
}
// Write the key to the file with restrictive permissions
if err := os.WriteFile(keyPath, []byte(key), KeyPerm); err != nil {
return "", fmt.Errorf("failed to write encryption key: %w", err)
}
// Double-check permissions (some systems might ignore mode in WriteFile)
if err := os.Chmod(keyPath, KeyPerm); err != nil {
return "", fmt.Errorf("failed to set encryption key permissions: %w", err)
}
log.Info("encryption key generated and stored", "path", keyPath)
return key, nil
}
// generateEncryptionKey generates a cryptographically secure random encryption key
func generateEncryptionKey() (string, error) {
keyBytes := make([]byte, KeyBytes)
if _, err := rand.Read(keyBytes); err != nil {
return "", fmt.Errorf("failed to generate random bytes: %w", err)
}