nestjs-keycloak-authorize v1.4.1

nestjs-keycloak-authorize

Description

NestJS package to authorize by role from Keycloak JWT (payload).

It is designed to work in Kubernetes cluster with Istio and Keycloak

JWT should be generated by Keycloak

Roles are expected to be in payload of token in

"realm_access": {
    "roles": [
      "ADMIN",
      "SYS"
    ]
  },

Decorators:

• for methods:
  • HasRole(roles)
    • e.g @HasRole('ADMIN', 'SYS')
  • IsPublic()
• for parameters
  • GetUser()
    • returns User object or throws UserNotFoundException

Installation

$ npm i nestjs-keycloak-authorize

NestJS module:

providers: [
    {
      provide: AUTHORIZATION_HEADER_NAME,
      useValue: 'x-authz'
    },
    {
      provide: APP_GUARD,
      useClass: RolesGuard,
    },
  ]

export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer): any {
    consumer.apply(AuthenticationMiddleware).forRoutes('*');
  }
}

Test

# unit tests
$ npm run test

# tests coverage
$ npm run test:cov