Directories
¶
| Path | Synopsis |
|---|---|
|
Package authtest is an identity provider for tests: a discovery document and a key set served over a real listener, so the code under test runs its actual discovery and key fetch rather than being handed a key.
|
Package authtest is an identity provider for tests: a discovery document and a key set served over a real listener, so the code under test runs its actual discovery and key fetch rather than being handed a key. |
|
Package bucketcontract checks a bucket against the v1 bucket contract, docs/reference/bucket-contract.md: the key grammar, the envelope of every line, the metadata of every object, its sha256, the hash of every record, and the order keys sort in.
|
Package bucketcontract checks a bucket against the v1 bucket contract, docs/reference/bucket-contract.md: the key grammar, the envelope of every line, the metadata of every object, its sha256, the hash of every record, and the order keys sort in. |
|
Package buildinfo says which build this process is.
|
Package buildinfo says which build this process is. |
|
Package cli is the implementation behind cmd/audit.
|
Package cli is the implementation behind cmd/audit. |
|
Package clock measures how far this machine's clock is from UTC.
|
Package clock measures how far this machine's clock is from UTC. |
|
Package config is what each binary of this repository is configured with: one typed configuration per binary, read from one file and validated against a JSON Schema before anything starts.
|
Package config is what each binary of this repository is configured with: one typed configuration per binary, read from one file and validated against a JSON Schema before anything starts. |
|
gen
command
Command gen writes the configuration schemas of version 2 into schemas/config/, and the chart's values schema, which embeds them, into charts/audit/.
|
Command gen writes the configuration schemas of version 2 into schemas/config/, and the chart's values schema, which embeds them, into charts/audit/. |
|
schema
Package schema builds the JSON Schema of each binary's configuration file.
|
Package schema builds the JSON Schema of each binary's configuration file. |
|
Package corpus reads the example records in testdata/records, for tests that hold a transport or an encoder to them.
|
Package corpus reads the example records in testdata/records, for tests that hold a transport or an encoder to them. |
|
Package health serves a process's readiness: whether it can do its work now, as against /healthz, which says only that the process is up and answering.
|
Package health serves a process's readiness: whether it can do its work now, as against /healthz, which says only that the process is up and answering. |
|
Package hold places and releases legal holds over the archive.
|
Package hold places and releases legal holds over the archive. |
|
Package identity is the way back from a pseudonym to the person, for the cases the law requires and only for them.
|
Package identity is the way back from a pseudonym to the person, for the cases the law requires and only for them. |
|
Package merkle is the Merkle tree of docs/reference/bucket-contract.md: the Merkle Tree Hash of RFC 6962 section 2.1, over SHA-256, and the audit path that proves one leaf is in it (RFC 9162 section 2.1.3 for the checking).
|
Package merkle is the Merkle tree of docs/reference/bucket-contract.md: the Merkle Tree Hash of RFC 6962 section 2.1, over SHA-256, and the audit path that proves one leaf is in it (RFC 9162 section 2.1.3 for the checking). |
|
Package observe is the third part of an installation: it turns the archive into the search index by following the bucket (docs/decisions/0020).
|
Package observe is the third part of an installation: it turns the archive into the search index by following the bucket (docs/decisions/0020). |
|
observetest
Package observetest is what the cursor indexer is held to, whatever it is run over: the same cases against the in-memory archive, a real S3 and a real Postgres, because the claims are about the listing and the transaction and both are the places a double is kinder than the real thing.
|
Package observetest is what the cursor indexer is held to, whatever it is run over: the same cases against the in-memory archive, a real S3 and a real Postgres, because the claims are about the listing and the transaction and both are the places a double is kinder than the real thing. |
|
Package pgtest gives a test its own Postgres schema.
|
Package pgtest gives a test its own Postgres schema. |
|
Package query is the read service: it turns a request into a closed query, narrows it to what the caller was granted, asks a searcher, and records that the read happened.
|
Package query is the read service: it turns a request into a closed query, narrows it to what the caller was granted, asks a searcher, and records that the read happened. |
|
Package recobj is the format of a record object: the one object an ingest batch becomes, as docs/reference/bucket-contract.md specifies it.
|
Package recobj is the format of a record object: the one object an ingest batch becomes, as docs/reference/bucket-contract.md specifies it. |
|
Package registry holds the catalogues a deployment has registered.
|
Package registry holds the catalogues a deployment has registered. |
|
Package s3test gives a test a real S3 to walk.
|
Package s3test gives a test a real S3 to walk. |
|
Package schemagen turns the record's protobuf descriptor into a JSON Schema of the form this project writes.
|
Package schemagen turns the record's protobuf descriptor into a JSON Schema of the form this project writes. |
|
Package seal is the format of the three signed statements of docs/reference/bucket-contract.md — seals, delegations and revocations — the keys that sign them, and how a verifier decides whether to believe one.
|
Package seal is the format of the three signed statements of docs/reference/bucket-contract.md — seals, delegations and revocations — the keys that sign them, and how a verifier decides whether to believe one. |
|
Package telemetry is the OpenTelemetry metrics and traces this repository's processes publish.
|
Package telemetry is the OpenTelemetry metrics and traces this repository's processes publish. |
|
Package ulid makes the identifiers that end a record object's key.
|
Package ulid makes the identifiers that end a record object's key. |
|
Package writer turns records into the copies the profiles keep, and puts those copies where they are kept.
|
Package writer turns records into the copies the profiles keep, and puts those copies where they are kept. |
Click to show internal directories.
Click to hide internal directories.