audit

Documentation

Index

• func CreateJavaProps(depsRepo string, serverDetails *config.ServerDetails) map[string]any
• func GetTechDependencyTree(params *clientUtils.GraphBasicParams, tech coreutils.Technology) (flatTree []*xrayCmdUtils.GraphNode, err error)
• type GenericAuditCommand
  • func NewGenericAuditCommand() *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) CommandName() string
  • func (auditCmd *GenericAuditCommand) CreateXrayGraphScanParams() *services.XrayGraphScanParams
  • func (auditCmd *GenericAuditCommand) Run() (err error)
  • func (auditCmd *GenericAuditCommand) SetFail(fail bool) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetIncludeLicenses(include bool) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetIncludeVulnerabilities(include bool) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetPrintExtendedTable(printExtendedTable bool) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetProject(project string) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetTargetRepoPath(repoPath string) *GenericAuditCommand
  • func (auditCmd *GenericAuditCommand) SetWatches(watches []string) *GenericAuditCommand
• type Params
  • func NewAuditParams() *Params
  • func (params *Params) FixableOnly() bool
  • func (params *Params) InstallFunc() func(tech string) error
  • func (params *Params) MinSeverityFilter() string
  • func (params *Params) SetFixableOnly(fixable bool) *Params
  • func (params *Params) SetGraphBasicParams(gbp *clientUtils.GraphBasicParams) *Params
  • func (params *Params) SetInstallFunc(installFunc func(tech string) error) *Params
  • func (params *Params) SetMinSeverityFilter(minSeverityFilter string) *Params
  • func (params *Params) SetWorkingDirs(workingDirs []string) *Params
  • func (params *Params) SetXrayGraphScanParams(xrayGraphScanParams *services.XrayGraphScanParams) *Params
  • func (params *Params) SetXrayVersion(version string) *Params
  • func (params *Params) WorkingDirs() []string
  • func (params *Params) XrayGraphScanParams() *services.XrayGraphScanParams
  • func (params *Params) XrayVersion() string
• type Results
  • func RunAudit(auditParams *Params) (results *Results, err error)

Functions

func CreateJavaProps

func CreateJavaProps(depsRepo string, serverDetails *config.ServerDetails) map[string]any

func GetTechDependencyTree

func GetTechDependencyTree(params *clientUtils.GraphBasicParams, tech coreutils.Technology) (flatTree []*xrayCmdUtils.GraphNode, err error)

Types

type GenericAuditCommand

type GenericAuditCommand struct {
	IncludeVulnerabilities bool
	IncludeLicenses        bool
	Fail                   bool
	PrintExtendedTable     bool
	Params
	// contains filtered or unexported fields
}

func NewGenericAuditCommand

func NewGenericAuditCommand() *GenericAuditCommand

func (*GenericAuditCommand) CommandName

func (auditCmd *GenericAuditCommand) CommandName() string

func (*GenericAuditCommand) CreateXrayGraphScanParams

func (auditCmd *GenericAuditCommand) CreateXrayGraphScanParams() *services.XrayGraphScanParams

func (*GenericAuditCommand) Run

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

func (*GenericAuditCommand) SetFail

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

func (*GenericAuditCommand) SetIncludeLicenses

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

func (*GenericAuditCommand) SetIncludeVulnerabilities

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

func (*GenericAuditCommand) SetPrintExtendedTable

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

func (*GenericAuditCommand) SetProject

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

func (*GenericAuditCommand) SetTargetRepoPath

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

func (*GenericAuditCommand) SetWatches

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

type Params

type Params struct {
	*clientUtils.GraphBasicParams
	// contains filtered or unexported fields
}

func NewAuditParams

func NewAuditParams() *Params

func (*Params) FixableOnly

func (params *Params) FixableOnly() bool

func (*Params) InstallFunc

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

func (*Params) MinSeverityFilter

func (params *Params) MinSeverityFilter() string

func (*Params) SetFixableOnly

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

func (*Params) SetGraphBasicParams

func (params *Params) SetGraphBasicParams(gbp *clientUtils.GraphBasicParams) *Params

func (*Params) SetInstallFunc

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

func (*Params) SetMinSeverityFilter

func (params *Params) SetMinSeverityFilter(minSeverityFilter string) *Params

func (*Params) SetWorkingDirs

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

func (*Params) SetXrayGraphScanParams

func (params *Params) SetXrayGraphScanParams(xrayGraphScanParams *services.XrayGraphScanParams) *Params

func (*Params) SetXrayVersion

func (params *Params) SetXrayVersion(version string) *Params

func (*Params) WorkingDirs

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

func (*Params) XrayGraphScanParams

func (params *Params) XrayGraphScanParams() *services.XrayGraphScanParams

func (*Params) XrayVersion

func (params *Params) XrayVersion() string

type Results

type Results struct {
	IsMultipleRootProject bool
	AuditError            error
	ExtendedScanResults   *xrutils.ExtendedScanResults
}

func RunAudit

func RunAudit(auditParams *Params) (results *Results, err error)

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.