@maximemrf/adonisjs-jwt 0.7.0-alpha.1 → 0.7.0

package/README.md

@@ -116,6 +116,27 @@ 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.
 
+## 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.
@@ -199,16 +220,18 @@ router.post('login', async ({ request, auth }) => {
 })
 
 // if the jwt guard is the default guard
-router.get('/', async ({ auth }) => {
-  return auth.getUserOrFail()
-})
-.use(middleware.auth())
+router
+  .get('/', async ({ auth }) => {
+    return auth.getUserOrFail()
+  })
+  .use(middleware.auth())
 
 // if the jwt guard is not the default guard
-router.get('/', async ({ auth }) => {
-  return auth.use('jwt').getUserOrFail()
-})
-.use(middleware.auth({ guards: ['jwt'] }))
+router
+  .get('/', async ({ auth }) => {
+    return auth.use('jwt').getUserOrFail()
+  })
+  .use(middleware.auth({ guards: ['jwt'] }))
 
 // if you use the refresh token
 router.post('jwt/refresh', async ({ auth }) => {

package/build/src/define_config.d.ts

@@ -4,6 +4,7 @@ import { JwtGuardUser, JwtUserProviderContract } from './types.js';
 import { JwtGuard } from './jwt.js';
 import type { StringValue } from 'ms';
 import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
+import { Options } from 'jwks-rsa';
 export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
     provider: UserProvider;
     refreshTokenUserProvider?: AccessTokensUserProviderContract<unknown>;
@@ -15,4 +16,5 @@ export declare function jwtGuard<UserProvider extends JwtUserProviderContract<un
     refreshTokenAbilities?: string[];
     secret?: string;
     content: <T>(user: JwtGuardUser<T>) => Record<string | number, any>;
+    jwks?: Options;
 }): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;

package/build/src/define_config.js

@@ -13,6 +13,7 @@ export function jwtGuard(config) {
                 useCookiesForRefreshToken: config.useCookiesForRefreshToken,
                 refreshTokenAbilities: config.refreshTokenAbilities,
                 content: config.content,
+                jwks: config.jwks,
             };
             return (ctx) => new JwtGuard(ctx, config.provider, options);
         },

package/build/src/jwks.d.ts

@@ -0,0 +1,7 @@
+import { Options, JwksClient } from 'jwks-rsa';
+export declare class JwksManager {
+    private client;
+    constructor(options: Options);
+    getClient(): JwksClient;
+    getSigningKey(kid: string): Promise<string>;
+}

package/build/src/jwks.js

@@ -0,0 +1,14 @@
+import { JwksClient } from 'jwks-rsa';
+export class JwksManager {
+    client;
+    constructor(options) {
+        this.client = new JwksClient(options);
+    }
+    getClient() {
+        return this.client;
+    }
+    async getSigningKey(kid) {
+        const key = await this.client.getSigningKey(kid);
+        return key.getPublicKey();
+    }
+}

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;
@@ -8,6 +9,7 @@ export class JwtGuard {
     #options;
     #tokenName;
     #refreshTokenName = 'refreshToken';
+    #jwksManager;
     constructor(ctx, userProvider, option) {
         this.#ctx = ctx;
         this.#userProvider = userProvider;
@@ -16,6 +18,7 @@ export class JwtGuard {
         if (!this.#options.content)
             this.#options.content = (user) => ({ userId: user.getId() });
         this.#tokenName = this.#options.tokenName ?? 'token';
+        this.#jwksManager = this.#options.jwks ? new JwksManager(this.#options.jwks) : undefined;
     }
     /**
      * A unique name for the guard driver
@@ -39,6 +42,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
             ? {
@@ -126,14 +134,26 @@ export class JwtGuard {
          */
         let payload;
         try {
-            payload = jwt.verify(token, this.#options.secret);
+            if (this.#jwksManager) {
+                const decoded = jwt.decode(token, { complete: true });
+                if (!decoded || !decoded.header || !decoded.header.kid) {
+                    throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                        guardDriverName: this.driverName,
+                    });
+                }
+                const key = await this.#jwksManager.getSigningKey(decoded.header.kid);
+                payload = jwt.verify(token, key);
+            }
+            else {
+                payload = jwt.verify(token, this.#options.secret);
+            }
         }
-        catch (error) {
+        catch {
             throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
                 guardDriverName: this.driverName,
             });
         }
-        if (typeof payload !== 'object' || !('userId' in payload)) {
+        if (!payload || typeof payload !== 'object' || !('userId' in payload)) {
             throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
                 guardDriverName: this.driverName,
             });
@@ -154,6 +174,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,
@@ -264,7 +289,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

@@ -1,6 +1,7 @@
 import { symbols } from '@adonisjs/auth';
 import type { StringValue } from 'ms';
 import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
+import { Options } from 'jwks-rsa';
 /**
  * The bridge between the User provider and the
  * Guard
@@ -40,6 +41,7 @@ export type BaseJwtContent = {
 };
 export type JwtGuardOptions<RealUser extends any = unknown> = {
     secret: string;
+    jwks?: Options;
     refreshTokenUserProvider?: AccessTokensUserProviderContract<RealUser>;
     tokenName?: string;
     expiresIn?: number | StringValue;

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.1",
+  "version": "0.7.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -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": "^10.0.3",
+    "@swc/core": "^1.15.10",
     "@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.10",
+    "np": "^11.0.1",
+    "prettier": "^3.8.1",
     "sqlite3": "^5.1.7",
     "timekeeper": "^2.3.1",
     "ts-node-maintained": "^10.9.6",
@@ -61,6 +63,7 @@
   "dependencies": {
     "@types/jsonwebtoken": "^9.0.10",
     "jsonwebtoken": "^9.0.3",
+    "jwks-rsa": "^3.2.2",
     "ms": "^2.1.3"
   },
   "peerDependencies": {