From 5942dfdf11528f8fd22293a12cfc879f6304c0a9 Mon Sep 17 00:00:00 2001 From: Guy Sheffer Date: Sun, 19 Nov 2023 14:40:55 +0200 Subject: [PATCH] Initial support for JAS docker scan support #1035 --- .../jas/applicability/applicabilitymanager.go | 43 +++++++++++++-- .../audit/jas/secrets/secretsscanner.go | 17 +++--- xray/commands/audit/jasrunner.go | 3 +- xray/commands/scan/jasrunner_cves.go | 53 +++++++++++++++++++ xray/commands/scan/scan.go | 45 +++++++++++++++- 5 files changed, 147 insertions(+), 14 deletions(-) create mode 100644 xray/commands/scan/jasrunner_cves.go diff --git a/xray/commands/audit/jas/applicability/applicabilitymanager.go b/xray/commands/audit/jas/applicability/applicabilitymanager.go index 7067963ae..b7583818d 100644 --- a/xray/commands/audit/jas/applicability/applicabilitymanager.go +++ b/xray/commands/audit/jas/applicability/applicabilitymanager.go @@ -17,9 +17,10 @@ import ( ) const ( - applicabilityScanType = "analyze-applicability" - applicabilityScanCommand = "ca" - applicabilityDocsUrlSuffix = "contextual-analysis" + applicabilityScanType = "analyze-applicability" + applicabilityScanCommand = "ca" + applicabilityDocsUrlSuffix = "contextual-analysis" + applicabilityDockerScanScanType = "analyze-applicability-docker-scan" ) type ApplicabilityScanManager struct { @@ -29,6 +30,7 @@ type ApplicabilityScanManager struct { xrayResults []services.ScanResponse scanner *jas.JasScanner thirdPartyScan bool + commandType string } // The getApplicabilityScanResults function runs the applicability scan flow, which includes the following steps: @@ -55,6 +57,37 @@ func RunApplicabilityScan(xrayResults []services.ScanResponse, directDependencie return } +// The getApplicabilityScanResults function runs the applicability scan flow, which includes the following steps: +// Creating an ApplicabilityScanManager object. +// Checking if the scanned project is eligible for applicability scan. +// Running the analyzer manager executable. +// Parsing the analyzer manager results. +// Return values: +// map[string]string: A map containing the applicability result of each XRAY CVE. +// bool: true if the user is entitled to the applicability scan, false otherwise. +// error: An error object (if any). +func RunApplicabilityWithScanCves(xrayResults []services.ScanResponse, cveList []string, + scannedTechnologies []coreutils.Technology, scanner *jas.JasScanner, thirdPartyContextualAnalysis bool) (results []*sarif.Run, err error) { + applicabilityScanManager := newApplicabilityScanManagerCves(xrayResults, cveList, scanner, thirdPartyContextualAnalysis) + if err = applicabilityScanManager.scanner.Run(applicabilityScanManager); err != nil { + err = utils.ParseAnalyzerManagerError(utils.Applicability, err) + return + } + results = applicabilityScanManager.applicabilityScanResults + return +} + +func newApplicabilityScanManagerCves(xrayScanResults []services.ScanResponse, cveList []string, scanner *jas.JasScanner, thirdPartyScan bool) (manager *ApplicabilityScanManager) { + return &ApplicabilityScanManager{ + applicabilityScanResults: []*sarif.Run{}, + directDependenciesCves: cveList, + xrayResults: xrayScanResults, + scanner: scanner, + thirdPartyScan: thirdPartyScan, + commandType: applicabilityDockerScanScanType, + } +} + func newApplicabilityScanManager(xrayScanResults []services.ScanResponse, directDependencies []string, scanner *jas.JasScanner, thirdPartyScan bool) (manager *ApplicabilityScanManager) { directDependenciesCves, indirectDependenciesCves := extractDependenciesCvesFromScan(xrayScanResults, directDependencies) return &ApplicabilityScanManager{ @@ -64,6 +97,7 @@ func newApplicabilityScanManager(xrayScanResults []services.ScanResponse, direct xrayResults: xrayScanResults, scanner: scanner, thirdPartyScan: thirdPartyScan, + commandType: applicabilityScanType, } } @@ -152,6 +186,7 @@ type scanConfiguration struct { CveWhitelist []string `yaml:"cve-whitelist"` IndirectCveWhitelist []string `yaml:"indirect-cve-whitelist"` SkippedDirs []string `yaml:"skipped-folders"` + ScanType string `yaml:"scantype"` } func (asm *ApplicabilityScanManager) createConfigFile(module jfrogappsconfig.Module) error { @@ -169,7 +204,7 @@ func (asm *ApplicabilityScanManager) createConfigFile(module jfrogappsconfig.Mod { Roots: roots, Output: asm.scanner.ResultsFileName, - Type: applicabilityScanType, + Type: asm.commandType, GrepDisable: false, CveWhitelist: asm.directDependenciesCves, IndirectCveWhitelist: asm.indirectDependenciesCves, diff --git a/xray/commands/audit/jas/secrets/secretsscanner.go b/xray/commands/audit/jas/secrets/secretsscanner.go index aad7fc6a6..657a28394 100644 --- a/xray/commands/audit/jas/secrets/secretsscanner.go +++ b/xray/commands/audit/jas/secrets/secretsscanner.go @@ -12,14 +12,16 @@ import ( ) const ( - secretsScanCommand = "sec" - secretsScannerType = "secrets-scan" - secretsDocsUrlSuffix = "secrets" + secretsScanCommand = "sec" + SecretsScannerType = "secrets-scan" + SecretsScannerDockerType = "secrets-docker-scan" + secretsDocsUrlSuffix = "secrets" ) type SecretScanManager struct { secretsScannerResults []*sarif.Run scanner *jas.JasScanner + scanType string } // The getSecretsScanResults function runs the secrets scan flow, which includes the following steps: @@ -29,8 +31,8 @@ type SecretScanManager struct { // Return values: // []utils.IacOrSecretResult: a list of the secrets that were found. // error: An error object (if any). -func RunSecretsScan(scanner *jas.JasScanner) (results []*sarif.Run, err error) { - secretScanManager := newSecretsScanManager(scanner) +func RunSecretsScan(scanner *jas.JasScanner, scanType string) (results []*sarif.Run, err error) { + secretScanManager := newSecretsScanManager(scanner, scanType) log.Info("Running secrets scanning...") if err = secretScanManager.scanner.Run(secretScanManager); err != nil { err = utils.ParseAnalyzerManagerError(utils.Secrets, err) @@ -43,10 +45,11 @@ func RunSecretsScan(scanner *jas.JasScanner) (results []*sarif.Run, err error) { return } -func newSecretsScanManager(scanner *jas.JasScanner) (manager *SecretScanManager) { +func newSecretsScanManager(scanner *jas.JasScanner, scanType string) (manager *SecretScanManager) { return &SecretScanManager{ secretsScannerResults: []*sarif.Run{}, scanner: scanner, + scanType: scanType, } } @@ -89,7 +92,7 @@ func (s *SecretScanManager) createConfigFile(module jfrogappsconfig.Module) erro { Roots: roots, Output: s.scanner.ResultsFileName, - Type: secretsScannerType, + Type: s.scanType, SkippedDirs: jas.GetExcludePatterns(module, module.Scanners.Secrets), }, }, diff --git a/xray/commands/audit/jasrunner.go b/xray/commands/audit/jasrunner.go index b9dc0c154..bad0fb016 100644 --- a/xray/commands/audit/jasrunner.go +++ b/xray/commands/audit/jasrunner.go @@ -2,6 +2,7 @@ package audit import ( "errors" + "github.com/jfrog/jfrog-cli-core/v2/utils/config" "github.com/jfrog/jfrog-cli-core/v2/xray/commands/audit/jas" "github.com/jfrog/jfrog-cli-core/v2/xray/commands/audit/jas/applicability" @@ -41,7 +42,7 @@ func runJasScannersAndSetResults(scanResults *utils.Results, directDependencies if progress != nil { progress.SetHeadlineMsg("Running secrets scanning") } - scanResults.ExtendedScanResults.SecretsScanResults, err = secrets.RunSecretsScan(scanner) + scanResults.ExtendedScanResults.SecretsScanResults, err = secrets.RunSecretsScan(scanner, secrets.SecretsScannerType) if err != nil { return } diff --git a/xray/commands/scan/jasrunner_cves.go b/xray/commands/scan/jasrunner_cves.go new file mode 100644 index 000000000..f8a60c742 --- /dev/null +++ b/xray/commands/scan/jasrunner_cves.go @@ -0,0 +1,53 @@ +package scan + +import ( + "errors" + "fmt" + + "github.com/jfrog/jfrog-cli-core/v2/utils/config" + "github.com/jfrog/jfrog-cli-core/v2/xray/commands/audit/jas" + "github.com/jfrog/jfrog-cli-core/v2/xray/commands/audit/jas/applicability" + "github.com/jfrog/jfrog-cli-core/v2/xray/commands/audit/jas/secrets" + + "github.com/jfrog/jfrog-cli-core/v2/xray/utils" + "github.com/jfrog/jfrog-client-go/utils/io" + "github.com/jfrog/jfrog-client-go/utils/log" +) + +func runJasScannersAndSetResults(scanResults *utils.Results, cveList []string, + serverDetails *config.ServerDetails, workingDirs []string, progress io.ProgressMgr, multiScanId string, thirdPartyApplicabilityScan bool) (err error) { + + if serverDetails == nil || len(serverDetails.Url) == 0 { + log.Warn("To include 'Advanced Security' scan as part of the audit output, please run the 'jf c add' command before running this command.") + return + } + + scanner, err := jas.NewJasScanner(workingDirs, serverDetails, multiScanId) + if err != nil { + return + } + + defer func() { + cleanup := scanner.ScannerDirCleanupFunc + err = errors.Join(err, cleanup()) + }() + + // if progress != nil { + // progress.SetHeadlineMsg("Running applicability scanning") + // } + + scanResults.ExtendedScanResults.ApplicabilityScanResults, err = applicability.RunApplicabilityWithScanCves(scanResults.GetScaScansXrayResults(), cveList, scanResults.GetScaScannedTechnologies(), scanner, thirdPartyApplicabilityScan) + if err != nil { + fmt.Println("there was an error:", err) + return + } + + // if progress != nil { + // progress.SetHeadlineMsg("Running secrets scanning") + // } + scanResults.ExtendedScanResults.SecretsScanResults, err = secrets.RunSecretsScan(scanner, secrets.SecretsScannerDockerType) + if err != nil { + return + } + return +} diff --git a/xray/commands/scan/scan.go b/xray/commands/scan/scan.go index 0747ca48a..399d3b677 100644 --- a/xray/commands/scan/scan.go +++ b/xray/commands/scan/scan.go @@ -5,13 +5,17 @@ import ( "encoding/json" "errors" "fmt" - "github.com/jfrog/jfrog-cli-core/v2/xray/scangraph" - xrayUtils "github.com/jfrog/jfrog-client-go/xray/services/utils" "os/exec" "path/filepath" "regexp" + "slices" "strings" + rtutils "github.com/jfrog/jfrog-cli-core/v2/artifactory/utils" + "github.com/jfrog/jfrog-cli-core/v2/xray/scangraph" + xrayUtils "github.com/jfrog/jfrog-client-go/xray/services/utils" + "golang.org/x/sync/errgroup" + "github.com/jfrog/gofrog/parallel" "github.com/jfrog/jfrog-cli-core/v2/common/spec" "github.com/jfrog/jfrog-cli-core/v2/utils/config" @@ -246,6 +250,25 @@ func (scanCmd *ScanCommand) Run() (err error) { scanResults.XrayVersion = xrayVersion scanResults.ScaResults = []xrutils.ScaScanResult{{XrayResults: flatResults}} + scanResults.ExtendedScanResults.EntitledForJas, err = xrutils.IsEntitledForJas(xrayManager, xrayVersion) + errGroup := new(errgroup.Group) + if scanResults.ExtendedScanResults.EntitledForJas { + // Download (if needed) the analyzer manager in a background routine. + errGroup.Go(rtutils.DownloadAnalyzerManagerIfNeeded) + } + // Wait for the Download of the AnalyzerManager to complete. + if err = errGroup.Wait(); err != nil { + err = errors.New("failed while trying to get Analyzer Manager: " + err.Error()) + } + + if scanResults.ExtendedScanResults.EntitledForJas { + cveList := cveListFromVulnerabilities(flatResults) + multiScanId := "" // Also empty for audit + thirdPartyApplicabilityScan := false + workingDirs := []string{(*(*scanCmd).spec).Files[0].Pattern} + scanResults.JasError = runJasScannersAndSetResults(scanResults, cveList, scanCmd.serverDetails, workingDirs, scanCmd.progress, multiScanId, thirdPartyApplicabilityScan) + } + if err = xrutils.NewResultsWriter(scanResults). SetOutputFormat(scanCmd.outputFormat). SetIncludeVulnerabilities(scanCmd.includeVulnerabilities). @@ -450,3 +473,21 @@ func appendErrorSlice(scanErrors []formats.SimpleJsonError, errorsToAdd [][]form } return scanErrors } + +func cveListFromVulnerabilities(flatResults []services.ScanResponse) []string { + var cveList []string + var technologiesList []string + for _, result := range flatResults { + for _, vulnerability := range result.Vulnerabilities { + for _, cve := range vulnerability.Cves { + if !slices.Contains(cveList, cve.Id) && (cve.Id != "") { + cveList = append(cveList, cve.Id) + } + } + if !slices.Contains(technologiesList, vulnerability.Technology) && (vulnerability.Technology != "") { + cveList = append(technologiesList, vulnerability.Technology) + } + } + } + return cveList +}