Skip to main content

Module bundle

Module bundle 

Source
Expand description

The evidence bundle: a ceremony run packaged with its definition.

A bundle is a directory with a fixed layout:

bundle.json                      this index
transcript.jsonl                 the transcript, byte for byte as the run wrote it
definition/ceremony.rite.yaml    the ceremony YAML the run was resolved from
artifacts/<file>                 artifacts the transcript records with a digest

The index locates files and says what each one is. It repeats no digest: every file other than the transcript is bound by a digest the transcript commits to (the template digest on CeremonyStarted, the digest on each ArtifactWritten), so a verifier checks files against the transcript and the index adds nothing that would need protecting or redacting on its own. The trust anchor is the transcript fingerprint, never the index.

A disclosure bundle has the same layout. Its transcript withholds every line above the index’s threshold and folds to the same fingerprint as the complete one; it carries only the artifacts whose facts it discloses, and never the definition, which can name people.

Structs§

BundleFile
One file in a bundle.
BundleIndex
The index at the root of a bundle.

Enums§

BundleKind
What a bundle holds relative to the run.
FileRole
What a bundle file is.

Constants§

ARTIFACTS_DIR
Directory holding artifacts within a bundle.
BUNDLE_FORMAT
Bundle format version this crate writes and reads. 0 while rite is before 1.0, like TRANSCRIPT_FORMAT.
BUNDLE_SCHEMA
URL of the JSON Schema for the index this release writes, which the index names as its $schema so editors validate it.
DEFINITION_FILE
Path of the ceremony definition within a bundle.
INDEX_FILE
Name of the index file at the bundle root.
TRANSCRIPT_FILE
Path of the transcript within a bundle.

Functions§

artifact_path
Where an artifact recorded under file is stored, relative to the bundle or run directory: artifacts/<file>.