obom

Documentation

Index

• Constants
• func GetAnnotations(sbom *v2_3.Document) (map[string]string, error)
• func GetFileDescriptor(filename string) (*oci.Descriptor, error)
• func GetFiles(sbom *v2_3.Document) ([]string, error)
• func GetPackages(sbom *v2_3.Document) ([]string, error)
• func LoadSBOM(filename string) (*v2_3.Document, *oci.Descriptor, error)
• func PrintSBOMSummary(doc *v2_3.Document, desc *oci.Descriptor)
• func PushFiles(filename string, reference string, spdx_annotations map[string]string, ...) error

Constants

const (
	OCI_ANNOTATION_DOCUMENT_NAME      = "org.spdx.name"
	OCI_ANNOTATION_DATA_LICENSE       = "org.spdx.license"
	OCI_ANNOTATION_DOCUMENT_NAMESPACE = "org.spdx.namespace"
	OCI_ANNOTATION_SPDX_VERSION       = "org.spdx.version"
	OCI_ANNOTATION_CREATION_DATE      = "org.spdx.created"
	OCI_ANNOTATION_ANNOTATOR          = "org.spdx.annotator"
	OCI_ANNOTATION_ANNOTATION_DATE    = "org.spdx.annotation_date"
)

const (
	MEDIATYPE_SPDX = "application/spdx+json"
)

Functions

func GetAnnotations

func GetAnnotations(sbom *v2_3.Document) (map[string]string, error)

GetAnnotations returns the annotations from the SBOM

func GetFileDescriptor

func GetFileDescriptor(filename string) (*oci.Descriptor, error)

func GetFiles

func GetFiles(sbom *v2_3.Document) ([]string, error)

func GetPackages

func GetPackages(sbom *v2_3.Document) ([]string, error)

GetPackages returns the packages from the SBOM

func LoadSBOM

func LoadSBOM(filename string) (*v2_3.Document, *oci.Descriptor, error)

LoadSBOM loads an SPDX file into memory

func PrintSBOMSummary

func PrintSBOMSummary(doc *v2_3.Document, desc *oci.Descriptor)

PrintSBOMSummary returns the SPDX summary from the SBOM

func PushFiles

func PushFiles(filename string, reference string, spdx_annotations map[string]string, username string, password string) error

PushFiles pushes the SPDX SBOM file to the registry