cyclonedx.model.vulnerability

Module Contents

Classes

BomTargetVersionRange	Class that represents either a version or version range and its affected status.
BomTarget	Class that represents referencing a Component or Service in a BOM.
VulnerabilityAnalysis	Class that models the analysis sub-element of the vulnerabilityType complex type.
VulnerabilityAdvisory	Class that models the advisoryType complex type.
VulnerabilitySource	Class that models the vulnerabilitySourceType complex type.
VulnerabilityReference	Class that models the nested reference within the vulnerabilityType complex type.
VulnerabilityScoreSource	Enum object that defines the permissible source types for a Vulnerability's score.
VulnerabilitySeverity	Class that defines the permissible severities for a Vulnerability.
VulnerabilityRating	Class that models the ratingType complex element CycloneDX core schema.
VulnerabilityCredits	Class that models the credits of vulnerabilityType complex type in the CycloneDX schema (version >= 1.4).
Vulnerability	Class that models the vulnerabilityType complex type in the CycloneDX schema (version >= 1.4).

class cyclonedx.model.vulnerability.BomTargetVersionRange(*, version: str | None = None, range: str | None = None, status: cyclonedx.model.impact_analysis.ImpactAnalysisAffectedStatus | None = None)

Class that represents either a version or version range and its affected status.

version and version_range are mutually exclusive.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property version: str | None

A single version of a component or service.

property range: str | None

A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst

Note

The VERSION-RANGE-SPEC from Package URL is not a formalised standard at the time of writing and this no validation of conformance with this draft standard is performed.

property status: cyclonedx.model.impact_analysis.ImpactAnalysisAffectedStatus | None

The vulnerability status for the version or range of versions.

__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.vulnerability.BomTarget(*, ref: str, versions: Iterable[BomTargetVersionRange] | None = None)

Class that represents referencing a Component or Service in a BOM.

Aims to represent the sub-element target of the complex type vulnerabilityType.

You can either create a cyclonedx.model.bom.Bom yourself programmatically, or generate a cyclonedx.model.bom.Bom from a cyclonedx.parser.BaseParser implementation.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property ref: str

Reference to a component or service by the objects bom-ref.

property versions: SortedSet[BomTargetVersionRange]

Zero or more individual versions or range of versions.

Returns:

Set of BomTargetVersionRange

__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.vulnerability.VulnerabilityAnalysis(*, state: cyclonedx.model.impact_analysis.ImpactAnalysisState | None = None, justification: cyclonedx.model.impact_analysis.ImpactAnalysisJustification | None = None, responses: Iterable[cyclonedx.model.impact_analysis.ImpactAnalysisResponse] | None = None, detail: str | None = None)

Class that models the analysis sub-element of the vulnerabilityType complex type.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property state: cyclonedx.model.impact_analysis.ImpactAnalysisState | None

The declared current state of an occurrence of a vulnerability, after automated or manual analysis.

Returns:

ImpactAnalysisState if set else None

property justification: cyclonedx.model.impact_analysis.ImpactAnalysisJustification | None

The rationale of why the impact analysis state was asserted.

Returns:

ImpactAnalysisJustification if set else None

property responses: SortedSet[ImpactAnalysisResponse]

A list of responses to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.

Returns:

Set of ImpactAnalysisResponse

property detail: str | None

A detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability.

Returns:

str if set else None

__eq__(other: object) → bool

Return self==value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

class cyclonedx.model.vulnerability.VulnerabilityAdvisory(*, url: cyclonedx.model.XsUri, title: str | None = None)

Class that models the advisoryType complex type.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_advisoryType

property title: str | None

The title of this advisory.

property url: cyclonedx.model.XsUri

The url of this advisory.

__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.vulnerability.VulnerabilitySource(*, name: str | None = None, url: cyclonedx.model.XsUri | None = None)

Class that models the vulnerabilitySourceType complex type.

This type is used for multiple purposes in the CycloneDX schema.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilitySourceType

property name: str | None

Name of this Source.

property url: cyclonedx.model.XsUri | None

The url of this Source.

__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.vulnerability.VulnerabilityReference(*, id: str | None = None, source: VulnerabilitySource | None = None)

Class that models the nested reference within the vulnerabilityType complex type.

Vulnerabilities may benefit from pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. These references provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property id: str | None

The identifier that uniquely identifies the vulnerability in the associated Source. For example: CVE-2021-39182.

property source: VulnerabilitySource | None

The source that published the vulnerability.

__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.vulnerability.VulnerabilityScoreSource

Bases: str, enum.Enum

Enum object that defines the permissible source types for a Vulnerability’s score.

Note

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

CVSS_V2 = 'CVSSv2'

CVSS_V3 = 'CVSSv3'

CVSS_V3_1 = 'CVSSv31'

OWASP = 'OWASP'

OPEN_FAIR = 'Open FAIR'

OTHER = 'other'

static get_from_vector(vector: str) → VulnerabilityScoreSource

Attempt to derive the correct SourceType from an attack vector.

For example, often attack vector strings are prefixed with the scheme in question - such that __CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:C/C:L/I:N/A:N__ would be the vector __AV:L/AC:L/PR:N/UI:R/S:C/C:L/I:N/A:N__ under the __CVSS 3__ scheme.

Returns:

Always returns an instance of VulnerabilityScoreSource. VulnerabilityScoreSource.OTHER is returned if the scheme is not obvious or known to us.

get_localised_vector(vector: str) → str

This method will remove any Source Scheme type from the supplied vector, returning just the vector.

Note

Currently supports CVSS 3.x, CVSS 2.x and OWASP schemes.

Returns:

The vector without any scheme prefix as a str.

get_value_pre_1_4() → str

Some of the enum values changed in 1.4 of the CycloneDX spec. This method allows us to backport some of the changes for pre-1.4.

Returns:

str

class cyclonedx.model.vulnerability.VulnerabilitySeverity

Bases: str, enum.Enum

Class that defines the permissible severities for a Vulnerability.

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_severityType

NONE = 'none'

INFO = 'info'

LOW = 'low'

MEDIUM = 'medium'

HIGH = 'high'

CRITICAL = 'critical'

UNKNOWN = 'unknown'

static get_from_cvss_scores(scores: Tuple[float] | float | None) → VulnerabilitySeverity

Derives the Severity of a Vulnerability from it’s declared CVSS scores.

Args:

scores: A tuple of CVSS scores. CVSS scoring system allows for up to three separate scores.

Returns:

Always returns an instance of VulnerabilitySeverity.

class cyclonedx.model.vulnerability.VulnerabilityRating(*, source: VulnerabilitySource | None = None, score: decimal.Decimal | None = None, severity: VulnerabilitySeverity | None = None, method: VulnerabilityScoreSource | None = None, vector: str | None = None, justification: str | None = None, score_base: float | None = None)

Class that models the ratingType complex element CycloneDX core schema.

This class previously modelled the scoreType complexe type in the schema extension used prior to schema version 1.4 - see https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd.

Note

See ratingType in https://cyclonedx.org/docs/1.4/#ratingType

Warning

As part of implementing support for CycloneDX schema version 1.4, the three score types defined in the schema externsion used prior to 1.4 have been deprecated. The deprecated score_base should loosely be equivalent to the new score in 1.4 schema. Both score_impact and score_exploitability are deprecated and removed as they are redundant if you have the vector (the vector allows you to calculate the scores).

property source: VulnerabilitySource | None

The source that published the vulnerability.

property score: decimal.Decimal | None

The numerical score of the rating.

property severity: VulnerabilitySeverity | None

The textual representation of the severity that corresponds to the numerical score of the rating.

property method: VulnerabilityScoreSource | None

The risk scoring methodology/standard used.

property vector: str | None

The textual representation of the metric values used to score the vulnerability - also known as the vector.

property justification: str | None

An optional reason for rating the vulnerability as it was.

__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.vulnerability.VulnerabilityCredits(*, organizations: Iterable[cyclonedx.model.OrganizationalEntity] | None = None, individuals: Iterable[cyclonedx.model.OrganizationalContact] | None = None)

Class that models the credits of vulnerabilityType complex type in the CycloneDX schema (version >= 1.4).

This class also provides data support for schema versions < 1.4 where Vulnerabilites were possible through a schema extension (in XML only).

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property organizations: SortedSet[OrganizationalEntity]

The organizations credited with vulnerability discovery.

Returns:

Set of OrganizationalEntity

property individuals: SortedSet[OrganizationalContact]

The individuals, not associated with organizations, that are credited with vulnerability discovery.

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.vulnerability.Vulnerability(*, bom_ref: str | cyclonedx.model.bom_ref.BomRef | None = None, id: str | None = None, source: VulnerabilitySource | None = None, references: Iterable[VulnerabilityReference] | None = None, ratings: Iterable[VulnerabilityRating] | None = None, cwes: Iterable[int] | None = None, description: str | None = None, detail: str | None = None, recommendation: str | None = None, advisories: Iterable[VulnerabilityAdvisory] | None = None, created: datetime.datetime | None = None, published: datetime.datetime | None = None, updated: datetime.datetime | None = None, credits: VulnerabilityCredits | None = None, tools: Iterable[cyclonedx.model.Tool] | None = None, analysis: VulnerabilityAnalysis | None = None, affects: Iterable[BomTarget] | None = None, properties: Iterable[cyclonedx.model.Property] | None = None, source_name: str | None = None, source_url: str | None = None, recommendations: Iterable[str] | None = None)

Class that models the vulnerabilityType complex type in the CycloneDX schema (version >= 1.4).

This class also provides data support for schema versions < 1.4 where Vulnerabilites were possible through a schema extension (in XML only).

Note

See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType

property bom_ref: cyclonedx.model.bom_ref.BomRef

Get the unique reference for this Vulnerability in this BOM.

If a value was not provided in the constructor, a UUIDv4 will have been assigned.

Returns:

BomRef

property id: str | None

The identifier that uniquely identifies the vulnerability. For example: CVE-2021-39182.

Returns:

str if set else None

property source: VulnerabilitySource | None

The source that published the vulnerability.

Returns:

VulnerabilitySource if set else None

property references: SortedSet[VulnerabilityReference]

Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provides a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.

Returns:

Set of VulnerabilityReference

property ratings: SortedSet[VulnerabilityRating]

List of vulnerability ratings.

Returns:

Set of VulnerabilityRating

property cwes: SortedSet[int]

A list of CWE (Common Weakness Enumeration) identifiers.

Note

See https://cwe.mitre.org/

Returns:

Set of int

property description: str | None

A description of the vulnerability as provided by the source.

Returns:

str if set else None

property detail: str | None

If available, an in-depth description of the vulnerability as provided by the source organization. Details often include examples, proof-of-concepts, and other information useful in understanding root cause.

Returns:

str if set else None

property recommendation: str | None

Recommendations of how the vulnerability can be remediated or mitigated.

Returns:

str if set else None

property advisories: SortedSet[VulnerabilityAdvisory]

Advisories relating to the Vulnerability.

Returns:

Set of VulnerabilityAdvisory

property created: datetime.datetime | None

The date and time (timestamp) when the vulnerability record was created in the vulnerability database.

Returns:

datetime if set else None

property published: datetime.datetime | None

The date and time (timestamp) when the vulnerability record was first published.

Returns:

datetime if set else None

property updated: datetime.datetime | None

The date and time (timestamp) when the vulnerability record was last updated.

Returns:

datetime if set else None

property credits: VulnerabilityCredits | None

Individuals or organizations credited with the discovery of the vulnerability.

Returns:

VulnerabilityCredits if set else None

property tools: SortedSet[Tool]

The tool(s) used to identify, confirm, or score the vulnerability.

Returns:

Set of Tool

property analysis: VulnerabilityAnalysis | None

Analysis of the Vulnerability in your context.

Returns:

VulnerabilityAnalysis if set else None

property affects: SortedSet[BomTarget]

The components or services that are affected by the vulnerability.

Returns:

Set of BomTarget

property properties: SortedSet[Property]

Provides the ability to document properties in a key/value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions.

Return:

Set of Property

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).