Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

oidc

0.6.4 • Public • Published

oidc

Middleware to enable OpenID Connect claims based authentication against an oidc provider (tested against Okta Preview). Includes middleware for both Express, Restify and socket.io.

Summary

This project basically came about as I wanted to make use of Json Web Tokens in a microservers architecture to pass around claims related to identity without constantly querying the OAuth server.

Key Features

  • Minimal configuration, automatic OpenID configuration discovery (/.well-known/openid-configuration)
  • Validation of JWTs against the Published Public Keys (jwks_uri) of the OpenID Connect provider

Limitations

  • Only supports RSA (RS256, RS384, RS512) signed JWT tokens at the moment
  • OIDC Provider public keys are cached once downloaded until the server restarts, as per the Okta OIDC spec, these change four times per year without warning
  • Only basic user information is returned at the moment, need to add the /userinfo extension
  • This code is so happy path it's not even funny

Authentication, not Authorisation

The purpose here is to prove to the microservices who you are, not what you can do. Subsequently; you'll need to think about AuthZ, and your implementation is going to be highly dependent on your architecture (each service might have it's own AuthZ? You might not need AuthZ because everyone can do everything if they're authenticated?).

Remember the JWT is just a signed set of claims, by one server, that another server trusts. For example:

"Hi Application Server, I want to access your resources and my username is bob, here is proof i am bob from Okta in the form of a JWT that's signed by Oktas private key"

Example

Use case

Your user is visiting a web page which aggregates information from multiple other microservices, each of those microservices however needs to know that you're authenticated, and who you are in order to provide the information back to you.

Components

  • Okta as an OpenID Connect provider
  • Application: Some web application
  • Microservice 1
  • Microservice 2

Sequence

The sequence looks like this: sequence

Note: Security Consideration: If a JWT is going to leave your network; it would be good practice to dereference it first. For example; if NGINX was in front of all of these services, it could handle the referencing of an incoming arbitary token to a JWT, which is then passed to the upstream.

The Code

Restify

let restify = require('restify');
let oidc = require('oidc');
 
let server = restify.createServer({
  name: 'Your super awesome application server',
  version: '0.1.0'
});
 
server.use(restify.acceptParser(server.acceptable));
server.use(restify.queryParser());
server.use(restify.bodyParser());
 
let auth = new oidc.Auth({
  oidcServer: 'https://youraccount.oktapreview.com',
  clientId: 'clientid-here',
  clientSecret: 'clientsecret-here',
  callbackURL: 'http://127.0.0.1:9000/auth/okta/callback',
  additionalScopes: ['address']
});
let middleware = new oidc.middleware.Restify(auth);
 
// Visiting this url, will redirect you to Okta for OAuth autentication
server.get(
  '/auth/okta',
  middleware.auth({
    redirectToOidc: true
  })
);
 
// This URL is called back from Okta
server.get(
  '/auth/okta/callback',
  middleware.auth(),
  (req, res, next) => {
    // Once we have a valid jwt; redirect to the profile page using it
    res.redirect('/profile?id_token=' + req.user.jwt.raw, next);
  }
);
 
// Protected resource expects the jwt to prove who they are to be passed
// in the query string as id_token=jwthash, not passing jwt here results 
// in a 401
server.get(
  '/profile',
  middleware.auth(),
  (req, res) => {
    res.send(req.user);
  }
);
 
server.listen(9000);

Express

To use express, just switch the middleware to 'middleware.Express', and if you want to use cookies to persist the session, add:

let cookieParser = require('cookie-parser');
app.use(cookieParser);

Socket.io

Something people always forget about are web sockets. Using this example; you can have a secure socket.io session too.

So here is your server:

const app = require('express')();
const http = require('http').Server(app);
const io = require('socket.io')(http);
const middleware = new oidc.middleware.SocketIO(auth);
io.set('authorization', middleware.auth);
io.on('connect', socket => {
  socket.on('something', () => {
    socket.emit('reply', 'to something');
  });
});
http.listen(3001, done);

And here is your client:

const socket = ioClient.connect('http://localhost:3001', {
  'reconnection delay': 0,
  'reopen delay': 0,
  'force new connection': true,
  query: 'id_token=anidtoken',
  transports: ['websocket']
});
socket.on('connect', () => {
  socket.on('reply', msg => {
    console.log('got the response');
  });
  socket.emit('something');
});

Install

npm i oidc

DownloadsWeekly Downloads

70

Version

0.6.4

License

Apache-2.0

Unpacked Size

155 kB

Total Files

29

Last publish

Collaborators

  • avatar
  • avatar