cyclonedx.model.citation

This set of classes represents the data about Citations.

Note

Introduced in CycloneDX v1.7

Note

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

Classes

Citation

Details a specific attribution of data within the BOM to a contributing entity or process.

Module Contents

class cyclonedx.model.citation.Citation(*, timestamp: datetime.datetime, bom_ref: str | cyclonedx.model.bom_ref.BomRef | None = None, pointers: collections.abc.Iterable[str] | None = None, expressions: collections.abc.Iterable[str] | None = None, attributed_to: str | cyclonedx.model.bom_ref.BomRef | None = None, process: str | cyclonedx.model.bom_ref.BomRef | None = None, note: str | None = None)

Details a specific attribution of data within the BOM to a contributing entity or process.

Exactly one of pointers or expressions must be provided. At least one of attributed_to or process must be provided.

Note

Introduced in CycloneDX v1.7

Note

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

property pointers: SortedSet[str]

One or more JSON Pointers (RFC 6901) identifying the BOM fields to which the attribution applies. Users of other serialization formats (e.g. XML) shall use the JSON Pointer format as well.

Returns:

Set of str

property expressions: SortedSet[str]

One or more path expressions used to locate values within a BOM. Use JSONPath for JSON and XPath for XML.

Returns:

Set of str

property timestamp: datetime.datetime

The date and time when the attribution was made or the information was supplied.

Returns:

datetime

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

The bom-ref of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information.

Returns:

BomRef if set else None

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

The bom-ref to a process (such as a formula, workflow, task, or step) defined in the formulation section that executed or generated the attributed data.

Returns:

BomRef if set else None

property note: str | None

A description or comment about the context or quality of the data attribution.

Returns:

str if set else None

property bom_ref: cyclonedx.model.bom_ref.BomRef

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

Returns:

BomRef