Skip to content

tomjackman/keypress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Keypress

Description

Keypress - Keycloak with Express.

This is a very experimental sample application to show how you can use Keycloak with Node.js/Express to provide Access Control in your Application. It has 2 main feature areas:

  • Auth/Access Control on Express routes using the Keycloak Node.js Adapter.
  • Server Administation using Node.js with the Keycloak Admin Client.

Technologies:

  • Node/Express
  • keycloak-connect
  • keycloak-admin-client
  • express-session
  • Pug
  • Bootstrap
  • Bluebird

Sample UI

alt text

Features

Currently the following UI functionality is implemented:

Users

  • Create
  • Read
  • Delete

Roles

  • Create
  • Read
  • Delete

Groups

  • Create
  • Read
  • Delete

Access Control

Access control for users with the Realm admin Role on the following routes:

  • /users
  • /groups
  • /roles

Requirements

You must have a running Keycloak instance.

Installation

Clone this repository. Run:

npm install

You must then login to Keycloak and Add the Provided Realm and Users.

  • Under the Realms section in Keycloak, add a new Realm with the Import option.
  • Import the keypress-realm.json file located in the /keycloak folder.
  • Once complete, visit the newly created realm and click the 'Import' button at the bottom left of the sidebar. You will import the users here. Choose the keypress-users-0.json file located in the /keycloak folder.

Then run the keypress application itself:

npm start

Visit http://localhost:3000/ in your browser.

The keypress-admin users password is admin.

How are the Roles, Groups and Users Configured?

  • TODO - Create a table with their configurations. Information can be seen in Keycloak anyway.

Bugs/Issues?

  • Open an Issue in GitHub and add a category label.

Bearer Example

For a bearer example, checkout the bearer_example branch that works with the Keyonic-v2 bearer_example branch. Also ensure that the following is set in your realm config "bearerOnly": true or simply set the client to be bearer-only in the admin console in Keycloak.

About

Keypress - Keycloak with Node & Express.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published