jsonwebtoken vs passport vs @nestjs/passport vs express-jwt
Authentication and Authorization in Node.js
jsonwebtokenpassport@nestjs/passportexpress-jwtSimilar Packages:
Authentication and Authorization in Node.js

Authentication and authorization are critical components of web applications, ensuring that users are who they claim to be (authentication) and that they have permission to access certain resources (authorization). These processes help secure applications by controlling access to sensitive data and functionalities. Various libraries in the Node.js ecosystem facilitate these processes, each with its own approach and features. For example, passport is a flexible and modular authentication middleware for Node.js, supporting various strategies like OAuth, JWT, and local authentication. jsonwebtoken is a library for creating and verifying JSON Web Tokens (JWT), which are commonly used for stateless authentication. express-jwt is a middleware that validates JWTs in incoming requests, ensuring that only authenticated users can access protected routes. @nestjs/passport integrates Passport.js with NestJS, providing a structured way to implement authentication in NestJS applications.

Npm Package Weekly Downloads Trend
3 Years
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
jsonwebtoken27,220,03518,11643.4 kB1854 days agoMIT
passport4,914,52123,468157 kB3932 years agoMIT
@nestjs/passport1,973,24854522.8 kB10a year agoMIT
express-jwt616,9894,51528.5 kB64a year agoMIT
Feature Comparison: jsonwebtoken vs passport vs @nestjs/passport vs express-jwt

Integration with Frameworks

  • jsonwebtoken:

    jsonwebtoken is a standalone library that works with any Node.js application. It does not depend on any framework, making it versatile for use in both Express and non-Express applications. However, it does not provide any built-in middleware or integration features.

  • passport:

    passport is a middleware for Express and Connect applications, but it is not tied to any specific framework. It provides a wide range of authentication strategies that can be integrated into any Express app, but it requires additional setup and configuration.

  • @nestjs/passport:

    @nestjs/passport is specifically designed for NestJS, leveraging its dependency injection and modular architecture. It provides decorators and guards that align with NestJS's design principles, making it easy to implement authentication in a structured way.

  • express-jwt:

    express-jwt is a middleware for Express applications, but it does not provide any framework-specific features. It can be easily integrated into any Express app to protect routes by validating JWTs, but it requires manual setup and configuration.

Token Handling

  • jsonwebtoken:

    jsonwebtoken provides comprehensive functionality for creating, signing, and verifying JWTs. It allows you to generate tokens with custom payloads, set expiration times, and validate tokens using secret keys or public/private key pairs.

  • passport:

    passport is agnostic to token handling and does not provide any built-in functionality for creating or validating tokens. It relies on external libraries (like jsonwebtoken) to handle token operations, especially when using token-based authentication strategies.

  • @nestjs/passport:

    @nestjs/passport does not handle token creation or validation directly, as it focuses on integrating Passport.js with NestJS. Token handling is typically done using jsonwebtoken or similar libraries in conjunction with Passport strategies.

  • express-jwt:

    express-jwt focuses solely on validating JWTs in incoming requests. It does not handle token creation or signing, so you will need to use a separate library like jsonwebtoken for that purpose.

Flexibility and Customization

  • jsonwebtoken:

    jsonwebtoken provides flexibility in how you create and verify tokens, including support for different signing algorithms and custom payloads. However, it is a low-level library that requires you to implement your own logic for handling tokens in your application.

  • passport:

    passport is highly flexible and customizable, allowing you to implement multiple authentication strategies (e.g., local, OAuth, JWT) within the same application. It supports custom strategy implementations, making it easy to integrate third-party authentication providers.

  • @nestjs/passport:

    @nestjs/passport offers flexibility in integrating various Passport strategies within a NestJS application. However, the customization is primarily around how strategies are implemented and used within the NestJS framework.

  • express-jwt:

    express-jwt is flexible in that it allows you to customize the JWT validation process, including providing your own token extraction logic and error handling. However, it is focused solely on JWTs and does not support other authentication methods.

Ease of Use: Code Examples

  • jsonwebtoken:

    JSON Web Token Example

    const jwt = require('jsonwebtoken');
    const secret = 'your_jwt_secret';
    
    // Create a token
    const token = jwt.sign({ userId: 1 }, secret, { expiresIn: '1h' });
    console.log('Generated Token:', token);
    
    // Verify the token
    jwt.verify(token, secret, (err, decoded) => {
      if (err) {
        console.error('Token verification failed:', err);
      } else {
        console.log('Decoded Token:', decoded);
      }
    });
    
  • passport:

    Passport Authentication Example

    const express = require('express');
    const passport = require('passport');
    const LocalStrategy = require('passport-local').Strategy;
    
    const app = express();
    app.use(passport.initialize());
    
    // Configure local strategy
    passport.use(new LocalStrategy((username, password, done) => {
      // Authenticate user (replace with your logic)
      if (username === 'user' && password === 'pass') {
        return done(null, { id: 1, username });
      }
      return done(null, false);
    }));
    
    // Login route
    app.post('/login', passport.authenticate('local'), (req, res) => {
      res.send('Logged in');
    });
    
    app.listen(3000, () => {
      console.log('Server running on http://localhost:3000');
    });
    
  • @nestjs/passport:

    NestJS Passport Example

    import { Controller, Get, UseGuards } from '@nestjs/common';
    import { AuthGuard } from '@nestjs/passport';
    
    @Controller('profile')
    export class ProfileController {
      @Get()
      @UseGuards(AuthGuard('jwt'))
      getProfile() {
        return { message: 'This is a protected route';
      }
    }
    
  • express-jwt:

    Express JWT Example

    const express = require('express');
    const jwt = require('jsonwebtoken');
    const expressJwt = require('express-jwt');
    
    const app = express();
    const secret = 'your_jwt_secret';
    
    // Middleware to protect routes
    app.use('/protected', expressJwt({ secret, algorithms: ['HS256'] }));
    
    app.get('/protected', (req, res) => {
      res.send('This is a protected route');
    });
    
    // Route to generate JWT
    app.get('/login', (req, res) => {
      const token = jwt.sign({ userId: 1 }, secret, { expiresIn: '1h' });
      res.json({ token });
    });
    
    app.listen(3000, () => {
      console.log('Server running on http://localhost:3000');
    });
    
How to Choose: jsonwebtoken vs passport vs @nestjs/passport vs express-jwt
  • jsonwebtoken:

    Use jsonwebtoken when you need to create, sign, and verify JSON Web Tokens (JWTs) in your application. This library is essential for implementing stateless authentication, allowing you to generate tokens that can be used for user sessions without maintaining server-side state.

  • passport:

    Opt for passport if you need a comprehensive and flexible authentication solution that supports multiple strategies (e.g., local, OAuth, JWT). Passport is highly customizable and can be integrated into any Express application, making it suitable for projects that require diverse authentication methods.

  • @nestjs/passport:

    Choose @nestjs/passport if you are building an application with NestJS and need a seamless integration with Passport.js. This package provides decorators and utilities that align with NestJS's modular architecture, making it easier to implement authentication strategies.

  • express-jwt:

    Select express-jwt if you need a lightweight middleware to protect your Express routes by validating JWTs. It is ideal for applications that already use JWTs for authentication and require a simple way to enforce token validation on specific routes.

README for jsonwebtoken

jsonwebtoken

BuildDependency
Build StatusDependency Status

An implementation of JSON Web Tokens.

This was developed against draft-ietf-oauth-json-web-token-08. It makes use of node-jws

Install

$ npm install jsonwebtoken

Migration notes

Usage

jwt.sign(payload, secretOrPrivateKey, [options, callback])

(Asynchronous) If a callback is supplied, the callback is called with the err or the JWT.

(Synchronous) Returns the JsonWebToken as string

payload could be an object literal, buffer or string representing valid JSON.

Please note that exp or any other claim is only set if the payload is an object literal. Buffer or string payloads are not checked for JSON validity.

If payload is not a buffer or a string, it will be coerced into a string using JSON.stringify.

secretOrPrivateKey is a string (utf-8 encoded), buffer, object, or KeyObject containing either the secret for HMAC algorithms or the PEM encoded private key for RSA and ECDSA. In case of a private key with passphrase an object { key, passphrase } can be used (based on crypto documentation), in this case be sure you pass the algorithm option. When signing with RSA algorithms the minimum modulus length is 2048 except when the allowInsecureKeySizes option is set to true. Private keys below this size will be rejected with an error.

options:

  • algorithm (default: HS256)
  • expiresIn: expressed in seconds or a string describing a time span vercel/ms.

    Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

  • notBefore: expressed in seconds or a string describing a time span vercel/ms.

    Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

  • audience
  • issuer
  • jwtid
  • subject
  • noTimestamp
  • header
  • keyid
  • mutatePayload: if true, the sign function will modify the payload object directly. This is useful if you need a raw reference to the payload after claims have been applied to it but before it has been encoded into a token.
  • allowInsecureKeySizes: if true allows private keys with a modulus below 2048 to be used for RSA
  • allowInvalidAsymmetricKeyTypes: if true, allows asymmetric keys which do not match the specified algorithm. This option is intended only for backwards compatability and should be avoided.

There are no default values for expiresIn, notBefore, audience, subject, issuer. These claims can also be provided in the payload directly with exp, nbf, aud, sub and iss respectively, but you can't include in both places.

Remember that exp, nbf and iat are NumericDate, see related Token Expiration (exp claim)

The header can be customized via the options.header object.

Generated jwts will include an iat (issued at) claim by default unless noTimestamp is specified. If iat is inserted in the payload, it will be used instead of the real timestamp for calculating other things like exp given a timespan in options.expiresIn.

Synchronous Sign with default (HMAC SHA256)

var jwt = require('jsonwebtoken');
var token = jwt.sign({ foo: 'bar' }, 'shhhhh');

Synchronous Sign with RSA SHA256

// sign with RSA SHA256
var privateKey = fs.readFileSync('private.key');
var token = jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' });

Sign asynchronously

jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' }, function(err, token) {
  console.log(token);
});

Backdate a jwt 30 seconds

var older_token = jwt.sign({ foo: 'bar', iat: Math.floor(Date.now() / 1000) - 30 }, 'shhhhh');

Token Expiration (exp claim)

The standard for JWT defines an exp claim for expiration. The expiration is represented as a NumericDate:

A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds. This is equivalent to the IEEE Std 1003.1, 2013 Edition [POSIX.1] definition "Seconds Since the Epoch", in which each day is accounted for by exactly 86400 seconds, other than that non-integer values can be represented. See RFC 3339 [RFC3339] for details regarding date/times in general and UTC in particular.

This means that the exp field should contain the number of seconds since the epoch.

Signing a token with 1 hour of expiration:

jwt.sign({
  exp: Math.floor(Date.now() / 1000) + (60 * 60),
  data: 'foobar'
}, 'secret');

Another way to generate a token like this with this library is:

jwt.sign({
  data: 'foobar'
}, 'secret', { expiresIn: 60 * 60 });

//or even better:

jwt.sign({
  data: 'foobar'
}, 'secret', { expiresIn: '1h' });

jwt.verify(token, secretOrPublicKey, [options, callback])

(Asynchronous) If a callback is supplied, function acts asynchronously. The callback is called with the decoded payload if the signature is valid and optional expiration, audience, or issuer are valid. If not, it will be called with the error.

(Synchronous) If a callback is not supplied, function acts synchronously. Returns the payload decoded if the signature is valid and optional expiration, audience, or issuer are valid. If not, it will throw the error.

Warning: When the token comes from an untrusted source (e.g. user input or external requests), the returned decoded payload should be treated like any other user input; please make sure to sanitize and only work with properties that are expected

token is the JsonWebToken string

secretOrPublicKey is a string (utf-8 encoded), buffer, or KeyObject containing either the secret for HMAC algorithms, or the PEM encoded public key for RSA and ECDSA. If jwt.verify is called asynchronous, secretOrPublicKey can be a function that should fetch the secret or public key. See below for a detailed example

As mentioned in this comment, there are other libraries that expect base64 encoded secrets (random bytes encoded using base64), if that is your case you can pass Buffer.from(secret, 'base64'), by doing this the secret will be decoded using base64 and the token verification will use the original random bytes.

options

  • algorithms: List of strings with the names of the allowed algorithms. For instance, ["HS256", "HS384"].

    If not specified a defaults will be used based on the type of key provided

    • secret - ['HS256', 'HS384', 'HS512']
    • rsa - ['RS256', 'RS384', 'RS512']
    • ec - ['ES256', 'ES384', 'ES512']
    • default - ['RS256', 'RS384', 'RS512']
  • audience: if you want to check audience (aud), provide a value here. The audience can be checked against a string, a regular expression or a list of strings and/or regular expressions.

    Eg: "urn:foo", /urn:f[o]{2}/, [/urn:f[o]{2}/, "urn:bar"]

  • complete: return an object with the decoded { payload, header, signature } instead of only the usual content of the payload.
  • issuer (optional): string or array of strings of valid values for the iss field.
  • jwtid (optional): if you want to check JWT ID (jti), provide a string value here.
  • ignoreExpiration: if true do not validate the expiration of the token.
  • ignoreNotBefore...
  • subject: if you want to check subject (sub), provide a value here
  • clockTolerance: number of seconds to tolerate when checking the nbf and exp claims, to deal with small clock differences among different servers
  • maxAge: the maximum allowed age for tokens to still be valid. It is expressed in seconds or a string describing a time span vercel/ms.

    Eg: 1000, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

  • clockTimestamp: the time in seconds that should be used as the current time for all necessary comparisons.
  • nonce: if you want to check nonce claim, provide a string value here. It is used on Open ID for the ID Tokens. (Open ID implementation notes)
  • allowInvalidAsymmetricKeyTypes: if true, allows asymmetric keys which do not match the specified algorithm. This option is intended only for backwards compatability and should be avoided.
// verify a token symmetric - synchronous
var decoded = jwt.verify(token, 'shhhhh');
console.log(decoded.foo) // bar

// verify a token symmetric
jwt.verify(token, 'shhhhh', function(err, decoded) {
  console.log(decoded.foo) // bar
});

// invalid token - synchronous
try {
  var decoded = jwt.verify(token, 'wrong-secret');
} catch(err) {
  // err
}

// invalid token
jwt.verify(token, 'wrong-secret', function(err, decoded) {
  // err
  // decoded undefined
});

// verify a token asymmetric
var cert = fs.readFileSync('public.pem');  // get public key
jwt.verify(token, cert, function(err, decoded) {
  console.log(decoded.foo) // bar
});

// verify audience
var cert = fs.readFileSync('public.pem');  // get public key
jwt.verify(token, cert, { audience: 'urn:foo' }, function(err, decoded) {
  // if audience mismatch, err == invalid audience
});

// verify issuer
var cert = fs.readFileSync('public.pem');  // get public key
jwt.verify(token, cert, { audience: 'urn:foo', issuer: 'urn:issuer' }, function(err, decoded) {
  // if issuer mismatch, err == invalid issuer
});

// verify jwt id
var cert = fs.readFileSync('public.pem');  // get public key
jwt.verify(token, cert, { audience: 'urn:foo', issuer: 'urn:issuer', jwtid: 'jwtid' }, function(err, decoded) {
  // if jwt id mismatch, err == invalid jwt id
});

// verify subject
var cert = fs.readFileSync('public.pem');  // get public key
jwt.verify(token, cert, { audience: 'urn:foo', issuer: 'urn:issuer', jwtid: 'jwtid', subject: 'subject' }, function(err, decoded) {
  // if subject mismatch, err == invalid subject
});

// alg mismatch
var cert = fs.readFileSync('public.pem'); // get public key
jwt.verify(token, cert, { algorithms: ['RS256'] }, function (err, payload) {
  // if token alg != RS256,  err == invalid signature
});

// Verify using getKey callback
// Example uses https://github.com/auth0/node-jwks-rsa as a way to fetch the keys.
var jwksClient = require('jwks-rsa');
var client = jwksClient({
  jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json'
});
function getKey(header, callback){
  client.getSigningKey(header.kid, function(err, key) {
    var signingKey = key.publicKey || key.rsaPublicKey;
    callback(null, signingKey);
  });
}

jwt.verify(token, getKey, options, function(err, decoded) {
  console.log(decoded.foo) // bar
});

Need to peek into a JWT without verifying it? (Click to expand)

jwt.decode(token [, options])

(Synchronous) Returns the decoded payload without verifying if the signature is valid.

Warning: This will not verify whether the signature is valid. You should not use this for untrusted messages. You most likely want to use jwt.verify instead.

Warning: When the token comes from an untrusted source (e.g. user input or external request), the returned decoded payload should be treated like any other user input; please make sure to sanitize and only work with properties that are expected

token is the JsonWebToken string

options:

  • json: force JSON.parse on the payload even if the header doesn't contain "typ":"JWT".
  • complete: return an object with the decoded payload and header.

Example

// get the decoded payload ignoring signature, no secretOrPrivateKey needed
var decoded = jwt.decode(token);

// get the decoded payload and header
var decoded = jwt.decode(token, {complete: true});
console.log(decoded.header);
console.log(decoded.payload)

Errors & Codes

Possible thrown errors during verification. Error is the first argument of the verification callback.

TokenExpiredError

Thrown error if the token is expired.

Error object:

  • name: 'TokenExpiredError'
  • message: 'jwt expired'
  • expiredAt: [ExpDate]
jwt.verify(token, 'shhhhh', function(err, decoded) {
  if (err) {
    /*
      err = {
        name: 'TokenExpiredError',
        message: 'jwt expired',
        expiredAt: 1408621000
      }
    */
  }
});

JsonWebTokenError

Error object:

  • name: 'JsonWebTokenError'
  • message:
    • 'invalid token' - the header or payload could not be parsed
    • 'jwt malformed' - the token does not have three components (delimited by a .)
    • 'jwt signature is required'
    • 'invalid signature'
    • 'jwt audience invalid. expected: [OPTIONS AUDIENCE]'
    • 'jwt issuer invalid. expected: [OPTIONS ISSUER]'
    • 'jwt id invalid. expected: [OPTIONS JWT ID]'
    • 'jwt subject invalid. expected: [OPTIONS SUBJECT]'
jwt.verify(token, 'shhhhh', function(err, decoded) {
  if (err) {
    /*
      err = {
        name: 'JsonWebTokenError',
        message: 'jwt malformed'
      }
    */
  }
});

NotBeforeError

Thrown if current time is before the nbf claim.

Error object:

  • name: 'NotBeforeError'
  • message: 'jwt not active'
  • date: 2018-10-04T16:10:44.000Z
jwt.verify(token, 'shhhhh', function(err, decoded) {
  if (err) {
    /*
      err = {
        name: 'NotBeforeError',
        message: 'jwt not active',
        date: 2018-10-04T16:10:44.000Z
      }
    */
  }
});

Algorithms supported

Array of supported algorithms. The following algorithms are currently supported.

alg Parameter ValueDigital Signature or MAC Algorithm
HS256HMAC using SHA-256 hash algorithm
HS384HMAC using SHA-384 hash algorithm
HS512HMAC using SHA-512 hash algorithm
RS256RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm
RS384RSASSA-PKCS1-v1_5 using SHA-384 hash algorithm
RS512RSASSA-PKCS1-v1_5 using SHA-512 hash algorithm
PS256RSASSA-PSS using SHA-256 hash algorithm (only node ^6.12.0 OR >=8.0.0)
PS384RSASSA-PSS using SHA-384 hash algorithm (only node ^6.12.0 OR >=8.0.0)
PS512RSASSA-PSS using SHA-512 hash algorithm (only node ^6.12.0 OR >=8.0.0)
ES256ECDSA using P-256 curve and SHA-256 hash algorithm
ES384ECDSA using P-384 curve and SHA-384 hash algorithm
ES512ECDSA using P-521 curve and SHA-512 hash algorithm
noneNo digital signature or MAC value included

Refreshing JWTs

First of all, we recommend you to think carefully if auto-refreshing a JWT will not introduce any vulnerability in your system.

We are not comfortable including this as part of the library, however, you can take a look at this example to show how this could be accomplished. Apart from that example there are an issue and a pull request to get more knowledge about this topic.

TODO

  • X.509 certificate chain is not checked

Issue Reporting

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.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.