updater

Documentation

Overview

Package updater updates the vulnerability database periodically using the registered vulnerability fetchers.

Index

• func Healthcheck() health.Status
• func RegisterFetcher(name string, f Fetcher)
• func Run(interval time.Duration, st *utils.Stopper)
• func Update()
• type Fetcher
• type FetcherResponse
• type FetcherVulnerability

Functions

func Healthcheck

func Healthcheck() health.Status

Healthcheck returns the health of the updater service.

func RegisterFetcher

func RegisterFetcher(name string, f Fetcher)

RegisterFetcher makes a Fetcher available by the provided name. If Register is called twice with the same name or if driver is nil, it panics.

func Run

func Run(interval time.Duration, st *utils.Stopper)

Run updates the vulnerability database at regular intervals

func Update

func Update()

Update fetches all the vulnerabilities from the registered fetchers, upserts them into the database and then sends notifications.

Types

type Fetcher

type Fetcher interface {
	FetchUpdate() (FetcherResponse, error)
}

Fetcher represents anything that can fetch vulnerabilities.

type FetcherResponse

type FetcherResponse struct {
	FlagName        string
	FlagValue       string
	Notes           []string
	Vulnerabilities []FetcherVulnerability
}

FetcherResponse represents the sum of results of an update.

type FetcherVulnerability

type FetcherVulnerability struct {
	ID          string
	Link        string
	Description string
	Priority    types.Priority
	FixedIn     []*database.Package
}

FetcherVulnerability represents an individual vulnerability processed from an update.