cyclonedx.model.composition

This set of classes represents the compositions in the CycloneDX standard.

Note

Introduced in CycloneDX v1.3

Note

See the CycloneDX Schema for compositions: https://cyclonedx.org/docs/1.7/xml/#type_compositionType

Classes

AggregateType

Enum object that defines the permissible 'aggregate' types for a Composition according to the CycloneDX schema.

Composition

Models a Composition within a BOM.

Module Contents

class cyclonedx.model.composition.AggregateType

Bases: str, enum.Enum

Enum object that defines the permissible ‘aggregate’ types for a Composition according to the CycloneDX schema.

Specifies an aggregate type that describes how complete a relationship is.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_aggregateType

COMPLETE = 'complete'
INCOMPLETE = 'incomplete'
INCOMPLETE_FIRST_PARTY_ONLY = 'incomplete_first_party_only'
INCOMPLETE_FIRST_PARTY_PROPRIETARY_ONLY = 'incomplete_first_party_proprietary_only'
INCOMPLETE_FIRST_PARTY_OPENSOURCE_ONLY = 'incomplete_first_party_opensource_only'
INCOMPLETE_THIRD_PARTY_ONLY = 'incomplete_third_party_only'
INCOMPLETE_THIRD_PARTY_PROPRIETARY_ONLY = 'incomplete_third_party_proprietary_only'
INCOMPLETE_THIRD_PARTY_OPENSOURCE_ONLY = 'incomplete_third_party_opensource_only'
UNKNOWN = 'unknown'
NOT_SPECIFIED = 'not_specified'
class cyclonedx.model.composition.Composition(*, aggregate: AggregateType = AggregateType.NOT_SPECIFIED, assemblies: collections.abc.Iterable[_Assembly] | None = None, dependencies: collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef] | None = None, vulnerabilities: collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef] | None = None, bom_ref: str | cyclonedx.model.bom_ref.BomRef | None = None)

Models a Composition within a BOM.

property aggregate: AggregateType

Specifies an aggregate type that describes how complete a relationship is.

Returns:

AggregateType

property assemblies: _AssemblyRepository

The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts.

Returns:

Set of BomRef/XsUri

property dependencies: _BomRefRepository

The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part.

Returns:

Set of BomRef

property vulnerabilities: _BomRefRepository

The bom-ref identifiers of the vulnerabilities being described.

Returns:

Set of BomRef

property bom_ref: cyclonedx.model.bom_ref.BomRef | None

An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.

Returns:

BomRef