Documentation
¶
Overview ¶
Package runner executes the child process with secrets in its environment: exec, stream stdio, propagate exit code. Plaintext exists only in the child's env for its lifetime; Masker additionally scrubs the values from captured output.
Index ¶
Constants ¶
const MinMaskLen = 6
MinMaskLen is the shortest value the masker will rewrite. Below it, values are too likely to collide with ordinary output ("true", "8080") and would shred it; such secrets pass through unmasked by design.
Variables ¶
This section is empty.
Functions ¶
func Run ¶
Run executes argv with the given environment, wiring stdin through (nil reads as empty — for callers whose own stdin belongs to a protocol) and streaming the child's output to stdout/stderr (pass os.Stdout/os.Stderr for a direct wire, or Maskers to scrub captured output — the caller flushes those after Run returns), forwarding termination signals to the child. It returns the child's exit code (128+signal if the child was killed by a signal); a child that never started is a *StartError.
Types ¶
type Masker ¶ added in v0.6.0
type Masker struct {
// contains filtered or unexported fields
}
Masker is a Writer that rewrites occurrences of injected secret values in a byte stream with placeholders before forwarding to dst. It exists for captured output: anything a child process prints can end up in an agent's context window, a CI log, or a shell pipeline, and a server that echoes its connection string on boot would otherwise hand the secret to whatever is reading. Masking is accident-proofing, not a boundary — code that already holds the secret can always move it some other way.
Matching is exact byte matching, streamed: a value split across two writes is still caught (the longest tail that could open a secret is held back until later bytes decide). Flush emits whatever is still held at end-of-stream; callers must call it after the child exits or trailing output is lost.
func NewMasker ¶ added in v0.6.0
NewMasker builds a masker over dst for the given secrets. Values shorter than MinMaskLen are skipped; duplicate values collapse into one pattern (named after the first env var alphabetically). With no usable patterns the masker degrades to a plain passthrough.
type StartError ¶ added in v0.11.0
type StartError struct{ Err error }
StartError reports that the child process never ran (the command was not found, not executable, or the spawn itself failed) — as opposed to an error after a successful start. Callers map the distinction to exit codes.
func (*StartError) Error ¶ added in v0.11.0
func (e *StartError) Error() string
func (*StartError) Unwrap ¶ added in v0.11.0
func (e *StartError) Unwrap() error
Source Files