cyclonedx

Documentation

Index

• Constants
• Variables
• func DecodeJSON(r io.Reader) (*cdx.BOM, error)
• type BOM
  • func (c *BOM) UnmarshalJSON(b []byte) error
• type Marshaler
  • func NewMarshaler(version string, opts ...core.Option) *Marshaler
  • func (e *Marshaler) Marshal(report types.Report) (*cdx.BOM, error)
  • func (e *Marshaler) MarshalReport(r types.Report) (*core.Component, error)
• type Package

Constants

const (
	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 DecodeJSON

func DecodeJSON(r io.Reader) (*cdx.BOM, error)

Types

type BOM

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

func (*BOM) UnmarshalJSON

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

type Marshaler

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

func NewMarshaler

func NewMarshaler(version string, opts ...core.Option) *Marshaler

func (*Marshaler) Marshal

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

Marshal converts the Vul report to the CycloneDX format

func (*Marshaler) MarshalReport

func (e *Marshaler) MarshalReport(r types.Report) (*core.Component, error)

type Package

type Package struct {
	ftypes.Package
	Type            string
	Metadata        types.Metadata
	Vulnerabilities []types.DetectedVulnerability
}