jsonwebtoken vs passport-jwt vs express-jwt vs express-jwt-permissions vs express-jwt-authz
웹 개발에서 JWT 인증 라이브러리
jsonwebtokenpassport-jwtexpress-jwtexpress-jwt-permissionsexpress-jwt-authz유사 패키지:

웹 개발에서 JWT 인증 라이브러리

JWT(JSON Web Token)는 웹 애플리케이션에서 사용자 인증 및 권한 부여를 위한 안전한 방법을 제공하는 라이브러리입니다. 이 라이브러리들은 Express.js와 함께 사용되어, API 요청에서 사용자 인증을 간편하게 처리할 수 있도록 도와줍니다. 각 라이브러리는 JWT의 생성, 검증 및 권한 부여를 위한 다양한 기능을 제공합니다.

npm 다운로드 트렌드

3 년

GitHub Stars 순위

통계 세부사항

패키지
다운로드
Stars
크기
Issues
발행일
라이선스
jsonwebtoken85,253,76018,18543.4 kB2171年前MIT
passport-jwt5,712,0641,98052 kB42-MIT
express-jwt1,143,2554,51128.5 kB642年前MIT
express-jwt-permissions125,82251819.9 kB9-MIT
express-jwt-authz37,141987.75 kB14-MIT

기능 비교: jsonwebtoken vs passport-jwt vs express-jwt vs express-jwt-permissions vs express-jwt-authz

기본 기능

  • jsonwebtoken:

    jsonwebtoken은 JWT를 생성하고 서명하는 기능을 제공합니다. 토큰의 페이로드를 정의하고, 비밀 키를 사용하여 서명된 토큰을 생성할 수 있습니다.

  • passport-jwt:

    passport-jwt는 Passport.js의 JWT 인증 전략을 제공합니다. 다양한 인증 방법을 통합하여, JWT를 통한 인증을 쉽게 구현할 수 있습니다.

  • express-jwt:

    express-jwt는 JWT를 검증하는 미들웨어를 제공하여, API 요청에서 인증을 간편하게 처리할 수 있습니다. 사용자가 전송한 JWT의 유효성을 검사하고, 유효하지 않은 경우 요청을 차단합니다.

  • express-jwt-permissions:

    express-jwt-permissions는 더 세밀한 권한 관리를 제공합니다. 사용자의 권한을 정의하고, 이를 기반으로 API 접근을 제어할 수 있습니다.

  • express-jwt-authz:

    express-jwt-authz는 express-jwt의 기능을 확장하여, 사용자 역할에 기반한 권한 부여를 지원합니다. 특정 API 엔드포인트에 대한 접근 권한을 설정할 수 있습니다.

사용 시나리오

  • jsonwebtoken:

    jsonwebtoken은 JWT를 직접 생성하고 관리해야 할 때 사용합니다. 예를 들어, 사용자 로그인 시 JWT를 생성하여 클라이언트에 반환할 수 있습니다.

  • passport-jwt:

    passport-jwt는 다양한 인증 전략을 사용할 때 유용합니다. 예를 들어, 소셜 로그인과 JWT 인증을 함께 사용할 수 있습니다.

  • express-jwt:

    express-jwt는 간단한 RESTful API에서 JWT 인증을 구현할 때 유용합니다. 사용자 인증이 필요한 모든 요청에 쉽게 적용할 수 있습니다.

  • express-jwt-permissions:

    express-jwt-permissions는 복잡한 권한 관리가 필요한 경우에 적합합니다. 예를 들어, 특정 리소스에 대한 읽기/쓰기 권한을 세분화하여 관리할 수 있습니다.

  • express-jwt-authz:

    express-jwt-authz는 역할 기반 권한 부여가 필요한 애플리케이션에서 사용됩니다. 예를 들어, 관리자는 모든 API에 접근할 수 있지만 일반 사용자는 특정 API에만 접근할 수 있도록 설정할 수 있습니다.

유지보수

  • jsonwebtoken:

    jsonwebtoken은 JWT 생성 및 검증을 위한 저수준 API를 제공하므로, 사용자가 직접 관리해야 할 부분이 많습니다. 따라서 유지보수가 필요할 수 있습니다.

  • passport-jwt:

    passport-jwt는 Passport.js의 구조를 따르므로, 다양한 인증 전략을 통합하여 유지보수할 수 있습니다. 그러나 여러 전략을 관리해야 하므로 복잡할 수 있습니다.

  • express-jwt:

    express-jwt는 간단한 구조로 유지보수가 용이합니다. 기본적인 JWT 검증 기능만 제공하므로, 복잡한 설정이 필요하지 않습니다.

  • express-jwt-permissions:

    express-jwt-permissions는 세부적인 권한 관리를 제공하므로, 유지보수가 더 복잡할 수 있습니다. 권한 정의와 관리가 필요합니다.

  • express-jwt-authz:

    express-jwt-authz는 역할 기반 권한 부여를 추가하는 만큼, 유지보수가 다소 복잡할 수 있습니다. 역할과 권한을 정의하고 관리해야 합니다.

학습 곡선

  • jsonwebtoken:

    jsonwebtoken은 JWT의 생성 및 검증을 위한 저수준 API를 제공하므로, 사용법을 익히는 데 시간이 걸릴 수 있습니다.

  • passport-jwt:

    passport-jwt는 Passport.js의 구조를 이해해야 하므로, 다른 인증 전략과 함께 사용할 때 학습 곡선이 있을 수 있습니다.

  • express-jwt:

    express-jwt는 간단한 사용법으로 학습 곡선이 낮습니다. 기본적인 JWT 검증 기능만 이해하면 쉽게 사용할 수 있습니다.

  • express-jwt-permissions:

    express-jwt-permissions는 세부적인 권한 관리 기능을 제공하므로, 학습 곡선이 다소 가파를 수 있습니다. 권한 정의와 관리 방법을 익혀야 합니다.

  • express-jwt-authz:

    express-jwt-authz는 express-jwt의 기능을 확장하므로, 기본적인 JWT 사용법을 이해한 후에 학습할 수 있습니다.

확장성

  • jsonwebtoken:

    jsonwebtoken은 JWT 생성 및 검증을 위한 저수준 API를 제공하므로, 필요에 따라 기능을 확장할 수 있습니다.

  • passport-jwt:

    passport-jwt는 다양한 인증 전략을 지원하므로, 확장성이 높습니다. 여러 인증 방법을 통합하여 사용할 수 있습니다.

  • express-jwt:

    express-jwt는 기본적인 JWT 검증 기능을 제공하므로, 다른 미들웨어와 쉽게 통합할 수 있습니다. 필요에 따라 기능을 확장할 수 있습니다.

  • express-jwt-permissions:

    express-jwt-permissions는 세부적인 권한 관리를 제공하므로, 확장성이 뛰어납니다. 복잡한 권한 구조를 쉽게 관리할 수 있습니다.

  • express-jwt-authz:

    express-jwt-authz는 역할 기반 권한 부여 기능을 추가하여, 확장성이 높습니다. 다양한 역할과 권한을 정의할 수 있습니다.

선택 방법: jsonwebtoken vs passport-jwt vs express-jwt vs express-jwt-permissions vs express-jwt-authz

  • jsonwebtoken:

    jsonwebtoken은 JWT를 생성하고 검증하는 데 필요한 기능을 제공합니다. 다른 라이브러리와 함께 사용하여, 토큰의 생성 및 서명을 직접 관리하고자 할 때 적합합니다.

  • passport-jwt:

    passport-jwt는 Passport.js와 함께 사용하여, 다양한 인증 전략을 통합하고자 할 때 선택합니다. 여러 인증 방법을 지원하며, JWT를 통한 인증을 쉽게 구현할 수 있습니다.

  • express-jwt:

    express-jwt는 JWT를 사용하여 API 요청을 인증하는 데 적합합니다. 간단한 설정으로 JWT를 검증하고, 미들웨어로 쉽게 통합할 수 있습니다.

  • express-jwt-permissions:

    express-jwt-permissions는 세분화된 권한 관리를 필요로 할 때 유용합니다. 특정 리소스에 대한 권한을 정의하고, 이를 기반으로 API 접근을 제어할 수 있습니다.

  • express-jwt-authz:

    express-jwt-authz는 권한 부여를 위한 추가 기능이 필요할 때 선택합니다. 역할 기반 액세스 제어(RBAC)를 구현하여, 사용자의 권한에 따라 API 접근을 제어할 수 있습니다.

jsonwebtoken의 README

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.