keycloak koa oauth jsonWebToken
npm install @pixelygroup/keycloak-koa-connect
$ npm i @pixelygroup/keycloak-koa-connect --save
Instructions
Because the library is implemented with Typescript, if you directly import (require) in nodejs using ES syntax, you will get no value, thus you need to import it's .default attributeIn root folder create a
file with your configuration and init-keycloak.js.
$3
`
// keycloak.jsmodule.exports = {
'realm': '', // realm
'auth-server-url': '', // keycloak URL: http://127.0.0.1:8080/auth
'ssl-required': 'external',
'resource': '', // client ID
'bearer-only': true,
'credentials': {
'secret': 'if-enabled client-secret ,then-need-to-fill-in-here secret'
},
'use-resource-role-mappings': true,
'confidential-port': 0,
'realm-public-key': ''
}
$3
// init-keycloak.jsconst KeycloakConnect = require('@pixelygroup/keycloak-koa-connect').default
const bodyStore = require('@pixelygroup/keycloak-koa-connect/stores/body-store').default // If this option is used, it is legal to include the value of jwt in the body
const queryStore = require('@pixelygroup/keycloak-koa-connect/stores/query-store').default // If this option is used, it is also legal to pass a token at http://a.com?jwt=token
const Keycloak = require('./keycloak.js')
const keycloak = new KeycloakConnect({ store: [queryStore, bodyStore,]}, Keycloak)
module.exports = { keycloak }
Then in:
$3
// index.jsconst Koa = require('koa');
const app = new Koa();
const { keycloak } = require('./init-keycloak.js')
keycloak.middleware()
.map(item => {
app.use(item)
})
app.listen(3000);
$3
// index.ts
import * as Koa from 'koa';
const app = new Koa();const { keycloak } = require('./init-keycloak.js')
keycloak.middleware()
.map(item => {
app.use(item)
})
app.listen(3000)
Notes
If you define your routes in , you need to import init-keycloack.js there as well$3
`
// routes/index.jsconst Router = require('koa-router')
const router = new Router()
const { keycloak } = require('../init-keycloak.js')
// ## To secure a resource with an application role for the current app:
router.get( '/special', keycloak.protect('special'), specialHandler )
// ## To secure a resource with an application role for a different app:
router.get( '/extra-special', keycloak.protect('other-app:special'), extraSpecialHandler )
// ## To secure a resource with a realm role:
router.get( '/admin', keycloak.protect( 'realm:admin' ), adminHandler )