fix(secrets): persist concrete backend ownership #1225
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| package secrets | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "filippo.io/age" | ||
| ) | ||
|
|
||
| type backendRegistry interface { | ||
| Open(kind Backend, idx *index, create bool) (backend, error) | ||
| ResolveForNewSecret(preference Backend, idx *index) (Backend, error) | ||
| } | ||
|
|
||
| type fixedBackendRegistry struct{ b backend } | ||
|
|
||
| func (r fixedBackendRegistry) Open(_ Backend, _ *index, _ bool) (backend, error) { return r.b, nil } | ||
| func (r fixedBackendRegistry) ResolveForNewSecret(_ Backend, _ *index) (Backend, error) { | ||
| return BackendKeyring, nil | ||
| } | ||
|
|
||
| type systemBackendRegistry struct{ dir string } | ||
|
|
||
| func newSystemBackendRegistry( | ||
| dir string, | ||
| ) backendRegistry { | ||
| return &systemBackendRegistry{dir: dir} | ||
| } | ||
|
|
||
| func (r *systemBackendRegistry) Open(kind Backend, idx *index, create bool) (backend, error) { | ||
| switch kind { | ||
| case BackendKeyring: | ||
| return keyringBackend{}, nil | ||
| case BackendFile: | ||
| var key *fileKey | ||
| var err error | ||
| if create { | ||
| key, err = resolveFileKey(r.dir, os.Getenv(EnvPassphrase)) | ||
| } else { | ||
| key, err = openExistingFileKey(r.dir, idx) | ||
|
Comment on lines
+38
to
+42
There was a problem hiding this comment.
When an existing file-owned secret is updated, |
||
| } | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if create && idx != nil { | ||
| idx.data.KeySource = string(key.source) | ||
| } | ||
| return newFileBackend(filepath.Join(r.dir, EncryptedFileName), key), nil | ||
| default: | ||
| return nil, fmt.Errorf("invalid secrets backend %q", kind) | ||
| } | ||
| } | ||
|
|
||
| func (r *systemBackendRegistry) ResolveForNewSecret( | ||
| preference Backend, | ||
| idx *index, | ||
| ) (Backend, error) { | ||
| switch preference { | ||
| case BackendKeyring: | ||
| return BackendKeyring, nil | ||
| case BackendFile: | ||
| return BackendFile, nil | ||
| case BackendAuto: | ||
| if keyringAvailable() { | ||
| return BackendKeyring, nil | ||
| } | ||
| return BackendFile, nil | ||
| default: | ||
| return "", fmt.Errorf("invalid secrets backend %q", preference) | ||
| } | ||
| } | ||
|
|
||
| func openExistingFileKey(dir string, idx *index) (*fileKey, error) { | ||
| source := keySource(idx.data.KeySource) | ||
| if source == "" { | ||
| return nil, fmt.Errorf("encrypted secrets are missing their key source metadata") | ||
| } | ||
| if source == keySourcePassphrase { | ||
| return openPassphraseFileKey() | ||
| } | ||
| var store keyStore | ||
| switch source { | ||
| case keySourceKeyring: | ||
| store = keyringKeyStore{} | ||
| case keySourceAutoFile: | ||
| store = fileKeyStore{path: filepath.Join(dir, KeyFileName)} | ||
| default: | ||
| return nil, fmt.Errorf("invalid secrets key source %q", source) | ||
| } | ||
| return keyFromStore(store, source) | ||
| } | ||
|
|
||
| func openPassphraseFileKey() (*fileKey, error) { | ||
| passphrase := os.Getenv(EnvPassphrase) | ||
| if passphrase == "" { | ||
| return nil, fmt.Errorf("encrypted secrets require %s", EnvPassphrase) | ||
| } | ||
| recipient, err := age.NewScryptRecipient(passphrase) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| identity, err := age.NewScryptIdentity(passphrase) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &fileKey{recipient: recipient, identity: identity, source: keySourcePassphrase}, nil | ||
| } | ||
|
|
||
| func keyFromStore(store keyStore, source keySource) (*fileKey, error) { | ||
| encoded, err := store.load() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if strings.TrimSpace(encoded) == "" { | ||
| return nil, ErrSecretNotFound | ||
| } | ||
| identity, err := age.ParseX25519Identity(strings.TrimSpace(encoded)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("parse stored secrets key: %w", err) | ||
| } | ||
| return &fileKey{recipient: identity.Recipient(), identity: identity, source: source}, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Cover
secretsErrortransitions in both store paths.SecretsPage.sveltedisplays the error banner from$secretsError, butsecrets.test.tsnever imports or assertssecretsError. Add rejection-then-success cases for bothinitSecrets()andrefreshSecrets()to assert that the error message is recorded and then cleared.🤖 Prompt for AI Agents