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};

/// Grouping SDO
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct Grouping {
    #[serde(flatten)]
    pub common: CommonProperties,

    pub name: Option<String>,
    pub description: Option<String>,
    pub context: String,
    pub object_refs: Vec<String>,
}

impl Grouping {
    pub fn builder() -> GroupingBuilder {
        GroupingBuilder::default()
    }
}

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

impl GroupingBuilder {
    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 context(mut self, c: impl Into<String>) -> Self {
        self.context = Some(c.into());
        self
    }
    pub fn object_refs(mut self, o: Vec<String>) -> Self {
        self.object_refs = Some(o);
        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<Grouping, super::BuilderError> {
        let context = self
            .context
            .ok_or(super::BuilderError::MissingField("context"))?;
        let object_refs = self
            .object_refs
            .ok_or(super::BuilderError::MissingField("object_refs"))?;
        let common = CommonProperties::new("grouping", self.created_by_ref);
        Ok(Grouping {
            common,
            name: self.name,
            description: self.description,
            context,
            object_refs,
        })
    }
}

impl StixObject for Grouping {
    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<Grouping> for crate::StixObjectEnum {
    fn from(g: Grouping) -> Self {
        crate::StixObjectEnum::Grouping(g)
    }
}

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

    #[test]
    fn grouping_builder_and_serialize() {
        let g = Grouping::builder()
            .context("suspicious-activity")
            .object_refs(vec!["file--1234".into()])
            .build()
            .unwrap();

        let s = serde_json::to_string(&g).unwrap();
        let v: Value = serde_json::from_str(&s).unwrap();
        assert_eq!(v.get("type").and_then(Value::as_str).unwrap(), "grouping");
        assert!(v.get("object_refs").is_some());
    }
}