sbom

Documentation

Index

• Variables
• type CycloneDX
  • func (c *CycloneDX) GetPackages(r io.ReadSeeker, callback func(Identifier) error) error
  • func (c *CycloneDX) MatchesRecognizedFileNames(path string) bool
  • func (c *CycloneDX) Name() string
• type Identifier
• type InvalidFormatError
  • func (e InvalidFormatError) Error() string
• type Reader
• type SPDX
  • func (s *SPDX) GetPackages(r io.ReadSeeker, callback func(Identifier) error) error
  • func (s *SPDX) MatchesRecognizedFileNames(path string) bool
  • func (s *SPDX) Name() string

Variables

var (
	Providers = []Reader{
		&SPDX{},
		&CycloneDX{},
	}
)

Types

type CycloneDX

type CycloneDX struct{}

func (*CycloneDX) GetPackages

func (c *CycloneDX) GetPackages(r io.ReadSeeker, callback func(Identifier) error) error

func (*CycloneDX) MatchesRecognizedFileNames

func (c *CycloneDX) MatchesRecognizedFileNames(path string) bool

func (*CycloneDX) Name

func (c *CycloneDX) Name() string

type Identifier

type Identifier struct {
	PURL string
}

Identifier is the identifier extracted from the SBOM.

type InvalidFormatError

type InvalidFormatError struct {
	Msg  string
	Errs []error
}

func (InvalidFormatError) Error

func (e InvalidFormatError) Error() string

type Reader

type Reader interface {
	Name() string
	// MatchesRecognizedFileNames checks if the file path is a standard recognized file name
	MatchesRecognizedFileNames(path string) bool
	GetPackages(r io.ReadSeeker, callback func(Identifier) error) error
}

Reader is an interface for all SBOM providers.

type SPDX

type SPDX struct{}

func (*SPDX) GetPackages

func (s *SPDX) GetPackages(r io.ReadSeeker, callback func(Identifier) error) error

func (*SPDX) MatchesRecognizedFileNames

func (s *SPDX) MatchesRecognizedFileNames(path string) bool

func (*SPDX) Name

func (s *SPDX) Name() string