vulnsrc

Documentation

Overview

Package vulnsrc exposes functions to dynamically register vulnerability sources used to update a Clair database.

Index

• Variables
• func CleanAll()
• func ListUpdaters() []string
• func RegisterUpdater(name string, u Updater)
• func Updaters() map[string]Updater
• type UpdateResponse
• type Updater

Variables

var (
	// ErrFilesystem is returned when a fetcher fails to interact with the local filesystem.
	ErrFilesystem = errors.New("vulnsrc: something went wrong when interacting with the fs")
)

Functions

func CleanAll

func CleanAll()

CleanAll is a utility function that calls Clean() on every registered Updater.

func ListUpdaters

func ListUpdaters() []string

ListUpdaters returns the names of registered vulnerability updaters.

func RegisterUpdater

func RegisterUpdater(name string, u Updater)

RegisterUpdater makes an Updater available by the provided name.

If called twice with the same name, the name is blank, or if the provided Updater is nil, this function panics.

func Updaters

func Updaters() map[string]Updater

Updaters returns the list of the registered Updaters.

Types

type UpdateResponse

type UpdateResponse struct {
	Flags           map[string]string
	Notes           []string
	Vulnerabilities []database.VulnerabilityWithAffected
}

UpdateResponse represents the sum of results of an update.

type Updater

type Updater interface {
	// Update gets vulnerability updates.
	Update(database.Datastore) (UpdateResponse, error)

	// Clean deletes any allocated resources.
	// It is invoked when Clair stops.
	Clean()
}

Updater represents anything that can fetch vulnerabilities.