@maximemrf/adonisjs-jwt 0.7.0-alpha.2 → 0.7.1

package/README.md

@@ -79,6 +79,11 @@ const authConfig = defineConfig({
       refreshTokenExpiresIn: '7d',
       // ability to separate cookie usage for refresh token
       useCookiesForRefreshToken: true,
+      // ability to configure the cookies options
+      cookie: {
+        httpOnly: true,
+        secure: true,
+      },
       // limit the abilities of the refresh token
       refreshTokenAbilities: ['refresh_token'],
       // content is a function that takes the user and returns the content of the token, it can be optional, by default it returns only the user id
@@ -116,6 +121,40 @@ useCookies: true
 
 If you just want to use jwt with the bearer token no need to set `useCookies` to `false` you can just remove it.
 
+You can also pass options to the cookies. Note that `maxAge` and `expires` are omitted from the options because they are automatically handled by the package based on the token validity (`tokenExpiresIn` and `refreshTokenExpiresIn`).
+By default, `httpOnly: true` and `secure: true` are enforced for better security, but you can override them using the `cookie` object configuration.
+
+```typescript
+cookie: {
+  httpOnly: true, // Default
+  secure: true,   // Default
+  path: '/',
+  sameSite: 'lax',
+  // maxAge and expires cannot be set here
+}
+```
+
+## JWKS
+
+You can use JWKS to verify the token by setting the `jwks` option in the guard configuration.
+
+```typescript
+// ...
+jwt: jwtGuard({
+  // ...
+  jwks: {
+    jwksUri: 'https://your-auth-server/.well-known/jwks.json',
+    // you can pass any options accepted by jwks-rsa package
+    cache: true,
+    rateLimit: true,
+  },
+}),
+// ...
+```
+
+> [!WARNING]
+> If you enable JWKS, you cannot use the `auth.use('jwt').generate(user)` and `auth.use('jwt').generateWithRefreshToken()` method because the token is signed by an external provider. You can only use the `authenticate` (or `check` / `getUserOrFail`) method to verify the token.
+
 ## Refresh Tokens
 
 To use refresh tokens, you have to set the `refreshTokenUserProvider` in the guard configuration, see the example above.

package/build/src/define_config.d.ts

@@ -1,6 +1,6 @@
 import { GuardConfigProvider } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
-import { JwtGuardUser, JwtUserProviderContract } from './types.js';
+import { JwtGuardUser, JwtUserProviderContract, JwtCookieOptions } from './types.js';
 import { JwtGuard } from './jwt.js';
 import type { StringValue } from 'ms';
 import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
@@ -17,4 +17,5 @@ export declare function jwtGuard<UserProvider extends JwtUserProviderContract<un
     secret?: string;
     content: <T>(user: JwtGuardUser<T>) => Record<string | number, any>;
     jwks?: Options;
+    cookie?: JwtCookieOptions;
 }): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;

package/build/src/define_config.js

@@ -1,5 +1,4 @@
 import { JwtGuard } from './jwt.js';
-import { JwksManager } from './jwks.js';
 export function jwtGuard(config) {
     return {
         async resolver(_, app) {
@@ -15,7 +14,7 @@ export function jwtGuard(config) {
                 refreshTokenAbilities: config.refreshTokenAbilities,
                 content: config.content,
                 jwks: config.jwks,
-                jwksClient: config.jwks ? new JwksManager(config.jwks).getClient() : undefined,
+                cookie: config.cookie,
             };
             return (ctx) => new JwtGuard(ctx, config.provider, options);
         },

package/build/src/jwt.js

@@ -1,6 +1,7 @@
 import { errors } from '@adonisjs/auth';
 import jwt from 'jsonwebtoken';
 import { Secret } from '@adonisjs/core/helpers';
+import { JwksManager } from './jwks.js';
 export class JwtGuard {
     #ctx;
     #userProvider;
@@ -9,6 +10,7 @@ export class JwtGuard {
     #tokenName;
     #refreshTokenName = 'refreshToken';
     #jwksManager;
+    #cookieOptions;
     constructor(ctx, userProvider, option) {
         this.#ctx = ctx;
         this.#userProvider = userProvider;
@@ -17,7 +19,12 @@ export class JwtGuard {
         if (!this.#options.content)
             this.#options.content = (user) => ({ userId: user.getId() });
         this.#tokenName = this.#options.tokenName ?? 'token';
-        this.#jwksManager = this.#options.jwksManager;
+        this.#jwksManager = this.#options.jwks ? new JwksManager(this.#options.jwks) : undefined;
+        this.#cookieOptions = {
+            httpOnly: true,
+            secure: true,
+            ...this.#options.cookie,
+        };
     }
     /**
      * A unique name for the guard driver
@@ -41,6 +48,11 @@ export class JwtGuard {
      * Generate a JWT token for a given user.
      */
     async generate(user) {
+        if (this.#options.jwks) {
+            throw new errors.E_UNAUTHORIZED_ACCESS("You can't use the auth.generate method with jwks", {
+                guardDriverName: this.driverName,
+            });
+        }
         const providerUser = await this.#userProvider.createUserForGuard(user);
         const token = jwt.sign(this.#options.content(providerUser), this.#options.secret, this.#options.expiresIn
             ? {
@@ -58,12 +70,14 @@ export class JwtGuard {
         }
         if (this.#options.useCookies) {
             this.#ctx.response.cookie(`${this.#tokenName}`, token, {
-                httpOnly: true,
+                ...this.#cookieOptions,
+                maxAge: this.#options.expiresIn,
             });
         }
         if (this.#options.useCookiesForRefreshToken && refreshToken) {
             this.#ctx.response.cookie(`${this.#refreshTokenName}`, refreshToken, {
-                httpOnly: true,
+                ...this.#cookieOptions,
+                maxAge: this.#options.refreshTokenExpiresIn,
             });
         }
         return {
@@ -88,17 +102,10 @@ export class JwtGuard {
             return this.getUserOrFail();
         }
         this.authenticationAttempted = true;
-        const cookieHeader = this.#ctx.request.request.headers.cookie;
-        let token;
         /**
-         * If cookies are enabled, then read the token from the cookies
+         * Try to read the token from the cookies.
          */
-        if (cookieHeader) {
-            const regex = new RegExp(`${this.#tokenName}=([^;]*)`);
-            token =
-                this.#ctx.request.cookie(`${this.#tokenName}`) ??
-                    (this.#ctx.request.request.headers.cookie.match(regex) || [])[1];
-        }
+        let token = this.#ctx.request.cookie(`${this.#tokenName}`);
         /**
          * If token is missing on cookies, then try to read it from the header authorization
          */
@@ -142,7 +149,7 @@ export class JwtGuard {
                 payload = jwt.verify(token, this.#options.secret);
             }
         }
-        catch (error) {
+        catch {
             throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
                 guardDriverName: this.driverName,
             });
@@ -168,6 +175,11 @@ export class JwtGuard {
     }
     async generateWithRefreshToken(refreshToken) {
         this.authenticationAttempted = true;
+        if (this.#options.jwks) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('JWKS is not supported for refresh token', {
+                guardDriverName: this.driverName,
+            });
+        }
         if (!this.#refreshTokenUserProvider) {
             throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
                 guardDriverName: this.driverName,
@@ -278,7 +290,7 @@ export class JwtGuard {
         const token = await this.generate(user);
         return {
             headers: {
-                authorization: `Bearer ${this.#options.useCookies ? token : token.token}`,
+                authorization: `Bearer ${token.token}`,
             },
         };
     }

package/build/src/types.d.ts

@@ -2,7 +2,8 @@ import { symbols } from '@adonisjs/auth';
 import type { StringValue } from 'ms';
 import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
 import { Options } from 'jwks-rsa';
-import { JwksManager } from './jwks.js';
+import type { CookieOptions } from '@adonisjs/core/types/http';
+export type JwtCookieOptions = Omit<Partial<CookieOptions>, 'maxAge' | 'expires'>;
 /**
  * The bridge between the User provider and the
  * Guard
@@ -43,7 +44,6 @@ export type BaseJwtContent = {
 export type JwtGuardOptions<RealUser extends any = unknown> = {
     secret: string;
     jwks?: Options;
-    jwksManager?: JwksManager;
     refreshTokenUserProvider?: AccessTokensUserProviderContract<RealUser>;
     tokenName?: string;
     expiresIn?: number | StringValue;
@@ -51,5 +51,6 @@ export type JwtGuardOptions<RealUser extends any = unknown> = {
     useCookies?: boolean;
     useCookiesForRefreshToken?: boolean;
     refreshTokenAbilities?: string[];
+    cookie?: JwtCookieOptions;
     content?: (user: JwtGuardUser<RealUser>) => Record<string, any>;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maximemrf/adonisjs-jwt",
   "description": "Adonisjs v6 package for authentication with jwt token",
-  "version": "0.7.0-alpha.2",
+  "version": "0.7.1",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -35,8 +35,8 @@
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/auth": "^9.5.1",
-    "@adonisjs/core": "^6.19.3",
+    "@adonisjs/auth": "^9.6.0",
+    "@adonisjs/core": "^6.20.0",
     "@adonisjs/eslint-config": "^2.1.2",
     "@adonisjs/lucid": "^21.8.2",
     "@adonisjs/prettier-config": "^1.4.5",
@@ -44,15 +44,17 @@
     "@japa/assert": "^4.2.0",
     "@japa/file-system": "^3.0.0",
     "@japa/runner": "^5.3.0",
-    "@swc/core": "^1.15.8",
+    "@types/nock": "^11.1.0",
+    "@swc/core": "^1.15.11",
     "@types/node": "^22.15.18",
     "c8": "^10.1.3",
     "copyfiles": "^2.4.1",
     "del-cli": "^7.0.0",
     "eslint": "^9.39.2",
     "luxon": "^3.7.2",
-    "np": "^10.3.0",
-    "prettier": "^3.8.0",
+    "nock": "^14.0.11",
+    "np": "^11.0.2",
+    "prettier": "^3.8.1",
     "sqlite3": "^5.1.7",
     "timekeeper": "^2.3.1",
     "ts-node-maintained": "^10.9.6",
@@ -98,4 +100,4 @@
       "tests/**"
     ]
   }
-}
+}