generate

Documentation

Overview

Package generate exposes cyclonedx-gomod's SBOM generation capabilities.

Index

• type Generator

Types

type Generator

type Generator interface {
	Generate() (*cdx.BOM, error)
}

Generator is the interface that provides abstraction for multiple BOM generation strategies.

Generators MUST only consider facts. Results MUST be reproducible. The returned BOM MUST NOT include any of the following elements:

• SerialNumber
• Metadata.Timestamp
• Metadata.Tools
• Metadata.Authors
• Metadata.Manufacture
• Metadata.Supplier
• Metadata.Licenses

It is the responsibility of the caller to ensure that these elements are set according to their context and use case.

At the very least, callers SHOULD set the SerialNumber and Metadata.Timestamp elements before publishing or forwarding the generated BOM.