@contrast/contrast 2.0.2-beta.2 → 2.0.2-beta.4

package/src/telemetry/telemetry.ts

@@ -1,154 +0,0 @@
-import { getHttpClient } from '../utils/commonApi'
-import * as crypto from 'crypto'
-import { ContrastConf } from '../utils/getConfig'
-
-export const TELEMETRY_CLI_COMMANDS_EVENT = 'CLI_COMMANDS'
-export const TELEMETRY_CLI_TIME_TO_AUTH_EVENT = 'CLI_TIME_TO_AUTH'
-
-export const sendTelemetryConfigAsConfObj = async (
-  config: ContrastConf,
-  command: string,
-  argv: string[],
-  result: string,
-  language: string
-) => {
-  const hostParam = '--host'
-  const hostParamAlias = '-h'
-  const orgIdParam = '--organization-id'
-  const orgIdParamAlias = '-o'
-  const authParam = '--authorization'
-  const apiKeyParam = '--api-key'
-
-  let configToUse
-
-  if (
-    paramExists(argv, hostParam, hostParamAlias) &&
-    paramExists(argv, orgIdParam, orgIdParamAlias) &&
-    paramExists(argv, authParam, null) &&
-    paramExists(argv, apiKeyParam, null)
-  ) {
-    //if the user has passed the values as params
-    configToUse = {
-      host: findParamValueFromArgs(argv, hostParam, hostParamAlias),
-      organizationId: findParamValueFromArgs(argv, orgIdParam, orgIdParamAlias),
-      authorization: findParamValueFromArgs(argv, authParam, null),
-      apiKey: findParamValueFromArgs(argv, apiKeyParam, null)
-    }
-  } else if (
-    config &&
-    config.get('host') &&
-    config.get('organizationId') &&
-    config.get('authorization') &&
-    config.get('apiKey')
-  ) {
-    configToUse = {
-      host: config.get('host')?.slice(0, -1), //slice off extra / in url, will 404 on teamserver if we don't
-      organizationId: config.get('organizationId'),
-      authorization: config.get('authorization'),
-      apiKey: config.get('apiKey')
-    }
-  } else {
-    //return when unable to get config
-    return
-  }
-
-  return await sendTelemetryConfigAsObject(
-    configToUse,
-    command,
-    argv,
-    result,
-    language
-  )
-}
-
-export const sendTelemetryConfigAsObject = async (
-  config: any,
-  command: string,
-  argv: string[],
-  result: string,
-  language: string
-) => {
-  const obfuscatedParams = obfuscateParams(argv)
-
-  const requestBody = {
-    event: TELEMETRY_CLI_COMMANDS_EVENT,
-    details: {
-      ip_address: '',
-      account_name: '',
-      account_host: '',
-      company_domain: '',
-      command: `contrast ${command} ${obfuscatedParams}`,
-      app_id:
-        config && config.applicationId
-          ? sha1Base64Value(config.applicationId)
-          : 'undefined',
-      project_id:
-        config && config.projectId
-          ? sha1Base64Value(config.projectId)
-          : 'undefined',
-      language: language,
-      result: result,
-      additional_info: '',
-      timestamp: new Date().toUTCString()
-    }
-  }
-
-  return await sendTelemetryRequest(config, requestBody)
-}
-
-export const sendTelemetryRequest = async (config: any, requestBody: any) => {
-  const client = getHttpClient(config)
-  return client
-    .postTelemetry(config, requestBody)
-    .then((res: any) => {
-      if (res.statusCode !== 200 && config.debug === true) {
-        console.log('Telemetry failed to send with status', res.statusCode)
-      }
-      return { statusCode: res.statusCode, statusMessage: res.statusMessage }
-    })
-    .catch((err: any) => {
-      return
-    })
-}
-
-export const obfuscateParams = (argv: string[]) => {
-  return argv
-    .join(' ')
-    .replace(/--(authorization [A-Z0-9]+)/gi, '--authorization *****')
-    .replace(/-(o [A-Z0-9-]+)/gi, '-o *****')
-    .replace(/--(organization-id [A-Z0-9-]+)/gi, '--organization-id *****')
-    .replace(/--(api-key [A-Z0-9]+)/gi, '--api-key *****')
-}
-
-export const paramExists = (
-  argv: string[],
-  param: string,
-  paramAlias: string | null
-) => {
-  return argv.find((arg: string) => arg === param || arg === paramAlias)
-}
-
-export const findParamValueFromArgs = (
-  argv: string[],
-  param: string,
-  paramAlias: string | null
-) => {
-  let paramAsValue
-
-  argv.forEach((arg: string, index: number) => {
-    if (
-      arg === param ||
-      (arg === paramAlias &&
-        argv[index + 1] !== undefined &&
-        argv[index + 1] !== null)
-    ) {
-      paramAsValue = argv[index + 1]
-    }
-  })
-
-  return paramAsValue
-}
-
-export const sha1Base64Value = (value: any) => {
-  return crypto.createHash('sha1').update(value).digest('base64')
-}

package/src/utils/capabilities.js

@@ -1,12 +0,0 @@
-const CLI_IGNORE_DEV_DEPS = 'CLI_IGNORE_DEV_DEPS'
-
-const featuresTeamServer = [
-  {
-    CLI_IGNORE_DEV_DEPS: '3.9.0'
-  }
-]
-
-module.exports = {
-  featuresTeamServer,
-  CLI_IGNORE_DEV_DEPS
-}

package/src/utils/commonApi.js

@@ -1,103 +0,0 @@
-const HttpClient = require('./../common/HTTPClient')
-const {
-  badRequestError,
-  unauthenticatedError,
-  forbiddenError,
-  proxyError,
-  genericError,
-  maxAppError,
-  snapshotFailureError,
-  vulnerabilitiesFailureError,
-  reportFailureError,
-  parametersError,
-  invalidHostNameError
-} = require('../common/errorHandling')
-const { performance } = require('perf_hooks')
-const requestUtils = require('./requestUtils')
-const oraFunctions = require('./oraWrapper')
-
-const getTimeout = config => {
-  if (config.timeout) {
-    return config.timeout
-  } else {
-    if (config.verbose) {
-      console.log('Timeout set to 5 minutes')
-    }
-    return 300
-  }
-}
-
-const handleTimeout = (startTime, timeout, reportSpinner) => {
-  const endTime = performance.now() - startTime
-  if (requestUtils.millisToSeconds(endTime) > timeout) {
-    oraFunctions.failSpinner(
-      reportSpinner,
-      'Contrast audit timed out at the specified timeout of ' +
-        timeout +
-        ' seconds.'
-    )
-    throw new Error('You can update the timeout using --timeout')
-  }
-}
-const handleResponseErrors = (res, api) => {
-  if (res.statusCode === 400) {
-    api === 'catalogue' ? badRequestError(true) : badRequestError(false)
-  } else if (res.statusCode === 401) {
-    unauthenticatedError()
-  } else if (res.statusCode === 403) {
-    forbiddenError()
-  } else if (res.statusCode === 407) {
-    proxyError()
-  } else if (res.statusCode === 412) {
-    maxAppError()
-  } else if (res.statusCode === 301) {
-    invalidHostNameError(res.statusCode)
-  } else if (res.statusCode === 302) {
-    parametersError(res.statusCode)
-  } else {
-    if (api === 'snapshot' || api === 'catalogue') {
-      snapshotFailureError()
-    }
-    if (api === 'vulnerabilities') {
-      vulnerabilitiesFailureError()
-    }
-    if (api === 'report') {
-      reportFailureError()
-    }
-    console.log(res.statusCode)
-    genericError(res)
-  }
-}
-
-const getProtocol = host => {
-  const hasProtocol =
-    host.toLowerCase().includes('https://') ||
-    host.toLowerCase().includes('http://')
-  return hasProtocol ? host : 'https://' + host
-}
-
-const getPath = host => {
-  const hasContrastPath = host.toLowerCase().endsWith('/contrast')
-  return hasContrastPath
-    ? host.toLowerCase().substring(0, host.length - 9)
-    : host.replace(/\/*$/, '')
-}
-
-const getValidHost = host => {
-  const correctProtocol = getProtocol(host)
-  return getPath(correctProtocol)
-}
-
-const getHttpClient = config => {
-  return new HttpClient(config)
-}
-
-module.exports = {
-  getPath: getPath,
-  getValidHost: getValidHost,
-  getProtocol: getProtocol,
-  handleResponseErrors: handleResponseErrors,
-  getHttpClient: getHttpClient,
-  handleTimeout: handleTimeout,
-  getTimeout: getTimeout
-}

package/src/utils/filterProjectPath.js

@@ -1,25 +0,0 @@
-const path = require('path')
-const child_process = require('child_process')
-
-function resolveFilePath(filepath) {
-  if (filepath[0] === '~') {
-    return path.join(process.env.HOME, filepath.slice(1))
-  }
-  return filepath
-}
-
-const returnProjectPath = () => {
-  if (process.platform == 'win32') {
-    let winPath = child_process.execSync('cd').toString()
-    return winPath.replace(/\//g, '\\').trim()
-  } else if (process.env.PWD !== (undefined || null || 'undefined')) {
-    return process.env.PWD
-  } else {
-    return process.argv[process.argv.indexOf('--file') + 1]
-  }
-}
-
-module.exports = {
-  returnProjectPath: returnProjectPath,
-  resolveFilePath: resolveFilePath
-}

package/src/utils/generalAPI.js

@@ -1,52 +0,0 @@
-const { featuresTeamServer } = require('./capabilities')
-const semver = require('semver')
-const commonApi = require('./commonApi')
-const { isNil } = require('lodash')
-
-const getGlobalProperties = async config => {
-  const client = commonApi.getHttpClient(config)
-  return client
-    .getGlobalProperties(config.host)
-    .then(res => {
-      if (res.statusCode === 200) {
-        return res.body
-      } else {
-        commonApi.handleResponseErrors(res, 'globalProperties')
-      }
-    })
-    .catch(err => {
-      console.log(err)
-    })
-}
-
-const getMode = async config => {
-  const features = await getGlobalProperties(config)
-
-  if (!isNil(features?.mode)) {
-    return features.mode
-  }
-  return ''
-}
-
-const getFeatures = version => {
-  const featuresEnabled = []
-
-  featuresTeamServer.forEach(feature => {
-    const versionFrom = Object.values(feature)[0]
-    return semver.gte(version, versionFrom)
-      ? featuresEnabled.push(Object.keys(feature)[0])
-      : null
-  })
-  return featuresEnabled
-}
-
-const isFeatureEnabled = (features, featureName) => {
-  return features.includes(featureName)
-}
-
-module.exports = {
-  getGlobalProperties,
-  getFeatures,
-  isFeatureEnabled,
-  getMode
-}

package/src/utils/getConfig.ts

@@ -1,34 +0,0 @@
-import Conf from 'conf'
-import { CE_URL } from '../constants/constants'
-
-type ContrastConfOptions = Partial<{
-  version: string
-  host: string
-  apiKey: string
-  orgId: string
-  authHeader: string
-  numOfRuns: number
-}>
-
-type ContrastConf = Conf<ContrastConfOptions>
-
-const localConfig = (name: string, version: string) => {
-  const config: ContrastConf = new Conf<ContrastConfOptions>({
-    configName: name
-  })
-  config.set('version', version)
-
-  if (!config.has('host')) {
-    config.set('host', CE_URL)
-  }
-  return config
-}
-
-const setConfigValues = (config: ContrastConf, values: ContrastConfOptions) => {
-  config.set('apiKey', values.apiKey)
-  config.set('organizationId', values.orgId)
-  config.set('authorization', values.authHeader)
-  values.host ? config.set('host', values.host) : config.set('host', CE_URL)
-}
-
-export { localConfig, setConfigValues, ContrastConf, ContrastConfOptions }

package/src/utils/oraWrapper.js

@@ -1,29 +0,0 @@
-const ora = require('ora')
-
-const returnOra = text => {
-  return ora(text)
-}
-
-const startSpinner = spinner => {
-  spinner.start()
-}
-
-const stopSpinner = spinner => {
-  spinner.stop()
-}
-
-const succeedSpinner = (spinner, text) => {
-  spinner.succeed(text)
-}
-
-const failSpinner = (spinner, text) => {
-  spinner.fail(text)
-}
-
-module.exports = {
-  returnOra,
-  startSpinner,
-  succeedSpinner,
-  failSpinner,
-  stopSpinner
-}

package/src/utils/paramsUtil/commandlineParams.js

@@ -1,12 +0,0 @@
-const getAuth = (parsedCLIOptions = {}) => {
-  let params = {}
-  params.apiKey = parsedCLIOptions['apiKey']
-  params.authorization = parsedCLIOptions['authorization']
-  params.host = parsedCLIOptions['host']
-  params.organizationId = parsedCLIOptions['organizationId']
-  return params
-}
-
-module.exports = {
-  getAuth: getAuth
-}

package/src/utils/paramsUtil/configStoreParams.js

@@ -1,19 +0,0 @@
-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 }

package/src/utils/paramsUtil/envVariableParams.js

@@ -1,10 +0,0 @@
-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/src/utils/paramsUtil/paramHandler.js

@@ -1,38 +0,0 @@
-const commandlineAuth = require('./commandlineParams')
-const configStoreParams = require('./configStoreParams')
-const envVariableParams = require('./envVariableParams')
-const {
-  validateAuthParams,
-  validateFingerprintParams
-} = require('../validationCheck')
-const i18n = require('i18n')
-
-const getAuth = params => {
-  let commandLineAuthParamsAuth = commandlineAuth.getAuth(params)
-  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 getFingerprint = params => {
-  if (validateFingerprintParams(params)) {
-    return params
-  } else {
-    console.log(
-      'missing fingerprint params please check repository-url and repository-name'
-    )
-    process.exit(1)
-  }
-}
-
-module.exports = { getAuth, getFingerprint }

package/src/utils/parsedCLIOptions.js

@@ -1,32 +0,0 @@
-const commandLineArgs = require('command-line-args')
-const { sendTelemetryConfigAsConfObj } = require('../telemetry/telemetry')
-
-const getCommandLineArgsCustom = async (
-  contrastConf,
-  command,
-  parameterList,
-  optionDefinitions
-) => {
-  try {
-    return commandLineArgs(optionDefinitions, {
-      argv: parameterList,
-      partial: false,
-      camelCase: true,
-      caseInsensitive: true
-    })
-  } catch (e) {
-    await sendTelemetryConfigAsConfObj(
-      contrastConf,
-      command,
-      parameterList,
-      'FAILURE',
-      'undefined'
-    )
-    console.log(e.message.toString())
-    process.exit(1)
-  }
-}
-
-module.exports = {
-  getCommandLineArgsCustom
-}

package/src/utils/requestUtils.js

@@ -1,29 +0,0 @@
-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 / 1000).toFixed(0)
-}
-
-const sleep = ms => {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}
-
-const timeOutError = (ms, reject) => {
-  return setTimeout(() => {
-    reject(new Error(`No input detected after 30s`))
-  }, ms)
-}
-
-module.exports = {
-  sendRequest: sendRequest,
-  sleep: sleep,
-  millisToSeconds: millisToSeconds,
-  timeOutError: timeOutError
-}

package/src/utils/saveFile.js

@@ -1,20 +0,0 @@
-const { SARIF_FILE } = require('../constants/constants')
-const commonApi = require('./commonApi')
-const saveResults = require('../scan/saveResults')
-const i18n = require('i18n')
-
-const saveScanFile = async (config, scanResults) => {
-  if (config.save === null || config.save.toUpperCase() === SARIF_FILE) {
-    const scanId = scanResults.scanDetail.id
-    const client = commonApi.getHttpClient(config)
-    const rawResults = await client.getSpecificScanResultSarif(config, scanId)
-    const name = await saveResults.writeResultsToFile(rawResults?.body)
-    console.log(`Scan Results saved to ${name}`)
-  } else {
-    console.log(i18n.__('scanNoFiletypeSpecifiedForSave'))
-  }
-}
-
-module.exports = {
-  saveScanFile: saveScanFile
-}

package/src/utils/validationCheck.js

@@ -1,39 +0,0 @@
-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
-  )
-}
-
-const validateFingerprintParams = params => {
-  return !!(params.repositoryUrl && params.repositoryName)
-}
-
-module.exports = {
-  checkConfigHasRequiredValues: checkConfigHasRequiredValues,
-  validateAuthParams: validateAuthParams,
-  validateRequiredScanParams: validateRequiredScanParams,
-  validateFingerprintParams: validateFingerprintParams
-}