keycloak-connect-roles

keycloak-roles-connect

Connect-like middleware for authorization and roles management.
This module can be easily extended to handler any kind of JWT roles specification by client. However the base config and implementation takes in consideration the keyclock:Oauth2 generated roles in the JWT.

This middleware does NOT verify JWT tokens, it is intended to be use for services that stand behind an api-gateway or proxy that handles the JWT token verification.

Basic Usage

const { middleware, protect } = require('keycloak-connect-roles').init()
app.use(middleware)
 
// middleware based role check
app.get('/admin', protect('sys-admin'), (req, res) => {
    ...
})
 
// middleware based roles check for the client
app.get('/profile', protect(['sys-admin', 'reviewer']), (req, res) => {
    ...
})
 
// middleware based role check for custom client
const clientId = 'yourclientid'
app.get('/admin', protect('role', clientId), (req, res) => {
    ...
})
 
// programmatic client role check
app.get('/admin', (req, res) => {
    if (!req.auth.isSysAdmin()) {
        // forbidden
    }
})
 
// programmatic custom client role check
app.get('/admin', (req, res) => {
    if (!req.auth.is('client', 'role')) {
        // forbidden
    }
})
 
// programmatic custom client roles check
app.get('/admin', (req, res) => {
    if (!req.auth.isOneOf('client', ['role1', 'role2'])) {
        // forbidden
    }
})

Setting up and extending the Auth class for custom use cases

//Adding custome roles for the application
const ROLES = {
  SYS_ADMIN: 'sys-admin',
  USER: 'user',
  REVIEWER: 'reviewer'
}
 
//Keycloack client id
const CLIENT_ID = 'client-app'
 
const KConnect = require('keycloak-connect-roles')
const { Auth } = KConnect
 
/**
 * Extending Auth class to add isReviewer method and overwriting
 * the default behavior of isSysAdmin.
*/
class CustomAuth extends Auth {
  isReviewer () {
    return this.is(KConnect.CLIENT_ID, KConnect.ROLES.REVIEWER)
  }
 
  isSysAdmin () {
    return this.is(KConnect.CLIENT_ID, KConnect.ROLES.SYS_ADMIN)
  }
}
 
module.exports = KConnect.init({ ROLES, CLIENT_ID, Auth: CustomAuth })
 

Checks Shortcuts

expect(req.auth.isSysAdmin()).toEqual(true)
expect(req.auth.isReviewer()).toEqual(false)