gritpack evidence

Inspect and check the signed records a hub keeps about packages

Generated from gritpack evidence --helpGritpack 1.2.63
gritpack evidence [OPTIONS] <COMMAND>

Commands

public-key
Write the public key that matches a signing seed, to share with others
root
Show the public keys the hub signs its records with
inspect
Show one of the hub's signed records, by its SHA-256
attestations
List the publisher signatures on a published version
lifecycle
Fetch and check the hub's newest signed lifecycle checkpoint
verify-lifecycle
Verify a saved lifecycle checkpoint without contacting a hub
receipt
Download a signed publication receipt
verify-receipt
Verify a saved signed publication receipt without contacting a hub
attach
Add a publisher signature to a package in a publication in progress

Options

-h, --helpPrint help

gritpack evidence public-key

Write the public key that matches a signing seed, to share with others

gritpack evidence public-key [OPTIONS] --signing-seed <SIGNING_SEED> --output <OUTPUT>

Options

--signing-seed <SIGNING_SEED>File with the Ed25519 signing seed: 32 raw bytes or 64 lowercase hex digits
--output <OUTPUT>New file to write the public key to, in unpadded base64url
-h, --helpPrint help

gritpack evidence root

Show the public keys the hub signs its records with

gritpack evidence root [OPTIONS]

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack evidence inspect

Show one of the hub's signed records, by its SHA-256

gritpack evidence inspect [OPTIONS] <EVIDENCE_SHA256>

Arguments

<EVIDENCE_SHA256>SHA-256 of the record, as other evidence commands print it

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack evidence attestations

List the publisher signatures on a published version

gritpack evidence attestations [OPTIONS] <VERSION>

Arguments

<VERSION>The published version, as name@version or its storage ID

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack evidence lifecycle

Fetch and check the hub's newest signed lifecycle checkpoint

gritpack evidence lifecycle [OPTIONS]

Options

--state <STATE>State saved by an earlier --save-state; an older checkpoint is refused
--save-state <SAVE_STATE>Where to save the accepted state, for a later --state
--save-checkpoint <SAVE_CHECKPOINT>Save the signed checkpoint, to check it offline later
--save-root <SAVE_ROOT>Save the hub's public keys, fetched over TLS, to check offline later
--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack evidence verify-lifecycle

Verify a saved lifecycle checkpoint without contacting a hub

gritpack evidence verify-lifecycle [OPTIONS] --root <ROOT> <CHECKPOINT>

Arguments

<CHECKPOINT>Checkpoint saved by gritpack evidence lifecycle --save-checkpoint

Options

--root <ROOT>The hub's public keys, saved by gritpack evidence lifecycle --save-root
--state <STATE>State saved by an earlier --save-state; an older checkpoint is refused
--save-state <SAVE_STATE>Where to save the accepted state, for a later --state
--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help

gritpack evidence receipt

Download a signed publication receipt

gritpack evidence receipt [OPTIONS] --output <OUTPUT> <RECEIPT_ID>

Arguments

<RECEIPT_ID>Receipt ID, as printed when a publication finishes

Options

--output <OUTPUT>Where to save the signed receipt
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack evidence verify-receipt

Verify a saved signed publication receipt without contacting a hub

gritpack evidence verify-receipt [OPTIONS] --root <ROOT> <RECEIPT>

Arguments

<RECEIPT>Receipt saved by gritpack evidence receipt

Options

--root <ROOT>The hub's public keys, obtained in a way you trust, such as --save-root
--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help

gritpack evidence attach

Add a publisher signature to a package in a publication in progress

gritpack evidence attach [OPTIONS] <TRANSACTION_ID> <NODE_ID> <ENVELOPE>

Arguments

<TRANSACTION_ID>Publication transaction ID, as printed by publish
<NODE_ID>ID of the package's node in the publication plan
<ENVELOPE>The publisher's signed file, in the gritpack/signed-envelope@1 format

Options

-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4