Compare commits
2
Commits
ef10bdddda
...
28606075c6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
28606075c6 | ||
|
|
46c395e045 |
No files matched your search
@@ -127,6 +127,17 @@ one.
|
|||||||
|
|
||||||
### Secret Management
|
### Secret Management
|
||||||
|
|
||||||
|
#### Secret Size
|
||||||
|
|
||||||
|
A secret's value is held in locked memory, which is never written to swap.
|
||||||
|
`secret` raises its locked-memory limit (`ulimit -l`) to the hard limit when it
|
||||||
|
starts, and `secret add`, `secret import` and `secret generate secret` refuse a
|
||||||
|
value that does not fit in that limit with 16 memory pages to spare (64 KiB with
|
||||||
|
4 KiB pages), with an error that names the limit. Linux's usual limit of 8 MiB
|
||||||
|
allows a value of nearly 8 MiB; a larger one needs a higher hard limit, such as
|
||||||
|
`memlock` in `/etc/security/limits.conf`. No value may be over 100 MiB, whatever
|
||||||
|
the limit.
|
||||||
|
|
||||||
#### `secret add <secret-name> [--force]`
|
#### `secret add <secret-name> [--force]`
|
||||||
|
|
||||||
Adds a secret to the current vault. Reads the secret value from stdin.
|
Adds a secret to the current vault. Reads the secret value from stdin.
|
||||||
@@ -381,6 +392,11 @@ which every command except `secret vault import` offers when the variable is not
|
|||||||
set, is the safer default; `secret vault import` has no prompt and needs both
|
set, is the safer default; `secret vault import` has no prompt and needs both
|
||||||
variables.
|
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
|
||||||
|
|
||||||
### Encryption
|
### Encryption
|
||||||
|
|||||||
@@ -18,6 +18,27 @@ https://git.eeqj.de/sneak/secret/milestone/12
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-14: A secret too large for the locked-memory limit (`ulimit -l`) makes
|
||||||
|
`secret add`, `secret import` and `secret generate secret` fail with an error
|
||||||
|
that names the limit, not crash with a panic
|
||||||
|
(https://git.eeqj.de/sneak/secret/issues/145). memguard panics when it cannot
|
||||||
|
lock memory, and the value was held twice, so with the usual 8 MiB limit any
|
||||||
|
value over about 4 MiB crashed. `secret` now raises the limit to the hard
|
||||||
|
limit at startup. The value is read a page at a time into a `memguard.Stream`,
|
||||||
|
which keeps it encrypted, and copied once into locked memory only after its
|
||||||
|
size is checked against 100 MiB and against the limit less 16 pages for the
|
||||||
|
command's keys. `generate secret` checks the length before it generates
|
||||||
|
anything.
|
||||||
|
- 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"
|
||||||
@@ -197,10 +198,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 +217,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
|
||||||
|
|||||||
@@ -133,10 +133,16 @@ func (cli *Instance) GenerateSecret(
|
|||||||
return errLengthTooSmall
|
return errLengthTooSmall
|
||||||
}
|
}
|
||||||
|
|
||||||
var (
|
if length > maxSecretSize {
|
||||||
secretValue string
|
return errSecretTooLarge
|
||||||
err error
|
}
|
||||||
)
|
|
||||||
|
err := checkLockedMemoryLimit(length)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var secretValue string
|
||||||
|
|
||||||
switch secretType {
|
switch secretType {
|
||||||
case "base58":
|
case "base58":
|
||||||
|
|||||||
@@ -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
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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()
|
||||||
|
}
|
||||||
+36
-8
@@ -14,17 +14,32 @@ import (
|
|||||||
// every memguard buffer before it returns, so the caller must do nothing
|
// every memguard buffer before it returns, so the caller must do nothing
|
||||||
// but exit with the code.
|
// but exit with the code.
|
||||||
func Entry() int {
|
func Entry() int {
|
||||||
|
raiseLockedMemoryLimit()
|
||||||
|
|
||||||
// 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)
|
||||||
|
|
||||||
@@ -38,6 +53,19 @@ func Entry() int {
|
|||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// raiseLockedMemoryLimit raises this process's limit on locked memory, which
|
||||||
|
// holds every secret value, to the hard limit, the most a process may set
|
||||||
|
// without privileges. When that fails the limit stays as it was, and
|
||||||
|
// checkLockedMemoryLimit names it in its error.
|
||||||
|
func raiseLockedMemoryLimit() {
|
||||||
|
var limit unix.Rlimit
|
||||||
|
|
||||||
|
if unix.Getrlimit(unix.RLIMIT_MEMLOCK, &limit) == nil {
|
||||||
|
limit.Cur = limit.Max
|
||||||
|
_ = unix.Setrlimit(unix.RLIMIT_MEMLOCK, &limit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func newRootCmd() *cobra.Command {
|
func newRootCmd() *cobra.Command {
|
||||||
secret.Debug("newRootCmd starting")
|
secret.Debug("newRootCmd starting")
|
||||||
|
|
||||||
|
|||||||
+93
-96
@@ -14,6 +14,7 @@ import (
|
|||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
"sneak.berlin/go/secret/internal/secret"
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
"sneak.berlin/go/secret/internal/vault"
|
"sneak.berlin/go/secret/internal/vault"
|
||||||
)
|
)
|
||||||
@@ -24,26 +25,28 @@ const (
|
|||||||
// vaultSecretParts is the number of parts when splitting vault:secret
|
// vaultSecretParts is the number of parts when splitting vault:secret
|
||||||
vaultSecretParts = 2
|
vaultSecretParts = 2
|
||||||
|
|
||||||
// initialBufferSize is the starting size for secret read buffers (4KB)
|
|
||||||
initialBufferSize = 4 * 1024
|
|
||||||
// maxSecretSize is the maximum allowed size of a secret (100MB)
|
// maxSecretSize is the maximum allowed size of a secret (100MB)
|
||||||
maxSecretSize = 100 * 1024 * 1024
|
maxSecretSize = 100 * 1024 * 1024
|
||||||
|
|
||||||
|
// lockedMemoryReservePages is the locked memory, in pages, that a command
|
||||||
|
// needs besides the value it stores, for its keys and its read buffer,
|
||||||
|
// with room to spare: memguard locks whole pages, at least one for each
|
||||||
|
// buffer, and `secret add` needs 7.
|
||||||
|
lockedMemoryReservePages = 16
|
||||||
|
// kibibyte is the unit of the locked-memory limit in `ulimit -l`.
|
||||||
|
kibibyte = 1024
|
||||||
)
|
)
|
||||||
|
|
||||||
// Sentinel errors for secret operations
|
// Sentinel errors for secret operations
|
||||||
var (
|
var (
|
||||||
errSecretTooLarge = errors.New("secret too large: exceeds 100MB limit")
|
errSecretTooLarge = errors.New("secret too large: exceeds 100MB limit")
|
||||||
|
errLockedMemoryLimit = errors.New(
|
||||||
|
"secret too large for the locked-memory limit")
|
||||||
errCrossVaultSourceUnqualified = errors.New(
|
errCrossVaultSourceUnqualified = errors.New(
|
||||||
"source must specify vault (e.g., vault:secret) for cross-vault move")
|
"source must specify vault (e.g., vault:secret) for cross-vault move")
|
||||||
errMoveOntoItself = errors.New("cannot be moved onto itself")
|
errMoveOntoItself = errors.New("cannot be moved onto itself")
|
||||||
)
|
)
|
||||||
|
|
||||||
// bufferInfo tracks a protected buffer and the number of bytes used in it
|
|
||||||
type bufferInfo struct {
|
|
||||||
buffer *memguard.LockedBuffer
|
|
||||||
used int
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseVaultSecretRef parses a "vault:secret" or just "secret" reference
|
// ParseVaultSecretRef parses a "vault:secret" or just "secret" reference
|
||||||
// Returns (vaultName, secretName, isQualified)
|
// Returns (vaultName, secretName, isQualified)
|
||||||
// If no vault is specified, returns empty vaultName and isQualified=false
|
// If no vault is specified, returns empty vaultName and isQualified=false
|
||||||
@@ -270,88 +273,100 @@ The source secret is deleted after successful copy.`,
|
|||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
// updateBufferSize updates the buffer size based on usage pattern
|
// checkLockedMemoryLimit returns an error naming the locked-memory limit
|
||||||
func updateBufferSize(currentSize int, sameSize *int) int {
|
// (`ulimit -l`) when a value of size bytes does not fit in it with
|
||||||
const (
|
// lockedMemoryReservePages. memguard, which holds secret values in locked
|
||||||
doubleAfterBuffers = 2
|
// memory, crashes the process when it cannot lock more, so this check comes
|
||||||
growthFactor = 2
|
// before a buffer for the value is allocated.
|
||||||
)
|
func checkLockedMemoryLimit(size int) error {
|
||||||
|
var limit unix.Rlimit
|
||||||
|
|
||||||
*sameSize++
|
err := unix.Getrlimit(unix.RLIMIT_MEMLOCK, &limit)
|
||||||
if *sameSize >= doubleAfterBuffers {
|
if err != nil {
|
||||||
*sameSize = 0
|
return fmt.Errorf("failed to read the locked-memory limit: %w", err)
|
||||||
|
|
||||||
return currentSize * growthFactor
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return currentSize
|
//nolint:gosec // G115: a size and a page count are never negative
|
||||||
}
|
needed := uint64(size + lockedMemoryReservePages*os.Getpagesize())
|
||||||
|
if needed > limit.Cur {
|
||||||
// destroyBuffers destroys every buffer in the list
|
return fmt.Errorf("%w of %d KiB (ulimit -l)",
|
||||||
func destroyBuffers(buffers []bufferInfo) {
|
errLockedMemoryLimit, limit.Cur/kibibyte)
|
||||||
for _, b := range buffers {
|
|
||||||
b.buffer.Destroy()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// readSecretFromReader reads all data from reader into protected buffers,
|
// readSecretFromReader reads all of reader into a new locked buffer, which
|
||||||
// enforcing the maximum secret size. On failure the accumulated buffers
|
// the caller must destroy, leaving out one trailing newline when trimNewline
|
||||||
// are destroyed; on success the caller must destroy them.
|
// is set. It reads a page at a time into a memguard.Stream, which keeps what
|
||||||
func readSecretFromReader(reader io.Reader) ([]bufferInfo, int, error) {
|
// it is given encrypted, so that the value is in locked memory only once, in
|
||||||
var buffers []bufferInfo
|
// the buffer returned, and both size checks come before that buffer is
|
||||||
|
// allocated. It takes the value back out with Stream.Next, not Stream.Read:
|
||||||
|
// Read puts back the part of a piece that does not fit, and memguard hangs
|
||||||
|
// when it runs out of locked memory doing that.
|
||||||
|
func readSecretFromReader(
|
||||||
|
reader io.Reader, trimNewline bool,
|
||||||
|
) (*memguard.LockedBuffer, error) {
|
||||||
|
stream := memguard.NewStream()
|
||||||
|
|
||||||
totalSize := 0
|
chunk := memguard.NewBuffer(os.Getpagesize())
|
||||||
currentBufferSize := initialBufferSize
|
defer chunk.Destroy()
|
||||||
sameSize := 0
|
|
||||||
|
size := 0
|
||||||
|
endsWithNewline := false
|
||||||
|
|
||||||
for {
|
for {
|
||||||
// Create a new buffer
|
n, err := io.ReadFull(reader, chunk.Bytes())
|
||||||
buffer := memguard.NewBuffer(currentBufferSize)
|
if n > 0 {
|
||||||
n, err := io.ReadFull(reader, buffer.Bytes())
|
size += n
|
||||||
|
if size > maxSecretSize {
|
||||||
if n == 0 {
|
return nil, errSecretTooLarge
|
||||||
// No data read, destroy the unused buffer
|
|
||||||
buffer.Destroy()
|
|
||||||
} else {
|
|
||||||
buffers = append(buffers, bufferInfo{buffer: buffer, used: n})
|
|
||||||
totalSize += n
|
|
||||||
|
|
||||||
if totalSize > maxSecretSize {
|
|
||||||
destroyBuffers(buffers)
|
|
||||||
|
|
||||||
return nil, 0, errSecretTooLarge
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we filled the buffer, consider growing for next iteration
|
endsWithNewline = chunk.Bytes()[n-1] == '\n'
|
||||||
if n == currentBufferSize {
|
|
||||||
currentBufferSize = updateBufferSize(currentBufferSize, &sameSize)
|
// Write encrypts the bytes and wipes them from chunk.
|
||||||
}
|
_, _ = stream.Write(chunk.Bytes()[:n])
|
||||||
}
|
}
|
||||||
|
|
||||||
if err == io.EOF || errors.Is(err, io.ErrUnexpectedEOF) {
|
if errors.Is(err, io.EOF) || errors.Is(err, io.ErrUnexpectedEOF) {
|
||||||
break
|
break
|
||||||
} else if err != nil {
|
}
|
||||||
destroyBuffers(buffers)
|
|
||||||
|
|
||||||
return nil, 0, err
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return buffers, totalSize, nil
|
// Freed before the value's buffer is allocated, so that the two are
|
||||||
}
|
// never locked at once.
|
||||||
|
chunk.Destroy()
|
||||||
|
|
||||||
// combineBuffers copies the used portions of buffers into a single
|
if trimNewline && endsWithNewline {
|
||||||
// protected buffer of totalSize bytes
|
size--
|
||||||
func combineBuffers(buffers []bufferInfo, totalSize int) *memguard.LockedBuffer {
|
|
||||||
valueBuffer := memguard.NewBuffer(totalSize)
|
|
||||||
|
|
||||||
offset := 0
|
|
||||||
for _, b := range buffers {
|
|
||||||
copy(valueBuffer.Bytes()[offset:], b.buffer.Bytes()[:b.used])
|
|
||||||
offset += b.used
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return valueBuffer
|
err := checkLockedMemoryLimit(size)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
value := memguard.NewBuffer(size)
|
||||||
|
|
||||||
|
// copy stops at the value's size, so a trimmed newline is not copied.
|
||||||
|
for offset := 0; offset < size; {
|
||||||
|
decrypted, err := stream.Next()
|
||||||
|
if err != nil {
|
||||||
|
value.Destroy()
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("failed to decrypt the value read: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
offset += copy(value.Bytes()[offset:], decrypted.Bytes())
|
||||||
|
decrypted.Destroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
return value, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddSecret adds a secret to the current vault
|
// AddSecret adds a secret to the current vault
|
||||||
@@ -370,35 +385,21 @@ func (cli *Instance) AddSecret(secretName string, force bool) error {
|
|||||||
|
|
||||||
secret.Debug("Got current vault", "vault_name", vlt.GetName())
|
secret.Debug("Got current vault", "vault_name", vlt.GetName())
|
||||||
|
|
||||||
// Read secret value directly into protected buffers
|
// Read the secret value, less a trailing newline, into locked memory
|
||||||
secret.Debug("Reading secret value from stdin into protected buffers")
|
secret.Debug("Reading secret value from stdin into a protected buffer")
|
||||||
|
|
||||||
buffers, totalSize, err := readSecretFromReader(cli.cmd.InOrStdin())
|
valueBuffer, err := readSecretFromReader(cli.cmd.InOrStdin(), true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, errSecretTooLarge) {
|
if errors.Is(err, errSecretTooLarge) || errors.Is(err, errLockedMemoryLimit) {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return fmt.Errorf("failed to read secret value: %w", err)
|
return fmt.Errorf("failed to read secret value: %w", err)
|
||||||
}
|
}
|
||||||
defer destroyBuffers(buffers)
|
|
||||||
|
|
||||||
// Check for trailing newline in the last buffer
|
|
||||||
if len(buffers) > 0 && totalSize > 0 {
|
|
||||||
lastBuffer := &buffers[len(buffers)-1]
|
|
||||||
if lastBuffer.buffer.Bytes()[lastBuffer.used-1] == '\n' {
|
|
||||||
lastBuffer.used--
|
|
||||||
totalSize--
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
secret.Debug("Read secret value from stdin",
|
|
||||||
"value_length", totalSize, "buffers", len(buffers))
|
|
||||||
|
|
||||||
// Combine all buffers into a single protected buffer
|
|
||||||
valueBuffer := combineBuffers(buffers, totalSize)
|
|
||||||
defer valueBuffer.Destroy()
|
defer valueBuffer.Destroy()
|
||||||
|
|
||||||
|
secret.Debug("Read secret value from stdin", "value_length", valueBuffer.Size())
|
||||||
|
|
||||||
// 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.
|
||||||
@@ -653,7 +654,7 @@ func (cli *Instance) ImportSecret(
|
|||||||
|
|
||||||
vlt.Mnemonic, vlt.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
vlt.Mnemonic, vlt.UnlockPassphrase = cli.Mnemonic, cli.UnlockPassphrase
|
||||||
|
|
||||||
// Read secret value from the source file into protected buffers
|
// Read secret value from the source file into a protected buffer
|
||||||
file, err := cli.fs.Open(sourceFile)
|
file, err := cli.fs.Open(sourceFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to open file %s: %w", sourceFile, err)
|
return fmt.Errorf("failed to open file %s: %w", sourceFile, err)
|
||||||
@@ -665,14 +666,10 @@ func (cli *Instance) ImportSecret(
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
buffers, totalSize, err := readSecretFromReader(file)
|
valueBuffer, err := readSecretFromReader(file, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to read secret from file %s: %w", sourceFile, err)
|
return fmt.Errorf("failed to read secret from file %s: %w", sourceFile, err)
|
||||||
}
|
}
|
||||||
defer destroyBuffers(buffers)
|
|
||||||
|
|
||||||
// Combine all buffers into a single protected buffer
|
|
||||||
valueBuffer := combineBuffers(buffers, totalSize)
|
|
||||||
defer valueBuffer.Destroy()
|
defer valueBuffer.Destroy()
|
||||||
|
|
||||||
// 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
|
||||||
|
|||||||
@@ -3,17 +3,23 @@ package cli
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"context"
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
"sneak.berlin/go/secret/internal/vault"
|
"sneak.berlin/go/secret/internal/vault"
|
||||||
"sneak.berlin/go/secret/pkg/agehd"
|
"sneak.berlin/go/secret/pkg/agehd"
|
||||||
)
|
)
|
||||||
@@ -315,6 +321,77 @@ func TestAddSecretStreamingBehavior(t *testing.T) {
|
|||||||
"Retrieved secret should match original")
|
"Retrieved secret should match original")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestSecretsAtLockedMemoryLimit runs the secret binary with the
|
||||||
|
// locked-memory limit (ulimit -l) lowered. add must store the largest value
|
||||||
|
// that fits, which takes holding it in locked memory only once. add, import
|
||||||
|
// and generate secret must refuse a value one byte larger, and generate secret
|
||||||
|
// one over 100 MB, with exit status 1 and an error saying why, where memguard
|
||||||
|
// would crash the process with a panic.
|
||||||
|
func TestSecretsAtLockedMemoryLimit(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const (
|
||||||
|
limitKiB = 1024
|
||||||
|
commandWait = 10 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
fits := limitKiB*kibibyte - lockedMemoryReservePages*os.Getpagesize()
|
||||||
|
limitError := fmt.Sprintf("locked-memory limit of %d KiB", limitKiB)
|
||||||
|
|
||||||
|
stateDir := t.TempDir()
|
||||||
|
_, err := vault.CreateVault(afero.NewOsFs(), stateDir, "default",
|
||||||
|
testMnemonicBuffer(t), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
secretPath, err := filepath.Abs("../../secret")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
tooBigFile := filepath.Join(t.TempDir(), "too-big")
|
||||||
|
require.NoError(t, os.WriteFile(tooBigFile, make([]byte, fits+1), 0o600))
|
||||||
|
|
||||||
|
run := func(stdin []byte, args ...string) (string, error) {
|
||||||
|
ctx, cancel := context.WithTimeout(t.Context(), commandWait)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
// The shell lowers the limit for itself and the binary only.
|
||||||
|
script := fmt.Sprintf(`ulimit -l %d && exec "$0" "$@"`, limitKiB)
|
||||||
|
|
||||||
|
//nolint:gosec // G204: runs the freshly built secret binary
|
||||||
|
cmd := exec.CommandContext(ctx, "sh",
|
||||||
|
append([]string{"-c", script, secretPath}, args...)...)
|
||||||
|
cmd.Env = []string{
|
||||||
|
secret.EnvStateDir + "=" + stateDir,
|
||||||
|
secret.EnvMnemonic + "=" + testMnemonic,
|
||||||
|
}
|
||||||
|
cmd.Stdin = bytes.NewReader(stdin)
|
||||||
|
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
|
||||||
|
return string(output), err
|
||||||
|
}
|
||||||
|
|
||||||
|
output, err := run(make([]byte, fits), "add", "fits")
|
||||||
|
require.NoError(t, err, "the largest value that fits: %s", output)
|
||||||
|
|
||||||
|
refused := func(wantError string, stdin []byte, args ...string) {
|
||||||
|
output, err := run(stdin, args...)
|
||||||
|
|
||||||
|
var exitErr *exec.ExitError
|
||||||
|
|
||||||
|
require.ErrorAs(t, err, &exitErr, "%v: %s", args, output)
|
||||||
|
assert.Equal(t, 1, exitErr.ExitCode(), "%v: %s", args, output)
|
||||||
|
assert.Contains(t, output, wantError, args)
|
||||||
|
assert.NotContains(t, output, "panic", args)
|
||||||
|
}
|
||||||
|
|
||||||
|
refused(limitError, make([]byte, fits+1), "add", "too-big")
|
||||||
|
refused(limitError, nil, "import", "too-big", "--source", tooBigFile)
|
||||||
|
refused(limitError, nil, "generate", "secret", "too-big",
|
||||||
|
"--length", strconv.Itoa(fits+1))
|
||||||
|
refused(errSecretTooLarge.Error(), nil, "generate", "secret", "too-big",
|
||||||
|
"--length", strconv.Itoa(maxSecretSize+1))
|
||||||
|
}
|
||||||
|
|
||||||
// slowReader simulates a reader that returns data in small chunks
|
// slowReader simulates a reader that returns data in small chunks
|
||||||
type slowReader struct {
|
type slowReader struct {
|
||||||
data []byte
|
data []byte
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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)
|
||||||
|
|||||||
Reference in new issue
Block a user