@squiz/dx-common-lib 1.39.1-alpha.11 → 1.39.1-alpha.14

package/.npm/_logs/{2023-06-27T01_19_15_613Z-debug-0.log → 2023-06-27T07_36_54_939Z-debug-0.log}

@@ -2,11 +2,11 @@
 1 info using npm@9.5.0
 2 info using node@v18.15.0
 3 timing npm:load:whichnode Completed in 1ms
-4 timing config:load:defaults Completed in 3ms
-5 timing config:load:file:/usr/local/lib/node_modules/npm/npmrc Completed in 0ms
-6 timing config:load:builtin Completed in 0ms
+4 timing config:load:defaults Completed in 2ms
+5 timing config:load:file:/usr/local/lib/node_modules/npm/npmrc Completed in 1ms
+6 timing config:load:builtin Completed in 1ms
 7 timing config:load:cli Completed in 2ms
-8 timing config:load:env Completed in 2ms
+8 timing config:load:env Completed in 1ms
 9 info found workspace root at /builds/developer-experience/cmp
 10 timing config:load:file:/builds/developer-experience/cmp/.npmrc Completed in 0ms
 11 timing config:load:project Completed in 24ms
@@ -15,23 +15,23 @@
 14 timing config:load:file:/usr/local/etc/npmrc Completed in 0ms
 15 timing config:load:global Completed in 0ms
 16 timing config:load:setEnvs Completed in 1ms
-17 timing config:load Completed in 34ms
-18 timing npm:load:configload Completed in 34ms
+17 timing config:load Completed in 33ms
+18 timing npm:load:configload Completed in 33ms
 19 timing npm:load:mkdirpcache Completed in 0ms
 20 timing npm:load:mkdirplogs Completed in 0ms
 21 verbose title npm run compile
 22 verbose argv "run" "compile" "--"
-23 timing npm:load:setTitle Completed in 1ms
-24 timing config:load:flatten Completed in 5ms
-25 timing npm:load:display Completed in 6ms
-26 verbose logfile logs-max:10 dir:/builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-06-27T01_19_15_613Z-
-27 verbose logfile /builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-06-27T01_19_15_613Z-debug-0.log
+23 timing npm:load:setTitle Completed in 2ms
+24 timing config:load:flatten Completed in 4ms
+25 timing npm:load:display Completed in 5ms
+26 verbose logfile logs-max:10 dir:/builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-06-27T07_36_54_939Z-
+27 verbose logfile /builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-06-27T07_36_54_939Z-debug-0.log
 28 timing npm:load:logFile Completed in 3ms
-29 timing npm:load:timers Completed in 1ms
+29 timing npm:load:timers Completed in 0ms
 30 timing npm:load:configScope Completed in 0ms
-31 timing npm:load Completed in 47ms
+31 timing npm:load Completed in 46ms
 32 silly logfile done cleaning log files
-33 timing command:run Completed in 4049ms
+33 timing command:run Completed in 3895ms
 34 verbose exit 0
-35 timing npm Completed in 4109ms
+35 timing npm Completed in 3952ms
 36 info ok

package/lib/api-key-validation/ApiKeyValidationService.d.ts

@@ -1,5 +1,10 @@
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
 export interface ApiKeyValidationService {
-    keyIsValid(key: string | undefined): boolean;
-    matrixKeyIsValid(key: string | undefined): boolean;
-    getMatrixKeys(): string[];
+    interServiceKeyIsValid(key: string | undefined): boolean;
+    /**
+     * @deprecated Suggest moving towards using JWT authentication.
+     */
+    matrixKeyIsValid(key: string | undefined, request: IncomingMessage): boolean;
+    getInterServiceKeys(): string[];
 }

package/lib/api-key-validation/CloudflareApiKeyService.d.ts

@@ -1,18 +1,23 @@
+/// <reference types="node" />
 import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { ApiKeyValidationService } from './ApiKeyValidationService';
 import { Logger } from '@squiz/dx-logger-lib';
+import { IncomingMessage } from 'http';
 export interface CloudFlareKeys {
-    keys: string[];
     'matrix-keys': string[];
+    'inter-service-keys': string[];
 }
 export declare class CloudflareApiKeyService implements ApiKeyValidationService {
     protected secretName: string;
     protected secretsClient: SecretsManagerClient;
     protected logger: Logger;
     constructor(secretName: string, logger?: Logger);
-    keyIsValid(key: string): boolean;
-    matrixKeyIsValid(key: string): boolean;
+    /**
+     * @deprecated Suggest moving towards using JWT authentication.
+     */
+    matrixKeyIsValid(key: string, request: IncomingMessage): boolean;
+    interServiceKeyIsValid(key: string): boolean;
     protected getValidApiKeys(): Promise<CloudFlareKeys>;
     refreshApiKeys(): Promise<void>;
-    getMatrixKeys(): string[];
+    getInterServiceKeys(): string[];
 }

package/lib/api-key-validation/CloudflareApiKeyService.js

@@ -5,8 +5,8 @@ const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
 const UnAuthenticatedRequestError_1 = require("../error/UnAuthenticatedRequestError");
 const dx_logger_lib_1 = require("@squiz/dx-logger-lib");
 let validKeys = {
-    keys: [],
     'matrix-keys': [],
+    'inter-service-keys': [],
 };
 let refreshInterval;
 // number must be smaller than 24 days.
@@ -23,17 +23,28 @@ class CloudflareApiKeyService {
         }
         this.logger = logger;
     }
-    keyIsValid(key) {
-        if (validKeys.keys.length == 0) {
+    /**
+     * @deprecated Suggest moving towards using JWT authentication.
+     */
+    matrixKeyIsValid(key, request) {
+        var _a;
+        if (validKeys['matrix-keys'].length == 0) {
             throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against');
         }
-        return validKeys.keys.includes(key);
+        if (validKeys['matrix-keys'].includes(key)) {
+            this.logger.info('Request authenticated using legacy Matrix API key', {
+                url: request.url,
+                userAgent: (_a = request.headers) === null || _a === void 0 ? void 0 : _a['user-agent'],
+            });
+            return true;
+        }
+        return false;
     }
-    matrixKeyIsValid(key) {
-        if (validKeys['matrix-keys'].length == 0) {
-            throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against');
+    interServiceKeyIsValid(key) {
+        if (validKeys['inter-service-keys'].length == 0) {
+            throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No inter service api keys to check against');
         }
-        return validKeys['matrix-keys'].includes(key);
+        return validKeys['inter-service-keys'].includes(key);
     }
     async getValidApiKeys() {
         let secretValue;
@@ -51,7 +62,7 @@ class CloudflareApiKeyService {
                 throw new Error('cloudflare api key SecretString undefined');
             }
             const secret = JSON.parse(secretValue.SecretString);
-            if (secret.keys) {
+            if (secret['matrix-keys'] && secret['inter-service-keys']) {
                 return secret;
             }
             throw new Error('api keys retrieved and decoded successfully but contained no values');
@@ -63,7 +74,8 @@ class CloudflareApiKeyService {
     async refreshApiKeys() {
         this.logger.info('refreshing keys');
         validKeys = await this.getValidApiKeys();
-        this.logger.info(`number of valid keys found: ${validKeys.keys.length}`);
+        this.logger.info(`found ${validKeys['matrix-keys'].length} valid matrix keys`);
+        this.logger.info(`found ${validKeys['inter-service-keys'].length} valid inter service keys`);
         if (!refreshInterval) {
             refreshInterval = setInterval(async () => {
                 await this.refreshApiKeys();
@@ -71,8 +83,8 @@ class CloudflareApiKeyService {
         }
     }
     // temporary method, to be removed when DXP auth is properly implemented
-    getMatrixKeys() {
-        return validKeys['matrix-keys'];
+    getInterServiceKeys() {
+        return validKeys['inter-service-keys'];
     }
 }
 exports.CloudflareApiKeyService = CloudflareApiKeyService;

package/lib/api-key-validation/CloudflareApiKeyService.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloudflareApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.ts"],"names":[],"mappings":";;;AAAA,4EAIyC;AACzC,sFAAmF;AAEnF,wDAAyD;AAOzD,IAAI,SAAS,GAAmB;IAC9B,IAAI,EAAE,EAAE;IACR,aAAa,EAAE,EAAE;CAClB,CAAC;AAEF,IAAI,eAA+C,CAAC;AACpD,uCAAuC;AACvC,2EAA2E;AAC3E,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,qCAAqC;AAEjF,MAAa,uBAAuB;IAIlC,YAAsB,UAAkB,EAAE,MAAe;QAAnC,eAAU,GAAV,UAAU,CAAQ;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,6CAAoB,CAAC;YAC5C,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,UAAU,CAAC,GAAW;QAC3B,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAAC;SACvE;QAED,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;YACxC,MAAM,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAAC;SACvE;QAED,OAAO,SAAS,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,eAAe;QAC7B,IAAI,WAAwC,CAAC;QAE7C,IAAI;YACF,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CACzC,IAAI,8CAAqB,CAAC;gBACxB,QAAQ,EAAE,IAAI,CAAC,UAAU;aAC1B,CAAC,CACH,CAAC;SACH;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;SACnE;QAED,IAAI;YACF,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;aAC9D;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAEpD,IAAI,MAAM,CAAC,IAAI,EAAE;gBACf,OAAO,MAAM,CAAC;aACf;YAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;IACH,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAEzE,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;gBACvC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9B,CAAC,EAAE,aAAa,CAAC,CAAC;SACnB;IACH,CAAC;IAED,wEAAwE;IACxE,aAAa;QACX,OAAO,SAAS,CAAC,aAAa,CAAC,CAAC;IAClC,CAAC;CACF;AA/ED,0DA+EC"}
+{"version":3,"file":"CloudflareApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.ts"],"names":[],"mappings":";;;AAAA,4EAIyC;AACzC,sFAAmF;AAEnF,wDAAyD;AAQzD,IAAI,SAAS,GAAmB;IAC9B,aAAa,EAAE,EAAE;IACjB,oBAAoB,EAAE,EAAE;CACzB,CAAC;AAEF,IAAI,eAA+C,CAAC;AACpD,uCAAuC;AACvC,2EAA2E;AAC3E,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,qCAAqC;AAEjF,MAAa,uBAAuB;IAIlC,YAAsB,UAAkB,EAAE,MAAe;QAAnC,eAAU,GAAV,UAAU,CAAQ;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,6CAAoB,CAAC;YAC5C,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,GAAW,EAAE,OAAwB;;QAC3D,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;YACxC,MAAM,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAAC;SACvE;QAED,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mDAAmD,EAAE;gBACpE,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,SAAS,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,YAAY,CAAC;aAC3C,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,sBAAsB,CAAC,GAAW;QACvC,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;YAC/C,MAAM,IAAI,yDAA2B,CAAC,4CAA4C,CAAC,CAAC;SACrF;QAED,OAAO,SAAS,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAES,KAAK,CAAC,eAAe;QAC7B,IAAI,WAAwC,CAAC;QAE7C,IAAI;YACF,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CACzC,IAAI,8CAAqB,CAAC;gBACxB,QAAQ,EAAE,IAAI,CAAC,UAAU;aAC1B,CAAC,CACH,CAAC;SACH;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;SACnE;QAED,IAAI;YACF,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;aAC9D;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAEpD,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,MAAM,CAAC,oBAAoB,CAAC,EAAE;gBACzD,OAAO,MAAM,CAAC;aACf;YAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;IACH,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,aAAa,CAAC,CAAC,MAAM,oBAAoB,CAAC,CAAC;QAC/E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,oBAAoB,CAAC,CAAC,MAAM,2BAA2B,CAAC,CAAC;QAE7F,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;gBACvC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9B,CAAC,EAAE,aAAa,CAAC,CAAC;SACnB;IACH,CAAC;IAED,wEAAwE;IACjE,mBAAmB;QACxB,OAAO,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACzC,CAAC;CACF;AA5FD,0DA4FC"}

package/lib/api-key-validation/CloudflareApiKeyService.spec.js

@@ -15,14 +15,14 @@ describe('CloudflareApiKeyService', () => {
         });
         it('should make a request to the aws secrets manager when refreshing the keys', async () => {
             sendSpy.mockClear();
-            sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+            sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }));
             await service.refreshApiKeys();
             expect(sendSpy.mock.lastCall[0].input).toEqual({ SecretId: 'my-secret-name' });
             expect(sendSpy.mock.lastCall[0]).toBeInstanceOf(client_secrets_manager_1.GetSecretValueCommand);
         });
         it('should start a refresh timer once called, but only once', (done) => {
             sendSpy.mockClear();
-            sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":["my-new-key"]}' }));
+            sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":["my-new-key"]}' }));
             const spy = jest.spyOn(service, 'refreshApiKeys');
             expect(spy).not.toBeCalled();
             expect(setInterval).toHaveBeenCalledTimes(1); // for the above 2 tests
@@ -30,62 +30,65 @@ describe('CloudflareApiKeyService', () => {
             expect(spy).toHaveBeenCalled();
             jest.useRealTimers();
             setTimeout(() => {
-                expect(service.keyIsValid('my-new-key')).toEqual(true);
+                expect(service.interServiceKeyIsValid('my-new-key')).toEqual(true);
                 done();
             }, 5);
         });
     });
-    describe('keyIsValid', () => {
+    describe('matrixKeyIsValid', () => {
         describe('when there are no api keys', () => {
             beforeAll(async () => {
-                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }));
                 await service.refreshApiKeys();
             });
             it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
-                expect(() => service.keyIsValid('anything')).toThrowError(new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against'));
+                expect(() => service.matrixKeyIsValid('anything', {})).toThrowError(new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against'));
             });
         });
         describe('when there are api keys', () => {
             beforeAll(async () => {
-                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }));
+                sendSpy.mockImplementation(() => Promise.resolve({
+                    SecretString: '{"matrix-keys":["my-matrix-key"], "inter-service-keys":["my-inter-service-key"]}',
+                }));
                 await service.refreshApiKeys();
             });
-            it('should return true when there are keys loaded and the input key is in the list of valid keys', () => {
-                expect(service.keyIsValid('my-key')).toEqual(true);
-                expect(service.keyIsValid('my-other-key')).toEqual(true);
+            it('should return true when there are keys loaded and the input key is in the list of valid matrix keys', () => {
+                expect(service.matrixKeyIsValid('my-matrix-key', {})).toEqual(true);
             });
-            it('should return false when there are keys loaded and the input key is not in the list of valid keys', async () => {
-                expect(service.keyIsValid('not-my-key')).toEqual(false);
+            it('should return false when there are keys loaded and the input key is not in the list of valid matrix keys', async () => {
+                expect(service.matrixKeyIsValid('not-my-key', {})).toEqual(false);
             });
-            it('should return false if trying to validate a matrix key', () => {
-                expect(service.keyIsValid('my-matrix-key')).toEqual(false);
+            it('should return false when using non matrix keys', async () => {
+                expect(service.matrixKeyIsValid('my-inter-service-key', {})).toEqual(false);
             });
         });
     });
-    describe('matrixKeyIsValid', () => {
+    describe('interServiceKeyIsValid', () => {
         describe('when there are no api keys', () => {
             beforeAll(async () => {
-                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[], "matrix-keys":[]}' }));
+                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }));
                 await service.refreshApiKeys();
             });
             it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
-                expect(() => service.matrixKeyIsValid('anything')).toThrowError(new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against'));
+                expect(() => service.interServiceKeyIsValid('anything')).toThrowError(new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No inter service api keys to check against'));
             });
         });
         describe('when there are api keys', () => {
             beforeAll(async () => {
-                sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }));
+                sendSpy.mockImplementation(() => Promise.resolve({
+                    SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"], "inter-service-keys":["my-inter-service-key"]}',
+                }));
                 await service.refreshApiKeys();
             });
             it('should return true when there are keys loaded and the input key is in the list of valid matrix keys', () => {
-                expect(service.matrixKeyIsValid('my-matrix-key')).toEqual(true);
+                expect(service.interServiceKeyIsValid('my-inter-service-key')).toEqual(true);
             });
             it('should return false when there are keys loaded and the input key is not in the list of valid matrix keys', async () => {
-                expect(service.matrixKeyIsValid('not-my-key')).toEqual(false);
+                expect(service.interServiceKeyIsValid('not-my-key')).toEqual(false);
             });
-            it('should return false when using non matrix keys', async () => {
-                expect(service.matrixKeyIsValid('my-key')).toEqual(false);
-                expect(service.matrixKeyIsValid('my-other-key')).toEqual(false);
+            it('should return false when using non inter-service keys', async () => {
+                expect(service.interServiceKeyIsValid('my-key')).toEqual(false);
+                expect(service.interServiceKeyIsValid('my-matrix-key')).toEqual(false);
             });
         });
     });

package/lib/api-key-validation/CloudflareApiKeyService.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloudflareApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,4EAA8F;AAC9F,sFAAmF;AACnF,uEAAoE;AAEpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,6CAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAEnE,IAAI,CAAC,aAAa,EAAE,CAAC;AACrB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAElC,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,OAAO,GAAG,IAAI,iDAAuB,CAAC,gBAAgB,CAAC,CAAC;IAE9D,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAEpF,MAAM,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CACzD,IAAI,KAAK,CAAC,4CAA4C,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YACvF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YAE/B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC/E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,8CAAqB,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,CAAC,IAAI,EAAE,EAAE;YACrE,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC;YACnG,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;YACtE,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,MAAM,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAE/B,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACvD,IAAI,EAAE,CAAC;YACT,CAAC,EAAE,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;gBACnF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CACvD,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,sEAAsE,EAAE,CAAC,CAC1G,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,8FAA8F,EAAE,GAAG,EAAE;gBACtG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACnD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mGAAmG,EAAE,KAAK,IAAI,EAAE;gBACjH,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;gBAChE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,+BAA+B,EAAE,CAAC,CAAC,CAAC;gBACrG,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAC7D,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,sEAAsE,EAAE,CAAC,CAC1G,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qGAAqG,EAAE,GAAG,EAAE;gBAC7G,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;gBACxH,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;gBAC9D,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC1D,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"CloudflareApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,4EAA8F;AAC9F,sFAAmF;AACnF,uEAAoE;AAGpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,6CAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAEnE,IAAI,CAAC,aAAa,EAAE,CAAC;AACrB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAElC,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,OAAO,GAAG,IAAI,iDAAuB,CAAC,gBAAgB,CAAC,CAAC;IAE9D,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAEpF,MAAM,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CACzD,IAAI,KAAK,CAAC,4CAA4C,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,6CAA6C,EAAE,CAAC,CACjF,CAAC;YACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YAE/B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC/E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,8CAAqB,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,CAAC,IAAI,EAAE,EAAE;YACrE,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,yDAAyD,EAAE,CAAC,CAC7F,CAAC;YACF,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;YACtE,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,MAAM,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAE/B,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACnE,IAAI,EAAE,CAAC;YACT,CAAC,EAAE,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,6CAA6C,EAAE,CAAC,CACjF,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,EAAqB,CAAC,CAAC,CAAC,YAAY,CACpF,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC;oBACd,YAAY,EAAE,kFAAkF;iBACjG,CAAC,CACH,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qGAAqG,EAAE,GAAG,EAAE;gBAC7G,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,EAAE,EAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;gBACxH,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,EAAE,EAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;gBAC9D,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,EAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACjG,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,6CAA6C,EAAE,CAAC,CACjF,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CACnE,IAAI,yDAA2B,CAAC,4CAA4C,CAAC,CAC9E,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC;oBACd,YAAY,EACV,qHAAqH;iBACxH,CAAC,CACH,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qGAAqG,EAAE,GAAG,EAAE;gBAC7G,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,sBAAsB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;gBACxH,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;gBACrE,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAChE,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/api-key-validation/DevelopmentApiKeyService.d.ts

@@ -1,6 +1,11 @@
+/// <reference types="node" />
+import { Logger } from '@squiz/dx-logger-lib';
 import { ApiKeyValidationService } from './ApiKeyValidationService';
+import { IncomingMessage } from 'http';
 export declare class DevelopmentApiKeyService implements ApiKeyValidationService {
-    keyIsValid(): boolean;
-    matrixKeyIsValid(): boolean;
-    getMatrixKeys(): string[];
+    private logger;
+    constructor(logger?: Logger);
+    matrixKeyIsValid(key: string | undefined, request: IncomingMessage): boolean;
+    interServiceKeyIsValid(key: string | undefined): boolean;
+    getInterServiceKeys(): string[];
 }

package/lib/api-key-validation/DevelopmentApiKeyService.js

@@ -1,16 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DevelopmentApiKeyService = void 0;
+const dx_logger_lib_1 = require("@squiz/dx-logger-lib");
 class DevelopmentApiKeyService {
-    keyIsValid() {
-        return true;
+    constructor(logger) {
+        this.logger = logger || (0, dx_logger_lib_1.getLogger)({ name: 'DevelopmentApiKeyService' });
     }
-    matrixKeyIsValid() {
+    matrixKeyIsValid(key, request) {
+        var _a;
+        this.logger.info('Request authenticated using legacy Matrix API key', {
+            url: request.url,
+            userAgent: (_a = request.headers) === null || _a === void 0 ? void 0 : _a['user-agent'],
+        });
         return true;
     }
+    interServiceKeyIsValid(key) {
+        return Boolean(key && this.getInterServiceKeys().includes(key));
+    }
     // temporary method, to be removed when DXP auth is properly implemented
-    getMatrixKeys() {
-        return ['matrix-api-key'];
+    getInterServiceKeys() {
+        return ['inter-service-api-key'];
     }
 }
 exports.DevelopmentApiKeyService = DevelopmentApiKeyService;

package/lib/api-key-validation/DevelopmentApiKeyService.js.map

@@ -1 +1 @@
-{"version":3,"file":"DevelopmentApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.ts"],"names":[],"mappings":";;;AAEA,MAAa,wBAAwB;IAC5B,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IACM,gBAAgB;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,wEAAwE;IACxE,aAAa;QACX,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;CACF;AAXD,4DAWC"}
+{"version":3,"file":"DevelopmentApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.ts"],"names":[],"mappings":";;;AAAA,wDAAyD;AAIzD,MAAa,wBAAwB;IAGnC,YAAmB,MAAe;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;IAC1E,CAAC;IACM,gBAAgB,CAAC,GAAuB,EAAE,OAAwB;;QACvE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mDAAmD,EAAE;YACpE,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,SAAS,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,YAAY,CAAC;SAC3C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,sBAAsB,CAAC,GAAuB;QACnD,OAAO,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,wEAAwE;IACjE,mBAAmB;QACxB,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACnC,CAAC;CACF;AApBD,4DAoBC"}

package/lib/api-key-validation/DevelopmentApiKeyService.spec.js

@@ -1,16 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const DevelopmentApiKeyService_1 = require("./DevelopmentApiKeyService");
+const dx_logger_lib_1 = require("@squiz/dx-logger-lib");
 describe('DevelopmentApiKeyService', () => {
-    const service = new DevelopmentApiKeyService_1.DevelopmentApiKeyService();
-    describe('keyIsValid', () => {
+    const service = new DevelopmentApiKeyService_1.DevelopmentApiKeyService((0, dx_logger_lib_1.getLogger)({ name: 'test', silent: true }));
+    describe('matrixKeyIsValid', () => {
         it('should always return true', () => {
-            expect(service.keyIsValid()).toEqual(true);
+            expect(service.matrixKeyIsValid(undefined, {})).toEqual(true);
         });
     });
-    describe('matrixKeyIsValid', () => {
-        it('should always return true', () => {
-            expect(service.matrixKeyIsValid()).toEqual(true);
+    describe('interServiceKeyIsValid', () => {
+        it('should return true if key is "inter-service-api-key"', () => {
+            expect(service.interServiceKeyIsValid('inter-service-api-key')).toEqual(true);
+        });
+        it('should return false if key is not "inter-service-api-key"', () => {
+            expect(service.interServiceKeyIsValid('invalid-api-key')).toEqual(false);
         });
     });
 });

package/lib/api-key-validation/DevelopmentApiKeyService.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"DevelopmentApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,yEAAsE;AAEtE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,OAAO,GAAG,IAAI,mDAAwB,EAAE,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"DevelopmentApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,yEAAsE;AAEtE,wDAAiD;AAEjD,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,OAAO,GAAG,IAAI,mDAAwB,CAAC,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAExF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -8,7 +8,6 @@ export * from './api-key-validation/ApiKeyValidationService';
 export * from './api-key-validation/CloudflareApiKeyService';
 export * from './api-key-validation/DevelopmentApiKeyService';
 export * from './api-key-validation/getApiKeyService';
-export * from './server-utils/apiKeyMiddleware';
 export * from './cache';
 export * from './formatted-text/formattedTextToHtmlString';
 export * from './json-order';

package/lib/index.js

@@ -24,7 +24,6 @@ __exportStar(require("./api-key-validation/ApiKeyValidationService"), exports);
 __exportStar(require("./api-key-validation/CloudflareApiKeyService"), exports);
 __exportStar(require("./api-key-validation/DevelopmentApiKeyService"), exports);
 __exportStar(require("./api-key-validation/getApiKeyService"), exports);
-__exportStar(require("./server-utils/apiKeyMiddleware"), exports);
 __exportStar(require("./cache"), exports);
 __exportStar(require("./formatted-text/formattedTextToHtmlString"), exports);
 __exportStar(require("./json-order"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,kEAAgD;AAChD,0CAAwB;AACxB,6EAA2D;AAC3D,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,0CAAwB;AACxB,6EAA2D;AAC3D,+CAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-common-lib",
-  "version": "1.39.1-alpha.11",
+  "version": "1.39.1-alpha.14",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -13,8 +13,8 @@
   "license": "ISC",
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "3.218.0",
-    "@squiz/dx-json-schema-lib": "1.39.1-alpha.11",
-    "@squiz/dx-logger-lib": "1.39.1-alpha.11",
+    "@squiz/dx-json-schema-lib": "1.39.1-alpha.14",
+    "@squiz/dx-logger-lib": "1.39.1-alpha.14",
     "archiver": "5.3.1",
     "escape-string-regexp": "4.0.0",
     "fs-extra": "11.1.0",
@@ -35,5 +35,5 @@
     "ts-node": "10.9.1",
     "typescript": "4.9.4"
   },
-  "gitHead": "788f8adc16c48ce3121dca04ca370ebc2c537758"
+  "gitHead": "258c9a26d3df69659115b7c74a79aed405e4bf5a"
 }

package/src/api-key-validation/ApiKeyValidationService.ts

@@ -1,5 +1,11 @@
+import { IncomingMessage } from 'http';
+
 export interface ApiKeyValidationService {
-  keyIsValid(key: string | undefined): boolean;
-  matrixKeyIsValid(key: string | undefined): boolean;
-  getMatrixKeys(): string[];
+  interServiceKeyIsValid(key: string | undefined): boolean;
+
+  /**
+   * @deprecated Suggest moving towards using JWT authentication.
+   */
+  matrixKeyIsValid(key: string | undefined, request: IncomingMessage): boolean;
+  getInterServiceKeys(): string[];
 }

package/src/api-key-validation/CloudflareApiKeyService.spec.ts

@@ -1,6 +1,7 @@
 import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { UnAuthenticatedRequestError } from '../error/UnAuthenticatedRequestError';
 import { CloudflareApiKeyService } from './CloudflareApiKeyService';
+import { IncomingMessage } from 'http';
 
 const sendSpy = jest.spyOn(SecretsManagerClient.prototype, 'send');
 
@@ -21,7 +22,9 @@ describe('CloudflareApiKeyService', () => {
 
     it('should make a request to the aws secrets manager when refreshing the keys', async () => {
       sendSpy.mockClear();
-      sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+      sendSpy.mockImplementationOnce(() =>
+        Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }),
+      );
       await service.refreshApiKeys();
 
       expect(sendSpy.mock.lastCall[0].input).toEqual({ SecretId: 'my-secret-name' });
@@ -30,7 +33,9 @@ describe('CloudflareApiKeyService', () => {
 
     it('should start a refresh timer once called, but only once', (done) => {
       sendSpy.mockClear();
-      sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":["my-new-key"]}' }));
+      sendSpy.mockImplementationOnce(() =>
+        Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":["my-new-key"]}' }),
+      );
       const spy = jest.spyOn(service, 'refreshApiKeys');
 
       expect(spy).not.toBeCalled();
@@ -41,21 +46,23 @@ describe('CloudflareApiKeyService', () => {
 
       jest.useRealTimers();
       setTimeout(() => {
-        expect(service.keyIsValid('my-new-key')).toEqual(true);
+        expect(service.interServiceKeyIsValid('my-new-key')).toEqual(true);
         done();
       }, 5);
     });
   });
 
-  describe('keyIsValid', () => {
+  describe('matrixKeyIsValid', () => {
     describe('when there are no api keys', () => {
       beforeAll(async () => {
-        sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+        sendSpy.mockImplementation(() =>
+          Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }),
+        );
         await service.refreshApiKeys();
       });
 
       it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
-        expect(() => service.keyIsValid('anything')).toThrowError(
+        expect(() => service.matrixKeyIsValid('anything', {} as IncomingMessage)).toThrowError(
           new UnAuthenticatedRequestError('No api keys to check against'),
         );
       });
@@ -64,35 +71,39 @@ describe('CloudflareApiKeyService', () => {
     describe('when there are api keys', () => {
       beforeAll(async () => {
         sendSpy.mockImplementation(() =>
-          Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }),
+          Promise.resolve({
+            SecretString: '{"matrix-keys":["my-matrix-key"], "inter-service-keys":["my-inter-service-key"]}',
+          }),
         );
         await service.refreshApiKeys();
       });
-      it('should return true when there are keys loaded and the input key is in the list of valid keys', () => {
-        expect(service.keyIsValid('my-key')).toEqual(true);
-        expect(service.keyIsValid('my-other-key')).toEqual(true);
+
+      it('should return true when there are keys loaded and the input key is in the list of valid matrix keys', () => {
+        expect(service.matrixKeyIsValid('my-matrix-key', {} as IncomingMessage)).toEqual(true);
       });
 
-      it('should return false when there are keys loaded and the input key is not in the list of valid keys', async () => {
-        expect(service.keyIsValid('not-my-key')).toEqual(false);
+      it('should return false when there are keys loaded and the input key is not in the list of valid matrix keys', async () => {
+        expect(service.matrixKeyIsValid('not-my-key', {} as IncomingMessage)).toEqual(false);
       });
 
-      it('should return false if trying to validate a matrix key', () => {
-        expect(service.keyIsValid('my-matrix-key')).toEqual(false);
+      it('should return false when using non matrix keys', async () => {
+        expect(service.matrixKeyIsValid('my-inter-service-key', {} as IncomingMessage)).toEqual(false);
       });
     });
   });
 
-  describe('matrixKeyIsValid', () => {
+  describe('interServiceKeyIsValid', () => {
     describe('when there are no api keys', () => {
       beforeAll(async () => {
-        sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[], "matrix-keys":[]}' }));
+        sendSpy.mockImplementation(() =>
+          Promise.resolve({ SecretString: '{"matrix-keys":[], "inter-service-keys":[]}' }),
+        );
         await service.refreshApiKeys();
       });
 
       it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
-        expect(() => service.matrixKeyIsValid('anything')).toThrowError(
-          new UnAuthenticatedRequestError('No api keys to check against'),
+        expect(() => service.interServiceKeyIsValid('anything')).toThrowError(
+          new UnAuthenticatedRequestError('No inter service api keys to check against'),
         );
       });
     });
@@ -100,22 +111,25 @@ describe('CloudflareApiKeyService', () => {
     describe('when there are api keys', () => {
       beforeAll(async () => {
         sendSpy.mockImplementation(() =>
-          Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }),
+          Promise.resolve({
+            SecretString:
+              '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"], "inter-service-keys":["my-inter-service-key"]}',
+          }),
         );
         await service.refreshApiKeys();
       });
 
       it('should return true when there are keys loaded and the input key is in the list of valid matrix keys', () => {
-        expect(service.matrixKeyIsValid('my-matrix-key')).toEqual(true);
+        expect(service.interServiceKeyIsValid('my-inter-service-key')).toEqual(true);
       });
 
       it('should return false when there are keys loaded and the input key is not in the list of valid matrix keys', async () => {
-        expect(service.matrixKeyIsValid('not-my-key')).toEqual(false);
+        expect(service.interServiceKeyIsValid('not-my-key')).toEqual(false);
       });
 
-      it('should return false when using non matrix keys', async () => {
-        expect(service.matrixKeyIsValid('my-key')).toEqual(false);
-        expect(service.matrixKeyIsValid('my-other-key')).toEqual(false);
+      it('should return false when using non inter-service keys', async () => {
+        expect(service.interServiceKeyIsValid('my-key')).toEqual(false);
+        expect(service.interServiceKeyIsValid('my-matrix-key')).toEqual(false);
       });
     });
   });