@sebastienrousseau/crypto-server 0.0.35 → 0.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/README.md +128 -73
  2. package/dist/@types/types.d.ts +1 -0
  3. package/dist/@types/types.d.ts.map +1 -1
  4. package/dist/config/auth-policy.d.ts +1 -0
  5. package/dist/config/auth-policy.d.ts.map +1 -1
  6. package/dist/config/auth-policy.js +10 -4
  7. package/dist/config/constants.d.ts +7 -2
  8. package/dist/config/constants.d.ts.map +1 -1
  9. package/dist/config/constants.js +15 -18
  10. package/dist/config/env.d.ts +9 -2
  11. package/dist/config/env.d.ts.map +1 -1
  12. package/dist/config/env.js +59 -36
  13. package/dist/config/settings.d.ts +3 -0
  14. package/dist/config/settings.d.ts.map +1 -0
  15. package/dist/config/settings.js +24 -0
  16. package/dist/enterprise/metering.d.ts +5 -5
  17. package/dist/enterprise/metering.d.ts.map +1 -1
  18. package/dist/enterprise/metering.js +20 -63
  19. package/dist/enterprise/types.d.ts +0 -11
  20. package/dist/enterprise/types.d.ts.map +1 -1
  21. package/dist/index.js +9 -35
  22. package/dist/lib/audit.d.ts +18 -0
  23. package/dist/lib/audit.d.ts.map +1 -0
  24. package/dist/lib/audit.js +57 -0
  25. package/dist/lib/auth.d.ts +4 -0
  26. package/dist/lib/auth.d.ts.map +1 -1
  27. package/dist/lib/auth.js +15 -1
  28. package/dist/lib/crypto-workers.d.ts +27 -0
  29. package/dist/lib/crypto-workers.d.ts.map +1 -0
  30. package/dist/lib/crypto-workers.js +46 -0
  31. package/dist/lib/http-metrics.d.ts +13 -0
  32. package/dist/lib/http-metrics.d.ts.map +1 -0
  33. package/dist/lib/http-metrics.js +45 -0
  34. package/dist/lib/key-store.d.ts +15 -1
  35. package/dist/lib/key-store.d.ts.map +1 -1
  36. package/dist/lib/key-store.js +128 -44
  37. package/dist/lib/kms-owners.d.ts +9 -0
  38. package/dist/lib/kms-owners.d.ts.map +1 -0
  39. package/dist/lib/kms-owners.js +80 -0
  40. package/dist/lib/kms-providers.d.ts +15 -0
  41. package/dist/lib/kms-providers.d.ts.map +1 -0
  42. package/dist/lib/kms-providers.js +99 -0
  43. package/dist/lib/lifecycle.d.ts +16 -0
  44. package/dist/lib/lifecycle.d.ts.map +1 -0
  45. package/dist/lib/lifecycle.js +50 -0
  46. package/dist/lib/logger.d.ts +5 -1
  47. package/dist/lib/logger.d.ts.map +1 -1
  48. package/dist/lib/logger.js +34 -15
  49. package/dist/lib/opaque-store.d.ts +13 -0
  50. package/dist/lib/opaque-store.d.ts.map +1 -1
  51. package/dist/lib/opaque-store.js +27 -2
  52. package/dist/lib/problem.d.ts +8 -0
  53. package/dist/lib/problem.d.ts.map +1 -1
  54. package/dist/lib/problem.js +25 -15
  55. package/dist/lib/readiness.d.ts +12 -0
  56. package/dist/lib/readiness.d.ts.map +1 -0
  57. package/dist/lib/readiness.js +17 -0
  58. package/dist/lib/telemetry.d.ts +1 -1
  59. package/dist/lib/telemetry.d.ts.map +1 -1
  60. package/dist/lib/telemetry.js +45 -73
  61. package/dist/routes/index.d.ts +3 -0
  62. package/dist/routes/index.d.ts.map +1 -1
  63. package/dist/routes/index.js +19 -12
  64. package/dist/routes/probes.d.ts.map +1 -1
  65. package/dist/routes/probes.js +4 -10
  66. package/dist/routes/v1/decrypt.d.ts.map +1 -1
  67. package/dist/routes/v1/decrypt.js +2 -1
  68. package/dist/routes/v1/encrypt.d.ts.map +1 -1
  69. package/dist/routes/v1/encrypt.js +2 -1
  70. package/dist/routes/v1/generate.d.ts.map +1 -1
  71. package/dist/routes/v1/generate.js +3 -2
  72. package/dist/routes/v1/index.js +2 -2
  73. package/dist/routes/v1/revoke.d.ts.map +1 -1
  74. package/dist/routes/v1/revoke.js +3 -2
  75. package/dist/routes/v1/verify.d.ts.map +1 -1
  76. package/dist/routes/v1/verify.js +27 -12
  77. package/dist/routes/v2/compliance.js +1 -1
  78. package/dist/routes/v2/hpke.d.ts.map +1 -1
  79. package/dist/routes/v2/hpke.js +8 -4
  80. package/dist/routes/v2/keys.d.ts.map +1 -1
  81. package/dist/routes/v2/keys.js +24 -2
  82. package/dist/routes/v2/kms.d.ts +8 -4
  83. package/dist/routes/v2/kms.d.ts.map +1 -1
  84. package/dist/routes/v2/kms.js +81 -82
  85. package/dist/routes/v2/opaque.d.ts.map +1 -1
  86. package/dist/routes/v2/opaque.js +26 -4
  87. package/dist/routes/v2/pq-hash-sign.d.ts.map +1 -1
  88. package/dist/routes/v2/pq-hash-sign.js +2 -4
  89. package/dist/routes/v2/pq-sign.d.ts.map +1 -1
  90. package/dist/routes/v2/pq-sign.js +2 -4
  91. package/dist/routes/v2/pq.d.ts.map +1 -1
  92. package/dist/routes/v2/pq.js +10 -9
  93. package/dist/server.d.ts +1 -1
  94. package/dist/server.d.ts.map +1 -1
  95. package/dist/server.js +40 -15
  96. package/dist/utils/keys.d.ts +1 -0
  97. package/dist/utils/keys.d.ts.map +1 -1
  98. package/dist/utils/keys.js +9 -2
  99. package/dist/utils/route-helpers.d.ts.map +1 -1
  100. package/dist/utils/route-helpers.js +5 -10
  101. package/package.json +6 -8
  102. package/dist/lib/kdf-runner.d.ts +0 -18
  103. package/dist/lib/kdf-runner.d.ts.map +0 -1
  104. package/dist/lib/kdf-runner.js +0 -27
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CryptoWorkers = exports.MODULES = exports.SIGNING_LIMITS = exports.KDF_LIMITS = void 0;
4
+ const node_os_1 = require("node:os");
5
+ const accel_1 = require("@sebastienrousseau/crypto-lib/accel");
6
+ exports.KDF_LIMITS = Object.freeze({
7
+ threads: 2,
8
+ maxQueue: 32,
9
+ taskTimeoutMs: 60_000,
10
+ });
11
+ exports.SIGNING_LIMITS = Object.freeze({
12
+ threads: Math.max(1, Math.min(4, (0, node_os_1.availableParallelism)() - 1)),
13
+ maxQueue: 64,
14
+ taskTimeoutMs: 60_000,
15
+ });
16
+ exports.MODULES = {
17
+ modern: require.resolve("@sebastienrousseau/crypto-lib/modern"),
18
+ highLevel: require.resolve("@sebastienrousseau/crypto-lib/high-level"),
19
+ keys: require.resolve("@sebastienrousseau/crypto-lib/keys"),
20
+ };
21
+ class CryptoWorkers {
22
+ limits;
23
+ pool;
24
+ constructor(limits) {
25
+ this.limits = limits;
26
+ }
27
+ run(module, functionName, ...args) {
28
+ this.pool ??= new accel_1.WorkerPool({
29
+ size: this.limits.threads,
30
+ maxQueue: this.limits.maxQueue,
31
+ taskTimeoutMs: this.limits.taskTimeoutMs,
32
+ });
33
+ return this.pool.execute({
34
+ modulePath: exports.MODULES[module],
35
+ functionName,
36
+ args,
37
+ });
38
+ }
39
+ async close() {
40
+ const pool = this.pool;
41
+ this.pool = undefined;
42
+ await pool?.shutdown();
43
+ }
44
+ }
45
+ exports.CryptoWorkers = CryptoWorkers;
46
+ //# sourceMappingURL=crypto-workers.js.map
@@ -0,0 +1,13 @@
1
+ import type { FastifyInstance } from "fastify";
2
+ export declare class HttpMetrics {
3
+ private readonly series;
4
+ record(method: string, route: string | undefined, status: number, durationMs: number): void;
5
+ render(): string;
6
+ }
7
+ declare module "fastify" {
8
+ interface FastifyInstance {
9
+ httpMetrics: HttpMetrics;
10
+ }
11
+ }
12
+ export declare function registerHttpMetrics(app: FastifyInstance): void;
13
+ //# sourceMappingURL=http-metrics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"http-metrics.d.ts","sourceRoot":"","sources":["../../src/lib/http-metrics.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAiB/C,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IAGpD,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,IAAI;IASP,MAAM,IAAI,MAAM;CAqBjB;AAED,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,eAAe;QAEvB,WAAW,EAAE,WAAW,CAAC;KAC1B;CACF;AAGD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI,CAU9D"}
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HttpMetrics = void 0;
4
+ exports.registerHttpMetrics = registerHttpMetrics;
5
+ const UNMATCHED = "unmatched";
6
+ function label(value) {
7
+ return value.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
8
+ }
9
+ class HttpMetrics {
10
+ series = new Map();
11
+ record(method, route, status, durationMs) {
12
+ const labels = `method="${label(method)}",route="${label(route ?? UNMATCHED)}",status="${status}"`;
13
+ const entry = this.series.get(labels) ?? { count: 0, totalMs: 0 };
14
+ entry.count += 1;
15
+ entry.totalMs += durationMs;
16
+ this.series.set(labels, entry);
17
+ }
18
+ render() {
19
+ const counts = [];
20
+ const sums = [];
21
+ for (const [labels, { count, totalMs }] of this.series) {
22
+ counts.push(`http_requests_total{${labels}} ${count}`);
23
+ sums.push(`http_request_duration_seconds_sum{${labels}} ${totalMs / 1000}`);
24
+ sums.push(`http_request_duration_seconds_count{${labels}} ${count}`);
25
+ }
26
+ return [
27
+ "# HELP http_requests_total Responses sent, by method, route and status",
28
+ "# TYPE http_requests_total counter",
29
+ ...counts,
30
+ "",
31
+ "# HELP http_request_duration_seconds Time spent answering requests",
32
+ "# TYPE http_request_duration_seconds summary",
33
+ ...sums,
34
+ "",
35
+ ].join("\n");
36
+ }
37
+ }
38
+ exports.HttpMetrics = HttpMetrics;
39
+ function registerHttpMetrics(app) {
40
+ app.decorate("httpMetrics", new HttpMetrics());
41
+ app.addHook("onResponse", async (request, reply) => {
42
+ app.httpMetrics.record(request.method, request.routeOptions.url, reply.statusCode, reply.elapsedTime);
43
+ });
44
+ }
45
+ //# sourceMappingURL=http-metrics.js.map
@@ -10,6 +10,7 @@ export interface StoredKey {
10
10
  export type NewKey = Pick<StoredKey, "algorithm" | "owner" | "publicParts" | "privateParts">;
11
11
  export declare const KEY_ID_PATTERN = "^k_[A-Za-z0-9_-]{22}$";
12
12
  export declare const DEFAULT_KEY_CAPACITY = 10000;
13
+ export declare const DEFAULT_KEYS_PER_OWNER = 1000;
13
14
  export declare class KeyStoreError extends Error {
14
15
  readonly statusCode: number;
15
16
  readonly code: string;
@@ -20,18 +21,31 @@ export interface EncryptedPartsPayload {
20
21
  readonly iv: string;
21
22
  readonly tag: string;
22
23
  readonly alg: "aes-256-gcm";
24
+ readonly aad?: "record-v2";
25
+ }
26
+ export interface KeyStoreOptions {
27
+ readonly acceptPlaintext?: boolean;
28
+ readonly maxKeysPerOwner?: number;
23
29
  }
24
30
  export declare class KeyStore {
25
31
  private readonly dir;
26
32
  private readonly capacity;
27
33
  private readonly keys;
28
34
  private readonly storageKey;
29
- constructor(dir: string | undefined, capacity?: number, storageKey?: string | Uint8Array);
35
+ private readonly acceptPlaintext;
36
+ private readonly maxKeysPerOwner;
37
+ private readonly ownerCounts;
38
+ constructor(dir: string | undefined, capacity?: number, storageKey?: string | Uint8Array, options?: KeyStoreOptions);
30
39
  put(key: NewKey): Promise<StoredKey>;
40
+ writable(): Promise<boolean>;
41
+ delete(keyId: string, owner: string): Promise<void>;
31
42
  get(keyId: string, owner: string, algorithms?: readonly string[]): Promise<StoredKey>;
32
43
  private lookup;
44
+ private readRecord;
45
+ private privatePartsOf;
33
46
  private remember;
34
47
  private file;
35
48
  }
49
+ export declare function keyStoreConfigError(env: NodeJS.ProcessEnv): string | null;
36
50
  export declare function keyStoreFromEnv(): KeyStore;
37
51
  //# sourceMappingURL=key-store.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"key-store.d.ts","sourceRoot":"","sources":["../../src/lib/key-store.ts"],"names":[],"mappings":"AAmCA,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAGxD,MAAM,WAAW,SAAS;IAExB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC;IAE/B,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC;CACjC;AAGD,MAAM,MAAM,MAAM,GAAG,IAAI,CACvB,SAAS,EACT,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,CACvD,CAAC;AAGF,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAKtD,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAG3C,qBAAa,aAAc,SAAQ,KAAK;IAEtC,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAM9D;AAGD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;CAC7B;AAmFD,qBAAa,QAAQ;IAajB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAb3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgC;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;gBAW7B,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,QAAQ,GAAE,MAA6B,EACxD,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU;IAM5B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAgDpC,GAAG,CACP,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,GAC7B,OAAO,CAAC,SAAS,CAAC;YAcP,MAAM;IAwDpB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,IAAI;CAGb;AAGD,wBAAgB,eAAe,IAAI,QAAQ,CAM1C"}
1
+ {"version":3,"file":"key-store.d.ts","sourceRoot":"","sources":["../../src/lib/key-store.ts"],"names":[],"mappings":"AAsCA,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAGxD,MAAM,WAAW,SAAS;IAExB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC;IAE/B,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC;CACjC;AAGD,MAAM,MAAM,MAAM,GAAG,IAAI,CACvB,SAAS,EACT,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,CACvD,CAAC;AAGF,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAKtD,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAG3C,eAAO,MAAM,sBAAsB,OAAQ,CAAC;AAG5C,qBAAa,aAAc,SAAQ,KAAK;IAEtC,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAM9D;AAGD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;IAM5B,QAAQ,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC;CAC5B;AA0HD,MAAM,WAAW,eAAe;IAK9B,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;IAOnC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,qBAAa,QAAQ;IAmBjB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAnB3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgC;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAChD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IAEzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;gBAatC,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,QAAQ,GAAE,MAA6B,EACxD,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,EAChC,OAAO,GAAE,eAAoB;IAQzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAoDpC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAY5B,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAanD,GAAG,CACP,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,GAC7B,OAAO,CAAC,SAAS,CAAC;YAcP,MAAM;YAuBN,UAAU;IAiBxB,OAAO,CAAC,cAAc;IAoCtB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,IAAI;CAGb;AAOD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,CAWzE;AAuBD,wBAAgB,eAAe,IAAI,QAAQ,CAY1C"}
@@ -33,15 +33,19 @@ var __importStar = (this && this.__importStar) || (function () {
33
33
  };
34
34
  })();
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.KeyStore = exports.KeyStoreError = exports.DEFAULT_KEY_CAPACITY = exports.KEY_ID_PATTERN = void 0;
36
+ exports.KeyStore = exports.KeyStoreError = exports.DEFAULT_KEYS_PER_OWNER = exports.DEFAULT_KEY_CAPACITY = exports.KEY_ID_PATTERN = void 0;
37
+ exports.keyStoreConfigError = keyStoreConfigError;
37
38
  exports.keyStoreFromEnv = keyStoreFromEnv;
38
39
  const crypto_1 = require("crypto");
40
+ const fs_1 = require("fs");
39
41
  const promises_1 = require("fs/promises");
40
42
  const path = __importStar(require("path"));
41
43
  const crypto_lib_1 = require("@sebastienrousseau/crypto-lib");
44
+ const settings_1 = require("../config/settings");
42
45
  exports.KEY_ID_PATTERN = "^k_[A-Za-z0-9_-]{22}$";
43
46
  const KEY_ID_RE = new RegExp(exports.KEY_ID_PATTERN);
44
47
  exports.DEFAULT_KEY_CAPACITY = 10_000;
48
+ exports.DEFAULT_KEYS_PER_OWNER = 1_000;
45
49
  class KeyStoreError extends Error {
46
50
  statusCode;
47
51
  code;
@@ -53,26 +57,48 @@ class KeyStoreError extends Error {
53
57
  }
54
58
  }
55
59
  exports.KeyStoreError = KeyStoreError;
56
- function resolveStorageKey(key) {
57
- if (!key)
58
- return undefined;
60
+ const STORAGE_KEY_FORMAT = "CRYPTO_KEY_STORAGE_KEY must be 64 hex characters (32 random bytes, for example from `openssl rand -hex 32`). " +
61
+ "A passphrase is not accepted; to read files written with one, set the hex SHA-256 of that passphrase and re-encrypt.";
62
+ function storageKeyError(key) {
63
+ if (key === undefined)
64
+ return null;
59
65
  if (typeof key !== "string") {
60
- if (key.length === 32)
61
- return Buffer.from(key);
62
- return (0, crypto_1.createHash)("sha256").update(key).digest();
66
+ return key.length === 32 ? null : "The storage key must be 32 bytes";
63
67
  }
64
68
  const trimmed = key.trim();
65
- if (!trimmed)
69
+ return trimmed === "" || /^[0-9a-fA-F]{64}$/.test(trimmed)
70
+ ? null
71
+ : STORAGE_KEY_FORMAT;
72
+ }
73
+ function resolveStorageKey(key) {
74
+ const error = storageKeyError(key);
75
+ if (error)
76
+ throw new Error(error);
77
+ if (key === undefined)
66
78
  return undefined;
67
- if (/^[0-9a-fA-F]{64}$/.test(trimmed)) {
68
- return Buffer.from(trimmed, "hex");
79
+ if (typeof key !== "string")
80
+ return Buffer.from(key);
81
+ const trimmed = key.trim();
82
+ return trimmed === "" ? undefined : Buffer.from(trimmed, "hex");
83
+ }
84
+ function recordAad(header, version) {
85
+ if (version !== "record-v2") {
86
+ return Buffer.from(`${header.keyId}:${header.owner}`, "utf8");
69
87
  }
70
- return (0, crypto_1.createHash)("sha256").update(trimmed, "utf8").digest();
88
+ const publicParts = Object.entries(header.publicParts).sort(([a], [b]) => a < b ? -1 : 1);
89
+ return Buffer.from(JSON.stringify([
90
+ "record-v2",
91
+ header.keyId,
92
+ header.owner,
93
+ header.algorithm,
94
+ header.createdAt,
95
+ publicParts,
96
+ ]), "utf8");
71
97
  }
72
- function encryptPrivateParts(privateParts, keyId, owner, key) {
98
+ function encryptPrivateParts(privateParts, header, key) {
73
99
  const iv = (0, crypto_1.randomBytes)(12);
74
100
  const cipher = (0, crypto_1.createCipheriv)("aes-256-gcm", key, iv);
75
- cipher.setAAD(Buffer.from(`${keyId}:${owner}`, "utf8"));
101
+ cipher.setAAD(recordAad(header, "record-v2"));
76
102
  const plaintext = Buffer.from(JSON.stringify(privateParts), "utf8");
77
103
  const ciphertext = Buffer.concat([cipher.update(plaintext), cipher.final()]);
78
104
  const tag = cipher.getAuthTag();
@@ -82,9 +108,10 @@ function encryptPrivateParts(privateParts, keyId, owner, key) {
82
108
  iv: iv.toString("base64"),
83
109
  tag: tag.toString("base64"),
84
110
  alg: "aes-256-gcm",
111
+ aad: "record-v2",
85
112
  };
86
113
  }
87
- function decryptPrivateParts(encrypted, keyId, owner, key) {
114
+ function decryptPrivateParts(encrypted, header, key) {
88
115
  if (encrypted.alg !== "aes-256-gcm") {
89
116
  throw new KeyStoreError(`Unsupported encryption algorithm: ${encrypted.alg}`, 500, "UNSUPPORTED_STORAGE_ALGORITHM");
90
117
  }
@@ -93,7 +120,7 @@ function decryptPrivateParts(encrypted, keyId, owner, key) {
93
120
  const tag = Buffer.from(encrypted.tag, "base64");
94
121
  const ciphertext = Buffer.from(encrypted.ciphertext, "base64");
95
122
  const decipher = (0, crypto_1.createDecipheriv)("aes-256-gcm", key, iv);
96
- decipher.setAAD(Buffer.from(`${keyId}:${owner}`, "utf8"));
123
+ decipher.setAAD(recordAad(header, encrypted.aad));
97
124
  decipher.setAuthTag(tag);
98
125
  const decrypted = Buffer.concat([
99
126
  decipher.update(ciphertext),
@@ -113,12 +140,21 @@ class KeyStore {
113
140
  capacity;
114
141
  keys = new Map();
115
142
  storageKey;
116
- constructor(dir, capacity = exports.DEFAULT_KEY_CAPACITY, storageKey) {
143
+ acceptPlaintext;
144
+ maxKeysPerOwner;
145
+ ownerCounts = new Map();
146
+ constructor(dir, capacity = exports.DEFAULT_KEY_CAPACITY, storageKey, options = {}) {
117
147
  this.dir = dir;
118
148
  this.capacity = capacity;
119
149
  this.storageKey = resolveStorageKey(storageKey);
150
+ this.acceptPlaintext = options.acceptPlaintext ?? false;
151
+ this.maxKeysPerOwner = options.maxKeysPerOwner ?? exports.DEFAULT_KEYS_PER_OWNER;
120
152
  }
121
153
  async put(key) {
154
+ const owned = this.ownerCounts.get(key.owner) ?? 0;
155
+ if (owned >= this.maxKeysPerOwner) {
156
+ throw new KeyStoreError(`Key quota of ${this.maxKeysPerOwner} reached; delete keys to create more`, 429, "KEY_QUOTA_EXCEEDED");
157
+ }
122
158
  if (!this.dir && this.keys.size >= this.capacity) {
123
159
  throw new KeyStoreError("Key store is full; set CRYPTO_KEY_OUT_DIR to persist keys", 503, "KEY_STORE_FULL");
124
160
  }
@@ -136,7 +172,7 @@ class KeyStore {
136
172
  publicParts: stored.publicParts,
137
173
  };
138
174
  if (this.storageKey) {
139
- diskRecord.encryptedPrivateParts = encryptPrivateParts(stored.privateParts, stored.keyId, stored.owner, this.storageKey);
175
+ diskRecord.encryptedPrivateParts = encryptPrivateParts(stored.privateParts, stored, this.storageKey);
140
176
  }
141
177
  else {
142
178
  diskRecord.privateParts = stored.privateParts;
@@ -148,8 +184,23 @@ class KeyStore {
148
184
  });
149
185
  }
150
186
  this.remember(stored);
187
+ this.ownerCounts.set(key.owner, owned + 1);
151
188
  return stored;
152
189
  }
190
+ async writable() {
191
+ if (!this.dir)
192
+ return true;
193
+ return (0, promises_1.access)(this.dir, fs_1.constants.W_OK).then(() => true, () => false);
194
+ }
195
+ async delete(keyId, owner) {
196
+ await this.get(keyId, owner);
197
+ this.keys.delete(keyId);
198
+ if (this.dir)
199
+ await (0, promises_1.unlink)(this.file(keyId));
200
+ const owned = this.ownerCounts.get(owner) ?? 0;
201
+ if (owned > 0)
202
+ this.ownerCounts.set(owner, owned - 1);
203
+ }
153
204
  async get(keyId, owner, algorithms) {
154
205
  const key = await this.lookup(keyId);
155
206
  if (!key || key.owner !== owner)
@@ -163,49 +214,53 @@ class KeyStore {
163
214
  if (!KEY_ID_RE.test(keyId))
164
215
  return undefined;
165
216
  const cached = this.keys.get(keyId);
166
- if (cached || !this.dir)
217
+ if (cached) {
218
+ this.remember(cached);
167
219
  return cached;
168
- let raw;
169
- try {
170
- raw = await (0, promises_1.readFile)(this.file(keyId), "utf8");
171
220
  }
172
- catch {
221
+ if (!this.dir)
173
222
  return undefined;
174
- }
175
- let record;
223
+ const record = await this.readRecord(keyId);
224
+ if (!record)
225
+ return undefined;
226
+ const stored = Object.freeze({
227
+ keyId: record.keyId,
228
+ algorithm: record.algorithm,
229
+ owner: record.owner,
230
+ createdAt: record.createdAt,
231
+ publicParts: record.publicParts,
232
+ privateParts: this.privatePartsOf(record),
233
+ });
234
+ this.remember(stored);
235
+ return stored;
236
+ }
237
+ async readRecord(keyId) {
176
238
  try {
177
- record = JSON.parse(raw);
239
+ const raw = await (0, promises_1.readFile)(this.file(keyId), "utf8");
240
+ const record = JSON.parse(raw);
241
+ return record.keyId === keyId ? record : undefined;
178
242
  }
179
243
  catch {
180
244
  return undefined;
181
245
  }
182
- if (record.keyId !== keyId)
183
- return undefined;
184
- let privateParts;
246
+ }
247
+ privatePartsOf(record) {
185
248
  if (record.encryptedPrivateParts) {
186
249
  if (!this.storageKey) {
187
250
  throw new KeyStoreError("Key is encrypted at rest; storage key required", 500, "STORAGE_KEY_REQUIRED");
188
251
  }
189
- privateParts = decryptPrivateParts(record.encryptedPrivateParts, record.keyId, record.owner, this.storageKey);
252
+ return decryptPrivateParts(record.encryptedPrivateParts, record, this.storageKey);
190
253
  }
191
- else if (record.privateParts) {
192
- privateParts = record.privateParts;
193
- }
194
- else {
254
+ if (!record.privateParts) {
195
255
  throw new KeyStoreError("Key file contains no private key material", 500, "KEY_CORRUPTED");
196
256
  }
197
- const stored = Object.freeze({
198
- keyId: record.keyId,
199
- algorithm: record.algorithm,
200
- owner: record.owner,
201
- createdAt: record.createdAt,
202
- publicParts: record.publicParts,
203
- privateParts,
204
- });
205
- this.remember(stored);
206
- return stored;
257
+ if (this.storageKey && !this.acceptPlaintext) {
258
+ throw new KeyStoreError("Plaintext key file refused while CRYPTO_KEY_STORAGE_KEY is set; set CRYPTO_KEY_ALLOW_PLAINTEXT=1 to read it while migrating", 500, "PLAINTEXT_KEY_REFUSED");
259
+ }
260
+ return record.privateParts;
207
261
  }
208
262
  remember(key) {
263
+ this.keys.delete(key.keyId);
209
264
  this.keys.set(key.keyId, key);
210
265
  if (this.keys.size > this.capacity) {
211
266
  const oldest = this.keys.keys().next().value;
@@ -217,7 +272,36 @@ class KeyStore {
217
272
  }
218
273
  }
219
274
  exports.KeyStore = KeyStore;
275
+ function keyStoreConfigError(env) {
276
+ const keyError = storageKeyError(env["CRYPTO_KEY_STORAGE_KEY"]) ?? perOwnerError(env);
277
+ if (keyError)
278
+ return keyError;
279
+ const plaintextOnDisk = env["NODE_ENV"] === "production" &&
280
+ Boolean(env["CRYPTO_KEY_OUT_DIR"]) &&
281
+ !env["CRYPTO_KEY_STORAGE_KEY"]?.trim();
282
+ return plaintextOnDisk && env["CRYPTO_KEY_ALLOW_PLAINTEXT"] !== "1"
283
+ ? "CRYPTO_KEY_OUT_DIR is set without CRYPTO_KEY_STORAGE_KEY, so private keys would be written in plaintext; set CRYPTO_KEY_STORAGE_KEY (or CRYPTO_KEY_ALLOW_PLAINTEXT=1 to accept it)"
284
+ : null;
285
+ }
286
+ function maxKeysPerOwner(env) {
287
+ return (0, settings_1.integerSetting)(env, "KEY_STORE_MAX_PER_PRINCIPAL", exports.DEFAULT_KEYS_PER_OWNER, 1);
288
+ }
289
+ function perOwnerError(env) {
290
+ try {
291
+ maxKeysPerOwner(env);
292
+ return undefined;
293
+ }
294
+ catch (e) {
295
+ return e.message;
296
+ }
297
+ }
220
298
  function keyStoreFromEnv() {
221
- return new KeyStore(process.env["CRYPTO_KEY_OUT_DIR"] || undefined, exports.DEFAULT_KEY_CAPACITY, process.env["CRYPTO_KEY_STORAGE_KEY"] || undefined);
299
+ const error = keyStoreConfigError(process.env);
300
+ if (error)
301
+ throw new Error(error);
302
+ return new KeyStore(process.env["CRYPTO_KEY_OUT_DIR"] || undefined, exports.DEFAULT_KEY_CAPACITY, process.env["CRYPTO_KEY_STORAGE_KEY"] || undefined, {
303
+ acceptPlaintext: process.env["CRYPTO_KEY_ALLOW_PLAINTEXT"] === "1",
304
+ maxKeysPerOwner: maxKeysPerOwner(process.env),
305
+ });
222
306
  }
223
307
  //# sourceMappingURL=key-store.js.map
@@ -0,0 +1,9 @@
1
+ export declare const KMS_OWNERS_FILE = "kms-owners.json";
2
+ export declare class KmsOwners {
3
+ private readonly owners;
4
+ private readonly file;
5
+ constructor(dir: string | undefined);
6
+ ownerOf(provider: string, keyId: string): string | undefined;
7
+ bind(provider: string, keyId: string, owner: string): void;
8
+ }
9
+ //# sourceMappingURL=kms-owners.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"kms-owners.d.ts","sourceRoot":"","sources":["../../src/lib/kms-owners.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,eAAe,oBAAoB,CAAC;AAQjD,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAqB;gBAO9B,GAAG,EAAE,MAAM,GAAG,SAAS;IAMnC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAM5D,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAQ3D"}
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.KmsOwners = exports.KMS_OWNERS_FILE = void 0;
37
+ const fs_1 = require("fs");
38
+ const path = __importStar(require("path"));
39
+ exports.KMS_OWNERS_FILE = "kms-owners.json";
40
+ const entry = (provider, keyId) => `${provider.toLowerCase()}:${keyId}`;
41
+ class KmsOwners {
42
+ owners;
43
+ file;
44
+ constructor(dir) {
45
+ this.file = dir ? path.join(dir, exports.KMS_OWNERS_FILE) : undefined;
46
+ this.owners = this.file && (0, fs_1.existsSync)(this.file) ? load(this.file) : {};
47
+ }
48
+ ownerOf(provider, keyId) {
49
+ const key = entry(provider, keyId);
50
+ return Object.hasOwn(this.owners, key) ? this.owners[key] : undefined;
51
+ }
52
+ bind(provider, keyId, owner) {
53
+ const current = this.ownerOf(provider, keyId);
54
+ if (current !== undefined && current !== owner) {
55
+ throw new Error(`KMS key ${keyId} is already owned by another principal`);
56
+ }
57
+ this.owners[entry(provider, keyId)] = owner;
58
+ if (this.file)
59
+ save(this.file, this.owners);
60
+ }
61
+ }
62
+ exports.KmsOwners = KmsOwners;
63
+ function load(file) {
64
+ try {
65
+ const parsed = JSON.parse((0, fs_1.readFileSync)(file, "utf8"));
66
+ if (parsed.version !== 1 || typeof parsed.owners !== "object") {
67
+ throw new Error("unexpected format");
68
+ }
69
+ return { ...parsed.owners };
70
+ }
71
+ catch (err) {
72
+ throw new Error(`Cannot read ${exports.KMS_OWNERS_FILE}: ${err.message}`, { cause: err });
73
+ }
74
+ }
75
+ function save(file, owners) {
76
+ const tmp = `${file}.${process.pid}.tmp`;
77
+ (0, fs_1.writeFileSync)(tmp, JSON.stringify({ version: 1, owners }), { mode: 0o600 });
78
+ (0, fs_1.renameSync)(tmp, file);
79
+ }
80
+ //# sourceMappingURL=kms-owners.js.map
@@ -0,0 +1,15 @@
1
+ import { type KmsProvider } from "@sebastienrousseau/crypto-kms";
2
+ export declare class KmsProviderNotEnabledError extends Error {
3
+ readonly provider: string;
4
+ readonly name = "KmsProviderNotEnabledError";
5
+ constructor(provider: string);
6
+ }
7
+ export declare function kmsProviderNames(env: NodeJS.ProcessEnv): string[];
8
+ export declare function kmsConfigError(env: NodeJS.ProcessEnv): string | null;
9
+ export declare class KmsRegistry {
10
+ private readonly providers;
11
+ constructor(env: NodeJS.ProcessEnv);
12
+ get(name?: string): KmsProvider;
13
+ register(name: string, provider: KmsProvider): void;
14
+ }
15
+ //# sourceMappingURL=kms-providers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"kms-providers.d.ts","sourceRoot":"","sources":["../../src/lib/kms-providers.ts"],"names":[],"mappings":"AAgBA,OAAO,EAKL,KAAK,WAAW,EACjB,MAAM,+BAA+B,CAAC;AAgBvC,qBAAa,0BAA2B,SAAQ,KAAK;IAEvC,QAAQ,CAAC,QAAQ,EAAE,MAAM;IADrC,SAAkB,IAAI,gCAAgC;gBACjC,QAAQ,EAAE,MAAM;CAGtC;AAGD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,EAAE,CAUjE;AAkBD,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,CAMpE;AA0BD,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;gBAGhD,GAAG,EAAE,MAAM,CAAC,UAAU;IASlC,GAAG,CAAC,IAAI,GAAE,MAAgB,GAAG,WAAW;IAOxC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;CAGpD"}
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.KmsRegistry = exports.KmsProviderNotEnabledError = void 0;
4
+ exports.kmsProviderNames = kmsProviderNames;
5
+ exports.kmsConfigError = kmsConfigError;
6
+ const crypto_kms_1 = require("@sebastienrousseau/crypto-kms");
7
+ const REQUIRED_SETTINGS = {
8
+ local: [],
9
+ aws: ["AWS_REGION"],
10
+ gcp: [
11
+ "GCP_PROJECT_ID",
12
+ "GCP_LOCATION_ID",
13
+ "GCP_KEY_RING_ID",
14
+ "GCP_AUTH_TOKEN",
15
+ ],
16
+ vault: ["VAULT_ADDR", "VAULT_TOKEN"],
17
+ };
18
+ class KmsProviderNotEnabledError extends Error {
19
+ provider;
20
+ name = "KmsProviderNotEnabledError";
21
+ constructor(provider) {
22
+ super(`KMS provider "${provider}" is not enabled`);
23
+ this.provider = provider;
24
+ }
25
+ }
26
+ exports.KmsProviderNotEnabledError = KmsProviderNotEnabledError;
27
+ function kmsProviderNames(env) {
28
+ const raw = env["KMS_PROVIDERS"]?.trim() || "local";
29
+ return [
30
+ ...new Set(raw
31
+ .split(",")
32
+ .map((s) => s.trim().toLowerCase())
33
+ .filter(Boolean)),
34
+ ];
35
+ }
36
+ function providerError(name, env) {
37
+ if (name === "azure") {
38
+ return 'KMS_PROVIDERS: "azure" is a stub provider and cannot be enabled';
39
+ }
40
+ const required = REQUIRED_SETTINGS[name];
41
+ if (!required) {
42
+ return `KMS_PROVIDERS: unknown provider "${name}" (use local, aws, gcp or vault)`;
43
+ }
44
+ const missing = required.filter((k) => !env[k]);
45
+ return missing.length > 0
46
+ ? `KMS_PROVIDERS: "${name}" needs ${missing.join(", ")}`
47
+ : null;
48
+ }
49
+ function kmsConfigError(env) {
50
+ for (const name of kmsProviderNames(env)) {
51
+ const error = providerError(name, env);
52
+ if (error)
53
+ return error;
54
+ }
55
+ return null;
56
+ }
57
+ function buildProvider(name, env) {
58
+ const get = (k) => env[k];
59
+ switch (name) {
60
+ case "aws":
61
+ return new crypto_kms_1.AwsKmsProvider({ region: get("AWS_REGION") });
62
+ case "gcp":
63
+ return new crypto_kms_1.GcpKmsProvider({
64
+ projectId: get("GCP_PROJECT_ID"),
65
+ locationId: get("GCP_LOCATION_ID"),
66
+ keyRingId: get("GCP_KEY_RING_ID"),
67
+ token: get("GCP_AUTH_TOKEN"),
68
+ });
69
+ case "vault":
70
+ return new crypto_kms_1.VaultKmsProvider({
71
+ address: get("VAULT_ADDR"),
72
+ token: get("VAULT_TOKEN"),
73
+ });
74
+ default:
75
+ return new crypto_kms_1.LocalKmsProvider();
76
+ }
77
+ }
78
+ class KmsRegistry {
79
+ providers = new Map();
80
+ constructor(env) {
81
+ const error = kmsConfigError(env);
82
+ if (error)
83
+ throw new Error(error);
84
+ for (const name of kmsProviderNames(env)) {
85
+ this.providers.set(name, buildProvider(name, env));
86
+ }
87
+ }
88
+ get(name = "local") {
89
+ const provider = this.providers.get(name.toLowerCase());
90
+ if (!provider)
91
+ throw new KmsProviderNotEnabledError(name);
92
+ return provider;
93
+ }
94
+ register(name, provider) {
95
+ this.providers.set(name.toLowerCase(), provider);
96
+ }
97
+ }
98
+ exports.KmsRegistry = KmsRegistry;
99
+ //# sourceMappingURL=kms-providers.js.map
@@ -0,0 +1,16 @@
1
+ import type { EventEmitter } from "events";
2
+ import type { FastifyInstance } from "fastify";
3
+ import type { Logger } from "pino";
4
+ export interface ShutdownOptions {
5
+ timeoutMs: number;
6
+ log: Logger;
7
+ exit: (code: number) => void;
8
+ onClosed?: () => Promise<void>;
9
+ }
10
+ export declare function gracefulShutdown(server: FastifyInstance, options: ShutdownOptions): (signal: string) => Promise<void>;
11
+ export interface StartOptions extends Omit<ShutdownOptions, "timeoutMs"> {
12
+ env: NodeJS.ProcessEnv;
13
+ signals: EventEmitter;
14
+ }
15
+ export declare function start(options: StartOptions): Promise<FastifyInstance>;
16
+ //# sourceMappingURL=lifecycle.d.ts.map