extractor

Documentation

Overview

Package extractor provides the common interface for standalone and filesystem extractors.

Index

• type Annotation
• type Extractor
• type Inventory
  • func (i *Inventory) Ecosystem() string
• type SourceCodeIdentifier

Types

type Annotation

type Annotation int64

Annotation are additional information about the inventory.

const (
	// Unknown is the default value for the annotation.
	Unknown Annotation = iota
	// Transitional packages just point to other packages without having actual code in them. This
	// happens for example when packages are renamed.
	Transitional
	// InsideOSPackage is set for packages that are found inside an OS package.
	// TODO(b/364536788): Annotation for language packages inside OS packages.
	InsideOSPackage
	// InsideCacheDir is set for packages that are found inside a cache directory.
	// TODO(b/364539671): Annotation for packages inside cache directories.
	InsideCacheDir
)

type Extractor

type Extractor interface {
	plugin.Plugin
	// ToPURL converts an inventory created by this extractor into a PURL.
	ToPURL(i *Inventory) *purl.PackageURL
	// ToCPEs converts an inventory created by this extractor into CPEs, if supported.
	ToCPEs(i *Inventory) []string
	// Ecosystem returns the Ecosystem of the given inventory created by this extractor.
	// For software packages this corresponds to an OSV ecosystem value, e.g. PyPI.
	Ecosystem(i *Inventory) string
}

Extractor is the common interface of inventory extraction plugins..

type Inventory

type Inventory struct {
	// A human-readable name representation of the package. Note that this field
	// should only be used for things like logging as different packages can have
	// multiple different types of names (e.g. .deb packages have a source name
	// and a binary name), in which case we arbitrarily pick one of them to use here.
	// In cases when the exact name type used is important (e.g. when matching
	// against vuln feeds) you should use the specific name field from the Metadata.
	Name string
	// The version of this package.
	Version string
	// Source code level package identifiers.
	SourceCode *SourceCodeIdentifier

	// Paths or source of files related to the package.
	Locations []string
	// The Extractor that found this software instance. Set by the core library.
	Extractor Extractor
	// The additional data found in the package.
	Metadata any

	Annotations []Annotation
}

Inventory is an instance of a software package or library found by the extractor.

func (*Inventory) Ecosystem

func (i *Inventory) Ecosystem() string

Ecosystem returns the Ecosystem of the inventory. For software packages this corresponds to an OSV ecosystem value, e.g. PyPI.

type SourceCodeIdentifier

type SourceCodeIdentifier struct {
	Repo   string
	Commit string
}

SourceCodeIdentifier lists additional identifiers for source code software packages (e.g. NPM).