rusthound_ce/objects/
group.rs

1use serde::{Deserialize, Serialize};
2use serde_json::value::Value;
3use ldap3::SearchEntry;
4use log::{debug, trace};
5use std::collections::HashMap;
6use std::error::Error;
7
8use crate::enums::regex::OBJECT_SID_RE1;
9use crate::objects::common::{LdapObject, AceTemplate, SPNTarget, Link, Member};
10use crate::enums::acl::parse_ntsecuritydescriptor;
11use crate::enums::secdesc::LdapSid;
12use crate::enums::sid::{objectsid_to_vec8, sid_maker};
13use crate::utils::date::string_to_epoch;
14
15/// Group structure
16#[derive(Debug, Clone, Deserialize, Serialize, Default)]
17pub struct Group {
18    #[serde(rename = "ObjectIdentifier")]
19    object_identifier: String,
20    #[serde(rename = "IsDeleted")]
21    is_deleted: bool,
22    #[serde(rename = "IsACLProtected")]
23    is_acl_protected: bool,
24    #[serde(rename = "Properties")]
25    properties: GroupProperties,
26    #[serde(rename = "Members")]
27    members: Vec<Member>,
28    #[serde(rename = "Aces")]
29    aces: Vec<AceTemplate>,
30    #[serde(rename = "ContainedBy")]
31    contained_by: Option<Member>,
32}
33
34impl Group {
35    // New group.
36    pub fn new() -> Self { 
37        Self { ..Default::default() } 
38    }
39
40    // Immutable access.
41    pub fn members(&self) -> &Vec<Member> {
42        &self.members
43    }
44
45    // Mutable access.
46    pub fn properties_mut(&mut self) -> &mut GroupProperties {
47        &mut self.properties
48    }
49    pub fn object_identifier_mut(&mut self) -> &mut String {
50        &mut self.object_identifier
51    }
52    pub fn members_mut(&mut self) -> &mut Vec<Member> {
53        &mut self.members
54    }
55
56    /// Function to parse and replace value for group object.
57    /// <https://bloodhound.readthedocs.io/en/latest/further-reading/json.html#groups>
58    pub fn parse(
59        &mut self,
60        result: SearchEntry,
61        domain: &str,
62        dn_sid: &mut HashMap<String, String>,
63        sid_type: &mut HashMap<String, String>,
64        domain_sid: &str,
65    ) -> Result<(), Box<dyn Error>> {
66        let result_dn: String = result.dn.to_uppercase();
67        let result_attrs: HashMap<String, Vec<String>> = result.attrs;
68        let result_bin: HashMap<String, Vec<Vec<u8>>> = result.bin_attrs;
69
70        debug!("Parse group: {result_dn}");
71
72        // Trace all result attributes
73        for (key, value) in &result_attrs {
74            trace!("  {key:?}:{value:?}");
75        }
76        // Trace all bin result attributes
77        for (key, value) in &result_bin {
78            trace!("  {key:?}:{value:?}");
79        }
80
81        // Some needed vectors.
82        let mut vec_members: Vec<Member> = Vec::new();
83        let mut member_template = Member::new();
84
85        // Change all values...
86        self.properties.domain = domain.to_uppercase();
87        self.properties.distinguishedname = result_dn;
88        self.properties.domainsid = domain_sid.to_string();
89
90        // With a check
91        for (key, value) in &result_attrs {
92            match key.as_str() {
93                "name" => {
94                    let name = &value[0];
95                    let email = format!("{}@{}", name.to_owned(), domain);
96                    self.properties.name = email.to_uppercase();
97                }
98                "description" => {
99                    self.properties.description = Some(value[0].to_owned());
100                }
101                "adminCount" => {
102                    let isadmin = &value[0];
103                    let mut admincount = false;
104                    if isadmin == "1" {
105                        admincount = true;
106                    }
107                    self.properties.admincount = admincount;
108                }
109                "sAMAccountName" => {
110                    self.properties.samaccountname = value[0].to_owned();
111                }
112                "member" => {
113                    if !value.is_empty() {
114                        for member in value {
115                            *member_template.object_identifier_mut() = member.to_owned().to_uppercase();
116                            if member_template.object_identifier() != "SID" {
117                                vec_members.push(member_template.to_owned());
118                            }
119                        }
120                        self.members = vec_members.to_owned();
121                    }
122                }
123                "objectSid" => {
124                    // objectSid to vec and raw to string
125                    let vec_sid = objectsid_to_vec8(&value[0]);
126                    let sid = sid_maker(LdapSid::parse(&vec_sid).unwrap().1, domain);
127                    self.object_identifier = sid.to_owned();
128
129                    /*let re = Regex::new(r"^S-[0-9]{1}-[0-9]{1}-[0-9]{1,}-[0-9]{1,}-[0-9]{1,}-[0-9]{1,}").unwrap();
130                    for domain_sid in re.captures_iter(&sid) 
131                    {
132                        group_json["Properties"]["domainsid"] = domain_sid[0].to_owned().to_string();
133                    }*/
134
135                    // highvalue
136                    if sid.ends_with("-512") 
137                        || sid.ends_with("-516") 
138                        || sid.ends_with("-519") 
139                        || sid.ends_with("-520") 
140                    {
141                        self.properties.highvalue = true;
142                    } else if sid.ends_with("S-1-5-32-544") 
143                        || sid.ends_with("S-1-5-32-548") 
144                        || sid.ends_with("S-1-5-32-549")
145                        || sid.ends_with("S-1-5-32-550") 
146                        || sid.ends_with("S-1-5-32-551")
147                    {
148                        self.properties.highvalue = true;
149                    } else {
150                        self.properties.highvalue = false;
151                    }
152                }
153                "whenCreated" => {
154                    let epoch = string_to_epoch(&value[0])?;
155                    if epoch.is_positive() {
156                        self.properties.whencreated = epoch;
157                    }
158                }
159                "IsDeleted" => {
160                    self.is_deleted = true;
161                }
162                _ => {}
163            }
164        }
165
166        // For all, bins attributs
167        for (key, value) in &result_bin {
168            match key.as_str() {
169                "objectSid" => {
170                    // objectSid raw to string
171                    let sid = sid_maker(LdapSid::parse(&value[0]).unwrap().1, domain);
172                    self.object_identifier = sid.to_owned();
173
174                    for domain_sid in OBJECT_SID_RE1.captures_iter(&sid) {
175                        self.properties.domainsid = domain_sid[0].to_owned().to_string();
176                    }
177    
178                    // highvalue
179                    if sid.ends_with("-512") 
180                        || sid.ends_with("-516") 
181                        || sid.ends_with("-519") 
182                        || sid.ends_with("-520") 
183                    {
184                        self.properties.highvalue = true;
185                    }
186                    else if sid.ends_with("S-1-5-32-544") 
187                        || sid.ends_with("S-1-5-32-548") 
188                        || sid.ends_with("S-1-5-32-549")
189                        || sid.ends_with("S-1-5-32-550") 
190                        || sid.ends_with("S-1-5-32-551") 
191                    {
192                        self.properties.highvalue = true;
193                    }
194                    else {
195                        self.properties.highvalue = false;
196                    }
197                }
198                "nTSecurityDescriptor" => {
199                    // nTSecurityDescriptor raw to string
200                    let relations_ace = parse_ntsecuritydescriptor(
201                        self,
202                        &value[0],
203                        "Group",
204                        &result_attrs,
205                        &result_bin,
206                        domain,
207                    );
208                    self.aces = relations_ace;
209                }
210                _ => {}
211            }
212        }
213
214        // Push DN and SID in HashMap
215        dn_sid.insert(
216            self.properties.distinguishedname.to_string(),
217            self.object_identifier.to_string(),
218        );
219        // Push DN and Type
220        sid_type.insert(
221            self.object_identifier.to_string(),
222            "Group".to_string(),
223        );
224
225        // Trace and return Group struct
226        // trace!("JSON OUTPUT: {:?}",serde_json::to_string(&self).unwrap());
227        Ok(())
228    }
229}
230
231impl LdapObject for Group {
232    // To JSON
233    fn to_json(&self) -> Value {
234        serde_json::to_value(self).unwrap()
235    }
236
237    // Get values
238    fn get_object_identifier(&self) -> &String {
239        &self.object_identifier
240    }
241    fn get_is_acl_protected(&self) -> &bool {
242        &self.is_acl_protected
243    }
244    fn get_aces(&self) -> &Vec<AceTemplate> {
245        &self.aces
246    }
247    fn get_spntargets(&self) -> &Vec<SPNTarget> {
248        panic!("Not used by current object.");
249    }
250    fn get_allowed_to_delegate(&self) -> &Vec<Member> {
251        panic!("Not used by current object.");
252    }
253    fn get_links(&self) -> &Vec<Link> {
254        panic!("Not used by current object.");
255    }
256    fn get_contained_by(&self) -> &Option<Member> {
257        &self.contained_by
258    }
259    fn get_child_objects(&self) -> &Vec<Member> {
260        panic!("Not used by current object.");
261    }
262    fn get_haslaps(&self) -> &bool {
263        &false
264    }
265    
266    // Get mutable values
267    fn get_aces_mut(&mut self) -> &mut Vec<AceTemplate> {
268        &mut self.aces
269    }
270    fn get_spntargets_mut(&mut self) -> &mut Vec<SPNTarget> {
271        panic!("Not used by current object.");
272    }
273    fn get_allowed_to_delegate_mut(&mut self) -> &mut Vec<Member> {
274        panic!("Not used by current object.");
275    }
276    
277    // Edit values
278    fn set_is_acl_protected(&mut self, is_acl_protected: bool) {
279        self.is_acl_protected = is_acl_protected;
280        self.properties.isaclprotected = is_acl_protected;
281    }
282    fn set_aces(&mut self, aces: Vec<AceTemplate>) {
283        self.aces = aces;
284    }
285    fn set_spntargets(&mut self, _spn_targets: Vec<SPNTarget>) {
286        // Not used by current object.
287    }
288    fn set_allowed_to_delegate(&mut self, _allowed_to_delegate: Vec<Member>) {
289        // Not used by current object.
290    }
291    fn set_links(&mut self, _links: Vec<Link>) {
292        // Not used by current object.
293    }
294    fn set_contained_by(&mut self, contained_by: Option<Member>) {
295        self.contained_by = contained_by;
296    }
297    fn set_child_objects(&mut self, _child_objects: Vec<Member>) {
298        // Not used by current object.
299    }
300}
301
302// Group properties structure
303#[derive(Debug, Clone, Deserialize, Serialize, Default)]
304pub struct GroupProperties {
305    domain: String,
306    name: String,
307    distinguishedname: String,
308    domainsid: String,
309    isaclprotected: bool,
310    highvalue: bool,
311    samaccountname: String,
312    description: Option<String>,
313    whencreated: i64,
314    admincount: bool,
315}
316
317impl GroupProperties {
318    // Mutable access.
319    pub fn name_mut(&mut self) -> &mut String {
320        &mut self.name
321    }
322    pub fn highvalue_mut(&mut self) -> &mut bool {
323        &mut self.highvalue
324    }
325}