@sebastienrousseau/crypto-server 0.0.8 → 0.0.9

package/README.md

@@ -159,46 +159,113 @@ All v2 endpoints accept and return `application/json`. Authenticated
 requests must include an `x-api-key` header (or
 `Authorization: Bearer <jwt>`).
 
-| Method | Path                          | Description                                                  |
-| :----- | :---------------------------- | :----------------------------------------------------------- |
-| `POST` | `/v2/hash`                    | Compute a cryptographic hash (SHA-2, SHA-3, BLAKE2b, BLAKE3) |
-| `POST` | `/v2/encrypt`                 | AEAD encryption with XChaCha20-Poly1305                      |
-| `POST` | `/v2/decrypt`                 | AEAD decryption with XChaCha20-Poly1305                      |
-| `POST` | `/v2/sign`                    | Create a digital signature                                   |
-| `POST` | `/v2/verify`                  | Verify a digital signature                                   |
-| `POST` | `/v2/kdf`                     | Derive a key (scrypt, HKDF-SHA256, PBKDF2-SHA256)            |
-| `POST` | `/v2/hmac`                    | Compute an HMAC                                              |
-| `POST` | `/v2/hmac/verify`             | Verify an HMAC in constant time                              |
-| `POST` | `/v2/password/hash`           | Hash a password with Argon2id                                |
-| `POST` | `/v2/password/verify`         | Verify a password against an Argon2id hash                   |
-| `POST` | `/v2/password/encrypt`        | Encrypt with password (Argon2id + XChaCha20-Poly1305)        |
-| `POST` | `/v2/password/decrypt`        | Decrypt with password                                        |
-| `POST` | `/v2/keys/generate`           | Generate a key pair for any supported algorithm              |
-| `POST` | `/v2/keys/wrap`               | Wrap a key with AES-KW or AES-KWP                            |
-| `POST` | `/v2/keys/unwrap`             | Unwrap a key                                                 |
-| `POST` | `/v2/secretbox/seal`          | Encrypt with XChaCha20-Poly1305 (secretbox)                  |
-| `POST` | `/v2/secretbox/open`          | Decrypt a secretbox ciphertext                               |
-| `POST` | `/v2/sealedbox/seal`          | Anonymous public-key encryption (X25519)                     |
-| `POST` | `/v2/sealedbox/open`          | Decrypt an anonymous sealed box                              |
-| `POST` | `/v2/sealedbox/seal-pq`       | Post-quantum sealed box (X25519 + ML-KEM-768)                |
-| `POST` | `/v2/sealedbox/open-pq`       | Decrypt a post-quantum sealed box                            |
-| `POST` | `/v2/multi-recipient/encrypt` | Encrypt for multiple recipients                              |
-| `POST` | `/v2/pq/keygen`               | Generate an ML-KEM-768 key pair (FIPS 203)                   |
-| `POST` | `/v2/pq/encapsulate`          | Encapsulate a shared secret with ML-KEM-768                  |
-| `POST` | `/v2/pq/decapsulate`          | Decapsulate and recover the shared secret                    |
-| `POST` | `/v2/pq/hybrid/keygen`        | Generate a hybrid X25519 + ML-KEM-768 key pair               |
-| `POST` | `/v2/pq/hybrid/encapsulate`   | Hybrid encapsulation                                         |
-| `POST` | `/v2/pq/hybrid/decapsulate`   | Hybrid decapsulation                                         |
-| `POST` | `/v2/pq/dsa/keygen`           | Generate an ML-DSA key pair (FIPS 204)                       |
-| `POST` | `/v2/pq/dsa/sign`             | Sign with ML-DSA                                             |
-| `POST` | `/v2/pq/dsa/verify`           | Verify an ML-DSA signature                                   |
-| `POST` | `/v2/pq/slh-dsa/keygen`       | Generate an SLH-DSA key pair (FIPS 205)                      |
-| `POST` | `/v2/pq/slh-dsa/sign`         | Sign with SLH-DSA                                            |
-| `POST` | `/v2/pq/slh-dsa/verify`       | Verify an SLH-DSA signature                                  |
-| `GET`  | `/v2/algorithms`              | List all supported algorithms                                |
-| `GET`  | `/live`                       | Liveness probe (Kubernetes)                                  |
-| `GET`  | `/ready`                      | Readiness probe (Kubernetes)                                 |
-| `GET`  | `/metrics`                    | Prometheus-compatible metrics                                |
+| Method | Path                          | Description                                                          |
+| :----- | :---------------------------- | :------------------------------------------------------------------- |
+| `POST` | `/v2/hash`                    | Compute a cryptographic hash (SHA-2, SHA-3, BLAKE2b, BLAKE3)         |
+| `POST` | `/v2/encrypt`                 | AEAD encryption with XChaCha20-Poly1305                              |
+| `POST` | `/v2/decrypt`                 | AEAD decryption with XChaCha20-Poly1305                              |
+| `POST` | `/v2/sign`                    | Sign with a server-held Ed25519 key (`keyId`)                        |
+| `POST` | `/v2/verify`                  | Verify a digital signature                                           |
+| `POST` | `/v2/kdf`                     | Derive a key (scrypt N=2^17 r=8, HKDF-SHA256, PBKDF2-SHA256 >= 600k) |
+| `POST` | `/v2/hmac`                    | Compute an HMAC                                                      |
+| `POST` | `/v2/hmac/verify`             | Verify an HMAC in constant time                                      |
+| `POST` | `/v2/password/hash`           | Hash a password with Argon2id (m >= 19 MiB, t >= 2)                  |
+| `POST` | `/v2/password/verify`         | Verify a password against an Argon2id hash                           |
+| `POST` | `/v2/password/encrypt`        | Encrypt with password (Argon2id + XChaCha20-Poly1305)                |
+| `POST` | `/v2/password/decrypt`        | Decrypt with password                                                |
+| `POST` | `/v2/keys/generate`           | Generate a server-held key pair; returns `keyId` + public key        |
+| `POST` | `/v2/keys/export`             | Export a private key (`crypto:keys:export` scope only)               |
+| `POST` | `/v2/keys/wrap`               | Wrap a key with AES-KW or AES-KWP                                    |
+| `POST` | `/v2/keys/unwrap`             | Unwrap a key                                                         |
+| `POST` | `/v2/secretbox/seal`          | Encrypt with XChaCha20-Poly1305 (secretbox)                          |
+| `POST` | `/v2/secretbox/open`          | Decrypt a secretbox ciphertext                                       |
+| `POST` | `/v2/sealedbox/seal`          | Anonymous public-key encryption (X25519)                             |
+| `POST` | `/v2/sealedbox/open`          | Decrypt a sealed box with a server-held X25519 key (`keyId`)         |
+| `POST` | `/v2/sealedbox/seal-pq`       | Post-quantum sealed box (X25519 + ML-KEM-768)                        |
+| `POST` | `/v2/sealedbox/open-pq`       | Decrypt a PQ sealed box with a server-held hybrid key                |
+| `POST` | `/v2/multi-recipient/encrypt` | Encrypt for multiple recipients                                      |
+| `POST` | `/v2/pq/keygen`               | Generate an ML-KEM-768 key pair (FIPS 203)                           |
+| `POST` | `/v2/pq/encapsulate`          | Encapsulate a shared secret with ML-KEM-768                          |
+| `POST` | `/v2/pq/decapsulate`          | Decapsulate with a server-held ML-KEM-768 key (`keyId`)              |
+| `POST` | `/v2/pq/hybrid/keygen`        | Generate a hybrid X25519 + ML-KEM-768 key pair                       |
+| `POST` | `/v2/pq/hybrid/encapsulate`   | Hybrid encapsulation                                                 |
+| `POST` | `/v2/pq/hybrid/decapsulate`   | Hybrid decapsulation with a server-held key (`keyId`)                |
+| `POST` | `/v2/pq/dsa/keygen`           | Generate an ML-DSA key pair (FIPS 204)                               |
+| `POST` | `/v2/pq/dsa/sign`             | Sign with a server-held ML-DSA key (`keyId`)                         |
+| `POST` | `/v2/pq/dsa/verify`           | Verify an ML-DSA signature                                           |
+| `POST` | `/v2/pq/slh-dsa/keygen`       | Generate an SLH-DSA key pair (FIPS 205)                              |
+| `POST` | `/v2/pq/slh-dsa/sign`         | Sign with a server-held SLH-DSA key (`keyId`)                        |
+| `POST` | `/v2/pq/slh-dsa/verify`       | Verify an SLH-DSA signature                                          |
+| `GET`  | `/v2/algorithms`              | List all supported algorithms                                        |
+| `GET`  | `/live`                       | Liveness probe (Kubernetes)                                          |
+| `GET`  | `/ready`                      | Readiness probe (Kubernetes)                                         |
+| `GET`  | `/metrics`                    | Prometheus-compatible metrics                                        |
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+### Errors
+
+Every error response is an RFC 9457 problem, served as
+`application/problem+json`:
+
+```json
+{
+  "type": "urn:crypto-service:problem:forbidden",
+  "title": "Forbidden",
+  "status": 403,
+  "detail": "Missing required scope: crypto:encrypt",
+  "instance": "/v2/encrypt"
+}
+```
+
+`type` is `urn:crypto-service:problem:<slug>`, one of
+`validation-failed` (400, with an `errors` array of `{ field, message }`),
+`invalid-input` (400), `request-error` (other 4xx), `unauthorized` (401),
+`forbidden` (403), `not-found` (404), `key-not-found` (404),
+`key-algorithm-mismatch` (400), `payload-too-large` (413),
+`rate-limited` (429, with `Retry-After`), `key-store-full` (503) and
+`internal-error` (500). A crypto-lib `CryptoError` or key-store error
+adds its `code`. A 500 never carries the internal message or stack, and
+`instance` is the request path without its query string.
+
+### Work factors
+
+`/v2/kdf` and `/v2/password/hash` enforce the OWASP Password Storage
+Cheat Sheet floors for new keys and hashes: scrypt N = 2^17 with r = 8
+(crypto-lib caps N at 2^17), PBKDF2-HMAC-SHA256 with at least 600,000
+iterations, and Argon2id with at least 19 MiB of memory and two passes.
+A lower value gets `400`. `/v2/password/verify` still accepts the
+parameters of existing hashes. Scrypt, PBKDF2 and Argon2 (including
+`/v2/password/encrypt` and `/decrypt`) run on two worker threads, so a
+derivation does not block other requests or the health probes; further
+derivations queue.
+
+### Key custody
+
+The API never takes a private key and never returns one, with one
+exception below. Key-generation routes (`/v2/keys/generate`,
+`/v2/pq/keygen`, `/v2/pq/hybrid/keygen`, `/v2/pq/dsa/keygen`,
+`/v2/pq/slh-dsa/keygen`) keep the private key on the server and return
+a `keyId` with the public key. Signing, sealed-box opening and
+decapsulation routes take that `keyId`. A key belongs to the principal
+(token `sub`) that generated it; for anyone else it does not exist
+(`404`).
+
+Keys live in memory (at most 10,000 without persistence). Set
+`CRYPTO_KEY_OUT_DIR` to also write each key to `<keyId>.json` there
+(mode `0600`, never overwritten) so keys survive a restart; those files
+hold the private key unencrypted, so protect the directory.
+
+`POST /v2/keys/export` returns a key's private parts. It needs the
+`crypto:keys:export` scope, granted explicitly in a JWT: `crypto:admin`
+does not include it, so API-key and anonymous principals cannot export.
+
+The v1 routes use the server's own OpenPGP key pair from
+`CRYPTO_KEY_DIR`: `/v1/decrypt` decrypts messages sent to it, and
+`/v1/encrypt` signs with it when `sign` is `true`.
+
+Symmetric keys (`/v2/encrypt`, `/v2/secretbox/*`, `/v2/hmac`, the
+key-wrap KEK) are still supplied by the client.
 
 <p align="right"><a href="#contents">Back to Top</a></p>
 
@@ -211,8 +278,9 @@ The server supports two authentication modes:
 2. **JWT Bearer** -- set `JWT_SECRET` and pass
    `Authorization: Bearer <token>`.
 
-If neither variable is set, all requests are allowed (development
-mode).
+If neither variable is set, every request except the probes and
+`/docs` gets `401`, unless `ALLOW_ANONYMOUS=1` is set for local
+development or behind an authenticating gateway.
 
 ```bash
 # API key
@@ -222,24 +290,59 @@ curl -H "x-api-key: your-secret-api-key" ...
 curl -H "Authorization: Bearer eyJhbGciOi..." ...
 ```
 
+A JWT must be HS256 and carry `exp` and `iat`; it is refused once it
+is older than `JWT_MAX_AGE` seconds (default 3600) or if it declares a
+longer lifetime (`exp - iat`). When `JWT_ISSUER` / `JWT_AUDIENCE` are
+set, its `iss` must equal the issuer and its `aud` must contain the
+audience. In production (`NODE_ENV=production`) both are required
+whenever `JWT_SECRET` is set, and the server refuses to start without
+them.
+
+### Scopes
+
+Every route requires one scope, defined in one table
+(`ROUTE_SCOPES` in `src/config/auth-policy.ts`). A principal without it
+gets `403`. The server refuses to start if a route has no entry.
+JWT principals carry their scopes in a `scopes` array claim; API-key
+and anonymous principals hold `crypto:admin`, which satisfies every
+scope except `crypto:keys:export`.
+
+| Scope                | Routes                                                                                                               |
+| :------------------- | :------------------------------------------------------------------------------------------------------------------- |
+| `crypto:encrypt`     | `/v1/encrypt`, `/v2/encrypt`, secretbox/sealedbox seal, password and multi-recipient encrypt, PQ encapsulate         |
+| `crypto:decrypt`     | `/v1/decrypt`, `/v2/decrypt`, secretbox/sealedbox open, password decrypt, PQ decapsulate                             |
+| `crypto:sign`        | `/v2/sign`, `/v2/stream/sign`, ML-DSA and SLH-DSA sign, `/v2/hmac`                                                   |
+| `crypto:verify`      | `/v1/verify`, `/v2/verify`, `/v2/stream/verify`, `/v2/stream/iso20022`, ML-DSA and SLH-DSA verify, `/v2/hmac/verify` |
+| `crypto:hash`        | `/v2/hash`                                                                                                           |
+| `crypto:kdf`         | `/v2/kdf`, `/v2/password/hash`, `/v2/password/verify`                                                                |
+| `crypto:keys`        | `/v1/generate`, `/v2/keys/*`, PQ, ML-DSA and SLH-DSA keygen                                                          |
+| `crypto:keys:export` | `/v2/keys/export`; never implied by `crypto:admin`                                                                   |
+| `crypto:admin`       | `/v1/revoke` (revokes the server's own key pair); satisfies every other scope except `crypto:keys:export`            |
+
+`GET /`, `GET /v2/algorithms` and `GET /v2/compliance/*` need
+authentication but no scope.
+
 <p align="right"><a href="#contents">Back to Top</a></p>
 
 ## Configuration
 
-| Variable              | Default       | Description                                        |
-| :-------------------- | :------------ | :------------------------------------------------- |
-| `PORT`                | `3000`        | TCP port to listen on                              |
-| `HOST`                | `localhost`   | Bind address                                       |
-| `PROTOCOL`            | `http`        | `http` or `https`                                  |
-| `NODE_ENV`            | `development` | `development`, `production`, or `test`             |
-| `LOG_LEVEL`           | `info`        | `error`, `warn`, `info`, or `debug`                |
-| `CRYPTO_API_KEY`      | --            | Static API key for `x-api-key` authentication      |
-| `JWT_SECRET`          | --            | HMAC secret for HS256 JWT validation               |
-| `CORS_ORIGIN`         | --            | Comma-separated allowed origins (empty = disabled) |
-| `TRUSTED_PROXY_CIDRS` | --            | Comma-separated trusted proxy CIDRs                |
-| `CRYPTO_KEY_DIR`      | --            | Directory for key storage                          |
-| `CRYPTO_KEY_OUT_DIR`  | --            | Directory for key output                           |
-| `SHUTDOWN_TIMEOUT_MS` | `30000`       | Graceful shutdown timeout in milliseconds          |
+| Variable              | Default       | Description                                          |
+| :-------------------- | :------------ | :--------------------------------------------------- |
+| `PORT`                | `3000`        | TCP port to listen on                                |
+| `HOST`                | `localhost`   | Bind address                                         |
+| `PROTOCOL`            | `http`        | `http` or `https`                                    |
+| `NODE_ENV`            | `development` | `development`, `production`, or `test`               |
+| `LOG_LEVEL`           | `info`        | `error`, `warn`, `info`, or `debug`                  |
+| `CRYPTO_API_KEY`      | --            | Static API key for `x-api-key` authentication        |
+| `JWT_SECRET`          | --            | HMAC secret for HS256 JWT validation                 |
+| `JWT_MAX_AGE`         | `3600`        | Maximum JWT lifetime in seconds                      |
+| `JWT_ISSUER`          | --            | Required JWT `iss` (required in production)          |
+| `JWT_AUDIENCE`        | --            | Required JWT `aud` (required in production)          |
+| `CORS_ORIGIN`         | --            | Comma-separated allowed origins (empty = disabled)   |
+| `TRUSTED_PROXY_CIDRS` | --            | Comma-separated trusted proxy CIDRs                  |
+| `CRYPTO_KEY_DIR`      | --            | Directory for key storage                            |
+| `CRYPTO_KEY_OUT_DIR`  | --            | Where generated keys are persisted (see Key custody) |
+| `SHUTDOWN_TIMEOUT_MS` | `30000`       | Graceful shutdown timeout in milliseconds            |
 
 <p align="right"><a href="#contents">Back to Top</a></p>
 

package/dist/@types/types.d.ts

@@ -20,13 +20,12 @@ export interface IBodyEncrypt {
     passphrase: string;
     message: string;
     publicKey: string;
-    privateKey?: string;
+    sign?: boolean;
 }
 export interface IBodyDecrypt {
     passphrase: string;
     message: string;
     publicKey: string;
-    privateKey: string;
 }
 export interface IBodyRevoke {
     passphrase: string;

package/dist/@types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/@types/types.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,SAAS,yBAA0B,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAKjD,eAAO,MAAM,WAAW,kIAUd,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAKrD,eAAO,MAAM,YAAY,0CAA2C,CAAC;AAErE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAKvD,eAAO,MAAM,gBAAgB,uBAAwB,CAAC;AAEtD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAiB/D,MAAM,WAAW,aAAa;IAE5B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,OAAO,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,SAAS,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,MAAM,EAAE,UAAU,CAAC;CACpB;AAcD,MAAM,WAAW,YAAY;IAE3B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAeD,MAAM,WAAW,YAAY;IAE3B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE,MAAM,CAAC;CACpB;AAcD,MAAM,WAAW,WAAW;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,MAAM,CAAC;CAChB;AAcD,MAAM,WAAW,WAAW;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/@types/types.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,SAAS,yBAA0B,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAKjD,eAAO,MAAM,WAAW,kIAUd,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAKrD,eAAO,MAAM,YAAY,0CAA2C,CAAC;AAErE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAKvD,eAAO,MAAM,gBAAgB,uBAAwB,CAAC;AAEtD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAiB/D,MAAM,WAAW,aAAa;IAE5B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,OAAO,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,SAAS,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,MAAM,EAAE,UAAU,CAAC;CACpB;AAcD,MAAM,WAAW,YAAY;IAE3B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAiBD,MAAM,WAAW,YAAY;IAE3B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;CACnB;AAcD,MAAM,WAAW,WAAW;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,MAAM,CAAC;CAChB;AAcD,MAAM,WAAW,WAAW;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}

package/dist/config/auth-policy.d.ts

@@ -1,2 +1,20 @@
+export declare const DEFAULT_JWT_MAX_AGE_SECONDS = 3600;
+export interface JwtPolicy {
+    readonly maxAgeSeconds: number;
+    readonly issuer: string | undefined;
+    readonly audience: string | undefined;
+}
+export declare function jwtConfigError(env: NodeJS.ProcessEnv): string | null;
+export declare function jwtPolicy(env: NodeJS.ProcessEnv): JwtPolicy;
 export declare function authConfigError(env: NodeJS.ProcessEnv): string | null;
+export declare const AUTHENTICATED = "authenticated";
+export declare const ROUTE_SCOPES: Readonly<Record<string, string>>;
+export declare function isPublicRoute(url: string): boolean;
+export declare function routeRequirement(method: string, url: string): string | undefined;
+export interface RegisteredRoute {
+    method: string | string[];
+    url: string;
+}
+export declare function unmappedRoutes(routes: readonly RegisteredRoute[]): string[];
+export declare function assertRoutesCovered(routes: readonly RegisteredRoute[]): void;
 //# sourceMappingURL=auth-policy.d.ts.map

package/dist/config/auth-policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-policy.d.ts","sourceRoot":"","sources":["../../src/config/auth-policy.ts"],"names":[],"mappings":"AAsBA,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,CAcrE"}
+{"version":3,"file":"auth-policy.d.ts","sourceRoot":"","sources":["../../src/config/auth-policy.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAGhD,MAAM,WAAW,SAAS;IAMxB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAQD,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,CAUpE;AAMD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,CAO3D;AAUD,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,CAgBrE;AAOD,eAAO,MAAM,aAAa,kBAAkB,CAAC;AAY7C,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA6DxD,CAAC;AAMH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAElD;AAMD,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GACV,MAAM,GAAG,SAAS,CAGpB;AAGD,MAAM,WAAW,eAAe;IAE9B,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE1B,GAAG,EAAE,MAAM,CAAC;CACb;AAMD,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,GAAG,MAAM,EAAE,CAY3E;AAOD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,GAAG,IAAI,CAO5E"}

package/dist/config/auth-policy.js

@@ -1,12 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTE_SCOPES = exports.AUTHENTICATED = exports.DEFAULT_JWT_MAX_AGE_SECONDS = void 0;
+exports.jwtConfigError = jwtConfigError;
+exports.jwtPolicy = jwtPolicy;
 exports.authConfigError = authConfigError;
+exports.isPublicRoute = isPublicRoute;
+exports.routeRequirement = routeRequirement;
+exports.unmappedRoutes = unmappedRoutes;
+exports.assertRoutesCovered = assertRoutesCovered;
+const constants_1 = require("./constants");
 const MIN_JWT_SECRET_BYTES = 32;
+exports.DEFAULT_JWT_MAX_AGE_SECONDS = 3600;
+function jwtConfigError(env) {
+    const maxAge = env["JWT_MAX_AGE"];
+    if (maxAge && !/^[1-9]\d{0,8}$/.test(maxAge)) {
+        return "JWT_MAX_AGE must be a positive integer number of seconds";
+    }
+    const pinned = Boolean(env["JWT_ISSUER"] && env["JWT_AUDIENCE"]);
+    if (env["NODE_ENV"] === "production" && env["JWT_SECRET"] && !pinned) {
+        return "Production with JWT_SECRET requires JWT_ISSUER and JWT_AUDIENCE";
+    }
+    return null;
+}
+function jwtPolicy(env) {
+    const maxAge = env["JWT_MAX_AGE"];
+    return {
+        maxAgeSeconds: maxAge ? Number(maxAge) : exports.DEFAULT_JWT_MAX_AGE_SECONDS,
+        issuer: env["JWT_ISSUER"] || undefined,
+        audience: env["JWT_AUDIENCE"] || undefined,
+    };
+}
 function authConfigError(env) {
     const jwtSecret = env["JWT_SECRET"];
     if (jwtSecret && Buffer.byteLength(jwtSecret) < MIN_JWT_SECRET_BYTES) {
         return `JWT_SECRET must be at least ${MIN_JWT_SECRET_BYTES} bytes`;
     }
+    const jwtError = jwtConfigError(env);
+    if (jwtError)
+        return jwtError;
     const hasCredential = Boolean(env["CRYPTO_API_KEY"] || jwtSecret);
     if (env["NODE_ENV"] === "production" &&
         !hasCredential &&
@@ -15,4 +46,82 @@ function authConfigError(env) {
     }
     return null;
 }
+exports.AUTHENTICATED = "authenticated";
+exports.ROUTE_SCOPES = Object.freeze({
+    "GET /": exports.AUTHENTICATED,
+    "GET /v2/algorithms": exports.AUTHENTICATED,
+    "GET /v2/compliance/dora": exports.AUTHENTICATED,
+    "GET /v2/compliance/cbom": exports.AUTHENTICATED,
+    "OPTIONS *": exports.AUTHENTICATED,
+    "POST /v1/encrypt": "crypto:encrypt",
+    "POST /v1/decrypt": "crypto:decrypt",
+    "POST /v1/verify": "crypto:verify",
+    "POST /v1/generate": "crypto:keys",
+    "POST /v1/revoke": "crypto:admin",
+    "POST /v2/encrypt": "crypto:encrypt",
+    "POST /v2/secretbox/seal": "crypto:encrypt",
+    "POST /v2/sealedbox/seal": "crypto:encrypt",
+    "POST /v2/sealedbox/seal-pq": "crypto:encrypt",
+    "POST /v2/password/encrypt": "crypto:encrypt",
+    "POST /v2/multi-recipient/encrypt": "crypto:encrypt",
+    "POST /v2/pq/encapsulate": "crypto:encrypt",
+    "POST /v2/pq/hybrid/encapsulate": "crypto:encrypt",
+    "POST /v2/decrypt": "crypto:decrypt",
+    "POST /v2/secretbox/open": "crypto:decrypt",
+    "POST /v2/sealedbox/open": "crypto:decrypt",
+    "POST /v2/sealedbox/open-pq": "crypto:decrypt",
+    "POST /v2/password/decrypt": "crypto:decrypt",
+    "POST /v2/pq/decapsulate": "crypto:decrypt",
+    "POST /v2/pq/hybrid/decapsulate": "crypto:decrypt",
+    "POST /v2/sign": "crypto:sign",
+    "POST /v2/stream/sign": "crypto:sign",
+    "POST /v2/pq/dsa/sign": "crypto:sign",
+    "POST /v2/pq/slh-dsa/sign": "crypto:sign",
+    "POST /v2/hmac": "crypto:sign",
+    "POST /v2/verify": "crypto:verify",
+    "POST /v2/stream/verify": "crypto:verify",
+    "POST /v2/stream/iso20022": "crypto:verify",
+    "POST /v2/pq/dsa/verify": "crypto:verify",
+    "POST /v2/pq/slh-dsa/verify": "crypto:verify",
+    "POST /v2/hmac/verify": "crypto:verify",
+    "POST /v2/hash": "crypto:hash",
+    "POST /v2/kdf": "crypto:kdf",
+    "POST /v2/password/hash": "crypto:kdf",
+    "POST /v2/password/verify": "crypto:kdf",
+    "POST /v2/keys/generate": "crypto:keys",
+    "POST /v2/keys/export": "crypto:keys:export",
+    "POST /v2/keys/wrap": "crypto:keys",
+    "POST /v2/keys/unwrap": "crypto:keys",
+    "POST /v2/pq/keygen": "crypto:keys",
+    "POST /v2/pq/hybrid/keygen": "crypto:keys",
+    "POST /v2/pq/dsa/keygen": "crypto:keys",
+    "POST /v2/pq/slh-dsa/keygen": "crypto:keys",
+});
+function isPublicRoute(url) {
+    return (0, constants_1.isProbePath)(url) || url.startsWith("/docs");
+}
+function routeRequirement(method, url) {
+    const verb = method === "HEAD" ? "GET" : method;
+    return exports.ROUTE_SCOPES[`${verb} ${url}`];
+}
+function unmappedRoutes(routes) {
+    const missing = [];
+    for (const route of routes) {
+        if (isPublicRoute(route.url))
+            continue;
+        const methods = Array.isArray(route.method) ? route.method : [route.method];
+        for (const method of methods) {
+            if (routeRequirement(method, route.url) === undefined) {
+                missing.push(`${method} ${route.url}`);
+            }
+        }
+    }
+    return missing;
+}
+function assertRoutesCovered(routes) {
+    const missing = unmappedRoutes(routes);
+    if (missing.length > 0) {
+        throw new Error(`Routes without an authorization policy: ${missing.join(", ")}`);
+    }
+}
 //# sourceMappingURL=auth-policy.js.map

package/dist/enterprise/metering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metering.d.ts","sourceRoot":"","sources":["../../src/enterprise/metering.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,eAAe,EAAgC,MAAM,SAAS,CAAC;AAE7E,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACnB,WAAW,EAEZ,MAAM,SAAS,CAAC;AAWjB,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,WAAW,CAsBxD,CAAC;AAGF,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAY1C,qBAAa,cAAc;IAKvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJ7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkC;gBAIvC,UAAU,GAAE,MAA4B;IAI3D,IAAW,IAAI,IAAI,MAAM,CAExB;IASM,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW;IAOhD,OAAO,CAAC,QAAQ;IAwBhB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,YAAY;IAqBb,YAAY,CACjB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,WAAW,EACjB,aAAa,CAAC,EAAE,MAAM,EACtB,KAAK,GAAE,MAAmB,GACzB,mBAAmB;IA4Df,KAAK,IAAI,IAAI;CAGrB;AAGD,eAAO,MAAM,qBAAqB,gBAAuB,CAAC;AA6B1D,eAAO,MAAM,gBAAgB,GAC3B,KAAK,eAAe,EACpB,SAAQ,cAAqC,KAC5C,IAgCF,CAAC"}
+{"version":3,"file":"metering.d.ts","sourceRoot":"","sources":["../../src/enterprise/metering.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,eAAe,EAAgC,MAAM,SAAS,CAAC;AAG7E,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACnB,WAAW,EAEZ,MAAM,SAAS,CAAC;AAWjB,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,WAAW,CAsBxD,CAAC;AAGF,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAY1C,qBAAa,cAAc;IAKvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJ7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkC;gBAIvC,UAAU,GAAE,MAA4B;IAI3D,IAAW,IAAI,IAAI,MAAM,CAExB;IASM,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW;IAOhD,OAAO,CAAC,QAAQ;IAwBhB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,YAAY;IAqBb,YAAY,CACjB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,WAAW,EACjB,aAAa,CAAC,EAAE,MAAM,EACtB,KAAK,GAAE,MAAmB,GACzB,mBAAmB;IA4Df,KAAK,IAAI,IAAI;CAGrB;AAGD,eAAO,MAAM,qBAAqB,gBAAuB,CAAC;AA6B1D,eAAO,MAAM,gBAAgB,GAC3B,KAAK,eAAe,EACpB,SAAQ,cAAqC,KAC5C,IAmCF,CAAC"}

package/dist/enterprise/metering.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerMetering = exports.defaultMeteringEngine = exports.MeteringEngine = exports.DEFAULT_MAX_TENANTS = exports.TIER_QUOTAS = void 0;
 const constants_1 = require("../config/constants");
+const problem_1 = require("../lib/problem");
 exports.TIER_QUOTAS = {
     community: {
         tier: "community",
@@ -144,10 +145,7 @@ const registerMetering = (app, engine = new MeteringEngine()) => {
             const code = result.statusCode;
             if (code === 429)
                 reply.header("Retry-After", result.resetSeconds);
-            return reply.code(code).send({
-                statusCode: code,
-                error: code === 413 ? "Payload Too Large" : "Too Many Requests",
-                message: result.error,
+            return (0, problem_1.sendProblem)(reply, code, code === 413 ? "payload-too-large" : "rate-limited", result.error, {
                 tier: result.tier,
                 limit: result.limit,
                 resetSeconds: result.resetSeconds,

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+#!/usr/bin/env node
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/auth.d.ts

@@ -1,6 +1,7 @@
 import type { FastifyInstance, FastifyRequest, FastifyReply } from "fastify";
-export declare const SCOPES: readonly ["crypto:encrypt", "crypto:decrypt", "crypto:sign", "crypto:verify", "crypto:hash", "crypto:kdf", "crypto:keys", "crypto:admin"];
+export declare const SCOPES: readonly ["crypto:encrypt", "crypto:decrypt", "crypto:sign", "crypto:verify", "crypto:hash", "crypto:kdf", "crypto:keys", "crypto:keys:export", "crypto:admin"];
 export type Scope = (typeof SCOPES)[number];
+export declare const EXPLICIT_SCOPES: readonly Scope[];
 export interface AuthPayload {
     sub: string;
     scopes: Scope[];
@@ -8,7 +9,9 @@ export interface AuthPayload {
     exp?: number;
 }
 export declare function registerAuth(app: FastifyInstance): Promise<void>;
+export declare function exceedsLifetime(payload: AuthPayload, maxAgeSeconds: number, nowSeconds?: number): boolean;
 export declare function authenticate(request: FastifyRequest, reply: FastifyReply): Promise<AuthPayload | null>;
 export declare function hasScope(payload: AuthPayload, required: Scope): boolean;
 export declare function requireScope(payload: AuthPayload, scope: Scope, reply: FastifyReply): boolean;
+export declare function authorizeRoute(request: FastifyRequest, reply: FastifyReply, payload: AuthPayload): boolean;
 //# sourceMappingURL=auth.d.ts.map

package/dist/lib/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/lib/auth.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAO7E,eAAO,MAAM,MAAM,2IAST,CAAC;AAGX,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAG5C,MAAM,WAAW,WAAW;IAE1B,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,KAAK,EAAE,CAAC;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAKD,wBAAsB,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAYtE;AAUD,wBAAsB,YAAY,CAChC,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAqD7B;AAKD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,GAAG,OAAO,CAIvE;AAKD,wBAAgB,YAAY,CAC1B,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,GAClB,OAAO,CAST"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/lib/auth.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAc7E,eAAO,MAAM,MAAM,iKAUT,CAAC;AAGX,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAO5C,eAAO,MAAM,eAAe,EAAE,SAAS,KAAK,EAA2B,CAAC;AAGxE,MAAM,WAAW,WAAW;IAE1B,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,KAAK,EAAE,CAAC;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAeD,wBAAsB,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BtE;AAOD,wBAAgB,eAAe,CAC7B,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,MAAM,EACrB,UAAU,GAAE,MAAsC,GACjD,OAAO,CAIT;AA0DD,wBAAsB,YAAY,CAChC,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CA0B7B;AAKD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,GAAG,OAAO,CAOvE;AAKD,wBAAgB,YAAY,CAC1B,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,GAClB,OAAO,CAMT;AASD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,WAAW,GACnB,OAAO,CAeT"}