Merge pull request #57 from axa-group/ntk/fix_regression

When adding a key to the KeyStore, do not normalize key "use" value to "sig" when already defined

Author: nulltoken

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [3.0.3](https://github.com/axa-group/oauth2-mock-server/compare/v3.0.2...v3.0.3) — 2020-11-12
+
+### Fixed
+
+- Fix regression: When adding a key to the KeyStore, do not normalize key "use" value to "sig" when already defined
+
 ## [3.0.2](https://github.com/axa-group/oauth2-mock-server/compare/v3.0.1...v3.0.2) — 2020-10-29
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "oauth2-mock-server",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "OAuth 2 mock server",
   "keywords": [
     "oauth",
@@ -63,27 +63,27 @@
     "@types/basic-auth": "^1.1.3",
     "@types/body-parser": "^1.19.0",
     "@types/cors": "^2.8.8",
-    "@types/express": "^4.17.8",
+    "@types/express": "^4.17.9",
     "@types/jest": "^26.0.15",
     "@types/jsonwebtoken": "^8.5.0",
     "@types/lodash.isplainobject": "^4.0.6",
     "@types/node": "^10.17.44",
     "@types/supertest": "^2.0.10",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.6.0",
-    "@typescript-eslint/parser": "^4.6.0",
-    "eslint": "^7.12.1",
+    "@typescript-eslint/eslint-plugin": "^4.7.0",
+    "@typescript-eslint/parser": "^4.7.0",
+    "eslint": "^7.13.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.1.0",
-    "eslint-plugin-jsdoc": "^30.7.3",
+    "eslint-plugin-jsdoc": "^30.7.7",
     "eslint-plugin-prettier": "^3.1.4",
-    "jest": "^26.6.1",
+    "jest": "^26.6.3",
     "jest-junit": "^12.0.0",
     "prettier": "^2.1.2",
     "rimraf": "^3.0.2",
-    "supertest": "^6.0.0",
-    "ts-jest": "^26.4.3",
+    "supertest": "^6.0.1",
+    "ts-jest": "^26.4.4",
     "ts-node": "^9.0.0",
     "typescript": "^4.0.5"
   }

src/lib/jwk-store.ts

@@ -61,7 +61,11 @@ export class JWKStore {
    * @returns {Promise<JWK.Key>} The promise for the added key.
    */
   async add(jwk: JWK.Key): Promise<JWK.Key> {
-    const jwkUse: JWK.Key = { ...jwk, use: 'sig' };
+    const jwkUse: JWK.Key = { ...jwk };
+
+    if (!('use' in jwkUse)) {
+      Object.assign(jwkUse, { use: 'sig' });
+    }
 
     const key = await this.#store.add(jwkUse);
     this.#keyRotator.add(key);

test/jwk-store.test.ts

@@ -1,3 +1,4 @@
+import type { JWK } from 'node-jose';
 import { JWKStore } from '../src/lib/jwk-store';
 import * as testKeys from './keys';
 
@@ -122,4 +123,40 @@ describe('JWK Store', () => {
       expect(jwk).toHaveProperty(prop);
     });
   });
+
+  it('should normalize key "use" value to "sig" when unset', async () => {
+    const initialKey = testKeys.getParsed('test-rsa-key.json')
+
+    expect(initialKey).not.toHaveProperty("use");
+
+    const store = new JWKStore();
+    const key = await store.add(initialKey);
+
+    expect(key).toHaveProperty("use");
+    expect(key.use).toEqual("sig")
+
+    const retrievedKey = store.get(key.kid)
+
+    expect(retrievedKey).toHaveProperty("use");
+    expect(key.use).toEqual("sig")
+  })
+
+  it('should preserve key "use" value when set', async () => {
+    const initialKey = testKeys.getParsed('test-rsa-key.json')
+
+    expect(initialKey).not.toHaveProperty("use");
+
+    const keyWithUseProperty: JWK.Key = { ...initialKey, use: 'enc' }
+
+    const store = new JWKStore();
+    const key = await store.add(keyWithUseProperty);
+
+    expect(key).toHaveProperty("use");
+    expect(key.use).toEqual("enc")
+
+    const retrievedKey = store.get(key.kid)
+
+    expect(retrievedKey).toHaveProperty("use");
+    expect(key.use).toEqual("enc")
+  })
 });