JWT token auth for express.js
This package provides JSON Web Token Authentication support for Express.
New to using JSON Web Tokens? Take a look at these resources:
Installation
npm install jwt-token-auth
Usage
var express = auth = app = // Require jwt authorization on all routesapp // Reguire jwt auth on a specfic routeapp app
Now your route(s) are protected and require an authorization header in the form of:
Authorization JWT < jwt token >
Configuration
Configure your JWT Secret. This must be changed for production. Default value is 'secret'
.
processenvJWT_SECRET_KEY = 'Your Secret'
Configure the authorization header prefix. this is optional. Default is 'JWT'
.
processenvjwtAuthHeaderPrefix
Provided Middleware
ensureAuthorizationHeader
An Express.js middleware that ensures that a request has supplied an authorization header.
- @param {object} req
- @param {object} res
- @param {function} next
validateJWTAuth
An Express.js middleware validates a JWT token.
- @param {object} req
- @param {object} res
- @param {function} next
ensureAuthorized
An Express.js middleware that ensures that a request has supplied an authorization header.
- @param {object} req
- @param {object} res
- @param {function} next
jwtAuthProtected
The grouped middleware needed to enforce jwt Auth. Mounts the same as a single middleware.
Errors
When authorization fails jwt-token-auth will return an UnauthorizedError
with some helpful details about what went wrong.
This implementation was based on the excellent django-rest-framework-jwt library.