backup

type Archive struct {
	Manifest *Manifest
	// Sidecar describes the encrypted file; [Publish] writes it after it.
	Sidecar *Sidecar
	// Path is the encrypted file.
	Path string
}

type BlobsEntry struct {
	Count int64 `json:"count"`
	Bytes int64 `json:"bytes"`
}

type Identities func(ctx context.Context) ([]age.Identity, error)

type Layout string

type Lines struct {
	Records int64  `json:"records"`
	SHA256  string `json:"sha256"`
}

type Manifest struct {
	// Format is the archive format version (see [Version]).
	Format int `json:"format"`
	// Instance and ID name the backup; they are also in its object key.
	Instance string `json:"instance"`
	ID       string `json:"id"`
	// Layout is the storage layout of the source installation.
	Layout Layout `json:"layout"`
	// Created is the start of the backup, UTC, RFC 3339.
	Created string `json:"created"`
	// Creator names what wrote it, for example "sluis-backup 1.76.1".
	Creator string `json:"creator"`
	// Modules lists the modules in the backup in [port.Modules] order, each
	// once.
	Modules []ModuleEntry `json:"modules"`
	// Files is the SHA-256 (hex) of every other member, by member name.
	Files map[string]string `json:"files"`
}

type ModuleEntry struct {
	Module  port.Module `json:"module"`
	State   Lines       `json:"state"`
	Secrets Lines       `json:"secrets"`
	Blobs   BlobsEntry  `json:"blobs"`
}

type ObjectInfo struct {
	Key    string `json:"key"`
	Size   int64  `json:"size"`
	SHA256 string `json:"sha256"`
}

type Params struct {
	Instance string
	ID       string
	Layout   Layout
	// Creator names what writes it, for example "sluis-backup 1.76.1".
	Creator string
	// Recipients are the age X25519 public keys (age1...) the backup is
	// encrypted to; at least one.
	Recipients []string
	// Now is the clock; time.Now when nil.
	Now func() time.Time
	// TempDir holds the spool and the encrypted file while they are written;
	// os.TempDir() (/tmp on Lambda) when empty.
	TempDir string
}

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

type Section string

type Sidecar struct {
	Format     int             `json:"format"`
	Instance   string          `json:"instance"`
	ID         string          `json:"id"`
	Created    string          `json:"created"`
	Creator    string          `json:"creator"`
	Layout     Layout          `json:"layout"`
	Object     ObjectInfo      `json:"object"`
	Recipients []string        `json:"recipients"`
	Modules    []SidecarModule `json:"modules"`
}

type SidecarModule struct {
	Module        port.Module `json:"module"`
	StateRecords  int64       `json:"stateRecords"`
	SecretRecords int64       `json:"secretRecords"`
	Blobs         int64       `json:"blobs"`
	BlobBytes     int64       `json:"blobBytes"`
}

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