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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

#![warn(missing_docs)]
#![warn(clippy::pedantic)]
#![cfg_attr(
    not(test),
    deny(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::todo,
        clippy::unimplemented,
        clippy::panic
    )
)]
#![allow(
    clippy::module_name_repetitions,
    clippy::must_use_candidate,
    clippy::missing_errors_doc
)]
#![forbid(unsafe_code)]
//! Universal security finding types for the Santh ecosystem.
//!
//! Every Santh tool — web scanners, code analyzers, secret detectors,
//! template engines — produces findings. This crate provides the shared
//! types so all tools speak the same language.
//!
//! # Core Types
//!
//! - [`Severity`] — Info, Low, Medium, High, Critical
//! - [`FindingKind`] — What was found (vulnerability, misconfiguration, exposure, etc.)
//! - [`Evidence`] — Typed proof attached to a finding
//! - [`Finding`] — The universal finding struct
//!
//! # Usage
//!
//! ```rust
//! use secfinding::{Finding, Severity, Evidence, FindingKind};
//!
//! let finding = Finding::builder("my-scanner", "https://example.com", Severity::High)
//!     .title("SQL Injection")
//!     .detail("User input in login form is not sanitized")
//!     .kind(FindingKind::Vulnerability)
//!     .evidence(Evidence::HttpResponse {
//!         status: 500,
//!         headers: vec![],
//!         body_excerpt: Some("SQL syntax error".into()),
//!     })
//!     .tag("sqli")
//!     .tag("owasp-a03")
//!     .cve("CVE-2024-12345")
//!     .exploit_hint("sqlmap -u 'https://example.com/login' --data 'user=admin'")
//!     .build()
//!     .unwrap();
//! ```

mod evidence;
mod filter;
mod finding;
mod kind;
mod location;
mod reportable;
mod severity;
mod status;

#[cfg(feature = "secir")]
pub mod bridge;

pub use evidence::Evidence;
pub use filter::{filter, FindingFilter};
pub use finding::{Finding, FindingBuildError, FindingBuilder};
pub use kind::FindingKind;
pub use location::{Location, LocationError};
pub use reportable::Reportable;
pub use severity::Severity;
pub use status::FindingStatus;

/// Convenience re-exports for common usage.
///
/// ```rust
/// use secfinding::prelude::*;
/// ```
pub mod prelude {
    pub use crate::{
        Evidence, Finding, FindingBuilder, FindingKind, FindingStatus, Location, Reportable,
        Severity,
    };
}