cyclonedx

Documentation

Index

• Constants
• Variables
• func DecodeJSON(r io.Reader) (*cdx.BOM, error)
• func IsTrivySBOM(c *cdx.BOM) bool
• type BOM
  • func (b *BOM) UnmarshalJSON(data []byte) error
• type Marshaler
  • func NewMarshaler(version string) Marshaler
  • func (*Marshaler) Hashes(files []core.File) *[]cdx.Hash
  • func (*Marshaler) Licenses(licenses []string) *cdx.Licenses
  • func (m *Marshaler) Marshal(ctx context.Context, bom *core.BOM) (*cdx.BOM, error)
  • func (m *Marshaler) MarshalComponent(component *core.Component) (*cdx.Component, error)
  • func (m *Marshaler) MarshalReport(ctx context.Context, report types.Report) (*cdx.BOM, error)
  • func (m *Marshaler) MarshalRoot() (*cdx.Component, error)
  • func (m *Marshaler) Metadata(ctx context.Context) *cdx.Metadata
  • func (*Marshaler) PackageURL(p *packageurl.PackageURL) string
  • func (*Marshaler) Properties(properties []core.Property) *[]cdx.Property
  • func (*Marshaler) Supplier(supplier string) *cdx.OrganizationalEntity

Constants

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

Variables

var (
	ErrUnsupportedType = errors.New("unsupported type")
)

Functions

func DecodeJSON

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

func IsTrivySBOM

func IsTrivySBOM(c *cdx.BOM) bool

Types

type BOM

type BOM struct {
	*core.BOM
}

func (*BOM) UnmarshalJSON

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

type Marshaler

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

func NewMarshaler

func NewMarshaler(version string) Marshaler

func (*Marshaler) Hashes

func (*Marshaler) Hashes(files []core.File) *[]cdx.Hash

func (*Marshaler) Licenses

func (*Marshaler) Licenses(licenses []string) *cdx.Licenses

func (*Marshaler) Marshal

func (m *Marshaler) Marshal(ctx context.Context, bom *core.BOM) (*cdx.BOM, error)

Marshal converts the Trivy component to the CycloneDX format

func (*Marshaler) MarshalComponent

func (m *Marshaler) MarshalComponent(component *core.Component) (*cdx.Component, error)

func (*Marshaler) MarshalReport

func (m *Marshaler) MarshalReport(ctx context.Context, report types.Report) (*cdx.BOM, error)

MarshalReport converts the Trivy report to the CycloneDX format

func (*Marshaler) MarshalRoot

func (m *Marshaler) MarshalRoot() (*cdx.Component, error)

func (*Marshaler) Metadata

func (m *Marshaler) Metadata(ctx context.Context) *cdx.Metadata

func (*Marshaler) PackageURL

func (*Marshaler) PackageURL(p *packageurl.PackageURL) string

func (*Marshaler) Properties

func (*Marshaler) Properties(properties []core.Property) *[]cdx.Property

func (*Marshaler) Supplier

func (*Marshaler) Supplier(supplier string) *cdx.OrganizationalEntity