Files
keyfunc/internal/cli/ssh/to.go
T
clawbot 40e9beea8c
check / check (push) Successful in 5s
Clean up the agent socket and working files when a signal ends the tool (closes #17)
`cli.Main` ran the command tree on a background context, so SIGINT, SIGTERM or SIGHUP killed the process before deferred cleanup ran: `ssh to` left its agent socket and directory behind, and `ssh install` left a copy of the host's `authorized_keys` in its working directory. `Main` now runs the tree on a `signal.NotifyContext` for those signals; the cancelled context ends the child `ssh` or `sftp` and the cleanup runs. `ssh to` stops its child with SIGTERM, not a kill, so `ssh` restores the terminal. Exit status after a signal is 1 unless `ssh` reported its own.

The test re-runs the test binary as the tool, waits for the agent socket, sends each signal and checks the directory is gone.

Disclosure: the repeated `"uptime"` test literal became a `remoteCommand` constant because `goconst` required it.

Model: opus-4-8 (implementation, review); fable-5-1 (merge message)
2026-09-21 16:58:24 +02:00

105 lines
2.6 KiB
Go

package ssh
import (
"context"
"errors"
"fmt"
"os"
"os/exec"
"slices"
"syscall"
"github.com/spf13/cobra"
)
// StatusError says the tool should end with the status ssh ended with.
// Only "ssh to" gives one back; every other error ends the tool with
// status 1.
type StatusError struct {
Status int
}
// Error says which status ssh ended with.
func (e StatusError) Error() string {
return fmt.Sprintf("ssh exited with status %d", e.Status)
}
// to returns the command that runs ssh with the derived key held by an
// agent of the tool's own.
func to() *cobra.Command {
cmd := &cobra.Command{
Use: "to <host> [ssh arguments...]",
Short: "run ssh with the derived key served from its own agent",
Long: "Serves the derived key from an SSH agent that runs " +
"inside the tool and points the system ssh at it. The host " +
"and everything after it are given to ssh unchanged, the " +
"tool ends with the status ssh ended with, and the key is " +
"never written to disk.",
Args: cobra.MinimumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
key, comment, err := derived(cmd)
if err != nil {
return err
}
served, err := key.Serve(cmd.Context(), comment)
if err != nil {
return err
}
defer served.Stop()
argv := slices.Concat([]string{
"-o", "IdentityAgent=" + served.Socket(),
}, args)
return connect(cmd.Context(), argv)
},
}
// Everything from the host onwards belongs to ssh, so flag
// reading stops at the first argument that is not a flag.
cmd.Flags().SetInterspersed(false)
addComment(cmd)
return cmd
}
// connect runs ssh on the terminal the tool was given and turns the
// status it ended with into the status the tool ends with.
func connect(ctx context.Context, argv []string) error {
//nolint:gosec // the arguments are the user's own, meant for ssh
command := exec.CommandContext(ctx, "ssh", argv...)
command.Env = childEnv()
command.Stdin = os.Stdin
command.Stdout = os.Stdout
command.Stderr = os.Stderr
// A cancelled context means a signal ended the tool. Send ssh a
// SIGTERM rather than the default kill, so it puts the terminal
// back the way it found it before it goes.
command.Cancel = func() error {
return command.Process.Signal(syscall.SIGTERM)
}
err := command.Run()
if err == nil {
return nil
}
var ended *exec.ExitError
if errors.As(err, &ended) {
status := ended.ExitCode()
if status < 0 {
// A signal ended ssh, and a signal has no status of its
// own to pass on.
status = 1
}
return StatusError{Status: status}
}
return fmt.Errorf("running ssh: %w", err)
}