cyclonedxvex

Documentation

Index

• func NewBomMetadata(name, version string, srcMetadata *source.Metadata) *cyclonedx.Metadata
• func NewDocument(packages []pkg.Package, matches match.Matches, srcMetadata *source.Metadata, ...) (*cyclonedx.BOM, error)
• func NewVulnerability(m match.Match, p vulnerability.MetadataProvider) (cyclonedx.Vulnerability, error)
• type Presenter
  • func NewPresenter(results match.Matches, packages []pkg.Package, srcMetadata *source.Metadata, ...) *Presenter
  • func (pres *Presenter) Present(output io.Writer) error

Functions

func NewBomMetadata

func NewBomMetadata(name, version string, srcMetadata *source.Metadata) *cyclonedx.Metadata

NewBomMetadata returns a new BomDescriptor tailored for the current time and "syft" tool details.

func NewDocument

func NewDocument(packages []pkg.Package, matches match.Matches, srcMetadata *source.Metadata, provider vulnerability.MetadataProvider) (*cyclonedx.BOM, error)

NewDocument returns a CycloneDX Document object populated with the SBOM and vulnerability findings.

func NewVulnerability

func NewVulnerability(m match.Match, p vulnerability.MetadataProvider) (cyclonedx.Vulnerability, error)

NewVulnerability creates a Vulnerability document from a match and the metadata provider

Types

type Presenter

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

Presenter writes a CycloneDX report from the given Matches and Scope contents

func NewPresenter

func NewPresenter(results match.Matches, packages []pkg.Package, srcMetadata *source.Metadata, metadataProvider vulnerability.MetadataProvider, embedded bool, format cyclonedx.BOMFileFormat) *Presenter

NewPresenter is a *Presenter constructor

func (*Presenter) Present

func (pres *Presenter) Present(output io.Writer) error

Present creates a CycloneDX-based reporting