Stop secret mv deleting a secret moved onto itself (closes #73)
check / check (push) Successful in 1m32s
check / check (push) Successful in 1m32s
`secret mv --force x x` deleted the secret: a move within one vault removes an existing destination before renaming the source onto it. The same happened for `work:x work:`, `work:x work` and `work:x ""`, where an empty destination defaults to the source name. moveSecretWithinVault now rejects a move whose two names are the same before touching anything. A move within a named vault works in that vault directly instead of selecting it, so the current vault never changes; the vault must be one of the existing vaults. The test runs each rejected move on a copy of two in-memory vaults and requires the exact error and an unchanged state directory. Model: opus-5-5
This commit is contained in:
@@ -25,6 +25,12 @@ Bring the repo into policy compliance in one commit:
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-03: `secret mv` rejects a move whose destination is the
|
||||||
|
source (`mv --force x x`, `mv --force work:x work:`, or an empty
|
||||||
|
destination, which defaults to the source name) before changing
|
||||||
|
anything; before, `--force` removed the destination first and so
|
||||||
|
deleted the secret. A move within a named vault no longer makes that
|
||||||
|
vault the current one, whether it succeeds or fails.
|
||||||
- 2026-10-03: Every command that builds a path from a secret name
|
- 2026-10-03: Every command that builds a path from a secret name
|
||||||
checks the name first with `vault.ValidateSecretName` and touches
|
checks the name first with `vault.ValidateSecretName` and touches
|
||||||
nothing when it is invalid: `rm`, `mv` (both names, within a vault
|
nothing when it is invalid: `rm`, `mv` (both names, within a vault
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
package cli_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.eeqj.de/sneak/secret/internal/cli"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRejectedMoveWithinVaultLeavesStateUnchanged is a regression test for
|
||||||
|
// https://git.eeqj.de/sneak/secret/issues/73, where a forced move of a secret
|
||||||
|
// onto itself deleted it, and a failed move within "work" left "work" the
|
||||||
|
// current vault. "default" is the current vault in every case, and each case
|
||||||
|
// runs on its own copy of the state directory.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // newTwoVaultFs uses t.Setenv
|
||||||
|
func TestRejectedMoveWithinVaultLeavesStateUnchanged(t *testing.T) {
|
||||||
|
before := snapshotStateDir(t, newTwoVaultFs(t))
|
||||||
|
require.Equal(t, "default", before[testStateDir+"/currentvault"])
|
||||||
|
|
||||||
|
const (
|
||||||
|
ontoItself = "secret 'x' cannot be moved onto itself"
|
||||||
|
workX = "work:x"
|
||||||
|
)
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
command string
|
||||||
|
source, dest string
|
||||||
|
force bool
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{"mv x x", "x", "x", false, ontoItself},
|
||||||
|
{"mv --force x x", "x", "x", true, ontoItself},
|
||||||
|
{"mv --force work:x work:", workX, "work:", true, ontoItself},
|
||||||
|
// An empty destination name defaults to the source name.
|
||||||
|
{`mv --force work:x ""`, workX, "", true, ontoItself},
|
||||||
|
// "work" is a vault name, so the destination is work:x.
|
||||||
|
{"mv --force work:x work", workX, "work", true, ontoItself},
|
||||||
|
{
|
||||||
|
"mv work:nosuch work:y", "work:nosuch", "work:y", false,
|
||||||
|
"secret 'nosuch' not found",
|
||||||
|
},
|
||||||
|
// Only an existing vault is used, so ".." cannot reach the state
|
||||||
|
// directory itself.
|
||||||
|
{
|
||||||
|
"mv --force ..:x ..:y", "..:x", "..:y", true,
|
||||||
|
"vault '..' does not exist",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.command, func(t *testing.T) {
|
||||||
|
fs := newFsFromSnapshot(t, before)
|
||||||
|
c := cli.NewCLIInstanceWithStateDir(fs, testStateDir)
|
||||||
|
|
||||||
|
err := c.MoveSecret(&cobra.Command{}, tt.source, tt.dest, tt.force)
|
||||||
|
|
||||||
|
require.Equal(t, before, snapshotStateDir(t, fs))
|
||||||
|
require.EqualError(t, err, tt.wantErr)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMoveWithinOtherVaultKeepsCurrentVault checks that `secret mv work:x
|
||||||
|
// work:y`, with "default" the current vault, renames "x" to "y" in "work" and
|
||||||
|
// leaves "default" the current vault.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // newTwoVaultFs uses t.Setenv
|
||||||
|
func TestMoveWithinOtherVaultKeepsCurrentVault(t *testing.T) {
|
||||||
|
fs := newTwoVaultFs(t)
|
||||||
|
c := cli.NewCLIInstanceWithStateDir(fs, testStateDir)
|
||||||
|
|
||||||
|
err := c.MoveSecret(&cobra.Command{}, "work:x", "work:y", false)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
after := snapshotStateDir(t, fs)
|
||||||
|
workSecrets := testStateDir + "/vaults.d/work/secrets.d/"
|
||||||
|
|
||||||
|
require.Equal(t, "default", after[testStateDir+"/currentvault"])
|
||||||
|
require.Contains(t, after, workSecrets+"y/")
|
||||||
|
require.NotContains(t, after, workSecrets+"x/")
|
||||||
|
}
|
||||||
+42
-21
@@ -40,6 +40,7 @@ var (
|
|||||||
errVaultDoesNotExist = errors.New("does not exist")
|
errVaultDoesNotExist = errors.New("does not exist")
|
||||||
errCrossVaultSourceUnqualified = errors.New(
|
errCrossVaultSourceUnqualified = errors.New(
|
||||||
"source must specify vault (e.g., vault:secret) for cross-vault move")
|
"source must specify vault (e.g., vault:secret) for cross-vault move")
|
||||||
|
errMoveOntoItself = errors.New("cannot be moved onto itself")
|
||||||
)
|
)
|
||||||
|
|
||||||
// bufferInfo tracks a protected buffer and the number of bytes used in it
|
// bufferInfo tracks a protected buffer and the number of bytes used in it
|
||||||
@@ -740,8 +741,8 @@ func (cli *Instance) MoveSecret(
|
|||||||
destSecretName = srcSecretName
|
destSecretName = srcSecretName
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check both names, for every form of the move, before selecting a vault
|
// Check both names, for every form of the move, before building any path
|
||||||
// below, so that a rejected move leaves the current vault as it was.
|
// from them.
|
||||||
err := vault.ValidateSecretName(srcSecretName)
|
err := vault.ValidateSecretName(srcSecretName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -752,20 +753,24 @@ func (cli *Instance) MoveSecret(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// If neither is qualified, this is a simple within-vault rename
|
// A move within one vault: the current vault when neither name is
|
||||||
if !srcQualified && !destQualified {
|
// qualified (both vault names are then empty), else the named vault,
|
||||||
return cli.moveSecretWithinVault(cmd, srcSecretName, destSecretName, force)
|
// which does not become the current vault.
|
||||||
}
|
|
||||||
|
|
||||||
// Same vault? Use simple rename if possible (optimization)
|
|
||||||
if srcVaultName == destVaultName {
|
if srcVaultName == destVaultName {
|
||||||
// Select the vault and do a simple move
|
var vlt *vault.Vault
|
||||||
err = vault.SelectVault(cli.fs, cli.stateDir, srcVaultName)
|
|
||||||
if err != nil {
|
if srcQualified {
|
||||||
return fmt.Errorf("failed to select vault '%s': %w", srcVaultName, err)
|
vlt, err = cli.existingVault(srcVaultName)
|
||||||
|
} else {
|
||||||
|
vlt, err = vault.GetCurrentVault(cli.fs, cli.stateDir)
|
||||||
}
|
}
|
||||||
|
|
||||||
return cli.moveSecretWithinVault(cmd, srcSecretName, destSecretName, force)
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return cli.moveSecretWithinVault(
|
||||||
|
cmd, vlt, srcSecretName, destSecretName, force)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cross-vault move
|
// Cross-vault move
|
||||||
@@ -773,17 +778,33 @@ func (cli *Instance) MoveSecret(
|
|||||||
cmd, srcVaultName, srcSecretName, destVaultName, destSecretName, force)
|
cmd, srcVaultName, srcSecretName, destVaultName, destSecretName, force)
|
||||||
}
|
}
|
||||||
|
|
||||||
// moveSecretWithinVault handles rename within the current vault. Its caller,
|
// existingVault returns the vault with the given name, or an error if there
|
||||||
// MoveSecret, has already checked both secret names.
|
// is none. Unlike vault.SelectVault, it leaves the current vault as it is.
|
||||||
func (cli *Instance) moveSecretWithinVault(
|
func (cli *Instance) existingVault(name string) (*vault.Vault, error) {
|
||||||
cmd *cobra.Command, source, dest string, force bool,
|
vaults, err := vault.ListVaults(cli.fs, cli.stateDir)
|
||||||
) error {
|
|
||||||
currentVlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return nil, fmt.Errorf("failed to list vaults: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
vaultDir, err := currentVlt.GetDirectory()
|
if !slices.Contains(vaults, name) {
|
||||||
|
return nil, fmt.Errorf("vault '%s' %w", name, errVaultDoesNotExist)
|
||||||
|
}
|
||||||
|
|
||||||
|
return vault.NewVault(cli.fs, cli.stateDir, name), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// moveSecretWithinVault renames a secret within the vault vlt. Its caller,
|
||||||
|
// MoveSecret, has already checked both secret names.
|
||||||
|
func (cli *Instance) moveSecretWithinVault(
|
||||||
|
cmd *cobra.Command, vlt *vault.Vault, source, dest string, force bool,
|
||||||
|
) error {
|
||||||
|
// With --force the destination is removed before the source is renamed
|
||||||
|
// onto it, which would delete the secret.
|
||||||
|
if source == dest {
|
||||||
|
return fmt.Errorf("secret '%s' %w", source, errMoveOntoItself)
|
||||||
|
}
|
||||||
|
|
||||||
|
vaultDir, err := vlt.GetDirectory()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user