spdx

Documentation

Overview

Package spdx extracts software dependencies from an SPDX SBOM.

Index

• type Extractor
  • func (e Extractor) Extract(ctx context.Context, input *extractor.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(path string, _ fs.FileMode) 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

Types

type Extractor

type Extractor struct{}

Extractor extracts software dependencies from an spdx SBOM.

func (Extractor) Extract

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

Extract parses the SPDX SBOM and returns a list purls from the SBOM.

func (Extractor) FileRequired

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

FileRequired returns true if the specified file is a supported spdx file.

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 converts an inventory created by this extractor into a list of CPEs.

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 {
	PURL *purl.PackageURL
	CPEs []string
}

Metadata holds parsing information for packages extracted from SPDX files.