@contrast/contrast 3.1.0 → 3.2.0

package/dist/constants/constants.js

@@ -17,7 +17,7 @@ export const HIGH = 'HIGH';
 export const CRITICAL = 'CRITICAL';
 // App
 export const APP_NAME = 'contrast';
-const APP_VERSION = '3.1.0';
+const APP_VERSION = '3.2.0';
 export const TIMEOUT = 120000;
 export const CRITICAL_PRIORITY = 1;
 export const HIGH_PRIORITY = 2;

package/dist/scaAnalysis/java/analysis.js

@@ -74,6 +74,9 @@ export const calculateMavenCommand = projectData => {
     else {
         projectData.mvnCommand = 'mvn';
     }
+    if (projectData.mvnCommand.includes('//')) {
+        projectData.mvnCommand = projectData.mvnCommand.replace(/\/+/g, '/');
+    }
 };
 export function checkForErrors(cmdDepTree, config) {
     checkMavenExists(cmdDepTree, config);

package/dist/scan/processScan.js

@@ -1,30 +1,39 @@
 import scanConfig from './scanConfig.js';
-import { startScan } from './scanController.js';
+import { startScan, startScanWithResults } from './scanController.js';
 import { saveScanFile } from '../utils/saveFile.js';
 import { ScanResultsModel } from './models/scanResultsModel.js';
 import { formatScanOutput } from './formatScanOutput.js';
 import { sendTelemetryConfigAsObject } from '../telemetry/telemetry.js';
 import { processFail } from '../common/fail.js';
 import { postRunMessage } from '../common/commonHelp.js';
-import { logInfo } from '../common/logging.js';
+import { logDebug, logInfo } from '../common/logging.js';
 import { validateHost } from '../utils/validationCheck.js';
 export const processScan = async (contrastConf, argv) => {
     let config = await scanConfig.getScanConfig(contrastConf, 'scan', argv);
     validateHost(config);
-    let output = undefined;
-    const scanResults = new ScanResultsModel(await startScan(config));
-    await sendTelemetryConfigAsObject(config, 'scan', argv, 'SUCCESS', scanResults.scanDetail.language);
-    if (scanResults.scanResultsInstances !== undefined) {
-        output = formatScanOutput(scanResults);
-    }
-    if (config.save !== undefined) {
-        await saveScanFile(config, scanResults);
+    let scanResults;
+    if (config.ff) {
+        logDebug(config, 'Is fire and forget request');
+        await startScan(config);
     }
     else {
-        logInfo('\nUse contrast scan --save to save results as a SARIF');
+        scanResults = new ScanResultsModel(await startScanWithResults(config));
     }
-    if (config.fail) {
-        processFail(config, output);
+    await sendTelemetryConfigAsObject(config, 'scan', argv, 'SUCCESS', config.ff ? 'UNKNOWN' : scanResults.scanDetail.language);
+    if (!config.ff) {
+        let output;
+        if (scanResults.scanResultsInstances !== undefined) {
+            output = formatScanOutput(scanResults);
+        }
+        if (config.save !== undefined) {
+            await saveScanFile(config, scanResults);
+        }
+        else {
+            logInfo('\nUse contrast scan --save to save results as a SARIF');
+        }
+        if (config.fail) {
+            processFail(config, output);
+        }
     }
     postRunMessage('scan');
 };

package/dist/scan/scan.js

@@ -13,7 +13,7 @@ export const isFileAllowed = (scanOption) => {
     });
     return valid;
 };
-export const sendScan = async (config) => {
+export const uploadArtifact = async (config) => {
     if (!isFileAllowed(config.file)) {
         const message = i18n.__('scanErrorFileMessage');
         logDebug(config, message);

package/dist/scan/scanController.js

@@ -1,12 +1,12 @@
 import i18n from 'i18n';
 import { populateProjectId } from './populateProjectIdAndProjectName.js';
-import { sendScan } from './scan.js';
+import { uploadArtifact } from './scan.js';
 import { performance } from 'perf_hooks';
 import { fileExists, fileIsEmpty } from './fileUtils.js';
 import { returnOra, startSpinner, stopSpinner, succeedSpinner } from '../utils/oraWrapper.js';
 import { returnScanResults } from './scanResults.js';
 import { autoDetectFileAndLanguage } from '../common/autoDetection.js';
-import { getScanResultsInstances } from './scanRequests.js';
+import { submitScanForArtifact, getScanResultsInstances } from './scanRequests.js';
 import { logDebug, logInfo } from '../common/logging.js';
 const getTimeout = config => {
     if (config.timeout) {
@@ -40,7 +40,6 @@ export const fileAndLanguageLogic = async (configToUse) => {
     }
 };
 export const startScan = async (configToUse) => {
-    const startTime = performance.now();
     await fileAndLanguageLogic(configToUse);
     let newProject;
     if (!configToUse.projectId) {
@@ -51,28 +50,33 @@ export const startScan = async (configToUse) => {
     else {
         newProject = false;
     }
-    const codeArtifactId = await sendScan(configToUse);
-    if (!configToUse.ff) {
-        const startScanSpinner = returnOra('🚀 Contrast Scan started');
-        startSpinner(startScanSpinner);
-        const scanDetail = await returnScanResults(configToUse, codeArtifactId, newProject, getTimeout(configToUse), startScanSpinner);
-        const scanResultsInstances = await getScanResultsInstances(configToUse, scanDetail.id);
-        const endTime = performance.now();
-        const scanDurationMs = endTime - startTime;
-        if (scanResultsInstances.statusCode !== 200) {
-            stopSpinner(startScanSpinner);
-            const message = 'Result Service is unavailable, please try again later';
-            logInfo(message);
-            logDebug(configToUse, message);
-            process.exit(1);
-        }
-        else {
-            succeedSpinner(startScanSpinner, 'Contrast Scan complete');
-            logInfo(`----- Scan completed in ${(scanDurationMs / 1000).toFixed(2)}s -----`);
-            return {
-                scanDetail,
-                scanResultsInstances: scanResultsInstances.body
-            };
-        }
+    const codeArtifactId = await uploadArtifact(configToUse);
+    const scanId = await submitScanForArtifact(configToUse, codeArtifactId);
+    logDebug(configToUse, `For proj: ${configToUse.projectId}, is new: ${newProject}, new scanId submitted: ${scanId}`);
+    return { newProject, scanId };
+};
+export const startScanWithResults = async (configToUse) => {
+    const startTime = performance.now();
+    const { newProject, scanId } = await startScan(configToUse);
+    const startScanSpinner = returnOra('🚀 Contrast Scan started');
+    startSpinner(startScanSpinner);
+    const scanDetail = await returnScanResults(configToUse, scanId, newProject, getTimeout(configToUse), startScanSpinner);
+    const scanResultsInstances = await getScanResultsInstances(configToUse, scanDetail.id);
+    const endTime = performance.now();
+    const scanDurationMs = endTime - startTime;
+    if (scanResultsInstances.statusCode !== 200) {
+        stopSpinner(startScanSpinner);
+        const message = 'Result Service is unavailable, please try again later';
+        logInfo(message);
+        logDebug(configToUse, message);
+        process.exit(1);
+    }
+    else {
+        succeedSpinner(startScanSpinner, 'Contrast Scan complete');
+        logInfo(`----- Scan completed in ${(scanDurationMs / 1000).toFixed(2)}s -----`);
+        return {
+            scanDetail,
+            scanResultsInstances: scanResultsInstances.body
+        };
     }
 };

package/dist/scan/scanRequests.js

@@ -2,6 +2,7 @@ import { buildBaseRequestOptions, ErrorType } from '../common/baseRequest.js';
 import { got } from 'got';
 import fs from 'fs';
 import FormData from 'form-data';
+import { logDebug } from '../common/logging.js';
 export function createProjectId(config) {
     const options = buildBaseRequestOptions(config, ErrorType.SCAN);
     options.json = {
@@ -38,17 +39,18 @@ export async function sendArtifact(config) {
 function createHarmonyUrl(config) {
     return `${config.host}/Contrast/api/sast/v1/organizations/${config.organizationId}/projects/${config.projectId}/code-artifacts`;
 }
-export function getScanId(config, codeArtifactId) {
+export const submitScanForArtifact = async (config, codeArtifactId) => {
     const options = buildBaseRequestOptions(config, ErrorType.SCAN);
     options.url = createGetScanIdURL(config);
     options.json = {
         codeArtifactId: codeArtifactId,
-        label: config.label
-            ? config.label
-            : `Started by CLI tool at ${new Date().toString()}`
+        label: config.label ?? `Started by CLI tool at ${new Date().toString()}`
     };
-    return got.post(options);
-}
+    logDebug(config, `Kicked off scan for project ${config.projectId} and codeArtifact: ${codeArtifactId}`);
+    const post = (await got.post(options));
+    const body = post.body;
+    return body.id;
+};
 const createGetScanIdURL = (config) => {
     return `${config.host}/Contrast/api/sast/v1/organizations/${config.organizationId}/projects/${config.projectId}/scans/`;
 };

package/dist/scan/scanResults.js

@@ -2,15 +2,13 @@ import { sleep, millisToSeconds, timeOutError } from '../utils/requestUtils.js';
 import i18n from 'i18n';
 import readline from 'readline';
 import { failSpinner, stopSpinner } from '../utils/oraWrapper.js';
-import { createNewEvent, getScanId, getSpecificScanResult } from './scanRequests.js';
+import { createNewEvent, getSpecificScanResult } from './scanRequests.js';
 import { logDebug, logInfo } from '../common/logging.js';
 export const pollScanResults = async (config, scanId) => {
     await sleep(5000);
     return getSpecificScanResult(config, scanId);
 };
-export const returnScanResults = async (config, codeArtifactId, newProject, timeout, startScanSpinner) => {
-    const scanIdRes = await getScanId(config, codeArtifactId);
-    const scanId = scanIdRes.body.id;
+export const returnScanResults = async (config, scanId, newProject, timeout, startScanSpinner) => {
     // send metrics event to sast-event-collector
     if (process.env.CODESEC_INVOCATION_ENVIRONMENT &&
         process.env.CODESEC_INVOCATION_ENVIRONMENT.toUpperCase() === 'GITHUB') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/contrast",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Contrast Security's command line tool",
   "exports": "./dist/index.js",
   "type": "module",