dpkg

Documentation

Overview

Package dpkg extracts packages from dpkg database.

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Config() Config
  • func (Extractor) Ecosystem(i *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.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(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int
• type Metadata

Constants

const (
	// Name is the unique name of this extractor.
	Name = "os/dpkg"
)

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
	// IncludeNotInstalled includes packages that are not installed
	// (e.g. `deinstall`, `purge`, and those missing a status field).
	IncludeNotInstalled bool
}

Config is the configuration for the Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the DPKG extractor.

type Extractor

type Extractor struct {
	// contains filtered or unexported fields
}

Extractor extracts packages from DPKG files.

func New

func New(cfg Config) *Extractor

New returns a DPKG extractor.

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

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Ecosystem

func (Extractor) Ecosystem(i *extractor.Inventory) string

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) ([]*extractor.Inventory, error)

Extract extracts packages from dpkg 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 dpkg status file pattern.

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(i *extractor.Inventory) *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.

type Metadata

type Metadata struct {
	PackageName       string
	Status            string
	SourceName        string
	SourceVersion     string
	PackageVersion    string
	OSID              string
	OSVersionCodename string
	OSVersionID       string
	Maintainer        string
	Architecture      string
}

Metadata holds parsing information for a dpkg package.