Skip to main content

Finding

Struct Finding 

Source
pub struct Finding {
Show 15 fields pub id: Uuid, pub scanner: String, pub target: String, pub severity: Severity, pub title: String, pub detail: String, pub kind: FindingKind, pub evidence: Vec<Evidence>, pub tags: Vec<String>, pub timestamp: DateTime<Utc>, pub cve_ids: Vec<String>, pub references: Vec<String>, pub confidence: Option<f64>, pub exploit_hint: Option<String>, pub matched_values: Vec<String>,
}
Expand description

A single security finding produced by any Santh tool.

This is the universal output format. Whether the finding comes from Gossan (discovery), Karyx (routing), Calyx (templates), Sear (SAST), jsdet (JS malware), or a binding (sqlmap-rs), it produces a Finding.

Fields§

§id: Uuid

Unique identifier for this finding instance.

§scanner: String

Which tool/scanner produced this finding.

§target: String

The target that was scanned (URL, file path, domain, IP, etc.).

§severity: Severity

Finding severity.

§title: String

Short human-readable title.

§detail: String

Detailed description of the finding.

§kind: FindingKind

Classification of the finding.

§evidence: Vec<Evidence>

Typed evidence proving the finding.

§tags: Vec<String>

Free-form tags for categorization and filtering.

§timestamp: DateTime<Utc>

When the finding was produced.

§cve_ids: Vec<String>

CVE identifiers associated with this finding.

§references: Vec<String>

Reference URLs (advisories, documentation, etc.).

§confidence: Option<f64>

Statistical confidence score (0.0 to 1.0).

§exploit_hint: Option<String>

Ready-to-run command demonstrating exploitability.

§matched_values: Vec<String>

Specific values that triggered the finding (matched strings, payloads, etc.).

Implementations§

Source§

impl Finding

Source

pub fn builder( scanner: impl Into<String>, target: impl Into<String>, severity: Severity, ) -> FindingBuilder

Start building a finding with the three required fields.

Examples found in repository?
examples/serialize_json.rs (line 8)
7fn main() {
8    let finding = Finding::builder("my-scanner", "192.168.1.100", Severity::Critical)
9        .title("Default Credentials")
10        .detail("Admin interface uses admin:admin")
11        .tag("auth")
12        .build();
13
14    let json = serde_json::to_string_pretty(&finding).expect("Failed to serialize");
15    println!("Serialized Finding:\n{}", json);
16}
More examples
Hide additional examples
examples/basic.rs (line 4)
3fn main() {
4    let finding = Finding::builder("basic-scanner", "https://example.com", Severity::High)
5        .title("Potential command injection")
6        .detail("Untrusted input reaches shell execution")
7        .tag("rce")
8        .evidence(secfinding::Evidence::http_status(500).unwrap())
9        .build()
10        .unwrap();
11
12    println!("{finding}");
13
14    let json = serde_json::to_string_pretty(&finding).unwrap();
15    println!("{json}");
16}
Source

pub fn new( scanner: impl Into<String>, target: impl Into<String>, severity: Severity, title: impl Into<String>, detail: impl Into<String>, ) -> Result<Self, &'static str>

Quick constructor for simple findings without the builder.

Trait Implementations§

Source§

impl Clone for Finding

Source§

fn clone(&self) -> Finding

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Finding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Finding

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Finding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for Finding

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Finding

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Finding

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Reportable for Finding

Blanket: secfinding’s own Finding implements Reportable.

Source§

fn scanner(&self) -> &str

Which tool produced this finding.
Source§

fn target(&self) -> &str

What was scanned (URL, file path, package name, etc.).
Source§

fn severity(&self) -> Severity

How severe is this finding.
Source§

fn title(&self) -> &str

Short human-readable title.
Source§

fn detail(&self) -> &str

Detailed description.
Source§

fn cwe_ids(&self) -> &[String]

CWE identifiers (e.g. ["CWE-89"]).
Source§

fn cve_ids(&self) -> &[String]

CVE identifiers.
Source§

fn tags(&self) -> &[String]

Free-form tags.
Source§

fn confidence(&self) -> Option<f64>

Confidence score 0.0-1.0 (None = not applicable).
Source§

fn exploit_hint(&self) -> Option<&str>

Exploit hint / PoC command.
Source§

fn evidence(&self) -> &[Evidence]

Evidence attached to the finding.
Source§

fn rule_id(&self) -> String

SARIF rule ID (defaults to “scanner/title-slug”).
Source§

fn sarif_level(&self) -> &str

SARIF severity level string.
Source§

impl Serialize for Finding

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Finding> for Value

Source§

type Error = Error

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

fn try_from(finding: Finding) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for Finding

Source§

impl StructuralPartialEq for Finding

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,