Verify attested data segments. Standalone SHA-256 verification for data provenance.
Project description
fors33-verifier
Standalone verification for attested data segments and general-purpose file integrity baselines. For machine-readable context (LLMs, crawlers), see LLM_CONTEXT.md. Confirm that a data segment or directory tree matches published hashes.
Warning: FORS33 Verifier provides cryptographic integrity checks only. It does not independently guarantee legal or regulatory compliance. See LEGAL_DISCLAIMER.md.
Release notes & version history
0.9.1 (2026-05-10)
- Manifest JSON compatibility: Keyword parameters on
verify_directory_from_manifest/execute_verification, CLI--legacy-manifest-json, or envFORS33_VERIFIER_LEGACY_MANIFEST_JSON=1opt into pre-0.9.0-style output (record-and-continue on manifest compromise, strippedcreated[].path,modified[].reason, broken lineage does not force exit 3 alone). Defaults stay extension-parity.
0.9.0 (2026-05-10)
- Manifest-mode extension parity: Sidecar path
dirname(target)/basename(target).f33, predicate byte-range hashing, triangle check order (data vs seal vs manifest),ManifestCompromisedErrorfail-fast by default after pool shutdown. lineage.json: After per-file verification, declares upstream digests checked against the same manifestentries; structuredlineageobject andfiles_scannedfield in JSON (see docs/lineage-json-convention-public.md).createddrift paths use multi-root keys verbatim (for example0:relative/path), matching extension output unless legacy compatibility is enabled (0.9.1).
0.8.1 (2026-05-10)
- Wave 3 predicate parity: Optional sidecar fields (
signature_intent,reason_for_change,sig_alg,nonce_hex,source_fingerprint) use the same canonical payload rules as the L3dgr extension. Reserved X.509sig_algtags fail with stableSIG_ALG_NOT_IMPLEMENTEDuntil chain validation ships. - Manifest HMAC:
verify_manifest_hmac()inverify_dpkvalidates an optionalfors33-manifest.hmacsidecar when a pepper is supplied; missing sidecar is legacy-OK (absent). - TSA: RFC 3161 path enforces TSA signer id-kp-timeStamping EKU; optional nonce check when
nonce_hexis present in the predicate (TSA_EKU_MISSING,TSA_NONCE_MISMATCH). - Receipts:
receipt_coreaddsgenerate_verification_receipt,receipt_to_json,receipt_to_base64;verify_receiptloadsfors33-manifest.jsonviamanifest_core.load_manifest(..., dataset_path)like the extension. - Supply chain: Docker images built by
publish-fors33-verifierattach SBOM and SLSA provenance (build-push-actionsbom: true,provenance: mode=max). Pin by digest in regulated CI.
0.8.0 (2026-05-01)
- Batch mode:
--directorywith concurrent verification of multiple PDF/ZIP/sealed datasets;--jsonsummary; thread-safe output.
0.7.0 (2026-04-28)
--verify-receipt, audit package / smart--filerouting,source_fingerprintin predicates, enhanced TSA token formats, zero-copy ZIP reads.
Earlier
- 0.6.0 and older: manifest hash chains, in-toto Statement v0.1/v1, canonical payload V1/V2, registry window,
hash_coremmap workers. Full text: CHANGELOG.md.
Install
pip install fors33-verifier
Releases are published to PyPI manually using python -m build and twine upload; the GitHub Actions workflow publish-fors33-verifier is responsible only for building and pushing Docker images. That workflow runs only when you trigger workflow_dispatch with explicit version (no leading v, e.g. 0.9.1) and push_latest—it does not run automatically on git tags.
Usage
Remote (presigned URL, full file):
fors33-verifier --url "https://..." --expected-hash <sha256_hex>
Remote (HTTP Range, segment only):
fors33-verifier --url "https://..." --start 0 --end 1048576 --expected-hash <sha256_hex>
Local full file:
fors33-verifier --file /path/to/segment.csv --expected-hash <sha256_hex>
Local segment (direct byte range):
fors33-verifier --file /path/to/data.csv --start 0 --end 4096 --expected-hash <sha256_hex>
Local segment (using attestation record):
fors33-verifier --file /path/to/data.csv --record /path/to/attestation_record.json
The attestation record JSON must contain byte_start, byte_end, and hash. Uses memory-efficient chunked reading so large files do not cause OOM.
Directory verification (manifest mode):
fors33-verifier --mode manifest --file ./baseline.sha256 --root ./root --format json
Use --root (or deprecated --target-dir) for the directory to verify. MD5/SHA-1 in manifests are rejected by default; use --force-insecure for legacy manifests.
Verify a directory against a checksum manifest (GNU/BSD-style text or JSON). Emits a structured drift report with modified, created, deleted, mutated_during_verification, skipped, files_scanned (extension-style residual live-path metric), and lineage when lineage.json rows are present (see docs/lineage-json-convention-public.md). --legacy-manifest-json or FORS33_VERIFIER_LEGACY_MANIFEST_JSON=1 opts into pre-0.9.0 manifest JSON and exit behavior (see release 0.9.1).
Sidecar verification:
fors33-verifier --mode sidecars --file ./root --format json
Walk the tree and verify .f33, .sha256, .sha512, and .md5 sidecars in place.
Optional TSA verification for JSON .f33 sidecars:
fors33-verifier --mode manifest --verify-tsa --file ./manifest.json --root ./root --format json
With --verify-tsa, the verifier accepts predicate.tsa.response_token (new enhanced format) or predicate.tsa.rfc3161_token_b64 (legacy format) or top-level predicate.rfc3161_token_b64 (RFC 3161 TimeStampResp DER, Base64) and/or the legacy Ed25519 predicate.tsa block. RFC tokens are checked offline: PKI status granted, CMS signature on the timestamp token, message imprint (hash OID from the token) over the same canonical attestation bytes as the main Ed25519 signature (V1/V2 line-oriented payload, or legacy JSON when canonical_payload_version is absent), TSA signer EKU (id-kp-timeStamping), and optional TSTInfo nonce vs predicate nonce_hex when present. MD5/SHA-1 imprint algorithms are rejected.
Receipt verification (standalone dataset verification):
fors33-verifier --verify-receipt receipt.json --root ./dataset
Verifies a portable JSON receipt (dataset digest + Ed25519 signature) against fors33-manifest.json under --root. The Python module receipt_core also exposes generate_verification_receipt, receipt_to_json, receipt_to_base64, and verify_receipt for tooling and tests.
Audit package verification (PDF with detached signature):
# Explicit flags
fors33-verifier --audit-package report.pdf --sig report.sig --pubkey public_key.pem
# Smart routing (automatic detection)
fors33-verifier --file report.pdf
fors33-verifier --file audit_package.zip
Verifies detached Ed25519 signatures of PDF audit packages. Smart routing automatically detects ZIP archives and PDF files, discovering associated .sig and .pem files in the same directory.
Batch verification (multiple audit packages):
# Text output (default)
fors33-verifier --directory /path/to/audit/packages
# JSON output for CI/CD integration
fors33-verifier --directory /path/to/audit/packages --json
# With custom worker count
fors33-verifier --directory /path/to/audit/packages --workers 16
Verifies multiple audit packages (PDF, ZIP, sealed datasets) in a single command with hardware-limited concurrent processing. Automatically discovers PDF files, ZIP archives, and sealed datasets (directories with fors33-manifest.json or manifest.json). Returns exit code 0 if all packages pass, 1 if any fail. JSON output includes per-package results and summary statistics for automated pipelines.
Legacy OpenPGP / GnuPG and fors33-verifier (separation of concerns)
This package deliberately keeps a narrow execution path: Ed25519-signed JSON .f33 attestations, standard checksum sidecars (.sha256, .sha512, .md5), and manifest verification. It does not parse or verify OpenPGP (.asc, detached PGP signatures, keyrings).
For legacy PGP / GnuPG artifacts, use the tooling your organization already trusts—for example gpg --verify against the signer’s public key and the detached signature file—alongside fors33-verifier for deterministic .f33 supply-chain attestations and published hash baselines. The two roles are complementary: GnuPG answers “was this blob signed by this PGP key?”; fors33-verifier answers “does this file or tree match the attested digest and seal metadata we ship in the kit?” without pulling OpenPGP into the verifier’s dependency or attack surface.
Manifest hashing workers (thread pool only):
fors33-verifier --mode manifest --workers 8 --file ./manifest.json --root ./root
Worker count: positive --workers wins; otherwise a positive FORS33_WORKERS; otherwise default_dpk_worker_count() (uses cpu_count and optional FORS33_DPK_MAX_WORKERS). Non-positive values mean auto. Hard cap 64.
Operator registry: when F33_KEY_REGISTRY_PATH is set to a non-empty path, that file must exist and be readable before verification starts. When unset or empty, registry checks are skipped.
Large-file hashing (hash_core): mmap window uses FORS33_MMAP_MIN_MB / FORS33_MMAP_MAX_MB (defaults 500 / 4000), clamped to cgroup/RAM ceiling on Linux; optional FORS33_MMAP_PSI_SOME_AVG10_MAX disables mmap when cgroup v2 memory pressure some avg10 exceeds the threshold. Optional global read throttle: set_global_read_bytes_per_second (extension use; shipped CLI does not set it).
Output
System-log format with timestamp, target, SHA-256, and status.
Exit codes:
0: verified / no drift1: drift or missing seal ([ ERR_MISSING_SEAL ])2: invocation or parameter misuse3: severe trust failures (e.g. bad signature, manifest compromise, invalid TSA)
Manifest/sidecars modes support --format json with --warn-only to report drift without failing.
GitHub Action (CI/CD)
Use FORS33 Data Provenance Check in your workflow. The step fails (exit 1) on hash mismatch, blocking the pipeline.
The action.yml default image: tag is a quickstart only. For production or regulated CI, pin a semver image tag (for example :0.9.1) or an immutable digest—do not rely on :latest as your compliance baseline.
- name: Verify data integrity
uses: fors33-official/fors33-verifier@v1 # or your tag
with:
file: ./dist/artifact.bin
expected-hash: 'abc123...'
For URL verification (presigned URLs only; no file uploads):
- uses: fors33-official/fors33-verifier@v1
with:
url: 'https://example.com/presigned.csv'
expected-hash: 'abc123...'
The FORS33 Data Provenance Kit runs on AWS S3, Snowflake, and local infrastructure. Procure licensing at fors33.com or GitHub Marketplace.
Docker
docker run --rm ghcr.io/fors33/fors33-verifier:0.9.1 --url "https://..." --expected-hash <sha256>
# or
docker run --rm docker.io/fors33/fors33-verifier:0.9.1 --file /data/file.csv --expected-hash <sha256>
Published images include SBOM and build provenance metadata (expand Release notes & version history near the top of this README). :latest is convenient for exploration; pin a version tag or immutable digest in production pipelines so runs stay reproducible.
URL-only API
For a hosted API that verifies presigned URLs only (no file uploads), run the image with the serve command. In-browser verification must use the Web Crypto API client-side; the file never leaves the user's machine.
Requirements
Python 3.9–3.12. cryptography and asn1crypto (required). Optional blake3 for faster hashing. Platforms: Linux, macOS, Windows.
License
MIT License. See LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fors33_verifier-0.9.1.tar.gz.
File metadata
- Download URL: fors33_verifier-0.9.1.tar.gz
- Upload date:
- Size: 42.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba6bbb93f345553cffafd8fc8c14b9cacf8fbf226c201e5d586f6ca7d151589c
|
|
| MD5 |
62876beb2412f83898d0335e02078560
|
|
| BLAKE2b-256 |
2f354131f23c9ef1007d92a7a085aa5ee5435bfffc168ae9453ff11c6ba7ffcb
|
File details
Details for the file fors33_verifier-0.9.1-py3-none-any.whl.
File metadata
- Download URL: fors33_verifier-0.9.1-py3-none-any.whl
- Upload date:
- Size: 43.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3994ce1759cb99ee228191cd8cd7df9e634c13f5b042ac68b946b3e165a60bf5
|
|
| MD5 |
3a19cbe5be57102a9865de1cedf269c4
|
|
| BLAKE2b-256 |
7ddb2c526221b985c9786b9c27e6fadfd7414f7d8301729352da9d65fe84640c
|