osv

Documentation

Overview

Package osv provides a Wrapper for osv plugins.

Index

• func WrapInput(input *filesystem.ScanInput) lockfile.DepFile
• type DepGroupMetadata
  • func (dgm DepGroupMetadata) DepGroups() []string
• type DepGroups
• type Metadata
• type Wrapper
  • func (e Wrapper) Ecosystem(i *extractor.Inventory) string
  • func (e Wrapper) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Wrapper) FileRequired(api filesystem.FileAPI) bool
  • func (e Wrapper) Name() string
  • func (e Wrapper) Requirements() *plugin.Capabilities
  • func (e Wrapper) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Wrapper) Version() int

Functions

func WrapInput

func WrapInput(input *filesystem.ScanInput) lockfile.DepFile

WrapInput returns an implementation of OSVs DepFile using a scalibr ScanInput.

Types

type DepGroupMetadata

type DepGroupMetadata struct {
	DepGroupVals []string
}

DepGroupMetadata is a metadata struct that only supports DepGroups

func (DepGroupMetadata) DepGroups

func (dgm DepGroupMetadata) DepGroups() []string

DepGroups return the dependency groups property in the metadata

type DepGroups

type DepGroups interface {
	DepGroups() []string
}

DepGroups provides access to the list of dependency groups an inventory item belongs to. Dependency groups are used by many language package managers as a way to organize dependencies (e.g. development dependencies will be in the "dev" group)

type Metadata

type Metadata struct {
	PURLType  string
	Commit    string
	Ecosystem string
	CompareAs string
}

Metadata holds parsing information for packages extracted by an OSV extractor wrapper.

type Wrapper

type Wrapper struct {
	ExtractorName    string
	ExtractorVersion int
	PURLType         string
	Extractor        lockfile.Extractor

	// Optional. A stats.Collector for reporting internal metrics.
	Stats stats.Collector

	// Optional. A config value for the maximum file size this extractor will
	// treat as required in `FileRequired`.
	MaxFileSizeBytes int64
}

Wrapper contains all the data to wrap a osv extractor to a scalibr extractor.

func (Wrapper) Ecosystem

func (e Wrapper) Ecosystem(i *extractor.Inventory) string

Ecosystem returns the OSV Ecosystem of the software extracted by this extractor.

func (Wrapper) Extract

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

Extract wraps the osv Extract method.

func (Wrapper) FileRequired

func (e Wrapper) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the specified file matches the extractor pattern.

func (Wrapper) Name

func (e Wrapper) Name() string

Name of the extractor.

func (Wrapper) Requirements

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

Requirements of the extractor.

func (Wrapper) ToPURL

func (e Wrapper) ToPURL(i *extractor.Inventory) *purl.PackageURL

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

func (Wrapper) Version

func (e Wrapper) Version() int

Version of the extractor.