Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a7986df1f7 |
@@ -438,14 +438,6 @@ asks when stdin is a pipe, as in `echo value | secret add name --force` or
|
|||||||
`cat file | secret encrypt key`. With no controlling terminal, as under cron or
|
`cat file | secret encrypt key`. With no controlling terminal, as under cron or
|
||||||
in a CI job, the command fails and names the variable to set.
|
in a CI job, the command fails and names the variable to set.
|
||||||
|
|
||||||
A command that changes anything locks the state directory, through its file
|
|
||||||
`lock`, and another such command waits until the lock is released.
|
|
||||||
`secret init`, `secret vault create`, `secret unlocker add`, `secret mv` from
|
|
||||||
one vault to another, and `secret add`, `secret import` and
|
|
||||||
`secret generate secret` with `--force`, ask for the mnemonic or passphrase
|
|
||||||
before they take the lock, so a prompt of theirs left open in one terminal holds
|
|
||||||
up no command in another.
|
|
||||||
|
|
||||||
## Security Features
|
## Security Features
|
||||||
|
|
||||||
### Encryption
|
### Encryption
|
||||||
|
|||||||
@@ -175,6 +175,12 @@ func (cli *Instance) GenerateSecret(
|
|||||||
return fmt.Errorf("failed to generate random secret: %w", err)
|
return fmt.Errorf("failed to generate random secret: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer release()
|
||||||
|
|
||||||
// Store the secret in the vault
|
// Store the secret in the vault
|
||||||
vlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
vlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -187,7 +193,7 @@ func (cli *Instance) GenerateSecret(
|
|||||||
secretBuffer := memguard.NewBufferFromBytes([]byte(secretValue))
|
secretBuffer := memguard.NewBufferFromBytes([]byte(secretValue))
|
||||||
defer secretBuffer.Destroy()
|
defer secretBuffer.Destroy()
|
||||||
|
|
||||||
err = cli.storeSecret(vlt, secretName, secretBuffer, force)
|
err = vlt.AddSecret(secretName, secretBuffer, force)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
+27
-33
@@ -67,15 +67,36 @@ func (cli *Instance) promptMnemonic() (*memguard.LockedBuffer, func(), error) {
|
|||||||
return mnemonicBuffer, mnemonicBuffer.Destroy, nil
|
return mnemonicBuffer, mnemonicBuffer.Destroy, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Init initializes the secret manager. It asks for the mnemonic and the
|
// Init initializes the secret manager, holding the state directory lock
|
||||||
// passphrase before it takes the state directory lock, so that no other
|
// while initialize runs
|
||||||
// command waits while the user answers, and holds the lock while
|
|
||||||
// initialize runs.
|
|
||||||
func (cli *Instance) Init(cmd *cobra.Command) error {
|
func (cli *Instance) Init(cmd *cobra.Command) error {
|
||||||
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer release()
|
||||||
|
|
||||||
|
return cli.initialize(cmd)
|
||||||
|
}
|
||||||
|
|
||||||
|
// initialize creates the state directory, the default vault and its first
|
||||||
|
// unlocker
|
||||||
|
func (cli *Instance) initialize(cmd *cobra.Command) error {
|
||||||
secret.Debug("Starting secret manager initialization")
|
secret.Debug("Starting secret manager initialization")
|
||||||
|
|
||||||
|
// Create state directory
|
||||||
|
stateDir := cli.GetStateDir()
|
||||||
|
secret.DebugWith("Creating state directory", slog.String("path", stateDir))
|
||||||
|
|
||||||
|
err := cli.fs.MkdirAll(stateDir, secret.DirPerms)
|
||||||
|
if err != nil {
|
||||||
|
secret.Debug("Failed to create state directory", "error", err)
|
||||||
|
|
||||||
|
return fmt.Errorf("failed to create state directory: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
// Refuse an existing default vault before asking for anything
|
// Refuse an existing default vault before asking for anything
|
||||||
err := vault.CheckNewVaultName(cli.fs, cli.stateDir, defaultVaultName)
|
err = vault.CheckNewVaultName(cli.fs, cli.stateDir, defaultVaultName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to create default vault: %w", err)
|
return fmt.Errorf("failed to create default vault: %w", err)
|
||||||
}
|
}
|
||||||
@@ -114,38 +135,11 @@ func (cli *Instance) Init(cmd *cobra.Command) error {
|
|||||||
}
|
}
|
||||||
defer cleanupPassphrase()
|
defer cleanupPassphrase()
|
||||||
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer release()
|
|
||||||
|
|
||||||
return cli.initialize(cmd, mnemonic, passphraseBuffer)
|
|
||||||
}
|
|
||||||
|
|
||||||
// initialize creates the state directory, and the default vault from
|
|
||||||
// mnemonic with a passphrase unlocker protected by passphrase. Another
|
|
||||||
// command may have created the vault since Init checked: vault.CreateVault
|
|
||||||
// checks again.
|
|
||||||
func (cli *Instance) initialize(
|
|
||||||
cmd *cobra.Command, mnemonic, passphrase *memguard.LockedBuffer,
|
|
||||||
) error {
|
|
||||||
// Create state directory
|
|
||||||
stateDir := cli.GetStateDir()
|
|
||||||
secret.DebugWith("Creating state directory", slog.String("path", stateDir))
|
|
||||||
|
|
||||||
err := cli.fs.MkdirAll(stateDir, secret.DirPerms)
|
|
||||||
if err != nil {
|
|
||||||
secret.Debug("Failed to create state directory", "error", err)
|
|
||||||
|
|
||||||
return fmt.Errorf("failed to create state directory: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create the default vault with its passphrase unlocker
|
// Create the default vault with its passphrase unlocker
|
||||||
secret.Debug("Creating default vault")
|
secret.Debug("Creating default vault")
|
||||||
|
|
||||||
vlt, err := vault.CreateVault(cli.fs, cli.stateDir, defaultVaultName,
|
vlt, err := vault.CreateVault(cli.fs, cli.stateDir, defaultVaultName,
|
||||||
mnemonic, passphrase)
|
mnemonic, passphraseBuffer)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to create default vault", "error", err)
|
secret.Debug("Failed to create default vault", "error", err)
|
||||||
|
|
||||||
|
|||||||
+14
-328
@@ -280,9 +280,9 @@ func stateDirModTimes(t *testing.T, fs afero.Fs) map[string]int64 {
|
|||||||
return modTimes
|
return modTimes
|
||||||
}
|
}
|
||||||
|
|
||||||
// setupEveryCommand makes what the commands that the lock tests below run
|
// setupEveryCommand makes what each command in
|
||||||
// need: the current vault "work" with two versions of "test/secret", the
|
// TestChangingCommandsWaitForLock needs: the current vault "work" with two
|
||||||
// vault "other", and the file testInput.
|
// versions of "test/secret", the vault "other", and the file testInput.
|
||||||
// There is no vault "default", which init creates. If withUnlocker is set,
|
// There is no vault "default", which init creates. If withUnlocker is set,
|
||||||
// it also gives "work" a passphrase unlocker, which is slow. It returns the
|
// it also gives "work" a passphrase unlocker, which is slow. It returns the
|
||||||
// older version and the unlocker's ID.
|
// older version and the unlocker's ID.
|
||||||
@@ -346,25 +346,6 @@ func waitingForLock() bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
// requireWaitingForLock returns once a command waits for the state
|
|
||||||
// directory lock. It fails the test if the command finishes first, sending
|
|
||||||
// its error on done, or never waits.
|
|
||||||
func requireWaitingForLock(t *testing.T, done <-chan error) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
timeout := time.After(lockWait)
|
|
||||||
|
|
||||||
for !waitingForLock() {
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
t.Fatalf("finished while the lock was held, with error %v", err)
|
|
||||||
case <-timeout:
|
|
||||||
t.Fatal("never waited for the lock")
|
|
||||||
case <-time.After(time.Millisecond):
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// requireWaitsForLock runs a command, given what setupEveryCommand made,
|
// requireWaitsForLock runs a command, given what setupEveryCommand made,
|
||||||
// while holding the state directory lock. The command must neither finish
|
// while holding the state directory lock. The command must neither finish
|
||||||
// nor change anything before it waits for the lock, and must succeed once
|
// nor change anything before it waits for the lock, and must succeed once
|
||||||
@@ -404,7 +385,17 @@ func requireWaitsForLock(
|
|||||||
|
|
||||||
go func() { done <- run(cli, olderVersion, unlockerID) }()
|
go func() { done <- run(cli, olderVersion, unlockerID) }()
|
||||||
|
|
||||||
requireWaitingForLock(t, done)
|
timeout := time.After(lockWait)
|
||||||
|
|
||||||
|
for !waitingForLock() {
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
t.Fatalf("finished while the lock was held, with error %v", err)
|
||||||
|
case <-timeout:
|
||||||
|
t.Fatal("never waited for the lock")
|
||||||
|
case <-time.After(time.Millisecond):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
assert.Equal(t, before, stateDirModTimes(t, fs),
|
assert.Equal(t, before, stateDirModTimes(t, fs),
|
||||||
"changed the state directory before waiting for the lock")
|
"changed the state directory before waiting for the lock")
|
||||||
@@ -481,311 +472,6 @@ func TestChangingCommandsWaitForLock(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestCommandsAskBeforeLocking is a regression test for
|
|
||||||
// https://git.eeqj.de/sneak/secret/issues/152: these commands took the
|
|
||||||
// state directory lock before asking for the mnemonic or a passphrase, so
|
|
||||||
// while one waited at its prompt, every other command that changes anything
|
|
||||||
// waited for it. Each runs here while the test holds the lock, given what
|
|
||||||
// takes it to the last step at which it can ask: the passphrase prompt of
|
|
||||||
// init and vault create, and the unlock of the vault, which asks for the
|
|
||||||
// passphrase of its passphrase unlocker, for the others. The tests have no
|
|
||||||
// terminal, so a prompt fails at once. Each command must get there, and
|
|
||||||
// fail, without waiting for the lock.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // waitingForLock sees any test's command waiting for the lock
|
|
||||||
func TestCommandsAskBeforeLocking(t *testing.T) {
|
|
||||||
newTestGPGKey(t)
|
|
||||||
|
|
||||||
mnemonic := testMnemonicBuffer(t)
|
|
||||||
|
|
||||||
wrongPassphrase := memguard.NewBufferFromBytes([]byte("wrong-passphrase"))
|
|
||||||
t.Cleanup(wrongPassphrase.Destroy)
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
run func(cli *Instance) error
|
|
||||||
// want is wrapped in the error the command fails with
|
|
||||||
want error
|
|
||||||
}{
|
|
||||||
{"init", func(cli *Instance) error {
|
|
||||||
cli.Mnemonic = mnemonic
|
|
||||||
|
|
||||||
return cli.Init(cli.cmd)
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
{"vault create", func(cli *Instance) error {
|
|
||||||
cli.Mnemonic = mnemonic
|
|
||||||
|
|
||||||
return cli.CreateVault(cli.cmd, "created")
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
// With no terminal to ask for the new passphrase on, the new
|
|
||||||
// unlocker takes the one in SB_UNLOCK_PASSPHRASE, which then fails
|
|
||||||
// to unlock the vault
|
|
||||||
{"unlocker add passphrase", func(cli *Instance) error {
|
|
||||||
cli.UnlockPassphrase = wrongPassphrase
|
|
||||||
|
|
||||||
return cli.UnlockersAdd("passphrase", cli.cmd)
|
|
||||||
}, secret.ErrWrongPassphrase},
|
|
||||||
{"unlocker add pgp", func(cli *Instance) error {
|
|
||||||
cli.cmd.Flags().String("keyid", unreadableTestGPGUserID, "")
|
|
||||||
|
|
||||||
return cli.UnlockersAdd("pgp", cli.cmd)
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
{"add --force", func(cli *Instance) error {
|
|
||||||
return cli.AddSecret("test/secret", true)
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
{"import --force", func(cli *Instance) error {
|
|
||||||
return cli.ImportSecret(cli.cmd, "test/secret", testInput, true)
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
{"generate secret --force", func(cli *Instance) error {
|
|
||||||
return cli.GenerateSecret(cli.cmd, "test/secret", 16, "base58", true)
|
|
||||||
}, secret.ErrNoTerminal},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
requireAsksBeforeLocking(t, tc.run, tc.want)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// startWhileLocked makes what setupEveryCommand makes, with the passphrase
|
|
||||||
// unlocker, on fs, an empty in-memory filesystem, takes the state directory
|
|
||||||
// lock there, and starts run, given a CLI instance on fs with "value" on
|
|
||||||
// stdin. It returns the function that releases the lock, which does so only
|
|
||||||
// the first time it is called, and the channel that run's error comes on.
|
|
||||||
// The lock is also released when the test ends, so that later tests can
|
|
||||||
// take it.
|
|
||||||
func startWhileLocked(
|
|
||||||
t *testing.T, fs afero.Fs, run func(cli *Instance) error,
|
|
||||||
) (func(), <-chan error) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
setupEveryCommand(t, fs, true)
|
|
||||||
|
|
||||||
release, err := vault.LockStateDir(fs, testStateDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
release = sync.OnceFunc(release)
|
|
||||||
t.Cleanup(release)
|
|
||||||
|
|
||||||
cli := NewCLIInstanceWithStateDir(fs, testStateDir)
|
|
||||||
cli.cmd = &cobra.Command{}
|
|
||||||
cli.cmd.SetIn(strings.NewReader("value"))
|
|
||||||
cli.cmd.SetOut(io.Discard)
|
|
||||||
|
|
||||||
done := make(chan error, 1)
|
|
||||||
|
|
||||||
go func() { done <- run(cli) }()
|
|
||||||
|
|
||||||
return release, done
|
|
||||||
}
|
|
||||||
|
|
||||||
// requireAsksBeforeLocking starts run while holding the state directory
|
|
||||||
// lock, as startWhileLocked does. run must fail, with an error wrapping
|
|
||||||
// want, without waiting for the lock.
|
|
||||||
func requireAsksBeforeLocking(
|
|
||||||
t *testing.T, run func(cli *Instance) error, want error,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
release, done := startWhileLocked(t, afero.NewMemMapFs(), run)
|
|
||||||
|
|
||||||
timeout := time.After(lockWait)
|
|
||||||
|
|
||||||
for !waitingForLock() {
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.ErrorIs(t, err, want)
|
|
||||||
|
|
||||||
return
|
|
||||||
case <-timeout:
|
|
||||||
t.Fatal("neither failed nor waited for the lock")
|
|
||||||
case <-time.After(time.Millisecond):
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Let the command go on, so that it releases the lock
|
|
||||||
release()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
case <-time.After(lockWait):
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Fatal("waited for the lock before asking")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCommandsCheckAgainOnceLocked checks that commands which check what
|
|
||||||
// they change before they ask for anything, and so before they take the
|
|
||||||
// state directory lock, check again once they hold it: another command may
|
|
||||||
// have changed it in the meantime. Each runs while the test holds the lock,
|
|
||||||
// given what it needs to ask for nothing. Once it waits for the lock, the
|
|
||||||
// test makes the change another command could have made, then releases the
|
|
||||||
// lock. The command must fail, and change nothing.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // waitingForLock sees any test's command waiting for the lock
|
|
||||||
func TestCommandsCheckAgainOnceLocked(t *testing.T) {
|
|
||||||
fingerprint := newTestGPGKey(t)
|
|
||||||
|
|
||||||
mnemonic := testMnemonicBuffer(t)
|
|
||||||
|
|
||||||
otherMnemonic := memguard.NewBufferFromBytes([]byte("legal winner thank " +
|
|
||||||
"year wave sausage worth useful legal winner thank yellow"))
|
|
||||||
t.Cleanup(otherMnemonic.Destroy)
|
|
||||||
|
|
||||||
passphrase := memguard.NewBufferFromBytes([]byte(testPassphrase))
|
|
||||||
t.Cleanup(passphrase.Destroy)
|
|
||||||
|
|
||||||
// work returns the vault "work" on fs, opened with the mnemonic
|
|
||||||
work := func(fs afero.Fs) *vault.Vault {
|
|
||||||
vlt := vault.NewVault(fs, testStateDir, "work")
|
|
||||||
vlt.Mnemonic = mnemonic
|
|
||||||
|
|
||||||
return vlt
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
run func(cli *Instance) error
|
|
||||||
// change is what another command changes while run waits
|
|
||||||
change func(fs afero.Fs) error
|
|
||||||
// want is wrapped in the error the command fails with
|
|
||||||
want error
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
"unlocker add, vault removed",
|
|
||||||
func(cli *Instance) error {
|
|
||||||
cli.Mnemonic, cli.UnlockPassphrase = mnemonic, passphrase
|
|
||||||
|
|
||||||
return cli.UnlockersAdd("passphrase", cli.cmd)
|
|
||||||
},
|
|
||||||
func(fs afero.Fs) error {
|
|
||||||
return fs.RemoveAll(testStateDir + "/vaults.d/work")
|
|
||||||
},
|
|
||||||
vault.ErrVaultNotFound,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"unlocker add, vault created again from another mnemonic",
|
|
||||||
func(cli *Instance) error {
|
|
||||||
cli.Mnemonic, cli.UnlockPassphrase = mnemonic, passphrase
|
|
||||||
|
|
||||||
return cli.UnlockersAdd("passphrase", cli.cmd)
|
|
||||||
},
|
|
||||||
func(fs afero.Fs) error {
|
|
||||||
err := fs.RemoveAll(testStateDir + "/vaults.d/work")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = vault.CreateVault(fs, testStateDir, "work",
|
|
||||||
otherMnemonic, passphrase)
|
|
||||||
|
|
||||||
return err
|
|
||||||
},
|
|
||||||
errVaultCreatedAgain,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"unlocker add pgp, key added",
|
|
||||||
func(cli *Instance) error {
|
|
||||||
cli.Mnemonic = mnemonic
|
|
||||||
cli.cmd.Flags().String("keyid", unreadableTestGPGUserID, "")
|
|
||||||
|
|
||||||
return cli.UnlockersAdd("pgp", cli.cmd)
|
|
||||||
},
|
|
||||||
func(fs afero.Fs) error {
|
|
||||||
_, err := secret.CreatePGPUnlocker(work(fs),
|
|
||||||
unreadableTestGPGUserID, fingerprint)
|
|
||||||
|
|
||||||
return err
|
|
||||||
},
|
|
||||||
errGPGKeyAlreadyUnlocker,
|
|
||||||
},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
requireChecksAgainOnceLocked(t, tc.run, tc.change, tc.want)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// requireChecksAgainOnceLocked starts run while holding the state directory
|
|
||||||
// lock, as startWhileLocked does. Once run waits for the lock, change makes
|
|
||||||
// the change that another command could have made in the meantime, and the
|
|
||||||
// lock is released. run must then fail, with an error wrapping want, and
|
|
||||||
// change nothing.
|
|
||||||
func requireChecksAgainOnceLocked(
|
|
||||||
t *testing.T, run func(cli *Instance) error,
|
|
||||||
change func(fs afero.Fs) error, want error,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
|
||||||
release, done := startWhileLocked(t, fs, run)
|
|
||||||
|
|
||||||
requireWaitingForLock(t, done)
|
|
||||||
require.NoError(t, change(fs))
|
|
||||||
|
|
||||||
// Left out: taking and releasing the lock writes the lock file
|
|
||||||
lockFile := testStateDir + "/lock"
|
|
||||||
|
|
||||||
before := stateDirModTimes(t, fs)
|
|
||||||
delete(before, lockFile)
|
|
||||||
|
|
||||||
release()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.ErrorIs(t, err, want)
|
|
||||||
case <-time.After(lockWait):
|
|
||||||
t.Fatal("did not finish once the lock was released")
|
|
||||||
}
|
|
||||||
|
|
||||||
after := stateDirModTimes(t, fs)
|
|
||||||
delete(after, lockFile)
|
|
||||||
|
|
||||||
assert.Equal(t, before, after, "changed the state directory")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestForcedAddReplacesSecretAddedMeanwhile runs a forced add of a secret
|
|
||||||
// that does not exist yet while the test holds the state directory lock.
|
|
||||||
// Once it waits for the lock, the test adds the secret, as another command
|
|
||||||
// could have, and releases the lock. The forced add must replace that
|
|
||||||
// secret, as if it had run after the other command.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // waitingForLock sees any test's command waiting for the lock
|
|
||||||
func TestForcedAddReplacesSecretAddedMeanwhile(t *testing.T) {
|
|
||||||
mnemonic := testMnemonicBuffer(t)
|
|
||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
|
||||||
release, done := startWhileLocked(t, fs, func(cli *Instance) error {
|
|
||||||
cli.Mnemonic = mnemonic
|
|
||||||
|
|
||||||
return cli.AddSecret("added", true)
|
|
||||||
})
|
|
||||||
|
|
||||||
requireWaitingForLock(t, done)
|
|
||||||
|
|
||||||
work := vault.NewVault(fs, testStateDir, "work")
|
|
||||||
work.Mnemonic = mnemonic
|
|
||||||
|
|
||||||
other := memguard.NewBufferFromBytes([]byte("other"))
|
|
||||||
t.Cleanup(other.Destroy)
|
|
||||||
|
|
||||||
require.NoError(t, work.AddSecret("added", other, false))
|
|
||||||
|
|
||||||
release()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.NoError(t, err)
|
|
||||||
case <-time.After(lockWait):
|
|
||||||
t.Fatal("did not finish once the lock was released")
|
|
||||||
}
|
|
||||||
|
|
||||||
value, err := work.GetSecret("added")
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(value.Destroy)
|
|
||||||
|
|
||||||
assert.Equal(t, "value", string(value.Bytes()))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEncryptWithExistingKeyTakesNoLock checks that secret encrypt with a
|
// TestEncryptWithExistingKeyTakesNoLock checks that secret encrypt with a
|
||||||
// key that already exists, which only reads the state directory, finishes
|
// key that already exists, which only reads the state directory, finishes
|
||||||
// while another command holds the state directory lock.
|
// while another command holds the state directory lock.
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ package cli
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -229,87 +230,68 @@ func TestCrossVaultMoveUnlocksBeforeLocking(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestCrossVaultMoveChecksAgainOnceLocked runs a move between vaults, given
|
// TestCrossVaultMoveChecksAgainOnceLocked starts a move between two vaults,
|
||||||
// the mnemonic, as TestCommandsCheckAgainOnceLocked runs the commands in its
|
// given the mnemonic, while the test holds the state directory lock. Once
|
||||||
// table: once the move waits for the state directory lock, the test removes
|
// the move waits for the lock, the test removes what another command could
|
||||||
// the source secret or the destination vault, or creates the destination
|
// have removed in the meantime, then releases the lock. The move must fail
|
||||||
// vault again from another mnemonic, and the move must then fail and change
|
// with the error that says what is missing.
|
||||||
// nothing.
|
|
||||||
//
|
//
|
||||||
//nolint:paralleltest // waitingForLock sees any test's command waiting for the lock
|
//nolint:paralleltest // waitingForLock sees any test's command waiting for the lock
|
||||||
func TestCrossVaultMoveChecksAgainOnceLocked(t *testing.T) {
|
func TestCrossVaultMoveChecksAgainOnceLocked(t *testing.T) {
|
||||||
mnemonic := testMnemonicBuffer(t)
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
otherMnemonic := memguard.NewBufferFromBytes([]byte("legal winner thank " +
|
// removed is the directory, under the state directory, that the
|
||||||
"year wave sausage worth useful legal winner thank yellow"))
|
// test removes
|
||||||
t.Cleanup(otherMnemonic.Destroy)
|
removed string
|
||||||
|
want error
|
||||||
move := func(cli *Instance) error {
|
}{
|
||||||
cli.Mnemonic = mnemonic
|
{"source", "/vaults.d/default/secrets.d/x", vault.ErrSecretNotFound},
|
||||||
|
{"destination vault", "/vaults.d/work", vault.ErrVaultNotFound},
|
||||||
return cli.MoveSecret(cli.cmd, "work:test/secret", "other:moved", false)
|
} {
|
||||||
}
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
|
||||||
t.Run("source removed", func(t *testing.T) {
|
|
||||||
requireChecksAgainOnceLocked(t, move, func(fs afero.Fs) error {
|
|
||||||
return fs.RemoveAll(testStateDir + "/vaults.d/work/secrets.d/test%secret")
|
|
||||||
}, vault.ErrSecretNotFound)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("destination vault removed", func(t *testing.T) {
|
|
||||||
requireChecksAgainOnceLocked(t, move, func(fs afero.Fs) error {
|
|
||||||
return fs.RemoveAll(testStateDir + "/vaults.d/other")
|
|
||||||
}, vault.ErrVaultNotFound)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("destination vault created again from another mnemonic", func(t *testing.T) {
|
|
||||||
// Set by the move, which has finished once
|
|
||||||
// requireChecksAgainOnceLocked returns
|
|
||||||
var moveErr error
|
|
||||||
|
|
||||||
requireChecksAgainOnceLocked(t, func(cli *Instance) error {
|
|
||||||
moveErr = move(cli)
|
|
||||||
|
|
||||||
return moveErr
|
|
||||||
}, func(fs afero.Fs) error {
|
|
||||||
err := fs.RemoveAll(testStateDir + "/vaults.d/other")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = vault.CreateVault(fs, testStateDir, "other", otherMnemonic, nil)
|
|
||||||
|
|
||||||
return err
|
|
||||||
}, errVaultCreatedAgain)
|
|
||||||
|
|
||||||
// secret unlocker add fails with the same error, so its message
|
|
||||||
// must fit a move too
|
|
||||||
require.EqualError(t, moveErr, "vault 'other' was removed and "+
|
|
||||||
"created again with another key while it was being unlocked; "+
|
|
||||||
"nothing was changed")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCrossVaultMoveRefusesExistingSecretBeforeUnlocking checks that a move
|
|
||||||
// between vaults onto a secret that exists, without --force, is refused
|
|
||||||
// before either vault is unlocked, since unlocking can ask for a
|
|
||||||
// passphrase. The vaults have no unlockers and the move is given no
|
|
||||||
// mnemonic, so unlocking either vault fails.
|
|
||||||
func TestCrossVaultMoveRefusesExistingSecretBeforeUnlocking(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
fs := afero.NewMemMapFs()
|
||||||
createCrossVaults(t, fs)
|
createCrossVaults(t, fs)
|
||||||
|
|
||||||
work := vault.NewVault(fs, testStateDir, "work")
|
release, err := vault.LockStateDir(fs, testStateDir)
|
||||||
work.Mnemonic = testMnemonicBuffer(t)
|
|
||||||
|
|
||||||
err := work.AddSecret("y",
|
|
||||||
memguard.NewBufferFromBytes([]byte("other")), false)
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
instance := NewCLIInstanceWithStateDir(fs, testStateDir)
|
// Released at most once, and also if the test fails while
|
||||||
|
// holding it, so that later tests can take it
|
||||||
|
release = sync.OnceFunc(release)
|
||||||
|
defer release()
|
||||||
|
|
||||||
err = instance.MoveSecret(&cobra.Command{}, "default:x", "work:y", false)
|
instance := NewCLIInstanceWithStateDir(fs, testStateDir)
|
||||||
require.ErrorIs(t, err, vault.ErrSecretExists)
|
instance.Mnemonic = testMnemonicBuffer(t)
|
||||||
|
|
||||||
|
done := make(chan error, 1)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
done <- instance.MoveSecret(&cobra.Command{},
|
||||||
|
"default:x", "work:y", false)
|
||||||
|
}()
|
||||||
|
|
||||||
|
timeout := time.After(lockWait)
|
||||||
|
|
||||||
|
for !waitingForLock() {
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
t.Fatalf("finished while the lock was held, with error %v",
|
||||||
|
err)
|
||||||
|
case <-timeout:
|
||||||
|
t.Fatal("never waited for the lock")
|
||||||
|
case <-time.After(time.Millisecond):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, fs.RemoveAll(testStateDir+tc.removed))
|
||||||
|
release()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
require.ErrorIs(t, err, tc.want)
|
||||||
|
case <-time.After(lockWait):
|
||||||
|
t.Fatal("did not finish once the lock was released")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+36
-111
@@ -422,92 +422,26 @@ func (cli *Instance) AddSecret(secretName string, force bool) error {
|
|||||||
// Locked only now that stdin has been read: in `secret encrypt key |
|
// Locked only now that stdin has been read: in `secret encrypt key |
|
||||||
// secret add name`, holding the lock while reading would leave each
|
// secret add name`, holding the lock while reading would leave each
|
||||||
// command waiting for the other.
|
// command waiting for the other.
|
||||||
return cli.storeSecret(vlt, secretName, valueBuffer, force)
|
|
||||||
}
|
|
||||||
|
|
||||||
// storeSecret adds the secret name with value to vlt, as vault.AddSecret
|
|
||||||
// does, holding the state directory lock while it does. With force, adding
|
|
||||||
// an existing secret replaces its current version, which needs the vault's
|
|
||||||
// long-term key. Getting the key can ask for the passphrase, so storeSecret
|
|
||||||
// gets it before it takes the lock, and no other command waits while the
|
|
||||||
// user answers. If another command adds the secret while this one waits for
|
|
||||||
// the lock, storeSecret lets go of the lock, gets the key, and takes the
|
|
||||||
// lock again.
|
|
||||||
func (cli *Instance) storeSecret(
|
|
||||||
vlt *vault.Vault, name string, value *memguard.LockedBuffer, force bool,
|
|
||||||
) error {
|
|
||||||
err := vault.ValidateSecretName(name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
replacing, err := replacesVersion(vlt, name, force)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if replacing {
|
|
||||||
_, err = vlt.GetOrDeriveLongTermKey()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to get long-term key: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
needsKey, err := cli.addWithoutAsking(vlt, name, value, force)
|
|
||||||
if !needsKey {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = vlt.GetOrDeriveLongTermKey()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to get long-term key: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// With the key in memory, this adds the secret
|
|
||||||
_, err = cli.addWithoutAsking(vlt, name, value, force)
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// addWithoutAsking takes the state directory lock and adds the secret name
|
|
||||||
// with value to vlt, as vault.AddSecret does. If that would replace the
|
|
||||||
// secret's current version while the vault's long-term key is not in
|
|
||||||
// memory, getting the key could ask for the passphrase with the lock held:
|
|
||||||
// addWithoutAsking then adds nothing and returns true.
|
|
||||||
func (cli *Instance) addWithoutAsking(
|
|
||||||
vlt *vault.Vault, name string, value *memguard.LockedBuffer, force bool,
|
|
||||||
) (bool, error) {
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return err
|
||||||
}
|
}
|
||||||
defer release()
|
defer release()
|
||||||
|
|
||||||
replacing, err := replacesVersion(vlt, name, force)
|
// Add the secret to the vault
|
||||||
|
secret.Debug("Calling vault.AddSecret", "secret_name", secretName,
|
||||||
|
"value_length", valueBuffer.Size(), "force", force)
|
||||||
|
|
||||||
|
err = vlt.AddSecret(secretName, valueBuffer, force)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
secret.Debug("vault.AddSecret failed", "error", err)
|
||||||
|
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if replacing && vlt.Locked() {
|
secret.Debug("vault.AddSecret completed successfully")
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return false, vlt.AddSecret(name, value, force)
|
return nil
|
||||||
}
|
|
||||||
|
|
||||||
// replacesVersion reports whether adding the secret name to vlt replaces
|
|
||||||
// the secret's current version: whether force is set and the secret has one.
|
|
||||||
func replacesVersion(vlt *vault.Vault, name string, force bool) (bool, error) {
|
|
||||||
if !force {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
exists, err := secret.NewSecret(vlt, name).Exists()
|
|
||||||
if err != nil {
|
|
||||||
return false, fmt.Errorf("failed to check if secret exists: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return exists, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecret retrieves and prints the current version of a secret
|
// GetSecret retrieves and prints the current version of a secret
|
||||||
@@ -773,7 +707,14 @@ func (cli *Instance) ImportSecret(
|
|||||||
|
|
||||||
// Locked only now that the file has been read, as in AddSecret: the
|
// Locked only now that the file has been read, as in AddSecret: the
|
||||||
// file may be a pipe written by another secret command.
|
// file may be a pipe written by another secret command.
|
||||||
err = cli.storeSecret(vlt, secretName, valueBuffer, force)
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer release()
|
||||||
|
|
||||||
|
// Store the secret in the vault
|
||||||
|
err = vlt.AddSecret(secretName, valueBuffer, force)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -1084,24 +1025,21 @@ func (cli *Instance) sameDirectory(dir, other string) (bool, error) {
|
|||||||
|
|
||||||
// moveSecretCrossVault handles moving between two different vaults. Its
|
// moveSecretCrossVault handles moving between two different vaults. Its
|
||||||
// caller, MoveSecret, has already checked both secret names and that both
|
// caller, MoveSecret, has already checked both secret names and that both
|
||||||
// vaults exist. The copy needs the source vault's long-term key and is
|
// vaults exist. The copy needs the source vault's long-term key; the
|
||||||
// encrypted to the destination vault's long-term public key. The
|
// destination vault is unlocked only to check that it can be. Either can ask
|
||||||
// destination vault is unlocked to check that the copy will open with what
|
// for a passphrase, so both happen before it takes the state directory lock,
|
||||||
// the user gave, and, once the state directory lock is held, that it still
|
// and no other command waits while the user answers.
|
||||||
// has the key unlocked. Either unlock can ask for a passphrase, so both
|
|
||||||
// happen before the lock is taken, and no other command waits while the
|
|
||||||
// user answers.
|
|
||||||
func (cli *Instance) moveSecretCrossVault(
|
func (cli *Instance) moveSecretCrossVault(
|
||||||
cmd *cobra.Command,
|
cmd *cobra.Command,
|
||||||
srcVault *vault.Vault, srcSecretName string,
|
srcVault *vault.Vault, srcSecretName string,
|
||||||
destVault *vault.Vault, destSecretName string,
|
destVault *vault.Vault, destSecretName string,
|
||||||
force bool,
|
force bool,
|
||||||
) error {
|
) error {
|
||||||
// Before unlocking, check that the source secret exists, that the
|
// Before unlocking, check that the source secret and the destination
|
||||||
// destination is not the source under another name, and, without
|
// vault exist, and that the destination is not the source under another
|
||||||
// --force, that the destination secret does not exist
|
// name
|
||||||
_, err := cli.checkCrossVaultMove(
|
_, err := cli.checkCrossVaultMove(
|
||||||
srcVault, srcSecretName, destVault, destSecretName, force)
|
srcVault, srcSecretName, destVault, destSecretName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -1110,7 +1048,7 @@ func (cli *Instance) moveSecretCrossVault(
|
|||||||
destVault.Mnemonic, destVault.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
destVault.Mnemonic, destVault.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
||||||
|
|
||||||
// Unlock destination vault (will fail if neither mnemonic nor unlocker available)
|
// Unlock destination vault (will fail if neither mnemonic nor unlocker available)
|
||||||
destIdentity, err := destVault.GetOrDeriveLongTermKey()
|
_, err = destVault.GetOrDeriveLongTermKey()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to unlock destination vault '%s': %w", destVault.Name, err)
|
return fmt.Errorf("failed to unlock destination vault '%s': %w", destVault.Name, err)
|
||||||
}
|
}
|
||||||
@@ -1127,11 +1065,6 @@ func (cli *Instance) moveSecretCrossVault(
|
|||||||
}
|
}
|
||||||
defer release()
|
defer release()
|
||||||
|
|
||||||
err = cli.checkLongTermKey(destVault, destIdentity)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return cli.copySecretAndRemoveSource(
|
return cli.copySecretAndRemoveSource(
|
||||||
cmd, srcVault, srcSecretName, destVault, destSecretName, force)
|
cmd, srcVault, srcSecretName, destVault, destSecretName, force)
|
||||||
}
|
}
|
||||||
@@ -1148,7 +1081,7 @@ func (cli *Instance) copySecretAndRemoveSource(
|
|||||||
force bool,
|
force bool,
|
||||||
) error {
|
) error {
|
||||||
srcSecretDir, err := cli.checkCrossVaultMove(
|
srcSecretDir, err := cli.checkCrossVaultMove(
|
||||||
srcVault, srcSecretName, destVault, destSecretName, force)
|
srcVault, srcSecretName, destVault, destSecretName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -1179,13 +1112,11 @@ func (cli *Instance) copySecretAndRemoveSource(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// checkCrossVaultMove checks that the secret srcSecretName exists in
|
// checkCrossVaultMove checks that the secret srcSecretName exists in
|
||||||
// srcVault, that destSecretName in destVault is not the source under
|
// srcVault, that destVault exists, and that destSecretName in destVault is
|
||||||
// another name, and, unless force is set, that destSecretName does not
|
// not the source under another name. It returns the source's directory.
|
||||||
// exist in destVault. It returns the source's directory.
|
|
||||||
func (cli *Instance) checkCrossVaultMove(
|
func (cli *Instance) checkCrossVaultMove(
|
||||||
srcVault *vault.Vault, srcSecretName string,
|
srcVault *vault.Vault, srcSecretName string,
|
||||||
destVault *vault.Vault, destSecretName string,
|
destVault *vault.Vault, destSecretName string,
|
||||||
force bool,
|
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
srcVaultDir, err := srcVault.GetDirectory()
|
srcVaultDir, err := srcVault.GetDirectory()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -1202,6 +1133,11 @@ func (cli *Instance) checkCrossVaultMove(
|
|||||||
srcSecretName, vault.ErrSecretNotFound, srcVault.Name)
|
srcSecretName, vault.ErrSecretNotFound, srcVault.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_, err = cli.existingVault(destVault.Name)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
// The source is removed after the copy, so a destination that is the
|
// The source is removed after the copy, so a destination that is the
|
||||||
// source under another name would be lost with it.
|
// source under another name would be lost with it.
|
||||||
destVaultDir, err := destVault.GetDirectory()
|
destVaultDir, err := destVault.GetDirectory()
|
||||||
@@ -1223,17 +1159,6 @@ func (cli *Instance) checkCrossVaultMove(
|
|||||||
destVault.Name, destSecretName)
|
destVault.Name, destSecretName)
|
||||||
}
|
}
|
||||||
|
|
||||||
exists, err = afero.DirExists(cli.fs, destSecretDir)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("failed to check if destination secret exists: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if exists && !force {
|
|
||||||
return "", fmt.Errorf(
|
|
||||||
"secret '%s' %w in vault '%s' (use --force to overwrite)",
|
|
||||||
destSecretName, vault.ErrSecretExists, destVault.Name)
|
|
||||||
}
|
|
||||||
|
|
||||||
return srcSecretDir, nil
|
return srcSecretDir, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+20
-107
@@ -15,7 +15,6 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"sneak.berlin/go/secret/internal/secret"
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
@@ -40,10 +39,6 @@ var (
|
|||||||
// composes "GPG key <id> is already added as an unlocker".
|
// composes "GPG key <id> is already added as an unlocker".
|
||||||
errGPGKeyAlreadyUnlocker = errors.New(
|
errGPGKeyAlreadyUnlocker = errors.New(
|
||||||
"is already added as an unlocker")
|
"is already added as an unlocker")
|
||||||
// errVaultCreatedAgain carries only the message tail; the caller
|
|
||||||
// composes "vault '<name>' was removed and created again ...".
|
|
||||||
errVaultCreatedAgain = errors.New("was removed and created again " +
|
|
||||||
"with another key while it was being unlocked; nothing was changed")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// UnlockerInfo represents unlocker information for display
|
// UnlockerInfo represents unlocker information for display
|
||||||
@@ -409,6 +404,12 @@ func (cli *Instance) printUnlockersTable(unlockers []UnlockerInfo) error {
|
|||||||
|
|
||||||
// UnlockersAdd adds a new unlocker
|
// UnlockersAdd adds a new unlocker
|
||||||
func (cli *Instance) UnlockersAdd(unlockerType string, cmd *cobra.Command) error {
|
func (cli *Instance) UnlockersAdd(unlockerType string, cmd *cobra.Command) error {
|
||||||
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer release()
|
||||||
|
|
||||||
switch unlockerType {
|
switch unlockerType {
|
||||||
case unlockerTypePassphrase:
|
case unlockerTypePassphrase:
|
||||||
return cli.addPassphraseUnlocker(cmd)
|
return cli.addPassphraseUnlocker(cmd)
|
||||||
@@ -422,64 +423,6 @@ func (cli *Instance) UnlockersAdd(unlockerType string, cmd *cobra.Command) error
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// unlockThenLock gets the long-term key of vlt, the vault an unlocker is
|
|
||||||
// added to, then takes the state directory lock and returns the function
|
|
||||||
// that releases it. Getting the key can ask for a passphrase, so it comes
|
|
||||||
// before the lock, as the question of askThenLock does, and no other
|
|
||||||
// command waits while the user answers. Once the lock is held, it fails if
|
|
||||||
// another command has removed the vault in the meantime, since writing the
|
|
||||||
// unlocker would create the vault's directory again, holding nothing else.
|
|
||||||
// It also fails if the vault was removed and created again with another
|
|
||||||
// long-term key, which the unlocker would then hold instead of the new
|
|
||||||
// vault's own.
|
|
||||||
func (cli *Instance) unlockThenLock(vlt *vault.Vault) (func(), error) {
|
|
||||||
ltIdentity, err := vlt.GetOrDeriveLongTermKey()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to get long-term key: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
err = cli.checkLongTermKey(vlt, ltIdentity)
|
|
||||||
if err != nil {
|
|
||||||
release()
|
|
||||||
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return release, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkLongTermKey checks, for the vault vlt unlocked as ltIdentity before
|
|
||||||
// the state directory lock was taken, that vlt still exists and that its
|
|
||||||
// long-term public key is still that of ltIdentity. Another command may have
|
|
||||||
// removed the vault in the meantime, or removed it and created it again with
|
|
||||||
// another long-term key. The caller holds the lock.
|
|
||||||
func (cli *Instance) checkLongTermKey(
|
|
||||||
vlt *vault.Vault, ltIdentity *age.X25519Identity,
|
|
||||||
) error {
|
|
||||||
_, err := cli.existingVault(vlt.GetName())
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
vaultDir, _ := vlt.GetDirectory()
|
|
||||||
|
|
||||||
ltPubKey, err := afero.ReadFile(cli.fs, filepath.Join(vaultDir, "pub.age"))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to read long-term public key: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if string(ltPubKey) != ltIdentity.Recipient().String() {
|
|
||||||
return fmt.Errorf("vault '%s' %w", vlt.GetName(), errVaultCreatedAgain)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// autoSelectUnlocker selects the newly created unlocker as current,
|
// autoSelectUnlocker selects the newly created unlocker as current,
|
||||||
// printing a warning if selection fails
|
// printing a warning if selection fails
|
||||||
func autoSelectUnlocker(cmd *cobra.Command, vlt *vault.Vault, unlockerID string) {
|
func autoSelectUnlocker(cmd *cobra.Command, vlt *vault.Vault, unlockerID string) {
|
||||||
@@ -499,6 +442,9 @@ func (cli *Instance) addPassphraseUnlocker(cmd *cobra.Command) error {
|
|||||||
return fmt.Errorf("failed to get current vault: %w", err)
|
return fmt.Errorf("failed to get current vault: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// For passphrase unlockers, we don't need the vault to be unlocked
|
||||||
|
// The CreatePassphraseUnlocker method will handle getting the
|
||||||
|
// long-term key
|
||||||
vlt.Mnemonic, vlt.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
vlt.Mnemonic, vlt.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
||||||
|
|
||||||
// The new passphrase is asked for even when SB_UNLOCK_PASSPHRASE is
|
// The new passphrase is asked for even when SB_UNLOCK_PASSPHRASE is
|
||||||
@@ -518,12 +464,6 @@ func (cli *Instance) addPassphraseUnlocker(cmd *cobra.Command) error {
|
|||||||
defer passphraseBuffer.Destroy()
|
defer passphraseBuffer.Destroy()
|
||||||
}
|
}
|
||||||
|
|
||||||
release, err := cli.unlockThenLock(vlt)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer release()
|
|
||||||
|
|
||||||
passphraseUnlocker, err := vlt.CreatePassphraseUnlocker(passphraseBuffer)
|
passphraseUnlocker, err := vlt.CreatePassphraseUnlocker(passphraseBuffer)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -562,13 +502,12 @@ func (cli *Instance) addPGPUnlocker(cmd *cobra.Command) error {
|
|||||||
cmd.Printf("Using default GPG key: %s\n", gpgKeyID)
|
cmd.Printf("Using default GPG key: %s\n", gpgKeyID)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check if this key is already added as an unlocker
|
||||||
vlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
vlt, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to get current vault: %w", err)
|
return fmt.Errorf("failed to get current vault: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
vlt.Mnemonic, vlt.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
|
||||||
|
|
||||||
// Resolve the GPG key ID to its fingerprint, once: the duplicate check
|
// Resolve the GPG key ID to its fingerprint, once: the duplicate check
|
||||||
// and the new unlocker's metadata both use this result
|
// and the new unlocker's metadata both use this result
|
||||||
fingerprint, err := secret.ResolveGPGKeyFingerprint(gpgKeyID)
|
fingerprint, err := secret.ResolveGPGKeyFingerprint(gpgKeyID)
|
||||||
@@ -576,26 +515,21 @@ func (cli *Instance) addPGPUnlocker(cmd *cobra.Command) error {
|
|||||||
return fmt.Errorf("failed to resolve GPG key fingerprint: %w", err)
|
return fmt.Errorf("failed to resolve GPG key fingerprint: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Refuse a key that is already an unlocker before asking for anything,
|
// Check if this GPG key is already added
|
||||||
// and again once the lock is held, since another command may have added
|
exists, err := cli.pgpUnlockerExists(vlt, fingerprint)
|
||||||
// it in the meantime
|
|
||||||
err = cli.checkPGPKeyNotAdded(vlt, gpgKeyID, fingerprint)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return fmt.Errorf(
|
||||||
|
"could not check whether GPG key %s is already an unlocker: %w",
|
||||||
|
gpgKeyID, err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
release, err := cli.unlockThenLock(vlt)
|
if exists {
|
||||||
if err != nil {
|
return fmt.Errorf("GPG key %s %w", gpgKeyID, errGPGKeyAlreadyUnlocker)
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer release()
|
|
||||||
|
|
||||||
err = cli.checkPGPKeyNotAdded(vlt, gpgKeyID, fingerprint)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pgpUnlocker, err := secret.CreatePGPUnlocker(vlt, gpgKeyID, fingerprint)
|
pgpUnlocker, err := secret.CreatePGPUnlocker(cli.fs, cli.stateDir,
|
||||||
|
gpgKeyID, fingerprint, cli.Mnemonic, cli.UnlockPassphrase)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -770,27 +704,6 @@ func (cli *Instance) UnlockerSelect(unlockerID string) error {
|
|||||||
return vlt.SelectUnlocker(unlockerID)
|
return vlt.SelectUnlocker(unlockerID)
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkPGPKeyNotAdded fails when vlt already has a PGP unlocker for the GPG
|
|
||||||
// key gpgKeyID, whose fingerprint is fingerprint, or when that cannot be
|
|
||||||
// checked.
|
|
||||||
func (cli *Instance) checkPGPKeyNotAdded(
|
|
||||||
vlt *vault.Vault, gpgKeyID, fingerprint string,
|
|
||||||
) error {
|
|
||||||
exists, err := cli.pgpUnlockerExists(vlt, fingerprint)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"could not check whether GPG key %s is already an unlocker: %w",
|
|
||||||
gpgKeyID, err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if exists {
|
|
||||||
return fmt.Errorf("GPG key %s %w", gpgKeyID, errGPGKeyAlreadyUnlocker)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// pgpUnlockerExists reports whether the vault already has a PGP unlocker
|
// pgpUnlockerExists reports whether the vault already has a PGP unlocker
|
||||||
// for the GPG key with the given fingerprint. It returns an error, and no
|
// for the GPG key with the given fingerprint. It returns an error, and no
|
||||||
// answer, when unlockers.d or an unlocker's metadata file cannot be read;
|
// answer, when unlockers.d or an unlocker's metadata file cannot be read;
|
||||||
|
|||||||
@@ -9,12 +9,11 @@
|
|||||||
// "nothing there" and go ahead.
|
// "nothing there" and go ahead.
|
||||||
//
|
//
|
||||||
// The tests make the look fail with a wrapper around the in-memory
|
// The tests make the look fail with a wrapper around the in-memory
|
||||||
// filesystem, which the state directory lock refuses. So they call a
|
// filesystem, which the state directory lock refuses. So they call the
|
||||||
// function that makes the look before any lock is taken: addPGPUnlocker for
|
// function each command runs once it holds the lock, such as addPGPUnlocker
|
||||||
// UnlockersAdd, which looks again once it holds the lock, or, for a removal,
|
// for UnlockersAdd, or, for a removal, the function that makes its checks,
|
||||||
// the function that makes its checks, such as findVaultToRemove for
|
// such as findVaultToRemove for RemoveVault, which runs again under the
|
||||||
// RemoveVault, which runs again under the lock before anything is removed,
|
// lock before anything is removed, with --force or without.
|
||||||
// with --force or without.
|
|
||||||
|
|
||||||
//nolint:testpackage // white-box test of unexported internals
|
//nolint:testpackage // white-box test of unexported internals
|
||||||
package cli
|
package cli
|
||||||
|
|||||||
+9
-12
@@ -222,14 +222,18 @@ func (cli *Instance) resolvePassphrase() (*memguard.LockedBuffer, func(), error)
|
|||||||
return passphraseBuffer, passphraseBuffer.Destroy, nil
|
return passphraseBuffer, passphraseBuffer.Destroy, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreateVault creates a new vault. It asks for the mnemonic and the
|
// CreateVault creates a new vault
|
||||||
// passphrase before it takes the state directory lock, so that no other
|
|
||||||
// command waits while the user answers.
|
|
||||||
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)
|
||||||
|
|
||||||
|
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer release()
|
||||||
|
|
||||||
// Refuse an invalid name or an existing vault before asking for anything
|
// Refuse an invalid name or an existing vault before asking for anything
|
||||||
err := vault.CheckNewVaultName(cli.fs, cli.stateDir, name)
|
err = vault.CheckNewVaultName(cli.fs, cli.stateDir, name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -261,14 +265,7 @@ func (cli *Instance) CreateVault(cmd *cobra.Command, name string) error {
|
|||||||
}
|
}
|
||||||
defer cleanupPassphrase()
|
defer cleanupPassphrase()
|
||||||
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
// Create the vault with its passphrase unlocker
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer release()
|
|
||||||
|
|
||||||
// Create the vault with its passphrase unlocker. Another command may
|
|
||||||
// have created it since the check above: vault.CreateVault checks again.
|
|
||||||
vlt, err := vault.CreateVault(cli.fs, cli.stateDir, name,
|
vlt, err := vault.CreateVault(cli.fs, cli.stateDir, name,
|
||||||
mnemonic, passphraseBuffer)
|
mnemonic, passphraseBuffer)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -375,7 +375,8 @@ func testCreatePGPUnlocker(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Now create a PGP unlock key (this will use our custom GPGEncryptFunc)
|
// Now create a PGP unlock key (this will use our custom GPGEncryptFunc)
|
||||||
pgpUnlocker, err := secret.CreatePGPUnlocker(vlt, keyID, fingerprint)
|
pgpUnlocker, err := secret.CreatePGPUnlocker(
|
||||||
|
fs, stateDir, keyID, fingerprint, mnemonic, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Failed to create PGP unlock key: %v", err)
|
t.Fatalf("Failed to create PGP unlock key: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -192,45 +192,58 @@ func generatePGPUnlockerName() (string, error) {
|
|||||||
return fmt.Sprintf("%s-pgp-%s", hostname, enrollmentTime), nil
|
return fmt.Sprintf("%s-pgp-%s", hostname, enrollmentTime), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// pgpUnlockerDir returns the directory in vault for a new PGP unlocker,
|
// pgpUnlockerDir returns the current vault and the directory in it for a
|
||||||
// named after the host and the time.
|
// new PGP unlocker, named after the host and the time.
|
||||||
func pgpUnlockerDir(vault VaultInterface) (string, error) {
|
//
|
||||||
|
//nolint:ireturn // the vault is only available behind VaultInterface
|
||||||
|
func pgpUnlockerDir(
|
||||||
|
fs afero.Fs, stateDir string,
|
||||||
|
) (VaultInterface, string, error) {
|
||||||
|
// Get current vault
|
||||||
|
vault, err := GetCurrentVault(fs, stateDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", fmt.Errorf("failed to get current vault: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
// Generate the unlocker name based on hostname and time
|
// Generate the unlocker name based on hostname and time
|
||||||
unlockerName, err := generatePGPUnlockerName()
|
unlockerName, err := generatePGPUnlockerName()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("failed to generate unlocker name: %w", err)
|
return nil, "", fmt.Errorf("failed to generate unlocker name: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
vaultDir, err := vault.GetDirectory()
|
vaultDir, err := vault.GetDirectory()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("failed to get vault directory: %w", err)
|
return nil, "", fmt.Errorf("failed to get vault directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return filepath.Join(vaultDir, "unlockers.d", unlockerName), nil
|
return vault, filepath.Join(vaultDir, "unlockers.d", unlockerName), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreatePGPUnlocker creates a new PGP unlocker and stores it in vault.
|
// CreatePGPUnlocker creates a new PGP unlocker and stores it in the vault.
|
||||||
// It encrypts to the GPG key gpgKeyID and records fingerprint, that key's
|
// It encrypts to the GPG key gpgKeyID and records fingerprint, that key's
|
||||||
// fingerprint as ResolveGPGKeyFingerprint returns it, in the metadata.
|
// fingerprint as ResolveGPGKeyFingerprint returns it, in the metadata.
|
||||||
// Everything that can fail short of writing a file is done before anything
|
// Everything that can fail short of writing a file is done before anything
|
||||||
// is written, and the files are written through WriteDir, so a failure
|
// is written, and the files are written through WriteDir, so a failure
|
||||||
// leaves no partial unlocker. The long-term key comes from vault's
|
// leaves no partial unlocker. The long-term key comes from mnemonic when it
|
||||||
// GetOrDeriveLongTermKey: the key it holds when it is unlocked, else the
|
// is not nil, else from the current unlocker, which is given passphrase when
|
||||||
// key from its mnemonic or its current unlocker.
|
// it is a passphrase unlocker.
|
||||||
func CreatePGPUnlocker(
|
func CreatePGPUnlocker(
|
||||||
vault VaultInterface, gpgKeyID, fingerprint string,
|
fs afero.Fs, stateDir, gpgKeyID, fingerprint string,
|
||||||
|
mnemonic, passphrase *memguard.LockedBuffer,
|
||||||
) (*PGPUnlocker, error) {
|
) (*PGPUnlocker, error) {
|
||||||
err := checkGPGAvailable()
|
err := checkGPGAvailable()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
unlockerDir, err := pgpUnlockerDir(vault)
|
vault, unlockerDir, err := pgpUnlockerDir(fs, stateDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
fs := vault.GetFilesystem()
|
// The vault's GetOrDeriveLongTermKey, in step 2, uses both
|
||||||
|
vault.SetMnemonic(mnemonic)
|
||||||
|
vault.SetUnlockPassphrase(passphrase)
|
||||||
|
|
||||||
// Step 1: Generate a new age keypair for the PGP unlocker
|
// Step 1: Generate a new age keypair for the PGP unlocker
|
||||||
ageIdentity, err := age.GenerateX25519Identity()
|
ageIdentity, err := age.GenerateX25519Identity()
|
||||||
@@ -282,7 +295,7 @@ func CreatePGPUnlocker(
|
|||||||
func encryptPGPUnlockerKeys(
|
func encryptPGPUnlockerKeys(
|
||||||
vault VaultInterface, ageIdentity *age.X25519Identity, gpgKeyID string,
|
vault VaultInterface, ageIdentity *age.X25519Identity, gpgKeyID string,
|
||||||
) ([]byte, []byte, error) {
|
) ([]byte, []byte, error) {
|
||||||
// The key vault holds, or else from its mnemonic or current unlocker
|
// From the mnemonic or the current unlocker, as for a passphrase unlocker
|
||||||
ltIdentity, err := vault.GetOrDeriveLongTermKey()
|
ltIdentity, err := vault.GetOrDeriveLongTermKey()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, fmt.Errorf("failed to get long-term key: %w", err)
|
return nil, nil, fmt.Errorf("failed to get long-term key: %w", err)
|
||||||
|
|||||||
@@ -58,8 +58,7 @@ func TestCreatePGPUnlockerFailureWritesNothing(t *testing.T) {
|
|||||||
}}
|
}}
|
||||||
|
|
||||||
_, err = secret.CreatePGPUnlocker(
|
_, err = secret.CreatePGPUnlocker(
|
||||||
vault.NewVault(fs, testVaultStateDir, testVaultName),
|
fs, testVaultStateDir, testGPGKeyID, testGPGFingerprint, nil, nil)
|
||||||
testGPGKeyID, testGPGFingerprint)
|
|
||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
|
|
||||||
vaultDir, err := vlt.GetDirectory()
|
vaultDir, err := vlt.GetDirectory()
|
||||||
@@ -88,15 +87,17 @@ func TestPGPUnlockerAddedTwiceKeepsFirst(t *testing.T) {
|
|||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
fs := afero.NewMemMapFs()
|
||||||
mnemonic := testMnemonicBuffer(t)
|
mnemonic := testMnemonicBuffer(t)
|
||||||
vlt, err := vault.CreateVault(fs, testVaultStateDir, testVaultName, mnemonic, nil)
|
_, err := vault.CreateVault(fs, testVaultStateDir, testVaultName, mnemonic, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
first, err := secret.CreatePGPUnlocker(vlt, testGPGKeyID, testGPGFingerprint)
|
first, err := secret.CreatePGPUnlocker(
|
||||||
|
fs, testVaultStateDir, testGPGKeyID, testGPGFingerprint, mnemonic, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
firstFiles := dirFiles(t, fs, first.GetDirectory())
|
firstFiles := dirFiles(t, fs, first.GetDirectory())
|
||||||
|
|
||||||
second, err := secret.CreatePGPUnlocker(vlt, testGPGKeyID, testGPGFingerprint)
|
second, err := secret.CreatePGPUnlocker(
|
||||||
|
fs, testVaultStateDir, testGPGKeyID, testGPGFingerprint, mnemonic, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.NotEqual(t, first.GetDirectory(), second.GetDirectory())
|
assert.NotEqual(t, first.GetDirectory(), second.GetDirectory())
|
||||||
assert.Equal(t, firstFiles, dirFiles(t, fs, first.GetDirectory()))
|
assert.Equal(t, firstFiles, dirFiles(t, fs, first.GetDirectory()))
|
||||||
|
|||||||
@@ -28,6 +28,11 @@ type VaultInterface interface {
|
|||||||
GetFilesystem() afero.Fs
|
GetFilesystem() afero.Fs
|
||||||
GetCurrentUnlocker() (Unlocker, error)
|
GetCurrentUnlocker() (Unlocker, error)
|
||||||
GetOrDeriveLongTermKey() (*age.X25519Identity, error)
|
GetOrDeriveLongTermKey() (*age.X25519Identity, error)
|
||||||
|
// SetMnemonic and SetUnlockPassphrase give GetOrDeriveLongTermKey the
|
||||||
|
// mnemonic to derive the long-term key from, and the passphrase for a
|
||||||
|
// current passphrase unlocker; nil for none.
|
||||||
|
SetMnemonic(mnemonic *memguard.LockedBuffer)
|
||||||
|
SetUnlockPassphrase(passphrase *memguard.LockedBuffer)
|
||||||
CreatePassphraseUnlocker(
|
CreatePassphraseUnlocker(
|
||||||
passphrase *memguard.LockedBuffer) (*PassphraseUnlocker, error)
|
passphrase *memguard.LockedBuffer) (*PassphraseUnlocker, error)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -118,6 +118,12 @@ func (m *MockVault) GetOrDeriveLongTermKey() (*age.X25519Identity, error) {
|
|||||||
return nil, errNotImplementedInMock
|
return nil, errNotImplementedInMock
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (m *MockVault) SetMnemonic(mnemonic *memguard.LockedBuffer) {
|
||||||
|
m.mnemonic = mnemonic
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *MockVault) SetUnlockPassphrase(_ *memguard.LockedBuffer) {}
|
||||||
|
|
||||||
func (m *MockVault) CreatePassphraseUnlocker(
|
func (m *MockVault) CreatePassphraseUnlocker(
|
||||||
_ *memguard.LockedBuffer,
|
_ *memguard.LockedBuffer,
|
||||||
) (*PassphraseUnlocker, error) {
|
) (*PassphraseUnlocker, error) {
|
||||||
|
|||||||
@@ -90,6 +90,10 @@ func (m *MockVersionVault) GetOrDeriveLongTermKey() (*age.X25519Identity, error)
|
|||||||
return nil, errNotImplementedInMock
|
return nil, errNotImplementedInMock
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (m *MockVersionVault) SetMnemonic(_ *memguard.LockedBuffer) {}
|
||||||
|
|
||||||
|
func (m *MockVersionVault) SetUnlockPassphrase(_ *memguard.LockedBuffer) {}
|
||||||
|
|
||||||
func (m *MockVersionVault) CreatePassphraseUnlocker(
|
func (m *MockVersionVault) CreatePassphraseUnlocker(
|
||||||
_ *memguard.LockedBuffer,
|
_ *memguard.LockedBuffer,
|
||||||
) (*secret.PassphraseUnlocker, error) {
|
) (*secret.PassphraseUnlocker, error) {
|
||||||
|
|||||||
@@ -132,7 +132,7 @@ func TestGetSecretWithWrongMnemonic(t *testing.T) {
|
|||||||
t.Cleanup(mnemonic.Destroy)
|
t.Cleanup(mnemonic.Destroy)
|
||||||
|
|
||||||
vlt := vault.NewVault(created.GetFilesystem(), testStateDir, testVaultName)
|
vlt := vault.NewVault(created.GetFilesystem(), testStateDir, testVaultName)
|
||||||
vlt.Mnemonic = mnemonic
|
vlt.SetMnemonic(mnemonic)
|
||||||
|
|
||||||
_, err := vlt.GetSecret(testSecretName)
|
_, err := vlt.GetSecret(testSecretName)
|
||||||
require.ErrorIs(t, err, vault.ErrMnemonicMismatch)
|
require.ErrorIs(t, err, vault.ErrMnemonicMismatch)
|
||||||
|
|||||||
@@ -235,9 +235,9 @@ func processMnemonicForVault(
|
|||||||
// vault: one wrapping ErrInvalidVaultName when it is not a valid vault name,
|
// vault: one wrapping ErrInvalidVaultName when it is not a valid vault name,
|
||||||
// and one wrapping ErrVaultExists when that vault already exists. Creating an
|
// and one wrapping ErrVaultExists when that vault already exists. Creating an
|
||||||
// existing vault again would replace its keys, and its secrets could no
|
// existing vault again would replace its keys, and its secrets could no
|
||||||
// longer be decrypted. The commands that create a vault check it before they
|
// longer be decrypted. CreateVault checks this before writing anything; the
|
||||||
// ask for the mnemonic or passphrase, and CreateVault checks it again, under
|
// commands that create a vault also check it before they ask for the
|
||||||
// the state directory lock, before writing anything.
|
// mnemonic or passphrase, holding the state directory lock.
|
||||||
func CheckNewVaultName(fs afero.Fs, stateDir string, name string) error {
|
func CheckNewVaultName(fs afero.Fs, stateDir string, name string) error {
|
||||||
err := ValidateVaultName(name)
|
err := ValidateVaultName(name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -336,7 +336,7 @@ func TestVaultVersionTimestampsAfterUnlock(t *testing.T) {
|
|||||||
|
|
||||||
// A new instance is locked; AddSecret unlocks it with the passphrase
|
// A new instance is locked; AddSecret unlocks it with the passphrase
|
||||||
vault := NewVault(fs, testStateDir, "test")
|
vault := NewVault(fs, testStateDir, "test")
|
||||||
vault.UnlockPassphrase = passphrase
|
vault.SetUnlockPassphrase(passphrase)
|
||||||
|
|
||||||
addTestSecretToVault(t, vault, testSecretPath, []byte("version-2"), true)
|
addTestSecretToVault(t, vault, testSecretPath, []byte("version-2"), true)
|
||||||
require.False(t, fs.readAt.IsZero(), "AddSecret did not unlock the vault")
|
require.False(t, fs.readAt.IsZero(), "AddSecret did not unlock the vault")
|
||||||
|
|||||||
@@ -64,6 +64,18 @@ func (v *Vault) ClearLongTermKey() {
|
|||||||
v.longTermKey = nil
|
v.longTermKey = nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetMnemonic sets v.Mnemonic, for code that has v only as a
|
||||||
|
// secret.VaultInterface.
|
||||||
|
func (v *Vault) SetMnemonic(mnemonic *memguard.LockedBuffer) {
|
||||||
|
v.Mnemonic = mnemonic
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUnlockPassphrase sets v.UnlockPassphrase, for code that has v only as
|
||||||
|
// a secret.VaultInterface.
|
||||||
|
func (v *Vault) SetUnlockPassphrase(passphrase *memguard.LockedBuffer) {
|
||||||
|
v.UnlockPassphrase = passphrase
|
||||||
|
}
|
||||||
|
|
||||||
// GetOrDeriveLongTermKey gets the long-term key from memory or derives it
|
// GetOrDeriveLongTermKey gets the long-term key from memory or derives it
|
||||||
// from available sources
|
// from available sources
|
||||||
func (v *Vault) GetOrDeriveLongTermKey() (*age.X25519Identity, error) {
|
func (v *Vault) GetOrDeriveLongTermKey() (*age.X25519Identity, error) {
|
||||||
|
|||||||
@@ -128,7 +128,7 @@ func TestAddSecretForceWithWrongPassphraseChangesNothing(t *testing.T) {
|
|||||||
t.Cleanup(wrong.Destroy)
|
t.Cleanup(wrong.Destroy)
|
||||||
|
|
||||||
vlt := vault.NewVault(fs, testStateDir, testVaultName)
|
vlt := vault.NewVault(fs, testStateDir, testVaultName)
|
||||||
vlt.UnlockPassphrase = wrong
|
vlt.SetUnlockPassphrase(wrong)
|
||||||
|
|
||||||
secretDir := filepath.Join(testStateDir, "vaults.d", testVaultName,
|
secretDir := filepath.Join(testStateDir, "vaults.d", testVaultName,
|
||||||
"secrets.d", testSecretName)
|
"secrets.d", testSecretName)
|
||||||
|
|||||||
Reference in New Issue
Block a user