bomdag

Documentation

Index

• func EdgeDependencyType(dependencyType BomDAGDependencyType) func(*graph.EdgeProperties)
• type BomDAG
  • func NewBomDAG() BomDAG
  • func (bomDAG *BomDAG) AddCDXComponent(value cdx.Component, options ...func(*graph.VertexProperties)) (valueHash BomDAGVertexHash, err error)
  • func (bomDAG *BomDAG) GetCDXComponents() ([]cdx.Component, map[cdx.BOMReference][]string, error)
  • func (bomDAG *BomDAG) Merge(other BomDAG) error
  • func (bomDAG *BomDAG) WriteToFile(filenamePrefix string)
• type BomDAGDependencyType
• type BomDAGVertexHash

Functions

func EdgeDependencyType

func EdgeDependencyType(dependencyType BomDAGDependencyType) func(*graph.EdgeProperties)

Types

type BomDAG

type BomDAG struct {
	graph.Graph[BomDAGVertexHash, bomDAGVertex]
	Root BomDAGVertexHash // Hash of the root component
}

BomDAG represents a directed, acyclic graph of several interconnected components

func NewBomDAG

func NewBomDAG() BomDAG

func (*BomDAG) AddCDXComponent

func (bomDAG *BomDAG) AddCDXComponent(value cdx.Component, options ...func(*graph.VertexProperties)) (valueHash BomDAGVertexHash, err error)

Add a component to this graph; This should be mainly used to add components to the graph

func (*BomDAG) GetCDXComponents

func (bomDAG *BomDAG) GetCDXComponents() ([]cdx.Component, map[cdx.BOMReference][]string, error)

Generate slice of cyclonedx-go components from the graph; also return a map of dependencies (e.g. "bomref1" depends on "bomref2" and "bomref3")

func (*BomDAG) Merge

func (bomDAG *BomDAG) Merge(other BomDAG) error

Merge other into the BomDag this method was called on

func (*BomDAG) WriteToFile

func (bomDAG *BomDAG) WriteToFile(filenamePrefix string)

Write a graphical representation of the graph to a file

type BomDAGDependencyType

type BomDAGDependencyType string

Type defining the different types of dependencies that components can have in the BomDAG

const (
	BomDAGDependencyTypeDependsOn                                            BomDAGDependencyType = "dependsOn"
	BomDAGDependencyTypeCertificatePropertiesSignatureAlgorithmRef           BomDAGDependencyType = "CertificatePropertiesSignatureAlgorithmRef"
	BomDAGDependencyTypeCertificatePropertiesSubjectPublicKeyRef             BomDAGDependencyType = "CertificatePropertiesSubjectPublicKeyRef"
	BomDAGDependencyTypeRelatedCryptoMaterialPropertiesAlgorithmRef          BomDAGDependencyType = "RelatedCryptoMaterialPropertiesAlgorithmRef"
	BomDAGDependencyTypeRelatedCryptoMaterialPropertiesSecuredByAlgorithmRef BomDAGDependencyType = "RelatedCryptoMaterialPropertiessecuredByAlgorithmRef"
	BomDAGDependencyTypeProtocolPropertiesCryptoRefArrayElement              BomDAGDependencyType = "protocolPropertiescryptoRefArray"
	BomDAGDependencyTypeOccurrence                                           BomDAGDependencyType = "occurrence"
)

type BomDAGVertexHash

type BomDAGVertexHash = [8]byte

Type that hold the hash of a BomDAG vertex