Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions pkg/ssh/remote_command_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,48 @@ func TestInitQuotesRemotePaths(t *testing.T) {
}
}

func initWithMissingDocker(t *testing.T, sudoScript string) (stderr *bytes.Buffer, err error) {
t.Helper()
provider := fakeExternalSSH(t)
dir := t.TempDir()
probes := map[string]string{
"uname": "#!/bin/sh\nprintf 'Linux\\n'\n",
"id": "#!/bin/sh\nprintf '1000\\n'\n",
"sudo": sudoScript,
}
for name, contents := range probes {
// #nosec G306 -- Controlled platform probes must be executable.
requireNoError(t, os.WriteFile(filepath.Join(dir, name), []byte(contents), 0o700))
}
t.Setenv("PATH", dir+string(os.PathListSeparator)+os.Getenv("PATH"))
provider.Config.AgentPath = filepath.Join(dir, "agent-dir", "agent")
provider.Config.DockerPath = filepath.Join(dir, "missing-docker")
stderr = &bytes.Buffer{}
err = Init(context.Background(), provider, Streams{Stdout: io.Discard, Stderr: stderr})
return stderr, err
}

func TestInitMissingDockerWithSudoIsQuiet(t *testing.T) {
stderr, err := initWithMissingDocker(t, "#!/bin/sh\nexit 0\n")
requireNoError(t, err)
if stderr.Len() != 0 {
t.Fatalf("docker probe stderr leaked: %q", stderr.String())
}
}

func TestInitMissingDockerWithoutSudoReportsProbeStderr(t *testing.T) {
stderr, err := initWithMissingDocker(t, "#!/bin/sh\nexit 1\n")
if err == nil {
t.Fatal("accepted missing docker without sudo")
}
if !strings.Contains(err.Error(), "missing-docker") {
t.Fatalf("error lacks probe stderr: %v", err)
}
if strings.Contains(stderr.String(), "missing-docker") {
t.Fatalf("probe stderr also streamed: %q", stderr.String())
}
}

func TestInitRejectsNULPaths(t *testing.T) {
provider := &SSHProvider{
Config: &options.Options{AgentPath: "/tmp/agent\x00suffix", DockerPath: "docker"},
Expand Down
25 changes: 20 additions & 5 deletions pkg/ssh/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,21 @@ func Init(ctx context.Context, provider *SSHProvider, streams Streams) error {
strings.ContainsRune(provider.Config.DockerPath, 0) {
return fmt.Errorf("remote executable or agent path contains NUL")
}
run := func(script string, output io.Writer) error {
remote := func(script string, output, errOutput io.Writer) error {
return provider.execRemoteScript(
ctx,
script,
Streams{Stdout: output, Stderr: streams.Stderr},
Streams{Stdout: output, Stderr: errOutput},
)
}
run := func(script string, output io.Writer) error {
return remote(script, output, streams.Stderr)
}
// Probe stderr is held back: a failed probe is often expected, and the
// caller decides whether to report it.
probe := func(script string, errOutput io.Writer) error {
return remote(script, io.Discard, errOutput)
}
if err := checkRemotePlatform(run); err != nil {
return err
}
Expand All @@ -75,7 +83,7 @@ func Init(ctx context.Context, provider *SSHProvider, streams Streams) error {
if uid == 0 {
return nil
}
return provider.checkAccess(run)
return provider.checkAccess(run, probe)
}

func checkRemotePlatform(run func(string, io.Writer) error) error {
Expand Down Expand Up @@ -111,7 +119,10 @@ func remoteUID(run func(string, io.Writer) error) (uint64, error) {
return uid, nil
}

func (provider *SSHProvider) checkAccess(run func(string, io.Writer) error) error {
func (provider *SSHProvider) checkAccess(
run func(string, io.Writer) error,
probe func(string, io.Writer) error,
) error {
agentDir, err := quotePOSIXArgument(path.Dir(provider.Config.AgentPath))
if err != nil {
return fmt.Errorf("agent path: %w", err)
Expand All @@ -123,8 +134,12 @@ func (provider *SSHProvider) checkAccess(run func(string, io.Writer) error) erro
if err := checkAgentDirectory(run, agentDir); err != nil {
return err
}
if err := run(dockerPath+" ps", io.Discard); err != nil {
var dockerStderr bytes.Buffer
if err := probe(dockerPath+" ps", &dockerStderr); err != nil {
if sudoErr := run("sudo -nl", io.Discard); sudoErr != nil {
if detail := strings.TrimSpace(dockerStderr.String()); detail != "" {
err = fmt.Errorf("%w: %s", err, detail)
}
return fmt.Errorf(
"docker executable inaccessible; passwordless sudo or docker group required: %w",
err,
Expand Down
Loading