analyzer

Documentation

Index

• Constants
• func ThreatInstanceId(id jsonreportspec.ReportThreat_ReportThreatId, ...) string
• type Analyzer
  • func NewCelFilterAnalyzer(fl string, failOnMatch bool) (Analyzer, error)
  • func NewCelFilterSuiteAnalyzer(path string, failOnMatch bool) (Analyzer, error)
  • func NewExceptionsGenerator(config ExceptionsGeneratorConfig) (Analyzer, error)
  • func NewJsonDumperAnalyzer(dir string) (Analyzer, error)
  • func NewLockfilePoisoningAnalyzer(config LockfilePoisoningAnalyzerConfig) (Analyzer, error)
• type AnalyzerEvent
  • func (ev *AnalyzerEvent) IsFailOnError() bool
  • func (ev *AnalyzerEvent) IsFilterMatch() bool
  • func (ev *AnalyzerEvent) IsLockfilePoisoningSignal() bool
• type AnalyzerEventHandler
• type AnalyzerEventType
• type ExceptionsGeneratorConfig
• type LockfilePoisoningAnalyzerConfig

Constants

const (
	ET_FilterExpressionMatched = AnalyzerEventType("ev_pkg_filter_match")
	ET_AnalyzerFailOnError     = AnalyzerEventType("ev_fail_on_error")

	// Following event types must set the Threat field
	ET_LockfilePoisoningSignal = AnalyzerEventType("ev_lockfile_poisoning")
)

Functions

func ThreatInstanceId

func ThreatInstanceId(id jsonreportspec.ReportThreat_ReportThreatId,
	st jsonreportspec.ReportThreat_SubjectType,
	s string) string

Types

type Analyzer

type Analyzer interface {
	Name() string

	Analyze(manifest *models.PackageManifest,
		handler AnalyzerEventHandler) error

	Finish() error
}

Contract for an analyzer

func NewCelFilterAnalyzer

func NewCelFilterAnalyzer(fl string, failOnMatch bool) (Analyzer, error)

func NewCelFilterSuiteAnalyzer

func NewCelFilterSuiteAnalyzer(path string, failOnMatch bool) (Analyzer, error)

func NewExceptionsGenerator

func NewExceptionsGenerator(config ExceptionsGeneratorConfig) (Analyzer, error)

func NewJsonDumperAnalyzer

func NewJsonDumperAnalyzer(dir string) (Analyzer, error)

func NewLockfilePoisoningAnalyzer

func NewLockfilePoisoningAnalyzer(config LockfilePoisoningAnalyzerConfig) (Analyzer, error)

type AnalyzerEvent

type AnalyzerEvent struct {
	// Analyzer generating this event
	Source string

	// Type of the event
	Type AnalyzerEventType

	// Message / Error / Filter
	Message interface{}
	Filter  *filtersuite.Filter
	Threat  *jsonreportspec.ReportThreat
	Err     error

	// Entities on which event was generated
	Manifest *models.PackageManifest
	Package  *models.Package
}

func (*AnalyzerEvent) IsFailOnError

func (ev *AnalyzerEvent) IsFailOnError() bool

func (*AnalyzerEvent) IsFilterMatch

func (ev *AnalyzerEvent) IsFilterMatch() bool

func (*AnalyzerEvent) IsLockfilePoisoningSignal

func (ev *AnalyzerEvent) IsLockfilePoisoningSignal() bool

type AnalyzerEventHandler

type AnalyzerEventHandler func(event *AnalyzerEvent) error

Callback to receive events from analyzer

type AnalyzerEventType

type AnalyzerEventType string

type ExceptionsGeneratorConfig

type ExceptionsGeneratorConfig struct {
	Path      string
	Filter    string
	ExpiresOn string
}

type LockfilePoisoningAnalyzerConfig

type LockfilePoisoningAnalyzerConfig struct {
	FailFast            bool
	TrustedRegistryUrls []string
}