secfinding 0.1.1

Universal security finding types — Severity, Evidence, Finding, FindingKind
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# secfinding — Shared security finding model

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Tests](https://img.shields.io/badge/tests-29%20passing-brightgreen.svg)](https://img.shields.io/badge/tests-29%20passing-brightgreen.svg) [![Crates.io](https://img.shields.io/crates/v/secfinding.svg)](https://crates.io/crates/secfinding)

## Why
Security tooling only scales when every scanner outputs the same structured finding schema. `secfinding` is that schema for the Santh ecosystem: severity, type, evidence, location, and metadata in one canonical shape.

This crate removes duplicated model code and lets reporting, aggregation, and downstream integrations work with one contract regardless of whether findings came from web scans, code scanners, or payload engines.

## Quick Start
```rust
use secfinding::{Finding, FindingKind, Evidence, Severity};

fn main() {
    let finding = Finding::builder("php-taint", "https://example.com", Severity::Critical)
        .title("Command execution from user input")
        .detail("eval receives unsanitized data from GET")
        .kind(FindingKind::Vulnerability)
        .evidence(Evidence::code("src/index.php", 12, "$cmd = $_GET['cmd']"))
        .tag("rce")
        .confidence(0.95)
        .exploit_hint("curl -d 'cmd=id' https://example.com/index.php")
        .build();

    println!("{} => {}", finding.target, finding.title);
}
```

## Features
- Canonical `Finding` struct for cross-tool exchange.
- Severity and finding classification via `Severity` and `FindingKind`.
- Rich, typed evidence in `Evidence` (HTTP, DNS, snippets, certificates, patterns).
- Fluent `FindingBuilder` plus `Finding::new` convenience constructor.
- Default `Reportable` implementation for rendering pipelines.

## TOML Configuration
Use [`FindingFilter::from_toml`] to configure severity/scanner/tag filtering.

```toml
min_severity = "high"
exclude_scanners = ["nmap"]
include_tags = ["sqli", "rce"]
```

```rust
use secfinding::{filter, Finding, FindingFilter};

let cfg = FindingFilter::from_toml(r#"
min_severity = \"high\"
exclude_scanners = [\"gobuster\"]
include_tags = [\"rce\"]
"#).unwrap();

let filtered: Vec<Finding> = filter(&findings, &cfg);
```

## API Overview
- `Finding`, `FindingBuilder`: main payload and fluent constructor API.
- `FindingKind`: vulnerability/misconfig/exposure/secret/etc.
- `Severity`: Info → Critical.
- `Evidence`: structured proof payloads.
- `Reportable`: trait consumed by `secreport` and compatible reporting crates.

## Examples
### 1) Build a vulnerability finding with typed evidence
```rust
use secfinding::{Finding, Evidence, FindingKind, Severity};

let finding = Finding::builder("sast", "src/user.rs", Severity::High)
    .title("Hardcoded secret")
    .detail("API key loaded from source code")
    .kind(FindingKind::SecretLeak)
    .evidence(Evidence::code("src/user.rs", 42, "let api_key = \"AKIA...\";"))
    .tag("secrets")
    .cve("CWE-798")
    .build();
```

### 2) Classify findings by type
```rust
use secfinding::FindingKind;

let kind = FindingKind::Misconfiguration;
println!("{} actionable: {}", kind, kind.is_actionable());
```

### 3) Render a multi-tool finding list with `secfinding` types
```rust
use secfinding::{Finding, FindingKind, Severity};

let mut findings = vec![
    Finding::new("web", "https://example.com", Severity::Low, "Weak CSP", "Content-Security-Policy missing"),
];

findings[0].kind = FindingKind::Misconfiguration;
println!("{} finding(s)", findings.len());
```

## Traits
`secfinding` defines `Reportable` to decouple finding models from rendering implementations.

```rust
use secfinding::{Reportable, Severity};

struct CustomFinding {
    target: String,
}

impl Reportable for CustomFinding {
    fn scanner(&self) -> &str { "custom-scanner" }
    fn target(&self) -> &str { &self.target }
    fn severity(&self) -> Severity { Severity::Medium }
    fn title(&self) -> &str { "Custom signal" }
}
```

## Related Crates
- [secreport](https://docs.rs/secreport)
- [phptaint](https://docs.rs/phptaint)
- [scanclient](https://docs.rs/scanclient)

## License
MIT, Corum Collective LLC

Docs: https://docs.rs/secfinding

Santh ecosystem: https://santh.io