sbom

Documentation

Index

• Variables
• func ReadPackageIndex(opts *options.Options, path string) (packages []*repository.Package, err error)
• type SBOM
  • func New() *SBOM
  • func NewWithWorkDir(path string, a types.Architecture) *SBOM
  • func (s *SBOM) Generate() ([]string, error)
  • func (s *SBOM) GenerateIndex() ([]string, error)
  • func (s *SBOM) ReadLayerTarball(path string) error
  • func (s *SBOM) ReadPackageIndex() error
  • func (s *SBOM) ReadReleaseData() error
  • func (s *SBOM) SetImplementation(impl sbomImplementation)

Variables

var DefaultOptions = options.Options{
	OS: options.OSInfo{
		ID:      "unknown",
		Name:    "Alpine Linux",
		Version: "Unknown",
	},
	ImageInfo: options.ImageInfo{
		Images: []options.ArchImageInfo{},
	},
	FileName: "sbom",
	Formats:  []string{"spdx", "cyclonedx"},
}

Functions

func ReadPackageIndex

func ReadPackageIndex(opts *options.Options, path string) (packages []*repository.Package, err error)

Types

type SBOM

type SBOM struct {
	Generators map[string]generator.Generator

	Options options.Options
	// contains filtered or unexported fields
}

func New

func New() *SBOM

func NewWithWorkDir

func NewWithWorkDir(path string, a types.Architecture) *SBOM

NewWithWorkDir returns a new sbom object with a working dir preset

func (*SBOM) Generate

func (s *SBOM) Generate() ([]string, error)

Generate creates the sboms according to the options set

func (*SBOM) GenerateIndex

func (s *SBOM) GenerateIndex() ([]string, error)

Generate creates the sboms according to the options set

func (*SBOM) ReadLayerTarball

func (s *SBOM) ReadLayerTarball(path string) error

ReadLayerTarball reads an apko layer tarball and adds its metadata to the SBOM options

func (*SBOM) ReadPackageIndex

func (s *SBOM) ReadPackageIndex() error

ReadPackageIndex parses the package index in the working directory and returns a slice of the installed packages

func (*SBOM) ReadReleaseData

func (s *SBOM) ReadReleaseData() error

func (*SBOM) SetImplementation

func (s *SBOM) SetImplementation(impl sbomImplementation)