sbom

Documentation

Overview

Package sbom implements standardized SBoM tooling that allows multiple SBoM formats to be generated from the same scanning information.

Index

• Constants
• type Format
  • func (f Format) Extension() string
• type FormattedReader
  • func NewFormattedReader(s SBOM, f Format) *FormattedReader
  • func (f *FormattedReader) Read(b []byte) (int, error)
• type Formatter
  • func (f Formatter) Formats() []packit.SBOMFormat
• type SBOM
  • func Generate(path string) (SBOM, error)
  • func GenerateFromDependency(dependency postal.Dependency, path string) (SBOM, error)
  • func NewSBOM(syft sbom.SBOM) SBOM
  • func (s SBOM) InFormats(mediaTypes ...string) (Formatter, error)

Constants

const (
	CycloneDXFormat = "application/vnd.cyclonedx+json"
	SPDXFormat      = "application/spdx+json"
	SyftFormat      = "application/vnd.syft+json"
)

const UnknownCPE = "cpe:2.3:-:-:-:-:-:-:-:-:-:-:-"

UnknownCPE is a Common Platform Enumeration (CPE) that uses the NA (Not applicable) logical operator for all components of its name. It is designed not to match with other CPEs, to avoid false positive CPE matches.

Types

type Format

type Format string

Format is the type declaration for the supported SBoM output formats.

func (Format) Extension

func (f Format) Extension() string

Extension outputs the expected file extension for a given Format.

type FormattedReader

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

FormattedReader outputs the SBoM in a specified format.

func NewFormattedReader

func NewFormattedReader(s SBOM, f Format) *FormattedReader

NewFormattedReader creates an instance of FormattedReader given an SBOM and Format.

func (*FormattedReader) Read

func (f *FormattedReader) Read(b []byte) (int, error)

Read implements the io.Reader interface to output the contents of the formatted SBoM.

type Formatter

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

Formatter implements the packit.SBOMFormatter interface.

func (Formatter) Formats

func (f Formatter) Formats() []packit.SBOMFormat

Formats returns a list of packit.SBOMFormat instances.

type SBOM

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

SBOM holds the internal representation of the generated software bill-of-materials. This type can be combined with a FormattedReader to output the SBoM in a number of file formats.

func Generate

func Generate(path string) (SBOM, error)

Generate returns a populated SBOM given a path to a directory to scan.

func GenerateFromDependency

func GenerateFromDependency(dependency postal.Dependency, path string) (SBOM, error)

nolint Ignore SA1019, informed usage of deprecated package

func NewSBOM

func NewSBOM(syft sbom.SBOM) SBOM

func (SBOM) InFormats

func (s SBOM) InFormats(mediaTypes ...string) (Formatter, error)

InFormats returns a Formatter containing mappings for the given Formats.