scan

Documentation

Index

• Constants
• func ConditionalUploadDefaultScanFunc(serverDetails *config.ServerDetails, fileSpec *spec.SpecFiles, threads int, ...) error
• func DownloadIndexerIfNeeded(xrayManager *xray.XrayServicesManager, xrayVersionStr string) (indexerPath string, err error)
• type BuildScanCommand
  • func NewBuildScanCommand() *BuildScanCommand
  • func (bsc *BuildScanCommand) CommandName() string
  • func (bsc *BuildScanCommand) Run() (err error)
  • func (bsc *BuildScanCommand) ServerDetails() (*config.ServerDetails, error)
  • func (bsc *BuildScanCommand) SetBuildConfiguration(buildConfiguration *build.BuildConfiguration) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetFailBuild(failBuild bool) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetIncludeVulnerabilities(include bool) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetOutputFormat(format outputFormat.OutputFormat) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetPrintExtendedTable(printExtendedTable bool) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetRescan(rescan bool) *BuildScanCommand
  • func (bsc *BuildScanCommand) SetServerDetails(server *config.ServerDetails) *BuildScanCommand
• type DockerScanCommand
  • func NewDockerScanCommand() *DockerScanCommand
  • func (dsc *DockerScanCommand) CommandName() string
  • func (dsc *DockerScanCommand) Run() (err error)
  • func (dsc *DockerScanCommand) SetImageTag(imageTag string) *DockerScanCommand
  • func (dsc *DockerScanCommand) SetTargetRepoPath(repoPath string) *DockerScanCommand
• type FileContext
• type ScanCommand
  • func NewScanCommand() *ScanCommand
  • func (scanCmd *ScanCommand) CommandName() string
  • func (scanCmd *ScanCommand) Run() (err error)
  • func (scanCmd *ScanCommand) ServerDetails() (*config.ServerDetails, error)
  • func (scanCmd *ScanCommand) SetBypassArchiveLimits(bypassArchiveLimits bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetFail(fail bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetFixableOnly(fixable bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetIncludeLicenses(include bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetIncludeVulnerabilities(include bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetMinSeverityFilter(minSeverityFilter string) *ScanCommand
  • func (scanCmd *ScanCommand) SetOutputFormat(format outputFormat.OutputFormat) *ScanCommand
  • func (scanCmd *ScanCommand) SetPrintExtendedTable(printExtendedTable bool) *ScanCommand
  • func (scanCmd *ScanCommand) SetProgress(progress ioUtils.ProgressMgr)
  • func (scanCmd *ScanCommand) SetProject(project string) *ScanCommand
  • func (scanCmd *ScanCommand) SetServerDetails(server *config.ServerDetails) *ScanCommand
  • func (scanCmd *ScanCommand) SetSpec(spec *spec.SpecFiles) *ScanCommand
  • func (scanCmd *ScanCommand) SetThreads(threads int) *ScanCommand
  • func (scanCmd *ScanCommand) SetWatches(watches []string) *ScanCommand
• type ScanInfo

Constants

const (
	BuildScanMinVersion                       = "3.37.0"
	BuildScanIncludeVulnerabilitiesMinVersion = "3.40.0"
)

const (
	BypassArchiveLimitsMinXrayVersion = "3.59.0"
)

const (
	DockerScanMinXrayVersion = "3.40.0"
)

Functions

func ConditionalUploadDefaultScanFunc

func ConditionalUploadDefaultScanFunc(serverDetails *config.ServerDetails, fileSpec *spec.SpecFiles, threads int, scanOutputFormat format.OutputFormat) error

func DownloadIndexerIfNeeded

func DownloadIndexerIfNeeded(xrayManager *xray.XrayServicesManager, xrayVersionStr string) (indexerPath string, err error)

Types

type BuildScanCommand

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

func NewBuildScanCommand

func NewBuildScanCommand() *BuildScanCommand

func (*BuildScanCommand) CommandName

func (bsc *BuildScanCommand) CommandName() string

func (*BuildScanCommand) Run

func (bsc *BuildScanCommand) Run() (err error)

Scan published builds with Xray

func (*BuildScanCommand) ServerDetails

func (bsc *BuildScanCommand) ServerDetails() (*config.ServerDetails, error)

func (*BuildScanCommand) SetBuildConfiguration

func (bsc *BuildScanCommand) SetBuildConfiguration(buildConfiguration *build.BuildConfiguration) *BuildScanCommand

func (*BuildScanCommand) SetFailBuild

func (bsc *BuildScanCommand) SetFailBuild(failBuild bool) *BuildScanCommand

func (*BuildScanCommand) SetIncludeVulnerabilities

func (bsc *BuildScanCommand) SetIncludeVulnerabilities(include bool) *BuildScanCommand

func (*BuildScanCommand) SetOutputFormat

func (bsc *BuildScanCommand) SetOutputFormat(format outputFormat.OutputFormat) *BuildScanCommand

func (*BuildScanCommand) SetPrintExtendedTable

func (bsc *BuildScanCommand) SetPrintExtendedTable(printExtendedTable bool) *BuildScanCommand

func (*BuildScanCommand) SetRescan

func (bsc *BuildScanCommand) SetRescan(rescan bool) *BuildScanCommand

func (*BuildScanCommand) SetServerDetails

func (bsc *BuildScanCommand) SetServerDetails(server *config.ServerDetails) *BuildScanCommand

type DockerScanCommand

type DockerScanCommand struct {
	ScanCommand
	// contains filtered or unexported fields
}

func NewDockerScanCommand

func NewDockerScanCommand() *DockerScanCommand

func (*DockerScanCommand) CommandName

func (dsc *DockerScanCommand) CommandName() string

func (*DockerScanCommand) Run

func (dsc *DockerScanCommand) Run() (err error)

func (*DockerScanCommand) SetImageTag

func (dsc *DockerScanCommand) SetImageTag(imageTag string) *DockerScanCommand

func (*DockerScanCommand) SetTargetRepoPath

func (dsc *DockerScanCommand) SetTargetRepoPath(repoPath string) *DockerScanCommand

type FileContext

type FileContext func(string) parallel.TaskFunc

type ScanCommand

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

func NewScanCommand

func NewScanCommand() *ScanCommand

func (*ScanCommand) CommandName

func (scanCmd *ScanCommand) CommandName() string

func (*ScanCommand) Run

func (scanCmd *ScanCommand) Run() (err error)

func (*ScanCommand) ServerDetails

func (scanCmd *ScanCommand) ServerDetails() (*config.ServerDetails, error)

func (*ScanCommand) SetBypassArchiveLimits

func (scanCmd *ScanCommand) SetBypassArchiveLimits(bypassArchiveLimits bool) *ScanCommand

func (*ScanCommand) SetFail

func (scanCmd *ScanCommand) SetFail(fail bool) *ScanCommand

func (*ScanCommand) SetFixableOnly

func (scanCmd *ScanCommand) SetFixableOnly(fixable bool) *ScanCommand

func (*ScanCommand) SetIncludeLicenses

func (scanCmd *ScanCommand) SetIncludeLicenses(include bool) *ScanCommand

func (*ScanCommand) SetIncludeVulnerabilities

func (scanCmd *ScanCommand) SetIncludeVulnerabilities(include bool) *ScanCommand

func (*ScanCommand) SetMinSeverityFilter

func (scanCmd *ScanCommand) SetMinSeverityFilter(minSeverityFilter string) *ScanCommand

func (*ScanCommand) SetOutputFormat

func (scanCmd *ScanCommand) SetOutputFormat(format outputFormat.OutputFormat) *ScanCommand

func (*ScanCommand) SetPrintExtendedTable

func (scanCmd *ScanCommand) SetPrintExtendedTable(printExtendedTable bool) *ScanCommand

func (*ScanCommand) SetProgress

func (scanCmd *ScanCommand) SetProgress(progress ioUtils.ProgressMgr)

func (*ScanCommand) SetProject

func (scanCmd *ScanCommand) SetProject(project string) *ScanCommand

func (*ScanCommand) SetServerDetails

func (scanCmd *ScanCommand) SetServerDetails(server *config.ServerDetails) *ScanCommand

func (*ScanCommand) SetSpec

func (scanCmd *ScanCommand) SetSpec(spec *spec.SpecFiles) *ScanCommand

func (*ScanCommand) SetThreads

func (scanCmd *ScanCommand) SetThreads(threads int) *ScanCommand

func (*ScanCommand) SetWatches

func (scanCmd *ScanCommand) SetWatches(watches []string) *ScanCommand

type ScanInfo

type ScanInfo struct {
	Target string
	Result *services.ScanResponse
}