driver

type ConfigUnmarshaler func(interface{}) error

type Configs map[string]ConfigUnmarshaler

type Distribution struct {
	ID        string
	VersionID string // Numeric version, like os-release
	Arch      string
	CPE       cpe.WFN
}

type EnrichmentParser interface {
	ParseEnrichment(context.Context, fs.FS) ([]EnrichmentRecord, error)
}

type EnrichmentRecord struct {
	Tags       []string
	Enrichment json.RawMessage
}

type Fingerprint string

type Package struct {
	Name              string
	Version           string
	Database          string
	Arch              string
	Module            string
	CPE               cpe.WFN
	NormalizedVersion types.Version
	Kind              types.PackageKind
	Repository        int // optional, -1 to omit
	Source            int // optional, -1 to omit
}

type ParsedVulnerabilities struct {
	Updater       string
	Vulnerability []Vulnerability
	Package       []Package
	Distribution  []Distribution
	Repository    []Repository
}

type Repository struct {
	Name string
	Key  string
	URI  string
	CPE  cpe.WFN
}

type Severity struct {
	// Upstream should be the value the upstream database provides.
	Upstream string
	// Normalized should be one of the proscribed Severity values. They roughly
	// correlate to CVSSv3 severity levels.
	Normalized types.Severity
}

type UpdateDiff struct {
	Added, Removed []Vulnerability
	Prev, Cur      UpdateOperation
}

type UpdateKind string

type UpdateOperation struct {
	Date        time.Time
	Updater     string
	Kind        UpdateKind
	Fingerprint Fingerprint
	Ref         uuid.UUID
}

type Updater interface {
	// Name is a unique name for this updater.
	//
	// The name preferably indicates the vendor who implemented it and the data
	// source it's fetching and interpreting.
	//
	// For Enrichers, this must be paired with an Enricher using the same value.
	Name() string
	// Fetch
	//
	// When called, the function should determine if new security advisory data
	// is available. A Fingerprint may be passed into in order for the Fetcher to
	// determine if the content has changed.
	//
	// If it has, the entirety of the database should be written to the provided
	// zip.Writer.
	//
	// If the content has not changed, ErrUnchanged should be returned.
	Fetch(context.Context, *zip.Writer, Fingerprint, *http.Client) (Fingerprint, error)
}

type UpdaterFactory interface {
	// Name is used to determine what configuration to use when calling Create.
	Name() string
	// Create is called whenever Updaters are needed to run.
	//
	// The Updater runner makes no assumptions about the lifecycle of the
	// updaters, so implementations may construct new objects on every call, or
	// create a set once and return it repeatedly.
	Create(context.Context, ConfigUnmarshaler) ([]Updater, error)
}

type Vulnerability struct {
	Issued         time.Time
	Name           string
	Description    string
	FixedInVersion string
	Severity       Severity
	Links          []string
	Package        []int // need at least one entry
	Range          types.Range
	ArchOperation  types.ArchOp
	Distribution   int // optional, -1 to omit
	Repository     int // optional, -1 to omit
}

type VulnerabilityParser interface {
	ParseVulnerability(context.Context, fs.FS) (*ParsedVulnerabilities, error)
}