Skip to main content

Compliance Reports

chronicle:report generates a signed, self-contained HTML report of the Chronicle ledger. The report is suitable for handing to auditors or storing as evidence.

Generating a report​

# Full ledger report
php artisan chronicle:report /path/to/report.html

# Report for a specific date range
php artisan chronicle:report /path/to/report.html --from=2025-01-01 --to=2025-03-31

The command writes a single HTML file to the given path. The path is required.

Options​

OptionDescription
--from=Start of the reporting period (Y-m-d or ISO 8601)
--to=End of the reporting period (Y-m-d or ISO 8601)

Both options are optional. Omitting them includes all entries.

Report contents​

The generated HTML report contains:

FieldDescription
Generated atUTC timestamp of when the report was created
PeriodDate range covered (--from / --to), or "All entries"
Entry countNumber of entries in the period
Chain headchain_hash of the most recent entry in the period
Report hashSHA-256 of the canonical report data (entry count, boundaries, chain head, period)
AlgorithmSigning algorithm (e.g. ed25519)
Key IDIdentifier of the signing key
SignatureDetached signature of the report hash

The report hash is computed over a canonical JSON structure that includes generated_at, entry_count, first_entry_id, last_entry_id, chain_head, from, and to. The signature covers that hash using the active SigningProvider.

Verification​

The report is self-contained: all the data needed to verify the signature is embedded in the HTML. An auditor can extract the report hash, the signature, the algorithm, and the key id, then verify the signature with the corresponding public key.

Chronicle does not ship a separate verify-report command. Verification is intended to be done by the recipient using standard cryptographic tooling for the algorithm in use (e.g. openssl for Ed25519).

Signing​

The report is signed by the active SigningProvider configured in config/chronicle.php. With the default Ed25519SigningProvider, the private key must be present via CHRONICLE_PRIVATE_KEY.

Note: if signing is not configured, report generation will fail. Ensure signing keys are in place before scheduling this command.

Example output (abbreviated)​

Generated:   2026-06-03T08:00:00+00:00
Period:      2025-01-01 – 2025-03-31
Entry count: 4 821
Chain head:  a3f7c9...
Report hash: 8e12bd...

Algorithm:  ed25519
Key ID:     chronicle-main
Signature:  base64...

See also​