sbom

Documentation

Index

• func SBOMFormatToSyftOutputFormat(format libcnb.SBOMFormat) string
• type SBOMScanner
• type SyftArtifact
  • func (s SyftArtifact) Hash() (string, error)
• type SyftCLISBOMScanner
  • func NewSyftCLISBOMScanner(layers libcnb.Layers, executor effect.Executor, logger bard.Logger) SyftCLISBOMScanner
  • func (b SyftCLISBOMScanner) ConvertCycloneDXXMLtoJSON(inputPath string, backup bool) error
  • func (b SyftCLISBOMScanner) ScanBuild(scanDir string, formats ...libcnb.SBOMFormat) error
  • func (b SyftCLISBOMScanner) ScanLaunch(scanDir string, formats ...libcnb.SBOMFormat) error
  • func (b SyftCLISBOMScanner) ScanLayer(layer libcnb.Layer, scanDir string, formats ...libcnb.SBOMFormat) error
• type SyftDependency
  • func NewSyftDependency(dependencyPath string, artifacts []SyftArtifact) SyftDependency
  • func (s SyftDependency) WriteTo(path string) error
• type SyftDescriptor
• type SyftLocation
• type SyftSchema
• type SyftSource

Functions

func SBOMFormatToSyftOutputFormat

func SBOMFormatToSyftOutputFormat(format libcnb.SBOMFormat) string

SBOMFormatToSyftOutputFormat converts a libcnb.SBOMFormat to the syft matching syft output format string

Types

type SBOMScanner

type SBOMScanner interface {
	ScanLayer(layer libcnb.Layer, scanDir string, formats ...libcnb.SBOMFormat) error
	ScanBuild(scanDir string, formats ...libcnb.SBOMFormat) error
	ScanLaunch(scanDir string, formats ...libcnb.SBOMFormat) error
}

type SyftArtifact

type SyftArtifact struct {
	ID        string
	Name      string
	Version   string
	Type      string
	FoundBy   string
	Locations []SyftLocation
	Licenses  []string
	Language  string
	CPEs      []string
	PURL      string
}

func (SyftArtifact) Hash

func (s SyftArtifact) Hash() (string, error)

type SyftCLISBOMScanner

type SyftCLISBOMScanner struct {
	Executor effect.Executor
	Layers   libcnb.Layers
	Logger   bard.Logger
}

func NewSyftCLISBOMScanner

func NewSyftCLISBOMScanner(layers libcnb.Layers, executor effect.Executor, logger bard.Logger) SyftCLISBOMScanner

func (SyftCLISBOMScanner) ConvertCycloneDXXMLtoJSON

func (b SyftCLISBOMScanner) ConvertCycloneDXXMLtoJSON(inputPath string, backup bool) error

ConvertCycloneDXXMLtoJSON reads input CycloneDX XML, converts to JSON and overwrites the XML optionally keeping a backup copy of the xml

func (SyftCLISBOMScanner) ScanBuild

func (b SyftCLISBOMScanner) ScanBuild(scanDir string, formats ...libcnb.SBOMFormat) error

ScanBuild will use syft CLI to scan the scanDir and write it's output to the build SBoM file in the given formats

func (SyftCLISBOMScanner) ScanLaunch

func (b SyftCLISBOMScanner) ScanLaunch(scanDir string, formats ...libcnb.SBOMFormat) error

ScanLaunch will use syft CLI to scan the scanDir and write it's output to the launch SBoM file in the given formats

func (SyftCLISBOMScanner) ScanLayer

func (b SyftCLISBOMScanner) ScanLayer(layer libcnb.Layer, scanDir string, formats ...libcnb.SBOMFormat) error

ScanLayer will use syft CLI to scan the scanDir and write it's output to the layer SBoM file in the given formats

type SyftDependency

type SyftDependency struct {
	Artifacts  []SyftArtifact
	Source     SyftSource
	Descriptor SyftDescriptor
	Schema     SyftSchema
}

func NewSyftDependency

func NewSyftDependency(dependencyPath string, artifacts []SyftArtifact) SyftDependency

func (SyftDependency) WriteTo

func (s SyftDependency) WriteTo(path string) error

type SyftDescriptor

type SyftDescriptor struct {
	Name    string
	Version string
}

type SyftLocation

type SyftLocation struct {
	Path string
}

type SyftSchema

type SyftSchema struct {
	Version string
	URL     string
}

type SyftSource

type SyftSource struct {
	Type   string
	Target string
}