maec-rs 0.1.0

MAEC (Malware Attribute Enumeration and Characterization) data model library 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

//! MAEC Relationship object

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

use crate::common::MaecObject;
use crate::error::{MaecError, Result};

/// MAEC Relationship
///
/// Connects two MAEC objects, expressing how they are related.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub struct Relationship {
    /// Common MAEC properties
    #[serde(flatten)]
    pub common: crate::common::CommonProperties,

    /// ID of the source object
    pub source_ref: String,

    /// ID of the target object
    pub target_ref: String,

    /// Type of relationship (e.g., "derived-from", "variant-of")
    pub relationship_type: String,

    /// Textual description
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

impl Relationship {
    pub fn builder() -> RelationshipBuilder {
        RelationshipBuilder::default()
    }

    pub fn new(
        source_ref: impl Into<String>,
        relationship_type: impl Into<String>,
        target_ref: impl Into<String>,
    ) -> Self {
        Self {
            common: crate::common::CommonProperties::new("relationship", None),
            source_ref: source_ref.into(),
            target_ref: target_ref.into(),
            relationship_type: relationship_type.into(),
            description: None,
        }
    }
}

impl MaecObject for Relationship {
    fn id(&self) -> &str {
        &self.common.id
    }

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

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

#[derive(Debug, Default)]
pub struct RelationshipBuilder {
    id: Option<String>,
    source_ref: Option<String>,
    target_ref: Option<String>,
    relationship_type: Option<String>,
    description: Option<String>,
}

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

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

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

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

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

    pub fn build(self) -> Result<Relationship> {
        let source_ref = self
            .source_ref
            .ok_or(MaecError::MissingField("source_ref"))?;
        let target_ref = self
            .target_ref
            .ok_or(MaecError::MissingField("target_ref"))?;
        let relationship_type = self
            .relationship_type
            .ok_or(MaecError::MissingField("relationship_type"))?;

        let mut common = crate::common::CommonProperties::new("relationship", None);
        if let Some(id) = self.id {
            common.id = id;
        }

        Ok(Relationship {
            common,
            source_ref,
            target_ref,
            relationship_type,
            description: self.description,
        })
    }
}