vendored

Documentation

Index

• type Extractor
  • func (e Extractor) Ecosystem(_ *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(fapi filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(_ *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int

Types

type Extractor

type Extractor struct {
	// ScanGitDir determines whether a vendored library with a git directory is scanned or not,
	// this is used to avoid duplicate results, once from git scanning, once from vendoredDir scanning
	ScanGitDir bool
	OSVClient  *osvdev.OSVClient
}

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(_ *extractor.Inventory) string

Ecosystem returns an empty string as all inventories are commit hashes

func (Extractor) Extract

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)

Extract determines the most likely package version from the directory and returns them as commit hash inventory entries

func (Extractor) FileRequired

func (e Extractor) FileRequired(fapi filesystem.FileAPI) bool

FileRequired returns true for likely directories to contain vendored c/c++ code

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) ToPURL

func (e Extractor) ToPURL(_ *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.