From 1c4ec39cd8d46a5016eb0029f81100502be67910 Mon Sep 17 00:00:00 2001 From: Sam Catlow Date: Tue, 27 Oct 2026 15:23:54 +1100 Subject: [PATCH] fix(bws): include the CLI's stderr in list failures --- secret-engines/bws/main.go | 28 +++++++++++++++++++++------- secret-engines/bws/main_test.go | 29 +++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 7 deletions(-) diff --git a/secret-engines/bws/main.go b/secret-engines/bws/main.go index f1ab1a4..bf323bd 100644 --- a/secret-engines/bws/main.go +++ b/secret-engines/bws/main.go @@ -4,11 +4,11 @@ package main import ( + "bytes" "context" "encoding/json" "errors" "fmt" - "io" "os" "os/exec" "path/filepath" @@ -69,18 +69,32 @@ func (e *engine) Resolve(ctx context.Context, r *secretenginev1.ResolveRequest) return &secretenginev1.ResolveResponse{Value: value}, nil } -func list(ctx context.Context) (map[string]string, error) { +// runner runs the bws CLI and returns its stdout and stderr. +type runner func(context.Context) (stdout, stderr []byte, err error) + +func list(ctx context.Context) (map[string]string, error) { return listWith(ctx, runBws) } + +func runBws(ctx context.Context) ([]byte, []byte, error) { command, err := find() if err != nil { - return nil, err + return nil, nil, err } - ctx, cancel := context.WithTimeout(ctx, listTimeout) - defer cancel() cmd := exec.CommandContext(ctx, command, "secret", "list", "--output", "json") cmd.Env = os.Environ() - cmd.Stderr = io.Discard - raw, err := cmd.Output() + var stdout, stderr bytes.Buffer + cmd.Stdout, cmd.Stderr = &stdout, &stderr + err = cmd.Run() + return stdout.Bytes(), stderr.Bytes(), err +} + +func listWith(ctx context.Context, run runner) (map[string]string, error) { + ctx, cancel := context.WithTimeout(ctx, listTimeout) + defer cancel() + raw, stderr, err := run(ctx) if err != nil { + if reason := bytes.TrimSpace(stderr); len(reason) > 0 { + return nil, fmt.Errorf("list bws secrets: %w: %.300s", err, reason) + } return nil, fmt.Errorf("list bws secrets: %w", err) } var records []struct{ Key, Value string } diff --git a/secret-engines/bws/main_test.go b/secret-engines/bws/main_test.go index 79edff1..3916235 100644 --- a/secret-engines/bws/main_test.go +++ b/secret-engines/bws/main_test.go @@ -3,6 +3,7 @@ package main import ( "context" "errors" + "strings" "testing" "time" @@ -41,3 +42,31 @@ func TestResolveRecovers(t *testing.T) { t.Fatalf("stale during outage: %q, %v; want v1, OK", v, code) } } + +func TestListWithFailure(t *testing.T) { + const secret = "s3cr3t-value" + tests := []struct { + name string + stdout string + stderr string + err error + want string + }{ + {"stderr reason", "", "Error: invalid access token\n", errors.New("exit status 1"), "invalid access token"}, + {"no stderr", "", "", errors.New("exit status 1"), "exit status 1"}, + {"stdout never leaks", secret, "Error: forbidden", errors.New("exit status 1"), "forbidden"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + _, err := listWith(t.Context(), func(context.Context) ([]byte, []byte, error) { + return []byte(tt.stdout), []byte(tt.stderr), tt.err + }) + if err == nil || !strings.Contains(err.Error(), tt.want) { + t.Fatalf("err = %v, want it to contain %q", err, tt.want) + } + if strings.Contains(err.Error(), secret) { + t.Fatalf("err leaks stdout: %v", err) + } + }) + } +}