@contrast/contrast 1.0.4 → 1.0.5

package/src/audit/languageAnalysisEngine/sendSnapshot.js

@@ -1,23 +1,8 @@
-const prettyjson = require('prettyjson')
-const i18n = require('i18n')
 const { getHttpClient } = require('../../utils/commonApi')
 const { handleResponseErrors } = require('../../common/errorHandling')
 const { APP_VERSION } = require('../../constants/constants')
 
-function displaySnapshotSuccessMessage(config) {
-  console.log(
-    '\n **************************' +
-      i18n.__('successHeader') +
-      '************************** '
-  )
-  console.log('\n' + i18n.__('snapshotSuccessMessage') + '\n')
-  console.log(
-    ` ${config.host}/Contrast/static/ng/index.html#/${config.organizationId}/applications/${config.applicationId}/libs/dependency-tree`
-  )
-  console.log('\n ***********************************************************')
-}
-
-const newSendSnapShot = async (analysis, applicationId) => {
+const newSendSnapShot = async analysis => {
   const analysisLanguage = analysis.config.language.toLowerCase()
   const requestBody = {
     appID: analysis.config.applicationId,
@@ -30,13 +15,7 @@ const newSendSnapShot = async (analysis, applicationId) => {
   return client
     .sendSnapshot(requestBody, analysis.config)
     .then(res => {
-      // if (!analysis.config.silent) {
-      //   console.log(prettyjson.render(requestBody))
-      // }
       if (res.statusCode === 201) {
-        if (analysis.config.host !== 'https://ce.contrastsecurity.com/') {
-          displaySnapshotSuccessMessage(analysis.config)
-        }
         return res.body
       } else {
         handleResponseErrors(res, 'snapshot')
@@ -48,6 +27,5 @@ const newSendSnapShot = async (analysis, applicationId) => {
 }
 
 module.exports = {
-  newSendSnapShot: newSendSnapShot,
-  displaySnapshotSuccessMessage: displaySnapshotSuccessMessage
+  newSendSnapShot: newSendSnapShot
 }

package/src/commands/audit/auditConfig.ts

@@ -2,6 +2,10 @@ import paramHandler from '../../utils/paramsUtil/paramHandler'
 import constants from '../../constants'
 import cliOptions from '../../utils/parsedCLIOptions'
 import languageAnalysisEngine from '../../audit/languageAnalysisEngine/constants'
+import {
+  determineProjectLanguage,
+  identifyLanguages
+} from '../../audit/autodetection/autoDetectLanguage'
 
 const {
   supportedLanguages: { NODE, JAVASCRIPT }
@@ -18,9 +22,14 @@ export const getAuditConfig = (argv: string[]): { [key: string]: string } => {
     auditParameters.language === undefined ||
     auditParameters.language === null
   ) {
-    //error no language
-    console.log('error, --language parameter is required')
-    process.exit(1)
+    try {
+      auditParameters.language = determineProjectLanguage(
+        identifyLanguages(auditParameters)
+      )
+    } catch (err: any) {
+      console.log(err.message)
+      process.exit(1)
+    }
   } else if (auditParameters.language.toUpperCase() === JAVASCRIPT) {
     auditParameters.language = NODE.toLowerCase()
   }

package/src/commands/audit/auditController.ts

@@ -3,14 +3,21 @@ import commonApi from '../../audit/languageAnalysisEngine/commonApi'
 
 const identifyLanguageAE = require('./../../audit/languageAnalysisEngine')
 const languageFactory = require('../../audit/languageAnalysisEngine/languageAnalysisFactory')
+const { v4: uuidv4 } = require('uuid')
 
-const dealWithNoAppId = async (config: { [x: string]: string }) => {
-  let appID
+export const dealWithNoAppId = async (config: { [x: string]: string }) => {
+  let appID: string
   try {
+    // @ts-ignore
     appID = await commonApi.returnAppId(config)
+    // console.log('appid', appID)
     if (!appID && config.applicationName) {
       return await catalogueApplication(config)
     }
+    if (!appID && !config.applicationName) {
+      config.applicationName = uuidv4()
+      return await catalogueApplication(config)
+    }
     // @ts-ignore
   } catch (e) {
     // @ts-ignore

package/src/commands/audit/processAudit.ts

@@ -10,6 +10,9 @@ export const processAudit = async (argv: parameterInput) => {
     process.exit(1)
   }
   const config = getAuditConfig(argv)
+
+  // console.log(config)
+
   const auditResults = await startAudit(config)
 }
 

package/src/commands/scan/processScan.js

@@ -1,12 +1,17 @@
-const { startScan } = require('../../scan/scanController')
-const { scanUsageGuide } = require('../../scan/help')
 const scanConfig = require('../../scan/scanConfig')
+const { startScan } = require('../../scan/scanController')
 const { saveScanFile } = require('../../utils/saveFile')
 const { ScanResultsModel } = require('../../scan/models/scanResultsModel')
-const { formatScanOutput } = require('../../scan/scan')
+const { formatScanOutput } = require('../../scan/formatScanOutput')
+const { processSca } = require('./sca/scaAnalysis')
 
 const processScan = async argvMain => {
   let config = scanConfig.getScanConfig(argvMain)
+  // console.log(config)
+  //try SCA analysis first
+  if (config.experimental) {
+    await processSca(config)
+  }
 
   let scanResults = new ScanResultsModel(await startScan(config))
   if (scanResults) {

package/src/commands/scan/sca/scaAnalysis.js

@@ -0,0 +1,73 @@
+const autoDetection = require('../../../scan/autoDetection')
+const { javaAnalysis } = require('../../../scaAnalysis/java')
+const { commonSendSnapShot } = require('../../../scaAnalysis/common/treeUpload')
+const {
+  manualDetectAuditFilesAndLanguages
+} = require('../../../scan/autoDetection')
+const { dealWithNoAppId } = require('../../audit/auditController')
+const {
+  supportedLanguages: { JAVA }
+} = require('../../../audit/languageAnalysisEngine/constants')
+
+const processSca = async config => {
+  let filesFound
+  if (config.projectPath) {
+    filesFound = await manualDetectAuditFilesAndLanguages(config.projectPath)
+  } else {
+    filesFound = await autoDetection.autoDetectAuditFilesAndLanguages(config)
+  }
+
+  // files found looks like [ { javascript: [ Array ] } ]
+  //check we have the language and call the right analyser
+  //refactor new analyser and see if we can clean it up
+  let messageToSend = undefined
+  if (filesFound.length === 1) {
+    switch (Object.keys(filesFound[0])[0]) {
+      case JAVA:
+        messageToSend = await javaAnalysis(config, filesFound[0])
+        config.language = JAVA
+        break
+      // case 'javascript':
+      //     // code block
+      //     break;
+      // case 'dotnet':
+      //     // code block
+      //     break;
+      // case 'python':
+      //     // code block
+      //     break;
+      // case 'ruby':
+      //     // code block
+      //     break;
+      // case 'php':
+      //     // code block
+      //     break;
+      // case 'go':
+      //     // code block
+      //     break;
+      default:
+        //something is wrong
+        console.log('language detected not supported')
+        return
+    }
+
+    if (!config.applicationId) {
+      config.applicationId = await dealWithNoAppId(config)
+    }
+    //send message to TS
+    console.log('processing dependencies')
+    const response = await commonSendSnapShot(messageToSend, config)
+  } else {
+    if (filesFound.length === 0) {
+      console.log('no compatible dependency files detected. Continuing...')
+    } else {
+      console.log(
+        'multiple language files detected, please use --project-path to specify a directory or the file where dependencies are declared'
+      )
+    }
+  }
+}
+
+module.exports = {
+  processSca
+}

package/src/common/HTTPClient.js

@@ -191,7 +191,7 @@ HTTPClient.prototype.catalogueCommand = function catalogueCommand(config) {
 
 HTTPClient.prototype.sendSnapshot = function sendSnapshot(requestBody, config) {
   if (config.language.toUpperCase() === 'RUBY') {
-    console.log('sendSnapshot requestBody', requestBody.snapshot.ruby)
+    //console.log('sendSnapshot requestBody', requestBody.snapshot.ruby)
   }
   const options = _.cloneDeep(this.requestOptions)
   let url = createSnapshotURL(config)

package/src/common/errorHandling.ts

@@ -27,30 +27,15 @@ const libraryAnalysisError = () => {
 }
 
 const snapshotFailureError = () => {
-  console.log(
-    '\n ******************************** ' +
-      i18n.__('snapshotFailureHeader') +
-      ' *********************************\n' +
-      i18n.__('snapshotFailureMessage')
-  )
+  console.log(i18n.__('snapshotFailureMessage'))
 }
 
 const vulnerabilitiesFailureError = () => {
-  console.log(
-    '\n ******************************** ' +
-      i18n.__('snapshotFailureHeader') +
-      ' *********************************\n' +
-      i18n.__('vulnerabilitiesFailureMessage')
-  )
+  console.log(i18n.__('vulnerabilitiesFailureMessage'))
 }
 
 const reportFailureError = () => {
-  console.log(
-    '\n ******************************** ' +
-      i18n.__('snapshotFailureHeader') +
-      ' *********************************\n' +
-      i18n.__('reportFailureMessage')
-  )
+  console.log(i18n.__('auditReportFailureMessage'))
 }
 
 const genericError = (missingCliOption: string) => {
@@ -79,10 +64,6 @@ const proxyError = () => {
   generalError('proxyErrorHeader', 'proxyErrorMessage')
 }
 
-const hostWarningError = () => {
-  console.log(i18n.__('snapshotHostMessage'))
-}
-
 const failOptionError = () => {
   console.log(
     '\n ******************************** ' +
@@ -152,10 +133,12 @@ export {
   forbiddenError,
   proxyError,
   failOptionError,
-  hostWarningError,
   generalError,
   getErrorMessage,
   handleResponseErrors,
   libraryAnalysisError,
-  findCommandOnError
+  findCommandOnError,
+  snapshotFailureError,
+  vulnerabilitiesFailureError,
+  reportFailureError
 }

package/src/constants/constants.js

@@ -13,12 +13,18 @@ const MEDIUM = 'MEDIUM'
 const HIGH = 'HIGH'
 const CRITICAL = 'CRITICAL'
 const APP_NAME = 'contrast'
-const APP_VERSION = '1.0.4'
+const APP_VERSION = '1.0.5'
 const TIMEOUT = 120000
+const HIGH_COLOUR = '#ff9900'
+const CRITICAL_COLOUR = '#e35858'
+const MEDIUM_COLOUR = '#f1c232'
+const LOW_COLOUR = '#ff9900'
+const NOTE_COLOUR = '#999999'
 
 const AUTH_UI_URL = 'https://cli-auth.contrastsecurity.com'
 const AUTH_CALLBACK_URL = 'https://cli-auth-api.contrastsecurity.com'
 const SARIF_FILE = 'SARIF'
+const CE_URL = 'https://ce.contrastsecurity.com/'
 
 module.exports = {
   supportedLanguages: { NODE, DOTNET, JAVA, RUBY, PYTHON, GO, PHP, JAVASCRIPT },
@@ -31,5 +37,11 @@ module.exports = {
   TIMEOUT,
   AUTH_UI_URL,
   AUTH_CALLBACK_URL,
-  SARIF_FILE
+  SARIF_FILE,
+  HIGH_COLOUR,
+  CRITICAL_COLOUR,
+  MEDIUM_COLOUR,
+  LOW_COLOUR,
+  NOTE_COLOUR,
+  CE_URL
 }

package/src/constants/locales.js

@@ -5,46 +5,29 @@ const en_locales = () => {
   return {
     successHeader: 'SUCCESS',
     snapshotSuccessMessage:
-      ' Please go to the Contrast UI to view your dependency tree.',
+      'Please go to the Contrast UI to view your dependency tree.',
     snapshotFailureHeader: 'FAIL',
-    snapshotFailureMessage:
-      ' Unable to send library analysis to your Contrast UI.',
+    snapshotFailureMessage: 'Library analysis failed',
     snapshotHostMessage:
-      " No host supplied. Using default host 'app.contrastsecurity.com'. Please ensure this is correct.",
-    vulnerabilitiesSuccessMessage: ' Vulnerability data successfully retrieved',
-    vulnerabilitiesFailureMessage:
-      ' Unable to retrieve library vulnerabilities from Team Server.',
+      "No host supplied. Using default host 'app.contrastsecurity.com'. Please ensure this is correct.",
+    vulnerabilitiesSuccessMessage: 'Vulnerability data successfully retrieved',
+    vulnerabilitiesFailureMessage: 'Unable to retrieve library vulnerabilities',
     catchErrorMessage: 'Contrast UI error: ',
     dependenciesNote:
       'Please Note: We currently only support projects with one .csproj AND *.package.lock.json',
-    languageAnalysisFailureMessage: 'LANGUAGE ANALYSIS FAILED',
+    languageAnalysisFailureMessage: 'SCA Analysis Failure',
     languageAnalysisFactoryFailureHeader: 'FAIL',
-    projectPathParameter:
-      'Please set the %s to locate the source code for the project',
-    apiKeyParameter: 'Please set the %s to connect to the Contrast UI',
-    applicationNameParameter:
-      'Please provide a value for %s, to appear in the Contrast UI',
-    languageParameter:
-      'Please set the %s to the language of the source project. Allowable values are JAVA, DOTNET, NODE, PYTHON and RUBY.',
-    hostParameter:
-      'Please set the %s to the hostname and (optionally) the port expressed as <host>:<port> of the Contrast UI',
-    organizationIdParameter:
-      'Please set the %s to correctly identify your organization within the Contrast UI',
-    authorizationParameter:
-      'Please set the %s to your authorization header, found in the Contrast UI',
-    applicationIdParameter:
-      'Please set the %s to the value provided within the Contrast UI for the target application',
     libraryAnalysisError:
-      'Please ensure the language parameter is set in accordance to the language specified on the project path.\nThe Contrast-CLI must be run in the same directory as the project manifest file OR the project_path parameter must be used to identify the directory containing the project manifest file.\n\nFor further information please read our usage guide, which can be accessed with the following command:\n\ncontrast-cli --help',
+      'Please ensure the language parameter is set in accordance to the language specified on the project path.\nContrast CLI must be run in the same directory as the project manifest file OR the project_path parameter must be used to identify the directory containing the project manifest file.\n\nFor further information please read our usage guide, which can be accessed with the following command:\n\ncontrast-cli --help',
     yamlMissingParametersHeader: 'Missing Parameters',
     yamlMissingParametersMessage:
-      'The following parameters are required: \n \norganization_id \napi_key \nauthorization \nhost \napplication_name or application_id \nlanguage \n \nThey must be specified as a command line argument or within the yaml file. \nFor further information please read our usage guide, which can be accessed with the following command:\ncontrast-cli --help',
+      'The following parameters are required: \n \norganization-id \napi-key \nauthorization \nhost \nlanguage \n \nThey must be specified as a command line argument. \nFor further information please read our usage guide, which can be accessed with the following command:\ncontrast audit --help',
     unauthenticatedErrorHeader: '401 error - Unauthenticated',
     unauthenticatedErrorMessage:
-      'Please check the following keys are correct:\n--organization_id, --api_key or --authorization',
+      'Please check the following keys are correct:\n--organization-id, --api-key or --authorization',
     badRequestErrorHeader: '400 error - Bad Request',
     badRequestErrorMessage:
-      'Please check the following key is correct: \n--application_id',
+      'Please check the following key is correct: \n--application-id',
     badRequestCatalogueErrorMessage:
       'The application name already exists, please use a unique name',
     forbiddenRequestErrorHeader: '403 error - Forbidden',
@@ -53,15 +36,7 @@ const en_locales = () => {
     proxyErrorHeader: '407 error - Proxy Authentication Required',
     proxyErrorMessage:
       'Please provide valid authentication credentials for the proxy server.',
-    downgradeHttpsHttp:
-      'Connection to ContrastUI using https failed.  Attempting to connect using http...',
-    setSpecifiedParameter: 'Please set the %s ',
-    catalogueFailureCommand:
-      'Failed to catalogue a new application for reason: ',
-    catalogueFailureHostCommand:
-      'Failed to catalogue a new application, please ensure you have the correct host and authentication. Error: ',
-    catalogueSuccessCommand:
-      'This application ID can now be used to send dependency data to Contrast: ',
+    catalogueSuccessCommand: 'Application Created',
     dotnetAnalysisFailure: '.NET analysis failed because: ',
     dotnetReadLockfile: 'Failed to read the lock file @ %s because: ',
     dotnetParseLockfile: "Failed to parse .NET lock file @ '%s' because: ",
@@ -129,12 +104,10 @@ const en_locales = () => {
     constantsOptionalForCatalogue: '(optional for catalogue)',
     constantsRequired: '(required)',
     constantsRequiredCatalogue: '(required for catalogue)',
-    constantsYamlPath:
-      'If you want to read params from the yaml file then enter the path to the file',
     constantsApiKey: 'An agent API key as provided by Contrast UI',
     constantsAuthorization:
-      'An agent Authorization credentials as provided by Contrast UI',
-    constantsOrganizationId: 'The ID of your organization in Contrast UI',
+      'Authorization credentials as provided by Contrast UI',
+    constantsOrganizationId: 'The ID of your organization',
     constantsApplicationId:
       'The ID of the application cataloged by Contrast UI',
     constantsHostId:
@@ -253,17 +226,17 @@ const en_locales = () => {
     goAnalysisError: 'GO analysis failed because: ',
     goParseProjectFile: 'Failed to parse go mod graph output because: ',
     mavenNotInstalledError:
-      " 'mvn' is not available. Please ensure you have Maven installed and available on your path.",
+      "'mvn' is not available. Please ensure you have Maven installed and available on your path.",
     mavenDependencyTreeNonZero:
       'Building maven dependancy tree failed with a non 0 exit code',
     gradleWrapperUnavailable:
-      ' Gradle wrapper not found in root of project. Please ensure gradlew or gradlew.bat is in root of the project.',
+      'Gradle wrapper not found in root of project. Please ensure gradlew or gradlew.bat is in root of the project.',
     gradleDependencyTreeNonZero:
       "Building gradle dependancy tree failed with a non 0 exit code. \n Please check you have the correct version of Java installed to compile your project? \n If running against a muti module project ensure you are using the '--sub-project' flag",
     yamlPathCamelCaseError:
-      ' Warning: The "yamlPath" parameter will be deprecated in a future release. Please look at our documentation for further guidance.',
+      'Warning: The "yamlPath" parameter will be deprecated in a future release. Please look at our documentation for further guidance.',
     constantsSbom:
-      ' Generate the Software Bill of Materials (SBOM) for the given application',
+      'Generate the Software Bill of Materials (SBOM) for the given application',
     constantsMetadata:
       'Define a set of key=value pairs (which conforms to RFC 2253) for specifying user-defined metadata associated with the application.',
     constantsTags:
@@ -271,8 +244,8 @@ const en_locales = () => {
     constantsCode:
       'Add the application code this application should use in the Contrast UI',
     constantsIgnoreCertErrors:
-      ' For EOP users with a local Teamserver install, this will bypass the SSL certificate and recognise a self signed certificate.',
-    constantsSave: ' Saves the Scan Results SARIF to file.',
+      'For EOP users with a local Teamserver install, this will bypass the SSL certificate and recognise a self signed certificate.',
+    constantsSave: 'Saves the Scan Results SARIF to file.',
     scanLabel:
       "adds a label to the scan - defaults to 'Started by CLI tool at current date'",
     constantsIgnoreDev:
@@ -291,9 +264,10 @@ const en_locales = () => {
     responseMessage: 'Response: %s',
     searchingDirectoryScan: 'Searched 3 directory levels & found: ',
     noFileFoundScan:
-      "We could't find a suitable file in your directories (we go 3 deep)",
+      "We couldn't find a suitable file in your directories (we go 3 deep)",
     specifyFileScanError:
       'Java Scan requires a .war or .jar file. Javascript Scan requires a .js or .zip file.\nTo start a Scan enter "contrast scan -f <path-to-file>"',
+    specifyFileAuditNotFound: 'No files found for library analysis',
     populateProjectIdMessage: 'project ID is %s',
     genericServiceError: 'returned with status code %s',
     projectIdError: 'Your project ID is %s please check this is correct',
@@ -342,6 +316,8 @@ const en_locales = () => {
     requiredParams: 'All required parameters are not present.',
     timeoutScan: 'Timeout set to 5 minutes.',
     searchingScanFileDirectory: 'Searching for file to scan from %s...',
+    searchingAuditFileDirectory:
+      'Searching for package manager files from %s...',
     scanHeader: 'Contrast Scan CLI',
     authHeader: 'Auth',
     lambdaHeader: 'Contrast Lambda CLI',
@@ -417,7 +393,11 @@ const en_locales = () => {
     auditOptionsSave: '-s, --save',
     auditOptionsSaveDescription:
       'saves the output in specified format Txt text, sbom',
+    scanNotCompleted:
+      'Scan not completed. Check for framework and language support here: %s',
     scanNoVulnerabilitiesFound: '👏 No vulnerabilities found',
+    scanNoVulnerabilitiesFoundSecureCode: '👍 Your code looks secure.',
+    scanNoVulnerabilitiesFoundGoodWork: '👏 Keep up the good work.',
     scanNoFiletypeSpecifiedForSave:
       'Please specify file type to save results to, accepted value is SARIF',
     auditSBOMSaveSuccess:
@@ -430,8 +410,9 @@ const en_locales = () => {
     )}`,
     auditReportWaiting: 'Waiting for report...',
     auditReportFail: 'Report Retrieval Failed, please try again',
-    auditReportSuccessMessage: ' Report successfully retrieved',
-    auditReportFailureMessage: ' Unable to generate library report.',
+    auditReportSuccessMessage: 'Report successfully retrieved',
+    auditReportFailureMessage: 'Unable to generate library report',
+    auditSCAAnalysisBegins: 'Contrast SCA analysis begins',
     ...lambda
   }
 }

package/src/constants.js

@@ -47,6 +47,15 @@ const scanOptionDefinitions = [
       '}: ' +
       i18n.__('constantsProjectId')
   },
+  {
+    name: 'project-path',
+    alias: 'i',
+    description:
+      '{bold ' +
+      i18n.__('constantsOptional') +
+      '}: ' +
+      i18n.__('constantsProjectPath')
+  },
   {
     name: 'timeout',
     alias: 't',
@@ -146,6 +155,19 @@ const scanOptionDefinitions = [
     name: 'debug',
     alias: 'd',
     type: Boolean
+  },
+  {
+    name: 'experimental',
+    alias: 'e',
+    type: Boolean
+  },
+  {
+    name: 'application-name',
+    description:
+      '{bold ' +
+      i18n.__('constantsOptional') +
+      '}: ' +
+      i18n.__('constantsApplicationName')
   }
 ]
 

package/src/scaAnalysis/common/formatMessage.js

@@ -0,0 +1,10 @@
+const createJavaTSMessage = javaTree => {
+  return {
+    java: {
+      mavenDependencyTrees: javaTree
+    }
+  }
+}
+module.exports = {
+  createJavaTSMessage
+}

package/src/scaAnalysis/common/treeUpload.js

@@ -0,0 +1,34 @@
+const { getHttpClient } = require('../../utils/commonApi')
+const { handleResponseErrors } = require('../../common/errorHandling')
+const { APP_VERSION } = require('../../constants/constants')
+
+const commonSendSnapShot = async (analysis, config) => {
+  const requestBody = {
+    appID: config.applicationId,
+    cliVersion: APP_VERSION,
+    snapshot: analysis
+  }
+
+  //console.log(JSON.stringify(analysis))
+
+  //console.log(JSON.stringify(requestBody))
+  const client = getHttpClient(config)
+  return client
+    .sendSnapshot(requestBody, config)
+    .then(res => {
+      if (res.statusCode === 201) {
+        console.log('snapshot processed successfully')
+        return res.body
+      } else {
+        console.log(res.statusCode)
+        handleResponseErrors(res, 'snapshot')
+      }
+    })
+    .catch(err => {
+      console.log(err)
+    })
+}
+
+module.exports = {
+  commonSendSnapShot
+}