logconsole

type Approve func(ctx context.Context, s console.Screen) console.Approval

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

type Caller struct{ UID, PID int }

type ClearView struct {
	On   bool
	Kept any
}

type Declined struct {
	Resp ipc.Response
}

type Engine interface {
	Handle(ctx context.Context, method string, params json.RawMessage, c Caller) (result any, refused *Refusal, err error)
	// Status is the engine's part of log.status and :status.
	Status(ctx context.Context) any
	Close() error
}

type OpenOptions struct {
	// Policy is the approved policy in force: the engine reads only the
	// sources it names.
	Policy config.Policy
	// Credentials are the secret of the profile's remote source (zero for
	// local sources).
	Credentials egress.Credentials
	// StateDir is the console's state directory (home volume).
	StateDir string
	// Roots are the mount roots of the policy's local sources, checked
	// against the launcher's (PlanRoots): the only directories the
	// sources may be given.
	Roots Roots
	// Project is the project root ("" for none): its .locklog holds the
	// human's PII rules.
	Project string
}

type Opener func(ctx context.Context, o OpenOptions) (Engine, error)

type Options struct {
	Profile string
	// Root is the project root ("" for none).
	Root string
	// StateDir is the console's state base.
	StateDir string
	// Network and ExtraRoots are LOCKLOG_NETWORK and LOCKLOG_EXTRA_ROOTS
	// as the launcher passed them: they are part of the policy.
	Network    string
	ExtraRoots []string
	// ExpectDir and ExpectRoots are LOCKLOG_EXPECT_DIR and
	// LOCKLOG_EXPECT_ROOTS: the device and inode of .locklog and of each
	// mount root, as the launcher checked them on the host.
	ExpectDir   string
	ExpectRoots string
	// DockerRoot is LOCKLOG_DOCKER_ROOT: the containers root the launcher
	// bound for a docker source.
	DockerRoot string
	// InContainer is true in locklog's image (InImage): LOCKLOG_EXPECT_DIR
	// is then required, and Root must be the directory the launcher
	// started the console in.
	InContainer bool
	// SysClassNet is /sys/class/net (tests replace it).
	SysClassNet string
	Open        Opener
}

type Policy struct {
	config.Policy
}

type Record struct {
	audit.Base
	Method  string   `json:"method"`
	Sources []string `json:"sources,omitempty"`
	From    string   `json:"from,omitempty"`
	To      string   `json:"to,omitempty"`
	// Tool is the tool an approved scan runs (log.scan).
	Tool string `json:"tool,omitempty"`
	// Pseudonyms name what an unmask revealed or a lookup resolved, by
	// pseudonym only (never the clear values).
	Pseudonyms []string `json:"pseudonyms,omitempty"`
	// ShownClear counts the records shown in clear on the console's
	// terminal (results on, Ctrl-O), never to the agent.
	ShownClear int `json:"shown_clear,omitempty"`
}

type Refusal struct {
	Message string
	Info    refusal.Info
}

type Revealer interface {
	Reveal(ctx context.Context, result any) []string
}

type Roots struct {
	// Dirs are the directories of the file sources' globs
	// (mountplan.Dir), sorted.
	Dirs []string
	// Journal are the journal directories bound (JournalDirs that
	// exist on the host).
	Journal []string
	// Docker is the containers root (LOCKLOG_DOCKER_ROOT), "" without a
	// docker source.
	Docker string
	// DockerChecked is set when the launcher could stat the containers
	// root from the host and passed its device:inode; usually it cannot
	// (/var/lib/docker is 0710 root), and the root is then the launcher's
	// "not checked from the host" case.
	DockerChecked bool
}