@blamejs/core 0.7.1 → 0.7.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +423 -389
- package/README.md +150 -149
- package/bin/blamejs.js +0 -0
- package/index.js +308 -282
- package/lib/api-key.js +660 -672
- package/lib/api-snapshot.js +338 -338
- package/lib/app-shutdown.js +385 -385
- package/lib/app.js +365 -365
- package/lib/archive.js +250 -250
- package/lib/atomic-file.js +544 -544
- package/lib/audit-chain.js +177 -177
- package/lib/audit-sign.js +344 -344
- package/lib/audit-tools.js +677 -677
- package/lib/audit.js +766 -766
- package/lib/auth/jwt.js +311 -311
- package/lib/auth/lockout.js +436 -436
- package/lib/auth/oauth.js +721 -721
- package/lib/auth/passkey.js +181 -181
- package/lib/auth/password.js +594 -594
- package/lib/backup/bundle.js +217 -217
- package/lib/backup/crypto.js +176 -176
- package/lib/backup/index.js +515 -515
- package/lib/backup/manifest.js +282 -282
- package/lib/break-glass.js +1338 -1338
- package/lib/bundler.js +441 -441
- package/lib/cache-redis.js +256 -266
- package/lib/cache.js +1206 -1211
- package/lib/canonical-json.js +115 -115
- package/lib/chain-writer.js +234 -234
- package/lib/cli-helpers.js +206 -206
- package/lib/cli.js +2334 -2334
- package/lib/cluster-provider-db.js +317 -317
- package/lib/cluster-storage.js +226 -226
- package/lib/cluster.js +703 -703
- package/lib/codepoint-class.js +196 -0
- package/lib/config-drift.js +301 -301
- package/lib/consent.js +222 -222
- package/lib/constants.js +191 -191
- package/lib/cookies.js +315 -315
- package/lib/credential-hash.js +322 -322
- package/lib/crypto.js +266 -266
- package/lib/csv.js +275 -286
- package/lib/db-declare-row-policy.js +267 -267
- package/lib/db-declare-view.js +420 -421
- package/lib/db-query.js +406 -406
- package/lib/db-schema.js +319 -319
- package/lib/db.js +1288 -1288
- package/lib/deprecate.js +222 -222
- package/lib/dev.js +335 -335
- package/lib/dual-control.js +473 -473
- package/lib/error-page.js +420 -420
- package/lib/external-db-migrate.js +441 -441
- package/lib/external-db.js +1061 -1061
- package/lib/file-type.js +273 -273
- package/lib/file-upload.js +1136 -0
- package/lib/forms.js +422 -422
- package/lib/framework-error.js +293 -202
- package/lib/framework-schema.js +717 -717
- package/lib/gate-contract.js +971 -0
- package/lib/guard-all.js +405 -0
- package/lib/guard-archive.js +739 -0
- package/lib/guard-csv.js +816 -0
- package/lib/guard-email.js +744 -0
- package/lib/guard-filename.js +724 -0
- package/lib/guard-html.js +976 -0
- package/lib/guard-json.js +729 -0
- package/lib/guard-markdown.js +586 -0
- package/lib/guard-svg.js +976 -0
- package/lib/guard-xml.js +405 -0
- package/lib/guard-yaml.js +529 -0
- package/lib/handlers.js +350 -350
- package/lib/http-client-cookie-jar.js +508 -508
- package/lib/http-client.js +1195 -1195
- package/lib/i18n.js +878 -878
- package/lib/jobs.js +185 -185
- package/lib/log-stream-cloudwatch.js +369 -369
- package/lib/log-stream-local.js +146 -146
- package/lib/log-stream-otlp-grpc.js +410 -410
- package/lib/log-stream-otlp.js +286 -286
- package/lib/log-stream-syslog.js +302 -302
- package/lib/log-stream-webhook.js +199 -199
- package/lib/log-stream.js +330 -330
- package/lib/log.js +500 -500
- package/lib/mail-bounce.js +528 -528
- package/lib/mail-dkim.js +369 -362
- package/lib/mail.js +981 -962
- package/lib/metrics.js +683 -683
- package/lib/middleware/api-encrypt.js +936 -573
- package/lib/middleware/attach-user.js +157 -157
- package/lib/middleware/body-parser.js +1170 -1091
- package/lib/middleware/bot-guard.js +178 -178
- package/lib/middleware/compression.js +452 -452
- package/lib/middleware/cors.js +314 -314
- package/lib/middleware/csp-nonce.js +348 -348
- package/lib/middleware/csrf-protect.js +316 -316
- package/lib/middleware/db-role-for.js +264 -269
- package/lib/middleware/health.js +392 -392
- package/lib/middleware/index.js +79 -79
- package/lib/middleware/rate-limit.js +358 -358
- package/lib/middleware/request-id.js +61 -61
- package/lib/middleware/request-log.js +168 -168
- package/lib/middleware/require-auth.js +104 -104
- package/lib/middleware/security-headers.js +116 -116
- package/lib/middleware/sse.js +166 -166
- package/lib/migrations.js +383 -383
- package/lib/mtls-ca.js +518 -518
- package/lib/mtls-engine-default.js +481 -481
- package/lib/network-dns.js +632 -632
- package/lib/network-heartbeat.js +290 -290
- package/lib/network-nts.js +574 -574
- package/lib/network-proxy.js +265 -265
- package/lib/network-tls.js +328 -328
- package/lib/network.js +233 -233
- package/lib/notify.js +612 -614
- package/lib/ntp-check.js +229 -229
- package/lib/numeric-bounds.js +111 -91
- package/lib/object-store/azure-blob-bucket-ops.js +349 -349
- package/lib/object-store/azure-blob.js +488 -451
- package/lib/object-store/gcs-bucket-ops.js +351 -351
- package/lib/object-store/gcs.js +519 -479
- package/lib/object-store/http-put.js +153 -153
- package/lib/object-store/index.js +197 -197
- package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
- package/lib/object-store/sigv4.js +903 -855
- package/lib/observability.js +151 -151
- package/lib/otel-export.js +269 -269
- package/lib/pagination.js +464 -464
- package/lib/parsers/index.js +80 -80
- package/lib/parsers/safe-env.js +642 -642
- package/lib/parsers/safe-ini.js +292 -292
- package/lib/parsers/safe-toml.js +784 -784
- package/lib/parsers/safe-xml.js +390 -390
- package/lib/parsers/safe-yaml.js +1015 -1015
- package/lib/permissions.js +708 -708
- package/lib/pqc-agent.js +87 -87
- package/lib/pqc-gate.js +279 -279
- package/lib/protobuf-encoder.js +190 -190
- package/lib/protocol-dispatcher.js +161 -161
- package/lib/pubsub-redis.js +167 -177
- package/lib/pubsub.js +429 -429
- package/lib/queue-local.js +476 -476
- package/lib/queue-redis.js +745 -752
- package/lib/queue-sqs.js +319 -319
- package/lib/queue.js +695 -695
- package/lib/redis-client.js +519 -489
- package/lib/request-helpers.js +340 -336
- package/lib/restore-bundle.js +237 -237
- package/lib/restore-rollback.js +259 -259
- package/lib/restore.js +409 -409
- package/lib/retry.js +376 -376
- package/lib/router.js +748 -748
- package/lib/safe-async.js +735 -735
- package/lib/safe-buffer.js +237 -237
- package/lib/safe-json.js +541 -541
- package/lib/safe-schema.js +1266 -1266
- package/lib/safe-url.js +159 -159
- package/lib/scheduler.js +706 -706
- package/lib/security-assert.js +373 -373
- package/lib/seeders.js +618 -630
- package/lib/session.js +478 -478
- package/lib/slug.js +269 -269
- package/lib/ssrf-guard.js +401 -401
- package/lib/static.js +879 -114
- package/lib/storage.js +471 -471
- package/lib/subject.js +281 -281
- package/lib/template.js +791 -791
- package/lib/testing.js +798 -798
- package/lib/time.js +310 -310
- package/lib/totp.js +302 -302
- package/lib/tracing.js +494 -494
- package/lib/uuid.js +132 -132
- package/lib/validate-opts.js +340 -270
- package/lib/vault/index.js +308 -308
- package/lib/vault/rotate.js +784 -784
- package/lib/vault/wrap.js +296 -296
- package/lib/vendor/noble-ciphers.cjs +9 -9
- package/lib/webhook.js +595 -598
- package/lib/websocket.js +1048 -1048
- package/package.json +77 -77
- package/sbom.cyclonedx.json +7 -7
package/lib/mtls-ca.js
CHANGED
|
@@ -1,518 +1,518 @@
|
|
|
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 atomicFile = require("./atomic-file");
|
|
78
|
-
var C = require("./constants");
|
|
79
|
-
var lazyRequire = require("./lazy-require");
|
|
80
|
-
var { boot } = require("./log");
|
|
81
|
-
var safeBuffer = require("./safe-buffer");
|
|
82
|
-
var safeJson = require("./safe-json");
|
|
83
|
-
var validateOpts = require("./validate-opts");
|
|
84
|
-
var { FrameworkError } = require("./framework-error");
|
|
85
|
-
|
|
86
|
-
// The default engine carries a 600+ KB vendored bundle (peculiar/x509 +
|
|
87
|
-
// pkijs + reflect-metadata). Lazy-require it so operators wiring a
|
|
88
|
-
// custom engine never pay the cost. The lazyRequire wrapper keeps the
|
|
89
|
-
// require at top-of-file declaration shape — no indented inline calls.
|
|
90
|
-
var mtlsEngineDefault = lazyRequire(function () { return require("./mtls-engine-default"); });
|
|
91
|
-
|
|
92
|
-
var caLog = boot("mtls-ca");
|
|
93
|
-
|
|
94
|
-
class MtlsCaError extends FrameworkError {
|
|
95
|
-
constructor(code, message) {
|
|
96
|
-
super(message, code);
|
|
97
|
-
this.name = "MtlsCaError";
|
|
98
|
-
this.permanent = true;
|
|
99
|
-
this.isMtlsCaError = true;
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
var DEFAULT_PATHS = {
|
|
104
|
-
caKey: "ca.key",
|
|
105
|
-
caKeySealed: "ca.key.sealed",
|
|
106
|
-
caCert: "ca.crt",
|
|
107
|
-
// Revocation registry — JSON file under dataDir tracking revoked
|
|
108
|
-
// serial numbers. Operators export this as a CRL via
|
|
109
|
-
// ca.generateCrl() (engine.generateCrl signs the list with the CA
|
|
110
|
-
// key). Persisted as JSON rather than a stored CRL because the
|
|
111
|
-
// signed CRL is a derivative artifact — the registry survives CA
|
|
112
|
-
// rotation, the CRL doesn't.
|
|
113
|
-
revocations: "revocations.json",
|
|
114
|
-
crl: "ca.crl",
|
|
115
|
-
};
|
|
116
|
-
|
|
117
|
-
var VALID_SEAL_MODES = { auto: 1, required: 1, disabled: 1 };
|
|
118
|
-
|
|
119
|
-
function _resolvePaths(dataDir, paths) {
|
|
120
|
-
var p = Object.assign({}, DEFAULT_PATHS, paths || {});
|
|
121
|
-
return {
|
|
122
|
-
caKey: path.join(dataDir, p.caKey),
|
|
123
|
-
caKeySealed: path.join(dataDir, p.caKeySealed),
|
|
124
|
-
caCert: path.join(dataDir, p.caCert),
|
|
125
|
-
revocations: path.join(dataDir, p.revocations),
|
|
126
|
-
crl: path.join(dataDir, p.crl),
|
|
127
|
-
};
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
// Parse "OU=CAv{N}" from a PEM cert's subject DN. Returns the integer
|
|
131
|
-
// N (defaulting to 1 for untagged legacy CAs) or 0 when the cert is
|
|
132
|
-
// unreadable. Untagged returning 1 means the first regen lifts a legacy
|
|
133
|
-
// CA to generation 2 without misidentifying it as fresh.
|
|
134
|
-
function parseGeneration(certPem) {
|
|
135
|
-
if (typeof certPem !== "string" && !Buffer.isBuffer(certPem)) return 0;
|
|
136
|
-
try {
|
|
137
|
-
var cert = new nodeCrypto.X509Certificate(certPem);
|
|
138
|
-
var subj = cert.subject || "";
|
|
139
|
-
var m = /OU=CAv(\d+)/.exec(subj);
|
|
140
|
-
return m ? parseInt(m[1], 10) : 1;
|
|
141
|
-
} catch (_e) {
|
|
142
|
-
return 0;
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
function create(opts) {
|
|
147
|
-
opts = opts || {};
|
|
148
|
-
validateOpts(opts, [
|
|
149
|
-
"dataDir", "paths", "vault",
|
|
150
|
-
"caKeySealedMode", "generation", "engine",
|
|
151
|
-
], "b.mtlsCa");
|
|
152
|
-
validateOpts.requireNonEmptyString(opts.dataDir, "mtlsCa.create: opts.dataDir", MtlsCaError, "mtls-ca/no-datadir");
|
|
153
|
-
// Auto-create the dataDir with restrictive perms (CA keys live here).
|
|
154
|
-
// Matches the behaviour of other framework primitives that own a
|
|
155
|
-
// dataDir — log-stream-local, backup, restore-bundle. Without this
|
|
156
|
-
// the first initCA() / generateClientCert() call fails with ENOENT
|
|
157
|
-
// on `ca.key.tmp` because the atomic-file write expects the parent
|
|
158
|
-
// dir to exist.
|
|
159
|
-
if (!fs.existsSync(opts.dataDir)) {
|
|
160
|
-
fs.mkdirSync(opts.dataDir, { recursive: true, mode: 0o700 });
|
|
161
|
-
}
|
|
162
|
-
var paths = _resolvePaths(opts.dataDir, opts.paths);
|
|
163
|
-
var vault = opts.vault || null;
|
|
164
|
-
var caKeySealedMode = (opts.caKeySealedMode || "auto").toLowerCase();
|
|
165
|
-
if (!VALID_SEAL_MODES[caKeySealedMode]) {
|
|
166
|
-
throw new MtlsCaError("mtls-ca/bad-mode",
|
|
167
|
-
"caKeySealedMode must be 'auto', 'required', or 'disabled'");
|
|
168
|
-
}
|
|
169
|
-
var generation = typeof opts.generation === "number" && opts.generation >= 1
|
|
170
|
-
? Math.floor(opts.generation) : 1;
|
|
171
|
-
// The default engine is lazy-loaded at top-of-file; resolve it only
|
|
172
|
-
// when no custom engine was passed.
|
|
173
|
-
var engine = opts.engine || mtlsEngineDefault();
|
|
174
|
-
|
|
175
|
-
function _requireVault(reason) {
|
|
176
|
-
if (!vault || typeof vault.seal !== "function" || typeof vault.unseal !== "function") {
|
|
177
|
-
throw new MtlsCaError("mtls-ca/no-vault",
|
|
178
|
-
reason + " requires opts.vault (with seal/unseal). Pass b.vault " +
|
|
179
|
-
"or use caKeySealedMode='disabled' to keep the CA key on disk in plaintext.");
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
function keyExists() {
|
|
184
|
-
return fs.existsSync(paths.caKey) || fs.existsSync(paths.caKeySealed);
|
|
185
|
-
}
|
|
186
|
-
function exists() {
|
|
187
|
-
return keyExists() && fs.existsSync(paths.caCert);
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
function status() {
|
|
191
|
-
if (!exists()) {
|
|
192
|
-
return {
|
|
193
|
-
exists: false,
|
|
194
|
-
generation: 0,
|
|
195
|
-
isLegacy: false,
|
|
196
|
-
current: generation,
|
|
197
|
-
};
|
|
198
|
-
}
|
|
199
|
-
var pem = fs.readFileSync(paths.caCert);
|
|
200
|
-
var gen = parseGeneration(pem);
|
|
201
|
-
return {
|
|
202
|
-
exists: true,
|
|
203
|
-
generation: gen,
|
|
204
|
-
isLegacy: gen < generation,
|
|
205
|
-
current: generation,
|
|
206
|
-
};
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
// Load the CA key in whichever form is on disk, applying the
|
|
210
|
-
// caKeySealedMode dispatch. Returns Buffer of PEM bytes, or throws
|
|
211
|
-
// with a precise reason when the mode rejects the on-disk form.
|
|
212
|
-
function loadKey() {
|
|
213
|
-
var hasPlain = fs.existsSync(paths.caKey);
|
|
214
|
-
var hasSealed = fs.existsSync(paths.caKeySealed);
|
|
215
|
-
if (!hasPlain && !hasSealed) {
|
|
216
|
-
throw new MtlsCaError("mtls-ca/missing-key",
|
|
217
|
-
"no CA key on disk at " + paths.caKey + " or " + paths.caKeySealed);
|
|
218
|
-
}
|
|
219
|
-
if (caKeySealedMode === "required") {
|
|
220
|
-
if (!hasSealed) {
|
|
221
|
-
throw new MtlsCaError("mtls-ca/sealed-required",
|
|
222
|
-
"CA_KEY_SEALED='required' but " + paths.caKeySealed + " does not exist");
|
|
223
|
-
}
|
|
224
|
-
_requireVault("sealed CA key load");
|
|
225
|
-
var sealedBytes = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
226
|
-
var pem = vault.unseal(sealedBytes);
|
|
227
|
-
if (!pem) {
|
|
228
|
-
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
229
|
-
"vault.unseal of " + paths.caKeySealed + " returned empty — vault key mismatch?");
|
|
230
|
-
}
|
|
231
|
-
return Buffer.from(pem, "utf8");
|
|
232
|
-
}
|
|
233
|
-
if (caKeySealedMode === "disabled") {
|
|
234
|
-
if (!hasPlain) {
|
|
235
|
-
throw new MtlsCaError("mtls-ca/plain-required",
|
|
236
|
-
"CA_KEY_SEALED='disabled' but " + paths.caKey + " does not exist");
|
|
237
|
-
}
|
|
238
|
-
return fs.readFileSync(paths.caKey);
|
|
239
|
-
}
|
|
240
|
-
// auto: prefer sealed if it exists (defense-in-depth default)
|
|
241
|
-
if (hasSealed) {
|
|
242
|
-
_requireVault("sealed CA key load");
|
|
243
|
-
var sealedBytesA = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
244
|
-
var pemA = vault.unseal(sealedBytesA);
|
|
245
|
-
if (!pemA) {
|
|
246
|
-
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
247
|
-
"vault.unseal of " + paths.caKeySealed + " returned empty");
|
|
248
|
-
}
|
|
249
|
-
return Buffer.from(pemA, "utf8");
|
|
250
|
-
}
|
|
251
|
-
return fs.readFileSync(paths.caKey);
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
function loadCert() {
|
|
255
|
-
if (!fs.existsSync(paths.caCert)) {
|
|
256
|
-
throw new MtlsCaError("mtls-ca/missing-cert",
|
|
257
|
-
"no CA cert on disk at " + paths.caCert);
|
|
258
|
-
}
|
|
259
|
-
return fs.readFileSync(paths.caCert);
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
// Atomic commit: write .tmp + atomic rename for both key and cert.
|
|
263
|
-
// Honors caKeySealedMode — when 'required', the key is vault-sealed
|
|
264
|
-
// before the on-disk write so plaintext PEM never touches the
|
|
265
|
-
// filesystem; when 'disabled', it goes to disk as PEM. 'auto'
|
|
266
|
-
// defaults to plaintext-on-disk.
|
|
267
|
-
function commit(opts2) {
|
|
268
|
-
if (!opts2 || typeof opts2.caKeyPem !== "string" || typeof opts2.caCertPem !== "string") {
|
|
269
|
-
throw new MtlsCaError("mtls-ca/bad-commit",
|
|
270
|
-
"commit requires opts.caKeyPem and opts.caCertPem (PEM strings)");
|
|
271
|
-
}
|
|
272
|
-
var sealed = caKeySealedMode === "required";
|
|
273
|
-
var keyDest = sealed ? paths.caKeySealed : paths.caKey;
|
|
274
|
-
var keyTmp = keyDest + ".tmp";
|
|
275
|
-
var certTmp = paths.caCert + ".tmp";
|
|
276
|
-
|
|
277
|
-
try {
|
|
278
|
-
if (sealed) {
|
|
279
|
-
_requireVault("sealed CA key commit");
|
|
280
|
-
fs.writeFileSync(keyTmp, vault.seal(opts2.caKeyPem), { mode: 0o600 });
|
|
281
|
-
} else {
|
|
282
|
-
fs.writeFileSync(keyTmp, opts2.caKeyPem, { mode: 0o600 });
|
|
283
|
-
}
|
|
284
|
-
fs.writeFileSync(certTmp, opts2.caCertPem, { mode: 0o644 });
|
|
285
|
-
fs.renameSync(keyTmp, keyDest);
|
|
286
|
-
fs.renameSync(certTmp, paths.caCert);
|
|
287
|
-
} catch (e) {
|
|
288
|
-
// Best-effort cleanup of half-written tmp files; the original
|
|
289
|
-
// commit error is what we re-raise. Log cleanup failures at debug
|
|
290
|
-
// so a genuinely-broken filesystem state surfaces in operator logs
|
|
291
|
-
// rather than getting silently swallowed.
|
|
292
|
-
try { if (fs.existsSync(keyTmp)) fs.unlinkSync(keyTmp); }
|
|
293
|
-
catch (cleanupErr) { caLog.debug("cleanup-failed", { op: "fs.unlinkSync", path: keyTmp, error: cleanupErr.message }); }
|
|
294
|
-
try { if (fs.existsSync(certTmp)) fs.unlinkSync(certTmp); }
|
|
295
|
-
catch (cleanupErr) { caLog.debug("cleanup-failed", { op: "fs.unlinkSync", path: certTmp, error: cleanupErr.message }); }
|
|
296
|
-
throw new MtlsCaError("mtls-ca/commit-failed",
|
|
297
|
-
"atomic CA commit failed: " + ((e && e.message) || String(e)));
|
|
298
|
-
}
|
|
299
|
-
return {
|
|
300
|
-
keyPath: keyDest,
|
|
301
|
-
certPath: paths.caCert,
|
|
302
|
-
sealed: sealed,
|
|
303
|
-
};
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
async function initCA() {
|
|
307
|
-
if (exists()) {
|
|
308
|
-
return { caCertPem: loadCert().toString("utf8"), caKeyPem: loadKey().toString("utf8") };
|
|
309
|
-
}
|
|
310
|
-
var fresh = await engine.generateCa({ generation: generation });
|
|
311
|
-
if (!fresh || typeof fresh.caCertPem !== "string" || typeof fresh.caKeyPem !== "string") {
|
|
312
|
-
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
313
|
-
"engine.generateCa must return { caCertPem, caKeyPem }");
|
|
314
|
-
}
|
|
315
|
-
commit(fresh);
|
|
316
|
-
return fresh;
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
async function generateClientCert(opts2) {
|
|
320
|
-
opts2 = opts2 || {};
|
|
321
|
-
var ca = await initCA();
|
|
322
|
-
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
323
|
-
var result = await engine.signClientCert(args);
|
|
324
|
-
if (!result || typeof result.cert !== "string" || typeof result.key !== "string") {
|
|
325
|
-
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
326
|
-
"engine.signClientCert must return { cert, key, ca?, issuedAt?, expiresAt? }");
|
|
327
|
-
}
|
|
328
|
-
return result;
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
async function generateClientP12(opts2) {
|
|
332
|
-
opts2 = opts2 || {};
|
|
333
|
-
if (!opts2.password || typeof opts2.password !== "string") {
|
|
334
|
-
throw new MtlsCaError("mtls-ca/no-password",
|
|
335
|
-
"generateClientP12 requires opts.password (the PKCS#12 encryption password)");
|
|
336
|
-
}
|
|
337
|
-
var ca = await initCA();
|
|
338
|
-
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
339
|
-
var result = await engine.packageP12(args);
|
|
340
|
-
if (!result || !Buffer.isBuffer(result.p12)) {
|
|
341
|
-
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
342
|
-
"engine.packageP12 must return { p12: Buffer, certPem, issuedAt, expiresAt }");
|
|
343
|
-
}
|
|
344
|
-
return result;
|
|
345
|
-
}
|
|
346
|
-
|
|
347
|
-
// ---- Revocation registry + CRL ----
|
|
348
|
-
|
|
349
|
-
function _loadRevocations() {
|
|
350
|
-
if (!fs.existsSync(paths.revocations)) return { revocations: [] };
|
|
351
|
-
try {
|
|
352
|
-
// safeJson.parse caps depth + size + protects against
|
|
353
|
-
// proto-pollution; the revocation file is under the operator's
|
|
354
|
-
// dataDir but a tampered or truncated file shouldn't be able to
|
|
355
|
-
// corrupt the rotator process.
|
|
356
|
-
var json = safeJson.parse(fs.readFileSync(paths.revocations, "utf8"),
|
|
357
|
-
{ maxBytes: C.BYTES.mib(16) });
|
|
358
|
-
if (!json || !Array.isArray(json.revocations)) return { revocations: [] };
|
|
359
|
-
return json;
|
|
360
|
-
} catch (e) {
|
|
361
|
-
throw new MtlsCaError("mtls-ca/revocation-corrupt",
|
|
362
|
-
"could not parse " + paths.revocations + ": " +
|
|
363
|
-
((e && e.message) || String(e)));
|
|
364
|
-
}
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
function _saveRevocations(state) {
|
|
368
|
-
atomicFile.writeSync(paths.revocations,
|
|
369
|
-
JSON.stringify(state, null, 2) + "\n", { mode: 0o600 });
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
function _normalizeSerial(s) {
|
|
373
|
-
if (!s || typeof s !== "string") {
|
|
374
|
-
throw new MtlsCaError("mtls-ca/bad-serial",
|
|
375
|
-
"serial number must be a non-empty string");
|
|
376
|
-
}
|
|
377
|
-
// Strip the optional leading `0x` and any common separators
|
|
378
|
-
// (`:` or `-` or whitespace). What remains MUST be hex — otherwise
|
|
379
|
-
// we silently accept gibberish like "xyz-not-hex" (which previously
|
|
380
|
-
// normalised to a single "e" because the strip-non-hex regex left
|
|
381
|
-
// exactly one valid char). Operators pasting an openssl-printed
|
|
382
|
-
// serial use any of: "0xABC123", "AB:C1:23", "AB-C1-23", "abc 123";
|
|
383
|
-
// a typo or non-serial string fails fast instead of registering a
|
|
384
|
-
// phantom revocation row.
|
|
385
|
-
var stripped = s.replace(/^0x/i, "").replace(/[:\-\s]/g, "");
|
|
386
|
-
if (!safeBuffer.isHex(stripped)) {
|
|
387
|
-
throw new MtlsCaError("mtls-ca/bad-serial",
|
|
388
|
-
"serial number contains non-hex characters " +
|
|
389
|
-
"(allowed shapes: hex with optional 0x prefix, ':', '-', or whitespace " +
|
|
390
|
-
"as separators): " + JSON.stringify(s));
|
|
391
|
-
}
|
|
392
|
-
return stripped.toLowerCase();
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
// Map operator-friendly reason codes to RFC 5280 numeric codes used
|
|
396
|
-
// by X.509 CRLs. Default "unspecified" (0) when omitted. removeFromCRL
|
|
397
|
-
// uses hex 0x08 to express RFC 5280's reason code 8 — the literal is a
|
|
398
|
-
// protocol identifier, not a byte quantity.
|
|
399
|
-
var CRL_REASON_BY_NAME = {
|
|
400
|
-
"unspecified": 0,
|
|
401
|
-
"keyCompromise": 1,
|
|
402
|
-
"key-compromise": 1,
|
|
403
|
-
"caCompromise": 2,
|
|
404
|
-
"ca-compromise": 2,
|
|
405
|
-
"affiliationChanged": 3,
|
|
406
|
-
"superseded": 4,
|
|
407
|
-
"cessationOfOperation": 5,
|
|
408
|
-
"cessation-of-operation": 5,
|
|
409
|
-
"certificateHold": 6,
|
|
410
|
-
"removeFromCRL": 0x08,
|
|
411
|
-
"privilegeWithdrawn": 9,
|
|
412
|
-
"aACompromise": 10,
|
|
413
|
-
};
|
|
414
|
-
|
|
415
|
-
function revoke(serialNumber, opts3) {
|
|
416
|
-
var serial = _normalizeSerial(serialNumber);
|
|
417
|
-
opts3 = opts3 || {};
|
|
418
|
-
var reasonName = opts3.reason || "unspecified";
|
|
419
|
-
var reasonCode = CRL_REASON_BY_NAME[reasonName];
|
|
420
|
-
if (reasonCode === undefined) {
|
|
421
|
-
throw new MtlsCaError("mtls-ca/bad-reason",
|
|
422
|
-
"revoke: unknown reason '" + reasonName + "' (valid: " +
|
|
423
|
-
Object.keys(CRL_REASON_BY_NAME).join(", ") + ")");
|
|
424
|
-
}
|
|
425
|
-
var state = _loadRevocations();
|
|
426
|
-
var existing = state.revocations.find(function (r) {
|
|
427
|
-
return r.serialNumber === serial;
|
|
428
|
-
});
|
|
429
|
-
if (existing) {
|
|
430
|
-
// Idempotent — repeated revoke() of the same serial doesn't
|
|
431
|
-
// shift the revokedAt timestamp.
|
|
432
|
-
return existing;
|
|
433
|
-
}
|
|
434
|
-
var entry = {
|
|
435
|
-
serialNumber: serial,
|
|
436
|
-
reason: reasonName,
|
|
437
|
-
reasonCode: reasonCode,
|
|
438
|
-
revokedAt: Date.now(),
|
|
439
|
-
};
|
|
440
|
-
state.revocations.push(entry);
|
|
441
|
-
_saveRevocations(state);
|
|
442
|
-
return entry;
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
function isRevoked(serialNumber) {
|
|
446
|
-
var serial = _normalizeSerial(serialNumber);
|
|
447
|
-
var state = _loadRevocations();
|
|
448
|
-
return state.revocations.some(function (r) {
|
|
449
|
-
return r.serialNumber === serial;
|
|
450
|
-
});
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
function getRevocations() {
|
|
454
|
-
return _loadRevocations().revocations.slice();
|
|
455
|
-
}
|
|
456
|
-
|
|
457
|
-
// Generate a signed X.509 CRL covering every entry in the registry.
|
|
458
|
-
// RFC 5280 — issuer = CA subject, signed by the CA private key.
|
|
459
|
-
// Operators publish the resulting PEM at a CRL distribution point
|
|
460
|
-
// referenced from issued certs (cert extension support is on the
|
|
461
|
-
// engine roadmap; for now operators set up the URL externally).
|
|
462
|
-
async function generateCrl(opts3) {
|
|
463
|
-
opts3 = opts3 || {};
|
|
464
|
-
if (typeof engine.generateCrl !== "function") {
|
|
465
|
-
throw new MtlsCaError("mtls-ca/engine-no-crl",
|
|
466
|
-
"configured engine does not implement generateCrl(); the bundled " +
|
|
467
|
-
"engine ships in v0.6.45+");
|
|
468
|
-
}
|
|
469
|
-
var ca = await initCA();
|
|
470
|
-
var revocations = _loadRevocations().revocations;
|
|
471
|
-
var nowMs = Date.now();
|
|
472
|
-
var thisUpdate = opts3.thisUpdate || new Date(nowMs);
|
|
473
|
-
var nextUpdate = opts3.nextUpdate ||
|
|
474
|
-
new Date(nowMs + C.TIME.days(7)); // 7d default
|
|
475
|
-
var crlPem = await engine.generateCrl({
|
|
476
|
-
caCertPem: ca.caCertPem,
|
|
477
|
-
caKeyPem: ca.caKeyPem,
|
|
478
|
-
revocations: revocations,
|
|
479
|
-
thisUpdate: thisUpdate,
|
|
480
|
-
nextUpdate: nextUpdate,
|
|
481
|
-
});
|
|
482
|
-
if (typeof crlPem !== "string" || crlPem.length === 0) {
|
|
483
|
-
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
484
|
-
"engine.generateCrl must return a non-empty PEM string");
|
|
485
|
-
}
|
|
486
|
-
if (opts3.persist !== false) {
|
|
487
|
-
atomicFile.writeSync(paths.crl, crlPem, { mode: 0o644 });
|
|
488
|
-
}
|
|
489
|
-
return { crlPem: crlPem, thisUpdate: thisUpdate, nextUpdate: nextUpdate,
|
|
490
|
-
entryCount: revocations.length, path: paths.crl };
|
|
491
|
-
}
|
|
492
|
-
|
|
493
|
-
return {
|
|
494
|
-
exists: exists,
|
|
495
|
-
keyExists: keyExists,
|
|
496
|
-
status: status,
|
|
497
|
-
loadKey: loadKey,
|
|
498
|
-
loadCert: loadCert,
|
|
499
|
-
commit: commit,
|
|
500
|
-
initCA: initCA,
|
|
501
|
-
generateClientCert: generateClientCert,
|
|
502
|
-
generateClientP12: generateClientP12,
|
|
503
|
-
revoke: revoke,
|
|
504
|
-
isRevoked: isRevoked,
|
|
505
|
-
getRevocations: getRevocations,
|
|
506
|
-
generateCrl: generateCrl,
|
|
507
|
-
paths: paths,
|
|
508
|
-
generation: generation,
|
|
509
|
-
caKeySealedMode: caKeySealedMode,
|
|
510
|
-
};
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
module.exports = {
|
|
514
|
-
create: create,
|
|
515
|
-
parseGeneration: parseGeneration,
|
|
516
|
-
MtlsCaError: MtlsCaError,
|
|
517
|
-
DEFAULT_PATHS: DEFAULT_PATHS,
|
|
518
|
-
};
|
|
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 atomicFile = require("./atomic-file");
|
|
78
|
+
var C = require("./constants");
|
|
79
|
+
var lazyRequire = require("./lazy-require");
|
|
80
|
+
var { boot } = require("./log");
|
|
81
|
+
var safeBuffer = require("./safe-buffer");
|
|
82
|
+
var safeJson = require("./safe-json");
|
|
83
|
+
var validateOpts = require("./validate-opts");
|
|
84
|
+
var { FrameworkError } = require("./framework-error");
|
|
85
|
+
|
|
86
|
+
// The default engine carries a 600+ KB vendored bundle (peculiar/x509 +
|
|
87
|
+
// pkijs + reflect-metadata). Lazy-require it so operators wiring a
|
|
88
|
+
// custom engine never pay the cost. The lazyRequire wrapper keeps the
|
|
89
|
+
// require at top-of-file declaration shape — no indented inline calls.
|
|
90
|
+
var mtlsEngineDefault = lazyRequire(function () { return require("./mtls-engine-default"); });
|
|
91
|
+
|
|
92
|
+
var caLog = boot("mtls-ca");
|
|
93
|
+
|
|
94
|
+
class MtlsCaError extends FrameworkError {
|
|
95
|
+
constructor(code, message) {
|
|
96
|
+
super(message, code);
|
|
97
|
+
this.name = "MtlsCaError";
|
|
98
|
+
this.permanent = true;
|
|
99
|
+
this.isMtlsCaError = true;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
var DEFAULT_PATHS = {
|
|
104
|
+
caKey: "ca.key",
|
|
105
|
+
caKeySealed: "ca.key.sealed",
|
|
106
|
+
caCert: "ca.crt",
|
|
107
|
+
// Revocation registry — JSON file under dataDir tracking revoked
|
|
108
|
+
// serial numbers. Operators export this as a CRL via
|
|
109
|
+
// ca.generateCrl() (engine.generateCrl signs the list with the CA
|
|
110
|
+
// key). Persisted as JSON rather than a stored CRL because the
|
|
111
|
+
// signed CRL is a derivative artifact — the registry survives CA
|
|
112
|
+
// rotation, the CRL doesn't.
|
|
113
|
+
revocations: "revocations.json",
|
|
114
|
+
crl: "ca.crl",
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
var VALID_SEAL_MODES = { auto: 1, required: 1, disabled: 1 };
|
|
118
|
+
|
|
119
|
+
function _resolvePaths(dataDir, paths) {
|
|
120
|
+
var p = Object.assign({}, DEFAULT_PATHS, paths || {});
|
|
121
|
+
return {
|
|
122
|
+
caKey: path.join(dataDir, p.caKey),
|
|
123
|
+
caKeySealed: path.join(dataDir, p.caKeySealed),
|
|
124
|
+
caCert: path.join(dataDir, p.caCert),
|
|
125
|
+
revocations: path.join(dataDir, p.revocations),
|
|
126
|
+
crl: path.join(dataDir, p.crl),
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Parse "OU=CAv{N}" from a PEM cert's subject DN. Returns the integer
|
|
131
|
+
// N (defaulting to 1 for untagged legacy CAs) or 0 when the cert is
|
|
132
|
+
// unreadable. Untagged returning 1 means the first regen lifts a legacy
|
|
133
|
+
// CA to generation 2 without misidentifying it as fresh.
|
|
134
|
+
function parseGeneration(certPem) {
|
|
135
|
+
if (typeof certPem !== "string" && !Buffer.isBuffer(certPem)) return 0;
|
|
136
|
+
try {
|
|
137
|
+
var cert = new nodeCrypto.X509Certificate(certPem);
|
|
138
|
+
var subj = cert.subject || "";
|
|
139
|
+
var m = /OU=CAv(\d+)/.exec(subj);
|
|
140
|
+
return m ? parseInt(m[1], 10) : 1;
|
|
141
|
+
} catch (_e) {
|
|
142
|
+
return 0;
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
function create(opts) {
|
|
147
|
+
opts = opts || {};
|
|
148
|
+
validateOpts(opts, [
|
|
149
|
+
"dataDir", "paths", "vault",
|
|
150
|
+
"caKeySealedMode", "generation", "engine",
|
|
151
|
+
], "b.mtlsCa");
|
|
152
|
+
validateOpts.requireNonEmptyString(opts.dataDir, "mtlsCa.create: opts.dataDir", MtlsCaError, "mtls-ca/no-datadir");
|
|
153
|
+
// Auto-create the dataDir with restrictive perms (CA keys live here).
|
|
154
|
+
// Matches the behaviour of other framework primitives that own a
|
|
155
|
+
// dataDir — log-stream-local, backup, restore-bundle. Without this
|
|
156
|
+
// the first initCA() / generateClientCert() call fails with ENOENT
|
|
157
|
+
// on `ca.key.tmp` because the atomic-file write expects the parent
|
|
158
|
+
// dir to exist.
|
|
159
|
+
if (!fs.existsSync(opts.dataDir)) {
|
|
160
|
+
fs.mkdirSync(opts.dataDir, { recursive: true, mode: 0o700 });
|
|
161
|
+
}
|
|
162
|
+
var paths = _resolvePaths(opts.dataDir, opts.paths);
|
|
163
|
+
var vault = opts.vault || null;
|
|
164
|
+
var caKeySealedMode = (opts.caKeySealedMode || "auto").toLowerCase();
|
|
165
|
+
if (!VALID_SEAL_MODES[caKeySealedMode]) {
|
|
166
|
+
throw new MtlsCaError("mtls-ca/bad-mode",
|
|
167
|
+
"caKeySealedMode must be 'auto', 'required', or 'disabled'");
|
|
168
|
+
}
|
|
169
|
+
var generation = typeof opts.generation === "number" && opts.generation >= 1
|
|
170
|
+
? Math.floor(opts.generation) : 1;
|
|
171
|
+
// The default engine is lazy-loaded at top-of-file; resolve it only
|
|
172
|
+
// when no custom engine was passed.
|
|
173
|
+
var engine = opts.engine || mtlsEngineDefault();
|
|
174
|
+
|
|
175
|
+
function _requireVault(reason) {
|
|
176
|
+
if (!vault || typeof vault.seal !== "function" || typeof vault.unseal !== "function") {
|
|
177
|
+
throw new MtlsCaError("mtls-ca/no-vault",
|
|
178
|
+
reason + " requires opts.vault (with seal/unseal). Pass b.vault " +
|
|
179
|
+
"or use caKeySealedMode='disabled' to keep the CA key on disk in plaintext.");
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
function keyExists() {
|
|
184
|
+
return fs.existsSync(paths.caKey) || fs.existsSync(paths.caKeySealed);
|
|
185
|
+
}
|
|
186
|
+
function exists() {
|
|
187
|
+
return keyExists() && fs.existsSync(paths.caCert);
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
function status() {
|
|
191
|
+
if (!exists()) {
|
|
192
|
+
return {
|
|
193
|
+
exists: false,
|
|
194
|
+
generation: 0,
|
|
195
|
+
isLegacy: false,
|
|
196
|
+
current: generation,
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
var pem = fs.readFileSync(paths.caCert);
|
|
200
|
+
var gen = parseGeneration(pem);
|
|
201
|
+
return {
|
|
202
|
+
exists: true,
|
|
203
|
+
generation: gen,
|
|
204
|
+
isLegacy: gen < generation,
|
|
205
|
+
current: generation,
|
|
206
|
+
};
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
// Load the CA key in whichever form is on disk, applying the
|
|
210
|
+
// caKeySealedMode dispatch. Returns Buffer of PEM bytes, or throws
|
|
211
|
+
// with a precise reason when the mode rejects the on-disk form.
|
|
212
|
+
function loadKey() {
|
|
213
|
+
var hasPlain = fs.existsSync(paths.caKey);
|
|
214
|
+
var hasSealed = fs.existsSync(paths.caKeySealed);
|
|
215
|
+
if (!hasPlain && !hasSealed) {
|
|
216
|
+
throw new MtlsCaError("mtls-ca/missing-key",
|
|
217
|
+
"no CA key on disk at " + paths.caKey + " or " + paths.caKeySealed);
|
|
218
|
+
}
|
|
219
|
+
if (caKeySealedMode === "required") {
|
|
220
|
+
if (!hasSealed) {
|
|
221
|
+
throw new MtlsCaError("mtls-ca/sealed-required",
|
|
222
|
+
"CA_KEY_SEALED='required' but " + paths.caKeySealed + " does not exist");
|
|
223
|
+
}
|
|
224
|
+
_requireVault("sealed CA key load");
|
|
225
|
+
var sealedBytes = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
226
|
+
var pem = vault.unseal(sealedBytes);
|
|
227
|
+
if (!pem) {
|
|
228
|
+
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
229
|
+
"vault.unseal of " + paths.caKeySealed + " returned empty — vault key mismatch?");
|
|
230
|
+
}
|
|
231
|
+
return Buffer.from(pem, "utf8");
|
|
232
|
+
}
|
|
233
|
+
if (caKeySealedMode === "disabled") {
|
|
234
|
+
if (!hasPlain) {
|
|
235
|
+
throw new MtlsCaError("mtls-ca/plain-required",
|
|
236
|
+
"CA_KEY_SEALED='disabled' but " + paths.caKey + " does not exist");
|
|
237
|
+
}
|
|
238
|
+
return fs.readFileSync(paths.caKey);
|
|
239
|
+
}
|
|
240
|
+
// auto: prefer sealed if it exists (defense-in-depth default)
|
|
241
|
+
if (hasSealed) {
|
|
242
|
+
_requireVault("sealed CA key load");
|
|
243
|
+
var sealedBytesA = fs.readFileSync(paths.caKeySealed, "utf8").trim();
|
|
244
|
+
var pemA = vault.unseal(sealedBytesA);
|
|
245
|
+
if (!pemA) {
|
|
246
|
+
throw new MtlsCaError("mtls-ca/unseal-failed",
|
|
247
|
+
"vault.unseal of " + paths.caKeySealed + " returned empty");
|
|
248
|
+
}
|
|
249
|
+
return Buffer.from(pemA, "utf8");
|
|
250
|
+
}
|
|
251
|
+
return fs.readFileSync(paths.caKey);
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
function loadCert() {
|
|
255
|
+
if (!fs.existsSync(paths.caCert)) {
|
|
256
|
+
throw new MtlsCaError("mtls-ca/missing-cert",
|
|
257
|
+
"no CA cert on disk at " + paths.caCert);
|
|
258
|
+
}
|
|
259
|
+
return fs.readFileSync(paths.caCert);
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
// Atomic commit: write .tmp + atomic rename for both key and cert.
|
|
263
|
+
// Honors caKeySealedMode — when 'required', the key is vault-sealed
|
|
264
|
+
// before the on-disk write so plaintext PEM never touches the
|
|
265
|
+
// filesystem; when 'disabled', it goes to disk as PEM. 'auto'
|
|
266
|
+
// defaults to plaintext-on-disk.
|
|
267
|
+
function commit(opts2) {
|
|
268
|
+
if (!opts2 || typeof opts2.caKeyPem !== "string" || typeof opts2.caCertPem !== "string") {
|
|
269
|
+
throw new MtlsCaError("mtls-ca/bad-commit",
|
|
270
|
+
"commit requires opts.caKeyPem and opts.caCertPem (PEM strings)");
|
|
271
|
+
}
|
|
272
|
+
var sealed = caKeySealedMode === "required";
|
|
273
|
+
var keyDest = sealed ? paths.caKeySealed : paths.caKey;
|
|
274
|
+
var keyTmp = keyDest + ".tmp";
|
|
275
|
+
var certTmp = paths.caCert + ".tmp";
|
|
276
|
+
|
|
277
|
+
try {
|
|
278
|
+
if (sealed) {
|
|
279
|
+
_requireVault("sealed CA key commit");
|
|
280
|
+
fs.writeFileSync(keyTmp, vault.seal(opts2.caKeyPem), { mode: 0o600 });
|
|
281
|
+
} else {
|
|
282
|
+
fs.writeFileSync(keyTmp, opts2.caKeyPem, { mode: 0o600 });
|
|
283
|
+
}
|
|
284
|
+
fs.writeFileSync(certTmp, opts2.caCertPem, { mode: 0o644 });
|
|
285
|
+
fs.renameSync(keyTmp, keyDest);
|
|
286
|
+
fs.renameSync(certTmp, paths.caCert);
|
|
287
|
+
} catch (e) {
|
|
288
|
+
// Best-effort cleanup of half-written tmp files; the original
|
|
289
|
+
// commit error is what we re-raise. Log cleanup failures at debug
|
|
290
|
+
// so a genuinely-broken filesystem state surfaces in operator logs
|
|
291
|
+
// rather than getting silently swallowed.
|
|
292
|
+
try { if (fs.existsSync(keyTmp)) fs.unlinkSync(keyTmp); }
|
|
293
|
+
catch (cleanupErr) { caLog.debug("cleanup-failed", { op: "fs.unlinkSync", path: keyTmp, error: cleanupErr.message }); }
|
|
294
|
+
try { if (fs.existsSync(certTmp)) fs.unlinkSync(certTmp); }
|
|
295
|
+
catch (cleanupErr) { caLog.debug("cleanup-failed", { op: "fs.unlinkSync", path: certTmp, error: cleanupErr.message }); }
|
|
296
|
+
throw new MtlsCaError("mtls-ca/commit-failed",
|
|
297
|
+
"atomic CA commit failed: " + ((e && e.message) || String(e)));
|
|
298
|
+
}
|
|
299
|
+
return {
|
|
300
|
+
keyPath: keyDest,
|
|
301
|
+
certPath: paths.caCert,
|
|
302
|
+
sealed: sealed,
|
|
303
|
+
};
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
async function initCA() {
|
|
307
|
+
if (exists()) {
|
|
308
|
+
return { caCertPem: loadCert().toString("utf8"), caKeyPem: loadKey().toString("utf8") };
|
|
309
|
+
}
|
|
310
|
+
var fresh = await engine.generateCa({ generation: generation });
|
|
311
|
+
if (!fresh || typeof fresh.caCertPem !== "string" || typeof fresh.caKeyPem !== "string") {
|
|
312
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
313
|
+
"engine.generateCa must return { caCertPem, caKeyPem }");
|
|
314
|
+
}
|
|
315
|
+
commit(fresh);
|
|
316
|
+
return fresh;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
async function generateClientCert(opts2) {
|
|
320
|
+
opts2 = opts2 || {};
|
|
321
|
+
var ca = await initCA();
|
|
322
|
+
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
323
|
+
var result = await engine.signClientCert(args);
|
|
324
|
+
if (!result || typeof result.cert !== "string" || typeof result.key !== "string") {
|
|
325
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
326
|
+
"engine.signClientCert must return { cert, key, ca?, issuedAt?, expiresAt? }");
|
|
327
|
+
}
|
|
328
|
+
return result;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
async function generateClientP12(opts2) {
|
|
332
|
+
opts2 = opts2 || {};
|
|
333
|
+
if (!opts2.password || typeof opts2.password !== "string") {
|
|
334
|
+
throw new MtlsCaError("mtls-ca/no-password",
|
|
335
|
+
"generateClientP12 requires opts.password (the PKCS#12 encryption password)");
|
|
336
|
+
}
|
|
337
|
+
var ca = await initCA();
|
|
338
|
+
var args = Object.assign({}, opts2, { caCertPem: ca.caCertPem, caKeyPem: ca.caKeyPem });
|
|
339
|
+
var result = await engine.packageP12(args);
|
|
340
|
+
if (!result || !Buffer.isBuffer(result.p12)) {
|
|
341
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
342
|
+
"engine.packageP12 must return { p12: Buffer, certPem, issuedAt, expiresAt }");
|
|
343
|
+
}
|
|
344
|
+
return result;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
// ---- Revocation registry + CRL ----
|
|
348
|
+
|
|
349
|
+
function _loadRevocations() {
|
|
350
|
+
if (!fs.existsSync(paths.revocations)) return { revocations: [] };
|
|
351
|
+
try {
|
|
352
|
+
// safeJson.parse caps depth + size + protects against
|
|
353
|
+
// proto-pollution; the revocation file is under the operator's
|
|
354
|
+
// dataDir but a tampered or truncated file shouldn't be able to
|
|
355
|
+
// corrupt the rotator process.
|
|
356
|
+
var json = safeJson.parse(fs.readFileSync(paths.revocations, "utf8"),
|
|
357
|
+
{ maxBytes: C.BYTES.mib(16) });
|
|
358
|
+
if (!json || !Array.isArray(json.revocations)) return { revocations: [] };
|
|
359
|
+
return json;
|
|
360
|
+
} catch (e) {
|
|
361
|
+
throw new MtlsCaError("mtls-ca/revocation-corrupt",
|
|
362
|
+
"could not parse " + paths.revocations + ": " +
|
|
363
|
+
((e && e.message) || String(e)));
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
function _saveRevocations(state) {
|
|
368
|
+
atomicFile.writeSync(paths.revocations,
|
|
369
|
+
JSON.stringify(state, null, 2) + "\n", { mode: 0o600 });
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
function _normalizeSerial(s) {
|
|
373
|
+
if (!s || typeof s !== "string") {
|
|
374
|
+
throw new MtlsCaError("mtls-ca/bad-serial",
|
|
375
|
+
"serial number must be a non-empty string");
|
|
376
|
+
}
|
|
377
|
+
// Strip the optional leading `0x` and any common separators
|
|
378
|
+
// (`:` or `-` or whitespace). What remains MUST be hex — otherwise
|
|
379
|
+
// we silently accept gibberish like "xyz-not-hex" (which previously
|
|
380
|
+
// normalised to a single "e" because the strip-non-hex regex left
|
|
381
|
+
// exactly one valid char). Operators pasting an openssl-printed
|
|
382
|
+
// serial use any of: "0xABC123", "AB:C1:23", "AB-C1-23", "abc 123";
|
|
383
|
+
// a typo or non-serial string fails fast instead of registering a
|
|
384
|
+
// phantom revocation row.
|
|
385
|
+
var stripped = s.replace(/^0x/i, "").replace(/[:\-\s]/g, "");
|
|
386
|
+
if (!safeBuffer.isHex(stripped)) {
|
|
387
|
+
throw new MtlsCaError("mtls-ca/bad-serial",
|
|
388
|
+
"serial number contains non-hex characters " +
|
|
389
|
+
"(allowed shapes: hex with optional 0x prefix, ':', '-', or whitespace " +
|
|
390
|
+
"as separators): " + JSON.stringify(s));
|
|
391
|
+
}
|
|
392
|
+
return stripped.toLowerCase();
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
// Map operator-friendly reason codes to RFC 5280 numeric codes used
|
|
396
|
+
// by X.509 CRLs. Default "unspecified" (0) when omitted. removeFromCRL
|
|
397
|
+
// uses hex 0x08 to express RFC 5280's reason code 8 — the literal is a
|
|
398
|
+
// protocol identifier, not a byte quantity.
|
|
399
|
+
var CRL_REASON_BY_NAME = {
|
|
400
|
+
"unspecified": 0,
|
|
401
|
+
"keyCompromise": 1,
|
|
402
|
+
"key-compromise": 1,
|
|
403
|
+
"caCompromise": 2,
|
|
404
|
+
"ca-compromise": 2,
|
|
405
|
+
"affiliationChanged": 3,
|
|
406
|
+
"superseded": 4,
|
|
407
|
+
"cessationOfOperation": 5,
|
|
408
|
+
"cessation-of-operation": 5,
|
|
409
|
+
"certificateHold": 6,
|
|
410
|
+
"removeFromCRL": 0x08,
|
|
411
|
+
"privilegeWithdrawn": 9,
|
|
412
|
+
"aACompromise": 10,
|
|
413
|
+
};
|
|
414
|
+
|
|
415
|
+
function revoke(serialNumber, opts3) {
|
|
416
|
+
var serial = _normalizeSerial(serialNumber);
|
|
417
|
+
opts3 = opts3 || {};
|
|
418
|
+
var reasonName = opts3.reason || "unspecified";
|
|
419
|
+
var reasonCode = CRL_REASON_BY_NAME[reasonName];
|
|
420
|
+
if (reasonCode === undefined) {
|
|
421
|
+
throw new MtlsCaError("mtls-ca/bad-reason",
|
|
422
|
+
"revoke: unknown reason '" + reasonName + "' (valid: " +
|
|
423
|
+
Object.keys(CRL_REASON_BY_NAME).join(", ") + ")");
|
|
424
|
+
}
|
|
425
|
+
var state = _loadRevocations();
|
|
426
|
+
var existing = state.revocations.find(function (r) {
|
|
427
|
+
return r.serialNumber === serial;
|
|
428
|
+
});
|
|
429
|
+
if (existing) {
|
|
430
|
+
// Idempotent — repeated revoke() of the same serial doesn't
|
|
431
|
+
// shift the revokedAt timestamp.
|
|
432
|
+
return existing;
|
|
433
|
+
}
|
|
434
|
+
var entry = {
|
|
435
|
+
serialNumber: serial,
|
|
436
|
+
reason: reasonName,
|
|
437
|
+
reasonCode: reasonCode,
|
|
438
|
+
revokedAt: Date.now(),
|
|
439
|
+
};
|
|
440
|
+
state.revocations.push(entry);
|
|
441
|
+
_saveRevocations(state);
|
|
442
|
+
return entry;
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
function isRevoked(serialNumber) {
|
|
446
|
+
var serial = _normalizeSerial(serialNumber);
|
|
447
|
+
var state = _loadRevocations();
|
|
448
|
+
return state.revocations.some(function (r) {
|
|
449
|
+
return r.serialNumber === serial;
|
|
450
|
+
});
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
function getRevocations() {
|
|
454
|
+
return _loadRevocations().revocations.slice();
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
// Generate a signed X.509 CRL covering every entry in the registry.
|
|
458
|
+
// RFC 5280 — issuer = CA subject, signed by the CA private key.
|
|
459
|
+
// Operators publish the resulting PEM at a CRL distribution point
|
|
460
|
+
// referenced from issued certs (cert extension support is on the
|
|
461
|
+
// engine roadmap; for now operators set up the URL externally).
|
|
462
|
+
async function generateCrl(opts3) {
|
|
463
|
+
opts3 = opts3 || {};
|
|
464
|
+
if (typeof engine.generateCrl !== "function") {
|
|
465
|
+
throw new MtlsCaError("mtls-ca/engine-no-crl",
|
|
466
|
+
"configured engine does not implement generateCrl(); the bundled " +
|
|
467
|
+
"engine ships in v0.6.45+");
|
|
468
|
+
}
|
|
469
|
+
var ca = await initCA();
|
|
470
|
+
var revocations = _loadRevocations().revocations;
|
|
471
|
+
var nowMs = Date.now();
|
|
472
|
+
var thisUpdate = opts3.thisUpdate || new Date(nowMs);
|
|
473
|
+
var nextUpdate = opts3.nextUpdate ||
|
|
474
|
+
new Date(nowMs + C.TIME.days(7)); // 7d default
|
|
475
|
+
var crlPem = await engine.generateCrl({
|
|
476
|
+
caCertPem: ca.caCertPem,
|
|
477
|
+
caKeyPem: ca.caKeyPem,
|
|
478
|
+
revocations: revocations,
|
|
479
|
+
thisUpdate: thisUpdate,
|
|
480
|
+
nextUpdate: nextUpdate,
|
|
481
|
+
});
|
|
482
|
+
if (typeof crlPem !== "string" || crlPem.length === 0) {
|
|
483
|
+
throw new MtlsCaError("mtls-ca/bad-engine-output",
|
|
484
|
+
"engine.generateCrl must return a non-empty PEM string");
|
|
485
|
+
}
|
|
486
|
+
if (opts3.persist !== false) {
|
|
487
|
+
atomicFile.writeSync(paths.crl, crlPem, { mode: 0o644 });
|
|
488
|
+
}
|
|
489
|
+
return { crlPem: crlPem, thisUpdate: thisUpdate, nextUpdate: nextUpdate,
|
|
490
|
+
entryCount: revocations.length, path: paths.crl };
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
return {
|
|
494
|
+
exists: exists,
|
|
495
|
+
keyExists: keyExists,
|
|
496
|
+
status: status,
|
|
497
|
+
loadKey: loadKey,
|
|
498
|
+
loadCert: loadCert,
|
|
499
|
+
commit: commit,
|
|
500
|
+
initCA: initCA,
|
|
501
|
+
generateClientCert: generateClientCert,
|
|
502
|
+
generateClientP12: generateClientP12,
|
|
503
|
+
revoke: revoke,
|
|
504
|
+
isRevoked: isRevoked,
|
|
505
|
+
getRevocations: getRevocations,
|
|
506
|
+
generateCrl: generateCrl,
|
|
507
|
+
paths: paths,
|
|
508
|
+
generation: generation,
|
|
509
|
+
caKeySealedMode: caKeySealedMode,
|
|
510
|
+
};
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
module.exports = {
|
|
514
|
+
create: create,
|
|
515
|
+
parseGeneration: parseGeneration,
|
|
516
|
+
MtlsCaError: MtlsCaError,
|
|
517
|
+
DEFAULT_PATHS: DEFAULT_PATHS,
|
|
518
|
+
};
|