@dbx-tools/email 0.6.44 → 0.6.45

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.
@@ -1,135 +0,0 @@
1
- /**
2
- * One-time-code store + session JWT for the email-OTP gate.
3
- *
4
- * Two pieces:
5
- *
6
- * - **Code store** - a 6-digit code is generated with `crypto.randomInt` and
7
- * kept server-side as a SHA-256 hash with an expiry and an attempt counter
8
- * (never the plaintext, never in the JWT). `verifyCode` is constant-time on
9
- * the hash, enforces the TTL, and burns the code after too many attempts or
10
- * one success. In-memory `Map` keyed by lowercased email - fine for a
11
- * single-instance app behind a tunnel.
12
- * - **Session JWT** - on a correct code, `signSession` mints a short-lived
13
- * HS256 JWT (via `jose`) carrying only the email; `verifySession` validates
14
- * it. The signing key comes from `AUTH_JWT_SECRET`; when unset the gate
15
- * FAILS OPEN with an ephemeral per-process key (sessions reset on restart)
16
- * rather than refusing service - a Databricks App is already access-limited,
17
- * so an unset secret degrades to "sessions don't survive restarts", not
18
- * "nobody can log in".
19
- *
20
- * @module
21
- */
22
- import { createHash, randomBytes, randomInt, timingSafeEqual } from "node:crypto";
23
- import { jwtVerify, SignJWT } from "jose";
24
- import { log } from "@dbx-tools/shared-core";
25
- const logger = log.logger("email:auth:otp");
26
- /** JWT issuer/audience so a token minted for this gate isn't accepted elsewhere. */
27
- const JWT_AUD = "dbx-tools-email-auth";
28
- /** SHA-256 hex of a value (for the stored code + a stable key comparison). */
29
- function sha256(value) {
30
- return createHash("sha256").update(value).digest("hex");
31
- }
32
- /** Constant-time compare of two hex digests of equal length. */
33
- function safeEqualHex(a, b) {
34
- if (a.length !== b.length)
35
- return false;
36
- return timingSafeEqual(Buffer.from(a, "hex"), Buffer.from(b, "hex"));
37
- }
38
- /** In-memory store of pending one-time codes, keyed by lowercased email. */
39
- export class CodeStore {
40
- ttlMs;
41
- maxAttempts;
42
- codes = new Map();
43
- constructor(ttlMs, maxAttempts) {
44
- this.ttlMs = ttlMs;
45
- this.maxAttempts = maxAttempts;
46
- }
47
- /**
48
- * Generate, store (hashed), and RETURN a fresh 6-digit code for `email`. The
49
- * caller emails the returned plaintext; only the hash is retained. Replaces
50
- * any pending code for the address.
51
- */
52
- issue(email, now = Date.now()) {
53
- const code = String(randomInt(0, 1_000_000)).padStart(6, "0");
54
- this.codes.set(email.toLowerCase(), {
55
- hash: sha256(code),
56
- expiresAt: now + this.ttlMs,
57
- attempts: 0,
58
- });
59
- return code;
60
- }
61
- /**
62
- * Check `code` for `email`. Consumes the entry on success or when attempts are
63
- * exhausted, so a code is single-use and can't be brute-forced past the cap.
64
- */
65
- verify(email, code, now = Date.now()) {
66
- const key = email.toLowerCase();
67
- const entry = this.codes.get(key);
68
- if (!entry)
69
- return "invalid";
70
- if (now >= entry.expiresAt) {
71
- this.codes.delete(key);
72
- return "expired";
73
- }
74
- entry.attempts += 1;
75
- if (safeEqualHex(entry.hash, sha256(code))) {
76
- this.codes.delete(key);
77
- return "ok";
78
- }
79
- if (entry.attempts >= this.maxAttempts) {
80
- this.codes.delete(key);
81
- return "too-many-attempts";
82
- }
83
- return "invalid";
84
- }
85
- /** Drop every pending code (tests). */
86
- clear() {
87
- this.codes.clear();
88
- }
89
- }
90
- /**
91
- * Resolve the HS256 signing key. Prefers `AUTH_JWT_SECRET`; when unset, mints an
92
- * ephemeral per-process key (fail-open) and warns once. Memoized so every
93
- * sign/verify in a process shares one key.
94
- */
95
- let cachedKey;
96
- function signingKey() {
97
- if (cachedKey)
98
- return cachedKey;
99
- const secret = process.env.AUTH_JWT_SECRET?.trim();
100
- if (secret) {
101
- cachedKey = new TextEncoder().encode(secret);
102
- }
103
- else {
104
- logger.warn("AUTH_JWT_SECRET is not set - using an ephemeral per-process key; sessions will not survive a restart");
105
- cachedKey = randomBytes(32);
106
- }
107
- return cachedKey;
108
- }
109
- /** Reset the memoized key (tests, or after changing the env in-process). */
110
- export function resetSigningKey() {
111
- cachedKey = undefined;
112
- }
113
- /** Mint a short-lived session JWT for `email`, expiring in `ttlSeconds`. */
114
- export async function signSession(email, ttlSeconds) {
115
- return new SignJWT({ email })
116
- .setProtectedHeader({ alg: "HS256" })
117
- .setSubject(email)
118
- .setAudience(JWT_AUD)
119
- .setIssuedAt()
120
- .setExpirationTime(`${ttlSeconds}s`)
121
- .sign(signingKey());
122
- }
123
- /** Validate a session JWT, returning the email it was minted for, or `undefined`. */
124
- export async function verifySession(token) {
125
- if (!token)
126
- return undefined;
127
- try {
128
- const { payload } = await jwtVerify(token, signingKey(), { audience: JWT_AUD });
129
- return typeof payload.email === "string" ? payload.email : undefined;
130
- }
131
- catch {
132
- return undefined;
133
- }
134
- }
135
- //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"otp.js","sourceRoot":"","sources":["../../../src/auth/otp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAE7C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE5C,oFAAoF;AACpF,MAAM,OAAO,GAAG,sBAAsB,CAAC;AAEvC,8EAA8E;AAC9E,SAAS,MAAM,CAAC,KAAa;IAC3B,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,gEAAgE;AAChE,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS;IACxC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AACvE,CAAC;AAWD,4EAA4E;AAC5E,MAAM,OAAO,SAAS;IAID;IACA;IAJF,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAEtD,YACmB,KAAa,EACb,WAAmB;QADnB,UAAK,GAAL,KAAK,CAAQ;QACb,gBAAW,GAAX,WAAW,CAAQ;IACnC,CAAC;IAEJ;;;;OAIG;IACH,KAAK,CAAC,KAAa,EAAE,MAAc,IAAI,CAAC,GAAG,EAAE;QAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE;YAClC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;YAClB,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC,KAAK;YAC3B,QAAQ,EAAE,CAAC;SACZ,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAa,EAAE,IAAY,EAAE,MAAc,IAAI,CAAC,GAAG,EAAE;QAC1D,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,IAAI,GAAG,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC;QACpB,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,uCAAuC;IACvC,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;;;GAIG;AACH,IAAI,SAAiC,CAAC;AACtC,SAAS,UAAU;IACjB,IAAI,SAAS;QAAE,OAAO,SAAS,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC;IACnD,IAAI,MAAM,EAAE,CAAC;QACX,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CACT,sGAAsG,CACvG,CAAC;QACF,SAAS,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,eAAe;IAC7B,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAAa,EAAE,UAAkB;IACjE,OAAO,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;SAC1B,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;SACpC,UAAU,CAAC,KAAK,CAAC;SACjB,WAAW,CAAC,OAAO,CAAC;SACpB,WAAW,EAAE;SACb,iBAAiB,CAAC,GAAG,UAAU,GAAG,CAAC;SACnC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;AACxB,CAAC;AAED,qFAAqF;AACrF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,KAAyB;IAC3D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,IAAI,CAAC;QACH,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAChF,OAAO,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC","sourcesContent":["/**\n * One-time-code store + session JWT for the email-OTP gate.\n *\n * Two pieces:\n *\n *   - **Code store** - a 6-digit code is generated with `crypto.randomInt` and\n *     kept server-side as a SHA-256 hash with an expiry and an attempt counter\n *     (never the plaintext, never in the JWT). `verifyCode` is constant-time on\n *     the hash, enforces the TTL, and burns the code after too many attempts or\n *     one success. In-memory `Map` keyed by lowercased email - fine for a\n *     single-instance app behind a tunnel.\n *   - **Session JWT** - on a correct code, `signSession` mints a short-lived\n *     HS256 JWT (via `jose`) carrying only the email; `verifySession` validates\n *     it. The signing key comes from `AUTH_JWT_SECRET`; when unset the gate\n *     FAILS OPEN with an ephemeral per-process key (sessions reset on restart)\n *     rather than refusing service - a Databricks App is already access-limited,\n *     so an unset secret degrades to \"sessions don't survive restarts\", not\n *     \"nobody can log in\".\n *\n * @module\n */\n\nimport { createHash, randomBytes, randomInt, timingSafeEqual } from \"node:crypto\";\nimport { jwtVerify, SignJWT } from \"jose\";\nimport { log } from \"@dbx-tools/shared-core\";\n\nconst logger = log.logger(\"email:auth:otp\");\n\n/** JWT issuer/audience so a token minted for this gate isn't accepted elsewhere. */\nconst JWT_AUD = \"dbx-tools-email-auth\";\n\n/** SHA-256 hex of a value (for the stored code + a stable key comparison). */\nfunction sha256(value: string): string {\n  return createHash(\"sha256\").update(value).digest(\"hex\");\n}\n\n/** Constant-time compare of two hex digests of equal length. */\nfunction safeEqualHex(a: string, b: string): boolean {\n  if (a.length !== b.length) return false;\n  return timingSafeEqual(Buffer.from(a, \"hex\"), Buffer.from(b, \"hex\"));\n}\n\ninterface CodeEntry {\n  hash: string;\n  expiresAt: number;\n  attempts: number;\n}\n\n/** Result of {@link CodeStore.verify}. */\nexport type VerifyOutcome = \"ok\" | \"invalid\" | \"expired\" | \"too-many-attempts\";\n\n/** In-memory store of pending one-time codes, keyed by lowercased email. */\nexport class CodeStore {\n  private readonly codes = new Map<string, CodeEntry>();\n\n  constructor(\n    private readonly ttlMs: number,\n    private readonly maxAttempts: number,\n  ) {}\n\n  /**\n   * Generate, store (hashed), and RETURN a fresh 6-digit code for `email`. The\n   * caller emails the returned plaintext; only the hash is retained. Replaces\n   * any pending code for the address.\n   */\n  issue(email: string, now: number = Date.now()): string {\n    const code = String(randomInt(0, 1_000_000)).padStart(6, \"0\");\n    this.codes.set(email.toLowerCase(), {\n      hash: sha256(code),\n      expiresAt: now + this.ttlMs,\n      attempts: 0,\n    });\n    return code;\n  }\n\n  /**\n   * Check `code` for `email`. Consumes the entry on success or when attempts are\n   * exhausted, so a code is single-use and can't be brute-forced past the cap.\n   */\n  verify(email: string, code: string, now: number = Date.now()): VerifyOutcome {\n    const key = email.toLowerCase();\n    const entry = this.codes.get(key);\n    if (!entry) return \"invalid\";\n    if (now >= entry.expiresAt) {\n      this.codes.delete(key);\n      return \"expired\";\n    }\n    entry.attempts += 1;\n    if (safeEqualHex(entry.hash, sha256(code))) {\n      this.codes.delete(key);\n      return \"ok\";\n    }\n    if (entry.attempts >= this.maxAttempts) {\n      this.codes.delete(key);\n      return \"too-many-attempts\";\n    }\n    return \"invalid\";\n  }\n\n  /** Drop every pending code (tests). */\n  clear(): void {\n    this.codes.clear();\n  }\n}\n\n/**\n * Resolve the HS256 signing key. Prefers `AUTH_JWT_SECRET`; when unset, mints an\n * ephemeral per-process key (fail-open) and warns once. Memoized so every\n * sign/verify in a process shares one key.\n */\nlet cachedKey: Uint8Array | undefined;\nfunction signingKey(): Uint8Array {\n  if (cachedKey) return cachedKey;\n  const secret = process.env.AUTH_JWT_SECRET?.trim();\n  if (secret) {\n    cachedKey = new TextEncoder().encode(secret);\n  } else {\n    logger.warn(\n      \"AUTH_JWT_SECRET is not set - using an ephemeral per-process key; sessions will not survive a restart\",\n    );\n    cachedKey = randomBytes(32);\n  }\n  return cachedKey;\n}\n\n/** Reset the memoized key (tests, or after changing the env in-process). */\nexport function resetSigningKey(): void {\n  cachedKey = undefined;\n}\n\n/** Mint a short-lived session JWT for `email`, expiring in `ttlSeconds`. */\nexport async function signSession(email: string, ttlSeconds: number): Promise<string> {\n  return new SignJWT({ email })\n    .setProtectedHeader({ alg: \"HS256\" })\n    .setSubject(email)\n    .setAudience(JWT_AUD)\n    .setIssuedAt()\n    .setExpirationTime(`${ttlSeconds}s`)\n    .sign(signingKey());\n}\n\n/** Validate a session JWT, returning the email it was minted for, or `undefined`. */\nexport async function verifySession(token: string | undefined): Promise<string | undefined> {\n  if (!token) return undefined;\n  try {\n    const { payload } = await jwtVerify(token, signingKey(), { audience: JWT_AUD });\n    return typeof payload.email === \"string\" ? payload.email : undefined;\n  } catch {\n    return undefined;\n  }\n}\n"]}
@@ -1,35 +0,0 @@
1
- /**
2
- * A small in-memory fixed-window rate limiter for the email-OTP gate.
3
- *
4
- * Keyed by an arbitrary string (an email address or a client IP). Each key gets
5
- * `max` hits per `windowMs`; the window resets on first use after it elapses.
6
- * `hit()` returns whether the call is allowed and, when not, how many seconds
7
- * until the window resets so a caller can surface a cooldown.
8
- *
9
- * In-memory is intentional and sufficient for a single-app-instance gate: an
10
- * app behind a portr tunnel serves from one process. It is NOT a distributed
11
- * limiter; a multi-replica deployment would need shared state. Entries are
12
- * pruned lazily on access, so an idle key costs nothing after its window.
13
- *
14
- * @module
15
- */
16
- /** A fixed-window rate limiter over string keys. */
17
- export declare class RateLimiter {
18
- private readonly max;
19
- private readonly windowMs;
20
- private readonly windows;
21
- constructor(max: number, windowMs: number);
22
- /**
23
- * Record a hit for `key`. Returns `{ allowed }`, plus `retryAfter` (seconds)
24
- * when the limit is exceeded. A limit of `<= 0` disables limiting (always
25
- * allowed), which lets a config turn it off without special-casing callers.
26
- */
27
- hit(key: string, now?: number): {
28
- allowed: boolean;
29
- retryAfter?: number;
30
- };
31
- /** Forget a key (e.g. clear a caller's window after a successful verify). */
32
- reset(key: string): void;
33
- /** Drop every window (tests). */
34
- clear(): void;
35
- }
@@ -1,53 +0,0 @@
1
- /**
2
- * A small in-memory fixed-window rate limiter for the email-OTP gate.
3
- *
4
- * Keyed by an arbitrary string (an email address or a client IP). Each key gets
5
- * `max` hits per `windowMs`; the window resets on first use after it elapses.
6
- * `hit()` returns whether the call is allowed and, when not, how many seconds
7
- * until the window resets so a caller can surface a cooldown.
8
- *
9
- * In-memory is intentional and sufficient for a single-app-instance gate: an
10
- * app behind a portr tunnel serves from one process. It is NOT a distributed
11
- * limiter; a multi-replica deployment would need shared state. Entries are
12
- * pruned lazily on access, so an idle key costs nothing after its window.
13
- *
14
- * @module
15
- */
16
- /** A fixed-window rate limiter over string keys. */
17
- export class RateLimiter {
18
- max;
19
- windowMs;
20
- windows = new Map();
21
- constructor(max, windowMs) {
22
- this.max = max;
23
- this.windowMs = windowMs;
24
- }
25
- /**
26
- * Record a hit for `key`. Returns `{ allowed }`, plus `retryAfter` (seconds)
27
- * when the limit is exceeded. A limit of `<= 0` disables limiting (always
28
- * allowed), which lets a config turn it off without special-casing callers.
29
- */
30
- hit(key, now = Date.now()) {
31
- if (this.max <= 0)
32
- return { allowed: true };
33
- const existing = this.windows.get(key);
34
- if (!existing || now >= existing.resetAt) {
35
- this.windows.set(key, { count: 1, resetAt: now + this.windowMs });
36
- return { allowed: true };
37
- }
38
- if (existing.count < this.max) {
39
- existing.count += 1;
40
- return { allowed: true };
41
- }
42
- return { allowed: false, retryAfter: Math.ceil((existing.resetAt - now) / 1000) };
43
- }
44
- /** Forget a key (e.g. clear a caller's window after a successful verify). */
45
- reset(key) {
46
- this.windows.delete(key);
47
- }
48
- /** Drop every window (tests). */
49
- clear() {
50
- this.windows.clear();
51
- }
52
- }
53
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmF0ZS1saW1pdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hdXRoL3JhdGUtbGltaXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7Ozs7Ozs7Ozs7O0dBY0c7QUFPSCxvREFBb0Q7QUFDcEQsTUFBTSxPQUFPLFdBQVc7SUFJSDtJQUNBO0lBSkYsT0FBTyxHQUFHLElBQUksR0FBRyxFQUFrQixDQUFDO0lBRXJELFlBQ21CLEdBQVcsRUFDWCxRQUFnQjtRQURoQixRQUFHLEdBQUgsR0FBRyxDQUFRO1FBQ1gsYUFBUSxHQUFSLFFBQVEsQ0FBUTtJQUNoQyxDQUFDO0lBRUo7Ozs7T0FJRztJQUNILEdBQUcsQ0FBQyxHQUFXLEVBQUUsTUFBYyxJQUFJLENBQUMsR0FBRyxFQUFFO1FBQ3ZDLElBQUksSUFBSSxDQUFDLEdBQUcsSUFBSSxDQUFDO1lBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztRQUM1QyxNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUN2QyxJQUFJLENBQUMsUUFBUSxJQUFJLEdBQUcsSUFBSSxRQUFRLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDekMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxPQUFPLEVBQUUsR0FBRyxHQUFHLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ2xFLE9BQU8sRUFBRSxPQUFPLEVBQUUsSUFBSSxFQUFFLENBQUM7UUFDM0IsQ0FBQztRQUNELElBQUksUUFBUSxDQUFDLEtBQUssR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7WUFDOUIsUUFBUSxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUM7WUFDcEIsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztRQUMzQixDQUFDO1FBQ0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsVUFBVSxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxRQUFRLENBQUMsT0FBTyxHQUFHLEdBQUcsQ0FBQyxHQUFHLElBQUksQ0FBQyxFQUFFLENBQUM7SUFDcEYsQ0FBQztJQUVELDZFQUE2RTtJQUM3RSxLQUFLLENBQUMsR0FBVztRQUNmLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRCxpQ0FBaUM7SUFDakMsS0FBSztRQUNILElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDdkIsQ0FBQztDQUNGIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBBIHNtYWxsIGluLW1lbW9yeSBmaXhlZC13aW5kb3cgcmF0ZSBsaW1pdGVyIGZvciB0aGUgZW1haWwtT1RQIGdhdGUuXG4gKlxuICogS2V5ZWQgYnkgYW4gYXJiaXRyYXJ5IHN0cmluZyAoYW4gZW1haWwgYWRkcmVzcyBvciBhIGNsaWVudCBJUCkuIEVhY2gga2V5IGdldHNcbiAqIGBtYXhgIGhpdHMgcGVyIGB3aW5kb3dNc2A7IHRoZSB3aW5kb3cgcmVzZXRzIG9uIGZpcnN0IHVzZSBhZnRlciBpdCBlbGFwc2VzLlxuICogYGhpdCgpYCByZXR1cm5zIHdoZXRoZXIgdGhlIGNhbGwgaXMgYWxsb3dlZCBhbmQsIHdoZW4gbm90LCBob3cgbWFueSBzZWNvbmRzXG4gKiB1bnRpbCB0aGUgd2luZG93IHJlc2V0cyBzbyBhIGNhbGxlciBjYW4gc3VyZmFjZSBhIGNvb2xkb3duLlxuICpcbiAqIEluLW1lbW9yeSBpcyBpbnRlbnRpb25hbCBhbmQgc3VmZmljaWVudCBmb3IgYSBzaW5nbGUtYXBwLWluc3RhbmNlIGdhdGU6IGFuXG4gKiBhcHAgYmVoaW5kIGEgcG9ydHIgdHVubmVsIHNlcnZlcyBmcm9tIG9uZSBwcm9jZXNzLiBJdCBpcyBOT1QgYSBkaXN0cmlidXRlZFxuICogbGltaXRlcjsgYSBtdWx0aS1yZXBsaWNhIGRlcGxveW1lbnQgd291bGQgbmVlZCBzaGFyZWQgc3RhdGUuIEVudHJpZXMgYXJlXG4gKiBwcnVuZWQgbGF6aWx5IG9uIGFjY2Vzcywgc28gYW4gaWRsZSBrZXkgY29zdHMgbm90aGluZyBhZnRlciBpdHMgd2luZG93LlxuICpcbiAqIEBtb2R1bGVcbiAqL1xuXG5pbnRlcmZhY2UgV2luZG93IHtcbiAgY291bnQ6IG51bWJlcjtcbiAgcmVzZXRBdDogbnVtYmVyO1xufVxuXG4vKiogQSBmaXhlZC13aW5kb3cgcmF0ZSBsaW1pdGVyIG92ZXIgc3RyaW5nIGtleXMuICovXG5leHBvcnQgY2xhc3MgUmF0ZUxpbWl0ZXIge1xuICBwcml2YXRlIHJlYWRvbmx5IHdpbmRvd3MgPSBuZXcgTWFwPHN0cmluZywgV2luZG93PigpO1xuXG4gIGNvbnN0cnVjdG9yKFxuICAgIHByaXZhdGUgcmVhZG9ubHkgbWF4OiBudW1iZXIsXG4gICAgcHJpdmF0ZSByZWFkb25seSB3aW5kb3dNczogbnVtYmVyLFxuICApIHt9XG5cbiAgLyoqXG4gICAqIFJlY29yZCBhIGhpdCBmb3IgYGtleWAuIFJldHVybnMgYHsgYWxsb3dlZCB9YCwgcGx1cyBgcmV0cnlBZnRlcmAgKHNlY29uZHMpXG4gICAqIHdoZW4gdGhlIGxpbWl0IGlzIGV4Y2VlZGVkLiBBIGxpbWl0IG9mIGA8PSAwYCBkaXNhYmxlcyBsaW1pdGluZyAoYWx3YXlzXG4gICAqIGFsbG93ZWQpLCB3aGljaCBsZXRzIGEgY29uZmlnIHR1cm4gaXQgb2ZmIHdpdGhvdXQgc3BlY2lhbC1jYXNpbmcgY2FsbGVycy5cbiAgICovXG4gIGhpdChrZXk6IHN0cmluZywgbm93OiBudW1iZXIgPSBEYXRlLm5vdygpKTogeyBhbGxvd2VkOiBib29sZWFuOyByZXRyeUFmdGVyPzogbnVtYmVyIH0ge1xuICAgIGlmICh0aGlzLm1heCA8PSAwKSByZXR1cm4geyBhbGxvd2VkOiB0cnVlIH07XG4gICAgY29uc3QgZXhpc3RpbmcgPSB0aGlzLndpbmRvd3MuZ2V0KGtleSk7XG4gICAgaWYgKCFleGlzdGluZyB8fCBub3cgPj0gZXhpc3RpbmcucmVzZXRBdCkge1xuICAgICAgdGhpcy53aW5kb3dzLnNldChrZXksIHsgY291bnQ6IDEsIHJlc2V0QXQ6IG5vdyArIHRoaXMud2luZG93TXMgfSk7XG4gICAgICByZXR1cm4geyBhbGxvd2VkOiB0cnVlIH07XG4gICAgfVxuICAgIGlmIChleGlzdGluZy5jb3VudCA8IHRoaXMubWF4KSB7XG4gICAgICBleGlzdGluZy5jb3VudCArPSAxO1xuICAgICAgcmV0dXJuIHsgYWxsb3dlZDogdHJ1ZSB9O1xuICAgIH1cbiAgICByZXR1cm4geyBhbGxvd2VkOiBmYWxzZSwgcmV0cnlBZnRlcjogTWF0aC5jZWlsKChleGlzdGluZy5yZXNldEF0IC0gbm93KSAvIDEwMDApIH07XG4gIH1cblxuICAvKiogRm9yZ2V0IGEga2V5IChlLmcuIGNsZWFyIGEgY2FsbGVyJ3Mgd2luZG93IGFmdGVyIGEgc3VjY2Vzc2Z1bCB2ZXJpZnkpLiAqL1xuICByZXNldChrZXk6IHN0cmluZyk6IHZvaWQge1xuICAgIHRoaXMud2luZG93cy5kZWxldGUoa2V5KTtcbiAgfVxuXG4gIC8qKiBEcm9wIGV2ZXJ5IHdpbmRvdyAodGVzdHMpLiAqL1xuICBjbGVhcigpOiB2b2lkIHtcbiAgICB0aGlzLndpbmRvd3MuY2xlYXIoKTtcbiAgfVxufVxuIl19
@@ -1,88 +0,0 @@
1
- /**
2
- * Unified access allow-list matching for the email-OTP gate.
3
- *
4
- * Each pattern in the configured list is one of three shapes, tried in order:
5
- *
6
- * - **domain shortcut** - `databricks.com` or `@databricks.com`: matches any
7
- * address whose domain equals it (case-insensitive). The leading `@` is
8
- * optional and stripped.
9
- * - **glob** - contains `*` or `?`, e.g. `*.databricks.com` or
10
- * `*@databricks.com`: matched against the WHOLE address with shell-style
11
- * wildcards (`*` = any run, `?` = one char).
12
- * - **regex** - wrapped in slashes, `/.../ [flags]`: compiled and tested
13
- * against the whole address. An invalid regex never matches (it is skipped
14
- * with a warning rather than throwing).
15
- *
16
- * An EMPTY list matches nobody (fail closed): an app that enables the gate but
17
- * configures no patterns lets no one in, which is the safe default.
18
- *
19
- * @module
20
- */
21
-
22
- import { log } from "@dbx-tools/shared-core";
23
-
24
- const logger = log.logger("email:auth:allowlist");
25
-
26
- /** Escape a string for literal use inside a `RegExp`. */
27
- function escapeRegExp(value: string): string {
28
- return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
29
- }
30
-
31
- /** Compile a shell-style glob (`*`, `?`) into an anchored, case-insensitive RegExp. */
32
- function globToRegExp(glob: string): RegExp {
33
- const body = glob
34
- .split(/([*?])/)
35
- .map((part) => (part === "*" ? ".*" : part === "?" ? "." : escapeRegExp(part)))
36
- .join("");
37
- return new RegExp(`^${body}$`, "i");
38
- }
39
-
40
- /** Parse a `/pattern/flags` string into a RegExp, or `undefined` if malformed. */
41
- function parseRegexLiteral(pattern: string): RegExp | undefined {
42
- const match = /^\/(.+)\/([a-z]*)$/is.exec(pattern);
43
- if (!match) return undefined;
44
- try {
45
- const flags = match[2]!.includes("i") ? match[2]! : `${match[2]!}i`;
46
- return new RegExp(match[1]!, flags);
47
- } catch (error) {
48
- logger.warn("ignoring invalid regex allow-list pattern", { pattern, error });
49
- return undefined;
50
- }
51
- }
52
-
53
- /** True when `email` matches a single allow-list `pattern`. */
54
- function matchesPattern(email: string, pattern: string): boolean {
55
- const trimmed = pattern.trim();
56
- if (!trimmed) return false;
57
- const address = email.trim().toLowerCase();
58
-
59
- // Regex literal: /.../
60
- if (trimmed.startsWith("/")) {
61
- const re = parseRegexLiteral(trimmed);
62
- return re ? re.test(address) : false;
63
- }
64
-
65
- // Glob: contains a wildcard.
66
- if (trimmed.includes("*") || trimmed.includes("?")) {
67
- return globToRegExp(trimmed).test(address);
68
- }
69
-
70
- // Domain shortcut: `@d.com` or `d.com` -> match the address's domain.
71
- const domain = trimmed.replace(/^@/, "").toLowerCase();
72
- const at = address.lastIndexOf("@");
73
- return at >= 0 && address.slice(at + 1) === domain;
74
- }
75
-
76
- /**
77
- * True when `email` is allowed by ANY pattern in `patterns`. An empty (or
78
- * missing) list allows nobody - the gate fails closed.
79
- */
80
- export function matchesAllowlist(email: string, patterns: readonly string[] | undefined): boolean {
81
- if (!email || !patterns || patterns.length === 0) return false;
82
- return patterns.some((pattern) => matchesPattern(email, pattern));
83
- }
84
-
85
- /** Rough shape check so a clearly-invalid address is rejected before any work. */
86
- export function looksLikeEmail(value: string): boolean {
87
- return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value.trim());
88
- }
package/src/auth/gate.ts DELETED
@@ -1,172 +0,0 @@
1
- /**
2
- * The email-OTP access gate: runtime + Express middleware + request handlers.
3
- *
4
- * {@link AuthGate} owns the allow-list, rate limiters, code store, and session
5
- * signing. The plugin wires four routes to it (`request`/`verify`/`logout`/
6
- * `status`) and mounts {@link AuthGate.middleware} so every OTHER request needs a
7
- * valid session cookie.
8
- *
9
- * Design points:
10
- * - `request` ALWAYS resolves `{ ok: true }` (anti-enumeration): a code is only
11
- * generated + emailed when the address is allow-listed AND under the rate
12
- * limit, but the caller can't tell the difference.
13
- * - the session lives in an HttpOnly + SameSite=Lax cookie (Secure in prod), so
14
- * it survives reloads and is not readable by page scripts.
15
- * - fail-open on a missing signing secret (see `otp.ts`): a Databricks App is
16
- * already access-limited; an unset `AUTH_JWT_SECRET` degrades to
17
- * non-durable sessions, not a lockout.
18
- *
19
- * @module
20
- */
21
-
22
- import type { CookieOptions, NextFunction, Request, Response } from "express";
23
- import { http, log } from "@dbx-tools/shared-core";
24
- import type { AuthStatus } from "@dbx-tools/shared-email";
25
- import { looksLikeEmail, matchesAllowlist } from "./allowlist.ts";
26
- import { CodeStore, signSession, verifySession } from "./otp.ts";
27
- import { RateLimiter } from "./rate-limit.ts";
28
-
29
- const logger = log.logger("email:auth");
30
-
31
- /** Cookie the session JWT rides in. */
32
- export const SESSION_COOKIE = "dbx_auth";
33
-
34
- /** Route prefix (under the plugin base `/api/email`) the gate leaves open. */
35
- const AUTH_PATH_PREFIX = "/auth";
36
-
37
- /** Resolved gate configuration. */
38
- export interface AuthGateOptions {
39
- /** Allow-list patterns (domain / glob / `/regex/`). Empty = allow nobody. */
40
- readonly allow: readonly string[];
41
- /** Session lifetime in seconds. */
42
- readonly sessionTtlSeconds: number;
43
- /** One-time code lifetime in seconds. */
44
- readonly codeTtlSeconds: number;
45
- /** Max verify attempts per issued code. */
46
- readonly maxAttempts: number;
47
- /** Send the code email. Returns nothing; failures are logged, not surfaced. */
48
- readonly sendCode: (email: string, code: string) => Promise<void>;
49
- /** True in production (sets the `Secure` cookie flag). */
50
- readonly secureCookies: boolean;
51
- }
52
-
53
- /** The email-OTP gate for one app. */
54
- export class AuthGate {
55
- private readonly codes: CodeStore;
56
- // Separate limiters: requesting a code is cheap-to-abuse (email spam), verifying
57
- // is a brute-force surface. Per-email AND per-IP so neither axis alone is a bypass.
58
- private readonly requestLimiter = new RateLimiter(5, 15 * 60 * 1000);
59
- private readonly verifyLimiter = new RateLimiter(10, 15 * 60 * 1000);
60
-
61
- constructor(private readonly options: AuthGateOptions) {
62
- this.codes = new CodeStore(options.codeTtlSeconds * 1000, options.maxAttempts);
63
- }
64
-
65
- /**
66
- * Handle `POST /auth/request`. Always resolves `{ ok: true }` (plus a
67
- * `retryAfter` when rate-limited); a code is issued + emailed only for an
68
- * allow-listed address under the limit. Errors in sending are swallowed so the
69
- * response never reveals whether an address exists / is allowed.
70
- */
71
- async handleRequest(email: string, ip: string): Promise<{ ok: true; retryAfter?: number }> {
72
- const address = email.trim().toLowerCase();
73
- const byIp = this.requestLimiter.hit(`ip:${ip}`);
74
- const byEmail = this.requestLimiter.hit(`email:${address}`);
75
- if (!byIp.allowed || !byEmail.allowed) {
76
- return { ok: true, retryAfter: byIp.retryAfter ?? byEmail.retryAfter };
77
- }
78
- if (looksLikeEmail(address) && matchesAllowlist(address, this.options.allow)) {
79
- const code = this.codes.issue(address);
80
- try {
81
- await this.options.sendCode(address, code);
82
- } catch (error) {
83
- logger.warn("failed to send OTP email", { error });
84
- }
85
- }
86
- return { ok: true };
87
- }
88
-
89
- /**
90
- * Handle `POST /auth/verify`. On a correct code, returns the session `token`
91
- * plus the `cookieOptions` for it so the route sets it with Express's own
92
- * `res.cookie(SESSION_COOKIE, token, options)` (no hand-rolled Set-Cookie).
93
- * Failures return `{ ok: false }` with a generic reason.
94
- */
95
- async handleVerify(
96
- email: string,
97
- code: string,
98
- ip: string,
99
- secure: boolean,
100
- ): Promise<{ ok: boolean; token?: string; cookieOptions?: CookieOptions; retryAfter?: number }> {
101
- const address = email.trim().toLowerCase();
102
- const byIp = this.verifyLimiter.hit(`ip:${ip}`);
103
- const byEmail = this.verifyLimiter.hit(`email:${address}`);
104
- if (!byIp.allowed || !byEmail.allowed) {
105
- return { ok: false, retryAfter: byIp.retryAfter ?? byEmail.retryAfter };
106
- }
107
- if (this.codes.verify(address, code.trim()) !== "ok") return { ok: false };
108
- // Correct code: clear the caller's request/verify budget and mint a session.
109
- this.requestLimiter.reset(`email:${address}`);
110
- this.verifyLimiter.reset(`email:${address}`);
111
- const token = await signSession(address, this.options.sessionTtlSeconds);
112
- return { ok: true, token, cookieOptions: this.cookieOptions(secure) };
113
- }
114
-
115
- /** Express cookie options for the session (used with `res.cookie`/`res.clearCookie`). */
116
- cookieOptions(secure: boolean): CookieOptions {
117
- return {
118
- httpOnly: true,
119
- sameSite: "lax",
120
- secure: secure || this.options.secureCookies,
121
- path: "/",
122
- maxAge: this.options.sessionTtlSeconds * 1000,
123
- };
124
- }
125
-
126
- /** Resolve the authenticated email for a request, or `undefined`. */
127
- async authenticate(req: Request): Promise<string | undefined> {
128
- // Reuse shared-core's cookie parser (accepts an Express req directly) rather
129
- // than re-implementing header splitting here.
130
- const token = http.parseCookies(req)[SESSION_COOKIE];
131
- return verifySession(token);
132
- }
133
-
134
- /** The `GET /auth/status` payload for a request. */
135
- async status(req: Request): Promise<AuthStatus> {
136
- const email = await this.authenticate(req);
137
- return { authenticated: Boolean(email), email, enabled: true };
138
- }
139
-
140
- /**
141
- * Express middleware gating the app's DATA APIs behind a session.
142
- *
143
- * It gates `/api/*` and returns 401 for an unauthenticated caller - EXCEPT the
144
- * login flow itself (`<emailBase>/auth/*`), which must stay open so a caller
145
- * can obtain a session. Static assets (the SPA shell, JS/CSS, favicons) are
146
- * NOT gated: the browser has to load the client so the `<AuthGate>` React
147
- * component can render the login screen and call these endpoints. A gated
148
- * `/api` request from the un-logged-in SPA simply 401s, which the client
149
- * treats as "show the login". This is the standard SPA gate shape - protect
150
- * the data, serve the shell.
151
- *
152
- * `emailBase` is the email plugin's mount path (e.g. `/api/email`), so both the
153
- * open login prefix and the gated API prefix are matched on the full path.
154
- */
155
- middleware(emailBase: string): (req: Request, res: Response, next: NextFunction) => void {
156
- const openPrefix = `${emailBase}${AUTH_PATH_PREFIX}`;
157
- return (req, res, next) => {
158
- // Only API traffic is gated; static assets load freely so the login UI can.
159
- if (!req.path.startsWith("/api/") || req.path.startsWith(openPrefix)) {
160
- next();
161
- return;
162
- }
163
- void this.authenticate(req).then((email) => {
164
- if (email) {
165
- next();
166
- } else {
167
- res.status(401).json({ error: "authentication required", loginPath: openPrefix });
168
- }
169
- });
170
- };
171
- }
172
- }
package/src/auth/otp.ts DELETED
@@ -1,151 +0,0 @@
1
- /**
2
- * One-time-code store + session JWT for the email-OTP gate.
3
- *
4
- * Two pieces:
5
- *
6
- * - **Code store** - a 6-digit code is generated with `crypto.randomInt` and
7
- * kept server-side as a SHA-256 hash with an expiry and an attempt counter
8
- * (never the plaintext, never in the JWT). `verifyCode` is constant-time on
9
- * the hash, enforces the TTL, and burns the code after too many attempts or
10
- * one success. In-memory `Map` keyed by lowercased email - fine for a
11
- * single-instance app behind a tunnel.
12
- * - **Session JWT** - on a correct code, `signSession` mints a short-lived
13
- * HS256 JWT (via `jose`) carrying only the email; `verifySession` validates
14
- * it. The signing key comes from `AUTH_JWT_SECRET`; when unset the gate
15
- * FAILS OPEN with an ephemeral per-process key (sessions reset on restart)
16
- * rather than refusing service - a Databricks App is already access-limited,
17
- * so an unset secret degrades to "sessions don't survive restarts", not
18
- * "nobody can log in".
19
- *
20
- * @module
21
- */
22
-
23
- import { createHash, randomBytes, randomInt, timingSafeEqual } from "node:crypto";
24
- import { jwtVerify, SignJWT } from "jose";
25
- import { log } from "@dbx-tools/shared-core";
26
-
27
- const logger = log.logger("email:auth:otp");
28
-
29
- /** JWT issuer/audience so a token minted for this gate isn't accepted elsewhere. */
30
- const JWT_AUD = "dbx-tools-email-auth";
31
-
32
- /** SHA-256 hex of a value (for the stored code + a stable key comparison). */
33
- function sha256(value: string): string {
34
- return createHash("sha256").update(value).digest("hex");
35
- }
36
-
37
- /** Constant-time compare of two hex digests of equal length. */
38
- function safeEqualHex(a: string, b: string): boolean {
39
- if (a.length !== b.length) return false;
40
- return timingSafeEqual(Buffer.from(a, "hex"), Buffer.from(b, "hex"));
41
- }
42
-
43
- interface CodeEntry {
44
- hash: string;
45
- expiresAt: number;
46
- attempts: number;
47
- }
48
-
49
- /** Result of {@link CodeStore.verify}. */
50
- export type VerifyOutcome = "ok" | "invalid" | "expired" | "too-many-attempts";
51
-
52
- /** In-memory store of pending one-time codes, keyed by lowercased email. */
53
- export class CodeStore {
54
- private readonly codes = new Map<string, CodeEntry>();
55
-
56
- constructor(
57
- private readonly ttlMs: number,
58
- private readonly maxAttempts: number,
59
- ) {}
60
-
61
- /**
62
- * Generate, store (hashed), and RETURN a fresh 6-digit code for `email`. The
63
- * caller emails the returned plaintext; only the hash is retained. Replaces
64
- * any pending code for the address.
65
- */
66
- issue(email: string, now: number = Date.now()): string {
67
- const code = String(randomInt(0, 1_000_000)).padStart(6, "0");
68
- this.codes.set(email.toLowerCase(), {
69
- hash: sha256(code),
70
- expiresAt: now + this.ttlMs,
71
- attempts: 0,
72
- });
73
- return code;
74
- }
75
-
76
- /**
77
- * Check `code` for `email`. Consumes the entry on success or when attempts are
78
- * exhausted, so a code is single-use and can't be brute-forced past the cap.
79
- */
80
- verify(email: string, code: string, now: number = Date.now()): VerifyOutcome {
81
- const key = email.toLowerCase();
82
- const entry = this.codes.get(key);
83
- if (!entry) return "invalid";
84
- if (now >= entry.expiresAt) {
85
- this.codes.delete(key);
86
- return "expired";
87
- }
88
- entry.attempts += 1;
89
- if (safeEqualHex(entry.hash, sha256(code))) {
90
- this.codes.delete(key);
91
- return "ok";
92
- }
93
- if (entry.attempts >= this.maxAttempts) {
94
- this.codes.delete(key);
95
- return "too-many-attempts";
96
- }
97
- return "invalid";
98
- }
99
-
100
- /** Drop every pending code (tests). */
101
- clear(): void {
102
- this.codes.clear();
103
- }
104
- }
105
-
106
- /**
107
- * Resolve the HS256 signing key. Prefers `AUTH_JWT_SECRET`; when unset, mints an
108
- * ephemeral per-process key (fail-open) and warns once. Memoized so every
109
- * sign/verify in a process shares one key.
110
- */
111
- let cachedKey: Uint8Array | undefined;
112
- function signingKey(): Uint8Array {
113
- if (cachedKey) return cachedKey;
114
- const secret = process.env.AUTH_JWT_SECRET?.trim();
115
- if (secret) {
116
- cachedKey = new TextEncoder().encode(secret);
117
- } else {
118
- logger.warn(
119
- "AUTH_JWT_SECRET is not set - using an ephemeral per-process key; sessions will not survive a restart",
120
- );
121
- cachedKey = randomBytes(32);
122
- }
123
- return cachedKey;
124
- }
125
-
126
- /** Reset the memoized key (tests, or after changing the env in-process). */
127
- export function resetSigningKey(): void {
128
- cachedKey = undefined;
129
- }
130
-
131
- /** Mint a short-lived session JWT for `email`, expiring in `ttlSeconds`. */
132
- export async function signSession(email: string, ttlSeconds: number): Promise<string> {
133
- return new SignJWT({ email })
134
- .setProtectedHeader({ alg: "HS256" })
135
- .setSubject(email)
136
- .setAudience(JWT_AUD)
137
- .setIssuedAt()
138
- .setExpirationTime(`${ttlSeconds}s`)
139
- .sign(signingKey());
140
- }
141
-
142
- /** Validate a session JWT, returning the email it was minted for, or `undefined`. */
143
- export async function verifySession(token: string | undefined): Promise<string | undefined> {
144
- if (!token) return undefined;
145
- try {
146
- const { payload } = await jwtVerify(token, signingKey(), { audience: JWT_AUD });
147
- return typeof payload.email === "string" ? payload.email : undefined;
148
- } catch {
149
- return undefined;
150
- }
151
- }