Documentation
¶
Overview ¶
Package sbom generates Software Bills of Materials by shelling out to Syft.
The document type and the Generator contract live in pkg/sbom; this package is the Syft implementation, kept internal so it can use internal/git and internal/toolexec.
Index ¶
Constants ¶
View Source
const Binary = "syft"
Binary is the tool Generate requires on PATH.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
Generator produces SBOMs. The zero value is not usable; use New.
func New ¶
func New() *Generator
New returns a Generator that shells out to Syft and clones with git.
func (*Generator) Generate ¶
func (g *Generator) Generate(ctx context.Context, component string, t plugin.Target, format saga.SBOMFormat) (pkgsbom.Document, error)
Generate produces an SBOM for one target. Repositories are checked out first; images are handed to Syft by reference, which reads the registry directly and needs no local copy.
Source Files
Click to show internal directories.
Click to hide internal directories.