sbomutil

Documentation

Index

• type SBOMCreator
  • func NewSBOMCreator(ctx context.Context, gcsClient *storage.Client, files *fs.Files) *SBOMCreator
  • func (s *SBOMCreator) GenerateSBOM(sourceImage, actualOutputImage *config.Image) error
  • func (s *SBOMCreator) ParseSBOMInput(sbomInputPath string) error
  • func (s *SBOMCreator) UploadSBOMToGCS(outputGCSPath string) error
• type SBOMInput
• type SBOMPackage

Types

type SBOMCreator

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

func NewSBOMCreator

func NewSBOMCreator(ctx context.Context, gcsClient *storage.Client, files *fs.Files) *SBOMCreator

NewSBOMCreator creates a new SBOMCreator.

func (*SBOMCreator) GenerateSBOM

func (s *SBOMCreator) GenerateSBOM(sourceImage, actualOutputImage *config.Image) error

GenerateSBOM uses the parsed input to generate an SPDX SBOM.

func (*SBOMCreator) ParseSBOMInput

func (s *SBOMCreator) ParseSBOMInput(sbomInputPath string) error

ParseSBOMInput parses the user input and saves the result in the SBOMCreator.

func (*SBOMCreator) UploadSBOMToGCS

func (s *SBOMCreator) UploadSBOMToGCS(outputGCSPath string) error

UploadSBOMToGCS uploads the generated SBOM to GCS in JSON format.

type SBOMInput

type SBOMInput struct {
	OutputImageName         string                  `json:"outputImageName,omitempty"`
	OutputImageVersion      string                  `json:"outputImageVersion,omitempty"`
	Creators                []string                `json:"creators"`
	Supplier                string                  `json:"supplier,omitempty"`
	SPDXPackages            []*spdx2_2.Package      `json:"SPDXPackages,omitempty"`
	SBOMPackages            []*SBOMPackage          `json:"SBOMPackages,omitempty"`
	ExtractedLicensingInfos []*spdx2_2.OtherLicense `json:"hasExtractedLicensingInfos,omitempty"`
}

type SBOMPackage

type SBOMPackage struct {
	Name          string                        `json:"name"`
	SpdxDocument  string                        `json:"spdxDocument"`
	Algorithm     spdx_common.ChecksumAlgorithm `json:"algorithm"`
	ChecksumValue string                        `json:"checksumValue"`
}