config

type Change = kconfig.Change

type Config struct {
	// ProjectRoot is the directory holding .locksql/config.toml, or "" when
	// no project config was found.
	ProjectRoot string
	Profiles    map[string]Profile
}

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

type ImportOptions struct {
	// Only, when not empty, limits the import to these profiles.
	Only []string
	// Replace drops the profiles of the file that the import does not
	// hold; by default they are kept.
	Replace bool
	// Local are the --local values: profile -> key -> value.
	Local map[string]map[string]string
}

type Limits struct {
	StatementTimeout  time.Duration `toml:"statement_timeout" json:"statement_timeout"`
	ExplainRowsWarn   int64         `toml:"explain_rows_warn" json:"explain_rows_warn"`
	ExplainRowsRefuse int64         `toml:"explain_rows_refuse" json:"explain_rows_refuse"`
	MaxRows           int           `toml:"max_rows" json:"max_rows"`
	MaxCellChars      int           `toml:"max_cell_chars" json:"max_cell_chars"`
	MaxOutputBytes    int           `toml:"max_output_bytes" json:"max_output_bytes"`
	// ExplainCostRefuse refuses a plan whose total cost, in the engine's
	// own units, is above it; 0 disables the check. Engines without a cost
	// (SQLite) are not checked.
	ExplainCostRefuse float64 `toml:"explain_cost_refuse" json:"explain_cost_refuse,omitempty"`
	// KAnonymity is the smallest number of rows a PII filter, a grouping
	// on a PII column or an aggregate of one may cover without a warning
	// on the approval screen.
	KAnonymity int `toml:"k_anonymity" json:"k_anonymity,omitempty"`
	// ReferenceProbe is how many distinct cells of one result the agent may
	// filter on, one statement each, before the console warns of equality
	// probing; raising it is a loosening.
	ReferenceProbe int `toml:"reference_probe" json:"reference_probe,omitempty"`
	// IdleTimeout ends the console session after that long without
	// activity, MaxSession after that long in all; raising either is a
	// loosening. Bounds: 1m <= IdleTimeout <= MaxSession <= 24h.
	IdleTimeout time.Duration `toml:"idle_timeout" json:"idle_timeout,omitempty"`
	MaxSession  time.Duration `toml:"max_session" json:"max_session,omitempty"`
}

type Policy struct {
	Profile  Profile  `json:"profile"`
	PIIMask  []string `json:"pii_mask"`  // sorted column patterns
	PIIAllow []string `json:"pii_allow"` // sorted column patterns
	// PIIModes maps a mask pattern to its mode when it is not the default
	// (redact): partial or email.
	PIIModes map[string]string `json:"pii_modes,omitempty"`
}

type Profile struct {
	Name        string `json:"name"`
	Engine      string `json:"engine"`
	Host        string `json:"host"`
	Path        string `json:"path"`
	User        string `json:"user"`
	Database    string `json:"database"`
	Credentials string `json:"credentials"`
	// TLS is the transport mode (TLSDisable ... TLSVerifyFull) and TLSCA an
	// optional PEM bundle that replaces the system roots.
	TLS   string `json:"tls,omitempty"`
	TLSCA string `json:"tls_ca,omitempty"`
	// TLSCert and TLSKey are the PEM files of a client certificate and its
	// private key, presented when the server asks for one. TLSServerName
	// replaces host as the name verify-full checks in the certificate.
	TLSCert       string `json:"tls_cert,omitempty"`
	TLSKey        string `json:"tls_key,omitempty"`
	TLSServerName string `json:"tls_server_name,omitempty"`
	// SSH, when set, is the bastion the profile is reached through.
	SSH *SSHProfile `json:"ssh,omitempty"`
	// ProxyCommand, when set, is the argv of a command whose stdin and
	// stdout carry each connection to the database, as OpenSSH's
	// ProxyCommand: docker exec, kubectl exec, ssh to a socket and so on.
	// It runs without a shell, as the console account.
	ProxyCommand []string `json:"proxy_command,omitempty"`
	Port         int      `json:"port"`
	Tier         Tier     `json:"tier"`
	Production   bool     `json:"production"`
	Detectors    []string `json:"detectors"`
	Limits       Limits   `json:"limits"`
	// CredentialsTTL makes the console ask for the secret again (and
	// reconnect) once the connection is that old; 0 keeps it for the
	// session. It suits short-lived secrets from a vault.
	CredentialsTTL time.Duration `json:"credentials_ttl,omitempty"`
	// VaultPath is the Vault path read for the login when Credentials is
	// "vault", such as "database/creds/app-readonly".
	VaultPath string `json:"vault_path,omitempty"`
	// PIIRules names the PII rule set of the profile: the file
	// pii/<set>.toml next to the config. The config holds the pii_rules
	// key, "" when it is not set; the console stores the set it resolved
	// (RuleSetOf, or the migrated default set) in the policy it approves.
	PIIRules string `json:"pii_rules,omitempty"`
	// WriteFunctions is "" (the denylist of every class) or
	// WriteFunctionsAllowlist: writes may call allowlisted functions only.
	WriteFunctions string `json:"write_functions,omitempty"`
}

type SSHProfile = kconfig.SSHProfile

type Share struct {
	Format   int                      `json:"locksql_config_format"`
	Version  string                   `json:"locksql_version,omitempty"`
	Profiles map[string]SharedProfile `json:"profiles"`
	PII      map[string]SharedRules   `json:"pii,omitempty"`
}

type SharedLimits struct {
	StatementTimeout  string  `json:"statement_timeout,omitempty"`
	ExplainRowsWarn   int64   `json:"explain_rows_warn,omitempty"`
	ExplainRowsRefuse int64   `json:"explain_rows_refuse,omitempty"`
	MaxRows           int     `json:"max_rows,omitempty"`
	MaxCellChars      int     `json:"max_cell_chars,omitempty"`
	MaxOutputBytes    int     `json:"max_output_bytes,omitempty"`
	ExplainCostRefuse float64 `json:"explain_cost_refuse,omitempty"`
	KAnonymity        int     `json:"k_anonymity,omitempty"`
	ReferenceProbe    int     `json:"reference_probe,omitempty"`
	IdleTimeout       string  `json:"idle_timeout,omitempty"`
	MaxSession        string  `json:"max_session,omitempty"`
}

type SharedProfile struct {
	Engine         string        `json:"engine"`
	Host           string        `json:"host,omitempty"`
	Port           int           `json:"port,omitempty"`
	User           string        `json:"user,omitempty"`
	Database       string        `json:"database,omitempty"`
	Credentials    string        `json:"credentials,omitempty"`
	VaultPath      string        `json:"vault_path,omitempty"`
	CredentialsTTL string        `json:"credentials_ttl,omitempty"`
	TLS            string        `json:"tls,omitempty"`
	TLSServerName  string        `json:"tls_server_name,omitempty"`
	Tier           string        `json:"tier,omitempty"`
	Production     bool          `json:"production,omitempty"`
	Detectors      []string      `json:"detectors"`
	PIIRules       string        `json:"pii_rules,omitempty"`
	WriteFunctions string        `json:"write_functions,omitempty"`
	Limits         *SharedLimits `json:"limits,omitempty"`
	SSH            *SharedSSH    `json:"ssh,omitempty"`
	NeedsLocal     []string      `json:"needs_local,omitempty"`
}

type SharedRule struct {
	Column string `json:"column"`
	Mode   string `json:"mode,omitempty"`
}

type SharedRules struct {
	Mask  []SharedRule `json:"mask"`
	Allow []SharedRule `json:"allow"`
}

type SharedSSH struct {
	Host        string `json:"host"`
	Port        int    `json:"port,omitempty"`
	User        string `json:"user"`
	Auth        string `json:"auth"`
	Credentials string `json:"credentials,omitempty"`
}

type Skipped struct{ Profile, Reason string }

type Tier int