@blamejs/core 0.7.18 → 0.7.20

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.
Files changed (169) hide show
  1. package/CHANGELOG.md +427 -423
  2. package/README.md +150 -150
  3. package/bin/blamejs.js +0 -0
  4. package/index.js +310 -308
  5. package/lib/api-key.js +660 -660
  6. package/lib/api-snapshot.js +338 -338
  7. package/lib/app-shutdown.js +385 -385
  8. package/lib/app.js +365 -365
  9. package/lib/archive.js +250 -250
  10. package/lib/atomic-file.js +544 -544
  11. package/lib/audit-chain.js +177 -177
  12. package/lib/audit-sign.js +344 -344
  13. package/lib/audit-tools.js +677 -677
  14. package/lib/audit.js +766 -766
  15. package/lib/auth/jwt-external.js +365 -0
  16. package/lib/auth/jwt.js +337 -311
  17. package/lib/auth/lockout.js +436 -436
  18. package/lib/auth/oauth.js +721 -721
  19. package/lib/auth/passkey.js +181 -181
  20. package/lib/auth/password.js +628 -594
  21. package/lib/backup/bundle.js +217 -217
  22. package/lib/backup/crypto.js +176 -176
  23. package/lib/backup/index.js +515 -515
  24. package/lib/backup/manifest.js +282 -282
  25. package/lib/break-glass.js +1338 -1338
  26. package/lib/bundler.js +441 -441
  27. package/lib/cache-redis.js +256 -256
  28. package/lib/cache.js +1206 -1206
  29. package/lib/canonical-json.js +115 -115
  30. package/lib/chain-writer.js +234 -234
  31. package/lib/cli-helpers.js +206 -206
  32. package/lib/cli.js +2334 -2334
  33. package/lib/cluster-provider-db.js +317 -317
  34. package/lib/cluster-storage.js +226 -226
  35. package/lib/cluster.js +703 -703
  36. package/lib/config-drift.js +301 -301
  37. package/lib/consent.js +222 -222
  38. package/lib/constants.js +191 -191
  39. package/lib/cookies.js +350 -315
  40. package/lib/credential-hash.js +322 -322
  41. package/lib/crypto.js +266 -266
  42. package/lib/csv.js +275 -275
  43. package/lib/db-declare-row-policy.js +267 -267
  44. package/lib/db-declare-view.js +420 -420
  45. package/lib/db-query.js +406 -406
  46. package/lib/db-schema.js +319 -319
  47. package/lib/db.js +1288 -1288
  48. package/lib/deprecate.js +222 -222
  49. package/lib/dev.js +335 -335
  50. package/lib/dual-control.js +473 -473
  51. package/lib/error-page.js +420 -420
  52. package/lib/external-db-migrate.js +441 -441
  53. package/lib/external-db.js +1061 -1061
  54. package/lib/file-type.js +273 -273
  55. package/lib/forms.js +422 -422
  56. package/lib/framework-error.js +293 -293
  57. package/lib/framework-schema.js +717 -717
  58. package/lib/handlers.js +350 -350
  59. package/lib/http-client-cookie-jar.js +508 -508
  60. package/lib/http-client.js +1195 -1195
  61. package/lib/i18n.js +878 -878
  62. package/lib/jobs.js +185 -185
  63. package/lib/log-stream-cloudwatch.js +369 -369
  64. package/lib/log-stream-local.js +146 -146
  65. package/lib/log-stream-otlp-grpc.js +410 -410
  66. package/lib/log-stream-otlp.js +286 -286
  67. package/lib/log-stream-syslog.js +302 -302
  68. package/lib/log-stream-webhook.js +199 -199
  69. package/lib/log-stream.js +330 -330
  70. package/lib/log.js +500 -500
  71. package/lib/mail-bounce.js +528 -528
  72. package/lib/mail-dkim.js +369 -369
  73. package/lib/mail.js +981 -981
  74. package/lib/metrics.js +683 -683
  75. package/lib/middleware/api-encrypt.js +936 -936
  76. package/lib/middleware/attach-user.js +157 -157
  77. package/lib/middleware/bearer-auth.js +152 -0
  78. package/lib/middleware/body-parser.js +1170 -1170
  79. package/lib/middleware/bot-guard.js +178 -178
  80. package/lib/middleware/compression.js +452 -452
  81. package/lib/middleware/cors.js +314 -314
  82. package/lib/middleware/csp-nonce.js +348 -348
  83. package/lib/middleware/csrf-protect.js +399 -316
  84. package/lib/middleware/db-role-for.js +264 -264
  85. package/lib/middleware/fetch-metadata.js +129 -0
  86. package/lib/middleware/health.js +392 -392
  87. package/lib/middleware/index.js +85 -79
  88. package/lib/middleware/rate-limit.js +358 -358
  89. package/lib/middleware/request-id.js +61 -61
  90. package/lib/middleware/request-log.js +168 -168
  91. package/lib/middleware/require-auth.js +104 -104
  92. package/lib/middleware/security-headers.js +121 -116
  93. package/lib/middleware/sse.js +166 -166
  94. package/lib/migrations.js +383 -383
  95. package/lib/mtls-ca.js +518 -518
  96. package/lib/mtls-engine-default.js +481 -481
  97. package/lib/network-dns.js +632 -632
  98. package/lib/network-heartbeat.js +290 -290
  99. package/lib/network-nts.js +574 -574
  100. package/lib/network-proxy.js +265 -265
  101. package/lib/network-tls.js +328 -328
  102. package/lib/network.js +233 -233
  103. package/lib/notify.js +612 -612
  104. package/lib/ntp-check.js +229 -229
  105. package/lib/numeric-bounds.js +111 -111
  106. package/lib/object-store/azure-blob-bucket-ops.js +349 -349
  107. package/lib/object-store/azure-blob.js +488 -488
  108. package/lib/object-store/gcs-bucket-ops.js +351 -351
  109. package/lib/object-store/gcs.js +519 -519
  110. package/lib/object-store/http-put.js +153 -153
  111. package/lib/object-store/index.js +197 -197
  112. package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
  113. package/lib/object-store/sigv4.js +903 -903
  114. package/lib/observability.js +151 -151
  115. package/lib/otel-export.js +269 -269
  116. package/lib/pagination.js +464 -464
  117. package/lib/parsers/index.js +80 -80
  118. package/lib/parsers/safe-env.js +642 -642
  119. package/lib/parsers/safe-ini.js +292 -292
  120. package/lib/parsers/safe-toml.js +784 -784
  121. package/lib/parsers/safe-xml.js +390 -390
  122. package/lib/parsers/safe-yaml.js +1015 -1015
  123. package/lib/permissions.js +708 -708
  124. package/lib/pqc-agent.js +87 -87
  125. package/lib/pqc-gate.js +279 -279
  126. package/lib/protobuf-encoder.js +190 -190
  127. package/lib/protocol-dispatcher.js +161 -161
  128. package/lib/pubsub-redis.js +167 -167
  129. package/lib/pubsub.js +429 -429
  130. package/lib/queue-local.js +476 -476
  131. package/lib/queue-redis.js +745 -745
  132. package/lib/queue-sqs.js +319 -319
  133. package/lib/queue.js +695 -695
  134. package/lib/redis-client.js +519 -519
  135. package/lib/request-helpers.js +340 -340
  136. package/lib/restore-bundle.js +237 -237
  137. package/lib/restore-rollback.js +259 -259
  138. package/lib/restore.js +409 -409
  139. package/lib/retry.js +376 -376
  140. package/lib/router.js +748 -748
  141. package/lib/safe-async.js +735 -735
  142. package/lib/safe-buffer.js +237 -237
  143. package/lib/safe-json.js +541 -541
  144. package/lib/safe-schema.js +1266 -1266
  145. package/lib/safe-url.js +159 -159
  146. package/lib/scheduler.js +706 -706
  147. package/lib/security-assert.js +373 -373
  148. package/lib/seeders.js +618 -618
  149. package/lib/session.js +535 -478
  150. package/lib/slug.js +269 -269
  151. package/lib/ssrf-guard.js +401 -401
  152. package/lib/static.js +7 -5
  153. package/lib/storage.js +471 -471
  154. package/lib/subject.js +281 -281
  155. package/lib/template.js +791 -791
  156. package/lib/testing.js +798 -798
  157. package/lib/time.js +310 -310
  158. package/lib/totp.js +302 -302
  159. package/lib/tracing.js +494 -494
  160. package/lib/uuid.js +132 -132
  161. package/lib/validate-opts.js +340 -340
  162. package/lib/vault/index.js +308 -308
  163. package/lib/vault/rotate.js +784 -784
  164. package/lib/vault/wrap.js +296 -296
  165. package/lib/vendor/noble-ciphers.cjs +9 -9
  166. package/lib/webhook.js +595 -595
  167. package/lib/websocket.js +1048 -1048
  168. package/package.json +77 -77
  169. package/sbom.cyclonedx.json +7 -7
package/lib/audit-sign.js CHANGED
@@ -1,344 +1,344 @@
1
- "use strict";
2
- /**
3
- * Audit signing key — separate PQC keypair for periodic checkpoint
4
- * signatures over the audit chain.
5
- *
6
- * Algorithm: SLH-DSA-SHAKE-256f (FIPS 205) by default. ML-DSA-87
7
- * (FIPS 204) supported as an opt-in alternative for throughput-
8
- * sensitive deployments. Both are NIST PQC Category 5 (~256-bit
9
- * symmetric security). SLH-DSA-SHAKE-256f is hash-only — its
10
- * security depends solely on the underlying hash function, with no
11
- * lattice / module-hardness assumptions — and matches the framework's
12
- * SHAKE256 KDF + SHA3-512 hash family. Audit checkpoints are long-
13
- * lived integrity attestations (must verify for the data retention
14
- * period — years for HIPAA / SOX), so the conservative-PQC posture
15
- * carries more weight here than the smaller ML-DSA-87 signature
16
- * (~5 KB) and faster sign (0.6 ms vs 76 ms).
17
- *
18
- * The algorithm is recorded in the on-disk key file's `algorithm`
19
- * field. Older key files that predate the algorithm field are loaded
20
- * as ML-DSA-87 (the previous implicit default) and continue to verify
21
- * their checkpoint history. Operators who want to migrate rotate
22
- * their audit-signing key.
23
- *
24
- * Design:
25
- * - Different keypair from the vault encryption keys. Compromise of the
26
- * vault DOES NOT let an attacker forge audit checkpoints.
27
- * - Stored at <dataDir>/audit-sign.key.sealed (default 'wrapped' mode)
28
- * or <dataDir>/audit-sign.key (opt-out 'plaintext' mode with warning).
29
- * - Wrapped under its OWN passphrase, sourced via:
30
- * BLAMEJS_AUDIT_SIGNING_PASSPHRASE (env)
31
- * BLAMEJS_AUDIT_SIGNING_PASSPHRASE_FILE (file)
32
- * BLAMEJS_AUDIT_SIGNING_PASSPHRASE_SOURCE (selector: auto|env|file|stdin)
33
- * These are intentionally distinct from BLAMEJS_VAULT_PASSPHRASE so
34
- * operator-error reuse of the same passphrase is at least explicit.
35
- * - First-run generates the keypair automatically.
36
- *
37
- * Threat model:
38
- * - Vault key compromised + DB write access:
39
- * attacker can read sealed values + rewrite audit_log rows + recompute
40
- * per-row chain hashes. They CANNOT forge new audit_checkpoint rows
41
- * because each checkpoint requires the audit-signing private key.
42
- * - Audit signing key compromised:
43
- * attacker can forge new checkpoints but cannot read sealed values.
44
- * Existing checkpoints still anchor history that pre-dated the
45
- * compromise (operator should rotate signing key on detection).
46
- * - Both compromised:
47
- * framework cannot defend against this — by design, the operator's
48
- * physical / administrative controls (HIPAA §164.310, GDPR Art. 32(1)(d))
49
- * cover this case.
50
- *
51
- * Public API:
52
- * await auditSign.init({ dataDir, mode? }) ← call at db.init()
53
- * auditSign.sign(payload) ← Buffer/string → Buffer signature
54
- * auditSign.verify(payload, signature, publicKey?) ← bool
55
- * auditSign.getPublicKey() ← PEM string
56
- * auditSign.getPublicKeyFingerprint() ← sha3 hex (stable id)
57
- * auditSign.getMode() ← 'wrapped' | 'plaintext'
58
- */
59
- var fs = require("fs");
60
- var path = require("path");
61
- var nodeCrypto = require("crypto");
62
- var atomicFile = require("./atomic-file");
63
- var { sha3Hash } = require("./crypto");
64
- var { defineClass } = require("./framework-error");
65
- var { boot } = require("./log");
66
- var safeBuffer = require("./safe-buffer");
67
- var safeJson = require("./safe-json");
68
- var vaultPassphraseSource = require("./vault/passphrase-source");
69
- var vaultWrap = require("./vault/wrap");
70
-
71
- // AuditSignError is thrown by init() for fatal boot-time conditions
72
- // (conflicting on-disk key files, passphrase rejected, schema invalid).
73
- // The caller — CLI or app boot — catches and translates to an exit code;
74
- // lib/ never calls process.exit unilaterally.
75
- var AuditSignError = defineClass("AuditSignError", { alwaysPermanent: true });
76
- var _err = AuditSignError.factory;
77
-
78
- // Default for newly-generated keys. Operators can override at init
79
- // via opts.algorithm — e.g. `auditSigning: { algorithm: "ml-dsa-87" }`
80
- // for throughput-sensitive deployments. Existing key files determine
81
- // their own algorithm via the on-disk `algorithm` field; legacy key
82
- // files that predate the algorithm field load as "ml-dsa-87" (the
83
- // previous implicit default).
84
- var DEFAULT_SIGNING_ALG = "slh-dsa-shake-256f";
85
- var LEGACY_DEFAULT_ALG = "ml-dsa-87";
86
- var SUPPORTED_SIGNING_ALGS = Object.freeze(["slh-dsa-shake-256f", "ml-dsa-87"]);
87
-
88
- var SIGNING_KEY_SCHEMA = {
89
- type: "object",
90
- required: ["publicKey", "privateKey"],
91
- properties: {
92
- publicKey: { type: "string" },
93
- privateKey: { type: "string" },
94
- algorithm: { type: "string" }, // optional; missing = legacy ml-dsa-87
95
- },
96
- };
97
-
98
- var ENV_VARS = {
99
- value: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE",
100
- file: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE_FILE",
101
- source: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE_SOURCE",
102
- };
103
-
104
- var keys = null; // { publicKey: PEM, privateKey: PEM, fingerprint }
105
- var initialized = false;
106
- var currentMode = null;
107
- var paths = null;
108
-
109
- var log = boot("audit-sign");
110
-
111
- function resolvePaths(dataDir) {
112
- return {
113
- dataDir: dataDir,
114
- plaintext: path.join(dataDir, "audit-sign.key"),
115
- sealed: path.join(dataDir, "audit-sign.key.sealed"),
116
- };
117
- }
118
-
119
- function _computeFingerprint(publicKeyPem) {
120
- return sha3Hash(publicKeyPem);
121
- }
122
-
123
- // ---- Passphrase sourcing (delegates to lib/passphrase-source.js with
124
- // audit-signing-specific env var names) ----
125
-
126
- function _getPassphrase(promptText) {
127
- return vaultPassphraseSource.getPassphrase({
128
- envVars: ENV_VARS,
129
- prompt: promptText || "Audit-signing passphrase: ",
130
- });
131
- }
132
-
133
- // ---- Init ----
134
-
135
- // Algorithm chosen for newly-generated keypairs. Set once per init()
136
- // call and read by _initPlaintext / _initFirstRunWrapped. Existing key
137
- // files take their algorithm from the file itself, ignoring this.
138
- var pendingNewKeyAlg = null;
139
-
140
- async function init(opts) {
141
- if (initialized) return;
142
- if (!opts || !opts.dataDir) {
143
- throw new AuditSignError("auditSign/bad-init",
144
- "auditSign.init({ dataDir }) is required");
145
- }
146
-
147
- var mode = (opts.mode || "wrapped").toLowerCase();
148
- if (mode !== "wrapped" && mode !== "plaintext") {
149
- throw new AuditSignError("auditSign/bad-mode",
150
- "auditSign.init: mode must be 'wrapped' or 'plaintext'");
151
- }
152
- // Algorithm-on-generate. Validated against the supported list so
153
- // typos surface here, not as an opaque "key generation failed"
154
- // deeper in nodeCrypto.
155
- var alg = (opts.algorithm || DEFAULT_SIGNING_ALG).toLowerCase();
156
- if (SUPPORTED_SIGNING_ALGS.indexOf(alg) === -1) {
157
- throw new AuditSignError("auditSign/bad-algorithm",
158
- "auditSign.init: algorithm must be one of " +
159
- SUPPORTED_SIGNING_ALGS.join(", ") + " (got: " + alg + ")");
160
- }
161
- pendingNewKeyAlg = alg;
162
- currentMode = mode;
163
- paths = resolvePaths(opts.dataDir);
164
-
165
- if (!fs.existsSync(paths.dataDir)) fs.mkdirSync(paths.dataDir, { recursive: true });
166
- // Sweep tmp files from any prior crashed write
167
- atomicFile.cleanOrphans(paths.sealed);
168
- atomicFile.cleanOrphans(paths.plaintext);
169
-
170
- var hasPlaintext = fs.existsSync(paths.plaintext);
171
- var hasSealed = fs.existsSync(paths.sealed);
172
- if (hasPlaintext && hasSealed) {
173
- throw _err("KEY_FILE_CONFLICT",
174
- "both audit-sign.key and audit-sign.key.sealed exist; resolve manually");
175
- }
176
- if (hasSealed && mode === "plaintext") {
177
- throw _err("MODE_MISMATCH",
178
- "audit-sign.key.sealed exists but mode='plaintext' requested");
179
- }
180
- if (hasPlaintext && mode === "wrapped") {
181
- throw _err("MODE_MISMATCH",
182
- "audit-sign.key (plaintext) exists but mode='wrapped' requested");
183
- }
184
-
185
- if (mode === "wrapped") {
186
- if (hasSealed) await _initWrapped();
187
- else await _initFirstRunWrapped();
188
- } else {
189
- log.warn("WARNING: PLAINTEXT mode — audit-sign.key is unprotected on disk.");
190
- log.warn(" Use mode: 'wrapped' (default) for any deployment that holds real data.");
191
- _initPlaintext();
192
- }
193
-
194
- initialized = true;
195
- }
196
-
197
- function _initPlaintext() {
198
- if (fs.existsSync(paths.plaintext)) {
199
- var loaded;
200
- try { loaded = safeJson.parse(atomicFile.readSync(paths.plaintext), { schema: SIGNING_KEY_SCHEMA }); }
201
- catch (e) {
202
- throw _err("KEY_FILE_CORRUPT",
203
- "audit-sign.key corrupted or schema-invalid at " + paths.plaintext + " - " + e.message);
204
- }
205
- var loadedAlg = loaded.algorithm || LEGACY_DEFAULT_ALG;
206
- keys = {
207
- publicKey: loaded.publicKey,
208
- privateKey: loaded.privateKey,
209
- algorithm: loadedAlg,
210
- fingerprint: _computeFingerprint(loaded.publicKey),
211
- };
212
- return;
213
- }
214
- // First run, plaintext — generate with the operator-selected (or default) alg
215
- var alg = pendingNewKeyAlg || DEFAULT_SIGNING_ALG;
216
- var pair = nodeCrypto.generateKeyPairSync(alg, {
217
- publicKeyEncoding: { type: "spki", format: "pem" },
218
- privateKeyEncoding: { type: "pkcs8", format: "pem" },
219
- });
220
- keys = {
221
- publicKey: pair.publicKey,
222
- privateKey: pair.privateKey,
223
- algorithm: alg,
224
- fingerprint: _computeFingerprint(pair.publicKey),
225
- };
226
- atomicFile.writeSync(
227
- paths.plaintext,
228
- JSON.stringify({ algorithm: alg, publicKey: keys.publicKey, privateKey: keys.privateKey }, null, 2),
229
- { fileMode: 0o600 }
230
- );
231
- log("plaintext audit-signing keypair generated at " + paths.plaintext + " (alg=" + alg + ")");
232
- }
233
-
234
- async function _initWrapped() {
235
- log("unsealing audit-sign.key.sealed...");
236
- var sealedBytes = atomicFile.readSync(paths.sealed);
237
- var passphrase = await _getPassphrase("Audit-signing passphrase: ");
238
- var plaintextBuf;
239
- try {
240
- try { plaintextBuf = await vaultWrap.unwrap(sealedBytes, passphrase); }
241
- catch (e) {
242
- throw _err("PASSPHRASE_REJECTED",
243
- "audit-signing passphrase rejected (" + e.message + ")");
244
- }
245
- var loaded;
246
- try { loaded = safeJson.parse(plaintextBuf, { schema: SIGNING_KEY_SCHEMA }); }
247
- catch (e) {
248
- throw _err("UNWRAPPED_INVALID",
249
- "unwrapped audit-sign.key invalid: " + e.message);
250
- }
251
- var loadedAlg = loaded.algorithm || LEGACY_DEFAULT_ALG;
252
- keys = {
253
- publicKey: loaded.publicKey,
254
- privateKey: loaded.privateKey,
255
- algorithm: loadedAlg,
256
- fingerprint: _computeFingerprint(loaded.publicKey),
257
- };
258
- log("audit-signing keypair unsealed (alg=" + loadedAlg + ").");
259
- } finally {
260
- // The audit-signing passphrase is single-use at boot — no re-wrap path
261
- // keeps it alive (unlike vault.currentPassphrase). Zero on the way out.
262
- safeBuffer.secureZero(passphrase);
263
- if (plaintextBuf) safeBuffer.secureZero(plaintextBuf);
264
- }
265
- }
266
-
267
- async function _initFirstRunWrapped() {
268
- var alg = pendingNewKeyAlg || DEFAULT_SIGNING_ALG;
269
- log("first-run wrapped — generating audit-signing keypair (alg=" + alg + ")...");
270
- var passphrase = await _getPassphrase("Choose an audit-signing passphrase: ");
271
- try {
272
- var pair = nodeCrypto.generateKeyPairSync(alg, {
273
- publicKeyEncoding: { type: "spki", format: "pem" },
274
- privateKeyEncoding: { type: "pkcs8", format: "pem" },
275
- });
276
- keys = {
277
- publicKey: pair.publicKey,
278
- privateKey: pair.privateKey,
279
- algorithm: alg,
280
- fingerprint: _computeFingerprint(pair.publicKey),
281
- };
282
-
283
- var sealed = await vaultWrap.wrap(
284
- JSON.stringify({ algorithm: alg, publicKey: keys.publicKey, privateKey: keys.privateKey }, null, 2),
285
- passphrase
286
- );
287
- atomicFile.writeSync(paths.sealed, sealed, { fileMode: 0o600 });
288
- log("generated and sealed audit-signing keypair (alg=" + alg + ")");
289
- } finally {
290
- safeBuffer.secureZero(passphrase);
291
- }
292
- }
293
-
294
- // ---- Public API ----
295
-
296
- function _requireInit() {
297
- if (!initialized) {
298
- throw new AuditSignError("auditSign/not-initialized",
299
- "auditSign.init() must be awaited before sign/verify");
300
- }
301
- }
302
-
303
- function sign(payload) {
304
- _requireInit();
305
- var buf = Buffer.isBuffer(payload) ? payload : Buffer.from(String(payload), "utf8");
306
- return nodeCrypto.sign(null, buf, keys.privateKey);
307
- }
308
-
309
- function verify(payload, signature, publicKeyPem) {
310
- _requireInit();
311
- var buf = Buffer.isBuffer(payload) ? payload : Buffer.from(String(payload), "utf8");
312
- var sigBuf = Buffer.isBuffer(signature) ? signature : Buffer.from(signature);
313
- var pub = publicKeyPem || keys.publicKey;
314
- return nodeCrypto.verify(null, buf, pub, sigBuf);
315
- }
316
-
317
- function getPublicKey() { _requireInit(); return keys.publicKey; }
318
- function getPublicKeyFingerprint() { _requireInit(); return keys.fingerprint; }
319
- function getMode() { return currentMode; }
320
- function getAlgorithm() { _requireInit(); return keys.algorithm; }
321
-
322
- function _resetForTest() {
323
- keys = null;
324
- initialized = false;
325
- currentMode = null;
326
- paths = null;
327
- pendingNewKeyAlg = null;
328
- }
329
-
330
- module.exports = {
331
- init: init,
332
- sign: sign,
333
- verify: verify,
334
- getPublicKey: getPublicKey,
335
- getPublicKeyFingerprint: getPublicKeyFingerprint,
336
- getMode: getMode,
337
- getAlgorithm: getAlgorithm,
338
- DEFAULT_SIGNING_ALG: DEFAULT_SIGNING_ALG,
339
- SUPPORTED_SIGNING_ALGS: SUPPORTED_SIGNING_ALGS,
340
- ENV_PASSPHRASE: ENV_VARS.value,
341
- ENV_PASSPHRASE_FILE: ENV_VARS.file,
342
- ENV_PASSPHRASE_SRC: ENV_VARS.source,
343
- _resetForTest: _resetForTest,
344
- };
1
+ "use strict";
2
+ /**
3
+ * Audit signing key — separate PQC keypair for periodic checkpoint
4
+ * signatures over the audit chain.
5
+ *
6
+ * Algorithm: SLH-DSA-SHAKE-256f (FIPS 205) by default. ML-DSA-87
7
+ * (FIPS 204) supported as an opt-in alternative for throughput-
8
+ * sensitive deployments. Both are NIST PQC Category 5 (~256-bit
9
+ * symmetric security). SLH-DSA-SHAKE-256f is hash-only — its
10
+ * security depends solely on the underlying hash function, with no
11
+ * lattice / module-hardness assumptions — and matches the framework's
12
+ * SHAKE256 KDF + SHA3-512 hash family. Audit checkpoints are long-
13
+ * lived integrity attestations (must verify for the data retention
14
+ * period — years for HIPAA / SOX), so the conservative-PQC posture
15
+ * carries more weight here than the smaller ML-DSA-87 signature
16
+ * (~5 KB) and faster sign (0.6 ms vs 76 ms).
17
+ *
18
+ * The algorithm is recorded in the on-disk key file's `algorithm`
19
+ * field. Older key files that predate the algorithm field are loaded
20
+ * as ML-DSA-87 (the previous implicit default) and continue to verify
21
+ * their checkpoint history. Operators who want to migrate rotate
22
+ * their audit-signing key.
23
+ *
24
+ * Design:
25
+ * - Different keypair from the vault encryption keys. Compromise of the
26
+ * vault DOES NOT let an attacker forge audit checkpoints.
27
+ * - Stored at <dataDir>/audit-sign.key.sealed (default 'wrapped' mode)
28
+ * or <dataDir>/audit-sign.key (opt-out 'plaintext' mode with warning).
29
+ * - Wrapped under its OWN passphrase, sourced via:
30
+ * BLAMEJS_AUDIT_SIGNING_PASSPHRASE (env)
31
+ * BLAMEJS_AUDIT_SIGNING_PASSPHRASE_FILE (file)
32
+ * BLAMEJS_AUDIT_SIGNING_PASSPHRASE_SOURCE (selector: auto|env|file|stdin)
33
+ * These are intentionally distinct from BLAMEJS_VAULT_PASSPHRASE so
34
+ * operator-error reuse of the same passphrase is at least explicit.
35
+ * - First-run generates the keypair automatically.
36
+ *
37
+ * Threat model:
38
+ * - Vault key compromised + DB write access:
39
+ * attacker can read sealed values + rewrite audit_log rows + recompute
40
+ * per-row chain hashes. They CANNOT forge new audit_checkpoint rows
41
+ * because each checkpoint requires the audit-signing private key.
42
+ * - Audit signing key compromised:
43
+ * attacker can forge new checkpoints but cannot read sealed values.
44
+ * Existing checkpoints still anchor history that pre-dated the
45
+ * compromise (operator should rotate signing key on detection).
46
+ * - Both compromised:
47
+ * framework cannot defend against this — by design, the operator's
48
+ * physical / administrative controls (HIPAA §164.310, GDPR Art. 32(1)(d))
49
+ * cover this case.
50
+ *
51
+ * Public API:
52
+ * await auditSign.init({ dataDir, mode? }) ← call at db.init()
53
+ * auditSign.sign(payload) ← Buffer/string → Buffer signature
54
+ * auditSign.verify(payload, signature, publicKey?) ← bool
55
+ * auditSign.getPublicKey() ← PEM string
56
+ * auditSign.getPublicKeyFingerprint() ← sha3 hex (stable id)
57
+ * auditSign.getMode() ← 'wrapped' | 'plaintext'
58
+ */
59
+ var fs = require("fs");
60
+ var path = require("path");
61
+ var nodeCrypto = require("crypto");
62
+ var atomicFile = require("./atomic-file");
63
+ var { sha3Hash } = require("./crypto");
64
+ var { defineClass } = require("./framework-error");
65
+ var { boot } = require("./log");
66
+ var safeBuffer = require("./safe-buffer");
67
+ var safeJson = require("./safe-json");
68
+ var vaultPassphraseSource = require("./vault/passphrase-source");
69
+ var vaultWrap = require("./vault/wrap");
70
+
71
+ // AuditSignError is thrown by init() for fatal boot-time conditions
72
+ // (conflicting on-disk key files, passphrase rejected, schema invalid).
73
+ // The caller — CLI or app boot — catches and translates to an exit code;
74
+ // lib/ never calls process.exit unilaterally.
75
+ var AuditSignError = defineClass("AuditSignError", { alwaysPermanent: true });
76
+ var _err = AuditSignError.factory;
77
+
78
+ // Default for newly-generated keys. Operators can override at init
79
+ // via opts.algorithm — e.g. `auditSigning: { algorithm: "ml-dsa-87" }`
80
+ // for throughput-sensitive deployments. Existing key files determine
81
+ // their own algorithm via the on-disk `algorithm` field; legacy key
82
+ // files that predate the algorithm field load as "ml-dsa-87" (the
83
+ // previous implicit default).
84
+ var DEFAULT_SIGNING_ALG = "slh-dsa-shake-256f";
85
+ var LEGACY_DEFAULT_ALG = "ml-dsa-87";
86
+ var SUPPORTED_SIGNING_ALGS = Object.freeze(["slh-dsa-shake-256f", "ml-dsa-87"]);
87
+
88
+ var SIGNING_KEY_SCHEMA = {
89
+ type: "object",
90
+ required: ["publicKey", "privateKey"],
91
+ properties: {
92
+ publicKey: { type: "string" },
93
+ privateKey: { type: "string" },
94
+ algorithm: { type: "string" }, // optional; missing = legacy ml-dsa-87
95
+ },
96
+ };
97
+
98
+ var ENV_VARS = {
99
+ value: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE",
100
+ file: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE_FILE",
101
+ source: "BLAMEJS_AUDIT_SIGNING_PASSPHRASE_SOURCE",
102
+ };
103
+
104
+ var keys = null; // { publicKey: PEM, privateKey: PEM, fingerprint }
105
+ var initialized = false;
106
+ var currentMode = null;
107
+ var paths = null;
108
+
109
+ var log = boot("audit-sign");
110
+
111
+ function resolvePaths(dataDir) {
112
+ return {
113
+ dataDir: dataDir,
114
+ plaintext: path.join(dataDir, "audit-sign.key"),
115
+ sealed: path.join(dataDir, "audit-sign.key.sealed"),
116
+ };
117
+ }
118
+
119
+ function _computeFingerprint(publicKeyPem) {
120
+ return sha3Hash(publicKeyPem);
121
+ }
122
+
123
+ // ---- Passphrase sourcing (delegates to lib/passphrase-source.js with
124
+ // audit-signing-specific env var names) ----
125
+
126
+ function _getPassphrase(promptText) {
127
+ return vaultPassphraseSource.getPassphrase({
128
+ envVars: ENV_VARS,
129
+ prompt: promptText || "Audit-signing passphrase: ",
130
+ });
131
+ }
132
+
133
+ // ---- Init ----
134
+
135
+ // Algorithm chosen for newly-generated keypairs. Set once per init()
136
+ // call and read by _initPlaintext / _initFirstRunWrapped. Existing key
137
+ // files take their algorithm from the file itself, ignoring this.
138
+ var pendingNewKeyAlg = null;
139
+
140
+ async function init(opts) {
141
+ if (initialized) return;
142
+ if (!opts || !opts.dataDir) {
143
+ throw new AuditSignError("auditSign/bad-init",
144
+ "auditSign.init({ dataDir }) is required");
145
+ }
146
+
147
+ var mode = (opts.mode || "wrapped").toLowerCase();
148
+ if (mode !== "wrapped" && mode !== "plaintext") {
149
+ throw new AuditSignError("auditSign/bad-mode",
150
+ "auditSign.init: mode must be 'wrapped' or 'plaintext'");
151
+ }
152
+ // Algorithm-on-generate. Validated against the supported list so
153
+ // typos surface here, not as an opaque "key generation failed"
154
+ // deeper in nodeCrypto.
155
+ var alg = (opts.algorithm || DEFAULT_SIGNING_ALG).toLowerCase();
156
+ if (SUPPORTED_SIGNING_ALGS.indexOf(alg) === -1) {
157
+ throw new AuditSignError("auditSign/bad-algorithm",
158
+ "auditSign.init: algorithm must be one of " +
159
+ SUPPORTED_SIGNING_ALGS.join(", ") + " (got: " + alg + ")");
160
+ }
161
+ pendingNewKeyAlg = alg;
162
+ currentMode = mode;
163
+ paths = resolvePaths(opts.dataDir);
164
+
165
+ if (!fs.existsSync(paths.dataDir)) fs.mkdirSync(paths.dataDir, { recursive: true });
166
+ // Sweep tmp files from any prior crashed write
167
+ atomicFile.cleanOrphans(paths.sealed);
168
+ atomicFile.cleanOrphans(paths.plaintext);
169
+
170
+ var hasPlaintext = fs.existsSync(paths.plaintext);
171
+ var hasSealed = fs.existsSync(paths.sealed);
172
+ if (hasPlaintext && hasSealed) {
173
+ throw _err("KEY_FILE_CONFLICT",
174
+ "both audit-sign.key and audit-sign.key.sealed exist; resolve manually");
175
+ }
176
+ if (hasSealed && mode === "plaintext") {
177
+ throw _err("MODE_MISMATCH",
178
+ "audit-sign.key.sealed exists but mode='plaintext' requested");
179
+ }
180
+ if (hasPlaintext && mode === "wrapped") {
181
+ throw _err("MODE_MISMATCH",
182
+ "audit-sign.key (plaintext) exists but mode='wrapped' requested");
183
+ }
184
+
185
+ if (mode === "wrapped") {
186
+ if (hasSealed) await _initWrapped();
187
+ else await _initFirstRunWrapped();
188
+ } else {
189
+ log.warn("WARNING: PLAINTEXT mode — audit-sign.key is unprotected on disk.");
190
+ log.warn(" Use mode: 'wrapped' (default) for any deployment that holds real data.");
191
+ _initPlaintext();
192
+ }
193
+
194
+ initialized = true;
195
+ }
196
+
197
+ function _initPlaintext() {
198
+ if (fs.existsSync(paths.plaintext)) {
199
+ var loaded;
200
+ try { loaded = safeJson.parse(atomicFile.readSync(paths.plaintext), { schema: SIGNING_KEY_SCHEMA }); }
201
+ catch (e) {
202
+ throw _err("KEY_FILE_CORRUPT",
203
+ "audit-sign.key corrupted or schema-invalid at " + paths.plaintext + " - " + e.message);
204
+ }
205
+ var loadedAlg = loaded.algorithm || LEGACY_DEFAULT_ALG;
206
+ keys = {
207
+ publicKey: loaded.publicKey,
208
+ privateKey: loaded.privateKey,
209
+ algorithm: loadedAlg,
210
+ fingerprint: _computeFingerprint(loaded.publicKey),
211
+ };
212
+ return;
213
+ }
214
+ // First run, plaintext — generate with the operator-selected (or default) alg
215
+ var alg = pendingNewKeyAlg || DEFAULT_SIGNING_ALG;
216
+ var pair = nodeCrypto.generateKeyPairSync(alg, {
217
+ publicKeyEncoding: { type: "spki", format: "pem" },
218
+ privateKeyEncoding: { type: "pkcs8", format: "pem" },
219
+ });
220
+ keys = {
221
+ publicKey: pair.publicKey,
222
+ privateKey: pair.privateKey,
223
+ algorithm: alg,
224
+ fingerprint: _computeFingerprint(pair.publicKey),
225
+ };
226
+ atomicFile.writeSync(
227
+ paths.plaintext,
228
+ JSON.stringify({ algorithm: alg, publicKey: keys.publicKey, privateKey: keys.privateKey }, null, 2),
229
+ { fileMode: 0o600 }
230
+ );
231
+ log("plaintext audit-signing keypair generated at " + paths.plaintext + " (alg=" + alg + ")");
232
+ }
233
+
234
+ async function _initWrapped() {
235
+ log("unsealing audit-sign.key.sealed...");
236
+ var sealedBytes = atomicFile.readSync(paths.sealed);
237
+ var passphrase = await _getPassphrase("Audit-signing passphrase: ");
238
+ var plaintextBuf;
239
+ try {
240
+ try { plaintextBuf = await vaultWrap.unwrap(sealedBytes, passphrase); }
241
+ catch (e) {
242
+ throw _err("PASSPHRASE_REJECTED",
243
+ "audit-signing passphrase rejected (" + e.message + ")");
244
+ }
245
+ var loaded;
246
+ try { loaded = safeJson.parse(plaintextBuf, { schema: SIGNING_KEY_SCHEMA }); }
247
+ catch (e) {
248
+ throw _err("UNWRAPPED_INVALID",
249
+ "unwrapped audit-sign.key invalid: " + e.message);
250
+ }
251
+ var loadedAlg = loaded.algorithm || LEGACY_DEFAULT_ALG;
252
+ keys = {
253
+ publicKey: loaded.publicKey,
254
+ privateKey: loaded.privateKey,
255
+ algorithm: loadedAlg,
256
+ fingerprint: _computeFingerprint(loaded.publicKey),
257
+ };
258
+ log("audit-signing keypair unsealed (alg=" + loadedAlg + ").");
259
+ } finally {
260
+ // The audit-signing passphrase is single-use at boot — no re-wrap path
261
+ // keeps it alive (unlike vault.currentPassphrase). Zero on the way out.
262
+ safeBuffer.secureZero(passphrase);
263
+ if (plaintextBuf) safeBuffer.secureZero(plaintextBuf);
264
+ }
265
+ }
266
+
267
+ async function _initFirstRunWrapped() {
268
+ var alg = pendingNewKeyAlg || DEFAULT_SIGNING_ALG;
269
+ log("first-run wrapped — generating audit-signing keypair (alg=" + alg + ")...");
270
+ var passphrase = await _getPassphrase("Choose an audit-signing passphrase: ");
271
+ try {
272
+ var pair = nodeCrypto.generateKeyPairSync(alg, {
273
+ publicKeyEncoding: { type: "spki", format: "pem" },
274
+ privateKeyEncoding: { type: "pkcs8", format: "pem" },
275
+ });
276
+ keys = {
277
+ publicKey: pair.publicKey,
278
+ privateKey: pair.privateKey,
279
+ algorithm: alg,
280
+ fingerprint: _computeFingerprint(pair.publicKey),
281
+ };
282
+
283
+ var sealed = await vaultWrap.wrap(
284
+ JSON.stringify({ algorithm: alg, publicKey: keys.publicKey, privateKey: keys.privateKey }, null, 2),
285
+ passphrase
286
+ );
287
+ atomicFile.writeSync(paths.sealed, sealed, { fileMode: 0o600 });
288
+ log("generated and sealed audit-signing keypair (alg=" + alg + ")");
289
+ } finally {
290
+ safeBuffer.secureZero(passphrase);
291
+ }
292
+ }
293
+
294
+ // ---- Public API ----
295
+
296
+ function _requireInit() {
297
+ if (!initialized) {
298
+ throw new AuditSignError("auditSign/not-initialized",
299
+ "auditSign.init() must be awaited before sign/verify");
300
+ }
301
+ }
302
+
303
+ function sign(payload) {
304
+ _requireInit();
305
+ var buf = Buffer.isBuffer(payload) ? payload : Buffer.from(String(payload), "utf8");
306
+ return nodeCrypto.sign(null, buf, keys.privateKey);
307
+ }
308
+
309
+ function verify(payload, signature, publicKeyPem) {
310
+ _requireInit();
311
+ var buf = Buffer.isBuffer(payload) ? payload : Buffer.from(String(payload), "utf8");
312
+ var sigBuf = Buffer.isBuffer(signature) ? signature : Buffer.from(signature);
313
+ var pub = publicKeyPem || keys.publicKey;
314
+ return nodeCrypto.verify(null, buf, pub, sigBuf);
315
+ }
316
+
317
+ function getPublicKey() { _requireInit(); return keys.publicKey; }
318
+ function getPublicKeyFingerprint() { _requireInit(); return keys.fingerprint; }
319
+ function getMode() { return currentMode; }
320
+ function getAlgorithm() { _requireInit(); return keys.algorithm; }
321
+
322
+ function _resetForTest() {
323
+ keys = null;
324
+ initialized = false;
325
+ currentMode = null;
326
+ paths = null;
327
+ pendingNewKeyAlg = null;
328
+ }
329
+
330
+ module.exports = {
331
+ init: init,
332
+ sign: sign,
333
+ verify: verify,
334
+ getPublicKey: getPublicKey,
335
+ getPublicKeyFingerprint: getPublicKeyFingerprint,
336
+ getMode: getMode,
337
+ getAlgorithm: getAlgorithm,
338
+ DEFAULT_SIGNING_ALG: DEFAULT_SIGNING_ALG,
339
+ SUPPORTED_SIGNING_ALGS: SUPPORTED_SIGNING_ALGS,
340
+ ENV_PASSPHRASE: ENV_VARS.value,
341
+ ENV_PASSPHRASE_FILE: ENV_VARS.file,
342
+ ENV_PASSPHRASE_SRC: ENV_VARS.source,
343
+ _resetForTest: _resetForTest,
344
+ };