Services Scan Support #772
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package services | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "time" | ||
|
|
||
| jfrogappsconfig "github.com/jfrog/jfrog-apps-config/go" | ||
| "github.com/jfrog/jfrog-cli-security/jas" | ||
| "github.com/jfrog/jfrog-cli-security/utils" | ||
| "github.com/jfrog/jfrog-cli-security/utils/formats/sarifutils" | ||
| "github.com/jfrog/jfrog-cli-security/utils/jasutils" | ||
| "github.com/jfrog/jfrog-client-go/utils/log" | ||
| "github.com/owenrumney/go-sarif/v3/pkg/report/v210/sarif" | ||
| ) | ||
|
|
||
| const ( | ||
| servicesScannerType = "services-scan" | ||
| servicesScanCommand = "svc" | ||
| servicesDocsUrlSuffix = "services-scans" | ||
|
Collaborator
There was a problem hiding this comment. No such URL as (i.e |
||
| ) | ||
|
|
||
| type ServicesScanManager struct { | ||
| scanner *jas.JasScanner | ||
|
|
||
| resultsToCompareFileName string | ||
| configFileName string | ||
| resultsFileName string | ||
| } | ||
|
Comment on lines
+22
to
+28
Collaborator
There was a problem hiding this comment. Adjust the file to have 2 ways to run (similar to the other scanners)
see |
||
|
|
||
| func RunServicesScan(scanner *jas.JasScanner, module jfrogappsconfig.Module, targetCount, threadId int, resultsToCompare ...*sarif.Run) (vulnerabilitiesResults []*sarif.Run, violationsResults []*sarif.Run, err error) { | ||
| var scannerTempDir string | ||
| if scannerTempDir, err = jas.CreateScannerTempDirectory(scanner, jasutils.Services.String(), threadId); err != nil { | ||
| return | ||
| } | ||
| servicesScanManager, err := newServicesScanManager(scanner, scannerTempDir, resultsToCompare...) | ||
| if err != nil { | ||
| return | ||
| } | ||
| startTime := time.Now() | ||
| log.Info(jas.GetStartJasScanLog(utils.ServicesScan, threadId, &module, targetCount)) | ||
| if vulnerabilitiesResults, violationsResults, err = servicesScanManager.scanner.Run(servicesScanManager, results.ScanTarget{Module: &module}); err != nil { | ||
|
Check failure on line 41 in jas/services/servicesscanner.go
|
||
| return | ||
| } | ||
| log.Info(utils.GetScanFindingsLog(utils.ServicesScan, sarifutils.GetResultsLocationCount(vulnerabilitiesResults...), startTime, threadId)) | ||
| return | ||
| } | ||
|
|
||
| func newServicesScanManager(scanner *jas.JasScanner, scannerTempDir string, resultsToCompare ...*sarif.Run) (manager *ServicesScanManager, err error) { | ||
| manager = &ServicesScanManager{ | ||
| scanner: scanner, | ||
| configFileName: filepath.Join(scannerTempDir, "config.yaml"), | ||
| resultsFileName: filepath.Join(scannerTempDir, "results.sarif"), | ||
| } | ||
| if len(resultsToCompare) == 0 { | ||
| return | ||
| } | ||
| log.Debug("Diff mode - Services results to compare provided") | ||
| manager.resultsToCompareFileName = filepath.Join(scannerTempDir, "target.sarif") | ||
| if err = jas.SaveScanResultsToCompareAsReport(manager.resultsToCompareFileName, resultsToCompare...); err != nil { | ||
| return | ||
| } | ||
|
Comment on lines
+57
to
+61
Collaborator
There was a problem hiding this comment. Make sure Diff logic is implemented in the AM (so Frogbot Scan PR can show only added issues for services). |
||
| return | ||
| } | ||
|
|
||
| func (ssm *ServicesScanManager) Run(module jfrogappsconfig.Module) (vulnerabilitiesSarifRuns []*sarif.Run, violationsSarifRuns []*sarif.Run, err error) { | ||
| if err = ssm.createConfigFile(module, ssm.scanner.ScannersExclusions.ServicesExcludePatterns, ssm.scanner.Exclusions...); err != nil { | ||
|
Check failure on line 66 in jas/services/servicesscanner.go
|
||
| return | ||
| } | ||
| if err = ssm.runAnalyzerManager(); err != nil { | ||
| return | ||
| } | ||
| return jas.ReadJasScanRunsFromFile(ssm.resultsFileName, module.SourceRoot, servicesDocsUrlSuffix, ssm.scanner.MinSeverity) | ||
|
Check failure on line 72 in jas/services/servicesscanner.go
|
||
| } | ||
|
|
||
| type servicesScanConfig struct { | ||
| Scans []servicesScanConfiguration `yaml:"scans"` | ||
| } | ||
|
|
||
| type servicesScanConfiguration struct { | ||
| Roots []string `yaml:"roots"` | ||
| Output string `yaml:"output"` | ||
| PathToResultsToCompare string `yaml:"target-result-file,omitempty"` | ||
| Type string `yaml:"type"` | ||
| SkippedDirs []string `yaml:"skipped-folders"` | ||
| } | ||
|
|
||
| func (ssm *ServicesScanManager) createConfigFile(module jfrogappsconfig.Module, centralConfigExclusions []string, exclusions ...string) error { | ||
| roots, err := jas.GetSourceRoots(module, nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| configFileContent := servicesScanConfig{ | ||
| Scans: []servicesScanConfiguration{ | ||
| { | ||
| Roots: roots, | ||
| Output: ssm.resultsFileName, | ||
| PathToResultsToCompare: ssm.resultsToCompareFileName, | ||
| Type: servicesScannerType, | ||
| SkippedDirs: jas.GetExcludePatterns(module, nil, centralConfigExclusions, exclusions...), | ||
|
Check failure on line 99 in jas/services/servicesscanner.go
|
||
| }, | ||
| }, | ||
| } | ||
| return jas.CreateScannersConfigFile(ssm.configFileName, configFileContent, jasutils.Services) | ||
| } | ||
|
|
||
| func (ssm *ServicesScanManager) runAnalyzerManager() error { | ||
| return ssm.scanner.AnalyzerManager.Exec(ssm.configFileName, servicesScanCommand, filepath.Dir(ssm.scanner.AnalyzerManager.AnalyzerManagerFullPath), ssm.scanner.ServerDetails, ssm.scanner.EnvVars) | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how is Sbom related?