audit

package
v1.24.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2025 License: Apache-2.0 Imports: 41 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateAuditResultsContext added in v1.14.0 

func CreateAuditResultsContext(serverDetails *config.ServerDetails, xrayVersion string, watches []string, artifactoryRepoPath, projectKey, gitRepoHttpsCloneUrl string, includeVulnerabilities, includeLicenses, includeSbom bool) (context results.ResultContext)

Create a results context based on the provided parameters. resolves conflicts between the parameters based on the retrieved platform watches.

func OutputResultsAndCmdError added in v1.23.0 

func OutputResultsAndCmdError(auditResults *results.SecurityCommandResults, outputWriter *output.ResultsWriter, failBuild bool) (err error)

func RunAudit 

func RunAudit(auditParams *AuditParams) (cmdResults *results.SecurityCommandResults)

Runs an audit scan based on the provided auditParams. Returns an audit Results object containing all the scan results. If the current server is entitled for JAS, the advanced security results will be included in the scan results.

Types

type AuditBasicParams added in v1.21.5 

type AuditBasicParams struct {
	// contains filtered or unexported fields
}

func (*AuditBasicParams) AllowPartialResults added in v1.21.5 

func (abp *AuditBasicParams) AllowPartialResults() bool

func (*AuditBasicParams) AppendDependenciesForApplicabilityScan added in v1.21.5 

func (abp *AuditBasicParams) AppendDependenciesForApplicabilityScan(directDependencies []string) *AuditBasicParams

func (*AuditBasicParams) Args added in v1.21.5 

func (abp *AuditBasicParams) Args() []string

func (*AuditBasicParams) DepsRepo added in v1.21.5 

func (abp *AuditBasicParams) DepsRepo() string

func (*AuditBasicParams) DirectDependencies added in v1.21.5 

func (abp *AuditBasicParams) DirectDependencies() *[]string

func (*AuditBasicParams) ExcludeTestDependencies added in v1.21.5 

func (abp *AuditBasicParams) ExcludeTestDependencies() bool

func (*AuditBasicParams) Exclusions added in v1.21.5 

func (abp *AuditBasicParams) Exclusions() []string

func (*AuditBasicParams) GetConfigProfile added in v1.21.5 

func (abp *AuditBasicParams) GetConfigProfile() *xscservices.ConfigProfile

func (*AuditBasicParams) GetXrayVersion added in v1.21.5 

func (abp *AuditBasicParams) GetXrayVersion() string

func (*AuditBasicParams) GetXscVersion added in v1.21.5 

func (abp *AuditBasicParams) GetXscVersion() string

func (*AuditBasicParams) IgnoreConfigFile added in v1.21.5 

func (abp *AuditBasicParams) IgnoreConfigFile() bool

func (*AuditBasicParams) InsecureTls added in v1.21.5 

func (abp *AuditBasicParams) InsecureTls() bool

func (*AuditBasicParams) InstallCommandArgs added in v1.21.5 

func (abp *AuditBasicParams) InstallCommandArgs() []string

func (*AuditBasicParams) InstallCommandName added in v1.21.5 

func (abp *AuditBasicParams) InstallCommandName() string

func (*AuditBasicParams) IsCurationCmd added in v1.21.5 

func (abp *AuditBasicParams) IsCurationCmd() bool

func (*AuditBasicParams) IsGradleDepTreeInstalled added in v1.21.5 

func (abp *AuditBasicParams) IsGradleDepTreeInstalled() bool

func (*AuditBasicParams) IsMavenDepTreeInstalled added in v1.21.5 

func (abp *AuditBasicParams) IsMavenDepTreeInstalled() bool

func (*AuditBasicParams) IsRecursiveScan added in v1.21.5 

func (abp *AuditBasicParams) IsRecursiveScan() bool

func (*AuditBasicParams) MaxTreeDepth added in v1.21.5 

func (abp *AuditBasicParams) MaxTreeDepth() string

func (*AuditBasicParams) OutputFormat added in v1.21.5 

func (abp *AuditBasicParams) OutputFormat() format.OutputFormat

func (*AuditBasicParams) PipRequirementsFile added in v1.21.5 

func (abp *AuditBasicParams) PipRequirementsFile() string

func (*AuditBasicParams) Progress added in v1.21.5 

func (abp *AuditBasicParams) Progress() ioUtils.ProgressMgr

func (*AuditBasicParams) ScansToPerform added in v1.21.5 

func (abp *AuditBasicParams) ScansToPerform() []utils.SubScanType

func (*AuditBasicParams) ServerDetails added in v1.21.5 

func (abp *AuditBasicParams) ServerDetails() (*config.ServerDetails, error)

func (*AuditBasicParams) SetAllowPartialResults added in v1.21.5 

func (abp *AuditBasicParams) SetAllowPartialResults(allowPartialResults bool) *AuditBasicParams

func (*AuditBasicParams) SetConanProfile added in v1.21.5 

func (abp *AuditBasicParams) SetConanProfile(file string) *AuditBasicParams

func (*AuditBasicParams) SetConfigProfile added in v1.21.5 

func (abp *AuditBasicParams) SetConfigProfile(profile *xscservices.ConfigProfile) *AuditBasicParams

func (*AuditBasicParams) SetDepsRepo added in v1.21.5 

func (abp *AuditBasicParams) SetDepsRepo(depsRepo string) *AuditBasicParams

func (*AuditBasicParams) SetExcludeTestDependencies added in v1.21.5 

func (abp *AuditBasicParams) SetExcludeTestDependencies(excludeTestDependencies bool) *AuditBasicParams

func (*AuditBasicParams) SetExclusions added in v1.21.5 

func (abp *AuditBasicParams) SetExclusions(exclusions []string) *AuditBasicParams

func (*AuditBasicParams) SetIgnoreConfigFile added in v1.21.5 

func (abp *AuditBasicParams) SetIgnoreConfigFile(ignoreConfigFile bool) *AuditBasicParams

func (*AuditBasicParams) SetInsecureTls added in v1.21.5 

func (abp *AuditBasicParams) SetInsecureTls(insecureTls bool) *AuditBasicParams

func (*AuditBasicParams) SetInstallCommandArgs added in v1.21.5 

func (abp *AuditBasicParams) SetInstallCommandArgs(installCommandArgs []string) *AuditBasicParams

func (*AuditBasicParams) SetInstallCommandName added in v1.21.5 

func (abp *AuditBasicParams) SetInstallCommandName(installCommandName string) *AuditBasicParams

func (*AuditBasicParams) SetIsCurationCmd added in v1.21.5 

func (abp *AuditBasicParams) SetIsCurationCmd(isCurationCmd bool) *AuditBasicParams

func (*AuditBasicParams) SetIsGradleDepTreeInstalled added in v1.21.5 

func (abp *AuditBasicParams) SetIsGradleDepTreeInstalled(isGradleDepTreeInstalled bool) *AuditBasicParams

func (*AuditBasicParams) SetIsMavenDepTreeInstalled added in v1.21.5 

func (abp *AuditBasicParams) SetIsMavenDepTreeInstalled(isMavenDepTreeInstalled bool) *AuditBasicParams

func (*AuditBasicParams) SetIsRecursiveScan added in v1.21.5 

func (abp *AuditBasicParams) SetIsRecursiveScan(isRecursiveScan bool) *AuditBasicParams

func (*AuditBasicParams) SetMaxTreeDepth added in v1.21.5 

func (abp *AuditBasicParams) SetMaxTreeDepth(maxTreeDepth string) *AuditBasicParams

func (*AuditBasicParams) SetNpmScope added in v1.21.5 

func (abp *AuditBasicParams) SetNpmScope(depType string) *AuditBasicParams

func (*AuditBasicParams) SetOutputFormat added in v1.21.5 

func (abp *AuditBasicParams) SetOutputFormat(format format.OutputFormat) *AuditBasicParams

func (*AuditBasicParams) SetPipRequirementsFile added in v1.21.5 

func (abp *AuditBasicParams) SetPipRequirementsFile(requirementsFile string) *AuditBasicParams

func (*AuditBasicParams) SetProgress added in v1.21.5 

func (abp *AuditBasicParams) SetProgress(progress ioUtils.ProgressMgr)

func (*AuditBasicParams) SetScansToPerform added in v1.21.5 

func (abp *AuditBasicParams) SetScansToPerform(scansToPerform []utils.SubScanType) *AuditBasicParams

func (*AuditBasicParams) SetServerDetails added in v1.21.5 

func (abp *AuditBasicParams) SetServerDetails(serverDetails *config.ServerDetails) *AuditBasicParams

func (*AuditBasicParams) SetSkipAutoInstall added in v1.21.5 

func (abp *AuditBasicParams) SetSkipAutoInstall(skipAutoInstall bool) *AuditBasicParams

func (*AuditBasicParams) SetSolutionFilePath added in v1.23.0 

func (abp *AuditBasicParams) SetSolutionFilePath(solutionFilePath string) *AuditBasicParams

func (*AuditBasicParams) SetTechnologies added in v1.21.5 

func (abp *AuditBasicParams) SetTechnologies(technologies []string) *AuditBasicParams

func (*AuditBasicParams) SetUseJas added in v1.21.5 

func (abp *AuditBasicParams) SetUseJas(useJas bool) *AuditBasicParams

func (*AuditBasicParams) SetUseWrapper added in v1.21.5 

func (abp *AuditBasicParams) SetUseWrapper(useWrapper bool) *AuditBasicParams

func (*AuditBasicParams) SetXrayVersion added in v1.21.5 

func (abp *AuditBasicParams) SetXrayVersion(xrayVersion string) *AuditBasicParams

func (*AuditBasicParams) SetXscVersion added in v1.21.5 

func (abp *AuditBasicParams) SetXscVersion(xscVersion string) *AuditBasicParams

func (*AuditBasicParams) SkipAutoInstall added in v1.21.5 

func (abp *AuditBasicParams) SkipAutoInstall() bool

func (*AuditBasicParams) SolutionFilePath added in v1.23.0 

func (abp *AuditBasicParams) SolutionFilePath() string

func (*AuditBasicParams) Technologies added in v1.21.5 

func (abp *AuditBasicParams) Technologies() []string

func (*AuditBasicParams) UseJas added in v1.21.5 

func (abp *AuditBasicParams) UseJas() bool

func (*AuditBasicParams) UseWrapper added in v1.21.5 

func (abp *AuditBasicParams) UseWrapper() bool

type AuditCommand 

type AuditCommand struct {
	IncludeVulnerabilities bool
	IncludeLicenses        bool
	IncludeSbom            bool
	Fail                   bool
	PrintExtendedTable     bool
	Threads                int
	AuditParams
	// contains filtered or unexported fields
}

func NewGenericAuditCommand 

func NewGenericAuditCommand() *AuditCommand

func (*AuditCommand) CommandName 

func (auditCmd *AuditCommand) CommandName() string

func (*AuditCommand) GetProjectKey added in v1.21.9 

func (auditCmd *AuditCommand) GetProjectKey() string

func (*AuditCommand) Run 

func (auditCmd *AuditCommand) Run() (err error)

func (*AuditCommand) SetFail 

func (auditCmd *AuditCommand) SetFail(fail bool) *AuditCommand

func (*AuditCommand) SetGitRepoHttpsCloneUrl added in v1.14.0 

func (auditCmd *AuditCommand) SetGitRepoHttpsCloneUrl(gitRepoHttpsCloneUrl string) *AuditCommand

func (*AuditCommand) SetIncludeLicenses 

func (auditCmd *AuditCommand) SetIncludeLicenses(include bool) *AuditCommand

func (*AuditCommand) SetIncludeSbom added in v1.16.0 

func (auditCmd *AuditCommand) SetIncludeSbom(include bool) *AuditCommand

func (*AuditCommand) SetIncludeVulnerabilities 

func (auditCmd *AuditCommand) SetIncludeVulnerabilities(include bool) *AuditCommand

func (*AuditCommand) SetPrintExtendedTable 

func (auditCmd *AuditCommand) SetPrintExtendedTable(printExtendedTable bool) *AuditCommand

func (*AuditCommand) SetProject 

func (auditCmd *AuditCommand) SetProject(project string) *AuditCommand

func (*AuditCommand) SetTargetRepoPath 

func (auditCmd *AuditCommand) SetTargetRepoPath(repoPath string) *AuditCommand

func (*AuditCommand) SetThreads added in v1.4.0 

func (auditCmd *AuditCommand) SetThreads(threads int) *AuditCommand

func (*AuditCommand) SetWatches 

func (auditCmd *AuditCommand) SetWatches(watches []string) *AuditCommand

type AuditNpmParams added in v1.21.5 

type AuditNpmParams struct {
	AuditParams
	// contains filtered or unexported fields
}

func (AuditNpmParams) NpmIgnoreNodeModules added in v1.21.5 

func (anp AuditNpmParams) NpmIgnoreNodeModules() bool

func (AuditNpmParams) NpmOverwritePackageLock added in v1.21.5 

func (anp AuditNpmParams) NpmOverwritePackageLock() bool

func (AuditNpmParams) SetNpmIgnoreNodeModules added in v1.21.5 

func (anp AuditNpmParams) SetNpmIgnoreNodeModules(ignoreNpmNodeModules bool) AuditNpmParams

func (AuditNpmParams) SetNpmOverwritePackageLock added in v1.21.5 

func (anp AuditNpmParams) SetNpmOverwritePackageLock(overwritePackageLock bool) AuditNpmParams

type AuditParams 

type AuditParams struct {
	*AuditBasicParams
	// contains filtered or unexported fields
}

func NewAuditParams 

func NewAuditParams() *AuditParams

func (*AuditParams) AllowedLicenses added in v1.23.0 

func (params *AuditParams) AllowedLicenses() []string

func (*AuditParams) BomGenerator added in v1.20.0 

func (params *AuditParams) BomGenerator() bom.SbomGenerator

func (*AuditParams) CustomAnalyzerManagerBinaryPath added in v1.20.0 

func (params *AuditParams) CustomAnalyzerManagerBinaryPath() string

func (*AuditParams) CustomBomGenBinaryPath added in v1.20.0 

func (params *AuditParams) CustomBomGenBinaryPath() string

func (*AuditParams) DiffMode added in v1.18.0 

func (params *AuditParams) DiffMode() bool

func (*AuditParams) FilesToScan added in v1.18.0 

func (params *AuditParams) FilesToScan() []string

func (*AuditParams) FixableOnly 

func (params *AuditParams) FixableOnly() bool

func (*AuditParams) GetMultiScanId added in v1.13.2 

func (params *AuditParams) GetMultiScanId() string

func (*AuditParams) GitContext added in v1.21.7 

func (params *AuditParams) GitContext() *xscServices.XscGitInfoContext

func (*AuditParams) InstallFunc 

func (params *AuditParams) InstallFunc() func(tech string) error

func (*AuditParams) MinSeverityFilter 

func (params *AuditParams) MinSeverityFilter() severityutils.Severity

func (*AuditParams) ResultsToCompare added in v1.18.0 

func (params *AuditParams) ResultsToCompare() *results.SecurityCommandResults

func (*AuditParams) RtResultRepository added in v1.23.0 

func (params *AuditParams) RtResultRepository() string

func (*AuditParams) SastRules added in v1.22.0 

func (params *AuditParams) SastRules() string

func (*AuditParams) ScaScanStrategy added in v1.20.0 

func (params *AuditParams) ScaScanStrategy() scan.SbomScanStrategy

func (*AuditParams) SetAllowedLicenses added in v1.23.0 

func (params *AuditParams) SetAllowedLicenses(allowedLicenses []string) *AuditParams

func (*AuditParams) SetBomGenerator added in v1.20.0 

func (params *AuditParams) SetBomGenerator(bomGenerator bom.SbomGenerator) *AuditParams

func (*AuditParams) SetCustomAnalyzerManagerBinaryPath added in v1.20.0 

func (params *AuditParams) SetCustomAnalyzerManagerBinaryPath(customAnalyzerManagerBinaryPath string) *AuditParams

func (*AuditParams) SetCustomBomGenBinaryPath added in v1.20.0 

func (params *AuditParams) SetCustomBomGenBinaryPath(customBomGenBinaryPath string) *AuditParams

func (*AuditParams) SetDepsRepo 

func (params *AuditParams) SetDepsRepo(depsRepo string) *AuditParams

func (*AuditParams) SetDiffMode added in v1.18.0 

func (params *AuditParams) SetDiffMode(diffMode bool) *AuditParams

func (*AuditParams) SetFilesToScan added in v1.18.0 

func (params *AuditParams) SetFilesToScan(filesToScan []string) *AuditParams

func (*AuditParams) SetFixableOnly 

func (params *AuditParams) SetFixableOnly(fixable bool) *AuditParams

func (*AuditParams) SetGitContext added in v1.21.7 

func (params *AuditParams) SetGitContext(gitContext *xscServices.XscGitInfoContext) *AuditParams

func (*AuditParams) SetGraphBasicParams 

func (params *AuditParams) SetGraphBasicParams(gbp *AuditBasicParams) *AuditParams

func (*AuditParams) SetInstallFunc 

func (params *AuditParams) SetInstallFunc(installFunc func(tech string) error) *AuditParams

func (*AuditParams) SetMinSeverityFilter 

func (params *AuditParams) SetMinSeverityFilter(minSeverityFilter severityutils.Severity) *AuditParams

func (*AuditParams) SetMultiScanId added in v1.13.2 

func (params *AuditParams) SetMultiScanId(msi string) *AuditParams

func (*AuditParams) SetResultsContext added in v1.14.0 

func (params *AuditParams) SetResultsContext(resultsContext results.ResultContext) *AuditParams

func (*AuditParams) SetResultsToCompare added in v1.18.0 

func (params *AuditParams) SetResultsToCompare(resultsToCompare *results.SecurityCommandResults) *AuditParams

func (*AuditParams) SetRtResultRepository added in v1.23.0 

func (params *AuditParams) SetRtResultRepository(rtResultRepository string) *AuditParams

func (*AuditParams) SetSastRules added in v1.22.0 

func (params *AuditParams) SetSastRules(sastRules string) *AuditParams

func (*AuditParams) SetScaScanStrategy added in v1.20.0 

func (params *AuditParams) SetScaScanStrategy(scaScanStrategy scan.SbomScanStrategy) *AuditParams

func (*AuditParams) SetScansResultsOutputDir added in v1.9.0 

func (params *AuditParams) SetScansResultsOutputDir(outputDir string) *AuditParams

func (*AuditParams) SetStartTime added in v1.13.2 

func (params *AuditParams) SetStartTime(startTime time.Time) *AuditParams

func (*AuditParams) SetThirdPartyApplicabilityScan 

func (params *AuditParams) SetThirdPartyApplicabilityScan(includeThirdPartyDeps bool) *AuditParams

func (*AuditParams) SetThreads added in v1.4.0 

func (params *AuditParams) SetThreads(threads int) *AuditParams

func (*AuditParams) SetUploadCdxResults added in v1.23.0 

func (params *AuditParams) SetUploadCdxResults(uploadCdxResults bool) *AuditParams

func (*AuditParams) SetViolationGenerator added in v1.23.0 

func (params *AuditParams) SetViolationGenerator(violationGenerator policy.PolicyHandler) *AuditParams

func (*AuditParams) SetWorkingDirs 

func (params *AuditParams) SetWorkingDirs(workingDirs []string) *AuditParams

func (*AuditParams) ShouldGetFlatTreeForApplicableScan added in v1.20.0 

func (params *AuditParams) ShouldGetFlatTreeForApplicableScan(tech techutils.Technology) bool

When building pip dependency tree using pipdeptree, some of the direct dependencies are recognized as transitive and missed by the CA scanner. Our solution for this case is to send all dependencies to the CA scanner. When thirdPartyApplicabilityScan is true, use flatten graph to include all the dependencies in applicability scanning. Only npm is supported for this flag.

func (*AuditParams) StartTime added in v1.13.2 

func (params *AuditParams) StartTime() time.Time

func (*AuditParams) ToBuildInfoBomGenParams added in v1.20.0 

func (params *AuditParams) ToBuildInfoBomGenParams() (bomParams technologies.BuildInfoBomGeneratorParams, err error)

func (*AuditParams) ToXrayScanGraphParams added in v1.20.0 

func (params *AuditParams) ToXrayScanGraphParams() (scanGraphParams scangraph.ScanGraphParams, err error)

func (*AuditParams) UploadCdxResults added in v1.23.0 

func (params *AuditParams) UploadCdxResults() bool

func (*AuditParams) ViolationGenerator added in v1.23.0 

func (params *AuditParams) ViolationGenerator() policy.PolicyHandler

func (*AuditParams) WorkingDirs 

func (params *AuditParams) WorkingDirs() []string

type AuditParamsInterface added in v1.21.5 

type AuditParamsInterface 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
	SetMaxTreeDepth(maxTreeDepth string) *AuditBasicParams
	MaxTreeDepth() string
	OutputFormat() format.OutputFormat
	DepsRepo() string
	SetDepsRepo(depsRepo string) *AuditBasicParams
	IgnoreConfigFile() bool
	SetIgnoreConfigFile(ignoreConfigFile bool) *AuditBasicParams
	IsMavenDepTreeInstalled() bool
	SetIsMavenDepTreeInstalled(isMavenDepTreeInstalled bool) *AuditBasicParams
	SetIsGradleDepTreeInstalled(isGradleDepTreeInstalled bool) *AuditBasicParams
	IsCurationCmd() bool
	SetIsCurationCmd(bool) *AuditBasicParams
	SetExclusions(exclusions []string) *AuditBasicParams
	Exclusions() []string
	SetIsRecursiveScan(isRecursiveScan bool) *AuditBasicParams
	IsRecursiveScan() bool
	SkipAutoInstall() bool
	AllowPartialResults() bool
	GetXrayVersion() string
	GetConfigProfile() *xscservices.ConfigProfile
	SolutionFilePath() string
	SetSolutionFilePath(solutionFilePath string) *AuditBasicParams
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.