audit

package
v1.12.5 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2024 License: Apache-2.0 Imports: 45 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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.

func RunJasScans added in v1.10.1

func RunJasScans(auditParallelRunner *utils.SecurityParallelRunner, auditParams *AuditParams, scanResults *results.SecurityCommandResults, jfrogAppsConfig *jfrogappsconfig.JFrogAppsConfig) (jasScanner *jas.JasScanner, generalError error)

func SetResolutionRepoInAuditParamsIfExists added in v1.11.2

func SetResolutionRepoInAuditParamsIfExists(params utils.AuditParams, tech techutils.Technology) (serverDetails *config.ServerDetails, err error)

Types

type AuditCommand

type AuditCommand struct {
	IncludeVulnerabilities bool
	IncludeLicenses        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) CreateCommonGraphScanParams added in v1.4.0

func (auditCmd *AuditCommand) CreateCommonGraphScanParams() *scangraph.CommonGraphScanParams

func (*AuditCommand) HasViolationContext added in v1.8.0

func (auditCmd *AuditCommand) HasViolationContext() bool

func (*AuditCommand) Run

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

func (*AuditCommand) SetAnalyticsMetricsService added in v1.1.0

func (auditCmd *AuditCommand) SetAnalyticsMetricsService(analyticsMetricsService *xsc.AnalyticsMetricsService) *AuditCommand

func (*AuditCommand) SetFail

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

func (*AuditCommand) SetIncludeLicenses

func (auditCmd *AuditCommand) SetIncludeLicenses(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 AuditParams

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

func NewAuditParams

func NewAuditParams() *AuditParams

func (*AuditParams) FixableOnly

func (params *AuditParams) FixableOnly() bool

func (*AuditParams) InstallFunc

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

func (*AuditParams) MinSeverityFilter

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

func (*AuditParams) SetCommonGraphScanParams added in v1.4.0

func (params *AuditParams) SetCommonGraphScanParams(commonParams *scangraph.CommonGraphScanParams) *AuditParams

func (*AuditParams) SetConfigProfile added in v1.8.0

func (params *AuditParams) SetConfigProfile(configProfile *clientservices.ConfigProfile) *AuditParams

func (*AuditParams) SetDepsRepo

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

func (*AuditParams) SetFixableOnly

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

func (*AuditParams) SetGraphBasicParams

func (params *AuditParams) SetGraphBasicParams(gbp *xrayutils.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) SetScansResultsOutputDir added in v1.9.0

func (params *AuditParams) SetScansResultsOutputDir(outputDir string) *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) SetWorkingDirs

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

func (*AuditParams) WorkingDirs

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

func (*AuditParams) XrayVersion

func (params *AuditParams) XrayVersion() string

type DependencyTreeResult added in v1.1.0

type DependencyTreeResult struct {
	FlatTree     *xrayCmdUtils.GraphNode
	FullDepTrees []*xrayCmdUtils.GraphNode
	DownloadUrls map[string]string
}

func GetTechDependencyTree

func GetTechDependencyTree(params xrayutils.AuditParams, artifactoryServerDetails *config.ServerDetails, tech techutils.Technology) (depTreeResult DependencyTreeResult, err error)

Directories

Path Synopsis
sca
go
npm

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL