@contrast/contrast 1.0.18 → 1.0.19

package/dist/cliConstants.js

@@ -185,6 +185,7 @@ const scanOptionDefinitions = [
     }
 ];
 const authOptionDefinitions = [
+    ...sharedConnectionOptionDefinitions,
     {
         name: 'help',
         alias: 'h',

package/dist/commands/auth/auth.js

@@ -1,21 +1,31 @@
 "use strict";
 const { v4: uuidv4 } = require('uuid');
-const { setConfigValues } = require('../../utils/getConfig');
-const open = require('open');
+const configFunctions = require('../../utils/getConfig');
 const commonApi = require('../../utils/commonApi');
-const { sleep } = require('../../utils/requestUtils');
+const requestUtils = require('../../utils/requestUtils');
 const i18n = require('i18n');
 const { returnOra, startSpinner, failSpinner, succeedSpinner } = require('../../utils/oraWrapper');
 const { TIMEOUT, AUTH_UI_URL } = require('../../constants/constants');
 const parsedCLIOptions = require('../../utils/parsedCLIOptions');
 const constants = require('../../cliConstants');
 const commandLineUsage = require('command-line-usage');
+const { commonMessageFormatter } = require('../../common/errorHandling');
+const open = require('open');
+const messages = require('../../constants/locales').en_locales();
 const processAuth = async (argv, config) => {
     let authParams = await parsedCLIOptions.getCommandLineArgsCustom(config, 'auth', argv, constants.commandLineDefinitions.authOptionDefinitions);
     if (authParams.help) {
         console.log(authUsageGuide);
         process.exit(0);
     }
+    if (checkForCustomCredentials(authParams)) {
+        processCustomCredentials(authParams, config);
+    }
+    else {
+        await startAuthProcess(config);
+    }
+};
+const startAuthProcess = async (config) => {
     const token = uuidv4();
     const url = `${AUTH_UI_URL}/?token=${token}`;
     console.log(i18n.__('redirectAuth', url));
@@ -25,9 +35,8 @@ const processAuth = async (argv, config) => {
         }, 0);
         const result = await isAuthComplete(token, TIMEOUT, config);
         if (result) {
-            setConfigValues(config, result);
+            configFunctions.setConfigValues(config, result);
         }
-        return;
     }
     finally {
     }
@@ -54,7 +63,7 @@ const isAuthComplete = async (token, timeout, config) => {
     }
 };
 const pollAuthResult = async (token, client) => {
-    await sleep(5000);
+    await requestUtils.sleep(5000);
     return client
         .pollForAuth(token)
         .then(res => {
@@ -74,6 +83,33 @@ const authUsageGuide = commandLineUsage([
         content: [i18n.__('constantsAuthUsageContents')]
     }
 ]);
+const checkForCustomCredentials = authParams => {
+    const hasSomeKeys = authParams.apiKey ||
+        authParams.organizationId ||
+        authParams.host ||
+        authParams.authorization;
+    const hasAllKeys = authParams.apiKey &&
+        authParams.organizationId &&
+        authParams.host &&
+        authParams.authorization;
+    if (hasAllKeys) {
+        return true;
+    }
+    if (hasSomeKeys) {
+        commonMessageFormatter(messages.authCommand.credentialsMissing, true);
+    }
+    return false;
+};
+const processCustomCredentials = (authParams, config) => {
+    const valuesToSet = {
+        apiKey: authParams.apiKey,
+        orgId: authParams.organizationId,
+        authHeader: authParams.authorization,
+        host: authParams.host
+    };
+    configFunctions.setConfigValues(config, valuesToSet);
+    commonMessageFormatter(messages.authCommand.credentialsAccepted, false);
+};
 module.exports = {
-    processAuth: processAuth
+    processAuth
 };

package/dist/common/HTTPClient.js

@@ -332,18 +332,18 @@ function createSnapshotURL(config) {
     return `${config.host}/Contrast/api/ng/sca/organizations/${config.organizationId}/applications/${config.applicationId}/snapshots`;
 }
 function createScaServiceReportURL(config, reportId) {
-    let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/applications/${config.applicationId}/reports/${reportId}`;
+    let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/reports/${reportId}`;
     baseUrl = config.ignoreDev ? baseUrl.concat('?nodesToInclude=PROD') : baseUrl;
     return baseUrl;
 }
 function createScaServiceReportStatusURL(config, reportId) {
-    return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests/${reportId}/status`;
+    return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests/${reportId}/status`;
 }
 function createScaServiceIngestsURL(config) {
-    return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests`;
+    return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests`;
 }
 function createScaServiceIngestURL(config) {
-    let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests/tree`;
+    let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests/tree`;
     baseUrl = config.track ? baseUrl.concat('?persist=true') : baseUrl;
     return baseUrl;
 }

package/dist/common/errorHandling.js

@@ -1,5 +1,6 @@
 "use strict";
 const i18n = require('i18n');
+const chalk = require('chalk');
 const libraryAnalysisError = () => {
     console.log(i18n.__('libraryAnalysisError'));
 };
@@ -79,6 +80,16 @@ const findCommandOnError = unknownOptions => {
         return foundCommands[0];
     }
 };
+const commonMessageFormatter = (message, fail) => {
+    console.log(chalk.bold(i18n.__(message.title)));
+    console.log(i18n.__(message.body));
+    if (message.extra) {
+        console.log(i18n.__(message.extra));
+    }
+    if (fail) {
+        process.exit(1);
+    }
+};
 module.exports = {
     genericError,
     unauthenticatedError,
@@ -95,5 +106,6 @@ module.exports = {
     reportFailureError,
     maxAppError,
     parametersError,
-    invalidHostNameError
+    invalidHostNameError,
+    commonMessageFormatter
 };

package/dist/constants/constants.js

@@ -12,7 +12,7 @@ const MEDIUM = 'MEDIUM';
 const HIGH = 'HIGH';
 const CRITICAL = 'CRITICAL';
 const APP_NAME = 'contrast';
-const APP_VERSION = '1.0.18';
+const APP_VERSION = '1.0.19';
 const TIMEOUT = 120000;
 const HIGH_COLOUR = '#ff9900';
 const CRITICAL_COLOUR = '#e35858';

package/dist/constants/locales.js

@@ -216,6 +216,18 @@ const en_locales = () => {
         commonHelpLearnMoreEnterpriseText: ' https://docs.contrastsecurity.com/en/run-contrast-cli.html ',
         commonHelpJoinDiscussionHeader: chalk.hex('#9DC184')('Join the discussion:'),
         commonHelpJoinDiscussionText: ' https://dev.to/codesec',
+        authCommand: {
+            credentialsAccepted: {
+                title: 'Credentials accepted',
+                body: 'Now run contrast audit, lambda or scan',
+                extra: 'Or contrast help for full list of commands'
+            },
+            credentialsMissing: {
+                title: 'Credentials missing',
+                body: 'You have not entered the right parameters or enough information',
+                extra: 'Please check and try again e.g. contrast auth --api-key yourApiKey--organization-id yourOrg --authorization yourAuth --host https://yourHost\nOr contrast help for full list of commands'
+            }
+        },
         ...lambda
     };
 };

package/dist/utils/getConfig.js

@@ -21,6 +21,6 @@ const setConfigValues = (config, values) => {
     config.set('apiKey', values.apiKey);
     config.set('organizationId', values.orgId);
     config.set('authorization', values.authHeader);
-    values.host ? config.set('host', values.host) : null;
+    values.host ? config.set('host', values.host) : config.set('host', constants_1.CE_URL);
 };
 exports.setConfigValues = setConfigValues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/contrast",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "description": "Contrast Security's command line tool",
   "main": "dist/index.js",
   "bin": {

package/src/cliConstants.js

@@ -211,6 +211,7 @@ const scanOptionDefinitions = [
 ]
 
 const authOptionDefinitions = [
+  ...sharedConnectionOptionDefinitions,
   {
     name: 'help',
     alias: 'h',

package/src/commands/auth/auth.js

@@ -1,8 +1,7 @@
 const { v4: uuidv4 } = require('uuid')
-const { setConfigValues } = require('../../utils/getConfig')
-const open = require('open')
+const configFunctions = require('../../utils/getConfig')
 const commonApi = require('../../utils/commonApi')
-const { sleep } = require('../../utils/requestUtils')
+const requestUtils = require('../../utils/requestUtils')
 const i18n = require('i18n')
 const {
   returnOra,
@@ -14,6 +13,9 @@ const { TIMEOUT, AUTH_UI_URL } = require('../../constants/constants')
 const parsedCLIOptions = require('../../utils/parsedCLIOptions')
 const constants = require('../../cliConstants')
 const commandLineUsage = require('command-line-usage')
+const { commonMessageFormatter } = require('../../common/errorHandling')
+const open = require('open')
+const messages = require('../../constants/locales').en_locales()
 
 const processAuth = async (argv, config) => {
   let authParams = await parsedCLIOptions.getCommandLineArgsCustom(
@@ -28,6 +30,15 @@ const processAuth = async (argv, config) => {
     process.exit(0)
   }
 
+  //check if user has entered enterprise credentials
+  if (checkForCustomCredentials(authParams)) {
+    processCustomCredentials(authParams, config)
+  } else {
+    await startAuthProcess(config)
+  }
+}
+
+const startAuthProcess = async config => {
   const token = uuidv4()
   const url = `${AUTH_UI_URL}/?token=${token}`
 
@@ -41,9 +52,8 @@ const processAuth = async (argv, config) => {
 
     const result = await isAuthComplete(token, TIMEOUT, config)
     if (result) {
-      setConfigValues(config, result)
+      configFunctions.setConfigValues(config, result)
     }
-    return
   } finally {
     //spinner stop
   }
@@ -72,7 +82,7 @@ const isAuthComplete = async (token, timeout, config) => {
 }
 
 const pollAuthResult = async (token, client) => {
-  await sleep(5000)
+  await requestUtils.sleep(5000)
   return client
     .pollForAuth(token)
     .then(res => {
@@ -94,6 +104,38 @@ const authUsageGuide = commandLineUsage([
   }
 ])
 
+const checkForCustomCredentials = authParams => {
+  const hasSomeKeys =
+    authParams.apiKey ||
+    authParams.organizationId ||
+    authParams.host ||
+    authParams.authorization
+  const hasAllKeys =
+    authParams.apiKey &&
+    authParams.organizationId &&
+    authParams.host &&
+    authParams.authorization
+
+  if (hasAllKeys) {
+    return true
+  }
+  if (hasSomeKeys) {
+    commonMessageFormatter(messages.authCommand.credentialsMissing, true)
+  }
+  return false
+}
+
+const processCustomCredentials = (authParams, config) => {
+  const valuesToSet = {
+    apiKey: authParams.apiKey,
+    orgId: authParams.organizationId,
+    authHeader: authParams.authorization,
+    host: authParams.host
+  }
+  configFunctions.setConfigValues(config, valuesToSet)
+  commonMessageFormatter(messages.authCommand.credentialsAccepted, false)
+}
+
 module.exports = {
-  processAuth: processAuth
+  processAuth
 }

package/src/common/HTTPClient.js

@@ -226,6 +226,7 @@ HTTPClient.prototype.scaServiceIngest = function scaServiceIngest(
   options.body = requestBody
   return requestUtils.sendRequest({ method: 'post', options })
 }
+
 HTTPClient.prototype.scaServiceReport = function scaServiceReport(
   config,
   reportId
@@ -460,21 +461,21 @@ function createSnapshotURL(config) {
 }
 
 function createScaServiceReportURL(config, reportId) {
-  let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/applications/${config.applicationId}/reports/${reportId}`
+  let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/reports/${reportId}`
   baseUrl = config.ignoreDev ? baseUrl.concat('?nodesToInclude=PROD') : baseUrl
   return baseUrl
 }
 
 function createScaServiceReportStatusURL(config, reportId) {
-  return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests/${reportId}/status`
+  return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests/${reportId}/status`
 }
 
 function createScaServiceIngestsURL(config) {
-  return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests`
+  return `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests`
 }
 
 function createScaServiceIngestURL(config) {
-  let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/libraries/ingests/tree`
+  let baseUrl = `${config.host}/Contrast/api/sca/organizations/${config.organizationId}/applications/${config.applicationId}/libraries/ingests/tree`
   baseUrl = config.track ? baseUrl.concat('?persist=true') : baseUrl
   return baseUrl
 }

package/src/common/errorHandling.js

@@ -1,4 +1,5 @@
 const i18n = require('i18n')
+const chalk = require('chalk')
 
 const libraryAnalysisError = () => {
   console.log(i18n.__('libraryAnalysisError'))
@@ -124,6 +125,17 @@ const findCommandOnError = unknownOptions => {
   }
 }
 
+const commonMessageFormatter = (message, fail) => {
+  console.log(chalk.bold(i18n.__(message.title)))
+  console.log(i18n.__(message.body))
+  if (message.extra) {
+    console.log(i18n.__(message.extra))
+  }
+  if (fail) {
+    process.exit(1)
+  }
+}
+
 module.exports = {
   genericError,
   unauthenticatedError,
@@ -140,5 +152,6 @@ module.exports = {
   reportFailureError,
   maxAppError,
   parametersError,
-  invalidHostNameError
+  invalidHostNameError,
+  commonMessageFormatter
 }

package/src/constants/constants.js

@@ -14,7 +14,7 @@ const HIGH = 'HIGH'
 const CRITICAL = 'CRITICAL'
 // App
 const APP_NAME = 'contrast'
-const APP_VERSION = '1.0.18'
+const APP_VERSION = '1.0.19'
 const TIMEOUT = 120000
 const HIGH_COLOUR = '#ff9900'
 const CRITICAL_COLOUR = '#e35858'

package/src/constants/locales.js

@@ -317,6 +317,19 @@ const en_locales = () => {
       'Join the discussion:'
     ),
     commonHelpJoinDiscussionText: ' https://dev.to/codesec',
+    authCommand: {
+      credentialsAccepted: {
+        title: 'Credentials accepted',
+        body: 'Now run contrast audit, lambda or scan',
+        extra: 'Or contrast help for full list of commands'
+      },
+      credentialsMissing: {
+        title: 'Credentials missing',
+        body: 'You have not entered the right parameters or enough information',
+        extra:
+          'Please check and try again e.g. contrast auth --api-key yourApiKey--organization-id yourOrg --authorization yourAuth --host https://yourHost\nOr contrast help for full list of commands'
+      }
+    },
     ...lambda
   }
 }

package/src/utils/getConfig.ts

@@ -29,7 +29,7 @@ const setConfigValues = (config: ContrastConf, values: ContrastConfOptions) => {
   config.set('apiKey', values.apiKey)
   config.set('organizationId', values.orgId)
   config.set('authorization', values.authHeader)
-  values.host ? config.set('host', values.host) : null
+  values.host ? config.set('host', values.host) : config.set('host', CE_URL)
 }
 
 export { localConfig, setConfigValues, ContrastConf, ContrastConfOptions }