@contrast/core 1.45.1 → 1.46.0

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@contrast/core",
-  "version": "1.45.1",
+  "version": "1.46.0",
   "description": "Preconfigured Contrast agent core services and models",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
   "files": [
-    "lib/"
+    "lib/",
+    "!*.test.*",
+    "!tsconfig.*",
+    "!*.map"
   ],
   "types": "lib/index.d.ts",
   "engines": {
@@ -16,12 +19,12 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.29.1",
-    "@contrast/config": "1.40.1",
+    "@contrast/common": "1.30.0",
+    "@contrast/config": "1.41.0",
     "@contrast/find-package-json": "^1.1.0",
     "@contrast/fn-inspect": "^4.3.0",
-    "@contrast/logger": "1.18.1",
-    "@contrast/patcher": "1.17.1",
+    "@contrast/logger": "1.19.0",
+    "@contrast/patcher": "1.18.0",
     "@tsxper/crc32": "^2.1.3",
     "axios": "^1.7.4",
     "semver": "^7.6.0"

package/lib/app-info.test.js

@@ -1,189 +0,0 @@
-'use strict';
-
-const sinon = require('sinon');
-const { expect } = require('chai');
-const proxyquire = require('proxyquire');
-const mocks = require('@contrast/test/mocks');
-
-describe('core app-info', function () {
-  let os, core, appInfo;
-
-  beforeEach(function () {
-    core = mocks.core();
-    core.config = mocks.config();
-    core.config.server.type = 'Node.js';
-    core.config.server.environment = 'PRODUCTION';
-    core.logger = mocks.logger();
-    core.config.server.name = 'zoing';
-
-    os = {
-      type: sinon.stub().returns('Linux'),
-      platform: sinon.stub().returns('linux'),
-      arch: sinon.stub().returns('x64'),
-      release: sinon.stub().returns('1.23.45'),
-      hostname: sinon.stub().returns('hostname'),
-    };
-  });
-
-  it('builds out app data from os and process information', function () {
-    appInfo = proxyquire(
-      './app-info',
-      {
-        os,
-        process: {
-          ...process,
-          argv: ['node', __filename],
-          version: 'v14.17.5'
-        }
-      }
-    )(core);
-
-    expect(appInfo).to.deep.include({
-      os: {
-        type: 'Linux',
-        platform: 'linux',
-        architecture: 'x64',
-        release: '1.23.45'
-      },
-      hostname: 'hostname',
-      indexFile: __filename,
-      serverVersion: undefined,
-      nodeVersion: 'v14.17.5',
-      appPath: '/',
-      serverName: 'zoing',
-      serverType: 'Node.js',
-      serverEnvironment: 'PRODUCTION',
-      group: undefined,
-      metadata: undefined
-    });
-  });
-
-  it("instantiates with _errors if package con't be found at provided app_root", function() {
-    const { npm_package_json } = process.env;
-    delete process.env.npm_package_json;
-
-    core.config.agent.node.app_root = '/no/package/at/this/path';
-    appInfo = proxyquire(
-      './app-info',
-      {
-        os,
-        process: {
-          ...process,
-          argv: ['node', ''],
-          version: 'v14.17.5'
-        }
-      }
-    );
-    const fn = () => appInfo(core);
-    expect(fn).throws('unable to locate application package.json');
-
-    process.env.npm_package_json = npm_package_json;
-  });
-
-  [
-    { version: 'v20.12.0', range: '>=18.19.0', badFlag: '-r', goodFlag: ['--import'] },
-    { version: 'v18.18.0', range: '>=16.17.0 <18.19.0', badFlag: '-r', goodFlag: ['--loader'] },
-    { version: 'v16.16.0', range: '<16.17.0', badFlag: '--loader', goodFlag: ['-r', '--require'] }
-  ].forEach(({ version, range, badFlag, goodFlag }) => {
-
-    it(`does not log a warning if '@contrast/agent' is not part of exec args (${version})`, function() {
-      appInfo = proxyquire(
-        './app-info',
-        {
-          os,
-          process: {
-            ...process,
-            argv: ['node', __filename],
-            version,
-            execArgv: [badFlag, 'some/file']
-          }
-        }
-      )(core);
-      expect(core.logger.warn).to.not.have.been.called;
-    });
-
-    it(`logs a warning if non-recommended preload flag is used (${version})`, function() {
-      appInfo = proxyquire(
-        './app-info',
-        {
-          os,
-          process: {
-            ...process,
-            argv: ['node', __filename],
-            version,
-            execArgv: [badFlag, '@contrast/agent']
-          }
-        }
-      )(core);
-      expect(core.logger.warn).to.have.been.calledWith(
-        'For Node LTS %s, use %s command to run the agent. See: https://docs.contrastsecurity.com/en/install-node-js.html',
-        range,
-        goodFlag
-      );
-    });
-
-    it(`logs a warning if non-recommended preload flag is used in NODE_OPTIONS (${version})`, function() {
-      appInfo = proxyquire(
-        './app-info',
-        {
-          os,
-          process: {
-            ...process,
-            argv: ['node', __filename],
-            version,
-            execArgv: [],
-            env: {
-              NODE_OPTIONS: `${badFlag} @contrast/agent`
-            }
-          }
-        }
-      )(core);
-      expect(core.logger.warn).to.have.been.calledWith(
-        'For Node LTS %s, use %s command to run the agent. See: https://docs.contrastsecurity.com/en/install-node-js.html',
-        range,
-        goodFlag
-      );
-    });
-  });
-
-  [
-    { version: 'v20.12.0', goodFlag: '--import' },
-    { version: 'v18.18.0', goodFlag: '--loader' },
-    { version: 'v16.16.0', goodFlag: '--require' }
-  ].forEach(({ version, goodFlag }) => {
-    it('does not log a warning if recommended preload flag is used', function() {
-      appInfo = proxyquire(
-        './app-info',
-        {
-          os,
-          process: {
-            ...process,
-            argv: ['node', __filename],
-            version,
-            execArgv: [goodFlag, '@contrast/agent']
-          }
-        }
-      )(core);
-      expect(core.logger.warn).not.to.have.been.called;
-    });
-
-    it('does not log a warning if recommended preload flag is used in NODE_OPTIONS', function() {
-      appInfo = proxyquire(
-        './app-info',
-        {
-          os,
-          process: {
-            ...process,
-            argv: ['node', __filename],
-            version,
-            execArgv: [],
-            env: {
-              NODE_OPTIONS: `${goodFlag} @contrast/agent`
-            }
-          }
-        }
-      )(core);
-      expect(core.logger.warn).not.to.have.been.called;
-    });
-  });
-});

package/lib/build-id.test.js

@@ -1,39 +0,0 @@
-'use strict';
-
-const sinon = require('sinon');
-const { expect } = require('chai');
-const proxyquire = require('proxyquire');
-
-describe('core build-id', function () {
-  let fs, getBuildId;
-
-  beforeEach(function() {
-    fs = { readFile: sinon.stub().rejects() };
-
-    getBuildId = proxyquire('./build-id', { 'fs/promises': fs })({
-      appInfo: {
-        app_dir: '/app',
-        pkg: { 'name': 'test', 'main': 'index.js', 'dependencies': {} }
-      }
-    });
-  });
-
-  it('resolves a string when package-lock is found', async function () {
-    fs.readFile.onCall(0).resolves(
-      Buffer.from('{"name":"test","lockfileVersion":3,"requires":true,"packages":{}}')
-    );
-
-    expect(await getBuildId()).to.equal('c6378fdf');
-  });
-
-  it('resolves a string when package-lock is not found first', async function () {
-    expect(await getBuildId()).to.equal('55d7b2de');
-  });
-
-  it('memoizes the result', async function () {
-    expect(await getBuildId()).to.equal('55d7b2de');
-    expect(fs.readFile).to.have.callCount(1);
-    await getBuildId();
-    expect(fs.readFile).to.have.callCount(1);
-  });
-});

package/lib/capture-stacktrace.test.js

@@ -1,55 +0,0 @@
-'use strict';
-
-const { expect } = require('chai');
-const mocks = require('@contrast/test/mocks');
-
-describe('core capture-stacktrace', function g() {
-  let core;
-
-  beforeEach(function () {
-    core = mocks.core();
-    core.config = mocks.config();
-    require('./capture-stacktrace')(core);
-  });
-
-  it('appends a stack getter property', function () {
-    const obj = { foo: 'bar' };
-    core.captureStacktrace(obj);
-    const desc = Object.getOwnPropertyDescriptor(obj, 'stack');
-    expect(typeof desc.get).to.equal('function');
-  });
-
-  it('generates a stacktrace from given options', function () {
-    (function outer() {
-      (function inner() {
-        const obj = {};
-        core.captureStacktrace(obj, { constructorOpt: inner });
-        expect(obj.stack[0]).to.have.property('method', 'outer');
-        expect(obj.stack).to.have.lengthOf(10);
-      })();
-    })();
-  });
-
-  describe('createSnapshot', function () {
-    it('prepends desired frames', function() {
-      const frame = { foo: 'bar' };
-      const stub = function stub() { };
-
-      const snapshot = core.createSnapshot({ prependFrames: [frame, stub] });
-      const result = snapshot();
-      expect(result[0]).to.equal(frame);
-      expect(result[1]).to.have.property('method', 'stub');
-    });
-
-    it('handles `eval`', function () {
-      const snapshot = eval('core.createSnapshot()');
-      const result = snapshot();
-
-      expect(result).to.have.length(10);
-      const evalFrame = result[3];
-      expect(evalFrame).to.have.property('eval').that.is.not.undefined;
-      expect(evalFrame).to.have.property('file').that.matches(/capture-stacktrace.test.js$/);
-      expect(evalFrame).to.have.property('method', 'eval');
-    });
-  });
-});

package/lib/contrast-methods.test.js

@@ -1,299 +0,0 @@
-'use strict';
-
-const sinon = require('sinon');
-const { expect } = require('chai');
-const mocks = require('@contrast/test/mocks');
-const patcher = require('@contrast/patcher');
-
-const { stringify } = JSON;
-
-const title = (method, args, expected) =>
-  `${method}(${args.map(stringify).join(', ')}) = ${stringify(expected)}`;
-
-describe('core contrast-methods', function () {
-  let core, contrastMethods, api;
-
-  beforeEach(function () {
-    core = mocks.core();
-    core.logger = mocks.logger();
-    core.patcher = patcher(core);
-    sinon.spy(core.patcher, 'patch');
-    contrastMethods = require('./contrast-methods')(core);
-    api = contrastMethods.api;
-  });
-
-  const GENERIC_TESTS = [{}, null, 1, 'two', undefined];
-
-  describe('.api', function () {
-    describe('.eval()', function () {
-      GENERIC_TESTS.forEach((arg) => {
-        it(title('eval', [arg], arg), function () {
-          expect(api.eval(arg)).to.equal(arg);
-        });
-      });
-    });
-
-    const ADD_TESTS = [
-      [[1, 2], 3],
-      [[1, '2'], '12'],
-      [['foo', 'bar'], 'foobar'],
-    ];
-
-    describe('.addAssign()', function () {
-      ADD_TESTS.forEach(([args, expected]) => {
-        it(title('addAssign', args, expected), function () {
-          expect(api.addAssign(...args)).to.equal(expected);
-        });
-      });
-    });
-
-    describe('.add()', function () {
-      ADD_TESTS.forEach(([args, expected], i) => {
-        it(title('add', args, expected), function () {
-          expect(api.add(...args)).to.equal(expected);
-        });
-      });
-    });
-
-    const obj1 = { foo: 'bar' };
-    const obj2 = { foo: 'bar' };
-    const EQ_TESTS = [
-      [['', ''], true, true],
-      [['foo', 'foo'], true, true],
-      [['foo', 'bar'], false, false],
-      [[1, 1], true, true],
-      [[1, 2], false, false],
-      [[1, '1'], true, false],
-      [[obj1, obj1], true, true],
-      [[obj1, obj2], false, false],
-    ];
-
-    describe('.eqEq()', function () {
-      EQ_TESTS.forEach(([args, expected]) => {
-        it(title('eqEq', args, expected), function () {
-          expect(api.eqEq(...args)).to.equal(expected);
-        });
-      });
-    });
-
-    describe('.eqEqEq()', function () {
-      EQ_TESTS.forEach(([args, _, expected]) => {
-        it(title('eqEqEq', args, expected), function () {
-          expect(api.eqEqEq(...args)).to.equal(expected);
-        });
-      });
-    });
-
-    describe('.notEq()', function () {
-      EQ_TESTS.forEach(([args, expected]) => {
-        it(title('notEq', args, !expected), function () {
-          expect(api.notEq(...args)).to.equal(!expected);
-        });
-      });
-    });
-
-    describe('.notEqEq()', function () {
-      EQ_TESTS.forEach(([args, _, expected]) => {
-        it(title('notEqEq', args, !expected), function () {
-          expect(api.notEqEq(...args)).to.equal(!expected);
-        });
-      });
-    });
-
-    describe('.forceCopy()', function () {
-      GENERIC_TESTS.forEach((arg) => {
-        it(title('forceCopy', [arg], arg), function () {
-          expect(api.forceCopy(arg)).to.equal(arg);
-        });
-      });
-    });
-
-    describe('.cast()', function () {
-      GENERIC_TESTS.forEach((arg) => {
-        it(title('cast', [arg], arg), function () {
-          expect(api.cast(arg)).to.equal(arg);
-        });
-      });
-    });
-
-    describe('.tag()', function () {
-      const bar = 'bar';
-      const baz = 'baz';
-
-      [
-        [[['']], ``], // eslint-disable-line quotes
-        [[['foo']], `foo`], // eslint-disable-line quotes
-        [[['', ''], bar], `${bar}`],
-        [[['foo', ''], bar], `foo${bar}`],
-        [[['foo', 'boo'], bar], `foo${bar}boo`],
-        [[['foo', 'boo', ''], bar, baz], `foo${bar}boo${baz}`],
-        [[['foo', 'boo', '.'], bar, baz], `foo${bar}boo${baz}.`],
-      ].forEach(([args, template]) => {
-        it(title('tag', args, template), function () {
-          expect(api.tag(...args)).to.equal(template);
-        });
-      });
-    });
-
-    describe('.Function()', function () {
-      it('patches the Function global', function () {
-        expect(core.patcher.patch).to.have.been.calledWithExactly(Function, {
-          name: 'global.Function',
-          patchType: 'rewrite-injection',
-          funcKey: 'rewrite-injection:global.Function',
-        });
-      });
-
-      it('acts as a function constructor', function () {
-        const fn = api.Function('return "hello world"');
-
-        expect(fn()).to.equal('hello world');
-      });
-    });
-
-    describe('.Number()', function () {
-      it('patches the Number global', function () {
-        expect(core.patcher.patch).to.have.been.calledWithExactly(Number, {
-          name: 'global.Number',
-          patchType: 'rewrite-injection',
-          funcKey: 'rewrite-injection:global.Number',
-        });
-      });
-
-      it('Number(14)', function () {
-        const result = api.Number(14);
-
-        expect(typeof result).to.equal('number');
-        expect(result).to.equal(14);
-      });
-
-      it("Number('14')", function () {
-        const result = api.Number('14');
-
-        expect(typeof result).to.equal('number');
-        expect(result).to.equal(14);
-      });
-
-      it("Number('boo')", function () {
-        const result = api.Number('boo');
-
-        expect(typeof result).to.equal('number');
-        expect(result).to.be.NaN;
-      });
-    });
-
-    describe('.Object()', function () {
-      it('patches the Object global', function () {
-        expect(core.patcher.patch).to.have.been.calledWithExactly(Object, {
-          name: 'global.Object',
-          patchType: 'rewrite-injection',
-          funcKey: 'rewrite-injection:global.Object',
-        });
-      });
-
-      it('Object(null)', function () {
-        const result = api.Object(null);
-
-        expect(typeof result).to.equal('object');
-        expect(result).not.to.equal({});
-        expect(result).to.deep.equal({});
-        expect(result.toString()).to.equal('[object Object]');
-      });
-
-      it("Object({ foo: 'bar' })", function () {
-        const obj = { foo: 'bar' };
-        const result = api.Object(obj);
-
-        expect(typeof result).to.equal('object');
-        expect(result).to.equal(obj);
-        expect(result.toString()).to.equal('[object Object]');
-      });
-
-      it("Object('boo')", function () {
-        const str = 'boo';
-        const result = api.Object(str);
-
-        expect(typeof result).to.equal('object');
-        expect(result == str).to.be.true;
-        expect(result === str).to.be.false;
-        expect(result.toString()).to.equal(str);
-      });
-    });
-
-    describe('.String()', function () {
-      it('patches the String global', function () {
-        expect(core.patcher.patch).to.have.been.calledWithExactly(String, {
-          name: 'global.String',
-          patchType: 'rewrite-injection',
-          funcKey: 'rewrite-injection:global.String',
-        });
-      });
-
-      it("String('boo')", function () {
-        const str = 'boo';
-        const result = api.String(str);
-
-        expect(typeof result).to.equal('string');
-        expect(result).to.equal(str);
-      });
-
-      it('String(14)', function () {
-        const result = api.String(14);
-
-        expect(typeof result).to.equal('string');
-        expect(result).to.equal('14');
-      });
-
-      it("String({ foo: 'bar' })", function () {
-        const result = api.String({ foo: 'bar' });
-
-        expect(typeof result).to.equal('string');
-        expect(result).to.equal('[object Object]');
-      });
-    });
-  });
-
-  describe('.getGlobal()', function () {
-    it('returns global', function () {
-      expect(contrastMethods.getGlobal()).to.equal(global);
-    });
-  });
-
-  describe('.install()', function () {
-    let globalMock;
-
-    beforeEach(function () {
-      globalMock = {};
-      sinon.stub(contrastMethods, 'getGlobal').returns(globalMock);
-    });
-
-    it('installs on global a single time', function () {
-      expect(globalMock).not.to.have.property('ContrastMethods');
-
-      contrastMethods.install();
-      expect(globalMock).to.have.property('ContrastMethods', api);
-      expect(contrastMethods.getGlobal).to.have.been.calledOnce;
-
-      expect(() => {
-        delete globalMock.ContrastMethods;
-      }).throw("Cannot delete property 'ContrastMethods'");
-
-      contrastMethods.install();
-      expect(globalMock).to.have.property('ContrastMethods', api);
-      expect(contrastMethods.getGlobal).to.have.been.calledOnce;
-    });
-
-    it('logs an error when global.ContrastMethods cannot be injected', function () {
-      Object.defineProperty(globalMock, 'ContrastMethods', {
-        configurable: false,
-        value: 'does not matter for test',
-      });
-
-      contrastMethods.install();
-      expect(core.logger.error).to.have.been.calledWith(
-        sinon.match(Error),
-        'Unable to define global.ContrastMethods',
-      );
-    });
-  });
-});

package/lib/sensitive-data-masking/index.test.js

@@ -1,163 +0,0 @@
-'use strict';
-
-const { describe } = require('mocha');
-const { expect } = require('chai');
-const dataMaskingFactory = require('../sensitive-data-masking');
-const mocks = require('@contrast/test/mocks');
-const { Event, Rule } = require('@contrast/common');
-
-describe('core sensitive-data-masking', function () {
-  let core, sdMasking, reqData, parsedParams, parsedCookies, parsedQuery, parsedBody, protect, resultsMap, trackRequest;
-
-  const ssn = '123-12-1234';
-  const cvv = '123';
-  const routingNumber = '123123123';
-  const apiToken = '$123-abcd<456*def';
-  const policy = require('../../test/resources/sensitive-data-policy');
-
-  beforeEach(function () {
-    core = mocks.core();
-    core.config = mocks.config();
-    core.logger = mocks.logger();
-    core.protect = mocks.protect();
-    core.config.api.enable = false;
-
-    reqData = {
-      uriPath: `/test/${cvv}/stuff`,
-      queries: `apiToken=${apiToken}&foo=bar`,
-      headers: [
-        'routingAccNum',
-        routingNumber,
-      ],
-    };
-    parsedQuery = { ssn };
-    parsedParams = { cvv };
-    parsedCookies = { ssn };
-    parsedBody = { ssn, input: '../../etc/passwd' };
-
-    trackRequest = true;
-    resultsMap = {
-      'sql-injection': [
-        {
-          value: apiToken,
-          score: 10,
-          ruleId: Rule.SQL_INJECTION,
-          path: [],
-          mappedId: 'sql-injection',
-          key: 'apiToken',
-          inputType: 'HeaderValue',
-          idsList: [
-            'worth-watching'
-          ],
-          exploitMetadata: [],
-          blocked: false
-        },
-        {
-          value: ssn,
-          score: 10,
-          ruleId: Rule.SQL_INJECTION,
-          path: [],
-          mappedId: 'sql-injection',
-          key: 'ssn',
-          inputType: 'JsonValue',
-          idsList: [],
-          exploitMetadata: [],
-          blocked: false
-        },
-      ],
-    };
-
-    protect = {
-      reqData,
-      parsedQuery,
-      parsedParams,
-      parsedCookies,
-      parsedBody,
-      resultsMap,
-      trackRequest
-    };
-    sdMasking = dataMaskingFactory(core);
-  });
-
-  it('logs when no policy is in server-settings message', function () {
-    core.messages.emit(Event.SERVER_SETTINGS_UPDATE, {});
-    expect(sdMasking.policy.keywordSets).to.be.empty;
-    expect(sdMasking.policy.idMap).to.be.empty;
-  });
-
-  it('handler is noop if no settings have been published', function () {
-    const store = { protect };
-
-    core.messages.emit(Event.PROTECT, store);
-
-    expect(reqData.uriPath).to.contain(cvv);
-    expect(reqData.queries).to.contain(apiToken);
-    expect(reqData.headers[1]).to.equal(routingNumber);
-    expect(parsedCookies).to.have.property('ssn', ssn);
-    expect(parsedQuery).to.have.property('ssn', ssn);
-    expect(parsedParams).to.have.property('cvv', cvv);
-    expect(protect.parsedBody).to.have.property('ssn', ssn);
-    expect(
-      resultsMap['sql-injection'][0]
-    ).to.have.property('value', apiToken);
-    expect(
-      store.protect.resultsMap['sql-injection'][1]
-    ).to.have.property('value', ssn);
-  });
-
-  it('handles protect message', function () {
-    const store = { protect };
-
-    core.messages.emit(Event.SERVER_SETTINGS_UPDATE, { sensitive_data_masking_policy: policy });
-    expect(core.logger.trace).to.have.been.calledWith('updating sensitive data masking policy');
-    expect(parsedCookies).to.have.property('ssn', ssn);
-
-    core.messages.emit(Event.PROTECT, store);
-
-    expect(reqData.uriPath).to.equal('/test/contrast-redacted-financial-info/stuff');
-    expect(reqData.queries).to.equal('apiToken=contrast-redacted-authentication-info&foo=bar');
-    expect(reqData.headers[1]).to.equal('contrast-redacted-financial-info');
-    expect(parsedCookies).to.have.property('ssn', 'contrast-redacted-government-id');
-    expect(parsedQuery).to.have.property('ssn', 'contrast-redacted-government-id');
-    expect(parsedParams).to.have.property('cvv', 'contrast-redacted-financial-info');
-    expect(protect.parsedBody).to.equal('contrast-redacted-body');
-    expect(
-      resultsMap['sql-injection'][0]
-    ).to.have.property('value', 'contrast-redacted-authentication-info');
-    expect(
-      store.protect.resultsMap['sql-injection'][1]
-    ).to.have.property('value', 'contrast-redacted-government-id');
-  });
-
-  it('policy controls masking of attack vectors and body', function () {
-    const store = { protect };
-    core.messages.emit(Event.SERVER_SETTINGS_UPDATE, {
-      sensitive_data_masking_policy: {
-        ...policy,
-        mask_http_body: false,
-        mask_attack_vector: false,
-      }
-    });
-    expect(core.logger.trace).to.have.been.calledWith('updating sensitive data masking policy');
-    expect(parsedCookies).to.have.property('ssn', ssn);
-
-    core.messages.emit(Event.PROTECT, store);
-
-    expect(reqData.uriPath).to.equal('/test/contrast-redacted-financial-info/stuff');
-    expect(reqData.queries).to.equal('apiToken=contrast-redacted-authentication-info&foo=bar');
-    expect(reqData.headers[1]).to.equal('contrast-redacted-financial-info');
-    expect(parsedCookies).to.have.property('ssn', 'contrast-redacted-government-id');
-    expect(parsedQuery).to.have.property('ssn', 'contrast-redacted-government-id');
-    expect(parsedParams).to.have.property('cvv', 'contrast-redacted-financial-info');
-    expect(protect.parsedBody).to.deep.equal({
-      ssn: 'contrast-redacted-government-id',
-      input: '../../etc/passwd'
-    });
-    expect(
-      resultsMap['sql-injection'][0]
-    ).to.have.property('value', apiToken);
-    expect(
-      store.protect.resultsMap['sql-injection'][1]
-    ).to.have.property('value', ssn);
-  });
-});

package/lib/system-info/cloud-provider-metadata.test.js

@@ -1,160 +0,0 @@
-// @ts-check
-'use strict';
-
-const sinon = require('sinon');
-const { expect } = require('chai');
-const proxyquire = require('proxyquire');
-const { CanceledError } = require('axios');
-
-describe('core system-result cloud-provider-metadata', function () {
-  /** @type {sinon.SinonStub} */
-  let axios;
-  /** @type {import('./cloud-provider-metadata').getCloudProviderMetadata} */
-  let getCloudProviderMetadata;
-
-  beforeEach(function () {
-    axios = sinon.stub().rejects();
-
-    getCloudProviderMetadata = proxyquire('./cloud-provider-metadata', {
-      axios: { default: axios }
-    }).getCloudProviderMetadata;
-  });
-
-  describe('AWS', function () {
-    it('handles aws', async function () {
-      axios.onCall(0).resolves({ data: 'foo' });
-      axios.onCall(1).resolves({ data: { region: 'us-east1', accountId: '123456789', instanceId: 'i-012345678' } });
-
-      const result = await getCloudProviderMetadata('AWS');
-      expect(axios).to.have.callCount(2);
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'PUT',
-        url: 'http://169.254.169.254/latest/api/token',
-        headers: {
-          'X-aws-ec2-metadata-token-ttl-seconds': '300'
-        },
-      });
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'GET',
-        url: 'http://169.254.169.254/latest/dynamic/instance-identity/document',
-        headers: {
-          'X-aws-ec2-metadata-token': 'foo'
-        }
-      });
-      expect(result).to.deep.equal({
-        provider: 'aws',
-        id: 'arn:aws:ec2:us-east1:123456789:instance/i-012345678',
-      });
-    });
-
-    it('handles errors', async function () {
-      axios.onCall(0).resolves({ data: 'foo' });
-      axios.onCall(1).rejects();
-
-      const result = await getCloudProviderMetadata('AWS');
-      expect(axios).to.have.callCount(2);
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'PUT',
-        url: 'http://169.254.169.254/latest/api/token',
-        headers: {
-          'X-aws-ec2-metadata-token-ttl-seconds': '300'
-        },
-        proxy: false,
-      });
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'GET',
-        url: 'http://169.254.169.254/latest/dynamic/instance-identity/document',
-        headers: {
-          'X-aws-ec2-metadata-token': 'foo'
-        },
-        proxy: false,
-      });
-      expect(result).to.be.null;
-    });
-  });
-
-  describe('Azure', function () {
-    it('handles azure', async function () {
-      // example from azure docs: https://learn.microsoft.com/en-us/azure/virtual-machines/instance-metadata-service?tabs=linux#access-azure-instance-metadata-service
-      const id = '/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname';
-      axios.resolves({ data: id });
-
-      const result = await getCloudProviderMetadata('Azure');
-      expect(axios).to.have.callCount(1);
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'GET',
-        url: 'http://169.254.169.254/metadata/instance/compute/resourceId?api-version=2021-02-01&format=text',
-        headers: {
-          Metadata: 'true'
-        },
-        proxy: false,
-      });
-      expect(result).to.deep.equal({ provider: 'azure', id });
-    });
-
-    it('handles errors', async function () {
-      axios.rejects();
-
-      const result = await getCloudProviderMetadata('Azure');
-      expect(axios).to.have.callCount(1);
-      expect(result).to.be.null;
-    });
-  });
-
-  describe('GCP', function () {
-    it('handles gcp', async function () {
-      axios.resolves({ data: '954399829989587067' });
-
-      const result = await getCloudProviderMetadata('GCP');
-      expect(axios).to.have.callCount(1);
-      expect(axios).to.have.been.calledWithMatch({
-        method: 'GET',
-        url: 'http://169.254.169.254/computeMetadata/v1/instance/id?alt=text',
-        headers: {
-          'Metadata-Flavor': 'Google'
-        },
-        proxy: false,
-      });
-      expect(result).to.deep.equal({ provider: 'gcp', id: '954399829989587067' });
-    });
-
-    it('retries if a 503 is returned', async function () {
-      axios.onCall(0).rejects({ response: { status: 503 } });
-      axios.onCall(1).resolves({ data: '954399829989587067' });
-
-      const result = await getCloudProviderMetadata('GCP');
-      expect(axios).to.have.callCount(2);
-      expect(result).to.deep.equal({ provider: 'gcp', id: '954399829989587067' });
-    });
-
-    it('handles misc errors', async function () {
-      axios.rejects();
-
-      const result = await getCloudProviderMetadata('GCP');
-      expect(axios).to.have.callCount(1);
-      expect(result).to.be.null;
-    });
-  });
-
-  describe('auto-detection', function () {
-    this.beforeEach(function () {
-      axios.rejects(new CanceledError('canceled'));
-    });
-
-    it('returns null if all responses timeout', async function () {
-      const result = await getCloudProviderMetadata(undefined);
-      expect(axios).to.have.callCount(3); // 1 aws + 1 azure + 1 gcp
-      expect(result).to.be.null;
-    });
-
-    it('handles a single valid response', async function () {
-      axios.withArgs(sinon.match({
-        url: 'http://169.254.169.254/metadata/instance/compute/resourceId?api-version=2021-02-01&format=text',
-      })).resolves({ data: 'azure-resource-identifier' });
-
-      const result = await getCloudProviderMetadata(undefined);
-      expect(axios).to.have.callCount(3); // 1 aws + 1 azure + 1 gcp
-      expect(result).to.deep.equal({ provider: 'azure', id: 'azure-resource-identifier' });
-    });
-  });
-});

package/lib/system-info/index.test.js

@@ -1,34 +0,0 @@
-'use strict';
-
-const sinon = require('sinon');
-const { expect } = require('chai');
-const proxyquire = require('proxyquire');
-
-describe('core system-info', function () {
-  let core;
-
-  beforeEach(function () {
-    core = require('@contrast/test/mocks/core')();
-    core.config = require('@contrast/test/mocks/config')();
-
-    proxyquire('.', {
-      './cloud-provider-metadata': {
-        getCloudProviderMetadata: sinon.stub().resolves(null)
-      }
-    })(core);
-  });
-
-  it('returns a properly structured object', async function () {
-    const info = await core.getSystemInfo();
-
-    expect(info).to.not.be.undefined;
-    expect(info).to.haveOwnProperty('ReportDate');
-    expect(info).to.haveOwnProperty('MachineName');
-    expect(info).to.haveOwnProperty('Contrast');
-    expect(info).to.haveOwnProperty('Node');
-    expect(info).to.haveOwnProperty('OperatingSystem');
-    expect(info).to.haveOwnProperty('Host');
-    expect(info).to.haveOwnProperty('Application');
-    expect(info).to.haveOwnProperty('Cloud');
-  });
-});

package/lib/system-info/linux-os-info.test.js

@@ -1,121 +0,0 @@
-'use strict';
-
-const fsp = require('node:fs/promises');
-const os = require('node:os');
-const { expect } = require('chai');
-const sinon = require('sinon');
-
-/**
-# cat /etc/os-release
-NAME="Alpine Linux"
-ID=alpine
-VERSION_ID=3.20.3
-PRETTY_NAME="Alpine Linux v3.20"
-HOME_URL="https://alpinelinux.org/"
-BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"
-# cat /etc/alpine-release
-3.20.3
-
-# cat /etc/os-release
-PRETTY_NAME="Ubuntu 22.04.3 LTS"
-NAME="Ubuntu"
-VERSION_ID="22.04"
-VERSION="22.04.3 LTS (Jammy Jellyfish)"
-VERSION_CODENAME=jammy
-ID=ubuntu
-ID_LIKE=debian
-HOME_URL="https://www.ubuntu.com/"
-SUPPORT_URL="https://help.ubuntu.com/"
-BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
-PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
-UBUNTU_CODENAME=jammy
- */
-
-const linuxOsInfo = require('./linux-os-info');
-
-describe('linux-os-info', function() {
-  let fsStub;
-  let osStub;
-
-  beforeEach(function() {
-    fsStub = sinon.stub(fsp, 'readFile');
-    // fake up so test passes on windows.
-    osStub = sinon.stub(os, 'type').returns('Linux');
-  });
-  afterEach(function() {
-    fsStub.restore();
-    osStub.restore();
-  });
-
-  it('should return info for Ubuntu', async function() {
-    fsStub.withArgs('/etc/os-release').resolves('PRETTY_NAME="Ubuntu 22.04.3 LTS"\nNAME="Ubuntu"\nVERSION_ID="22.04"\nVERSION="22.04.3 LTS (Jammy Jellyfish)"\nVERSION_CODENAME=jammy\nID=ubuntu\nID_LIKE=debian\nHOME_URL="https://www.ubuntu.com/"\nSUPPORT_URL="https://help.ubuntu.com/"\nBUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"\nPRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"\nUBUNTU_CODENAME=jammy\n');
-    fsStub.withArgs('/etc/alpine-release').rejects(new Error('ENOENT'));
-
-    const result = await linuxOsInfo();
-    expect(result).to.deep.equal({
-      file: '/etc/os-release',
-      pretty_name: 'Ubuntu 22.04.3 LTS',
-      name: 'Ubuntu',
-      id: 'ubuntu',
-      version_id: '22.04',
-      version: '22.04.3 LTS (Jammy Jellyfish)',
-      version_codename: 'jammy',
-      id_like: 'debian',
-      home_url: 'https://www.ubuntu.com/',
-      support_url: 'https://help.ubuntu.com/',
-      bug_report_url: 'https://bugs.launchpad.net/ubuntu/',
-      privacy_policy_url: 'https://www.ubuntu.com/legal/terms-and-policies/privacy-policy',
-      ubuntu_codename: 'jammy',
-    });
-  });
-
-  it('should return info for Alpine without an os-release file', async function() {
-    fsStub.withArgs('/etc/os-release').rejects(new Error('ENOENT'));
-    fsStub.withArgs('/usr/lib/os-release').rejects(new Error('ENOENT'));
-    fsStub.withArgs('/etc/alpine-release').resolves('3.20.3\n');
-
-    const result = await linuxOsInfo();
-    expect(result).to.deep.equal({
-      file: '/etc/alpine-release',
-      name: 'Alpine',
-      id: 'alpine',
-      version: '3.20.3',
-      version_id: '3.20.3',
-    });
-  });
-
-  it('should return info for Alpine with an os-release file', async function() {
-    fsStub.withArgs('/etc/os-release').resolves('NAME="Alpine Linux"\nID=alpine\nVERSION_ID=3.20.3\nPRETTY_NAME="Alpine Linux v3.20"\nHOME_URL="https://alpinelinux.org/"\nBUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"\n');
-    fsStub.withArgs('/usr/lib/os-release').rejects(new Error('ENOENT'));
-    fsStub.withArgs('/etc/alpine-release').resolves('3.20.3\n');
-
-    const result = await linuxOsInfo();
-    expect(result).to.deep.equal({
-      file: '/etc/os-release',
-      name: 'Alpine Linux',
-      id: 'alpine',
-      version_id: '3.20.3',
-      pretty_name: 'Alpine Linux v3.20',
-      home_url: 'https://alpinelinux.org/',
-      bug_report_url: 'https://gitlab.alpinelinux.org/alpine/aports/-/issues',
-    });
-  });
-
-  it('should return info when no os-release or alpine-release files are found', async function() {
-    fsStub.withArgs('/etc/os-release').rejects(new Error('ENOENT'));
-    fsStub.withArgs('/usr/lib/os-release').rejects(new Error('ENOENT'));
-    fsStub.withArgs('/etc/alpine-release').rejects(new Error('ENOENT'));
-
-    const result = await linuxOsInfo();
-    // no file found
-    expect(result).deep.equal({ file: undefined });
-  });
-
-  it('should return null for non-linux systems', async function() {
-    osStub.returns('Windows_NT');
-
-    const result = await linuxOsInfo();
-
-    expect(result).to.be.null;
-  });
-});