express-jwt

Middleware that validates JsonWebTokens and sets req.user.

This module lets you authenticate HTTP requests using JWT tokens in your Node.js applications. JWTs are typically used protect API endpoints, and are often issued using OpenID Connect.

Install

$ npm install express-jwt

Usage

The JWT authentication middleware authenticates callers using a JWT. If the token is valid, req.user will be set with the JSON object decoded to be used by later middleware for authorization and access control.

For example,

var jwt = require('express-jwt');

app.get('/protected',
  jwt({secret: 'shhhhhhared-secret'}),
  function(req, res) {
    if (!req.user.admin) return res.send(401);
    res.send(200);
  });

You can specify audience and/or issuer as well:

jwt({ secret: 'shhhhhhared-secret',
  audience: 'http://myapi/protected',
  issuer: 'http://issuer' })

If the JWT has an expiration (exp), it will be checked.

Optionally you can make some paths unprotected as follows:

app.use(jwt({ secret: 'shhhhhhared-secret'}).unless({path: ['/token']}));

This is especially useful when applying to multiple routes.

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('/pat/to/public.pub');
jwt({ secret: publicKey });

By default, the decoded token is attached to req.user but can be configured with the userProperty option.

jwt({ secret: publicKey, userProperty: 'auth' });

Error handling

The default behavior is to throw an error when the token is invalid, so you can add your custom logic to manage unauthorized access as follows:

app.use(function (err, req, res, next) {
  if (err.name === 'UnauthorizedError') {
    res.send(401, 'invalid token...');
  }
});

You might want to use this module to identify registered users without preventing unregistered clients to access to some data, you can do it using the option credentialsRequired:

app.use(jwt({ 
  secret: 'hello world !',
  credentialsRequired: false
}));

Related Modules

jsonwebtoken — JSON Web Token sign and verification

Tests

$ npm install
$ npm test

Credits

@jfromaniello (20 contributions)
@woloski (16 contributions)
@aaronogle (3 contributions)
@mck- (3 contributions)
@CLevasseur (2 contributions)
@wiherek5 (1 contributions)
@davis (1 contributions)
@godeatgod (1 contributions)
@nkcmr (1 contributions)
@philosoralphter (1 contributions)
@iamsebastian (1 contributions)
@tonytamps (1 contributions)
@dannyrscott (1 contributions)
@dschenkelman (1 contributions)

License

The MIT License

pose/express-jwt