1 Commits
Author SHA1 Message Date
sneak dc3a0150f3 Read --index and --words as decimal numbers (closes #75)
check / check (push) Successful in 3m14s
Both flags were uint32 flags, which the flag library reads with Go's
base-0 rules, so `-n 010` derived key 8 and `0x10` or `1_0` were
accepted. They are now string flags read by options.Decimal, which
takes decimal digits only: a leading zero stays decimal, and a base
prefix, an underscore or a sign is refused with an error naming the
flag, before the mnemonic is looked for. --help shows both as a
number, and the README says the index is a decimal number.

Model: opus-5-5
2026-10-12 23:10:13 +00:00
15 changed files with 115 additions and 306 deletions
+7 -17
View File
@@ -124,15 +124,9 @@ refused with a message saying so. Keys are derived from the mnemonic's words
joined by single spaces, whatever whitespace is around or between them, so one joined by single spaces, whatever whitespace is around or between them, so one
word per line, tabs or extra spaces give the same keys. word per line, tabs or extra spaces give the same keys.
The key index, `--words`, the `--to` recipients and the file `age encrypt` or
`age decrypt` is given to read are checked before the mnemonic is looked for, so
a run refused for one of them never prompts for the mnemonic or runs the
mnemonic command.
`KEYFUNC_MNEMONIC` and `KEYFUNC_MNEMONIC_COMMAND` are removed from the `KEYFUNC_MNEMONIC` and `KEYFUNC_MNEMONIC_COMMAND` are removed from the
environment before the mnemonic command, the system `ssh` (`keyfunc ssh to`) and environment before the system `ssh` (`keyfunc ssh to`) and `sftp`
`sftp` (`keyfunc ssh install`) are started, so the mnemonic is never handed on (`keyfunc ssh install`) are started, so the mnemonic is never handed on to them.
to them.
Every command takes `--index` / `-n` and `--mnemonic-command`, and has `--help`. Every command takes `--index` / `-n` and `--mnemonic-command`, and has `--help`.
`keyfunc --version` prints the version. `make build` stamps it; a binary `keyfunc --version` prints the version. `make build` stamps it; a binary
@@ -225,15 +219,11 @@ first, or pass `-o StrictHostKeyChecking=accept-new` after `--`.
Derives the key, serves it from an SSH agent that runs inside the tool on a unix Derives the key, serves it from an SSH agent that runs inside the tool on a unix
socket in a new private `0700` temporary directory, then runs the system `ssh` socket in a new private `0700` temporary directory, then runs the system `ssh`
with `-o IdentityAgent=<that socket> -o IdentitiesOnly=no` followed by the host with `-o IdentityAgent=<that socket>` followed by the host and all remaining
and all remaining arguments unchanged. Without `IdentitiesOnly=no`, an arguments unchanged. The tool exits with `ssh`'s exit status and removes the
`IdentitiesOnly yes` in the user's `ssh` configuration keeps the derived key socket and directory on the way out. The private key is never written to disk. A
from being offered. The agent holds no other key, so turning it off adds nothing SIGINT, SIGTERM or SIGHUP ends `ssh` and still removes the socket and directory,
else to what `ssh` offers. The tool exits with `ssh`'s exit status and removes and the tool then exits with status 1 unless `ssh` reported one of its own.
the socket and directory on the way out. The private key is never written to
disk. A SIGINT, SIGTERM or SIGHUP ends `ssh` and still removes the socket and
directory, and the tool then exits with status 1 unless `ssh` reported one of
its own.
## age identities: `keyfunc age` ## age identities: `keyfunc age`
+12 -9
View File
@@ -94,12 +94,15 @@ func (k *Key) Identity() string {
} }
// Encrypt copies src to dst, encrypted to this key and to every extra // Encrypt copies src to dst, encrypted to this key and to every extra
// recipient given, so the same mnemonic can always read it back again. // recipient named, so the same mnemonic can always read it back again.
// Armored output is the text form age also reads. // Armored output is the text form age also reads.
func (k *Key) Encrypt( func (k *Key) Encrypt(
dst io.Writer, src io.Reader, to []age.Recipient, armored bool, dst io.Writer, src io.Reader, to []string, armored bool,
) error { ) error {
all := append([]age.Recipient{k.identity.Recipient()}, to...) all, err := recipients(k.identity.Recipient(), to)
if err != nil {
return err
}
out := dst out := dst
@@ -110,7 +113,7 @@ func (k *Key) Encrypt(
out = text out = text
} }
err := encrypt(out, src, all) err = encrypt(out, src, all)
if err != nil { if err != nil {
return err return err
} }
@@ -127,12 +130,12 @@ func (k *Key) Encrypt(
return nil return nil
} }
// Recipients reads the recipients named on the command line, for // recipients returns the key's own recipient followed by the ones
// Encrypt to add to the key's own. // named on the command line, so what the key encrypts it can read.
func Recipients(names []string) ([]age.Recipient, error) { func recipients(mine age.Recipient, to []string) ([]age.Recipient, error) {
list := make([]age.Recipient, 0, len(names)) list := []age.Recipient{mine}
for _, name := range names { for _, name := range to {
parsed, err := age.ParseX25519Recipient(name) parsed, err := age.ParseX25519Recipient(name)
if err != nil { if err != nil {
return nil, fmt.Errorf("reading recipient %q: %w", name, err) return nil, fmt.Errorf("reading recipient %q: %w", name, err)
+8 -5
View File
@@ -119,12 +119,12 @@ func TestAnExtraRecipientCanReadItTooAndSoCanTheDerivedOne(t *testing.T) {
mine, theirs := forIndex(t, 0), forIndex(t, 1) mine, theirs := forIndex(t, 0), forIndex(t, 1)
to, err := agekey.Recipients([]string{theirs.Recipient()})
require.NoError(t, err)
var sealed bytes.Buffer var sealed bytes.Buffer
err = mine.Encrypt(&sealed, strings.NewReader("hello"), to, false) err := mine.Encrypt(
&sealed, strings.NewReader("hello"),
[]string{theirs.Recipient()}, false,
)
require.NoError(t, err) require.NoError(t, err)
for _, key := range []*agekey.Key{mine, theirs} { for _, key := range []*agekey.Key{mine, theirs} {
@@ -138,7 +138,10 @@ func TestAnExtraRecipientCanReadItTooAndSoCanTheDerivedOne(t *testing.T) {
func TestARecipientThatIsNotOneIsRefused(t *testing.T) { func TestARecipientThatIsNotOneIsRefused(t *testing.T) {
t.Parallel() t.Parallel()
_, err := agekey.Recipients([]string{"not a recipient"}) err := forIndex(t, 0).Encrypt(
&bytes.Buffer{}, strings.NewReader("hello"),
[]string{"not a recipient"}, false,
)
require.Error(t, err) require.Error(t, err)
} }
+5 -15
View File
@@ -29,17 +29,6 @@ const DefaultWords = twelve
// ErrWordCount is returned for a length this tool does not offer. // ErrWordCount is returned for a length this tool does not offer.
var ErrWordCount = errors.New("a child mnemonic has 12, 18 or 24 words") var ErrWordCount = errors.New("a child mnemonic has 12, 18 or 24 words")
// CheckWords refuses a length this tool does not offer, so that the
// command can turn it down before it looks for the mnemonic.
func CheckWords(words uint32) error {
switch words {
case twelve, eighteen, twentyFour:
return nil
default:
return fmt.Errorf("%w, not %d", ErrWordCount, words)
}
}
// Derive returns the English child mnemonic of that many words at that // Derive returns the English child mnemonic of that many words at that
// key index, taken from the master key with BIP-85's own mnemonic // key index, taken from the master key with BIP-85's own mnemonic
// application, number 39. The words come straight from the BIP-85 // application, number 39. The words come straight from the BIP-85
@@ -49,12 +38,13 @@ func Derive(
master *hdkeychain.ExtendedKey, master *hdkeychain.ExtendedKey,
words, index uint32, words, index uint32,
) (string, error) { ) (string, error) {
err := CheckWords(words) switch words {
if err != nil { case twelve, eighteen, twentyFour:
return "", err default:
return "", fmt.Errorf("%w, not %d", ErrWordCount, words)
} }
err = derive.CheckIndex(index) err := derive.CheckIndex(index)
if err != nil { if err != nil {
return "", err return "", err
} }
+27 -43
View File
@@ -108,45 +108,47 @@ func decrypt() *cobra.Command {
} }
// runEncrypt encrypts to the derived recipient and any others given. // runEncrypt encrypts to the derived recipient and any others given.
// The recipients are read and the input opened before the key is
// derived, so that a run refused for either never asks for the
// mnemonic.
func runEncrypt(cmd *cobra.Command, args []string) error { func runEncrypt(cmd *cobra.Command, args []string) error {
names, err := cmd.Flags().GetStringArray("to") key, err := derived(cmd)
if err != nil {
return fmt.Errorf("reading the recipients: %w", err)
}
to, err := agekey.Recipients(names)
if err != nil { if err != nil {
return err return err
} }
to, err := cmd.Flags().GetStringArray("to")
if err != nil {
return fmt.Errorf("reading the recipients: %w", err)
}
armored, err := cmd.Flags().GetBool("armor") armored, err := cmd.Flags().GetBool("armor")
if err != nil { if err != nil {
return fmt.Errorf("reading the armor flag: %w", err) return fmt.Errorf("reading the armor flag: %w", err)
} }
src, closeSrc, err := input(cmd, args) return through(cmd, args, func(dst io.Writer, src io.Reader) error {
if err != nil { return key.Encrypt(dst, src, to, armored)
return err
}
defer closeSrc()
key, err := derived(cmd)
if err != nil {
return err
}
return through(cmd, src, func(dst io.Writer, plain io.Reader) error {
return key.Encrypt(dst, plain, to, armored)
}) })
} }
// runDecrypt decrypts with the derived identity. The input is opened // runDecrypt decrypts with the derived identity.
// before the key is derived, as for runEncrypt.
func runDecrypt(cmd *cobra.Command, args []string) error { func runDecrypt(cmd *cobra.Command, args []string) error {
key, err := derived(cmd)
if err != nil {
return err
}
return through(cmd, args, key.Decrypt)
}
// through opens the input the arguments ask for and hands it to the
// work, with the file --output names to write to, or the command's own
// output when it names none or names the same file as that output, and
// the command's own error output when it names the same file as that.
// Those two are the streams the tool already has, so whatever they are
// redirected to is written as the redirect says, never replaced.
func through(
cmd *cobra.Command, args []string,
work func(io.Writer, io.Reader) error,
) error {
src, closeSrc, err := input(cmd, args) src, closeSrc, err := input(cmd, args)
if err != nil { if err != nil {
return err return err
@@ -154,24 +156,6 @@ func runDecrypt(cmd *cobra.Command, args []string) error {
defer closeSrc() defer closeSrc()
key, err := derived(cmd)
if err != nil {
return err
}
return through(cmd, src, key.Decrypt)
}
// through hands the input to the work, with the file --output names to
// write to, or the command's own output when it names none or names the
// same file as that output, and the command's own error output when it
// names the same file as that. Those two are the streams the tool
// already has, so whatever they are redirected to is written as the
// redirect says, never replaced.
func through(
cmd *cobra.Command, src io.Reader,
work func(io.Writer, io.Reader) error,
) error {
name, err := cmd.Flags().GetString("output") name, err := cmd.Flags().GetString("output")
if err != nil { if err != nil {
return fmt.Errorf("reading the output file: %w", err) return fmt.Errorf("reading the output file: %w", err)
-39
View File
@@ -17,7 +17,6 @@ import (
"sneak.berlin/go/keyfunc/internal/agekey" "sneak.berlin/go/keyfunc/internal/agekey"
"sneak.berlin/go/keyfunc/internal/cli" "sneak.berlin/go/keyfunc/internal/cli"
"sneak.berlin/go/keyfunc/internal/cli/age" "sneak.berlin/go/keyfunc/internal/cli/age"
"sneak.berlin/go/keyfunc/internal/derive"
"sneak.berlin/go/keyfunc/internal/mnemonic" "sneak.berlin/go/keyfunc/internal/mnemonic"
) )
@@ -70,44 +69,6 @@ func TestAnotherRecipientIsAddedAndTheDerivedOneStays(t *testing.T) {
) )
} }
// The mnemonic command fails in these runs, so the refusal of the index
// shows that it was checked before the mnemonic was looked for.
func TestAnAgeIndexWithNoHardenedChildIsRefused(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, failingMnemonicCommand)
for _, command := range []string{"pub", "priv", "encrypt", "decrypt"} {
out, err := execute(t, "age", command, "-n", tooLarge)
require.ErrorIs(t, err, derive.ErrIndexTooLarge, command)
require.Empty(t, out, command)
}
}
// The mnemonic command fails in this run, so the refusal of the
// recipient shows that it was read before the mnemonic was looked for.
func TestAnEncryptionToARecipientThatIsNotOneIsRefused(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, failingMnemonicCommand)
plain := written(t, "notes.txt", "the secret\n")
out, err := execute(t, "age", "encrypt", "--to", "bogus", plain)
require.ErrorContains(t, err, `reading recipient "bogus"`)
require.Empty(t, out)
}
// The mnemonic command fails in these runs, so the refusal of the input
// file shows that it was opened before the mnemonic was looked for.
func TestAnInputFileThatCannotBeOpenedIsRefused(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, failingMnemonicCommand)
missing := filepath.Join(t.TempDir(), "missing")
for _, operation := range []string{"encrypt", "decrypt"} {
out, err := execute(t, "age", operation, missing)
require.ErrorIs(t, err, fs.ErrNotExist, operation)
require.Empty(t, out, operation)
}
}
func TestAFileForAnotherKeyIsRefused(t *testing.T) { func TestAFileForAnotherKeyIsRefused(t *testing.T) {
t.Setenv(mnemonic.Variable, example()) t.Setenv(mnemonic.Variable, example())
+6 -49
View File
@@ -34,14 +34,6 @@ const (
twentyFour = 24 twentyFour = 24
) )
// tooLarge is the smallest key index with no hardened child.
const tooLarge = "2147483648"
// failingMnemonicCommand fails loudly, so a run that looks for the
// mnemonic ends with that failure. A run that ends with the refusal of
// an argument instead shows that the argument was checked first.
const failingMnemonicCommand = "echo the mnemonic was looked for >&2; exit 1"
// example returns the mnemonic the README gives its test vectors for: // example returns the mnemonic the README gives its test vectors for:
// eleven abandons and about. // eleven abandons and about.
func example() string { func example() string {
@@ -107,25 +99,12 @@ func TestThePrivateKeyMatchesThePublicOne(t *testing.T) {
require.Equal(t, vectorOne, back) require.Equal(t, vectorOne, back)
} }
// The mnemonic command fails in these runs, so the refusal of the index
// shows that it was checked before the mnemonic was looked for. The age
// commands have a test of their own.
func TestAnIndexWithNoHardenedChildIsRefused(t *testing.T) { func TestAnIndexWithNoHardenedChildIsRefused(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, failingMnemonicCommand) t.Setenv(mnemonic.Variable, example())
for _, args := range [][]string{ out, err := execute(t, "ssh", "pub", "-n", "2147483648")
{subcommand, "pub", "-n", tooLarge}, require.ErrorIs(t, err, derive.ErrIndexTooLarge)
{subcommand, "priv", "-n", tooLarge}, require.Empty(t, out)
{subcommand, installing, "-n", tooLarge, host},
{subcommand, "to", "-n", tooLarge, host},
{"mnemonic", "-n", tooLarge},
} {
name := strings.Join(args, " ")
out, err := execute(t, args...)
require.ErrorIs(t, err, derive.ErrIndexTooLarge, name)
require.Empty(t, out, name)
}
} }
func TestAnIndexWithALeadingZeroIsDecimal(t *testing.T) { func TestAnIndexWithALeadingZeroIsDecimal(t *testing.T) {
@@ -144,7 +123,7 @@ func TestAnIndexWithALeadingZeroIsDecimal(t *testing.T) {
func TestAnIndexThatIsNotDecimalDigitsIsRefused(t *testing.T) { func TestAnIndexThatIsNotDecimalDigitsIsRefused(t *testing.T) {
t.Parallel() t.Parallel()
for _, index := range []string{"0x10", "1_0", "+1", "-1", ""} { for _, index := range []string{"0x10", "1_0", "+1", "-1"} {
t.Run(index, func(t *testing.T) { t.Run(index, func(t *testing.T) {
t.Parallel() t.Parallel()
@@ -158,26 +137,6 @@ func TestAnIndexThatIsNotDecimalDigitsIsRefused(t *testing.T) {
} }
} }
// Neither a command group nor --version reads the index, so these
// show that it is refused while the flags are parsed.
func TestAnIndexNotInDecimalIsRefusedBeforeAnyCommandRuns(t *testing.T) {
t.Parallel()
for _, args := range [][]string{
{"ssh", "-n", "0x10"},
{"-n", "0x10", "--version"},
} {
t.Run(strings.Join(args, " "), func(t *testing.T) {
t.Parallel()
out, err := execute(t, args...)
require.ErrorIs(t, err, strconv.ErrSyntax)
require.ErrorContains(t, err, "--index")
require.Empty(t, out)
})
}
}
func TestTheMnemonicCommandIsUsed(t *testing.T) { func TestTheMnemonicCommandIsUsed(t *testing.T) {
t.Setenv(mnemonic.Variable, "") t.Setenv(mnemonic.Variable, "")
@@ -202,10 +161,8 @@ func TestAChildMnemonicIsPrinted(t *testing.T) {
require.NotEqual(t, short, next) require.NotEqual(t, short, next)
} }
// The mnemonic command fails in this run, so the refusal of the length
// shows that it was checked before the mnemonic was looked for.
func TestALengthTheToolDoesNotOfferIsRefused(t *testing.T) { func TestALengthTheToolDoesNotOfferIsRefused(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, failingMnemonicCommand) t.Setenv(mnemonic.Variable, example())
out, err := execute(t, "mnemonic", "--words", "15") out, err := execute(t, "mnemonic", "--words", "15")
require.ErrorIs(t, err, childmnemonic.ErrWordCount) require.ErrorIs(t, err, childmnemonic.ErrWordCount)
+5 -10
View File
@@ -3,6 +3,7 @@ package mnemonic
import ( import (
"fmt" "fmt"
"strconv"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"sneak.berlin/go/keyfunc/internal/childmnemonic" "sneak.berlin/go/keyfunc/internal/childmnemonic"
@@ -31,10 +32,9 @@ func Command() *cobra.Command {
}, },
} }
words := options.Decimal(childmnemonic.DefaultWords) cmd.Flags().String(
cmd.Flags().Var( "words", strconv.Itoa(childmnemonic.DefaultWords),
&words, "words", "the `number` of words in the child mnemonic: 12, 18 or 24",
"how long the child mnemonic is: 12, 18 or 24 words",
) )
return cmd return cmd
@@ -47,12 +47,7 @@ func derived(cmd *cobra.Command) (string, error) {
return "", err return "", err
} }
words, err := cmd.Flags().GetUint32("words") words, err := options.Decimal(cmd, "words")
if err != nil {
return "", fmt.Errorf("reading the word count: %w", err)
}
err = childmnemonic.CheckWords(words)
if err != nil { if err != nil {
return "", err return "", err
} }
+20 -43
View File
@@ -7,7 +7,6 @@ import (
"strconv" "strconv"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"sneak.berlin/go/keyfunc/internal/derive"
"sneak.berlin/go/keyfunc/internal/mnemonic" "sneak.berlin/go/keyfunc/internal/mnemonic"
) )
@@ -18,27 +17,35 @@ func Add(cmd *cobra.Command) {
"mnemonic-command", "", "mnemonic-command", "",
"shell command whose output is the mnemonic", "shell command whose output is the mnemonic",
) )
cmd.PersistentFlags().VarP( cmd.PersistentFlags().StringP(
new(Decimal), "index", "n", "index", "n", "0",
"which key to derive", "which key to derive, as a decimal `number`",
) )
} }
// Index returns the key index the user asked for, and refuses one above // Index returns the key index the user asked for.
// derive.MaxIndex. Every command calls it before it looks for the
// mnemonic.
func Index(cmd *cobra.Command) (uint32, error) { func Index(cmd *cobra.Command) (uint32, error) {
index, err := cmd.Flags().GetUint32("index") return Decimal(cmd, "index")
if err != nil {
return 0, fmt.Errorf("reading the index: %w", err)
} }
err = derive.CheckIndex(index) // Decimal reads the named string flag as a number written in decimal
// digits only: a leading zero is still decimal, and a base prefix, an
// underscore or a sign is refused. The back-quoted word in the usage
// of such a flag is what --help shows as its type.
func Decimal(cmd *cobra.Command, name string) (uint32, error) {
text, err := cmd.Flags().GetString(name)
if err != nil { if err != nil {
return 0, err return 0, fmt.Errorf("reading --%s: %w", name, err)
} }
return index, nil number, err := strconv.ParseUint(text, 10, 32)
if err != nil {
return 0, fmt.Errorf(
"reading --%s as a decimal number: %w", name, err,
)
}
return uint32(number), nil
} }
// Mnemonic returns the mnemonic, from the first source that has one. // Mnemonic returns the mnemonic, from the first source that has one.
@@ -50,33 +57,3 @@ func Mnemonic(cmd *cobra.Command) (string, error) {
return mnemonic.Read(cmd.Context(), command) return mnemonic.Read(cmd.Context(), command)
} }
// Decimal is a flag value for a number written in decimal digits only.
// The flag library's own uint32 flags read 010 as octal 8 and also
// take 0x10 or 1_0.
type Decimal uint32
// String returns the number in decimal digits.
func (d *Decimal) String() string {
return strconv.FormatUint(uint64(*d), 10)
}
// Set reads text as a decimal number that fits in 32 bits: a leading
// zero is still decimal, and a base prefix, an underscore or a sign is
// refused.
func (d *Decimal) Set(text string) error {
number, err := strconv.ParseUint(text, 10, 32)
if err != nil {
return err
}
*d = Decimal(number)
return nil
}
// Type is what --help shows as the flag's type, and what GetUint32
// checks before it reads the value back.
func (d *Decimal) Type() string {
return "uint32"
}
+1 -2
View File
@@ -16,7 +16,6 @@ import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
"sneak.berlin/go/keyfunc/internal/cli/signals" "sneak.berlin/go/keyfunc/internal/cli/signals"
"sneak.berlin/go/keyfunc/internal/mnemonic"
) )
// Where the key goes on the host and what the file it arrives in is // Where the key goes on the host and what the file it arrives in is
@@ -221,7 +220,7 @@ func session(
//nolint:gosec // the options are the user's own, meant for sftp //nolint:gosec // the options are the user's own, meant for sftp
command := exec.CommandContext(cmd.Context(), "sftp", argv...) command := exec.CommandContext(cmd.Context(), "sftp", argv...)
command.Env = mnemonic.ChildEnv() command.Env = childEnv()
command.Stdin = strings.NewReader(strings.Join(batch, "\n") + "\n") command.Stdin = strings.NewReader(strings.Join(batch, "\n") + "\n")
command.Stdout = &said command.Stdout = &said
command.Stderr = &said command.Stderr = &said
+23
View File
@@ -3,10 +3,13 @@ package ssh
import ( import (
"fmt" "fmt"
"os"
"strings"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"sneak.berlin/go/keyfunc/internal/cli/options" "sneak.berlin/go/keyfunc/internal/cli/options"
"sneak.berlin/go/keyfunc/internal/derive" "sneak.berlin/go/keyfunc/internal/derive"
"sneak.berlin/go/keyfunc/internal/mnemonic"
"sneak.berlin/go/keyfunc/internal/sshkey" "sneak.berlin/go/keyfunc/internal/sshkey"
) )
@@ -84,6 +87,26 @@ func write(cmd *cobra.Command, text string) error {
return nil return nil
} }
// childEnv is the tool's environment with the mnemonic variables taken
// out, for the ssh and sftp children it starts. "ssh to" exists so the
// private key never leaves the tool; the mnemonic, from either variable,
// must not leave it either.
func childEnv() []string {
environ := os.Environ()
kept := make([]string, 0, len(environ))
for _, entry := range environ {
name, _, _ := strings.Cut(entry, "=")
if name == mnemonic.Variable || name == mnemonic.CommandVariable {
continue
}
kept = append(kept, entry)
}
return kept
}
// addComment gives a command its comment flag. // addComment gives a command its comment flag.
func addComment(cmd *cobra.Command) { func addComment(cmd *cobra.Command) {
cmd.Flags().String( cmd.Flags().String(
+1 -7
View File
@@ -11,7 +11,6 @@ import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
"sneak.berlin/go/keyfunc/internal/cli/signals" "sneak.berlin/go/keyfunc/internal/cli/signals"
"sneak.berlin/go/keyfunc/internal/mnemonic"
) )
// StatusError says the tool should end with the status ssh ended with. // StatusError says the tool should end with the status ssh ended with.
@@ -58,13 +57,8 @@ func to() *cobra.Command {
defer served.Stop() defer served.Stop()
// IdentitiesOnly yes in the user's ssh configuration
// would keep the agent's key from being offered. The
// agent holds only the derived key, so turning it off
// adds no other key.
argv := slices.Concat([]string{ argv := slices.Concat([]string{
"-o", "IdentityAgent=" + served.Socket(), "-o", "IdentityAgent=" + served.Socket(),
"-o", "IdentitiesOnly=no",
}, args) }, args)
return connect(ctx, argv) return connect(ctx, argv)
@@ -85,7 +79,7 @@ func to() *cobra.Command {
func connect(ctx context.Context, argv []string) error { func connect(ctx context.Context, argv []string) error {
//nolint:gosec // the arguments are the user's own, meant for ssh //nolint:gosec // the arguments are the user's own, meant for ssh
command := exec.CommandContext(ctx, "ssh", argv...) command := exec.CommandContext(ctx, "ssh", argv...)
command.Env = mnemonic.ChildEnv() command.Env = childEnv()
command.Stdin = os.Stdin command.Stdin = os.Stdin
command.Stdout = os.Stdout command.Stdout = os.Stdout
command.Stderr = os.Stderr command.Stderr = os.Stderr
+1 -21
View File
@@ -587,7 +587,7 @@ func TestSSHIsPointedAtTheAgentAndItsStatusIsHandedOn(t *testing.T) {
given := recorded(t, arguments) given := recorded(t, arguments)
require.Equal(t, "-o", given[0]) require.Equal(t, "-o", given[0])
require.Equal(t, []string{host, remoteCommand}, given[4:]) require.Equal(t, []string{host, remoteCommand}, given[2:])
// The stand-in wrote the path down only because there really was // The stand-in wrote the path down only because there really was
// a socket there while it ran. // a socket there while it ran.
@@ -596,26 +596,6 @@ func TestSSHIsPointedAtTheAgentAndItsStatusIsHandedOn(t *testing.T) {
require.NoDirExists(t, filepath.Dir(socket)) require.NoDirExists(t, filepath.Dir(socket))
} }
func TestIdentitiesOnlyIsTurnedOffBeforeTheHost(t *testing.T) {
t.Setenv(mnemonic.Variable, example())
arguments, _ := pretendCall(t)
_, err := execute(t, subcommand, "to", host, remoteCommand)
var passed ssh.StatusError
require.ErrorAs(t, err, &passed)
// IdentitiesOnly yes in the user's ssh configuration keeps ssh
// from offering the agent's key. An option given before the host
// wins over the configuration.
given := recorded(t, arguments)
require.Equal(t,
[]string{"-o", "IdentitiesOnly=no", host, remoteCommand}, given[2:],
)
}
func TestTheToolEndsWithTheStatusSSHEndedWith(t *testing.T) { func TestTheToolEndsWithTheStatusSSHEndedWith(t *testing.T) {
t.Setenv(mnemonic.Variable, example()) t.Setenv(mnemonic.Variable, example())
-20
View File
@@ -63,7 +63,6 @@ func Read(ctx context.Context, command string) (string, error) {
func run(ctx context.Context, command string) (string, error) { func run(ctx context.Context, command string) (string, error) {
//nolint:gosec // running the user's own command is the point //nolint:gosec // running the user's own command is the point
shell := exec.CommandContext(ctx, "sh", "-c", command) shell := exec.CommandContext(ctx, "sh", "-c", command)
shell.Env = ChildEnv()
var complaint bytes.Buffer var complaint bytes.Buffer
@@ -84,25 +83,6 @@ func run(ctx context.Context, command string) (string, error) {
return string(out), nil return string(out), nil
} }
// ChildEnv is the tool's environment with the mnemonic variables taken
// out, for the programs the tool starts: the mnemonic command, ssh and
// sftp. The mnemonic, from either variable, never leaves the tool.
func ChildEnv() []string {
environ := os.Environ()
kept := make([]string, 0, len(environ))
for _, entry := range environ {
name, _, _ := strings.Cut(entry, "=")
if name == Variable || name == CommandVariable {
continue
}
kept = append(kept, entry)
}
return kept
}
// ask prompts on the terminal with echo turned off. // ask prompts on the terminal with echo turned off.
func ask() (string, error) { func ask() (string, error) {
fd := int(os.Stdin.Fd()) fd := int(os.Stdin.Fd())
-27
View File
@@ -1,8 +1,6 @@
package mnemonic_test package mnemonic_test
import ( import (
"os"
"path/filepath"
"strings" "strings"
"testing" "testing"
@@ -63,31 +61,6 @@ func TestTheMnemonicInTheEnvironmentComesLast(t *testing.T) {
require.Equal(t, fromVariable, words) require.Equal(t, fromVariable, words)
} }
func TestTheMnemonicIsNotHandedToTheCommand(t *testing.T) {
const marker = "KEYFUNC_TEST_MARKER"
t.Setenv(mnemonic.CommandVariable, prints(fromCommandVariable))
t.Setenv(mnemonic.Variable, fromVariable)
t.Setenv(marker, "reaches the command")
path := filepath.Join(t.TempDir(), "environment")
words, err := mnemonic.Read(
t.Context(), "env > '"+path+"'; "+prints(example()),
)
require.NoError(t, err)
require.Equal(t, example(), words)
//nolint:gosec // the path is a temporary file of the test's own
content, err := os.ReadFile(path)
require.NoError(t, err)
environment := string(content)
require.NotContains(t, environment, mnemonic.Variable+"=")
require.NotContains(t, environment, mnemonic.CommandVariable+"=")
require.Contains(t, environment, marker+"=")
}
func TestAFailingCommandSaysWhatWentWrong(t *testing.T) { func TestAFailingCommandSaysWhatWentWrong(t *testing.T) {
t.Setenv(mnemonic.CommandVariable, "") t.Setenv(mnemonic.CommandVariable, "")
t.Setenv(mnemonic.Variable, "") t.Setenv(mnemonic.Variable, "")