@prson/login-verifier 0.0.0-stage → 0.1.0
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.
- package/LICENSE +202 -0
- package/README.md +246 -2
- package/dist/index.d.ts +172 -0
- package/dist/index.js +602 -0
- package/dist/notify.d.ts +48 -0
- package/dist/notify.js +46 -0
- package/dist/status.d.ts +50 -0
- package/dist/status.js +105 -0
- package/dist/verdict.d.ts +84 -0
- package/dist/verdict.js +117 -0
- package/package.json +53 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,247 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @prson/login-verifier
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Pure-function Node.js verifier for SD-JWT-VC presentations issued
|
|
4
|
+
> by the Prson notary. **Drop-in**: no Prson API key, no live
|
|
5
|
+
> network call beyond fetching the publicly-served notary JWKS
|
|
6
|
+
> (cached aggressively). Verifies via standard IETF SD-JWT + SD-JWT-VC
|
|
7
|
+
> primitives, so this code reads like spec.
|
|
8
|
+
>
|
|
9
|
+
> See [`../../README.md`](../../README.md) for the system overview,
|
|
10
|
+
> [`../../ARCHITECTURE.md`](../../ARCHITECTURE.md) for the wire
|
|
11
|
+
> format, [`../../SECURITY.md` §7](../../SECURITY.md#7-the-five-rules-a-verifier-must-enforce)
|
|
12
|
+
> for the five rules every verifier must enforce.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @prson/login-verifier
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Node 20 or later. This package is server-side only and has no browser
|
|
21
|
+
bundle.
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install @prson/login-verifier
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## API
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { verifyPresentation, VerifyOptions, VerifyResult } from "@prson/login-verifier";
|
|
31
|
+
|
|
32
|
+
const result: VerifyResult = await verifyPresentation(presentation, {
|
|
33
|
+
expectedAudience: "https://example.com",
|
|
34
|
+
expectedNonce: "the-nonce-you-generated",
|
|
35
|
+
|
|
36
|
+
// Optional knobs:
|
|
37
|
+
maxKbJwtAgeSeconds: 60, // default 60
|
|
38
|
+
trustedIssuer: "did:web:app.prson.net", // default
|
|
39
|
+
jwksUri: "https://app.prson.net/.well-known/jwt-vc-issuer", // default
|
|
40
|
+
fetch: globalThis.fetch, // default
|
|
41
|
+
jwksCacheTtlMs: 60 * 60 * 1000, // default 1h
|
|
42
|
+
acceptedVcts: [ // default: these two
|
|
43
|
+
"https://app.prson.net/credentials/verified-human/v1",
|
|
44
|
+
"https://app.prson.net/credentials/verified-identity/v1",
|
|
45
|
+
],
|
|
46
|
+
status: { // revocation (Token Status List)
|
|
47
|
+
onUnavailable: "fail-closed", // default: closed at level 5+, open below
|
|
48
|
+
cacheSeconds: 60, // default 60
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
if (!result.ok) {
|
|
53
|
+
// result.reason is a VerifyFailureReason (see the table below);
|
|
54
|
+
// result.detail, when present, is a human-readable hint for your logs.
|
|
55
|
+
return res.status(401).send(result.reason);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const userId = result.prsonId; // the person's Prson ID on this site
|
|
59
|
+
const claims = result.claims; // disclosed claim values
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
What `verifyPresentation` checks, in order: the issuer JWS header `typ`
|
|
63
|
+
is `dc+sd-jwt` (SD-JWT VC, current draft) or the older `vc+sd-jwt`;
|
|
64
|
+
`iss` is the trusted issuer; `vct` is accepted; `exp` is present and in
|
|
65
|
+
the future (`nbf`, if set, is not more than 30 s ahead); the RS256
|
|
66
|
+
signature against the issuer's published key (by `kid`); the
|
|
67
|
+
credential's Token Status List entry (not revoked); every disclosure is
|
|
68
|
+
bound by `_sd`; and the key-binding JWT (`typ: kb+jwt`, EdDSA, signed by
|
|
69
|
+
`cnf.jwk`) carries your audience and nonce, a fresh `iat`, and the
|
|
70
|
+
`sd_hash` of the presentation.
|
|
71
|
+
|
|
72
|
+
### Failure reasons (`VerifyFailureReason`)
|
|
73
|
+
|
|
74
|
+
| `reason` | Meaning |
|
|
75
|
+
|---|---|
|
|
76
|
+
| `malformed` | Not a parseable SD-JWT presentation (shape, JSON, disclosure, missing `exp`). |
|
|
77
|
+
| `typ_not_accepted` | The issuer JWS `typ` is not `dc+sd-jwt` or `vc+sd-jwt`. |
|
|
78
|
+
| `issuer_key_resolve_failed` | `iss` is not the trusted issuer, there is no `kid`, or the key couldn't be fetched. |
|
|
79
|
+
| `issuer_sig_invalid` | The issuer signature does not verify. |
|
|
80
|
+
| `vc_expired` | The credential's `exp` has passed. |
|
|
81
|
+
| `vc_not_yet_valid` | The credential's `nbf` is in the future. |
|
|
82
|
+
| `vct_not_accepted` | `vct` is not in `acceptedVcts`. |
|
|
83
|
+
| `disclosure_unmatched` | A disclosure's digest is not in the credential's `_sd`. |
|
|
84
|
+
| `kb_missing` | No key-binding JWT, or no `cnf.jwk` (Ed25519) to check it against. |
|
|
85
|
+
| `kb_sig_invalid` | The key-binding JWT is malformed, wrongly typed or its signature fails. |
|
|
86
|
+
| `aud_mismatch` | The key-binding JWT's `aud` is not `expectedAudience`. |
|
|
87
|
+
| `nonce_mismatch` | The key-binding JWT's `nonce` is not `expectedNonce`. |
|
|
88
|
+
| `sd_hash_mismatch` | The key-binding JWT doesn't cover this exact presentation. |
|
|
89
|
+
| `kb_iat_stale` | The key-binding JWT is older than `maxKbJwtAgeSeconds` (or from the future). |
|
|
90
|
+
| `vc_revoked` | The issuer's status list marks the credential invalid or suspended. |
|
|
91
|
+
| `status_unavailable` | The status list couldn't be fetched or verified and the policy is `fail-closed` (or the status reference is malformed). |
|
|
92
|
+
|
|
93
|
+
## Predicate facts and unique-human ids
|
|
94
|
+
|
|
95
|
+
Facts ("age ≥ 18", "document not expired") are standalone signed
|
|
96
|
+
claims, not sign-in proofs: no key binding or nonce; their replay
|
|
97
|
+
protection is a short expiry plus, for audience-scoped facts, the
|
|
98
|
+
domain they are bound to. All three functions below take
|
|
99
|
+
`FragmentVerifyOptions`: `expectedAudience` (your host; required for
|
|
100
|
+
audience-scoped facts and always for unique-human ids), `trustedIssuer`,
|
|
101
|
+
`jwksUri`, `fetch`, `jwksCacheTtlMs`, `acceptedPredicateVcts` (default
|
|
102
|
+
`["https://app.prson.net/credentials/predicate/v1"]`) and `now` (tests).
|
|
103
|
+
They resolve to `FragmentVerifyResult` (or `UniqueHumanIdVerifyResult`):
|
|
104
|
+
`{ ok: true, fragmentId, value, propertyHash, propertyType, identityId,
|
|
105
|
+
signedAt, expiresAt, kid, … }` or `{ ok: false, reason, detail? }`
|
|
106
|
+
with `reason` one of `malformed`, `issuer_key_resolve_failed`,
|
|
107
|
+
`issuer_sig_invalid`, `expired`, `vct_not_accepted`,
|
|
108
|
+
`unsupported_format`, `audience_mismatch`.
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
import {
|
|
112
|
+
verifyFragmentCredential,
|
|
113
|
+
verifySignedFragment,
|
|
114
|
+
verifyUniqueHumanId,
|
|
115
|
+
} from "@prson/login-verifier";
|
|
116
|
+
|
|
117
|
+
// A JWT-shaped fact (string). The JWS `typ` picks the format:
|
|
118
|
+
// "vc+jwt" → a W3C VC Data Model 2.0 credential (@context
|
|
119
|
+
// https://www.w3.org/ns/credentials/v2, type
|
|
120
|
+
// ["VerifiableCredential", "PrsonPredicateCredential"]);
|
|
121
|
+
// the fact is in credentialSubject.
|
|
122
|
+
// "dc+sd-jwt" → an SD-JWT VC whose vct is accepted; the fact is the
|
|
123
|
+
// disclosure appended after "~".
|
|
124
|
+
// Anything else → reason "unsupported_format". Both need iss, a kid,
|
|
125
|
+
// an exp in the future and a valid RS256 signature.
|
|
126
|
+
const fact = await verifyFragmentCredential(credential, { expectedAudience: "shop.example.com" });
|
|
127
|
+
// fact.format: "vc+jwt" | "vc+sd-jwt"
|
|
128
|
+
|
|
129
|
+
// Prson's native fact object ({ fragmentId, value, propertyHash,
|
|
130
|
+
// propertyType, identityId, audience?, signedAt, expiresAt, signature, kid }):
|
|
131
|
+
// RSA-SHA256 over the colon-joined fields (plus ":aud:<host>" when scoped).
|
|
132
|
+
const native = await verifySignedFragment(fragment, { expectedAudience: "shop.example.com" });
|
|
133
|
+
// native.format: "native"
|
|
134
|
+
|
|
135
|
+
// "One unique, document-verified human at your domain":
|
|
136
|
+
// { envelope: { scope: "prson-unique-human/1", audience, uniqueIdHash, … }, signature, kid }.
|
|
137
|
+
// Checks scope, audience (must equal expectedAudience), expiry and the
|
|
138
|
+
// signature over the canonical (sorted-keys) envelope.
|
|
139
|
+
const unique = await verifyUniqueHumanId(credential, { expectedAudience: "shop.example.com" });
|
|
140
|
+
if (unique.ok) useAsAccountKey(unique.uniqueIdHash); // pairwise: stable here only
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
`resolveIssuerKey(kid, opts?)` fetches (and caches) an issuer key, e.g.
|
|
144
|
+
to pre-warm the cache.
|
|
145
|
+
|
|
146
|
+
## Revocation on its own: `checkCredentialStatus`
|
|
147
|
+
|
|
148
|
+
`verifyPresentation` already checks revocation. To check a credential
|
|
149
|
+
payload you decoded yourself:
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
import { checkCredentialStatus, clearStatusCache } from "@prson/login-verifier";
|
|
153
|
+
|
|
154
|
+
const r = await checkCredentialStatus(payload /* the decoded JWT claims */, {
|
|
155
|
+
resolveKey: async (kid) => issuerJwkFor(kid), // the issuer's JWK, or null
|
|
156
|
+
onUnavailable: "fail-closed", // default: closed at level 5+ / verified_human, open below
|
|
157
|
+
cacheSeconds: 60, // default 60, never longer than the list's ttl
|
|
158
|
+
// fetch, now: overrides for tests
|
|
159
|
+
});
|
|
160
|
+
// { ok: true, checked: true } — listed as valid
|
|
161
|
+
// { ok: true, checked: false, unavailable?: string } — no status claim, or fail-open
|
|
162
|
+
// { ok: false, reason: "vc_revoked" | "status_unavailable", detail? }
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
It reads `status.status_list.{idx, uri}`, fetches the Token Status List
|
|
166
|
+
token (`typ: statuslist+jwt`, signed by the issuer key) and reads the
|
|
167
|
+
entry: 0 is valid, 1 invalid, 2 suspended. `clearStatusCache()` forgets
|
|
168
|
+
cached lists.
|
|
169
|
+
|
|
170
|
+
## Express middleware example
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
import express from "express";
|
|
174
|
+
import { verifyPresentation } from "@prson/login-verifier";
|
|
175
|
+
import crypto from "node:crypto";
|
|
176
|
+
|
|
177
|
+
const app = express();
|
|
178
|
+
app.use(express.json());
|
|
179
|
+
|
|
180
|
+
app.get("/api/nonce", (req, res) => {
|
|
181
|
+
// Mint a single-use nonce and stash it in the session for the
|
|
182
|
+
// /api/login round-trip. The SDK passes this same nonce to the
|
|
183
|
+
// wallet via the QR / deep-link.
|
|
184
|
+
const nonce = crypto.randomBytes(32).toString("base64url");
|
|
185
|
+
req.session.prsonNonce = nonce;
|
|
186
|
+
res.json({ nonce });
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
app.post("/api/login", async (req, res) => {
|
|
190
|
+
const result = await verifyPresentation(req.body.presentation, {
|
|
191
|
+
expectedAudience: `https://${req.hostname}`,
|
|
192
|
+
expectedNonce: req.session.prsonNonce,
|
|
193
|
+
});
|
|
194
|
+
if (!result.ok) return res.status(401).json({ error: result.reason });
|
|
195
|
+
|
|
196
|
+
// Single-use nonce — discard so a replay can't reuse it.
|
|
197
|
+
delete req.session.prsonNonce;
|
|
198
|
+
|
|
199
|
+
req.session.userId = result.prsonId;
|
|
200
|
+
req.session.expiresAt = result.credential.expiresAt;
|
|
201
|
+
res.json({ ok: true, claims: result.claims });
|
|
202
|
+
});
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## Proof verdicts (`prson-truth-verdict/2`)
|
|
206
|
+
|
|
207
|
+
A verification answer (`GET /v1/verifications/:id`, its webhooks) carries
|
|
208
|
+
Prson's signed verdict and the values it covers:
|
|
209
|
+
|
|
210
|
+
```ts
|
|
211
|
+
import { verifyVerdict } from "@prson/login-verifier";
|
|
212
|
+
|
|
213
|
+
// response.verdict_signature = { envelope, signature, kid }
|
|
214
|
+
// response.verdict_disclosures = [[salt, kind, id, value], ...]
|
|
215
|
+
const keys = (await (await fetch("https://api.prson.net/v1/company/public-key")).json())
|
|
216
|
+
.verificationKeys.map((k: { kid: string; publicKey: string }) => ({ kid: k.kid, publicKey: k.publicKey }));
|
|
217
|
+
const { envelope, signature, kid } = response.verdict_signature;
|
|
218
|
+
const result = verifyVerdict(envelope, signature, response.verdict_disclosures, { keys, kid });
|
|
219
|
+
// result.ok: the signature checks and every value is one Prson signed.
|
|
220
|
+
// result.disclosures: [{ kind, id, value, verified, reason? }] per value.
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
The envelope holds one `{kind, id, digest}` per disclosed item (`kind`:
|
|
224
|
+
`fact`, `property` or `document_field`), with
|
|
225
|
+
`digest = base64url(SHA-256(canonicalJson([salt, kind, id, value])))`; the
|
|
226
|
+
16-byte random salt means the envelope alone reveals no value. Keep the
|
|
227
|
+
envelope, signature and disclosures together and anyone can re-check them
|
|
228
|
+
offline later. `opts` takes `publicKey` (SPKI PEM, JWK or `KeyObject`) or
|
|
229
|
+
`keys: [{kid, publicKey}]` plus the seal's `kid`. A `prson-truth-verdict/1`
|
|
230
|
+
envelope (made before verdicts covered values) can still have a valid
|
|
231
|
+
signature, but no value verifies against it (`reason: "not-covered"`).
|
|
232
|
+
`verdictDisclosureDigest(d)` and `canonicalJson(v)` are exported too.
|
|
233
|
+
|
|
234
|
+
## Website notifications
|
|
235
|
+
|
|
236
|
+
`readNotifyHandle(body)` reads the handle the browser SDK returned
|
|
237
|
+
(`signIn({ notifications: true })`); keep it on the account you just verified.
|
|
238
|
+
`sendNotification({ apiKey, handle, title, body, url? })` posts to
|
|
239
|
+
`/v1/notify` (an API key with `notify:write`); `revoked: true` (410) means
|
|
240
|
+
the person turned your site off. See `documentation/SITE_NOTIFICATIONS.md`.
|
|
241
|
+
|
|
242
|
+
## Build status
|
|
243
|
+
|
|
244
|
+
Implemented on [`jose`](https://github.com/panva/jose) and `node:crypto`;
|
|
245
|
+
tests: `npm test` (unit tests plus `test/*.test.ts`, which check real
|
|
246
|
+
credential shapes). See
|
|
247
|
+
[`../../CHANGELOG.md`](../../CHANGELOG.md).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import { type StatusPolicy } from "./status.js";
|
|
2
|
+
export { checkCredentialStatus, clearStatusCache, type StatusCheckOptions, type StatusCheckResult, type StatusPolicy } from "./status.js";
|
|
3
|
+
export { NOTIFY_HANDLE, readNotifyHandle, sendNotification, type SendNotificationOptions, type SendNotificationResult, } from "./notify.js";
|
|
4
|
+
export { canonicalJson, verdictDisclosureDigest, verifyVerdict, VERDICT_SCOPE_V1, VERDICT_SCOPE_V2, } from "./verdict.js";
|
|
5
|
+
export type { VerdictDisclosure, VerdictDisclosureKind, VerdictEnvelope, VerdictPublicKey, VerifiedDisclosure, VerifyVerdictOptions, VerifyVerdictResult, } from "./verdict.js";
|
|
6
|
+
type FetchLike = (input: string, init?: {
|
|
7
|
+
headers?: Record<string, string>;
|
|
8
|
+
}) => Promise<{
|
|
9
|
+
ok: boolean;
|
|
10
|
+
status: number;
|
|
11
|
+
json(): Promise<unknown>;
|
|
12
|
+
}>;
|
|
13
|
+
export type VerifyOptions = {
|
|
14
|
+
expectedAudience: string;
|
|
15
|
+
expectedNonce: string;
|
|
16
|
+
maxKbJwtAgeSeconds?: number;
|
|
17
|
+
trustedIssuer?: string;
|
|
18
|
+
jwksUri?: string;
|
|
19
|
+
fetch?: FetchLike;
|
|
20
|
+
jwksCacheTtlMs?: number;
|
|
21
|
+
acceptedVcts?: readonly string[];
|
|
22
|
+
/**
|
|
23
|
+
* Revocation (the credential's Token Status List entry, status.ts).
|
|
24
|
+
* onUnavailable: when the list can't be fetched or verified; default
|
|
25
|
+
* "fail-closed" for verified humans (level 5+), "fail-open" below.
|
|
26
|
+
* cacheSeconds: how long a list is reused (default 60).
|
|
27
|
+
*/
|
|
28
|
+
status?: {
|
|
29
|
+
onUnavailable?: StatusPolicy;
|
|
30
|
+
cacheSeconds?: number;
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export type VerifyFailureReason = "malformed" | "issuer_key_resolve_failed" | "issuer_sig_invalid" | "vc_expired" | "vc_not_yet_valid" | "vct_not_accepted" | "typ_not_accepted" | "disclosure_unmatched" | "kb_missing" | "kb_sig_invalid" | "aud_mismatch" | "nonce_mismatch" | "sd_hash_mismatch" | "kb_iat_stale" | "vc_revoked" | "status_unavailable";
|
|
34
|
+
export type VerifyResult = {
|
|
35
|
+
ok: false;
|
|
36
|
+
reason: VerifyFailureReason;
|
|
37
|
+
detail?: string;
|
|
38
|
+
} | {
|
|
39
|
+
ok: true;
|
|
40
|
+
/**
|
|
41
|
+
* The person's Prson ID for your site: stable across sign-ins, different
|
|
42
|
+
* on every other site, so sites can't link people. Use it as the user id
|
|
43
|
+
* in your database. (It is the wallet's per-site key, `cnf.jwk.x`.)
|
|
44
|
+
*/
|
|
45
|
+
prsonId: string;
|
|
46
|
+
claims: Record<string, unknown>;
|
|
47
|
+
cnf: {
|
|
48
|
+
jwk: {
|
|
49
|
+
kty: "OKP";
|
|
50
|
+
crv: "Ed25519";
|
|
51
|
+
x: string;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
credential: {
|
|
55
|
+
vct: string;
|
|
56
|
+
iss: string;
|
|
57
|
+
kid: string;
|
|
58
|
+
iat: number;
|
|
59
|
+
expiresAt: number;
|
|
60
|
+
};
|
|
61
|
+
disclosedClaimNames: string[];
|
|
62
|
+
};
|
|
63
|
+
export declare function verifyPresentation(presentation: string, opts: VerifyOptions): Promise<VerifyResult>;
|
|
64
|
+
export type SignedFragmentNative = {
|
|
65
|
+
fragmentId: string;
|
|
66
|
+
value: boolean | number | string;
|
|
67
|
+
description?: string;
|
|
68
|
+
propertyHash: string;
|
|
69
|
+
propertyType: string;
|
|
70
|
+
identityId: string;
|
|
71
|
+
/**
|
|
72
|
+
* Present on audience-scoped (pairwise) fragments. When set,
|
|
73
|
+
* `propertyHash` and `identityId` are pairwise identifiers derived
|
|
74
|
+
* for THIS domain only — stable here, uncorrelatable anywhere else —
|
|
75
|
+
* and the signature canonical carries an `:aud:<host>` suffix.
|
|
76
|
+
*/
|
|
77
|
+
audience?: string;
|
|
78
|
+
signedAt: string;
|
|
79
|
+
expiresAt: string;
|
|
80
|
+
signature: string;
|
|
81
|
+
kid?: string;
|
|
82
|
+
};
|
|
83
|
+
export type FragmentVerifyOptions = Pick<VerifyOptions, "jwksUri" | "fetch" | "jwksCacheTtlMs" | "trustedIssuer"> & {
|
|
84
|
+
acceptedPredicateVcts?: readonly string[];
|
|
85
|
+
/**
|
|
86
|
+
* Your domain (host). REQUIRED to accept audience-scoped fragments:
|
|
87
|
+
* the fragment's `audience` must equal this value or verification
|
|
88
|
+
* fails with `audience_mismatch` (a pairwise fragment minted for
|
|
89
|
+
* another relying party must never verify here). Legacy fragments
|
|
90
|
+
* (no `audience` field) are unaffected.
|
|
91
|
+
*/
|
|
92
|
+
expectedAudience?: string;
|
|
93
|
+
/** Override the current time, for deterministic tests. */
|
|
94
|
+
now?: Date;
|
|
95
|
+
};
|
|
96
|
+
export type FragmentVerifyFailureReason = "malformed" | "issuer_key_resolve_failed" | "issuer_sig_invalid" | "expired" | "vct_not_accepted" | "unsupported_format" | "audience_mismatch";
|
|
97
|
+
export type FragmentVerifyResult = {
|
|
98
|
+
ok: false;
|
|
99
|
+
reason: FragmentVerifyFailureReason;
|
|
100
|
+
detail?: string;
|
|
101
|
+
} | {
|
|
102
|
+
ok: true;
|
|
103
|
+
format: "native" | "vc+jwt" | "vc+sd-jwt";
|
|
104
|
+
fragmentId: string;
|
|
105
|
+
value: boolean | number | string;
|
|
106
|
+
propertyHash: string;
|
|
107
|
+
propertyType: string;
|
|
108
|
+
identityId: string;
|
|
109
|
+
signedAt: string;
|
|
110
|
+
expiresAt: string;
|
|
111
|
+
description?: string;
|
|
112
|
+
kid: string;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Verify a Prson-native signed fragment. The signature is RSA-SHA256
|
|
116
|
+
* over the colon-delimited canonical string
|
|
117
|
+
* `${propertyHash}:${fragmentId}:${value}:${identityId}:${signedAt}:${expiresAt}`
|
|
118
|
+
* — identical bytes to what the server signed in
|
|
119
|
+
* `functions/utils/predicateFormatters.js#formatNative`.
|
|
120
|
+
*/
|
|
121
|
+
export declare function verifySignedFragment(fragment: SignedFragmentNative, opts?: FragmentVerifyOptions): Promise<FragmentVerifyResult>;
|
|
122
|
+
/**
|
|
123
|
+
* Verify a JWT-shaped signed fragment. Detects the variant from the
|
|
124
|
+
* JWS `typ` header:
|
|
125
|
+
*
|
|
126
|
+
* * `vc+jwt` — plain W3C VC Data Model 2.0 JWS. The predicate sits
|
|
127
|
+
* in `credentialSubject`.
|
|
128
|
+
* * `sd-jwt` — IETF SD-JWT-VC. The disclosure (joined by `~`) is
|
|
129
|
+
* hashed and matched against `_sd[0]`.
|
|
130
|
+
*
|
|
131
|
+
* Anything else fails with `unsupported_format`.
|
|
132
|
+
*/
|
|
133
|
+
export declare function verifyFragmentCredential(credential: string, opts?: FragmentVerifyOptions): Promise<FragmentVerifyResult>;
|
|
134
|
+
/**
|
|
135
|
+
* Resolve a Prson notary issuer JWK by `kid` against the published
|
|
136
|
+
* JWKS. Exposed separately so verifiers can pre-warm the cache.
|
|
137
|
+
*/
|
|
138
|
+
export declare function resolveIssuerKey(kid: string, opts?: Pick<VerifyOptions, "jwksUri" | "fetch" | "jwksCacheTtlMs" | "trustedIssuer">): Promise<unknown | null>;
|
|
139
|
+
export type UniqueHumanIdEnvelope = {
|
|
140
|
+
scope: "prson-unique-human/1";
|
|
141
|
+
audience: string;
|
|
142
|
+
uniqueIdHash: string;
|
|
143
|
+
trustTier: "nfc" | "mrz";
|
|
144
|
+
verificationLevel: number;
|
|
145
|
+
documentType: string | null;
|
|
146
|
+
issuingCountry: string | null;
|
|
147
|
+
signedAt: string;
|
|
148
|
+
expiresAt: string;
|
|
149
|
+
};
|
|
150
|
+
export type UniqueHumanIdCredential = {
|
|
151
|
+
envelope: UniqueHumanIdEnvelope;
|
|
152
|
+
signature: string;
|
|
153
|
+
kid: string;
|
|
154
|
+
};
|
|
155
|
+
export type UniqueHumanIdVerifyResult = {
|
|
156
|
+
ok: false;
|
|
157
|
+
reason: FragmentVerifyFailureReason;
|
|
158
|
+
detail?: string;
|
|
159
|
+
} | {
|
|
160
|
+
ok: true;
|
|
161
|
+
uniqueIdHash: string;
|
|
162
|
+
envelope: UniqueHumanIdEnvelope;
|
|
163
|
+
kid: string;
|
|
164
|
+
};
|
|
165
|
+
/**
|
|
166
|
+
* Verify a unique-human-id credential. Checks, in order: shape, scope,
|
|
167
|
+
* audience binding (must equal YOUR host — pass `expectedAudience`),
|
|
168
|
+
* expiry, and the notary RSA-SHA256 signature against the published
|
|
169
|
+
* JWKS (kid-pinned). On success, `uniqueIdHash` is safe to use as the
|
|
170
|
+
* per-domain uniqueness key.
|
|
171
|
+
*/
|
|
172
|
+
export declare function verifyUniqueHumanId(credential: UniqueHumanIdCredential, opts?: FragmentVerifyOptions): Promise<UniqueHumanIdVerifyResult>;
|