python

Documentation

Overview

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) Vulnerable(ctx context.Context, record *claircore.IndexRecord, ...) (bool, error)
• type Scanner
  • func (Scanner) DefaultRepository(ctx context.Context) *claircore.Repository
  • 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) Vulnerable

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

Vulnerable implements driver.Matcher.

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. This type attempts to follow the specs documented by the PyPA, with the newer PEPs being preferred.

The zero value is ready to use.

func (Scanner) DefaultRepository

func (Scanner) DefaultRepository(ctx context.Context) *claircore.Repository

DefaultRepository implements indexer.DefaultRepoScanner

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.