cpbackup

type AlertSource struct {
	Local *Manager
	Svc   *Service
	// LocalScheduled is false when scheduled local snapshots are switched off,
	// so their absence is not staleness.
	LocalScheduled bool
}

type Bucket interface {
	Put(ctx context.Context, key string, body io.ReadSeeker, contentType, contentEncoding string) error
	Get(ctx context.Context, key string) (io.ReadCloser, int64, error)
	Delete(ctx context.Context, key string) error
	List(ctx context.Context, prefix, token string, limit int32) (objectstore.ListPage, error)
}

type Check struct {
	Name   string `json:"name"`
	OK     bool   `json:"ok"`
	Detail string `json:"detail"`
}

type Checklist struct {
	DestinationChosen  bool `json:"destination_chosen"`
	RecipientSet       bool `json:"recipient_set"`
	EscrowAcknowledged bool `json:"escrow_acknowledged"`
	DrillPassed        bool `json:"drill_passed"`
}

type ConfigUpdate struct {
	Enabled        bool
	TargetID       string
	Recipients     []string
	Schedule       string
	DrillSchedule  string
	Retention      Retention
	EscrowTargetID string
}

type Destinations interface {
	Open(ctx context.Context, targetID string) (Bucket, Location, error)
}

type DrillResult struct {
	At        time.Time     `json:"at"`
	OK        bool          `json:"ok"`
	Partial   bool          `json:"partial"`
	Detail    string        `json:"detail"`
	BackupKey string        `json:"backup_key,omitempty"`
	Duration  time.Duration `json:"duration_ns"`
	Checks    []Check       `json:"checks"`
}

type DrillStatus struct {
	At         *time.Time `json:"at,omitempty"`
	OK         bool       `json:"ok"`
	Partial    bool       `json:"partial"`
	Detail     string     `json:"detail"`
	DurationMs int64      `json:"duration_ms"`
}

type Effective struct {
	Schedule      string    `json:"schedule"`
	DrillSchedule string    `json:"drill_schedule"`
	Retention     Retention `json:"-"`
}

type Entry struct {
	Key       string
	CreatedAt time.Time
}

type EscrowBundle struct {
	Armored        string    `json:"armored"`
	Instructions   string    `json:"instructions"`
	Fingerprint    string    `json:"fingerprint"`
	RecipientCount int       `json:"recipient_count"`
	CreatedAt      time.Time `json:"created_at"`
	UploadedKey    string    `json:"uploaded_key,omitempty"`
}

type EscrowInput struct {
	EscrowMaterial
	Recipients []string
	Upload     bool
}

type EscrowMaterial struct {
	MasterKey string
	Files     map[string]string
}

type EscrowPayload struct {
	Version       int       `json:"version"`
	CreatedAt     time.Time `json:"created_at"`
	InstallID     string    `json:"install_id"`
	BinaryVersion string    `json:"binary_version"`
	// MasterKey is the serialized master key identity. Never log it.
	MasterKey       string `json:"master_key"`
	MasterRecipient string `json:"master_recipient"`
	// Files holds other recovery material by file name, such as the agent CA
	// key that lives outside the database. Never log its values.
	Files        map[string]string `json:"files,omitempty"`
	Instructions string            `json:"instructions"`
}

type Identity struct {
	// Recipient is the public key, safe to store and share.
	Recipient string
	// Secret is the private key line. Never log it.
	Secret string
}

type Info struct {
	Name      string    `json:"name"`
	SizeBytes int64     `json:"size_bytes"`
	CreatedAt time.Time `json:"created_at"`
	SHA256    string    `json:"sha256"`
	// VerifiedAt and VerifiedOK describe the last verification, if any.
	VerifiedAt *time.Time `json:"verified_at,omitempty"`
	VerifiedOK *bool      `json:"verified_ok,omitempty"`
}

type Location struct {
	TargetID string `json:"target_id"`
	Name     string `json:"name"`
	Endpoint string `json:"endpoint"`
	Bucket   string `json:"bucket"`
}

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

type Manifest struct {
	ManifestVersion int       `json:"manifest_version"`
	InstallID       string    `json:"install_id"`
	Key             string    `json:"key"`
	CreatedAt       time.Time `json:"created_at"`
	BinaryVersion   string    `json:"binary_version"`
	SchemaVersion   int       `json:"schema_version"`
	// MigrationsApplied is the row count of the snapshot's schema_migrations.
	MigrationsApplied int    `json:"migrations_applied"`
	SHA256            string `json:"sha256"`
	SizeBytes         int64  `json:"size_bytes"`
	PlainSHA256       string `json:"plain_sha256"`
	PlainSizeBytes    int64  `json:"plain_size_bytes"`
	Compression       string `json:"compression"`
	Encryption        string `json:"encryption"`
	RecipientCount    int    `json:"recipient_count"`
	// ContainsWrappedSecrets is true: the database holds secret ciphertexts and
	// wrapped data keys. IncludesMasterKey is always false.
	ContainsWrappedSecrets bool `json:"contains_wrapped_secrets"`
	IncludesMasterKey      bool `json:"includes_master_key"`
}

type Options struct {
	Schedule      string
	DrillSchedule string
	Retention     Retention
	MaxPrune      int
	Tick          time.Duration
	RetryAfter    time.Duration
	// Grace is how late a scheduled run may be before it counts as overdue.
	Grace time.Duration
	// OrphanAge is how old an object without its partner must be before pruning removes it.
	OrphanAge time.Duration
}

type Remote struct {
	Key         string    `json:"key"`
	ManifestKey string    `json:"manifest_key"`
	CreatedAt   time.Time `json:"created_at"`
	SizeBytes   int64     `json:"size_bytes"`
	// Complete is true when both the ciphertext and its manifest exist.
	Complete bool `json:"complete"`
	// Modified is the newest object modification time, used to age out orphans.
	Modified time.Time `json:"-"`
}

type ResolverDestinations struct{ Resolver *objectstore.Resolver }

type RestoreOptions struct {
	// LivePath is the control plane database file to replace.
	LivePath   string
	Identities []age.Identity
	// DryRun verifies everything and leaves the live database untouched.
	DryRun bool
	// ForceInstallID accepts a backup taken by a different install.
	ForceInstallID bool
	Now            func() time.Time
	// BeforeInstall runs just before the live database is replaced; an error aborts the restore.
	BeforeInstall func() error
	// contains filtered or unexported fields
}

type RestoreReport struct {
	Source        string   `json:"source"`
	Manifest      Manifest `json:"manifest"`
	SchemaVersion int      `json:"schema_version"`
	Checks        []Check  `json:"checks"`
	DryRun        bool     `json:"dry_run"`
	PreRestore    string   `json:"pre_restore,omitempty"`
}

type Retention struct {
	Daily, Weekly, Monthly int
}

type Service struct {
	DB            Snapshotter
	Store         SettingsStore
	Dest          Destinations
	DataDir       string
	BinaryVersion string
	Opts          Options
	Logger        *slog.Logger
	Now           func() time.Time
	// DrillIdentities, when set, decrypt backups during drills. Their public
	// keys are added as recipients of every backup.
	DrillIdentities []age.Identity
	// contains filtered or unexported fields
}

type SettingsStore interface {
	GetCPDRSettings(ctx context.Context) (store.CPDRSettings, error)
	UpdateCPDRConfig(ctx context.Context, s store.CPDRSettings, now time.Time) error
	SetCPDRInstallID(ctx context.Context, id string) error
	RecordCPDRBackup(ctx context.Context, at time.Time, key, runErr string) error
	RecordCPDRDrill(ctx context.Context, at time.Time, ok, partial bool, detail string, ms int64) error
	RecordCPDREscrow(ctx context.Context, at time.Time) error
	AckCPDREscrow(ctx context.Context, at time.Time) error
}

type Snapshotter interface {
	SnapshotTo(ctx context.Context, dest string) (int64, string, error)
}

type Source interface {
	Describe() string
	ReadManifest(ctx context.Context) (Manifest, error)
	Fetch(ctx context.Context, dst string, maxBytes int64) error
}

type Status struct {
	Enabled                 bool        `json:"enabled"`
	Configured              bool        `json:"configured"`
	TargetID                string      `json:"target_id"`
	TargetName              string      `json:"target_name,omitempty"`
	InstallID               string      `json:"install_id"`
	Recipients              []string    `json:"recipients"`
	Schedule                string      `json:"schedule"`
	DrillSchedule           string      `json:"drill_schedule"`
	RetainDaily             int         `json:"retain_daily"`
	RetainWeekly            int         `json:"retain_weekly"`
	RetainMonthly           int         `json:"retain_monthly"`
	EscrowTargetID          string      `json:"escrow_target_id"`
	EscrowGeneratedAt       *time.Time  `json:"escrow_generated_at,omitempty"`
	EscrowAckedAt           *time.Time  `json:"escrow_acked_at,omitempty"`
	NextBackupAt            *time.Time  `json:"next_backup_at,omitempty"`
	NextDrillAt             *time.Time  `json:"next_drill_at,omitempty"`
	LastBackupAt            *time.Time  `json:"last_backup_at,omitempty"`
	LastBackupKey           string      `json:"last_backup_key,omitempty"`
	LastBackupError         string      `json:"last_backup_error,omitempty"`
	LastAttemptAt           *time.Time  `json:"last_attempt_at,omitempty"`
	LastDrill               DrillStatus `json:"last_drill"`
	DrillIdentityConfigured bool        `json:"drill_identity_configured"`
	BackupRunning           bool        `json:"backup_running"`
	DrillRunning            bool        `json:"drill_running"`
	Checklist               Checklist   `json:"checklist"`
	Warnings                []Warning   `json:"warnings"`
}

type VerifyResult struct {
	Name       string    `json:"name"`
	OK         bool      `json:"ok"`
	Checks     []Check   `json:"checks"`
	VerifiedAt time.Time `json:"verified_at"`
}

type Warning struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}