diff --git a/README.md b/README.md index 4e20dd9..f98bf47 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ # jsonwebtoken | **Build** | **Dependency** | -|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [![Build Status](https://secure.travis-ci.org/auth0/node-jsonwebtoken.svg?branch=master)](http://travis-ci.org/auth0/node-jsonwebtoken) | [![Dependency Status](https://david-dm.org/auth0/node-jsonwebtoken.svg)](https://david-dm.org/auth0/node-jsonwebtoken) | - An implementation of [JSON Web Tokens](https://tools.ietf.org/html/rfc7519). This was developed against `draft-ietf-oauth-json-web-token-08`. It makes use of [node-jws](https://github.com/brianloveswords/node-jws) @@ -17,8 +16,8 @@ $ npm install jsonwebtoken # Migration notes -* [From v8 to v9](https://github.com/auth0/node-jsonwebtoken/wiki/Migration-Notes:-v8-to-v9) -* [From v7 to v8](https://github.com/auth0/node-jsonwebtoken/wiki/Migration-Notes:-v7-to-v8) +- [From v8 to v9](https://github.com/auth0/node-jsonwebtoken/wiki/Migration-Notes:-v8-to-v9) +- [From v7 to v8](https://github.com/auth0/node-jsonwebtoken/wiki/Migration-Notes:-v7-to-v8) # Usage @@ -28,7 +27,8 @@ $ npm install jsonwebtoken (Synchronous) Returns the JsonWebToken as string -`payload` could be an object literal, buffer or string representing valid JSON. +`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`. @@ -39,29 +39,26 @@ When signing with RSA algorithms the minimum modulus length is 2048 except when `options`: -* `algorithm` (default: `HS256`) -* `expiresIn`: expressed in seconds or a string describing a time span [vercel/ms](https://github.com/vercel/ms). +- `algorithm` (default: `HS256`) +- `expiresIn`: expressed in seconds or a string describing a time span [vercel/ms](https://github.com/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](https://github.com/vercel/ms). +- `notBefore`: expressed in seconds or a string describing a time span [vercel/ms](https://github.com/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. +- `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)](#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`. @@ -69,58 +66,80 @@ Generated jwts will include an `iat` (issued at) claim by default unless `noTime Synchronous Sign with default (HMAC SHA256) ```js -var jwt = require('jsonwebtoken'); -var token = jwt.sign({ foo: 'bar' }, 'shhhhh'); +const jwt = require("jsonwebtoken"); +const token = jwt.sign({ foo: "bar" }, "shhhhh"); ``` Synchronous Sign with RSA SHA256 + ```js // sign with RSA SHA256 -var privateKey = fs.readFileSync('private.key'); -var token = jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' }); +const privateKey = fs.readFileSync("private.key"); +const token = jwt.sign({ foo: "bar" }, privateKey, { algorithm: "RS256" }); ``` Sign asynchronously + ```js -jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' }, function(err, token) { - console.log(token); -}); +jwt.sign( + { foo: "bar" }, + privateKey, + { algorithm: "RS256" }, + function (err, token) { + console.log(token); + } +); ``` Backdate a jwt 30 seconds + ```js -var older_token = jwt.sign({ foo: 'bar', iat: Math.floor(Date.now() / 1000) - 30 }, 'shhhhh'); +const 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. +> 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: ```javascript -jwt.sign({ - exp: Math.floor(Date.now() / 1000) + (60 * 60), - data: 'foobar' -}, 'secret'); +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: ```javascript -jwt.sign({ - data: 'foobar' -}, 'secret', { expiresIn: 60 * 60 }); +jwt.sign( + { + data: "foobar", + }, + "secret", + { expiresIn: 60 * 60 } +); //or even better: -jwt.sign({ - data: 'foobar' -}, 'secret', { expiresIn: '1h' }); +jwt.sign( + { + data: "foobar", + }, + "secret", + { expiresIn: "1h" } +); ``` ### jwt.verify(token, secretOrPublicKey, [options, callback]) @@ -129,7 +148,7 @@ jwt.sign({ (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 +> **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 @@ -141,103 +160,125 @@ As mentioned in [this comment](https://github.com/auth0/node-jsonwebtoken/issues `options` -* `algorithms`: List of strings with the names of the allowed algorithms. For instance, `["HS256", "HS384"]`. +- `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. + > + > - 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](https://github.com/vercel/ms). +- `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](https://github.com/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](https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes)) -* `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. +- `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](https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes)) +- `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. ```js +import jwt from "jsonwebtoken"; +import fs from "fs"; +import jwksClient from "jwks-rsa"; + +const privateKey = "shhhhh"; // Your secret key +// const privateKey = process.env.PRIVATE_KEY ; // Your secret key from .env + // verify a token symmetric - synchronous -var decoded = jwt.verify(token, 'shhhhh'); -console.log(decoded.foo) // bar +const decodedSync = jwt.verify(token, privateKey); +console.log(decodedSync.foo); // bar // verify a token symmetric -jwt.verify(token, 'shhhhh', function(err, decoded) { - console.log(decoded.foo) // bar +jwt.verify(token, privateKey, (err, decoded) => { + console.log(decoded.foo); // bar }); // invalid token - synchronous try { - var decoded = jwt.verify(token, 'wrong-secret'); -} catch(err) { + const decodedInvalidSync = jwt.verify(token, "wrong-secret"); +} catch (err) { // err } // invalid token -jwt.verify(token, 'wrong-secret', function(err, decoded) { +jwt.verify(token, "wrong-secret", (err, decoded) => { // err // decoded undefined }); +const cert = fs.readFileSync("public.pem"); // get public key + // 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 + +jwt.verify(token, cert, (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) { +jwt.verify(token, cert, { audience: "urn:foo" }, (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 -}); +jwt.verify( + token, + cert, + { audience: "urn:foo", issuer: "urn:issuer" }, + (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 -}); +jwt.verify( + token, + cert, + { audience: "urn:foo", issuer: "urn:issuer", jwtid: "jwtid" }, + (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 -}); +jwt.verify( + token, + cert, + { + audience: "urn:foo", + issuer: "urn:issuer", + jwtid: "jwtid", + subject: "subject", + }, + (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) { +jwt.verify(token, cert, { algorithms: ["RS256"] }, (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' +const 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; +const getKey = (header, callback) => { + client.getSigningKey(header.kid, (err, key) => { + const signingKey = key.publicKey || key.rsaPublicKey; callback(null, signingKey); }); -} +}; -jwt.verify(token, getKey, options, function(err, decoded) { - console.log(decoded.foo) // bar +jwt.verify(token, getKey, options, (err, decoded) => { + console.log(decoded.foo); // bar }); - ```
@@ -247,17 +288,16 @@ jwt.verify(token, getKey, options, function(err, decoded) { (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 +> **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. +- `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 @@ -266,14 +306,15 @@ Example var decoded = jwt.decode(token); // get the decoded payload and header -var decoded = jwt.decode(token, {complete: true}); +var decoded = jwt.decode(token, { complete: true }); console.log(decoded.header); -console.log(decoded.payload) +console.log(decoded.payload); ```
## Errors & Codes + Possible thrown errors during verification. Error is the first argument of the verification callback. @@ -283,12 +324,12 @@ Thrown error if the token is expired. Error object: -* name: 'TokenExpiredError' -* message: 'jwt expired' -* expiredAt: [ExpDate] +- name: 'TokenExpiredError' +- message: 'jwt expired' +- expiredAt: [ExpDate] ```js -jwt.verify(token, 'shhhhh', function(err, decoded) { +jwt.verify(token, "shhhhh", function (err, decoded) { if (err) { /* err = { @@ -302,21 +343,22 @@ jwt.verify(token, 'shhhhh', function(err, decoded) { ``` ### 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]' +- 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]' ```js -jwt.verify(token, 'shhhhh', function(err, decoded) { +jwt.verify(token, "shhhhh", function (err, decoded) { if (err) { /* err = { @@ -329,16 +371,17 @@ jwt.verify(token, 'shhhhh', function(err, decoded) { ``` ### 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 +- name: 'NotBeforeError' +- message: 'jwt not active' +- date: 2018-10-04T16:10:44.000Z ```js -jwt.verify(token, 'shhhhh', function(err, decoded) { +jwt.verify(token, "shhhhh", function (err, decoded) { if (err) { /* err = { @@ -351,13 +394,12 @@ jwt.verify(token, 'shhhhh', function(err, decoded) { }); ``` - ## Algorithms supported Array of supported algorithms. The following algorithms are currently supported. | alg Parameter Value | Digital Signature or MAC Algorithm | -|---------------------|------------------------------------------------------------------------| +| ------------------- | ---------------------------------------------------------------------- | | HS256 | HMAC using SHA-256 hash algorithm | | HS384 | HMAC using SHA-384 hash algorithm | | HS512 | HMAC using SHA-512 hash algorithm | @@ -381,7 +423,7 @@ Apart from that example there are [an issue](https://github.com/auth0/node-jsonw # TODO -* X.509 certificate chain is not checked +- X.509 certificate chain is not checked ## Issue Reporting