Documentation ¶
Index ¶
- Constants
- Variables
- func CheckIfFailBuild(results []services.ScanResponse) bool
- func ConvertSummaryToString(results SecurityCommandsSummary) (summary string, err error)
- func ConvertXrayScanToSimpleJson(results *Results, isMultipleRoots, includeLicenses, simplifiedOutput bool, ...) (formats.SimpleJsonResults, error)
- func CreateRestsMockServer(testHandler restsTestHandler) *httptest.Server
- func CreateXscRestsMockServer(t *testing.T, testHandler restsTestHandler) (*httptest.Server, *config.ServerDetails, ...)
- func GenereateSarifReportFromResults(results *Results, isMultipleRoots, includeLicenses bool, ...) (report *sarif.Report, err error)
- func GetCurationCacheFolder() (string, error)
- func GetCurationCacheFolderByTech(tech techutils.Technology) (projectDir string, err error)
- func GetCurationPipCacheFolder() (string, error)
- func GetDependenciesGraph(projectDir string) (map[string][]string, error)
- func GetDependenciesList(projectDir string, errorFunc utils.HandleErrorFunc) (map[string]bool, error)
- func GetIssueIdentifier(cvesRow []formats.CveRow, issueId string) string
- func GetScaScanFileName(r *Results) string
- func GetScaSummaryCountString(summary formats.ScanScaResult, padding int) (content string)
- func GetScanSummaryString(summary formats.ScanSummaryResult, singleData bool) (content string)
- func GetSeveritySummaryCountString(summary formats.SummaryCount, padding int) (content string)
- func GetSummaryContentString(summary formats.SummaryCount, delimiter string, wrapWithBracket bool) (content string)
- func GetUniqueKey(vulnerableDependency, vulnerableVersion, xrayID string, fixVersionExist bool) string
- func GetViolatedLicenses(allowedLicenses []string, licenses []formats.LicenseRow) (violatedLicenses []formats.LicenseRow)
- func IsEmptyScanResponse(results []services.ScanResponse) bool
- func JSONMarshal(t interface{}) ([]byte, error)
- func MergeMaps(maps ...map[string]string) map[string]string
- func NewFailBuildError() error
- func PrepareIacs(iacs []*sarif.Run) []formats.SourceCodeRow
- func PrepareLicenses(licenses []services.License) ([]formats.LicenseRow, error)
- func PrepareSast(sasts []*sarif.Run) []formats.SourceCodeRow
- func PrepareSecrets(secrets []*sarif.Run) []formats.SourceCodeRow
- func PrepareViolations(violations []services.Violation, results *Results, ...) ([]formats.VulnerabilityOrViolationRow, []formats.LicenseRow, ...)
- func PrepareVulnerabilities(vulnerabilities []services.Vulnerability, results *Results, ...) ([]formats.VulnerabilityOrViolationRow, error)
- func PrintIacTable(iacs []*sarif.Run, entitledForIacScan bool) error
- func PrintJson(output interface{}) error
- func PrintLicensesTable(licenses []services.License, printExtended bool, scanType services.ScanType) error
- func PrintSarif(results *Results, isMultipleRoots, includeLicenses bool) error
- func PrintSastTable(sast []*sarif.Run, entitledForSastScan bool) error
- func PrintSecretsTable(secrets []*sarif.Run, entitledForSecretsScan bool) error
- func PrintViolationsTable(violations []services.Violation, results *Results, ...) error
- func PrintVulnerabilitiesTable(vulnerabilities []services.Vulnerability, results *Results, ...) error
- func RecordSecurityCommandOutput(content ScanCommandSummaryResult) (err error)
- func SecurityCommandsJobSummary() (js *commandsummary.CommandSummary, err error)
- func SplitComponentId(componentId string) (string, string, string)
- func SplitScanResults(results []*ScaScanResult) ([]services.Violation, []services.Vulnerability, []services.License)
- func ToCommandEnvVars(envVarsMap map[string]string) (converted []string)
- func ToEnvVarsMap(envVars []string) (converted map[string]string)
- func XscServer(t *testing.T, xscVersion string) (*httptest.Server, *config.ServerDetails)
- type AuditBasicParams
- func (abp *AuditBasicParams) AppendDependenciesForApplicabilityScan(directDependencies []string) *AuditBasicParams
- func (abp *AuditBasicParams) Args() []string
- func (abp *AuditBasicParams) DepsRepo() string
- func (abp *AuditBasicParams) DirectDependencies() *[]string
- func (abp *AuditBasicParams) ExcludeTestDependencies() bool
- func (abp *AuditBasicParams) Exclusions() []string
- func (abp *AuditBasicParams) IgnoreConfigFile() bool
- func (abp *AuditBasicParams) InsecureTls() bool
- func (abp *AuditBasicParams) InstallCommandArgs() []string
- func (abp *AuditBasicParams) InstallCommandName() string
- func (abp *AuditBasicParams) IsCurationCmd() bool
- func (abp *AuditBasicParams) IsMavenDepTreeInstalled() bool
- func (abp *AuditBasicParams) IsRecursiveScan() bool
- func (abp *AuditBasicParams) OutputFormat() format.OutputFormat
- func (abp *AuditBasicParams) PipRequirementsFile() string
- func (abp *AuditBasicParams) Progress() ioUtils.ProgressMgr
- func (abp *AuditBasicParams) ScansToPerform() []SubScanType
- func (abp *AuditBasicParams) ServerDetails() (*config.ServerDetails, error)
- func (abp *AuditBasicParams) SetConanProfile(file string) *AuditBasicParams
- func (abp *AuditBasicParams) SetDepsRepo(depsRepo string) *AuditBasicParams
- func (abp *AuditBasicParams) SetExcludeTestDependencies(excludeTestDependencies bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetExclusions(exclusions []string) *AuditBasicParams
- func (abp *AuditBasicParams) SetIgnoreConfigFile(ignoreConfigFile bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetInsecureTls(insecureTls bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetInstallCommandArgs(installCommandArgs []string) *AuditBasicParams
- func (abp *AuditBasicParams) SetInstallCommandName(installCommandName string) *AuditBasicParams
- func (abp *AuditBasicParams) SetIsCurationCmd(isCurationCmd bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetIsMavenDepTreeInstalled(isMavenDepTreeInstalled bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetIsRecursiveScan(isRecursiveScan bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetNpmScope(depType string) *AuditBasicParams
- func (abp *AuditBasicParams) SetOutputFormat(format format.OutputFormat) *AuditBasicParams
- func (abp *AuditBasicParams) SetPipRequirementsFile(requirementsFile string) *AuditBasicParams
- func (abp *AuditBasicParams) SetProgress(progress ioUtils.ProgressMgr)
- func (abp *AuditBasicParams) SetScansToPerform(scansToPerform []SubScanType) *AuditBasicParams
- func (abp *AuditBasicParams) SetServerDetails(serverDetails *config.ServerDetails) *AuditBasicParams
- func (abp *AuditBasicParams) SetTechnologies(technologies []string) *AuditBasicParams
- func (abp *AuditBasicParams) SetUseJas(useJas bool) *AuditBasicParams
- func (abp *AuditBasicParams) SetUseWrapper(useWrapper bool) *AuditBasicParams
- func (abp *AuditBasicParams) Technologies() []string
- func (abp *AuditBasicParams) UseJas() bool
- func (abp *AuditBasicParams) UseWrapper() bool
- type AuditNpmParams
- type AuditParams
- type ExtendedScanResults
- type IssueDetails
- type Results
- func (r *Results) CountScanResultsFindings() (total int)
- func (r *Results) GetScaScannedTechnologies() []techutils.Technology
- func (r *Results) GetScaScansXrayResults() (results []services.ScanResponse)
- func (r *Results) GetSummary() (summary formats.SummaryResults)
- func (r *Results) IsIssuesFound() bool
- func (r *Results) IsMultipleProject() bool
- func (r *Results) IsScaIssuesFound() bool
- type ResultsWriter
- func (rw *ResultsWriter) PrintScanResults() error
- func (rw *ResultsWriter) SetExtraMessages(messages []string) *ResultsWriter
- func (rw *ResultsWriter) SetIncludeLicenses(licenses bool) *ResultsWriter
- func (rw *ResultsWriter) SetIncludeVulnerabilities(includeVulnerabilities bool) *ResultsWriter
- func (rw *ResultsWriter) SetIsMultipleRootProject(isMultipleRootProject bool) *ResultsWriter
- func (rw *ResultsWriter) SetOutputFormat(f format.OutputFormat) *ResultsWriter
- func (rw *ResultsWriter) SetPrintExtendedTable(extendedTable bool) *ResultsWriter
- func (rw *ResultsWriter) SetScanType(scanType services.ScanType) *ResultsWriter
- func (rw *ResultsWriter) SetSimpleJsonError(jsonErrors []formats.SimpleJsonError) *ResultsWriter
- func (rw *ResultsWriter) SetSubScansPreformed(subScansPreformed []SubScanType) *ResultsWriter
- type ScaScanResult
- type ScanCommandSummaryResult
- type SecurityCommandsSummary
- type SecurityParallelRunner
- type SecuritySummarySection
- type SubScanType
Constants ¶
const ( JfrogCurationDirName = "curation" CurationsDir = "JFROG_CLI_CURATION_DIR" // #nosec G101 -- Not credentials. CurationSupportFlag = "JFROG_CLI_CURATION" )
const ( NodeModulesPattern = "**/*node_modules*/**" JfMsiEnvVariable = "JF_MSI" )
const (
BaseDocumentationURL = "https://docs.jfrog-applications.jfrog.io/jfrog-security-features/"
)
const MissingCveScore = "0"
const (
NpmPackageTypeIdentifier = "npm://"
)
const TestMsi = "27e175b8-e525-11ee-842b-7aa2c69b8f1f"
Variables ¶
var ( // Exclude pattern for files. DefaultJasExcludePatterns = []string{"**/.git/**", "**/*test*/**", "**/*venv*/**", NodeModulesPattern, "**/target/**"} // Exclude pattern for directories. DefaultScaExcludePatterns = []string{"*.git*", "*node_modules*", "*target*", "*venv*", "*test*"} )
Functions ¶
func CheckIfFailBuild ¶
func CheckIfFailBuild(results []services.ScanResponse) bool
func ConvertSummaryToString ¶ added in v1.2.0
func ConvertSummaryToString(results SecurityCommandsSummary) (summary string, err error)
func CreateRestsMockServer ¶ added in v1.1.0
Create mock server to test REST APIs. testHandler - The HTTP handler of the test
func CreateXscRestsMockServer ¶ added in v1.1.0
func CreateXscRestsMockServer(t *testing.T, testHandler restsTestHandler) (*httptest.Server, *config.ServerDetails, artifactory.ArtifactoryServicesManager)
func GetCurationCacheFolder ¶ added in v1.0.4
func GetCurationCacheFolderByTech ¶ added in v1.3.0
func GetCurationCacheFolderByTech(tech techutils.Technology) (projectDir string, err error)
func GetCurationPipCacheFolder ¶ added in v1.1.0
func GetDependenciesGraph ¶ added in v1.3.0
func GetDependenciesList ¶ added in v1.3.0
func GetScaScanFileName ¶ added in v1.6.0
func GetScaSummaryCountString ¶ added in v1.2.0
func GetScaSummaryCountString(summary formats.ScanScaResult, padding int) (content string)
func GetScanSummaryString ¶ added in v1.2.0
func GetScanSummaryString(summary formats.ScanSummaryResult, singleData bool) (content string)
func GetSeveritySummaryCountString ¶ added in v1.2.0
func GetSeveritySummaryCountString(summary formats.SummaryCount, padding int) (content string)
func GetSummaryContentString ¶ added in v1.2.0
func GetSummaryContentString(summary formats.SummaryCount, delimiter string, wrapWithBracket bool) (content string)
func GetUniqueKey ¶
func GetUniqueKey(vulnerableDependency, vulnerableVersion, xrayID string, fixVersionExist bool) string
GetUniqueKey returns a unique string key of format "vulnerableDependency:vulnerableVersion:xrayID:fixVersionExist"
func GetViolatedLicenses ¶
func GetViolatedLicenses(allowedLicenses []string, licenses []formats.LicenseRow) (violatedLicenses []formats.LicenseRow)
func IsEmptyScanResponse ¶
func IsEmptyScanResponse(results []services.ScanResponse) bool
func JSONMarshal ¶ added in v1.6.4
func MergeMaps ¶ added in v1.5.0
Merge multiple maps into one, the last map will override the previous ones
func NewFailBuildError ¶
func NewFailBuildError() error
func PrepareIacs ¶
func PrepareIacs(iacs []*sarif.Run) []formats.SourceCodeRow
Prepare iacs for all non-table formats (without style or emoji)
func PrepareLicenses ¶
func PrepareLicenses(licenses []services.License) ([]formats.LicenseRow, error)
func PrepareSast ¶
func PrepareSast(sasts []*sarif.Run) []formats.SourceCodeRow
func PrepareSecrets ¶
func PrepareSecrets(secrets []*sarif.Run) []formats.SourceCodeRow
Prepare secrets for all non-table formats (without style or emoji)
func PrepareViolations ¶
func PrepareViolations(violations []services.Violation, results *Results, multipleRoots, simplifiedOutput bool) ([]formats.VulnerabilityOrViolationRow, []formats.LicenseRow, []formats.OperationalRiskViolationRow, error)
Prepare violations for all non-table formats (without style or emoji)
func PrepareVulnerabilities ¶
func PrepareVulnerabilities(vulnerabilities []services.Vulnerability, results *Results, multipleRoots, simplifiedOutput bool) ([]formats.VulnerabilityOrViolationRow, error)
Prepare vulnerabilities for all non-table formats (without style or emoji)
func PrintLicensesTable ¶
func PrintLicensesTable(licenses []services.License, printExtended bool, scanType services.ScanType) error
PrintLicensesTable prints the licenses in a table. Set multipleRoots to true in case the given licenses array contains (or may contain) results of several projects or files (like in binary scan). In case multipleRoots is true, the field Component will show the root of each impact path, otherwise it will show the root's child. Set printExtended to true to print fields with 'extended' tag. If the scan argument is set to true, print the scan tables.
func PrintSarif ¶
func PrintSecretsTable ¶
func PrintViolationsTable ¶
func PrintViolationsTable(violations []services.Violation, results *Results, multipleRoots, printExtended bool, scanType services.ScanType) error
PrintViolationsTable prints the violations in 4 tables: security violations, license compliance violations, operational risk violations and ignore rule URLs. Set multipleRoots to true in case the given violations array contains (or may contain) results of several projects or files (like in binary scan). In case multipleRoots is true, the field Component will show the root of each impact path, otherwise it will show the root's child. In case one (or more) of the violations contains the field FailBuild set to true, CliError with exit code 3 will be returned. Set printExtended to true to print fields with 'extended' tag. If the scan argument is set to true, print the scan tables.
func PrintVulnerabilitiesTable ¶
func PrintVulnerabilitiesTable(vulnerabilities []services.Vulnerability, results *Results, multipleRoots, printExtended bool, scanType services.ScanType) error
PrintVulnerabilitiesTable prints the vulnerabilities in a table. Set multipleRoots to true in case the given vulnerabilities array contains (or may contain) results of several projects or files (like in binary scan). In case multipleRoots is true, the field Component will show the root of each impact path, otherwise it will show the root's child. Set printExtended to true to print fields with 'extended' tag. If the scan argument is set to true, print the scan tables.
func RecordSecurityCommandOutput ¶ added in v1.2.0
func RecordSecurityCommandOutput(content ScanCommandSummaryResult) (err error)
Record the security command output
func SecurityCommandsJobSummary ¶ added in v1.2.0
func SecurityCommandsJobSummary() (js *commandsummary.CommandSummary, err error)
Manage the job summary for security commands
func SplitComponentId ¶
SplitComponentId splits a Xray component ID to the component name, version and package type. In case componentId doesn't contain a version, the returned version will be an empty string. In case componentId's format is invalid, it will be returned as the component name and empty strings will be returned instead of the version and the package type. Examples:
- componentId: "gav://antparent:ant:1.6.5" Returned values: Component name: "antparent:ant" Component version: "1.6.5" Package type: "Maven"
- componentId: "generic://sha256:244fd47e07d1004f0aed9c156aa09083c82bf8944eceb67c946ff7430510a77b/foo.jar" Returned values: Component name: "foo.jar" Component version: "" Package type: "Generic"
- componentId: "invalid-comp-id" Returned values: Component name: "invalid-comp-id" Component version: "" Package type: ""
func SplitScanResults ¶
func SplitScanResults(results []*ScaScanResult) ([]services.Violation, []services.Vulnerability, []services.License)
Splits scan responses into aggregated lists of violations, vulnerabilities and licenses.
func ToCommandEnvVars ¶ added in v1.5.0
map[string]string to []string (key=value format)
func ToEnvVarsMap ¶ added in v1.5.0
[]string (key=value format) to map[string]string
Types ¶
type AuditBasicParams ¶
type AuditBasicParams struct {
// contains filtered or unexported fields
}
func (*AuditBasicParams) AppendDependenciesForApplicabilityScan ¶
func (abp *AuditBasicParams) AppendDependenciesForApplicabilityScan(directDependencies []string) *AuditBasicParams
func (*AuditBasicParams) Args ¶
func (abp *AuditBasicParams) Args() []string
func (*AuditBasicParams) DepsRepo ¶
func (abp *AuditBasicParams) DepsRepo() string
func (*AuditBasicParams) DirectDependencies ¶
func (abp *AuditBasicParams) DirectDependencies() *[]string
func (*AuditBasicParams) ExcludeTestDependencies ¶
func (abp *AuditBasicParams) ExcludeTestDependencies() bool
func (*AuditBasicParams) Exclusions ¶ added in v1.0.4
func (abp *AuditBasicParams) Exclusions() []string
func (*AuditBasicParams) IgnoreConfigFile ¶
func (abp *AuditBasicParams) IgnoreConfigFile() bool
func (*AuditBasicParams) InsecureTls ¶
func (abp *AuditBasicParams) InsecureTls() bool
func (*AuditBasicParams) InstallCommandArgs ¶
func (abp *AuditBasicParams) InstallCommandArgs() []string
func (*AuditBasicParams) InstallCommandName ¶
func (abp *AuditBasicParams) InstallCommandName() string
func (*AuditBasicParams) IsCurationCmd ¶ added in v1.0.2
func (abp *AuditBasicParams) IsCurationCmd() bool
func (*AuditBasicParams) IsMavenDepTreeInstalled ¶
func (abp *AuditBasicParams) IsMavenDepTreeInstalled() bool
func (*AuditBasicParams) IsRecursiveScan ¶ added in v1.0.4
func (abp *AuditBasicParams) IsRecursiveScan() bool
func (*AuditBasicParams) OutputFormat ¶
func (abp *AuditBasicParams) OutputFormat() format.OutputFormat
func (*AuditBasicParams) PipRequirementsFile ¶
func (abp *AuditBasicParams) PipRequirementsFile() string
func (*AuditBasicParams) Progress ¶
func (abp *AuditBasicParams) Progress() ioUtils.ProgressMgr
func (*AuditBasicParams) ScansToPerform ¶ added in v1.4.0
func (abp *AuditBasicParams) ScansToPerform() []SubScanType
func (*AuditBasicParams) ServerDetails ¶
func (abp *AuditBasicParams) ServerDetails() (*config.ServerDetails, error)
func (*AuditBasicParams) SetConanProfile ¶ added in v1.6.5
func (abp *AuditBasicParams) SetConanProfile(file string) *AuditBasicParams
func (*AuditBasicParams) SetDepsRepo ¶
func (abp *AuditBasicParams) SetDepsRepo(depsRepo string) *AuditBasicParams
func (*AuditBasicParams) SetExcludeTestDependencies ¶
func (abp *AuditBasicParams) SetExcludeTestDependencies(excludeTestDependencies bool) *AuditBasicParams
func (*AuditBasicParams) SetExclusions ¶ added in v1.0.4
func (abp *AuditBasicParams) SetExclusions(exclusions []string) *AuditBasicParams
func (*AuditBasicParams) SetIgnoreConfigFile ¶
func (abp *AuditBasicParams) SetIgnoreConfigFile(ignoreConfigFile bool) *AuditBasicParams
func (*AuditBasicParams) SetInsecureTls ¶
func (abp *AuditBasicParams) SetInsecureTls(insecureTls bool) *AuditBasicParams
func (*AuditBasicParams) SetInstallCommandArgs ¶
func (abp *AuditBasicParams) SetInstallCommandArgs(installCommandArgs []string) *AuditBasicParams
func (*AuditBasicParams) SetInstallCommandName ¶
func (abp *AuditBasicParams) SetInstallCommandName(installCommandName string) *AuditBasicParams
func (*AuditBasicParams) SetIsCurationCmd ¶ added in v1.0.2
func (abp *AuditBasicParams) SetIsCurationCmd(isCurationCmd bool) *AuditBasicParams
func (*AuditBasicParams) SetIsMavenDepTreeInstalled ¶
func (abp *AuditBasicParams) SetIsMavenDepTreeInstalled(isMavenDepTreeInstalled bool) *AuditBasicParams
func (*AuditBasicParams) SetIsRecursiveScan ¶ added in v1.0.4
func (abp *AuditBasicParams) SetIsRecursiveScan(isRecursiveScan bool) *AuditBasicParams
func (*AuditBasicParams) SetNpmScope ¶
func (abp *AuditBasicParams) SetNpmScope(depType string) *AuditBasicParams
func (*AuditBasicParams) SetOutputFormat ¶
func (abp *AuditBasicParams) SetOutputFormat(format format.OutputFormat) *AuditBasicParams
func (*AuditBasicParams) SetPipRequirementsFile ¶
func (abp *AuditBasicParams) SetPipRequirementsFile(requirementsFile string) *AuditBasicParams
func (*AuditBasicParams) SetProgress ¶
func (abp *AuditBasicParams) SetProgress(progress ioUtils.ProgressMgr)
func (*AuditBasicParams) SetScansToPerform ¶ added in v1.4.0
func (abp *AuditBasicParams) SetScansToPerform(scansToPerform []SubScanType) *AuditBasicParams
func (*AuditBasicParams) SetServerDetails ¶
func (abp *AuditBasicParams) SetServerDetails(serverDetails *config.ServerDetails) *AuditBasicParams
func (*AuditBasicParams) SetTechnologies ¶
func (abp *AuditBasicParams) SetTechnologies(technologies []string) *AuditBasicParams
func (*AuditBasicParams) SetUseJas ¶ added in v1.4.0
func (abp *AuditBasicParams) SetUseJas(useJas bool) *AuditBasicParams
func (*AuditBasicParams) SetUseWrapper ¶
func (abp *AuditBasicParams) SetUseWrapper(useWrapper bool) *AuditBasicParams
func (*AuditBasicParams) Technologies ¶
func (abp *AuditBasicParams) Technologies() []string
func (*AuditBasicParams) UseJas ¶ added in v1.4.0
func (abp *AuditBasicParams) UseJas() bool
func (*AuditBasicParams) UseWrapper ¶
func (abp *AuditBasicParams) UseWrapper() bool
type AuditNpmParams ¶
type AuditNpmParams struct { AuditParams // contains filtered or unexported fields }
func (AuditNpmParams) NpmIgnoreNodeModules ¶
func (anp AuditNpmParams) NpmIgnoreNodeModules() bool
func (AuditNpmParams) NpmOverwritePackageLock ¶
func (anp AuditNpmParams) NpmOverwritePackageLock() bool
func (AuditNpmParams) SetNpmIgnoreNodeModules ¶
func (anp AuditNpmParams) SetNpmIgnoreNodeModules(ignoreNpmNodeModules bool) AuditNpmParams
func (AuditNpmParams) SetNpmOverwritePackageLock ¶
func (anp AuditNpmParams) SetNpmOverwritePackageLock(overwritePackageLock bool) AuditNpmParams
type AuditParams ¶
type AuditParams interface { DirectDependencies() *[]string AppendDependenciesForApplicabilityScan(directDependencies []string) *AuditBasicParams ServerDetails() (*config.ServerDetails, error) SetServerDetails(serverDetails *config.ServerDetails) *AuditBasicParams PipRequirementsFile() string SetPipRequirementsFile(requirementsFile string) *AuditBasicParams ExcludeTestDependencies() bool SetExcludeTestDependencies(excludeTestDependencies bool) *AuditBasicParams UseWrapper() bool SetUseWrapper(useWrapper bool) *AuditBasicParams InsecureTls() bool SetInsecureTls(insecureTls bool) *AuditBasicParams Technologies() []string SetTechnologies(technologies []string) *AuditBasicParams Progress() ioUtils.ProgressMgr SetProgress(progress ioUtils.ProgressMgr) Args() []string InstallCommandName() string InstallCommandArgs() []string SetNpmScope(depType string) *AuditBasicParams OutputFormat() format.OutputFormat DepsRepo() string SetDepsRepo(depsRepo string) *AuditBasicParams IgnoreConfigFile() bool SetIgnoreConfigFile(ignoreConfigFile bool) *AuditBasicParams IsMavenDepTreeInstalled() bool SetIsMavenDepTreeInstalled(isMavenDepTreeInstalled bool) *AuditBasicParams IsCurationCmd() bool SetIsCurationCmd(bool) *AuditBasicParams SetExclusions(exclusions []string) *AuditBasicParams Exclusions() []string SetIsRecursiveScan(isRecursiveScan bool) *AuditBasicParams IsRecursiveScan() bool }
type ExtendedScanResults ¶
type ExtendedScanResults struct { ApplicabilityScanResults []*sarif.Run SecretsScanResults []*sarif.Run IacScanResults []*sarif.Run SastScanResults []*sarif.Run EntitledForJas bool }
func (*ExtendedScanResults) GetResultsForTarget ¶ added in v1.2.0
func (e *ExtendedScanResults) GetResultsForTarget(target string) (result *ExtendedScanResults)
func (*ExtendedScanResults) IsIssuesFound ¶
func (e *ExtendedScanResults) IsIssuesFound() bool
type IssueDetails ¶ added in v1.3.0
type Results ¶
type Results struct { ScaResults []*ScaScanResult XrayVersion string ScansErr error ExtendedScanResults *ExtendedScanResults MultiScanId string }
func NewAuditResults ¶
func NewAuditResults() *Results
func (*Results) CountScanResultsFindings ¶ added in v1.1.0
Counts the total number of unique findings in the provided results. A unique SCA finding is identified by a unique pair of vulnerability's/violation's issueId and component id or by a result returned from one of JAS scans.
func (*Results) GetScaScannedTechnologies ¶
func (r *Results) GetScaScannedTechnologies() []techutils.Technology
func (*Results) GetScaScansXrayResults ¶
func (r *Results) GetScaScansXrayResults() (results []services.ScanResponse)
func (*Results) GetSummary ¶ added in v1.2.0
func (r *Results) GetSummary() (summary formats.SummaryResults)
func (*Results) IsIssuesFound ¶
func (*Results) IsMultipleProject ¶
func (*Results) IsScaIssuesFound ¶
type ResultsWriter ¶
type ResultsWriter struct {
// contains filtered or unexported fields
}
func NewResultsWriter ¶
func NewResultsWriter(scanResults *Results) *ResultsWriter
func (*ResultsWriter) PrintScanResults ¶
func (rw *ResultsWriter) PrintScanResults() error
PrintScanResults prints the scan results in the specified format. Note that errors are printed only with SimpleJson format.
func (*ResultsWriter) SetExtraMessages ¶
func (rw *ResultsWriter) SetExtraMessages(messages []string) *ResultsWriter
func (*ResultsWriter) SetIncludeLicenses ¶
func (rw *ResultsWriter) SetIncludeLicenses(licenses bool) *ResultsWriter
func (*ResultsWriter) SetIncludeVulnerabilities ¶
func (rw *ResultsWriter) SetIncludeVulnerabilities(includeVulnerabilities bool) *ResultsWriter
func (*ResultsWriter) SetIsMultipleRootProject ¶
func (rw *ResultsWriter) SetIsMultipleRootProject(isMultipleRootProject bool) *ResultsWriter
func (*ResultsWriter) SetOutputFormat ¶
func (rw *ResultsWriter) SetOutputFormat(f format.OutputFormat) *ResultsWriter
func (*ResultsWriter) SetPrintExtendedTable ¶
func (rw *ResultsWriter) SetPrintExtendedTable(extendedTable bool) *ResultsWriter
func (*ResultsWriter) SetScanType ¶
func (rw *ResultsWriter) SetScanType(scanType services.ScanType) *ResultsWriter
func (*ResultsWriter) SetSimpleJsonError ¶
func (rw *ResultsWriter) SetSimpleJsonError(jsonErrors []formats.SimpleJsonError) *ResultsWriter
func (*ResultsWriter) SetSubScansPreformed ¶ added in v1.4.0
func (rw *ResultsWriter) SetSubScansPreformed(subScansPreformed []SubScanType) *ResultsWriter
type ScaScanResult ¶
type ScaScanResult struct { // Could be working directory (audit), file path (binary scan) or build name+number (build scan) Target string `json:"Target"` Technology techutils.Technology `json:"Technology,omitempty"` XrayResults []services.ScanResponse `json:"XrayResults,omitempty"` Descriptors []string `json:"Descriptors,omitempty"` IsMultipleRootProject *bool `json:"IsMultipleRootProject,omitempty"` }
func (ScaScanResult) HasInformation ¶
func (s ScaScanResult) HasInformation() bool
type ScanCommandSummaryResult ¶ added in v1.2.0
type ScanCommandSummaryResult struct { Section SecuritySummarySection `json:"section"` WorkingDirectory string `json:"workingDirectory"` Results formats.SummaryResults `json:"results"` }
type SecurityCommandsSummary ¶ added in v1.2.0
type SecurityCommandsSummary struct { BuildScanCommands []formats.SummaryResults `json:"buildScanCommands"` ScanCommands []formats.SummaryResults `json:"scanCommands"` AuditCommands []formats.SummaryResults `json:"auditCommands"` CurationCommands []formats.SummaryResults `json:"curationCommands"` }
func (*SecurityCommandsSummary) GenerateMarkdownFromFiles ¶ added in v1.2.0
func (scs *SecurityCommandsSummary) GenerateMarkdownFromFiles(dataFilePaths []string) (markdown string, err error)
func (*SecurityCommandsSummary) GetOrderedSectionsWithContent ¶ added in v1.2.0
func (scs *SecurityCommandsSummary) GetOrderedSectionsWithContent() (sections []SecuritySummarySection)
type SecurityParallelRunner ¶ added in v1.4.0
type SecurityParallelRunner struct { Runner parallel.Runner ErrorsQueue chan error ResultsMu sync.Mutex ScaScansWg sync.WaitGroup // Verify that the sca scan routines are done before running contextual scan JasScannersWg sync.WaitGroup // Verify that all scanners routines are done before cleaning temp dir JasWg sync.WaitGroup // Verify that downloading analyzer manager and running all scanners are done ErrWg sync.WaitGroup // Verify that all errors are handled before finishing the audit func }
func CreateSecurityParallelRunner ¶ added in v1.4.0
func CreateSecurityParallelRunner(numOfParallelScans int) *SecurityParallelRunner
func NewSecurityParallelRunner ¶ added in v1.4.0
func NewSecurityParallelRunner(numOfParallelScans int) SecurityParallelRunner
func (*SecurityParallelRunner) AddErrorToChan ¶ added in v1.4.0
func (spr *SecurityParallelRunner) AddErrorToChan(err error)
type SecuritySummarySection ¶ added in v1.2.0
type SecuritySummarySection string
const ( Build SecuritySummarySection = "Builds" Binary SecuritySummarySection = "Artifacts" Modules SecuritySummarySection = "Modules" Curation SecuritySummarySection = "Curation" )
type SubScanType ¶ added in v1.4.0
type SubScanType string
const ( ContextualAnalysisScan SubScanType = "contextual_analysis" ScaScan SubScanType = "sca" IacScan SubScanType = "iac" SastScan SubScanType = "sast" SecretsScan SubScanType = "secrets" )
func GetAllSupportedScans ¶ added in v1.4.0
func GetAllSupportedScans() []SubScanType
func (SubScanType) String ¶ added in v1.4.0
func (s SubScanType) String() string