Struct Threat 

#[non_exhaustive]
pub struct Threat {

    pub threat_id: Option<String>,
    pub threat_job_id: Option<String>,
    pub title: Option<String>,
    pub statement: Option<String>,
    pub severity: Option<ThreatSeverity>,
    pub status: Option<ThreatStatus>,
    pub comments: Option<String>,
    pub threat_source: Option<String>,
    pub prerequisites: Option<String>,
    pub threat_action: Option<String>,
    pub threat_impact: Option<String>,
    pub impacted_goal: Option<Vec<String>>,
    pub impacted_assets: Option<Vec<String>>,
    pub anchor: Option<ThreatAnchorShape>,
    pub evidence: Option<Vec<ThreatEvidenceShape>>,
    pub stride: Option<Vec<StrideCategory>>,
    pub recommendation: Option<String>,
    pub created_by: Option<ThreatActor>,
    pub updated_by: Option<ThreatActor>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
}

Represents a threat identified during threat modeling.

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.

threat_id: Option<String>

The unique identifier of the threat.

threat_job_id: Option<String>

The unique identifier of the threat model job that produced the threat.

title: Option<String>

A short title summarizing the threat.

statement: Option<String>

The natural-language threat statement.

severity: Option<ThreatSeverity>

The severity level of the threat.

status: Option<ThreatStatus>

The current status of the threat.

comments: Option<String>

Optional customer comment on the threat.

threat_source: Option<String>

The actor or origin of the threat.

prerequisites: Option<String>

The conditions required for the threat to be exploitable.

threat_action: Option<String>

What the threat source can do.

threat_impact: Option<String>

The direct consequence of the threat action.

impacted_goal: Option<Vec<String>>

The security goals affected by the threat.

impacted_assets: Option<Vec<String>>

The specific assets affected by the threat.

anchor: Option<ThreatAnchorShape>

The DFD element this threat is anchored to.

evidence: Option<Vec<ThreatEvidenceShape>>

The source code files supporting the threat.

stride: Option<Vec<StrideCategory>>

The STRIDE categories applicable to this threat.

recommendation: Option<String>

The recommended mitigation guidance for this threat.

created_by: Option<ThreatActor>

Who created this threat.

updated_by: Option<ThreatActor>

Who last updated this threat.

created_at: Option<DateTime>

The date and time the threat was created, in UTC format.

updated_at: Option<DateTime>

The date and time the threat was last updated, in UTC format.

Implementations

impl Threat

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

The unique identifier of the threat.

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

The unique identifier of the threat model job that produced the threat.

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

A short title summarizing the threat.

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

The natural-language threat statement.

pub fn severity(&self) -> Option<&ThreatSeverity>

The severity level of the threat.

pub fn status(&self) -> Option<&ThreatStatus>

The current status of the threat.

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

Optional customer comment on the threat.

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

The actor or origin of the threat.

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

The conditions required for the threat to be exploitable.

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

What the threat source can do.

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

The direct consequence of the threat action.

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

The security goals affected by the threat.

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

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

The specific assets affected by the threat.

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

pub fn anchor(&self) -> Option<&ThreatAnchorShape>

The DFD element this threat is anchored to.

pub fn evidence(&self) -> &[ThreatEvidenceShape]

The source code files supporting the threat.

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

pub fn stride(&self) -> &[StrideCategory]

The STRIDE categories applicable to this threat.

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

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

The recommended mitigation guidance for this threat.

pub fn created_by(&self) -> Option<&ThreatActor>

Who created this threat.

pub fn updated_by(&self) -> Option<&ThreatActor>

Who last updated this threat.

pub fn created_at(&self) -> Option<&DateTime>

The date and time the threat was created, in UTC format.

pub fn updated_at(&self) -> Option<&DateTime>

The date and time the threat was last updated, in UTC format.

impl Threat

pub fn builder() -> ThreatBuilder

Creates a new builder-style object to manufacture Threat.

Trait Implementations

impl Clone for Threat

fn clone(&self) -> Threat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Threat

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

Formats the value using the given formatter.

impl PartialEq for Threat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Threat