gobin

Documentation

Overview

Package gobin implements a package scanner that pulls go runtime and dependency information out of a compiled executable.

Main module versioning

The go toolchain currently only fills in version information for modules obtained as a module. Most go executables are built from source checkouts, meaning they are not in module form. See issue 50603 for details on why and what's being explored to provide this information. Accordingly, claircore cannot report advisories for main modules.

Index

• Variables
• func NewEcosystem(ctx context.Context) *indexer.Ecosystem
• type Detector
  • func (Detector) DefaultRepository(ctx context.Context) *claircore.Repository
  • func (Detector) Kind() string
  • func (Detector) Name() string
  • func (Detector) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Package, error)
  • func (Detector) Version() string
• type Matcher
  • func (matcher *Matcher) Filter(record *claircore.IndexRecord) bool
  • func (m *Matcher) Name() string
  • func (matcher *Matcher) Query() []driver.MatchConstraint
  • func (matcher *Matcher) VersionAuthoritative() bool
  • func (matcher *Matcher) VersionFilter()
  • func (matcher *Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, ...) (bool, error)

Variables

var (
	Repository = claircore.Repository{
		Name: "go",
		URI:  "https://pkg.go.dev/",
	}
)

Functions

func NewEcosystem

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

NewEcosystem provides the ecosystem for handling go binaries.

Types

type Detector

type Detector struct{}

Detector detects go binaries and reports the packages used to build them.

func (Detector) DefaultRepository

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

Scan implements indexer.DefaultRepoScanner.

func (Detector) Kind

func (Detector) Kind() string

Kind implements indexer.PackageScanner.

func (Detector) Name

func (Detector) Name() string

Name implements indexer.PackageScanner.

func (Detector) Scan

func (Detector) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Package, error)

Scan implements indexer.PackageScanner.

func (Detector) Version

func (Detector) Version() string

Version implements indexer.PackageScanner.

type Matcher

type Matcher struct{}

Matcher matches discovered go packages against advisories provided via OSV.

func (*Matcher) Filter

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

Filter implements driver.Matcher.

func (*Matcher) Name

func (m *Matcher) Name() string

Name implements driver.Matcher.

func (*Matcher) Query

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

Query implements driver.Matcher.

func (*Matcher) VersionAuthoritative

func (matcher *Matcher) VersionAuthoritative() bool

func (*Matcher) VersionFilter

func (matcher *Matcher) VersionFilter()

func (*Matcher) Vulnerable

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

Vulnerable implements driver.Matcher.