python

Documentation

Overview

Package python contains components for interrogating python packages in container layers.

Package python contains components for interrogating python packages in container layers.

Index

• Variables
• func NewCoalescer(_ context.Context) (indexer.Coalescer, error)
• func NewEcosystem(ctx context.Context) *indexer.Ecosystem
• type Matcher
  • func (*Matcher) Filter(record *claircore.IndexRecord) bool
  • func (*Matcher) Name() string
  • func (*Matcher) Query() []driver.MatchConstraint
  • func (*Matcher) VersionAuthoritative() bool
  • func (*Matcher) VersionFilter()
  • func (*Matcher) Vulnerable(record *claircore.IndexRecord, vuln *claircore.Vulnerability) bool
• type RepoScanner
  • func (*RepoScanner) Kind() string
  • func (*RepoScanner) Name() string
  • func (rs *RepoScanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Repository, error)
  • func (*RepoScanner) Version() string
• type Scanner
  • func (*Scanner) Kind() string
  • func (*Scanner) Name() string
  • func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)
  • func (*Scanner) Version() string

Variables

var (
	Repository = claircore.Repository{
		Name: "pypi",
		URI:  "https://pypi.org/simple",
	}
)

Functions

func NewCoalescer

func NewCoalescer(_ context.Context) (indexer.Coalescer, error)

func NewEcosystem

func NewEcosystem(ctx context.Context) *indexer.Ecosystem

NewEcosystem provides the set of scanners for the python ecosystem.

Types

type Matcher

type Matcher struct{}

Matcher attempts to correlate discovered python packages with reported vulnerabilities.

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) VersionAuthoritative

func (*Matcher) VersionAuthoritative() bool

VersionAuthoritative implements driver.VersionFilter.

func (*Matcher) VersionFilter

func (*Matcher) VersionFilter()

VersionFilter opts in to filtering versions in the database.

func (*Matcher) Vulnerable

func (*Matcher) Vulnerable(record *claircore.IndexRecord, vuln *claircore.Vulnerability) bool

Vulnerable implements driver.Matcher.

type RepoScanner

type RepoScanner struct{}

func (*RepoScanner) Kind

func (*RepoScanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*RepoScanner) Name

func (*RepoScanner) Name() string

Name implements scanner.VersionedScanner.

func (*RepoScanner) Scan

func (rs *RepoScanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Repository, error)

Scan attempts to find wheel or egg info directories and record the package information there.

A return of (nil, nil) is expected if there's nothing found.

func (*RepoScanner) Version

func (*RepoScanner) Version() string

Version implements scanner.VersionedScanner.

type Scanner

type Scanner struct{}

Scanner implements the scanner.PackageScanner interface.

It looks for directories that seem like wheels or eggs, and looks at the metadata recorded there.

The zero value is ready to use.

func (*Scanner) Kind

func (*Scanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*Scanner) Name

func (*Scanner) Name() string

Name implements scanner.VersionedScanner.

func (*Scanner) Scan

func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)

Scan attempts to find wheel or egg info directories and record the package information there.

A return of (nil, nil) is expected if there's nothing found.

func (*Scanner) Version

func (*Scanner) Version() string

Version implements scanner.VersionedScanner.