skutil-express-jwt

A small wrapper around express-jwt with built-in JWT signing and verification.

Install

npm install skutil-express-jwt

Usage

const express = require('express')
const JWT = require('skutil-express-jwt')

const jwt = new JWT({
  secret: 'your-secret-key',
  algorithms: ['HS256'],
  sign: {
    expiresIn: '1h'
  },
  verify: {
    // additional express-jwt verify options
  }
})

const token = jwt.sign({ userId: 123 })
const payload = jwt.verify(token)

const app = express()
app.get('/protected', jwt.createMidware(), (req, res) => {
  const auth = req.auth
  res.json({ auth })
})

API

new JWT(options)

Create a new JWT helper instance.

options:

• secret (string) - required. JWT signing secret.
• algorithms (string[]) - required. Supported algorithms for signing and verification.
• sign (jwt.SignOptions) - optional. Default options for sign().
• verify (expressjwt.Params) - optional. Default options for verify() and middleware creation.
• requestProperty (string) - optional. Request property name used by express-jwt. Defaults to auth.

jwt.sign(data, signOptions)

Sign a payload and return a JWT string.

• data (any) - payload to sign.
• signOptions (jwt.SignOptions) - optional. Merged with constructor sign options.

jwt.verify(token, verifyOptions)

Verify a JWT and return the decoded payload.

• token (string) - JWT to verify.
• verifyOptions (jwt.VerifyOptions) - optional. Merged with constructor verify options.

jwt.createMidware()

Return Express middleware from express-jwt using configured settings.

The middleware attaches decoded token data to req[requestProperty].