@farm.js/auth0 0.1.34 → 0.1.36

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;AAmRD,wBAAgB,KAAK,CAAC,KAAK,GAAE,qBAA0B;;;;;;;yBAU5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBA0SH,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
  }
@@ -182,6 +184,15 @@ async function exchangeCode(domain, clientId, clientSecret, code, redirectUri, c
182
184
  }
183
185
  throw new Error(lastFailure);
184
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
+ }
185
196
  export function auth0(input = {}) {
186
197
  if (input.instance) {
187
198
  return defineIntegration({
@@ -207,8 +218,30 @@ export function auth0(input = {}) {
207
218
  const profilePath = input.profilePath ?? "/auth/profile";
208
219
  const scopes = input.scopes?.length ? input.scopes : ["openid", "profile", "email"];
209
220
  const allowedOrigins = resolveIntegrationAllowedOrigins(input.allowedOrigins, "auth0.allowedOrigins");
210
- const stateCookieName = "farm_auth0_state";
211
- 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
+ }
212
245
  const callbackSettings = resolveCallbackSettings({
213
246
  callbackUrl: input.callbackUrl,
214
247
  callbackPath: input.callbackPath,
@@ -338,10 +371,16 @@ export function auth0(input = {}) {
338
371
  const redirectUri = callbackSettings.getCallbackUrl(request);
339
372
  const tokenResponse = await exchangeCode(domain, clientId, clientSecret, code, redirectUri, statePayload.codeVerifier, input.tokenEndpointAuthMethod);
340
373
  const user = await createUserProfile(domain, tokenResponse.access_token, tokenResponse.id_token);
341
- 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");
342
379
  const headers = new Headers();
343
- headers.append("set-cookie", createRequestCookie(sessionCookieName, signValue({ user, expiresAt }, secret, "session"), request, {
344
- 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,
345
384
  }));
346
385
  headers.append("set-cookie", clearRequestCookie(stateCookieName, request));
347
386
  headers.set("location", new URL(statePayload.returnTo || "/dashboard", origin).toString());
@@ -354,7 +393,7 @@ export function auth0(input = {}) {
354
393
  }),
355
394
  integrationRoute.get(logoutPath, {
356
395
  responseFormat: "json",
357
- handler(request) {
396
+ async handler(request) {
358
397
  // Sign-out is a GET, so it is also reachable as a plain link or a
359
398
  // bookmark with no origin metadata at all. Only a request the browser
360
399
  // labelled cross-site is refused.
@@ -376,6 +415,9 @@ export function auth0(input = {}) {
376
415
  const redirectTo = new URL("/v2/logout", `https://${domain}`);
377
416
  redirectTo.searchParams.set("client_id", clientId);
378
417
  redirectTo.searchParams.set("returnTo", origin);
418
+ const endedSession = getSession(request, sessionCookieName, secret);
419
+ if (endedSession)
420
+ await input.onSignOut?.(endedSession, request);
379
421
  const headers = new Headers();
380
422
  headers.append("set-cookie", clearRequestCookie(sessionCookieName, request));
381
423
  if (request.headers.get("x-farm-integration-client") === "1") {
@@ -395,8 +437,8 @@ export function auth0(input = {}) {
395
437
  }),
396
438
  integrationRoute.get(profilePath, {
397
439
  responseFormat: "json",
398
- handler(request) {
399
- const session = getSession(request, sessionCookieName, secret);
440
+ async handler(request) {
441
+ const session = await readSession(request);
400
442
  if (!session) {
401
443
  return Response.json({
402
444
  authenticated: false,
@@ -413,8 +455,8 @@ export function auth0(input = {}) {
413
455
  ? [
414
456
  {
415
457
  matcher: protectedMatchers,
416
- handler(request) {
417
- const session = getSession(request, sessionCookieName, secret);
458
+ async handler(request) {
459
+ const session = await readSession(request);
418
460
  if (session) {
419
461
  return;
420
462
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farm.js/auth0",
3
- "version": "0.1.34",
3
+ "version": "0.1.36",
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/core": "0.1.34",
33
- "@farm.js/integration-utils": "0.1.34"
32
+ "@farm.js/core": "0.1.36",
33
+ "@farm.js/integration-utils": "0.1.36"
34
34
  },
35
35
  "scripts": {
36
36
  "build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc",