rustbin 0.8.0

Parsers for binary file formats (mostly Windows related).
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
use chrono::{DateTime, Utc};
use serde::Serialize;

use crate::pe::{
    dos::DosHeader, 
    export::ExportDirectory, 
    file::{self, FileHeader, MachineType}, 
    import::{x64::ImportLookup64, x86::ImportLookup32, ImportDescriptor, ImportLookup}, 
    optional::{self, x64::OptionalHeader64, x86::OptionalHeader32, OptionalHeader}, 
    rsrc::{ResourceDirectory, ResourceEntry, ResourceNode, ResourceType}, 
    section::{self, SectionHeader}, 
    PeImage};

use super::{DataDirValue, ExportValue, RelocBlockValue, ResourceDataValue, ResourceStringValue};


#[derive(Debug, Serialize)]
pub struct MinPeImage {
    pub dos_header: MinDosHeader,
    pub file_hedaer: MinFileHeader,
    pub optional_header: MinOptionalHeader,
    pub data_directories: Vec<DataDirValue>,
    pub sections: Vec<MinSectionHeader>,
    #[serde(skip_serializing_if="Option::is_none")]
    pub import_directories: Option<Vec<MinImportDescriptor>>,
    #[serde(skip_serializing_if="Option::is_none")]
    pub export_directory: Option<MinExportDirectory>,
    #[serde(skip_serializing_if="Option::is_none")]
    pub relocations: Option<Vec<RelocBlockValue>>,
    #[serde(skip_serializing_if="Option::is_none")]
    pub resources: Option<MinRsrcDirectory>,
}

impl From<&PeImage> for MinPeImage {
    fn from(value: &PeImage) -> Self {
        Self { 
            dos_header: MinDosHeader::from(&value.dos.value),
            file_hedaer: MinFileHeader::from(&value.file.value),
            optional_header: MinOptionalHeader::from(&value.optional.value),
            
            data_directories: value.data_dirs.value
                .iter()
                .filter(|dir| dir.value.size.value > 0)
                .map(|dir| DataDirValue::from(&dir.value))
                .collect::<Vec<DataDirValue>>(),
            
            sections: value.sections.value
                .iter()
                .map(|s| MinSectionHeader::from(&s.value))
                .collect(),
            
            import_directories: if value.has_imports() {
                Some( 
                    value.imports.value
                    .iter()
                    .map(|id| MinImportDescriptor::from(&id.value))
                    .collect()
                )} else { Option::None },

            export_directory: if value.has_exports() {
                    Some(MinExportDirectory::from(&value.exports.value))
                } else { Option::None },
            
            relocations: if value.has_relocations() { 
                Some(
                    value.relocations.value.blocks
                    .iter()
                    .map(|rb| RelocBlockValue::from(&rb.value))
                    .collect() 
                )} else { Option::None },

            resources: if value.has_rsrc() {
                    Some( MinRsrcDirectory::from(&value.resources.value))
                } else { Option::None }
        }
    }
}

#[derive(Debug, Serialize)]
#[serde(rename="dos_header")]
pub struct MinDosHeader {
    pub magic: String,
    pub e_lfanew: u32,    
}

impl From<&DosHeader> for MinDosHeader {
    fn from(value: &DosHeader) -> Self {
        Self { 
            magic: std::str::from_utf8(&value.e_magic.value.to_le_bytes())
                    .unwrap_or("ERR")
                    .trim_matches('\0') //has trailing NULL bytes
                    .to_string(),
            e_lfanew: value.e_lfanew.value, 
        }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="file_header")]
pub struct MinFileHeader {
    pub magic: String,
    #[serde(rename="machine_type")]
    pub machine: MachineType,
    #[serde(rename="number_of_sections")]
    pub sections: u16,
    pub timestamp: DateTime<Utc>,
    #[serde(skip_serializing)]
    #[serde(rename="pointer_to_symbol_table")]
    pub sym_ptr: u32,
    #[serde(skip_serializing)]
    #[serde(rename="number_of_symbols")]
    pub symbols: u32,
    #[serde(rename="size_of_optional_header")]
    pub optional_header_size: u16,
    pub charactristics: file::Flags,
}

impl From<&FileHeader> for MinFileHeader {
    fn from(value: &FileHeader) -> Self {
        Self { 
            magic: std::str::from_utf8(&value.magic.value.to_le_bytes())
                    .unwrap_or("ERR")
                    .trim_matches('\0') //magic has traling NULL bytes 
                    .to_string(), 
            machine: value.machine.value, 
            sections: value.sections.value, 
            timestamp: value.timestamp.value, 
            sym_ptr: value.symbol_table_ptr.value, 
            symbols: value.symbols.value, 
            optional_header_size: value.optional_header_size.value, 
            charactristics: file::Flags::from_bits_truncate(value.charactristics.value),
        }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="optional_header")]
pub struct MinOptionalHeader32 {
    pub magic: optional::ImageType,
    pub major_linker_version: u8,
    pub minor_linker_version: u8,
    pub size_of_code: u32,
    pub size_of_initialized_data: u32,
    pub size_of_uninitialized_data: u32,
    pub address_of_entry_point: u32,
    pub base_of_code: u32,
    pub base_of_data: u32,
    pub image_base: u32,
    pub major_os_version: u16,
    pub minor_os_version: u16,
    pub major_subsystem_version: u16,
    pub minor_subsystem_version: u16,
    pub size_of_image: u32,
    pub size_of_headers: u32,
    pub checksum: u32,
    pub subsystem: optional::SubSystem,
    pub dll_charactristics: optional::Flags,
    pub number_of_rva_and_sizes: u32,
}

impl From<&OptionalHeader32> for MinOptionalHeader32 {
    fn from(value: &OptionalHeader32) -> Self {
        Self { 
            magic: value.magic.value, 
            major_linker_version: value.major_linker_ver.value, 
            minor_linker_version: value.minor_linker_ver.value, 
            size_of_code: value.sizeof_code.value, 
            size_of_initialized_data: value.sizeof_initiailized_data.value, 
            size_of_uninitialized_data: value.sizeof_uninitiailized_data.value,
            address_of_entry_point: value.address_of_entry_point.value, 
            base_of_code: value.base_of_code.value,
            base_of_data: value.base_of_data.value,
            image_base: value.image_base.value, 
            major_os_version: value.major_os_version.value,
            minor_os_version: value.minor_os_version.value,
            major_subsystem_version: value.major_subsystem_version.value,
            minor_subsystem_version: value.minor_subsystem_version.value,
            size_of_image: value.sizeof_image.value, 
            size_of_headers: value.sizeof_headers.value, 
            checksum: value.checksum.value, 
            subsystem: value.subsystem.value, 
            dll_charactristics: optional::Flags::from_bits_retain(value.dll_charactristics.value), 
            number_of_rva_and_sizes:  value.number_of_rva_and_sizes.value
        }
    }
}

#[derive(Debug, Serialize)]
#[serde(rename="optional_header")]
pub struct MinOptionalHeader64 {
    pub magic: optional::ImageType,
    pub major_linker_version: u8,
    pub minor_linker_version: u8,
    pub size_of_code: u32,
    pub size_of_initialized_data: u32,
    pub size_of_uninitialized_data: u32,
    pub address_of_entry_point: u32,
    pub base_of_code: u32,
    pub image_base: u64,
    pub major_os_version: u16,
    pub minor_os_version: u16,
    pub major_subsystem_version: u16,
    pub minor_subsystem_version: u16,
    pub size_of_image: u32,
    pub size_of_headers: u32,
    pub checksum: u32,
    pub subsystem: optional::SubSystem,
    pub dll_charactristics: optional::Flags,
    pub number_of_rva_and_sizes: u32,
}

impl From<&OptionalHeader64> for MinOptionalHeader64 {
    fn from(value: &OptionalHeader64) -> Self {
        Self { 
            magic: value.magic.value, 
            major_linker_version: value.major_linker_ver.value, 
            minor_linker_version: value.minor_linker_ver.value, 
            size_of_code: value.sizeof_code.value, 
            size_of_initialized_data: value.sizeof_initiailized_data.value, 
            size_of_uninitialized_data: value.sizeof_uninitiailized_data.value,
            address_of_entry_point: value.address_of_entry_point.value, 
            base_of_code: value.base_of_code.value,
            image_base: value.image_base.value, 
            major_os_version: value.major_os_version.value,
            minor_os_version: value.minor_os_version.value,
            major_subsystem_version: value.major_subsystem_version.value,
            minor_subsystem_version: value.minor_subsystem_version.value,
            size_of_image: value.sizeof_image.value, 
            size_of_headers: value.sizeof_headers.value, 
            checksum: value.checksum.value, 
            subsystem: value.subsystem.value, 
            dll_charactristics: optional::Flags::from_bits_retain(value.dll_charactristics.value), 
            number_of_rva_and_sizes:  value.number_of_rva_and_sizes.value
        }
    }
}

#[derive(Debug, Serialize)]
#[serde(rename="optional_header")]
pub enum MinOptionalHeader {
    #[serde(untagged)]
    X86(MinOptionalHeader32),
    #[serde(untagged)]
    X64(MinOptionalHeader64),
}


impl From<&OptionalHeader> for MinOptionalHeader {
    fn from(value: &OptionalHeader) -> Self {
        match value {
            OptionalHeader::X86(opt) => Self::X86(MinOptionalHeader32::from(opt)),
            OptionalHeader::X64(opt) => Self::X64(MinOptionalHeader64::from(opt)),
        }
    }
}

#[derive(Debug, Serialize)]
#[serde(rename="section")]
pub struct MinSectionHeader {
    pub name: String,
    pub virtual_size: u32,
    pub virtual_address: u32,
    #[serde(rename="size_of_raw_data")]
    pub sizeof_raw_data: u32,
    #[serde(rename="pointer_to_raw_data")]
    pub raw_data_ptr: u32,
    pub charactristics: section::Flags,
}

impl From<&SectionHeader> for MinSectionHeader {
    fn from(value: &SectionHeader) -> Self {
        Self { 
            name: String::from_utf8(value.name.value.to_vec())
                    .unwrap_or("ERR".to_string())
                    .trim_end_matches('\0') //section name usually has trailing NULL bytes.
                    .to_string(), 
            virtual_size: value.virtual_size.value,
            virtual_address: value.virtual_address.value,
            sizeof_raw_data: value.sizeof_raw_data.value,
            raw_data_ptr: value.raw_data_ptr.value,
            charactristics: section::Flags::from_bits_retain(value.charactristics.value),
        }
    }
}



/** **V**alue **O**nly variant of `ImportLookup`s.  
  For every member, takes only `value` form `HeaderField`. 
*/
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum ImportLookupVO {
    Ordinal(u16),
    Name(String),
}

impl From<&ImportLookup32> for ImportLookupVO{
    fn from(value: &ImportLookup32) -> Self {
        if let Some(iname)  = &value.iname {
            Self::Name(iname.value.name.value.clone())
        }
        else {
            Self::Ordinal(value.ordinal.unwrap_or_default())
        }
    }
}

impl From<&ImportLookup64> for ImportLookupVO{
    fn from(value: &ImportLookup64) -> Self {
        if let Some(iname)  = &value.iname {
            Self::Name(iname.value.name.value.clone())
        }
        else {
            Self::Ordinal(value.ordinal.unwrap_or_default())
        }
    }
}

impl From<&ImportLookup> for ImportLookupVO {
    fn from(value: &ImportLookup) -> Self {
        match value {
            ImportLookup::X86(import) => Self::from(import),
            ImportLookup::X64(import) => Self::from(import),
        }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="import_descriptor")]
pub struct MinImportDescriptor {
    pub dll_name: String,
    //#[serde(flatten)]
    pub functions: Vec<ImportLookupVO>,
}

impl From<&ImportDescriptor> for MinImportDescriptor {
    fn from(value: &ImportDescriptor) -> Self {
        Self { 
            dll_name: value.name.clone().unwrap_or(String::from("ERR")), 
            functions: value.imports
                .iter()
                .map(|i| ImportLookupVO::from(i))
                .collect()
        }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="export_directory")]
pub struct MinExportDirectory {
    pub timestamp: DateTime<Utc>,
    pub name: String, 
    pub exports: Vec<ExportValue>,
}

impl From<&ExportDirectory> for MinExportDirectory {
    fn from(value: &ExportDirectory) -> Self {
        Self { 
            timestamp: value.timestamp.value, 
            name: value.name.clone(), 
            exports: value.exports
                .iter()
                .map(|ex| ExportValue::from(ex))
                .collect(),
            }
    }
}



#[derive(Debug, Serialize)]
//#[serde(untagged)]
pub enum MinRsrcNode {
    Str(ResourceStringValue),
    Data(ResourceDataValue),
    Dir(MinRsrcDirectory)
}

impl From<&ResourceNode> for MinRsrcNode {
    fn from(value: &ResourceNode) -> Self {
        match value {
            ResourceNode::Str(str) => Self::Str(ResourceStringValue::from(str)),
            ResourceNode::Data(data) => Self::Data(ResourceDataValue::from(data)),
            ResourceNode::Dir(dir) => Self::Dir(MinRsrcDirectory::from(dir)),
        }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="Entry")]
pub struct MinRsrcEntry {
    pub id: ResourceType,
    #[serde(flatten)]
    pub data: MinRsrcNode,
}

impl From<&ResourceEntry> for MinRsrcEntry {
    fn from(rsrc_entry: &ResourceEntry) -> Self {
        Self { id: rsrc_entry.id, data: MinRsrcNode::from(&rsrc_entry.data) }
    }
}


#[derive(Debug, Serialize)]
#[serde(rename="resource_directory")]
pub struct MinRsrcDirectory {
    #[serde(rename="number_of_named_entries")]
    pub named_entry_count: u16,
    #[serde(rename="number_of_id_entries")]
    pub id_entry_count: u16,
    pub entries: Vec<MinRsrcEntry>,
}


impl From<&ResourceDirectory> for MinRsrcDirectory {
    fn from(rsrc_dir: &ResourceDirectory) -> Self {
        Self { 
            named_entry_count: rsrc_dir.named_entry_count.value, 
            id_entry_count: rsrc_dir.id_entry_count.value, 
            entries:  rsrc_dir.entries
                .iter()
                .map(|e| MinRsrcEntry::from(e))
                .collect(),
        }
    }
}

#[cfg(test)]
mod tests;