@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/cookies.js CHANGED
@@ -1,315 +1,350 @@
1
- "use strict";
2
- /**
3
- * cookies — cookie parse/serialize + access-gated sealed cookies.
4
- *
5
- * RFC 6265 cookie plumbing the framework was duplicating across
6
- * middleware: a parser in attach-user, ad-hoc Set-Cookie strings in
7
- * route handlers, no shared place for attribute defaults. This is the
8
- * single primitive.
9
- *
10
- * Two surfaces:
11
- *
12
- * 1. Module-level (stateless): cookies.parse / cookies.serialize.
13
- * Useful in test fixtures and code that doesn't have a vault.
14
- *
15
- * 2. Instance (cookies.create): bound defaults for cookie attributes,
16
- * a wired vault for sealed reads/writes, and req/res helpers.
17
- *
18
- * var cookies = b.cookies.create({
19
- * vault: b.vault, // required for sealed* methods
20
- * defaults: {
21
- * httpOnly: true,
22
- * secure: true, // default true; HTTPS expected
23
- * sameSite: "Lax",
24
- * path: "/",
25
- * maxAge: 7 * 86400, // seconds
26
- * },
27
- * });
28
- *
29
- * cookies.parse("a=1; b=2") → { a: "1", b: "2" }
30
- * cookies.serialize("name", "v",
31
- * { maxAge: 3600 }) → "name=v; Max-Age=3600; Path=/; HttpOnly; SameSite=Lax; Secure"
32
- *
33
- * cookies.read(req, "name") → "v" or null
34
- * cookies.write(res, "name", "v", {}) // appends to existing Set-Cookie
35
- * cookies.clear(res, "name", {}) // expire by Max-Age=0
36
- *
37
- * cookies.writeSealed(res, "session", sid) // vault.seal then write
38
- * cookies.readSealed(req, "session") // read then vault.unseal
39
- *
40
- * Sealed-cookie purpose: the cookie value is a vault.seal of the real
41
- * value. Without the framework's vault key, no client can hand-craft a
42
- * valid cookie value, so the API is unreachable via curl-with-arbitrary-
43
- * cookies or any tool that hasn't been through the framework's crypto
44
- * flow. The vault prefix is stripped on write and re-added on read so
45
- * the cookie carries only the base64 envelope.
46
- *
47
- * Defense in serialize/parse:
48
- * - Cookie name must be a valid token (no CTLs, no separator chars).
49
- * - Cookie value must not contain CRLF, semicolon, or comma.
50
- * - Value is percent-encoded on write, percent-decoded on read.
51
- * - Domain / Path are CRLF-stripped to defeat header injection
52
- * attempts via operator-controlled but improperly-escaped inputs.
53
- */
54
-
55
- var C = require("./constants");
56
- var validateOpts = require("./validate-opts");
57
- var { FrameworkError } = require("./framework-error");
58
-
59
- class CookieError extends FrameworkError {
60
- constructor(code, message) {
61
- super(message, code);
62
- this.name = "CookieError";
63
- this.permanent = true;
64
- this.isCookieError = true;
65
- }
66
- }
67
-
68
- // RFC 6265 cookie-name token: VCHAR minus separators. Reject anything
69
- // outside this range — embeddings of CTLs / separators / whitespace
70
- // would break parsing on the next hop.
71
- var TOKEN_RE = /^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/;
72
- // Reject CRLF, NUL, semicolon, comma in cookie value pre-encoding.
73
- var FORBIDDEN_VALUE_RE = /[\r\n\0;,]/;
74
-
75
- // Length caps applied before the regex tests so a hostile caller can't
76
- // stage a pathological-length input against the engine. RFC 6265 doesn't
77
- // pin a name/value length; browsers vary, with a practical 4 KiB total
78
- // envelope. The framework caps name + value to leave headroom.
79
- var MAX_NAME_LENGTH = C.BYTES.bytes(256);
80
- var MAX_VALUE_LENGTH = C.BYTES.kib(4);
81
-
82
- function _validateName(name) {
83
- if (typeof name !== "string" || name.length === 0) {
84
- throw new CookieError("cookies/invalid-name",
85
- "cookie name must be a non-empty string");
86
- }
87
- // Length cap before the regex test — bound the engine on hostile
88
- // input lengths even though the regex is anchored.
89
- if (name.length > MAX_NAME_LENGTH || !TOKEN_RE.test(name)) {
90
- throw new CookieError("cookies/invalid-name",
91
- "cookie name '" + name + "' is empty, too long, or contains forbidden characters");
92
- }
93
- }
94
-
95
- function _validateValue(value) {
96
- if (typeof value !== "string") {
97
- throw new CookieError("cookies/invalid-value",
98
- "cookie value must be a string");
99
- }
100
- // Length cap before the regex test (defense in depth — the regex
101
- // here is a simple character class, but the same discipline that
102
- // bounds longer regexes elsewhere applies).
103
- if (value.length > MAX_VALUE_LENGTH || FORBIDDEN_VALUE_RE.test(value)) {
104
- throw new CookieError("cookies/invalid-value",
105
- "cookie value is too long or contains forbidden control character (CRLF/NUL/;/,)");
106
- }
107
- }
108
-
109
- // Strip CRLF/NUL defensively from operator-supplied attribute strings
110
- // (Domain, Path, SameSite). Even if the attribute is constant in the
111
- // caller's code, attribute strings flow into Set-Cookie which is a
112
- // header — never trust unscrubbed values reach the wire.
113
- function _scrubAttr(s) {
114
- if (typeof s !== "string") return s;
115
- return s.replace(/[\r\n\0]/g, "");
116
- }
117
-
118
- function parse(cookieHeader) {
119
- var out = {};
120
- if (typeof cookieHeader !== "string" || cookieHeader.length === 0) return out;
121
- var pairs = cookieHeader.split(/;\s*/);
122
- for (var i = 0; i < pairs.length; i++) {
123
- var pair = pairs[i];
124
- if (!pair) continue;
125
- var eq = pair.indexOf("=");
126
- if (eq < 0) continue;
127
- var k = pair.slice(0, eq).trim();
128
- if (!k) continue;
129
- var v = pair.slice(eq + 1).trim();
130
- // Strip surrounding double-quotes per RFC 6265 §5.2.
131
- if (v.length >= 2 && v.charAt(0) === '"' && v.charAt(v.length - 1) === '"') {
132
- v = v.slice(1, -1);
133
- }
134
- try { v = decodeURIComponent(v); }
135
- catch (_e) { /* malformed encoding — keep raw */ }
136
- // Last write wins per RFC; matches every browser's behavior.
137
- out[k] = v;
138
- }
139
- return out;
140
- }
141
-
142
- function serialize(name, value, attrs) {
143
- _validateName(name);
144
- _validateValue(value);
145
- attrs = attrs || {};
146
-
147
- var parts = [name + "=" + encodeURIComponent(value)];
148
-
149
- if (attrs.maxAge !== undefined && attrs.maxAge !== null) {
150
- var maxAge = Number(attrs.maxAge);
151
- if (!Number.isFinite(maxAge) || Math.floor(maxAge) !== maxAge) {
152
- throw new CookieError("cookies/invalid-attr",
153
- "cookie attr maxAge must be an integer (seconds)");
154
- }
155
- parts.push("Max-Age=" + maxAge);
156
- }
157
- if (attrs.expires !== undefined && attrs.expires !== null) {
158
- var d = attrs.expires instanceof Date ? attrs.expires : new Date(attrs.expires);
159
- if (isNaN(d.getTime())) {
160
- throw new CookieError("cookies/invalid-attr",
161
- "cookie attr expires must be a Date or parseable date string");
162
- }
163
- parts.push("Expires=" + d.toUTCString());
164
- }
165
- if (attrs.domain) {
166
- var dom = _scrubAttr(String(attrs.domain));
167
- // RFC 6265 §4.1.2.3 + §5.1.3: Domain attribute is a host name.
168
- // A leading "." is tolerated by browsers (legacy form). Anything
169
- // else (URLs, paths, spaces, scheme prefixes) makes browsers
170
- // either ignore the cookie or apply it inconsistently.
171
- if (!/^\.?[a-z0-9]([a-z0-9.-]*[a-z0-9])?$/i.test(dom)) {
172
- throw new CookieError("cookies/invalid-attr",
173
- "cookie attr domain must be a valid host name " +
174
- "(letters/digits/dots/hyphens, optional leading dot), got " + JSON.stringify(dom));
175
- }
176
- parts.push("Domain=" + dom);
177
- }
178
- if (attrs.path !== undefined && attrs.path !== null) {
179
- parts.push("Path=" + _scrubAttr(String(attrs.path)));
180
- }
181
- if (attrs.httpOnly) parts.push("HttpOnly");
182
- if (attrs.sameSite) {
183
- var ss = String(attrs.sameSite);
184
- var ssLow = ss.toLowerCase();
185
- var ssNorm;
186
- if (ssLow === "strict") ssNorm = "Strict";
187
- else if (ssLow === "lax") ssNorm = "Lax";
188
- else if (ssLow === "none") ssNorm = "None";
189
- else throw new CookieError("cookies/invalid-attr",
190
- "cookie attr sameSite must be Strict, Lax, or None");
191
- parts.push("SameSite=" + ssNorm);
192
- // SameSite=None requires Secure per spec; force it on so operators
193
- // don't ship a cookie that browsers silently drop.
194
- if (ssNorm === "None") attrs = Object.assign({}, attrs, { secure: true });
195
- }
196
- if (attrs.secure) parts.push("Secure");
197
- if (attrs.partitioned) parts.push("Partitioned");
198
- if (attrs.priority) {
199
- var p = String(attrs.priority);
200
- var pLow = p.toLowerCase();
201
- var pNorm;
202
- if (pLow === "low") pNorm = "Low";
203
- else if (pLow === "medium") pNorm = "Medium";
204
- else if (pLow === "high") pNorm = "High";
205
- else throw new CookieError("cookies/invalid-attr",
206
- "cookie attr priority must be Low, Medium, or High");
207
- parts.push("Priority=" + pNorm);
208
- }
209
- return parts.join("; ");
210
- }
211
-
212
- // Append a Set-Cookie header preserving any already on the response.
213
- function _appendSetCookie(res, header) {
214
- if (!res || typeof res.setHeader !== "function") {
215
- throw new CookieError("cookies/no-set-header",
216
- "response object has no setHeader (not a Node http.ServerResponse?)");
217
- }
218
- var existing;
219
- if (typeof res.getHeader === "function") existing = res.getHeader("Set-Cookie");
220
- var arr;
221
- if (Array.isArray(existing)) arr = existing.slice();
222
- else if (existing !== undefined) arr = [existing];
223
- else arr = [];
224
- arr.push(header);
225
- res.setHeader("Set-Cookie", arr);
226
- }
227
-
228
- function _readCookieFromReq(req, name) {
229
- if (!req || !req.headers) return null;
230
- var header = req.headers.cookie;
231
- if (!header) return null;
232
- var jar = parse(header);
233
- return Object.prototype.hasOwnProperty.call(jar, name) ? jar[name] : null;
234
- }
235
-
236
- function create(opts) {
237
- opts = opts || {};
238
- validateOpts(opts, ["vault", "defaults"], "b.cookies");
239
- var vault = opts.vault || null;
240
- // Defaults applied on every write unless the per-call attrs override.
241
- // secure defaults to true: cookies should never be sent in cleartext;
242
- // operators developing locally over http opt out explicitly.
243
- var defaults = Object.assign({
244
- httpOnly: true,
245
- secure: true,
246
- sameSite: "Lax",
247
- path: "/",
248
- }, opts.defaults || {});
249
-
250
- function _mergeAttrs(callerAttrs) {
251
- return Object.assign({}, defaults, callerAttrs || {});
252
- }
253
-
254
- function read(req, name) { return _readCookieFromReq(req, name); }
255
- function write(res, name, value, attrs) {
256
- _appendSetCookie(res, serialize(name, value, _mergeAttrs(attrs)));
257
- }
258
- function clear(res, name, attrs) {
259
- // Expire-now cookie. Domain + Path must match the original write
260
- // for the browser to actually delete it — operators pass the same
261
- // attrs they used on write (or rely on the same defaults).
262
- var attrsExp = Object.assign({}, _mergeAttrs(attrs), { maxAge: 0 });
263
- delete attrsExp.expires;
264
- _appendSetCookie(res, serialize(name, "", attrsExp));
265
- }
266
-
267
- function _requireVault() {
268
- if (!vault || typeof vault.seal !== "function" || typeof vault.unseal !== "function") {
269
- throw new CookieError("cookies/no-vault",
270
- "sealed cookies require opts.vault (a value with .seal/.unseal)");
271
- }
272
- }
273
-
274
- // Vault.seal returns "vault:<base64>". We strip the constant prefix
275
- // on the wire to keep cookies short, and re-add it before unseal.
276
- // Within a vault major version the prefix is stable for the cookie's
277
- // entire Max-Age window, so this is safe.
278
- function writeSealed(res, name, value, attrs) {
279
- _requireVault();
280
- if (typeof value !== "string") {
281
- throw new CookieError("cookies/invalid-value",
282
- "sealed cookie value must be a string before sealing");
283
- }
284
- var sealed = vault.seal(value);
285
- var stripped = sealed.startsWith(C.VAULT_PREFIX)
286
- ? sealed.substring(C.VAULT_PREFIX.length)
287
- : sealed;
288
- write(res, name, stripped, attrs);
289
- }
290
- function readSealed(req, name) {
291
- _requireVault();
292
- var raw = _readCookieFromReq(req, name);
293
- if (raw === null) return null;
294
- try { return vault.unseal(C.VAULT_PREFIX + raw); }
295
- catch (_e) { return null; }
296
- }
297
-
298
- return {
299
- parse: parse,
300
- serialize: function (n, v, a) { return serialize(n, v, _mergeAttrs(a)); },
301
- read: read,
302
- write: write,
303
- clear: clear,
304
- writeSealed: writeSealed,
305
- readSealed: readSealed,
306
- defaults: defaults,
307
- };
308
- }
309
-
310
- module.exports = {
311
- create: create,
312
- parse: parse,
313
- serialize: serialize,
314
- CookieError: CookieError,
315
- };
1
+ "use strict";
2
+ /**
3
+ * cookies — cookie parse/serialize + access-gated sealed cookies.
4
+ *
5
+ * RFC 6265 cookie plumbing the framework was duplicating across
6
+ * middleware: a parser in attach-user, ad-hoc Set-Cookie strings in
7
+ * route handlers, no shared place for attribute defaults. This is the
8
+ * single primitive.
9
+ *
10
+ * Two surfaces:
11
+ *
12
+ * 1. Module-level (stateless): cookies.parse / cookies.serialize.
13
+ * Useful in test fixtures and code that doesn't have a vault.
14
+ *
15
+ * 2. Instance (cookies.create): bound defaults for cookie attributes,
16
+ * a wired vault for sealed reads/writes, and req/res helpers.
17
+ *
18
+ * var cookies = b.cookies.create({
19
+ * vault: b.vault, // required for sealed* methods
20
+ * defaults: {
21
+ * httpOnly: true,
22
+ * secure: true, // default true; HTTPS expected
23
+ * sameSite: "Lax",
24
+ * path: "/",
25
+ * maxAge: 7 * 86400, // seconds
26
+ * },
27
+ * });
28
+ *
29
+ * cookies.parse("a=1; b=2") → { a: "1", b: "2" }
30
+ * cookies.serialize("name", "v",
31
+ * { maxAge: 3600 }) → "name=v; Max-Age=3600; Path=/; HttpOnly; SameSite=Lax; Secure"
32
+ *
33
+ * cookies.read(req, "name") → "v" or null
34
+ * cookies.write(res, "name", "v", {}) // appends to existing Set-Cookie
35
+ * cookies.clear(res, "name", {}) // expire by Max-Age=0
36
+ *
37
+ * cookies.writeSealed(res, "session", sid) // vault.seal then write
38
+ * cookies.readSealed(req, "session") // read then vault.unseal
39
+ *
40
+ * Sealed-cookie purpose: the cookie value is a vault.seal of the real
41
+ * value. Without the framework's vault key, no client can hand-craft a
42
+ * valid cookie value, so the API is unreachable via curl-with-arbitrary-
43
+ * cookies or any tool that hasn't been through the framework's crypto
44
+ * flow. The vault prefix is stripped on write and re-added on read so
45
+ * the cookie carries only the base64 envelope.
46
+ *
47
+ * Defense in serialize/parse:
48
+ * - Cookie name must be a valid token (no CTLs, no separator chars).
49
+ * - Cookie value must not contain CRLF, semicolon, or comma.
50
+ * - Value is percent-encoded on write, percent-decoded on read.
51
+ * - Domain / Path are CRLF-stripped to defeat header injection
52
+ * attempts via operator-controlled but improperly-escaped inputs.
53
+ */
54
+
55
+ var C = require("./constants");
56
+ var validateOpts = require("./validate-opts");
57
+ var { FrameworkError } = require("./framework-error");
58
+
59
+ class CookieError extends FrameworkError {
60
+ constructor(code, message) {
61
+ super(message, code);
62
+ this.name = "CookieError";
63
+ this.permanent = true;
64
+ this.isCookieError = true;
65
+ }
66
+ }
67
+
68
+ // RFC 6265 cookie-name token: VCHAR minus separators. Reject anything
69
+ // outside this range — embeddings of CTLs / separators / whitespace
70
+ // would break parsing on the next hop.
71
+ var TOKEN_RE = /^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/;
72
+ // Reject CRLF, NUL, semicolon, comma in cookie value pre-encoding.
73
+ var FORBIDDEN_VALUE_RE = /[\r\n\0;,]/;
74
+
75
+ // Length caps applied before the regex tests so a hostile caller can't
76
+ // stage a pathological-length input against the engine. RFC 6265 doesn't
77
+ // pin a name/value length; browsers vary, with a practical 4 KiB total
78
+ // envelope. The framework caps name + value to leave headroom.
79
+ var MAX_NAME_LENGTH = C.BYTES.bytes(256);
80
+ var MAX_VALUE_LENGTH = C.BYTES.kib(4);
81
+
82
+ function _validateName(name) {
83
+ if (typeof name !== "string" || name.length === 0) {
84
+ throw new CookieError("cookies/invalid-name",
85
+ "cookie name must be a non-empty string");
86
+ }
87
+ // Length cap before the regex test — bound the engine on hostile
88
+ // input lengths even though the regex is anchored.
89
+ if (name.length > MAX_NAME_LENGTH || !TOKEN_RE.test(name)) {
90
+ throw new CookieError("cookies/invalid-name",
91
+ "cookie name '" + name + "' is empty, too long, or contains forbidden characters");
92
+ }
93
+ }
94
+
95
+ function _validateValue(value) {
96
+ if (typeof value !== "string") {
97
+ throw new CookieError("cookies/invalid-value",
98
+ "cookie value must be a string");
99
+ }
100
+ // Length cap before the regex test (defense in depth — the regex
101
+ // here is a simple character class, but the same discipline that
102
+ // bounds longer regexes elsewhere applies).
103
+ if (value.length > MAX_VALUE_LENGTH || FORBIDDEN_VALUE_RE.test(value)) {
104
+ throw new CookieError("cookies/invalid-value",
105
+ "cookie value is too long or contains forbidden control character (CRLF/NUL/;/,)");
106
+ }
107
+ }
108
+
109
+ // Strip CRLF/NUL defensively from operator-supplied attribute strings
110
+ // (Domain, Path, SameSite). Even if the attribute is constant in the
111
+ // caller's code, attribute strings flow into Set-Cookie which is a
112
+ // header — never trust unscrubbed values reach the wire.
113
+ function _scrubAttr(s) {
114
+ if (typeof s !== "string") return s;
115
+ return s.replace(/[\r\n\0]/g, "");
116
+ }
117
+
118
+ function parse(cookieHeader) {
119
+ var out = {};
120
+ if (typeof cookieHeader !== "string" || cookieHeader.length === 0) return out;
121
+ var pairs = cookieHeader.split(/;\s*/);
122
+ for (var i = 0; i < pairs.length; i++) {
123
+ var pair = pairs[i];
124
+ if (!pair) continue;
125
+ var eq = pair.indexOf("=");
126
+ if (eq < 0) continue;
127
+ var k = pair.slice(0, eq).trim();
128
+ if (!k) continue;
129
+ var v = pair.slice(eq + 1).trim();
130
+ // Strip surrounding double-quotes per RFC 6265 §5.2.
131
+ if (v.length >= 2 && v.charAt(0) === '"' && v.charAt(v.length - 1) === '"') {
132
+ v = v.slice(1, -1);
133
+ }
134
+ try { v = decodeURIComponent(v); }
135
+ catch (_e) { /* malformed encoding — keep raw */ }
136
+ // Last write wins per RFC; matches every browser's behavior.
137
+ out[k] = v;
138
+ }
139
+ return out;
140
+ }
141
+
142
+ function serialize(name, value, attrs) {
143
+ _validateName(name);
144
+ _validateValue(value);
145
+ attrs = attrs || {};
146
+
147
+ // RFC 6265bis §4.1.3 cookie-prefix invariants refused at serialize-
148
+ // time so an operator-side typo doesn't ship a broken cookie that
149
+ // browsers silently reject (and the operator wonders why their cookie
150
+ // never sets).
151
+ //
152
+ // __Secure-* MUST be Secure
153
+ // __Host-* — MUST be Secure, Path=/, NO Domain
154
+ //
155
+ // Caught at the source so every caller (csrf-protect / session /
156
+ // operator) gets the same enforcement.
157
+ if (name.indexOf("__Secure-") === 0) {
158
+ if (attrs.secure !== true) {
159
+ throw new CookieError("cookies/prefix-secure-required",
160
+ "__Secure-* cookies MUST set Secure (RFC 6265bis §4.1.3.1) — got '" +
161
+ name + "' without secure: true");
162
+ }
163
+ }
164
+ if (name.indexOf("__Host-") === 0) {
165
+ if (attrs.secure !== true) {
166
+ throw new CookieError("cookies/prefix-host-secure-required",
167
+ "__Host-* cookies MUST set Secure (RFC 6265bis §4.1.3.2) got '" +
168
+ name + "' without secure: true");
169
+ }
170
+ if (attrs.path !== "/") {
171
+ throw new CookieError("cookies/prefix-host-path-required",
172
+ "__Host-* cookies MUST set Path=/ (RFC 6265bis §4.1.3.2) — got '" +
173
+ name + "' with path=" + JSON.stringify(attrs.path || "<unset>"));
174
+ }
175
+ if (attrs.domain) {
176
+ throw new CookieError("cookies/prefix-host-no-domain",
177
+ "__Host-* cookies MUST NOT set Domain (RFC 6265bis §4.1.3.2) — got '" +
178
+ name + "' with domain=" + JSON.stringify(attrs.domain));
179
+ }
180
+ }
181
+
182
+ var parts = [name + "=" + encodeURIComponent(value)];
183
+
184
+ if (attrs.maxAge !== undefined && attrs.maxAge !== null) {
185
+ var maxAge = Number(attrs.maxAge);
186
+ if (!Number.isFinite(maxAge) || Math.floor(maxAge) !== maxAge) {
187
+ throw new CookieError("cookies/invalid-attr",
188
+ "cookie attr maxAge must be an integer (seconds)");
189
+ }
190
+ parts.push("Max-Age=" + maxAge);
191
+ }
192
+ if (attrs.expires !== undefined && attrs.expires !== null) {
193
+ var d = attrs.expires instanceof Date ? attrs.expires : new Date(attrs.expires);
194
+ if (isNaN(d.getTime())) {
195
+ throw new CookieError("cookies/invalid-attr",
196
+ "cookie attr expires must be a Date or parseable date string");
197
+ }
198
+ parts.push("Expires=" + d.toUTCString());
199
+ }
200
+ if (attrs.domain) {
201
+ var dom = _scrubAttr(String(attrs.domain));
202
+ // RFC 6265 §4.1.2.3 + §5.1.3: Domain attribute is a host name.
203
+ // A leading "." is tolerated by browsers (legacy form). Anything
204
+ // else (URLs, paths, spaces, scheme prefixes) makes browsers
205
+ // either ignore the cookie or apply it inconsistently.
206
+ if (!/^\.?[a-z0-9]([a-z0-9.-]*[a-z0-9])?$/i.test(dom)) {
207
+ throw new CookieError("cookies/invalid-attr",
208
+ "cookie attr domain must be a valid host name " +
209
+ "(letters/digits/dots/hyphens, optional leading dot), got " + JSON.stringify(dom));
210
+ }
211
+ parts.push("Domain=" + dom);
212
+ }
213
+ if (attrs.path !== undefined && attrs.path !== null) {
214
+ parts.push("Path=" + _scrubAttr(String(attrs.path)));
215
+ }
216
+ if (attrs.httpOnly) parts.push("HttpOnly");
217
+ if (attrs.sameSite) {
218
+ var ss = String(attrs.sameSite);
219
+ var ssLow = ss.toLowerCase();
220
+ var ssNorm;
221
+ if (ssLow === "strict") ssNorm = "Strict";
222
+ else if (ssLow === "lax") ssNorm = "Lax";
223
+ else if (ssLow === "none") ssNorm = "None";
224
+ else throw new CookieError("cookies/invalid-attr",
225
+ "cookie attr sameSite must be Strict, Lax, or None");
226
+ parts.push("SameSite=" + ssNorm);
227
+ // SameSite=None requires Secure per spec; force it on so operators
228
+ // don't ship a cookie that browsers silently drop.
229
+ if (ssNorm === "None") attrs = Object.assign({}, attrs, { secure: true });
230
+ }
231
+ if (attrs.secure) parts.push("Secure");
232
+ if (attrs.partitioned) parts.push("Partitioned");
233
+ if (attrs.priority) {
234
+ var p = String(attrs.priority);
235
+ var pLow = p.toLowerCase();
236
+ var pNorm;
237
+ if (pLow === "low") pNorm = "Low";
238
+ else if (pLow === "medium") pNorm = "Medium";
239
+ else if (pLow === "high") pNorm = "High";
240
+ else throw new CookieError("cookies/invalid-attr",
241
+ "cookie attr priority must be Low, Medium, or High");
242
+ parts.push("Priority=" + pNorm);
243
+ }
244
+ return parts.join("; ");
245
+ }
246
+
247
+ // Append a Set-Cookie header preserving any already on the response.
248
+ function _appendSetCookie(res, header) {
249
+ if (!res || typeof res.setHeader !== "function") {
250
+ throw new CookieError("cookies/no-set-header",
251
+ "response object has no setHeader (not a Node http.ServerResponse?)");
252
+ }
253
+ var existing;
254
+ if (typeof res.getHeader === "function") existing = res.getHeader("Set-Cookie");
255
+ var arr;
256
+ if (Array.isArray(existing)) arr = existing.slice();
257
+ else if (existing !== undefined) arr = [existing];
258
+ else arr = [];
259
+ arr.push(header);
260
+ res.setHeader("Set-Cookie", arr);
261
+ }
262
+
263
+ function _readCookieFromReq(req, name) {
264
+ if (!req || !req.headers) return null;
265
+ var header = req.headers.cookie;
266
+ if (!header) return null;
267
+ var jar = parse(header);
268
+ return Object.prototype.hasOwnProperty.call(jar, name) ? jar[name] : null;
269
+ }
270
+
271
+ function create(opts) {
272
+ opts = opts || {};
273
+ validateOpts(opts, ["vault", "defaults"], "b.cookies");
274
+ var vault = opts.vault || null;
275
+ // Defaults applied on every write unless the per-call attrs override.
276
+ // secure defaults to true: cookies should never be sent in cleartext;
277
+ // operators developing locally over http opt out explicitly.
278
+ var defaults = Object.assign({
279
+ httpOnly: true,
280
+ secure: true,
281
+ sameSite: "Lax",
282
+ path: "/",
283
+ }, opts.defaults || {});
284
+
285
+ function _mergeAttrs(callerAttrs) {
286
+ return Object.assign({}, defaults, callerAttrs || {});
287
+ }
288
+
289
+ function read(req, name) { return _readCookieFromReq(req, name); }
290
+ function write(res, name, value, attrs) {
291
+ _appendSetCookie(res, serialize(name, value, _mergeAttrs(attrs)));
292
+ }
293
+ function clear(res, name, attrs) {
294
+ // Expire-now cookie. Domain + Path must match the original write
295
+ // for the browser to actually delete it — operators pass the same
296
+ // attrs they used on write (or rely on the same defaults).
297
+ var attrsExp = Object.assign({}, _mergeAttrs(attrs), { maxAge: 0 });
298
+ delete attrsExp.expires;
299
+ _appendSetCookie(res, serialize(name, "", attrsExp));
300
+ }
301
+
302
+ function _requireVault() {
303
+ if (!vault || typeof vault.seal !== "function" || typeof vault.unseal !== "function") {
304
+ throw new CookieError("cookies/no-vault",
305
+ "sealed cookies require opts.vault (a value with .seal/.unseal)");
306
+ }
307
+ }
308
+
309
+ // Vault.seal returns "vault:<base64>". We strip the constant prefix
310
+ // on the wire to keep cookies short, and re-add it before unseal.
311
+ // Within a vault major version the prefix is stable for the cookie's
312
+ // entire Max-Age window, so this is safe.
313
+ function writeSealed(res, name, value, attrs) {
314
+ _requireVault();
315
+ if (typeof value !== "string") {
316
+ throw new CookieError("cookies/invalid-value",
317
+ "sealed cookie value must be a string before sealing");
318
+ }
319
+ var sealed = vault.seal(value);
320
+ var stripped = sealed.startsWith(C.VAULT_PREFIX)
321
+ ? sealed.substring(C.VAULT_PREFIX.length)
322
+ : sealed;
323
+ write(res, name, stripped, attrs);
324
+ }
325
+ function readSealed(req, name) {
326
+ _requireVault();
327
+ var raw = _readCookieFromReq(req, name);
328
+ if (raw === null) return null;
329
+ try { return vault.unseal(C.VAULT_PREFIX + raw); }
330
+ catch (_e) { return null; }
331
+ }
332
+
333
+ return {
334
+ parse: parse,
335
+ serialize: function (n, v, a) { return serialize(n, v, _mergeAttrs(a)); },
336
+ read: read,
337
+ write: write,
338
+ clear: clear,
339
+ writeSealed: writeSealed,
340
+ readSealed: readSealed,
341
+ defaults: defaults,
342
+ };
343
+ }
344
+
345
+ module.exports = {
346
+ create: create,
347
+ parse: parse,
348
+ serialize: serialize,
349
+ CookieError: CookieError,
350
+ };