Documentation
¶
Overview ¶
Package rpm extracts packages from rpm database.
Index ¶
- Constants
- func NewDefault() filesystem.Extractor
- type Config
- type Extractor
- func (Extractor) Ecosystem(p *extractor.Package) string
- func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
- func (e Extractor) FileRequired(api filesystem.FileAPI) bool
- func (e Extractor) Name() string
- func (e Extractor) Requirements() *plugin.Capabilities
- func (e Extractor) ToPURL(p *extractor.Package) *purl.PackageURL
- func (e Extractor) Version() int
- type Metadata
Constants ¶
const Name = "os/rpm"
Name is the name for the RPM extractor
Variables ¶
This section is empty.
Functions ¶
func NewDefault ¶ added in v0.1.7
func NewDefault() filesystem.Extractor
NewDefault returns an extractor with the default config settings.
Types ¶
type Config ¶
type Config struct { // Stats is a stats collector for reporting metrics. Stats stats.Collector // MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If // `FileRequired` gets a bigger file, it will return false, MaxFileSizeBytes int64 // Timeout is the timeout duration for parsing the RPM database. Timeout time.Duration }
Config contains RPM specific configuration values
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the default configuration values for the RPM extractor.
type Extractor ¶
Extractor extracts rpm packages from rpm database.
func New ¶
New returns an RPM extractor.
For most use cases, initialize with: ``` e := New(DefaultConfig()) ```
func (Extractor) Ecosystem ¶ added in v0.1.3
Ecosystem returns the OSV Ecosystem of the software extracted by this extractor.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts packages from rpm status files passed through the scan input.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file matches rpm status file pattern.
func (Extractor) Requirements ¶ added in v0.1.3
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.