@blamejs/core 0.7.1 → 0.7.18

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 (180) hide show
  1. package/CHANGELOG.md +423 -389
  2. package/README.md +150 -149
  3. package/bin/blamejs.js +0 -0
  4. package/index.js +308 -282
  5. package/lib/api-key.js +660 -672
  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.js +311 -311
  16. package/lib/auth/lockout.js +436 -436
  17. package/lib/auth/oauth.js +721 -721
  18. package/lib/auth/passkey.js +181 -181
  19. package/lib/auth/password.js +594 -594
  20. package/lib/backup/bundle.js +217 -217
  21. package/lib/backup/crypto.js +176 -176
  22. package/lib/backup/index.js +515 -515
  23. package/lib/backup/manifest.js +282 -282
  24. package/lib/break-glass.js +1338 -1338
  25. package/lib/bundler.js +441 -441
  26. package/lib/cache-redis.js +256 -266
  27. package/lib/cache.js +1206 -1211
  28. package/lib/canonical-json.js +115 -115
  29. package/lib/chain-writer.js +234 -234
  30. package/lib/cli-helpers.js +206 -206
  31. package/lib/cli.js +2334 -2334
  32. package/lib/cluster-provider-db.js +317 -317
  33. package/lib/cluster-storage.js +226 -226
  34. package/lib/cluster.js +703 -703
  35. package/lib/codepoint-class.js +196 -0
  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 +315 -315
  40. package/lib/credential-hash.js +322 -322
  41. package/lib/crypto.js +266 -266
  42. package/lib/csv.js +275 -286
  43. package/lib/db-declare-row-policy.js +267 -267
  44. package/lib/db-declare-view.js +420 -421
  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/file-upload.js +1136 -0
  56. package/lib/forms.js +422 -422
  57. package/lib/framework-error.js +293 -202
  58. package/lib/framework-schema.js +717 -717
  59. package/lib/gate-contract.js +971 -0
  60. package/lib/guard-all.js +405 -0
  61. package/lib/guard-archive.js +739 -0
  62. package/lib/guard-csv.js +816 -0
  63. package/lib/guard-email.js +744 -0
  64. package/lib/guard-filename.js +724 -0
  65. package/lib/guard-html.js +976 -0
  66. package/lib/guard-json.js +729 -0
  67. package/lib/guard-markdown.js +586 -0
  68. package/lib/guard-svg.js +976 -0
  69. package/lib/guard-xml.js +405 -0
  70. package/lib/guard-yaml.js +529 -0
  71. package/lib/handlers.js +350 -350
  72. package/lib/http-client-cookie-jar.js +508 -508
  73. package/lib/http-client.js +1195 -1195
  74. package/lib/i18n.js +878 -878
  75. package/lib/jobs.js +185 -185
  76. package/lib/log-stream-cloudwatch.js +369 -369
  77. package/lib/log-stream-local.js +146 -146
  78. package/lib/log-stream-otlp-grpc.js +410 -410
  79. package/lib/log-stream-otlp.js +286 -286
  80. package/lib/log-stream-syslog.js +302 -302
  81. package/lib/log-stream-webhook.js +199 -199
  82. package/lib/log-stream.js +330 -330
  83. package/lib/log.js +500 -500
  84. package/lib/mail-bounce.js +528 -528
  85. package/lib/mail-dkim.js +369 -362
  86. package/lib/mail.js +981 -962
  87. package/lib/metrics.js +683 -683
  88. package/lib/middleware/api-encrypt.js +936 -573
  89. package/lib/middleware/attach-user.js +157 -157
  90. package/lib/middleware/body-parser.js +1170 -1091
  91. package/lib/middleware/bot-guard.js +178 -178
  92. package/lib/middleware/compression.js +452 -452
  93. package/lib/middleware/cors.js +314 -314
  94. package/lib/middleware/csp-nonce.js +348 -348
  95. package/lib/middleware/csrf-protect.js +316 -316
  96. package/lib/middleware/db-role-for.js +264 -269
  97. package/lib/middleware/health.js +392 -392
  98. package/lib/middleware/index.js +79 -79
  99. package/lib/middleware/rate-limit.js +358 -358
  100. package/lib/middleware/request-id.js +61 -61
  101. package/lib/middleware/request-log.js +168 -168
  102. package/lib/middleware/require-auth.js +104 -104
  103. package/lib/middleware/security-headers.js +116 -116
  104. package/lib/middleware/sse.js +166 -166
  105. package/lib/migrations.js +383 -383
  106. package/lib/mtls-ca.js +518 -518
  107. package/lib/mtls-engine-default.js +481 -481
  108. package/lib/network-dns.js +632 -632
  109. package/lib/network-heartbeat.js +290 -290
  110. package/lib/network-nts.js +574 -574
  111. package/lib/network-proxy.js +265 -265
  112. package/lib/network-tls.js +328 -328
  113. package/lib/network.js +233 -233
  114. package/lib/notify.js +612 -614
  115. package/lib/ntp-check.js +229 -229
  116. package/lib/numeric-bounds.js +111 -91
  117. package/lib/object-store/azure-blob-bucket-ops.js +349 -349
  118. package/lib/object-store/azure-blob.js +488 -451
  119. package/lib/object-store/gcs-bucket-ops.js +351 -351
  120. package/lib/object-store/gcs.js +519 -479
  121. package/lib/object-store/http-put.js +153 -153
  122. package/lib/object-store/index.js +197 -197
  123. package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
  124. package/lib/object-store/sigv4.js +903 -855
  125. package/lib/observability.js +151 -151
  126. package/lib/otel-export.js +269 -269
  127. package/lib/pagination.js +464 -464
  128. package/lib/parsers/index.js +80 -80
  129. package/lib/parsers/safe-env.js +642 -642
  130. package/lib/parsers/safe-ini.js +292 -292
  131. package/lib/parsers/safe-toml.js +784 -784
  132. package/lib/parsers/safe-xml.js +390 -390
  133. package/lib/parsers/safe-yaml.js +1015 -1015
  134. package/lib/permissions.js +708 -708
  135. package/lib/pqc-agent.js +87 -87
  136. package/lib/pqc-gate.js +279 -279
  137. package/lib/protobuf-encoder.js +190 -190
  138. package/lib/protocol-dispatcher.js +161 -161
  139. package/lib/pubsub-redis.js +167 -177
  140. package/lib/pubsub.js +429 -429
  141. package/lib/queue-local.js +476 -476
  142. package/lib/queue-redis.js +745 -752
  143. package/lib/queue-sqs.js +319 -319
  144. package/lib/queue.js +695 -695
  145. package/lib/redis-client.js +519 -489
  146. package/lib/request-helpers.js +340 -336
  147. package/lib/restore-bundle.js +237 -237
  148. package/lib/restore-rollback.js +259 -259
  149. package/lib/restore.js +409 -409
  150. package/lib/retry.js +376 -376
  151. package/lib/router.js +748 -748
  152. package/lib/safe-async.js +735 -735
  153. package/lib/safe-buffer.js +237 -237
  154. package/lib/safe-json.js +541 -541
  155. package/lib/safe-schema.js +1266 -1266
  156. package/lib/safe-url.js +159 -159
  157. package/lib/scheduler.js +706 -706
  158. package/lib/security-assert.js +373 -373
  159. package/lib/seeders.js +618 -630
  160. package/lib/session.js +478 -478
  161. package/lib/slug.js +269 -269
  162. package/lib/ssrf-guard.js +401 -401
  163. package/lib/static.js +879 -114
  164. package/lib/storage.js +471 -471
  165. package/lib/subject.js +281 -281
  166. package/lib/template.js +791 -791
  167. package/lib/testing.js +798 -798
  168. package/lib/time.js +310 -310
  169. package/lib/totp.js +302 -302
  170. package/lib/tracing.js +494 -494
  171. package/lib/uuid.js +132 -132
  172. package/lib/validate-opts.js +340 -270
  173. package/lib/vault/index.js +308 -308
  174. package/lib/vault/rotate.js +784 -784
  175. package/lib/vault/wrap.js +296 -296
  176. package/lib/vendor/noble-ciphers.cjs +9 -9
  177. package/lib/webhook.js +595 -598
  178. package/lib/websocket.js +1048 -1048
  179. package/package.json +77 -77
  180. package/sbom.cyclonedx.json +7 -7
package/lib/vault/wrap.js CHANGED
@@ -1,296 +1,296 @@
1
- "use strict";
2
- /**
3
- * Vault-key wrapping — passphrase-derived AEAD wrap for the framework's vault key.
4
- *
5
- * Format (magic 0xE2):
6
- * byte 0: 0xE2 magic
7
- * byte 1: format version (0x01)
8
- * byte 2: KDF ID (0x01 Argon2id)
9
- * byte 3: reserved (0x00)
10
- * bytes 4-7: Argon2 memory cost (KiB, uint32 BE)
11
- * bytes 8-9: Argon2 time cost (uint16 BE)
12
- * byte 10: Argon2 parallelism (uint8)
13
- * byte 11: salt length (uint8)
14
- * bytes 12..: salt
15
- * byte N: cipher ID (0x02 XChaCha20-Poly1305)
16
- * byte N+1: nonce length (uint8, must be 24)
17
- * bytes N+2..: nonce (24 bytes)
18
- * bytes N+26..N+29: ciphertext length (uint32 BE)
19
- * bytes N+30..: XChaCha20-Poly1305 ciphertext + tag
20
- *
21
- * The entire header (bytes 0 through N+29) is bound as AAD on the AEAD tag.
22
- * Any header-byte flip therefore fails AEAD verification — prevents
23
- * downgrade-in-header attacks on KDF params or cipher ID.
24
- *
25
- * This module is PURE — no filesystem I/O. Callers handle reading/writing.
26
- * wrap() and unwrap() are async because Argon2 is async via its native binding.
27
- */
28
- var argon2 = require("../vendor/argon2");
29
- var C = require("../constants");
30
- var { xchacha20poly1305 } = require("../vendor/noble-ciphers.cjs");
31
- var { generateBytes } = require("../crypto");
32
- var safeBuffer = require("../safe-buffer");
33
-
34
- // ---- Format constants ----
35
- var MAGIC = 0xE2;
36
- var FORMAT_VERSION = 0x01;
37
- var KDF_ARGON2ID = 0x01;
38
- var CIPHER_XCHACHA20_POLY = 0x02;
39
- var NONCE_LENGTH = C.BYTES.bytes(24);
40
-
41
- // ---- Default Argon2id parameters ----
42
- // 64 MiB / t=3 / p=4 targets ~1s derivation on commodity 2026 hardware —
43
- // painful for offline brute force, tolerable for an operator-initiated boot.
44
- // memoryCost is denominated in KiB per RFC 9106 §3.1, so the 64 MiB target
45
- // expresses as MiB→KiB through the framework's byte helpers.
46
- var DEFAULT_ARGON2 = Object.freeze({
47
- memoryCost: C.BYTES.mib(64) / C.BYTES.kib(1),
48
- timeCost: 3,
49
- parallelism: 4,
50
- saltLength: C.BYTES.bytes(16),
51
- hashLength: C.BYTES.bytes(32),
52
- });
53
-
54
- // ---- Hard bounds — reject malformed or adversarial headers ----
55
- var MIN_SALT_LENGTH = C.BYTES.bytes(8);
56
- var MAX_SALT_LENGTH = C.BYTES.bytes(64);
57
- var MAX_PASSPHRASE_LENGTH = C.BYTES.kib(4);
58
- // argon2 memoryCost is denominated in KiB per RFC 9106 §3.1, not bytes.
59
- // Express the bound as a byte-quantity divided by KiB so the framework's
60
- // C.BYTES helpers stay the single source of truth for the underlying scale.
61
- var MIN_ARGON2_MEMORY = C.BYTES.mib(1) / C.BYTES.kib(1); // 1 MiB-in-KiB
62
- var MAX_ARGON2_MEMORY = C.BYTES.gib(4) / C.BYTES.kib(1); // 4 GiB-in-KiB
63
- var MAX_ARGON2_TIME = 100;
64
- // Argon2 lane count cap. Hex form because the literal isn't a byte
65
- // quantity — using C.BYTES.* would mis-name the unit at the call site.
66
- var MAX_ARGON2_PARALLELISM = 0x20;
67
-
68
- function buildHeader(params) {
69
- var salt = params.salt;
70
- var nonce = params.nonce;
71
- if (!Buffer.isBuffer(salt) && !(salt instanceof Uint8Array)) {
72
- throw new Error("salt must be a Buffer/Uint8Array");
73
- }
74
- if (!Buffer.isBuffer(nonce) && !(nonce instanceof Uint8Array)) {
75
- throw new Error("nonce must be a Buffer/Uint8Array");
76
- }
77
- if (nonce.length !== NONCE_LENGTH) {
78
- throw new Error("nonce must be " + NONCE_LENGTH + " bytes, got " + nonce.length);
79
- }
80
- if (salt.length < MIN_SALT_LENGTH || salt.length > MAX_SALT_LENGTH) {
81
- throw new Error("salt length out of range [" + MIN_SALT_LENGTH + "," + MAX_SALT_LENGTH + "]: " + salt.length);
82
- }
83
- var saltLen = salt.length;
84
- var headerLen = 12 + saltLen + 2 + NONCE_LENGTH + 4;
85
- var h = Buffer.alloc(headerLen);
86
- h[0] = MAGIC;
87
- h[1] = FORMAT_VERSION;
88
- h[2] = KDF_ARGON2ID;
89
- h[3] = 0x00;
90
- h.writeUInt32BE(params.memoryCost >>> 0, 4);
91
- h.writeUInt16BE(params.timeCost & 0xffff, C.BYTES.bytes(8));
92
- h[10] = params.parallelism & 0xff;
93
- h[11] = saltLen;
94
- Buffer.from(salt).copy(h, 12);
95
- var pos = 12 + saltLen;
96
- h[pos] = CIPHER_XCHACHA20_POLY;
97
- h[pos + 1] = NONCE_LENGTH;
98
- Buffer.from(nonce).copy(h, pos + 2);
99
- pos += 2 + NONCE_LENGTH;
100
- h.writeUInt32BE(params.ciphertextLength >>> 0, pos);
101
- return h;
102
- }
103
-
104
- function parseHeader(buf) {
105
- if (!Buffer.isBuffer(buf)) buf = Buffer.from(buf);
106
- if (buf.length < 12) throw new Error("wrapped vault file too short (< 12 bytes)");
107
- if (buf[0] !== MAGIC) {
108
- throw new Error("not a wrapped vault file (magic byte 0x" + buf[0].toString(0x10) +
109
- " != 0x" + MAGIC.toString(0x10) + ")");
110
- }
111
- if (buf[1] !== FORMAT_VERSION) {
112
- throw new Error("unsupported wrapped-vault format version " + buf[1] + " — upgrade blamejs");
113
- }
114
- if (buf[2] !== KDF_ARGON2ID) {
115
- throw new Error("unsupported KDF ID " + buf[2] + " — upgrade blamejs");
116
- }
117
- // byte 3 reserved
118
-
119
- var memoryCost = buf.readUInt32BE(4);
120
- var timeCost = buf.readUInt16BE(C.BYTES.bytes(8));
121
- var parallelism = buf[10];
122
- var saltLen = buf[11];
123
-
124
- if (memoryCost < MIN_ARGON2_MEMORY || memoryCost > MAX_ARGON2_MEMORY) {
125
- throw new Error("argon2 memory cost out of bounds: " + memoryCost + " KiB");
126
- }
127
- if (timeCost < 1 || timeCost > MAX_ARGON2_TIME) {
128
- throw new Error("argon2 time cost out of bounds: " + timeCost);
129
- }
130
- if (parallelism < 1 || parallelism > MAX_ARGON2_PARALLELISM) {
131
- throw new Error("argon2 parallelism out of bounds: " + parallelism);
132
- }
133
- if (saltLen < MIN_SALT_LENGTH || saltLen > MAX_SALT_LENGTH) {
134
- throw new Error("salt length out of bounds: " + saltLen);
135
- }
136
-
137
- var saltEnd = 12 + saltLen;
138
- if (buf.length < saltEnd + 2 + NONCE_LENGTH + 4) {
139
- throw new Error("wrapped vault file truncated (header incomplete)");
140
- }
141
-
142
- var salt = Buffer.from(buf.subarray(12, saltEnd));
143
- var cipherId = buf[saltEnd];
144
- if (cipherId !== CIPHER_XCHACHA20_POLY) {
145
- throw new Error("unsupported cipher ID " + cipherId + " — upgrade blamejs");
146
- }
147
- var nonceLen = buf[saltEnd + 1];
148
- if (nonceLen !== NONCE_LENGTH) {
149
- throw new Error("invalid nonce length " + nonceLen + " (expected " + NONCE_LENGTH + ")");
150
- }
151
- var nonce = Buffer.from(buf.subarray(saltEnd + 2, saltEnd + 2 + NONCE_LENGTH));
152
- var ctLenPos = saltEnd + 2 + NONCE_LENGTH;
153
- var ciphertextLength = buf.readUInt32BE(ctLenPos);
154
- var headerEnd = ctLenPos + 4;
155
-
156
- if (ciphertextLength < C.BYTES.bytes(16)) {
157
- throw new Error("ciphertext length too short (< Poly1305 tag): " + ciphertextLength);
158
- }
159
- if (buf.length < headerEnd + ciphertextLength) {
160
- throw new Error("wrapped vault file truncated (ciphertext length " + ciphertextLength +
161
- " exceeds remaining " + (buf.length - headerEnd) + ")");
162
- }
163
-
164
- return {
165
- params: {
166
- memoryCost: memoryCost,
167
- timeCost: timeCost,
168
- parallelism: parallelism,
169
- salt: salt,
170
- nonce: nonce,
171
- ciphertextLength: ciphertextLength,
172
- },
173
- headerEnd: headerEnd,
174
- headerBytes: Buffer.from(buf.subarray(0, headerEnd)),
175
- };
176
- }
177
-
178
- async function deriveWrappingKey(passphrase, salt, argonParams) {
179
- argonParams = argonParams || {};
180
- // Track whether we own pwBuf (we allocated it from a string). When the
181
- // caller passed a Buffer directly we don't own it — zeroing would
182
- // mutate caller state.
183
- var weOwnPwBuf = !Buffer.isBuffer(passphrase);
184
- var pwBuf = Buffer.isBuffer(passphrase) ? passphrase : Buffer.from(String(passphrase), "utf8");
185
- if (pwBuf.length === 0) {
186
- if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
187
- throw new Error("passphrase must not be empty");
188
- }
189
- if (pwBuf.length > MAX_PASSPHRASE_LENGTH) {
190
- if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
191
- throw new Error("passphrase exceeds " + MAX_PASSPHRASE_LENGTH + " byte sanity limit");
192
- }
193
- var raw;
194
- try {
195
- raw = await argon2.hash(pwBuf, {
196
- type: argon2.argon2id,
197
- salt: Buffer.from(salt),
198
- memoryCost: argonParams.memoryCost || DEFAULT_ARGON2.memoryCost,
199
- timeCost: argonParams.timeCost || DEFAULT_ARGON2.timeCost,
200
- parallelism: argonParams.parallelism || DEFAULT_ARGON2.parallelism,
201
- hashLength: C.BYTES.bytes(32),
202
- raw: true,
203
- });
204
- } finally {
205
- if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
206
- }
207
- if (!raw || raw.length !== C.BYTES.bytes(32)) {
208
- safeBuffer.secureZero(raw);
209
- throw new Error("Argon2 returned unexpected hash length: " + (raw && raw.length));
210
- }
211
- // Buffer.from(raw) copies bytes — the original `raw` Uint8Array can be
212
- // zeroed without affecting the returned Buffer.
213
- var out = Buffer.from(raw);
214
- safeBuffer.secureZero(raw);
215
- return out;
216
- }
217
-
218
- async function wrap(plaintext, passphrase, opts) {
219
- opts = opts || {};
220
- // We own plaintextBuf only if we converted from a string. When the
221
- // caller passed a Buffer directly we don't own it.
222
- var weOwnPlaintextBuf = !Buffer.isBuffer(plaintext);
223
- var plaintextBuf = Buffer.isBuffer(plaintext) ? plaintext : Buffer.from(plaintext, "utf8");
224
-
225
- var memoryCost = opts.memoryCost || DEFAULT_ARGON2.memoryCost;
226
- var timeCost = opts.timeCost || DEFAULT_ARGON2.timeCost;
227
- var parallelism = opts.parallelism || DEFAULT_ARGON2.parallelism;
228
- var saltLength = opts.saltLength || DEFAULT_ARGON2.saltLength;
229
-
230
- var salt = opts.salt ? Buffer.from(opts.salt) : generateBytes(saltLength);
231
- var nonce = opts.nonce ? Buffer.from(opts.nonce) : generateBytes(NONCE_LENGTH);
232
-
233
- var wrappingKey = await deriveWrappingKey(passphrase, salt, {
234
- memoryCost: memoryCost,
235
- timeCost: timeCost,
236
- parallelism: parallelism,
237
- });
238
-
239
- try {
240
- var ciphertextLength = plaintextBuf.length + C.BYTES.bytes(16);
241
- var header = buildHeader({
242
- memoryCost: memoryCost,
243
- timeCost: timeCost,
244
- parallelism: parallelism,
245
- salt: salt,
246
- nonce: nonce,
247
- ciphertextLength: ciphertextLength,
248
- });
249
-
250
- var ct = xchacha20poly1305(wrappingKey, nonce, header).encrypt(plaintextBuf);
251
- var ctBuf = Buffer.from(ct);
252
- if (ctBuf.length !== ciphertextLength) {
253
- throw new Error("internal: ciphertext length mismatch (" + ctBuf.length + " != " + ciphertextLength + ")");
254
- }
255
- return Buffer.concat([header, ctBuf]);
256
- } finally {
257
- safeBuffer.secureZero(wrappingKey);
258
- if (weOwnPlaintextBuf) safeBuffer.secureZero(plaintextBuf);
259
- }
260
- }
261
-
262
- async function unwrap(sealed, passphrase) {
263
- var parsed = parseHeader(sealed);
264
- var ciphertext = sealed.subarray(parsed.headerEnd, parsed.headerEnd + parsed.params.ciphertextLength);
265
-
266
- var wrappingKey = await deriveWrappingKey(passphrase, parsed.params.salt, {
267
- memoryCost: parsed.params.memoryCost,
268
- timeCost: parsed.params.timeCost,
269
- parallelism: parsed.params.parallelism,
270
- });
271
-
272
- try {
273
- var pt = xchacha20poly1305(wrappingKey, parsed.params.nonce, parsed.headerBytes).decrypt(ciphertext);
274
- return Buffer.from(pt);
275
- } catch (_e) {
276
- // Any AEAD failure — wrong passphrase, header tampered, ciphertext tampered.
277
- // Deliberately do not expose which to the caller.
278
- throw new Error("Passphrase rejected or wrapped file corrupted");
279
- } finally {
280
- safeBuffer.secureZero(wrappingKey);
281
- }
282
- }
283
-
284
- module.exports = {
285
- wrap: wrap,
286
- unwrap: unwrap,
287
- buildHeader: buildHeader,
288
- parseHeader: parseHeader,
289
- deriveWrappingKey: deriveWrappingKey,
290
- MAGIC: MAGIC,
291
- FORMAT_VERSION: FORMAT_VERSION,
292
- KDF_ARGON2ID: KDF_ARGON2ID,
293
- CIPHER_XCHACHA20_POLY: CIPHER_XCHACHA20_POLY,
294
- NONCE_LENGTH: NONCE_LENGTH,
295
- DEFAULT_ARGON2: DEFAULT_ARGON2,
296
- };
1
+ "use strict";
2
+ /**
3
+ * Vault-key wrapping — passphrase-derived AEAD wrap for the framework's vault key.
4
+ *
5
+ * Format (magic 0xE2):
6
+ * byte 0: 0xE2 magic
7
+ * byte 1: format version (0x01)
8
+ * byte 2: KDF ID (0x01 Argon2id)
9
+ * byte 3: reserved (0x00)
10
+ * bytes 4-7: Argon2 memory cost (KiB, uint32 BE)
11
+ * bytes 8-9: Argon2 time cost (uint16 BE)
12
+ * byte 10: Argon2 parallelism (uint8)
13
+ * byte 11: salt length (uint8)
14
+ * bytes 12..: salt
15
+ * byte N: cipher ID (0x02 XChaCha20-Poly1305)
16
+ * byte N+1: nonce length (uint8, must be 24)
17
+ * bytes N+2..: nonce (24 bytes)
18
+ * bytes N+26..N+29: ciphertext length (uint32 BE)
19
+ * bytes N+30..: XChaCha20-Poly1305 ciphertext + tag
20
+ *
21
+ * The entire header (bytes 0 through N+29) is bound as AAD on the AEAD tag.
22
+ * Any header-byte flip therefore fails AEAD verification — prevents
23
+ * downgrade-in-header attacks on KDF params or cipher ID.
24
+ *
25
+ * This module is PURE — no filesystem I/O. Callers handle reading/writing.
26
+ * wrap() and unwrap() are async because Argon2 is async via its native binding.
27
+ */
28
+ var argon2 = require("../vendor/argon2");
29
+ var C = require("../constants");
30
+ var { xchacha20poly1305 } = require("../vendor/noble-ciphers.cjs");
31
+ var { generateBytes } = require("../crypto");
32
+ var safeBuffer = require("../safe-buffer");
33
+
34
+ // ---- Format constants ----
35
+ var MAGIC = 0xE2;
36
+ var FORMAT_VERSION = 0x01;
37
+ var KDF_ARGON2ID = 0x01;
38
+ var CIPHER_XCHACHA20_POLY = 0x02;
39
+ var NONCE_LENGTH = C.BYTES.bytes(24);
40
+
41
+ // ---- Default Argon2id parameters ----
42
+ // 64 MiB / t=3 / p=4 targets ~1s derivation on commodity 2026 hardware —
43
+ // painful for offline brute force, tolerable for an operator-initiated boot.
44
+ // memoryCost is denominated in KiB per RFC 9106 §3.1, so the 64 MiB target
45
+ // expresses as MiB→KiB through the framework's byte helpers.
46
+ var DEFAULT_ARGON2 = Object.freeze({
47
+ memoryCost: C.BYTES.mib(64) / C.BYTES.kib(1),
48
+ timeCost: 3,
49
+ parallelism: 4,
50
+ saltLength: C.BYTES.bytes(16),
51
+ hashLength: C.BYTES.bytes(32),
52
+ });
53
+
54
+ // ---- Hard bounds — reject malformed or adversarial headers ----
55
+ var MIN_SALT_LENGTH = C.BYTES.bytes(8);
56
+ var MAX_SALT_LENGTH = C.BYTES.bytes(64);
57
+ var MAX_PASSPHRASE_LENGTH = C.BYTES.kib(4);
58
+ // argon2 memoryCost is denominated in KiB per RFC 9106 §3.1, not bytes.
59
+ // Express the bound as a byte-quantity divided by KiB so the framework's
60
+ // C.BYTES helpers stay the single source of truth for the underlying scale.
61
+ var MIN_ARGON2_MEMORY = C.BYTES.mib(1) / C.BYTES.kib(1); // 1 MiB-in-KiB
62
+ var MAX_ARGON2_MEMORY = C.BYTES.gib(4) / C.BYTES.kib(1); // 4 GiB-in-KiB
63
+ var MAX_ARGON2_TIME = 100;
64
+ // Argon2 lane count cap. Hex form because the literal isn't a byte
65
+ // quantity — using C.BYTES.* would mis-name the unit at the call site.
66
+ var MAX_ARGON2_PARALLELISM = 0x20;
67
+
68
+ function buildHeader(params) {
69
+ var salt = params.salt;
70
+ var nonce = params.nonce;
71
+ if (!Buffer.isBuffer(salt) && !(salt instanceof Uint8Array)) {
72
+ throw new Error("salt must be a Buffer/Uint8Array");
73
+ }
74
+ if (!Buffer.isBuffer(nonce) && !(nonce instanceof Uint8Array)) {
75
+ throw new Error("nonce must be a Buffer/Uint8Array");
76
+ }
77
+ if (nonce.length !== NONCE_LENGTH) {
78
+ throw new Error("nonce must be " + NONCE_LENGTH + " bytes, got " + nonce.length);
79
+ }
80
+ if (salt.length < MIN_SALT_LENGTH || salt.length > MAX_SALT_LENGTH) {
81
+ throw new Error("salt length out of range [" + MIN_SALT_LENGTH + "," + MAX_SALT_LENGTH + "]: " + salt.length);
82
+ }
83
+ var saltLen = salt.length;
84
+ var headerLen = 12 + saltLen + 2 + NONCE_LENGTH + 4;
85
+ var h = Buffer.alloc(headerLen);
86
+ h[0] = MAGIC;
87
+ h[1] = FORMAT_VERSION;
88
+ h[2] = KDF_ARGON2ID;
89
+ h[3] = 0x00;
90
+ h.writeUInt32BE(params.memoryCost >>> 0, 4);
91
+ h.writeUInt16BE(params.timeCost & 0xffff, C.BYTES.bytes(8));
92
+ h[10] = params.parallelism & 0xff;
93
+ h[11] = saltLen;
94
+ Buffer.from(salt).copy(h, 12);
95
+ var pos = 12 + saltLen;
96
+ h[pos] = CIPHER_XCHACHA20_POLY;
97
+ h[pos + 1] = NONCE_LENGTH;
98
+ Buffer.from(nonce).copy(h, pos + 2);
99
+ pos += 2 + NONCE_LENGTH;
100
+ h.writeUInt32BE(params.ciphertextLength >>> 0, pos);
101
+ return h;
102
+ }
103
+
104
+ function parseHeader(buf) {
105
+ if (!Buffer.isBuffer(buf)) buf = Buffer.from(buf);
106
+ if (buf.length < 12) throw new Error("wrapped vault file too short (< 12 bytes)");
107
+ if (buf[0] !== MAGIC) {
108
+ throw new Error("not a wrapped vault file (magic byte 0x" + buf[0].toString(0x10) +
109
+ " != 0x" + MAGIC.toString(0x10) + ")");
110
+ }
111
+ if (buf[1] !== FORMAT_VERSION) {
112
+ throw new Error("unsupported wrapped-vault format version " + buf[1] + " — upgrade blamejs");
113
+ }
114
+ if (buf[2] !== KDF_ARGON2ID) {
115
+ throw new Error("unsupported KDF ID " + buf[2] + " — upgrade blamejs");
116
+ }
117
+ // byte 3 reserved
118
+
119
+ var memoryCost = buf.readUInt32BE(4);
120
+ var timeCost = buf.readUInt16BE(C.BYTES.bytes(8));
121
+ var parallelism = buf[10];
122
+ var saltLen = buf[11];
123
+
124
+ if (memoryCost < MIN_ARGON2_MEMORY || memoryCost > MAX_ARGON2_MEMORY) {
125
+ throw new Error("argon2 memory cost out of bounds: " + memoryCost + " KiB");
126
+ }
127
+ if (timeCost < 1 || timeCost > MAX_ARGON2_TIME) {
128
+ throw new Error("argon2 time cost out of bounds: " + timeCost);
129
+ }
130
+ if (parallelism < 1 || parallelism > MAX_ARGON2_PARALLELISM) {
131
+ throw new Error("argon2 parallelism out of bounds: " + parallelism);
132
+ }
133
+ if (saltLen < MIN_SALT_LENGTH || saltLen > MAX_SALT_LENGTH) {
134
+ throw new Error("salt length out of bounds: " + saltLen);
135
+ }
136
+
137
+ var saltEnd = 12 + saltLen;
138
+ if (buf.length < saltEnd + 2 + NONCE_LENGTH + 4) {
139
+ throw new Error("wrapped vault file truncated (header incomplete)");
140
+ }
141
+
142
+ var salt = Buffer.from(buf.subarray(12, saltEnd));
143
+ var cipherId = buf[saltEnd];
144
+ if (cipherId !== CIPHER_XCHACHA20_POLY) {
145
+ throw new Error("unsupported cipher ID " + cipherId + " — upgrade blamejs");
146
+ }
147
+ var nonceLen = buf[saltEnd + 1];
148
+ if (nonceLen !== NONCE_LENGTH) {
149
+ throw new Error("invalid nonce length " + nonceLen + " (expected " + NONCE_LENGTH + ")");
150
+ }
151
+ var nonce = Buffer.from(buf.subarray(saltEnd + 2, saltEnd + 2 + NONCE_LENGTH));
152
+ var ctLenPos = saltEnd + 2 + NONCE_LENGTH;
153
+ var ciphertextLength = buf.readUInt32BE(ctLenPos);
154
+ var headerEnd = ctLenPos + 4;
155
+
156
+ if (ciphertextLength < C.BYTES.bytes(16)) {
157
+ throw new Error("ciphertext length too short (< Poly1305 tag): " + ciphertextLength);
158
+ }
159
+ if (buf.length < headerEnd + ciphertextLength) {
160
+ throw new Error("wrapped vault file truncated (ciphertext length " + ciphertextLength +
161
+ " exceeds remaining " + (buf.length - headerEnd) + ")");
162
+ }
163
+
164
+ return {
165
+ params: {
166
+ memoryCost: memoryCost,
167
+ timeCost: timeCost,
168
+ parallelism: parallelism,
169
+ salt: salt,
170
+ nonce: nonce,
171
+ ciphertextLength: ciphertextLength,
172
+ },
173
+ headerEnd: headerEnd,
174
+ headerBytes: Buffer.from(buf.subarray(0, headerEnd)),
175
+ };
176
+ }
177
+
178
+ async function deriveWrappingKey(passphrase, salt, argonParams) {
179
+ argonParams = argonParams || {};
180
+ // Track whether we own pwBuf (we allocated it from a string). When the
181
+ // caller passed a Buffer directly we don't own it — zeroing would
182
+ // mutate caller state.
183
+ var weOwnPwBuf = !Buffer.isBuffer(passphrase);
184
+ var pwBuf = Buffer.isBuffer(passphrase) ? passphrase : Buffer.from(String(passphrase), "utf8");
185
+ if (pwBuf.length === 0) {
186
+ if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
187
+ throw new Error("passphrase must not be empty");
188
+ }
189
+ if (pwBuf.length > MAX_PASSPHRASE_LENGTH) {
190
+ if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
191
+ throw new Error("passphrase exceeds " + MAX_PASSPHRASE_LENGTH + " byte sanity limit");
192
+ }
193
+ var raw;
194
+ try {
195
+ raw = await argon2.hash(pwBuf, {
196
+ type: argon2.argon2id,
197
+ salt: Buffer.from(salt),
198
+ memoryCost: argonParams.memoryCost || DEFAULT_ARGON2.memoryCost,
199
+ timeCost: argonParams.timeCost || DEFAULT_ARGON2.timeCost,
200
+ parallelism: argonParams.parallelism || DEFAULT_ARGON2.parallelism,
201
+ hashLength: C.BYTES.bytes(32),
202
+ raw: true,
203
+ });
204
+ } finally {
205
+ if (weOwnPwBuf) safeBuffer.secureZero(pwBuf);
206
+ }
207
+ if (!raw || raw.length !== C.BYTES.bytes(32)) {
208
+ safeBuffer.secureZero(raw);
209
+ throw new Error("Argon2 returned unexpected hash length: " + (raw && raw.length));
210
+ }
211
+ // Buffer.from(raw) copies bytes — the original `raw` Uint8Array can be
212
+ // zeroed without affecting the returned Buffer.
213
+ var out = Buffer.from(raw);
214
+ safeBuffer.secureZero(raw);
215
+ return out;
216
+ }
217
+
218
+ async function wrap(plaintext, passphrase, opts) {
219
+ opts = opts || {};
220
+ // We own plaintextBuf only if we converted from a string. When the
221
+ // caller passed a Buffer directly we don't own it.
222
+ var weOwnPlaintextBuf = !Buffer.isBuffer(plaintext);
223
+ var plaintextBuf = Buffer.isBuffer(plaintext) ? plaintext : Buffer.from(plaintext, "utf8");
224
+
225
+ var memoryCost = opts.memoryCost || DEFAULT_ARGON2.memoryCost;
226
+ var timeCost = opts.timeCost || DEFAULT_ARGON2.timeCost;
227
+ var parallelism = opts.parallelism || DEFAULT_ARGON2.parallelism;
228
+ var saltLength = opts.saltLength || DEFAULT_ARGON2.saltLength;
229
+
230
+ var salt = opts.salt ? Buffer.from(opts.salt) : generateBytes(saltLength);
231
+ var nonce = opts.nonce ? Buffer.from(opts.nonce) : generateBytes(NONCE_LENGTH);
232
+
233
+ var wrappingKey = await deriveWrappingKey(passphrase, salt, {
234
+ memoryCost: memoryCost,
235
+ timeCost: timeCost,
236
+ parallelism: parallelism,
237
+ });
238
+
239
+ try {
240
+ var ciphertextLength = plaintextBuf.length + C.BYTES.bytes(16);
241
+ var header = buildHeader({
242
+ memoryCost: memoryCost,
243
+ timeCost: timeCost,
244
+ parallelism: parallelism,
245
+ salt: salt,
246
+ nonce: nonce,
247
+ ciphertextLength: ciphertextLength,
248
+ });
249
+
250
+ var ct = xchacha20poly1305(wrappingKey, nonce, header).encrypt(plaintextBuf);
251
+ var ctBuf = Buffer.from(ct);
252
+ if (ctBuf.length !== ciphertextLength) {
253
+ throw new Error("internal: ciphertext length mismatch (" + ctBuf.length + " != " + ciphertextLength + ")");
254
+ }
255
+ return Buffer.concat([header, ctBuf]);
256
+ } finally {
257
+ safeBuffer.secureZero(wrappingKey);
258
+ if (weOwnPlaintextBuf) safeBuffer.secureZero(plaintextBuf);
259
+ }
260
+ }
261
+
262
+ async function unwrap(sealed, passphrase) {
263
+ var parsed = parseHeader(sealed);
264
+ var ciphertext = sealed.subarray(parsed.headerEnd, parsed.headerEnd + parsed.params.ciphertextLength);
265
+
266
+ var wrappingKey = await deriveWrappingKey(passphrase, parsed.params.salt, {
267
+ memoryCost: parsed.params.memoryCost,
268
+ timeCost: parsed.params.timeCost,
269
+ parallelism: parsed.params.parallelism,
270
+ });
271
+
272
+ try {
273
+ var pt = xchacha20poly1305(wrappingKey, parsed.params.nonce, parsed.headerBytes).decrypt(ciphertext);
274
+ return Buffer.from(pt);
275
+ } catch (_e) {
276
+ // Any AEAD failure — wrong passphrase, header tampered, ciphertext tampered.
277
+ // Deliberately do not expose which to the caller.
278
+ throw new Error("Passphrase rejected or wrapped file corrupted");
279
+ } finally {
280
+ safeBuffer.secureZero(wrappingKey);
281
+ }
282
+ }
283
+
284
+ module.exports = {
285
+ wrap: wrap,
286
+ unwrap: unwrap,
287
+ buildHeader: buildHeader,
288
+ parseHeader: parseHeader,
289
+ deriveWrappingKey: deriveWrappingKey,
290
+ MAGIC: MAGIC,
291
+ FORMAT_VERSION: FORMAT_VERSION,
292
+ KDF_ARGON2ID: KDF_ARGON2ID,
293
+ CIPHER_XCHACHA20_POLY: CIPHER_XCHACHA20_POLY,
294
+ NONCE_LENGTH: NONCE_LENGTH,
295
+ DEFAULT_ARGON2: DEFAULT_ARGON2,
296
+ };