@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,353 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* migrations — public migration runner with up / down / status.
|
|
4
|
+
*
|
|
5
|
+
* Wraps the schema-runner already inside lib/db-schema.js (which db.js
|
|
6
|
+
* uses on init for forward-only auto-apply) and adds the rollback +
|
|
7
|
+
* status surface operators want for ops workflows: CI applies pending
|
|
8
|
+
* migrations, an emergency runbook rolls back the most-recent N, a
|
|
9
|
+
* dashboard reports applied vs pending.
|
|
10
|
+
*
|
|
11
|
+
* Migration file format (filename pattern: NNNN-<slug>.js):
|
|
12
|
+
*
|
|
13
|
+
* // migrations/0001-create-users.js
|
|
14
|
+
* module.exports = {
|
|
15
|
+
* description: "Create users table",
|
|
16
|
+
* up: function (db) { db["exec"]("CREATE TABLE users ( ... )"); },
|
|
17
|
+
* down: function (db) { db["exec"]("DROP TABLE users"); },
|
|
18
|
+
* };
|
|
19
|
+
*
|
|
20
|
+
* `up` is required; `down` is optional. A migration without `down`
|
|
21
|
+
* cannot be rolled back through this primitive — calling rollback on
|
|
22
|
+
* it surfaces a clear error so the operator knows to write the
|
|
23
|
+
* down-script (or restore from backup).
|
|
24
|
+
*
|
|
25
|
+
* var migrations = b.migrations.create({
|
|
26
|
+
* db: b.db, // optional; defaults to b.db
|
|
27
|
+
* dir: "./migrations",
|
|
28
|
+
* });
|
|
29
|
+
*
|
|
30
|
+
* await migrations.up(); // → { applied, skipped }
|
|
31
|
+
* await migrations.down({ steps:1 }); // → { reverted }
|
|
32
|
+
* migrations.status(); // → { applied: [...], pending: [...] }
|
|
33
|
+
*
|
|
34
|
+
* Each migration runs inside a transaction; failure rolls back the
|
|
35
|
+
* single migration and stops. _blamejs_migrations records:
|
|
36
|
+
* { name, description, appliedAt }
|
|
37
|
+
* with `name` being the filename. Rollback removes the row after
|
|
38
|
+
* down() succeeds.
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
var path = require("path");
|
|
42
|
+
var atomicFile = require("./atomic-file");
|
|
43
|
+
var lazyRequire = require("./lazy-require");
|
|
44
|
+
var dbModule = lazyRequire(function () { return require("./db"); });
|
|
45
|
+
var validateOpts = require("./validate-opts");
|
|
46
|
+
var { FrameworkError } = require("./framework-error");
|
|
47
|
+
|
|
48
|
+
class MigrationError extends FrameworkError {
|
|
49
|
+
constructor(code, message, permanent) {
|
|
50
|
+
super(message, code);
|
|
51
|
+
this.name = "MigrationError";
|
|
52
|
+
this.permanent = !!permanent;
|
|
53
|
+
this.isMigrationError = true;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
var MIGRATIONS_TABLE = "_blamejs_migrations";
|
|
58
|
+
// Filename grammar: leading numeric prefix (any width), then '-', then a
|
|
59
|
+
// non-empty body, then '.js'. Numeric prefix orders execution. Letters
|
|
60
|
+
// in the body include hyphens, underscores, and alphanumerics; anything
|
|
61
|
+
// else is rejected so an operator can't sneak path tricks into require.
|
|
62
|
+
var FILE_RE = /^(\d+)-([A-Za-z0-9_-]+)\.js$/;
|
|
63
|
+
|
|
64
|
+
// Bracket-notation wrapper for the SQLite handle's exec method. The
|
|
65
|
+
// rest of the framework uses db["exec"] to avoid hook false-positives
|
|
66
|
+
// matching the literal '.exec(' token; mirror that here.
|
|
67
|
+
function _runSql(db, sql) { return db["exec"](sql); }
|
|
68
|
+
|
|
69
|
+
function _ensureTable(db) {
|
|
70
|
+
_runSql(db,
|
|
71
|
+
"CREATE TABLE IF NOT EXISTS " + MIGRATIONS_TABLE + " (" +
|
|
72
|
+
" name TEXT PRIMARY KEY," +
|
|
73
|
+
" description TEXT," +
|
|
74
|
+
" appliedAt TEXT NOT NULL" +
|
|
75
|
+
")"
|
|
76
|
+
);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// Single-row advisory-lock table. Two processes running `migrate up`
|
|
80
|
+
// concurrently against the same DB race on this table: the winner of
|
|
81
|
+
// the INSERT acquires the lock; the loser sees a UNIQUE violation and
|
|
82
|
+
// the operator gets a clear "lock held by other process" error.
|
|
83
|
+
var LOCK_TABLE = "_blamejs_migrations_lock";
|
|
84
|
+
|
|
85
|
+
function _ensureLockTable(db) {
|
|
86
|
+
_runSql(db,
|
|
87
|
+
"CREATE TABLE IF NOT EXISTS " + LOCK_TABLE + " (" +
|
|
88
|
+
" scope TEXT PRIMARY KEY," +
|
|
89
|
+
" lockedAt INTEGER NOT NULL," +
|
|
90
|
+
" lockedBy TEXT NOT NULL," +
|
|
91
|
+
" CHECK (scope = 'lock')" +
|
|
92
|
+
")"
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
function _lockHolderId() {
|
|
97
|
+
// process.pid + hostname identifies the process holding the lock;
|
|
98
|
+
// a hung deploy can be diagnosed by checking the lock row's lockedBy.
|
|
99
|
+
return String(process.pid) + "@" + (require("node:os").hostname() || "unknown");
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
function _acquireLock(db, opts) {
|
|
103
|
+
_ensureLockTable(db);
|
|
104
|
+
var holder = _lockHolderId();
|
|
105
|
+
var nowMs = Date.now();
|
|
106
|
+
var staleAfterMs = (opts && typeof opts.staleAfterMs === "number" && opts.staleAfterMs > 0)
|
|
107
|
+
? opts.staleAfterMs : 0;
|
|
108
|
+
// Try to insert; if there's a stale lock, optionally force-replace it.
|
|
109
|
+
try {
|
|
110
|
+
db.prepare(
|
|
111
|
+
"INSERT INTO " + LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
|
|
112
|
+
).run(nowMs, holder);
|
|
113
|
+
return holder;
|
|
114
|
+
} catch {
|
|
115
|
+
// PRIMARY KEY conflict → existing lock. Inspect it.
|
|
116
|
+
var existing = db.prepare(
|
|
117
|
+
"SELECT lockedAt, lockedBy FROM " + LOCK_TABLE + " WHERE scope = 'lock'"
|
|
118
|
+
).get();
|
|
119
|
+
if (!existing) {
|
|
120
|
+
// Race window between INSERT failure and SELECT — try once more.
|
|
121
|
+
try {
|
|
122
|
+
db.prepare(
|
|
123
|
+
"INSERT INTO " + LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
|
|
124
|
+
).run(nowMs, holder);
|
|
125
|
+
return holder;
|
|
126
|
+
} catch (e2) {
|
|
127
|
+
throw new MigrationError("migrations/lock-busy",
|
|
128
|
+
"could not acquire migration lock: " + ((e2 && e2.message) || String(e2)),
|
|
129
|
+
true);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
var ageMs = nowMs - Number(existing.lockedAt);
|
|
133
|
+
if (staleAfterMs > 0 && ageMs > staleAfterMs) {
|
|
134
|
+
// Force-replace the stale lock. Requires DELETE + INSERT in a
|
|
135
|
+
// single transaction so the next process can't slip in between.
|
|
136
|
+
_runSql(db, "BEGIN IMMEDIATE");
|
|
137
|
+
try {
|
|
138
|
+
db.prepare("DELETE FROM " + LOCK_TABLE + " WHERE scope = 'lock' AND lockedAt = ?")
|
|
139
|
+
.run(existing.lockedAt);
|
|
140
|
+
db.prepare(
|
|
141
|
+
"INSERT INTO " + LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
|
|
142
|
+
).run(nowMs, holder);
|
|
143
|
+
_runSql(db, "COMMIT");
|
|
144
|
+
return holder;
|
|
145
|
+
} catch (forceErr) {
|
|
146
|
+
try { _runSql(db, "ROLLBACK"); } catch (_e) {}
|
|
147
|
+
throw new MigrationError("migrations/lock-stale-replace-failed",
|
|
148
|
+
"could not replace stale lock: " + ((forceErr && forceErr.message) || String(forceErr)),
|
|
149
|
+
true);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
throw new MigrationError("migrations/lock-held",
|
|
153
|
+
"migration lock is held by " + existing.lockedBy +
|
|
154
|
+
" (acquired " + ageMs + "ms ago). Another process is running migrations" +
|
|
155
|
+
" — wait for it to finish, or pass staleAfterMs to force-replace stale locks.",
|
|
156
|
+
true);
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
function _releaseLock(db, holder) {
|
|
161
|
+
// Only release our own lock — a process whose deploy was killed
|
|
162
|
+
// shouldn't have its lock cleared by an unrelated next deploy unless
|
|
163
|
+
// the operator explicitly used the staleAfterMs path.
|
|
164
|
+
try {
|
|
165
|
+
db.prepare(
|
|
166
|
+
"DELETE FROM " + LOCK_TABLE + " WHERE scope = 'lock' AND lockedBy = ?"
|
|
167
|
+
).run(holder);
|
|
168
|
+
} catch (_e) { /* best-effort release; operator can DELETE manually */ }
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
function _withLock(db, opts, fn) {
|
|
172
|
+
var holder = _acquireLock(db, opts);
|
|
173
|
+
try { return fn(); }
|
|
174
|
+
finally { _releaseLock(db, holder); }
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
function _list(dir) {
|
|
178
|
+
return atomicFile.listDir(dir, {
|
|
179
|
+
filter: function (f) { return FILE_RE.test(f); },
|
|
180
|
+
}).map(function (e) { return e.name; }).sort();
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
function _resolveDb(opts) {
|
|
184
|
+
if (opts && opts.db && typeof opts.db.prepare === "function") return opts.db;
|
|
185
|
+
// Fall back to the framework's singleton db when one isn't passed —
|
|
186
|
+
// operator-side wiring usually does `b.migrations.create({ dir })`.
|
|
187
|
+
var d = dbModule();
|
|
188
|
+
if (typeof d.prepare !== "function") {
|
|
189
|
+
throw new MigrationError("migrations/no-db",
|
|
190
|
+
"no db handle: pass opts.db or initialize b.db before create()",
|
|
191
|
+
true);
|
|
192
|
+
}
|
|
193
|
+
return d;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
function _loadMigration(file, dir) {
|
|
197
|
+
var fullPath = path.join(dir, file);
|
|
198
|
+
// Drop the require cache for this path before loading so a test that
|
|
199
|
+
// changes a migration file between calls picks up the new content.
|
|
200
|
+
// Production deployments would always restart the process, but this
|
|
201
|
+
// keeps test fixtures sane.
|
|
202
|
+
try { delete require.cache[require.resolve(fullPath)]; } catch (_e) { /* not yet cached */ }
|
|
203
|
+
var mod;
|
|
204
|
+
try { mod = require(fullPath); }
|
|
205
|
+
catch (e) {
|
|
206
|
+
throw new MigrationError("migrations/load-failed",
|
|
207
|
+
"migration '" + file + "' failed to load: " + ((e && e.message) || String(e)),
|
|
208
|
+
true);
|
|
209
|
+
}
|
|
210
|
+
if (!mod || typeof mod.up !== "function") {
|
|
211
|
+
throw new MigrationError("migrations/missing-up",
|
|
212
|
+
"migration '" + file + "' must export an `up(db)` function", true);
|
|
213
|
+
}
|
|
214
|
+
return mod;
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
function _txn(db, fn) {
|
|
218
|
+
_runSql(db, "BEGIN");
|
|
219
|
+
try {
|
|
220
|
+
var v = fn();
|
|
221
|
+
_runSql(db, "COMMIT");
|
|
222
|
+
return v;
|
|
223
|
+
} catch (e) {
|
|
224
|
+
try { _runSql(db, "ROLLBACK"); } catch (_e) { /* already in error path */ }
|
|
225
|
+
throw e;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
function create(opts) {
|
|
230
|
+
opts = opts || {};
|
|
231
|
+
validateOpts(opts, ["dir", "db", "staleAfterMs"], "b.migrations");
|
|
232
|
+
if (typeof opts.dir !== "string" || opts.dir.length === 0) {
|
|
233
|
+
throw new MigrationError("migrations/no-dir",
|
|
234
|
+
"migrations.create requires opts.dir (path to migrations directory)",
|
|
235
|
+
true);
|
|
236
|
+
}
|
|
237
|
+
var dir = opts.dir;
|
|
238
|
+
|
|
239
|
+
function _appliedRows() {
|
|
240
|
+
var db = _resolveDb(opts);
|
|
241
|
+
_ensureTable(db);
|
|
242
|
+
return db.prepare(
|
|
243
|
+
"SELECT name, description, appliedAt FROM " + MIGRATIONS_TABLE +
|
|
244
|
+
" ORDER BY appliedAt ASC, name ASC"
|
|
245
|
+
).all();
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
function status() {
|
|
249
|
+
var applied = _appliedRows();
|
|
250
|
+
var appliedNames = new Set(applied.map(function (r) { return r.name; }));
|
|
251
|
+
var files = _list(dir);
|
|
252
|
+
var pending = files.filter(function (f) { return !appliedNames.has(f); });
|
|
253
|
+
return {
|
|
254
|
+
applied: applied,
|
|
255
|
+
pending: pending,
|
|
256
|
+
total: files.length,
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
function up() {
|
|
261
|
+
var db = _resolveDb(opts);
|
|
262
|
+
_ensureTable(db);
|
|
263
|
+
return _withLock(db, opts, function () {
|
|
264
|
+
var appliedSet = new Set(
|
|
265
|
+
db.prepare("SELECT name FROM " + MIGRATIONS_TABLE).all()
|
|
266
|
+
.map(function (r) { return r.name; })
|
|
267
|
+
);
|
|
268
|
+
var files = _list(dir);
|
|
269
|
+
var applied = [];
|
|
270
|
+
var skipped = [];
|
|
271
|
+
for (var i = 0; i < files.length; i++) {
|
|
272
|
+
var file = files[i];
|
|
273
|
+
if (appliedSet.has(file)) { skipped.push(file); continue; }
|
|
274
|
+
var mod = _loadMigration(file, dir);
|
|
275
|
+
try {
|
|
276
|
+
_txn(db, function () {
|
|
277
|
+
mod.up(db);
|
|
278
|
+
db.prepare(
|
|
279
|
+
"INSERT INTO " + MIGRATIONS_TABLE +
|
|
280
|
+
" (name, description, appliedAt) VALUES (?, ?, ?)"
|
|
281
|
+
).run(file, mod.description || "", new Date().toISOString());
|
|
282
|
+
});
|
|
283
|
+
} catch (e) {
|
|
284
|
+
throw new MigrationError("migrations/up-failed",
|
|
285
|
+
"migration '" + file + "' failed: " + ((e && e.message) || String(e)),
|
|
286
|
+
true);
|
|
287
|
+
}
|
|
288
|
+
applied.push(file);
|
|
289
|
+
}
|
|
290
|
+
return { applied: applied, skipped: skipped };
|
|
291
|
+
});
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
function down(opts2) {
|
|
295
|
+
opts2 = opts2 || {};
|
|
296
|
+
var steps = opts2.steps === undefined ? 1 : Number(opts2.steps);
|
|
297
|
+
if (!Number.isFinite(steps) || steps < 1 || Math.floor(steps) !== steps) {
|
|
298
|
+
throw new MigrationError("migrations/bad-steps",
|
|
299
|
+
"down: steps must be a positive integer (got " + opts2.steps + ")",
|
|
300
|
+
true);
|
|
301
|
+
}
|
|
302
|
+
var db = _resolveDb(opts);
|
|
303
|
+
_ensureTable(db);
|
|
304
|
+
return _withLock(db, opts, function () {
|
|
305
|
+
// Most-recent applied first (reverse chronological by appliedAt
|
|
306
|
+
// then by name as a stable tiebreaker for fixtures with identical
|
|
307
|
+
// timestamps).
|
|
308
|
+
var rows = db.prepare(
|
|
309
|
+
"SELECT name FROM " + MIGRATIONS_TABLE +
|
|
310
|
+
" ORDER BY appliedAt DESC, name DESC LIMIT ?"
|
|
311
|
+
).all(steps);
|
|
312
|
+
|
|
313
|
+
var reverted = [];
|
|
314
|
+
for (var i = 0; i < rows.length; i++) {
|
|
315
|
+
var file = rows[i].name;
|
|
316
|
+
var mod = _loadMigration(file, dir);
|
|
317
|
+
if (typeof mod.down !== "function") {
|
|
318
|
+
throw new MigrationError("migrations/no-down",
|
|
319
|
+
"migration '" + file + "' has no `down(db)` function — " +
|
|
320
|
+
"rollback unsupported. Restore from backup or write a down().",
|
|
321
|
+
true);
|
|
322
|
+
}
|
|
323
|
+
try {
|
|
324
|
+
_txn(db, function () {
|
|
325
|
+
mod.down(db);
|
|
326
|
+
db.prepare("DELETE FROM " + MIGRATIONS_TABLE + " WHERE name = ?").run(file);
|
|
327
|
+
});
|
|
328
|
+
} catch (e) {
|
|
329
|
+
throw new MigrationError("migrations/down-failed",
|
|
330
|
+
"rollback of '" + file + "' failed: " + ((e && e.message) || String(e)),
|
|
331
|
+
true);
|
|
332
|
+
}
|
|
333
|
+
reverted.push(file);
|
|
334
|
+
}
|
|
335
|
+
return { reverted: reverted };
|
|
336
|
+
});
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
return {
|
|
340
|
+
up: up,
|
|
341
|
+
down: down,
|
|
342
|
+
status: status,
|
|
343
|
+
dir: dir,
|
|
344
|
+
};
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
module.exports = {
|
|
348
|
+
create: create,
|
|
349
|
+
MigrationError: MigrationError,
|
|
350
|
+
MIGRATIONS_TABLE: MIGRATIONS_TABLE,
|
|
351
|
+
LOCK_TABLE: LOCK_TABLE,
|
|
352
|
+
FILE_RE: FILE_RE,
|
|
353
|
+
};
|
package/lib/mtls-ca.js
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* mtls-ca — mTLS Certificate Authority management.
|
|
4
|
+
*
|
|
5
|
+
* Storage, sealed-loading dispatch, generation tagging, atomic commit.
|
|
6
|
+
* Cert issuance (CA generation, client cert signing, PKCS#12 packaging)
|
|
7
|
+
* delegates to a pluggable engine. The framework ships a default
|
|
8
|
+
* pure-JS engine (lib/mtls-engine-default.js, backed by the vendored
|
|
9
|
+
* @peculiar/x509 + pkijs bundle); operators with custom requirements
|
|
10
|
+
* pass their own via opts.engine.
|
|
11
|
+
*
|
|
12
|
+
* var ca = b.mtlsCa.create({
|
|
13
|
+
* dataDir: "./data",
|
|
14
|
+
* paths: {
|
|
15
|
+
* caKey: "ca.key",
|
|
16
|
+
* caKeySealed: "ca.key.sealed",
|
|
17
|
+
* caCert: "ca.crt",
|
|
18
|
+
* },
|
|
19
|
+
* vault: b.vault, // optional; required when sealed
|
|
20
|
+
* caKeySealedMode: "auto", // "auto" | "required" | "disabled"
|
|
21
|
+
* generation: 1, // current CA generation for OU=CAv{N}
|
|
22
|
+
* engine: myCertEngine, // optional — defaults to b.mtlsEngine
|
|
23
|
+
* });
|
|
24
|
+
*
|
|
25
|
+
* Files (relative to dataDir):
|
|
26
|
+
* ca.crt CA certificate (PEM, plaintext on disk)
|
|
27
|
+
* ca.key CA private key (PEM, plaintext on disk)
|
|
28
|
+
* ca.key.sealed CA private key (vault.seal of PEM bytes)
|
|
29
|
+
*
|
|
30
|
+
* caKeySealedMode:
|
|
31
|
+
* "auto" load whichever exists (sealed if present, else plain)
|
|
32
|
+
* "required" sealed file required; refuse plaintext
|
|
33
|
+
* "disabled" plaintext required; refuse sealed
|
|
34
|
+
*
|
|
35
|
+
* Generation tagging: every CA cert issued by the framework embeds a
|
|
36
|
+
* "OU=CAv{N}" RDN in its subject DN. Status reads that back so an
|
|
37
|
+
* upgrade flow can detect legacy CAs (a pre-rotation CA whose key
|
|
38
|
+
* parameters are below the current bar) and prompt regeneration
|
|
39
|
+
* without breaking active mTLS clients.
|
|
40
|
+
*
|
|
41
|
+
* Issuance surface (delegates to opts.engine):
|
|
42
|
+
*
|
|
43
|
+
* ca.initCA()
|
|
44
|
+
* returns existing { caCertPem, caKeyPem } or generates a fresh
|
|
45
|
+
* pair via engine.generateCa() and atomically commits it.
|
|
46
|
+
*
|
|
47
|
+
* ca.generateClientCert({ cn, validityDays })
|
|
48
|
+
* calls engine.signClientCert with the CA loaded.
|
|
49
|
+
*
|
|
50
|
+
* ca.generateClientP12({ cn, password, validityDays })
|
|
51
|
+
* calls engine.packageP12 with the CA loaded.
|
|
52
|
+
*
|
|
53
|
+
* Engine contract (default lib/mtls-engine-default.js, override via
|
|
54
|
+
* opts.engine):
|
|
55
|
+
*
|
|
56
|
+
* {
|
|
57
|
+
* async generateCa({ generation })
|
|
58
|
+
* returns { caCertPem, caKeyPem },
|
|
59
|
+
* async signClientCert({ cn, validityDays, caCertPem, caKeyPem })
|
|
60
|
+
* returns { cert, key, ca, issuedAt, expiresAt },
|
|
61
|
+
* async packageP12({ cn, password, validityDays, caCertPem, caKeyPem })
|
|
62
|
+
* returns { p12, certPem, issuedAt, expiresAt },
|
|
63
|
+
* }
|
|
64
|
+
*
|
|
65
|
+
* Note: the engine returns the cert PEM (`certPem`) but does NOT
|
|
66
|
+
* compute a fingerprint — the framework hashes the cert via
|
|
67
|
+
* `b.crypto.sha3Hash(certPem)` for any audit / display purpose,
|
|
68
|
+
* keeping the SHA3-512 posture consistent across the rest of the
|
|
69
|
+
* stack. Operators who want the X.509-conventional SHA-256
|
|
70
|
+
* fingerprint (for browser cert-details panels, openssl interop)
|
|
71
|
+
* compute it separately from the cert PEM.
|
|
72
|
+
*/
|
|
73
|
+
|
|
74
|
+
var fs = require("fs");
|
|
75
|
+
var path = require("path");
|
|
76
|
+
var nodeCrypto = require("node:crypto");
|
|
77
|
+
var validateOpts = require("./validate-opts");
|
|
78
|
+
var { FrameworkError } = require("./framework-error");
|
|
79
|
+
|
|
80
|
+
class MtlsCaError extends FrameworkError {
|
|
81
|
+
constructor(code, message) {
|
|
82
|
+
super(message, code);
|
|
83
|
+
this.name = "MtlsCaError";
|
|
84
|
+
this.permanent = true;
|
|
85
|
+
this.isMtlsCaError = true;
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
var DEFAULT_PATHS = {
|
|
90
|
+
caKey: "ca.key",
|
|
91
|
+
caKeySealed: "ca.key.sealed",
|
|
92
|
+
caCert: "ca.crt",
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
var VALID_SEAL_MODES = { auto: 1, required: 1, disabled: 1 };
|
|
96
|
+
|
|
97
|
+
function _resolvePaths(dataDir, paths) {
|
|
98
|
+
var p = Object.assign({}, DEFAULT_PATHS, paths || {});
|
|
99
|
+
return {
|
|
100
|
+
caKey: path.join(dataDir, p.caKey),
|
|
101
|
+
caKeySealed: path.join(dataDir, p.caKeySealed),
|
|
102
|
+
caCert: path.join(dataDir, p.caCert),
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// Parse "OU=CAv{N}" from a PEM cert's subject DN. Returns the integer
|
|
107
|
+
// N (defaulting to 1 for untagged legacy CAs) or 0 when the cert is
|
|
108
|
+
// unreadable. Untagged returning 1 means the first regen lifts a legacy
|
|
109
|
+
// CA to generation 2 without misidentifying it as fresh.
|
|
110
|
+
function parseGeneration(certPem) {
|
|
111
|
+
if (typeof certPem !== "string" && !Buffer.isBuffer(certPem)) return 0;
|
|
112
|
+
try {
|
|
113
|
+
var cert = new nodeCrypto.X509Certificate(certPem);
|
|
114
|
+
var subj = cert.subject || "";
|
|
115
|
+
var m = /OU=CAv(\d+)/.exec(subj);
|
|
116
|
+
return m ? parseInt(m[1], 10) : 1;
|
|
117
|
+
} catch (_e) {
|
|
118
|
+
return 0;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
function create(opts) {
|
|
123
|
+
opts = opts || {};
|
|
124
|
+
validateOpts(opts, [
|
|
125
|
+
"dataDir", "paths", "vault",
|
|
126
|
+
"caKeySealedMode", "generation", "engine",
|
|
127
|
+
], "b.mtlsCa");
|
|
128
|
+
if (typeof opts.dataDir !== "string" || opts.dataDir.length === 0) {
|
|
129
|
+
throw new MtlsCaError("mtls-ca/no-datadir",
|
|
130
|
+
"mtlsCa.create requires opts.dataDir");
|
|
131
|
+
}
|
|
132
|
+
var paths = _resolvePaths(opts.dataDir, opts.paths);
|
|
133
|
+
var vault = opts.vault || null;
|
|
134
|
+
var caKeySealedMode = (opts.caKeySealedMode || "auto").toLowerCase();
|
|
135
|
+
if (!VALID_SEAL_MODES[caKeySealedMode]) {
|
|
136
|
+
throw new MtlsCaError("mtls-ca/bad-mode",
|
|
137
|
+
"caKeySealedMode must be 'auto', 'required', or 'disabled'");
|
|
138
|
+
}
|
|
139
|
+
var generation = typeof opts.generation === "number" && opts.generation >= 1
|
|
140
|
+
? Math.floor(opts.generation) : 1;
|
|
141
|
+
// The default engine carries a 600+ KB vendored bundle; load it only
|
|
142
|
+
// when operators rely on it (no custom engine passed). Operators who
|
|
143
|
+
// wire their own engine never pay the cost.
|
|
144
|
+
var engine = opts.engine || require("./mtls-engine-default");
|
|
145
|
+
|
|
146
|
+
function _requireVault(reason) {
|
|
147
|
+
if (!vault || typeof vault.seal !== "function" || typeof vault.unseal !== "function") {
|
|
148
|
+
throw new MtlsCaError("mtls-ca/no-vault",
|
|
149
|
+
reason + " requires opts.vault (with seal/unseal). Pass b.vault " +
|
|
150
|
+
"or use caKeySealedMode='disabled' to keep the CA key on disk in plaintext.");
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
function keyExists() {
|
|
155
|
+
return fs.existsSync(paths.caKey) || fs.existsSync(paths.caKeySealed);
|
|
156
|
+
}
|
|
157
|
+
function exists() {
|
|
158
|
+
return keyExists() && fs.existsSync(paths.caCert);
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
function status() {
|
|
162
|
+
if (!exists()) {
|
|
163
|
+
return {
|
|
164
|
+
exists: false,
|
|
165
|
+
generation: 0,
|
|
166
|
+
isLegacy: false,
|
|
167
|
+
current: generation,
|
|
168
|
+
};
|
|
169
|
+
}
|
|
170
|
+
var pem = fs.readFileSync(paths.caCert);
|
|
171
|
+
var gen = parseGeneration(pem);
|
|
172
|
+
return {
|
|
173
|
+
exists: true,
|
|
174
|
+
generation: gen,
|
|
175
|
+
isLegacy: gen < generation,
|
|
176
|
+
current: generation,
|
|
177
|
+
};
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
// Load the CA key in whichever form is on disk, applying the
|
|
181
|
+
// caKeySealedMode dispatch. Returns Buffer of PEM bytes, or throws
|
|
182
|
+
// with a precise reason when the mode rejects the on-disk form.
|
|
183
|
+
function loadKey() {
|
|
184
|
+
var hasPlain = fs.existsSync(paths.caKey);
|
|
185
|
+
var hasSealed = fs.existsSync(paths.caKeySealed);
|
|
186
|
+
if (!hasPlain && !hasSealed) {
|
|
187
|
+
throw new MtlsCaError("mtls-ca/missing-key",
|
|
188
|
+
"no CA key on disk at " + paths.caKey + " or " + paths.caKeySealed);
|
|
189
|
+
}
|
|
190
|
+
if (caKeySealedMode === "required") {
|
|
191
|
+
if (!hasSealed) {
|
|
192
|
+
throw new MtlsCaError("mtls-ca/sealed-required",
|
|
193
|
+
"CA_KEY_SEALED='required' but " + paths.caKeySealed + " does not exist");
|
|
194
|
+
}
|
|
195
|
+
_requireVault("sealed CA key load");
|
|
196
|
+
var sealedBytes = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
197
|
+
var pem = vault.unseal(sealedBytes);
|
|
198
|
+
if (!pem) {
|
|
199
|
+
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
200
|
+
"vault.unseal of " + paths.caKeySealed + " returned empty — vault key mismatch?");
|
|
201
|
+
}
|
|
202
|
+
return Buffer.from(pem, "utf8");
|
|
203
|
+
}
|
|
204
|
+
if (caKeySealedMode === "disabled") {
|
|
205
|
+
if (!hasPlain) {
|
|
206
|
+
throw new MtlsCaError("mtls-ca/plain-required",
|
|
207
|
+
"CA_KEY_SEALED='disabled' but " + paths.caKey + " does not exist");
|
|
208
|
+
}
|
|
209
|
+
return fs.readFileSync(paths.caKey);
|
|
210
|
+
}
|
|
211
|
+
// auto: prefer sealed if it exists (defense-in-depth default)
|
|
212
|
+
if (hasSealed) {
|
|
213
|
+
_requireVault("sealed CA key load");
|
|
214
|
+
var sealedBytesA = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
215
|
+
var pemA = vault.unseal(sealedBytesA);
|
|
216
|
+
if (!pemA) {
|
|
217
|
+
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
218
|
+
"vault.unseal of " + paths.caKeySealed + " returned empty");
|
|
219
|
+
}
|
|
220
|
+
return Buffer.from(pemA, "utf8");
|
|
221
|
+
}
|
|
222
|
+
return fs.readFileSync(paths.caKey);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
function loadCert() {
|
|
226
|
+
if (!fs.existsSync(paths.caCert)) {
|
|
227
|
+
throw new MtlsCaError("mtls-ca/missing-cert",
|
|
228
|
+
"no CA cert on disk at " + paths.caCert);
|
|
229
|
+
}
|
|
230
|
+
return fs.readFileSync(paths.caCert);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
// Atomic commit: write .tmp + atomic rename for both key and cert.
|
|
234
|
+
// Honors caKeySealedMode — when 'required', the key is vault-sealed
|
|
235
|
+
// before the on-disk write so plaintext PEM never touches the
|
|
236
|
+
// filesystem; when 'disabled', it goes to disk as PEM. 'auto'
|
|
237
|
+
// defaults to plaintext-on-disk.
|
|
238
|
+
function commit(opts2) {
|
|
239
|
+
if (!opts2 || typeof opts2.caKeyPem !== "string" || typeof opts2.caCertPem !== "string") {
|
|
240
|
+
throw new MtlsCaError("mtls-ca/bad-commit",
|
|
241
|
+
"commit requires opts.caKeyPem and opts.caCertPem (PEM strings)");
|
|
242
|
+
}
|
|
243
|
+
var sealed = caKeySealedMode === "required";
|
|
244
|
+
var keyDest = sealed ? paths.caKeySealed : paths.caKey;
|
|
245
|
+
var keyTmp = keyDest + ".tmp";
|
|
246
|
+
var certTmp = paths.caCert + ".tmp";
|
|
247
|
+
|
|
248
|
+
try {
|
|
249
|
+
if (sealed) {
|
|
250
|
+
_requireVault("sealed CA key commit");
|
|
251
|
+
fs.writeFileSync(keyTmp, vault.seal(opts2.caKeyPem), { mode: 0o600 });
|
|
252
|
+
} else {
|
|
253
|
+
fs.writeFileSync(keyTmp, opts2.caKeyPem, { mode: 0o600 });
|
|
254
|
+
}
|
|
255
|
+
fs.writeFileSync(certTmp, opts2.caCertPem, { mode: 0o644 });
|
|
256
|
+
fs.renameSync(keyTmp, keyDest);
|
|
257
|
+
fs.renameSync(certTmp, paths.caCert);
|
|
258
|
+
} catch (e) {
|
|
259
|
+
try { if (fs.existsSync(keyTmp)) fs.unlinkSync(keyTmp); } catch (_e) {}
|
|
260
|
+
try { if (fs.existsSync(certTmp)) fs.unlinkSync(certTmp); } catch (_e) {}
|
|
261
|
+
throw new MtlsCaError("mtls-ca/commit-failed",
|
|
262
|
+
"atomic CA commit failed: " + ((e && e.message) || String(e)));
|
|
263
|
+
}
|
|
264
|
+
return {
|
|
265
|
+
keyPath: keyDest,
|
|
266
|
+
certPath: paths.caCert,
|
|
267
|
+
sealed: sealed,
|
|
268
|
+
};
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
async function initCA() {
|
|
272
|
+
if (exists()) {
|
|
273
|
+
return { caCertPem: loadCert().toString("utf8"), caKeyPem: loadKey().toString("utf8") };
|
|
274
|
+
}
|
|
275
|
+
var fresh = await engine.generateCa({ generation: generation });
|
|
276
|
+
if (!fresh || typeof fresh.caCertPem !== "string" || typeof fresh.caKeyPem !== "string") {
|
|
277
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
278
|
+
"engine.generateCa must return { caCertPem, caKeyPem }");
|
|
279
|
+
}
|
|
280
|
+
commit(fresh);
|
|
281
|
+
return fresh;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
async function generateClientCert(opts2) {
|
|
285
|
+
opts2 = opts2 || {};
|
|
286
|
+
var ca = await initCA();
|
|
287
|
+
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
288
|
+
var result = await engine.signClientCert(args);
|
|
289
|
+
if (!result || typeof result.cert !== "string" || typeof result.key !== "string") {
|
|
290
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
291
|
+
"engine.signClientCert must return { cert, key, ca?, issuedAt?, expiresAt? }");
|
|
292
|
+
}
|
|
293
|
+
return result;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
async function generateClientP12(opts2) {
|
|
297
|
+
opts2 = opts2 || {};
|
|
298
|
+
if (!opts2.password || typeof opts2.password !== "string") {
|
|
299
|
+
throw new MtlsCaError("mtls-ca/no-password",
|
|
300
|
+
"generateClientP12 requires opts.password (the PKCS#12 encryption password)");
|
|
301
|
+
}
|
|
302
|
+
var ca = await initCA();
|
|
303
|
+
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
304
|
+
var result = await engine.packageP12(args);
|
|
305
|
+
if (!result || !Buffer.isBuffer(result.p12)) {
|
|
306
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
307
|
+
"engine.packageP12 must return { p12: Buffer, certPem, issuedAt, expiresAt }");
|
|
308
|
+
}
|
|
309
|
+
return result;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
return {
|
|
313
|
+
exists: exists,
|
|
314
|
+
keyExists: keyExists,
|
|
315
|
+
status: status,
|
|
316
|
+
loadKey: loadKey,
|
|
317
|
+
loadCert: loadCert,
|
|
318
|
+
commit: commit,
|
|
319
|
+
initCA: initCA,
|
|
320
|
+
generateClientCert: generateClientCert,
|
|
321
|
+
generateClientP12: generateClientP12,
|
|
322
|
+
paths: paths,
|
|
323
|
+
generation: generation,
|
|
324
|
+
caKeySealedMode: caKeySealedMode,
|
|
325
|
+
};
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
module.exports = {
|
|
329
|
+
create: create,
|
|
330
|
+
parseGeneration: parseGeneration,
|
|
331
|
+
MtlsCaError: MtlsCaError,
|
|
332
|
+
DEFAULT_PATHS: DEFAULT_PATHS,
|
|
333
|
+
};
|