photon

Documentation

Index

• Constants
• func NormalizeSeverity(severity string) claircore.Severity
• func UpdaterSet(_ context.Context) (driver.UpdaterSet, error)
• type DistributionScanner
  • func (*DistributionScanner) Kind() string
  • func (*DistributionScanner) Name() string
  • func (ds *DistributionScanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)
  • func (*DistributionScanner) Version() string
• type Matcher
  • func (*Matcher) Filter(record *claircore.IndexRecord) bool
  • func (*Matcher) Name() string
  • func (*Matcher) Query() []driver.MatchConstraint
  • func (*Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, ...) (bool, error)
• type Option
  • func WithClient(c *http.Client) Option
  • func WithURL(uri, compression string) Option
• type Release
• type Updater
  • func NewUpdater(r Release, opts ...Option) (*Updater, error)
  • func (u *Updater) Name() string
  • func (u *Updater) Parse(ctx context.Context, r io.ReadCloser) ([]*claircore.Vulnerability, error)

Constants

const (
	Low       = "Low"
	Moderate  = "Moderate"
	Important = "Important"
	Critical  = "Critical"
)

Functions

func NormalizeSeverity

func NormalizeSeverity(severity string) claircore.Severity

func UpdaterSet

func UpdaterSet(_ context.Context) (driver.UpdaterSet, error)

Types

type DistributionScanner

type DistributionScanner struct{}

DistributionScanner attempts to discover if a layer displays characteristics of a photon distribution

func (*DistributionScanner) Kind

func (*DistributionScanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*DistributionScanner) Name

func (*DistributionScanner) Name() string

Name implements scanner.VersionedScanner.

func (*DistributionScanner) Scan

func (ds *DistributionScanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)

Scan will inspect the layer for an os-release or lsb-release file and perform a regex match for keywords indicating the associated photon release

If neither file is found a (nil,nil) is returned. If the files are found but all regexp fail to match an empty slice is returned.

func (*DistributionScanner) Version

func (*DistributionScanner) Version() string

Version implements scanner.VersionedScanner.

type Matcher

type Matcher struct{}

Matcher implements driver.Matcher.

func (*Matcher) Filter

func (*Matcher) Filter(record *claircore.IndexRecord) bool

Filter implements driver.Matcher.

func (*Matcher) Name

func (*Matcher) Name() string

Name implements driver.Matcher.

func (*Matcher) Query

func (*Matcher) Query() []driver.MatchConstraint

Query implements driver.Matcher.

func (*Matcher) Vulnerable

func (*Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, vuln *claircore.Vulnerability) (bool, error)

Vulnerable implements driver.Matcher.

type Option

type Option func(*Updater) error

Option configures an Updater.

func WithClient

func WithClient(c *http.Client) Option

WithClient sets an http.Client for use with an Updater.

If this Option is not supplied, http.DefaultClient will be used.

func WithURL

func WithURL(uri, compression string) Option

WithURL overrides the default URL to fetch an OVAL database.

type Release

type Release string

Release indicates the Photon release OVAL database to pull from.

const (
	Photon1 Release = `photon1`
	Photon2 Release = `photon2`
	Photon3 Release = `photon3`
)

These are some known Releases.

type Updater

type Updater struct {
	ovalutil.Fetcher // promoted Fetch method
	// contains filtered or unexported fields
}

Updater implements driver.Updater for Photon.

func NewUpdater

func NewUpdater(r Release, opts ...Option) (*Updater, error)

NewUpdater configures an updater to fetch the specified Release.

func (*Updater) Name

func (u *Updater) Name() string

Name satisfies driver.Updater.

func (*Updater) Parse

func (u *Updater) Parse(ctx context.Context, r io.ReadCloser) ([]*claircore.Vulnerability, error)