burnledger 0.4.0 → 0.6.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/README.md +11 -4
- package/dist/cjs/anchor.d.ts +71 -0
- package/dist/cjs/anchor.d.ts.map +1 -0
- package/dist/cjs/anchor.js +279 -0
- package/dist/cjs/anchor.js.map +1 -0
- package/dist/cjs/client.d.ts +26 -2
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +27 -5
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/enclave-seal.d.ts +101 -0
- package/dist/cjs/enclave-seal.d.ts.map +1 -0
- package/dist/cjs/enclave-seal.js +479 -0
- package/dist/cjs/enclave-seal.js.map +1 -0
- package/dist/cjs/errors.d.ts +42 -1
- package/dist/cjs/errors.d.ts.map +1 -1
- package/dist/cjs/errors.js +44 -2
- package/dist/cjs/errors.js.map +1 -1
- package/dist/cjs/http.d.ts +21 -1
- package/dist/cjs/http.d.ts.map +1 -1
- package/dist/cjs/http.js +76 -12
- package/dist/cjs/http.js.map +1 -1
- package/dist/cjs/index.browser.d.ts +2 -4
- package/dist/cjs/index.browser.d.ts.map +1 -1
- package/dist/cjs/index.browser.js.map +1 -1
- package/dist/cjs/index.d.ts +16 -11
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +20 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/keys.d.ts +66 -0
- package/dist/cjs/keys.d.ts.map +1 -1
- package/dist/cjs/keys.js +128 -3
- package/dist/cjs/keys.js.map +1 -1
- package/dist/cjs/models.d.ts +41 -3
- package/dist/cjs/models.d.ts.map +1 -1
- package/dist/cjs/models.js +25 -4
- package/dist/cjs/models.js.map +1 -1
- package/dist/cjs/verify.d.ts +72 -6
- package/dist/cjs/verify.d.ts.map +1 -1
- package/dist/cjs/verify.js +392 -62
- package/dist/cjs/verify.js.map +1 -1
- package/dist/cjs/web-verifier.d.ts +54 -5
- package/dist/cjs/web-verifier.d.ts.map +1 -1
- package/dist/cjs/web-verifier.js +36 -3
- package/dist/cjs/web-verifier.js.map +1 -1
- package/dist/esm/anchor.d.ts +71 -0
- package/dist/esm/anchor.d.ts.map +1 -0
- package/dist/esm/anchor.js +275 -0
- package/dist/esm/anchor.js.map +1 -0
- package/dist/esm/cli.d.ts +45 -14
- package/dist/esm/cli.d.ts.map +1 -1
- package/dist/esm/cli.js +357 -50
- package/dist/esm/cli.js.map +1 -1
- package/dist/esm/client.d.ts +26 -2
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +27 -5
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/enclave-seal.d.ts +101 -0
- package/dist/esm/enclave-seal.d.ts.map +1 -0
- package/dist/esm/enclave-seal.js +472 -0
- package/dist/esm/enclave-seal.js.map +1 -0
- package/dist/esm/errors.d.ts +42 -1
- package/dist/esm/errors.d.ts.map +1 -1
- package/dist/esm/errors.js +43 -1
- package/dist/esm/errors.js.map +1 -1
- package/dist/esm/http.d.ts +21 -1
- package/dist/esm/http.d.ts.map +1 -1
- package/dist/esm/http.js +75 -12
- package/dist/esm/http.js.map +1 -1
- package/dist/esm/index.browser.d.ts +2 -4
- package/dist/esm/index.browser.d.ts.map +1 -1
- package/dist/esm/index.browser.js.map +1 -1
- package/dist/esm/index.d.ts +16 -11
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +11 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/keys.d.ts +66 -0
- package/dist/esm/keys.d.ts.map +1 -1
- package/dist/esm/keys.js +125 -3
- package/dist/esm/keys.js.map +1 -1
- package/dist/esm/models.d.ts +41 -3
- package/dist/esm/models.d.ts.map +1 -1
- package/dist/esm/models.js +24 -4
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/verify.d.ts +72 -6
- package/dist/esm/verify.d.ts.map +1 -1
- package/dist/esm/verify.js +390 -63
- package/dist/esm/verify.js.map +1 -1
- package/dist/esm/web-verifier.d.ts +54 -5
- package/dist/esm/web-verifier.d.ts.map +1 -1
- package/dist/esm/web-verifier.js +40 -3
- package/dist/esm/web-verifier.js.map +1 -1
- package/package.json +1 -1
- package/src/anchor.ts +330 -0
- package/src/cli.ts +389 -54
- package/src/client.ts +46 -4
- package/src/enclave-seal.ts +582 -0
- package/src/errors.ts +47 -2
- package/src/http.ts +79 -12
- package/src/index.browser.ts +2 -2
- package/src/index.ts +28 -9
- package/src/keys.ts +176 -3
- package/src/models.ts +72 -7
- package/src/verify.ts +467 -72
- package/src/web-verifier.ts +58 -5
package/src/cli.ts
CHANGED
|
@@ -6,57 +6,97 @@ import { readFile } from "node:fs/promises";
|
|
|
6
6
|
import { realpathSync } from "node:fs";
|
|
7
7
|
import { fileURLToPath } from "node:url";
|
|
8
8
|
import { nodeCrypto } from "./crypto-node.js";
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
9
|
+
import { CERTIFICATE_REVOKED, VerificationError } from "./errors.js";
|
|
10
|
+
import {
|
|
11
|
+
formatTimestamp,
|
|
12
|
+
publicKeyFromHex,
|
|
13
|
+
verifyCertificateWithStatus,
|
|
14
|
+
verifyTransparency,
|
|
15
|
+
VALID_REVOCATION_UNKNOWN,
|
|
16
|
+
} from "./verify.js";
|
|
17
|
+
import {
|
|
18
|
+
KEY_LIST_STALE,
|
|
19
|
+
KEY_LIST_VALID,
|
|
20
|
+
parseKeyListDocument,
|
|
21
|
+
verifyKeyList,
|
|
22
|
+
type KeyEntry,
|
|
23
|
+
type KeyListEvidence,
|
|
24
|
+
} from "./keys.js";
|
|
25
|
+
import { ANCHOR_INCONSISTENT, checkStatementAnchor, type AnchorResult } from "./anchor.js";
|
|
11
26
|
import type { PublicKeyInfo } from "./verify.js";
|
|
12
27
|
|
|
13
28
|
type Cert = Record<string, unknown>;
|
|
14
|
-
|
|
29
|
+
/** A published status statement, exactly as GET /v1/certificates/{id}/status
|
|
30
|
+
* serves it: hex strings, not decoded bytes. verifyCertificateWithStatus reads
|
|
31
|
+
* this shape, so nothing here re-encodes a field the signature covers. */
|
|
32
|
+
type StatusStatement = Record<string, unknown>;
|
|
33
|
+
const USAGE = "Usage: burnledger check --cert <file> --keys <file> [--online --api-url <url>]\n";
|
|
15
34
|
|
|
16
35
|
function die(msg: string): never { process.stderr.write(msg); process.exit(2); }
|
|
17
36
|
|
|
18
37
|
function parseArgs(argv: string[]): {
|
|
19
|
-
certPath: string; keysPath: string; online: boolean; apiUrl: string;
|
|
38
|
+
certPath: string; keysPath: string; online: boolean; apiUrl: string;
|
|
20
39
|
} {
|
|
21
40
|
const args = argv.slice(2);
|
|
22
41
|
if (args[0] !== "check") die(USAGE);
|
|
23
|
-
let certPath = "", keysPath = "", online = false, apiUrl = ""
|
|
42
|
+
let certPath = "", keysPath = "", online = false, apiUrl = "";
|
|
24
43
|
for (let i = 1; i < args.length; i++) {
|
|
25
44
|
const a = args[i]!;
|
|
26
45
|
if (a === "--cert") { certPath = args[++i] ?? die("--cert requires a value\n"); }
|
|
27
46
|
else if (a === "--keys") { keysPath = args[++i] ?? die("--keys requires a value\n"); }
|
|
28
47
|
else if (a === "--online") { online = true; }
|
|
29
48
|
else if (a === "--api-url") { apiUrl = args[++i] ?? die("--api-url requires a value\n"); }
|
|
30
|
-
|
|
49
|
+
// Accepted and ignored. The status endpoint is unauthenticated, so the key
|
|
50
|
+
// buys nothing — but it is a published flag that scripts already pass, and
|
|
51
|
+
// failing on an unknown flag would break them for no gain.
|
|
52
|
+
else if (a === "--api-key") { void (args[++i] ?? die("--api-key requires a value\n")); }
|
|
31
53
|
else die(`Unknown argument: ${a}\n`);
|
|
32
54
|
}
|
|
33
55
|
if (!certPath || !keysPath) die("Both --cert and --keys are required.\n");
|
|
34
56
|
if (online) {
|
|
35
57
|
try {
|
|
36
|
-
|
|
58
|
+
apiUrl = resolveApiBaseUrl(apiUrl, process.env);
|
|
37
59
|
} catch (e) {
|
|
38
60
|
die((e as Error).message + "\n");
|
|
39
61
|
}
|
|
40
62
|
}
|
|
41
|
-
return { certPath, keysPath, online, apiUrl
|
|
63
|
+
return { certPath, keysPath, online, apiUrl };
|
|
42
64
|
}
|
|
43
65
|
|
|
44
66
|
/** Flag first, then environment — the precedence docs/cli.md promises and the
|
|
45
|
-
* Go CLI (cmd/cli/online.go
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
67
|
+
* Go CLI (cmd/cli/online.go resolveAPIBaseURL) implements. Exported for testing.
|
|
68
|
+
*
|
|
69
|
+
* It no longer resolves a key, and that is the change. GET
|
|
70
|
+
* /v1/certificates/{id}/status is unauthenticated by design: the audience for
|
|
71
|
+
* revocation is a relying party holding a certificate — a regulator, an
|
|
72
|
+
* auditor, the customer's customer — who has no account here and never will.
|
|
73
|
+
* Demanding an API key was what stopped that reader asking the one question the
|
|
74
|
+
* artifact exists to answer. */
|
|
75
|
+
export function resolveApiBaseUrl(
|
|
76
|
+
apiUrl: string, env: Record<string, string | undefined>,
|
|
77
|
+
): string {
|
|
49
78
|
apiUrl ||= env.BURNLEDGER_API_URL ?? "";
|
|
50
79
|
if (!apiUrl) throw new Error("--api-url or BURNLEDGER_API_URL environment variable is required for online mode");
|
|
51
|
-
|
|
52
|
-
if (!apiKey) throw new Error("--api-key or BURNLEDGER_API_KEY environment variable is required for online mode");
|
|
53
|
-
return { apiUrl, apiKey };
|
|
80
|
+
return apiUrl;
|
|
54
81
|
}
|
|
55
82
|
|
|
56
|
-
|
|
83
|
+
/** Load the key set and, separately, what the file establishes about the key
|
|
84
|
+
* STATUSES (ADR-017 §5a). The keys load the same way whether or not the file
|
|
85
|
+
* carries a signed statement — key_id == sha256(public_key) makes every
|
|
86
|
+
* identity self-checking — so an unsigned file is not refused. What changes is
|
|
87
|
+
* what this CLI is entitled to say about the statuses and dates. Mirrors
|
|
88
|
+
* loadKeysFromFile in cmd/cli/keys.go. */
|
|
89
|
+
async function loadKeys(path: string): Promise<{ keys: Map<string, PublicKeyInfo>; keyList: KeyListEvidence }> {
|
|
57
90
|
let entries: KeyEntry[];
|
|
91
|
+
let keyList: KeyListEvidence;
|
|
58
92
|
try {
|
|
59
|
-
|
|
93
|
+
const doc = parseKeyListDocument(JSON.parse(await readFile(path, "utf-8")));
|
|
94
|
+
entries = doc.keys;
|
|
95
|
+
// A statement that will not verify is a verdict; one that will not PARSE
|
|
96
|
+
// is a hard error, exactly as in Go: someone signed something the reader
|
|
97
|
+
// cannot read, and continuing as though the file were merely unsigned
|
|
98
|
+
// would throw that fact away.
|
|
99
|
+
keyList = await verifyKeyList(nodeCrypto, doc, new Date());
|
|
60
100
|
} catch (e) {
|
|
61
101
|
die((e as Error).message + "\n");
|
|
62
102
|
}
|
|
@@ -92,31 +132,162 @@ async function loadKeys(path: string): Promise<Map<string, PublicKeyInfo>> {
|
|
|
92
132
|
}
|
|
93
133
|
map.set(pki.keyId, pki);
|
|
94
134
|
}
|
|
95
|
-
return map;
|
|
135
|
+
return { keys: map, keyList };
|
|
96
136
|
}
|
|
97
137
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
138
|
+
/** Retrieve the SIGNED status statement for a certificate.
|
|
139
|
+
*
|
|
140
|
+
* It replaces a GET of /v1/certificates/{id}/revocation-status, which returned
|
|
141
|
+
* a bare {"status": "..."} with no signature over it. That answer was the API's
|
|
142
|
+
* word — or the word of whatever --api-url happened to point at — and this CLI
|
|
143
|
+
* printed it. Nothing about it was checkable, so a network attacker, a stale
|
|
144
|
+
* proxy or a wrong URL could suppress a revocation and the reader could not
|
|
145
|
+
* tell. Every field of this response that the verdict acts on is covered by the
|
|
146
|
+
* issuer's signature.
|
|
147
|
+
*
|
|
148
|
+
* No Authorization header is sent. The endpoint takes none, and sending an API
|
|
149
|
+
* key to an arbitrary --api-url is a credential leak the check never needed. */
|
|
150
|
+
async function fetchStatusStatement(apiUrl: string, certId: string): Promise<StatusStatement> {
|
|
151
|
+
const res = await fetch(`${apiUrl.replace(/\/+$/, "")}/v1/certificates/${certId}/status`);
|
|
152
|
+
if (!res.ok) throw new Error(`HTTP ${res.status}`);
|
|
153
|
+
return unwrapStatusStatement(await res.json());
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/** The API wraps every response in {"data": ...}; a caller may hand over either
|
|
157
|
+
* the envelope or the document inside it. Mirrors
|
|
158
|
+
* core.ParseCertificateStatusDocument, so this CLI and the Go one cannot
|
|
159
|
+
* disagree about which shape the endpoint returns. Exported for testing.
|
|
160
|
+
*
|
|
161
|
+
* A document that does not parse THROWS, and the caller turns that into a
|
|
162
|
+
* warning and a VALID_REVOCATION_UNKNOWN verdict. That is deliberate: an answer
|
|
163
|
+
* this build cannot read is silence about revocation, not a finding about the
|
|
164
|
+
* certificate. Handing a half-read document to the verifier instead would
|
|
165
|
+
* report "status statement signature is invalid" — a claim about the issuer —
|
|
166
|
+
* when what actually happened is that something returned nonsense.
|
|
167
|
+
*
|
|
168
|
+
* `status` itself is NOT validated against a known set. A statement saying
|
|
169
|
+
* SUSPENDED is a statement this build cannot read, and the verifier already has
|
|
170
|
+
* the right answer for that: it authenticates the signature first, then reports
|
|
171
|
+
* VALID_REVOCATION_UNKNOWN. Refusing it here would discard the statement before
|
|
172
|
+
* anyone authenticated it. */
|
|
173
|
+
export function unwrapStatusStatement(parsed: unknown): StatusStatement {
|
|
174
|
+
if (parsed === null || typeof parsed !== "object") {
|
|
175
|
+
throw new Error("status statement: response is not a JSON object");
|
|
176
|
+
}
|
|
177
|
+
let doc = parsed as StatusStatement;
|
|
178
|
+
if (doc.certificate_id === undefined && doc.data !== null && typeof doc.data === "object") {
|
|
179
|
+
doc = doc.data as StatusStatement;
|
|
180
|
+
}
|
|
181
|
+
for (const f of ["certificate_id", "status", "key_id"]) {
|
|
182
|
+
if (typeof doc[f] !== "string" || doc[f] === "") throw new Error(`status statement: ${f} is missing`);
|
|
183
|
+
}
|
|
184
|
+
for (const f of ["statement_issued_at", "statement_expires_at"]) requireRfc3339(doc, f);
|
|
185
|
+
if (doc.revoked_at != null) requireRfc3339(doc, "revoked_at");
|
|
186
|
+
if (typeof doc.sth_tree_size !== "number") throw new Error("status statement: sth_tree_size is not a number");
|
|
187
|
+
// Refuse a short or long value rather than letting it through: a truncated
|
|
188
|
+
// signature or root hash that reaches the verifier is checked against bytes
|
|
189
|
+
// nobody sent.
|
|
190
|
+
requireHex(doc, "sth_root_hash", 32);
|
|
191
|
+
requireHex(doc, "signature", 64);
|
|
192
|
+
return doc;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
function requireRfc3339(doc: StatusStatement, field: string): void {
|
|
196
|
+
const v = doc[field];
|
|
197
|
+
if (typeof v !== "string" || Number.isNaN(Date.parse(v))) {
|
|
198
|
+
throw new Error(`status statement: ${field} is not RFC 3339`);
|
|
199
|
+
}
|
|
104
200
|
}
|
|
105
201
|
|
|
202
|
+
function requireHex(doc: StatusStatement, field: string, bytes: number): void {
|
|
203
|
+
const v = doc[field];
|
|
204
|
+
if (typeof v !== "string" || !new RegExp(`^[0-9a-fA-F]{${bytes * 2}}$`).test(v)) {
|
|
205
|
+
throw new Error(`status statement: ${field} is not ${bytes} bytes of hex`);
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/** The verdicts a reader can act on, and therefore the ones that exit 0.
|
|
210
|
+
*
|
|
211
|
+
* VALID_REVOCATION_UNKNOWN is here. It is the verdict every offline run now
|
|
212
|
+
* carries, and it means what an offline run has always meant: the document
|
|
213
|
+
* verified, and nothing was learned about revocation. Failing it would turn
|
|
214
|
+
* every existing `burnledger check` red overnight while telling the reader
|
|
215
|
+
* nothing new — the honest words are on the first line, where a human reads
|
|
216
|
+
* them, and the exit code keeps the meaning it was given. The soft KEY verdicts
|
|
217
|
+
* still exit 1, unchanged: those need a human before the record is relied on. */
|
|
218
|
+
const USABLE_VERDICTS: ReadonlySet<string> = new Set(["VALID", VALID_REVOCATION_UNKNOWN]);
|
|
219
|
+
|
|
220
|
+
/** The verdict word for an authenticated statement that says REVOKED.
|
|
221
|
+
*
|
|
222
|
+
* It is derived from VerificationError.code, never from the error's prose and
|
|
223
|
+
* never from the statement's own `status` field: every other rejection on the
|
|
224
|
+
* status path — unknown key, revoked key, bad signature, a statement about a
|
|
225
|
+
* different certificate — means the statement could not be authenticated, and
|
|
226
|
+
* rendering one of those as "REVOKED" would report an unauthenticated document
|
|
227
|
+
* as a fact about this certificate. */
|
|
228
|
+
const REVOKED = "REVOKED";
|
|
229
|
+
|
|
106
230
|
/** The pass/fail decision behind the exit code. A signature failure, a
|
|
107
|
-
* transparency FAILURE (thrown, not NOT_AVAILABLE)
|
|
108
|
-
*
|
|
231
|
+
* revocation, or a transparency FAILURE (thrown, not NOT_AVAILABLE) all make
|
|
232
|
+
* the certificate unusable. Revocation is no longer a separate input: it is
|
|
233
|
+
* part of the verdict verifyCertificateWithStatus returns. Exported for
|
|
234
|
+
* testing.
|
|
235
|
+
*
|
|
236
|
+
* An INCONSISTENT anchor refuses, mirroring exitCode in cmd/cli/check.go. It is
|
|
237
|
+
* not a doubt: it is a proof, from the issuer's own signatures, that the head a
|
|
238
|
+
* statement was anchored to is not a prefix of the head the log now publishes.
|
|
239
|
+
* An anchor that could NOT be checked does not refuse — the reader is told so,
|
|
240
|
+
* and the statement still stands on its own signature. */
|
|
109
241
|
export function certVerdict(
|
|
110
|
-
sigResult: string,
|
|
111
|
-
transparencyFailed: boolean,
|
|
112
|
-
online: boolean,
|
|
113
|
-
revocation: { status: string } | undefined,
|
|
242
|
+
sigResult: string, transparencyFailed: boolean, anchor?: AnchorResult,
|
|
114
243
|
): boolean {
|
|
115
|
-
return
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
244
|
+
if (anchor?.verdict === ANCHOR_INCONSISTENT) return false;
|
|
245
|
+
return USABLE_VERDICTS.has(sigResult) && !transparencyFailed;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
/** Verdicts that are neither a pass nor a refusal, and what each one leaves
|
|
249
|
+
* unestablished. ADR-017 §2 calls them results a reader must be SHOWN; the
|
|
250
|
+
* verdict string alone leaves them to guess which half of the check is
|
|
251
|
+
* missing. Mirrors softKeyVerdictNote in cmd/cli/format.go. */
|
|
252
|
+
const SOFT_KEY_VERDICTS: Record<string, string> = {
|
|
253
|
+
VALID_KEY_WINDOW_UNKNOWN:
|
|
254
|
+
"signatures verify; the signing key states a validity interval and this " +
|
|
255
|
+
"certificate carries no transparency proof to date it against",
|
|
256
|
+
VALID_KEY_COMPROMISED_LATER:
|
|
257
|
+
"signatures verify and appear to predate the key's compromise; " +
|
|
258
|
+
"confirm against the witness's record",
|
|
259
|
+
};
|
|
260
|
+
|
|
261
|
+
/** What a VALID_REVOCATION_UNKNOWN verdict leaves unestablished, and there are
|
|
262
|
+
* two ways to arrive at it.
|
|
263
|
+
*
|
|
264
|
+
* Offline it is the ordinary case and always was: nothing was asked, so nothing
|
|
265
|
+
* is known. Online it means the ask failed — a status endpoint that did not
|
|
266
|
+
* answer, an answer this build could not read, or one whose window had closed.
|
|
267
|
+
* Both are silence about revocation, and silence is reported as unknown. This
|
|
268
|
+
* CLI used to report both as VALID, which reads as "checked and not revoked".
|
|
269
|
+
* Mirrors revocationUnknownOffline/Online in cmd/cli/format.go. */
|
|
270
|
+
const REVOCATION_UNKNOWN_OFFLINE =
|
|
271
|
+
"offline — nothing was asked about revocation, so nothing is known; " +
|
|
272
|
+
"re-run with --online to fetch a signed status statement";
|
|
273
|
+
const REVOCATION_UNKNOWN_ONLINE =
|
|
274
|
+
"no usable signed status statement — the issuer said nothing this " +
|
|
275
|
+
"build could read about revocation, which is not the same as saying the record is live";
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* The certificate formats whose signing payload covers enclave_pcr0.
|
|
279
|
+
* Mirrors core.SignatureCoversEnclavePCR0 (core/payload.go).
|
|
280
|
+
*
|
|
281
|
+
* A SET, not a single version, and a predicate rather than an equality test.
|
|
282
|
+
* It was `=== "5.0"`, which silently stopped being true the moment v6 was
|
|
283
|
+
* added: v6 signs the measurement exactly as v5 does, and this CLI told the
|
|
284
|
+
* reader the field was under no signature while the Go CLI said the opposite
|
|
285
|
+
* about the same file.
|
|
286
|
+
*/
|
|
287
|
+
const ENCLAVE_PCR0_SIGNED_IN: readonly string[] = Object.freeze(["5.0", "6.0"]);
|
|
288
|
+
|
|
289
|
+
function signatureCoversEnclavePcr0(version: string): boolean {
|
|
290
|
+
return ENCLAVE_PCR0_SIGNED_IN.includes(version);
|
|
120
291
|
}
|
|
121
292
|
|
|
122
293
|
/** Byte fields arrive as number arrays (Go [N]byte) or strings; show hex. */
|
|
@@ -129,25 +300,56 @@ function displayHash(v: unknown): string {
|
|
|
129
300
|
|
|
130
301
|
export function formatOutput(
|
|
131
302
|
cert: Cert, sigResult: string, transparency: string, transparencyFailed: boolean,
|
|
132
|
-
|
|
303
|
+
status: StatusStatement | undefined, online: boolean, anchor?: AnchorResult,
|
|
304
|
+
keyList?: KeyListEvidence,
|
|
133
305
|
): string {
|
|
134
306
|
const id = (cert.certificate_id as string).slice(0, 6);
|
|
135
307
|
const sub = displayHash((cert.subject as Record<string, unknown>).identifier_hash);
|
|
136
308
|
const att = cert.attestation as Record<string, unknown>;
|
|
137
309
|
const L: string[] = [];
|
|
138
310
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
311
|
+
// A proven-inconsistent anchor outranks every verdict below it, including
|
|
312
|
+
// REVOKED. The issuer has contradicted itself about an append-only structure,
|
|
313
|
+
// so nothing it says about this record — revoked or live — can be taken at
|
|
314
|
+
// face value, and printing "REVOKED" or "VALID" here would answer a question
|
|
315
|
+
// that is no longer the important one. Mirrors formatResult in
|
|
316
|
+
// cmd/cli/format.go, which puts this branch in the same place.
|
|
317
|
+
if (anchor?.verdict === ANCHOR_INCONSISTENT) {
|
|
318
|
+
L.push(`Verification record dc_${id}: INVALID (LOG_ANCHOR_INCONSISTENT)`);
|
|
319
|
+
L.push(` ${anchor.detail}`);
|
|
320
|
+
L.push(` The certificate itself verified as ${sigResult}; the issuer's log is what does not add up.`);
|
|
321
|
+
pushStatementEvidence(L, status);
|
|
322
|
+
return L.join("\n") + "\n";
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
// A soft key verdict is not a forgery: every signature verified, and what
|
|
326
|
+
// could not be established is the key's authority. "INVALID" would send an
|
|
327
|
+
// auditor hunting for tampering that is not there, and "VALID" — which this
|
|
328
|
+
// CLI printed — claims a check that did not happen.
|
|
329
|
+
const note = SOFT_KEY_VERDICTS[sigResult];
|
|
330
|
+
if (note !== undefined) return `Verification record dc_${id}: ${sigResult} (${note})\n`;
|
|
331
|
+
// Revocation is now a signed fact, so the reader gets the evidence with the
|
|
332
|
+
// verdict: who said it, when, and which log entry it points at.
|
|
333
|
+
if (sigResult === REVOKED) {
|
|
334
|
+
L.push(`Verification record dc_${id}: INVALID (REVOKED)`);
|
|
335
|
+
pushStatementEvidence(L, status);
|
|
336
|
+
pushAnchorEvidence(L, anchor);
|
|
144
337
|
return L.join("\n") + "\n";
|
|
145
338
|
}
|
|
339
|
+
if (!USABLE_VERDICTS.has(sigResult)) return `Verification record dc_${id}: INVALID (${sigResult})\n`;
|
|
340
|
+
if (transparencyFailed) return `Verification record dc_${id}: INVALID (transparency: ${transparency})\n`;
|
|
146
341
|
|
|
147
|
-
|
|
148
|
-
|
|
342
|
+
// The two usable verdicts. VALID is sayable without a qualifier for the first
|
|
343
|
+
// time: it is reached only when a fresh statement, signed by a key from the
|
|
344
|
+
// key file and naming this certificate, said ACTIVE. Everything short of that
|
|
345
|
+
// is VALID_REVOCATION_UNKNOWN and says so in the verdict itself, not in a
|
|
346
|
+
// footnote a script will never read.
|
|
347
|
+
const tag = sigResult === VALID_REVOCATION_UNKNOWN
|
|
348
|
+
? `${VALID_REVOCATION_UNKNOWN} (${online ? REVOCATION_UNKNOWN_ONLINE : REVOCATION_UNKNOWN_OFFLINE})`
|
|
349
|
+
: "VALID (a signed status statement says this record is live)";
|
|
350
|
+
L.push(`Verification record dc_${id}: ${tag}`);
|
|
149
351
|
L.push(` Subject: sha256:${sub.slice(0, 6)}...`);
|
|
150
|
-
L.push(`
|
|
352
|
+
L.push(` Format version: ${cert.certificate_format_version as string}`);
|
|
151
353
|
|
|
152
354
|
// v3 carries ONE system list at the top level, with both counts on each
|
|
153
355
|
// record. Reading att.systems here is what made this CLI die on every real
|
|
@@ -167,10 +369,24 @@ export function formatOutput(
|
|
|
167
369
|
// Its own line, never appended to a verdict (ADR-020), and worded so it
|
|
168
370
|
// cannot be read as a checked fact: nothing offline can verify a measurement.
|
|
169
371
|
// Proof is the NSM attestation document.
|
|
372
|
+
//
|
|
373
|
+
// The attribution differs by version. From v5 the field is inside the signing
|
|
374
|
+
// payload, so it is the signer's claim about itself. On v4 — the format that
|
|
375
|
+
// is actually issued, and into which the enclave writes its real measurement —
|
|
376
|
+
// no signature covers it, so calling it the signer's claim names an author
|
|
377
|
+
// nothing established: it is whatever the last holder of the file wrote.
|
|
170
378
|
const issuer = cert.issuer as Record<string, unknown> | undefined;
|
|
171
379
|
const pcr0 = issuer?.enclave_pcr0;
|
|
172
380
|
if (typeof pcr0 === "string" && pcr0 !== "") {
|
|
173
|
-
|
|
381
|
+
const version = cert.certificate_format_version as string;
|
|
382
|
+
if (signatureCoversEnclavePcr0(version)) {
|
|
383
|
+
L.push(` Enclave image (claimed by signer, not verified here): ${pcr0}`);
|
|
384
|
+
} else {
|
|
385
|
+
L.push(
|
|
386
|
+
` Enclave image (format ${version} puts this field under no signature — ` +
|
|
387
|
+
`unattributable, not verified here): ${pcr0}`,
|
|
388
|
+
);
|
|
389
|
+
}
|
|
174
390
|
}
|
|
175
391
|
|
|
176
392
|
if (transparency === "INCLUDED") {
|
|
@@ -179,10 +395,90 @@ export function formatOutput(
|
|
|
179
395
|
} else {
|
|
180
396
|
L.push(` Transparency log: ${transparency === "NOT_AVAILABLE" ? "not included" : transparency}`);
|
|
181
397
|
}
|
|
182
|
-
|
|
398
|
+
pushStatementEvidence(L, status);
|
|
399
|
+
pushAnchorEvidence(L, anchor);
|
|
400
|
+
pushKeyListEvidence(L, keyList);
|
|
183
401
|
return L.join("\n") + "\n";
|
|
184
402
|
}
|
|
185
403
|
|
|
404
|
+
/** Where the key statuses this verdict rests on came from, printed on every
|
|
405
|
+
* run — including the ordinary one, where the answer is "an unsigned list".
|
|
406
|
+
*
|
|
407
|
+
* ADR-017 §5a's point is not that an unsigned key list is unusable. It is that
|
|
408
|
+
* the two halves of a key set have different lifetimes: key_id is
|
|
409
|
+
* sha256(public_key), so every key's IDENTITY is self-checking offline forever,
|
|
410
|
+
* while its status and dates are only as good as the endpoint they were
|
|
411
|
+
* fetched from and the moment they were fetched. Mirrors writeKeyListEvidence
|
|
412
|
+
* in cmd/cli/format.go, word for word, so the four verifiers say one thing. */
|
|
413
|
+
function pushKeyListEvidence(L: string[], e: KeyListEvidence | undefined): void {
|
|
414
|
+
if (e === undefined) return;
|
|
415
|
+
if (!e.present) {
|
|
416
|
+
L.push(" Key statuses: unsigned key list — identities are self-checking " +
|
|
417
|
+
"(key_id = sha256(public_key)); statuses and dates are not evidenced");
|
|
418
|
+
return;
|
|
419
|
+
}
|
|
420
|
+
if (e.result === KEY_LIST_VALID) {
|
|
421
|
+
L.push(` Key statuses: signed key_list.v3, VALID until ${e.expiresAt}`);
|
|
422
|
+
if (e.selfSigned) {
|
|
423
|
+
// Said out loud, every time. A list that vouches for itself proves only
|
|
424
|
+
// that whoever wrote it holds the key it names, and a reader who does
|
|
425
|
+
// not know that will read "VALID" as more than it is.
|
|
426
|
+
L.push(" Key list trust: the list is signed by a key inside itself — " +
|
|
427
|
+
"trust-on-first-use, not proof; pin this file and compare it on later runs");
|
|
428
|
+
}
|
|
429
|
+
return;
|
|
430
|
+
}
|
|
431
|
+
if (e.result === KEY_LIST_STALE) {
|
|
432
|
+
L.push(` Key statuses: signed key_list.v3, but its window closed at ${e.expiresAt} — ` +
|
|
433
|
+
"the identities still check, the statuses no longer do");
|
|
434
|
+
return;
|
|
435
|
+
}
|
|
436
|
+
L.push(` Key statuses: signed key_list.v3 did NOT verify (${e.result}) — ` +
|
|
437
|
+
"treat its statuses and dates as unevidenced");
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
/** Whether the statement's log anchor was tested, and how it came out.
|
|
441
|
+
*
|
|
442
|
+
* The UNVERIFIED line matters as much as the CONFIRMED one. A statement whose
|
|
443
|
+
* anchor could not be checked is a statement that rests entirely on its
|
|
444
|
+
* issuer's signature, and a reader who is not told that will assume the stronger
|
|
445
|
+
* thing — which is the mistake this whole command has been correcting. Mirrors
|
|
446
|
+
* writeAnchorEvidence in cmd/cli/format.go. */
|
|
447
|
+
function pushAnchorEvidence(L: string[], anchor: AnchorResult | undefined): void {
|
|
448
|
+
if (anchor === undefined) return;
|
|
449
|
+
L.push(` Statement log anchor: ${anchor.verdict} (${anchor.detail})`);
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/** What the signed statement said, and by whom.
|
|
453
|
+
*
|
|
454
|
+
* Nothing is printed when there is no statement: the verdict line has already
|
|
455
|
+
* told the reader that revocation is unknown, and a "Revocation status: n/a"
|
|
456
|
+
* line here would put a word where there is no evidence.
|
|
457
|
+
*
|
|
458
|
+
* `Statement signed by` is not decoration. The verdict rests on that key, the
|
|
459
|
+
* key came from the reader's own --keys file, and naming it is what lets an
|
|
460
|
+
* auditor say which key they are trusting rather than "the API said so".
|
|
461
|
+
* Mirrors writeStatementEvidence in cmd/cli/format.go. */
|
|
462
|
+
function pushStatementEvidence(L: string[], status: StatusStatement | undefined): void {
|
|
463
|
+
if (status === undefined) return;
|
|
464
|
+
L.push(` Revocation status: ${String(status.status)} (signed status statement)`);
|
|
465
|
+
L.push(` Statement signed by: ${String(status.key_id)}`);
|
|
466
|
+
L.push(` Statement valid: ${formatTimestamp(status.statement_issued_at)} to ` +
|
|
467
|
+
`${formatTimestamp(status.statement_expires_at)}`);
|
|
468
|
+
// The head the issuer had seen when it spoke. Printed as evidence; whether it
|
|
469
|
+
// is a prefix of the head the log publishes now is a separate question, and
|
|
470
|
+
// the "Statement log anchor" line below answers it (anchor.ts).
|
|
471
|
+
L.push(` Statement anchored to: tree size ${String(status.sth_tree_size)}, ` +
|
|
472
|
+
`root ${displayHash(status.sth_root_hash)}`);
|
|
473
|
+
if (status.revoked_at != null) L.push(` Revoked at: ${formatTimestamp(status.revoked_at)}`);
|
|
474
|
+
if (status.replacement_certificate_id != null) {
|
|
475
|
+
L.push(` Replaced by: ${String(status.replacement_certificate_id)}`);
|
|
476
|
+
}
|
|
477
|
+
if (status.revocation_log_index != null) {
|
|
478
|
+
L.push(` Revocation log entry: #${String(status.revocation_log_index)}`);
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
|
|
186
482
|
/** Accept the raw API response too: GET /v1/certificates/{id} nests the
|
|
187
483
|
* signed certificate as data.certificate. Exported for testing. */
|
|
188
484
|
export function unwrapCertificate(parsed: Cert): Cert {
|
|
@@ -200,11 +496,51 @@ export function unwrapCertificate(parsed: Cert): Cert {
|
|
|
200
496
|
async function main(): Promise<void> {
|
|
201
497
|
const args = parseArgs(process.argv);
|
|
202
498
|
const cert = unwrapCertificate(JSON.parse(await readFile(args.certPath, "utf-8")) as Cert);
|
|
203
|
-
const keys = await loadKeys(args.keysPath);
|
|
499
|
+
const { keys, keyList } = await loadKeys(args.keysPath);
|
|
204
500
|
|
|
501
|
+
// Fetched first, because the verdict now depends on it. A status statement is
|
|
502
|
+
// an input to the verdict, not a footnote printed beside one:
|
|
503
|
+
// verifyCertificateWithStatus answers REVOKED, VALID or
|
|
504
|
+
// VALID_REVOCATION_UNKNOWN from the same call, and splitting that decision
|
|
505
|
+
// across two checks is how this CLI ended up printing VALID for a certificate
|
|
506
|
+
// whose revocation it had never established.
|
|
507
|
+
let status: StatusStatement | undefined;
|
|
508
|
+
let anchor: AnchorResult | undefined;
|
|
509
|
+
if (args.online) {
|
|
510
|
+
try {
|
|
511
|
+
status = await fetchStatusStatement(args.apiUrl, cert.certificate_id as string);
|
|
512
|
+
} catch (e) {
|
|
513
|
+
// Non-fatal, and NOT a pass. Leaving `status` undefined sends the verdict
|
|
514
|
+
// to VALID_REVOCATION_UNKNOWN rather than to VALID: an endpoint that did
|
|
515
|
+
// not answer has said nothing about revocation, and the older code
|
|
516
|
+
// reported that silence as a clean bill of health.
|
|
517
|
+
process.stderr.write(
|
|
518
|
+
`warning: signed status statement unavailable: ${e instanceof Error ? e.message : String(e)}\n`,
|
|
519
|
+
);
|
|
520
|
+
}
|
|
521
|
+
// The statement's anchor is only checkable against the log, and only with a
|
|
522
|
+
// key the reader already holds. A statement signed by a key that is not in
|
|
523
|
+
// --keys cannot be authenticated at all, so there is nothing to anchor and
|
|
524
|
+
// no anchor line is printed. See anchor.ts for what this does and does not
|
|
525
|
+
// close.
|
|
526
|
+
if (status !== undefined) {
|
|
527
|
+
const key = keys.get(status.key_id as string);
|
|
528
|
+
if (key !== undefined) {
|
|
529
|
+
anchor = await checkStatementAnchor(nodeCrypto, args.apiUrl, status, key);
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
// The verifier's own verdict, never a hardcoded word. VALID_KEY_WINDOW_UNKNOWN
|
|
535
|
+
// and VALID_KEY_COMPROMISED_LATER are cases verifyCertificateWithStatus
|
|
536
|
+
// deliberately refused to call VALID, and this is the tool an auditor runs in
|
|
537
|
+
// a script — the one whose exit code gets trusted.
|
|
205
538
|
let sigResult = "VALID";
|
|
206
|
-
try { await
|
|
207
|
-
catch (e) {
|
|
539
|
+
try { sigResult = await verifyCertificateWithStatus(nodeCrypto, cert, keys, status ?? null); }
|
|
540
|
+
catch (e) {
|
|
541
|
+
if (e instanceof VerificationError && e.code === CERTIFICATE_REVOKED) sigResult = REVOKED;
|
|
542
|
+
else sigResult = e instanceof Error ? e.message : "unknown error";
|
|
543
|
+
}
|
|
208
544
|
|
|
209
545
|
// NOT_AVAILABLE (no proof) is a legitimate result; only a thrown error is a
|
|
210
546
|
// transparency FAILURE and must fail the verdict + exit code.
|
|
@@ -213,12 +549,11 @@ async function main(): Promise<void> {
|
|
|
213
549
|
try { transparency = await verifyTransparency(nodeCrypto, cert, keys); }
|
|
214
550
|
catch (e) { transparency = e instanceof Error ? e.message : "unknown error"; transparencyFailed = true; }
|
|
215
551
|
|
|
216
|
-
|
|
217
|
-
if (args.online) revocation = await checkRevocation(args.apiUrl, args.apiKey, cert.certificate_id as string);
|
|
552
|
+
const valid = certVerdict(sigResult, transparencyFailed, anchor);
|
|
218
553
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
554
|
+
process.stdout.write(
|
|
555
|
+
formatOutput(cert, sigResult, transparency, transparencyFailed, status, args.online, anchor, keyList),
|
|
556
|
+
);
|
|
222
557
|
process.exit(valid ? 0 : 1);
|
|
223
558
|
}
|
|
224
559
|
|
package/src/client.ts
CHANGED
|
@@ -11,6 +11,7 @@ import type {
|
|
|
11
11
|
ApiKeyResponse,
|
|
12
12
|
Attestation,
|
|
13
13
|
BatchAttestationResponse,
|
|
14
|
+
BatchRevokeResponse,
|
|
14
15
|
CertificateResponse,
|
|
15
16
|
CertificateStats,
|
|
16
17
|
ConsistencyProof,
|
|
@@ -31,6 +32,7 @@ import {
|
|
|
31
32
|
parseApiKeyResponse,
|
|
32
33
|
parseAttestation,
|
|
33
34
|
parseBatchAttestationResponse,
|
|
35
|
+
parseBatchRevokeResponse,
|
|
34
36
|
parseCertificateResponse,
|
|
35
37
|
parseCertificateStats,
|
|
36
38
|
parseConsistencyProof,
|
|
@@ -55,8 +57,20 @@ export interface BurnLedgerOptions {
|
|
|
55
57
|
baseUrl?: string;
|
|
56
58
|
timeout?: number;
|
|
57
59
|
maxRetries?: number;
|
|
60
|
+
/**
|
|
61
|
+
* Team to act as, sent as X-Team-ID beside the key.
|
|
62
|
+
*
|
|
63
|
+
* Omit it and the API uses the caller's default team — the first one they
|
|
64
|
+
* joined — which is the right answer for a single-team account and the wrong
|
|
65
|
+
* one for anybody else.
|
|
66
|
+
*/
|
|
67
|
+
teamId?: string;
|
|
58
68
|
}
|
|
59
69
|
|
|
70
|
+
/** Per-call cap on POST /v1/certificates/batch-revoke, the same 100 the
|
|
71
|
+
* server enforces (service.maxBatchRevoke). Chunk larger sets by this. */
|
|
72
|
+
export const MAX_BATCH_REVOKE = 100;
|
|
73
|
+
|
|
60
74
|
export class BurnLedger {
|
|
61
75
|
private readonly transport: Transport;
|
|
62
76
|
|
|
@@ -66,6 +80,7 @@ export class BurnLedger {
|
|
|
66
80
|
apiKey: opts.apiKey,
|
|
67
81
|
timeout: opts.timeout ?? 30,
|
|
68
82
|
maxRetries: opts.maxRetries ?? 2,
|
|
83
|
+
teamId: opts.teamId,
|
|
69
84
|
});
|
|
70
85
|
}
|
|
71
86
|
|
|
@@ -297,6 +312,27 @@ export class BurnLedger {
|
|
|
297
312
|
return parseCertificateResponse(data as Raw);
|
|
298
313
|
}
|
|
299
314
|
|
|
315
|
+
/** Revokes up to MAX_BATCH_REVOKE records under one reason. Partial
|
|
316
|
+
* completion is the normal case, not an exception: inspect `errors`. */
|
|
317
|
+
async batchRevokeCertificates(
|
|
318
|
+
certificateIds: string[],
|
|
319
|
+
opts: { reason: string },
|
|
320
|
+
): Promise<BatchRevokeResponse> {
|
|
321
|
+
if (certificateIds.length > MAX_BATCH_REVOKE) {
|
|
322
|
+
// The server answers 400 and revokes nothing; failing here spares the
|
|
323
|
+
// caller a rate-limited round trip for a request that cannot succeed.
|
|
324
|
+
throw new Error(
|
|
325
|
+
`batchRevokeCertificates: ${certificateIds.length} ids exceeds the limit of ${MAX_BATCH_REVOKE} per call`,
|
|
326
|
+
);
|
|
327
|
+
}
|
|
328
|
+
const data = await this.transport.request(
|
|
329
|
+
"POST",
|
|
330
|
+
"/v1/certificates/batch-revoke",
|
|
331
|
+
{ json: { certificate_ids: certificateIds, reason: opts.reason } },
|
|
332
|
+
);
|
|
333
|
+
return parseBatchRevokeResponse(data as Raw);
|
|
334
|
+
}
|
|
335
|
+
|
|
300
336
|
async getCertificateStats(): Promise<CertificateStats> {
|
|
301
337
|
const data = await this.transport.request("GET", "/v1/certificates/stats");
|
|
302
338
|
return parseCertificateStats(data as Raw);
|
|
@@ -387,10 +423,14 @@ export class BurnLedger {
|
|
|
387
423
|
);
|
|
388
424
|
}
|
|
389
425
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
426
|
+
/** Create an API key. `teamId` pins it to one team the caller belongs to:
|
|
427
|
+
* a pinned key always acts for that team and refuses a conflicting
|
|
428
|
+
* `X-Team-ID` with 403. Omitted means unpinned — the server resolves the
|
|
429
|
+
* team per request, as every key created before pinning existed does. */
|
|
430
|
+
async createApiKey(params?: { teamId?: string }): Promise<ApiKeyResponse> {
|
|
431
|
+
const json: Record<string, unknown> = {};
|
|
432
|
+
if (params?.teamId !== undefined) json.team_id = params.teamId;
|
|
433
|
+
const data = await this.transport.request("POST", "/v1/api-keys", { json });
|
|
394
434
|
return parseApiKeyResponse(data as Raw);
|
|
395
435
|
}
|
|
396
436
|
|
|
@@ -405,6 +445,8 @@ export class BurnLedger {
|
|
|
405
445
|
return parseProfile(data as Raw);
|
|
406
446
|
}
|
|
407
447
|
|
|
448
|
+
/** Rename the account. `email` must be the current address: changing it
|
|
449
|
+
* needs a dashboard session, and an API key is refused with 403. */
|
|
408
450
|
async updateMe(params: { name: string; email: string }): Promise<Profile> {
|
|
409
451
|
const data = await this.transport.request("PATCH", "/v1/me", {
|
|
410
452
|
json: { name: params.name, email: params.email },
|