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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
use std::collections::HashMap;

use anyhow::{anyhow, Ok, Result};
use serde::{Deserialize, Serialize};

use crate::{condition::Condition, helpers::Connection, vulnerability::Vulnerability, Formalize};

#[derive(PartialEq, Eq, Debug, Serialize, Deserialize, Clone)]
pub struct Capability {
    #[serde(default, alias = "Name", alias = "NAME")]
    pub name: Option<String>,
    #[serde(default, alias = "Description", alias = "DESCRIPTION")]
    pub description: Option<String>,
    #[serde(default, alias = "Condition", alias = "CONDITION")]
    pub condition: String,
    #[serde(default, alias = "Vulnerabilities", alias = "VULNERABILITIES")]
    pub vulnerabilities: Option<Vec<String>>,
}

impl Formalize for Capability {
    fn formalize(&mut self) -> Result<()> {
        if let Some(vulnerabilities) = &self.vulnerabilities {
            if vulnerabilities.is_empty() {
                return Err(anyhow!(
                    "Capability requires at least one Vulnerability but none found under Scenario"
                ));
            }
        }
        Ok(())
    }
}

pub type Capabilities = HashMap<String, Capability>;

impl Connection<Vulnerability> for (&String, &Capability) {
    fn validate_connections(
        &self,
        potential_vulnerability_names: &Option<Vec<String>>,
    ) -> Result<()> {
        if let Some(capability_vulnerabilities) = &self.1.vulnerabilities {
            if let Some(vulnerabilities) = potential_vulnerability_names {
                for vulnerability_name in capability_vulnerabilities.iter() {
                    if !vulnerabilities.contains(vulnerability_name) {
                        return Err(anyhow!(
                            "Vulnerability \"{vulnerability_name}\" not found under Scenario Vulnerabilities",
                        ));
                    }
                }
            } else if !capability_vulnerabilities.is_empty() {
                return Err(anyhow!(
                "Capability \"{capability_name}\" has Vulnerabilities but none found under Scenario",
                capability_name = self.0
            ));
            }
        }
        Ok(())
    }
}

impl Connection<Condition> for (&String, &Capability) {
    fn validate_connections(&self, potential_condition_names: &Option<Vec<String>>) -> Result<()> {
        let condition_name = &self.1.condition;

        if let Some(condition_names) = potential_condition_names {
            if !condition_names.contains(condition_name) {
                return Err(anyhow!(
                    "Condition \"{condition_name}\" not found under Scenario Conditions"
                ));
            }
        } else {
            return Err(anyhow!(
                "Capability requires at least one Condition but none found under Scenario"
            ));
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parse_sdl;

    #[test]
    fn capability_is_parsed() {
        let sdl = r#"
          description: "Can defend against Dirty Cow"
          condition: condition-4
          vulnerabilities:
            - vulnerability-1
            - vulnerability-2
        "#;
        serde_yaml::from_str::<Capability>(sdl).unwrap();
    }

    #[test]
    #[should_panic(expected = "expected a sequence")]
    fn capability_with_zero_vulnerabilities_fails_formalization() {
        let sdl = r#"
          description: "Can defend against Dirty Cow"
          condition: condition-4
          vulnerabilities: {}
        "#;
        let mut capability = serde_yaml::from_str::<Capability>(sdl).unwrap();
        capability.formalize().unwrap();
    }

    #[test]
    fn can_parse_capabilities_in_sdl() {
        let sdl = r#"
            name: test-scenario
            description: some-description
            start: 2022-01-20T13:00:00Z
            end: 2022-01-20T23:00:00Z
            vulnerabilities:
              vulnerability-1:
                name: Some other vulnerability
                description: some-description
                technical: false
                class: CWE-1343
              vulnerability-2:
                name: Some vulnerability
                description: some-description
                technical: false
                class: CWE-1341
            conditions:
              condition-1:
                source: digital-library-package
              condition-2:
                source: digital-library-package
            capabilities:
              capability-1:
                description: "Can execute Dirty Cow"
                condition: condition-1
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
              capability-2:
                description: "Can defend against Dirty Cow"
                condition: condition-2
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
        "#;
        let capabilities = parse_sdl(sdl).unwrap().capabilities;
        insta::with_settings!({sort_maps => true}, {
                insta::assert_yaml_snapshot!(capabilities);
        });
    }

    #[test]
    #[should_panic(expected = "Condition \"condition-3\" not found under Scenario Conditions")]
    fn fails_parsing_when_missing_condition() {
        let sdl = r#"
            name: test-scenario
            description: some-description
            start: 2022-01-20T13:00:00Z
            end: 2022-01-20T23:00:00Z
            vulnerabilities:
              vulnerability-1:
                name: some-vulnerability
                description: some-description
                technical: false
                class: CWE-1343
              vulnerability-2:
                name: some-vulnerability
                description: some-description
                technical: false
                class: CWE-1343
            conditions:
              condition-1:
                command: executable/path.sh
                interval: 30
              condition-2:
                source: digital-library-package
            capabilities:
              capability-1:
                description: "Can execute Dirty Cow"
                condition: condition-1
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
              capability-2:
                description: "Can defend against Dirty Cow"
                condition: condition-3
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
        "#;
        parse_sdl(sdl).unwrap();
    }

    #[test]
    #[should_panic(expected = "Vulnerability \"vulnerability-4\" not found under Scenario Vulnerabilities")]
    fn fails_parsing_when_missing_vulnerability() {
        let sdl = r#"
            name: test-scenario
            description: some-description
            start: 2022-01-20T13:00:00Z
            end: 2022-01-20T23:00:00Z
            vulnerabilities:
              vulnerability-1:
                name: some-vulnerability
                description: some-description
                technical: false
                class: CWE-1343
              vulnerability-2:
                name: some-vulnerability
                description: some-description
                technical: false
                class: CWE-1343
            conditions:
              condition-1:
                command: executable/path.sh
                interval: 30
              condition-2:
                source: digital-library-package
            capabilities:
              capability-1:
                description: "Can execute Dirty Cow"
                condition: condition-1
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
                  - vulnerability-4
              capability-2:
                description: "Can defend against Dirty Cow"
                condition: condition-2
                vulnerabilities:
                  - vulnerability-1
                  - vulnerability-2
        "#;
        parse_sdl(sdl).unwrap();
    }
}