keycloak-backend
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

keycloak-backend

NPM version NPM Total Downloads License TypeScript support Github stars

Keycloak Node.js minimalist connector for backend services integration. It aims to serve as base for high performance authorization middlewares.

In order to use this module, the used Keycloak client Direct Access Grants Enabled setting should be ON

Keycloak Introduction

The awesome open-source Identity and Access Management solution develop by RedHat. Keycloak support those very nice features you are looking for:

  • Single-Sign On
  • LDAP and Active Directory
  • Standard Protocols
  • Social Login
  • Clustering
  • Custom Themes
  • Centralized Management
  • Identity Brokering
  • Extensible
  • Adapters
  • High Performance
  • Password Policies

More about Keycloak: http://www.keycloak.org/

Using the keycloak-backend module

Configuration

const Keycloak = require('keycloak-backend').Keycloak
const keycloak = new Keycloak({
  "realm": "realm-name",
  "keycloak_base_url": "https://keycloak.example.org",
  "client_id": "super-secure-client",
  "username": "user@example.org",
  "password": "passw0rd",
  "is_legacy_endpoint": false
})

The is_legacy_endpoint configuration property should be TRUE for older Keycloak versions (under 18)

For TypeScript:

import { Keycloak } from "keycloak-backend"
const keycloak = new Keycloak({
  "realm": "realm-name",
  "keycloak_base_url": "https://keycloak.example.org",
  "client_id": "super-secure-client",
  "username": "user@example.org",
  "password": "passw0rd",
  "is_legacy_endpoint": false
})

Generating access tokens

const accessToken = await keycloak.accessToken.get()

Or:

request.get('http://service.example.org/api/endpoint', {
  'auth': {
    'bearer': await keycloak.accessToken.get()
  }
})

Validating access tokens

Online validation

This method requires online connection to the Keycloak service to validate the access token. It is highly secure since it also check for possible token invalidation. The disadvantage is that a request to the Keycloak service happens on every validation:

const token = await keycloak.jwt.verify(accessToken)
//console.log(token.isExpired())
//console.log(token.hasRealmRole('user'))
//console.log(token.hasApplicationRole('app-client-name', 'some-role'))

Offline validation

This method perform offline JWT verification against the access token using the Keycloak Realm public key. Performance is higher compared to the online method, as a disadvantage no access token invalidation on Keycloak server is checked:

const cert = fs.readFileSync('public_cert.pem')
const token = await keycloak.jwt.verifyOffline(accessToken, cert)
//console.log(token.isExpired())
//console.log(token.hasRealmRole('user'))
//console.log(token.hasApplicationRole('app-client-name', 'some-role'))

Breaking changes

v4

  • Codebase migrated from JavaScript to TypeScript. Many thanks to @neferin12

v3

  • The UserManager class was dropped
  • The auth-server-url config property was changed to keycloak_base_url
  • Most recent Keycloak API is supported by default, old versions are still supported through the is_legacy_endpoint config property

Package Sidebar

Install

npm i keycloak-backend

Weekly Downloads

3,412

Version

5.0.0

License

MIT

Unpacked Size

23.2 kB

Total Files

18

Last publish

Collaborators

  • jkyberneees