Documentation
¶
Overview ¶
Package sbom implements standardized SBoM tooling that allows multiple SBoM formats to be generated from the same scanning information.
Index ¶
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.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Format ¶
type Format string
Format is the type declaration for the supported SBoM output formats.
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.
type Formatter ¶
type Formatter struct {
// contains filtered or unexported fields
}
Formatter implements the packit.SBOMFormatter interface.
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 GenerateFromDependency ¶
func GenerateFromDependency(dependency postal.Dependency, path string) (SBOM, error)
nolint Ignore SA1019, informed usage of deprecated package
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
spdxlicense
Code generated by go generate; DO NOT EDIT.
|
Code generated by go generate; DO NOT EDIT. |
|
version
Package version contains all build time metadata (version, build time, git commit, etc).
|
Package version contains all build time metadata (version, build time, git commit, etc). |