@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
@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const crypto_lib_1 = require("@sebastienrousseau/crypto-lib");
4
4
  const problem_1 = require("../../lib/problem");
5
5
  const route_helpers_1 = require("../../utils/route-helpers");
6
+ const auth_1 = require("../../lib/auth");
7
+ const opaque_store_1 = require("../../lib/opaque-store");
6
8
  const { pake } = crypto_lib_1.protocols;
7
9
  function parseHex(hex) {
8
10
  if (hex.length % 2 !== 0 || !/^[0-9a-fA-F]+$/.test(hex)) {
@@ -13,6 +15,20 @@ function parseHex(hex) {
13
15
  function toHex(bytes) {
14
16
  return Buffer.from(bytes).toString("hex");
15
17
  }
18
+ function opaqueFailure(error, request, reply, operation) {
19
+ if (error instanceof opaque_store_1.OpaqueStoreFullError) {
20
+ return (0, problem_1.sendProblem)(reply, 503, "service-unavailable", error.message);
21
+ }
22
+ return (0, route_helpers_1.classifyCryptoError)(error, request, reply, operation);
23
+ }
24
+ function mayRegister(request, reply, credentialIdentifier) {
25
+ const auth = request.auth;
26
+ if ((0, auth_1.hasScope)(auth, "crypto:admin") || auth.sub === credentialIdentifier) {
27
+ return true;
28
+ }
29
+ (0, problem_1.sendProblem)(reply, 403, "forbidden", "A credential can only be registered for the caller's own subject");
30
+ return false;
31
+ }
16
32
  const OPAQUE_RATE_LIMIT = Object.freeze({
17
33
  config: { rateLimit: { max: 100, timeWindow: "1 minute" } },
18
34
  });
@@ -80,6 +96,9 @@ function registerRegisterInit(app) {
80
96
  app.post("/v2/opaque/register/init", { ...OPAQUE_RATE_LIMIT, schema: REGISTER_INIT_SCHEMA }, async (request, reply) => {
81
97
  try {
82
98
  const body = request.body;
99
+ if (!mayRegister(request, reply, body.credentialIdentifier)) {
100
+ return reply;
101
+ }
83
102
  const suite = body.suite ?? "P256-SHA256";
84
103
  const store = request.server.opaqueStore;
85
104
  const setup = store.getSetup(suite);
@@ -90,7 +109,7 @@ function registerRegisterInit(app) {
90
109
  return reply.send({ data: { response: toHex(responseBytes) } });
91
110
  }
92
111
  catch (error) {
93
- return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "OPAQUE registration init");
112
+ return opaqueFailure(error, request, reply, "OPAQUE registration init");
94
113
  }
95
114
  });
96
115
  }
@@ -98,6 +117,9 @@ function registerRegisterFinish(app) {
98
117
  app.post("/v2/opaque/register/finish", { ...OPAQUE_RATE_LIMIT, schema: REGISTER_FINISH_SCHEMA }, async (request, reply) => {
99
118
  try {
100
119
  const body = request.body;
120
+ if (!mayRegister(request, reply, body.credentialIdentifier)) {
121
+ return reply;
122
+ }
101
123
  const suite = body.suite ?? "P256-SHA256";
102
124
  const store = request.server.opaqueStore;
103
125
  if (store.hasRecord(body.credentialIdentifier)) {
@@ -114,7 +136,7 @@ function registerRegisterFinish(app) {
114
136
  });
115
137
  }
116
138
  catch (error) {
117
- return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "OPAQUE registration finish");
139
+ return opaqueFailure(error, request, reply, "OPAQUE registration finish");
118
140
  }
119
141
  });
120
142
  }
@@ -142,7 +164,7 @@ function registerLoginInit(app) {
142
164
  return reply.send({ data: { sessionId, ke2: toHex(ke2Bytes) } });
143
165
  }
144
166
  catch (error) {
145
- return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "OPAQUE login init");
167
+ return opaqueFailure(error, request, reply, "OPAQUE login init");
146
168
  }
147
169
  });
148
170
  }
@@ -161,7 +183,7 @@ function registerLoginFinish(app) {
161
183
  return reply.send({ data: { sessionKey: toHex(sessionKey) } });
162
184
  }
163
185
  catch (error) {
164
- return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "OPAQUE login finish");
186
+ return opaqueFailure(error, request, reply, "OPAQUE login finish");
165
187
  }
166
188
  });
167
189
  }
@@ -1 +1 @@
1
- {"version":3,"file":"pq-hash-sign.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq-hash-sign.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBAsJ/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAKE"}
1
+ {"version":3,"file":"pq-hash-sign.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq-hash-sign.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBAiK/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAKE"}
@@ -67,9 +67,8 @@ function registerKeygen(app) {
67
67
  },
68
68
  },
69
69
  }, async (request, reply) => {
70
- const { slhDsaKeygen } = await Promise.resolve().then(() => __importStar(require("@sebastienrousseau/crypto-lib/modern")));
71
70
  const { variant } = request.body;
72
- const { publicKey, secretKey, algorithm } = slhDsaKeygen(variant);
71
+ const { publicKey, secretKey, algorithm } = await request.server.signer.run("modern", "slhDsaKeygen", variant);
73
72
  const stored = await (0, keys_1.storeKey)(request, algorithm, { publicKey }, { secretKey });
74
73
  return reply.send({ data: (0, keys_1.publicView)(stored) });
75
74
  });
@@ -92,12 +91,11 @@ function registerSign(app) {
92
91
  },
93
92
  },
94
93
  }, async (request, reply) => {
95
- const { slhDsaSign } = await Promise.resolve().then(() => __importStar(require("@sebastienrousseau/crypto-lib/modern")));
96
94
  const body = request.body;
97
95
  const key = await (0, keys_1.resolveKey)(request, body.keyId, SLH_DSA_ALGORITHMS);
98
96
  const variant = key.algorithm.slice("slh-dsa-".length);
99
97
  return reply.send({
100
- data: slhDsaSign(variant, key.privateParts["secretKey"], body.message),
98
+ data: await request.server.signer.run("modern", "slhDsaSign", variant, key.privateParts["secretKey"], body.message),
101
99
  });
102
100
  });
103
101
  }
@@ -1 +1 @@
1
- {"version":3,"file":"pq-sign.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq-sign.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBAoI/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAKE"}
1
+ {"version":3,"file":"pq-sign.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq-sign.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBA6I/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAKE"}
@@ -52,9 +52,8 @@ function registerKeygen(app) {
52
52
  },
53
53
  },
54
54
  }, async (request, reply) => {
55
- const { mlDsaKeygen } = await Promise.resolve().then(() => __importStar(require("@sebastienrousseau/crypto-lib/modern")));
56
55
  const { level } = request.body;
57
- const { publicKey, secretKey, algorithm } = mlDsaKeygen(level);
56
+ const { publicKey, secretKey, algorithm } = await request.server.signer.run("modern", "mlDsaKeygen", level);
58
57
  const stored = await (0, keys_1.storeKey)(request, algorithm, { publicKey }, { secretKey });
59
58
  return reply.send({ data: (0, keys_1.publicView)(stored) });
60
59
  });
@@ -76,12 +75,11 @@ function registerSign(app) {
76
75
  },
77
76
  },
78
77
  }, async (request, reply) => {
79
- const { mlDsaSign } = await Promise.resolve().then(() => __importStar(require("@sebastienrousseau/crypto-lib/modern")));
80
78
  const body = request.body;
81
79
  const key = await (0, keys_1.resolveKey)(request, body.keyId, ML_DSA_ALGORITHMS);
82
80
  const level = Number(key.algorithm.slice("ml-dsa-".length));
83
81
  return reply.send({
84
- data: mlDsaSign(level, key.privateParts["secretKey"], body.message),
82
+ data: await request.server.signer.run("modern", "mlDsaSign", level, key.privateParts["secretKey"], body.message),
85
83
  });
86
84
  });
87
85
  }
@@ -1 +1 @@
1
- {"version":3,"file":"pq.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBA0P/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAUE"}
1
+ {"version":3,"file":"pq.d.ts","sourceRoot":"","sources":["../../../src/routes/v2/pq.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;yBAuQ/B,KAAK,eAAe,KAAG,IAAI;AAA3C,wBAUE"}
@@ -17,7 +17,7 @@ function registerMlKemKeygen(app) {
17
17
  body: EMPTY_BODY,
18
18
  },
19
19
  }, async (request, reply) => {
20
- const { publicKey, secretKey, algorithm } = (0, modern_1.mlKemGenerateKeyPair)();
20
+ const { publicKey, secretKey, algorithm } = (0, modern_1.mlKemKeygen)(768);
21
21
  const stored = await (0, keys_1.storeKey)(request, algorithm, { publicKey }, { secretKey });
22
22
  return reply.send({ data: (0, keys_1.publicView)(stored) });
23
23
  });
@@ -40,7 +40,7 @@ function registerMlKemEncapsulate(app) {
40
40
  }, async (request, reply) => {
41
41
  try {
42
42
  const { publicKey } = request.body;
43
- const result = (0, modern_1.mlKemEncapsulate)(publicKey);
43
+ const result = (0, modern_1.mlKemEncapsulate)(768, publicKey);
44
44
  return reply.send({ data: result });
45
45
  }
46
46
  catch (error) {
@@ -68,7 +68,7 @@ function registerMlKemDecapsulate(app) {
68
68
  const { keyId, ciphertext } = request.body;
69
69
  const key = await (0, keys_1.resolveKey)(request, keyId, ["ml-kem-768"]);
70
70
  try {
71
- const result = (0, modern_1.mlKemDecapsulate)(key.privateParts["secretKey"], ciphertext);
71
+ const result = (0, modern_1.mlKemDecapsulate)(768, key.privateParts["secretKey"], ciphertext);
72
72
  return reply.send({ data: result });
73
73
  }
74
74
  catch (error) {
@@ -76,6 +76,7 @@ function registerMlKemDecapsulate(app) {
76
76
  }
77
77
  });
78
78
  }
79
+ const COMBINER = "crypto-service/hybrid-kem/v2";
79
80
  function registerHybridKeygen(app) {
80
81
  app.post("/v2/pq/hybrid/keygen", {
81
82
  schema: {
@@ -85,7 +86,7 @@ function registerHybridKeygen(app) {
85
86
  body: EMPTY_BODY,
86
87
  },
87
88
  }, async (request, reply) => {
88
- const kp = (0, modern_1.hybridGenerateKeyPair)();
89
+ const kp = (0, modern_1.hybridKemKeygen)(768);
89
90
  const stored = await (0, keys_1.storeKey)(request, kp.algorithm, {
90
91
  x25519PublicKey: kp.x25519PublicKey,
91
92
  mlKemPublicKey: kp.mlKemPublicKey,
@@ -101,7 +102,7 @@ function registerHybridEncapsulate(app) {
101
102
  schema: {
102
103
  tags: ["Post-Quantum"],
103
104
  summary: "Hybrid encapsulate (X25519 + ML-KEM-768)",
104
- description: "Performs X25519 ECDH + ML-KEM encapsulation, derives a combined shared secret via HKDF-SHA256.",
105
+ description: "Performs X25519 ECDH + ML-KEM-768 encapsulation and derives the shared secret with crypto-lib's v2 combiner (HKDF-SHA256 binding both shared secrets, ciphertexts and public keys). The response names the combiner.",
105
106
  body: {
106
107
  type: "object",
107
108
  required: ["x25519PublicKey", "mlKemPublicKey"],
@@ -115,8 +116,8 @@ function registerHybridEncapsulate(app) {
115
116
  }, async (request, reply) => {
116
117
  try {
117
118
  const { x25519PublicKey, mlKemPublicKey } = request.body;
118
- const result = (0, modern_1.hybridEncapsulate)(x25519PublicKey, mlKemPublicKey);
119
- return reply.send({ data: result });
119
+ const result = (0, modern_1.hybridKemEncapsulate)(768, x25519PublicKey, mlKemPublicKey);
120
+ return reply.send({ data: { ...result, combiner: COMBINER } });
120
121
  }
121
122
  catch (error) {
122
123
  return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "Hybrid encapsulation");
@@ -149,8 +150,8 @@ function registerHybridDecapsulate(app) {
149
150
  const key = await (0, keys_1.resolveKey)(request, body.keyId, ["x25519-ml-kem-768"]);
150
151
  try {
151
152
  const { x25519PrivateKey, mlKemSecretKey } = key.privateParts;
152
- const result = (0, modern_1.hybridDecapsulate)(x25519PrivateKey, mlKemSecretKey, body.x25519EphemeralPublic, body.mlKemCiphertext);
153
- return reply.send({ data: result });
153
+ const result = (0, modern_1.hybridKemDecapsulate)(768, x25519PrivateKey, mlKemSecretKey, body.x25519EphemeralPublic, body.mlKemCiphertext);
154
+ return reply.send({ data: { ...result, combiner: COMBINER } });
154
155
  }
155
156
  catch (error) {
156
157
  return (0, route_helpers_1.classifyCryptoError)(error, request, reply, "Hybrid decapsulation");
package/dist/server.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import * as fastify from "fastify";
2
- declare function init(): Promise<fastify.FastifyInstance>;
2
+ declare function init(overrides?: Pick<fastify.FastifyServerOptions, "logger">): Promise<fastify.FastifyInstance>;
3
3
  export { init };
4
4
  //# sourceMappingURL=server.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAuCnC,iBAAe,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAgFtD;AAED,OAAO,EAAE,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAsDA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAoEnC,iBAAe,IAAI,CACjB,SAAS,GAAE,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAM,GAC3D,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CA4FlC;AAED,OAAO,EAAE,IAAI,EAAE,CAAC"}
package/dist/server.js CHANGED
@@ -47,19 +47,26 @@ const helmet_1 = __importDefault(require("@fastify/helmet"));
47
47
  const rate_limit_1 = __importDefault(require("@fastify/rate-limit"));
48
48
  const swagger_1 = __importDefault(require("@fastify/swagger"));
49
49
  const swagger_ui_1 = __importDefault(require("@fastify/swagger-ui"));
50
- const crypto_1 = require("crypto");
51
- const logger_1 = __importDefault(require("./lib/logger"));
50
+ const logger_1 = __importStar(require("./lib/logger"));
52
51
  const auth_1 = require("./lib/auth");
53
52
  const auth_policy_1 = require("./config/auth-policy");
53
+ const env_1 = require("./config/env");
54
54
  const metering_1 = require("./enterprise/metering");
55
55
  const key_store_1 = require("./lib/key-store");
56
- const kdf_runner_1 = require("./lib/kdf-runner");
56
+ const kms_providers_1 = require("./lib/kms-providers");
57
+ const kms_owners_1 = require("./lib/kms-owners");
58
+ const crypto_workers_1 = require("./lib/crypto-workers");
57
59
  const problem_1 = require("./lib/problem");
58
60
  const trace_1 = require("./utils/trace");
59
61
  const opaque_store_1 = require("./lib/opaque-store");
62
+ const http_metrics_1 = require("./lib/http-metrics");
63
+ const audit_1 = require("./lib/audit");
64
+ const readiness_1 = require("./lib/readiness");
60
65
  const routes_1 = __importDefault(require("./routes"));
61
66
  const fastify = __importStar(require("fastify"));
62
67
  async function registerDocs(app) {
68
+ if (!(0, env_1.docsEnabled)())
69
+ return;
63
70
  await app.register(swagger_1.default, {
64
71
  openapi: {
65
72
  info: {
@@ -83,21 +90,40 @@ async function registerDocs(app) {
83
90
  routePrefix: "/docs",
84
91
  });
85
92
  }
86
- async function init() {
87
- const app = fastify.fastify(constants_1.fastifyOptions);
93
+ function decorateServices(app) {
94
+ app.decorate("keyStore", (0, key_store_1.keyStoreFromEnv)());
95
+ app.decorate("kms", new kms_providers_1.KmsRegistry(process.env));
96
+ app.decorate("kmsOwners", new kms_owners_1.KmsOwners(process.env["CRYPTO_KEY_OUT_DIR"] || undefined));
97
+ app.decorate("kdf", new crypto_workers_1.CryptoWorkers(crypto_workers_1.KDF_LIMITS));
98
+ app.decorate("signer", new crypto_workers_1.CryptoWorkers(crypto_workers_1.SIGNING_LIMITS));
99
+ app.decorate("opaqueStore", new opaque_store_1.OpaqueStore());
100
+ (0, readiness_1.trackLifecycle)(app);
101
+ app.addHook("onClose", async () => {
102
+ await Promise.all([app.kdf.close(), app.signer.close()]);
103
+ });
104
+ }
105
+ async function init(overrides = {}) {
106
+ const app = fastify.fastify({
107
+ ...constants_1.fastifyOptions,
108
+ genReqId: (req) => (0, logger_1.requestIdFrom)(req.headers["x-request-id"]),
109
+ ...(overrides.logger === undefined
110
+ ? { loggerInstance: logger_1.default }
111
+ : { logger: overrides.logger }),
112
+ });
88
113
  const registered = [];
89
114
  app.addHook("onRoute", (route) => {
90
115
  registered.push({ method: route.method, url: route.url });
91
116
  });
92
- logger_1.default.info("\n\nEnvironment details: " + constants_1.consoleOutput);
117
+ app.log.info(constants_1.serverDetails, "Server configuration");
93
118
  (0, problem_1.registerProblemHandlers)(app);
119
+ (0, http_metrics_1.registerHttpMetrics)(app);
120
+ (0, audit_1.registerAudit)(app);
94
121
  app.addHook("onRequest", async (request, reply) => {
95
- const reqId = request.headers["x-request-id"] ?? (0, crypto_1.randomUUID)();
96
- reply.header("x-request-id", reqId);
122
+ reply.header("x-request-id", request.id);
97
123
  (0, trace_1.propagateTraceContext)(request, reply);
98
124
  });
99
125
  app.addHook("onSend", async (request, reply) => {
100
- if (request.url.startsWith("/v2/")) {
126
+ if (!request.url.startsWith("/docs")) {
101
127
  reply.header("Cache-Control", "no-store, no-cache, must-revalidate");
102
128
  reply.header("Pragma", "no-cache");
103
129
  }
@@ -116,17 +142,16 @@ async function init() {
116
142
  });
117
143
  await (0, auth_1.registerAuth)(app);
118
144
  app.addHook("onRequest", async (request, reply) => {
119
- if ((0, auth_policy_1.isPublicRoute)(request.url))
145
+ if ((0, auth_policy_1.isPublicRoute)(request.routeOptions.url ?? request.url))
120
146
  return;
121
147
  const auth = await (0, auth_1.authenticate)(request, reply);
122
- if (!auth || !(0, auth_1.authorizeRoute)(request, reply, auth))
148
+ if (!auth)
123
149
  return reply;
124
150
  request.auth = auth;
151
+ if (!(0, auth_1.authorizeRoute)(request, reply, auth))
152
+ return reply;
125
153
  });
126
- app.decorate("keyStore", (0, key_store_1.keyStoreFromEnv)());
127
- app.decorate("kdf", new kdf_runner_1.KdfRunner());
128
- app.decorate("opaqueStore", new opaque_store_1.OpaqueStore());
129
- app.addHook("onClose", () => app.kdf.close());
154
+ decorateServices(app);
130
155
  (0, metering_1.registerMetering)(app);
131
156
  await app.register(async (scope) => {
132
157
  (0, routes_1.default)(scope);
@@ -11,6 +11,7 @@ export declare const KEY_ID_SCHEMA: {
11
11
  readonly description: "Identifier of a server-held key, returned by a key-generation route.";
12
12
  };
13
13
  export declare function resolveKey(request: FastifyRequest, keyId: string, algorithms?: readonly string[]): Promise<StoredKey>;
14
+ export declare function deleteKey(request: FastifyRequest, keyId: string): Promise<void>;
14
15
  export declare function storeKey(request: FastifyRequest, algorithm: string, publicParts: KeyParts, privateParts: KeyParts): Promise<StoredKey>;
15
16
  export declare function serverPgpPrivateKey(): Promise<string>;
16
17
  export declare function publicView(key: StoredKey): Record<string, string>;
@@ -1 +1 @@
1
- {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/utils/keys.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,SAAS,EACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,eAAe;QAEvB,QAAQ,EAAE,QAAQ,CAAC;KACpB;CACF;AAGD,eAAO,MAAM,aAAa;;;;CAKhB,CAAC;AAeX,wBAAgB,UAAU,CACxB,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,GAC7B,OAAO,CAAC,SAAS,CAAC,CAEpB;AAGD,wBAAgB,QAAQ,CACtB,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,QAAQ,EACrB,YAAY,EAAE,QAAQ,GACrB,OAAO,CAAC,SAAS,CAAC,CAOpB;AAOD,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAG3D;AAGD,wBAAgB,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAEjE"}
1
+ {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/utils/keys.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,SAAS,EACf,MAAM,kBAAkB,CAAC;AAG1B,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,eAAe;QAEvB,QAAQ,EAAE,QAAQ,CAAC;KACpB;CACF;AAGD,eAAO,MAAM,aAAa;;;;CAKhB,CAAC;AAeX,wBAAgB,UAAU,CACxB,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,GAC7B,OAAO,CAAC,SAAS,CAAC,CAEpB;AAGD,wBAAgB,SAAS,CACvB,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAEf;AAGD,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,QAAQ,EACrB,YAAY,EAAE,QAAQ,GACrB,OAAO,CAAC,SAAS,CAAC,CASpB;AAOD,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAG3D;AAGD,wBAAgB,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAEjE"}
@@ -2,11 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.KEY_ID_SCHEMA = void 0;
4
4
  exports.resolveKey = resolveKey;
5
+ exports.deleteKey = deleteKey;
5
6
  exports.storeKey = storeKey;
6
7
  exports.serverPgpPrivateKey = serverPgpPrivateKey;
7
8
  exports.publicView = publicView;
8
9
  const pgp_1 = require("@sebastienrousseau/crypto-lib/pgp");
9
10
  const key_store_1 = require("../lib/key-store");
11
+ const audit_1 = require("../lib/audit");
10
12
  exports.KEY_ID_SCHEMA = {
11
13
  type: "string",
12
14
  pattern: key_store_1.KEY_ID_PATTERN,
@@ -18,13 +20,18 @@ function principalOf(request) {
18
20
  function resolveKey(request, keyId, algorithms) {
19
21
  return request.server.keyStore.get(keyId, principalOf(request), algorithms);
20
22
  }
21
- function storeKey(request, algorithm, publicParts, privateParts) {
22
- return request.server.keyStore.put({
23
+ function deleteKey(request, keyId) {
24
+ return request.server.keyStore.delete(keyId, principalOf(request));
25
+ }
26
+ async function storeKey(request, algorithm, publicParts, privateParts) {
27
+ const stored = await request.server.keyStore.put({
23
28
  algorithm,
24
29
  owner: principalOf(request),
25
30
  publicParts,
26
31
  privateParts,
27
32
  });
33
+ (0, audit_1.noteAuditKey)(request, stored.keyId);
34
+ return stored;
28
35
  }
29
36
  async function serverPgpPrivateKey() {
30
37
  const { privateKeyArmored } = await (0, pgp_1.loadKeystore)();
@@ -1 +1 @@
1
- {"version":3,"file":"route-helpers.d.ts","sourceRoot":"","sources":["../../src/utils/route-helpers.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAGL,gBAAgB,EACjB,MAAM,cAAc,CAAC;AAOtB,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAEnD,OAAO,EAAE,CAAC,EACV,KAAK,EAAE,YAAY,GAEjB;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,GACtE,IAAI,CAmBP;AAsBD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,EACd,OAAO,EAAE;IAAE,GAAG,EAAE;QAAE,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,CAAA;CAAE,EAChE,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,MAAM,GAChB,YAAY,CA6Bd"}
1
+ {"version":3,"file":"route-helpers.d.ts","sourceRoot":"","sources":["../../src/utils/route-helpers.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQ5C,OAAO,EAGL,gBAAgB,EACjB,MAAM,cAAc,CAAC;AAOtB,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAEnD,OAAO,EAAE,CAAC,EACV,KAAK,EAAE,YAAY,GAEjB;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,GACtE,IAAI,CAmBP;AAaD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,EACd,OAAO,EAAE;IAAE,GAAG,EAAE;QAAE,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,CAAA;CAAE,EAChE,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,MAAM,GAChB,YAAY,CAiCd"}
@@ -23,19 +23,14 @@ function collectValidation(results, reply) {
23
23
  }
24
24
  return out;
25
25
  }
26
- const INPUT_ERROR_PATTERNS = [
27
- /invalid hex/i,
28
- /must be \d+ bytes/i,
29
- /too short/i,
30
- /unsupported/i,
31
- /expected.*length/i,
32
- /of length \d+ expected/i,
33
- ];
34
26
  function classifyCryptoError(error, request, reply, operation) {
35
- const msg = error instanceof Error ? error.message : String(error);
27
+ if ((0, problem_1.isWorkerOverload)(error)) {
28
+ const spec = (0, problem_1.busy)();
29
+ return (0, problem_1.sendProblem)(reply, spec.status, spec.slug, spec.detail);
30
+ }
36
31
  const code = (0, problem_1.isCryptoError)(error) ? error.code : undefined;
37
32
  const isInputError = code === undefined
38
- ? INPUT_ERROR_PATTERNS.some((pattern) => pattern.test(msg))
33
+ ? error instanceof RangeError
39
34
  : (0, problem_1.cryptoErrorStatus)(code) === 400;
40
35
  const extensions = code === undefined ? {} : { code };
41
36
  if (isInputError) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sebastienrousseau/crypto-server",
3
- "version": "0.0.35",
3
+ "version": "0.0.37",
4
4
  "description": "Fastify REST API for cryptography as a service: post-quantum ML-KEM and ML-DSA, encryption, signing, hashing and KMS endpoints, with OpenAPI docs, API key or JWT auth, rate limiting and OpenTelemetry.",
5
5
  "author": "Sebastien Rousseau <sebastienrousseau@users.noreply.github.com>",
6
6
  "license": "MIT OR Apache-2.0",
@@ -43,32 +43,29 @@
43
43
  "@fastify/etag": "^6.2.1",
44
44
  "@fastify/helmet": "^13.2.0",
45
45
  "@fastify/jwt": "^10.2.4",
46
+ "@fastify/otel": "^0.21.3",
46
47
  "@fastify/rate-limit": "^11.2.1",
47
48
  "@fastify/swagger": "^9.9.2",
48
49
  "@fastify/swagger-ui": "^6.1.2",
49
50
  "@opentelemetry/api": "^1.9.0",
50
51
  "@opentelemetry/exporter-metrics-otlp-http": "^0.223.0",
51
52
  "@opentelemetry/exporter-trace-otlp-http": "^0.223.0",
52
- "@opentelemetry/instrumentation-fastify": "^0.57.0",
53
53
  "@opentelemetry/instrumentation-http": "^0.223.0",
54
54
  "@opentelemetry/resources": "^2.12.0",
55
55
  "@opentelemetry/sdk-metrics": "^2.12.0",
56
56
  "@opentelemetry/sdk-node": "^0.223.0",
57
- "@opentelemetry/sdk-trace-node": "^2.12.0",
58
57
  "@opentelemetry/semantic-conventions": "^1.43.0",
59
58
  "fastify": "^5.12.7",
60
59
  "fastify-healthcheck": "^5.1.0",
61
- "uuid": "^14.0.3",
62
- "winston": "^3.17.0",
63
- "@sebastienrousseau/crypto-lib": "0.0.35",
64
- "@sebastienrousseau/crypto-kms": "0.0.35"
60
+ "pino": "10.4.0",
61
+ "@sebastienrousseau/crypto-kms": "0.0.37",
62
+ "@sebastienrousseau/crypto-lib": "0.0.37"
65
63
  },
66
64
  "devDependencies": {
67
65
  "@types/chai": "^5.2.3",
68
66
  "@types/chai-as-promised": "^8.0.2",
69
67
  "@types/mocha": "^10.0.10",
70
68
  "@types/node": "^26.6.5",
71
- "@types/uuid": "^11.0.0",
72
69
  "c8": "^12.0.0",
73
70
  "chai": "^6.3.0",
74
71
  "chai-as-promised": "^8.0.2",
@@ -110,6 +107,7 @@
110
107
  "format:check": "prettier --check \"src/**/*.ts\"",
111
108
  "start": "node dist/index.js",
112
109
  "test": "c8 --check-coverage --lines 100 --branches 100 --functions 100 --reporter=lcov --reporter=text mocha --config=.mocharc.cjs",
110
+ "test:run": "mocha --config=.mocharc.cjs",
113
111
  "docs": "typedoc"
114
112
  }
115
113
  }
@@ -1,18 +0,0 @@
1
- export declare const KDF_WORKER_THREADS = 2;
2
- declare const MODULES: {
3
- readonly modern: string;
4
- readonly highLevel: string;
5
- };
6
- export type KdfModule = keyof typeof MODULES;
7
- export declare class KdfRunner {
8
- private pool;
9
- run<T>(module: KdfModule, functionName: string, ...args: unknown[]): Promise<T>;
10
- close(): Promise<void>;
11
- }
12
- declare module "fastify" {
13
- interface FastifyInstance {
14
- kdf: KdfRunner;
15
- }
16
- }
17
- export {};
18
- //# sourceMappingURL=kdf-runner.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"kdf-runner.d.ts","sourceRoot":"","sources":["../../src/lib/kdf-runner.ts"],"names":[],"mappings":"AAsBA,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAQpC,QAAA,MAAM,OAAO;;;CAGH,CAAC;AAGX,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,OAAO,CAAC;AAM7C,qBAAa,SAAS;IACpB,OAAO,CAAC,IAAI,CAAyB;IAOrC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAU5D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAK7B;AAED,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,eAAe;QAEvB,GAAG,EAAE,SAAS,CAAC;KAChB;CACF"}
@@ -1,27 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.KdfRunner = exports.KDF_WORKER_THREADS = void 0;
4
- const accel_1 = require("@sebastienrousseau/crypto-lib/accel");
5
- exports.KDF_WORKER_THREADS = 2;
6
- const MODULES = {
7
- modern: require.resolve("@sebastienrousseau/crypto-lib/modern"),
8
- highLevel: require.resolve("@sebastienrousseau/crypto-lib/high-level"),
9
- };
10
- class KdfRunner {
11
- pool;
12
- run(module, functionName, ...args) {
13
- this.pool ??= new accel_1.WorkerPool({ size: exports.KDF_WORKER_THREADS });
14
- return this.pool.execute({
15
- modulePath: MODULES[module],
16
- functionName,
17
- args,
18
- });
19
- }
20
- async close() {
21
- const pool = this.pool;
22
- this.pool = undefined;
23
- await pool?.shutdown();
24
- }
25
- }
26
- exports.KdfRunner = KdfRunner;
27
- //# sourceMappingURL=kdf-runner.js.map