cyclonedx

Documentation

Index

• Constants
• Variables
• func WithClock(clock clock.Clock) marshalOption
• func WithNewUUID(newUUID newUUID) marshalOption
• type CycloneDX
  • func (c *CycloneDX) UnmarshalJSON(b []byte) error
• 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)

Constants

const (
	ToolVendor = "aquasecurity"
	ToolName   = "trivy"
	Namespace  = ToolVendor + ":" + ToolName + ":"

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

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

	// Package properties
	PropertyPkgID           = "PkgID"
	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")
)

var (
	ErrPURLEmpty = errors.New("purl empty error")
)

Functions

func WithClock

func WithClock(clock clock.Clock) marshalOption

func WithNewUUID

func WithNewUUID(newUUID newUUID) marshalOption

Types

type CycloneDX

type CycloneDX struct {
	*types.SBOM
	// contains filtered or unexported fields
}

func (*CycloneDX) UnmarshalJSON

func (c *CycloneDX) UnmarshalJSON(b []byte) error

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.