\n\n\nTable of content (click to expand)\n\n\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Learnings](#learnings)\n- [Contributing](#contributing)\n \n \n\n## Installation\n\nInstallation is as simple as running:\n\n`npm install @boyuai/nestjs-oauth2-server`\n\nor\n\n`yarn add @boyuai/nestjs-oauth2-server`.\n\n## Configuration\n\n1. Include the module as a dependency in the module where oauth will happen:\n\n`oauth2.module.ts`\n\n```ts\nimport { Module } from '@nestjs/common';\nimport { OAuth2ServerModule } from '@boyuai/nestjs-oauth2-server';\nimport { OAuth2Controller } from './oauth2.controller';\nimport { OAuth2ServiceModule } from './oauth2-service.module';\nimport { OAuth2Model } from './oauth2.model';\n\n@Module({\n imports: [\n OAuth2ServiceModule,\n OAuth2ServerModule.forRoot({\n imports: [OAuth2ServiceModule], // import your repository for OAuth2Model here\n modelClass: OAuth2Model,\n }),\n ],\n controllers: [OAuth2Controller],\n})\nexport class OAuth2Module {}\n```\n\nIn addition to the above the, **oauth2-server** requires a [model](https://oauth2-server.readthedocs.io/en/latest/model/overview.html) to create the server. This can be provided as a service from any part of the application. This should be able to fetch data about clients, users, token, and authorization codes. This **MUST** be a service decorated with the `Injectable` decorator.\n\n`oauth2.model.ts`\n\n```ts\nimport { Injectable } from '@nestjs/common';\n\n@Injectable()\nexport class OAuth2Model implements RequestAuthenticationModel {\n getAccessToken() {}\n\n verifyScope() {}\n // ...\n // check more codes in test/src/test-model.service.ts\n}\n```\n\n## Usage\n\nThe module also provides some nifty decorators to help with configuring the oauth2 handler endpoints. An example controller covering the entire array of decorators is given below\n\n`oauth2.controller.ts`\n\n```ts\nimport { Controller } from '@nestjs/common';\nimport {\n OAuth2Authorization,\n OAuth2Authorize,\n OAuth2RenewToken,\n OAuth2Token,\n} from '@boyuai/nestjs-oauth2-server';\n\n@Controller()\nexport class OAuth2Controller {\n @Post()\n @OAuth2Authenticate()\n authenticateClient(@OAuth2Token() token: Token) {\n return token;\n }\n\n @Post()\n @OAuth2Authorize()\n authorizeClient(\n @OAuth2Authorization()\n authorization: AuthorizationCode,\n ) {\n return authorization;\n }\n\n @Post()\n @OAuth2RenewToken()\n renewToken(@OAuth2Token() token: Token) {\n return token;\n }\n}\n```\n\n## Async Configuration\n\nThe module could also be included asynchronously using the `forRootAsync` method.\n\nExamples below:\n\n- Using factory provider approach\n\n```ts\nimport { Module } from '@nestjs/common';\nimport {\n OAuth2ServerModule,\n IOAuth2ServerModuleOptions,\n} from '@boyuai/nestjs-oauth2-server';\n\n@Module({\n imports: [\n // ... other modules\n OAuth2ServerModule.forRootAsync({\n useFactory: (factory: IOAuth2ServerOptionsFactory) => ({}),\n modelClass: YourModelService,\n }),\n ],\n})\nexport class YourModule {}\n```\n\n- Using class or existing provider approach:\n\n`oauth2-server-config.service.ts`\n\n```ts\nimport {\n IOAuth2ServerModuleOptions,\n IOAuth2ServerOptionsFactory,\n} from '@boyuai/nestjs-oauth2-server';\nimport { Injectable } from '@nestjs/common';\n\n@Injectable()\nexport class OAuth2ServerConfigService\n implements IOAuth2ServerOptionsFactory {\n createOAuth2ServerOptions(): IOAuth2ServerModuleOptions {\n return {};\n }\n}\n```\n\nThe `OAuth2ServerConfigService` **SHOULD** implement the `IOAuth2ServerOptionsFactory`, **MUST** declare the `createOAuth2ServerOptions` method and **MUST** return `IOAuth2ServerModuleOptions` object.\n\n```ts\nimport { Module } from '@nestjs/common';\nimport { OAuth2ServerModule } from '@boyuai/nestjs-oauth2-server';\nimport { OAuth2ServerConfigService } from './oauth2-server-config.service.ts';\n\n@Module({\n imports: [\n // ... other modules\n OAuth2ServerModule.forRootAsync({\n useClass: OAuth2ServerConfigService,\n modelClass: YourModelService,\n }),\n ],\n})\nexport class YourModule {}\n```\n\n## Learnings\n\nThe concept of OAuth2 can be further understood in this article [here](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2). Also you can head over to the oauth2-server package [documentation](package).\n\n## Contributing\n\nSuggestions for improvement are welcomed, however, please adhere to the [contributing](./CONTRIBUTING.md) guidelines.\n\n[package]: https://oauth2-server.readthedocs.io/en/latest/index.html\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n ![\"OAuth2](\"https://github.com/boyuai/nestjs-oauth2-server/blob/master/oauth2.png?raw=true\")
\n![\"npm\"](\"https://img.shields.io/npm/dm/@boyuai/nestjs-oauth2-server\")
![\"npm](\"https://img.shields.io/npm/v/@boyuai/nestjs-oauth2-server?label=NPM&logo=NPM\")
![\"LICENCE\"](\"https://img.shields.io/npm/l/@boyuai/nestjs-oauth2-server\")
![\"synk](\"https://img.shields.io/snyk/vulnerabilities/npm/@boyuai/nestjs-oauth2-server\")