secfinding 0.3.0

Universal security finding types for vulnerability scanners.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Lifecycle status of a security finding.

use serde::{Deserialize, Serialize};

/// Current lifecycle state of a finding.
///
/// # Examples
///
/// ```
/// use secfinding::FindingStatus;
///
/// assert_eq!(FindingStatus::Open.label(), "OPEN");
/// assert_eq!(FindingStatus::Resolved.to_string(), "resolved");
/// ```
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum FindingStatus {
    /// New finding, needs triaging.
    #[default]
    Open,
    /// Manually confirmed to be a real issue.
    Confirmed,
    /// Manually marked as a false positive.
    FalsePositive,
    /// Issue has been fixed or remediated.
    Resolved,
}

impl FindingStatus {
    /// Short label for terminal output.
    #[must_use]
    pub fn label(&self) -> &'static str {
        match self {
            Self::Open => "OPEN",
            Self::Confirmed => "CONF",
            Self::FalsePositive => "F/P",
            Self::Resolved => "FIXD",
        }
    }
}

impl std::fmt::Display for FindingStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let s = match self {
            Self::Open => "open",
            Self::Confirmed => "confirmed",
            Self::FalsePositive => "false_positive",
            Self::Resolved => "resolved",
        };
        f.write_str(s)
    }
}