@contrast/contrast 1.0.16 → 1.0.18

package/src/cliConstants.js

@@ -11,7 +11,7 @@ i18n.configure({
   defaultLocale: 'en'
 })
 
-const sharedOptionDefinitions = [
+const sharedCertOptionDefinitions = [
   {
     name: 'proxy',
     description:
@@ -45,46 +45,55 @@ const sharedOptionDefinitions = [
       i18n.__('constantsProxyCert')
   },
   {
-    name: 'ignore-cert-errors',
+    name: 'cert-self-signed',
     type: Boolean,
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
       '}:' +
-      i18n.__('constantsIgnoreCertErrors')
+      i18n.__('constantsCertSelfSigned')
   }
 ]
 
-// CLI options that we will allow and handle
-const scanOptionDefinitions = [
-  ...sharedOptionDefinitions,
+const sharedConnectionOptionDefinitions = [
   {
-    name: 'name',
-    alias: 'n',
+    name: 'organization-id',
+    alias: 'o',
     description:
       '{bold ' +
-      i18n.__('constantsOptional') +
+      i18n.__('constantsRequiredEnterprise') +
       '}: ' +
-      i18n.__('constantsProjectName')
+      i18n.__('constantsOrganizationId')
   },
   {
-    name: 'language',
-    alias: 'l',
+    name: 'api-key',
     description:
       '{bold ' +
-      i18n.__('constantsOptional') +
+      i18n.__('constantsRequiredEnterprise') +
       '}: ' +
-      i18n.__('scanOptionsLanguageSummary')
+      i18n.__('constantsApiKey')
   },
   {
-    name: 'file',
-    alias: 'f',
+    name: 'authorization',
     description:
       '{bold ' +
-      i18n.__('constantsOptional') +
+      i18n.__('constantsRequiredEnterprise') +
       '}: ' +
-      i18n.__('scanOptionsFileNameSummary')
+      i18n.__('constantsAuthorization')
   },
+  {
+    name: 'host',
+    description:
+      '{bold ' +
+      i18n.__('constantsRequiredEnterprise') +
+      '}: ' +
+      i18n.__('constantsHostId')
+  }
+]
+
+const scanAdvancedOptionDefinitionsForHelp = [
+  ...sharedConnectionOptionDefinitions,
+  ...sharedCertOptionDefinitions,
   {
     name: 'project-id',
     alias: 'p',
@@ -95,55 +104,60 @@ const scanOptionDefinitions = [
       i18n.__('constantsProjectId')
   },
   {
-    name: 'project-path',
+    name: 'language',
+    alias: 'l',
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsProjectPath')
+      i18n.__('scanOptionsLanguageSummary')
   },
   {
-    name: 'timeout',
-    alias: 't',
-    type: Number,
+    name: 'ff',
+    type: Boolean,
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('scanOptionsTimeoutSummary')
+      i18n.__('constantsDoNotWaitForScan')
   },
   {
-    name: 'organization-id',
-    alias: 'o',
+    name: 'label',
     description:
-      '{bold ' +
-      i18n.__('constantsRequired') +
-      '}: ' +
-      i18n.__('constantsOrganizationId')
-  },
+      '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('scanLabel')
+  }
+]
+
+// CLI options that we will allow and handle
+const scanOptionDefinitions = [
+  ...scanAdvancedOptionDefinitionsForHelp,
   {
-    name: 'api-key',
+    name: 'name',
+    alias: 'n',
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsApiKey')
+      i18n.__('constantsProjectName')
   },
   {
-    name: 'authorization',
+    name: 'file',
+    alias: 'f',
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsAuthorization')
+      i18n.__('scanOptionsFileNameSummary')
   },
   {
-    name: 'host',
+    name: 'timeout',
+    alias: 't',
+    type: Number,
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsHostId')
+      i18n.__('scanOptionsTimeoutSummary')
   },
   {
     name: 'fail',
@@ -163,15 +177,6 @@ const scanOptionDefinitions = [
       '}: ' +
       i18n.__('constantsSeverity')
   },
-  {
-    name: 'ff',
-    type: Boolean,
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsDoNotWaitForScan')
-  },
   {
     name: 'verbose',
     alias: 'v',
@@ -188,11 +193,6 @@ const scanOptionDefinitions = [
     description:
       '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('constantsSave')
   },
-  {
-    name: 'label',
-    description:
-      '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('scanLabel')
-  },
   {
     name: 'help',
     alias: 'h',
@@ -207,14 +207,6 @@ const scanOptionDefinitions = [
     name: 'experimental',
     alias: 'e',
     type: Boolean
-  },
-  {
-    name: 'application-name',
-    description:
-      '{bold ' +
-      i18n.__('constantsOptional') +
-      '}: ' +
-      i18n.__('constantsApplicationName')
   }
 ]
 
@@ -241,8 +233,9 @@ const configOptionDefinitions = [
   }
 ]
 
-const auditOptionDefinitions = [
-  ...sharedOptionDefinitions,
+const auditAdvancedOptionDefinitionsForHelp = [
+  ...sharedConnectionOptionDefinitions,
+  ...sharedCertOptionDefinitions,
   {
     name: 'application-id',
     description:
@@ -259,39 +252,11 @@ const auditOptionDefinitions = [
       '}: ' +
       i18n.__('constantsApplicationName')
   },
-  {
-    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: 'app-groups',
     description:
       '{bold ' +
-      i18n.__('constantsOptionalForCatalogue') +
+      i18n.__('constantsOptional') +
       '}: ' +
       i18n.__('constantsAppGroups')
   },
@@ -322,50 +287,58 @@ const auditOptionDefinitions = [
       '{bold ' + i18n.__('constantsOptional') + '}: ' + i18n.__('constantsCode')
   },
   {
-    name: 'ignore-dev',
-    type: Boolean,
-    alias: 'i',
+    name: 'maven-settings-path',
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsIgnoreDev')
-  },
-  {
-    name: 'maven-settings-path'
-  },
+      i18n.__('constantsMavenSettingsPath')
+  }
+]
+
+const auditOptionDefinitions = [
+  ...auditAdvancedOptionDefinitionsForHelp,
   {
-    name: 'organization-id',
-    alias: 'o',
+    name: 'file',
+    alias: 'f',
+    defaultValue: process.cwd().concat('/'),
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsOrganizationId')
+      i18n.__('constantsFilePath')
   },
   {
-    name: 'api-key',
+    name: 'fail',
+    type: Boolean,
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsApiKey')
+      i18n.__('failOptionMessage')
   },
   {
-    name: 'authorization',
+    name: 'severity',
+    type: severity => parseSeverity(severity),
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsAuthorization')
+      i18n.__('constantsSeverity')
   },
   {
-    name: 'host',
+    name: 'ignore-dev',
+    type: Boolean,
+    alias: 'i',
     description:
       '{bold ' +
-      i18n.__('constantsRequired') +
+      i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsHostId')
+      i18n.__('constantsIgnoreDev')
+  },
+  {
+    name: 'fingerprint',
+    type: Boolean
   },
   {
     name: 'save',
@@ -455,13 +428,18 @@ const mainUsageGuide = commandLineUsage([
       { name: i18n.__('helpName'), summary: i18n.__('helpSummary') }
     ]
   },
+  {
+    header: i18n.__('constantsAdvancedOptions'),
+    optionList: sharedCertOptionDefinitions
+  },
   {
     header: i18n.__('configHeader2'),
     content: [
       { name: i18n.__('clearHeader'), summary: i18n.__('clearContent') }
     ]
   },
-  commonHelpLinks()
+  commonHelpLinks()[0],
+  commonHelpLinks()[1]
 ])
 
 const mainDefinition = [{ name: 'command', defaultOption: true }]
@@ -473,6 +451,8 @@ module.exports = {
     scanOptionDefinitions,
     auditOptionDefinitions,
     authOptionDefinitions,
-    configOptionDefinitions
+    configOptionDefinitions,
+    scanAdvancedOptionDefinitionsForHelp,
+    auditAdvancedOptionDefinitionsForHelp
   }
 }

package/src/commands/audit/auditConfig.js

@@ -0,0 +1,19 @@
+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)
+  const javaAgreement = paramHandler.getAgreement()
+  return { ...paramsAuth, ...auditParameters, ...javaAgreement }
+}
+
+module.exports = {
+  getAuditConfig
+}

package/src/commands/audit/{auditController.ts → auditController.js}

@@ -1,23 +1,24 @@
-import { catalogueApplication } from '../../audit/catalogueApplication/catalogueApplication'
-import commonApi from '../../audit/languageAnalysisEngine/commonApi'
+const catalogue = require('../../audit/catalogueApplication/catalogueApplication')
+const commonApi = require('../../audit/languageAnalysisEngine/commonApi')
 
-export const dealWithNoAppId = async (config: { [x: string]: string }) => {
-  let appID: string
+const dealWithNoAppId = async config => {
+  let appID
   try {
-    // @ts-ignore
     appID = await commonApi.returnAppId(config)
+
     if (!appID && config.applicationName) {
-      return await catalogueApplication(config)
+      return await catalogue.catalogueApplication(config)
     }
+
     if (!appID && !config.applicationName) {
-      config.applicationName = getAppName(config.file) as string
-      // @ts-ignore
+      config.applicationName = getAppName(config.file)
       appID = await commonApi.returnAppId(config)
+
       if (!appID) {
-        return await catalogueApplication(config)
+        return await catalogue.catalogueApplication(config)
       }
     }
-  } catch (e: any) {
+  } catch (e) {
     if (e.toString().includes('tunneling socket could not be established')) {
       console.log(e.message.toString())
       console.log(
@@ -29,7 +30,7 @@ export const dealWithNoAppId = async (config: { [x: string]: string }) => {
   return appID
 }
 
-export const getAppName = (file: string) => {
+const getAppName = file => {
   const last = file.charAt(file.length - 1)
   if (last !== '/') {
     return file.split('/').pop()
@@ -39,6 +40,10 @@ export const getAppName = (file: string) => {
   }
 }
 
-const removeLastChar = (str: string) => {
+const removeLastChar = str => {
   return str.substring(0, str.length - 1)
 }
+
+module.exports = {
+  dealWithNoAppId
+}

package/src/commands/audit/{help.ts → help.js}

@@ -1,7 +1,7 @@
-import commandLineUsage from 'command-line-usage'
-import i18n from 'i18n'
-import constants from '../../cliConstants'
-import { commonHelpLinks } from '../../common/commonHelp'
+const commandLineUsage = require('command-line-usage')
+const i18n = require('i18n')
+const constants = require('../../cliConstants')
+const { commonHelpLinks } = require('../../common/commonHelp')
 
 const auditUsageGuide = commandLineUsage([
   {
@@ -34,9 +34,12 @@ const auditUsageGuide = commandLineUsage([
       'authorization',
       'host',
       'proxy',
+      'cert',
+      'cacert',
+      'key',
       'help',
       'ff',
-      'ignore-cert-errors',
+      'cert-self-signed',
       'verbose',
       'debug',
       'experimental',
@@ -49,10 +52,19 @@ const auditUsageGuide = commandLineUsage([
       'app-groups',
       'metadata',
       'track',
+      'fingerprint',
       'branch'
     ]
   },
-  commonHelpLinks()
+  {
+    header: i18n.__('constantsAdvancedOptions'),
+    optionList:
+      constants.commandLineDefinitions.auditAdvancedOptionDefinitionsForHelp
+  },
+  commonHelpLinks()[0],
+  commonHelpLinks()[1]
 ])
 
-export { auditUsageGuide }
+module.exports = {
+  auditUsageGuide
+}

package/src/commands/audit/processAudit.js

@@ -0,0 +1,37 @@
+const auditConfig = require('./auditConfig')
+const { auditUsageGuide } = require('./help')
+const scaController = require('../scan/sca/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)
+  }
+
+  const 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.ts → saveFile.js}

@@ -1,6 +1,6 @@
-import fs from 'fs'
+const fs = require('fs')
 
-export const saveFile = (config: any, type: string, rawResults: any) => {
+const saveFile = (config, type, rawResults) => {
   const fileName = `${config.applicationId}-sbom-${type}.json`
   fs.writeFileSync(fileName, JSON.stringify(rawResults))
 }

package/src/commands/scan/processScan.js

@@ -5,7 +5,7 @@ const { ScanResultsModel } = require('../../scan/models/scanResultsModel')
 const { formatScanOutput } = require('../../scan/formatScanOutput')
 const common = require('../../common/fail')
 const { sendTelemetryConfigAsObject } = require('../../telemetry/telemetry')
-const chalk = require('chalk')
+const { postRunMessage } = require('../../common/commonHelp')
 
 const processScan = async (contrastConf, argv) => {
   let config = await scanConfig.getScanConfig(contrastConf, 'scan', argv)
@@ -26,21 +26,15 @@ const processScan = async (contrastConf, argv) => {
 
   if (config.save !== undefined) {
     await saveScanFile(config, scanResults)
+  } else {
+    console.log('\nUse contrast scan --save to save results as a SARIF')
   }
 
   if (config.fail) {
     common.processFail(config, output)
   }
 
-  postRunMessage()
-}
-
-const postRunMessage = () => {
-  console.log('\n' + chalk.underline.bold('Other Codesec Features:'))
-  console.log(
-    "'contrast audit' to find vulnerabilities in your open source dependencies"
-  )
-  console.log("'contrast lambda' to secure your AWS serverless functions\n")
+  postRunMessage('scan')
 }
 
 module.exports = {