hostsecurity

type AppliedException struct {
	Owner     string    `json:"owner"`
	Reason    string    `json:"reason"`
	ExpiresAt time.Time `json:"expires_at"`
}

type Control struct {
	ID          string            `json:"id"`
	State       State             `json:"state"`
	Expected    string            `json:"expected"`
	Observed    string            `json:"observed"`
	ObservedAt  time.Time         `json:"observed_at"`
	Reason      string            `json:"reason,omitempty"`
	ReasonCode  string            `json:"reason_code,omitempty"`
	Remediation Remediation       `json:"remediation"`
	Exception   *AppliedException `json:"exception,omitempty"`
}

type ControlSnapshot struct {
	State    State  `json:"state"`
	Observed string `json:"observed"`
}

type Engine struct {
	Host Host
}

type Evidence struct {
	SchemaVersion   string            `json:"schema_version"`
	Kit             string            `json:"kit,omitempty"`
	Mode            Mode              `json:"mode"`
	SiteKind        SiteKind          `json:"site_kind"`
	BaselineVersion string            `json:"baseline_version"`
	NodeRef         string            `json:"node_ref,omitempty"`
	PlanHash        string            `json:"plan_hash,omitempty"`
	ObservedAt      time.Time         `json:"observed_at"`
	ExpiresAt       time.Time         `json:"expires_at"`
	FreshnessSecs   int               `json:"freshness_budget_seconds"`
	Overall         State             `json:"overall"`
	Controls        []Control         `json:"controls"`
	Exceptions      []ExceptionRecord `json:"exceptions,omitempty"`
	Notices         []string          `json:"notices,omitempty"`
}

type Exception struct {
	Control   string    `json:"control"`
	Owner     string    `json:"owner"`
	Reason    string    `json:"reason"`
	ExpiresAt time.Time `json:"expires_at"`
}

type ExceptionRecord struct {
	Control   string          `json:"control"`
	Owner     string          `json:"owner,omitempty"`
	Reason    string          `json:"reason,omitempty"`
	ExpiresAt time.Time       `json:"expires_at,omitzero"`
	Status    ExceptionStatus `json:"status"`
	Detail    string          `json:"detail,omitempty"`
}

type ExceptionStatus string

type ExceptionsFile struct {
	SchemaVersion string      `json:"schema_version"`
	Exceptions    []Exception `json:"exceptions"`
}

type FirewallPolicy struct {
	// SSHPorts are the ports sshd listens on. They are never closed to the
	// management path.
	SSHPorts []int
	// Peers are the client addresses of SSH sessions in use when the policy was
	// built; they keep reaching sshd after the policy loads.
	Peers []netip.Addr
	// ManagementSources are owner-configured networks that may always reach
	// sshd (a jump host, an office network).
	ManagementSources []netip.Prefix
	// DeclaredOnly restricts LAN, overlay and container traffic to declared
	// service ports. Without declared-service authority the policy trusts
	// those sources on every port and drops everything else.
	DeclaredOnly bool
	// DeclaredTCP and DeclaredUDP are the declared service ports.
	DeclaredTCP []int
	DeclaredUDP []int
}

type Host interface {
	// LookPath resolves an executable like exec.LookPath.
	LookPath(name string) (string, error)
	// ReadFile reads a file like os.ReadFile.
	ReadFile(path string) ([]byte, error)
	// Stat reports file metadata like os.Stat.
	Stat(path string) (fs.FileInfo, error)
	// Run executes a command by name or absolute path. A nonzero exit is
	// reported in Output.ExitCode with a nil error; the error is for a command
	// that could not run or a context that ended.
	Run(ctx context.Context, name string, args ...string) (Output, error)
	// WriteFile atomically replaces a file with the given mode.
	WriteFile(path string, data []byte, mode os.FileMode) error
	// Remove deletes a file; a missing file is not an error.
	Remove(path string) error
	// MkdirAll creates a directory and its parents like os.MkdirAll.
	MkdirAll(path string, mode os.FileMode) error
	// Getenv reads one environment variable of the running process.
	Getenv(key string) string
	// Geteuid is the effective user ID of the running process.
	Geteuid() int
	// Now is the host clock.
	Now() time.Time
	// Sleep waits for d or until ctx ends.
	Sleep(ctx context.Context, d time.Duration) error
}

type Listener struct {
	Transport string `json:"transport"`
	Port      int    `json:"port"`
}

type LocalHost struct{}

type ManagedSysctl struct {
	Key     string
	Minimum int
}

type ManagementPath struct {
	SSHPorts          []int    `json:"ssh_ports"`
	SessionPeers      []string `json:"session_peers,omitempty"`
	ManagementSources []string `json:"management_sources,omitempty"`
	SessionUser       string   `json:"session_user,omitempty"`
	KeyAccounts       []string `json:"key_accounts,omitempty"`
	InSSHSession      bool     `json:"in_ssh_session"`
	// SSHInstalled is false when the host has no sshd, in which case there is
	// no ssh path to preserve.
	SSHInstalled bool `json:"ssh_installed"`
	// contains filtered or unexported fields
}

type Mode string

type Options struct {
	Kit      string
	Mode     Mode
	SiteKind SiteKind
	NodeRef  string
	PlanHash string
	// Freshness is the budget after which the evidence expires. Zero selects
	// DefaultFreshness.
	Freshness time.Duration
	// DeclaredListeners is the declared-service authority. nil means no
	// authority is available, which makes exposed listeners unknown rather
	// than compliant.
	DeclaredListeners []Listener
	DeclaredAuthority string
	// ManagementSources are owner-configured networks that always reach sshd.
	ManagementSources []netip.Prefix
	// ExceptionsPath is the owner-controlled exceptions file; empty means none.
	ExceptionsPath string
	// WorkspaceRoot locates custody material (certificates). Empty skips it.
	WorkspaceRoot string
}

type Outcome string

type Output struct {
	Stdout   string
	Stderr   string
	ExitCode int
}

type Packet struct {
	Source      netip.Addr
	Interface   string
	Protocol    string // tcp, udp or icmp
	Port        int    // destination port
	SourcePort  int
	Established bool
	Invalid     bool
}

type Remediation struct {
	Capability RemediationCapability `json:"capability"`
	Action     string                `json:"action,omitempty"`
}

type RemediationCapability string

type RepairOptions struct {
	Options
	// Controls restricts the repair to the named controls. Empty repairs every
	// drifted control that can be restored automatically.
	Controls []string
	// Apply carries the plan out. It is the only switch that changes the host.
	Apply bool
}

type RepairReport struct {
	SchemaVersion string          `json:"schema_version"`
	Outcome       Outcome         `json:"outcome"`
	Applied       bool            `json:"applied"`
	StartedAt     time.Time       `json:"started_at"`
	FinishedAt    time.Time       `json:"finished_at"`
	Management    ManagementPath  `json:"management_path"`
	Steps         []RepairStep    `json:"steps"`
	Before        Evidence        `json:"before"`
	After         *Evidence       `json:"after,omitempty"`
	Firewall      *FirewallPolicy `json:"firewall_policy,omitempty"`
}

type RepairStep struct {
	Control string     `json:"control"`
	Status  StepStatus `json:"status"`
	Summary string     `json:"summary,omitempty"`
	Changes []string   `json:"changes,omitempty"`
	Reason  string     `json:"reason,omitempty"`
	// ReasonCode is a stable code for a refusal, for example no_authorized_key.
	ReasonCode string           `json:"reason_code,omitempty"`
	Before     *ControlSnapshot `json:"before,omitempty"`
	After      *ControlSnapshot `json:"after,omitempty"`
}

type SiteKind string

type State string

type StepStatus string