@blamejs/core 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +230 -0
- package/LICENSE +201 -0
- package/LTS-CALENDAR.md +29 -0
- package/MIGRATING.md +7 -0
- package/NOTICE +59 -0
- package/README.md +100 -0
- package/bin/blamejs.js +13 -0
- package/index.js +253 -0
- package/lib/api-key.js +705 -0
- package/lib/api-snapshot.js +335 -0
- package/lib/app-shutdown.js +381 -0
- package/lib/app.js +364 -0
- package/lib/atomic-file.js +525 -0
- package/lib/audit-chain.js +168 -0
- package/lib/audit-sign.js +319 -0
- package/lib/audit-tools.js +682 -0
- package/lib/audit.js +753 -0
- package/lib/auth/jwt.js +280 -0
- package/lib/auth/oauth.js +691 -0
- package/lib/auth/passkey.js +185 -0
- package/lib/auth/password.js +139 -0
- package/lib/auth/totp.js +17 -0
- package/lib/auth-header.js +81 -0
- package/lib/backup/bundle.js +219 -0
- package/lib/backup/crypto.js +174 -0
- package/lib/backup/index.js +490 -0
- package/lib/backup/manifest.js +275 -0
- package/lib/bundler.js +295 -0
- package/lib/cache.js +819 -0
- package/lib/chain-writer.js +234 -0
- package/lib/cli-helpers.js +201 -0
- package/lib/cli.js +1377 -0
- package/lib/cluster-provider-db.js +245 -0
- package/lib/cluster-storage.js +166 -0
- package/lib/cluster.js +691 -0
- package/lib/consent.js +222 -0
- package/lib/constants.js +186 -0
- package/lib/cookies.js +293 -0
- package/lib/credential-hash.js +303 -0
- package/lib/crypto-field.js +159 -0
- package/lib/crypto.js +250 -0
- package/lib/db-query.js +297 -0
- package/lib/db-schema.js +250 -0
- package/lib/db.js +1054 -0
- package/lib/deprecate.js +226 -0
- package/lib/dev.js +324 -0
- package/lib/error-page.js +424 -0
- package/lib/events.js +135 -0
- package/lib/external-db.js +422 -0
- package/lib/forms.js +378 -0
- package/lib/framework-error.js +189 -0
- package/lib/framework-schema.js +604 -0
- package/lib/handlers.js +350 -0
- package/lib/html-balance.js +227 -0
- package/lib/http-client.js +615 -0
- package/lib/i18n.js +780 -0
- package/lib/jobs.js +181 -0
- package/lib/lazy-require.js +48 -0
- package/lib/log-stream-local.js +137 -0
- package/lib/log-stream-webhook.js +170 -0
- package/lib/log-stream.js +211 -0
- package/lib/log.js +355 -0
- package/lib/mail-bounce.js +507 -0
- package/lib/mail.js +701 -0
- package/lib/metrics.js +647 -0
- package/lib/middleware/api-encrypt.js +553 -0
- package/lib/middleware/attach-user.js +156 -0
- package/lib/middleware/body-parser.js +883 -0
- package/lib/middleware/bot-guard.js +148 -0
- package/lib/middleware/compression.js +436 -0
- package/lib/middleware/cors.js +236 -0
- package/lib/middleware/csp-nonce.js +332 -0
- package/lib/middleware/csrf-protect.js +275 -0
- package/lib/middleware/error-handler.js +46 -0
- package/lib/middleware/health.js +358 -0
- package/lib/middleware/index.js +52 -0
- package/lib/middleware/rate-limit.js +319 -0
- package/lib/middleware/request-id.js +53 -0
- package/lib/middleware/require-auth.js +95 -0
- package/lib/middleware/security-headers.js +91 -0
- package/lib/migrations.js +353 -0
- package/lib/mtls-ca.js +333 -0
- package/lib/mtls-engine-default.js +285 -0
- package/lib/nonce-store.js +177 -0
- package/lib/notify.js +643 -0
- package/lib/ntp-check.js +178 -0
- package/lib/object-store/azure-blob.js +467 -0
- package/lib/object-store/gcs.js +469 -0
- package/lib/object-store/http-put.js +153 -0
- package/lib/object-store/index.js +140 -0
- package/lib/object-store/local.js +163 -0
- package/lib/object-store/retry.js +15 -0
- package/lib/object-store/sigv4.js +535 -0
- package/lib/observability.js +114 -0
- package/lib/pagination.js +371 -0
- package/lib/parsers/index.js +64 -0
- package/lib/parsers/safe-csv.js +224 -0
- package/lib/parsers/safe-env.js +614 -0
- package/lib/parsers/safe-toml.js +745 -0
- package/lib/parsers/safe-xml.js +379 -0
- package/lib/parsers/safe-yaml.js +977 -0
- package/lib/permissions.js +430 -0
- package/lib/pqc-agent.js +85 -0
- package/lib/pqc-gate.js +266 -0
- package/lib/protocol-dispatcher.js +144 -0
- package/lib/queue-local.js +327 -0
- package/lib/queue.js +430 -0
- package/lib/redact.js +192 -0
- package/lib/render.js +193 -0
- package/lib/request-helpers.js +178 -0
- package/lib/restore-bundle.js +239 -0
- package/lib/restore-rollback.js +254 -0
- package/lib/restore.js +301 -0
- package/lib/retry.js +329 -0
- package/lib/router.js +437 -0
- package/lib/safe-async.js +520 -0
- package/lib/safe-buffer.js +162 -0
- package/lib/safe-json.js +532 -0
- package/lib/safe-schema.js +1176 -0
- package/lib/safe-sql.js +157 -0
- package/lib/safe-url.js +109 -0
- package/lib/scheduler.js +680 -0
- package/lib/seeders.js +622 -0
- package/lib/session.js +304 -0
- package/lib/slug.js +243 -0
- package/lib/static.js +268 -0
- package/lib/storage.js +470 -0
- package/lib/subject.js +281 -0
- package/lib/template.js +781 -0
- package/lib/testing.js +621 -0
- package/lib/totp.js +285 -0
- package/lib/tracing.js +484 -0
- package/lib/validate-opts.js +56 -0
- package/lib/vault/index.js +299 -0
- package/lib/vault/passphrase-ops.js +311 -0
- package/lib/vault/passphrase-source.js +198 -0
- package/lib/vault/rotate.js +761 -0
- package/lib/vault/wrap.js +289 -0
- package/lib/vendor/MANIFEST.json +84 -0
- package/lib/vendor/argon2/argon2.cjs +466 -0
- package/lib/vendor/argon2/argon2.d.cts +62 -0
- package/lib/vendor/argon2/package.json +1 -0
- package/lib/vendor/argon2/prebuilds/darwin-arm64/argon2.armv8.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/darwin-x64/argon2.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/freebsd-arm64/argon2.armv8.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/freebsd-x64/argon2.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-arm/argon2.armv7.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-arm/argon2.armv7.musl.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-arm64/argon2.armv8.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-arm64/argon2.armv8.musl.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-x64/argon2.glibc.node +0 -0
- package/lib/vendor/argon2/prebuilds/linux-x64/argon2.musl.node +0 -0
- package/lib/vendor/argon2/prebuilds/win32-x64/argon2.glibc.node +0 -0
- package/lib/vendor/noble-ciphers.cjs +9 -0
- package/lib/vendor/pki.cjs +181 -0
- package/lib/vendor/simplewebauthn-server.cjs +328 -0
- package/lib/webhook.js +632 -0
- package/lib/websocket-channels.js +413 -0
- package/lib/websocket.js +833 -0
- package/package.json +39 -0
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* HTTP middleware — request-lifecycle hardening primitives.
|
|
4
|
+
*
|
|
5
|
+
* Exposed as b.middleware.{requestId, securityHeaders, errorHandler,
|
|
6
|
+
* botGuard, cors, rateLimit}. Each export is a `create(opts)` factory
|
|
7
|
+
* that returns a 3-arg `(req, res, next)` middleware function compatible
|
|
8
|
+
* with the framework's Router.
|
|
9
|
+
*
|
|
10
|
+
* Recommended mount order:
|
|
11
|
+
* 1. requestId — every later middleware should be able to log requestId
|
|
12
|
+
* 2. securityHeaders — set headers before any response could be partially sent
|
|
13
|
+
* 3. cors — handle preflights before deeper logic
|
|
14
|
+
* 4. botGuard — cheap rejection of obviously-bot traffic
|
|
15
|
+
* 5. rateLimit — slow down anything still here
|
|
16
|
+
* 6. (your auth + business middleware + routes)
|
|
17
|
+
* 7. errorHandler — must be LAST so it catches everything that throws
|
|
18
|
+
*/
|
|
19
|
+
module.exports = {
|
|
20
|
+
requestId: require("./request-id").create,
|
|
21
|
+
securityHeaders: require("./security-headers").create,
|
|
22
|
+
errorHandler: require("./error-handler").create,
|
|
23
|
+
botGuard: require("./bot-guard").create,
|
|
24
|
+
cors: require("./cors").create,
|
|
25
|
+
rateLimit: require("./rate-limit").create,
|
|
26
|
+
attachUser: require("./attach-user").create,
|
|
27
|
+
requireAuth: require("./require-auth").create,
|
|
28
|
+
csrfProtect: require("./csrf-protect").create,
|
|
29
|
+
bodyParser: require("./body-parser").create,
|
|
30
|
+
health: require("./health").create,
|
|
31
|
+
compression: require("./compression").create,
|
|
32
|
+
cspNonce: require("./csp-nonce").create,
|
|
33
|
+
apiEncrypt: require("./api-encrypt"),
|
|
34
|
+
|
|
35
|
+
// Module exports for advanced use (constants, raw factory access)
|
|
36
|
+
_modules: {
|
|
37
|
+
requestId: require("./request-id"),
|
|
38
|
+
securityHeaders: require("./security-headers"),
|
|
39
|
+
errorHandler: require("./error-handler"),
|
|
40
|
+
botGuard: require("./bot-guard"),
|
|
41
|
+
cors: require("./cors"),
|
|
42
|
+
rateLimit: require("./rate-limit"),
|
|
43
|
+
attachUser: require("./attach-user"),
|
|
44
|
+
requireAuth: require("./require-auth"),
|
|
45
|
+
csrfProtect: require("./csrf-protect"),
|
|
46
|
+
bodyParser: require("./body-parser"),
|
|
47
|
+
health: require("./health"),
|
|
48
|
+
compression: require("./compression"),
|
|
49
|
+
cspNonce: require("./csp-nonce"),
|
|
50
|
+
apiEncrypt: require("./api-encrypt"),
|
|
51
|
+
},
|
|
52
|
+
};
|
|
@@ -0,0 +1,319 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Rate-limit middleware — pluggable backend, default in-memory.
|
|
4
|
+
*
|
|
5
|
+
* Per-IP by default; key extractor is configurable (per-user, per-API-key,
|
|
6
|
+
* per-route). Two built-in backends:
|
|
7
|
+
*
|
|
8
|
+
* - 'memory' (default) — token-bucket, in-process. Each key gets
|
|
9
|
+
* `burst` tokens up front; tokens refill at `refillPerSecond`;
|
|
10
|
+
* each request costs 1 token. Single-process accuracy only.
|
|
11
|
+
*
|
|
12
|
+
* - 'cluster' — fixed-window counter shared across the cluster
|
|
13
|
+
* via `_blamejs_rate_limit_counters`. Atomic INSERT...ON CONFLICT
|
|
14
|
+
* increments per key within a window and rolls over when the
|
|
15
|
+
* window advances. Multi-process / multi-node accurate.
|
|
16
|
+
*
|
|
17
|
+
* Cluster opt-in switches the algorithm shape from token-bucket
|
|
18
|
+
* to fixed-window because that's what models cleanly in SQL —
|
|
19
|
+
* the operator-facing config keys change accordingly.
|
|
20
|
+
*
|
|
21
|
+
* Operators can also pass a custom `{ take, reset }` object as the
|
|
22
|
+
* backend for Redis / Memcached / etc.
|
|
23
|
+
*
|
|
24
|
+
* Options:
|
|
25
|
+
* {
|
|
26
|
+
* keyFn: (req) → 'rate-key' (default: client IP)
|
|
27
|
+
* statusOnLimit: 429
|
|
28
|
+
* bodyOnLimit: 'Too Many Requests'
|
|
29
|
+
* header: true // set X-RateLimit-* response headers
|
|
30
|
+
* skipPaths: [] // string-prefix or regex matchers
|
|
31
|
+
* scope: 'global' | 'per-route' (default 'global')
|
|
32
|
+
* backend: 'memory' (default) | 'cluster' | { take, reset, gc? }
|
|
33
|
+
*
|
|
34
|
+
* // Memory-backend tuning (token bucket):
|
|
35
|
+
* burst: 60 // initial token bucket size
|
|
36
|
+
* refillPerSecond: 10 // sustained throughput
|
|
37
|
+
*
|
|
38
|
+
* // Cluster-backend tuning (fixed window):
|
|
39
|
+
* limit: 60 // max requests per window
|
|
40
|
+
* windowMs: C.TIME.minutes(1) // window duration
|
|
41
|
+
* pruneIntervalMs: C.TIME.minutes(5) // how often the leader prunes expired rows
|
|
42
|
+
* }
|
|
43
|
+
*
|
|
44
|
+
* Audit: every limit hit emits system.ratelimit.block with the key + path.
|
|
45
|
+
*/
|
|
46
|
+
var C = require("../constants");
|
|
47
|
+
var lazyRequire = require("../lazy-require");
|
|
48
|
+
var validateOpts = require("../validate-opts");
|
|
49
|
+
var clusterStorage = require("../cluster-storage");
|
|
50
|
+
|
|
51
|
+
var audit = lazyRequire(function () { return require("../audit"); });
|
|
52
|
+
var logger = lazyRequire(function () { return require("../log").boot("rate-limit"); });
|
|
53
|
+
|
|
54
|
+
function _clientIp(req) {
|
|
55
|
+
var fwd = req.headers && req.headers["x-forwarded-for"];
|
|
56
|
+
if (fwd) return String(fwd).split(",")[0].trim();
|
|
57
|
+
return (req.socket && req.socket.remoteAddress) || "unknown";
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// ---- Memory backend (token bucket) ----
|
|
61
|
+
|
|
62
|
+
function _memoryBackend(opts) {
|
|
63
|
+
var burst = opts.burst || 60;
|
|
64
|
+
var refillPerSecond = opts.refillPerSecond || 10;
|
|
65
|
+
var buckets = new Map();
|
|
66
|
+
|
|
67
|
+
// Periodic GC of stale buckets so the map doesn't grow unbounded.
|
|
68
|
+
var gcInterval = setInterval(function () {
|
|
69
|
+
var cutoff = Date.now() - C.TIME.hours(1);
|
|
70
|
+
for (var k of buckets.keys()) {
|
|
71
|
+
if (buckets.get(k).lastRefillAt < cutoff) buckets.delete(k);
|
|
72
|
+
}
|
|
73
|
+
}, C.TIME.minutes(5));
|
|
74
|
+
if (typeof gcInterval.unref === "function") gcInterval.unref();
|
|
75
|
+
|
|
76
|
+
// Memory backend returns verdicts SYNCHRONOUSLY — no awaitable.
|
|
77
|
+
// The middleware checks `.then` to decide whether to chain. Keeping
|
|
78
|
+
// the hot path synchronous means single-process apps pay no
|
|
79
|
+
// microtask cost per request.
|
|
80
|
+
function take(key, _cost) {
|
|
81
|
+
var now = Date.now();
|
|
82
|
+
var b = buckets.get(key);
|
|
83
|
+
if (!b) {
|
|
84
|
+
b = { tokens: burst, lastRefillAt: now };
|
|
85
|
+
buckets.set(key, b);
|
|
86
|
+
} else {
|
|
87
|
+
var elapsed = (now - b.lastRefillAt) / 1000;
|
|
88
|
+
b.tokens = Math.min(burst, b.tokens + elapsed * refillPerSecond);
|
|
89
|
+
b.lastRefillAt = now;
|
|
90
|
+
}
|
|
91
|
+
if (b.tokens >= 1) {
|
|
92
|
+
b.tokens -= 1;
|
|
93
|
+
return {
|
|
94
|
+
allowed: true,
|
|
95
|
+
limit: burst,
|
|
96
|
+
remaining: Math.floor(b.tokens),
|
|
97
|
+
retryAfter: 0,
|
|
98
|
+
};
|
|
99
|
+
}
|
|
100
|
+
var deficit = 1 - b.tokens;
|
|
101
|
+
var waitMs = Math.ceil((deficit / refillPerSecond) * 1000);
|
|
102
|
+
return {
|
|
103
|
+
allowed: false,
|
|
104
|
+
limit: burst,
|
|
105
|
+
remaining: 0,
|
|
106
|
+
retryAfter: Math.ceil(waitMs / 1000),
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
function reset(key) {
|
|
111
|
+
buckets.delete(key);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
function close() {
|
|
115
|
+
try { clearInterval(gcInterval); } catch (_e) {}
|
|
116
|
+
buckets.clear();
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
return { take: take, reset: reset, close: close };
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
// ---- Cluster backend (fixed-window counter, SQL-backed) ----
|
|
123
|
+
|
|
124
|
+
function _clusterBackend(opts) {
|
|
125
|
+
var limit = opts.limit || 60;
|
|
126
|
+
var windowMs = opts.windowMs || C.TIME.minutes(1);
|
|
127
|
+
var pruneIntervalMs = opts.pruneIntervalMs || C.TIME.minutes(5);
|
|
128
|
+
var lastPruneAt = 0;
|
|
129
|
+
|
|
130
|
+
// Best-effort prune of expired window rows. Rate-limited at the
|
|
131
|
+
// call site so we don't hammer the DB on every request.
|
|
132
|
+
function _maybePrune() {
|
|
133
|
+
var now = Date.now();
|
|
134
|
+
if (now - lastPruneAt < pruneIntervalMs) return;
|
|
135
|
+
lastPruneAt = now;
|
|
136
|
+
var cutoff = now - windowMs;
|
|
137
|
+
clusterStorage.execute(
|
|
138
|
+
"DELETE FROM _blamejs_rate_limit_counters WHERE windowStart < ?",
|
|
139
|
+
[cutoff]
|
|
140
|
+
).catch(function (e) {
|
|
141
|
+
try {
|
|
142
|
+
logger().warn("rate-limit prune failed: " + ((e && e.message) || String(e)));
|
|
143
|
+
} catch (_e) { /* logger best-effort */ }
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
async function take(key, _cost) {
|
|
148
|
+
var now = Date.now();
|
|
149
|
+
var windowStart = Math.floor(now / windowMs) * windowMs;
|
|
150
|
+
|
|
151
|
+
// Atomic increment: a fresh window resets count to 1; an existing
|
|
152
|
+
// row in the same window gets count + 1. Postgres + SQLite both
|
|
153
|
+
// support ON CONFLICT...DO UPDATE...RETURNING.
|
|
154
|
+
var result = await clusterStorage.execute(
|
|
155
|
+
"INSERT INTO _blamejs_rate_limit_counters (key, windowStart, count) " +
|
|
156
|
+
"VALUES (?, ?, 1) " +
|
|
157
|
+
"ON CONFLICT (key) DO UPDATE SET " +
|
|
158
|
+
" count = CASE " +
|
|
159
|
+
" WHEN excluded.windowStart > _blamejs_rate_limit_counters.windowStart " +
|
|
160
|
+
" THEN 1 " +
|
|
161
|
+
" ELSE _blamejs_rate_limit_counters.count + 1 " +
|
|
162
|
+
" END, " +
|
|
163
|
+
" windowStart = CASE " +
|
|
164
|
+
" WHEN excluded.windowStart > _blamejs_rate_limit_counters.windowStart " +
|
|
165
|
+
" THEN excluded.windowStart " +
|
|
166
|
+
" ELSE _blamejs_rate_limit_counters.windowStart " +
|
|
167
|
+
" END " +
|
|
168
|
+
"RETURNING count, windowStart",
|
|
169
|
+
[key, windowStart]
|
|
170
|
+
);
|
|
171
|
+
var row = result.rows && result.rows[0];
|
|
172
|
+
var count = row ? row.count : 1;
|
|
173
|
+
var rowWindow = row ? row.windowStart : windowStart;
|
|
174
|
+
|
|
175
|
+
_maybePrune();
|
|
176
|
+
|
|
177
|
+
if (count <= limit) {
|
|
178
|
+
return {
|
|
179
|
+
allowed: true,
|
|
180
|
+
limit: limit,
|
|
181
|
+
remaining: Math.max(0, limit - count),
|
|
182
|
+
retryAfter: 0,
|
|
183
|
+
};
|
|
184
|
+
}
|
|
185
|
+
var retryMs = (rowWindow + windowMs) - now;
|
|
186
|
+
return {
|
|
187
|
+
allowed: false,
|
|
188
|
+
limit: limit,
|
|
189
|
+
remaining: 0,
|
|
190
|
+
retryAfter: Math.max(1, Math.ceil(retryMs / 1000)),
|
|
191
|
+
};
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
async function reset(key) {
|
|
195
|
+
await clusterStorage.execute(
|
|
196
|
+
"DELETE FROM _blamejs_rate_limit_counters WHERE key = ?",
|
|
197
|
+
[key]
|
|
198
|
+
);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
function close() { /* no resources to release */ }
|
|
202
|
+
|
|
203
|
+
return { take: take, reset: reset, close: close };
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// ---- Backend resolution ----
|
|
207
|
+
|
|
208
|
+
function _resolveBackend(opts) {
|
|
209
|
+
var requested = opts.backend;
|
|
210
|
+
if (requested && typeof requested === "object" && typeof requested.take === "function") {
|
|
211
|
+
return requested; // operator-supplied custom backend
|
|
212
|
+
}
|
|
213
|
+
if (requested === "cluster") return _clusterBackend(opts);
|
|
214
|
+
if (!requested || requested === "memory") return _memoryBackend(opts);
|
|
215
|
+
throw new Error("rate-limit: unknown backend '" + requested +
|
|
216
|
+
"' (must be 'memory', 'cluster', or { take, reset })");
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function create(opts) {
|
|
220
|
+
opts = opts || {};
|
|
221
|
+
validateOpts(opts, [
|
|
222
|
+
"keyFn", "statusOnLimit", "bodyOnLimit", "header", "skipPaths", "scope",
|
|
223
|
+
"backend",
|
|
224
|
+
// memory backend
|
|
225
|
+
"burst", "refillPerSecond",
|
|
226
|
+
// cluster backend
|
|
227
|
+
"limit", "windowMs", "pruneIntervalMs",
|
|
228
|
+
], "middleware.rateLimit");
|
|
229
|
+
var keyFn = opts.keyFn || _clientIp;
|
|
230
|
+
var statusOnLimit = opts.statusOnLimit || 429;
|
|
231
|
+
var bodyOnLimit = opts.bodyOnLimit !== undefined ? opts.bodyOnLimit : "Too Many Requests";
|
|
232
|
+
var emitHeaders = opts.header !== false;
|
|
233
|
+
var skipPaths = opts.skipPaths || [];
|
|
234
|
+
var scope = opts.scope || "global";
|
|
235
|
+
|
|
236
|
+
var backend = _resolveBackend(opts);
|
|
237
|
+
|
|
238
|
+
function _shouldSkip(req) {
|
|
239
|
+
var path = req.pathname || req.url || "/";
|
|
240
|
+
for (var i = 0; i < skipPaths.length; i++) {
|
|
241
|
+
if (typeof skipPaths[i] === "string" ? path.indexOf(skipPaths[i]) === 0 : skipPaths[i].test(path)) {
|
|
242
|
+
return true;
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
return false;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
function _writeBlocked(req, res, k, verdict) {
|
|
249
|
+
if (emitHeaders && typeof res.setHeader === "function") {
|
|
250
|
+
res.setHeader("X-RateLimit-Limit", String(verdict.limit));
|
|
251
|
+
res.setHeader("X-RateLimit-Remaining", String(verdict.remaining));
|
|
252
|
+
if (verdict.retryAfter > 0) res.setHeader("Retry-After", String(verdict.retryAfter));
|
|
253
|
+
}
|
|
254
|
+
try {
|
|
255
|
+
audit().emit({
|
|
256
|
+
actor: { ip: _clientIp(req), userAgent: req.headers && req.headers["user-agent"] },
|
|
257
|
+
action: "system.ratelimit.block",
|
|
258
|
+
outcome: "denied",
|
|
259
|
+
reason: "rate limit exceeded",
|
|
260
|
+
metadata: { key: k, method: req.method, path: req.pathname || req.url, retryAfter: verdict.retryAfter },
|
|
261
|
+
requestId: req.requestId,
|
|
262
|
+
});
|
|
263
|
+
} catch (_e) {}
|
|
264
|
+
if (typeof res.writeHead === "function") {
|
|
265
|
+
res.writeHead(statusOnLimit, { "Content-Type": "text/plain" });
|
|
266
|
+
res.end(bodyOnLimit);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
var middleware = function rateLimit(req, res, next) {
|
|
271
|
+
if (_shouldSkip(req)) return next();
|
|
272
|
+
var k = keyFn(req);
|
|
273
|
+
if (scope === "per-route") k = (req.method || "GET") + ":" + (req.pathname || req.url || "/") + "|" + k;
|
|
274
|
+
|
|
275
|
+
function _handle(verdict) {
|
|
276
|
+
if (emitHeaders && typeof res.setHeader === "function") {
|
|
277
|
+
res.setHeader("X-RateLimit-Limit", String(verdict.limit));
|
|
278
|
+
res.setHeader("X-RateLimit-Remaining", String(verdict.remaining));
|
|
279
|
+
}
|
|
280
|
+
if (!verdict.allowed) return _writeBlocked(req, res, k, verdict);
|
|
281
|
+
next();
|
|
282
|
+
}
|
|
283
|
+
function _onErr(e) {
|
|
284
|
+
// Fail-open on backend errors. The framework's job is to throttle
|
|
285
|
+
// attackers, not to crash the request path. Surface the error to
|
|
286
|
+
// ops via boot logger; the next request retries.
|
|
287
|
+
try {
|
|
288
|
+
logger().error("rate-limit backend take() failed: " + ((e && e.message) || String(e)));
|
|
289
|
+
} catch (_e) { /* best-effort */ }
|
|
290
|
+
next();
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
// Memory backend returns sync; cluster / custom backends return a
|
|
294
|
+
// Promise. Detect via `.then` so the hot path stays synchronous.
|
|
295
|
+
var verdictOrPromise;
|
|
296
|
+
try {
|
|
297
|
+
verdictOrPromise = backend.take(k, 1);
|
|
298
|
+
} catch (e) { return _onErr(e); }
|
|
299
|
+
|
|
300
|
+
if (verdictOrPromise && typeof verdictOrPromise.then === "function") {
|
|
301
|
+
verdictOrPromise.then(_handle, _onErr);
|
|
302
|
+
} else {
|
|
303
|
+
_handle(verdictOrPromise);
|
|
304
|
+
}
|
|
305
|
+
};
|
|
306
|
+
|
|
307
|
+
// Expose a couple of operator hooks on the middleware function.
|
|
308
|
+
middleware.reset = function (key) { return backend.reset(key); };
|
|
309
|
+
middleware.close = function () { return backend.close && backend.close(); };
|
|
310
|
+
|
|
311
|
+
return middleware;
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
module.exports = {
|
|
315
|
+
create: create,
|
|
316
|
+
// Backends exported for tests + advanced operator wiring.
|
|
317
|
+
_memoryBackend: _memoryBackend,
|
|
318
|
+
_clusterBackend: _clusterBackend,
|
|
319
|
+
};
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Request-ID middleware. Propagates an existing X-Request-Id header (or
|
|
4
|
+
* trace ID from upstream) when present and well-formed; otherwise
|
|
5
|
+
* generates a fresh 32-hex value. Sets req.requestId AND emits the same
|
|
6
|
+
* value as a response header so downstream services + auditors can
|
|
7
|
+
* correlate.
|
|
8
|
+
*
|
|
9
|
+
* Threading the request ID into audit.record() metadata is what makes
|
|
10
|
+
* the cross-event correlation traceable; apps should pass this through
|
|
11
|
+
* to every audit.record() they call within the request lifecycle.
|
|
12
|
+
*
|
|
13
|
+
* Options:
|
|
14
|
+
* {
|
|
15
|
+
* headerName: 'X-Request-Id'
|
|
16
|
+
* trustUpstream: true // propagate upstream id if it matches
|
|
17
|
+
* // the format check; false → always
|
|
18
|
+
* // generate fresh
|
|
19
|
+
* formatRegex: /^[A-Za-z0-9._-]{8,128}$/
|
|
20
|
+
* }
|
|
21
|
+
*/
|
|
22
|
+
var { generateToken } = require("../crypto");
|
|
23
|
+
var validateOpts = require("../validate-opts");
|
|
24
|
+
|
|
25
|
+
var DEFAULT_FORMAT = /^[A-Za-z0-9._-]{8,128}$/;
|
|
26
|
+
|
|
27
|
+
function create(opts) {
|
|
28
|
+
opts = opts || {};
|
|
29
|
+
validateOpts(opts, [
|
|
30
|
+
"headerName", "trustUpstream", "formatRegex",
|
|
31
|
+
], "middleware.requestId");
|
|
32
|
+
var headerName = (opts.headerName || "X-Request-Id");
|
|
33
|
+
var headerNameLower = headerName.toLowerCase();
|
|
34
|
+
var trustUpstream = opts.trustUpstream !== false;
|
|
35
|
+
var format = opts.formatRegex || DEFAULT_FORMAT;
|
|
36
|
+
|
|
37
|
+
return function requestId(req, res, next) {
|
|
38
|
+
var inbound = req.headers && req.headers[headerNameLower];
|
|
39
|
+
var id;
|
|
40
|
+
if (trustUpstream && inbound && format.test(inbound)) {
|
|
41
|
+
id = inbound;
|
|
42
|
+
} else {
|
|
43
|
+
id = generateToken(16); // 32 hex chars
|
|
44
|
+
}
|
|
45
|
+
req.requestId = id;
|
|
46
|
+
if (typeof res.setHeader === "function") {
|
|
47
|
+
res.setHeader(headerName, id);
|
|
48
|
+
}
|
|
49
|
+
next();
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
module.exports = { create: create };
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* require-auth middleware — gates routes that require an authenticated
|
|
4
|
+
* user. Mount AFTER attachUser; this middleware reads `req.user` and
|
|
5
|
+
* either lets the request through or rejects it.
|
|
6
|
+
*
|
|
7
|
+
* Rejection shape:
|
|
8
|
+
* - JSON-preferring caller (Accept: application/json, or X-Requested-With:
|
|
9
|
+
* XMLHttpRequest, or content-type starts application/json):
|
|
10
|
+
* 401 application/json with { error: "Authentication required." }
|
|
11
|
+
* - Browser-preferring caller, when opts.redirectTo is set:
|
|
12
|
+
* 302 with Location header
|
|
13
|
+
* - Otherwise:
|
|
14
|
+
* 401 text/plain
|
|
15
|
+
*
|
|
16
|
+
* Always emits `auth.required.denied` audit event on rejection (when
|
|
17
|
+
* opts.audit !== false). The event records request method + path +
|
|
18
|
+
* client IP — keys-only, no body content.
|
|
19
|
+
*
|
|
20
|
+
* Options:
|
|
21
|
+
* {
|
|
22
|
+
* redirectTo: null (optional URL for browser redirects;
|
|
23
|
+
* when set, prefersJson()=false rejections
|
|
24
|
+
* produce 302 instead of 401 text/plain)
|
|
25
|
+
* prefersJson: function (optional override; defaults to checking
|
|
26
|
+
* Accept / X-Requested-With / Content-Type)
|
|
27
|
+
* errorMessage: 'Authentication required.'
|
|
28
|
+
* audit: true (emit auth.required.denied on reject)
|
|
29
|
+
* }
|
|
30
|
+
*/
|
|
31
|
+
var lazyRequire = require("../lazy-require");
|
|
32
|
+
var validateOpts = require("../validate-opts");
|
|
33
|
+
var audit = lazyRequire(function () { return require("../audit"); });
|
|
34
|
+
|
|
35
|
+
function _defaultPrefersJson(req) {
|
|
36
|
+
var h = req.headers || {};
|
|
37
|
+
if (typeof h.accept === "string" && h.accept.indexOf("application/json") !== -1) return true;
|
|
38
|
+
if (h["x-requested-with"] === "XMLHttpRequest") return true;
|
|
39
|
+
if (typeof h["content-type"] === "string" &&
|
|
40
|
+
h["content-type"].indexOf("application/json") === 0) return true;
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function create(opts) {
|
|
45
|
+
opts = opts || {};
|
|
46
|
+
validateOpts(opts, [
|
|
47
|
+
"redirectTo", "prefersJson", "errorMessage", "audit",
|
|
48
|
+
], "middleware.requireAuth");
|
|
49
|
+
var redirectTo = opts.redirectTo || null;
|
|
50
|
+
var prefersJson = typeof opts.prefersJson === "function"
|
|
51
|
+
? opts.prefersJson
|
|
52
|
+
: _defaultPrefersJson;
|
|
53
|
+
var msg = opts.errorMessage || "Authentication required.";
|
|
54
|
+
var auditOn = opts.audit !== false;
|
|
55
|
+
|
|
56
|
+
return function requireAuth(req, res, next) {
|
|
57
|
+
if (req.user) return next();
|
|
58
|
+
|
|
59
|
+
if (auditOn) {
|
|
60
|
+
try {
|
|
61
|
+
audit().emit({
|
|
62
|
+
action: "auth.required.denied",
|
|
63
|
+
outcome: "denied",
|
|
64
|
+
actor: { ip: req.socket && req.socket.remoteAddress, userAgent: req.headers && req.headers["user-agent"] },
|
|
65
|
+
reason: "no authenticated user on request",
|
|
66
|
+
metadata: { method: req.method, path: req.pathname || (req.url || "").split("?")[0] },
|
|
67
|
+
});
|
|
68
|
+
} catch (_e) { /* audit best-effort */ }
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
if (prefersJson(req)) {
|
|
72
|
+
if (typeof res.writeHead === "function") {
|
|
73
|
+
res.writeHead(401, { "Content-Type": "application/json" });
|
|
74
|
+
res.end(JSON.stringify({ error: msg }));
|
|
75
|
+
}
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
if (redirectTo) {
|
|
79
|
+
if (typeof res.writeHead === "function") {
|
|
80
|
+
res.writeHead(302, { "Location": redirectTo });
|
|
81
|
+
res.end();
|
|
82
|
+
}
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
if (typeof res.writeHead === "function") {
|
|
86
|
+
res.writeHead(401, { "Content-Type": "text/plain" });
|
|
87
|
+
res.end(msg);
|
|
88
|
+
}
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
module.exports = {
|
|
93
|
+
create: create,
|
|
94
|
+
_defaultPrefersJson: _defaultPrefersJson,
|
|
95
|
+
};
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Security headers middleware. Sets the headers every modern app should
|
|
4
|
+
* send, regardless of content. Deliberately strict by default — operators
|
|
5
|
+
* who need to soften a header opt in explicitly per option.
|
|
6
|
+
*
|
|
7
|
+
* Strict-Transport-Security — force HTTPS (HSTS); 2-year max-age + includeSubDomains + preload
|
|
8
|
+
* X-Content-Type-Options: nosniff — block MIME sniffing
|
|
9
|
+
* X-Frame-Options: DENY — prevent clickjacking via iframes
|
|
10
|
+
* Referrer-Policy: no-referrer — don't leak full URL to outbound links
|
|
11
|
+
* Permissions-Policy — disable common-attack APIs (camera, geolocation, payment, etc.)
|
|
12
|
+
* Cross-Origin-Opener-Policy: same-origin
|
|
13
|
+
* Cross-Origin-Embedder-Policy: require-corp (off by default — breaks images from CDNs)
|
|
14
|
+
* Cross-Origin-Resource-Policy: same-origin
|
|
15
|
+
* Content-Security-Policy — operator-supplied; framework provides a safe default that
|
|
16
|
+
* only allows same-origin and prevents inline scripts
|
|
17
|
+
*
|
|
18
|
+
* These are the OWASP-aligned defaults. Apps that need different policies
|
|
19
|
+
* (e.g. allow-list for analytics scripts, embed iframes from a known
|
|
20
|
+
* partner) override per-option without losing the others.
|
|
21
|
+
*
|
|
22
|
+
* Options:
|
|
23
|
+
* {
|
|
24
|
+
* hsts: '<value>' or false to disable
|
|
25
|
+
* contentTypeOptions: 'nosniff' or false
|
|
26
|
+
* frameOptions: 'DENY' | 'SAMEORIGIN' or false
|
|
27
|
+
* referrerPolicy: '<value>' or false
|
|
28
|
+
* permissionsPolicy: '<value>' or false
|
|
29
|
+
* coop / coep / corp: '<value>' or false
|
|
30
|
+
* csp: '<full CSP string>' or false to disable
|
|
31
|
+
* }
|
|
32
|
+
*/
|
|
33
|
+
|
|
34
|
+
var validateOpts = require("../validate-opts");
|
|
35
|
+
|
|
36
|
+
var DEFAULT_PERMISSIONS = [
|
|
37
|
+
"accelerometer=()", "ambient-light-sensor=()", "autoplay=()",
|
|
38
|
+
"camera=()", "display-capture=()", "encrypted-media=()", "fullscreen=(self)",
|
|
39
|
+
"geolocation=()", "gyroscope=()", "magnetometer=()", "microphone=()",
|
|
40
|
+
"midi=()", "payment=()", "picture-in-picture=()", "publickey-credentials-get=()",
|
|
41
|
+
"screen-wake-lock=()", "sync-xhr=()", "usb=()", "web-share=()", "xr-spatial-tracking=()",
|
|
42
|
+
];
|
|
43
|
+
|
|
44
|
+
var DEFAULT_CSP =
|
|
45
|
+
"default-src 'self'; " +
|
|
46
|
+
"script-src 'self'; " +
|
|
47
|
+
"style-src 'self' 'unsafe-inline'; " +
|
|
48
|
+
"img-src 'self' data:; " +
|
|
49
|
+
"font-src 'self'; " +
|
|
50
|
+
"connect-src 'self'; " +
|
|
51
|
+
"frame-ancestors 'none'; " +
|
|
52
|
+
"base-uri 'self'; " +
|
|
53
|
+
"form-action 'self'; " +
|
|
54
|
+
"object-src 'none';";
|
|
55
|
+
|
|
56
|
+
function create(opts) {
|
|
57
|
+
opts = opts || {};
|
|
58
|
+
validateOpts(opts, [
|
|
59
|
+
"hsts", "contentTypeOptions", "frameOptions", "referrerPolicy",
|
|
60
|
+
"permissionsPolicy", "coop", "coep", "corp", "csp",
|
|
61
|
+
], "middleware.securityHeaders");
|
|
62
|
+
var hsts = opts.hsts === undefined ? "max-age=63072000; includeSubDomains; preload" : opts.hsts;
|
|
63
|
+
var ctOpts = opts.contentTypeOptions === undefined ? "nosniff" : opts.contentTypeOptions;
|
|
64
|
+
var frameOpts = opts.frameOptions === undefined ? "DENY" : opts.frameOptions;
|
|
65
|
+
var refPolicy = opts.referrerPolicy === undefined ? "no-referrer" : opts.referrerPolicy;
|
|
66
|
+
var permPolicy = opts.permissionsPolicy === undefined ? DEFAULT_PERMISSIONS.join(", ") : opts.permissionsPolicy;
|
|
67
|
+
var coop = opts.coop === undefined ? "same-origin" : opts.coop;
|
|
68
|
+
var coep = opts.coep === undefined ? false : opts.coep;
|
|
69
|
+
var corp = opts.corp === undefined ? "same-origin" : opts.corp;
|
|
70
|
+
var csp = opts.csp === undefined ? DEFAULT_CSP : opts.csp;
|
|
71
|
+
|
|
72
|
+
return function securityHeaders(req, res, next) {
|
|
73
|
+
if (typeof res.setHeader !== "function") return next();
|
|
74
|
+
if (hsts) res.setHeader("Strict-Transport-Security", hsts);
|
|
75
|
+
if (ctOpts) res.setHeader("X-Content-Type-Options", ctOpts);
|
|
76
|
+
if (frameOpts) res.setHeader("X-Frame-Options", frameOpts);
|
|
77
|
+
if (refPolicy) res.setHeader("Referrer-Policy", refPolicy);
|
|
78
|
+
if (permPolicy) res.setHeader("Permissions-Policy", permPolicy);
|
|
79
|
+
if (coop) res.setHeader("Cross-Origin-Opener-Policy", coop);
|
|
80
|
+
if (coep) res.setHeader("Cross-Origin-Embedder-Policy", coep);
|
|
81
|
+
if (corp) res.setHeader("Cross-Origin-Resource-Policy", corp);
|
|
82
|
+
if (csp) res.setHeader("Content-Security-Policy", csp);
|
|
83
|
+
next();
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
module.exports = {
|
|
88
|
+
create: create,
|
|
89
|
+
DEFAULT_PERMISSIONS: DEFAULT_PERMISSIONS,
|
|
90
|
+
DEFAULT_CSP: DEFAULT_CSP,
|
|
91
|
+
};
|