audit

type Actor struct {
	Type ActorType
	ID   string
	Name string
}

type ActorType string

type Backlog struct {
	Source  string
	Pending int64
	Oldest  time.Time // zero when nothing is pending
}

type Break struct {
	Seq    int64
	Reason string
}

type CheckpointInfo struct {
	Seq  int64
	Time string
}

type CheckpointLog struct {
	DB    *sql.DB // writer of the audit log
	Scope string
}

type CheckpointResult struct {
	Made bool
	Head Head   // the checkpoint entry itself
	Key  string // fingerprint of the signing key
}

type Checkpointer struct {
	Logs   []CheckpointLog
	Signer Signer
	Clock  clock.Clock
	Log    *slog.Logger
	Every  int64 // 0 = CheckpointEvery
}

type Deliverer struct {
	Routes []Route
	Clock  clock.Clock
	Log    *slog.Logger

	// Checkpoints, if set, makes a checkpoint after every 1000 entries and
	// once a day (step 6a).
	Checkpoints *Checkpointer
	// contains filtered or unexported fields
}

type Entry struct {
	Time     time.Time
	Actor    Actor
	Action   string // dotted, e.g. "certificate.issue"
	Target   Target
	Result   Result
	SourceIP string         // IP address only (no port, no host name); "" if none
	Details  map[string]any // never secrets – see forbiddenKey
}

type Head struct {
	Seq  int64
	Hash string
}

type Report struct {
	Entries int64
	Head    Head   // Seq 0 = empty log
	Break   *Break // nil = intact

	Checkpoints    int64
	LastCheckpoint *CheckpointInfo // nil = none yet
	CheckpointKey  string          // fingerprint of the key all checkpoints use
}

type Result string

type Route struct {
	Source string  // outbox_id prefix, e.g. "system" or "pki"; unique per audit log
	From   *sql.DB // writer of the producing database
	To     *sql.DB // writer of the audit log
	Scope  string  // scope of the audit log
}

type Signer interface {
	SignCheckpoint(msg []byte) (sig []byte, pub ed25519.PublicKey, err error)
}

type Target struct {
	Type string
	ID   string
}

type VerifyOptions struct {
	// CheckpointKey pins the checkpoint key: a fingerprint (prefix of at
	// least 16 hex digits) noted at init or taken from the process log.
	// Without it, Verify only checks that all checkpoints use one key.
	CheckpointKey string
}