pe-assembler 0.1.1

PE/COFF assembler for Windows instruction sets - strongly typed, object-oriented, zero-dependency core
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
436
437
438
439
440
441
442
443
444
445
446
447
448
use crate::types::{
    CoffHeader, DosHeader, ExportTable, ImportTable, NtHeader, OptionalHeader, PeHeader, PeInfo, PeProgram, PeSection,
    SectionHeader,
};
use gaia_binary::{LittleEndian, ReadBytesExt};
use gaia_types::{helpers::Architecture, GaiaError};
use std::io::{Read, Seek, SeekFrom};

/// Common trait for PE file readers
pub trait PeReader<R: Read + Seek> {
    /// Get a mutable reference to the binary reader
    fn get_viewer(&mut self) -> &mut R;

    /// Get a mutable reference to diagnostics information
    fn add_diagnostics(&mut self, error: impl Into<GaiaError>);

    fn get_position(&mut self) -> Result<u64, GaiaError>
    where
        R: Seek,
    {
        let position = self.get_viewer().stream_position()?;
        Ok(position)
    }

    fn set_position(&mut self, offset: u64) -> Result<u64, GaiaError>
    where
        R: Seek,
    {
        let position = self.get_viewer().seek(SeekFrom::Start(offset))?;
        Ok(position)
    }

    /// Get cached section headers
    fn get_section_headers(&mut self) -> Result<&[SectionHeader], GaiaError>;

    /// Read PE header information (generic implementation)
    fn get_pe_header(&mut self) -> Result<&PeHeader, GaiaError>;

    /// Convert RVA to file offset (generic implementation)
    fn rva_to_file_offset(&self, rva: u32, sections: &[PeSection]) -> Result<u32, GaiaError> {
        for section in sections {
            if rva >= section.virtual_address && rva < section.virtual_address + section.virtual_size {
                let offset_in_section = rva - section.virtual_address;
                return Ok(section.pointer_to_raw_data + offset_in_section);
            }
        }
        Err(GaiaError::invalid_data(&format!("Unable to convert RVA 0x{:08X} to file offset", rva)))
    }

    /// Parse import table (generic implementation)
    fn parse_import_table(&mut self, header: &PeHeader, sections: &[PeSection]) -> Result<ImportTable, GaiaError> {
        // Check if the data directory table contains import table information
        if header.optional_header.data_directories.len() < 2 {
            return Ok(ImportTable::new());
        }

        let import_dir = &header.optional_header.data_directories[1]; // Import table is the 2nd data directory
        if import_dir.virtual_address == 0 || import_dir.size == 0 {
            return Ok(ImportTable::new());
        }

        // Convert RVA to file offset
        let file_offset = self.rva_to_file_offset(import_dir.virtual_address, sections)?;

        // Save current position
        let current_pos = self.get_position()?;

        // Seek to the import table
        self.set_position(file_offset as u64)?;

        let mut import_table = ImportTable::new();

        // Read import descriptors
        loop {
            let import_lookup_table = self.get_viewer().read_u32::<LittleEndian>()?;
            let time_date_stamp = self.get_viewer().read_u32::<LittleEndian>()?;
            let forwarder_chain = self.get_viewer().read_u32::<LittleEndian>()?;
            let name_rva = self.get_viewer().read_u32::<LittleEndian>()?;
            let import_address_table = self.get_viewer().read_u32::<LittleEndian>()?;

            // If all fields are 0, it means the end of the import table
            if import_lookup_table == 0
                && time_date_stamp == 0
                && forwarder_chain == 0
                && name_rva == 0
                && import_address_table == 0
            {
                break;
            }

            let mut dll_name = String::new();
            let mut functions = Vec::new();

            // Read DLL name
            if name_rva != 0 {
                let name_offset = self.rva_to_file_offset(name_rva, sections)?;
                let saved_pos = self.get_position()?;
                self.set_position(name_offset as u64)?;

                let mut name_bytes = Vec::new();
                loop {
                    let byte = self.get_viewer().read_u8()?;
                    if byte == 0 {
                        break;
                    }
                    name_bytes.push(byte);
                }
                dll_name = String::from_utf8_lossy(&name_bytes).to_string();
                self.set_position(saved_pos)?;
            }

            // Read function names (from Import Lookup Table)
            if import_lookup_table != 0 {
                let lookup_offset = self.rva_to_file_offset(import_lookup_table, sections)?;
                let saved_pos = self.get_position()?;
                self.set_position(lookup_offset as u64)?;

                loop {
                    let entry = if header.optional_header.magic == 0x20b {
                        // PE32+
                        self.get_viewer().read_u64::<LittleEndian>()?
                    }
                    else {
                        // PE32
                        self.get_viewer().read_u32::<LittleEndian>()? as u64
                    };

                    if entry == 0 {
                        break;
                    }

                    // Check if imported by name (highest bit is 0)
                    let is_ordinal = if header.optional_header.magic == 0x20b {
                        (entry & 0x8000000000000000) != 0
                    }
                    else {
                        (entry & 0x80000000) != 0
                    };

                    if !is_ordinal {
                        let hint_name_rva =
                            entry & if header.optional_header.magic == 0x20b { 0x7FFFFFFFFFFFFFFF } else { 0x7FFFFFFF };
                        let hint_name_offset = self.rva_to_file_offset(hint_name_rva as u32, sections)?;
                        let func_pos = self.get_position()?;
                        self.set_position(hint_name_offset as u64)?;

                        // Skip hint (2 bytes)
                        self.get_viewer().read_u16::<LittleEndian>()?;

                        // Read function name
                        let mut func_name_bytes = Vec::new();
                        loop {
                            let byte = self.get_viewer().read_u8()?;
                            if byte == 0 {
                                break;
                            }
                            func_name_bytes.push(byte);
                        }
                        let func_name = String::from_utf8_lossy(&func_name_bytes).to_string();
                        functions.push(func_name);

                        self.set_position(func_pos)?;
                    }
                    else {
                        // Import by ordinal
                        let ordinal = entry & 0xFFFF;
                        functions.push(format!("Ordinal_{}", ordinal));
                    }
                }

                self.set_position(saved_pos)?;
            }

            // Add import entry
            if !dll_name.is_empty() {
                use crate::types::tables::ImportEntry;
                let entry = ImportEntry { dll_name, functions };
                import_table.entries.push(entry);
            }
        }

        // Restore position
        self.set_position(current_pos)?;

        Ok(import_table)
    }

    /// Parse export table (generic implementation)
    fn parse_export_table(&mut self, header: &PeHeader, sections: &[PeSection]) -> Result<ExportTable, GaiaError> {
        // Check if the data directory table contains export table information
        if header.optional_header.data_directories.is_empty() {
            return Ok(ExportTable { name: String::new(), functions: Vec::new() });
        }

        let export_dir = &header.optional_header.data_directories[0]; // Export table is the 1st data directory
        if export_dir.virtual_address == 0 || export_dir.size == 0 {
            return Ok(ExportTable { name: String::new(), functions: Vec::new() });
        }

        // Convert RVA to file offset
        let file_offset = self.rva_to_file_offset(export_dir.virtual_address, sections)?;

        // Save current position
        let current_pos = self.get_position()?;

        // Seek to the export table
        self.set_position(file_offset as u64)?;

        // Read Export Directory Table
        let _export_flags = self.get_viewer().read_u32::<LittleEndian>()?;
        let _time_date_stamp = self.get_viewer().read_u32::<LittleEndian>()?;
        let _major_version = self.get_viewer().read_u16::<LittleEndian>()?;
        let _minor_version = self.get_viewer().read_u16::<LittleEndian>()?;
        let name_rva = self.get_viewer().read_u32::<LittleEndian>()?;
        let _ordinal_base = self.get_viewer().read_u32::<LittleEndian>()?;
        let _number_of_functions = self.get_viewer().read_u32::<LittleEndian>()?;
        let number_of_names = self.get_viewer().read_u32::<LittleEndian>()?;
        let _address_of_functions = self.get_viewer().read_u32::<LittleEndian>()?;
        let address_of_names = self.get_viewer().read_u32::<LittleEndian>()?;
        let _address_of_name_ordinals = self.get_viewer().read_u32::<LittleEndian>()?;

        // Read module name
        let mut name = String::new();
        if name_rva != 0 {
            let name_offset = self.rva_to_file_offset(name_rva, sections)?;
            let saved_pos = self.get_position()?;
            self.set_position(name_offset as u64)?;

            let mut name_bytes = Vec::new();
            loop {
                let byte = self.get_viewer().read_u8()?;
                if byte == 0 {
                    break;
                }
                name_bytes.push(byte);
            }
            name = String::from_utf8_lossy(&name_bytes).to_string();
            self.set_position(saved_pos)?;
        }

        // Read function names
        let mut functions = Vec::new();
        if address_of_names != 0 && number_of_names > 0 {
            let names_offset = self.rva_to_file_offset(address_of_names, sections)?;
            let saved_pos = self.get_position()?;
            self.set_position(names_offset as u64)?;

            for _ in 0..number_of_names {
                let name_rva = self.get_viewer().read_u32::<LittleEndian>()?;
                if name_rva != 0 {
                    let func_name_offset = self.rva_to_file_offset(name_rva, sections)?;
                    let func_pos = self.get_position()?;
                    self.set_position(func_name_offset as u64)?;

                    let mut func_name_bytes = Vec::new();
                    loop {
                        let byte = self.get_viewer().read_u8()?;
                        if byte == 0 {
                            break;
                        }
                        func_name_bytes.push(byte);
                    }
                    let func_name = String::from_utf8_lossy(&func_name_bytes).to_string();
                    functions.push(func_name);

                    self.set_position(func_pos)?;
                }
            }

            self.set_position(saved_pos)?;
        }

        // Restore position
        self.set_position(current_pos)?;

        Ok(ExportTable { name, functions })
    }

    /// Create PE info view (generic implementation)
    fn create_pe_info(&mut self) -> Result<PeInfo, GaiaError> {
        let header = self.get_pe_header()?.clone();

        // Determine architecture based on machine type
        let target_arch = match header.coff_header.machine {
            0x014c => Architecture::X86,
            0x8664 => Architecture::X86_64,
            0x01c0 => Architecture::ARM32,
            0xaa64 => Architecture::ARM64,
            unknown => {
                tracing::warn!("Unknown machine type: {:04x}", unknown);
                Architecture::Unknown
            }
        };

        // Get current file size
        let current_pos = self.get_position()?;
        self.get_viewer().seek(std::io::SeekFrom::End(0))?;
        let file_size = self.get_position()?;
        self.set_position(current_pos)?;

        Ok(PeInfo {
            target_arch,
            subsystem: header.optional_header.subsystem,
            entry_point: header.optional_header.address_of_entry_point,
            image_base: header.optional_header.image_base,
            section_count: header.coff_header.number_of_sections,
            file_size,
        })
    }
    /// Force read full [PeProgram] and cache the result
    fn get_program(&mut self) -> Result<&PeProgram, GaiaError>;
}

/// Parse PE header (generic implementation)
pub fn read_pe_head<R: Read + Seek>(reader: &mut impl PeReader<R>) -> Result<PeHeader, GaiaError> {
    // Save current position
    let original_pos = reader.get_position()?;

    // Reset to the beginning of the file
    reader.set_position(0)?;

    // Read DOS header
    let dos_header = DosHeader::read(reader.get_viewer())?;

    // Verify DOS signature (MZ)
    if dos_header.e_magic != 0x5A4D {
        let error = GaiaError::invalid_data("Invalid DOS signature (MZ)");
        reader.add_diagnostics(error);
    }

    // Jump to NT header position
    reader.set_position(dos_header.e_lfanew as u64)?;

    // Read NT header
    let nt_header = NtHeader::read(reader.get_viewer())?;

    // Verify PE signature (PE\0\0)
    if nt_header.signature != 0x00004550 {
        let error = GaiaError::invalid_data("Invalid PE signature (PE)");
        reader.add_diagnostics(error);
    }

    // Read COFF header
    let coff_header = CoffHeader::read(reader.get_viewer())?;

    // Verify number of sections in COFF header
    if coff_header.number_of_sections == 0 {
        let error = GaiaError::invalid_data("PE file must have at least one section");
        reader.add_diagnostics(error);
    }

    // Read optional header
    let optional_header = OptionalHeader::read(reader.get_viewer())?;

    // Verify optional header magic
    match optional_header.magic {
        0x10b => {} // PE32
        0x20b => {} // PE32+
        _ => {
            let error = GaiaError::invalid_data("Invalid optional header magic");
            reader.add_diagnostics(error);
            return Err(GaiaError::invalid_data("Invalid optional header magic"));
        }
    }

    // Restore original position
    reader.set_position(original_pos)?;

    Ok(PeHeader { dos_header, nt_header, coff_header, optional_header })
}

/// Read section header information (generic implementation)
pub fn read_pe_section_headers<R: Read + Seek>(reader: &mut impl PeReader<R>) -> Result<Vec<SectionHeader>, GaiaError> {
    // Read the main header first
    let header = reader.get_pe_header()?.clone();
    let original_pos = reader.get_position()?;

    // Read section headers
    let mut section_headers = Vec::with_capacity(header.coff_header.number_of_sections as usize);

    // Seek to the section headers position
    let section_header_offset = header.dos_header.e_lfanew as u64
        + 4 // PE signature
        + std::mem::size_of::<CoffHeader>() as u64
        + header.coff_header.size_of_optional_header as u64;

    reader.set_position(section_header_offset)?;

    for _ in 0..header.coff_header.number_of_sections {
        let section_header = SectionHeader::read(reader.get_viewer())?;
        section_headers.push(section_header);
    }

    // Restore original position
    reader.set_position(original_pos)?;

    Ok(section_headers)
}

/// Read section data from section header (generic implementation)
pub fn read_section_from_header<R: Read + Seek>(
    reader: &mut impl PeReader<R>,
    header: &SectionHeader,
) -> Result<PeSection, GaiaError> {
    let name = String::from_utf8_lossy(&header.name).trim_end_matches('\0').to_string();

    let mut data = Vec::new();
    if header.size_of_raw_data > 0 && header.pointer_to_raw_data > 0 {
        let original_pos = reader.get_position()?;
        reader.set_position(header.pointer_to_raw_data as u64)?;
        data.resize(header.size_of_raw_data as usize, 0);
        reader.get_viewer().read_exact(&mut data)?;
        reader.set_position(original_pos)?;
    }

    Ok(PeSection {
        name,
        virtual_size: header.virtual_size,
        virtual_address: header.virtual_address,
        size_of_raw_data: header.size_of_raw_data,
        pointer_to_raw_data: header.pointer_to_raw_data,
        pointer_to_relocations: header.pointer_to_relocations,
        pointer_to_line_numbers: header.pointer_to_line_numbers,
        number_of_relocations: header.number_of_relocations,
        number_of_line_numbers: header.number_of_line_numbers,
        characteristics: header.characteristics,
        data,
    })
}

pub fn read_pe_program<R: Read + Seek>(reader: &mut impl PeReader<R>) -> Result<PeProgram, GaiaError> {
    let header = reader.get_pe_header()?.clone();
    let section_headers = reader.get_section_headers()?.to_vec();

    // Read section data
    let mut sections = Vec::new();
    for section_header in section_headers {
        let section = read_section_from_header(reader, &section_header)?;
        sections.push(section);
    }

    // Parse import table
    let imports = reader.parse_import_table(&header, &sections)?;

    // Parse export table (EXE files usually don't have an export table)
    let exports = reader.parse_export_table(&header, &sections)?;
    Ok(PeProgram { header, sections, imports, exports })
}