Struct Finding

Source
pub struct Finding {
    pub title: String,
    pub id: String,
    pub description: String,
    pub severity: Severity,
}
Expand description

A struct that represents a vulernability found by a ScanModule.

Fields§

§title: String

The title of the vulenrability. This is human-meaningful, and should make sense on its own with only the context of the scan module’s name. This shouldn’t be a complete sentence; the knowledge of the scan module should make only a noun necessary; that is, the title indicates what the scan module actually found. Therefore, it is not necessary to include a verb.

For example, the title of a Finding created by the strings scan module might be XOR DECODE LOOP (COMMON TO MICROSOFT MALWARE). Because this will be listed explicitly as a finding of the Strings scan module, such a title will make sense to the user.

§id: String

A consistent and unique identifier for the type of finding in screaming snake case. All findings of the same type should have the same ID. For example, the ID of a finding of the string scan module might be SUSPICIOUS_STRING.

§description: String

A human meaningful description of the finding. This should be between one and two full sentences.

§severity: Severity

The Severity of the finding. This ranges from Ok to Severe. See the documentation for Severity for more in-depth explanations of each possible state.

Trait Implementations§

Source§

impl Debug for Finding

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.