sbom

Documentation

Index

• Variables
• func Decode(f io.Reader, format Format) (types.SBOM, error)
• func IsCycloneDXJSON(r io.ReadSeeker) (bool, error)
• func IsCycloneDXXML(r io.ReadSeeker) (bool, error)
• func IsSPDXJSON(r io.ReadSeeker) (bool, error)
• func IsSPDXTV(r io.ReadSeeker) (bool, error)
• type Format
  • func DetectFormat(r io.ReadSeeker) (Format, error)

Variables

var ErrUnknownFormat = xerrors.New("Unknown SBOM format")

Functions

func Decode

func Decode(f io.Reader, format Format) (types.SBOM, error)

func IsCycloneDXJSON

func IsCycloneDXJSON(r io.ReadSeeker) (bool, error)

func IsCycloneDXXML

func IsCycloneDXXML(r io.ReadSeeker) (bool, error)

func IsSPDXJSON

func IsSPDXJSON(r io.ReadSeeker) (bool, error)

func IsSPDXTV

func IsSPDXTV(r io.ReadSeeker) (bool, error)

Types

type Format

type Format string

const (
	FormatCycloneDXJSON       Format = "cyclonedx-json"
	FormatCycloneDXXML        Format = "cyclonedx-xml"
	FormatSPDXJSON            Format = "spdx-json"
	FormatSPDXTV              Format = "spdx-tv"
	FormatSPDXXML             Format = "spdx-xml"
	FormatAttestCycloneDXJSON Format = "attest-cyclonedx-json"
	FormatUnknown             Format = "unknown"

	// FormatLegacyCosignAttestCycloneDXJSON is used to support the older format of CycloneDX JSON Attestation
	// produced by the Cosign V1.
	// ref. https://github.com/sigstore/cosign/pull/2718
	FormatLegacyCosignAttestCycloneDXJSON Format = "legacy-cosign-attest-cyclonedx-json"

	// PredicateCycloneDXBeforeV05 is the PredicateCycloneDX value defined in in-toto-golang before v0.5.0.
	// This is necessary for backward-compatible SBOM detection.
	// ref. https://github.com/in-toto/in-toto-golang/pull/188
	PredicateCycloneDXBeforeV05 = "https://cyclonedx.org/schema"
)

func DetectFormat

func DetectFormat(r io.ReadSeeker) (Format, error)