Compare commits
2
Commits
956935172b
...
933bc8fb23
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
933bc8fb23 | ||
|
|
46c395e045 |
No files matched your search
@@ -268,10 +268,6 @@ Selects an unlocker as the current default for operations.
|
|||||||
Imports a secret from a file and stores it in the current vault under the given
|
Imports a secret from a file and stores it in the current vault under the given
|
||||||
name.
|
name.
|
||||||
|
|
||||||
#### `secret vault import [vault-name]`
|
|
||||||
|
|
||||||
Imports a mnemonic phrase into the specified vault (defaults to "default").
|
|
||||||
|
|
||||||
### Encryption Operations
|
### Encryption Operations
|
||||||
|
|
||||||
#### `secret encrypt <secret-name> [--input=file] [--output=file]`
|
#### `secret encrypt <secret-name> [--input=file] [--output=file]`
|
||||||
@@ -377,9 +373,12 @@ line or in a CI job, they end up in shell history and CI logs. `secret` unsets
|
|||||||
each one as soon as it has read it, so that the programs it runs itself, such as
|
each one as soon as it has read it, so that the programs it runs itself, such as
|
||||||
`gpg`, do not inherit it, but that erases nothing: the environment the process
|
`gpg`, do not inherit it, but that erases nothing: the environment the process
|
||||||
started with, and its memory, still hold the value. The interactive prompt,
|
started with, and its memory, still hold the value. The interactive prompt,
|
||||||
which every command except `secret vault import` offers when the variable is not
|
which every command offers when the variable is not set, is the safer default.
|
||||||
set, is the safer default; `secret vault import` has no prompt and needs both
|
|
||||||
variables.
|
The prompt asks on the terminal the command runs in, not on stdin, so it also
|
||||||
|
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
|
||||||
|
in a CI job, the command fails and names the variable to set.
|
||||||
|
|
||||||
## Security Features
|
## Security Features
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,24 @@ https://git.eeqj.de/sneak/secret/milestone/12
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-14: `secret vault import` is gone
|
||||||
|
(https://git.eeqj.de/sneak/secret/issues/139). It took only a vault without a
|
||||||
|
long-term key, and `secret init` and `secret vault create` give every vault
|
||||||
|
one, so it always failed. A mnemonic enters through those two commands, which
|
||||||
|
the help and the note of `secret generate mnemonic` now name; they named
|
||||||
|
`secret import`, which imports a file as a secret. `secret vault import` now
|
||||||
|
prints the help of `secret vault`, which cobra prints for any subcommand of
|
||||||
|
`secret vault` that does not exist.
|
||||||
|
- 2026-10-14: The passphrase and mnemonic prompts ask on the controlling
|
||||||
|
terminal (`/dev/tty`) instead of stdin, so `echo v | secret add s1 --force`,
|
||||||
|
`cat file | secret encrypt key` and `cat file.age | secret decrypt key` ask
|
||||||
|
for the passphrase at a terminal instead of failing
|
||||||
|
(https://git.eeqj.de/sneak/secret/issues/144). Only a process with no
|
||||||
|
controlling terminal gets the error that names the variable to set. On SIGINT
|
||||||
|
or SIGTERM, `Entry()` restores the settings of that terminal, not of stdin,
|
||||||
|
since that is where the prompt turns echo off. `secret init` and
|
||||||
|
`secret vault create` no longer write a newline to stderr after the mnemonic
|
||||||
|
is typed, since the prompt ends that line on the terminal.
|
||||||
- 2026-10-14: `secret generate mnemonic`, `secret vault list` and
|
- 2026-10-14: `secret generate mnemonic`, `secret vault list` and
|
||||||
`secret unlocker list` print their output to stdout, as `secret list` does, so
|
`secret unlocker list` print their output to stdout, as `secret list` does, so
|
||||||
it can be piped or captured (https://git.eeqj.de/sneak/secret/issues/138).
|
it can be piped or captured (https://git.eeqj.de/sneak/secret/issues/138).
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"os/exec"
|
"os/exec"
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
@@ -140,6 +141,30 @@ func TestVaultCreationLeavesNoSecretInEnvironment(t *testing.T) {
|
|||||||
run("vault", "create", "work")
|
run("vault", "create", "work")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestNoVaultImportCommand is a regression test for
|
||||||
|
// https://git.eeqj.de/sneak/secret/issues/139: `secret vault import`
|
||||||
|
// refused every vault that `secret vault create` makes, because each has a
|
||||||
|
// long-term key. The command is gone, so cobra answers it with the help of
|
||||||
|
// `secret vault`, as it does any subcommand of `secret vault` it does not
|
||||||
|
// know.
|
||||||
|
func TestNoVaultImportCommand(t *testing.T) {
|
||||||
|
t.Setenv(secret.EnvStateDir, t.TempDir())
|
||||||
|
|
||||||
|
run := func(args ...string) string {
|
||||||
|
t.Setenv(secret.EnvMnemonic, testMnemonic)
|
||||||
|
t.Setenv(secret.EnvUnlockPassphrase, testPassphrase)
|
||||||
|
|
||||||
|
output, err := cli.ExecuteCommandInProcess(args, "", nil)
|
||||||
|
require.NoError(t, err, "%v", args)
|
||||||
|
|
||||||
|
return output
|
||||||
|
}
|
||||||
|
|
||||||
|
run("vault", "create", "work")
|
||||||
|
|
||||||
|
require.Equal(t, run("vault"), run("vault", "import", "work"))
|
||||||
|
}
|
||||||
|
|
||||||
// TestStopAtPassphrasePromptLeavesNothing is a regression test for the
|
// TestStopAtPassphrasePromptLeavesNothing is a regression test for the
|
||||||
// review of https://git.eeqj.de/sneak/secret/pulls/82: `secret init` or
|
// review of https://git.eeqj.de/sneak/secret/pulls/82: `secret init` or
|
||||||
// `secret vault create` stopped at the passphrase prompt left a vault with
|
// `secret vault create` stopped at the passphrase prompt left a vault with
|
||||||
@@ -197,10 +222,10 @@ func TestStopAtPassphrasePromptLeavesNothing(t *testing.T) {
|
|||||||
|
|
||||||
// TestMnemonicNotReadNamesOnlyMnemonic is a regression test for
|
// TestMnemonicNotReadNamesOnlyMnemonic is a regression test for
|
||||||
// https://git.eeqj.de/sneak/secret/issues/115: `secret init` without
|
// https://git.eeqj.de/sneak/secret/issues/115: `secret init` without
|
||||||
// SB_SECRET_MNEMONIC and with a stdin that is not a terminal said "failed to
|
// SB_SECRET_MNEMONIC and with no terminal said "failed to read mnemonic:
|
||||||
// read mnemonic: failed to read passphrase: ...". The error must wrap
|
// failed to read passphrase: ...". The error must wrap
|
||||||
// secret.ErrMnemonicNotRead and name the mnemonic only. The message is
|
// secret.ErrMnemonicNotRead and name the mnemonic only. The message is
|
||||||
// pinned on the built binary, whose stdin is surely not a terminal.
|
// pinned on the built binary, run in a new session, which has no terminal.
|
||||||
func TestMnemonicNotReadNamesOnlyMnemonic(t *testing.T) {
|
func TestMnemonicNotReadNamesOnlyMnemonic(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -216,14 +241,15 @@ func TestMnemonicNotReadNamesOnlyMnemonic(t *testing.T) {
|
|||||||
"PATH=" + os.Getenv("PATH"),
|
"PATH=" + os.Getenv("PATH"),
|
||||||
"HOME=" + os.Getenv("HOME"),
|
"HOME=" + os.Getenv("HOME"),
|
||||||
}
|
}
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true}
|
||||||
|
|
||||||
output, err := cmd.CombinedOutput()
|
output, err := cmd.CombinedOutput()
|
||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
|
|
||||||
require.Equal(t, "Initialized secrets manager at: "+stateDir+"\n"+
|
require.Equal(t, "Initialized secrets manager at: "+stateDir+"\n"+
|
||||||
"Error: failed to read mnemonic: stdin is not a terminal (piped input "+
|
"Error: failed to read mnemonic: there is no terminal to ask on. "+
|
||||||
"or script). Please set the SB_SECRET_MNEMONIC environment variable "+
|
"Please set the SB_SECRET_MNEMONIC environment variable or run "+
|
||||||
"or run interactively\n", string(output))
|
"interactively\n", string(output))
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestStopDuringCreateLeavesWholeVaultOrNone is a regression test for
|
// TestStopDuringCreateLeavesWholeVaultOrNone is a regression test for
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ func newGenerateMnemonicCmd() *cobra.Command {
|
|||||||
Short: "Generate a random BIP39 mnemonic phrase",
|
Short: "Generate a random BIP39 mnemonic phrase",
|
||||||
Long: `Generate a cryptographically secure random BIP39 ` +
|
Long: `Generate a cryptographically secure random BIP39 ` +
|
||||||
`mnemonic phrase that can be used with 'secret init' ` +
|
`mnemonic phrase that can be used with 'secret init' ` +
|
||||||
`or 'secret import'.`,
|
`or 'secret vault create'.`,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
cli, err := NewCLIInstance()
|
cli, err := NewCLIInstance()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -115,8 +115,10 @@ func (cli *Instance) GenerateMnemonic(cmd *cobra.Command) error {
|
|||||||
" • If you lose this phrase, your secrets cannot be recovered")
|
" • If you lose this phrase, your secrets cannot be recovered")
|
||||||
fmt.Fprintln(os.Stderr, "")
|
fmt.Fprintln(os.Stderr, "")
|
||||||
fmt.Fprintln(os.Stderr, "Use this mnemonic with:")
|
fmt.Fprintln(os.Stderr, "Use this mnemonic with:")
|
||||||
fmt.Fprintln(os.Stderr, " secret init (to initialize a new secret manager)")
|
fmt.Fprintln(os.Stderr,
|
||||||
fmt.Fprintln(os.Stderr, " secret import (to import into an existing vault)")
|
" secret init (to initialize a new secret manager)")
|
||||||
|
fmt.Fprintln(os.Stderr,
|
||||||
|
" secret vault create <name> (to create another vault)")
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
@@ -57,13 +56,11 @@ func (cli *Instance) promptMnemonic() (*memguard.LockedBuffer, func(), error) {
|
|||||||
// Read mnemonic securely without echo
|
// Read mnemonic securely without echo
|
||||||
mnemonicBuffer, err := secret.ReadMnemonic("Enter your BIP39 mnemonic phrase: ")
|
mnemonicBuffer, err := secret.ReadMnemonic("Enter your BIP39 mnemonic phrase: ")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
secret.Debug("Failed to read mnemonic from stdin", "error", err)
|
secret.Debug("Failed to read mnemonic", "error", err)
|
||||||
|
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
fmt.Fprintln(os.Stderr) // Add newline after hidden input
|
|
||||||
|
|
||||||
return mnemonicBuffer, mnemonicBuffer.Destroy, nil
|
return mnemonicBuffer, mnemonicBuffer.Destroy, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -7,12 +7,10 @@ import (
|
|||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"sneak.berlin/go/secret/internal/vault"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestInvalidMnemonicError checks that every command that takes a mnemonic
|
// TestInvalidMnemonicError checks that every command that takes a mnemonic
|
||||||
// returns errInvalidMnemonicPhrase for one that is not valid BIP39. The vault
|
// returns errInvalidMnemonicPhrase for one that is not valid BIP39.
|
||||||
// "other" has no long-term key, as vault import needs.
|
|
||||||
func TestInvalidMnemonicError(t *testing.T) {
|
func TestInvalidMnemonicError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -24,20 +22,13 @@ func TestInvalidMnemonicError(t *testing.T) {
|
|||||||
{"secret vault create work", func(c *Instance) error {
|
{"secret vault create work", func(c *Instance) error {
|
||||||
return c.CreateVault(c.cmd, "work")
|
return c.CreateVault(c.cmd, "work")
|
||||||
}},
|
}},
|
||||||
{"secret vault import other", func(c *Instance) error {
|
|
||||||
return c.VaultImport(c.cmd, "other")
|
|
||||||
}},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.command, func(t *testing.T) {
|
t.Run(tt.command, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
instance, _ := newTestInstance(afero.NewMemMapFs())
|
||||||
_, err := vault.CreateVault(fs, listTestStateDir, "other", nil, nil)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
instance, _ := newTestInstance(fs)
|
|
||||||
instance.Mnemonic = memguard.NewBufferFromBytes([]byte("not a mnemonic"))
|
instance.Mnemonic = memguard.NewBufferFromBytes([]byte("not a mnemonic"))
|
||||||
t.Cleanup(instance.Mnemonic.Destroy)
|
t.Cleanup(instance.Mnemonic.Destroy)
|
||||||
|
|
||||||
|
|||||||
@@ -140,16 +140,6 @@ func TestSecretManagerIntegration(t *testing.T) {
|
|||||||
// - currentvault symlink updated to point to work
|
// - currentvault symlink updated to point to work
|
||||||
test03CreateVault(t, tempDir, runSecret)
|
test03CreateVault(t, tempDir, runSecret)
|
||||||
|
|
||||||
// Test 4: Import mnemonic into work vault
|
|
||||||
// Command: secret vault import work
|
|
||||||
// Purpose: Import mnemonic with passphrase unlocker
|
|
||||||
// Expected filesystem:
|
|
||||||
// - work vault has pub.age file
|
|
||||||
// - work vault has unlockers.d/passphrase directory
|
|
||||||
// - Unlocker metadata and encrypted keys present
|
|
||||||
// NOTE: Skipped because vault creation now includes mnemonic import
|
|
||||||
// test04ImportMnemonic(t, tempDir, testMnemonic, testPassphrase, runSecretWithEnv)
|
|
||||||
|
|
||||||
// Test 5: Add secrets with versioning
|
// Test 5: Add secrets with versioning
|
||||||
// Command: echo "password123" | secret add database/password
|
// Command: echo "password123" | secret add database/password
|
||||||
// Purpose: Add a secret and verify versioned storage
|
// Purpose: Add a secret and verify versioned storage
|
||||||
@@ -535,65 +525,6 @@ func test03CreateVault(t *testing.T, tempDir string, runSecret func(...string) (
|
|||||||
assert.Contains(t, output, "work", "should list work vault")
|
assert.Contains(t, output, "work", "should list work vault")
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:unused // TODO: re-enable when vault import is implemented
|
|
||||||
func test04ImportMnemonic(t *testing.T, tempDir, testMnemonic, testPassphrase string, runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
// Import mnemonic into work vault
|
|
||||||
output, err := runSecretWithEnv(map[string]string{
|
|
||||||
secret.EnvMnemonic: testMnemonic,
|
|
||||||
secret.EnvUnlockPassphrase: testPassphrase,
|
|
||||||
}, "vault", "import", "work")
|
|
||||||
|
|
||||||
require.NoError(t, err, "vault import should succeed")
|
|
||||||
assert.Contains(t, output, "Successfully imported mnemonic into vault 'work'", "should confirm import")
|
|
||||||
|
|
||||||
// Verify work vault now has long-term key
|
|
||||||
workVaultDir := filepath.Join(tempDir, "vaults.d", "work")
|
|
||||||
pubKeyFile := filepath.Join(workVaultDir, "pub.age")
|
|
||||||
verifyFileExists(t, pubKeyFile)
|
|
||||||
|
|
||||||
// Verify passphrase unlocker was created
|
|
||||||
currentUnlocker := readFile(t, filepath.Join(workVaultDir, "current-unlocker"))
|
|
||||||
passphraseUnlockerDir := filepath.Join(workVaultDir, "unlockers.d", string(currentUnlocker))
|
|
||||||
verifyFileExists(t, passphraseUnlockerDir)
|
|
||||||
|
|
||||||
// Check unlocker files
|
|
||||||
unlockerMetadata := filepath.Join(passphraseUnlockerDir, "unlocker-metadata.json")
|
|
||||||
verifyFileExists(t, unlockerMetadata)
|
|
||||||
|
|
||||||
encryptedLTPrivKey := filepath.Join(passphraseUnlockerDir, "priv.age")
|
|
||||||
verifyFileExists(t, encryptedLTPrivKey)
|
|
||||||
|
|
||||||
encryptedLTPubKey := filepath.Join(passphraseUnlockerDir, "pub.age")
|
|
||||||
verifyFileExists(t, encryptedLTPubKey)
|
|
||||||
|
|
||||||
longtermKeyFile := filepath.Join(passphraseUnlockerDir, "longterm.age")
|
|
||||||
verifyFileExists(t, longtermKeyFile)
|
|
||||||
|
|
||||||
// Verify vault metadata was created with derivation index
|
|
||||||
vaultMetadata := filepath.Join(workVaultDir, "vault-metadata.json")
|
|
||||||
verifyFileExists(t, vaultMetadata)
|
|
||||||
|
|
||||||
metadataBytes := readFile(t, vaultMetadata)
|
|
||||||
|
|
||||||
var metadata map[string]any
|
|
||||||
|
|
||||||
err = json.Unmarshal(metadataBytes, &metadata)
|
|
||||||
require.NoError(t, err, "vault metadata should be valid JSON")
|
|
||||||
|
|
||||||
// Work vault should have a different derivation index than default (0)
|
|
||||||
derivIndex, ok := metadata["derivationIndex"].(float64)
|
|
||||||
require.True(t, ok, "derivationIndex should be a number")
|
|
||||||
assert.NotEqual(t, float64(0), derivIndex, "work vault should have non-zero derivation index")
|
|
||||||
|
|
||||||
// Verify public key hash is stored
|
|
||||||
assert.Contains(t, metadata, "publicKeyHash", "should contain public key hash")
|
|
||||||
pubKeyHash, ok := metadata["publicKeyHash"].(string)
|
|
||||||
require.True(t, ok, "publicKeyHash should be a string")
|
|
||||||
assert.NotEmpty(t, pubKeyHash, "public key hash should not be empty")
|
|
||||||
}
|
|
||||||
|
|
||||||
func test05AddSecret(t *testing.T, tempDir, testMnemonic string, runSecret func(...string) (string, error), runSecretWithEnv func(map[string]string, ...string) (string, error), runSecretWithStdin func(string, map[string]string, ...string) (string, error)) {
|
func test05AddSecret(t *testing.T, tempDir, testMnemonic string, runSecret func(...string) (string, error), runSecretWithEnv func(map[string]string, ...string) (string, error), runSecretWithStdin func(string, map[string]string, ...string) (string, error)) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
@@ -1939,14 +1870,6 @@ func test23ErrorHandling(t *testing.T, tempDir, secretPath, testMnemonic string,
|
|||||||
_, err = runSecret("vault", "select", "nonexistent")
|
_, err = runSecret("vault", "select", "nonexistent")
|
||||||
require.ErrorIs(t, err, vault.ErrVaultNotFound, "select non-existent vault should fail")
|
require.ErrorIs(t, err, vault.ErrVaultNotFound, "select non-existent vault should fail")
|
||||||
|
|
||||||
// Import to non-existent vault with test passphrase
|
|
||||||
testPassphrase := "test-passphrase-123" // Define testPassphrase locally
|
|
||||||
_, err = runSecretWithEnv(map[string]string{
|
|
||||||
secret.EnvMnemonic: testMnemonic,
|
|
||||||
secret.EnvUnlockPassphrase: testPassphrase,
|
|
||||||
}, "vault", "import", "nonexistent")
|
|
||||||
require.ErrorIs(t, err, vault.ErrVaultNotFound, "import to non-existent vault should fail")
|
|
||||||
|
|
||||||
// Get specific version that doesn't exist
|
// Get specific version that doesn't exist
|
||||||
_, err = runSecretWithEnv(map[string]string{
|
_, err = runSecretWithEnv(map[string]string{
|
||||||
secret.EnvMnemonic: testMnemonic,
|
secret.EnvMnemonic: testMnemonic,
|
||||||
|
|||||||
@@ -282,11 +282,10 @@ func stateDirModTimes(t *testing.T, fs afero.Fs) map[string]int64 {
|
|||||||
|
|
||||||
// setupEveryCommand makes what each command in
|
// setupEveryCommand makes what each command in
|
||||||
// TestChangingCommandsWaitForLock needs: the current vault "work" with two
|
// TestChangingCommandsWaitForLock needs: the current vault "work" with two
|
||||||
// versions of "test/secret", the vault "other" without a long-term key, for
|
// versions of "test/secret", the vault "other", and the file testInput.
|
||||||
// vault import, and the file testInput. There is no vault "default", which
|
// There is no vault "default", which init creates. If withUnlocker is set,
|
||||||
// init creates. If withUnlocker is set, it also gives "work" a passphrase
|
// it also gives "work" a passphrase unlocker, which is slow. It returns the
|
||||||
// unlocker, which is slow. It returns the older version and the unlocker's
|
// older version and the unlocker's ID.
|
||||||
// ID.
|
|
||||||
func setupEveryCommand(
|
func setupEveryCommand(
|
||||||
t *testing.T, fs afero.Fs, withUnlocker bool,
|
t *testing.T, fs afero.Fs, withUnlocker bool,
|
||||||
) (string, string) {
|
) (string, string) {
|
||||||
@@ -294,13 +293,9 @@ func setupEveryCommand(
|
|||||||
|
|
||||||
mnemonic := testMnemonicBuffer(t)
|
mnemonic := testMnemonicBuffer(t)
|
||||||
|
|
||||||
other, err := vault.CreateVault(fs, testStateDir, "other", mnemonic, nil)
|
_, err := vault.CreateVault(fs, testStateDir, "other", mnemonic, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
otherDir, err := other.GetDirectory()
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, fs.Remove(filepath.Join(otherDir, "pub.age")))
|
|
||||||
|
|
||||||
vlt, err := vault.CreateVault(fs, testStateDir, "work", mnemonic, nil)
|
vlt, err := vault.CreateVault(fs, testStateDir, "work", mnemonic, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
@@ -455,9 +450,6 @@ func TestChangingCommandsWaitForLock(t *testing.T) {
|
|||||||
{"vault select", false, func(cli *Instance, _, _ string) error {
|
{"vault select", false, func(cli *Instance, _, _ string) error {
|
||||||
return cli.SelectVault(cli.cmd, "other")
|
return cli.SelectVault(cli.cmd, "other")
|
||||||
}},
|
}},
|
||||||
{"vault import", false, func(cli *Instance, _, _ string) error {
|
|
||||||
return cli.VaultImport(cli.cmd, "other")
|
|
||||||
}},
|
|
||||||
{"vault rm --force", false, func(cli *Instance, _, _ string) error {
|
{"vault rm --force", false, func(cli *Instance, _, _ string) error {
|
||||||
return cli.RemoveVault(cli.cmd, "other", true)
|
return cli.RemoveVault(cli.cmd, "other", true)
|
||||||
}},
|
}},
|
||||||
|
|||||||
@@ -0,0 +1,204 @@
|
|||||||
|
package cli_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"filippo.io/age"
|
||||||
|
"github.com/awnumar/memguard"
|
||||||
|
"github.com/creack/pty"
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
|
"sneak.berlin/go/secret/internal/vault"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestPassphraseAskedAtTerminalWithPipedStdin is a regression test for
|
||||||
|
// https://git.eeqj.de/sneak/secret/issues/144: run at a terminal with stdin
|
||||||
|
// a pipe, as in `echo v2 | secret add s1 --force`, a command that needed
|
||||||
|
// the passphrase failed instead of asking for it. Each command here must ask
|
||||||
|
// on the terminal and succeed once the passphrase is typed there.
|
||||||
|
func TestPassphraseAskedAtTerminalWithPipedStdin(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
stateDir := t.TempDir()
|
||||||
|
|
||||||
|
passphrase := memguard.NewBufferFromBytes([]byte(testPassphrase))
|
||||||
|
defer passphrase.Destroy()
|
||||||
|
|
||||||
|
vlt, err := vault.CreateVault(afero.NewOsFs(), stateDir, "default",
|
||||||
|
testMnemonicBuffer(t), passphrase)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
value := memguard.NewBufferFromBytes([]byte("v1"))
|
||||||
|
defer value.Destroy()
|
||||||
|
|
||||||
|
require.NoError(t, vlt.AddSecret("s1", value, false))
|
||||||
|
|
||||||
|
identity, err := age.GenerateX25519Identity()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
key := secret.IdentityToLockedBuffer(identity)
|
||||||
|
defer key.Destroy()
|
||||||
|
|
||||||
|
require.NoError(t, vlt.AddSecret("mykey", key, false))
|
||||||
|
|
||||||
|
runAtTerminal(t, stateDir, "v2\n", "add", "s1", "--force")
|
||||||
|
|
||||||
|
vlt.UnlockPassphrase = passphrase
|
||||||
|
|
||||||
|
added, err := vlt.GetSecret("s1")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
defer added.Destroy()
|
||||||
|
|
||||||
|
assert.Equal(t, "v2", added.String())
|
||||||
|
|
||||||
|
encrypted := runAtTerminal(t, stateDir, "a document\n", "encrypt", "mykey")
|
||||||
|
decrypted := runAtTerminal(t, stateDir, encrypted, "decrypt", "mykey")
|
||||||
|
assert.Equal(t, "a document\n", decrypted)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInitWritesNoBlankLineAfterMnemonic runs `secret init 2>log` at a
|
||||||
|
// terminal: the terminal is its controlling terminal and none of stdin,
|
||||||
|
// stdout and stderr. The mnemonic is typed on the terminal and the prompt
|
||||||
|
// ends its line there, so stderr must not get a newline for it as well, a
|
||||||
|
// blank line in the log. pty.Open is described above
|
||||||
|
// TestRemoveIgnoresTerminalOnStdout.
|
||||||
|
func TestInitWritesNoBlankLineAfterMnemonic(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(t.Context(), commandWait)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
stateDir := t.TempDir()
|
||||||
|
|
||||||
|
//nolint:gosec // G204: test executes the freshly built secret binary
|
||||||
|
cmd := exec.CommandContext(ctx, secretBinaryPath(t), "init")
|
||||||
|
cmd.Env = []string{
|
||||||
|
secret.EnvStateDir + "=" + stateDir,
|
||||||
|
secret.EnvUnlockPassphrase + "=" + testPassphrase,
|
||||||
|
"PATH=" + os.Getenv("PATH"),
|
||||||
|
"HOME=" + os.Getenv("HOME"),
|
||||||
|
}
|
||||||
|
|
||||||
|
ptmx, tty, err := pty.Open()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
defer func() { _ = ptmx.Close() }()
|
||||||
|
|
||||||
|
deadline, _ := ctx.Deadline()
|
||||||
|
require.NoError(t, ptmx.SetReadDeadline(deadline))
|
||||||
|
|
||||||
|
var stderr strings.Builder
|
||||||
|
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
cmd.ExtraFiles = []*os.File{tty}
|
||||||
|
// Ctty is a descriptor in the new process: 3, the first of ExtraFiles.
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true, Setctty: true, Ctty: 3}
|
||||||
|
|
||||||
|
require.NoError(t, cmd.Start())
|
||||||
|
|
||||||
|
_ = tty.Close()
|
||||||
|
|
||||||
|
var (
|
||||||
|
shown []byte
|
||||||
|
char byte
|
||||||
|
)
|
||||||
|
|
||||||
|
terminal := bufio.NewReader(ptmx)
|
||||||
|
for !bytes.HasSuffix(shown, []byte("Enter your BIP39 mnemonic phrase: ")) {
|
||||||
|
char, err = terminal.ReadByte()
|
||||||
|
require.NoError(t, err, "secret init did not ask on the terminal: %s",
|
||||||
|
shown)
|
||||||
|
|
||||||
|
shown = append(shown, char)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = ptmx.WriteString(testMnemonic + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// The read ends once the command has exited and so closed the terminal.
|
||||||
|
rest, _ := io.ReadAll(terminal)
|
||||||
|
|
||||||
|
err = cmd.Wait()
|
||||||
|
require.NoError(t, err, "secret init: %s%s%s", shown, rest, stderr.String())
|
||||||
|
|
||||||
|
assert.True(t, strings.HasPrefix(stderr.String(),
|
||||||
|
"Initialized secrets manager at: "+stateDir+"\n\n"+
|
||||||
|
"Default vault created and configured\n"),
|
||||||
|
"stderr: %q", stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// runAtTerminal runs the secret binary with args and input on stdin, in a
|
||||||
|
// new session whose controlling terminal is a new terminal, which is also
|
||||||
|
// its stderr: a command typed at a terminal with its input piped. pty.Open
|
||||||
|
// is described above TestRemoveIgnoresTerminalOnStdout. runAtTerminal waits
|
||||||
|
// for the passphrase prompt on the terminal, types the passphrase there,
|
||||||
|
// and returns what the command wrote to stdout once it has succeeded.
|
||||||
|
func runAtTerminal(t *testing.T, stateDir, input string, args ...string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(t.Context(), commandWait)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
//nolint:gosec // G204: test executes the freshly built secret binary
|
||||||
|
cmd := exec.CommandContext(ctx, secretBinaryPath(t), args...)
|
||||||
|
cmd.Env = []string{
|
||||||
|
secret.EnvStateDir + "=" + stateDir,
|
||||||
|
"PATH=" + os.Getenv("PATH"),
|
||||||
|
"HOME=" + os.Getenv("HOME"),
|
||||||
|
}
|
||||||
|
|
||||||
|
ptmx, tty, err := pty.Open()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
defer func() { _ = ptmx.Close() }()
|
||||||
|
|
||||||
|
deadline, _ := ctx.Deadline()
|
||||||
|
require.NoError(t, ptmx.SetReadDeadline(deadline))
|
||||||
|
|
||||||
|
var stdout strings.Builder
|
||||||
|
|
||||||
|
cmd.Stdin = strings.NewReader(input)
|
||||||
|
cmd.Stdout = &stdout
|
||||||
|
cmd.Stderr = tty
|
||||||
|
// Ctty is a descriptor in the new process: 2, its stderr.
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true, Setctty: true, Ctty: 2}
|
||||||
|
|
||||||
|
require.NoError(t, cmd.Start())
|
||||||
|
|
||||||
|
_ = tty.Close()
|
||||||
|
|
||||||
|
var (
|
||||||
|
shown []byte
|
||||||
|
char byte
|
||||||
|
)
|
||||||
|
|
||||||
|
terminal := bufio.NewReader(ptmx)
|
||||||
|
for !bytes.HasSuffix(shown, []byte("Enter unlock passphrase: ")) {
|
||||||
|
char, err = terminal.ReadByte()
|
||||||
|
require.NoError(t, err, "secret %v did not ask on the terminal: %s",
|
||||||
|
args, shown)
|
||||||
|
|
||||||
|
shown = append(shown, char)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = ptmx.WriteString(testPassphrase + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// The read ends once the command has exited and so closed the terminal.
|
||||||
|
rest, _ := io.ReadAll(terminal)
|
||||||
|
|
||||||
|
require.NoError(t, cmd.Wait(), "secret %v: %s%s", args, shown, rest)
|
||||||
|
|
||||||
|
return stdout.String()
|
||||||
|
}
|
||||||
@@ -306,8 +306,7 @@ func TestInvalidVersionLeavesVaultsUnchanged(t *testing.T) {
|
|||||||
|
|
||||||
// TestInvalidVaultNameLeavesStateUnchanged is a regression test for
|
// TestInvalidVaultNameLeavesStateUnchanged is a regression test for
|
||||||
// https://git.eeqj.de/sneak/secret/issues/68, where
|
// https://git.eeqj.de/sneak/secret/issues/68, where
|
||||||
// `secret vault import ..` wrote a long-term key and an unlocker into the
|
// `secret vault select ..` made the state directory itself the current
|
||||||
// state directory itself, and `secret vault select ..` made it the current
|
|
||||||
// vault. Each command that takes a vault name must reject an invalid one
|
// vault. Each command that takes a vault name must reject an invalid one
|
||||||
// before building a path from it. The instance is given the mnemonic and
|
// before building a path from it. The instance is given the mnemonic and
|
||||||
// the passphrase, and moves and removals use --force, so that only the name
|
// the passphrase, and moves and removals use --force, so that only the name
|
||||||
@@ -331,9 +330,6 @@ func TestInvalidVaultNameLeavesStateUnchanged(t *testing.T) {
|
|||||||
{"vault create %q", func(c *cli.Instance, name string) error {
|
{"vault create %q", func(c *cli.Instance, name string) error {
|
||||||
return c.CreateVault(cmd, name)
|
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 {
|
{"vault select %q", func(c *cli.Instance, name string) error {
|
||||||
return c.SelectVault(cmd, name)
|
return c.SelectVault(cmd, name)
|
||||||
}},
|
}},
|
||||||
|
|||||||
+21
-8
@@ -15,16 +15,29 @@ import (
|
|||||||
// but exit with the code.
|
// but exit with the code.
|
||||||
func Entry() int {
|
func Entry() int {
|
||||||
// On SIGINT or SIGTERM memguard runs this function, wipes every buffer
|
// On SIGINT or SIGTERM memguard runs this function, wipes every buffer
|
||||||
// and exits with status 1. The passphrase prompt turns terminal echo
|
// and exits with status 1. The passphrase prompt turns echo off on the
|
||||||
// off until the read finishes, so a signal there would leave echo off.
|
// controlling terminal until the read finishes, so a signal there would
|
||||||
// Only a process in the terminal's foreground process group may reset
|
// leave echo off. Only a process in the terminal's foreground process
|
||||||
// it: one in the background that tries is stopped instead of exiting.
|
// group may reset it: one in the background that tries is stopped
|
||||||
terminalState, terminalErr := term.GetState(unix.Stdin)
|
// instead of exiting.
|
||||||
|
terminal, terminalErr := os.Open(secret.TerminalPath)
|
||||||
|
|
||||||
|
var terminalState *term.State
|
||||||
|
|
||||||
|
if terminalErr == nil {
|
||||||
|
defer func() { _ = terminal.Close() }()
|
||||||
|
|
||||||
|
terminalState, terminalErr = term.GetState(int(terminal.Fd()))
|
||||||
|
}
|
||||||
|
|
||||||
memguard.CatchSignal(func(os.Signal) {
|
memguard.CatchSignal(func(os.Signal) {
|
||||||
foreground, err := unix.IoctlGetInt(unix.Stdin, unix.TIOCGPGRP)
|
if terminalErr != nil {
|
||||||
if terminalErr == nil && err == nil && foreground == unix.Getpgrp() {
|
return
|
||||||
_ = term.Restore(unix.Stdin, terminalState)
|
}
|
||||||
|
|
||||||
|
foreground, err := unix.IoctlGetInt(int(terminal.Fd()), unix.TIOCGPGRP)
|
||||||
|
if err == nil && foreground == unix.Getpgrp() {
|
||||||
|
_ = term.Restore(int(terminal.Fd()), terminalState)
|
||||||
}
|
}
|
||||||
}, os.Interrupt, unix.SIGTERM)
|
}, os.Interrupt, unix.SIGTERM)
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
@@ -288,7 +289,7 @@ func TestMissingCurrentUnlockerNamesMnemonic(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// TestPassphraseNotReadNamesNoMnemonic runs `secret get x` on the built
|
// TestPassphraseNotReadNamesNoMnemonic runs `secret get x` on the built
|
||||||
// binary without SB_UNLOCK_PASSPHRASE and with a stdin that is not a
|
// binary without SB_UNLOCK_PASSPHRASE and in a new session, which has no
|
||||||
// terminal, so the passphrase cannot be read. The unlocker was not tried,
|
// terminal, so the passphrase cannot be read. The unlocker was not tried,
|
||||||
// and adding one would need a passphrase read the same way, so the error
|
// and adding one would need a passphrase read the same way, so the error
|
||||||
// is the cause alone, without the advice to use the mnemonic.
|
// is the cause alone, without the advice to use the mnemonic.
|
||||||
@@ -319,15 +320,16 @@ func TestPassphraseNotReadNamesNoMnemonic(t *testing.T) {
|
|||||||
"PATH=" + os.Getenv("PATH"),
|
"PATH=" + os.Getenv("PATH"),
|
||||||
"HOME=" + os.Getenv("HOME"),
|
"HOME=" + os.Getenv("HOME"),
|
||||||
}
|
}
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true}
|
||||||
|
|
||||||
output, err := cmd.CombinedOutput()
|
output, err := cmd.CombinedOutput()
|
||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
|
|
||||||
assert.Equal(t, "Error: failed to unlock vault: "+
|
assert.Equal(t, "Error: failed to unlock vault: "+
|
||||||
"failed to get long-term key: failed to get unlocker identity: "+
|
"failed to get long-term key: failed to get unlocker identity: "+
|
||||||
"failed to read passphrase: stdin is not a terminal (piped input or "+
|
"failed to read passphrase: there is no terminal to ask on. Please "+
|
||||||
"script). Please set the SB_UNLOCK_PASSPHRASE environment variable or "+
|
"set the SB_UNLOCK_PASSPHRASE environment variable or run "+
|
||||||
"run interactively\n", string(output))
|
"interactively\n", string(output))
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestCryptoUnlockFailureNamesMnemonic checks that `secret encrypt` and
|
// TestCryptoUnlockFailureNamesMnemonic checks that `secret encrypt` and
|
||||||
|
|||||||
@@ -371,19 +371,3 @@ func TestRemoveSecretAbortsWhenVersionsUnreadable(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.True(t, exists, "the secret must not be removed")
|
assert.True(t, exists, "the secret must not be removed")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVaultImportAbortsWhenPubKeyUnreadable asserts that a mnemonic import
|
|
||||||
// stops when whether the vault already has a long-term key cannot be
|
|
||||||
// determined.
|
|
||||||
func TestVaultImportAbortsWhenPubKeyUnreadable(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
base := newListTestVault(t, 1)
|
|
||||||
instance, cmd := newTestInstance(&statFailFs{
|
|
||||||
Fs: base, path: filepath.Join(testVaultDir(listTestVaultName), "pub.age"),
|
|
||||||
})
|
|
||||||
|
|
||||||
err := instance.importMnemonic(cmd, listTestVaultName)
|
|
||||||
|
|
||||||
require.ErrorIs(t, err, errStatFailed)
|
|
||||||
}
|
|
||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
@@ -16,19 +15,12 @@ import (
|
|||||||
"sneak.berlin/go/secret/internal/bip39"
|
"sneak.berlin/go/secret/internal/bip39"
|
||||||
"sneak.berlin/go/secret/internal/secret"
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
"sneak.berlin/go/secret/internal/vault"
|
"sneak.berlin/go/secret/internal/vault"
|
||||||
"sneak.berlin/go/secret/pkg/agehd"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Sentinel errors for vault operations
|
// Sentinel errors for vault operations
|
||||||
var (
|
var (
|
||||||
errMnemonicEmpty = errors.New("mnemonic cannot be empty")
|
errMnemonicEmpty = errors.New("mnemonic cannot be empty")
|
||||||
errInvalidMnemonicPhrase = errors.New("invalid BIP39 mnemonic phrase")
|
errInvalidMnemonicPhrase = errors.New("invalid BIP39 mnemonic phrase")
|
||||||
errVaultHasLongTermKey = errors.New(
|
|
||||||
"already has a long-term key configured")
|
|
||||||
errMnemonicEnvNotSet = errors.New(
|
|
||||||
"SB_SECRET_MNEMONIC environment variable not set")
|
|
||||||
errPassphraseEnvNotSet = errors.New(
|
|
||||||
"SB_UNLOCK_PASSPHRASE environment variable not set")
|
|
||||||
errCannotRemoveLastVault = errors.New("cannot remove the last vault")
|
errCannotRemoveLastVault = errors.New("cannot remove the last vault")
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -42,7 +34,6 @@ func newVaultCmd() *cobra.Command {
|
|||||||
cmd.AddCommand(newVaultListCmd())
|
cmd.AddCommand(newVaultListCmd())
|
||||||
cmd.AddCommand(newVaultCreateCmd())
|
cmd.AddCommand(newVaultCreateCmd())
|
||||||
cmd.AddCommand(newVaultSelectCmd())
|
cmd.AddCommand(newVaultSelectCmd())
|
||||||
cmd.AddCommand(newVaultImportCmd())
|
|
||||||
cmd.AddCommand(newVaultRemoveCmd())
|
cmd.AddCommand(newVaultRemoveCmd())
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
@@ -111,38 +102,6 @@ func newVaultSelectCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newVaultImportCmd() *cobra.Command {
|
|
||||||
cli, err := NewCLIInstance()
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("failed to initialize CLI: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return &cobra.Command{
|
|
||||||
Use: "import <vault-name>",
|
|
||||||
Short: "Import a mnemonic into a vault",
|
|
||||||
Long: `Import a BIP39 mnemonic phrase into the specified vault ` +
|
|
||||||
`(default if not specified).`,
|
|
||||||
Args: cobra.MaximumNArgs(1),
|
|
||||||
ValidArgsFunction: getVaultNamesCompletionFunc(cli.fs, cli.stateDir),
|
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
|
||||||
vaultName := "default"
|
|
||||||
if len(args) > 0 {
|
|
||||||
vaultName = args[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
cli, err := NewCLIInstance()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to initialize CLI: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
destroySecrets := cli.readSecretEnv()
|
|
||||||
defer destroySecrets()
|
|
||||||
|
|
||||||
return cli.VaultImport(cmd, vaultName)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func newVaultRemoveCmd() *cobra.Command {
|
func newVaultRemoveCmd() *cobra.Command {
|
||||||
cli, err := NewCLIInstance()
|
cli, err := NewCLIInstance()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -336,196 +295,6 @@ func (cli *Instance) SelectVault(cmd *cobra.Command, name string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// vaultImportPreflight verifies the vault exists without a long-term key
|
|
||||||
// and returns the vault directory, public key path, and validated mnemonic
|
|
||||||
func (cli *Instance) vaultImportPreflight(
|
|
||||||
vlt *vault.Vault, vaultName string,
|
|
||||||
) (string, string, string, error) {
|
|
||||||
// Check if vault exists
|
|
||||||
vaultDir, err := vlt.GetDirectory()
|
|
||||||
if err != nil {
|
|
||||||
return "", "", "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
exists, err := afero.DirExists(cli.fs, vaultDir)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", "", fmt.Errorf("failed to check if vault exists: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !exists {
|
|
||||||
return "", "", "", fmt.Errorf("vault '%s' %w",
|
|
||||||
vaultName, vault.ErrVaultNotFound)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if vault already has a public key
|
|
||||||
pubKeyPath := vaultDir + "/pub.age"
|
|
||||||
|
|
||||||
exists, err = afero.Exists(cli.fs, pubKeyPath)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", "", fmt.Errorf("failed to check %s: %w", pubKeyPath, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if exists {
|
|
||||||
return "", "", "", fmt.Errorf("vault '%s' %w",
|
|
||||||
vaultName, errVaultHasLongTermKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get mnemonic from environment
|
|
||||||
if cli.Mnemonic == nil {
|
|
||||||
return "", "", "", errMnemonicEnvNotSet
|
|
||||||
}
|
|
||||||
|
|
||||||
mnemonic := cli.Mnemonic.String()
|
|
||||||
|
|
||||||
// Validate the mnemonic
|
|
||||||
mnemonicWords := strings.Fields(mnemonic)
|
|
||||||
secret.Debug("Validating BIP39 mnemonic", "word_count", len(mnemonicWords))
|
|
||||||
|
|
||||||
if !bip39.IsMnemonicValid(mnemonic) {
|
|
||||||
return "", "", "", errInvalidMnemonicPhrase
|
|
||||||
}
|
|
||||||
|
|
||||||
return vaultDir, pubKeyPath, mnemonic, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// updateVaultImportMetadata stores the derivation info in vault metadata
|
|
||||||
func updateVaultImportMetadata(
|
|
||||||
fs afero.Fs, vaultDir string, derivationIndex uint32,
|
|
||||||
publicKeyHash, familyHash string,
|
|
||||||
) error {
|
|
||||||
// Load existing metadata
|
|
||||||
existingMetadata, err := vault.LoadVaultMetadata(fs, vaultDir)
|
|
||||||
if err != nil {
|
|
||||||
// If metadata doesn't exist, create new
|
|
||||||
existingMetadata = &vault.Metadata{
|
|
||||||
CreatedAt: time.Now(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update metadata with new derivation info
|
|
||||||
existingMetadata.DerivationIndex = derivationIndex
|
|
||||||
existingMetadata.PublicKeyHash = publicKeyHash
|
|
||||||
existingMetadata.MnemonicFamilyHash = familyHash
|
|
||||||
|
|
||||||
err = vault.SaveVaultMetadata(fs, vaultDir, existingMetadata)
|
|
||||||
if err != nil {
|
|
||||||
secret.Debug("Failed to save vault metadata", "error", err)
|
|
||||||
|
|
||||||
return fmt.Errorf("failed to save vault metadata: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
secret.Debug("Saved vault metadata with derivation index and public key hash")
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// VaultImport imports a mnemonic into a specific vault, holding the state
|
|
||||||
// directory lock while importMnemonic runs
|
|
||||||
func (cli *Instance) VaultImport(cmd *cobra.Command, vaultName string) error {
|
|
||||||
err := vault.ValidateVaultName(vaultName)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
release, err := vault.LockStateDir(cli.fs, cli.stateDir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer release()
|
|
||||||
|
|
||||||
return cli.importMnemonic(cmd, vaultName)
|
|
||||||
}
|
|
||||||
|
|
||||||
// importMnemonic gives the vault a long-term key derived from the mnemonic
|
|
||||||
// and a passphrase unlocker
|
|
||||||
func (cli *Instance) importMnemonic(cmd *cobra.Command, vaultName string) error {
|
|
||||||
secret.Debug("Importing mnemonic into vault",
|
|
||||||
"vault_name", vaultName, "state_dir", cli.stateDir)
|
|
||||||
|
|
||||||
// Get the specific vault by name
|
|
||||||
vlt := vault.NewVault(cli.fs, cli.stateDir, vaultName)
|
|
||||||
|
|
||||||
vaultDir, pubKeyPath, mnemonic, err := cli.vaultImportPreflight(vlt, vaultName)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get the next available derivation index for this mnemonic
|
|
||||||
derivationIndex, err := vault.GetNextDerivationIndex(cli.fs, cli.stateDir, mnemonic)
|
|
||||||
if err != nil {
|
|
||||||
secret.Debug("Failed to get next derivation index", "error", err)
|
|
||||||
|
|
||||||
return fmt.Errorf("failed to get next derivation index: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
secret.Debug("Using derivation index", "index", derivationIndex)
|
|
||||||
|
|
||||||
// Derive long-term key from mnemonic with the appropriate index
|
|
||||||
secret.Debug("Deriving long-term key from mnemonic", "index", derivationIndex)
|
|
||||||
|
|
||||||
ltIdentity, err := agehd.DeriveIdentity(mnemonic, derivationIndex)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to derive long-term key: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store long-term public key in vault
|
|
||||||
ltPublicKey := ltIdentity.Recipient().String()
|
|
||||||
secret.Debug("Storing long-term public key",
|
|
||||||
"pubkey", ltPublicKey, "vault_dir", vaultDir)
|
|
||||||
|
|
||||||
err = secret.WriteFileAtomic(cli.fs, pubKeyPath, []byte(ltPublicKey))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to store long-term public key: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Calculate public key hash from the actual derivation index being used
|
|
||||||
// This is used to verify that the derived key matches what was stored
|
|
||||||
publicKeyHash := vault.ComputeDoubleSHA256([]byte(ltIdentity.Recipient().String()))
|
|
||||||
|
|
||||||
// Calculate family hash from index 0 (same for all vaults with this
|
|
||||||
// mnemonic). This is used to identify which vaults belong to the same
|
|
||||||
// mnemonic family.
|
|
||||||
identity0, err := agehd.DeriveIdentity(mnemonic, 0)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to derive identity for index 0: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
familyHash := vault.ComputeDoubleSHA256([]byte(identity0.Recipient().String()))
|
|
||||||
|
|
||||||
err = updateVaultImportMetadata(
|
|
||||||
cli.fs, vaultDir, derivationIndex, publicKeyHash, familyHash)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get passphrase from environment variable
|
|
||||||
passphraseBuffer := cli.UnlockPassphrase
|
|
||||||
if passphraseBuffer == nil {
|
|
||||||
return errPassphraseEnvNotSet
|
|
||||||
}
|
|
||||||
|
|
||||||
secret.Debug("Using unlock passphrase from environment variable")
|
|
||||||
|
|
||||||
// Unlock the vault with the derived long-term key
|
|
||||||
vlt.Unlock(ltIdentity)
|
|
||||||
|
|
||||||
// Create passphrase-protected unlocker
|
|
||||||
secret.Debug("Creating passphrase-protected unlocker")
|
|
||||||
|
|
||||||
passphraseUnlocker, err := vlt.CreatePassphraseUnlocker(passphraseBuffer)
|
|
||||||
if err != nil {
|
|
||||||
secret.Debug("Failed to create unlocker", "error", err)
|
|
||||||
|
|
||||||
return fmt.Errorf("failed to create unlocker: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cmd.Printf("Successfully imported mnemonic into vault '%s'\n", vaultName)
|
|
||||||
cmd.Printf("Long-term public key: %s\n", ltPublicKey)
|
|
||||||
cmd.Printf("Unlocker ID: %s\n", passphraseUnlocker.GetID())
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// countVaultSecrets returns the number of secrets in the vault directory
|
// countVaultSecrets returns the number of secrets in the vault directory
|
||||||
func (cli *Instance) countVaultSecrets(vaultDir string) (int, error) {
|
func (cli *Instance) countVaultSecrets(vaultDir string) (int, error) {
|
||||||
secretsDir := filepath.Join(vaultDir, "secrets.d")
|
secretsDir := filepath.Join(vaultDir, "secrets.d")
|
||||||
|
|||||||
@@ -17,6 +17,10 @@ const (
|
|||||||
// EnvGPGKeyID is the environment variable for providing the GPG key ID
|
// EnvGPGKeyID is the environment variable for providing the GPG key ID
|
||||||
EnvGPGKeyID = "SB_GPG_KEY_ID"
|
EnvGPGKeyID = "SB_GPG_KEY_ID"
|
||||||
|
|
||||||
|
// TerminalPath opens the controlling terminal of the process that opens
|
||||||
|
// it, where the passphrase and mnemonic prompts ask.
|
||||||
|
TerminalPath = "/dev/tty"
|
||||||
|
|
||||||
// UnlockerTimeFormat is the layout of the time, in UTC, in the name of a
|
// UnlockerTimeFormat is the layout of the time, in UTC, in the name of a
|
||||||
// new unlocker's directory. It runs to the nanosecond, so that every new
|
// new unlocker's directory. It runs to the nanosecond, so that every new
|
||||||
// unlocker, even one added right after another, gets a directory of its
|
// unlocker, even one added right after another, gets a directory of its
|
||||||
|
|||||||
+17
-26
@@ -6,7 +6,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"syscall"
|
|
||||||
"unsafe"
|
"unsafe"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
@@ -16,11 +15,8 @@ import (
|
|||||||
|
|
||||||
var (
|
var (
|
||||||
errNilPassphraseBuffer = errors.New("passphrase buffer is nil")
|
errNilPassphraseBuffer = errors.New("passphrase buffer is nil")
|
||||||
errStdinNotTerminal = errors.New(
|
errNoTerminal = errors.New("there is no terminal to ask on")
|
||||||
"stdin is not a terminal (piped input or script)")
|
errNothingEntered = errors.New("nothing was entered")
|
||||||
errStderrNotTerminal = errors.New(
|
|
||||||
"stderr is not a terminal (running in non-interactive mode)")
|
|
||||||
errNothingEntered = errors.New("nothing was entered")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrMnemonicNotRead is wrapped in every error of ReadMnemonic: there is no
|
// ErrMnemonicNotRead is wrapped in every error of ReadMnemonic: there is no
|
||||||
@@ -193,38 +189,33 @@ func ReadMnemonic(prompt string) (*memguard.LockedBuffer, error) {
|
|||||||
return readFromTerminal(prompt, ErrMnemonicNotRead, EnvMnemonic)
|
return readFromTerminal(prompt, ErrMnemonicNotRead, EnvMnemonic)
|
||||||
}
|
}
|
||||||
|
|
||||||
// readFromTerminal reads input from the terminal without echoing it. Every
|
// readFromTerminal asks on the controlling terminal and reads the answer
|
||||||
// error it returns wraps notRead; without a terminal, the error says to set
|
// there without echoing it, whatever stdin is: in
|
||||||
// envVar instead.
|
// `echo value | secret add name --force`, stdin is a pipe. Every error it
|
||||||
|
// returns wraps notRead; without a terminal, the error says to set envVar
|
||||||
|
// instead.
|
||||||
func readFromTerminal(
|
func readFromTerminal(
|
||||||
prompt string, notRead error, envVar string,
|
prompt string, notRead error, envVar string,
|
||||||
) (*memguard.LockedBuffer, error) {
|
) (*memguard.LockedBuffer, error) {
|
||||||
// Check if stdin is a terminal
|
terminal, err := os.OpenFile(TerminalPath, os.O_RDWR, 0)
|
||||||
if !term.IsTerminal(syscall.Stdin) {
|
if err != nil {
|
||||||
// Not a terminal - never read secrets from piped input
|
Debug("Failed to open the controlling terminal", "error", err)
|
||||||
// for security reasons
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"%w: %w. Please set the %s environment variable or run interactively",
|
"%w: %w. Please set the %s environment variable or run interactively",
|
||||||
notRead, errStdinNotTerminal, envVar)
|
notRead, errNoTerminal, envVar)
|
||||||
}
|
}
|
||||||
|
defer func() { _ = terminal.Close() }()
|
||||||
|
|
||||||
// stdin is a terminal, check if stderr is also a terminal for
|
_, _ = fmt.Fprint(terminal, prompt)
|
||||||
// interactive prompting
|
|
||||||
if !term.IsTerminal(syscall.Stderr) {
|
|
||||||
return nil, fmt.Errorf("%w: %w. Please set the %s environment variable",
|
|
||||||
notRead, errStderrNotTerminal, envVar)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Both stdin and stderr are terminals - use secure password reading
|
input, err := term.ReadPassword(int(terminal.Fd()))
|
||||||
fmt.Fprint(os.Stderr, prompt) // Write prompt to stderr, not stdout
|
|
||||||
|
|
||||||
input, err := term.ReadPassword(syscall.Stdin)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("%w: %w", notRead, err)
|
return nil, fmt.Errorf("%w: %w", notRead, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Print newline to stderr since ReadPassword doesn't echo
|
// The newline typed after the input, which ReadPassword did not echo
|
||||||
fmt.Fprintln(os.Stderr)
|
_, _ = fmt.Fprintln(terminal)
|
||||||
|
|
||||||
if len(input) == 0 {
|
if len(input) == 0 {
|
||||||
return nil, fmt.Errorf("%w: %w", notRead, errNothingEntered)
|
return nil, fmt.Errorf("%w: %w", notRead, errNothingEntered)
|
||||||
|
|||||||
@@ -296,91 +296,6 @@ func TestSampleHashCalculation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWorkflowMismatch(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// Create a temporary directory for testing
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
|
|
||||||
// Test Case 1: Create vault WITH mnemonic (like init command)
|
|
||||||
_, err := vault.CreateVault(fs, tempDir, "default", testMnemonicBuffer(t), nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to create vault with mnemonic: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load metadata for vault1
|
|
||||||
vault1Dir := filepath.Join(tempDir, "vaults.d", "default")
|
|
||||||
|
|
||||||
metadata1, err := vault.LoadVaultMetadata(fs, vault1Dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to load vault1 metadata: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Logf("Vault1 (with mnemonic) - DerivationIndex: %d, PublicKeyHash: %s",
|
|
||||||
metadata1.DerivationIndex, metadata1.PublicKeyHash)
|
|
||||||
|
|
||||||
// Test Case 2: Create vault WITHOUT mnemonic, then import (work vault)
|
|
||||||
_, err = vault.CreateVault(fs, tempDir, "work", nil, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to create vault without mnemonic: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
vault2Dir := filepath.Join(tempDir, "vaults.d", "work")
|
|
||||||
|
|
||||||
// Simulate the vault import process: get the next available derivation
|
|
||||||
// index for this mnemonic
|
|
||||||
derivationIndex, err := vault.GetNextDerivationIndex(fs, tempDir, testMnemonic)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to get next derivation index: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Logf("Next derivation index for import: %d", derivationIndex)
|
|
||||||
|
|
||||||
// Calculate public key hash from index 0 (same as in VaultImport)
|
|
||||||
identity0, err := agehd.DeriveIdentity(testMnemonic, 0)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to derive identity for index 0: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
publicKeyHash := vault.ComputeDoubleSHA256(
|
|
||||||
[]byte(identity0.Recipient().String()))
|
|
||||||
|
|
||||||
// Load existing metadata and update it (same as in VaultImport)
|
|
||||||
existingMetadata, err := vault.LoadVaultMetadata(fs, vault2Dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to load existing metadata: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update metadata with new derivation info
|
|
||||||
existingMetadata.DerivationIndex = derivationIndex
|
|
||||||
existingMetadata.PublicKeyHash = publicKeyHash
|
|
||||||
|
|
||||||
err = vault.SaveVaultMetadata(fs, vault2Dir, existingMetadata)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to save vault metadata: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load updated metadata for vault2
|
|
||||||
metadata2, err := vault.LoadVaultMetadata(fs, vault2Dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to load vault2 metadata: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Logf("Vault2 (imported mnemonic) - DerivationIndex: %d, PublicKeyHash: %s",
|
|
||||||
metadata2.DerivationIndex, metadata2.PublicKeyHash)
|
|
||||||
|
|
||||||
// Verify that both vaults have the same public key hash
|
|
||||||
if metadata1.PublicKeyHash != metadata2.PublicKeyHash {
|
|
||||||
t.Errorf("Public key hashes don't match!")
|
|
||||||
t.Logf("Vault1 hash: %s", metadata1.PublicKeyHash)
|
|
||||||
t.Logf("Vault2 hash: %s", metadata2.PublicKeyHash)
|
|
||||||
} else {
|
|
||||||
t.Logf("SUCCESS: Both vaults have the same public key hash: %s",
|
|
||||||
metadata1.PublicKeyHash)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestReverseEngineerHash(t *testing.T) {
|
func TestReverseEngineerHash(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user