Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BackendStack21/keycloak-backend
Keycloak Node.js minimalist connector for backend services integration.
https://github.com/BackendStack21/keycloak-backend
Last synced: 14 days ago
JSON representation
Keycloak Node.js minimalist connector for backend services integration.
- Host: GitHub
- URL: https://github.com/BackendStack21/keycloak-backend
- Owner: BackendStack21
- License: mit
- Created: 2017-06-24T14:39:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T21:11:47.000Z (about 1 year ago)
- Last Synced: 2024-05-20T03:19:47.111Z (6 months ago)
- Language: TypeScript
- Size: 129 KB
- Stars: 70
- Watchers: 2
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- cuban-opensource - keycloak-backend
README
# keycloak-backend
[](https://www.npmjs.com/package/keycloak-backend)
[](https://www.npmjs.com/package/keycloak-backend)
[](https://www.npmjs.com/package/keycloak-backend)
[](https://www.npmjs.com/package/keycloak-backend)
[](https://github.com/BackendStack21/keycloak-backend.git)
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
```js
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": "[email protected]",
"password": "passw0rd",
"is_legacy_endpoint": false
})
```
> The `is_legacy_endpoint` configuration property should be TRUE for older Keycloak versions (under 18)
For TypeScript:
```ts
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": "[email protected]",
"password": "passw0rd",
"is_legacy_endpoint": false
})
```
### Generating access tokens
```js
const accessToken = await keycloak.accessToken.get()
```
Or:
```js
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:
```js
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:
```js
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