cyclonedx.model

Submodules

• cyclonedx.model.bom
• cyclonedx.model.bom_ref
• cyclonedx.model.component
• cyclonedx.model.dependency
• cyclonedx.model.impact_analysis
• cyclonedx.model.issue
• cyclonedx.model.release_note
• cyclonedx.model.service
• cyclonedx.model.vulnerability

Package Contents

Classes

SchemaVersion1Dot3	Helper class that provides a standard way to create an ABC using
SchemaVersion1Dot4	Helper class that provides a standard way to create an ABC using
ComparableTuple	Allows comparison of tuples, allowing for None values.
DataFlow	This is our internal representation of the dataFlowType simple type within the CycloneDX standard.
DataClassification	This is our internal representation of the dataClassificationType complex type within the CycloneDX standard.
Encoding	This is our internal representation of the encoding simple type within the CycloneDX standard.
AttachedText	This is our internal representation of the attachedTextType complex type within the CycloneDX standard.
HashAlgorithm	This is our internal representation of the hashAlg simple type within the CycloneDX standard.
HashType	This is our internal representation of the hashType complex type within the CycloneDX standard.
ExternalReferenceType	Enum object that defines the permissible 'types' for an External Reference according to the CycloneDX schema.
XsUri	Helper class that allows us to perform validation on data strings that are defined as xs:anyURI
ExternalReference	This is our internal representation of an ExternalReference complex type that can be used in multiple places within
License	This is our internal representation of licenseType complex type that can be used in multiple places within
LicenseChoice	This is our internal representation of licenseChoiceType complex type that can be used in multiple places within
Property	This is our internal representation of propertyType complex type that can be used in multiple places within
NoteText	This is our internal representation of the Note.text complex type that can be used in multiple places within
Note	This is our internal representation of the Note complex type that can be used in multiple places within
OrganizationalContact	This is our internal representation of the organizationalContact complex type that can be used in multiple places
OrganizationalEntity	This is our internal representation of the organizationalEntity complex type that can be used in multiple places
Tool	This is our internal representation of the toolType complex type within the CycloneDX standard.
IdentifiableAction	This is our internal representation of the identifiableActionType complex type.
Copyright	This is our internal representation of the copyrightsType complex type.

Functions

get_now_utc(→ datetime.datetime)
sha1sum(→ str)	Generate a SHA1 hash of the provided file.

Attributes

__ThisToolVersion
_T
ThisTool

cyclonedx.model.__ThisToolVersion = '4.2.0'

exception cyclonedx.model.InvalidLocaleTypeException

Bases: CycloneDxModelException

Raised when the supplied locale does not conform to ISO-639 specification.

Good examples:

• en

• en-US

• en-GB

• fr

• fr-CA

The language code MUST be lowercase. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign.

exception cyclonedx.model.InvalidUriException

Bases: CycloneDxModelException

Raised when a str is provided that needs to be a valid URI, but isn’t.

exception cyclonedx.model.MutuallyExclusivePropertiesException

Bases: CycloneDxModelException

Raised when mutually exclusive properties are provided.

exception cyclonedx.model.NoPropertiesProvidedException

Bases: CycloneDxModelException

Raised when attempting to construct a model class and providing NO values (where all properites are defined as Optional, but at least one is required).

exception cyclonedx.model.UnknownHashTypeException

Bases: CycloneDxModelException

Exception raised when we are unable to determine the type of hash from a composite hash string.

class cyclonedx.model.SchemaVersion1Dot3

Bases: BaseSchemaVersion

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version_enum: cyclonedx.schema.SchemaVersion

class cyclonedx.model.SchemaVersion1Dot4

Bases: BaseSchemaVersion

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version_enum: cyclonedx.schema.SchemaVersion

cyclonedx.model.get_now_utc() → datetime.datetime

cyclonedx.model.sha1sum(filename: str) → str

Generate a SHA1 hash of the provided file.

Args:

filename:

Absolute path to file to hash as str

Returns:

SHA-1 hash

cyclonedx.model._T

class cyclonedx.model.ComparableTuple

Bases: Tuple[Optional[_T], Ellipsis]

Allows comparison of tuples, allowing for None values.

__lt__(other: Any) → bool

Return self<value.

__gt__(other: Any) → bool

Return self>value.

class cyclonedx.model.DataFlow

Bases: str, enum.Enum

This is our internal representation of the dataFlowType simple type within the CycloneDX standard.

Note

See the CycloneDX Schema: https://cyclonedx.org/docs/1.4/xml/#type_dataFlowType

INBOUND = 'inbound'

OUTBOUND = 'outbound'

BI_DIRECTIONAL = 'bi-directional'

UNKNOWN = 'unknown'

class cyclonedx.model.DataClassification(*, flow: DataFlow, classification: str)

This is our internal representation of the dataClassificationType complex type within the CycloneDX standard.

Note

See the CycloneDX Schema for dataClassificationType: https://cyclonedx.org/docs/1.4/xml/#type_dataClassificationType

property flow: DataFlow

Specifies the flow direction of the data.

Valid values are: inbound, outbound, bi-directional, and unknown.

Direction is relative to the service.

• Inbound flow states that data enters the service

• Outbound flow states that data leaves the service

• Bi-directional states that data flows both ways

• Unknown states that the direction is not known

Returns:

DataFlow

property classification: str

Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.

Returns:

str

__eq__(other: object) → bool

Return self==value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.Encoding

Bases: str, enum.Enum

This is our internal representation of the encoding simple type within the CycloneDX standard.

Note

See the CycloneDX Schema: https://cyclonedx.org/docs/1.4/#type_encoding

BASE_64 = 'base64'

class cyclonedx.model.AttachedText(*, content: str, content_type: str = DEFAULT_CONTENT_TYPE, encoding: Encoding | None = None)

This is our internal representation of the attachedTextType complex type within the CycloneDX standard.

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.3/#type_attachedTextType

property content_type: str

Specifies the content type of the text. Defaults to text/plain if not specified.

Returns:

str

property encoding: Encoding | None

Specifies the optional encoding the text is represented in.

Returns:

Encoding if set else None

property content: str

The attachment data.

Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Returns:

str

DEFAULT_CONTENT_TYPE = 'text/plain'

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.HashAlgorithm

Bases: str, enum.Enum

This is our internal representation of the hashAlg simple type within the CycloneDX standard.

Note

See the CycloneDX Schema: https://cyclonedx.org/docs/1.3/#type_hashAlg

BLAKE2B_256 = 'BLAKE2b-256'

BLAKE2B_384 = 'BLAKE2b-384'

BLAKE2B_512 = 'BLAKE2b-512'

BLAKE3 = 'BLAKE3'

MD5 = 'MD5'

SHA_1 = 'SHA-1'

SHA_256 = 'SHA-256'

SHA_384 = 'SHA-384'

SHA_512 = 'SHA-512'

SHA3_256 = 'SHA3-256'

SHA3_384 = 'SHA3-384'

SHA3_512 = 'SHA3-512'

class cyclonedx.model.HashType(*, alg: HashAlgorithm, content: str)

This is our internal representation of the hashType complex type within the CycloneDX standard.

Note

See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.3/#type_hashType

property alg: HashAlgorithm

Specifies the algorithm used to create the hash.

Returns:

HashAlgorithm

property content: str

Hash value content.

Returns:

str

static from_composite_str(composite_hash: str) → HashType

Attempts to convert a string which includes both the Hash Algorithm and Hash Value and represent using our internal model classes.

Args:

composite_hash:

Composite Hash string of the format HASH_ALGORITHM:HASH_VALUE. Example: sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b.

Raises:

UnknownHashTypeException if the type of hash cannot be determined.

Returns:

An instance of HashType.

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.ExternalReferenceType

Bases: str, enum.Enum

Enum object that defines the permissible ‘types’ for an External Reference according to the CycloneDX schema.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.3/#type_externalReferenceType

ADVISORIES = 'advisories'

BOM = 'bom'

BUILD_META = 'build-meta'

BUILD_SYSTEM = 'build-system'

CHAT = 'chat'

DISTRIBUTION = 'distribution'

DOCUMENTATION = 'documentation'

ISSUE_TRACKER = 'issue-tracker'

LICENSE = 'license'

MAILING_LIST = 'mailing-list'

OTHER = 'other'

RELEASE_NOTES = 'release-notes'

SOCIAL = 'social'

SCM = 'vcs'

SUPPORT = 'support'

VCS = 'vcs'

WEBSITE = 'website'

class cyclonedx.model.XsUri(uri: str)

Bases: serializable.helpers.BaseHelper

Helper class that allows us to perform validation on data strings that are defined as xs:anyURI in CycloneDX schema.

Developers can just use this via str(XsUri(‘https://www.google.com’)).

Note

See XSD definition for xsd:anyURI: http://www.datypic.com/sc/xsd/t-xsd_anyURI.html

property uri: str

_INVALID_URI_REGEX

classmethod serialize(o: object) → str

classmethod deserialize(o: object) → XsUri

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

__str__() → str

Return str(self).

class cyclonedx.model.ExternalReference(*, type: ExternalReferenceType, url: XsUri, comment: str | None = None, hashes: Iterable[HashType] | None = None)

This is our internal representation of an ExternalReference complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.3/#type_externalReference

property url: XsUri

The URL to the external reference.

Returns:

XsUri

property comment: str | None

An optional comment describing the external reference.

Returns:

str if set else None

property type: ExternalReferenceType

Specifies the type of external reference.

There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the “other” type.

Returns:

ExternalReferenceType

property hashes: SortedSet[HashType]

The hashes of the external reference (if applicable).

Returns:

Set of HashType

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.License(*, id: str | None = None, name: str | None = None, text: AttachedText | None = None, url: XsUri | None = None)

This is our internal representation of licenseType complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_licenseType

property id: str | None

A valid SPDX license ID

Returns:

str or None

property name: str | None

If SPDX does not define the license used, this field may be used to provide the license name.

Returns:

str or None

property text: AttachedText | None

Specifies the optional full text of the attachment

Returns:

AttachedText else None

property url: XsUri | None

The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness.

Returns:

XsUri or None

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.LicenseChoice(*, license: License | None = None, expression: str | None = None)

This is our internal representation of licenseChoiceType complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_licenseChoiceType

property license: License | None

License definition

Returns:

License or None

property expression: str | None

A valid SPDX license expression (not enforced).

Refer to https://spdx.org/specifications for syntax requirements.

Returns:

str or None

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.Property(*, name: str, value: str)

This is our internal representation of propertyType complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_propertyType

Specifies an individual property with a name and value.

property name: str

The name of the property.

Duplicate names are allowed, each potentially having a different value.

Returns:

str

property value: str

Value of this Property.

Returns:

str

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.NoteText(*, content: str, content_type: str | None = None, encoding: Encoding | None = None)

This is our internal representation of the Note.text complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_releaseNotesType

property content: str

Get the text content of this Note.

Returns:

str note content

property content_type: str | None

Get the content-type of this Note.

Defaults to ‘text/plain’ if one was not explicitly specified.

Returns:

str content-type

property encoding: Encoding | None

Get the encoding method used for the note’s content.

Returns:

Encoding if set else None

DEFAULT_CONTENT_TYPE: str = 'text/plain'

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.Note(*, text: NoteText, locale: str | None = None)

This is our internal representation of the Note complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_releaseNotesType

@todo: Replace NoteText with AttachedText?

property text: NoteText

Specifies the full content of the release note.

Returns:

NoteText

property locale: str | None

Get the ISO locale of this Note.

The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code.

Examples include: “en”, “en-US”, “fr” and “fr-CA”.

Returns:

str locale if set else None

_LOCALE_TYPE_REGEX

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.OrganizationalContact(*, name: str | None = None, phone: str | None = None, email: str | None = None)

This is our internal representation of the organizationalContact complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_organizationalContact

property name: str | None

Get the name of the contact.

Returns:

str if set else None

property email: str | None

Get the email of the contact.

Returns:

str if set else None

property phone: str | None

Get the phone of the contact.

Returns:

str if set else None

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.OrganizationalEntity(*, name: str | None = None, urls: Iterable[XsUri] | None = None, contacts: Iterable[OrganizationalContact] | None = None)

This is our internal representation of the organizationalEntity complex type that can be used in multiple places within a CycloneDX BOM document.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_organizationalEntity

property name: str | None

Get the name of the organization.

Returns:

str if set else None

property urls: SortedSet[XsUri]

Get a list of URLs of the organization. Multiple URLs are allowed.

Returns:

Set of XsUri

property contacts: SortedSet[OrganizationalContact]

Get a list of contact person at the organization. Multiple contacts are allowed.

Returns:

Set of OrganizationalContact

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.Tool(*, vendor: str | None = None, name: str | None = None, version: str | None = None, hashes: Iterable[HashType] | None = None, external_references: Iterable[ExternalReference] | None = None)

This is our internal representation of the toolType complex type within the CycloneDX standard.

Tool(s) are the things used in the creation of the BOM.

Note

See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.3/#type_toolType

property vendor: str | None

The name of the vendor who created the tool.

Returns:

str if set else None

property name: str | None

The name of the tool.

Returns:

str if set else None

property version: str | None

The version of the tool.

Returns:

str if set else None

property hashes: SortedSet[HashType]

The hashes of the tool (if applicable).

Returns:

Set of HashType

property external_references: SortedSet[ExternalReference]

External References provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.

Returns:

Set of ExternalReference

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.IdentifiableAction(*, timestamp: datetime.datetime | None = None, name: str | None = None, email: str | None = None)

This is our internal representation of the identifiableActionType complex type.

Note

See the CycloneDX specification: https://cyclonedx.org/docs/1.4/xml/#type_identifiableActionType

property timestamp: datetime.datetime | None

The timestamp in which the action occurred.

Returns:

datetime if set else None

property name: str | None

The name of the individual who performed the action.

Returns:

str if set else None

property email: str | None

The email address of the individual who performed the action.

Returns:

str if set else None

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.Copyright(*, text: str)

This is our internal representation of the copyrightsType complex type.

Note

See the CycloneDX specification: https://cyclonedx.org/docs/1.4/xml/#type_copyrightsType

property text: str

Copyright statement.

Returns:

str if set else None

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

cyclonedx.model.ThisTool