cyclonedx

package

v0.0.0-...-82b092a Latest Latest Go to latest Published: Feb 25, 2023 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/w3security/cvescan

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 ¶

View Source

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 ¶

View Source

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

View Source

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 cvescan report to the CycloneDX format

func (*Marshaler) MarshalVulnerabilities ¶

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

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL