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

package/src/cliConstants.js

@@ -1,523 +0,0 @@
-const commandLineUsage = require('command-line-usage')
-const i18n = require('i18n')
-const { en_locales } = require('./constants/locales.js')
-const { parseSeverity } = require('./common/fail')
-const { commonHelpLinks } = require('./common/commonHelp')
-
-i18n.configure({
-  staticCatalog: {
-    en: en_locales()
-  },
-  defaultLocale: 'en'
-})
-
-const sharedCertOptionDefinitions = [
-  {
-    name: 'proxy',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProxyServer')
-  },
-  {
-    name: 'key',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProxyKey')
-  },
-  {
-    name: 'cacert',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProxyCaCert')
-  },
-  {
-    name: 'cert',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProxyCert')
-  },
-  {
-    name: 'cert-self-signed',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('constantsCertSelfSigned')
-  }
-]
-
-const sharedConnectionOptionDefinitions = [
-  {
-    name: 'organization-id',
-    alias: 'o',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequiredEnterprise') +
-      '}: ' +
-      i18n.__('constantsOrganizationId')
-  },
-  {
-    name: 'api-key',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequiredEnterprise') +
-      '}: ' +
-      i18n.__('constantsApiKey')
-  },
-  {
-    name: 'authorization',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequiredEnterprise') +
-      '}: ' +
-      i18n.__('constantsAuthorization')
-  },
-  {
-    name: 'host',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequiredEnterprise') +
-      '}: ' +
-      i18n.__('constantsHostId')
-  }
-]
-
-const scanAdvancedOptionDefinitionsForHelp = [
-  ...sharedConnectionOptionDefinitions,
-  ...sharedCertOptionDefinitions,
-  {
-    name: 'project-id',
-    alias: 'p',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProjectId')
-  },
-  {
-    name: 'language',
-    alias: 'l',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('scanOptionsLanguageSummary')
-  },
-  {
-    name: 'ff',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsDoNotWaitForScan')
-  },
-  {
-    name: 'label',
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('scanLabel')
-  }
-]
-
-// CLI options that we will allow and handle
-const scanOptionDefinitions = [
-  ...scanAdvancedOptionDefinitionsForHelp,
-  {
-    name: 'name',
-    alias: 'n',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProjectName')
-  },
-  {
-    name: 'file',
-    alias: 'f',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('scanOptionsFileNameSummary')
-  },
-  {
-    name: 'timeout',
-    alias: 't',
-    type: Number,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('scanOptionsTimeoutSummary')
-  },
-  {
-    name: 'fail',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('failOptionMessage')
-  },
-  {
-    name: 'severity',
-    type: severity => parseSeverity(severity),
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsSeverity')
-  },
-  {
-    name: 'verbose',
-    alias: 'v',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('scanOptionsVerboseSummary')
-  },
-  {
-    name: 'save',
-    alias: 's',
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('constantsSave')
-  },
-  {
-    name: 'help',
-    alias: 'h',
-    type: Boolean
-  },
-  {
-    name: 'debug',
-    alias: 'd',
-    type: Boolean
-  },
-  {
-    name: 'experimental',
-    alias: 'e',
-    type: Boolean
-  }
-]
-
-const authOptionDefinitions = [
-  ...sharedConnectionOptionDefinitions,
-  ...sharedCertOptionDefinitions,
-  {
-    name: 'help',
-    alias: 'h',
-    type: Boolean
-  }
-]
-
-const configOptionDefinitions = [
-  {
-    name: 'help',
-    alias: 'h',
-    type: Boolean,
-    description: 'Help text'
-  },
-  {
-    name: 'clear',
-    alias: 'c',
-    type: Boolean,
-    description: 'Clear the currently stored config'
-  }
-]
-
-const auditAdvancedOptionDefinitionsForHelp = [
-  ...sharedConnectionOptionDefinitions,
-  ...sharedCertOptionDefinitions,
-  {
-    name: 'application-id',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequired') +
-      '}: ' +
-      i18n.__('constantsApplicationId')
-  },
-  {
-    name: 'application-name',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsApplicationName')
-  },
-  {
-    name: 'name',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsProjectName')
-  },
-  {
-    name: 'app-groups',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsAppGroups')
-  },
-  {
-    name: 'sub-project',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsGradleMultiProject')
-  },
-  {
-    name: 'metadata',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsMetadata')
-  },
-  {
-    name: 'tags',
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}: ' + i18n.__('constantsTags')
-  },
-  {
-    name: 'code',
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}: ' + i18n.__('constantsCode')
-  },
-  {
-    name: 'maven-settings-path',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsMavenSettingsPath')
-  }
-]
-
-const auditOptionDefinitions = [
-  ...auditAdvancedOptionDefinitionsForHelp,
-  {
-    name: 'file',
-    alias: 'f',
-    defaultValue: process.cwd().concat('/'),
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsFilePath')
-  },
-  {
-    name: 'fail',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('failOptionMessage')
-  },
-  {
-    name: 'severity',
-    type: severity => parseSeverity(severity),
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsSeverity')
-  },
-  {
-    name: 'ignore-dev',
-    type: Boolean,
-    alias: 'i',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsIgnoreDev')
-  },
-  {
-    name: 'save',
-    alias: 's',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('auditOptionsSaveDescription') +
-      i18n.__('auditOptionsSaveOptionsDescription')
-  },
-  {
-    name: 'experimental',
-    alias: 'e',
-    type: Boolean
-  },
-  {
-    name: 'timeout',
-    alias: 't',
-    type: Number,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('scanOptionsTimeoutSummary')
-  },
-  {
-    name: 'help',
-    alias: 'h',
-    type: Boolean
-  },
-  {
-    name: 'debug',
-    alias: 'd',
-    type: Boolean
-  },
-  {
-    name: 'verbose',
-    alias: 'v',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('scanOptionsVerboseSummary')
-  },
-  {
-    name: 'track',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('auditOptionsTrackSummary')
-  },
-  {
-    name: 'branch',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('auditOptionsBranchSummary')
-  },
-  {
-    name: 'legacy',
-    alias: 'l',
-    type: Boolean,
-    defaultValue: false,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('auditOptionsLegacySummary')
-  },
-  {
-    name: 'repo',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}:' +
-      i18n.__('auditOptionsRepoSummary')
-  },
-  {
-    name: 'repository-id',
-    type: String,
-    description: ''
-  },
-  {
-    name: 'project-group-id',
-    type: String,
-    description: ''
-  }
-]
-
-const fingerprintOptionDefinitions = [
-  ...auditOptionDefinitions,
-  {
-    name: 'depth',
-    type: Number,
-    default: 3,
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}: ' + i18n.__('depthOption')
-  },
-  {
-    name: 'repository-url',
-    type: String,
-    description: ''
-  },
-  {
-    name: 'external-id',
-    type: String,
-    description: ''
-  },
-  {
-    name: 'repository-name',
-    type: String,
-    description: ''
-  }
-]
-
-const mainUsageGuide = commandLineUsage([
-  {
-    header: i18n.__('constantsHeader'),
-    content: [
-      i18n.__('constantsContrastContent'),
-      i18n.__('constantsContrastCategories')
-    ]
-  },
-  {
-    header: i18n.__('constantsUsage'),
-    content: [i18n.__('constantsUsageCommandExample')]
-  },
-  {
-    header: i18n.__('constantsCommands'),
-    content: [
-      { name: i18n.__('authName'), summary: i18n.__('helpAuthSummary') },
-      { name: i18n.__('configName'), summary: i18n.__('helpConfigSummary') },
-      { name: i18n.__('versionName'), summary: i18n.__('helpVersionSummary') },
-      { name: i18n.__('auditName'), summary: i18n.__('helpAuditSummary') },
-      { name: i18n.__('scanName'), summary: i18n.__('helpScanSummary') },
-      { name: i18n.__('lambdaName'), summary: i18n.__('helpLambdaSummary') },
-      { name: i18n.__('helpName'), summary: i18n.__('helpSummary') },
-      { name: i18n.__('learnName'), summary: i18n.__('helpLearnSummary') }
-    ]
-  },
-  {
-    header: i18n.__('constantsAdvancedOptions'),
-    optionList: sharedCertOptionDefinitions
-  },
-  {
-    header: i18n.__('configHeader2'),
-    content: [
-      { name: i18n.__('clearHeader'), summary: i18n.__('clearContent') }
-    ]
-  },
-  commonHelpLinks()[0],
-  commonHelpLinks()[1],
-  commonHelpLinks()[2]
-])
-
-const mainDefinition = [{ name: 'command', defaultOption: true }]
-
-module.exports = {
-  commandLineDefinitions: {
-    mainUsageGuide,
-    mainDefinition,
-    scanOptionDefinitions,
-    fingerprintOptionDefinitions,
-    auditOptionDefinitions,
-    authOptionDefinitions,
-    configOptionDefinitions,
-    scanAdvancedOptionDefinitionsForHelp,
-    auditAdvancedOptionDefinitionsForHelp
-  }
-}

package/src/commands/audit/auditConfig.js

@@ -1,18 +0,0 @@
-const { getCommandLineArgsCustom } = require('../../utils/parsedCLIOptions')
-const constants = require('../../cliConstants')
-const paramHandler = require('../../utils/paramsUtil/paramHandler')
-
-const getAuditConfig = async (contrastConf, command, argv) => {
-  const auditParameters = await getCommandLineArgsCustom(
-    contrastConf,
-    command,
-    argv,
-    constants.commandLineDefinitions.auditOptionDefinitions
-  )
-  const paramsAuth = paramHandler.getAuth(auditParameters)
-  return { ...paramsAuth, ...auditParameters }
-}
-
-module.exports = {
-  getAuditConfig
-}

package/src/commands/audit/auditController.js

@@ -1,50 +0,0 @@
-const catalogue = require('../../audit/catalogueApplication/catalogueApplication')
-const commonApi = require('../../audit/languageAnalysisEngine/commonApi')
-
-const dealWithNoAppId = async config => {
-  let appID
-  try {
-    appID = await commonApi.returnAppId(config)
-
-    if (!appID && config.applicationName) {
-      return await catalogue.catalogueApplication(config)
-    }
-
-    if (!appID && !config.applicationName) {
-      config.applicationName = getAppName(config.file)
-      appID = await commonApi.returnAppId(config)
-
-      if (!appID) {
-        return await catalogue.catalogueApplication(config)
-      }
-    }
-  } catch (e) {
-    if (e.toString().includes('tunneling socket could not be established')) {
-      console.log(e.message.toString())
-      console.log(
-        'There seems to be an issue with your proxy, please check and try again'
-      )
-    }
-    process.exit(1)
-  }
-  return appID
-}
-
-const getAppName = file => {
-  const last = file.charAt(file.length - 1)
-  if (last !== '/') {
-    return file.split('/').pop()
-  } else {
-    const str = removeLastChar(file)
-    return str.split('/').pop()
-  }
-}
-
-const removeLastChar = str => {
-  return str.substring(0, str.length - 1)
-}
-
-module.exports = {
-  dealWithNoAppId,
-  getAppName
-}

package/src/commands/audit/help.js

@@ -1,72 +0,0 @@
-const commandLineUsage = require('command-line-usage')
-const i18n = require('i18n')
-const constants = require('../../cliConstants')
-const { commonHelpLinks } = require('../../common/commonHelp')
-
-const auditUsageGuide = commandLineUsage([
-  {
-    header: i18n.__('constantsHeader')
-  },
-  {
-    header: i18n.__('auditHeader'),
-    content: [i18n.__('auditHeaderMessage')]
-  },
-  {
-    header: i18n.__('constantsPrerequisitesHeader'),
-    content: [
-      '{bold ' +
-        i18n.__('constantsAuditPrerequisitesContentSupportedLanguages') +
-        '}',
-      i18n.__('constantsAuditPrerequisitesJavaContentMessage'),
-      i18n.__('constantsAuditPrerequisitesContentDotNetMessage'),
-      i18n.__('constantsAuditPrerequisitesContentNodeMessage'),
-      i18n.__('constantsAuditPrerequisitesContentRubyMessage'),
-      i18n.__('constantsAuditPrerequisitesContentPythonMessage'),
-      i18n.__('constantsAuditPrerequisitesContentGoMessage'),
-      i18n.__('constantsAuditPrerequisitesContentPHPMessage')
-    ]
-  },
-  {
-    header: i18n.__('constantsAuditOptions'),
-    optionList: constants.commandLineDefinitions.auditOptionDefinitions,
-    hide: [
-      'application-id',
-      'application-name',
-      'organization-id',
-      'api-key',
-      'authorization',
-      'host',
-      'proxy',
-      'cert',
-      'cacert',
-      'key',
-      'help',
-      'ff',
-      'cert-self-signed',
-      'verbose',
-      'debug',
-      'experimental',
-      'tags',
-      'sub-project',
-      'code',
-      'maven-settings-path',
-      'language',
-      'app-groups',
-      'metadata',
-      'branch',
-      'repo'
-    ]
-  },
-  {
-    header: i18n.__('constantsAdvancedOptions'),
-    optionList:
-      constants.commandLineDefinitions.auditAdvancedOptionDefinitionsForHelp
-  },
-  commonHelpLinks()[0],
-  commonHelpLinks()[1],
-  commonHelpLinks()[2]
-])
-
-module.exports = {
-  auditUsageGuide
-}

package/src/commands/audit/processAudit.js

@@ -1,34 +0,0 @@
-const auditConfig = require('./auditConfig')
-const { auditUsageGuide } = require('./help')
-const scaController = require('../../scaAnalysis/scaAnalysis')
-const { sendTelemetryConfigAsObject } = require('../../telemetry/telemetry')
-const { postRunMessage } = require('../../common/commonHelp')
-
-const processAudit = async (contrastConf, argvMain) => {
-  if (argvMain.indexOf('--help') !== -1) {
-    printHelpMessage()
-    process.exit(0)
-  }
-
-  let config = await auditConfig.getAuditConfig(contrastConf, 'audit', argvMain)
-
-  await scaController.processSca(config)
-  if (!config.fingerprint) {
-    postRunMessage('audit')
-    await sendTelemetryConfigAsObject(
-      config,
-      'audit',
-      argvMain,
-      'SUCCESS',
-      config.language
-    )
-  }
-}
-
-const printHelpMessage = () => {
-  console.log(auditUsageGuide)
-}
-
-module.exports = {
-  processAudit
-}

package/src/commands/audit/saveFile.js

@@ -1,15 +0,0 @@
-const fs = require('fs')
-
-const saveFile = (config, type, rawResults) => {
-  let fileStart = config.legacy ? config.applicationId : config.projectId
-  if (fileStart === undefined) {
-    fileStart = 'my'
-  }
-
-  const fileName = `${fileStart}-sbom-${type}.json`
-  fs.writeFileSync(fileName, JSON.stringify(rawResults))
-}
-
-module.exports = {
-  saveFile
-}