An adapter for keycloak-nodejs-connect.
- Protect your resources using Keycloak's Authorization Services.
- Simply add
@Resource
and@Scopes
in your controllers and you're good to go. - Compatible with Fastify platform.
yarn add nest-keycloak-connect
npm install nest-keycloak-connect --save
Register the module in app.module.ts
import { Module } from '@nestjs/common';
import { KeycloakConnectModule, ResourceGuard, AuthGuard } from 'nest-keycloak-connect';
@Module({
imports: [KeycloakConnectModule.register({
authServerUrl: 'http://localhost:8080/auth',
realm: 'master',
clientId: 'my-nestjs-app',
secret: 'secret',
})],
providers: [
// These are in order, see https://docs.nestjs.com/guards#binding-guards
// for more information
// This adds a global level authentication guard, you can also have it scoped
// if you like.
//
// Will return a 401 unauthorized when it is unable to
// verify the JWT token or Bearer header is missing.
{
provide: APP_GUARD,
useClass: AuthGuard,
},
// This adds a global level resource guard, which is permissive.
// Only controllers annotated with @Resource and methods with @Scopes
// are handled by this guard.
{
provide: APP_GUARD,
useClass: ResourceGuard,
},
],
})
export class AppModule {}
In your controllers, simply do:
import { Resource, Scopes } from 'nest-keycloak-connect';
import { Controller, Get, Delete, Put, Post, Param } from '@nestjs/common';
import { Product } from './product';
import { ProductService } from './product.service';
@Controller()
@Resource(Product.name)
export class ProductController {
constructor(private service: ProductService) {}
@Get()
@Scopes('View', 'View All')
async findAll() {
return await this.service.findAll();
}
@Get(':code')
@Scopes('View')
async findByCode(@Param('code') code: string) {
return await this.service.findByCode(code);
}
@Post()
@Scopes('Create')
async create(@Body product: Product) {
return await this.service.create(product);
}
@Delete(':code')
@Scopes('Delete')
async deleteByCode(@Param('code') code: string) {
return await this.service.deleteByCode(code);
}
@Put(':code')
@Scopes('Edit')
async update(@Param('code') code: string, @Body product: Product) {
return await this.service.update(code, product);
}
}