@contrast/contrast 1.0.3 → 1.0.6

package/src/constants/constants.js

@@ -13,12 +13,23 @@ const MEDIUM = 'MEDIUM'
 const HIGH = 'HIGH'
 const CRITICAL = 'CRITICAL'
 const APP_NAME = 'contrast'
-const APP_VERSION = '1.0.3'
+const APP_VERSION = '1.0.6'
 const TIMEOUT = 120000
+const HIGH_COLOUR = '#ff9900'
+const CRITICAL_COLOUR = '#e35858'
+const MEDIUM_COLOUR = '#f1c232'
+const LOW_COLOUR = '#b7b7b7'
+const NOTE_COLOUR = '#999999'
+const CRITICAL_PRIORITY = 1
+const HIGH_PRIORITY = 2
+const MEDIUM_PRIORITY = 3
+const LOW_PRIORITY = 4
+const NOTE_PRIORITY = 5
 
 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 +42,16 @@ 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,
+  CRITICAL_PRIORITY,
+  HIGH_PRIORITY,
+  MEDIUM_PRIORITY,
+  LOW_PRIORITY,
+  NOTE_PRIORITY
 }

package/src/constants/lambda.js

@@ -36,11 +36,13 @@ const lambda = {
   loadingFunctionList: 'Loading lambda function list',
   functionsFound: '{{count}} functions found',
   noFunctionsFound: 'No functions found',
-  failedToLoadFunctions: 'Faled to load lambda functions',
+  failedToLoadFunctions: 'Failed to load lambda functions',
   availableForScan: '{{icon}} {{count}} available for scan',
   runtimeCount: '----- {{runtime}} ({{count}}) -----',
 
   // ====== print vulnerabilities ===== //
+  gatherResults: 'Gathering results...',
+  doneGatherResults: 'Done gathering results',
   whatHappenedTitle: 'What happened:',
   whatHappenedItem: '{{policy}} have:\n{{comments}}\n',
   recommendation: 'Recommendation:',

package/src/constants/locales.js

@@ -5,48 +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.',
-    reportSuccessMessage: ' Report successfully retrieved',
-    reportFailureMessage: ' Unable to generate library report.',
+      "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',
@@ -55,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: ",
@@ -131,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:
@@ -175,7 +146,7 @@ const en_locales = () => {
     constantsHeader: 'CodeSec by Contrast Security',
     constantsPrerequisitesContentScanLanguages: 'Java & JavaScript supported',
     constantsContrastContent:
-      'Use the Contrast CLI to run a scan(Java, JavaScript and .NET ) or lambda command (Java and Python) to find your vulnerabilities and start securing your code.',
+      'Use the Contrast CLI to run a scan (Java, JavaScript and .NET ) or lambda command (Java and Python) to find your vulnerabilities and start securing your code.',
     constantsUsageGuideContentRecommendation:
       'Our recommendation is that this is invoked as part of a CI pipeline so that running the cli is automated as part of your build process.',
     constantsPrerequisitesHeader: 'Pre-requisites',
@@ -255,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:
@@ -273,8 +244,10 @@ 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 JSON 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:
       'Combined with the --report command excludes developer dependencies from the vulnerabilities report. By default all dependencies are included in a report.',
     constantsCommands: 'Commands',
@@ -284,18 +257,20 @@ const en_locales = () => {
     ignoreDevDep: 'No private libraries that are not scoped detected',
     foundExistingProjectScan: 'Found existing project...',
     projectCreatedScan: 'Project created',
-    uploadingScan: 'Uploading...',
+    uploadingScan: 'Uploading file to scan.',
     uploadingScanSuccessful: 'Uploaded file successfully.',
     uploadingScanFail: 'Unable to upload the file.',
     waitingTimedOut: 'Timed out.',
     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',
     permissionsError:
       'You do not have the correct permissions here. \n Contact support@contrastsecurity.com to get this fixed.',
     scanErrorFileMessage:
@@ -341,16 +316,23 @@ 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 help',
+    lambdaHeader: 'Contrast Lambda CLI',
     lambdaSummary:
       'Performs static security scan on an AWS Lambda Function.\nProduces CVE (Vulnerable Dependencies) and Least Privilege violations/remediation results.',
     lambdaUsage: 'contrast lambda --function-name <function> [options]',
-    lambdaPrerequisitesContent: 'contrast cli',
-    scanFileNameOption: ' -f, --file',
-    lambdaFunctionNameOption: ' -f, --function-name',
-    lambdaListFunctionsOption: ' -l, --list-functions',
+    lambdaPrerequisitesContent: '',
+    lambdaPrerequisitesContentLambdaLanguages:
+      'Supported runtimes: Java & Python',
+    lambdaPrerequisitesContentLambdaDescriptionTitle: 'AWS Requirements\n',
+    lambdaPrerequisitesContentLambdaDescription:
+      'Make sure you have the AWS credentials configured on your local environment. \nYou need the following AWS permissions configured on your IAM user:\n   - Lambda: GetFunction, GetLayerVersionֿ\n   - IAM: GetRolePolicy, GetPolicy, GetPolicyVersion, ListRolePolicies, ListAttachedRolePolicies',
+    scanFileNameOption: '-f, --file',
+    lambdaFunctionNameOption: '-f, --function-name',
+    lambdaListFunctionsOption: '-l, --list-functions',
     lambdaEndpointOption: '-e, --endpoint-url',
     lambdaRegionOption: '-r, --region',
     lambdaProfileOption: '-p, --profile',
@@ -411,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:
@@ -422,6 +408,11 @@ const en_locales = () => {
     auditBadFiletypeSpecifiedForSave: `\n ${chalk.yellow.bold(
       'Bad file type specified for --save option. Use audit --help to see valid --save options.'
     )}`,
+    auditReportWaiting: 'Waiting for report...',
+    auditReportFail: 'Report Retrieval Failed, please try again',
+    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',
@@ -132,6 +141,11 @@ const scanOptionDefinitions = [
     description:
       '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('constantsSave')
   },
+  {
+    name: 'label',
+    description:
+      '{bold ' + i18n.__('constantsOptional') + '}:' + i18n.__('scanLabel')
+  },
   {
     name: 'help',
     alias: 'h',
@@ -141,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')
   }
 ]
 
@@ -331,7 +358,8 @@ const mainUsageGuide = commandLineUsage([
     ]
   },
   {
-    content: '{underline https://www.contrastsecurity.com}'
+    content:
+      '{underline https://developer.contrastsecurity.com/} \n For technical support head to {underline https://support.contrastsecurity.com}'
   }
 ])
 

package/src/index.ts

@@ -44,7 +44,7 @@ const start = async () => {
       argvMain.includes('--version')
     ) {
       console.log(APP_VERSION)
-      await findLatestCLIVersion()
+      await findLatestCLIVersion(config.get('updateMessageHidden') as boolean)
       return
     }
 
@@ -53,8 +53,7 @@ const start = async () => {
 
     // @ts-ignore
     if (config.get('numOfRuns') >= 5) {
-      // @ts-ignore
-      await findLatestCLIVersion()
+      await findLatestCLIVersion(config.get('updateMessageHidden') as boolean)
       config.set('numOfRuns', 0)
     }
 

package/src/lambda/help.ts

@@ -8,7 +8,15 @@ const lambdaUsageGuide = commandLineUsage([
   },
   {
     header: i18n.__('constantsPrerequisitesHeader'),
-    content: [i18n.__('lambdaPrerequisitesContent')]
+    content: [
+      '{bold ' +
+        i18n.__('lambdaPrerequisitesContentLambdaLanguages') +
+        '}\n\n' +
+        '{bold ' +
+        i18n.__('lambdaPrerequisitesContentLambdaDescriptionTitle') +
+        '}' +
+        i18n.__('lambdaPrerequisitesContentLambdaDescription')
+    ]
   },
   {
     header: i18n.__('constantsUsage'),
@@ -18,49 +26,49 @@ const lambdaUsageGuide = commandLineUsage([
     header: i18n.__('constantsOptions'),
     content: [
       {
-        name: i18n.__('lambdaFunctionNameOption'),
+        name: '{bold ' + i18n.__('lambdaFunctionNameOption') + '}',
         summary: i18n.__('lambdaFunctionNameSummery')
       },
       {
-        name: i18n.__('lambdaListFunctionsOption'),
+        name: '{bold ' + i18n.__('lambdaListFunctionsOption') + '}',
         summary: i18n.__('lambdaListFunctionsSummery')
       },
       {
-        name: i18n.__('lambdaEndpointOption'),
+        name: '{bold ' + i18n.__('lambdaEndpointOption') + '}',
         summary:
-          '{italic ' +
+          '{bold ' +
           i18n.__('constantsOptional') +
           '}: ' +
           i18n.__('lambdaEndpointSummery')
       },
       {
-        name: i18n.__('lambdaRegionOption'),
+        name: '{bold ' + i18n.__('lambdaRegionOption') + '}',
         summary:
-          '{italic ' +
+          '{bold ' +
           i18n.__('constantsOptional') +
           '}: ' +
           i18n.__('lambdaRegionSummery')
       },
       {
-        name: i18n.__('lambdaProfileOption'),
+        name: '{bold ' + i18n.__('lambdaProfileOption') + '}',
         summary:
-          '{italic ' +
+          '{bold ' +
           i18n.__('constantsOptional') +
           '}: ' +
           i18n.__('lambdaProfileSummery')
       },
       {
-        name: i18n.__('lambdaJsonOption'),
+        name: '{bold ' + i18n.__('lambdaJsonOption') + '}',
         summary:
-          '{italic ' +
+          '{bold ' +
           i18n.__('constantsOptional') +
           '}: ' +
           i18n.__('lambdaJsonSummery')
       },
       {
-        name: i18n.__('lambdaVerboseOption'),
+        name: '{bold ' + i18n.__('lambdaVerboseOption') + '}',
         summary:
-          '{italic ' +
+          '{bold ' +
           i18n.__('constantsOptional') +
           '}: ' +
           i18n.__('lambdaVerbosSummery')
@@ -73,7 +81,7 @@ const lambdaUsageGuide = commandLineUsage([
     ]
   },
   {
-    content: '{underline https://www.contrastsecurity.com}'
+    content: '{underline https://www.contrastsecurity.com/developer/codesec}'
   }
 ])
 

package/src/lambda/lambda.ts

@@ -12,6 +12,8 @@ import { requestScanFunctionPost } from './scanRequest'
 import { getScanResults } from './scanResults'
 import { printResults } from './utils'
 import { getAllLambdas, printAvailableLambdas } from './lambdaUtils'
+import { sleep } from '../utils/requestUtils'
+import ora from '../utils/oraWrapper'
 
 type LambdaOptions = {
   functionName?: string
@@ -123,6 +125,12 @@ const actualProcessLambda = async (lambdaOptions: LambdaOptions) => {
     })
   }
 
+  // Wait to make sure we will have all the results
+  const startGetherResultsSpinner = ora.returnOra(i18n.__('gatherResults'))
+  ora.startSpinner(startGetherResultsSpinner)
+  await sleep(15 * 1000)
+  ora.succeedSpinner(startGetherResultsSpinner, 'Done gathering results')
+
   const resultsResponse = await getScanResults(
     auth,
     params,

package/src/scaAnalysis/common/formatMessage.js

@@ -0,0 +1,20 @@
+const createJavaTSMessage = javaTree => {
+  return {
+    java: {
+      mavenDependencyTrees: javaTree
+    }
+  }
+}
+
+const createGoTSMessage = goTree => {
+  return {
+    go: {
+      goDependencyTrees: goTree
+    }
+  }
+}
+
+module.exports = {
+  createJavaTSMessage,
+  createGoTSMessage
+}

package/src/scaAnalysis/common/treeUpload.js

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

package/src/scaAnalysis/go/goAnalysis.js

@@ -0,0 +1,20 @@
+const { createGoTSMessage } = require('../common/formatMessage')
+const goReadDepFile = require('./goReadDepFile')
+const goParseDeps = require('./goParseDeps')
+
+const goAnalysis = (config, languageFiles) => {
+  try {
+    const rawGoDependencies = goReadDepFile.getGoDependencies(config)
+    const parsedGoDependencies = goParseDeps.parseGoDependencies(
+      rawGoDependencies
+    )
+
+    return createGoTSMessage(parsedGoDependencies)
+  } catch (e) {
+    console.log(e.message.toString())
+  }
+}
+
+module.exports = {
+  goAnalysis
+}