processor

Documentation

Index

• Constants
• func GetFormatNames() []string
• func Import(opt *ImportOptions) error
• func Query(opt *query.Options) error
• type Format
  • func GetFormats() []Format
  • func ParseFormat(s string) (Format, error)
  • func (f Format) String() string
• type Hashible
• type ImportOptions
• type VulnerabilityMapper

Constants

const (
	FormatUnknown   Format = iota
	FormatGrypeJSON        // grype JSON format
	FormatTrivyJSON        // trivy JSON format
	FormatSnykJSON         // snyk JSON format

	FormatUnknownName   = "unknown"
	FormatGrypeJSONName = "grype"
	FormatTrivyJSONName = "trivy"
	FormatSnykJSONName  = "snyk"
)

Functions

func GetFormatNames

func GetFormatNames() []string

GetFormatNames returns the names of the supported source formats.

func Import

func Import(opt *ImportOptions) error

Import imports the vulnerability report to the target data store.

func Query

func Query(opt *query.Options) error

Query imports the vulnerability report to the target data store.

Types

type Format

type Format int64

Format represents the source format.

func GetFormats

func GetFormats() []Format

GetFormats returns the supported source formats.

func ParseFormat

func ParseFormat(s string) (Format, error)

ParseFormat parses the source format.

func (Format) String

func (f Format) String() string

String returns the string representation of the source format.

type Hashible

type Hashible interface {
	GetID() string
}

type ImportOptions

type ImportOptions struct {
	// Source is the URI of the image from which the report was generated.
	Source string

	// File path to the vulnerability report to import.
	File string

	// Scanners is the list of scanners to use.
	Scanners string

	// Target is the target data store uri.
	Target string

	// FormatType is the type of the format (e.g. json, yaml, etc.).
	FormatType Format
	// contains filtered or unexported fields
}

ImportOptions represents the input options.

type VulnerabilityMapper

type VulnerabilityMapper func(c *gabs.Container) ([]*data.Vulnerability, error)

VulnerabilityMapper is a function that converts a source to a list of common vulnerability types.