@contrast/contrast 1.0.13 → 1.0.15

package/src/audit/report/commonReportingFunctions.ts

@@ -1,355 +0,0 @@
-import { getHttpClient, handleResponseErrors } from '../../utils/commonApi'
-import {
-  ReportCompositeKey,
-  ReportList,
-  ReportModelStructure
-} from './models/reportListModel'
-import { ReportSeverityModel } from './models/reportSeverityModel'
-import { orderBy } from 'lodash'
-import chalk from 'chalk'
-import { ReportCVEModel, ReportLibraryModel } from './models/reportLibraryModel'
-import {
-  countVulnerableLibrariesBySeverity,
-  findCVESeveritiesAndOrderByHighestPriority,
-  findHighestSeverityCVE,
-  findNameAndVersion,
-  severityCountAllCVEs
-} from './utils/reportUtils'
-import { SeverityCountModel } from './models/severityCountModel'
-import {
-  ReportOutputBodyModel,
-  ReportOutputHeaderModel,
-  ReportOutputModel
-} from './models/reportOutputModel'
-import {
-  CE_URL,
-  CRITICAL_COLOUR,
-  HIGH_COLOUR,
-  LOW_COLOUR,
-  MEDIUM_COLOUR,
-  NOTE_COLOUR
-} from '../../constants/constants'
-import Table from 'cli-table3'
-import { ReportGuidanceModel } from './models/reportGuidanceModel'
-
-export const createSummaryMessageTop = (
-  numberOfVulnerableLibraries: number,
-  numberOfCves: number
-) => {
-  numberOfVulnerableLibraries === 1
-    ? console.log(`Found 1 vulnerable library containing ${numberOfCves} CVE`)
-    : console.log(
-        `Found ${numberOfVulnerableLibraries} vulnerable libraries containing ${numberOfCves} CVEs`
-      )
-}
-
-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
-    .getReportById(config, reportId)
-    .then((res: { statusCode: number; body: any }) => {
-      if (res.statusCode === 200) {
-        return res.body
-      } else {
-        console.log(JSON.stringify(res))
-        handleResponseErrors(res, 'report')
-      }
-    })
-    .catch((err: any) => {
-      console.log(err)
-    })
-}
-
-export const printVulnerabilityResponse = (
-  config: any,
-  vulnerableLibraries: ReportLibraryModel[],
-  numberOfVulnerableLibraries: number,
-  numberOfCves: number,
-  guidance: any
-) => {
-  let hasSomeVulnerabilitiesReported = false
-  printFormattedOutput(
-    config,
-    vulnerableLibraries,
-    numberOfVulnerableLibraries,
-    numberOfCves,
-    guidance
-  )
-  if (Object.keys(vulnerableLibraries).length > 0) {
-    hasSomeVulnerabilitiesReported = true
-  }
-  return hasSomeVulnerabilitiesReported
-}
-
-export const printFormattedOutput = (
-  config: any,
-  libraries: ReportLibraryModel[],
-  numberOfVulnerableLibraries: number,
-  numberOfCves: number,
-  guidance: any
-) => {
-  createSummaryMessageTop(numberOfVulnerableLibraries, numberOfCves)
-  console.log()
-  const report = new ReportList()
-
-  for (const library of libraries) {
-    const { name, version } = findNameAndVersion(library, config)
-
-    const newOutputModel = new ReportModelStructure(
-      new ReportCompositeKey(
-        name,
-        version,
-        findHighestSeverityCVE(library.cveArray) as ReportSeverityModel,
-        severityCountAllCVEs(
-          library.cveArray,
-          new SeverityCountModel()
-        ).getTotal
-      ),
-      library.cveArray
-    )
-    report.reportOutputList.push(newOutputModel)
-  }
-
-  const outputOrderedByLowestSeverityAndLowestNumOfCvesFirst = orderBy(
-    report.reportOutputList,
-    [
-      (reportListItem: ReportModelStructure) => {
-        return reportListItem.compositeKey.highestSeverity.priority
-      },
-      (reportListItem: ReportModelStructure) => {
-        return reportListItem.compositeKey.numberOfSeverities
-      }
-    ],
-    ['asc', 'desc']
-  )
-
-  let contrastHeaderNumCounter = 0
-  for (const reportModel of outputOrderedByLowestSeverityAndLowestNumOfCvesFirst) {
-    contrastHeaderNumCounter++
-    const { libraryName, libraryVersion, highestSeverity } =
-      reportModel.compositeKey
-    const numOfCVEs = reportModel.cveArray.length
-
-    const table = new Table({
-      chars: {
-        top: '',
-        'top-mid': '',
-        'top-left': '',
-        'top-right': '',
-        bottom: '',
-        'bottom-mid': '',
-        'bottom-left': '',
-        'bottom-right': '',
-        left: '',
-        'left-mid': '',
-        mid: '',
-        'mid-mid': '',
-        right: '',
-        'right-mid': '',
-        middle: ' '
-      },
-      style: { 'padding-left': 0, 'padding-right': 0 },
-      colAligns: ['right'],
-      wordWrap: true,
-      colWidths: [12, 1, 100]
-    })
-
-    const header = buildHeader(
-      highestSeverity,
-      contrastHeaderNumCounter,
-      libraryName,
-      libraryVersion,
-      numOfCVEs
-    )
-
-    const advice = gatherRemediationAdvice(
-      guidance,
-      libraryName,
-      libraryVersion
-    )
-
-    const body = buildBody(reportModel.cveArray, advice)
-
-    const reportOutputModel = new ReportOutputModel(header, body)
-
-    table.push(
-      reportOutputModel.body.issueMessage,
-      reportOutputModel.body.adviceMessage
-    )
-
-    console.log(
-      reportOutputModel.header.vulnMessage,
-      reportOutputModel.header.introducesMessage
-    )
-    console.log(table.toString() + '\n')
-  }
-
-  createSummaryMessageBottom(numberOfVulnerableLibraries)
-  const {
-    criticalMessage,
-    highMessage,
-    mediumMessage,
-    lowMessage,
-    noteMessage
-  } = buildFooter(outputOrderedByLowestSeverityAndLowestNumOfCvesFirst)
-  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(
-  highestSeverity: ReportSeverityModel,
-  contrastHeaderNum: number,
-  libraryName: string,
-  version: string,
-  numOfCVEs: number
-) {
-  const vulnerabilityPluralised =
-    numOfCVEs > 1 ? 'vulnerabilities' : 'vulnerability'
-  const formattedHeaderNum = buildFormattedHeaderNum(contrastHeaderNum)
-
-  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: ReportGuidanceModel
-) {
-  const cveMessages: string[] = []
-
-  findCVESeveritiesAndOrderByHighestPriority(cveArray).forEach(
-    reportSeverityModel => {
-      // @ts-ignore
-      const { outputColour, severity, cveName } = reportSeverityModel
-
-      const severityShorthand = chalk
-        .hex(outputColour)
-        .bold(`[${severity.charAt(0).toUpperCase()}]`)
-
-      const builtMessage = severityShorthand + cveName
-      cveMessages.push(builtMessage)
-    }
-  )
-
-  const numAndSeverityType = getNumOfAndSeverityType(cveArray)
-
-  const issueMessage = [
-    chalk.bold('Issue'),
-    ':',
-    `${numAndSeverityType} ${cveMessages.join(', ')}`
-  ]
-
-  //todo different advice based on remediationGuidance being available or now
-  // console.log(advice)
-
-  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, adviceMessage)
-}
-
-export function gatherRemediationAdvice(
-  guidance: any,
-  libraryName: string,
-  libraryVersion: string
-) {
-  const guidanceModel = new ReportGuidanceModel()
-
-  const data = guidance[libraryName + '@' + libraryVersion]
-
-  if (data) {
-    guidanceModel.minimum = data.minUpgradeVersion
-    guidanceModel.maximum = data.maxUpgradeVersion
-  }
-
-  return guidanceModel
-}
-
-export function buildFormattedHeaderNum(contrastHeaderNum: number) {
-  return `CONTRAST-${contrastHeaderNum.toString().padStart(3, '0')}`
-}
-
-export function getNumOfAndSeverityType(cveArray: ReportCVEModel[]) {
-  const { critical, high, medium, low, note } = severityCountAllCVEs(
-    cveArray,
-    new SeverityCountModel()
-  )
-
-  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}`
-    .replace(/\s+/g, ' ')
-    .trim()
-}
-
-const buildFooter = (reportModelStructure: ReportModelStructure[]) => {
-  const { critical, high, medium, low, note } =
-    countVulnerableLibrariesBySeverity(reportModelStructure)
-
-  const criticalMessage = chalk
-    .hex(CRITICAL_COLOUR)
-    .bold(`${critical} Critical`)
-  const highMessage = chalk.hex(HIGH_COLOUR).bold(`${high} High`)
-  const mediumMessage = chalk.hex(MEDIUM_COLOUR).bold(`${medium} Medium`)
-  const lowMessage = chalk.hex(LOW_COLOUR).bold(`${low} Low`)
-  const noteMessage = chalk.hex(NOTE_COLOUR).bold(`${note} Note`)
-
-  return {
-    criticalMessage,
-    highMessage,
-    mediumMessage,
-    lowMessage,
-    noteMessage
-  }
-}