Code Monkey home page Code Monkey logo

condor-jwt-keycloak's Introduction

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.

condor-jwt-keycloak's People

Contributors

c3s4r avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

wearetheledger

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.