Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
952627fd51 |
@@ -25,13 +25,12 @@ Bring the repo into policy compliance in one commit:
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-03: `version rm`, `version promote` and `get --version`
|
- 2026-10-03: A PGP unlocker whose metadata has no usable GPG key ID
|
||||||
accept a version only if it is one of the versions `version list`
|
no longer panics: `GetID()` warns with the unlocker's directory and
|
||||||
lists for that secret, compared as typed before any path is built
|
returns `pgp-unknown`. `ListUnlockers` skips, with a warning, an
|
||||||
(`secret.VersionExists`), and touch nothing otherwise. An empty
|
unlocker whose metadata file cannot be read or parsed instead of
|
||||||
`--version` is rejected instead of meaning the current version.
|
failing, so `secret unlocker list` still lists the others; the
|
||||||
Before, `secret version rm x ../../..` deleted the whole vault,
|
listing's ID lookup no longer warns about that directory again.
|
||||||
`secret version rm x ..` the secret, and `.` or `""` every version.
|
|
||||||
- 2026-10-03: Key material is wiped on every exit: `Entry()` returns
|
- 2026-10-03: Key material is wiped on every exit: `Entry()` returns
|
||||||
the exit code after its deferred `memguard.Purge()` has run, and only
|
the exit code after its deferred `memguard.Purge()` has run, and only
|
||||||
`main` calls `os.Exit`. SIGINT and SIGTERM go through memguard's
|
`main` calls `os.Exit`. SIGINT and SIGTERM go through memguard's
|
||||||
@@ -125,8 +124,6 @@ Bring the repo into policy compliance in one commit:
|
|||||||
- Timing attacks: bytes.Equal passphrase compare (cli/init.go:
|
- Timing attacks: bytes.Equal passphrase compare (cli/init.go:
|
||||||
209-216); non-constant-time public key compare (vault.go:95-100).
|
209-216); non-constant-time public key compare (vault.go:95-100).
|
||||||
- High priority:
|
- High priority:
|
||||||
- Return errors instead of panicking on corrupted metadata
|
|
||||||
(pgpunlocker.go:116, keychainunlocker.go:141).
|
|
||||||
- Secure temporary file handling and cleanup.
|
- Secure temporary file handling and cleanup.
|
||||||
- Print cobra usage only for argument errors, not internal
|
- Print cobra usage only for argument errors, not internal
|
||||||
failures.
|
failures.
|
||||||
|
|||||||
@@ -829,14 +829,6 @@ func test09GetSpecificVersion(t *testing.T, tempDir, testMnemonic string, runSec
|
|||||||
|
|
||||||
require.NoError(t, err, "get current version should succeed")
|
require.NoError(t, err, "get current version should succeed")
|
||||||
assert.Equal(t, "newpassword456", strings.TrimSpace(output), "should return new secret value without --version")
|
assert.Equal(t, "newpassword456", strings.TrimSpace(output), "should return new secret value without --version")
|
||||||
|
|
||||||
// An empty --version is not a version; it does not mean the current one
|
|
||||||
output, err = runSecretWithEnv(map[string]string{
|
|
||||||
secret.EnvMnemonic: testMnemonic,
|
|
||||||
}, "get", "--version", "", "database/password")
|
|
||||||
|
|
||||||
require.Error(t, err, "get with an empty version should fail")
|
|
||||||
assert.Contains(t, output, "version '' not found", "should reject the empty version")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func test10PromoteVersion(t *testing.T, tempDir, testMnemonic string, runSecret func(...string) (string, error), runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
func test10PromoteVersion(t *testing.T, tempDir, testMnemonic string, runSecret func(...string) (string, error), runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
package cli_test
|
package cli_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"maps"
|
"maps"
|
||||||
"os"
|
"os"
|
||||||
"slices"
|
"slices"
|
||||||
@@ -120,13 +119,13 @@ func newFsFromSnapshot(t *testing.T, tree map[string]string) afero.Fs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// requireRejectedAndUnchanged runs a command on a copy of the state
|
// requireRejectedAndUnchanged runs a command on a copy of the state
|
||||||
// directory recorded in before. It requires an error with exactly the
|
// directory recorded in before. It requires exactly the error
|
||||||
// message of want, so that a later check rejecting the argument does not
|
// vault.ValidateSecretName gives for the rejected name, so that a later
|
||||||
// count, and everything under the state directory as it was: the error
|
// check rejecting the name does not count, and everything under the state
|
||||||
// alone proves nothing, since it could come after the vault had already
|
// directory as it was: the error alone proves nothing, since it could come
|
||||||
// been deleted.
|
// after the vault had already been deleted.
|
||||||
func requireRejectedAndUnchanged(
|
func requireRejectedAndUnchanged(
|
||||||
t *testing.T, before map[string]string, want error,
|
t *testing.T, before map[string]string, rejected string,
|
||||||
run func(c *cli.Instance) error,
|
run func(c *cli.Instance) error,
|
||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
@@ -136,7 +135,8 @@ func requireRejectedAndUnchanged(
|
|||||||
err := run(cli.NewCLIInstanceWithStateDir(fs, testStateDir))
|
err := run(cli.NewCLIInstanceWithStateDir(fs, testStateDir))
|
||||||
|
|
||||||
require.Equal(t, before, snapshotStateDir(t, fs))
|
require.Equal(t, before, snapshotStateDir(t, fs))
|
||||||
require.EqualError(t, err, want.Error())
|
require.ErrorIs(t, err, vault.ErrInvalidSecretName)
|
||||||
|
require.EqualError(t, err, vault.ValidateSecretName(rejected).Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestInvalidSecretNameLeavesVaultsUnchanged is a regression test for
|
// TestInvalidSecretNameLeavesVaultsUnchanged is a regression test for
|
||||||
@@ -229,92 +229,11 @@ func TestInvalidSecretNameLeavesVaultsUnchanged(t *testing.T) {
|
|||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.command, func(t *testing.T) {
|
t.Run(tt.command, func(t *testing.T) {
|
||||||
requireRejectedAndUnchanged(t, before, vault.ValidateSecretName(tt.rejected), tt.run)
|
requireRejectedAndUnchanged(t, before, tt.rejected, tt.run)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestInvalidVersionLeavesVaultsUnchanged is a regression test for
|
|
||||||
// https://git.eeqj.de/sneak/secret/issues/67, where
|
|
||||||
// `secret version rm x ../../..` deleted the whole vault,
|
|
||||||
// `secret version rm x ..` the secret x, and `secret version rm x .` or
|
|
||||||
// `secret version rm x ""` every version of x. A version argument is
|
|
||||||
// accepted only if it is one of the versions `secret version list` lists.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // newTwoVaultFs uses t.Setenv
|
|
||||||
func TestInvalidVersionLeavesVaultsUnchanged(t *testing.T) {
|
|
||||||
before := snapshotStateDir(t, newTwoVaultFs(t))
|
|
||||||
|
|
||||||
cmd := &cobra.Command{}
|
|
||||||
|
|
||||||
commands := []struct {
|
|
||||||
command string
|
|
||||||
run func(c *cli.Instance, version string) error
|
|
||||||
}{
|
|
||||||
{"version rm x", func(c *cli.Instance, version string) error {
|
|
||||||
return c.RemoveVersion(cmd, "x", version)
|
|
||||||
}},
|
|
||||||
{"version promote x", func(c *cli.Instance, version string) error {
|
|
||||||
return c.PromoteVersion(cmd, "x", version)
|
|
||||||
}},
|
|
||||||
{"get x --version", func(c *cli.Instance, version string) error {
|
|
||||||
return c.GetSecretWithVersion(cmd, "x", version)
|
|
||||||
}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range commands {
|
|
||||||
for _, version := range []string{"", ".", "..", "../../..", "a/b"} {
|
|
||||||
t.Run(fmt.Sprintf("%s %q", tt.command, version), func(t *testing.T) {
|
|
||||||
want := fmt.Errorf("version '%s' %w '%s'",
|
|
||||||
version, vault.ErrVersionNotFound, "x")
|
|
||||||
requireRejectedAndUnchanged(t, before, want,
|
|
||||||
func(c *cli.Instance) error { return tt.run(c, version) })
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRemoveVersionRemovesOnlyThatVersion checks that `secret version rm`
|
|
||||||
// with a version that is not the current one removes that version and
|
|
||||||
// changes nothing else.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // newTwoVaultFs uses t.Setenv
|
|
||||||
func TestRemoveVersionRemovesOnlyThatVersion(t *testing.T) {
|
|
||||||
fs := newTwoVaultFs(t)
|
|
||||||
|
|
||||||
vlt, err := vault.GetCurrentVault(fs, testStateDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// A second version of "x" becomes the current one.
|
|
||||||
err = vlt.AddSecret("x", memguard.NewBufferFromBytes([]byte("new")), true)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
secretDir := testStateDir + "/vaults.d/default/secrets.d/x"
|
|
||||||
versions, err := secret.ListVersions(fs, secretDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, versions, 2)
|
|
||||||
|
|
||||||
// ListVersions lists the newest version first.
|
|
||||||
oldDir := secretDir + "/versions/" + versions[1] + "/"
|
|
||||||
before := snapshotStateDir(t, fs)
|
|
||||||
require.Contains(t, before, oldDir)
|
|
||||||
|
|
||||||
c := cli.NewCLIInstanceWithStateDir(fs, testStateDir)
|
|
||||||
err = c.RemoveVersion(&cobra.Command{}, "x", versions[1])
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Expected: the state as before without everything under oldDir.
|
|
||||||
want := map[string]string{}
|
|
||||||
|
|
||||||
for path, content := range before {
|
|
||||||
if !strings.HasPrefix(path, oldDir) {
|
|
||||||
want[path] = content
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
require.Equal(t, want, snapshotStateDir(t, fs))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestMoveToVaultNameRenamesInCurrentVault checks that `secret mv x work`,
|
// TestMoveToVaultNameRenamesInCurrentVault checks that `secret mv x work`,
|
||||||
// where "work" is also the name of a vault, renames the secret "x" to "work"
|
// where "work" is also the name of a vault, renames the secret "x" to "work"
|
||||||
// in the current vault and changes nothing else.
|
// in the current vault and changes nothing else.
|
||||||
|
|||||||
+10
-30
@@ -109,12 +109,6 @@ func newGetCmd() *cobra.Command {
|
|||||||
return fmt.Errorf("failed to initialize CLI: %w", err)
|
return fmt.Errorf("failed to initialize CLI: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Without --version, get the current version. A given
|
|
||||||
// --version is checked as typed, so an empty one is rejected.
|
|
||||||
if !cmd.Flags().Changed("version") {
|
|
||||||
return cli.GetSecret(cmd, args[0])
|
|
||||||
}
|
|
||||||
|
|
||||||
return cli.GetSecretWithVersion(cmd, args[0], version)
|
return cli.GetSecretWithVersion(cmd, args[0], version)
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -399,32 +393,12 @@ func (cli *Instance) AddSecret(secretName string, force bool) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecret retrieves and prints the current version of a secret
|
// GetSecret retrieves and prints a secret from the current vault
|
||||||
func (cli *Instance) GetSecret(cmd *cobra.Command, secretName string) error {
|
func (cli *Instance) GetSecret(cmd *cobra.Command, secretName string) error {
|
||||||
secret.Debug("GetSecret called", "secretName", secretName)
|
return cli.GetSecretWithVersion(cmd, secretName, "")
|
||||||
|
|
||||||
// Store the command for output
|
|
||||||
cli.cmd = cmd
|
|
||||||
|
|
||||||
// Get current vault
|
|
||||||
vlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
value, err := vlt.GetSecret(secretName)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print the secret value to stdout
|
|
||||||
_, _ = cli.Print(string(value))
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecretWithVersion retrieves and prints a specific version of a secret.
|
// GetSecretWithVersion retrieves and prints a specific version of a secret
|
||||||
// The version must be one of the secret's versions.
|
|
||||||
func (cli *Instance) GetSecretWithVersion(
|
func (cli *Instance) GetSecretWithVersion(
|
||||||
cmd *cobra.Command, secretName string, version string,
|
cmd *cobra.Command, secretName string, version string,
|
||||||
) error {
|
) error {
|
||||||
@@ -443,7 +417,13 @@ func (cli *Instance) GetSecretWithVersion(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Get the secret value
|
// Get the secret value
|
||||||
value, err := vlt.GetSecretVersion(secretName, version)
|
var value []byte
|
||||||
|
if version == "" {
|
||||||
|
value, err = vlt.GetSecret(secretName)
|
||||||
|
} else {
|
||||||
|
value, err = vlt.GetSecretVersion(secretName, version)
|
||||||
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to get secret", "error", err)
|
secret.Debug("Failed to get secret", "error", err)
|
||||||
|
|
||||||
|
|||||||
@@ -349,6 +349,10 @@ func unlockerIDFromDir(
|
|||||||
// itself cannot be read. Callers must distinguish the two: an unreadable
|
// itself cannot be read. Callers must distinguish the two: an unreadable
|
||||||
// directory means the unlocker's real ID is unknowable, so the entry has
|
// directory means the unlocker's real ID is unknowable, so the entry has
|
||||||
// to be skipped rather than reported under a synthesized ID.
|
// to be skipped rather than reported under a synthesized ID.
|
||||||
|
//
|
||||||
|
// A metadata file that cannot be read or parsed is skipped without a
|
||||||
|
// warning: every caller gets metadata from vault.ListUnlockers first,
|
||||||
|
// which has already warned about that directory.
|
||||||
func findUnlockerIDByMetadata(
|
func findUnlockerIDByMetadata(
|
||||||
fs afero.Fs, unlockersDir string, metadata secret.UnlockerMetadata,
|
fs afero.Fs, unlockersDir string, metadata secret.UnlockerMetadata,
|
||||||
includeSecureEnclave bool,
|
includeSecureEnclave bool,
|
||||||
@@ -371,9 +375,6 @@ func findUnlockerIDByMetadata(
|
|||||||
// Check if this is the right unlocker by comparing metadata
|
// Check if this is the right unlocker by comparing metadata
|
||||||
metadataBytes, err := afero.ReadFile(fs, metadataPath)
|
metadataBytes, err := afero.ReadFile(fs, metadataPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Warn("Could not read unlocker metadata file",
|
|
||||||
"path", metadataPath, "error", err)
|
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -381,9 +382,6 @@ func findUnlockerIDByMetadata(
|
|||||||
|
|
||||||
err = json.Unmarshal(metadataBytes, &diskMetadata)
|
err = json.Unmarshal(metadataBytes, &diskMetadata)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Warn("Could not parse unlocker metadata file",
|
|
||||||
"path", metadataPath, "error", err)
|
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,13 +1,18 @@
|
|||||||
// Unlocker List Tests
|
// Unlocker List Tests
|
||||||
//
|
//
|
||||||
// Tests for `secret unlocker list` behavior when the unlockers.d directory
|
// Tests for `secret unlocker list` behavior when the unlockers.d directory,
|
||||||
// cannot be read while the listing is being rendered:
|
// or an unlocker's metadata in it, cannot be read while the listing is
|
||||||
|
// being rendered:
|
||||||
//
|
//
|
||||||
// - TestUnlockersListSkipsUnreadableUnlockersDir: an unreadable
|
// - TestUnlockersListSkipsUnreadableUnlockersDir: an unreadable
|
||||||
// unlockers.d yields no rows rather than rows bearing synthesized IDs.
|
// unlockers.d yields no rows rather than rows bearing synthesized IDs.
|
||||||
// - TestUnlockersListSkipsOnlyUnreadableEntries: a readable entry is
|
// - TestUnlockersListSkipsOnlyUnreadableEntries: a readable entry is
|
||||||
// still listed, with its real ID and its current-unlocker marker,
|
// still listed, with its real ID and its current-unlocker marker,
|
||||||
// when a later entry's scan fails.
|
// when a later entry's scan fails.
|
||||||
|
// - TestUnlockersListToleratesCorruptMetadata: one unlocker's corrupt
|
||||||
|
// metadata does not stop the others from being listed.
|
||||||
|
// - TestUnlockersListSkipsUnreadableMetadata: an unlocker whose metadata
|
||||||
|
// file cannot be read is left out, and the other is still listed.
|
||||||
//
|
//
|
||||||
// The listing resolves each unlocker's real ID by rescanning unlockers.d
|
// The listing resolves each unlocker's real ID by rescanning unlockers.d
|
||||||
// after the vault has already enumerated it. If that rescan fails the ID
|
// after the vault has already enumerated it. If that rescan fails the ID
|
||||||
@@ -92,6 +97,28 @@ func (f *unlockersDirFailFs) Open(name string) (afero.File, error) {
|
|||||||
return f.Fs.Open(name)
|
return f.Fs.Open(name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// errMetadataUnreadable is returned by the test filesystem in place of a
|
||||||
|
// successful open of one unlocker's metadata file.
|
||||||
|
var errMetadataUnreadable = errors.New("input/output error")
|
||||||
|
|
||||||
|
// metadataReadFailFs fails every open of the file at unreadablePath. The
|
||||||
|
// file still exists, so checking for it succeeds and only reading it fails.
|
||||||
|
type metadataReadFailFs struct {
|
||||||
|
afero.Fs
|
||||||
|
|
||||||
|
unreadablePath string
|
||||||
|
}
|
||||||
|
|
||||||
|
//nolint:ireturn // afero.File is the interface required by afero.Fs
|
||||||
|
func (f *metadataReadFailFs) Open(name string) (afero.File, error) {
|
||||||
|
if name == f.unreadablePath {
|
||||||
|
return nil, errMetadataUnreadable
|
||||||
|
}
|
||||||
|
|
||||||
|
//nolint:wrapcheck // test double must return the wrapped Fs error as-is
|
||||||
|
return f.Fs.Open(name)
|
||||||
|
}
|
||||||
|
|
||||||
// writePGPUnlocker writes a PGP unlocker directory with metadata that
|
// writePGPUnlocker writes a PGP unlocker directory with metadata that
|
||||||
// yields the real ID "pgp-<keyID>".
|
// yields the real ID "pgp-<keyID>".
|
||||||
func writePGPUnlocker(
|
func writePGPUnlocker(
|
||||||
@@ -227,3 +254,79 @@ func TestUnlockersListReadableEntriesAreListed(t *testing.T) {
|
|||||||
assert.True(t, unlockers[0].IsCurrent)
|
assert.True(t, unlockers[0].IsCurrent)
|
||||||
assert.False(t, unlockers[1].IsCurrent)
|
assert.False(t, unlockers[1].IsCurrent)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestUnlockersListToleratesCorruptMetadata asserts that one unlocker with
|
||||||
|
// corrupt metadata does not stop the listing. Metadata that is not JSON
|
||||||
|
// leaves that unlocker out; PGP metadata without a usable GPG key ID lists
|
||||||
|
// it as "pgp-unknown". The healthy unlocker is listed with its real ID.
|
||||||
|
func TestUnlockersListToleratesCorruptMetadata(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
healthyID := "pgp-" + listTestGPGKeyID + "A"
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
metadata string
|
||||||
|
wantIDs []string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "not JSON",
|
||||||
|
metadata: "not json",
|
||||||
|
wantIDs: []string{healthyID},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "GPG key ID of the wrong type",
|
||||||
|
metadata: `{"type": "pgp", "gpgKeyId": 42}`,
|
||||||
|
wantIDs: []string{healthyID, "pgp-unknown"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "GPG key ID missing",
|
||||||
|
metadata: `{"type": "pgp"}`,
|
||||||
|
wantIDs: []string{healthyID, "pgp-unknown"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := newListTestVault(t, 2)
|
||||||
|
metadataPath := filepath.Join(listTestStateDir, "vaults.d",
|
||||||
|
listTestVaultName, listTestUnlockersDirName,
|
||||||
|
listTestUnlockerDirTwo, listTestMetadataFileName)
|
||||||
|
require.NoError(t, afero.WriteFile(
|
||||||
|
fs, metadataPath, []byte(tt.metadata), listTestFilePerm,
|
||||||
|
))
|
||||||
|
|
||||||
|
unlockers := listUnlockersJSON(t, fs)
|
||||||
|
require.Len(t, unlockers, len(tt.wantIDs))
|
||||||
|
|
||||||
|
for i, wantID := range tt.wantIDs {
|
||||||
|
assert.Equal(t, wantID, unlockers[i].ID)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnlockersListSkipsUnreadableMetadata asserts that an unlocker whose
|
||||||
|
// metadata file exists but cannot be read is left out of the listing, and
|
||||||
|
// the other unlocker is still listed with its real ID. The unreadable one
|
||||||
|
// sorts first, so finding the other's ID has to step past it as well.
|
||||||
|
func TestUnlockersListSkipsUnreadableMetadata(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
base := newListTestVault(t, 2)
|
||||||
|
fs := &metadataReadFailFs{
|
||||||
|
Fs: base,
|
||||||
|
unreadablePath: filepath.Join(listTestStateDir, "vaults.d",
|
||||||
|
listTestVaultName, listTestUnlockersDirName,
|
||||||
|
listTestUnlockerDirOne, listTestMetadataFileName),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlockers := listUnlockersJSON(t, fs)
|
||||||
|
|
||||||
|
require.Len(t, unlockers, 1,
|
||||||
|
"only the unlocker with readable metadata may be listed")
|
||||||
|
assert.Equal(t, "pgp-"+listTestGPGKeyID+"B", unlockers[0].ID,
|
||||||
|
"the listed row must carry the real unlocker ID")
|
||||||
|
}
|
||||||
|
|||||||
@@ -265,7 +265,9 @@ func (cli *Instance) PromoteVersion(
|
|||||||
secretDir := filepath.Join(vaultDir, "secrets.d", encodedName)
|
secretDir := filepath.Join(vaultDir, "secrets.d", encodedName)
|
||||||
|
|
||||||
// Check if version exists
|
// Check if version exists
|
||||||
exists, err := secret.VersionExists(cli.fs, secretDir, version)
|
versionDir := filepath.Join(secretDir, "versions", version)
|
||||||
|
|
||||||
|
exists, err := afero.DirExists(cli.fs, versionDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to check if version exists: %w", err)
|
return fmt.Errorf("failed to check if version exists: %w", err)
|
||||||
}
|
}
|
||||||
@@ -321,7 +323,9 @@ func (cli *Instance) RemoveVersion(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check if version exists
|
// Check if version exists
|
||||||
exists, err = secret.VersionExists(cli.fs, secretDir, version)
|
versionDir := filepath.Join(secretDir, "versions", version)
|
||||||
|
|
||||||
|
exists, err = afero.DirExists(cli.fs, versionDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to check if version exists: %w", err)
|
return fmt.Errorf("failed to check if version exists: %w", err)
|
||||||
}
|
}
|
||||||
@@ -344,8 +348,6 @@ func (cli *Instance) RemoveVersion(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Remove the version directory
|
// Remove the version directory
|
||||||
versionDir := filepath.Join(secretDir, "versions", version)
|
|
||||||
|
|
||||||
err = cli.fs.RemoveAll(versionDir)
|
err = cli.fs.RemoveAll(versionDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to remove version: %w", err)
|
return fmt.Errorf("failed to remove version: %w", err)
|
||||||
|
|||||||
@@ -276,8 +276,8 @@ func TestGetSecretWithVersion(t *testing.T) {
|
|||||||
var buf bytes.Buffer
|
var buf bytes.Buffer
|
||||||
cmd.SetOut(&buf)
|
cmd.SetOut(&buf)
|
||||||
|
|
||||||
// Test getting the current version
|
// Test getting current version (empty version string)
|
||||||
err = cli.GetSecret(cmd, "test/secret")
|
err = cli.GetSecretWithVersion(cmd, "test/secret", "")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, "version-2", buf.String())
|
assert.Equal(t, "version-2", buf.String())
|
||||||
|
|
||||||
|
|||||||
@@ -155,14 +155,18 @@ func (p *PGPUnlocker) GetDirectory() string {
|
|||||||
return p.Directory
|
return p.Directory
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetID implements Unlocker interface - generates ID from GPG key ID
|
// GetID implements Unlocker interface - generates ID from GPG key ID.
|
||||||
|
// If the metadata has no usable GPG key ID, it warns with the unlocker's
|
||||||
|
// directory and returns "pgp-unknown", so listing the other unlockers
|
||||||
|
// still works.
|
||||||
func (p *PGPUnlocker) GetID() string {
|
func (p *PGPUnlocker) GetID() string {
|
||||||
// Generate ID using GPG key ID: pgp-<keyid>
|
// Generate ID using GPG key ID: pgp-<keyid>
|
||||||
gpgKeyID, err := p.GetGPGKeyID()
|
gpgKeyID, err := p.GetGPGKeyID()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// The vault metadata is corrupt - this is a fatal error
|
Warn("PGP unlocker metadata is corrupt or missing its GPG key ID",
|
||||||
// We cannot continue with a fallback ID as that would mask data corruption
|
"directory", p.Directory, "error", err)
|
||||||
panic(fmt.Sprintf("PGP unlocker metadata is corrupt or missing GPG key ID: %v", err))
|
|
||||||
|
return "pgp-unknown"
|
||||||
}
|
}
|
||||||
|
|
||||||
return "pgp-" + gpgKeyID
|
return "pgp-" + gpgKeyID
|
||||||
@@ -197,6 +201,10 @@ func (p *PGPUnlocker) GetGPGKeyID() (string, error) {
|
|||||||
return "", fmt.Errorf("failed to parse PGP metadata: %w", err)
|
return "", fmt.Errorf("failed to parse PGP metadata: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if pgpMetadata.GPGKeyID == "" {
|
||||||
|
return "", fmt.Errorf("PGP metadata: %w", errGPGKeyIDEmpty)
|
||||||
|
}
|
||||||
|
|
||||||
return pgpMetadata.GPGKeyID, nil
|
return pgpMetadata.GPGKeyID, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"slices"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -525,18 +524,6 @@ func ListVersions(fs afero.Fs, secretDir string) ([]string, error) {
|
|||||||
return versions, nil
|
return versions, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// VersionExists reports whether version is one of the versions ListVersions
|
|
||||||
// lists for the secret in secretDir. It only compares names, so a version
|
|
||||||
// the user typed can be checked with it before any path is built from it.
|
|
||||||
func VersionExists(fs afero.Fs, secretDir string, version string) (bool, error) {
|
|
||||||
versions, err := ListVersions(fs, secretDir)
|
|
||||||
if err != nil {
|
|
||||||
return false, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return slices.Contains(versions, version), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetCurrentVersion returns the version that the "current" file points to
|
// GetCurrentVersion returns the version that the "current" file points to
|
||||||
// The file contains just the version name (e.g., "20231215.001")
|
// The file contains just the version name (e.g., "20231215.001")
|
||||||
func GetCurrentVersion(fs afero.Fs, secretDir string) (string, error) {
|
func GetCurrentVersion(fs afero.Fs, secretDir string) (string, error) {
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ var (
|
|||||||
|
|
||||||
// ErrVersionNotFound indicates the requested secret version does not
|
// ErrVersionNotFound indicates the requested secret version does not
|
||||||
// exist. Composed as
|
// exist. Composed as
|
||||||
// "version '<version>' not found for secret '<name>'".
|
// "version <version> not found for secret <name>".
|
||||||
ErrVersionNotFound = errors.New("not found for secret")
|
ErrVersionNotFound = errors.New("not found for secret")
|
||||||
|
|
||||||
// ErrNoVersions indicates the source secret has no versions. Composed
|
// ErrNoVersions indicates the source secret has no versions. Composed
|
||||||
|
|||||||
@@ -235,10 +235,10 @@ func testRetrieveSpecificVersions(
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, []byte("version-3-data"), value3)
|
assert.Equal(t, []byte("version-3-data"), value3)
|
||||||
|
|
||||||
// An empty version is not one of the versions; GetSecret gets the
|
// Empty version should return current
|
||||||
// current one
|
valueCurrent, err := vault.GetSecretVersion(secretName, "")
|
||||||
_, err = vault.GetSecretVersion(secretName, "")
|
require.NoError(t, err)
|
||||||
require.ErrorIs(t, err, ErrVersionNotFound)
|
assert.Equal(t, []byte("version-3-data"), valueCurrent)
|
||||||
}
|
}
|
||||||
|
|
||||||
func testPromoteOldVersion(
|
func testPromoteOldVersion(
|
||||||
|
|||||||
+37
-30
@@ -259,31 +259,18 @@ func updateVersionMetadata(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecret retrieves the current version of a secret from this vault
|
// GetSecret retrieves a secret from this vault
|
||||||
func (v *Vault) GetSecret(name string) ([]byte, error) {
|
func (v *Vault) GetSecret(name string) ([]byte, error) {
|
||||||
secret.DebugWith("Getting secret from vault",
|
secret.DebugWith("Getting secret from vault",
|
||||||
slog.String("vault_name", v.Name),
|
slog.String("vault_name", v.Name),
|
||||||
slog.String("secret_name", name),
|
slog.String("secret_name", name),
|
||||||
)
|
)
|
||||||
|
|
||||||
// GetSecretObject validates the name and checks that the secret exists
|
return v.GetSecretVersion(name, "")
|
||||||
secretObj, err := v.GetSecretObject(name)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
currentVersion, err := secret.GetCurrentVersion(v.fs, secretObj.Directory)
|
|
||||||
if err != nil {
|
|
||||||
secret.Debug("Failed to get current version", "error", err, "secret_name", name)
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("failed to get current version: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return v.GetSecretVersion(name, currentVersion)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecretVersion retrieves a specific version of a secret. The version
|
// GetSecretVersion retrieves a specific version of a secret (empty version
|
||||||
// must be one of the secret's versions; GetSecret gets the current one.
|
// means current)
|
||||||
func (v *Vault) GetSecretVersion(name string, version string) ([]byte, error) {
|
func (v *Vault) GetSecretVersion(name string, version string) ([]byte, error) {
|
||||||
secret.DebugWith("Getting secret version from vault",
|
secret.DebugWith("Getting secret version from vault",
|
||||||
slog.String("vault_name", v.Name),
|
slog.String("vault_name", v.Name),
|
||||||
@@ -291,8 +278,8 @@ func (v *Vault) GetSecretVersion(name string, version string) ([]byte, error) {
|
|||||||
slog.String("version", version),
|
slog.String("version", version),
|
||||||
)
|
)
|
||||||
|
|
||||||
// Validate the name and check that the version exists
|
// Validate the name and resolve the version to fetch
|
||||||
err := v.checkSecretVersion(name, version)
|
version, err := v.resolveSecretVersion(name, version)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -653,15 +640,15 @@ func (v *Vault) updatePreviousVersion(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkSecretVersion validates the secret name and verifies that the secret
|
// resolveSecretVersion validates the secret name, verifies the secret and
|
||||||
// exists and that version is one of its versions.
|
// version exist, and resolves an empty version to the current one.
|
||||||
func (v *Vault) checkSecretVersion(name, version string) error {
|
func (v *Vault) resolveSecretVersion(name, version string) (string, error) {
|
||||||
// Validate secret name to prevent path traversal
|
// Validate secret name to prevent path traversal
|
||||||
err := ValidateSecretName(name)
|
err := ValidateSecretName(name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Invalid secret name provided", "secret_name", name)
|
secret.Debug("Invalid secret name provided", "secret_name", name)
|
||||||
|
|
||||||
return err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get vault directory
|
// Get vault directory
|
||||||
@@ -669,7 +656,7 @@ func (v *Vault) checkSecretVersion(name, version string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to get vault directory", "error", err, "vault_name", v.Name)
|
secret.Debug("Failed to get vault directory", "error", err, "vault_name", v.Name)
|
||||||
|
|
||||||
return err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Convert slashes to percent signs for storage
|
// Convert slashes to percent signs for storage
|
||||||
@@ -681,30 +668,50 @@ func (v *Vault) checkSecretVersion(name, version string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to check if secret exists", "error", err, "secret_name", name)
|
secret.Debug("Failed to check if secret exists", "error", err, "secret_name", name)
|
||||||
|
|
||||||
return fmt.Errorf("failed to check if secret exists: %w", err)
|
return "", fmt.Errorf("failed to check if secret exists: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !exists {
|
if !exists {
|
||||||
secret.Debug("Secret not found in vault", "secret_name", name, "vault_name", v.Name)
|
secret.Debug("Secret not found in vault", "secret_name", name, "vault_name", v.Name)
|
||||||
|
|
||||||
return fmt.Errorf("secret %s %w", name, ErrSecretNotFound)
|
return "", fmt.Errorf("secret %s %w", name, ErrSecretNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine which version to get
|
||||||
|
if version == "" {
|
||||||
|
// Get current version
|
||||||
|
currentVersion, err := secret.GetCurrentVersion(v.fs, secretDir)
|
||||||
|
if err != nil {
|
||||||
|
secret.Debug("Failed to get current version", "error", err, "secret_name", name)
|
||||||
|
|
||||||
|
return "", fmt.Errorf("failed to get current version: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
version = currentVersion
|
||||||
|
|
||||||
|
secret.Debug("Using current version", "version", version, "secret_name", name)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if version exists
|
// Check if version exists
|
||||||
exists, err = secret.VersionExists(v.fs, secretDir, version)
|
versionPath := filepath.Join(secretDir, "versions", version)
|
||||||
|
|
||||||
|
exists, err = afero.DirExists(v.fs, versionPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to check if version exists", "error", err, "version", version)
|
secret.Debug("Failed to check if version exists", "error", err, "version", version)
|
||||||
|
|
||||||
return fmt.Errorf("failed to check if version exists: %w", err)
|
return "", fmt.Errorf("failed to check if version exists: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !exists {
|
if !exists {
|
||||||
secret.Debug("Version not found", "version", version, "secret_name", name)
|
secret.Debug("Version not found", "version", version, "secret_name", name)
|
||||||
|
|
||||||
return fmt.Errorf("version '%s' %w '%s'", version, ErrVersionNotFound, name)
|
return "", fmt.Errorf(
|
||||||
|
"version %s %w %s",
|
||||||
|
version, ErrVersionNotFound, name,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return version, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// createAndSaveVersion generates a new version name, sets the version
|
// createAndSaveVersion generates a new version name, sets the version
|
||||||
|
|||||||
@@ -202,10 +202,10 @@ func TestVaultGetSecretVersion(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, []byte("version-2"), value)
|
assert.Equal(t, []byte("version-2"), value)
|
||||||
|
|
||||||
// An empty version is not one of the versions; GetSecret gets the
|
// Get current (empty version)
|
||||||
// current one
|
value, err = vault.GetSecretVersion(testSecretPath, "")
|
||||||
_, err = vault.GetSecretVersion(testSecretPath, "")
|
require.NoError(t, err)
|
||||||
require.ErrorIs(t, err, ErrVersionNotFound)
|
assert.Equal(t, []byte("version-2"), value)
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:paralleltest // createTestVaultWithKey uses t.Setenv
|
//nolint:paralleltest // createTestVaultWithKey uses t.Setenv
|
||||||
|
|||||||
@@ -247,16 +247,20 @@ func (v *Vault) ListUnlockers() ([]UnlockerMetadata, error) {
|
|||||||
|
|
||||||
metadataBytes, err := afero.ReadFile(v.fs, metadataPath)
|
metadataBytes, err := afero.ReadFile(v.fs, metadataPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
secret.Warn("Skipping unlocker directory with unreadable metadata file",
|
||||||
"failed to read metadata for unlocker %s: %w", file.Name(), err)
|
"directory", file.Name(), "error", err)
|
||||||
|
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
var metadata UnlockerMetadata
|
var metadata UnlockerMetadata
|
||||||
|
|
||||||
err = json.Unmarshal(metadataBytes, &metadata)
|
err = json.Unmarshal(metadataBytes, &metadata)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
secret.Warn("Skipping unlocker directory with corrupt metadata file",
|
||||||
"failed to parse metadata for unlocker %s: %w", file.Name(), err)
|
"directory", file.Name(), "error", err)
|
||||||
|
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
unlockers = append(unlockers, metadata)
|
unlockers = append(unlockers, metadata)
|
||||||
|
|||||||
Reference in New Issue
Block a user