Skip to content

connect/express middleware that validates a JsonWebToken (JWT) and set the req.user with the attributes

Notifications You must be signed in to change notification settings

Inqb8r/express-jwt

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

express-jwt

Build

Middleware that validates JsonWebTokens and set req.user.

This module lets you authenticate HTTP requests using JWT tokens, in your Node.js applications. JWT tokens 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 token. 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 add paths for the middleware to skip:

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 });

Related Modules

Tests

$ npm install
$ npm test

Credits

License

The MIT License

Copyright (c) 2013 Auth0 <http://auth0.com>

About

connect/express middleware that validates a JsonWebToken (JWT) and set the req.user with the attributes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%