store

type APIKeyRecord struct {
	// ID is the stable identifier used in audit log entries and revocation calls.
	ID string `json:"id"`
	// TokenHash is the lowercase-hex SHA-256 of the raw token.
	TokenHash string `json:"-"`
	// Name is a human-readable label for the key (for example "ci-runner").
	Name string `json:"name"`
	// Role is the authorization role: admin, operator, or viewer.
	Role string `json:"role"`
	// ClusterScope lists cluster names (or "group:<name>" entries) this key may
	// act on. The single element "*" grants unrestricted access.
	ClusterScope []string `json:"cluster_scope"`
	// CreatedAt is when the key was minted.
	CreatedAt time.Time `json:"created_at"`
	// ExpiresAt, when non-zero, is when the key automatically becomes invalid.
	ExpiresAt time.Time `json:"expires_at"`
	// LastUsedAt is the most recent successful authentication.
	LastUsedAt time.Time `json:"last_used_at"`
	// RevokedAt, when non-zero, marks the key as administratively disabled.
	RevokedAt time.Time `json:"revoked_at"`
	// CreatedBy identifies the actor that created this key (admin key id, or
	// "bootstrap" for the legacy --auth-token, or "cli" for offline creation).
	CreatedBy string `json:"created_by,omitempty"`
}

type AckRecord struct {
	// Fingerprint is the SHA-256 of cluster|scanner|rule.
	Fingerprint string `json:"fingerprint"`
	// Cluster echoes the finding's cluster scope (or "fleet").
	Cluster string `json:"cluster"`
	// Scanner echoes the finding's source scanner.
	Scanner string `json:"scanner"`
	// Title echoes the finding's title at ack time, for human context.
	Title string `json:"title"`
	// AckBy identifies the operator who acked, free-form.
	AckBy string `json:"ack_by,omitempty"`
	// Reason is the operator's stated reason for acking.
	Reason string `json:"reason,omitempty"`
	// SnoozeUntil, when non-zero, is when the ack expires and the finding
	// resumes alerting. Zero value means "permanent until removed".
	SnoozeUntil time.Time `json:"snooze_until"`
	// CreatedAt is when the ack was recorded.
	CreatedAt time.Time `json:"created_at"`
}

type AlertListOptions struct {
	// Limit caps the number of rows returned. Defaults to 200 when zero.
	Limit int
	// Cluster, when non-empty, restricts results to a single cluster.
	Cluster string
	// Status, when non-empty, filters by alert status ("firing"/"resolved").
	Status string
	// Severity, when non-empty, filters by severity label value.
	Severity string
	// Since, when non-zero, only returns alerts received strictly after this time.
	Since time.Time
}

type AlertRecord struct {
	// Fingerprint is the AlertManager-assigned stable identity.
	Fingerprint string `json:"fingerprint"`
	// Cluster is the cluster the alert applies to. Derived from the
	// `cluster` label when present and falling back to the empty string
	// when AlertManager doesn't carry a cluster label.
	Cluster string `json:"cluster"`
	// Status is "firing" or "resolved".
	Status string `json:"status"`
	// AlertName is the value of the alertname label.
	AlertName string `json:"alertname"`
	// Severity is the value of the severity label when present.
	Severity string `json:"severity,omitempty"`
	// Summary is the value of the summary annotation when present.
	Summary string `json:"summary,omitempty"`
	// StartsAt is when the alert began firing.
	StartsAt time.Time `json:"starts_at"`
	// EndsAt is when the alert resolved (zero while firing).
	EndsAt time.Time `json:"ends_at"`
	// ReceivedAt is when Fleetsweeper recorded the alert.
	ReceivedAt time.Time `json:"received_at"`
	// Labels carries every label AlertManager attached to the alert.
	Labels map[string]string `json:"labels"`
	// Annotations carries every annotation AlertManager attached to the alert.
	Annotations map[string]string `json:"annotations"`
	// GeneratorURL is the link back to the Prometheus rule that fired.
	GeneratorURL string `json:"generator_url,omitempty"`
}

type AuditEntry struct {
	// ID is a time-sortable identifier.
	ID string `json:"id"`
	// Timestamp is when the request was received.
	Timestamp time.Time `json:"timestamp"`
	// ActorID identifies the api key that performed the action.
	// Empty when --insecure mode allowed an anonymous call.
	ActorID string `json:"actor_id,omitempty"`
	// ActorName is the key's human-readable label at request time.
	ActorName string `json:"actor_name,omitempty"`
	// ActorRole is the role the key carried at request time.
	ActorRole string `json:"actor_role,omitempty"`
	// Method is the HTTP verb (POST, PUT, DELETE).
	Method string `json:"method"`
	// Path is the request path.
	Path string `json:"path"`
	// Status is the HTTP response status.
	Status int `json:"status"`
	// RemoteAddr is the client address as reported by the transport.
	RemoteAddr string `json:"remote_addr,omitempty"`
	// UserAgent is the client's User-Agent header.
	UserAgent string `json:"user_agent,omitempty"`
	// DurationMS is the request handler duration in milliseconds.
	DurationMS int64 `json:"duration_ms"`
	// Error, when non-empty, is a short message describing why the request
	// failed authorization or processing.
	Error string `json:"error,omitempty"`
}

type AuditListOptions struct {
	// Limit caps the number of rows returned. Defaults to 100 when zero.
	Limit int
	// Since, when non-zero, only returns entries strictly newer than this time.
	Since time.Time
	// ActorID, when non-empty, restricts results to a single API key.
	ActorID string
	// MinStatus, when non-zero, only returns entries with status >= MinStatus.
	// Use 400 to surface only failures.
	MinStatus int
}

type ClusterRecord struct {
	// Name is the kubeconfig context name.
	Name string `json:"name"`
	// FirstSeen is when this cluster was first scanned.
	FirstSeen time.Time `json:"first_seen"`
	// LastSeen is when this cluster was last scanned.
	LastSeen time.Time `json:"last_seen"`
	// Groups lists the group names this cluster belongs to.
	Groups []string `json:"groups"`
	// Tags is the cluster's free-form tag map, omitted from the wire
	// when no tags are set.
	Tags map[string]string `json:"tags,omitempty"`
}

type Driver string

type GroupRecord struct {
	// Name is the group name.
	Name string `json:"name"`
	// Clusters lists the cluster names in this group.
	Clusters []string `json:"clusters"`
}

type LocationRecord struct {
	// Cluster is the cluster context name.
	Cluster string `json:"cluster"`
	// Lat is latitude in degrees north (positive) or south (negative).
	Lat float64 `json:"lat"`
	// Lng is longitude in degrees east (positive) or west (negative).
	Lng float64 `json:"lng"`
	// Site is a human-readable label (for example "Edge site 42, Manhattan").
	Site string `json:"site,omitempty"`
	// Notes is free-form text the operator can use.
	Notes string `json:"notes,omitempty"`
	// UpdatedAt is when the record was last written.
	UpdatedAt time.Time `json:"updated_at"`
}

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

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

type ScanRecord struct {
	// ID is the unique, time-sortable scan identifier.
	ID string `json:"id"`
	// Timestamp is when the scan was executed.
	Timestamp time.Time `json:"timestamp"`
	// Clusters lists the cluster context names that were scanned.
	Clusters []string `json:"clusters"`
	// Scanners lists the scanner names that were executed.
	Scanners []string `json:"scanners"`
}

type ScanResultRecord struct {
	// ScanID is the parent scan identifier.
	ScanID string `json:"scan_id"`
	// Cluster is the cluster context name.
	Cluster string `json:"cluster"`
	// Scanner is the scanner name.
	Scanner string `json:"scanner"`
	// DataJSON is the raw JSON-encoded scanner output.
	DataJSON []byte `json:"data_json"`
	// State is how much to trust DataJSON, as the scanner reported it.
	State scanner.State `json:"state,omitempty"`
	// Reason explains a State other than OK.
	Reason string `json:"reason,omitempty"`
}

type Store interface {
	// SaveScan persists a complete scan with all per-cluster results. Returns
	// the generated scan ID.
	SaveScan(ctx context.Context, clusters []string, results map[string]map[string]scanner.Result) (string, error)

	// SaveScanRecord persists a scan under rec.ID and rec.Timestamp so a caller can hand out the
	// ID before the scan finishes, or carry an existing scan across stores. An empty ID is
	// generated and a zero Timestamp means now. rec.Clusters lists the scanned clusters and
	// rec.Scanners is ignored in favor of the scanners present in results. Returns the scan ID.
	SaveScanRecord(ctx context.Context, rec ScanRecord, results map[string]map[string]scanner.Result) (string, error)

	// GetScan retrieves a scan record by ID.
	GetScan(ctx context.Context, id string) (*ScanRecord, error)

	// ListScans returns scan records ordered by timestamp descending.
	ListScans(ctx context.Context, limit int) ([]ScanRecord, error)

	// GetScanResults retrieves all per-cluster scanner results for a scan,
	// reconstructed into the same map shape the scan engine produces.
	GetScanResults(ctx context.Context, scanID string) (map[string]map[string]scanner.Result, error)

	// ListClusters returns all known clusters.
	ListClusters(ctx context.Context) ([]ClusterRecord, error)

	// SaveGroup creates or updates a group with the given cluster members.
	SaveGroup(ctx context.Context, name string, clusters []string) error

	// GetGroup retrieves a group by name.
	GetGroup(ctx context.Context, name string) (*GroupRecord, error)

	// ListGroups returns all groups.
	ListGroups(ctx context.Context) ([]GroupRecord, error)

	// DeleteGroup removes a group.
	DeleteGroup(ctx context.Context, name string) error

	// AddClusterToGroup adds a cluster to an existing group.
	AddClusterToGroup(ctx context.Context, group, cluster string) error

	// RemoveClusterFromGroup removes a cluster from a group.
	RemoveClusterFromGroup(ctx context.Context, group, cluster string) error

	// GetClusterHistory returns scan results for a specific cluster across
	// scans, ordered by time descending.
	GetClusterHistory(ctx context.Context, cluster string, limit int) ([]ScanResultRecord, error)

	// GetScansByTimeRange returns scans within a time window.
	GetScansByTimeRange(ctx context.Context, start, end time.Time) ([]ScanRecord, error)

	// Prune deletes scans older than cutoff. Returns the number of scans deleted.
	Prune(ctx context.Context, cutoff time.Time) (int, error)

	// Vacuum reclaims unused database pages.
	Vacuum(ctx context.Context) error

	// SetLocation upserts a manual location override for a cluster.
	SetLocation(ctx context.Context, loc LocationRecord) error

	// GetLocation returns a single cluster's manual override, or nil if none.
	GetLocation(ctx context.Context, cluster string) (*LocationRecord, error)

	// ListLocations returns every manual override.
	ListLocations(ctx context.Context) ([]LocationRecord, error)

	// DeleteLocation removes a manual override.
	DeleteLocation(ctx context.Context, cluster string) error

	// SaveAck upserts a finding acknowledgement. The fingerprint primary key
	// allows the same finding to be acked once across many scan cycles.
	SaveAck(ctx context.Context, rec AckRecord) error

	// DeleteAck removes an acknowledgement. Idempotent.
	DeleteAck(ctx context.Context, fingerprint string) error

	// GetAck returns the active acknowledgement for a fingerprint. Returns the
	// wrapped ErrNotFound when no row matches or its snooze has expired.
	GetAck(ctx context.Context, fingerprint string) (AckRecord, error)

	// ListAcks returns every active acknowledgement (expired snoozes pruned).
	ListAcks(ctx context.Context) ([]AckRecord, error)

	// IsAcked reports whether a finding is currently acknowledged.
	IsAcked(ctx context.Context, fingerprint string) (bool, error)

	// SaveAPIKey inserts a new API key. The raw token is never persisted: the
	// caller must hash it and place the result in rec.TokenHash before calling.
	SaveAPIKey(ctx context.Context, rec APIKeyRecord) error

	// GetAPIKeyByHash looks up a key by token hash. Returns the wrapped
	// ErrNotFound when no row matches.
	GetAPIKeyByHash(ctx context.Context, hash string) (*APIKeyRecord, error)

	// GetAPIKey returns the key with the given ID.
	GetAPIKey(ctx context.Context, id string) (*APIKeyRecord, error)

	// ListAPIKeys returns every API key including revoked ones, newest first.
	ListAPIKeys(ctx context.Context) ([]APIKeyRecord, error)

	// RevokeAPIKey marks the key with the given ID as administratively disabled.
	RevokeAPIKey(ctx context.Context, id string) error

	// TouchAPIKey updates the last-used-at timestamp. Best-effort; callers
	// should not fail authentication on error.
	TouchAPIKey(ctx context.Context, id string, at time.Time) error

	// SaveAuditEntry inserts one audit log row.
	SaveAuditEntry(ctx context.Context, rec AuditEntry) error

	// ListAuditEntries returns audit entries matching opts, newest first.
	ListAuditEntries(ctx context.Context, opts AuditListOptions) ([]AuditEntry, error)

	// PruneAuditEntries deletes audit log rows older than cutoff and returns
	// the number of rows removed. Used by the audit-retention ticker.
	PruneAuditEntries(ctx context.Context, cutoff time.Time) (int, error)

	// UpsertAlert inserts or updates an inbound AlertManager alert keyed by
	// its fingerprint. Reusing the fingerprint allows the same alert to
	// transition between firing/resolved without producing duplicate rows.
	UpsertAlert(ctx context.Context, rec AlertRecord) error

	// GetAlert returns the alert row with the given fingerprint. Returns
	// ErrNotFound when no row matches.
	GetAlert(ctx context.Context, fingerprint string) (*AlertRecord, error)

	// ListAlerts returns alerts matching opts, newest received_at first.
	ListAlerts(ctx context.Context, opts AlertListOptions) ([]AlertRecord, error)

	// PruneAlerts deletes alert rows older than cutoff (received_at). Returns
	// the number of rows removed.
	PruneAlerts(ctx context.Context, cutoff time.Time) (int, error)

	// SetClusterTag upserts a single key/value tag on a cluster.
	SetClusterTag(ctx context.Context, cluster, key, value string) error

	// DeleteClusterTag removes one key from a cluster's tag set. Idempotent.
	DeleteClusterTag(ctx context.Context, cluster, key string) error

	// GetClusterTags returns every tag pair on a cluster as a key→value
	// map. Empty map when no tags are set.
	GetClusterTags(ctx context.Context, cluster string) (map[string]string, error)

	// ListClusterTags returns every tag across the fleet, grouped by
	// cluster. Convenient for the dashboard's per-cluster render.
	ListClusterTags(ctx context.Context) (map[string]map[string]string, error)

	// Close releases database resources.
	Close() error
}