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
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

// Extracted from src/reportable.rs
use secfinding::*;
use secfinding::reportable::*;

use super::*;
use crate::{Finding, Severity};

#[test]
fn finding_implements_reportable() {
    let f = Finding::new("scanner", "target", Severity::High, "Title", "Detail").unwrap();
    assert_eq!(Reportable::scanner(&f), "scanner");
    assert_eq!(Reportable::target(&f), "target");
    assert_eq!(Reportable::severity(&f), Severity::High);
    assert_eq!(Reportable::title(&f), "Title");
    assert_eq!(Reportable::detail(&f), "Detail");
}

#[test]
fn custom_type_implements_reportable() {
    struct CustomFinding {
        name: String,
    }

    impl Reportable for CustomFinding {
        fn scanner(&self) -> &'static str {
            "custom"
        }
        fn target(&self) -> &'static str {
            "custom-target"
        }
        fn severity(&self) -> Severity {
            Severity::Critical
        }
        fn title(&self) -> &str {
            &self.name
        }
        fn cwe_ids(&self) -> &[String] {
            &[]
        }
        fn cve_ids(&self) -> &[String] {
            &[]
        }
        fn tags(&self) -> &[String] {
            &[]
        }
    }

    let f = CustomFinding { name: "XSS".into() };
    assert_eq!(f.scanner(), "custom");
    assert_eq!(f.severity(), Severity::Critical);
    assert_eq!(f.detail(), ""); // default
    assert!(f.tags().is_empty()); // default
    assert!(f.rule_id().contains("xss"));
}

#[test]
fn reportable_defaults_are_sensible() {
    struct Minimal;
    impl Reportable for Minimal {
        fn scanner(&self) -> &'static str {
            "s"
        }
        fn target(&self) -> &'static str {
            "t"
        }
        fn severity(&self) -> Severity {
            Severity::Info
        }
        fn title(&self) -> &'static str {
            "minimal"
        }
        fn cwe_ids(&self) -> &[String] {
            &[]
        }
        fn cve_ids(&self) -> &[String] {
            &[]
        }
        fn tags(&self) -> &[String] {
            &[]
        }
    }

    let m = Minimal;
    assert_eq!(m.detail(), "");
    assert!(m.cwe_ids().is_empty());
    assert!(m.cve_ids().is_empty());
    assert!(m.tags().is_empty());
    assert_eq!(m.confidence(), None);
    assert_eq!(m.exploit_hint(), None);
    assert_eq!(m.rule_id(), "s/minimal");
}

#[test]
fn reportable_custom_sarif_level() {
    struct CustomSev;
    impl Reportable for CustomSev {
        fn scanner(&self) -> &'static str {
            "s"
        }
        fn target(&self) -> &'static str {
            "t"
        }
        fn severity(&self) -> Severity {
            Severity::Critical
        }
        fn title(&self) -> &'static str {
            "t"
        }
        fn cwe_ids(&self) -> &[String] {
            &[]
        }
        fn cve_ids(&self) -> &[String] {
            &[]
        }
        fn tags(&self) -> &[String] {
            &[]
        }
    }
    let f = CustomSev;
    assert_eq!(f.sarif_level(), "error");
}

#[test]
fn reportable_custom_rule_id() {
    struct CustomRuleId;
    impl Reportable for CustomRuleId {
        fn scanner(&self) -> &'static str {
            "scanner"
        }
        fn target(&self) -> &'static str {
            "target"
        }
        fn severity(&self) -> Severity {
            Severity::Info
        }
        fn title(&self) -> &'static str {
            "MY custom TITLE!"
        }
        fn rule_id(&self) -> String {
            "CUSTOM-RULE-ID".to_string()
        }
        fn cwe_ids(&self) -> &[String] {
            &[]
        }
        fn cve_ids(&self) -> &[String] {
            &[]
        }
        fn tags(&self) -> &[String] {
            &[]
        }
    }
    let f = CustomRuleId;
    assert_eq!(f.rule_id(), "CUSTOM-RULE-ID");
}

#[test]
fn reportable_default_rule_id_formatting() {
    struct Spaces;
    impl Reportable for Spaces {
        fn scanner(&self) -> &'static str {
            "scan"
        }
        fn target(&self) -> &'static str {
            "target"
        }
        fn severity(&self) -> Severity {
            Severity::Info
        }
        fn title(&self) -> &'static str {
            "Some spaces here"
        }
        fn cwe_ids(&self) -> &[String] {
            &[]
        }
        fn cve_ids(&self) -> &[String] {
            &[]
        }
        fn tags(&self) -> &[String] {
            &[]
        }
    }
    let f = Spaces;
    assert_eq!(f.rule_id(), "scan/some-spaces-here");
}