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

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

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

/// Note SDO
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct Note {
    #[serde(flatten)]
    pub common: CommonProperties,
    #[serde(rename = "abstract")]
    pub abstract_: Option<String>,
    pub content: Option<String>,
}

impl Note {
    pub fn builder() -> NoteBuilder {
        NoteBuilder::default()
    }
}

#[derive(Debug, Default)]
pub struct NoteBuilder {
    abstract_: Option<String>,
    content: Option<String>,
    created_by_ref: Option<String>,
}

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

    pub fn content(mut self, c: impl Into<String>) -> Self {
        self.content = Some(c.into());
        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<Note, BuilderError> {
        let common = CommonProperties::new("note", self.created_by_ref);
        Ok(Note {
            common,
            abstract_: self.abstract_,
            content: self.content,
        })
    }
}

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

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

    #[test]
    fn note_builder() {
        let note = Note::builder()
            .abstract_("Summary of findings")
            .content("Detailed analysis of the threat actor's TTPs")
            .build()
            .unwrap();

        assert_eq!(note.abstract_.as_deref(), Some("Summary of findings"));
        assert_eq!(note.common.r#type, "note");
    }

    #[test]
    fn note_serialize() {
        let note = Note::builder()
            .content("Important observation")
            .build()
            .unwrap();

        let json = serde_json::to_string(&note).unwrap();
        assert!(json.contains("\"type\":\"note\""));
        assert!(json.contains("\"content\":\"Important observation\""));
    }
}