@articulate/authentic

Proper validation of JWT's against JWK's.

Motivation

The process of validating JWT's against JWK's is quite involved, but at the end of the day, you probably have an auth server with a /.well-known/openid-configuration endpoint, and you just want to know if an incoming JWT is valid. End of story. You don't want to fumble with parsing the JWT, matching kid values, converting certs, or caching JWK's.

Now you don't need to. Initialize authentic with an issWhitelist, and you'll receive a function that accepts a JWT and validates it. The rest is handled for you.

Usage

authentic :: { k: v } -> String -> Promise Boom { k: v }

Initialize authentic with an options object containing an issWhitelist array listing the token.payload.iss values you will accept. For example:

Provider	Sample issWhitelist
Auth0	[ 'https://${tenant}.auth0.com/' ]
Okta	[ 'https://${tenant}.oktapreview.com/oauth2/${appName}' ]

Note: The urls in the list need to be exact matches of the payload.iss values in your JWT's.

You'll receive a unary function which takes a JWT and returns a Promise that resolves with the parsed JWT payload if it is valid, or rejects with a 401 Boom error if it is invalid.

// lib/authentic.js
import { authentic } from '@articulate/authentic'

export default authentic({
  issWhitelist: process.env.ISS_WHITELIST.split('|'),
})

// main.js
import authentic from './lib/authentic'

const handler = req =>
  authentic(req.cookies.token)
    .then(token => {
      /* the JWT has been validated */
    })
    .catch(/* invalid token */)

Options

authentic accepts a JSON object with the following options:

• jwks Object: options to forward to jose.createRemoteJWKSet from jose with the following defaults:

option	default
timeoutDuration	5000 (5 seconds)
cooldownDuration	30000 (30 seconds)
cacheMaxAge	60000 (10 minutes)

• verify Object: options to forward to jose.jwtVerify from jose
• issWhitelist Array: list of trusted OIDC issuers
• claimsInError Array: list of jwt payload claims to receive as the data property of the error when verification fails. When a list is not provided a data property will not be added to the error.

Contributing

Changes are tracked & published using changesets.

Adding a Changeset

1. Create a git branch. Make your desired changes.
2. Run yarn changesets. Follow the prompts & specify if your change is a major, minor, or patch change.
3. Add all the changes to .changesets & commit.
4. Create a Pull Request. Merge into the main branch when ready.

Publishing to NPM

Changesets will create a "Release" pull request whenever unpublished changesets are merged into main. When ready to publish to NPM, merge this pull request, and changes will be automatically published.