jwt
This module contains functions and types to encode and decode JWTs issued and used by Auth.js.
The JWT issued by Auth.js is encrypted by default, using the A256GCM algorithm (JWE).
It uses the AUTH_SECRET environment variable to derive a sufficient encryption key.
Auth.js JWTs are meant to be used by the same app that issued them. If you need JWT authentication for your third-party API, you should rely on your Identity Provider instead.
Installation
- npm
- yarn
- pnpm
npm install @auth/core
yarn add @auth/core
pnpm add @auth/core
You can then import this submodule from @auth/core/jwt.
Usage
This module will be refactored/changed. We do not recommend relying on it right now.
Resources
decode()
decode<
Payload>(params):Promise<Payload|null>
Decodes a Auth.js issued JWT.
Type parameters
| Parameter | Default |
|---|---|
Payload | JWT |
Parameters
| Parameter | Type |
|---|---|
params | JWTDecodeParams |
Returns
Promise< Payload | null >
encode()
encode<
Payload>(params):Promise<string>
Issues a JWT. By default, the JWT is encrypted using "A256GCM".
Type parameters
| Parameter | Default |
|---|---|
Payload | JWT |
Parameters
| Parameter | Type |
|---|---|
params | JWTEncodeParams< Payload > |
Returns
Promise< string >
getToken()
getToken<
R>(params):Promise<Rextendstrue?string:JWT|null>
Takes an Auth.js request (req) and returns either the Auth.js issued JWT's payload,
or the raw JWT string. We look for the JWT in the either the cookies, or the Authorization header.
Documentation
Type parameters
| Parameter | Default |
|---|---|
R extends boolean | false |
Parameters
| Parameter | Type |
|---|---|
params | GetTokenParams< R > |
Returns
Promise< R extends true ? string : JWT | null >
JWT
Returned by the jwt callback and getToken, when using JWT sessions