jose 1.27.0 → 1.28.0

package/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+# [1.28.0](https://github.com/panva/jose/compare/v1.27.3...v1.28.0) (2020-08-10)
+
+
+### Features
+
+* support for validating issuer from a list of values ([#91](https://github.com/panva/jose/issues/91)) ([ce6836a](https://github.com/panva/jose/commit/ce6836af88c9e73c29560233f15ed1760c7dcc13))
+
+
+
+## [1.27.3](https://github.com/panva/jose/compare/v1.27.2...v1.27.3) (2020-08-04)
+
+
+### Bug Fixes
+
+* do not mutate unencoded payload when signing for multiple parties ([1695423](https://github.com/panva/jose/commit/169542363f884e4028db9f80086d631e626eb469)), closes [#89](https://github.com/panva/jose/issues/89)
+* ensure "b64" is the same for all recipients edge cases ([d56ec9f](https://github.com/panva/jose/commit/d56ec9f5ddc2612e5ff21fe35d45a56e7153e0e4))
+
+
+
+## [1.27.2](https://github.com/panva/jose/compare/v1.27.1...v1.27.2) (2020-07-01)
+
+
+### Bug Fixes
+
+* handle private EC keys without public component ([#86](https://github.com/panva/jose/issues/86)) ([e8ad389](https://github.com/panva/jose/commit/e8ad38993e29747098f7fd1594dde4ce893ba802)), closes [#85](https://github.com/panva/jose/issues/85)
+
+
+
+## [1.27.1](https://github.com/panva/jose/compare/v1.27.0...v1.27.1) (2020-06-01)
+
+
+### Bug Fixes
+
+* allow any JSON numeric value for timestamp values ([7ba4922](https://github.com/panva/jose/commit/7ba492237aaf788914166c134d50fb046041efa0))
+
+
+
 # [1.27.0](https://github.com/panva/jose/compare/v1.26.1...v1.27.0) (2020-05-05)
 
 

package/README.md

@@ -326,8 +326,8 @@ Legend:
 <sup>2</sup> Unsecured JWS is [supported][documentation-none] for the JWS and JWT sign and verify
 operations but it is an entirely opt-in behaviour, downgrade attacks are prevented by the required
 use of a special `JWK.Key`-like object that cannot be instantiated through the key import API  
-<sup>3</sup> RSAES OAEP using SHA-2 and MGF1 with SHA-2 is only supported when Node.js >= 12.9.0 runtime is detected  
-<sup>4</sup> ECDH-ES with X25519 and X448 keys is only supported when Node.js >= 13.9.0 runtime is detected  
+<sup>3</sup> RSAES OAEP using SHA-2 and MGF1 with SHA-2 is only supported when Node.js `>=12.9.0` runtime is detected  
+<sup>4</sup> ECDH-ES with X25519 and X448 keys is only supported when Node.js `^12.17.0 || >=13.9.0` runtime is detected  
 <sup>5</sup> Draft specification profiles are updated as minor versions of the library, therefore,
 since they may have breaking changes use the `~` semver operator when using these and pay close
 attention to changelog and the drafts themselves.

package/lib/help/key_utils.js

@@ -4,6 +4,7 @@ const { EOL } = require('os')
 
 const errors = require('../errors')
 
+const { keyObjectSupported } = require('./runtime_support')
 const { createPublicKey } = require('./key_object')
 const base64url = require('./base64url')
 const asn1 = require('./asn1')
@@ -89,10 +90,21 @@ const keyObjectToJWK = {
       const ECPrivateKey = asn1.get('ECPrivateKey')
 
       const { privateKey, algorithm: { parameters: { value: crv } } } = PrivateKeyInfo.decode(der)
-      const { privateKey: d, publicKey: { data: publicKey } } = ECPrivateKey.decode(privateKey)
+      const { privateKey: d, publicKey } = ECPrivateKey.decode(privateKey)
+
+      if (typeof publicKey === 'undefined') {
+        if (keyObjectSupported) {
+          return {
+            ...keyObjectToJWK.ec.public(createPublicKey(keyObject)),
+            d: base64url.encodeBuffer(d)
+          }
+        }
 
-      const x = publicKey.slice(1, ((publicKey.length - 1) / 2) + 1)
-      const y = publicKey.slice(((publicKey.length - 1) / 2) + 1)
+        throw new errors.JOSENotSupported('Private EC keys without the public key embedded are not supported in your Node.js runtime version')
+      }
+
+      const x = publicKey.data.slice(1, ((publicKey.data.length - 1) / 2) + 1)
+      const y = publicKey.data.slice(((publicKey.data.length - 1) / 2) + 1)
 
       return {
         kty: 'EC',

package/lib/jwe/encrypt.js

@@ -190,7 +190,11 @@ class Encrypt {
     let aad
     if (this._aad) {
       final.aad = base64url.encode(this._aad)
-      aad = Buffer.concat([Buffer.from(final.protected || ''), Buffer.from('.'), Buffer.from(final.aad)])
+      aad = Buffer.concat([
+        Buffer.from(final.protected || ''),
+        Buffer.from('.'),
+        Buffer.from(final.aad)
+      ])
     } else {
       aad = Buffer.from(final.protected || '')
     }

package/lib/jws/serializers.js

@@ -44,9 +44,20 @@ const generalSerializer = (payload, recipients) => {
   }
 }
 generalSerializer.validate = (jws, recipients) => {
+  let validateB64 = false
   recipients.forEach(({ protectedHeader, unprotectedHeader }) => {
+    if (protectedHeader && !validateB64 && 'b64' in protectedHeader) {
+      validateB64 = true
+    }
     validateCrit(protectedHeader, unprotectedHeader, protectedHeader ? protectedHeader.crit : undefined)
   })
+
+  if (validateB64) {
+    const values = recipients.map(({ protectedHeader }) => protectedHeader && protectedHeader.b64)
+    if (!values.every((actual, i, [expected]) => actual === expected)) {
+      throw new JWSInvalid('the "b64" Header Parameter value MUST be the same for all recipients')
+    }
+  }
 }
 
 const isJSON = (input) => {

package/lib/jws/sign.js

@@ -57,7 +57,7 @@ class Sign {
   /*
    * @private
    */
-  [PROCESS_RECIPIENT] (recipient) {
+  [PROCESS_RECIPIENT] (recipient, first) {
     const { key, protectedHeader, unprotectedHeader } = recipient
 
     if (key.use === 'enc') {
@@ -87,32 +87,21 @@ class Sign {
     recipient.header = unprotectedHeader
     recipient.protected = Object.keys(joseHeader.protected).length ? base64url.JSON.encode(joseHeader.protected) : ''
 
-    let toBeSigned
-    if (joseHeader.protected.crit && joseHeader.protected.crit.includes('b64')) {
-      if (this._b64 !== undefined && this._b64 !== joseHeader.protected.b64) {
-        throw new JWSInvalid('the "b64" Header Parameter value MUST be the same for all recipients')
+    if (first && joseHeader.protected.crit && joseHeader.protected.crit.includes('b64') && joseHeader.protected.b64 === false) {
+      if (this._binary) {
+        this._payload = base64url.decodeToBuffer(this._payload)
       } else {
-        this._b64 = joseHeader.protected.b64
+        this._payload = base64url.decode(this._payload)
       }
-
-      if (!joseHeader.protected.b64) {
-        if (this._binary) {
-          this._payload = base64url.decodeToBuffer(this._payload)
-        } else {
-          this._payload = base64url.decode(this._payload)
-        }
-      }
-
-      toBeSigned = Buffer.concat([
-        Buffer.from(recipient.protected || ''),
-        Buffer.from('.'),
-        Buffer.isBuffer(this._payload) ? this._payload : Buffer.from(this._payload)
-      ])
-    } else {
-      toBeSigned = `${recipient.protected || ''}.${this._payload}`
     }
 
-    recipient.signature = base64url.encodeBuffer(sign(alg, key, toBeSigned))
+    const data = Buffer.concat([
+      Buffer.from(recipient.protected || ''),
+      Buffer.from('.'),
+      Buffer.from(this._payload)
+    ])
+
+    recipient.signature = base64url.encodeBuffer(sign(alg, key, data))
   }
 
   /*
@@ -130,9 +119,9 @@ class Sign {
 
     serializer.validate(this, this._recipients)
 
-    for (const recipient of this._recipients) {
-      this[PROCESS_RECIPIENT](recipient)
-    }
+    this._recipients.forEach((recipient, i) => {
+      this[PROCESS_RECIPIENT](recipient, i === 0)
+    })
 
     return serializer(this._payload, this._recipients)
   }

package/lib/jwt/verify.js

@@ -20,8 +20,8 @@ const isTimestamp = (value, label, required = false) => {
     throw new JWTClaimInvalid(`"${label}" claim is missing`, label, 'missing')
   }
 
-  if (value !== undefined && (typeof value !== 'number' || !Number.isSafeInteger(value))) {
-    throw new JWTClaimInvalid(`"${label}" claim must be a unix timestamp`, label, 'invalid')
+  if (value !== undefined && (typeof value !== 'number')) {
+    throw new JWTClaimInvalid(`"${label}" claim must be a JSON numeric value`, label, 'invalid')
   }
 }
 
@@ -63,12 +63,15 @@ const validateOptions = ({
 
   isOptionString(maxTokenAge, 'options.maxTokenAge')
   isOptionString(subject, 'options.subject')
-  isOptionString(issuer, 'options.issuer')
   isOptionString(maxAuthAge, 'options.maxAuthAge')
   isOptionString(jti, 'options.jti')
   isOptionString(clockTolerance, 'options.clockTolerance')
   isOptionString(typ, 'options.typ')
 
+  if (issuer !== undefined && (isNotString(issuer) && isNotArrayOfStrings(issuer))) {
+    throw new TypeError('options.issuer must be a string or an array of strings')
+  }
+
   if (audience !== undefined && (isNotString(audience) && isNotArrayOfStrings(audience))) {
     throw new TypeError('options.audience must be a string or an array of strings')
   }
@@ -161,7 +164,7 @@ const validateTypes = ({ header, payload }, profile, options) => {
   isPayloadString(payload.jti, '"jti" claim', 'jti', profile === LOGOUTTOKEN || profile === ATJWT || !!options.jti)
   isPayloadString(payload.acr, '"acr" claim', 'acr')
   isPayloadString(payload.nonce, '"nonce" claim', 'nonce', !!options.nonce)
-  isPayloadString(payload.iss, '"iss" claim', 'iss', !!options.issuer)
+  isStringOrArrayOfStrings(payload.iss, 'iss', !!options.issuer)
   isPayloadString(payload.sub, '"sub" claim', 'sub', profile === IDTOKEN || profile === ATJWT || !!options.subject)
   isStringOrArrayOfStrings(payload.aud, 'aud', !!options.audience)
   isPayloadString(payload.azp, '"azp" claim', 'azp', profile === IDTOKEN && Array.isArray(payload.aud) && payload.aud.length > 1)
@@ -235,7 +238,7 @@ module.exports = (token, key, options = {}) => {
   const unix = epoch(now)
   validateTypes(decoded, profile, options)
 
-  if (issuer && decoded.payload.iss !== issuer) {
+  if (issuer && (typeof decoded.payload.iss !== 'string' || !(typeof issuer === 'string' ? [issuer] : issuer).includes(decoded.payload.iss))) {
     throw new JWTClaimInvalid('unexpected "iss" claim value', 'iss', 'check_failed')
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jose",
-  "version": "1.27.0",
+  "version": "1.28.0",
   "description": "JSON Web Almost Everything - JWA, JWS, JWE, JWK, JWT, JWKS for Node.js with minimal dependencies",
   "keywords": [
     "access token",
@@ -81,11 +81,11 @@
     "@panva/asn1.js": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.3.4",
-    "@commitlint/config-conventional": "^8.3.4",
+    "@commitlint/cli": "^9.1.1",
+    "@commitlint/config-conventional": "^9.1.1",
     "ava": "^2.4.0",
     "babel-eslint": "^10.0.3",
-    "c8": "^7.0.0",
+    "c8": "^7.2.1",
     "husky": "^4.0.0",
     "standard": "^14.3.1"
   },

package/types/index.d.ts

@@ -444,7 +444,7 @@ export namespace JWT {
     ignoreIat?: boolean;
     maxTokenAge?: string;
     subject?: string;
-    issuer?: string;
+    issuer?: string | string[];
     maxAuthAge?: string;
     jti?: string;
     clockTolerance?: string;
@@ -479,7 +479,7 @@ export namespace JWT {
   function sign(payload: object, key: ProduceKeyInputWithNone, options?: SignOptions): string;
 
   interface VerifyProfileOptions<profile> {
-    issuer: string;
+    issuer: string | string[];
     audience: string | string[];
     profile?: profile;
   }