@contrast/contrast 1.0.7 → 1.0.10

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

@@ -1,24 +1,49 @@
 const autoDetection = require('../../../scan/autoDetection')
 const javaAnalysis = require('../../../scaAnalysis/java')
 const treeUpload = require('../../../scaAnalysis/common/treeUpload')
-const {
-  manualDetectAuditFilesAndLanguages
-} = require('../../../scan/autoDetection')
 const auditController = require('../../audit/auditController')
 const {
-  supportedLanguages: { JAVA, GO, RUBY, PYTHON }
-} = require('../../../audit/languageAnalysisEngine/constants')
+  supportedLanguages: { JAVA, GO, PYTHON, RUBY, JAVASCRIPT, NODE, PHP, DOTNET }
+} = require('../../../constants/constants')
 const goAnalysis = require('../../../scaAnalysis/go/goAnalysis')
+const phpAnalysis = require('../../../scaAnalysis/php/index')
 const { rubyAnalysis } = require('../../../scaAnalysis/ruby')
 const { pythonAnalysis } = require('../../../scaAnalysis/python')
-
+const javascriptAnalysis = require('../../../scaAnalysis/javascript')
+const {
+  pollForSnapshotCompletition
+} = require('../../../audit/languageAnalysisEngine/sendSnapshot')
+const {
+  returnOra,
+  startSpinner,
+  succeedSpinner
+} = require('../../../utils/oraWrapper')
+const i18n = require('i18n')
+const {
+  vulnerabilityReportV2
+} = require('../../../audit/languageAnalysisEngine/report/reportingFeature')
+const auditSave = require('../../../audit/save')
+const { dotNetAnalysis } = require('../../../scaAnalysis/dotnet')
+const rootFile = require('../../../audit/languageAnalysisEngine/getProjectRootFilenames')
+const path = require('path')
 const processSca = async config => {
+  const startTime = performance.now()
   let filesFound
-  if (config.projectPath) {
-    filesFound = manualDetectAuditFilesAndLanguages(config.projectPath)
-  } else {
-    filesFound = await autoDetection.autoDetectAuditFilesAndLanguages(config)
-    config.projectPath = process.cwd()
+
+  const projectStats = await rootFile.getProjectStats(config.file)
+  let pathWithFile = projectStats.isFile()
+
+  let fileName = config.file
+  config.file = pathWithFile
+    ? rootFile.getDirectoryFromPathGiven(config.file).concat('/')
+    : config.file
+
+  filesFound = await autoDetection.autoDetectAuditFilesAndLanguages(config.file)
+
+  if (filesFound.length > 1 && pathWithFile) {
+    filesFound = filesFound.filter(i =>
+      Object.values(i)[0].includes(path.basename(fileName))
+    )
   }
 
   // files found looks like [ { javascript: [ Array ] } ]
@@ -31,48 +56,78 @@ const processSca = async config => {
         messageToSend = javaAnalysis.javaAnalysis(config, filesFound[0])
         config.language = JAVA
         break
-      // case 'javascript':
-      //     // code block
-      //     break;
-      // case 'dotnet':
-      //     // code block
-      //     break;
-      case RUBY:
-        messageToSend = rubyAnalysis(config, filesFound[0])
-        config.language = RUBY
+      case JAVASCRIPT:
+        messageToSend = await javascriptAnalysis.jsAnalysis(
+          config,
+          filesFound[0]
+        )
+        config.language = NODE
         break
       case PYTHON:
         messageToSend = pythonAnalysis(config, filesFound[0])
         config.language = PYTHON
         break
-      // case 'ruby':
-      //     // code block
-      //     break;
-      // case 'php':
-      //     // code block
-      //     break;
+      case RUBY:
+        messageToSend = rubyAnalysis(config, filesFound[0])
+        config.language = RUBY
+        break
+      case 'PHP':
+        messageToSend = phpAnalysis.phpAnalysis(config, filesFound[0])
+        config.language = PHP
+        break
       case GO:
         messageToSend = goAnalysis.goAnalysis(config, filesFound[0])
         config.language = GO
         break
+      case DOTNET:
+        messageToSend = dotNetAnalysis(config, filesFound[0])
+        config.language = DOTNET
+        break
       default:
         //something is wrong
-        console.log('language detected not supported')
+        console.log('No supported language detected in project path')
         return
     }
 
     if (!config.applicationId) {
       config.applicationId = await auditController.dealWithNoAppId(config)
     }
+
+    console.log('') //empty log for space before spinner
     //send message to TS
-    console.log('processing dependencies')
-    const response = await treeUpload.commonSendSnapShot(messageToSend, config)
+    const reportSpinner = returnOra(i18n.__('auditSCAAnalysisBegins'))
+    startSpinner(reportSpinner)
+    const snapshotResponse = await treeUpload.commonSendSnapShot(
+      messageToSend,
+      config
+    )
+
+    //poll for completion
+    await pollForSnapshotCompletition(
+      config,
+      snapshotResponse.id,
+      reportSpinner
+    )
+    succeedSpinner(reportSpinner, i18n.__('auditSCAAnalysisComplete'))
+
+    await vulnerabilityReportV2(config, snapshotResponse.id)
+    if (config.save !== undefined) {
+      await auditSave.auditSave(config)
+    }
+    const endTime = performance.now() - startTime
+    const scanDurationMs = endTime - startTime
+
+    console.log(
+      `----- completed in ${(scanDurationMs / 1000).toFixed(2)}s -----`
+    )
   } else {
     if (filesFound.length === 0) {
-      console.log('no compatible dependency files detected. Continuing...')
+      console.log(i18n.__('languageAnalysisNoLanguage'))
+      console.log(i18n.__('languageAnalysisNoLanguageHelpLine'))
+      throw new Error()
     } else {
-      console.log(
-        'multiple language files detected, please use --project-path to specify a directory or the file where dependencies are declared'
+      throw new Error(
+        'multiple language files detected, please use --file to specify a directory or the file where dependencies are declared'
       )
     }
   }

package/src/common/HTTPClient.js

@@ -333,9 +333,16 @@ HTTPClient.prototype.checkLibrary = function checkLibrary(data) {
   return requestUtils.sendRequest({ method: 'post', options })
 }
 
-HTTPClient.prototype.getSbom = function getSbom(config) {
+HTTPClient.prototype.getSbom = function getSbom(config, type) {
   const options = _.cloneDeep(this.requestOptions)
-  options.url = createSbomCycloneDXUrl(config)
+  options.url = createSbomUrl(config, type)
+  return requestUtils.sendRequest({ method: 'get', options })
+}
+
+HTTPClient.prototype.getLatestVersion = function getLatestVersion() {
+  const options = _.cloneDeep(this.requestOptions)
+  options.url =
+    'https://pkg.contrastsecurity.com/artifactory/cli/latest-version.txt'
   return requestUtils.sendRequest({ method: 'get', options })
 }
 
@@ -410,13 +417,13 @@ function createLibraryVulnerabilitiesUrl(config) {
   return `${config.host}/Contrast/api/ng/${config.organizationId}/libraries/artifactsByGroupNameVersion`
 }
 
-function createSpecificReportUrl(config, reportId) {
-  return `${config.host}/Contrast/api/ng/sca/organizations/${config.organizationId}/applications/${config.applicationId}/reports/${reportId}`
+function createSpecificReportUrl(config, reportId, includeTree = false) {
+  return `${config.host}/Contrast/api/ng/sca/organizations/${config.organizationId}/applications/${config.applicationId}/reports/${reportId}?&includeTree=${includeTree}`
 }
 
-function createSpecificReportWithProdUrl(config, reportId) {
-  return createSpecificReportUrl(config, reportId).concat(
-    `?nodesToInclude=PROD`
+function createSpecificReportWithProdUrl(config, reportId, includeTree) {
+  return createSpecificReportUrl(config, reportId, includeTree).concat(
+    `&nodesToInclude=PROD`
   )
 }
 
@@ -428,8 +435,8 @@ function createDataUrl() {
   return `https://ardy.contrastsecurity.com/production`
 }
 
-function createSbomCycloneDXUrl(config) {
-  return `${config.host}/Contrast/api/ng/${config.organizationId}/applications/${config.applicationId}/libraries/sbom/cyclonedx`
+function createSbomUrl(config, type) {
+  return `${config.host}/Contrast/api/ng/${config.organizationId}/applications/${config.applicationId}/libraries/sbom/${type}`
 }
 
 module.exports = HTTPClient

package/src/common/errorHandling.ts

@@ -39,9 +39,8 @@ const reportFailureError = () => {
 }
 
 const genericError = (missingCliOption: string) => {
-  // prettier-ignore
-  console.log(`*************************** ${i18n.__('yamlMissingParametersHeader')} ***************************\n${missingCliOption}`)
-  console.error(i18n.__('yamlMissingParametersMessage'))
+  console.log(missingCliOption)
+  console.error(i18n.__('genericErrorMessage'))
   process.exit(1)
 }
 

package/src/common/versionChecker.ts

@@ -1,12 +1,31 @@
-import latestVersion from 'latest-version'
 import { APP_VERSION } from '../constants/constants'
 import boxen from 'boxen'
 import chalk from 'chalk'
 import semver from 'semver'
+import commonApi from '../utils/commonApi'
+import { constants } from 'http2'
+import { ContrastConf } from '../utils/getConfig'
 
-export async function findLatestCLIVersion(updateMessageHidden: boolean) {
-  if (!updateMessageHidden) {
-    const latestCLIVersion = await latestVersion('@contrast/contrast')
+const getLatestVersion = async (config: any) => {
+  const client = commonApi.getHttpClient(config)
+  try {
+    const res = await client.getLatestVersion()
+    if (res.statusCode === constants.HTTP_STATUS_OK) {
+      return res.body
+    }
+  } catch (e) {
+    return
+  }
+}
+
+// @ts-ignore
+export async function findLatestCLIVersion(config: ContrastConf) {
+  const messageHidden = config.get('updateMessageHidden') as boolean
+
+  if (!messageHidden) {
+    let latestCLIVersion: string = await getLatestVersion(config)
+    //strip key
+    latestCLIVersion = latestCLIVersion.substring(8)
 
     if (semver.lt(APP_VERSION, latestCLIVersion)) {
       const updateAvailableMessage = `Update available ${chalk.yellow(

package/src/constants/constants.js

@@ -5,15 +5,16 @@ const JAVA = 'JAVA'
 const RUBY = 'RUBY'
 const PYTHON = 'PYTHON'
 const GO = 'GO'
-// we set the langauge as Node instead of PHP since we're using the Node engine in TS
 const PHP = 'PHP'
 const JAVASCRIPT = 'JAVASCRIPT'
+// Severity
 const LOW = 'LOW'
 const MEDIUM = 'MEDIUM'
 const HIGH = 'HIGH'
 const CRITICAL = 'CRITICAL'
+// App
 const APP_NAME = 'contrast'
-const APP_VERSION = '1.0.7'
+const APP_VERSION = '1.0.10'
 const TIMEOUT = 120000
 const HIGH_COLOUR = '#ff9900'
 const CRITICAL_COLOUR = '#e35858'
@@ -29,10 +30,13 @@ 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 SBOM_CYCLONE_DX_FILE = 'cyclonedx'
+const SBOM_SPDX_FILE = 'spdx'
 const CE_URL = 'https://ce.contrastsecurity.com/'
 
 module.exports = {
   supportedLanguages: { NODE, DOTNET, JAVA, RUBY, PYTHON, GO, PHP, JAVASCRIPT },
+  supportedLanguagesScan: { JAVASCRIPT, DOTNET, JAVA },
   LOW,
   MEDIUM,
   HIGH,
@@ -53,5 +57,7 @@ module.exports = {
   HIGH_PRIORITY,
   MEDIUM_PRIORITY,
   LOW_PRIORITY,
-  NOTE_PRIORITY
+  NOTE_PRIORITY,
+  SBOM_CYCLONE_DX_FILE,
+  SBOM_SPDX_FILE
 }

package/src/constants/locales.js

@@ -15,13 +15,13 @@ const en_locales = () => {
     catchErrorMessage: 'Contrast UI error: ',
     dependenciesNote:
       'Please Note: We currently only support projects with one .csproj AND *.package.lock.json',
-    languageAnalysisFailureMessage: 'SCA Analysis Failure',
+    languageAnalysisFailureMessage: 'SCA audit Failure',
     languageAnalysisFactoryFailureHeader: 'FAIL',
     libraryAnalysisError:
       '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 \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',
+    genericErrorMessage:
+      'An error has occur please check your command again. For more information use the --help commands.',
     unauthenticatedErrorHeader: '401 error - Unauthenticated',
     unauthenticatedErrorMessage:
       'Please check the following keys are correct:\n--organization-id, --api-key or --authorization',
@@ -53,8 +53,10 @@ const en_locales = () => {
       "Identified project language as '%s' but found multiple project files: %s. Please specify which project file you would like analyzed with the %s CLI option.",
     languageAnalysisHasNoLockFile:
       "Identified project language as '%s' but no project lock file was found.",
+    languageAnalysisHasNoPackageJsonFile:
+      'Identified project language as javascript but no package.json file was found.',
     languageAnalysisHasMultipleLockFiles:
-      "Identified project language as '%s' but multiple project lock files were found: %s \n",
+      "Identified project language as '%s' but multiple project lock files were found.",
     languageAnalysisProjectFileError:
       "Identified project language as '%s' but no project file was found.",
     languageAnalysisProjectRootFileNameReadError:
@@ -64,17 +66,20 @@ const en_locales = () => {
     languageAnalysisProjectRootFileNameFailure:
       'Failed to get information about the file or directory @ %s because: ',
     languageAnalysisFailure: ' analysis failed because: ',
-    languageAnalysisNoLanguage: 'No language detected in project path @ %s',
+    languageAnalysisNoLanguage:
+      'We cannot detect a project, use -f <path> to specify a file or folder to analyze.',
+    languageAnalysisNoLanguageHelpLine: `${chalk.bold(
+      'contrast audit --help'
+    )} for more information.`,
     NodeAnalysisFailure: 'NODE analysis failed because: ',
     phpAnalysisFailure: 'PHP analysis failed because: ',
-    NodeParseNPM:
-      "Failed to parse NODE package-lock.json file @ '%s' because: ",
+    NodeParseNPM: 'Failed to parse NODE package-lock.json file because: ',
     phpParseComposerLock:
       "Failed to parse PHP composer.lock file @ '%s' because: ",
     NodeReadNpmError:
       'Failed to read the package-lock.json file @ "%s" because: ',
     phpReadError: 'Failed to read the composer.lock file @ "%s" because: ',
-    NodeParseYarn: "Failed to parse Node yarn.lock version 1 @ '%s' because: ",
+    NodeParseYarn: 'Failed to parse yarn.lock version %s because: ',
     NodeParseYarn2: "Failed to parse Node yarn.lock version 2 @ '%s' because: ",
     nodeReadProjectFileError:
       'Failed to read the NODE project file @ "%s" because: ',
@@ -118,8 +123,7 @@ const en_locales = () => {
       'Provide this if you want to catalogue an application',
     constantsLanguage:
       'Valid values are JAVA, DOTNET, NODE, PYTHON and RUBY. If there are multiple project configuration files in the project_path, language is also required.  Also, provide this when cataloguing an application',
-    constantsProjectPath:
-      'The directory root of a project/application that you would like analyzed. Defaults to current directory.',
+    constantsFilePath: `Path of the file you want to perform an SCA audit on. If no folder is specified, Contrast searches for dependency files in the working directory.`,
     constantsSilent: 'Silences JSON output.',
     constantsAppGroups:
       'Assign your application to one or more pre-existing groups when using the catalogue command. Group lists should be comma separated.',
@@ -137,16 +141,22 @@ const en_locales = () => {
       'The ID associated with a scan project. Replace <ProjectID> with the ID for the scan project. To find the ID, select a scan project in Contrast and locate the last number in the URL.',
     constantsReport: 'Display vulnerability information for this application',
     constantsFail:
-      'Set the process to fail if this option is set in combination with the --report and --cve_severity.',
+      'Set the process to fail if this option is set in combination with --cve_severity.',
     failOptionErrorMessage:
-      " FAIL - CVE's have been detected that match at least the cve_severity or cve_threshold option specified.",
+      ' FAIL - CVEs have been detected that match at least the cve_severity or cve_threshold option specified.',
     constantsSeverity:
-      'Combined with the --report command, allows the user to report libraries with vulnerabilities above a chosen severity level. For example, cve_severity medium only reports libraries with vulnerabilities at medium or higher severity. Values for level are high, medium or low.',
-    constantsCount: "The number of CVE's that must be exceeded to fail a build",
+      'Allows the user to report libraries with vulnerabilities above a chosen severity level. For example, cve_severity medium only reports libraries with vulnerabilities at medium or higher severity. Values for level are high, medium or low.',
+    constantsCount: 'The number of CVEs that must be exceeded to fail a build',
     constantsHeader: 'CodeSec by Contrast Security',
-    constantsPrerequisitesContentScanLanguages: 'Java & JavaScript supported',
+    configHeader2: 'Config options',
+    clearHeader: '-c, --clear',
+    clearContent: 'Removes stored credentials',
+    constantsPrerequisitesContentScanLanguages:
+      'Java, Javascript and .NET supported',
     constantsContrastContent:
-      "Use the 'contrast' command for fast and accurate security analysis of your applications and APIs (Java, JavaScript and .NET ) as well as serverless functions (AWS lambda, Java and Python).",
+      'Use the ‘contrast’ command for fast and accurate security analysis of your applications, APIs, serverless functions, and libraries.',
+    constantsContrastCategories:
+      '\n Code: Java, .NET, .NET Core, JavaScript\n Serverless: AWS Lambda - Java, Python\n Libraries: Java, .NET, Node, Ruby, Python, Go, PHP\n',
     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',
@@ -249,7 +259,7 @@ const en_locales = () => {
     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.',
+      'Excludes developer dependencies from the results. All dependencies are included by default.',
     constantsCommands: 'Commands',
     constantsScanOptions: 'Scan Options',
     sbomError: 'All required parameters are not present.',
@@ -277,12 +287,17 @@ const en_locales = () => {
       'We only accept the following file types: \nJava - .jar, .war \nJavaScript - .js or .zip files',
     helpAuthSummary:
       'Authenticate Contrast using your Github or Google account',
-    helpScanSummary: 'Perform static analysis on binaries / code artifacts',
-    helpLambdaSummary: 'Perform scan on AWS Lambda functions',
+    helpAuditSummary:
+      'Searches for a suitable file in the working directory to perform a security audit of dependencies and returns the results. [Contrast audit --help (for options).]',
+    helpScanSummary:
+      'Searches for a .jar, .war, .js, or .zip file in the working directory, uploads files for analysis, and returns the results. [For further help/options, enter scan --help]',
+    helpLambdaSummary:
+      'Performs a static security scan on an AWS lambda function. lambda --help (for options)',
     helpVersionSummary: 'Displays version of Contrast CLI',
     helpConfigSummary: 'Displays stored credentials',
     helpSummary: 'Displays usage guide',
     authName: 'auth',
+    auditName: 'audit',
     scanName: 'scan',
     lambdaName: 'lambda',
     versionName: 'version',
@@ -300,8 +315,7 @@ const en_locales = () => {
     scanOptionsVerboseSummary: ' Returns extended information to the terminal.',
     authSuccessMessage: 'Authentication successful',
     runAuthSuccessMessage:
-      "Now you can use Contrast CLI \nRun 'contrast scan' on your file \n" +
-      "or 'contrast help' to learn more about the capabilities.",
+      "Now you can use CodeSec by Contrast \nRun: \n'contrast scan' on your file \n'contrast audit' on a file or directory,\n'contrast lambda' on an AWS function.\nor 'contrast help' to learn more about the capabilities.",
     authWaitingMessage: 'Waiting for auth...',
     authTimedOutMessage: 'Auth Timed out, try again',
     zipErrorScan:
@@ -329,7 +343,7 @@ const en_locales = () => {
       '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',
+      '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, ListFunctions\n   - IAM: GetRolePolicy, GetPolicy, GetPolicyVersion, ListRolePolicies, ListAttachedRolePolicies',
     scanFileNameOption: '-f, --file',
     lambdaFunctionNameOption: '-f, --function-name',
     lambdaListFunctionsOption: '-l, --list-functions',
@@ -364,42 +378,49 @@ const en_locales = () => {
       'An error has occurred when trying to get the Project Id please check your internet connection or provide the Project Id manually',
     internalServerErrorHeader: '500 error - Internal server error',
     resourceLockedErrorHeader: '423 error - Resource is locked',
-    auditHeader: 'Contrast Audit',
-    auditHeaderMessage: `
-    Performs software composition analysis (SCA) on your application/code time to show you the dependencies between open source libraries, including where vulnerabilities were introduced.\n
-    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.`,
+    auditHeader: 'Contrast audit help',
+    auditHeaderMessage:
+      "Use 'contrast audit' to analyze a project’s dependencies for vulnerabilities.",
     constantsAuditPrerequisitesContentSupportedLanguages:
       'Supported languages and their requirements are:',
-    constantsAuditPrerequisitesContentJava: 'Java: ',
-    constantsAuditPrerequisitesContentMessage: `
-       pom.xml AND Maven build platform, including the dependency plugin. 
-       For a Gradle project (v4.8+) use build.gradle. A gradle-wrapper.properties file is also required.
-       Kotlin is also supported requiring a build.gradle.kts file.`,
-    constantsAuditPrerequisitesContentDotNet: '.NET framework and .NET core: ',
+    constantsAuditPrerequisitesJavaContentMessage: `
+    ${chalk.bold('Java:')} pom.xml ${chalk.bold(
+      'and'
+    )} Maven build platform including the dependency plugin. 
+    ${chalk.bold('Or')} build.gradle ${chalk.bold(
+      'and'
+    )} gradle dependencies or ./gradlew dependencies must be supported`,
     constantsAuditPrerequisitesContentDotNetMessage: `
-       MSBuild 15.0 or greater and have a packages.lock.json file are supported.\n
-       Note: If the packages.lock.json file is unavailable it can be generated by setting RestorePackagesWithLockFile to true within each *.csproj file and running dotnet build.\n`,
-    constantsAuditPrerequisitesContentLanguageNode: 'Node: ',
-    constantsAuditPrerequisitesContentLanguageRuby: 'Ruby: ',
-    constantsAuditPrerequisitesContentLanguagePython: 'Python: ',
-    constantsAuditPrerequisitesContentLanguageNodeMessage:
-      '*.package.json AND a lock file either *.package-lock.json or *.yarn.lock',
-    constantsAuditPrerequisitesContentLanguageRubyMessage:
-      'gemfile AND gemfile.lock',
-    constantsAuditPrerequisitesContentLanguagePythonMessage:
-      'pipfile AND pipfile.lock',
+    ${chalk.bold(
+      '.NET framework and .NET core:'
+    )} MSBuild 15.0 or greater and a packages.lock.json file.
+    Note: If the packages.lock.json file is unavailable it can be generated by setting RestorePackagesWithLockFile to true within each *.csproj file and running dotnet build.\n`,
+    constantsAuditPrerequisitesContentNodeMessage: `${chalk.bold(
+      'Node:'
+    )} package.json and a lock file (either .package-lock.json or .yarn.lock.)\n`,
+    constantsAuditPrerequisitesContentRubyMessage: `${chalk.bold(
+      'Ruby:'
+    )} gemfile and gemfile.lock\n`,
+    constantsAuditPrerequisitesContentPythonMessage: `${chalk.bold(
+      'Python:'
+    )} pipfile and pipfile.lock\n`,
+    constantsAuditPrerequisitesContentGoMessage: `${chalk.bold(
+      'Go:'
+    )} go.mod\n`,
+    constantsAuditPrerequisitesContentPHPMessage: `${chalk.bold(
+      'PHP:'
+    )} composer.json and composer.lock\n`,
     constantsAuditOptions: 'Audit Options',
-    auditOptionsIgnoreDevDependencies: '-igd, --ignore-dev',
-    auditOptionsIgnoreDevDependenciesDescription: 'ignores DevDependencies',
-    auditOptionsSave: '-s, --save',
     auditOptionsSaveDescription:
-      'saves the output in specified format Txt text, sbom',
+      'Generate and save an SBOM (Software Bill of Materials)\n',
+    auditOptionsSaveOptionsDescription:
+      'Valid options are: spdx, cyclonedx (cycloneDX is the default format)',
     scanNotCompleted:
       'Scan not completed. Check for framework and language support here: %s',
     auditNotCompleted: 'audit not completed.  Please try again',
-    scanNoVulnerabilitiesFound: '👏 No vulnerabilities found',
+    scanNoVulnerabilitiesFound: '🎉 No vulnerabilities found.',
     scanNoVulnerabilitiesFoundSecureCode: '👍 Your code looks secure.',
-    scanNoVulnerabilitiesFoundGoodWork: '👏 Keep up the good work.',
+    scanNoVulnerabilitiesFoundGoodWork: '   Keep up the good work.',
     scanNoFiletypeSpecifiedForSave:
       'Please specify file type to save results to, accepted value is SARIF',
     auditSBOMSaveSuccess:
@@ -414,7 +435,8 @@ const en_locales = () => {
     auditReportFail: 'Report Retrieval Failed, please try again',
     auditReportSuccessMessage: 'Report successfully retrieved',
     auditReportFailureMessage: 'Unable to generate library report',
-    auditSCAAnalysisBegins: 'Contrast SCA analysis begins',
+    auditSCAAnalysisBegins: 'Contrast SCA audit started',
+    auditSCAAnalysisComplete: 'Contrast audit complete',
     ...lambda
   }
 }

package/src/constants.js

@@ -49,7 +49,6 @@ const scanOptionDefinitions = [
   },
   {
     name: 'project-path',
-    alias: 'i',
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
@@ -212,13 +211,14 @@ const auditOptionDefinitions = [
       i18n.__('constantsApplicationName')
   },
   {
-    name: 'project-path',
-    defaultValue: process.env.PWD,
+    name: 'file',
+    alias: 'f',
+    defaultValue: process.cwd().concat('/'),
     description:
       '{bold ' +
       i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('constantsProjectPath')
+      i18n.__('constantsFilePath')
   },
   {
     name: 'app-groups',
@@ -266,15 +266,6 @@ const auditOptionDefinitions = [
   {
     name: 'maven-settings-path'
   },
-  {
-    name: 'language',
-    alias: 'l',
-    description:
-      '{bold ' +
-      i18n.__('constantsRequiredCatalogue') +
-      '}: ' +
-      i18n.__('constantsLanguage')
-  },
   {
     name: 'organization-id',
     alias: 'o',
@@ -333,14 +324,33 @@ const auditOptionDefinitions = [
       '{bold ' +
       i18n.__('constantsOptional') +
       '}: ' +
-      i18n.__('auditOptionsSaveDescription')
+      i18n.__('auditOptionsSaveDescription') +
+      i18n.__('auditOptionsSaveOptionsDescription')
+  },
+  {
+    name: 'experimental',
+    alias: 'e',
+    type: Boolean
+  },
+  {
+    name: 'timeout',
+    alias: 't',
+    type: Number,
+    description:
+      '{bold ' +
+      i18n.__('constantsOptional') +
+      '}: ' +
+      i18n.__('scanOptionsTimeoutSummary')
   }
 ]
 
 const mainUsageGuide = commandLineUsage([
   {
     header: i18n.__('constantsHeader'),
-    content: [i18n.__('constantsContrastContent')]
+    content: [
+      i18n.__('constantsContrastContent'),
+      i18n.__('constantsContrastCategories')
+    ]
   },
   {
     header: i18n.__('constantsUsage'),
@@ -352,6 +362,7 @@ const mainUsageGuide = commandLineUsage([
       { name: i18n.__('authName'), summary: i18n.__('helpAuthSummary') },
       { name: i18n.__('scanName'), summary: i18n.__('helpScanSummary') },
       { name: i18n.__('lambdaName'), summary: i18n.__('helpLambdaSummary') },
+      { name: i18n.__('auditName'), summary: i18n.__('helpAuditSummary') },
       { name: i18n.__('versionName'), summary: i18n.__('helpVersionSummary') },
       { name: i18n.__('configName'), summary: i18n.__('helpConfigSummary') },
       { name: i18n.__('helpName'), summary: i18n.__('helpSummary') }
@@ -360,6 +371,12 @@ const mainUsageGuide = commandLineUsage([
   {
     content:
       '{underline https://developer.contrastsecurity.com/} \n For technical support head to {underline https://support.contrastsecurity.com}'
+  },
+  {
+    header: i18n.__('configHeader2'),
+    content: [
+      { name: i18n.__('clearHeader'), summary: i18n.__('clearContent') }
+    ]
   }
 ])