cyclonedx

Documentation

Index

• Constants
• Variables
• func NewJSONUnmarshaler() sbom.Unmarshaler
• func WithClock(clock clock.Clock) marshalOption
• func WithNewUUID(newUUID newUUID) marshalOption
• type Marshaler
  • func NewMarshaler(version string, opts ...marshalOption) *Marshaler
  • func (e *Marshaler) Marshal(report types.Report) (*cdx.BOM, error)
  • func (e *Marshaler) MarshalVulnerabilities(report types.Report) (*cdx.BOM, error)
• type Unmarshaler
  • func (u *Unmarshaler) Unmarshal(r io.Reader) (sbom.SBOM, error)

Constants

const (
	Namespace = "aquasecurity:trivy:"

	PropertySchemaVersion = "SchemaVersion"
	PropertyType          = "Type"
	PropertyClass         = "Class"

	// Image properties
	PropertySize       = "Size"
	PropertyImageID    = "ImageID"
	PropertyRepoDigest = "RepoDigest"
	PropertyDiffID     = "DiffID"
	PropertyRepoTag    = "RepoTag"

	// Package properties
	PropertyPkgType         = "PkgType"
	PropertySrcName         = "SrcName"
	PropertySrcVersion      = "SrcVersion"
	PropertySrcRelease      = "SrcRelease"
	PropertySrcEpoch        = "SrcEpoch"
	PropertyModularitylabel = "Modularitylabel"
	PropertyFilePath        = "FilePath"
	PropertyLayerDigest     = "LayerDigest"
	PropertyLayerDiffID     = "LayerDiffID"
)

Variables

var (
	ErrInvalidBOMLink = xerrors.New("invalid bomLink format error")
)

Functions

func NewJSONUnmarshaler

func NewJSONUnmarshaler() sbom.Unmarshaler

func WithClock

func WithClock(clock clock.Clock) marshalOption

func WithNewUUID

func WithNewUUID(newUUID newUUID) marshalOption

Types

type Marshaler

type Marshaler struct {
	// contains filtered or unexported fields
}

func NewMarshaler

func NewMarshaler(version string, opts ...marshalOption) *Marshaler

func (*Marshaler) Marshal

func (e *Marshaler) Marshal(report types.Report) (*cdx.BOM, error)

Marshal converts the Trivy report to the CycloneDX format

func (*Marshaler) MarshalVulnerabilities

func (e *Marshaler) MarshalVulnerabilities(report types.Report) (*cdx.BOM, error)

MarshalVulnerabilities converts the Trivy report to the CycloneDX format only with vulnerabilities. The output refers to another CycloneDX SBOM.

type Unmarshaler

type Unmarshaler struct {
	// contains filtered or unexported fields
}

func (*Unmarshaler) Unmarshal

func (u *Unmarshaler) Unmarshal(r io.Reader) (sbom.SBOM, error)