cyclonedx.model.definition

Classes

CreId	Helper class that allows us to perform validation on data strings that must conform to
Requirement	A requirement comprising a standard.
Level	Level of compliance for a standard.
Standard	A standard of regulations, industry or organizational-specific standards, maturity models, best practices,
Definitions	The repository for definitions

Module Contents

class cyclonedx.model.definition.CreId(id: str)

Helper class that allows us to perform validation on data strings that must conform to Common Requirements Enumeration (CRE) identifier(s).

property id: str

classmethod serialize(o: Any) → str

classmethod deserialize(o: Any) → _T_CreId

class cyclonedx.model.definition.Requirement

A requirement comprising a standard.

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/json/#definitions_standards_items_requirements

identifier: str | None

The identifier of the requirement.

title: str | None

The title of the requirement.

text: str | None

The text of the requirement.

property bom_ref: cyclonedx.model.bom_ref.BomRef

An optional identifier which can be used to reference the requirement elsewhere in the BOM.

property descriptions: SortedSet[str]

A SortedSet of descriptions of the requirement.

property open_cre: SortedSet[CreId]

The Common Requirements Enumeration (CRE) identifier(s).

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

The optional bom-ref to a parent requirement.

property properties: SortedSet[Property]

Properties in a key/value store.

property external_references: SortedSet[ExternalReference]

External references related to the component.

class cyclonedx.model.definition.Level

Level of compliance for a standard.

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/json/#definitions_standards_items_levels

identifier: str | None

The identifier of the level.

title: str | None

The title of the level.

description: str | None

The description of the level.

property bom_ref: cyclonedx.model.bom_ref.BomRef

An optional identifier which can be used to reference the level elsewhere in the BOM.

property requirements: SortedSet[BomRef]

A SortedSet of requirements associated with the level.

class cyclonedx.model.definition.Standard

A standard of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements.

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/xml/#type_standard

name: str | None

The name of the standard.

version: str | None

The version of the standard.

description: str | None

The description of the standard.

owner: str | None

The owner of the standard.

property bom_ref: cyclonedx.model.bom_ref.BomRef

An optional identifier which can be used to reference the standard elsewhere in the BOM.

property requirements: SortedSet[Requirement]

A SortedSet of requirements comprising the standard.

property levels: SortedSet[Level]

A SortedSet of levels associated with the standard.

property external_references: SortedSet[ExternalReference]

A SortedSet of external references associated with the standard.

class cyclonedx.model.definition.Definitions

The repository for definitions

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/xml/#type_definitionsType

property standards: SortedSet[Standard]

A SortedSet of Standards.