@contrast/contrast 2.0.2-beta.3 → 2.0.2-beta.4

package/src/commands/auth/auth.js

@@ -1,146 +0,0 @@
-const { v4: uuidv4 } = require('uuid')
-const configFunctions = require('../../utils/getConfig')
-const commonApi = require('../../utils/commonApi')
-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)
-  }
-
-  //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}`
-
-  console.log(i18n.__('redirectAuth', url))
-
-  try {
-    //start a spinner / progress
-    await setTimeout(() => {
-      open(url)
-    }, 0)
-
-    const result = await isAuthComplete(token, TIMEOUT, config)
-    if (result) {
-      configFunctions.setConfigValues(config, result)
-    }
-  } finally {
-    //spinner stop
-  }
-}
-
-const isAuthComplete = async (token, timeout, config) => {
-  const authSpinner = returnOra(i18n.__('authWaitingMessage'))
-  startSpinner(authSpinner)
-  const client = commonApi.getHttpClient(config)
-  let startTime = new Date()
-  let complete = false
-  while (!complete) {
-    let result = await pollAuthResult(token, client)
-    if (result.statusCode === 200) {
-      succeedSpinner(authSpinner, i18n.__('authSuccessMessage'))
-      console.log(i18n.__('runAuthSuccessMessage'))
-      return result.body
-    }
-    let endTime = new Date() - startTime
-    if (endTime > timeout) {
-      failSpinner(authSpinner, i18n.__('authTimedOutMessage'))
-      process.exit(1)
-      return
-    }
-  }
-}
-
-const pollAuthResult = async (token, client) => {
-  await requestUtils.sleep(5000)
-  return client
-    .pollForAuth(token)
-    .then(res => {
-      return res
-    })
-    .catch(err => {
-      console.log(err)
-    })
-}
-
-const authUsageGuide = commandLineUsage([
-  {
-    header: i18n.__('authHeader'),
-    content: [i18n.__('constantsAuthHeaderContents')]
-  },
-  {
-    header: i18n.__('constantsAuthUsageHeader'),
-    content: [i18n.__('constantsAuthUsageContents')]
-  },
-  {
-    header: i18n.__('constantsAdvancedOptions'),
-    optionList: constants.commandLineDefinitions.authOptionDefinitions,
-    hide: ['organization-id', 'api-key', 'authorization', 'host']
-  }
-])
-
-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
-}

package/src/commands/config/config.js

@@ -1,41 +0,0 @@
-const parsedCLIOptions = require('../../utils/parsedCLIOptions')
-const constants = require('../../cliConstants')
-const commandLineUsage = require('command-line-usage')
-const i18n = require('i18n')
-
-const processConfig = async (argv, config) => {
-  try {
-    let configParams = await parsedCLIOptions.getCommandLineArgsCustom(
-      config,
-      'config',
-      argv,
-      constants.commandLineDefinitions.configOptionDefinitions
-    )
-    if (configParams.help) {
-      console.log(configUsageGuide)
-      process.exit(0)
-    }
-    if (configParams.clear) {
-      config.clear()
-    } else {
-      console.log(JSON.parse(JSON.stringify(config.store)))
-    }
-  } catch (e) {
-    //handle unknown command inputs
-    console.log(e.message.toString())
-  }
-}
-
-const configUsageGuide = commandLineUsage([
-  {
-    header: i18n.__('configHeader')
-  },
-  {
-    content: [i18n.__('constantsConfigUsageContents')],
-    optionList: constants.commandLineDefinitions.configOptionDefinitions
-  }
-])
-
-module.exports = {
-  processConfig: processConfig
-}

package/src/commands/github/fingerprintConfig.js

@@ -1,19 +0,0 @@
-const parsedCLIOptions = require('../../utils/parsedCLIOptions')
-const constants = require('../../cliConstants')
-const paramHandler = require('../../utils/paramsUtil/paramHandler')
-
-const getFingerprintConfig = async (contrastConf, command, argv) => {
-  let fingerprintParameters = await parsedCLIOptions.getCommandLineArgsCustom(
-    contrastConf,
-    command,
-    argv,
-    constants.commandLineDefinitions.fingerprintOptionDefinitions
-  )
-  const paramsAuth = paramHandler.getAuth(fingerprintParameters)
-  fingerprintParameters = paramHandler.getFingerprint(fingerprintParameters)
-  return { ...paramsAuth, ...fingerprintParameters }
-}
-
-module.exports = {
-  getFingerprintConfig
-}

package/src/commands/github/processFingerprint.js

@@ -1,37 +0,0 @@
-const fingerprintConfig = require('./fingerprintConfig')
-const repoServices = require('./repoServices')
-const autoDetection = require('../../common/autoDetection')
-const saveResults = require('../../scan/saveResults')
-const projectConfig = require('./projectGroup')
-const processFingerprint = async (contrastConf, argvMain) => {
-  let config = await fingerprintConfig.getFingerprintConfig(
-    contrastConf,
-    'fingerprint',
-    argvMain
-  )
-  config.repositoryId = await repoServices.getRepoId(config)
-  if (config.repositoryId !== '') {
-    config.projectGroupId = await projectConfig.getProjectGroupId(config)
-    let fingerprint = await autoDetection.autoDetectFingerprintInfo(
-      config.file,
-      config.depth,
-      config
-    )
-
-    if (fingerprint.length === 0) {
-      console.log('No supported manifests found')
-      process.exit(0)
-    }
-
-    let idArray = fingerprint.map(x => x.id)
-    await saveResults.writeResultsToFile(fingerprint, 'fingerPrintInfo.json')
-    return console.log(idArray)
-  } else {
-    console.log('No repository Id found')
-    process.exit(1)
-  }
-}
-
-module.exports = {
-  processFingerprint: processFingerprint
-}

package/src/commands/github/projectGroup.js

@@ -1,298 +0,0 @@
-const commonApi = require('../../utils/commonApi')
-const { getAppName } = require('../audit/auditController')
-
-const getProjectIdByOrg = async config => {
-  const client = await commonApi.getHttpClient(config)
-  config.language = config.language === 'NODE' ? 'JAVASCRIPT' : config.language
-  let projectId = ''
-
-  let projectByOrg = await retrieveProjectByOrganization(config, client)
-
-  if (projectByOrg?.length > 0) {
-    projectId = getProjectIdFromArray(config, projectByOrg)
-  }
-
-  return projectId
-}
-
-const createNewProjectGroupBody = async config => {
-  let body = {
-    organizationId: config.organizationId
-  }
-  if (config.repo || config?.repositoryId) {
-    body.repositoryId = config.repositoryId
-    body.type = 'REPOSITORY'
-    body.name = getProjectGroupNameRepo(config)
-  } else {
-    body.repositoryId = null
-    body.type = 'CLI'
-    body.name = getProjectGroupNameCLI(config)
-  }
-  return body
-}
-
-const getProjectGroupNameRepo = config => {
-  return config.repositoryName
-}
-const getProjectGroupNameCLI = config => {
-  // file here is actually folder name
-  return config.name ? config.name : config.file
-}
-
-const getProjectName = config => {
-  return config.name ? config.name : config.fileName
-}
-
-const registerNewProjectGroup = async config => {
-  let body = await createNewProjectGroupBody(config)
-
-  const client = await commonApi.getHttpClient(config)
-  if (config.repositoryId) {
-    body.projects = []
-  } else {
-    body.projects = createProjectsArray([config])
-  }
-  let projectGroupInfo = await client
-    .registerProjectGroup(config, body)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nRegister ProjectGroup')
-        console.log(res.statusCode)
-        console.log(res.body)
-      }
-      if (res.statusCode === 201 || res.statusCode === 200) {
-        if (config.debug || config.verbose) {
-          console.log('registerProjectGroup - response')
-          console.log('response', res.body)
-        }
-        return res?.body?.projectGroupId
-      }
-
-      if (res.statusCode === 409) {
-        return ''
-      }
-    })
-    .catch(err => {
-      console.log('\nError Registering Project Group')
-      console.log(err.statusCode)
-    })
-
-  return projectGroupInfo
-}
-
-const createProjectsArray = params => {
-  let projectsArray = []
-  let projects = {}
-  params.forEach(param => {
-    projects = createProject(param)
-    projectsArray.push(projects)
-  })
-
-  return projectsArray
-}
-
-const createProject = (param, shortenedProjectName) => {
-  return {
-    path: param.fileName,
-    name: param.repo ? shortenedProjectName : getProjectName(param),
-    source: 'SCA',
-    language: param.language,
-    packageManager: param.packageManager,
-    target: 'SCA',
-    sourceId: ''
-  }
-}
-
-const getExistingGroupProjectId = (config, projectGroupsInfoEx) => {
-  let existingGroupProjectId = ''
-  projectGroupsInfoEx.forEach(i => {
-    if (i.repositoryId === config.repositoryId) {
-      existingGroupProjectId = i.projectGroupId
-    }
-  })
-  return existingGroupProjectId
-}
-
-const getProjectIdFromArray = (config, array) => {
-  if (array.length === 1) {
-    return array[0].projectId
-  }
-
-  if (config.name) {
-    for (const i of array) {
-      //match on name
-      if (i.name === config.name) return i.projectId
-    }
-  }
-
-  for (const i of array) {
-    //match on fileName
-    if (i.name === config.fileName) return i.projectId
-  }
-
-  return ''
-}
-
-const addAdditionalData = (body, data) => {
-  body.projectGroupId = data.projectGroupId ? data.projectGroupId : null
-  body.projectGroupName = data.projectGroupName ? data.projectGroupName : null
-  body.projectLanguage = data.projectLanguage ? data.projectLanguage : null
-  body.projectType = data.projectType ? data.projectType : null
-}
-
-const registerProjectIdOnCliServices = async (
-  config,
-  projectId,
-  shortenedProjectName,
-  additionalData = undefined
-) => {
-  const client = commonApi.getHttpClient(config)
-
-  let cliServicesBody = {
-    projectId: projectId,
-    name: config.repo ? shortenedProjectName : getProjectName(config)
-  }
-
-  if (additionalData) {
-    addAdditionalData(cliServicesBody, additionalData)
-  }
-
-  let result = await client
-    .registerOnCliServices(config, cliServicesBody)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nregistration on cli services')
-        console.log('request body', cliServicesBody)
-        console.log('response code', res.statusCode)
-      }
-      if (res.statusCode === 201 || res.statusCode === 200) {
-        return res.body
-      } else {
-        console.log('Failed to Register On Cli Services')
-        console.log(res.statusCode)
-        process.exit(1)
-      }
-    })
-
-  return result
-}
-
-const registerProjectWithGroupProjectId = async (
-  config,
-  shortenedProjectName
-) => {
-  const client = commonApi.getHttpClient(config)
-  config.language = config.language === 'NODE' ? 'JAVASCRIPT' : config.language
-
-  let body = createProject(config, shortenedProjectName)
-  let result = await client.registerProject(config, body).then(res => {
-    if (config.debug || config.verbose) {
-      console.log('\nregister Project With Group ProjectId')
-      console.log(res.statusCode)
-      console.log(res.body)
-    }
-    if (res.statusCode === 201 || res.statusCode === 200) {
-      return res.body
-    } else {
-      return []
-    }
-  })
-
-  return result
-}
-
-const retrieveExistingProjectIdWithProjectGroupId = async (
-  config,
-  client,
-  projectGroupId
-) => {
-  return await client
-    .retrieveExistingProjectIdByProjectGroupId(config, projectGroupId)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nRetrieve Existing ProjectId By ProjectGroupId')
-        console.log(res.statusCode)
-        console.log(res.body)
-      }
-
-      if (res.statusCode === 200) {
-        return res.body
-      } else {
-        return ''
-      }
-    })
-}
-
-const retrieveProjectByOrganization = async (config, client) => {
-  return await client.retrieveProjectByOrganizationId(config).then(res => {
-    if (config.debug || config.verbose) {
-      console.log('\nRetrieve Project By OrganizationId')
-      console.log(res.statusCode)
-      console.log(res.body)
-    }
-
-    if (res.statusCode === 201 || res.statusCode === 200) {
-      return res.body
-    } else {
-      return []
-    }
-  })
-}
-
-const retrieveExistingProjectGroups = async config => {
-  const client = commonApi.getHttpClient(config)
-  return await client.retrieveExistingProjectGroupsByOrg(config).then(res => {
-    if (config.debug || config.verbose) {
-      console.log('retrieve Existing ProjectGroups By Org')
-      console.log(res.statusCode)
-      console.log(res.body)
-    }
-    if (res.statusCode === 201 || res.statusCode === 200) {
-      let correctGroupID = res?.body?.filter(
-        i => i.repositoryId === config.repositoryId
-      )
-
-      if (correctGroupID.length > 0) {
-        return correctGroupID[0].projectGroupId
-      }
-      return ''
-    } else {
-      return ''
-    }
-  })
-}
-
-const getProjectGroupId = async config => {
-  let projectGroupId = ''
-  if (config.projectGroupId === '' || config.projectGroupId === undefined) {
-    projectGroupId = await retrieveExistingProjectGroups(config)
-  }
-
-  if (projectGroupId === '') {
-    projectGroupId = await registerNewProjectGroup(config)
-  }
-  return projectGroupId
-}
-
-const dealWithNoName = async config => {
-  try {
-    config.name = getAppName(config.file)
-  } catch (e) {
-    console.log(e.message.toString())
-    process.exit(1)
-  }
-  return config
-}
-
-module.exports = {
-  getProjectIdByOrg,
-  registerProjectIdOnCliServices,
-  dealWithNoName,
-  registerNewProjectGroup,
-  createNewProjectGroupBody,
-  registerProjectWithGroupProjectId,
-  getExistingGroupProjectId,
-  getProjectGroupId,
-  retrieveExistingProjectGroups,
-  createProject
-}

package/src/commands/github/repoServices.js

@@ -1,122 +0,0 @@
-const commonApi = require('../../utils/commonApi')
-const retrieveRepoId = async config => {
-  const client = await commonApi.getHttpClient(config)
-
-  let repositoryId = await client
-    .retrieveRepoByOrgAndGitURL(config)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nRetrieve RepoId By retrieveRepoByOrgAndGitURL')
-        console.log(res.statusCode)
-        console.log(res.body)
-      }
-
-      if (res.statusCode === 201 || res.statusCode === 200) {
-        return res.body.repositoryId
-      } else {
-        return ''
-      }
-    })
-
-  return repositoryId
-}
-
-const registerNewRepo = async config => {
-  let body = {
-    externalScmUrl: config.repositoryUrl,
-    externalScmName: config.repositoryName,
-    externalId: config.externalId,
-    primaryLanguage: config.language,
-    defaultBranch: 'develop'
-  }
-  if (config.debug || config.verbose) {
-    console.log('registerNewRepo')
-    console.log(body)
-  }
-
-  const client = await commonApi.getHttpClient(config)
-
-  let result = await client
-    .registerRepo(config, body)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nRegister Repository')
-        console.log(res.statusCode)
-        console.log(res.body)
-      }
-      if (res.statusCode === 201 || res.statusCode === 200) {
-        if (config.debug || config.verbose) {
-          console.log('registerRepository - response')
-          console.log('response', res.body)
-        }
-        return res?.body?.repositoryId
-      }
-
-      if (res.statusCode === 409) {
-        return ''
-      }
-      if (res.statusCode === 400) {
-        if (config.debug || config.verbose) {
-          console.log('\nError Registering Repository - Bad request')
-          console.log(res.statusCode)
-          console.log(res.message)
-        }
-        process.exit(1)
-      }
-    })
-    .catch(err => {
-      console.log('\nError Registering Repository')
-      console.log(err.statusCode)
-      console.log(err.message)
-      process.exit(1)
-    })
-
-  return result
-}
-
-const retrieveProjectInfoViaRepoId = async config => {
-  const client = commonApi.getHttpClient(config)
-
-  let result = await client
-    .retrieveProjectByRepoId(config)
-    .then(res => {
-      if (config.debug || config.verbose) {
-        console.log('\nRetrieve Project By RepoId')
-        console.log(res.statusCode)
-        console.log(res.body)
-      }
-      if (res.statusCode === 201 || res.statusCode === 200) {
-        return res?.body
-      }
-
-      if (res.statusCode === 409) {
-        return []
-      }
-    })
-    .catch(err => {
-      console.log('\nError Retrieve Project By RepoId')
-      console.log(err.statusCode)
-    })
-
-  return result
-}
-
-const getRepoId = async config => {
-  let repoId = ''
-  if (config.repositoryId === '' || config.repositoryId === undefined) {
-    repoId = await retrieveRepoId(config)
-  }
-
-  if (repoId === '') {
-    repoId = await registerNewRepo(config)
-  }
-
-  return repoId
-}
-
-module.exports = {
-  retrieveRepoId,
-  registerNewRepo,
-  getRepoId,
-  retrieveProjectInfoViaRepoId
-}

package/src/commands/learn/learn.js

@@ -1,10 +0,0 @@
-const open = require('open')
-
-async function openLearnPage() {
-  const url = 'https://www.contrastsecurity.com/developer/learn'
-  return open(url)
-}
-
-module.exports = {
-  openLearnPage
-}

package/src/commands/learn/processLearn.js

@@ -1,13 +0,0 @@
-const { openLearnPage } = require('./learn')
-
-async function processLearn() {
-  console.log('Opening Contrast’s Secure Code Learning Hub...')
-  console.log(
-    'If the page does not open you can open it directly via https://www.contrastsecurity.com/developer/learn'
-  )
-  return openLearnPage()
-}
-
-module.exports = {
-  processLearn
-}