@farm.js/auth0 0.1.61 → 0.1.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -26,8 +26,44 @@ export interface Auth0IntegrationInput {
26
26
  audience?: string;
27
27
  scopes?: string[];
28
28
  tokenEndpointAuthMethod?: "auto" | "client_secret_basic" | "client_secret_post" | "none";
29
+ /**
30
+ * Session cookie name. A `__Host-` name (`__Host-farm_auth0_session`) cannot be set or
31
+ * shadowed by a sibling subdomain; Farm adds the `Secure` and `Path=/` it requires.
32
+ * @default "farm_auth0_session"
33
+ */
34
+ cookieName?: string;
35
+ /**
36
+ * Login state cookie name, held between the redirect to Auth0 and the callback.
37
+ * @default "farm_auth0_state"
38
+ */
39
+ stateCookieName?: string;
40
+ /**
41
+ * Longest a sign-in lasts, in seconds, when shorter than the Auth0 token lifetime. The session
42
+ * is a signed cookie, not a server record, so sign-out cannot invalidate a copy of it: a short
43
+ * max age bounds how long a copied cookie stays usable.
44
+ * @default the token's `expires_in`
45
+ */
46
+ sessionMaxAge?: number;
47
+ /**
48
+ * Called for every session Farm reads (profile route, protected routes). Return `true` to treat
49
+ * it as signed out, for example after `onSignOut` recorded its `sessionId` in your store.
50
+ * Sessions issued before this option existed have no `sessionId`.
51
+ */
52
+ isSessionRevoked?(session: Auth0Session, request: Request): boolean | Promise<boolean>;
53
+ /** Called on sign-out with the session being ended, so the app can revoke its `sessionId`. */
54
+ onSignOut?(session: Auth0Session, request: Request): void | Promise<void>;
29
55
  log?: FarmIntegrationLogger;
30
56
  }
57
+ /** A signed-in Auth0 session as Farm stores it in the session cookie. */
58
+ export interface Auth0Session {
59
+ user: Record<string, unknown>;
60
+ /** Epoch milliseconds after which the session is no longer accepted. */
61
+ expiresAt: number;
62
+ /** Random id of this sign-in; absent on sessions issued by older Farm releases. */
63
+ sessionId?: string;
64
+ /** Epoch milliseconds the session was issued; absent on older sessions. */
65
+ issuedAt?: number;
66
+ }
31
67
  interface ResolvedAuth0Env {
32
68
  domain: string;
33
69
  clientId: string;
@@ -88,7 +124,7 @@ export declare function auth0(input?: Auth0IntegrationInput): import("@farm.js/c
88
124
  routes: import("@farm.js/core").FarmTypedIntegrationRoute<string, never, any, unknown, false, "GET", import("@farm.js/core").FarmSchema | undefined>[];
89
125
  middleware: {
90
126
  matcher: string[];
91
- handler(request: Request): Response | undefined;
127
+ handler(request: Request): Promise<Response | undefined>;
92
128
  }[];
93
129
  }, import("@farm.js/core").FarmSchema | undefined>;
94
130
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAuC,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAgChG,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC;IACzE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,uBAAuB,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,MAAM,CAAC;IACzF,GAAG,CAAC,EAAE,qBAAqB,CAAC;CAC7B;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA6PD,wBAAgB,KAAK,CAAC,KAAK,GAAE,qBAA0B;;;;;;;yBAU5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAsSH,OAAO;;mDAmBrC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAuC,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AA+BhG,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC;IACzE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,uBAAuB,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,MAAM,CAAC;IACzF;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvF,8FAA8F;IAC9F,SAAS,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,GAAG,CAAC,EAAE,qBAAqB,CAAC;CAC7B;AAED,yEAAyE;AACzE,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA6RD,wBAAgB,KAAK,CAAC,KAAK,GAAE,qBAA0B;;;;;;;yBAU5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAoVG,OAAO;;mDAmB3C"}
package/dist/index.js CHANGED
@@ -2,13 +2,13 @@ import { createHash, createHmac, randomBytes, timingSafeEqual } from "node:crypt
2
2
  import { defineIntegration, integrationRoute } from "@farm.js/core";
3
3
  import { describeIntegrationOriginRejection, resolveIntegrationAllowedOrigins, validateIntegrationRequestOrigin, } from "@farm.js/core/integrations";
4
4
  import { clearRequestCookie, createPathInferredClientApi, createDocumentNavigationMatchers, createRequestCookie, getOrigin, getReturnTo, integrationConfig, normalizeMatchers, parseCookieHeaderMap, resolveCallbackSettings, } from "@farm.js/integration-utils";
5
+ import { resolveDevelopmentSecret } from "@farm.js/integration-utils/dev-secret";
5
6
  import { auth0Client } from "./client.js";
6
- const DEV_SECRET = "farmjs-auth0-development-secret-2026";
7
7
  // The built server re-evaluates farm.config.ts at runtime to instantiate
8
8
  // integrations, and Farm does not force NODE_ENV=production into that process.
9
9
  // Treating an absent NODE_ENV as "development" would silently sign production
10
- // sessions with the public DEV_SECRET, so only an explicit dev/test value may
11
- // use it. `farm dev` runs through Vite, which sets NODE_ENV="development".
10
+ // sessions with a development secret, so only an explicit dev/test value may
11
+ // use one. `farm dev` runs through Vite, which sets NODE_ENV="development".
12
12
  function isExplicitDevelopmentEnv() {
13
13
  return process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test";
14
14
  }
@@ -34,13 +34,15 @@ function resolveEnv(input) {
34
34
  const domain = normalizeDomain(input.domain ?? process.env.AUTH0_DOMAIN ?? "");
35
35
  const clientId = input.clientId ?? process.env.AUTH0_CLIENT_ID ?? "";
36
36
  const clientSecret = input.clientSecret ?? process.env.AUTH0_CLIENT_SECRET ?? "";
37
- const secret = input.secret ?? process.env.AUTH0_SECRET ?? (isExplicitDevelopmentEnv() ? DEV_SECRET : "");
37
+ const secret = input.secret ??
38
+ process.env.AUTH0_SECRET ??
39
+ (isExplicitDevelopmentEnv() ? resolveDevelopmentSecret("auth0") : "");
38
40
  const appBaseUrl = input.appBaseUrl ?? process.env.APP_BASE_URL ?? undefined;
39
41
  if (!domain || !clientId) {
40
42
  throw new Error("Auth0 integration requires AUTH0_DOMAIN and AUTH0_CLIENT_ID.");
41
43
  }
42
44
  if (!secret) {
43
- throw new Error("Auth0 integration requires AUTH0_SECRET. A development-only fallback secret is used " +
45
+ throw new Error("Auth0 integration requires AUTH0_SECRET. A generated development-only secret is used " +
44
46
  'only when NODE_ENV is "development" or "test"; set AUTH0_SECRET to a random 32-byte ' +
45
47
  "value in every other environment.");
46
48
  }
@@ -58,12 +60,14 @@ function createCodeVerifier() {
58
60
  function createCodeChallenge(verifier) {
59
61
  return createHash("sha256").update(verifier).digest("base64url");
60
62
  }
61
- function signValue(value, secret) {
63
+ function signPayload(payload, secret, purpose) {
64
+ return createHmac("sha256", secret).update(`farm-auth0:${purpose}.${payload}`).digest("hex");
65
+ }
66
+ function signValue(value, secret, purpose) {
62
67
  const payload = Buffer.from(JSON.stringify(value), "utf8").toString("base64url");
63
- const signature = createHmac("sha256", secret).update(payload).digest("hex");
64
- return `${payload}.${signature}`;
68
+ return `${payload}.${signPayload(payload, secret, purpose)}`;
65
69
  }
66
- function unsignValue(signed, secret) {
70
+ function unsignValue(signed, secret, purpose) {
67
71
  if (!signed) {
68
72
  return null;
69
73
  }
@@ -73,11 +77,13 @@ function unsignValue(signed, secret) {
73
77
  }
74
78
  const payload = signed.slice(0, separator);
75
79
  const signature = signed.slice(separator + 1);
76
- const expected = createHmac("sha256", secret).update(payload).digest("hex");
77
- if (signature.length !== expected.length) {
78
- return null;
79
- }
80
- if (!timingSafeEqual(Buffer.from(signature, "utf8"), Buffer.from(expected, "utf8"))) {
80
+ const expected = signPayload(payload, secret, purpose);
81
+ // Compare byte lengths: a multibyte signature can match the hex digest's
82
+ // character count, and timingSafeEqual throws on unequal buffers.
83
+ const signatureBytes = Buffer.from(signature, "utf8");
84
+ const expectedBytes = Buffer.from(expected, "utf8");
85
+ if (signatureBytes.length !== expectedBytes.length ||
86
+ !timingSafeEqual(signatureBytes, expectedBytes)) {
81
87
  return null;
82
88
  }
83
89
  try {
@@ -104,8 +110,14 @@ function decodeJwtPayload(token) {
104
110
  }
105
111
  function getSession(request, cookieName, secret) {
106
112
  const cookies = parseCookieHeaderMap(request.headers.get("cookie"));
107
- const session = unsignValue(cookies[cookieName], secret);
108
- if (!session) {
113
+ const session = unsignValue(cookies[cookieName], secret, "session");
114
+ if (!session ||
115
+ typeof session !== "object" ||
116
+ typeof session.expiresAt !== "number" ||
117
+ !Number.isFinite(session.expiresAt) ||
118
+ !session.user ||
119
+ typeof session.user !== "object" ||
120
+ Array.isArray(session.user)) {
109
121
  return null;
110
122
  }
111
123
  if (session.expiresAt <= Date.now()) {
@@ -172,6 +184,15 @@ async function exchangeCode(domain, clientId, clientSecret, code, redirectUri, c
172
184
  }
173
185
  throw new Error(lastFailure);
174
186
  }
187
+ function resolveCookieName(value, fallback, option) {
188
+ if (value === undefined)
189
+ return fallback;
190
+ // RFC 6265 token: no separators, whitespace, or control characters.
191
+ if (!/^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/.test(value)) {
192
+ throw new Error(`Auth0 integration ${option} must be a valid cookie name, got ${JSON.stringify(value)}.`);
193
+ }
194
+ return value;
195
+ }
175
196
  export function auth0(input = {}) {
176
197
  if (input.instance) {
177
198
  return defineIntegration({
@@ -197,8 +218,30 @@ export function auth0(input = {}) {
197
218
  const profilePath = input.profilePath ?? "/auth/profile";
198
219
  const scopes = input.scopes?.length ? input.scopes : ["openid", "profile", "email"];
199
220
  const allowedOrigins = resolveIntegrationAllowedOrigins(input.allowedOrigins, "auth0.allowedOrigins");
200
- const stateCookieName = "farm_auth0_state";
201
- const sessionCookieName = "farm_auth0_session";
221
+ const stateCookieName = resolveCookieName(input.stateCookieName, "farm_auth0_state", "stateCookieName");
222
+ const sessionCookieName = resolveCookieName(input.cookieName, "farm_auth0_session", "cookieName");
223
+ if (stateCookieName === sessionCookieName) {
224
+ throw new Error("Auth0 integration cookieName and stateCookieName must differ.");
225
+ }
226
+ const sessionMaxAge = input.sessionMaxAge;
227
+ if (sessionMaxAge !== undefined &&
228
+ (typeof sessionMaxAge !== "number" || !Number.isFinite(sessionMaxAge) || sessionMaxAge < 60)) {
229
+ throw new Error("Auth0 integration sessionMaxAge must be a number of seconds, at least 60.");
230
+ }
231
+ /** The session cookie, unless it expired, outlived `sessionMaxAge`, or the app revoked it. */
232
+ async function readSession(request) {
233
+ const session = getSession(request, sessionCookieName, secret);
234
+ if (!session)
235
+ return null;
236
+ if (sessionMaxAge !== undefined &&
237
+ typeof session.issuedAt === "number" &&
238
+ session.issuedAt + sessionMaxAge * 1000 <= Date.now()) {
239
+ return null;
240
+ }
241
+ if (input.isSessionRevoked && (await input.isSessionRevoked(session, request)))
242
+ return null;
243
+ return session;
244
+ }
202
245
  const callbackSettings = resolveCallbackSettings({
203
246
  callbackUrl: input.callbackUrl,
204
247
  callbackPath: input.callbackPath,
@@ -228,7 +271,7 @@ export function auth0(input = {}) {
228
271
  authorizeUrl.searchParams.set("screen_hint", screenHint);
229
272
  }
230
273
  const headers = new Headers();
231
- headers.append("set-cookie", createRequestCookie(stateCookieName, signValue({ state, returnTo, codeVerifier }, secret), request, { maxAge: 600 }));
274
+ headers.append("set-cookie", createRequestCookie(stateCookieName, signValue({ state, returnTo, codeVerifier }, secret, "state"), request, { maxAge: 600 }));
232
275
  return {
233
276
  redirectTo: authorizeUrl.toString(),
234
277
  headers,
@@ -320,7 +363,7 @@ export function auth0(input = {}) {
320
363
  return new Response("Missing Auth0 authorization code or state.", { status: 400 });
321
364
  }
322
365
  const cookies = parseCookieHeaderMap(request.headers.get("cookie"));
323
- const statePayload = unsignValue(cookies[stateCookieName], secret);
366
+ const statePayload = unsignValue(cookies[stateCookieName], secret, "state");
324
367
  if (!statePayload || statePayload.state !== state) {
325
368
  return new Response("Invalid Auth0 state.", { status: 400 });
326
369
  }
@@ -328,10 +371,16 @@ export function auth0(input = {}) {
328
371
  const redirectUri = callbackSettings.getCallbackUrl(request);
329
372
  const tokenResponse = await exchangeCode(domain, clientId, clientSecret, code, redirectUri, statePayload.codeVerifier, input.tokenEndpointAuthMethod);
330
373
  const user = await createUserProfile(domain, tokenResponse.access_token, tokenResponse.id_token);
331
- const expiresAt = Date.now() + Math.max(tokenResponse.expires_in || 3600, 60) * 1000;
374
+ const issuedAt = Date.now();
375
+ const tokenLifetime = Math.max(tokenResponse.expires_in || 3600, 60);
376
+ const sessionLifetime = Math.min(tokenLifetime, sessionMaxAge ?? tokenLifetime);
377
+ const expiresAt = issuedAt + sessionLifetime * 1000;
378
+ const sessionId = randomBytes(16).toString("hex");
332
379
  const headers = new Headers();
333
- headers.append("set-cookie", createRequestCookie(sessionCookieName, signValue({ user, expiresAt }, secret), request, {
334
- maxAge: Math.max((expiresAt - Date.now()) / 1000, 60),
380
+ headers.append("set-cookie", createRequestCookie(sessionCookieName, signValue({ user, expiresAt, sessionId, issuedAt }, secret, "session"), request, {
381
+ // The lifetime itself, not expiresAt minus a later clock read, so the
382
+ // cookie's Max-Age is exact and never a second short.
383
+ maxAge: sessionLifetime,
335
384
  }));
336
385
  headers.append("set-cookie", clearRequestCookie(stateCookieName, request));
337
386
  headers.set("location", new URL(statePayload.returnTo || "/dashboard", origin).toString());
@@ -344,7 +393,7 @@ export function auth0(input = {}) {
344
393
  }),
345
394
  integrationRoute.get(logoutPath, {
346
395
  responseFormat: "json",
347
- handler(request) {
396
+ async handler(request) {
348
397
  // Sign-out is a GET, so it is also reachable as a plain link or a
349
398
  // bookmark with no origin metadata at all. Only a request the browser
350
399
  // labelled cross-site is refused.
@@ -366,6 +415,9 @@ export function auth0(input = {}) {
366
415
  const redirectTo = new URL("/v2/logout", `https://${domain}`);
367
416
  redirectTo.searchParams.set("client_id", clientId);
368
417
  redirectTo.searchParams.set("returnTo", origin);
418
+ const endedSession = getSession(request, sessionCookieName, secret);
419
+ if (endedSession)
420
+ await input.onSignOut?.(endedSession, request);
369
421
  const headers = new Headers();
370
422
  headers.append("set-cookie", clearRequestCookie(sessionCookieName, request));
371
423
  if (request.headers.get("x-farm-integration-client") === "1") {
@@ -385,8 +437,8 @@ export function auth0(input = {}) {
385
437
  }),
386
438
  integrationRoute.get(profilePath, {
387
439
  responseFormat: "json",
388
- handler(request) {
389
- const session = getSession(request, sessionCookieName, secret);
440
+ async handler(request) {
441
+ const session = await readSession(request);
390
442
  if (!session) {
391
443
  return Response.json({
392
444
  authenticated: false,
@@ -403,8 +455,8 @@ export function auth0(input = {}) {
403
455
  ? [
404
456
  {
405
457
  matcher: protectedMatchers,
406
- handler(request) {
407
- const session = getSession(request, sessionCookieName, secret);
458
+ async handler(request) {
459
+ const session = await readSession(request);
408
460
  if (session) {
409
461
  return;
410
462
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farm.js/auth0",
3
- "version": "0.1.61",
3
+ "version": "0.1.62",
4
4
  "description": "Auth0 integration for Farm.js",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -29,8 +29,8 @@
29
29
  "access": "public"
30
30
  },
31
31
  "dependencies": {
32
- "@farm.js/integration-utils": "0.1.61",
33
- "@farm.js/core": "0.1.61"
32
+ "@farm.js/core": "0.1.62",
33
+ "@farm.js/integration-utils": "0.1.62"
34
34
  },
35
35
  "scripts": {
36
36
  "build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc",