sdcreceipt
Verify and settle VSL Settlement Receipts.
Verification needs no account, no network, and nothing from the issuer. That is the point of the tool: a claim that anyone can check a Receipt independently is worth exactly as much as the ability to do it.
Apache-2.0.
pip install sdcreceipt
Four verbs
# Check a Receipt you were sent. Offline.
sdcreceipt verify receipt.json --keys issuer-keys.json
# Set yourself up as a party: keypair + the document to publish.
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
# Authorize a settlement you are a party to.
sdcreceipt trigger receipt.json --key vsl-party.pem \
--key-id https://vendor.example/.well-known/vsl-key.json
# Ask an issuer for a Receipt. The one verb that needs an account.
sdcreceipt settle payload.xml \
--party https://vendor.example/.well-known/vsl-key.json \
--party did:web:partner.example
settle prompts for anything it needs and was not given. Two of its fields are
not guessable and never were: the release condition is hashed by the issuer and
never stored, and current_state/target_state come from a governance workflow
defined in a schema the issuer holds, not you.
If the issuer refuses the transition it answers with the ones it would have
accepted, and settle prints them:
Governance evaluation produced no Receipt. Decision was DENY
From 'draft' you can go to: review
This model's workflow:
standard: draft -> review -> published
It exits 2 there, and 1 on a real failure, so a script can tell "ask again differently" from "something is broken".
verify exits 0 only if every check passed, so it composes in a shell without
anyone parsing output.
That is the whole surface. This is a client, not a product, and its value is in being small enough to read.
Try it without reading anything
python examples/settle.py
One settlement end to end: two parties, two signatures, verified offline. No
account, no network, no API key. See examples/.
For an agent
The same two things over MCP, in the same package:
sdcreceipt-mcp --key vsl-party.pem \
--key-id https://vendor.example/.well-known/vsl-key.json
Exposes verify_receipt, sign_trigger and settle. Each is advertised only
when the server has what it needs, so a tool is never offered whose every call
would fail.
Two deliberate omissions, and they are the security posture rather than an oversight:
- No key generation. A private key generated inside an agent session has no
clear custody story.
initstays a human act at a terminal. - No submission.
sign_triggerreturns a signed trigger for you to submit. Submitting takes a destination from the caller, and a signed trigger plus an arbitrary host is the combination worth refusing.
settle is available when the server is started with --endpoint and a token,
and it is the only tool that reaches the network. The endpoint is fixed at
start-up exactly like the key, so a caller can never redirect where a payload
goes. No tool takes a URL, and that is the invariant to keep if this ever
grows another one.
The signing key is given at start-up, never in a tool call, so it does not travel through the conversation.
If you were sent a Receipt
You do not need an account with anyone.
pip install sdcreceipt
curl -O https://sdcstudio.axius-sdc.com/.well-known/sdcstudio-signing-keys.json
sdcreceipt verify receipt.json --keys sdcstudio-signing-keys.json
Every check is reported, not just the first failure:
PASS schema: conforms
PASS receipt_hash: matches the canonical content
PASS signature[sdcstudio-signing-key-v1]: verifies over receipt_hash
PASS trigger[https://vendor.example/.well-known/vsl-key.json]: verifies
PASS settlement.complete: every listed party has triggered
VERIFIED
A Receipt carries hash commitments, never the payload. So verification tells you a conformant, authorized, dual-triggered exchange occurred, without anyone having to disclose what was exchanged. If you also hold the payload or the governance Receipt, pass them and those get checked too:
sdcreceipt verify receipt.json --keys keys.json \
--payload manifest.xml --governance governance-receipt.json
If you need to become a party
A settlement identifies each party by a key_id that you control. That is
deliberate: it means verifying your signature does not route through the
issuer, so nobody has to stay alive for your old signatures to keep meaning
something.
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
That writes a private key (mode 0600) and a key document, and tells you the
exact URL the document must be reachable at. Publishing one JSON file is the
whole onboarding requirement.
Then, when you are sent a Receipt to authorize:
sdcreceipt trigger receipt.json --key vsl-party.pem --key-id <your key_id>
It prints a signed trigger and stops. Signing is inert; submitting is a side
effect, so you send it yourself, or add --submit <url>.
★ Never take the verification key from the document
The set of keys you will accept is decided before you read the document, and the document cannot change it.
ds:RetrievalMethod in XML-Signature, jku and x5u in JOSE, and their
equivalents elsewhere all say "here is where my key lives." That pointer was
written by whoever produced the document, so following it asks the document to
nominate the key that will judge it. A forged document nominates the forger's
key and verification "succeeds."
The failure is quiet. A pointer can name a domain that was correct when the document was signed and has since lapsed; anyone who registers it can serve a key at that path, and nothing about the document looks wrong — because nothing about it is wrong. The verifier was asked where to look and did as it was told.
This tool cannot make that mistake: verify takes keys as arguments and has
no code path that fetches one. That is a security property, not an
inconvenience.
The same applies to party keys, with a corollary rather than an exemption.
Those key_ids are URIs the counterparty controls, deliberately. Resolve
them over HTTPS only, only for identifiers already recorded in a Receipt you
trust, and keep a copy — a party who later loses a domain must not be able to
change what their old signatures mean.
Supply them, too. Party keys are optional in the sense that the issuer
signature and the payload hash can be checked without them, and not in the
sense that a settled Receipt means anything without them. Whether every party
triggered is a claim about authorization, so with no key to check a signature
against, settlement.complete is recorded as unestablished rather than passed
and the Receipt does not verify. Before 4.2.1 it passed on a comparison of
key_id strings alone, which reported VERIFIED over fabricated triggers.
Conformance
tests/conformance/ ships the issuer's published vectors, and the suite runs
this implementation against them.
Eleven vectors. Every invalid one encodes a defect that was actually made,
not a hypothetical: a DER signature where ES256 requires P1363, a signature
over the hex text of receipt_hash rather than its raw bytes, a governance
binding that does not match the evidence held, a trigger replayed from another
Receipt sharing the same release condition, and so on. Failing one for the
wrong reason does not count — the manifest names the check that must break.
pytest
On independence, honestly. Passing these vectors shows this tool agrees with the issuer's published expectations, and that it never drifted from them. It is not an independent re-derivation: this implementation and the issuer's share design and history. The vectors are most valuable to someone writing a verifier from the specification alone, which is what they are published for.
Building your own
You do not have to use this tool, and the specification does not depend on it. If you are writing a verifier:
Do not write a second canonicalizer. Use sdcgovernance or another
conformant RFC 8785 implementation. A second implementation can disagree with
the first, and the disagreement is silent: the bytes differ, so the hash
differs, and the artifact reads as tampered with rather than misencoded. This
tool re-exports sdcgovernance.jcs for exactly that reason and adds nothing.
Refuse rather than guess. Integers beyond ±(2⁵³−1) cannot round-trip
through an IEEE 754 double, and NaN/Infinity have no JSON representation.
Emitting something for those produces a hash that looks fine and fails only in
someone else's verifier.
Report every check. Stopping at the first failure hides the case that matters most: a Receipt whose signature verifies but whose governance binding does not.
Check the curve. A signature verified against a key on an unexpected curve proves nothing about the party you believe signed.
Versioning
MAJOR tracks the SDC reference model, so a 4.x.x release targets SDC4.
It starts at 4 rather than 0 because of that convention, not because there
were three earlier versions. MINOR is features, PATCH is fixes. An SDC5
reference model would make this 5.x.x.
The same scheme is used by sdcvalidator, sdcgovernance and the rest of the
family, so a version number tells you which reference model an artifact
targets without looking anything up.
Note that the Receipt format version is separate and independent: a
Receipt says "version": "1.0", which is the frozen wire format, not this
package.
Dependencies
sdcgovernance for canonicalization and cryptography for ECDSA, both
Apache-2.0-compatible libraries. jsonschema is optional and only needed for
--schema.
These are library dependencies. Nothing here calls a service, and
verify makes no network request at all.
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 sdcreceipt-4.2.1.tar.gz.
File metadata
- Download URL: sdcreceipt-4.2.1.tar.gz
- Upload date:
- Size: 47.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7ecc21024e72965be34a15edf93bcc507b4e34246e03dcba5e63d1e56b9fcaea
|
|
| MD5 |
c449253c6bc97c28c58498a6ec889529
|
|
| BLAKE2b-256 |
0e8f7aca5954a9c678792e2aabcfe2c55bd2a0ebea27803af83919c8bc381089
|
Provenance
The following attestation bundles were made for sdcreceipt-4.2.1.tar.gz:
Publisher:
release.yml on SemanticDataCharter/sdcreceipt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sdcreceipt-4.2.1.tar.gz -
Subject digest:
7ecc21024e72965be34a15edf93bcc507b4e34246e03dcba5e63d1e56b9fcaea - Sigstore transparency entry: 2676686187
- Sigstore integration time:
-
Permalink:
SemanticDataCharter/sdcreceipt@7119f20f045defad28e4e0f96e6f9d63573b220e -
Branch / Tag:
refs/tags/v4.2.1 - Owner: https://github.com/SemanticDataCharter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7119f20f045defad28e4e0f96e6f9d63573b220e -
Trigger Event:
push
-
Statement type:
File details
Details for the file sdcreceipt-4.2.1-py3-none-any.whl.
File metadata
- Download URL: sdcreceipt-4.2.1-py3-none-any.whl
- Upload date:
- Size: 32.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c690020bd2e403180fa58480b546ecfdc380f1ebc6eb33fda2e3d54ca68ec9fe
|
|
| MD5 |
218737d93ba508922215450e06bcf126
|
|
| BLAKE2b-256 |
01c597bf768e57b5743527f42adb71936803e9af886fb9a28f17f8af23049ae5
|
Provenance
The following attestation bundles were made for sdcreceipt-4.2.1-py3-none-any.whl:
Publisher:
release.yml on SemanticDataCharter/sdcreceipt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sdcreceipt-4.2.1-py3-none-any.whl -
Subject digest:
c690020bd2e403180fa58480b546ecfdc380f1ebc6eb33fda2e3d54ca68ec9fe - Sigstore transparency entry: 2676686322
- Sigstore integration time:
-
Permalink:
SemanticDataCharter/sdcreceipt@7119f20f045defad28e4e0f96e6f9d63573b220e -
Branch / Tag:
refs/tags/v4.2.1 - Owner: https://github.com/SemanticDataCharter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7119f20f045defad28e4e0f96e6f9d63573b220e -
Trigger Event:
push
-
Statement type: