standalone

package

v0.3.0 Latest Latest Go to latest Published: Jun 12, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Details

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

Repository

github.com/google/osv-scalibr

Links

Open Source Insights

Documentation ¶

Overview ¶

Package standalone provides a way to extract in a standalone mode (e.g. a command).

Index ¶

func Run(ctx context.Context, config *Config) (inventory.Inventory, []*plugin.Status, error)
type Config
type Extractor
type ScanInput

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(ctx context.Context, config *Config) (inventory.Inventory, []*plugin.Status, error)

Run the extractors that are specified in the config.

Types ¶

type Config ¶

type Config struct {
	Extractors []Extractor
	ScanRoot   *scalibrfs.ScanRoot
}

Config for running standalone extractors.

type Extractor ¶

type Extractor interface {
	extractor.Extractor
	// Extract the information.
	Extract(ctx context.Context, input *ScanInput) (inventory.Inventory, error)
}

Extractor is an interface for plugins that extract information independently. For example, a plugin that executes a command or retrieves information from only one file.

type ScanInput ¶

type ScanInput struct {
	// The root of the artifact being scanned.
	ScanRoot *scalibrfs.ScanRoot
}

ScanInput provides information for the extractor about the scan.

Source Files ¶

View all Source files

standalone.go

Directories ¶

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

Path	Synopsis
containers
containerd Package containerd extracts container inventory from containerd API.	Package containerd extracts container inventory from containerd API.
containerd/fakeclient Package fakeclient contains a fake implementation of the containerd client for testing purposes.	Package fakeclient contains a fake implementation of the containerd client for testing purposes.
docker Package docker extracts container inventory from docker API.	Package docker extracts container inventory from docker API.
docker/fakeclient Package fakeclient contains a fake implementation of the docker client for testing purposes.	Package fakeclient contains a fake implementation of the docker client for testing purposes.
list Package list contains the list of all standalone extractors.	Package list contains the list of all standalone extractors.
os
netports Package netports extracts open ports on the system and maps them to running processes when possible.	Package netports extracts open ports on the system and maps them to running processes when possible.
windows
common/metadata Package metadata provides metadata structures to annotate Windows packages.	Package metadata provides metadata structures to annotate Windows packages.
common/purl Package purl converts Windows application package details into a PackageURL.	Package purl converts Windows application package details into a PackageURL.
common/winproducts Package winproducts contains information about Windows products.	Package winproducts contains information about Windows products.
dismpatch Package dismpatch extract patch level from the DISM command line tool.	Package dismpatch extract patch level from the DISM command line tool.
dismpatch/dismparser Package dismparser has methods that can be used to parse DISM output	Package dismparser has methods that can be used to parse DISM output
ospackages Package ospackages extracts installed softwares on Windows.	Package ospackages extracts installed softwares on Windows.
regosversion Package regosversion extracts the OS version (build, major, minor release) from the registry.	Package regosversion extracts the OS version (build, major, minor release) from the registry.
regpatchlevel Package regpatchlevel extract patch level from the Windows registry.	Package regpatchlevel extract patch level from the Windows registry.