@blamejs/core 0.7.18 → 0.7.19

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 (167) hide show
  1. package/CHANGELOG.md +425 -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 +315 -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 +316 -316
  84. package/lib/middleware/db-role-for.js +264 -264
  85. package/lib/middleware/health.js +392 -392
  86. package/lib/middleware/index.js +82 -79
  87. package/lib/middleware/rate-limit.js +358 -358
  88. package/lib/middleware/request-id.js +61 -61
  89. package/lib/middleware/request-log.js +168 -168
  90. package/lib/middleware/require-auth.js +104 -104
  91. package/lib/middleware/security-headers.js +116 -116
  92. package/lib/middleware/sse.js +166 -166
  93. package/lib/migrations.js +383 -383
  94. package/lib/mtls-ca.js +518 -518
  95. package/lib/mtls-engine-default.js +481 -481
  96. package/lib/network-dns.js +632 -632
  97. package/lib/network-heartbeat.js +290 -290
  98. package/lib/network-nts.js +574 -574
  99. package/lib/network-proxy.js +265 -265
  100. package/lib/network-tls.js +328 -328
  101. package/lib/network.js +233 -233
  102. package/lib/notify.js +612 -612
  103. package/lib/ntp-check.js +229 -229
  104. package/lib/numeric-bounds.js +111 -111
  105. package/lib/object-store/azure-blob-bucket-ops.js +349 -349
  106. package/lib/object-store/azure-blob.js +488 -488
  107. package/lib/object-store/gcs-bucket-ops.js +351 -351
  108. package/lib/object-store/gcs.js +519 -519
  109. package/lib/object-store/http-put.js +153 -153
  110. package/lib/object-store/index.js +197 -197
  111. package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
  112. package/lib/object-store/sigv4.js +903 -903
  113. package/lib/observability.js +151 -151
  114. package/lib/otel-export.js +269 -269
  115. package/lib/pagination.js +464 -464
  116. package/lib/parsers/index.js +80 -80
  117. package/lib/parsers/safe-env.js +642 -642
  118. package/lib/parsers/safe-ini.js +292 -292
  119. package/lib/parsers/safe-toml.js +784 -784
  120. package/lib/parsers/safe-xml.js +390 -390
  121. package/lib/parsers/safe-yaml.js +1015 -1015
  122. package/lib/permissions.js +708 -708
  123. package/lib/pqc-agent.js +87 -87
  124. package/lib/pqc-gate.js +279 -279
  125. package/lib/protobuf-encoder.js +190 -190
  126. package/lib/protocol-dispatcher.js +161 -161
  127. package/lib/pubsub-redis.js +167 -167
  128. package/lib/pubsub.js +429 -429
  129. package/lib/queue-local.js +476 -476
  130. package/lib/queue-redis.js +745 -745
  131. package/lib/queue-sqs.js +319 -319
  132. package/lib/queue.js +695 -695
  133. package/lib/redis-client.js +519 -519
  134. package/lib/request-helpers.js +340 -340
  135. package/lib/restore-bundle.js +237 -237
  136. package/lib/restore-rollback.js +259 -259
  137. package/lib/restore.js +409 -409
  138. package/lib/retry.js +376 -376
  139. package/lib/router.js +748 -748
  140. package/lib/safe-async.js +735 -735
  141. package/lib/safe-buffer.js +237 -237
  142. package/lib/safe-json.js +541 -541
  143. package/lib/safe-schema.js +1266 -1266
  144. package/lib/safe-url.js +159 -159
  145. package/lib/scheduler.js +706 -706
  146. package/lib/security-assert.js +373 -373
  147. package/lib/seeders.js +618 -618
  148. package/lib/session.js +535 -478
  149. package/lib/slug.js +269 -269
  150. package/lib/ssrf-guard.js +401 -401
  151. package/lib/storage.js +471 -471
  152. package/lib/subject.js +281 -281
  153. package/lib/template.js +791 -791
  154. package/lib/testing.js +798 -798
  155. package/lib/time.js +310 -310
  156. package/lib/totp.js +302 -302
  157. package/lib/tracing.js +494 -494
  158. package/lib/uuid.js +132 -132
  159. package/lib/validate-opts.js +340 -340
  160. package/lib/vault/index.js +308 -308
  161. package/lib/vault/rotate.js +784 -784
  162. package/lib/vault/wrap.js +296 -296
  163. package/lib/vendor/noble-ciphers.cjs +9 -9
  164. package/lib/webhook.js +595 -595
  165. package/lib/websocket.js +1048 -1048
  166. package/package.json +77 -77
  167. package/sbom.cyclonedx.json +7 -7
package/lib/mail-dkim.js CHANGED
@@ -1,369 +1,369 @@
1
- "use strict";
2
- /**
3
- * mail-dkim — DKIM-Signature header generation for outbound mail.
4
- *
5
- * RFC 6376 (rsa-sha256) is the default; RFC 8463 (ed25519-sha256) is
6
- * available as opt-in. The two share the same signer surface so
7
- * operators flip algorithms by changing the `algorithm` opt and the
8
- * private key — no code change.
9
- *
10
- * Forward-looking: the DKIM-Signature `a=` tag carries an algorithm
11
- * identifier. When the IETF standardizes a post-quantum DKIM algorithm
12
- * (an SLH-DSA or ML-DSA variant), this module gains a third allowed
13
- * value alongside `rsa-sha256` and `ed25519-sha256`. The signer's
14
- * outer surface stays the same.
15
- *
16
- * Public API:
17
- *
18
- * var signer = b.mail.dkim.create({
19
- * domain: "example.com",
20
- * selector: "s1",
21
- * privateKey: pemString | crypto.KeyObject,
22
- * algorithm: "rsa-sha256" (default) | "ed25519-sha256"
23
- * headersToSign: ["from","to","subject","date","message-id"]
24
- * (default — order matters in the signed string)
25
- * canonicalization:"relaxed/relaxed" (default) | "simple/simple"
26
- * | "relaxed/simple" | "simple/relaxed"
27
- * bodyLength: number (optional `l=` cap; off by default)
28
- * audit: false (default true)
29
- * });
30
- *
31
- * var signedRfc822 = signer.sign(rfc822String);
32
- *
33
- * The signer never mutates the message object — it consumes the final
34
- * RFC 822 wire format produced by `mail._buildRfc822` and returns a
35
- * new string with the DKIM-Signature header prepended.
36
- *
37
- * Validation surface uses DkimError (FrameworkError subclass) with a
38
- * permanent flag — every problem here is a configuration / shape
39
- * problem, not a transient one.
40
- */
41
- var lazyRequire = require("./lazy-require");
42
- var audit = lazyRequire(function () { return require("./audit"); });
43
- var nodeCrypto = require("crypto");
44
- var safeBuffer = require("./safe-buffer");
45
- var validateOpts = require("./validate-opts");
46
- var { FrameworkError } = require("./framework-error");
47
-
48
- class DkimError extends FrameworkError {
49
- constructor(code, message) {
50
- super(message, code);
51
- this.name = "DkimError";
52
- this.permanent = true;
53
- this.isDkimError = true;
54
- }
55
- }
56
-
57
- var ALLOWED_ALGORITHMS = ["rsa-sha256", "ed25519-sha256"];
58
- var ALLOWED_CANON = [
59
- "relaxed/relaxed",
60
- "simple/simple",
61
- "relaxed/simple",
62
- "simple/relaxed",
63
- ];
64
- var DEFAULT_HEADERS = ["from", "to", "subject", "date", "message-id"];
65
-
66
- // ---- Canonicalization (RFC 6376 §3.4) ----
67
-
68
- function _canonHeaderRelaxed(name, value) {
69
- // Lowercase name, unfold continuations, collapse internal WSP runs to
70
- // single SP, strip leading/trailing WSP from value.
71
- var unfolded = String(value).replace(/\r?\n[ \t]+/g, " ");
72
- var trimmed = unfolded.replace(/[ \t]+/g, " ").replace(/^[ \t]+|[ \t]+$/g, "");
73
- return name.toLowerCase() + ":" + trimmed + "\r\n";
74
- }
75
-
76
- function _canonHeaderSimple(name, value) {
77
- // Preserve as-is. Used rarely in practice but spec-compliant.
78
- return name + ":" + value + "\r\n";
79
- }
80
-
81
- function _canonBodyRelaxed(body) {
82
- // 1) Reduce internal WSP runs in each line to a single SP, strip
83
- // trailing WSP. 2) Strip empty lines at end of body. 3) Ensure
84
- // a single trailing CRLF. Empty body → just "\r\n".
85
- if (!body) return "\r\n";
86
- var normalized = body.replace(/\r?\n/g, "\r\n");
87
- var lines = normalized.split("\r\n");
88
- for (var i = 0; i < lines.length; i++) {
89
- lines[i] = safeBuffer.stripTrailingHspace(lines[i].replace(/[ \t]+/g, " "));
90
- }
91
- // Drop trailing empty lines.
92
- while (lines.length > 0 && lines[lines.length - 1] === "") lines.pop();
93
- if (lines.length === 0) return "\r\n";
94
- return lines.join("\r\n") + "\r\n";
95
- }
96
-
97
- function _canonBodySimple(body) {
98
- // Strip trailing empty lines but otherwise preserve the body. Empty
99
- // body → "\r\n".
100
- if (!body) return "\r\n";
101
- var normalized = body.replace(/\r?\n/g, "\r\n");
102
- // Strip trailing empty lines.
103
- while (normalized.endsWith("\r\n\r\n")) {
104
- normalized = normalized.slice(0, -2);
105
- }
106
- if (!normalized.endsWith("\r\n")) normalized += "\r\n";
107
- return normalized;
108
- }
109
-
110
- // ---- RFC 822 split ----
111
-
112
- function _splitHeadersBody(rfc822) {
113
- // Headers terminated by the first empty line. Headers may use folded
114
- // continuation lines (CRLF + WSP); we keep them folded and let the
115
- // canonicalizer unfold relaxed-mode.
116
- var sep = rfc822.indexOf("\r\n\r\n");
117
- if (sep === -1) {
118
- throw new DkimError("dkim/missing-body-separator",
119
- "rfc822 input has no header/body separator (CRLF CRLF)");
120
- }
121
- return {
122
- headers: rfc822.slice(0, sep + 2), // include trailing CRLF after last header
123
- body: rfc822.slice(sep + 4),
124
- };
125
- }
126
-
127
- function _parseHeaders(rawHeaders) {
128
- // Parse into [{ name, value }, ...] preserving order. Folded
129
- // continuation lines (start with WSP) are appended to the prior
130
- // header's value verbatim.
131
- var lines = rawHeaders.split("\r\n");
132
- var out = [];
133
- for (var i = 0; i < lines.length; i++) {
134
- var line = lines[i];
135
- if (!line) continue;
136
- if (line[0] === " " || line[0] === "\t") {
137
- if (out.length > 0) out[out.length - 1].value += "\r\n" + line;
138
- continue;
139
- }
140
- var colon = line.indexOf(":");
141
- if (colon === -1) continue;
142
- out.push({
143
- name: line.slice(0, colon),
144
- value: line.slice(colon + 1), // preserve leading SP for simple canon
145
- });
146
- }
147
- return out;
148
- }
149
-
150
- // ---- Hashing + signing ----
151
-
152
- function _bodyHashB64(body, algorithm, canonBody) {
153
- var canonicalized = canonBody === "simple"
154
- ? _canonBodySimple(body)
155
- : _canonBodyRelaxed(body);
156
- var hashName = "sha256"; // both rsa-sha256 and ed25519-sha256 hash with sha256
157
- return nodeCrypto.createHash(hashName)
158
- .update(canonicalized).digest("base64");
159
- }
160
-
161
- function _signString(strToSign, privateKey, algorithm) {
162
- if (algorithm === "rsa-sha256") {
163
- return nodeCrypto.createSign("RSA-SHA256")
164
- .update(strToSign).sign(privateKey).toString("base64");
165
- }
166
- if (algorithm === "ed25519-sha256") {
167
- // Ed25519 in node:crypto signs the raw message (it hashes
168
- // internally as part of EdDSA). Per RFC 8463 the verifier still
169
- // sees `a=ed25519-sha256` because the body hash is sha256.
170
- return nodeCrypto.sign(null, Buffer.from(strToSign, "utf8"), privateKey)
171
- .toString("base64");
172
- }
173
- throw new DkimError("dkim/bad-algorithm",
174
- "unknown algorithm: " + algorithm);
175
- }
176
-
177
- // ---- Signature header construction ----
178
-
179
- function _foldSignatureHeader(unfolded) {
180
- // RFC 5322 §2.2.3 line length: 78 preferred, 998 max. The b= value
181
- // is long enough that folding helps readability and stays well clear
182
- // of the limit.
183
- var maxLine = 76;
184
- var name = "DKIM-Signature: ";
185
- var rest = unfolded;
186
- if ((name + rest).length <= maxLine) return name + rest;
187
- // Fold on tag boundaries (`; tag=value`). Keep the first chunk on
188
- // the header line, subsequent chunks on continuation lines starting
189
- // with TAB.
190
- var parts = rest.split("; ");
191
- var lines = [name + parts[0]];
192
- for (var i = 1; i < parts.length; i++) {
193
- lines.push("\t" + parts[i] + (i < parts.length - 1 ? ";" : ""));
194
- }
195
- return lines.join("\r\n");
196
- }
197
-
198
- // ---- Public surface ----
199
-
200
- function create(opts) {
201
- opts = opts || {};
202
- validateOpts(opts, [
203
- "domain", "selector", "privateKey", "algorithm",
204
- "headersToSign", "canonicalization", "bodyLength", "audit",
205
- ], "mail.dkim.create");
206
-
207
- if (typeof opts.domain !== "string" || !/^[a-z0-9.-]+\.[a-z]{2,}$/i.test(opts.domain)) {
208
- throw new DkimError("dkim/bad-domain",
209
- "domain must be a valid DNS name (e.g. 'example.com')");
210
- }
211
- if (typeof opts.selector !== "string" || !/^[a-z0-9_-]+$/i.test(opts.selector)) {
212
- throw new DkimError("dkim/bad-selector",
213
- "selector must be a non-empty token of [A-Za-z0-9_-]");
214
- }
215
- if (!opts.privateKey || (typeof opts.privateKey !== "string" &&
216
- typeof opts.privateKey !== "object")) {
217
- throw new DkimError("dkim/missing-private-key",
218
- "privateKey is required (PEM string or crypto.KeyObject)");
219
- }
220
- var algorithm = opts.algorithm || "rsa-sha256";
221
- if (ALLOWED_ALGORITHMS.indexOf(algorithm) === -1) {
222
- throw new DkimError("dkim/bad-algorithm",
223
- "algorithm must be one of: " + ALLOWED_ALGORITHMS.join(", "));
224
- }
225
- var canonicalization = opts.canonicalization || "relaxed/relaxed";
226
- if (ALLOWED_CANON.indexOf(canonicalization) === -1) {
227
- throw new DkimError("dkim/bad-canonicalization",
228
- "canonicalization must be one of: " + ALLOWED_CANON.join(", "));
229
- }
230
- var canonHeader = canonicalization.split("/")[0];
231
- var canonBody = canonicalization.split("/")[1];
232
-
233
- var headersToSign = opts.headersToSign || DEFAULT_HEADERS;
234
- if (!Array.isArray(headersToSign) || headersToSign.length === 0) {
235
- throw new DkimError("dkim/bad-headers",
236
- "headersToSign must be a non-empty array of header names");
237
- }
238
- for (var i = 0; i < headersToSign.length; i++) {
239
- if (typeof headersToSign[i] !== "string" || headersToSign[i].length === 0) {
240
- throw new DkimError("dkim/bad-headers",
241
- "headersToSign[" + i + "] must be a non-empty string");
242
- }
243
- }
244
- // The DKIM `l=` body-length tag is intentionally NOT supported.
245
- // M³AAWG, Gmail, and Microsoft 365 guidance is "never use l=" — it
246
- // enables append-after-signature attacks where an attacker appends
247
- // arbitrary content past the signed length and the DKIM signature
248
- // still validates against the original prefix. Throw at create-time
249
- // so the misconfiguration surfaces at boot, not at first send().
250
- if (opts.bodyLength !== undefined) {
251
- throw new DkimError("dkim/l-tag-forbidden",
252
- "DKIM `l=` body-length tag is forbidden — append-after-signature " +
253
- "attack vector. Remove opts.bodyLength.");
254
- }
255
-
256
- var auditOn = opts.audit !== false;
257
- // Try to parse the private key once at create time so misconfigured
258
- // operators see the failure at boot rather than at first send().
259
- var keyObject;
260
- try {
261
- keyObject = typeof opts.privateKey === "string" || Buffer.isBuffer(opts.privateKey)
262
- ? nodeCrypto.createPrivateKey({ key: opts.privateKey, format: "pem" })
263
- : opts.privateKey;
264
- } catch (e) {
265
- throw new DkimError("dkim/bad-private-key",
266
- "privateKey could not be parsed: " + ((e && e.message) || String(e)));
267
- }
268
-
269
- function _emit(action, info) {
270
- if (!auditOn) return;
271
- audit().safeEmit({
272
- action: action,
273
- outcome: info.outcome || "success",
274
- actor: info.actor || {},
275
- metadata: {
276
- domain: opts.domain,
277
- selector: opts.selector,
278
- algorithm: algorithm,
279
- bodyLength: info.bodyLength,
280
- durationMs: info.durationMs,
281
- },
282
- reason: info.reason || null,
283
- });
284
- }
285
-
286
- function sign(rfc822) {
287
- if (typeof rfc822 !== "string" || rfc822.length === 0) {
288
- throw new DkimError("dkim/bad-input",
289
- "sign() requires the rfc822 wire format as a non-empty string");
290
- }
291
- var t0 = Date.now();
292
- var split = _splitHeadersBody(rfc822);
293
- var parsedHeaders = _parseHeaders(split.headers);
294
-
295
- // Body hash. The `l=` body-length tag is forbidden at create-time
296
- // (above), so the body is always hashed in full.
297
- var body = split.body;
298
- var bh = _bodyHashB64(body, algorithm, canonBody);
299
-
300
- // Build the unsigned DKIM-Signature header (b= empty).
301
- // Tag order follows RFC 6376 examples: v, a, c, d, s, h, bh, b.
302
- var sigTags = [
303
- "v=1",
304
- "a=" + algorithm,
305
- "c=" + canonicalization,
306
- "d=" + opts.domain,
307
- "s=" + opts.selector,
308
- "h=" + headersToSign.join(":"),
309
- "bh=" + bh,
310
- ];
311
- sigTags.push("b=");
312
- var unsignedSigValue = sigTags.join("; ");
313
-
314
- // Canonicalize the header set: each header in headersToSign (in
315
- // order, picking the LAST occurrence per RFC 6376 §5.4.2), then
316
- // the DKIM-Signature header itself with empty b=. The result is
317
- // what gets signed.
318
- var headerNamesLc = parsedHeaders.map(function (h) { return h.name.toLowerCase(); });
319
- var canonicalizedHeaders = "";
320
- for (var j = 0; j < headersToSign.length; j++) {
321
- var wantLc = headersToSign[j].toLowerCase();
322
- var idx = -1;
323
- for (var k = 0; k < headerNamesLc.length; k++) {
324
- if (headerNamesLc[k] === wantLc) idx = k;
325
- }
326
- if (idx === -1) continue; // missing headers are skipped (signer's choice)
327
- var h = parsedHeaders[idx];
328
- canonicalizedHeaders += canonHeader === "simple"
329
- ? _canonHeaderSimple(h.name, h.value)
330
- : _canonHeaderRelaxed(h.name, h.value);
331
- }
332
- // Append the unsigned DKIM-Signature header without trailing CRLF
333
- // per RFC 6376 §3.7.
334
- var dkimHeaderForSigning = canonHeader === "simple"
335
- ? _canonHeaderSimple("DKIM-Signature", " " + unsignedSigValue)
336
- : _canonHeaderRelaxed("DKIM-Signature", unsignedSigValue);
337
- canonicalizedHeaders += dkimHeaderForSigning.replace(/\r\n$/, "");
338
-
339
- var signature = _signString(canonicalizedHeaders, keyObject, algorithm);
340
- // Replace the empty `b=` placeholder with the actual base64 signature.
341
- var finalSigValue = sigTags.slice(0, -1).concat(["b=" + signature]).join("; ");
342
-
343
- var dkimHeaderLine = _foldSignatureHeader(finalSigValue) + "\r\n";
344
-
345
- _emit("dkim.sign.success", {
346
- bodyLength: body.length,
347
- durationMs: Date.now() - t0,
348
- });
349
-
350
- return dkimHeaderLine + rfc822;
351
- }
352
-
353
- return {
354
- sign: sign,
355
- domain: opts.domain,
356
- selector: opts.selector,
357
- algorithm: algorithm,
358
- };
359
- }
360
-
361
- // Test-only exports for unit testing the canonicalization primitives
362
- // directly without going through a full sign() round.
363
- module.exports = {
364
- create: create,
365
- DkimError: DkimError,
366
- _canonHeaderRelaxedForTest: _canonHeaderRelaxed,
367
- _canonBodyRelaxedForTest: _canonBodyRelaxed,
368
- _canonBodySimpleForTest: _canonBodySimple,
369
- };
1
+ "use strict";
2
+ /**
3
+ * mail-dkim — DKIM-Signature header generation for outbound mail.
4
+ *
5
+ * RFC 6376 (rsa-sha256) is the default; RFC 8463 (ed25519-sha256) is
6
+ * available as opt-in. The two share the same signer surface so
7
+ * operators flip algorithms by changing the `algorithm` opt and the
8
+ * private key — no code change.
9
+ *
10
+ * Forward-looking: the DKIM-Signature `a=` tag carries an algorithm
11
+ * identifier. When the IETF standardizes a post-quantum DKIM algorithm
12
+ * (an SLH-DSA or ML-DSA variant), this module gains a third allowed
13
+ * value alongside `rsa-sha256` and `ed25519-sha256`. The signer's
14
+ * outer surface stays the same.
15
+ *
16
+ * Public API:
17
+ *
18
+ * var signer = b.mail.dkim.create({
19
+ * domain: "example.com",
20
+ * selector: "s1",
21
+ * privateKey: pemString | crypto.KeyObject,
22
+ * algorithm: "rsa-sha256" (default) | "ed25519-sha256"
23
+ * headersToSign: ["from","to","subject","date","message-id"]
24
+ * (default — order matters in the signed string)
25
+ * canonicalization:"relaxed/relaxed" (default) | "simple/simple"
26
+ * | "relaxed/simple" | "simple/relaxed"
27
+ * bodyLength: number (optional `l=` cap; off by default)
28
+ * audit: false (default true)
29
+ * });
30
+ *
31
+ * var signedRfc822 = signer.sign(rfc822String);
32
+ *
33
+ * The signer never mutates the message object — it consumes the final
34
+ * RFC 822 wire format produced by `mail._buildRfc822` and returns a
35
+ * new string with the DKIM-Signature header prepended.
36
+ *
37
+ * Validation surface uses DkimError (FrameworkError subclass) with a
38
+ * permanent flag — every problem here is a configuration / shape
39
+ * problem, not a transient one.
40
+ */
41
+ var lazyRequire = require("./lazy-require");
42
+ var audit = lazyRequire(function () { return require("./audit"); });
43
+ var nodeCrypto = require("crypto");
44
+ var safeBuffer = require("./safe-buffer");
45
+ var validateOpts = require("./validate-opts");
46
+ var { FrameworkError } = require("./framework-error");
47
+
48
+ class DkimError extends FrameworkError {
49
+ constructor(code, message) {
50
+ super(message, code);
51
+ this.name = "DkimError";
52
+ this.permanent = true;
53
+ this.isDkimError = true;
54
+ }
55
+ }
56
+
57
+ var ALLOWED_ALGORITHMS = ["rsa-sha256", "ed25519-sha256"];
58
+ var ALLOWED_CANON = [
59
+ "relaxed/relaxed",
60
+ "simple/simple",
61
+ "relaxed/simple",
62
+ "simple/relaxed",
63
+ ];
64
+ var DEFAULT_HEADERS = ["from", "to", "subject", "date", "message-id"];
65
+
66
+ // ---- Canonicalization (RFC 6376 §3.4) ----
67
+
68
+ function _canonHeaderRelaxed(name, value) {
69
+ // Lowercase name, unfold continuations, collapse internal WSP runs to
70
+ // single SP, strip leading/trailing WSP from value.
71
+ var unfolded = String(value).replace(/\r?\n[ \t]+/g, " ");
72
+ var trimmed = unfolded.replace(/[ \t]+/g, " ").replace(/^[ \t]+|[ \t]+$/g, "");
73
+ return name.toLowerCase() + ":" + trimmed + "\r\n";
74
+ }
75
+
76
+ function _canonHeaderSimple(name, value) {
77
+ // Preserve as-is. Used rarely in practice but spec-compliant.
78
+ return name + ":" + value + "\r\n";
79
+ }
80
+
81
+ function _canonBodyRelaxed(body) {
82
+ // 1) Reduce internal WSP runs in each line to a single SP, strip
83
+ // trailing WSP. 2) Strip empty lines at end of body. 3) Ensure
84
+ // a single trailing CRLF. Empty body → just "\r\n".
85
+ if (!body) return "\r\n";
86
+ var normalized = body.replace(/\r?\n/g, "\r\n");
87
+ var lines = normalized.split("\r\n");
88
+ for (var i = 0; i < lines.length; i++) {
89
+ lines[i] = safeBuffer.stripTrailingHspace(lines[i].replace(/[ \t]+/g, " "));
90
+ }
91
+ // Drop trailing empty lines.
92
+ while (lines.length > 0 && lines[lines.length - 1] === "") lines.pop();
93
+ if (lines.length === 0) return "\r\n";
94
+ return lines.join("\r\n") + "\r\n";
95
+ }
96
+
97
+ function _canonBodySimple(body) {
98
+ // Strip trailing empty lines but otherwise preserve the body. Empty
99
+ // body → "\r\n".
100
+ if (!body) return "\r\n";
101
+ var normalized = body.replace(/\r?\n/g, "\r\n");
102
+ // Strip trailing empty lines.
103
+ while (normalized.endsWith("\r\n\r\n")) {
104
+ normalized = normalized.slice(0, -2);
105
+ }
106
+ if (!normalized.endsWith("\r\n")) normalized += "\r\n";
107
+ return normalized;
108
+ }
109
+
110
+ // ---- RFC 822 split ----
111
+
112
+ function _splitHeadersBody(rfc822) {
113
+ // Headers terminated by the first empty line. Headers may use folded
114
+ // continuation lines (CRLF + WSP); we keep them folded and let the
115
+ // canonicalizer unfold relaxed-mode.
116
+ var sep = rfc822.indexOf("\r\n\r\n");
117
+ if (sep === -1) {
118
+ throw new DkimError("dkim/missing-body-separator",
119
+ "rfc822 input has no header/body separator (CRLF CRLF)");
120
+ }
121
+ return {
122
+ headers: rfc822.slice(0, sep + 2), // include trailing CRLF after last header
123
+ body: rfc822.slice(sep + 4),
124
+ };
125
+ }
126
+
127
+ function _parseHeaders(rawHeaders) {
128
+ // Parse into [{ name, value }, ...] preserving order. Folded
129
+ // continuation lines (start with WSP) are appended to the prior
130
+ // header's value verbatim.
131
+ var lines = rawHeaders.split("\r\n");
132
+ var out = [];
133
+ for (var i = 0; i < lines.length; i++) {
134
+ var line = lines[i];
135
+ if (!line) continue;
136
+ if (line[0] === " " || line[0] === "\t") {
137
+ if (out.length > 0) out[out.length - 1].value += "\r\n" + line;
138
+ continue;
139
+ }
140
+ var colon = line.indexOf(":");
141
+ if (colon === -1) continue;
142
+ out.push({
143
+ name: line.slice(0, colon),
144
+ value: line.slice(colon + 1), // preserve leading SP for simple canon
145
+ });
146
+ }
147
+ return out;
148
+ }
149
+
150
+ // ---- Hashing + signing ----
151
+
152
+ function _bodyHashB64(body, algorithm, canonBody) {
153
+ var canonicalized = canonBody === "simple"
154
+ ? _canonBodySimple(body)
155
+ : _canonBodyRelaxed(body);
156
+ var hashName = "sha256"; // both rsa-sha256 and ed25519-sha256 hash with sha256
157
+ return nodeCrypto.createHash(hashName)
158
+ .update(canonicalized).digest("base64");
159
+ }
160
+
161
+ function _signString(strToSign, privateKey, algorithm) {
162
+ if (algorithm === "rsa-sha256") {
163
+ return nodeCrypto.createSign("RSA-SHA256")
164
+ .update(strToSign).sign(privateKey).toString("base64");
165
+ }
166
+ if (algorithm === "ed25519-sha256") {
167
+ // Ed25519 in node:crypto signs the raw message (it hashes
168
+ // internally as part of EdDSA). Per RFC 8463 the verifier still
169
+ // sees `a=ed25519-sha256` because the body hash is sha256.
170
+ return nodeCrypto.sign(null, Buffer.from(strToSign, "utf8"), privateKey)
171
+ .toString("base64");
172
+ }
173
+ throw new DkimError("dkim/bad-algorithm",
174
+ "unknown algorithm: " + algorithm);
175
+ }
176
+
177
+ // ---- Signature header construction ----
178
+
179
+ function _foldSignatureHeader(unfolded) {
180
+ // RFC 5322 §2.2.3 line length: 78 preferred, 998 max. The b= value
181
+ // is long enough that folding helps readability and stays well clear
182
+ // of the limit.
183
+ var maxLine = 76;
184
+ var name = "DKIM-Signature: ";
185
+ var rest = unfolded;
186
+ if ((name + rest).length <= maxLine) return name + rest;
187
+ // Fold on tag boundaries (`; tag=value`). Keep the first chunk on
188
+ // the header line, subsequent chunks on continuation lines starting
189
+ // with TAB.
190
+ var parts = rest.split("; ");
191
+ var lines = [name + parts[0]];
192
+ for (var i = 1; i < parts.length; i++) {
193
+ lines.push("\t" + parts[i] + (i < parts.length - 1 ? ";" : ""));
194
+ }
195
+ return lines.join("\r\n");
196
+ }
197
+
198
+ // ---- Public surface ----
199
+
200
+ function create(opts) {
201
+ opts = opts || {};
202
+ validateOpts(opts, [
203
+ "domain", "selector", "privateKey", "algorithm",
204
+ "headersToSign", "canonicalization", "bodyLength", "audit",
205
+ ], "mail.dkim.create");
206
+
207
+ if (typeof opts.domain !== "string" || !/^[a-z0-9.-]+\.[a-z]{2,}$/i.test(opts.domain)) {
208
+ throw new DkimError("dkim/bad-domain",
209
+ "domain must be a valid DNS name (e.g. 'example.com')");
210
+ }
211
+ if (typeof opts.selector !== "string" || !/^[a-z0-9_-]+$/i.test(opts.selector)) {
212
+ throw new DkimError("dkim/bad-selector",
213
+ "selector must be a non-empty token of [A-Za-z0-9_-]");
214
+ }
215
+ if (!opts.privateKey || (typeof opts.privateKey !== "string" &&
216
+ typeof opts.privateKey !== "object")) {
217
+ throw new DkimError("dkim/missing-private-key",
218
+ "privateKey is required (PEM string or crypto.KeyObject)");
219
+ }
220
+ var algorithm = opts.algorithm || "rsa-sha256";
221
+ if (ALLOWED_ALGORITHMS.indexOf(algorithm) === -1) {
222
+ throw new DkimError("dkim/bad-algorithm",
223
+ "algorithm must be one of: " + ALLOWED_ALGORITHMS.join(", "));
224
+ }
225
+ var canonicalization = opts.canonicalization || "relaxed/relaxed";
226
+ if (ALLOWED_CANON.indexOf(canonicalization) === -1) {
227
+ throw new DkimError("dkim/bad-canonicalization",
228
+ "canonicalization must be one of: " + ALLOWED_CANON.join(", "));
229
+ }
230
+ var canonHeader = canonicalization.split("/")[0];
231
+ var canonBody = canonicalization.split("/")[1];
232
+
233
+ var headersToSign = opts.headersToSign || DEFAULT_HEADERS;
234
+ if (!Array.isArray(headersToSign) || headersToSign.length === 0) {
235
+ throw new DkimError("dkim/bad-headers",
236
+ "headersToSign must be a non-empty array of header names");
237
+ }
238
+ for (var i = 0; i < headersToSign.length; i++) {
239
+ if (typeof headersToSign[i] !== "string" || headersToSign[i].length === 0) {
240
+ throw new DkimError("dkim/bad-headers",
241
+ "headersToSign[" + i + "] must be a non-empty string");
242
+ }
243
+ }
244
+ // The DKIM `l=` body-length tag is intentionally NOT supported.
245
+ // M³AAWG, Gmail, and Microsoft 365 guidance is "never use l=" — it
246
+ // enables append-after-signature attacks where an attacker appends
247
+ // arbitrary content past the signed length and the DKIM signature
248
+ // still validates against the original prefix. Throw at create-time
249
+ // so the misconfiguration surfaces at boot, not at first send().
250
+ if (opts.bodyLength !== undefined) {
251
+ throw new DkimError("dkim/l-tag-forbidden",
252
+ "DKIM `l=` body-length tag is forbidden — append-after-signature " +
253
+ "attack vector. Remove opts.bodyLength.");
254
+ }
255
+
256
+ var auditOn = opts.audit !== false;
257
+ // Try to parse the private key once at create time so misconfigured
258
+ // operators see the failure at boot rather than at first send().
259
+ var keyObject;
260
+ try {
261
+ keyObject = typeof opts.privateKey === "string" || Buffer.isBuffer(opts.privateKey)
262
+ ? nodeCrypto.createPrivateKey({ key: opts.privateKey, format: "pem" })
263
+ : opts.privateKey;
264
+ } catch (e) {
265
+ throw new DkimError("dkim/bad-private-key",
266
+ "privateKey could not be parsed: " + ((e && e.message) || String(e)));
267
+ }
268
+
269
+ function _emit(action, info) {
270
+ if (!auditOn) return;
271
+ audit().safeEmit({
272
+ action: action,
273
+ outcome: info.outcome || "success",
274
+ actor: info.actor || {},
275
+ metadata: {
276
+ domain: opts.domain,
277
+ selector: opts.selector,
278
+ algorithm: algorithm,
279
+ bodyLength: info.bodyLength,
280
+ durationMs: info.durationMs,
281
+ },
282
+ reason: info.reason || null,
283
+ });
284
+ }
285
+
286
+ function sign(rfc822) {
287
+ if (typeof rfc822 !== "string" || rfc822.length === 0) {
288
+ throw new DkimError("dkim/bad-input",
289
+ "sign() requires the rfc822 wire format as a non-empty string");
290
+ }
291
+ var t0 = Date.now();
292
+ var split = _splitHeadersBody(rfc822);
293
+ var parsedHeaders = _parseHeaders(split.headers);
294
+
295
+ // Body hash. The `l=` body-length tag is forbidden at create-time
296
+ // (above), so the body is always hashed in full.
297
+ var body = split.body;
298
+ var bh = _bodyHashB64(body, algorithm, canonBody);
299
+
300
+ // Build the unsigned DKIM-Signature header (b= empty).
301
+ // Tag order follows RFC 6376 examples: v, a, c, d, s, h, bh, b.
302
+ var sigTags = [
303
+ "v=1",
304
+ "a=" + algorithm,
305
+ "c=" + canonicalization,
306
+ "d=" + opts.domain,
307
+ "s=" + opts.selector,
308
+ "h=" + headersToSign.join(":"),
309
+ "bh=" + bh,
310
+ ];
311
+ sigTags.push("b=");
312
+ var unsignedSigValue = sigTags.join("; ");
313
+
314
+ // Canonicalize the header set: each header in headersToSign (in
315
+ // order, picking the LAST occurrence per RFC 6376 §5.4.2), then
316
+ // the DKIM-Signature header itself with empty b=. The result is
317
+ // what gets signed.
318
+ var headerNamesLc = parsedHeaders.map(function (h) { return h.name.toLowerCase(); });
319
+ var canonicalizedHeaders = "";
320
+ for (var j = 0; j < headersToSign.length; j++) {
321
+ var wantLc = headersToSign[j].toLowerCase();
322
+ var idx = -1;
323
+ for (var k = 0; k < headerNamesLc.length; k++) {
324
+ if (headerNamesLc[k] === wantLc) idx = k;
325
+ }
326
+ if (idx === -1) continue; // missing headers are skipped (signer's choice)
327
+ var h = parsedHeaders[idx];
328
+ canonicalizedHeaders += canonHeader === "simple"
329
+ ? _canonHeaderSimple(h.name, h.value)
330
+ : _canonHeaderRelaxed(h.name, h.value);
331
+ }
332
+ // Append the unsigned DKIM-Signature header without trailing CRLF
333
+ // per RFC 6376 §3.7.
334
+ var dkimHeaderForSigning = canonHeader === "simple"
335
+ ? _canonHeaderSimple("DKIM-Signature", " " + unsignedSigValue)
336
+ : _canonHeaderRelaxed("DKIM-Signature", unsignedSigValue);
337
+ canonicalizedHeaders += dkimHeaderForSigning.replace(/\r\n$/, "");
338
+
339
+ var signature = _signString(canonicalizedHeaders, keyObject, algorithm);
340
+ // Replace the empty `b=` placeholder with the actual base64 signature.
341
+ var finalSigValue = sigTags.slice(0, -1).concat(["b=" + signature]).join("; ");
342
+
343
+ var dkimHeaderLine = _foldSignatureHeader(finalSigValue) + "\r\n";
344
+
345
+ _emit("dkim.sign.success", {
346
+ bodyLength: body.length,
347
+ durationMs: Date.now() - t0,
348
+ });
349
+
350
+ return dkimHeaderLine + rfc822;
351
+ }
352
+
353
+ return {
354
+ sign: sign,
355
+ domain: opts.domain,
356
+ selector: opts.selector,
357
+ algorithm: algorithm,
358
+ };
359
+ }
360
+
361
+ // Test-only exports for unit testing the canonicalization primitives
362
+ // directly without going through a full sign() round.
363
+ module.exports = {
364
+ create: create,
365
+ DkimError: DkimError,
366
+ _canonHeaderRelaxedForTest: _canonHeaderRelaxed,
367
+ _canonBodyRelaxedForTest: _canonBodyRelaxed,
368
+ _canonBodySimpleForTest: _canonBodySimple,
369
+ };