cyclonedx

Documentation

Index

• type Component
• type CycloneDX
  • func New(fs apkfs.FullFS) CycloneDX
  • func (cdx *CycloneDX) Ext() string
  • func (cdx *CycloneDX) Generate(opts *options.Options, path string) error
  • func (cdx *CycloneDX) GenerateIndex(opts *options.Options, path string) error
  • func (cdx *CycloneDX) Key() string
• type Dependency
• type Document
• type ExternalReference
• type Hash
• type HashAlgorithm
• type License

Types

type Component

type Component struct {
	BOMRef             string              `json:"bom-ref"`
	Type               string              `json:"type"`
	Name               string              `json:"name"`
	Version            string              `json:"version"`
	Description        string              `json:"description"`
	PUrl               string              `json:"purl"`
	Hashes             []Hash              `json:"hashes,omitempty"`
	ExternalReferences []ExternalReference `json:"externalReferences,omitempty"`
	Licenses           []License           `json:"licenses,omitempty"`
	Components         []Component         `json:"components,omitempty"`
}

type CycloneDX

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

func New

func New(fs apkfs.FullFS) CycloneDX

func (*CycloneDX) Ext

func (cdx *CycloneDX) Ext() string

func (*CycloneDX) Generate

func (cdx *CycloneDX) Generate(opts *options.Options, path string) error

Generate writes a CycloneDX sbom in path

func (*CycloneDX) GenerateIndex

func (cdx *CycloneDX) GenerateIndex(opts *options.Options, path string) error

func (*CycloneDX) Key

func (cdx *CycloneDX) Key() string

type Dependency

type Dependency struct {
	Ref       string   `json:"ref"`
	DependsOn []string `json:"dependsOn"`
}

type Document

type Document struct {
	BOMFormat    string       `json:"bomFormat"`
	SpecVersion  string       `json:"specVersion"`
	Version      int          `json:"version"`
	Components   []Component  `json:"components,omitempty"`
	Dependencies []Dependency `json:"dependencies,omitempty"`
}

TODO(kaniini): Move most of this over to gitlab.alpinelinux.org/alpine/go.

type ExternalReference

type ExternalReference struct {
	URL  string `json:"url"`
	Type string `json:"type"`
}

type Hash

type Hash struct {
	Algorithm HashAlgorithm `json:"alg"`
	Value     string        `json:"content"`
}

type HashAlgorithm

type HashAlgorithm string

type License

type License struct {
	Expression string `json:"expression"`
}