api

type Checkpoint struct {
	// Origin is the unique identifier for the log issuing this checkpoint.
	Origin string
	// Size is the number of entries in the log at this checkpoint.
	Size uint64
	// Hash is the hash which commits to the contents of the entire log.
	Hash []byte
}

type FirmwareRelease struct {
	// Description is a human readable description of the firmware release.
	Description string `json:"description"`

	// PlatformID identifies the hardware platform this release targets.
	PlatformID string `json:"platform_id"`

	// Revision identifies the revision of this release.
	// e.g. "v2021.05.03"
	Revision string `json:"revision"`

	// ArtifactSHA256 contains the SHA256 hashes of the named release artifacts.
	ArtifactSHA256 map[string][]byte `json:"artifact_sha256"`

	// SourceURL is the location from which an archive of the source code used to
	// produce this release can be downloaded.
	SourceURL string `json:"source_url"`

	// SourceSHA256 is the SHA256 hash of the contents of the source file at the location
	// pointed to by SourceURL.
	SourceSHA256 []byte `json:"source_sha256"`

	// ToolChain identifies the toolchain used to build the release from the source.
	ToolChain string `json:"tool_chain"`

	// BuildArgs identifies the set of build arguments used to build the firmware from the source.
	BuildArgs map[string]string `json:"build_args"`
}

type ProofBundle struct {
	// NewCheckpoint is the signed checkpoint from the log covering the updated release.
	//
	// This is stored in the format specified at https://github.com/google/trillian-examples/tree/master/formats/log
	NewCheckpoint []byte

	// FirmwareRelease is the signed FirmwareRelease statement corresponding to the update.
	//
	// This is stored as a sumbdb signed note containing the JSON representation of the
	// FirmwareRelease struct.
	FirmwareRelease []byte

	// LeafHashes contains all leaf hashes committed to by NewCheckpoint.
	//
	// This is to allow users who don't/cannot use a tool to install the firmware to verify
	// consistency with any possible Checkpoint they may have on their device currently.
	LeafHashes [][]byte
}