We build your next generation software !

OAuth2 Server Module 

This module turns your NestJS Application into an OAuth2 Server. It is based on

* TypeORM: For entities and database model
* NestJS CQRS Module: For commands and queries
* Passport: For securing routes

Installation

``bash
npm install --save @switchit/nestjs-oauth2-server # or yarn install @switchit/nestjs-oauth2-server
`

Usage

$3

The UserValidatorInterface lets you validate a user using the PasswordGrantStrategy. It is queried in your application
to validate that the given username and password matches with a user in your application's DB.

IMPORTANT: When the user is not found your have to throw an InvalidUserException.

`typescript
import {Injectable} from "@nestjs/common";
import {UserValidatorInterface, UserInterface, InvalidUserException} from "@switchit/nestjs-oauth2-server";

@Injectable()
export class UserValidator implements UserValidatorInterface {
async validate(username, password): Promise {
// check if the user exists with the given username and password
// ...
// or
throw InvalidUserException.withUsernameAndPassword(username, password);
}
}
`

The validate method should return an instance of the UserInterface:

`typescript
export interface UserInterface {
id: string;
username: string;
email: string;
}
`

The user interface is then accessible in the payload once connected ot the AccessToken is used.

$3

The UserLoaderInterface lets you load a user from the database when the AccessToken is user specific.
The user is then accessible in the request context of your application.

IMPORTANT: When the user is not found your have to throw an InvalidUserException.

`typescript
import {Injectable} from "@nestjs/common";
import {UserLoaderInterface, UserInterface, InvalidUserException} from "@switchit/nestjs-oauth2-server";

@Injectable()
export class UserLoader implements UserLoaderInterface {
async load(userId: string): Promise {
// Load the user from the database
// ...
// or throw and
throw InvalidUserException.withId(userId);
}
}
`

$3

Import the OAuth2Module into the root AppModule.

`typescript
//app.module.ts
import { Module } from '@nestjs/common';
import { OAuth2Module } from '@switchit/nestjs-oauth2-server';

@Module({
imports: [
OAuth2Module.forRoot({
userLoader: new UserLoader(),
userValidator: new UserValidator(),
}),
],
})
export class AppModule {}
`

Of course you can use an async configuration:

`typescript
//app.module.ts
import { Module } from '@nestjs/common';
import { OAuth2Module } from '@switchit/nestjs-oauth2-server';

@Module({
imports: [
OAuth2Module.forRootAsync({
useFactory: () => ({
userLoader: new UserLoader(),
userValidator: new UserValidator(),
})
}),
],
})
export class AppModule {}
`

The OAuth2 Controller

The modules is shipped with a specific controller that lets you expose the oauth2/token endpoint in your application
and use the different implemented strategies accordingly to the request sent.

$3

Used for server-to-server communications.

`bash
curl -X POST http://localhost:3000/oauth2/token -d '{"grant_type":"client_credentials", "client_id":"6ab1cfab-0b3d-418b-8ca2-94d98663fb6f", "client_secret": "6nV9GGm1pu8OY0HDZ3Y7QsVnxtkb60wu", "scopes": ["app-1"]}'
`

$3

Used to refresh an existing token

`bash
curl -X POST http://localhost:3000/oauth2/token -d '{"grant_type":"refresh_token", "client_id":"6ab1cfab-0b3d-418b-8ca2-94d98663fb6f", "client_secret": "6nV9GGm1pu8OY0HDZ3Y7QsVnxtkb60wu", "refresh_token": "6nV9GGm1pu8OY0HDZ3Y7QsVnxtkb6fgqstyudhjqskdqsd"}'
`

$3

Used to refresh an existing token

`bash
curl -X POST http://localhost:3000/oauth2/token -d '{"grant_type":"password", "client_id":"6ab1cfab-0b3d-418b-8ca2-94d98663fb6f", "username": "j.doe@change.me", "password": "changeme", "scopes": ["app-1"]}'
`

Securing your routes using the AccessTokenStrategy

The module comes with a PassportJS strategy of type http-bearer. You can secure your routes using the passport
AuthGuard with the access-token strategy name:

`typescript
@Controller('oauth2-secured')
export class TestSecuredController {
@Get('me')
@UseGuards(AuthGuard('access-token'))
async auth(): Promise {
return {message: 'hello'};
}
}
`

Adding the entities to your TypeORM configuration

IMPORTANT: The module comes with entities you have to add the configuration node_modules/@switchit/*/.entity.js
to let typeorm scan your entities or add them to the entitie` configuration variable in TypeORM.