stix-rs 0.1.0

STIX 2.1 types and helpers for Rust
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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::common::{CommonProperties, StixObject};
use crate::sdos::BuilderError;

/// Tool SDO
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct Tool {
    #[serde(flatten)]
    pub common: CommonProperties,
    pub name: String,
    pub description: Option<String>,
    pub tool_types: Option<Vec<String>>,
}

impl Tool {
    pub fn builder() -> ToolBuilder {
        ToolBuilder::default()
    }
}

#[derive(Debug, Default)]
pub struct ToolBuilder {
    name: Option<String>,
    description: Option<String>,
    tool_types: Option<Vec<String>>,
    created_by_ref: Option<String>,
}

impl ToolBuilder {
    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = Some(name.into());
        self
    }

    pub fn description(mut self, d: impl Into<String>) -> Self {
        self.description = Some(d.into());
        self
    }

    pub fn tool_types(mut self, t: Vec<String>) -> Self {
        self.tool_types = Some(t);
        self
    }

    pub fn created_by_ref(mut self, r: impl Into<String>) -> Self {
        self.created_by_ref = Some(r.into());
        self
    }

    pub fn build(self) -> Result<Tool, BuilderError> {
        let name = self.name.ok_or(BuilderError::MissingField("name"))?;
        let common = CommonProperties::new("tool", self.created_by_ref);
        Ok(Tool {
            common,
            name,
            description: self.description,
            tool_types: self.tool_types,
        })
    }
}

impl StixObject for Tool {
    fn id(&self) -> &str {
        &self.common.id
    }

    fn type_(&self) -> &str {
        &self.common.r#type
    }

    fn created(&self) -> DateTime<Utc> {
        self.common.created
    }
}

impl From<Tool> for crate::StixObjectEnum {
    fn from(t: Tool) -> Self {
        crate::StixObjectEnum::Tool(t)
    }
}

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

    #[test]
    fn tool_builder() {
        let tool = Tool::builder()
            .name("Metasploit")
            .description("Penetration testing framework")
            .tool_types(vec!["exploitation".into()])
            .build()
            .unwrap();

        assert_eq!(tool.name, "Metasploit");
        assert_eq!(tool.common.r#type, "tool");
    }

    #[test]
    fn tool_serialize() {
        let tool = Tool::builder().name("Cobalt Strike").build().unwrap();

        let json = serde_json::to_string(&tool).unwrap();
        assert!(json.contains("\"type\":\"tool\""));
        assert!(json.contains("\"name\":\"Cobalt Strike\""));
    }
}