@contrast/contrast 1.0.0

package/dist/utils/getConfig.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setConfigValues = exports.createConfigFromYaml = exports.localConfig = void 0;
+const conf_1 = __importDefault(require("conf"));
+const localConfig = (name, version) => {
+    const config = new conf_1.default({
+        configName: name
+    });
+    config.set('version', version);
+    if (!config.has('host')) {
+        config.set('host', 'https://ce.contrastsecurity.com/');
+    }
+    return config;
+};
+exports.localConfig = localConfig;
+const createConfigFromYaml = (yamlPath) => {
+    const yamlConfig = {};
+    return yamlConfig;
+};
+exports.createConfigFromYaml = createConfigFromYaml;
+const setConfigValues = (config, values) => {
+    config.set('apiKey', values.apiKey);
+    config.set('organizationId', values.orgId);
+    config.set('authorization', values.authHeader);
+    values.host ? config.set('host', values.host) : null;
+};
+exports.setConfigValues = setConfigValues;

package/dist/utils/oraWrapper.js

@@ -0,0 +1,20 @@
+"use strict";
+const ora = require('ora');
+const returnOra = text => {
+    return ora(text);
+};
+const startSpinner = spinner => {
+    spinner.start();
+};
+const succeedSpinner = (spinner, text) => {
+    spinner.succeed(text);
+};
+const failSpinner = (spinner, text) => {
+    spinner.fail(text);
+};
+module.exports = {
+    returnOra,
+    startSpinner,
+    succeedSpinner,
+    failSpinner
+};

package/dist/utils/paramsUtil/commandlineParams.js

@@ -0,0 +1,31 @@
+"use strict";
+const cliOptions = require('../parsedCLIOptions');
+const parsedCLIOptions = cliOptions.getCommandLineArgs();
+const getAuth = () => {
+    let params = {};
+    params.apiKey = parsedCLIOptions['apiKey'];
+    params.authorization = parsedCLIOptions['authorization'];
+    params.host = parsedCLIOptions['host'];
+    params.organizationId = parsedCLIOptions['organizationId'];
+    return params;
+};
+const getScanParams = () => {
+    let scanParams = {};
+    scanParams.help = parsedCLIOptions['help'];
+    scanParams.file = parsedCLIOptions['file'];
+    scanParams.language = parsedCLIOptions['language']
+        ? parsedCLIOptions['language'].toUpperCase()
+        : parsedCLIOptions['language'];
+    scanParams.ff = parsedCLIOptions['ff'];
+    scanParams.timeout = parsedCLIOptions['timeout'];
+    scanParams.name = parsedCLIOptions['name'];
+    scanParams.verbose = parsedCLIOptions['verbose'];
+    if (!scanParams.name) {
+        scanParams.name = scanParams.file;
+    }
+    return scanParams;
+};
+module.exports = {
+    getScanParams: getScanParams,
+    getAuth: getAuth
+};

package/dist/utils/paramsUtil/configStoreParams.js

@@ -0,0 +1,18 @@
+"use strict";
+const validationCheck = require('../validationCheck');
+const commonApi = require('../commonApi');
+const config = require('../getConfig');
+const { APP_NAME, APP_VERSION } = require('../../constants/constants');
+const getAuth = () => {
+    const ContrastConf = config.localConfig(APP_NAME, APP_VERSION);
+    let ContrastConfToUse = {};
+    if (validationCheck.checkConfigHasRequiredValues(ContrastConf)) {
+        ContrastConfToUse.apiKey = ContrastConf.get('apiKey');
+        ContrastConfToUse.organizationId = ContrastConf.get('organizationId');
+        ContrastConfToUse.host = commonApi.getValidHost(ContrastConf.get('host'));
+        ContrastConfToUse.authorization = ContrastConf.get('authorization');
+        ContrastConfToUse.version = ContrastConf.get('version');
+    }
+    return ContrastConfToUse;
+};
+module.exports = { getAuth: getAuth };

package/dist/utils/paramsUtil/envVariableParams.js

@@ -0,0 +1,10 @@
+"use strict";
+const getAuth = () => {
+    let params = {};
+    params.apiKey = process.env.CONTRAST__API__API_KEY;
+    params.authorization = process.env.CONTRAST__API__AUTHORIZATION;
+    params.host = process.env.CONTRAST__API__URL;
+    params.organizationId = process.env.CONTRAST__API__ORGANIZATION_ID;
+    return params;
+};
+module.exports = { getAuth: getAuth };

package/dist/utils/paramsUtil/paramHandler.js

@@ -0,0 +1,28 @@
+"use strict";
+const commandlineAuth = require('./commandlineParams');
+const configStoreParams = require('./configStoreParams');
+const envVariableParams = require('./envVariableParams');
+const { validateAuthParams } = require('../validationCheck');
+const i18n = require('i18n');
+const getAuth = () => {
+    let commandLineAuthParamsAuth = commandlineAuth.getAuth();
+    let envVariableParamsAuth = envVariableParams.getAuth();
+    let configStoreParamsAuth = configStoreParams.getAuth();
+    if (validateAuthParams(commandLineAuthParamsAuth)) {
+        return commandLineAuthParamsAuth;
+    }
+    else if (validateAuthParams(envVariableParamsAuth)) {
+        return envVariableParamsAuth;
+    }
+    else if (validateAuthParams(configStoreParamsAuth)) {
+        return configStoreParamsAuth;
+    }
+    else {
+        console.log(i18n.__('configNotFound'));
+        process.exit(1);
+    }
+};
+const getScanSubCommands = () => {
+    return commandlineAuth.getScanParams();
+};
+module.exports = { getAuth: getAuth, getScanSubCommands: getScanSubCommands };

package/dist/utils/paramsUtil/yamlParams.js

@@ -0,0 +1,6 @@
+'use strict'
+const fs = require('fs')
+const yaml = require('js-yaml')
+const getAuth = yamlPath => {
+  const yamlParams = yaml.load(fs.readFileSync(yamlPath, 'utf8'))
+}

package/dist/utils/parsedCLIOptions.js

@@ -0,0 +1,13 @@
+"use strict";
+const constants = require('../constants');
+const commandLineArgs = require('command-line-args');
+const getCommandLineArgs = () => {
+    return commandLineArgs(constants.commandLineDefinitions.scanOptionDefinitions, {
+        partial: true,
+        camelCase: true,
+        caseInsensitive: true
+    });
+};
+module.exports = {
+    getCommandLineArgs: getCommandLineArgs
+};

package/dist/utils/requestUtils.js

@@ -0,0 +1,18 @@
+"use strict";
+const request = require('request');
+const Promise = require('bluebird');
+Promise.promisifyAll(request);
+function sendRequest({ options, method = 'put' }) {
+    return request[`${method}Async`](options.url, options);
+}
+const millisToSeconds = millis => {
+    return ((millis % 60000) / 1000).toFixed(0);
+};
+const sleep = ms => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+module.exports = {
+    sendRequest: sendRequest,
+    sleep: sleep,
+    millisToSeconds: millisToSeconds
+};

package/dist/utils/validationCheck.js

@@ -0,0 +1,26 @@
+"use strict";
+const checkConfigHasRequiredValues = store => {
+    return (store.has('apiKey') &&
+        store.has('organizationId') &&
+        store.has('host') &&
+        store.has('authorization') &&
+        store.has('version'));
+};
+const validateRequiredScanParams = params => {
+    return (params.apiKey &&
+        params.organizationId &&
+        params.host &&
+        params.authorization &&
+        params.version);
+};
+const validateAuthParams = params => {
+    return !!(params.apiKey &&
+        params.organizationId &&
+        params.host &&
+        params.authorization);
+};
+module.exports = {
+    checkConfigHasRequiredValues: checkConfigHasRequiredValues,
+    validateAuthParams: validateAuthParams,
+    validateRequiredScanParams: validateRequiredScanParams
+};

package/package.json

@@ -0,0 +1,123 @@
+{
+  "name": "@contrast/contrast",
+  "version": "1.0.0",
+  "description": "Contrast Security's command line tool",
+  "main": "dist/index.js",
+  "bin": {
+    "contrast": "./bin/contrast.js"
+  },
+  "author": "Jamie Mcgurk <jamie.mcgurk@contrastsecurity.com>",
+  "contributors": [
+    {
+      "name": "Chris Dunne",
+      "email": "christopher.dunne@contrastsecurity.com"
+    },
+    {
+      "name": "Andrew Shanks",
+      "email": "andrew.shanks@contrastsecurity.com"
+    }
+  ],
+  "license": "ISC",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --testPathIgnorePatterns=./test-integration/",
+    "test-int": "jest ./test-integration/scan/",
+    "format": "prettier --write \"**/*.{ts,tsx,js,css,scss,json,md,yml}\" .eslintrc.* .babelrc",
+    "check-format": "prettier --check \"**/*.{ts,tsx,js,css,scss,json,md,yml}\" .eslintrc.* .babelrc",
+    "coverage-local": "nyc --reporter=text mocha './test/**/*.spec.js'",
+    "coverage": "yarn test --coverage",
+    "lint": "eslint --config .eslintrc.json . --ext .ts",
+    "extract-licenses": "node scripts/extract-licenses",
+    "test-jest": "jest",
+    "lambda-dev": "npx ts-node src/index.ts lambda",
+    "dev": "npx ts-node src/index.ts"
+  },
+  "engines": {
+    "node": ">=16.13.2 <17"
+  },
+  "dependencies": {
+    "@aws-sdk/client-iam": "^3.53.0",
+    "@aws-sdk/client-lambda": "^3.53.0",
+    "@yarnpkg/lockfile": "^1.1.0",
+    "adm-zip": "^0.5.9",
+    "bluebird": "^3.7.2",
+    "chalk": "^4.1.2",
+    "command-line-args": "^5.2.1",
+    "command-line-usage": "^6.1.1",
+    "conf": "^10.1.1",
+    "dotenv": "^16.0.0",
+    "fast-glob": "^3.2.11",
+    "i18n": "^0.14.1",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "log-symbols": "^4.1.0",
+    "open": "^8.4.0",
+    "ora": "5.4.1",
+    "prettyjson": "^1.2.5",
+    "request": "^2.88.2",
+    "semver": "^7.3.5",
+    "string-builder": "^0.1.8",
+    "string-multiple-replace": "^1.0.5",
+    "tmp": "^0.2.1",
+    "xml2js": "^0.4.23",
+    "yarn-lockfile": "^1.1.1"
+  },
+  "devDependencies": {
+    "@tsconfig/node16": "^1.0.2",
+    "@types/command-line-args": "^5.2.0",
+    "@types/command-line-usage": "^5.0.2",
+    "@types/i18n": "^0.13.2",
+    "@types/jest": "^27.4.1",
+    "@types/lodash": "^4.14.181",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "csv-writer": "^1.6.0",
+    "eslint": "^8.8.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^3.0.9",
+    "jest": "^27.4.7",
+    "mocha": "^9.2.1",
+    "npm-license-crawler": "^0.2.1",
+    "nyc": "^15.1.0",
+    "pkg": "^5.5.2",
+    "prettier": "^1.19.1",
+    "tmp": "^0.2.1",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.2",
+    "uuid": "^8.3.2"
+  },
+  "resolutions": {
+    "faker": "5.5.3",
+    "colors": "1.4.0"
+  },
+  "eslintIgnore": [
+    "node_modules"
+  ],
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "overrides": [
+      {
+        "files": [
+          ".eslintrc.ng",
+          ".babelrc"
+        ],
+        "options": {
+          "parser": "json"
+        }
+      }
+    ]
+  },
+  "pkg": {
+    "scripts": [
+      "dist/**/*.js",
+      "bin/contrast"
+    ],
+    "assets": [
+      "dist"
+    ],
+    "outputPath": "binaries"
+  }
+}

package/src/commands/auth/auth.js

@@ -0,0 +1,73 @@
+const { v4: uuidv4 } = require('uuid')
+const { setConfigValues } = require('../../utils/getConfig')
+const open = require('open')
+const commonApi = require('../../utils/commonApi')
+const { sleep } = require('../../utils/requestUtils')
+const i18n = require('i18n')
+const {
+  returnOra,
+  startSpinner,
+  failSpinner,
+  succeedSpinner
+} = require('../../utils/oraWrapper')
+const { TIMEOUT, AUTH_UI_URL } = require('../../constants/constants')
+
+const processAuth = async config => {
+  const token = uuidv4()
+  const url = `${AUTH_UI_URL}/?token=${token}`
+
+  console.log(i18n.__('redirectAuth', url))
+
+  try {
+    //start a spinner / progress
+    await setTimeout(() => {
+      open(url)
+    }, 0)
+
+    const result = await isAuthComplete(token, TIMEOUT, config)
+    if (result) {
+      setConfigValues(config, result)
+    }
+    return
+  } finally {
+    //spinner stop
+  }
+}
+
+const isAuthComplete = async (token, timeout, config) => {
+  const authSpinner = returnOra(i18n.__('authWaitingMessage'))
+  startSpinner(authSpinner)
+  const client = commonApi.getHttpClient(config)
+  let startTime = new Date()
+  let complete = false
+  while (!complete) {
+    let result = await pollAuthResult(token, client)
+    if (result.statusCode === 200) {
+      succeedSpinner(authSpinner, i18n.__('authSuccessMessage'))
+      console.log(i18n.__('runScanMessage'))
+      return result.body
+    }
+    let endTime = new Date() - startTime
+    if (endTime > timeout) {
+      failSpinner(authSpinner, i18n.__('authTimedOutMessage'))
+      process.exit(1)
+      return
+    }
+  }
+}
+
+const pollAuthResult = async (token, client) => {
+  await sleep(5000)
+  return client
+    .pollForAuth(token)
+    .then(res => {
+      return res
+    })
+    .catch(err => {
+      console.log(err)
+    })
+}
+
+module.exports = {
+  processAuth: processAuth
+}

package/src/commands/config/config.js

@@ -0,0 +1,25 @@
+const commandLineArgs = require('command-line-args')
+
+const processConfig = (argv, config) => {
+  const options = [{ name: 'clear', alias: 'c', type: Boolean }]
+
+  try {
+    const configOptions = commandLineArgs(options, {
+      argv,
+      caseInsensitive: true,
+      camelCase: true
+    })
+    if (configOptions.clear) {
+      config.clear()
+    } else {
+      console.log(JSON.parse(JSON.stringify(config.store)))
+    }
+  } catch (e) {
+    //handle unknown command inputs
+    console.log(e.message.toString())
+  }
+}
+
+module.exports = {
+  processConfig: processConfig
+}

package/src/commands/scan/processScan.js

@@ -0,0 +1,29 @@
+const { startScan } = require('../../scan/scanController')
+const paramHandler = require('../../utils/paramsUtil/paramHandler')
+const { formatScanOutput } = require('../../scan/scan')
+const { scanUsageGuide } = require('../../scan/help')
+
+const processScan = async () => {
+  let getScanSubCommands = paramHandler.getScanSubCommands()
+  if (getScanSubCommands.help) {
+    printHelpMessage()
+    process.exit(1)
+  }
+
+  let scanResults = await startScan()
+  if (scanResults) {
+    formatScanOutput(
+      scanResults?.projectOverview,
+      scanResults?.scanResultsInstances
+    )
+  }
+}
+
+const printHelpMessage = () => {
+  console.log(scanUsageGuide)
+}
+
+module.exports = {
+  processScan,
+  printHelpMessage
+}