blob: 318770c337799ac650457c888711edfb1b5f10f4 [file] [log] [blame]
//! Qualitative Severity Rating Scale
use crate::{Error, Result};
use alloc::borrow::ToOwned;
use core::{fmt, str::FromStr};
#[cfg(feature = "serde")]
use {
alloc::string::String,
serde::{de, ser, Deserialize, Serialize},
};
/// Qualitative Severity Rating Scale
///
/// Described in CVSS v3.1 Specification: Section 5:
/// <https://www.first.org/cvss/specification-document#t17>
///
/// > For some purposes it is useful to have a textual representation of the
/// > numeric Base, Temporal and Environmental scores.
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub enum Severity {
/// None: CVSS Score 0.0
None,
/// Low: CVSS Score 0.1 - 3.9
Low,
/// Medium: CVSS Score 4.0 - 6.9
Medium,
/// High: CVSS Score 7.0 - 8.9
High,
/// Critical: CVSS Score 9.0 - 10.0
Critical,
}
impl Severity {
/// Get a `str` describing the severity level
pub fn as_str(self) -> &'static str {
match self {
Severity::None => "none",
Severity::Low => "low",
Severity::Medium => "medium",
Severity::High => "high",
Severity::Critical => "critical",
}
}
}
impl FromStr for Severity {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
match s.to_ascii_lowercase().as_str() {
"none" => Ok(Severity::None),
"low" => Ok(Severity::Low),
"medium" => Ok(Severity::Medium),
"high" => Ok(Severity::High),
"critical" => Ok(Severity::Critical),
_ => Err(Error::InvalidSeverity { name: s.to_owned() }),
}
}
}
impl fmt::Display for Severity {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.as_str())
}
}
#[cfg(feature = "serde")]
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
impl<'de> Deserialize<'de> for Severity {
fn deserialize<D: de::Deserializer<'de>>(
deserializer: D,
) -> core::result::Result<Self, D::Error> {
String::deserialize(deserializer)?
.parse()
.map_err(de::Error::custom)
}
}
#[cfg(feature = "serde")]
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
impl Serialize for Severity {
fn serialize<S: ser::Serializer>(
&self,
serializer: S,
) -> core::result::Result<S::Ok, S::Error> {
self.as_str().serialize(serializer)
}
}