This module provides Express middleware for validating JWTs (JSON Web Tokens) through the jsonwebtoken module. The decoded JWT payload is available on the request object.
Install
$ npm install express-jwt
API
expressjwt(options)
Options has the following parameters:
secret: jwt.Secret | GetVerificationKey (required): The secret as a string or a function to retrieve the secret.
getToken?: TokenGetter (optional): A function that receives the express Request and returns the token, by default it looks in the Authorization header.
isRevoked?: IsRevoked (optional): A function to verify if a token is revoked.
credentialsRequired?: boolean (optional): If its false, continue to the next middleware if the request does not contain a token instead of failing, defaults to true.
requestProperty?: string (optional): Name of the property in the request object where the payload is set. Default to req.auth.
var { expressjwt: jwt } = require("express-jwt");// or ES6// import { expressjwt, ExpressJwtRequest } from "express-jwt";app.get( "/protected", jwt({ secret: "shhhhhhared-secret", algorithms: ["HS256"] }), function (req, res) { if (!req.auth.admin) return res.sendStatus(401); res.sendStatus(200); });
The decoded JWT payload is available on the request via the auth property.
The default behavior of the module is to extract the JWT from the Authorization header as an OAuth2 Bearer token.
Required Parameters
The algorithms parameter is required to prevent potential downgrade attacks when providing third party libraries as secrets.
:warning: Do not mix symmetric and asymmetric (ie HS256/RS256) algorithms: Mixing algorithms without further validation can potentially result in downgrade vulnerabilities.
This is especially useful when applying to multiple routes. In the example above, path can be a string, a regexp, or an array of any of those.
For more details on the .unless syntax including additional options, please see express-unless.
This module also support tokens signed with public/private key pairs. Instead of a secret, you can specify a Buffer with the public key
var publicKey = fs.readFileSync("/path/to/public.pub");jwt({ secret: publicKey, algorithms: ["RS256"] });
Customizing Token Location
A custom function for extracting the token from a request can be specified with
the getToken option. This is useful if you need to pass the token through a
query parameter or a cookie. You can throw an error in this function and it will
be handled by express-jwt.
If you need to obtain the key dynamically from other sources, you can pass a function in the secret parameter with the following parameters:
req (Object) - The express request object.
token (Object) - An object with the JWT payload and headers.
For example, if the secret varies based on the issuer:
var jwt = require("express-jwt");var data = require("./data");var utilities = require("./utilities");var getSecret = async function (req, token) { const issuer = token.payload.iss; const tenant = await data.getTenantByIdentifier(issuer); if (!tenant) { throw new Error("missing_secret"); } return utilities.decrypt(tenant.secret);};app.get( "/protected", jwt({ secret: getSecret, algorithms: ["HS256"] }), function (req, res) { if (!req.auth.admin) return res.sendStatus(401); res.sendStatus(200); });
Secret rotation
The getSecret callback could also be used in cases where the same issuer might issue tokens with different keys at certain point:
var getSecret = async function (req, token) { const { iss } = token.payload; const { kid } = token.header; // get the verification key by a given key-id and issuer. return verificationKey;};
Revoked tokens
It is possible that some tokens will need to be revoked so they cannot be used any longer. You can provide a function as the isRevoked option. The signature of the function is function(req, payload, done):
req (Object) - The express request object.
token (Object) - An object with the JWT payload and headers.
For example, if the (iss, jti) claim pair is used to identify a JWT:
You might want to use this module to identify registered users while still providing access to unregistered users. You can do this by using the option credentialsRequired:
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.