sbom

Documentation

Overview

Package sbom generates Software Bill of Materials in CycloneDX and SPDX formats.

Index

• func FormatCycloneDX(w io.Writer, result *Result) error
• func FormatSPDX(w io.Writer, result *Result) error
• type Component
• type Result
  • func Generate(ctx context.Context, paths []string, toolVersion string) (*Result, error)

Functions

func FormatCycloneDX

func FormatCycloneDX(w io.Writer, result *Result) error

func FormatSPDX

func FormatSPDX(w io.Writer, result *Result) error

Types

type Component

type Component struct {
	Name      string
	Version   string
	Ecosystem string
	PURL      string
}

Component represents a single package in the SBOM.

type Result

type Result struct {
	Tool       string
	Version    string
	Timestamp  time.Time
	Components []Component
}

Result holds the SBOM data.

func Generate

func Generate(ctx context.Context, paths []string, toolVersion string) (*Result, error)

Generate extracts all packages from the given paths and returns an SBOM result.