vendored

package

v2.3.0 Latest Latest Go to latest Published: Nov 19, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/google/osv-scanner

Links

Open Source Insights

Documentation ¶

Overview ¶

Package vendored provides an extractor for vendored C/C++ code.

Index ¶

Constants
func Configure(plug plugin.Plugin, config Config)
func New() filesystem.Extractor
type Config
type Extractor

Constants ¶

View Source

const (
	// Name is the unique name of this extractor.
	Name = "filesystem/vendored"
)

Variables ¶

This section is empty.

Functions ¶

func Configure ¶ added in v2.0.3

func Configure(plug plugin.Plugin, config Config)

func New ¶ added in v2.2.0

func New() filesystem.Extractor

New returns a new instance of the extractor.

Types ¶

type Config ¶ added in v2.0.3

type Config 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
}

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) Configure ¶ added in v2.0.3

func (e *Extractor) Configure(config Config)

func (*Extractor) Ecosystem ¶

func (e *Extractor) Ecosystem(_ *extractor.Package) 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) (inventory.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.Package) *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.

Source Files ¶

View all Source files

vendored.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL