Compare commits
2
Commits
f6b55f285e
...
4c225b177d
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4c225b177d | ||
|
|
24d99819a3 |
No files matched your search
@@ -91,6 +91,9 @@ Lists all available vaults. The current vault is marked.
|
|||||||
|
|
||||||
Creates a new vault with the specified name.
|
Creates a new vault with the specified name.
|
||||||
|
|
||||||
|
**Vault Name Format:** only lowercase ASCII letters, digits, `.`, `-` and `_`
|
||||||
|
are allowed, and a name must not be empty, `.` or `..`.
|
||||||
|
|
||||||
#### `secret vault select <name>`
|
#### `secret vault select <name>`
|
||||||
|
|
||||||
Switches to the specified vault for subsequent operations.
|
Switches to the specified vault for subsequent operations.
|
||||||
@@ -198,7 +201,9 @@ Creates a new unlocker of the specified type:
|
|||||||
|
|
||||||
**DANGER**: Permanently removes an unlocker. Like Unix `rm`, this command
|
**DANGER**: Permanently removes an unlocker. Like Unix `rm`, this command
|
||||||
does not ask for confirmation. Cannot remove the last unlocker if the vault
|
does not ask for confirmation. Cannot remove the last unlocker if the vault
|
||||||
has secrets unless --force is used.
|
has secrets unless --force is used. An unlocker directory that
|
||||||
|
`secret unlocker list` skips with a warning, because its metadata cannot be
|
||||||
|
read or parsed, is removed by the directory name the warning gives.
|
||||||
- `--force, -f`: Force removal of last unlocker even if vault has secrets
|
- `--force, -f`: Force removal of last unlocker even if vault has secrets
|
||||||
- **CRITICAL WARNING**: Without unlockers and without your mnemonic phrase,
|
- **CRITICAL WARNING**: Without unlockers and without your mnemonic phrase,
|
||||||
vault data will be PERMANENTLY INACCESSIBLE
|
vault data will be PERMANENTLY INACCESSIBLE
|
||||||
|
|||||||
@@ -25,6 +25,25 @@ Bring the repo into policy compliance in one commit:
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-04: A vault name may use only lowercase ASCII letters, digits,
|
||||||
|
`.`, `-` and `_`, and must not be empty, `.` or `..`
|
||||||
|
(https://git.eeqj.de/sneak/secret/issues/68); the error and `README.md`
|
||||||
|
state the rule. `vault create`, `vault import`, `vault select`,
|
||||||
|
`vault remove` and both vault names of `mv` check the name as typed with
|
||||||
|
`vault.ValidateVaultName` before building any path from it, and
|
||||||
|
`vault create` checks it before asking for the mnemonic. Before,
|
||||||
|
`vault import ..` wrote a long-term key and an unlocker into the state
|
||||||
|
directory itself, and `vault select ..` made that the current vault.
|
||||||
|
- 2026-10-04: `secret unlocker select` and `secret unlocker remove`
|
||||||
|
skip, with the warning `unlocker list` gives, an unlocker directory
|
||||||
|
whose metadata file cannot be checked for, read or parsed, instead of
|
||||||
|
failing when it sorts before the unlocker asked for. Such a directory,
|
||||||
|
or one without a metadata file, is removed by its directory name, the
|
||||||
|
name the warning gives; only the directory is removed, since its type
|
||||||
|
is unknown. Removing one whose metadata file is missing or corrupt
|
||||||
|
never counts as removing the last unlocker. Removing one whose metadata
|
||||||
|
file cannot be checked for or read always does, since it may be the
|
||||||
|
only working unlocker, so in a vault with secrets it needs `--force`.
|
||||||
- 2026-10-04: A failed command prints its error once, without the usage
|
- 2026-10-04: A failed command prints its error once, without the usage
|
||||||
text after it (https://git.eeqj.de/sneak/secret/issues/41). Usage is
|
text after it (https://git.eeqj.de/sneak/secret/issues/41). Usage is
|
||||||
still printed for a command called wrongly: wrong number of arguments,
|
still printed for a command called wrongly: wrong number of arguments,
|
||||||
@@ -121,7 +140,7 @@ Bring the repo into policy compliance in one commit:
|
|||||||
which `vault create` has already made the current vault;
|
which `vault create` has already made the current vault;
|
||||||
- from an unlocker add stopped before its metadata is written, a
|
- from an unlocker add stopped before its metadata is written, a
|
||||||
directory that `unlocker list` warns about and `unlocker rm`
|
directory that `unlocker list` warns about and `unlocker rm`
|
||||||
cannot remove;
|
removes only by its directory name;
|
||||||
- data under a `.tmp-` name in the state directory: a secret or
|
- data under a `.tmp-` name in the state directory: a secret or
|
||||||
version being added, or the secret, version, unlocker or vault
|
version being added, or the secret, version, unlocker or vault
|
||||||
being removed, encrypted keys included. Nothing deletes it; it
|
being removed, encrypted keys included. Nothing deletes it; it
|
||||||
|
|||||||
@@ -48,26 +48,25 @@ func TestRejectedMoveWithinVaultLeavesStateUnchanged(t *testing.T) {
|
|||||||
"mv work:nosuch work:y", "work:nosuch", "work:y", false,
|
"mv work:nosuch work:y", "work:nosuch", "work:y", false,
|
||||||
"secret 'nosuch' not found",
|
"secret 'nosuch' not found",
|
||||||
},
|
},
|
||||||
// Only an existing vault is used, so ".." cannot reach the state
|
// Only an existing vault is used.
|
||||||
// directory itself.
|
|
||||||
{
|
{
|
||||||
"mv --force ..:x ..:y", "..:x", "..:y", true,
|
"mv --force nosuch:x nosuch:y", "nosuch:x", "nosuch:y", true,
|
||||||
"vault '..' does not exist",
|
"vault 'nosuch' does not exist",
|
||||||
},
|
},
|
||||||
// Each of these spells "work" a second way. The spelling is not an
|
// Each of these spells "work" a second way. The spelling is not a
|
||||||
// existing vault name, so the move is not taken for a move between
|
// valid vault name, so the move is not taken for a move between two
|
||||||
// two vaults, which would delete the destination, here the source.
|
// vaults, which would delete the destination, here the source.
|
||||||
{
|
{
|
||||||
"mv --force work:x work/:x", workX, "work/:x", true,
|
"mv --force work:x work/:x", workX, "work/:x", true,
|
||||||
"vault 'work/' does not exist",
|
vault.ValidateVaultName("work/").Error(),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"mv --force work/:x work:", "work/:x", "work:", true,
|
"mv --force work/:x work:", "work/:x", "work:", true,
|
||||||
"vault 'work/' does not exist",
|
vault.ValidateVaultName("work/").Error(),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"mv --force work:x ./work:x", workX, "./work:x", true,
|
"mv --force work:x ./work:x", workX, "./work:x", true,
|
||||||
"vault './work' does not exist",
|
vault.ValidateVaultName("./work").Error(),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -292,6 +292,58 @@ func TestInvalidVersionLeavesVaultsUnchanged(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestInvalidVaultNameLeavesStateUnchanged is a regression test for
|
||||||
|
// https://git.eeqj.de/sneak/secret/issues/68, where
|
||||||
|
// `secret vault import ..` wrote a long-term key and an unlocker into the
|
||||||
|
// state directory itself, and `secret vault select ..` made it the current
|
||||||
|
// vault. Each command that takes a vault name must reject an invalid one
|
||||||
|
// before building a path from it. The mnemonic and the passphrase are set,
|
||||||
|
// and moves and removals use --force, so that only the name check stands
|
||||||
|
// in the way.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // newTwoVaultFs uses t.Setenv
|
||||||
|
func TestInvalidVaultNameLeavesStateUnchanged(t *testing.T) {
|
||||||
|
before := snapshotStateDir(t, newTwoVaultFs(t))
|
||||||
|
|
||||||
|
t.Setenv(secret.EnvUnlockPassphrase, testPassphrase)
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
|
||||||
|
// Each command is a format with %q where the vault name goes.
|
||||||
|
commands := []struct {
|
||||||
|
command string
|
||||||
|
run func(c *cli.Instance, name string) error
|
||||||
|
}{
|
||||||
|
{"vault create %q", func(c *cli.Instance, name string) error {
|
||||||
|
return c.CreateVault(cmd, name)
|
||||||
|
}},
|
||||||
|
{"vault import %q", func(c *cli.Instance, name string) error {
|
||||||
|
return c.VaultImport(cmd, name)
|
||||||
|
}},
|
||||||
|
{"vault select %q", func(c *cli.Instance, name string) error {
|
||||||
|
return c.SelectVault(cmd, name)
|
||||||
|
}},
|
||||||
|
{"vault remove --force %q", func(c *cli.Instance, name string) error {
|
||||||
|
return c.RemoveVault(cmd, name, true)
|
||||||
|
}},
|
||||||
|
{"mv --force %q:x work:x", func(c *cli.Instance, name string) error {
|
||||||
|
return c.MoveSecret(cmd, name+":x", "work:x", true)
|
||||||
|
}},
|
||||||
|
{"mv --force default:x %q:x", func(c *cli.Instance, name string) error {
|
||||||
|
return c.MoveSecret(cmd, "default:x", name+":x", true)
|
||||||
|
}},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range commands {
|
||||||
|
for _, name := range []string{"", ".", "..", "a/b"} {
|
||||||
|
t.Run(fmt.Sprintf(tt.command, name), func(t *testing.T) {
|
||||||
|
requireRejectedAndUnchanged(t, before, vault.ValidateVaultName(name),
|
||||||
|
func(c *cli.Instance) error { return tt.run(c, name) })
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestRemoveVersionRemovesOnlyThatVersion checks that `secret version rm`
|
// TestRemoveVersionRemovesOnlyThatVersion checks that `secret version rm`
|
||||||
// with a version that is not the current one removes that version and
|
// with a version that is not the current one removes that version and
|
||||||
// changes nothing else.
|
// changes nothing else.
|
||||||
|
|||||||
+11
-5
@@ -811,9 +811,9 @@ func (cli *Instance) moveSecret(
|
|||||||
cmd, vlt, srcSecretName, destSecretName, force)
|
cmd, vlt, srcSecretName, destSecretName, force)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Both vaults must be existing vaults by exact name, so that two
|
// Both vault names must be valid and name existing vaults exactly, so
|
||||||
// spellings of one vault, such as "work" and "work/", are never taken for
|
// that two spellings of one vault, such as "work" and "work/", are never
|
||||||
// two vaults. A named vault does not become the current vault.
|
// taken for two vaults. A named vault does not become the current vault.
|
||||||
srcVault, err := cli.existingVault(srcVaultName)
|
srcVault, err := cli.existingVault(srcVaultName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -833,9 +833,15 @@ func (cli *Instance) moveSecret(
|
|||||||
cmd, srcVault, srcSecretName, destVault, destSecretName, force)
|
cmd, srcVault, srcSecretName, destVault, destSecretName, force)
|
||||||
}
|
}
|
||||||
|
|
||||||
// existingVault returns the vault with the given name, or an error if there
|
// existingVault returns the vault with the given name, or an error if the
|
||||||
// is none. Unlike vault.SelectVault, it leaves the current vault as it is.
|
// name is not a valid vault name or there is no such vault. Unlike
|
||||||
|
// vault.SelectVault, it leaves the current vault as it is.
|
||||||
func (cli *Instance) existingVault(name string) (*vault.Vault, error) {
|
func (cli *Instance) existingVault(name string) (*vault.Vault, error) {
|
||||||
|
err := vault.ValidateVaultName(name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
vaults, err := vault.ListVaults(cli.fs, cli.stateDir)
|
vaults, err := vault.ListVaults(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to list vaults: %w", err)
|
return nil, fmt.Errorf("failed to list vaults: %w", err)
|
||||||
|
|||||||
@@ -744,14 +744,43 @@ func (cli *Instance) removeUnlocker(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get list of unlockers
|
// Get list of unlockers. It leaves out a directory whose metadata file
|
||||||
|
// is missing or cannot be checked for, read or parsed.
|
||||||
unlockers, err := vlt.ListUnlockers()
|
unlockers, err := vlt.ListUnlockers()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to list unlockers: %w", err)
|
return fmt.Errorf("failed to list unlockers: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
vaultDir, err := vlt.GetDirectory()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get vault directory: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
unlockersDir := filepath.Join(vaultDir, "unlockers.d")
|
||||||
|
|
||||||
// Check if we're removing the last unlocker
|
// Check if we're removing the last unlocker
|
||||||
|
removingLast := false
|
||||||
|
|
||||||
if len(unlockers) == 1 {
|
if len(unlockers) == 1 {
|
||||||
|
lastID, err := findUnlockerIDByMetadata(
|
||||||
|
cli.fs, unlockersDir, unlockers[0], true)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
removingLast = lastID == unlockerID
|
||||||
|
}
|
||||||
|
|
||||||
|
// unlockerID may instead name a directory left out of the list. If its
|
||||||
|
// metadata file is missing or corrupt it is not a working unlocker, so
|
||||||
|
// removing it never removes the last one. If the file cannot be checked
|
||||||
|
// for or read, the unlocker may be the only working one, so removing it
|
||||||
|
// counts as removing the last unlocker.
|
||||||
|
if metadataUnreadable(cli.fs, filepath.Join(unlockersDir, unlockerID)) {
|
||||||
|
removingLast = true
|
||||||
|
}
|
||||||
|
|
||||||
|
if removingLast {
|
||||||
// Check if vault has secrets
|
// Check if vault has secrets
|
||||||
numSecrets, err := vlt.NumSecrets()
|
numSecrets, err := vlt.NumSecrets()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -785,6 +814,20 @@ func (cli *Instance) removeUnlocker(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// metadataUnreadable reports whether checking for or reading the metadata
|
||||||
|
// file in the unlocker directory unlockerDir fails. A missing file is not
|
||||||
|
// a failure.
|
||||||
|
func metadataUnreadable(fs afero.Fs, unlockerDir string) bool {
|
||||||
|
metadataPath := filepath.Join(unlockerDir, "unlocker-metadata.json")
|
||||||
|
|
||||||
|
exists, err := afero.Exists(fs, metadataPath)
|
||||||
|
if err == nil && exists {
|
||||||
|
_, err = afero.ReadFile(fs, metadataPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
return err != nil
|
||||||
|
}
|
||||||
|
|
||||||
// UnlockerSelect selects an unlocker as current
|
// UnlockerSelect selects an unlocker as current
|
||||||
func (cli *Instance) UnlockerSelect(unlockerID string) error {
|
func (cli *Instance) UnlockerSelect(unlockerID string) error {
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
|||||||
@@ -0,0 +1,167 @@
|
|||||||
|
// Corrupt Unlocker Tests
|
||||||
|
//
|
||||||
|
// `secret unlocker select` and `secret unlocker remove` find an unlocker
|
||||||
|
// by its ID. These tests give the first unlocker, which sorts before the
|
||||||
|
// one the commands act on, metadata that is not JSON, and check that the
|
||||||
|
// commands step past it, and that it can itself be removed by its
|
||||||
|
// directory name, which `secret unlocker list` names in its warning. A
|
||||||
|
// last test checks that an unlocker whose metadata file cannot be read is
|
||||||
|
// removed by its directory name only as the last unlocker is.
|
||||||
|
|
||||||
|
//nolint:testpackage // white-box test of unexported internals
|
||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.eeqj.de/sneak/secret/internal/vault"
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// newCorruptUnlockerVault returns the two-unlocker test vault with the
|
||||||
|
// metadata of the first unlocker replaced by text that is not JSON.
|
||||||
|
func newCorruptUnlockerVault(t *testing.T) *afero.MemMapFs {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
fs := newListTestVault(t, 2)
|
||||||
|
require.NoError(t, afero.WriteFile(fs,
|
||||||
|
filepath.Join(testVaultDir(listTestVaultName), listTestUnlockersDirName,
|
||||||
|
listTestUnlockerDirOne, listTestMetadataFileName),
|
||||||
|
[]byte("not json"), listTestFilePerm))
|
||||||
|
|
||||||
|
return fs
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnlockerSelectSkipsCorruptUnlocker asserts that the second unlocker
|
||||||
|
// can be selected, and that the corrupt one, having no type to be used as,
|
||||||
|
// cannot be selected by its directory name.
|
||||||
|
func TestUnlockerSelectSkipsCorruptUnlocker(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := newCorruptUnlockerVault(t)
|
||||||
|
instance, _ := newTestInstance(fs)
|
||||||
|
|
||||||
|
require.NoError(t, instance.UnlockerSelect("pgp-"+listTestGPGKeyID+"B"))
|
||||||
|
|
||||||
|
current, err := afero.ReadFile(fs,
|
||||||
|
filepath.Join(testVaultDir(listTestVaultName), "current-unlocker"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, listTestUnlockerDirTwo, string(current))
|
||||||
|
|
||||||
|
err = instance.UnlockerSelect(listTestUnlockerDirOne)
|
||||||
|
require.ErrorIs(t, err, vault.ErrUnlockerNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnlockerRemoveWithCorruptUnlocker asserts that the second unlocker
|
||||||
|
// can be removed, unless the vault holds secrets: the corrupt unlocker
|
||||||
|
// cannot unlock the vault, so the second is its last. The corrupt one can
|
||||||
|
// be removed by its directory name without --force even then.
|
||||||
|
func TestUnlockerRemoveWithCorruptUnlocker(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
unlockerID string
|
||||||
|
withSecret bool
|
||||||
|
wantErr error
|
||||||
|
wantEntries []string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "the other unlocker",
|
||||||
|
unlockerID: "pgp-" + listTestGPGKeyID + "B",
|
||||||
|
wantEntries: []string{listTestUnlockerDirOne},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "the other unlocker, the last one, with secrets",
|
||||||
|
unlockerID: "pgp-" + listTestGPGKeyID + "B",
|
||||||
|
withSecret: true,
|
||||||
|
wantErr: errLastUnlocker,
|
||||||
|
wantEntries: []string{
|
||||||
|
listTestUnlockerDirOne, listTestUnlockerDirTwo,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "the corrupt unlocker by its directory name",
|
||||||
|
unlockerID: listTestUnlockerDirOne,
|
||||||
|
withSecret: true,
|
||||||
|
wantEntries: []string{listTestUnlockerDirTwo},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := newCorruptUnlockerVault(t)
|
||||||
|
if tt.withSecret {
|
||||||
|
writeTestSecret(t, fs, testVaultDir(listTestVaultName))
|
||||||
|
}
|
||||||
|
|
||||||
|
instance, cmd := newTestInstance(fs)
|
||||||
|
|
||||||
|
err := instance.UnlockersRemove(tt.unlockerID, false, cmd)
|
||||||
|
require.ErrorIs(t, err, tt.wantErr)
|
||||||
|
|
||||||
|
assertDirEntries(t, fs,
|
||||||
|
filepath.Join(testVaultDir(listTestVaultName),
|
||||||
|
listTestUnlockersDirName),
|
||||||
|
tt.wantEntries...)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnlockerRemoveWithUnreadableMetadata asserts that removing the only
|
||||||
|
// unlocker of a vault with secrets by its directory name, when its
|
||||||
|
// metadata file cannot be checked for or read, is refused without --force:
|
||||||
|
// listing leaves it out, but it may still be the vault's only working
|
||||||
|
// unlocker. With --force it is removed. The state directory lock refuses
|
||||||
|
// the failing filesystem, so the test calls removeUnlocker, which
|
||||||
|
// UnlockersRemove runs once it holds the lock.
|
||||||
|
func TestUnlockerRemoveWithUnreadableMetadata(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
vaultDir := testVaultDir(listTestVaultName)
|
||||||
|
unlockersDir := filepath.Join(vaultDir, listTestUnlockersDirName)
|
||||||
|
failingPath := filepath.Join(unlockersDir, listTestUnlockerDirOne,
|
||||||
|
listTestMetadataFileName)
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
wrap func(base afero.Fs) afero.Fs
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "checking for the file fails",
|
||||||
|
wrap: func(base afero.Fs) afero.Fs {
|
||||||
|
return &metadataStatFailFs{Fs: base, uncheckablePath: failingPath}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "reading the file fails",
|
||||||
|
wrap: func(base afero.Fs) afero.Fs {
|
||||||
|
return &metadataReadFailFs{Fs: base, unreadablePath: failingPath}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
base := newListTestVault(t, 1)
|
||||||
|
writeTestSecret(t, base, vaultDir)
|
||||||
|
|
||||||
|
instance, cmd := newTestInstance(tt.wrap(base))
|
||||||
|
|
||||||
|
err := instance.removeUnlocker(listTestUnlockerDirOne, false, cmd)
|
||||||
|
require.ErrorIs(t, err, errLastUnlocker)
|
||||||
|
assertDirEntries(t, base, unlockersDir, listTestUnlockerDirOne)
|
||||||
|
|
||||||
|
require.NoError(t,
|
||||||
|
instance.removeUnlocker(listTestUnlockerDirOne, true, cmd))
|
||||||
|
assertDirEntries(t, base, unlockersDir)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -267,6 +267,12 @@ func resolvePassphrase() (*memguard.LockedBuffer, error) {
|
|||||||
func (cli *Instance) CreateVault(cmd *cobra.Command, name string) error {
|
func (cli *Instance) CreateVault(cmd *cobra.Command, name string) error {
|
||||||
secret.Debug("Creating new vault", "name", name, "state_dir", cli.stateDir)
|
secret.Debug("Creating new vault", "name", name, "state_dir", cli.stateDir)
|
||||||
|
|
||||||
|
// vault.CreateVault checks the name too, but only after the prompts below.
|
||||||
|
err := vault.ValidateVaultName(name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -477,6 +483,11 @@ func (cli *Instance) importMnemonic(cmd *cobra.Command, vaultName string) error
|
|||||||
secret.Debug("Importing mnemonic into vault",
|
secret.Debug("Importing mnemonic into vault",
|
||||||
"vault_name", vaultName, "state_dir", cli.stateDir)
|
"vault_name", vaultName, "state_dir", cli.stateDir)
|
||||||
|
|
||||||
|
err := vault.ValidateVaultName(vaultName)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
// Get the specific vault by name
|
// Get the specific vault by name
|
||||||
vlt := vault.NewVault(cli.fs, cli.stateDir, vaultName)
|
vlt := vault.NewVault(cli.fs, cli.stateDir, vaultName)
|
||||||
|
|
||||||
@@ -628,6 +639,11 @@ func (cli *Instance) RemoveVault(cmd *cobra.Command, name string, force bool) er
|
|||||||
|
|
||||||
// removeVault removes a vault with safety checks
|
// removeVault removes a vault with safety checks
|
||||||
func (cli *Instance) removeVault(cmd *cobra.Command, name string, force bool) error {
|
func (cli *Instance) removeVault(cmd *cobra.Command, name string, force bool) error {
|
||||||
|
err := vault.ValidateVaultName(name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
// Get list of all vaults
|
// Get list of all vaults
|
||||||
vaults, err := vault.ListVaults(cli.fs, cli.stateDir)
|
vaults, err := vault.ListVaults(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -17,9 +17,10 @@ var (
|
|||||||
"derived public key does not match vault: mnemonic may be incorrect",
|
"derived public key does not match vault: mnemonic may be incorrect",
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrInvalidVaultName indicates a vault name that does not match the
|
// ErrInvalidVaultName indicates a vault name that breaks the naming
|
||||||
// allowed pattern [a-z0-9.\-_]+. Composed as
|
// rule: only lowercase ASCII letters, digits, '.', '-' and '_'; not
|
||||||
// "invalid vault name '<name>': must match pattern [a-z0-9.\-_]+".
|
// empty, "." or "..". Composed by ValidateVaultName as
|
||||||
|
// "invalid vault name '<name>': <the rule>".
|
||||||
ErrInvalidVaultName = errors.New("invalid vault name")
|
ErrInvalidVaultName = errors.New("invalid vault name")
|
||||||
|
|
||||||
// ErrVaultNotFound indicates the named vault does not exist. Composed
|
// ErrVaultNotFound indicates the named vault does not exist. Composed
|
||||||
|
|||||||
@@ -24,10 +24,12 @@ func init() {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// isValidVaultName validates vault names according to the format [a-z0-9\.\-\_]+
|
// isValidVaultName reports whether name is a valid vault name: only
|
||||||
// Note: We don't allow slashes in vault names unlike secret names
|
// lowercase ASCII letters, digits, '.', '-' and '_', and not empty, "." or
|
||||||
|
// "..". With no path separator allowed, a vault is always one directory
|
||||||
|
// directly under vaults.d.
|
||||||
func isValidVaultName(name string) bool {
|
func isValidVaultName(name string) bool {
|
||||||
if name == "" {
|
if name == "" || name == "." || name == ".." {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -36,6 +38,21 @@ func isValidVaultName(name string) bool {
|
|||||||
return matched
|
return matched
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ValidateVaultName returns an error wrapping ErrInvalidVaultName when name
|
||||||
|
// is not a valid vault name. Call it on the name exactly as the user gave it,
|
||||||
|
// before building any path from it.
|
||||||
|
func ValidateVaultName(name string) error {
|
||||||
|
if !isValidVaultName(name) {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w '%s': only lowercase ASCII letters, digits, '.', '-' and '_' "+
|
||||||
|
"are allowed, and a name must not be empty, '.' or '..'",
|
||||||
|
ErrInvalidVaultName, name,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ResolveVaultSymlink reads the currentvault file to get the path to the current vault
|
// ResolveVaultSymlink reads the currentvault file to get the path to the current vault
|
||||||
// The file contains just the vault name (e.g., "default")
|
// The file contains just the vault name (e.g., "default")
|
||||||
func ResolveVaultSymlink(fs afero.Fs, currentVaultPath string) (string, error) {
|
func ResolveVaultSymlink(fs afero.Fs, currentVaultPath string) (string, error) {
|
||||||
@@ -199,14 +216,11 @@ func processMnemonicForVault(
|
|||||||
func CreateVault(fs afero.Fs, stateDir string, name string) (*Vault, error) {
|
func CreateVault(fs afero.Fs, stateDir string, name string) (*Vault, error) {
|
||||||
secret.Debug("Creating new vault", "name", name, "state_dir", stateDir)
|
secret.Debug("Creating new vault", "name", name, "state_dir", stateDir)
|
||||||
|
|
||||||
// Validate vault name
|
err := ValidateVaultName(name)
|
||||||
if !isValidVaultName(name) {
|
if err != nil {
|
||||||
secret.Debug("Invalid vault name provided", "vault_name", name)
|
secret.Debug("Invalid vault name provided", "vault_name", name)
|
||||||
|
|
||||||
return nil, fmt.Errorf(
|
return nil, err
|
||||||
"%w '%s': must match pattern [a-z0-9.\\-_]+",
|
|
||||||
ErrInvalidVaultName, name,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
secret.Debug("Vault name validation passed", "vault_name", name)
|
secret.Debug("Vault name validation passed", "vault_name", name)
|
||||||
@@ -285,14 +299,11 @@ func CreateVault(fs afero.Fs, stateDir string, name string) (*Vault, error) {
|
|||||||
func SelectVault(fs afero.Fs, stateDir string, name string) error {
|
func SelectVault(fs afero.Fs, stateDir string, name string) error {
|
||||||
secret.Debug("Selecting vault", "vault_name", name, "state_dir", stateDir)
|
secret.Debug("Selecting vault", "vault_name", name, "state_dir", stateDir)
|
||||||
|
|
||||||
// Validate vault name
|
err := ValidateVaultName(name)
|
||||||
if !isValidVaultName(name) {
|
if err != nil {
|
||||||
secret.Debug("Invalid vault name provided", "vault_name", name)
|
secret.Debug("Invalid vault name provided", "vault_name", name)
|
||||||
|
|
||||||
return fmt.Errorf(
|
return err
|
||||||
"%w '%s': must match pattern [a-z0-9.\\-_]+",
|
|
||||||
ErrInvalidVaultName, name,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
secret.Debug("Vault name validation passed", "vault_name", name)
|
secret.Debug("Vault name validation passed", "vault_name", name)
|
||||||
|
|||||||
+77
-70
@@ -126,7 +126,11 @@ func (v *Vault) resolveUnlockerDirectory(currentUnlockerPath string) (string, er
|
|||||||
}
|
}
|
||||||
|
|
||||||
// findUnlockerByID finds an unlocker by its ID and returns the unlocker
|
// findUnlockerByID finds an unlocker by its ID and returns the unlocker
|
||||||
// instance and its directory path
|
// instance and its directory path. A directory that ListUnlockers skips is
|
||||||
|
// skipped here too, with the same warning. Such a directory has no ID: if
|
||||||
|
// no unlocker has the ID unlockerID but such a directory is named
|
||||||
|
// unlockerID, that directory is returned with a nil unlocker, so that
|
||||||
|
// RemoveUnlocker can remove it.
|
||||||
//
|
//
|
||||||
//nolint:ireturn // returns one of several concrete unlocker implementations
|
//nolint:ireturn // returns one of several concrete unlocker implementations
|
||||||
func (v *Vault) findUnlockerByID(
|
func (v *Vault) findUnlockerByID(
|
||||||
@@ -137,42 +141,24 @@ func (v *Vault) findUnlockerByID(
|
|||||||
return nil, "", fmt.Errorf("failed to read unlockers directory: %w", err)
|
return nil, "", fmt.Errorf("failed to read unlockers directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
skippedDirPath := ""
|
||||||
|
|
||||||
for _, file := range files {
|
for _, file := range files {
|
||||||
if !file.IsDir() {
|
if !file.IsDir() {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Read metadata file
|
unlockerDirPath := filepath.Join(unlockersDir, file.Name())
|
||||||
metadataPath := filepath.Join(unlockersDir, file.Name(), "unlocker-metadata.json")
|
|
||||||
|
|
||||||
exists, err := afero.Exists(v.fs, metadataPath)
|
metadata, ok := v.readUnlockerMetadataOrWarn(unlockersDir, file.Name())
|
||||||
if err != nil {
|
if !ok {
|
||||||
return nil, "", fmt.Errorf(
|
if file.Name() == unlockerID {
|
||||||
"failed to check if metadata exists for unlocker %s: %w",
|
skippedDirPath = unlockerDirPath
|
||||||
file.Name(), err)
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if !exists {
|
|
||||||
// Skip directories without metadata - they might not be unlockers
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
metadataBytes, err := afero.ReadFile(v.fs, metadataPath)
|
|
||||||
if err != nil {
|
|
||||||
return nil, "", fmt.Errorf(
|
|
||||||
"failed to read metadata for unlocker %s: %w", file.Name(), err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var metadata UnlockerMetadata
|
|
||||||
|
|
||||||
err = json.Unmarshal(metadataBytes, &metadata)
|
|
||||||
if err != nil {
|
|
||||||
return nil, "", fmt.Errorf(
|
|
||||||
"failed to parse metadata for unlocker %s: %w", file.Name(), err)
|
|
||||||
}
|
|
||||||
|
|
||||||
unlockerDirPath := filepath.Join(unlockersDir, file.Name())
|
|
||||||
|
|
||||||
// Create the appropriate unlocker instance
|
// Create the appropriate unlocker instance
|
||||||
var tempUnlocker secret.Unlocker
|
var tempUnlocker secret.Unlocker
|
||||||
|
|
||||||
@@ -195,7 +181,7 @@ func (v *Vault) findUnlockerByID(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, "", nil
|
return nil, skippedDirPath, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListUnlockers returns a list of available unlockers for this vault
|
// ListUnlockers returns a list of available unlockers for this vault
|
||||||
@@ -226,44 +212,12 @@ func (v *Vault) ListUnlockers() ([]UnlockerMetadata, error) {
|
|||||||
var unlockers []UnlockerMetadata
|
var unlockers []UnlockerMetadata
|
||||||
|
|
||||||
for _, file := range files {
|
for _, file := range files {
|
||||||
if file.IsDir() {
|
if !file.IsDir() {
|
||||||
// Read metadata file
|
continue
|
||||||
metadataPath := filepath.Join(unlockersDir, file.Name(),
|
}
|
||||||
"unlocker-metadata.json")
|
|
||||||
|
|
||||||
exists, err := afero.Exists(v.fs, metadataPath)
|
|
||||||
if err != nil {
|
|
||||||
secret.Warn("Skipping unlocker directory whose metadata file cannot be checked",
|
|
||||||
"directory", file.Name(), "error", err)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if !exists {
|
|
||||||
secret.Warn("Skipping unlocker directory with missing metadata file",
|
|
||||||
"directory", file.Name())
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
metadataBytes, err := afero.ReadFile(v.fs, metadataPath)
|
|
||||||
if err != nil {
|
|
||||||
secret.Warn("Skipping unlocker directory with unreadable metadata file",
|
|
||||||
"directory", file.Name(), "error", err)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
var metadata UnlockerMetadata
|
|
||||||
|
|
||||||
err = json.Unmarshal(metadataBytes, &metadata)
|
|
||||||
if err != nil {
|
|
||||||
secret.Warn("Skipping unlocker directory with corrupt metadata file",
|
|
||||||
"directory", file.Name(), "error", err)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
|
metadata, ok := v.readUnlockerMetadataOrWarn(unlockersDir, file.Name())
|
||||||
|
if ok {
|
||||||
unlockers = append(unlockers, metadata)
|
unlockers = append(unlockers, metadata)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -271,7 +225,54 @@ func (v *Vault) ListUnlockers() ([]UnlockerMetadata, error) {
|
|||||||
return unlockers, nil
|
return unlockers, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveUnlocker removes an unlocker from this vault
|
// readUnlockerMetadataOrWarn reads the metadata of the unlocker directory
|
||||||
|
// name in unlockersDir. If the metadata file cannot be checked for, is
|
||||||
|
// missing, or cannot be read or parsed, it warns, naming the directory,
|
||||||
|
// and returns false: the caller skips that directory.
|
||||||
|
func (v *Vault) readUnlockerMetadataOrWarn(
|
||||||
|
unlockersDir, name string,
|
||||||
|
) (UnlockerMetadata, bool) {
|
||||||
|
metadataPath := filepath.Join(unlockersDir, name, "unlocker-metadata.json")
|
||||||
|
|
||||||
|
var metadata UnlockerMetadata
|
||||||
|
|
||||||
|
exists, err := afero.Exists(v.fs, metadataPath)
|
||||||
|
if err != nil {
|
||||||
|
secret.Warn("Skipping unlocker directory whose metadata file cannot be checked",
|
||||||
|
"directory", name, "error", err)
|
||||||
|
|
||||||
|
return metadata, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if !exists {
|
||||||
|
secret.Warn("Skipping unlocker directory with missing metadata file",
|
||||||
|
"directory", name)
|
||||||
|
|
||||||
|
return metadata, false
|
||||||
|
}
|
||||||
|
|
||||||
|
metadataBytes, err := afero.ReadFile(v.fs, metadataPath)
|
||||||
|
if err != nil {
|
||||||
|
secret.Warn("Skipping unlocker directory with unreadable metadata file",
|
||||||
|
"directory", name, "error", err)
|
||||||
|
|
||||||
|
return metadata, false
|
||||||
|
}
|
||||||
|
|
||||||
|
err = json.Unmarshal(metadataBytes, &metadata)
|
||||||
|
if err != nil {
|
||||||
|
secret.Warn("Skipping unlocker directory with corrupt metadata file",
|
||||||
|
"directory", name, "error", err)
|
||||||
|
|
||||||
|
return metadata, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return metadata, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveUnlocker removes an unlocker from this vault. An unlocker
|
||||||
|
// directory that ListUnlockers skips is removed by its directory name; its
|
||||||
|
// type is unknown, so only the directory is removed.
|
||||||
func (v *Vault) RemoveUnlocker(unlockerID string) error {
|
func (v *Vault) RemoveUnlocker(unlockerID string) error {
|
||||||
vaultDir, err := v.GetDirectory()
|
vaultDir, err := v.GetDirectory()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -282,15 +283,19 @@ func (v *Vault) RemoveUnlocker(unlockerID string) error {
|
|||||||
unlockersDir := filepath.Join(vaultDir, "unlockers.d")
|
unlockersDir := filepath.Join(vaultDir, "unlockers.d")
|
||||||
|
|
||||||
// Find the unlocker by ID
|
// Find the unlocker by ID
|
||||||
unlocker, _, err := v.findUnlockerByID(unlockersDir, unlockerID)
|
unlocker, unlockerDir, err := v.findUnlockerByID(unlockersDir, unlockerID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if unlocker == nil {
|
if unlockerDir == "" {
|
||||||
return fmt.Errorf("unlocker with ID %s %w", unlockerID, ErrUnlockerNotFound)
|
return fmt.Errorf("unlocker with ID %s %w", unlockerID, ErrUnlockerNotFound)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if unlocker == nil {
|
||||||
|
return secret.RemoveDirAtomic(v.fs, unlockerDir)
|
||||||
|
}
|
||||||
|
|
||||||
// Use the unlocker's Remove method
|
// Use the unlocker's Remove method
|
||||||
return unlocker.Remove()
|
return unlocker.Remove()
|
||||||
}
|
}
|
||||||
@@ -306,12 +311,14 @@ func (v *Vault) SelectUnlocker(unlockerID string) error {
|
|||||||
unlockersDir := filepath.Join(vaultDir, "unlockers.d")
|
unlockersDir := filepath.Join(vaultDir, "unlockers.d")
|
||||||
|
|
||||||
// Find the unlocker by ID
|
// Find the unlocker by ID
|
||||||
_, targetUnlockerDir, err := v.findUnlockerByID(unlockersDir, unlockerID)
|
unlocker, targetUnlockerDir, err := v.findUnlockerByID(unlockersDir, unlockerID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if targetUnlockerDir == "" {
|
// A directory found without an unlocker is one ListUnlockers skips; it
|
||||||
|
// cannot be selected.
|
||||||
|
if unlocker == nil {
|
||||||
return fmt.Errorf("unlocker with ID %s %w", unlockerID, ErrUnlockerNotFound)
|
return fmt.Errorf("unlocker with ID %s %w", unlockerID, ErrUnlockerNotFound)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user