config

type AutoAction string

type AutoRules struct {
	Read   AutoValue `json:"read,omitempty"`
	Unmask AutoValue `json:"unmask,omitempty"`
	Lookup AutoValue `json:"lookup,omitempty"`
}

type AutoValue string

type Budgets struct {
	// Range is the widest time range of a call with text, regex or
	// masked-field predicates.
	Range time.Duration `json:"range"`
	// CountRange is the widest range of a count on trusted fields only,
	// served from the local index or server-side metric queries.
	CountRange time.Duration `json:"count_range"`
	// MaxBytes is the most bytes one call processes (remote: fetches).
	MaxBytes int64 `json:"max_bytes"`
	// BytesPerHour is the rolling budget of bytes processed per hour.
	BytesPerHour int64 `json:"bytes_per_hour"`
	// MetricQueriesPerHour and RequestsPerMinute bound the load put on a
	// remote backend (remote only; 0 for local).
	MetricQueriesPerHour int `json:"metric_queries_per_hour,omitempty"`
	RequestsPerMinute    int `json:"requests_per_minute,omitempty"`
}

type Limits struct {
	Local  Budgets `json:"local"`
	Remote Budgets `json:"remote"`
	// MaxRecords and MaxOutputBytes cap one call's output.
	MaxRecords     int   `json:"max_records"`
	MaxOutputBytes int64 `json:"max_output_bytes"`
	// LookupsPerHour caps the distinct values locklog_lookup resolves per
	// hour for the whole console, LookupsPerHourPerUID per peer uid.
	LookupsPerHour       int `json:"lookups_per_hour"`
	LookupsPerHourPerUID int `json:"lookups_per_hour_per_uid"`
	// PIIAddsPerHour and PIIRulesMax cap the agent's own masking rules.
	PIIAddsPerHour int `json:"pii_adds_per_hour"`
	PIIRulesMax    int `json:"pii_rules_max"`
	// MaxCalls caps the agent calls the console runs at once; a call over
	// it is refused with E_BUSY. 0 is the default (DefaultMaxCalls), and
	// is left out of the policy's JSON so that a profile that does not
	// set it keeps its fingerprint.
	MaxCalls int `json:"max_calls,omitempty"`
}

type Policy struct {
	Profile Profile `json:"profile"`
	// Network is LOCKLOG_NETWORK: a Docker network the console joins to
	// reach a backend ("" for none).
	Network string `json:"network"`
	// ExtraRoots is LOCKLOG_EXTRA_ROOTS: mount roots beyond the built-in
	// allowlist, sorted.
	ExtraRoots []string `json:"extra_roots"`
	// PIIAllow are the allow rules of the project's .locklog/pii.toml in
	// their canonical form (mask.Rule.Text), sorted: an allow rule loosens
	// the masking, so it applies only once part of an approved policy.
	PIIAllow []string `json:"pii_allow,omitempty"`
}

type Profile struct {
	Name string `json:"name"`
	// Base carries production and the session limits; its connection
	// fields are unused (each remote source has its own).
	kconfig.Base
	Structured string   `json:"structured"`
	Text       string   `json:"text"`
	Detectors  []string `json:"detectors"`
	Unmask     string   `json:"unmask"`
	Lookup     string   `json:"lookup"`
	// Strict makes every search and count a ticket the human approves.
	Strict bool `json:"strict"`
	// Prefilter matches clear text before masking (non-production only):
	// faster, but latency then reveals how many records hold a substring.
	Prefilter bool `json:"prefilter"`
	// UserJournals also serves user-*.journal files.
	UserJournals bool `json:"user_journals"`
	// PseudonymRotation is "session", "never" or a duration ("7d");
	// PseudonymMaxAge is when an unrotated key shows red.
	PseudonymRotation string        `json:"pseudonym_rotation"`
	PseudonymMaxAge   time.Duration `json:"pseudonym_max_age"`
	Limits            Limits        `json:"limits"`
	// Sources are sorted by name.
	Sources []Source `json:"sources"`
	// Auto is the profile's auto mode for lox run (auto.go): only the
	// actions that differ from DefaultAutoRules, nil when none does. Read
	// it with AutoRules.
	Auto *AutoRules `json:"auto,omitempty"`
}

type Remote struct {
	URL string `json:"url"`
	// Selector is ANDed into every query: label = value (Loki), field =
	// value (Elasticsearch, OpenSearch).
	Selector map[string]string `json:"selector"`
	// TrustedLabels and TrustedMetadata (Loki) are shown (after the
	// detectors) and selectable; every other label and field is dropped.
	TrustedLabels   []string `json:"trusted_labels"`
	TrustedMetadata []string `json:"trusted_metadata"`
	Auth            string   `json:"auth"`
	OrgID           string   `json:"org_id,omitempty"`

	// Elasticsearch and OpenSearch: the indices, aliases, data streams or
	// trailing-'*' patterns read; the keyword fields shown (after the
	// detectors), selectable and countable (every other field is
	// dropped); the time, message and tiebreaker fields; the OpenSearch
	// roles the human vouches grant no write or manage permission.
	Indices       []string `json:"indices,omitempty"`
	TrustedFields []string `json:"trusted_fields,omitempty"`
	TimeField     string   `json:"time_field,omitempty"`
	MessageField  string   `json:"message_field,omitempty"`
	TieBreaker    string   `json:"tiebreaker,omitempty"`
	ReadOnlyRoles []string `json:"read_only_roles,omitempty"`
	// Base holds user, credentials, vault_path and the TLS settings.
	kconfig.Base
}

type Source struct {
	Name string `json:"name"`
	Kind string `json:"kind"`
	// Format is the format of a line (of the message, for journald,
	// containers and Loki); Multiline how lines become events.
	Format    string `json:"format"`
	Multiline string `json:"multiline"`
	// Trusted are the fields the human trusts beyond the parser's own:
	// shown in clear after the detectors, selectable and countable.
	Trusted []string `json:"trusted"`

	// File: absolute path globs; ** (one per glob) only when Recursive.
	Paths     []string `json:"paths,omitempty"`
	Recursive bool     `json:"recursive,omitempty"`

	// journald: the units served (empty: every unit), extra fields
	// allowed besides the trusted ones and MESSAGE.
	Units []string `json:"units,omitempty"`
	Allow []string `json:"allow,omitempty"`

	// Docker: container name globs, and the json-file attrs allowed.
	Containers []string `json:"containers,omitempty"`
	Attrs      []string `json:"attrs,omitempty"`

	// Loki, Elasticsearch, OpenSearch.
	Remote *Remote `json:"remote,omitempty"`
}