ethan-arrowood / fastify-jwt-authz

Verify authenticated user scope

Fastify JWT Authz

Created by Ethan Arrowood

fastifyJWTAuthz is a fastify plugin for verifying an authenticated request.user scope. Registering the plugin binds the jwtAuthz method to the fastify request instance. See the demo below on how to use the plugin.

const fastify = require('fastify')()
const jwt = require('fastify-jwt')
const jwtAuthz = require('fastify-jwt-authz')

fastify.register(jwt, {
  secret: 'superSecretCode'
})
fastify.register(jwtAuthz)

fastify.get('/api', {
  beforeHandler: [
    function(request, reply, done) {
      request.jwtVerify(done)
      /* The user's JWT auth token is
       * connected to the request object 
       * under `headers.authentication`.
       * 
       * The jwtVerify method will verify 
       * the JWT token with the secret.
       * 
       * If it verifies, the user object is 
       * populated onto the request object 
       * which is passed to the next function.
       * */
    }, 
    function(request, reply, done) {
      request.jwtAuthz(['read:data', 'write:data'], done)
      /* jwtAuthz will read the verified user's
       * scope off of the request object. It will 
       * then compare the scopes defined above to
       * the user's scopes aquired by the JWT verification
       * method.
       * */
    },
  ],
}, (request, reply) => {
  fastify.log.info('reached API endpoint')
  reply.send({ userVerified: true })
})

jwtAuthz takes a list of scopes for verification. Additionally, it takes an optional callback parameter. It returns a promise otherwise.

fastify-jwt-authz's Issues

Increase test coverage to 100%

Using node-tap increase the code coverage to 100% across all branches. Add the travis markdown widget to the README. This module will support Node.JS 4+.

Publish to npm

After documentation (#1) and unit tests (#2) are complete. Publish version 1.0.0 to npm.

Add API spec to README.md

Simple documentation must be written. Include an example of integrating it with fastify-jwt

Add to Fastify Ecosystem

Once published to npm (#3), submit a PR to Fastify in order to add this module to their ecosystem page.