@farm.js/auth0 0.1.34 → 0.1.35
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 +37 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +46 -9
- package/package.json +3 -3
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 {};
|
package/dist/index.d.ts.map
CHANGED
|
@@ -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;
|
|
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;;;;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;AA2RD,wBAAgB,KAAK,CAAC,KAAK,GAAE,qBAA0B;;;;;;;yBAU5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAkVG,OAAO;;mDAmB3C"}
|
package/dist/index.js
CHANGED
|
@@ -182,6 +182,15 @@ async function exchangeCode(domain, clientId, clientSecret, code, redirectUri, c
|
|
|
182
182
|
}
|
|
183
183
|
throw new Error(lastFailure);
|
|
184
184
|
}
|
|
185
|
+
function resolveCookieName(value, fallback, option) {
|
|
186
|
+
if (value === undefined)
|
|
187
|
+
return fallback;
|
|
188
|
+
// RFC 6265 token: no separators, whitespace, or control characters.
|
|
189
|
+
if (!/^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/.test(value)) {
|
|
190
|
+
throw new Error(`Auth0 integration ${option} must be a valid cookie name, got ${JSON.stringify(value)}.`);
|
|
191
|
+
}
|
|
192
|
+
return value;
|
|
193
|
+
}
|
|
185
194
|
export function auth0(input = {}) {
|
|
186
195
|
if (input.instance) {
|
|
187
196
|
return defineIntegration({
|
|
@@ -207,8 +216,30 @@ export function auth0(input = {}) {
|
|
|
207
216
|
const profilePath = input.profilePath ?? "/auth/profile";
|
|
208
217
|
const scopes = input.scopes?.length ? input.scopes : ["openid", "profile", "email"];
|
|
209
218
|
const allowedOrigins = resolveIntegrationAllowedOrigins(input.allowedOrigins, "auth0.allowedOrigins");
|
|
210
|
-
const stateCookieName = "farm_auth0_state";
|
|
211
|
-
const sessionCookieName = "farm_auth0_session";
|
|
219
|
+
const stateCookieName = resolveCookieName(input.stateCookieName, "farm_auth0_state", "stateCookieName");
|
|
220
|
+
const sessionCookieName = resolveCookieName(input.cookieName, "farm_auth0_session", "cookieName");
|
|
221
|
+
if (stateCookieName === sessionCookieName) {
|
|
222
|
+
throw new Error("Auth0 integration cookieName and stateCookieName must differ.");
|
|
223
|
+
}
|
|
224
|
+
const sessionMaxAge = input.sessionMaxAge;
|
|
225
|
+
if (sessionMaxAge !== undefined &&
|
|
226
|
+
(typeof sessionMaxAge !== "number" || !Number.isFinite(sessionMaxAge) || sessionMaxAge < 60)) {
|
|
227
|
+
throw new Error("Auth0 integration sessionMaxAge must be a number of seconds, at least 60.");
|
|
228
|
+
}
|
|
229
|
+
/** The session cookie, unless it expired, outlived `sessionMaxAge`, or the app revoked it. */
|
|
230
|
+
async function readSession(request) {
|
|
231
|
+
const session = getSession(request, sessionCookieName, secret);
|
|
232
|
+
if (!session)
|
|
233
|
+
return null;
|
|
234
|
+
if (sessionMaxAge !== undefined &&
|
|
235
|
+
typeof session.issuedAt === "number" &&
|
|
236
|
+
session.issuedAt + sessionMaxAge * 1000 <= Date.now()) {
|
|
237
|
+
return null;
|
|
238
|
+
}
|
|
239
|
+
if (input.isSessionRevoked && (await input.isSessionRevoked(session, request)))
|
|
240
|
+
return null;
|
|
241
|
+
return session;
|
|
242
|
+
}
|
|
212
243
|
const callbackSettings = resolveCallbackSettings({
|
|
213
244
|
callbackUrl: input.callbackUrl,
|
|
214
245
|
callbackPath: input.callbackPath,
|
|
@@ -338,9 +369,12 @@ export function auth0(input = {}) {
|
|
|
338
369
|
const redirectUri = callbackSettings.getCallbackUrl(request);
|
|
339
370
|
const tokenResponse = await exchangeCode(domain, clientId, clientSecret, code, redirectUri, statePayload.codeVerifier, input.tokenEndpointAuthMethod);
|
|
340
371
|
const user = await createUserProfile(domain, tokenResponse.access_token, tokenResponse.id_token);
|
|
341
|
-
const
|
|
372
|
+
const issuedAt = Date.now();
|
|
373
|
+
const tokenLifetime = Math.max(tokenResponse.expires_in || 3600, 60);
|
|
374
|
+
const expiresAt = issuedAt + Math.min(tokenLifetime, sessionMaxAge ?? tokenLifetime) * 1000;
|
|
375
|
+
const sessionId = randomBytes(16).toString("hex");
|
|
342
376
|
const headers = new Headers();
|
|
343
|
-
headers.append("set-cookie", createRequestCookie(sessionCookieName, signValue({ user, expiresAt }, secret, "session"), request, {
|
|
377
|
+
headers.append("set-cookie", createRequestCookie(sessionCookieName, signValue({ user, expiresAt, sessionId, issuedAt }, secret, "session"), request, {
|
|
344
378
|
maxAge: Math.max((expiresAt - Date.now()) / 1000, 60),
|
|
345
379
|
}));
|
|
346
380
|
headers.append("set-cookie", clearRequestCookie(stateCookieName, request));
|
|
@@ -354,7 +388,7 @@ export function auth0(input = {}) {
|
|
|
354
388
|
}),
|
|
355
389
|
integrationRoute.get(logoutPath, {
|
|
356
390
|
responseFormat: "json",
|
|
357
|
-
handler(request) {
|
|
391
|
+
async handler(request) {
|
|
358
392
|
// Sign-out is a GET, so it is also reachable as a plain link or a
|
|
359
393
|
// bookmark with no origin metadata at all. Only a request the browser
|
|
360
394
|
// labelled cross-site is refused.
|
|
@@ -376,6 +410,9 @@ export function auth0(input = {}) {
|
|
|
376
410
|
const redirectTo = new URL("/v2/logout", `https://${domain}`);
|
|
377
411
|
redirectTo.searchParams.set("client_id", clientId);
|
|
378
412
|
redirectTo.searchParams.set("returnTo", origin);
|
|
413
|
+
const endedSession = getSession(request, sessionCookieName, secret);
|
|
414
|
+
if (endedSession)
|
|
415
|
+
await input.onSignOut?.(endedSession, request);
|
|
379
416
|
const headers = new Headers();
|
|
380
417
|
headers.append("set-cookie", clearRequestCookie(sessionCookieName, request));
|
|
381
418
|
if (request.headers.get("x-farm-integration-client") === "1") {
|
|
@@ -395,8 +432,8 @@ export function auth0(input = {}) {
|
|
|
395
432
|
}),
|
|
396
433
|
integrationRoute.get(profilePath, {
|
|
397
434
|
responseFormat: "json",
|
|
398
|
-
handler(request) {
|
|
399
|
-
const session =
|
|
435
|
+
async handler(request) {
|
|
436
|
+
const session = await readSession(request);
|
|
400
437
|
if (!session) {
|
|
401
438
|
return Response.json({
|
|
402
439
|
authenticated: false,
|
|
@@ -413,8 +450,8 @@ export function auth0(input = {}) {
|
|
|
413
450
|
? [
|
|
414
451
|
{
|
|
415
452
|
matcher: protectedMatchers,
|
|
416
|
-
handler(request) {
|
|
417
|
-
const session =
|
|
453
|
+
async handler(request) {
|
|
454
|
+
const session = await readSession(request);
|
|
418
455
|
if (session) {
|
|
419
456
|
return;
|
|
420
457
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farm.js/auth0",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.35",
|
|
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/
|
|
33
|
-
"@farm.js/
|
|
32
|
+
"@farm.js/integration-utils": "0.1.35",
|
|
33
|
+
"@farm.js/core": "0.1.35"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc",
|