A progressive Node.js framework for building efficient and scalable server-side applications.
\n
\n\n\n\n\n\n\n \n \n
\n \n\n## Description\n\nJWT utilities module for [Nest](https://github.com/nestjs/nest) based on the [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) package.\n\n## Installation\n\n```bash\n$ npm i --save @nestjs/jwt\n```\n\n## Usage\n\nImport `JwtModule`:\n\n```typescript\n@Module({\n imports: [JwtModule.register({ secret: 'hard!to-guess_secret' })],\n providers: [...],\n})\nexport class AuthModule {}\n```\n\nInject `JwtService`:\n\n```typescript\n@Injectable()\nexport class AuthService {\n constructor(private readonly jwtService: JwtService) {}\n}\n```\n\n## Secret / Encryption Key options\n\nIf you want to control secret and key management dynamically you can use the `secretOrKeyProvider` function for that purpose. You also can use asynchronous version of `secretOrKeyProvider`.\nNOTE: For asynchronous version of `secretOrKeyProvider`, synchronous versions of `.sign()` and `.verify()` will throw an exception.\n\n```typescript\nJwtModule.register({\n /* Secret has precedence over keys */\n secret: 'hard!to-guess_secret',\n\n /* public key used in asymmetric algorithms (required if non other secrets present) */\n publicKey: '...',\n\n /* private key used in asymmetric algorithms (required if non other secrets present) */\n privateKey: '...',\n\n /* Dynamic key provider has precedence over static secret or pub/private keys */\n secretOrKeyProvider: (\n requestType: JwtSecretRequestType,\n tokenOrPayload: string | Object | Buffer,\n verifyOrSignOrOptions?: jwt.VerifyOptions | jwt.SignOptions\n ) => {\n switch (requestType) {\n case JwtSecretRequestType.SIGN:\n // retrieve signing key dynamically\n return 'privateKey';\n case JwtSecretRequestType.VERIFY:\n // retrieve public key for verification dynamically\n return 'publicKey';\n default:\n // retrieve secret dynamically\n return 'hard!to-guess_secret';\n }\n },\n});\n```\n\n## Async options\n\nQuite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use `registerAsync()` method, that provides a couple of various ways to deal with async data.\n\n**1. Use factory**\n\n```typescript\nJwtModule.registerAsync({\n useFactory: () => ({\n secret: 'hard!to-guess_secret'\n })\n});\n```\n\nObviously, our factory behaves like every other one (might be `async` and is able to inject dependencies through `inject`).\n\n```typescript\nJwtModule.registerAsync({\n imports: [ConfigModule],\n useFactory: async (configService: ConfigService) => ({\n secret: configService.get('SECRET'),\n }),\n inject: [ConfigService],\n}),\n```\n\n**2. Use class**\n\n```typescript\nJwtModule.registerAsync({\n useClass: JwtConfigService\n});\n```\n\nAbove construction will instantiate `JwtConfigService` inside `JwtModule` and will leverage it to create options object.\n\n```typescript\nclass JwtConfigService implements JwtOptionsFactory {\n createJwtOptions(): JwtModuleOptions {\n return {\n secret: 'hard!to-guess_secret'\n };\n }\n}\n```\n\n**3. Use existing**\n\n```typescript\nJwtModule.registerAsync({\n imports: [ConfigModule],\n useExisting: ConfigService,\n}),\n```\n\nIt works the same as `useClass` with one critical difference - `JwtModule` will lookup imported modules to reuse already created `ConfigService`, instead of instantiating it on its own.\n\n## API Spec\n\nThe `JwtService` uses [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) underneath.\n\n#### jwtService.sign(payload: string | Object | Buffer, options?: JwtSignOptions): string\n\nThe sign method is an implementation of jsonwebtoken `.sign()`. Differing from jsonwebtoken it also allows an additional `secret`, `privateKey`, and `publicKey` properties on `options` to override options passed in from the module. It only overrides the `secret`, `publicKey` or `privateKey` though not a `secretOrKeyProvider`.\nNOTE: Will throw an exception for asynchronous version of `secretOrKeyProvider`;\n\n#### jwtService.signAsync(payload: string | Object | Buffer, options?: JwtSignOptions): Promise\\\n\nThe asynchronous `.sign()` method.\n\n#### jwtService.verify\\(token: string, options?: JwtVerifyOptions): T\n\nThe verify method is an implementation of jsonwebtoken `.verify()`. Differing from jsonwebtoken it also allows an additional `secret`, `privateKey`, and `publicKey` properties on `options` to override options passed in from the module. It only overrides the `secret`, `publicKey` or `privateKey` though not a `secretOrKeyProvider`.\nNOTE: Will throw an exception for asynchronous version of `secretOrKeyProvider`;\n\n#### jwtService.verifyAsync\\(token: string, options?: JwtVerifyOptions): Promise\\\n\nThe asynchronous `.verify()` method.\n\n#### jwtService.decode(token: string, options: DecodeOptions): object | string\n\nThe decode method is an implementation of jsonwebtoken `.decode()`.\n\nThe `JwtModule` takes an `options` object:\n\n- `secret` is either a string, buffer, or object containing the secret for HMAC algorithms\n- `secretOrKeyProvider` function with the following signature `(requestType, tokenOrPayload, options?) => jwt.Secret | Promise` (allows generating either secrets or keys dynamically)\n- `signOptions` [read more](https://github.com/auth0/node-jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback)\n- `privateKey` PEM encoded private key for RSA and ECDSA with passphrase an object `{ key, passphrase }` [read more](https://github.com/auth0/node-jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback)\n- `publicKey` PEM encoded public key for RSA and ECDSA\n- `verifyOptions` [read more](https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback)\n- `secretOrPrivateKey` (DEPRECATED!) [read more](https://github.com/auth0/node-jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback)\n\nFor performance purposes, it is advised to pass instances of `KeyObject` to `secret`, `privateKey` and `publicKey` properties of this `options` object. These `KeyObject` can be generated with `createSecretKey()`, `createPrivateKey()` and `createPublicKey()` from Node.js `crypto` module. For example:\n\n```typescript\nimport { createSecretKey } from 'crypto';\n\nnew JwtService({\n secret: createSecretKey(Buffer.from('the secret key'))\n});\n```\n\n## Support\n\nNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).\n\n## Stay in touch\n\n- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)\n- Website - [https://nestjs.com](https://nestjs.com/)\n- Twitter - [@nestframework](https://twitter.com/nestframework)\n\n## License\n\nNest is [MIT licensed](LICENSE).","users":{}}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/@nestjs/core.svg\")
\n![\"Package](\"https://img.shields.io/npm/l/@nestjs/core.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/@nestjs/core.svg\")
\n![\"Discord\"/](\"https://img.shields.io/badge/discord-online-brightgreen.svg\"){kind=icon}
\n![\"Backers](\"https://opencollective.com/nest/backers/badge.svg\"){kind=icon}
\n![\"Sponsors](\"https://opencollective.com/nest/sponsors/badge.svg\"){kind=icon}
\n ![](\"https://img.shields.io/badge/Donate-PayPal-dc3d53.svg\"/){kind=icon}
\n ![](\"https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow\")
\n