@contrast/contrast 1.0.10 → 1.0.13

package/dist/telemetry/telemetry.js

@@ -0,0 +1,137 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sha1Base64Value = exports.findParamValueFromArgs = exports.paramExists = exports.obfuscateParams = exports.sendTelemetryRequest = exports.sendTelemetryConfigAsObject = exports.sendTelemetryConfigAsConfObj = exports.TELEMETRY_CLI_TIME_TO_AUTH_EVENT = exports.TELEMETRY_CLI_COMMANDS_EVENT = void 0;
+const commonApi_1 = require("../utils/commonApi");
+const crypto = __importStar(require("crypto"));
+exports.TELEMETRY_CLI_COMMANDS_EVENT = 'CLI_COMMANDS';
+exports.TELEMETRY_CLI_TIME_TO_AUTH_EVENT = 'CLI_TIME_TO_AUTH';
+const sendTelemetryConfigAsConfObj = async (config, command, argv, result, language) => {
+    const hostParam = '--host';
+    const hostParamAlias = '-h';
+    const orgIdParam = '--organization-id';
+    const orgIdParamAlias = '-o';
+    const authParam = '--authorization';
+    const apiKeyParam = '--api-key';
+    let configToUse;
+    if ((0, exports.paramExists)(argv, hostParam, hostParamAlias) &&
+        (0, exports.paramExists)(argv, orgIdParam, orgIdParamAlias) &&
+        (0, exports.paramExists)(argv, authParam, null) &&
+        (0, exports.paramExists)(argv, apiKeyParam, null)) {
+        configToUse = {
+            host: (0, exports.findParamValueFromArgs)(argv, hostParam, hostParamAlias),
+            organizationId: (0, exports.findParamValueFromArgs)(argv, orgIdParam, orgIdParamAlias),
+            authorization: (0, exports.findParamValueFromArgs)(argv, authParam, null),
+            apiKey: (0, exports.findParamValueFromArgs)(argv, apiKeyParam, null)
+        };
+    }
+    else if (config &&
+        config.get('host') &&
+        config.get('organizationId') &&
+        config.get('authorization') &&
+        config.get('apiKey')) {
+        configToUse = {
+            host: config.get('host')?.slice(0, -1),
+            organizationId: config.get('organizationId'),
+            authorization: config.get('authorization'),
+            apiKey: config.get('apiKey')
+        };
+    }
+    else {
+        return;
+    }
+    return await (0, exports.sendTelemetryConfigAsObject)(configToUse, command, argv, result, language);
+};
+exports.sendTelemetryConfigAsConfObj = sendTelemetryConfigAsConfObj;
+const sendTelemetryConfigAsObject = async (config, command, argv, result, language) => {
+    const obfuscatedParams = (0, exports.obfuscateParams)(argv);
+    const requestBody = {
+        event: exports.TELEMETRY_CLI_COMMANDS_EVENT,
+        details: {
+            ip_address: '',
+            account_name: '',
+            account_host: '',
+            company_domain: '',
+            command: `contrast ${command} ${obfuscatedParams}`,
+            app_id: config && config.applicationId
+                ? (0, exports.sha1Base64Value)(config.applicationId)
+                : 'undefined',
+            project_id: config && config.projectId
+                ? (0, exports.sha1Base64Value)(config.projectId)
+                : 'undefined',
+            language: language,
+            result: result,
+            additional_info: '',
+            timestamp: new Date().toUTCString()
+        }
+    };
+    return await (0, exports.sendTelemetryRequest)(config, requestBody);
+};
+exports.sendTelemetryConfigAsObject = sendTelemetryConfigAsObject;
+const sendTelemetryRequest = async (config, requestBody) => {
+    const client = (0, commonApi_1.getHttpClient)(config);
+    return client
+        .postTelemetry(config, requestBody)
+        .then((res) => {
+        if (res.statusCode !== 200 && config.debug === true) {
+            console.log('Telemetry failed to send with status', res.statusCode);
+        }
+        return { statusCode: res.statusCode, statusMessage: res.statusMessage };
+    })
+        .catch((err) => {
+        return;
+    });
+};
+exports.sendTelemetryRequest = sendTelemetryRequest;
+const obfuscateParams = (argv) => {
+    return argv
+        .join(' ')
+        .replace(/--(authorization [A-Z0-9]+)/gi, '--authorization *****')
+        .replace(/-(o [A-Z0-9-]+)/gi, '-o *****')
+        .replace(/--(organization-id [A-Z0-9-]+)/gi, '--organization-id *****')
+        .replace(/--(api-key [A-Z0-9]+)/gi, '--api-key *****');
+};
+exports.obfuscateParams = obfuscateParams;
+const paramExists = (argv, param, paramAlias) => {
+    return argv.find((arg) => arg === param || arg === paramAlias);
+};
+exports.paramExists = paramExists;
+const findParamValueFromArgs = (argv, param, paramAlias) => {
+    let paramAsValue;
+    argv.forEach((arg, index) => {
+        if (arg === param ||
+            (arg === paramAlias &&
+                argv[index + 1] !== undefined &&
+                argv[index + 1] !== null)) {
+            paramAsValue = argv[index + 1];
+        }
+    });
+    return paramAsValue;
+};
+exports.findParamValueFromArgs = findParamValueFromArgs;
+const sha1Base64Value = (value) => {
+    return crypto.createHash('sha1').update(value).digest('base64');
+};
+exports.sha1Base64Value = sha1Base64Value;

package/dist/{audit/languageAnalysisEngine/util → utils}/generalAPI.js

@@ -1,12 +1,13 @@
 "use strict";
 const { featuresTeamServer } = require('./capabilities');
 const semver = require('semver');
-const { handleResponseErrors } = require('../../../common/errorHandling');
-const { getHttpClient } = require('../../../utils/commonApi');
+const { handleResponseErrors } = require('../common/errorHandling');
+const commonApi = require('./commonApi');
+const { isNil } = require('lodash');
 const getGlobalProperties = async (config) => {
-    const client = getHttpClient(config);
+    const client = commonApi.getHttpClient(config);
     return client
-        .getGlobalProperties(config)
+        .getGlobalProperties(config.host)
         .then(res => {
         if (res.statusCode === 200) {
             return res.body;
@@ -19,6 +20,13 @@ const getGlobalProperties = async (config) => {
         console.log(err);
     });
 };
+const getMode = async (config) => {
+    const features = await getGlobalProperties(config);
+    if (!isNil(features?.mode)) {
+        return features.mode;
+    }
+    return '';
+};
 const getFeatures = version => {
     const featuresEnabled = [];
     featuresTeamServer.forEach(feature => {
@@ -35,5 +43,6 @@ const isFeatureEnabled = (features, featureName) => {
 module.exports = {
     getGlobalProperties,
     getFeatures,
-    isFeatureEnabled
+    isFeatureEnabled,
+    getMode
 };

package/dist/utils/getConfig.js

@@ -5,16 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setConfigValues = exports.localConfig = void 0;
 const conf_1 = __importDefault(require("conf"));
+const constants_1 = require("../constants/constants");
 const localConfig = (name, version) => {
     const config = new conf_1.default({
         configName: name
     });
     config.set('version', version);
-    if (process.env.CONTRAST_CODSEC_DISABLE_UPDATE_MESSAGE) {
-        config.set('updateMessageHidden', JSON.parse(process.env.CONTRAST_CODSEC_DISABLE_UPDATE_MESSAGE.toLowerCase()));
-    }
     if (!config.has('host')) {
-        config.set('host', 'https://ce.contrastsecurity.com/');
+        config.set('host', constants_1.CE_URL);
     }
     return config;
 };

package/dist/utils/parsedCLIOptions.js

@@ -1,6 +1,7 @@
 "use strict";
 const commandLineArgs = require('command-line-args');
-const getCommandLineArgsCustom = (parameterList, optionDefinitions) => {
+const { sendTelemetryConfigAsConfObj } = require('../telemetry/telemetry');
+const getCommandLineArgsCustom = async (contrastConf, command, parameterList, optionDefinitions) => {
     try {
         return commandLineArgs(optionDefinitions, {
             argv: parameterList,
@@ -10,6 +11,7 @@ const getCommandLineArgsCustom = (parameterList, optionDefinitions) => {
         });
     }
     catch (e) {
+        await sendTelemetryConfigAsConfObj(contrastConf, command, parameterList, 'FAILURE', 'undefined');
         console.log(e.message.toString());
         process.exit(1);
     }

package/dist/utils/requestUtils.js

@@ -11,8 +11,14 @@ const millisToSeconds = millis => {
 const sleep = ms => {
     return new Promise(resolve => setTimeout(resolve, ms));
 };
+const timeOutError = (ms, reject) => {
+    return setTimeout(() => {
+        reject(new Error(`No input detected after 30s`));
+    }, ms);
+};
 module.exports = {
     sendRequest: sendRequest,
     sleep: sleep,
-    millisToSeconds: millisToSeconds
+    millisToSeconds: millisToSeconds,
+    timeOutError: timeOutError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/contrast",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "description": "Contrast Security's command line tool",
   "main": "dist/index.js",
   "bin": {
@@ -23,7 +23,9 @@
     "test": "jest --testPathIgnorePatterns=./test-integration/",
     "test-int": "jest ./test-integration/",
     "test-int-scan": "jest ./test-integration/scan",
-    "test-int-audit": "jest test-integration/audit/audit-int.spec.js",
+    "test-int-audit": "jest test-integration/audit",
+    "test-int-audit-reports": "jest test-integration/audit/audit-language-reports.spec.js",
+    "test-int-audit-features": "jest test-integration/audit/auditFeatures/",
     "format": "prettier --write \"**/*.{ts,tsx,js,json,md,yml}\" .eslintrc.*",
     "check-format": "prettier --check \"**/*.{ts,tsx,js,json,md,yml}\" .eslintrc.*",
     "coverage-local": "nyc --reporter=text mocha './test/**/*.spec.js'",

package/src/audit/{languageAnalysisEngine/report → report}/commonReportingFunctions.ts

@@ -1,4 +1,4 @@
-import { getHttpClient, handleResponseErrors } from '../../../utils/commonApi'
+import { getHttpClient, handleResponseErrors } from '../../utils/commonApi'
 import {
   ReportCompositeKey,
   ReportList,
@@ -22,15 +22,17 @@ import {
   ReportOutputModel
 } from './models/reportOutputModel'
 import {
+  CE_URL,
   CRITICAL_COLOUR,
   HIGH_COLOUR,
   LOW_COLOUR,
   MEDIUM_COLOUR,
   NOTE_COLOUR
-} from '../../../constants/constants'
+} from '../../constants/constants'
 import Table from 'cli-table3'
+import { ReportGuidanceModel } from './models/reportGuidanceModel'
 
-export const createSummaryMessage = (
+export const createSummaryMessageTop = (
   numberOfVulnerableLibraries: number,
   numberOfCves: number
 ) => {
@@ -41,6 +43,14 @@ export const createSummaryMessage = (
       )
 }
 
+export const createSummaryMessageBottom = (
+  numberOfVulnerableLibraries: number
+) => {
+  numberOfVulnerableLibraries === 1
+    ? console.log(`Found 1 vulnerable library`)
+    : console.log(`Found ${numberOfVulnerableLibraries} vulnerable libraries`)
+}
+
 export const getReport = async (config: any, reportId: string) => {
   const client = getHttpClient(config)
   return client
@@ -86,7 +96,7 @@ export const printFormattedOutput = (
   numberOfCves: number,
   guidance: any
 ) => {
-  createSummaryMessage(numberOfVulnerableLibraries, numberOfCves)
+  createSummaryMessageTop(numberOfVulnerableLibraries, numberOfCves)
   console.log()
   const report = new ReportList()
 
@@ -160,7 +170,11 @@ export const printFormattedOutput = (
       numOfCVEs
     )
 
-    const advice = gatherRemediationAdvice(guidance, reportModel)
+    const advice = gatherRemediationAdvice(
+      guidance,
+      libraryName,
+      libraryVersion
+    )
 
     const body = buildBody(reportModel.cveArray, advice)
 
@@ -168,7 +182,6 @@ export const printFormattedOutput = (
 
     table.push(
       reportOutputModel.body.issueMessage,
-      reportOutputModel.body.issueMessageCves,
       reportOutputModel.body.adviceMessage
     )
 
@@ -179,7 +192,7 @@ export const printFormattedOutput = (
     console.log(table.toString() + '\n')
   }
 
-  createSummaryMessage(numberOfVulnerableLibraries, numberOfCves)
+  createSummaryMessageBottom(numberOfVulnerableLibraries)
   const {
     criticalMessage,
     highMessage,
@@ -190,6 +203,15 @@ export const printFormattedOutput = (
   console.log(
     `${criticalMessage} | ${highMessage} | ${mediumMessage} | ${lowMessage} | ${noteMessage}`
   )
+
+  if (config.host !== CE_URL) {
+    console.log(
+      '\n' + chalk.bold('View your full dependency tree in Contrast:')
+    )
+    console.log(
+      `${config.host}/Contrast/static/ng/index.html#/${config.organizationId}/applications/${config.applicationId}/libs/dependency-tree`
+    )
+  }
 }
 
 export function buildHeader(
@@ -203,18 +225,22 @@ export function buildHeader(
     numOfCVEs > 1 ? 'vulnerabilities' : 'vulnerability'
   const formattedHeaderNum = buildFormattedHeaderNum(contrastHeaderNum)
 
-  const vulnMessage = chalk
-    .hex(highestSeverity.outputColour)
-    .bold(
-      `${formattedHeaderNum} - [${highestSeverity.severity}] ${libraryName}-${version}`
-    )
+  const headerColour = chalk.hex(highestSeverity.outputColour)
+  const headerNumAndSeverity = headerColour(
+    `${formattedHeaderNum} - [${highestSeverity.severity}]`
+  )
+  const libraryNameAndVersion = headerColour.bold(`${libraryName}-${version}`)
+  const vulnMessage = `${headerNumAndSeverity} ${libraryNameAndVersion}`
 
   const introducesMessage = `introduces ${numOfCVEs} ${vulnerabilityPluralised}`
 
   return new ReportOutputHeaderModel(vulnMessage, introducesMessage)
 }
 
-export function buildBody(cveArray: ReportCVEModel[], advice: any) {
+export function buildBody(
+  cveArray: ReportCVEModel[],
+  advice: ReportGuidanceModel
+) {
   const cveMessages: string[] = []
 
   findCVESeveritiesAndOrderByHighestPriority(cveArray).forEach(
@@ -233,46 +259,40 @@ export function buildBody(cveArray: ReportCVEModel[], advice: any) {
 
   const numAndSeverityType = getNumOfAndSeverityType(cveArray)
 
-  const issueMessage = [chalk.bold('Issue'), ':', `${numAndSeverityType}`]
-
-  const issueMessageCves = ['', '', cveMessages.join(', ')]
+  const issueMessage = [
+    chalk.bold('Issue'),
+    ':',
+    `${numAndSeverityType} ${cveMessages.join(', ')}`
+  ]
 
   //todo different advice based on remediationGuidance being available or now
   // console.log(advice)
 
-  const displayAdvice = advice?.minimum
-    ? `Update to version ${chalk.bold(advice.minimum)}`
-    : `Update to latest version`
+  const minOrMax = advice.maximum ? advice.maximum : advice.minimum
+  const displayAdvice = minOrMax
+    ? `Change to version ${chalk.bold(minOrMax)}`
+    : 'No recommendation is available according to our data. Upgrade to the latest stable is the best advice we can give.'
 
   const adviceMessage = [chalk.bold('Advice'), ':', displayAdvice]
 
-  return new ReportOutputBodyModel(
-    issueMessage,
-    issueMessageCves,
-    adviceMessage
-  )
+  return new ReportOutputBodyModel(issueMessage, adviceMessage)
 }
 
-export function gatherRemediationAdvice(guidance: any, reportModel: any) {
-  const guidanceData = {
-    minimum: undefined,
-    maximum: undefined,
-    latest: undefined
-  }
+export function gatherRemediationAdvice(
+  guidance: any,
+  libraryName: string,
+  libraryVersion: string
+) {
+  const guidanceModel = new ReportGuidanceModel()
 
-  const data =
-    guidance[
-      reportModel.compositeKey.libraryName +
-        '@' +
-        reportModel.compositeKey.libraryVersion
-    ]
+  const data = guidance[libraryName + '@' + libraryVersion]
 
   if (data) {
-    guidanceData.minimum = data.minUpgradeVersion
-    guidanceData.maximum = data.maxUpgradeVersion
+    guidanceModel.minimum = data.minUpgradeVersion
+    guidanceModel.maximum = data.maxUpgradeVersion
   }
 
-  return guidanceData
+  return guidanceModel
 }
 
 export function buildFormattedHeaderNum(contrastHeaderNum: number) {
@@ -285,11 +305,27 @@ export function getNumOfAndSeverityType(cveArray: ReportCVEModel[]) {
     new SeverityCountModel()
   )
 
-  const criticalMessage = critical > 0 ? `${critical} Critical` : ''
-  const highMessage = high > 0 ? `${high} High` : ''
-  const mediumMessage = medium > 0 ? `${medium} Medium` : ''
-  const lowMessage = low > 0 ? `${low} Low` : ''
-  const noteMessage = note > 0 ? `${note} Note` : ''
+  const criticalNumCheck = critical > 0
+
+  const highNumCheck = high > 0
+  const highDivider = highNumCheck ? '|' : ''
+
+  const mediumNumCheck = medium > 0
+  const mediumDivider = mediumNumCheck ? '|' : ''
+
+  const lowNumCheck = low > 0
+  const lowDivider = lowNumCheck ? '|' : ''
+
+  const noteNumCheck = low > 0
+  const noteDivider = noteNumCheck ? '|' : ''
+
+  const criticalMessage = criticalNumCheck
+    ? `${critical} Critical ${highDivider}`
+    : ''
+  const highMessage = highNumCheck ? `${high} High ${mediumDivider}` : ''
+  const mediumMessage = mediumNumCheck ? `${medium} Medium ${lowDivider}` : ''
+  const lowMessage = lowNumCheck ? `${low} Low ${noteDivider}` : ''
+  const noteMessage = noteNumCheck ? `${note} Note` : ''
 
   //removes/trims whitespace to single spaces
   return `${criticalMessage} ${highMessage} ${mediumMessage} ${lowMessage} ${noteMessage}`

package/src/audit/report/models/reportGuidanceModel.ts

@@ -0,0 +1,5 @@
+export class ReportGuidanceModel {
+  minimum?: string
+  maximum?: string
+  latest?: string
+}

package/src/audit/{languageAnalysisEngine/report → report}/models/reportOutputModel.ts

@@ -20,16 +20,10 @@ export class ReportOutputHeaderModel {
 
 export class ReportOutputBodyModel {
   issueMessage: string[]
-  issueMessageCves: string[]
   adviceMessage: string[]
 
-  constructor(
-    issueMessage: string[],
-    issueMessageCves: string[],
-    adviceMessage: string[]
-  ) {
+  constructor(issueMessage: string[], adviceMessage: string[]) {
     this.issueMessage = issueMessage
-    this.issueMessageCves = issueMessageCves
     this.adviceMessage = adviceMessage
   }
 }

package/src/audit/{languageAnalysisEngine/report → report}/models/severityCountModel.ts

@@ -4,6 +4,7 @@ export class SeverityCountModel {
   medium!: number
   low!: number
   note!: number
+  total!: number
 
   //needed as default to stop NaN when new object constructed
   constructor() {
@@ -12,6 +13,7 @@ export class SeverityCountModel {
     this.medium = 0
     this.low = 0
     this.note = 0
+    this.total = 0
   }
 
   get getTotal(): number {

package/src/audit/{languageAnalysisEngine/report → report}/reportingFeature.ts

@@ -8,7 +8,9 @@ import {
 } from './utils/reportUtils'
 import i18n from 'i18n'
 import chalk from 'chalk'
-import * as constants from '../../../constants/constants'
+import * as constants from '../../constants/constants'
+import { SeverityCountModel } from './models/severityCountModel'
+import * as common from '../../common/fail'
 
 export function convertKeysToStandardFormat(config: any, guidance: any) {
   let convertedGuidance = guidance
@@ -72,6 +74,7 @@ export function formatVulnerabilityOutput(
         String(0)
       )
     )
+    return [false, 0, [new SeverityCountModel()]]
   } else {
     let numberOfCves = 0
     vulnerableLibraries.forEach(lib => (numberOfCves += lib.cveArray.length))
@@ -83,12 +86,13 @@ export function formatVulnerabilityOutput(
       numberOfCves,
       guidance
     )
-
-    return [
-      hasSomeVulnerabilitiesReported,
-      numberOfCves,
-      severityCountAllLibraries(vulnerableLibraries)
-    ]
+    let severityCount = new SeverityCountModel()
+    severityCount = severityCountAllLibraries(
+      vulnerableLibraries,
+      severityCount
+    )
+    severityCount.total = severityCount.getTotal
+    return [hasSomeVulnerabilitiesReported, numberOfCves, severityCount]
   }
 }
 
@@ -97,8 +101,7 @@ export async function vulnerabilityReportV2(config: any, reportId: string) {
   const reportResponse = await getReport(config, reportId)
 
   if (reportResponse !== undefined) {
-    const name = config.applicationName
-    formatVulnerabilityOutput(
+    let output = formatVulnerabilityOutput(
       reportResponse.vulnerabilities,
       config.applicationId,
       config,
@@ -106,5 +109,9 @@ export async function vulnerabilityReportV2(config: any, reportId: string) {
         ? reportResponse.remediationGuidance
         : {}
     )
+
+    if (config.fail) {
+      common.processFail(config, output[2])
+    }
   }
 }

package/src/audit/{languageAnalysisEngine/report → report}/utils/reportUtils.ts

@@ -3,7 +3,7 @@ import {
   ReportLibraryModel
 } from '../models/reportLibraryModel'
 import { ReportSeverityModel } from '../models/reportSeverityModel'
-import languageAnalysisEngine from './../../../../constants/constants'
+import languageAnalysisEngine from '../../../constants/constants'
 import {
   CRITICAL_COLOUR,
   CRITICAL_PRIORITY,
@@ -15,7 +15,7 @@ import {
   MEDIUM_PRIORITY,
   NOTE_COLOUR,
   NOTE_PRIORITY
-} from '../../../../constants/constants'
+} from '../../../constants/constants'
 import { orderBy } from 'lodash'
 import { SeverityCountModel } from '../models/severityCountModel'
 import { ReportModelStructure } from '../models/reportListModel'
@@ -75,9 +75,9 @@ export function convertGenericToTypedLibraryVulns(libraries: any) {
 }
 
 export function severityCountAllLibraries(
-  vulnerableLibraries: ReportLibraryModel[]
+  vulnerableLibraries: ReportLibraryModel[],
+  severityCount: SeverityCountModel
 ) {
-  const severityCount = new SeverityCountModel()
   vulnerableLibraries.forEach(lib =>
     severityCountAllCVEs(lib.cveArray, severityCount)
   )

package/src/commands/audit/auditConfig.ts

@@ -1,9 +1,16 @@
 import paramHandler from '../../utils/paramsUtil/paramHandler'
 import constants from '../../constants'
-import cliOptions from '../../utils/parsedCLIOptions'
+import { getCommandLineArgsCustom } from '../../utils/parsedCLIOptions'
+import { ContrastConf } from '../../utils/getConfig'
 
-export const getAuditConfig = (argv: string[]): { [key: string]: string } => {
-  const auditParameters = cliOptions.getCommandLineArgsCustom(
+export const getAuditConfig = async (
+  contrastConf: ContrastConf,
+  command: string,
+  argv: string[]
+): Promise<{ [key: string]: string }> => {
+  const auditParameters = await getCommandLineArgsCustom(
+    contrastConf,
+    command,
     argv,
     constants.commandLineDefinitions.auditOptionDefinitions
   )

package/src/commands/audit/help.ts

@@ -1,6 +1,7 @@
 import commandLineUsage from 'command-line-usage'
 import i18n from 'i18n'
 import constants from '../../constants'
+import { commonHelpLinks } from '../../common/commonHelp'
 
 const auditUsageGuide = commandLineUsage([
   {
@@ -48,7 +49,8 @@ const auditUsageGuide = commandLineUsage([
       'app-groups',
       'metadata'
     ]
-  }
+  },
+  commonHelpLinks()
 ])
 
 export { auditUsageGuide }