sdcreceipt 4.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sdcreceipt-4.0.0/LICENSE +201 -0
- sdcreceipt-4.0.0/PKG-INFO +211 -0
- sdcreceipt-4.0.0/README.md +191 -0
- sdcreceipt-4.0.0/pyproject.toml +36 -0
- sdcreceipt-4.0.0/setup.cfg +4 -0
- sdcreceipt-4.0.0/src/sdcreceipt/__init__.py +22 -0
- sdcreceipt-4.0.0/src/sdcreceipt/canonical.py +26 -0
- sdcreceipt-4.0.0/src/sdcreceipt/cli.py +206 -0
- sdcreceipt-4.0.0/src/sdcreceipt/party.py +223 -0
- sdcreceipt-4.0.0/src/sdcreceipt/verify.py +311 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/PKG-INFO +211 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/SOURCES.txt +16 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/dependency_links.txt +1 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/entry_points.txt +2 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/requires.txt +9 -0
- sdcreceipt-4.0.0/src/sdcreceipt.egg-info/top_level.txt +1 -0
- sdcreceipt-4.0.0/tests/test_conformance.py +162 -0
- sdcreceipt-4.0.0/tests/test_roundtrip.py +175 -0
sdcreceipt-4.0.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sdcreceipt
|
|
3
|
+
Version: 4.0.0
|
|
4
|
+
Summary: Verify and settle VSL Settlement Receipts. No account, no network for verification.
|
|
5
|
+
Author: Axius SDC, Inc.
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/SemanticDataCharter/sdcreceipt
|
|
8
|
+
Keywords: vsl,settlement,receipt,xmldsig,rfc8785,sdc
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: sdcgovernance>=4.2.0
|
|
13
|
+
Requires-Dist: cryptography>=42.0
|
|
14
|
+
Provides-Extra: schema
|
|
15
|
+
Requires-Dist: jsonschema>=4.20; extra == "schema"
|
|
16
|
+
Provides-Extra: dev
|
|
17
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
18
|
+
Requires-Dist: jsonschema>=4.20; extra == "dev"
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# sdcreceipt
|
|
22
|
+
|
|
23
|
+
Verify and settle VSL Settlement Receipts.
|
|
24
|
+
|
|
25
|
+
**Verification needs no account, no network, and nothing from the issuer.**
|
|
26
|
+
That is the point of the tool: a claim that anyone can check a Receipt
|
|
27
|
+
independently is worth exactly as much as the ability to do it.
|
|
28
|
+
|
|
29
|
+
Apache-2.0.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pip install sdcreceipt
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Three verbs
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Check a Receipt you were sent. Offline.
|
|
39
|
+
sdcreceipt verify receipt.json --keys issuer-keys.json
|
|
40
|
+
|
|
41
|
+
# Set yourself up as a party: keypair + the document to publish.
|
|
42
|
+
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
|
|
43
|
+
|
|
44
|
+
# Authorize a settlement you are a party to.
|
|
45
|
+
sdcreceipt trigger receipt.json --key vsl-party.pem \
|
|
46
|
+
--key-id https://vendor.example/.well-known/vsl-key.json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
`verify` exits 0 only if every check passed, so it composes in a shell without
|
|
50
|
+
anyone parsing output.
|
|
51
|
+
|
|
52
|
+
There will not be a fourth verb. This is a client, not a product, and its
|
|
53
|
+
value is in being small enough to read.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## If you were sent a Receipt
|
|
58
|
+
|
|
59
|
+
You do not need an account with anyone.
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
pip install sdcreceipt
|
|
63
|
+
curl -O https://sdcstudio.axius-sdc.com/.well-known/sdcstudio-signing-keys.json
|
|
64
|
+
sdcreceipt verify receipt.json --keys sdcstudio-signing-keys.json
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Every check is reported, not just the first failure:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
PASS schema: conforms
|
|
71
|
+
PASS receipt_hash: matches the canonical content
|
|
72
|
+
PASS signature[sdcstudio-signing-key-v1]: verifies over receipt_hash
|
|
73
|
+
PASS trigger[https://vendor.example/.well-known/vsl-key.json]: verifies
|
|
74
|
+
PASS settlement.complete: every listed party has triggered
|
|
75
|
+
|
|
76
|
+
VERIFIED
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
A Receipt carries **hash commitments, never the payload**. So verification
|
|
80
|
+
tells you a conformant, authorized, dual-triggered exchange occurred, without
|
|
81
|
+
anyone having to disclose what was exchanged. If you also hold the payload or
|
|
82
|
+
the governance Receipt, pass them and those get checked too:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
sdcreceipt verify receipt.json --keys keys.json \
|
|
86
|
+
--payload manifest.xml --governance governance-receipt.json
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## If you need to become a party
|
|
90
|
+
|
|
91
|
+
A settlement identifies each party by a `key_id` that **you** control. That is
|
|
92
|
+
deliberate: it means verifying your signature does not route through the
|
|
93
|
+
issuer, so nobody has to stay alive for your old signatures to keep meaning
|
|
94
|
+
something.
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
That writes a private key (mode `0600`) and a key document, and tells you the
|
|
101
|
+
exact URL the document must be reachable at. Publishing one JSON file is the
|
|
102
|
+
whole onboarding requirement.
|
|
103
|
+
|
|
104
|
+
Then, when you are sent a Receipt to authorize:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
sdcreceipt trigger receipt.json --key vsl-party.pem --key-id <your key_id>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
It prints a signed trigger and stops. **Signing is inert; submitting is a side
|
|
111
|
+
effect**, so you send it yourself, or add `--submit <url>`.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## ★ Never take the verification key from the document
|
|
116
|
+
|
|
117
|
+
> The set of keys you will accept is decided **before** you read the document,
|
|
118
|
+
> and the document cannot change it.
|
|
119
|
+
|
|
120
|
+
`ds:RetrievalMethod` in XML-Signature, `jku` and `x5u` in JOSE, and their
|
|
121
|
+
equivalents elsewhere all say *"here is where my key lives."* That pointer was
|
|
122
|
+
written by whoever produced the document, so following it asks the document to
|
|
123
|
+
nominate the key that will judge it. A forged document nominates the forger's
|
|
124
|
+
key and verification "succeeds."
|
|
125
|
+
|
|
126
|
+
The failure is quiet. A pointer can name a domain that was correct when the
|
|
127
|
+
document was signed and has since lapsed; anyone who registers it can serve a
|
|
128
|
+
key at that path, and nothing about the document looks wrong — because nothing
|
|
129
|
+
about it *is* wrong. The verifier was asked where to look and did as it was
|
|
130
|
+
told.
|
|
131
|
+
|
|
132
|
+
This tool cannot make that mistake: `verify` takes keys as arguments and has
|
|
133
|
+
no code path that fetches one. That is a security property, not an
|
|
134
|
+
inconvenience.
|
|
135
|
+
|
|
136
|
+
The same applies to party keys, with a corollary rather than an exemption.
|
|
137
|
+
Those `key_id`s *are* URIs the counterparty controls, deliberately. Resolve
|
|
138
|
+
them over HTTPS only, only for identifiers already recorded in a Receipt you
|
|
139
|
+
trust, and keep a copy — a party who later loses a domain must not be able to
|
|
140
|
+
change what their old signatures mean.
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Conformance
|
|
145
|
+
|
|
146
|
+
`tests/conformance/` ships the issuer's published vectors, and the suite runs
|
|
147
|
+
this implementation against them.
|
|
148
|
+
|
|
149
|
+
Ten vectors. **Every invalid one encodes a defect that was actually made**,
|
|
150
|
+
not a hypothetical: a DER signature where ES256 requires P1363, a signature
|
|
151
|
+
over the hex text of `receipt_hash` rather than its raw bytes, a governance
|
|
152
|
+
binding that does not match the evidence held, a trigger replayed from another
|
|
153
|
+
Receipt sharing the same release condition, and so on. Failing one for the
|
|
154
|
+
wrong reason does not count — the manifest names the check that must break.
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
pytest
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
**On independence, honestly.** Passing these vectors shows this tool agrees
|
|
161
|
+
with the issuer's published expectations, and that it never drifted from them.
|
|
162
|
+
It is *not* an independent re-derivation: this implementation and the issuer's
|
|
163
|
+
share design and history. The vectors are most valuable to someone writing a
|
|
164
|
+
verifier from the specification alone, which is what they are published for.
|
|
165
|
+
|
|
166
|
+
## Building your own
|
|
167
|
+
|
|
168
|
+
You do not have to use this tool, and the specification does not depend on it.
|
|
169
|
+
If you are writing a verifier:
|
|
170
|
+
|
|
171
|
+
**Do not write a second canonicalizer.** Use `sdcgovernance` or another
|
|
172
|
+
conformant RFC 8785 implementation. A second implementation can disagree with
|
|
173
|
+
the first, and the disagreement is silent: the bytes differ, so the hash
|
|
174
|
+
differs, and the artifact reads as tampered with rather than misencoded. This
|
|
175
|
+
tool re-exports `sdcgovernance.jcs` for exactly that reason and adds nothing.
|
|
176
|
+
|
|
177
|
+
**Refuse rather than guess.** Integers beyond ±(2⁵³−1) cannot round-trip
|
|
178
|
+
through an IEEE 754 double, and `NaN`/`Infinity` have no JSON representation.
|
|
179
|
+
Emitting something for those produces a hash that looks fine and fails only in
|
|
180
|
+
someone else's verifier.
|
|
181
|
+
|
|
182
|
+
**Report every check.** Stopping at the first failure hides the case that
|
|
183
|
+
matters most: a Receipt whose signature verifies but whose governance binding
|
|
184
|
+
does not.
|
|
185
|
+
|
|
186
|
+
**Check the curve.** A signature verified against a key on an unexpected curve
|
|
187
|
+
proves nothing about the party you believe signed.
|
|
188
|
+
|
|
189
|
+
## Versioning
|
|
190
|
+
|
|
191
|
+
MAJOR tracks the **SDC reference model**, so a `4.x.x` release targets SDC4.
|
|
192
|
+
It starts at 4 rather than 0 because of that convention, not because there
|
|
193
|
+
were three earlier versions. MINOR is features, PATCH is fixes. An SDC5
|
|
194
|
+
reference model would make this `5.x.x`.
|
|
195
|
+
|
|
196
|
+
The same scheme is used by `sdcvalidator`, `sdcgovernance` and the rest of the
|
|
197
|
+
family, so a version number tells you which reference model an artifact
|
|
198
|
+
targets without looking anything up.
|
|
199
|
+
|
|
200
|
+
Note that the **Receipt format version is separate** and independent: a
|
|
201
|
+
Receipt says `"version": "1.0"`, which is the frozen wire format, not this
|
|
202
|
+
package.
|
|
203
|
+
|
|
204
|
+
## Dependencies
|
|
205
|
+
|
|
206
|
+
`sdcgovernance` for canonicalization and `cryptography` for ECDSA, both
|
|
207
|
+
Apache-2.0-compatible libraries. `jsonschema` is optional and only needed for
|
|
208
|
+
`--schema`.
|
|
209
|
+
|
|
210
|
+
These are **library** dependencies. Nothing here calls a service, and
|
|
211
|
+
`verify` makes no network request at all.
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# sdcreceipt
|
|
2
|
+
|
|
3
|
+
Verify and settle VSL Settlement Receipts.
|
|
4
|
+
|
|
5
|
+
**Verification needs no account, no network, and nothing from the issuer.**
|
|
6
|
+
That is the point of the tool: a claim that anyone can check a Receipt
|
|
7
|
+
independently is worth exactly as much as the ability to do it.
|
|
8
|
+
|
|
9
|
+
Apache-2.0.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install sdcreceipt
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Three verbs
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Check a Receipt you were sent. Offline.
|
|
19
|
+
sdcreceipt verify receipt.json --keys issuer-keys.json
|
|
20
|
+
|
|
21
|
+
# Set yourself up as a party: keypair + the document to publish.
|
|
22
|
+
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
|
|
23
|
+
|
|
24
|
+
# Authorize a settlement you are a party to.
|
|
25
|
+
sdcreceipt trigger receipt.json --key vsl-party.pem \
|
|
26
|
+
--key-id https://vendor.example/.well-known/vsl-key.json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
`verify` exits 0 only if every check passed, so it composes in a shell without
|
|
30
|
+
anyone parsing output.
|
|
31
|
+
|
|
32
|
+
There will not be a fourth verb. This is a client, not a product, and its
|
|
33
|
+
value is in being small enough to read.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## If you were sent a Receipt
|
|
38
|
+
|
|
39
|
+
You do not need an account with anyone.
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install sdcreceipt
|
|
43
|
+
curl -O https://sdcstudio.axius-sdc.com/.well-known/sdcstudio-signing-keys.json
|
|
44
|
+
sdcreceipt verify receipt.json --keys sdcstudio-signing-keys.json
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Every check is reported, not just the first failure:
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
PASS schema: conforms
|
|
51
|
+
PASS receipt_hash: matches the canonical content
|
|
52
|
+
PASS signature[sdcstudio-signing-key-v1]: verifies over receipt_hash
|
|
53
|
+
PASS trigger[https://vendor.example/.well-known/vsl-key.json]: verifies
|
|
54
|
+
PASS settlement.complete: every listed party has triggered
|
|
55
|
+
|
|
56
|
+
VERIFIED
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
A Receipt carries **hash commitments, never the payload**. So verification
|
|
60
|
+
tells you a conformant, authorized, dual-triggered exchange occurred, without
|
|
61
|
+
anyone having to disclose what was exchanged. If you also hold the payload or
|
|
62
|
+
the governance Receipt, pass them and those get checked too:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
sdcreceipt verify receipt.json --keys keys.json \
|
|
66
|
+
--payload manifest.xml --governance governance-receipt.json
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## If you need to become a party
|
|
70
|
+
|
|
71
|
+
A settlement identifies each party by a `key_id` that **you** control. That is
|
|
72
|
+
deliberate: it means verifying your signature does not route through the
|
|
73
|
+
issuer, so nobody has to stay alive for your old signatures to keep meaning
|
|
74
|
+
something.
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
sdcreceipt init --key-id https://vendor.example/.well-known/vsl-key.json
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
That writes a private key (mode `0600`) and a key document, and tells you the
|
|
81
|
+
exact URL the document must be reachable at. Publishing one JSON file is the
|
|
82
|
+
whole onboarding requirement.
|
|
83
|
+
|
|
84
|
+
Then, when you are sent a Receipt to authorize:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
sdcreceipt trigger receipt.json --key vsl-party.pem --key-id <your key_id>
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
It prints a signed trigger and stops. **Signing is inert; submitting is a side
|
|
91
|
+
effect**, so you send it yourself, or add `--submit <url>`.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## ★ Never take the verification key from the document
|
|
96
|
+
|
|
97
|
+
> The set of keys you will accept is decided **before** you read the document,
|
|
98
|
+
> and the document cannot change it.
|
|
99
|
+
|
|
100
|
+
`ds:RetrievalMethod` in XML-Signature, `jku` and `x5u` in JOSE, and their
|
|
101
|
+
equivalents elsewhere all say *"here is where my key lives."* That pointer was
|
|
102
|
+
written by whoever produced the document, so following it asks the document to
|
|
103
|
+
nominate the key that will judge it. A forged document nominates the forger's
|
|
104
|
+
key and verification "succeeds."
|
|
105
|
+
|
|
106
|
+
The failure is quiet. A pointer can name a domain that was correct when the
|
|
107
|
+
document was signed and has since lapsed; anyone who registers it can serve a
|
|
108
|
+
key at that path, and nothing about the document looks wrong — because nothing
|
|
109
|
+
about it *is* wrong. The verifier was asked where to look and did as it was
|
|
110
|
+
told.
|
|
111
|
+
|
|
112
|
+
This tool cannot make that mistake: `verify` takes keys as arguments and has
|
|
113
|
+
no code path that fetches one. That is a security property, not an
|
|
114
|
+
inconvenience.
|
|
115
|
+
|
|
116
|
+
The same applies to party keys, with a corollary rather than an exemption.
|
|
117
|
+
Those `key_id`s *are* URIs the counterparty controls, deliberately. Resolve
|
|
118
|
+
them over HTTPS only, only for identifiers already recorded in a Receipt you
|
|
119
|
+
trust, and keep a copy — a party who later loses a domain must not be able to
|
|
120
|
+
change what their old signatures mean.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Conformance
|
|
125
|
+
|
|
126
|
+
`tests/conformance/` ships the issuer's published vectors, and the suite runs
|
|
127
|
+
this implementation against them.
|
|
128
|
+
|
|
129
|
+
Ten vectors. **Every invalid one encodes a defect that was actually made**,
|
|
130
|
+
not a hypothetical: a DER signature where ES256 requires P1363, a signature
|
|
131
|
+
over the hex text of `receipt_hash` rather than its raw bytes, a governance
|
|
132
|
+
binding that does not match the evidence held, a trigger replayed from another
|
|
133
|
+
Receipt sharing the same release condition, and so on. Failing one for the
|
|
134
|
+
wrong reason does not count — the manifest names the check that must break.
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
pytest
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**On independence, honestly.** Passing these vectors shows this tool agrees
|
|
141
|
+
with the issuer's published expectations, and that it never drifted from them.
|
|
142
|
+
It is *not* an independent re-derivation: this implementation and the issuer's
|
|
143
|
+
share design and history. The vectors are most valuable to someone writing a
|
|
144
|
+
verifier from the specification alone, which is what they are published for.
|
|
145
|
+
|
|
146
|
+
## Building your own
|
|
147
|
+
|
|
148
|
+
You do not have to use this tool, and the specification does not depend on it.
|
|
149
|
+
If you are writing a verifier:
|
|
150
|
+
|
|
151
|
+
**Do not write a second canonicalizer.** Use `sdcgovernance` or another
|
|
152
|
+
conformant RFC 8785 implementation. A second implementation can disagree with
|
|
153
|
+
the first, and the disagreement is silent: the bytes differ, so the hash
|
|
154
|
+
differs, and the artifact reads as tampered with rather than misencoded. This
|
|
155
|
+
tool re-exports `sdcgovernance.jcs` for exactly that reason and adds nothing.
|
|
156
|
+
|
|
157
|
+
**Refuse rather than guess.** Integers beyond ±(2⁵³−1) cannot round-trip
|
|
158
|
+
through an IEEE 754 double, and `NaN`/`Infinity` have no JSON representation.
|
|
159
|
+
Emitting something for those produces a hash that looks fine and fails only in
|
|
160
|
+
someone else's verifier.
|
|
161
|
+
|
|
162
|
+
**Report every check.** Stopping at the first failure hides the case that
|
|
163
|
+
matters most: a Receipt whose signature verifies but whose governance binding
|
|
164
|
+
does not.
|
|
165
|
+
|
|
166
|
+
**Check the curve.** A signature verified against a key on an unexpected curve
|
|
167
|
+
proves nothing about the party you believe signed.
|
|
168
|
+
|
|
169
|
+
## Versioning
|
|
170
|
+
|
|
171
|
+
MAJOR tracks the **SDC reference model**, so a `4.x.x` release targets SDC4.
|
|
172
|
+
It starts at 4 rather than 0 because of that convention, not because there
|
|
173
|
+
were three earlier versions. MINOR is features, PATCH is fixes. An SDC5
|
|
174
|
+
reference model would make this `5.x.x`.
|
|
175
|
+
|
|
176
|
+
The same scheme is used by `sdcvalidator`, `sdcgovernance` and the rest of the
|
|
177
|
+
family, so a version number tells you which reference model an artifact
|
|
178
|
+
targets without looking anything up.
|
|
179
|
+
|
|
180
|
+
Note that the **Receipt format version is separate** and independent: a
|
|
181
|
+
Receipt says `"version": "1.0"`, which is the frozen wire format, not this
|
|
182
|
+
package.
|
|
183
|
+
|
|
184
|
+
## Dependencies
|
|
185
|
+
|
|
186
|
+
`sdcgovernance` for canonicalization and `cryptography` for ECDSA, both
|
|
187
|
+
Apache-2.0-compatible libraries. `jsonschema` is optional and only needed for
|
|
188
|
+
`--schema`.
|
|
189
|
+
|
|
190
|
+
These are **library** dependencies. Nothing here calls a service, and
|
|
191
|
+
`verify` makes no network request at all.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "sdcreceipt"
|
|
7
|
+
version = "4.0.0"
|
|
8
|
+
description = "Verify and settle VSL Settlement Receipts. No account, no network for verification."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = { text = "Apache-2.0" }
|
|
12
|
+
authors = [{ name = "Axius SDC, Inc." }]
|
|
13
|
+
keywords = ["vsl", "settlement", "receipt", "xmldsig", "rfc8785", "sdc"]
|
|
14
|
+
|
|
15
|
+
dependencies = [
|
|
16
|
+
# Canonicalization, reused rather than reimplemented: a second RFC 8785
|
|
17
|
+
# implementation can disagree with the first, and the disagreement is
|
|
18
|
+
# silent. Apache-2.0, and a library dependency, not a service one.
|
|
19
|
+
"sdcgovernance>=4.2.0",
|
|
20
|
+
"cryptography>=42.0",
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
[project.optional-dependencies]
|
|
24
|
+
# Schema checking is optional so `verify` works in an environment that has
|
|
25
|
+
# only the crypto stack.
|
|
26
|
+
schema = ["jsonschema>=4.20"]
|
|
27
|
+
dev = ["pytest>=8.0", "jsonschema>=4.20"]
|
|
28
|
+
|
|
29
|
+
[project.scripts]
|
|
30
|
+
sdcreceipt = "sdcreceipt.cli:main"
|
|
31
|
+
|
|
32
|
+
[project.urls]
|
|
33
|
+
Homepage = "https://github.com/SemanticDataCharter/sdcreceipt"
|
|
34
|
+
|
|
35
|
+
[tool.setuptools.packages.find]
|
|
36
|
+
where = ["src"]
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Copyright (c) 2025, Axius SDC, Inc.
|
|
3
|
+
# Licensed under the Apache License, Version 2.0.
|
|
4
|
+
#
|
|
5
|
+
"""
|
|
6
|
+
sdcreceipt - verify and settle VSL Settlement Receipts.
|
|
7
|
+
|
|
8
|
+
Three verbs and no more: `verify`, `init`, `trigger`. It is a client, not a
|
|
9
|
+
product; the value is in it being small enough to read.
|
|
10
|
+
|
|
11
|
+
`verify` requires no network, no account, and nothing from the issuer.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
#: SDC ecosystem versioning: MAJOR tracks the reference model, so a 4.x.x
|
|
15
|
+
#: release targets SDC4. It starts at 4 rather than 0 for that reason, not
|
|
16
|
+
#: because there were three earlier versions. MINOR is features, PATCH is
|
|
17
|
+
#: fixes. An SDC5 reference model would make this 5.x.x.
|
|
18
|
+
__version__ = "4.0.0"
|
|
19
|
+
|
|
20
|
+
from sdcreceipt.verify import Result, verify # noqa: F401
|
|
21
|
+
|
|
22
|
+
__all__ = ["verify", "Result", "__version__"]
|