sshconsole

type Backend struct {
	// contains filtered or unexported fields
}

type Options struct {
	Profile string
	// Root is the project root ("" for a profile of the user config).
	Root string
	// UserConfig is the user config file ("" for none).
	UserConfig string
	// StateDir is the state base of the console (console.Options.StateDir;
	// "" is kit.StateBase()): Connect reads the approved policy there.
	StateDir string
	// IO answers the host key question (the console's terminal).
	IO console.IO
	// Home is the console account's home ("" is os.UserHomeDir()): "~/"
	// in key and the default known_hosts file.
	Home string
}

type Output struct {
	Command string `json:"command"`
	// Rule is the allow rule that matched ("" for an exec).
	Rule   string `json:"rule,omitempty"`
	Action string `json:"action"`
	// ExitStatus is the command's exit status; nil when a signal ended it
	// (Signal) or it timed out.
	ExitStatus *int   `json:"exit_status"`
	Signal     string `json:"signal,omitempty"`
	TimedOut   bool   `json:"timed_out,omitempty"`
	Stdout     string `json:"stdout"`
	Stderr     string `json:"stderr"`
	// StdoutTruncated and StderrTruncated: the stream was longer than
	// max_output_bytes and was cut there (before masking).
	StdoutTruncated bool  `json:"stdout_truncated,omitempty"`
	StderrTruncated bool  `json:"stderr_truncated,omitempty"`
	DurationMS      int64 `json:"duration_ms"`
	// Masked counts the masked values by kind; Unmasked marks an approved
	// clear output.
	Masked   map[string]int `json:"masked,omitempty"`
	Unmasked bool           `json:"unmasked,omitempty"`
}

type Params struct {
	// Argv is the program and its arguments, one string each.
	Argv []string `json:"argv"`
	// Intent is the agent's one-line reason, shown on approval screens
	// and kept in the audit log.
	Intent string `json:"intent,omitempty"`
	// Unmask asks for the output in clear: refused unless the human allowed
	// it in the console (:unmask, --allow-unmask), then decided by a human
	// on its own ticket, never by an auto rule.
	Unmask bool `json:"unmask,omitempty"`
	// Ticket runs, in hub mode, the request of a pending ticket once the
	// hub decided it; Requester is the agent behind the request
	// (mcpkit.RequesterFromEnv), to whose token a hub plan is bound.
	Ticket    string        `json:"ticket,omitempty"`
	Requester ipc.Requester `json:"requester,omitzero"`
}

type Plan struct {
	Command string `json:"command,omitempty"`
	Action  string `json:"action,omitempty"`
	Rule    string `json:"rule,omitempty"`
	// Verdict is run (runs at once), hub (decided on the approval hub:
	// op.run answers pending with a ticket), prompt (a console without a
	// hub, in tests) or refused.
	Verdict  string        `json:"verdict"`
	Reason   string        `json:"reason,omitempty"`
	Refusal  *refusal.Info `json:"refusal,omitempty"`
	Screen   []string      `json:"screen,omitempty"`
	Warnings []string      `json:"warnings,omitempty"`
}

type Policy struct {
	config.Policy
}

type Record struct {
	audit.Base
	Command string `json:"command,omitempty"`
	Action  string `json:"action,omitempty"`
	Rule    string `json:"rule,omitempty"`
	Exit    *int   `json:"exit_status,omitempty"`
	Signal  string `json:"signal,omitempty"`
	// TimedOut and Unmasked mark the run.
	TimedOut bool `json:"timed_out,omitempty"`
	Unmasked bool `json:"unmasked,omitempty"`
	// AutoRule is the profile's auto rule that applied to the request,
	// DecidedBy who decided its ticket on the hub ("auto:<rule id>",
	// "human").
	AutoRule  string `json:"auto_rule,omitempty"`
	DecidedBy string `json:"decided_by,omitempty"`
}

type Result struct {
	Untrusted string `json:"untrusted"`
	Data      Output `json:"data"`
}