Take the master key from KEEPORG_MASTER_KEY_FILE
Why: the usual way to hand a secret to a container is to mount it as a file and name the path in the environment. Compose, swarm and Kubernetes all do it that way, and it keeps the key out of the process environment and off any disk the container can write. What: the master key is now looked for in KEEPORG_MASTER_KEY, then KEEPORG_MASTER_KEY_FILE, then the configured master_key_file. A secret file may hold base64, with or without padding or a trailing newline, or exactly 32 raw bytes, because secret stores produce both. Only the configured path is ever created, which is what keeps a plain package install working with no setup. The two environment variables name a key something else owns, so a missing one is reported and vault creation refused. Minting a replacement there would be worse than failing: it opens none of the existing vaults, and the mistake would otherwise surface one failed merge at a time. The compose example now provisions the key as a real secret rather than an environment variable, and the Dockerfile and README show the same. Neither names a version any more, so they stop drifting as the server is bumped. Proved: unit tests for every source and precedence, all four accepted encodings, and that a missing secret writes nothing anywhere. In real containers: a podman secret carrying base64 survives a stop and start with "1 vault keys available for merging" and merges a stale push afterwards; a secret holding 32 raw bytes creates a vault; and a secret that failed to mount is named in the startup log, with vault creation answering with the three places a key may come from.
This commit is contained in:
+71
-17
@@ -15,37 +15,73 @@ import (
|
||||
// a vault: it can decrypt a vault, so it holds that vault's key.
|
||||
//
|
||||
// The wrapped secrets live in the server's state document; the key that
|
||||
// unwraps them does not. It comes from the environment or from a file
|
||||
// outside the data directory, so a copy of the data directory alone yields
|
||||
// ciphertext. Whoever holds both holds the vaults.
|
||||
// unwraps them does not. It comes from the environment, from a secret file
|
||||
// an orchestrator provisioned, or from a file outside the data directory,
|
||||
// so a copy of the data directory alone yields ciphertext. Whoever holds
|
||||
// both holds the vaults.
|
||||
type Keyring struct {
|
||||
aead cipher.AEAD
|
||||
}
|
||||
|
||||
// MasterKeyEnv names the environment variable holding a base64 master key,
|
||||
// which takes precedence over the key file.
|
||||
const MasterKeyEnv = "KEEPORG_MASTER_KEY"
|
||||
// Environment variables that supply the master key. Both are read before
|
||||
// any configured path.
|
||||
const (
|
||||
// MasterKeyEnv holds the base64 key itself.
|
||||
MasterKeyEnv = "KEEPORG_MASTER_KEY"
|
||||
// MasterKeyFileEnv holds the path to a file containing it, which is how
|
||||
// a container runtime or an orchestrator hands over a provisioned
|
||||
// secret without putting it in the process environment.
|
||||
MasterKeyFileEnv = "KEEPORG_MASTER_KEY_FILE"
|
||||
)
|
||||
|
||||
// LoadKeyring reads the master key from the environment or from path,
|
||||
// creating one at path if neither exists.
|
||||
// keySize is the master key length in bytes.
|
||||
const keySize = 32
|
||||
|
||||
// LoadKeyring finds the master key, in this order:
|
||||
//
|
||||
// 1. $KEEPORG_MASTER_KEY, the base64 key itself.
|
||||
// 2. $KEEPORG_MASTER_KEY_FILE, a path to a provisioned secret. It must
|
||||
// already exist: something else owns that file, so a missing one is a
|
||||
// misconfiguration to report, not a reason to mint a new key that would
|
||||
// fail to open any existing vault.
|
||||
// 3. path, from -master-key-file or master_key_file in the configuration.
|
||||
// This one is created on first run if it is absent, which is what makes
|
||||
// a plain package install work with no setup.
|
||||
//
|
||||
// A file may hold the key as base64 text, with or without a trailing
|
||||
// newline, or as exactly 32 raw bytes, because secret stores produce both.
|
||||
func LoadKeyring(path string) (*Keyring, error) {
|
||||
if v := strings.TrimSpace(os.Getenv(MasterKeyEnv)); v != "" {
|
||||
key, err := base64.StdEncoding.DecodeString(v)
|
||||
key, err := decodeKey([]byte(v))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("secret: %s is not valid base64: %w", MasterKeyEnv, err)
|
||||
return nil, fmt.Errorf("secret: $%s: %w", MasterKeyEnv, err)
|
||||
}
|
||||
return NewKeyring(key)
|
||||
}
|
||||
|
||||
if p := strings.TrimSpace(os.Getenv(MasterKeyFileEnv)); p != "" {
|
||||
b, err := os.ReadFile(p)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("secret: $%s points at %s: %w",
|
||||
MasterKeyFileEnv, p, err)
|
||||
}
|
||||
key, err := decodeKey(b)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("secret: $%s file %s: %w", MasterKeyFileEnv, p, err)
|
||||
}
|
||||
return NewKeyring(key)
|
||||
}
|
||||
|
||||
if path == "" {
|
||||
return nil, errors.New("secret: no master key: set " + MasterKeyEnv +
|
||||
" or configure master_key_file")
|
||||
return nil, errors.New("secret: no master key: set $" + MasterKeyEnv +
|
||||
", $" + MasterKeyFileEnv + ", or configure master_key_file")
|
||||
}
|
||||
b, err := os.ReadFile(path)
|
||||
switch {
|
||||
case err == nil:
|
||||
key, derr := base64.StdEncoding.DecodeString(strings.TrimSpace(string(b)))
|
||||
key, derr := decodeKey(b)
|
||||
if derr != nil {
|
||||
return nil, fmt.Errorf("secret: master key file %s is not valid base64: %w", path, derr)
|
||||
return nil, fmt.Errorf("secret: master key file %s: %w", path, derr)
|
||||
}
|
||||
return NewKeyring(key)
|
||||
case !os.IsNotExist(err):
|
||||
@@ -53,7 +89,7 @@ func LoadKeyring(path string) (*Keyring, error) {
|
||||
}
|
||||
// First run: mint one. It is written with owner-only permissions and is
|
||||
// the one file an operator must back up separately from the data.
|
||||
key := randBytes(32)
|
||||
key := randBytes(keySize)
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -64,10 +100,28 @@ func LoadKeyring(path string) (*Keyring, error) {
|
||||
return NewKeyring(key)
|
||||
}
|
||||
|
||||
// decodeKey accepts the shapes a provisioned secret arrives in: exactly 32
|
||||
// raw bytes, or base64 text with or without padding and trailing newline.
|
||||
func decodeKey(b []byte) ([]byte, error) {
|
||||
if len(b) == keySize {
|
||||
return b, nil
|
||||
}
|
||||
text := strings.TrimSpace(string(b))
|
||||
if key, err := base64.StdEncoding.DecodeString(text); err == nil {
|
||||
return key, nil
|
||||
}
|
||||
if key, err := base64.RawStdEncoding.DecodeString(text); err == nil {
|
||||
return key, nil
|
||||
}
|
||||
return nil, fmt.Errorf("expected %d raw bytes or a base64 key, got %d bytes "+
|
||||
"that are neither", keySize, len(b))
|
||||
}
|
||||
|
||||
// NewKeyring builds a keyring from a 32-byte key.
|
||||
func NewKeyring(key []byte) (*Keyring, error) {
|
||||
if len(key) != 32 {
|
||||
return nil, fmt.Errorf("secret: master key must be 32 bytes, got %d", len(key))
|
||||
if len(key) != keySize {
|
||||
return nil, fmt.Errorf("secret: master key must be %d bytes, got %d",
|
||||
keySize, len(key))
|
||||
}
|
||||
block, err := aes.NewCipher(key)
|
||||
if err != nil {
|
||||
|
||||
Reference in New Issue
Block a user