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

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

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

/// Observed Data SDO
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct ObservedData {
    #[serde(flatten)]
    pub common: CommonProperties,
    pub first_observed: DateTime<Utc>,
    pub last_observed: DateTime<Utc>,
    pub number_observed: u32,
    pub object_refs: Vec<String>,
}

impl ObservedData {
    pub fn builder() -> ObservedDataBuilder {
        ObservedDataBuilder::default()
    }
}

#[derive(Debug, Default)]
pub struct ObservedDataBuilder {
    first_observed: Option<DateTime<Utc>>,
    last_observed: Option<DateTime<Utc>>,
    number_observed: Option<u32>,
    object_refs: Option<Vec<String>>,
    created_by_ref: Option<String>,
}

impl ObservedDataBuilder {
    pub fn first_observed(mut self, t: DateTime<Utc>) -> Self {
        self.first_observed = Some(t);
        self
    }

    pub fn last_observed(mut self, t: DateTime<Utc>) -> Self {
        self.last_observed = Some(t);
        self
    }

    pub fn number_observed(mut self, n: u32) -> Self {
        self.number_observed = Some(n);
        self
    }

    pub fn object_refs(mut self, refs: Vec<String>) -> Self {
        self.object_refs = Some(refs);
        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<ObservedData, BuilderError> {
        let first = self
            .first_observed
            .ok_or(BuilderError::MissingField("first_observed"))?;
        let last = self
            .last_observed
            .ok_or(BuilderError::MissingField("last_observed"))?;
        let num = self
            .number_observed
            .ok_or(BuilderError::MissingField("number_observed"))?;
        let objs = self
            .object_refs
            .ok_or(BuilderError::MissingField("object_refs"))?;
        let common = CommonProperties::new("observed-data", self.created_by_ref);
        Ok(ObservedData {
            common,
            first_observed: first,
            last_observed: last,
            number_observed: num,
            object_refs: objs,
        })
    }
}

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

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

    #[test]
    fn observed_data_builder() {
        let od = ObservedData::builder()
            .first_observed(Utc::now())
            .last_observed(Utc::now())
            .number_observed(1)
            .object_refs(vec!["file--1234".into()])
            .build()
            .unwrap();

        assert_eq!(od.number_observed, 1);
        assert_eq!(od.common.r#type, "observed-data");
    }

    #[test]
    fn observed_data_serialize() {
        let od = ObservedData::builder()
            .first_observed(Utc::now())
            .last_observed(Utc::now())
            .number_observed(1)
            .object_refs(vec!["file--1234".into()])
            .build()
            .unwrap();

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