component

Documentation

Index

• func AddCPE(c *cyclonedx.Component, cpe string)
• func AddDescription(c *cyclonedx.Component, description string)
• func AddLayer(c *cyclonedx.Component, layer string)
• func AddLicense(c *cyclonedx.Component, license string)
• func AddOrigin(c *cyclonedx.Component, origin string)
• func AddRawMetadata(c *cyclonedx.Component, metadata []byte)
• func AddRefQualifier(c *cyclonedx.Component, qualifiers map[string]string)
• func AddType(c *cyclonedx.Component, componentType string)
• func New(name, version, category string) *cyclonedx.Component

Functions

func AddCPE

func AddCPE(c *cyclonedx.Component, cpe string)

AddCPE adds a CPE to the given cyclonedx.Component. The CPE should be a CPE 2.3 identifier.

func AddDescription

func AddDescription(c *cyclonedx.Component, description string)

AddDescription adds a description to the given cyclonedx.Component. The description should be a found on the package's website or in the package's metadata.

func AddLayer

func AddLayer(c *cyclonedx.Component, layer string)

func AddLicense

func AddLicense(c *cyclonedx.Component, license string)

AddLicense adds a license to the given cyclonedx.Component. The license should be a SPDX license identifier.

https://spdx.org/licenses/

func AddOrigin

func AddOrigin(c *cyclonedx.Component, origin string)

AddOrigin adds an origin to the given cyclonedx.Component. The origin should be the package's location on the filesystem.

func AddRawMetadata

func AddRawMetadata(c *cyclonedx.Component, metadata []byte)

AddRawMetadata adds raw metadata to the given cyclonedx.Component. The metadata should be in string value.

func AddRefQualifier

func AddRefQualifier(c *cyclonedx.Component, qualifiers map[string]string)

func AddType

func AddType(c *cyclonedx.Component, componentType string)

AddType adds a type to the given cyclonedx.Component. The type should be one of the package types defined in the Scanner Module.

func New

func New(name, version, category string) *cyclonedx.Component

New creates a new cyclonedx.Component with the given name, version, and category.