rpm

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(path string, _ fs.FileInfo) bool
  • func (e Extractor) Name() string
  • func (e Extractor) ToCPEs(i *extractor.Inventory) ([]string, error)
  • func (e Extractor) ToPURL(i *extractor.Inventory) (*purl.PackageURL, error)
  • func (e Extractor) Version() int
• type Metadata

Constants

const Name = "os/rpm"

Name is the name for the RPM extractor

Types

type Config

type Config struct {
	Stats            stats.Collector
	MaxFileSizeBytes int64
	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

type Extractor struct{}

Extractor extracts rpm packages from rpm database.

func New

func New(cfg Config) *Extractor

New returns an RPM extractor.

For most use cases, initialize with: ``` e := New(DefaultConfig()) ```

func (Extractor) Extract

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

Extract extracts packages from rpm status files passed through the scan input.

func (Extractor) FileRequired

func (e Extractor) FileRequired(path string, _ fs.FileInfo) bool

FileRequired always returns false as RPM extractor is not supported.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) ToCPEs

func (e Extractor) ToCPEs(i *extractor.Inventory) ([]string, error)

ToCPEs is not applicable as this extractor does not infer CPEs from the Inventory.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) (*purl.PackageURL, error)

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

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.

type Metadata

type Metadata struct {
	PackageName  string
	SourceRPM    string
	Epoch        int
	OSName       string
	OSID         string
	OSVersionID  string
	OSBuildID    string
	Vendor       string
	Architecture string
	License      string
}

Metadata holds parsing information for an rpm package.