Struct FindingVulnerability 

#[non_exhaustive]
pub struct FindingVulnerability {

    pub title: Option<String>,
    pub description: Option<String>,
    pub cwe_id: Option<String>,
    pub cwe_caption: Option<String>,
    pub additional_cwe_ids: Option<Vec<String>>,
    pub cve_id: Option<String>,
    pub cvss_base_score: Option<f64>,
    pub fix_coverage: Option<String>,
    pub fix_coverage_id: Option<i32>,
    pub locations: Option<Vec<FindingLocation>>,
    pub remediation: Option<String>,
    pub remediation_references: Option<Vec<String>>,
    pub code: Option<String>,
    pub details: Option<String>,
    pub affected_packages: Option<Vec<AffectedPackage>>,
}

One vulnerability reported by a finding. A customer document may report several; each carries its own identity, locations and remediation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

The title of a finding, from the producer’s own title – OCSF finding_info.title, or the scanner’s finding title. Length matches the OCSF title constraint.

description: Option<String>

Free-form prose about a finding (summary, detailed analysis, rationale, remediation guidance). Capped well below the finding document’s own 256 KB limit, since several of these can appear on one finding.

cwe_id: Option<String>

Primary CWE for this vulnerability, e.g. “CWE-89”.

cwe_caption: Option<String>

The producer’s human-readable caption for cweId.

additional_cwe_ids: Option<Vec<String>>

Further CWEs the producer attributed to this same vulnerability.

cve_id: Option<String>

A CVE identifier, e.g. “CVE-2020-8203”.

cvss_base_score: Option<f64>

The CVSS base score for cveId, when the producer supplies one, from 0.0 to 10.0.

fix_coverage: Option<String>

The producer’s description of how completely a fix is available.

fix_coverage_id: Option<i32>

The producer’s enum value behind fixCoverage.

locations: Option<Vec<FindingLocation>>

Every location this vulnerability was reported at.

remediation: Option<String>

Free-form prose about a finding (summary, detailed analysis, rationale, remediation guidance). Capped well below the finding document’s own 256 KB limit, since several of these can appear on one finding.

remediation_references: Option<Vec<String>>

A free-form list of strings carried verbatim from a producer.

code: Option<String>

The vulnerable fragment, when the producer supplied one.

details: Option<String>

The producer’s extended analysis for this vulnerability.

affected_packages: Option<Vec<AffectedPackage>>

Software packages implicated by a finding.

Implementations

impl FindingVulnerability

pub fn title(&self) -> Option<&str>

The title of a finding, from the producer’s own title – OCSF finding_info.title, or the scanner’s finding title. Length matches the OCSF title constraint.

pub fn description(&self) -> Option<&str>

Free-form prose about a finding (summary, detailed analysis, rationale, remediation guidance). Capped well below the finding document’s own 256 KB limit, since several of these can appear on one finding.

pub fn cwe_id(&self) -> Option<&str>

Primary CWE for this vulnerability, e.g. “CWE-89”.

pub fn cwe_caption(&self) -> Option<&str>

The producer’s human-readable caption for cweId.

pub fn additional_cwe_ids(&self) -> &[String]

Further CWEs the producer attributed to this same vulnerability.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_cwe_ids.is_none().

pub fn cve_id(&self) -> Option<&str>

A CVE identifier, e.g. “CVE-2020-8203”.

pub fn cvss_base_score(&self) -> Option<f64>

The CVSS base score for cveId, when the producer supplies one, from 0.0 to 10.0.

pub fn fix_coverage(&self) -> Option<&str>

The producer’s description of how completely a fix is available.

pub fn fix_coverage_id(&self) -> Option<i32>

The producer’s enum value behind fixCoverage.

pub fn locations(&self) -> &[FindingLocation]

Every location this vulnerability was reported at.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .locations.is_none().

pub fn remediation(&self) -> Option<&str>

Free-form prose about a finding (summary, detailed analysis, rationale, remediation guidance). Capped well below the finding document’s own 256 KB limit, since several of these can appear on one finding.

pub fn remediation_references(&self) -> &[String]

A free-form list of strings carried verbatim from a producer.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .remediation_references.is_none().

pub fn code(&self) -> Option<&str>

The vulnerable fragment, when the producer supplied one.

pub fn details(&self) -> Option<&str>

The producer’s extended analysis for this vulnerability.

pub fn affected_packages(&self) -> &[AffectedPackage]

Software packages implicated by a finding.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .affected_packages.is_none().

impl FindingVulnerability

pub fn builder() -> FindingVulnerabilityBuilder

Creates a new builder-style object to manufacture FindingVulnerability.

Trait Implementations

impl Clone for FindingVulnerability

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FindingVulnerability

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FindingVulnerability

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FindingVulnerability