Skip to content
Condor middleware to authenticate GRPC calls using Keycloak.
JavaScript
Branch: master
Clone or download
Latest commit 9fdf3da May 8, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib implement introspection May 8, 2017
spec/support initial commit May 5, 2017
.editorconfig initial commit May 5, 2017
.eslintignore initial commit May 5, 2017
.eslintrc.json initial commit May 5, 2017
.gitignore initial commit May 5, 2017
.istanbul.yml initial commit May 5, 2017
.travis.yml initial commit May 5, 2017
LICENSE initial commit May 5, 2017
README.md fix typo May 8, 2017
index.js implement facade May 8, 2017
index.spec.js implement facade May 8, 2017
package.json add coveralls May 8, 2017

README.md

condor-jwt-keycloak

This module lets you authenticate GRPC calls using JSON Web Tokens (JWTs) created by Keycloak in your Condor GRPC services.

Build Status Coverage Status

Condor is a GRPC Framework for node.

Features

This module extends condor-jwt and offers additional features for integration with keycloak:

  • Handles public key rotation retrieval
  • Allows live token validation (using introspection)
  • Multi-tenancy support, by allowing multiple realms

Installation

npm i --save condor-framework condor-jwt-keycloak

How to use

The JWT middleware decodes and verifies a JsonWebToken passed in the authorization header. If the token is valid, context.token will be set with the JSON object decoded to be used by later middleware for authorization and access control. (See condor-authorize)

const Condor = require('condor-framework');
const jwt = require('condor-jwt-keycloak');
const Greeter = require('./greeter');

const options = {
  'url': 'http://localhost:8080/auth',
  'realm': 'master',
};

const app = new Condor()
  .addService('./protos/greeter.proto', 'myapp.Greeter', new Greeter())
  .use(jwt(options))
  // middleware below this line is only reached if JWT token is valid
  .use((context, next) => {
    console.log('valid token found: ', context.token);
    next();
  })
  .start();

Options

Allows all the options of the condor-jwt module. And also:

Option Description Default
url The authorization server URL. E.g. http://localhost:8080/auth. Required.
realm The realm name. E.g. master. Required unless allowAnyRealm is true.
allowAnyRealm Allow to authenticate against any realm in the authorization server. false
minTimeBetweenJwksRequests How many milliseconds should have elapsed before trying to get JWKs from keycloak again 10000
introspect Perform live validation using token introspection. false
clientId Client ID setup in keycloak. Required when introspect is true.
clientSecret Client secret (can be found in keycloak, under credentials tab). Required when introspect is true.

Additionaly, you can send any option of the verify method of the jsonwebtoken. Such options will be used to verify the token.

License and Credits

MIT License. Copyright 2017

Built by the GRPC experts at Devsu.

You can’t perform that action at this time.