pelite 0.10.0

Lightweight, memory-safe, zero-allocation library for reading and navigating PE binaries.
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

/*!

PE headers.
 */

use std::slice;
use std::ops::Range;

use super::Pe;
use super::image::*;

pub use crate::wrap::sections::*;

/// Describes the PE headers.
#[derive(Copy, Clone)]
pub struct Headers<P> {
	pe: P,
}

impl<'a, P: Pe<'a>> Headers<P> {
	pub(crate) fn new(pe: P) -> Headers<P> {
		Headers { pe }
	}
	/// Gets the PE instance.
	pub fn pe(&self) -> P {
		self.pe
	}
	/// Gets the PE headers as a byte slice.
	pub fn image(&self) -> &'a [u8] {
		unsafe { self.pe.image().get_unchecked(..self.pe.optional_header().SizeOfHeaders as usize) }
	}
	/// Calculates the optional header's CheckSum.
	pub fn check_sum(&self) -> u32 {
		let image = self.pe.image();
		let check_sum_position = (
			self.pe.dos_header().e_lfanew as usize +
			dataview::offset_of!(IMAGE_NT_HEADERS.OptionalHeader) +
			dataview::offset_of!(IMAGE_OPTIONAL_HEADER.CheckSum)) / 4;
		let dwords = unsafe { slice::from_raw_parts(image.as_ptr() as *const u32, image.len() / 4) };
		let mut check_sum = 0u64;
		for i in 0..dwords.len() {
			if i == check_sum_position {
				continue;
			}
			let dw = dwords[i];
			check_sum = (check_sum & 0xffffffff) + dw as u64 + (check_sum >> 32);
			if check_sum > 0xffffffff {
				check_sum = (check_sum & 0xffffffff) + (check_sum >> 32);
			}
		}
		check_sum = (check_sum & 0xffff) + (check_sum >> 16);
		check_sum = check_sum + (check_sum >> 16);
		check_sum = check_sum & 0xffff;

		check_sum += image.len() as u64;

		check_sum as u32
	}
	/// Gets the code range from the optional header.
	pub fn code_range(&self) -> Range<Rva> {
		let optional_header = self.pe.optional_header();
		optional_header.BaseOfCode..u32::wrapping_add(optional_header.BaseOfCode, optional_header.SizeOfCode)
	}
	/// Gets the full image range excluding the PE headers.
	pub fn image_range(&self) -> Range<Rva> {
		let optional_header = self.pe.optional_header();
		optional_header.SizeOfHeaders..optional_header.SizeOfImage
	}
}

/*
	"headers": {
		"DosHeader": { .. }
		"NtHeaders": {
			"Signature": ..,
			"FileHeader": { .. }
			"OptionalHeader": { .. }
		}
		"DataDirectory": [ .. ]
		"SectionHeaders": [ .. ]
		"details": {
			"DosHeader.e_magic": "MZ",
			"NtHeaders.Signature": "PE",
			"FileHeader.Machine": "AMD",
			"FileHeader.Characteristics": [],
			"OptionalHeader.Magic": "PE32+",
			"DataDirectory.Names": ["Exports", "Imports", ..],
			"DataDirectory.Sections": [1, 1, ..],
			"SectionHeaders.Characteristics": [["executable", "read", "write"], ["read"], ["read", "write"]],
		}
	}
*/

#[cfg(feature = "serde")]
mod serde {
	use crate::util::serde_helper::*;
	use crate::stringify;
	use super::{Pe, Headers};

	impl<'a, P: Pe<'a>> Serialize for Headers<P> {
		fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
			let mut state = serializer.serialize_struct("Headers", 5)?;
			state.serialize_field("DosHeader", self.pe.dos_header())?;
			state.serialize_field("NtHeaders", self.pe.nt_headers())?;
			state.serialize_field("DataDirectory", self.pe.data_directory())?;
			state.serialize_field("SectionHeaders", self.pe.section_headers())?;
			state.serialize_field("details", &Details { pe: self.pe })?;
			state.end()
		}
	}

	struct Details<P> { pe: P }
	impl<'a, P: Pe<'a>> Serialize for Details<P> {
		fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
			let mut state = serializer.serialize_struct("Details", 11)?;

			state.serialize_field("DosHeader.e_magic", "MZ")?;
			state.serialize_field("NtHeaders.Signature", "PE")?;

			let file_header = self.pe.file_header();
			state.serialize_field("FileHeader.Machine", &stringify::Machine(file_header.Machine).to_str())?;
			state.serialize_field("FileHeader.Characteristics", &SerdeIter(stringify::FileChars(file_header.Characteristics).to_strs()))?;

			let optional_header = self.pe.optional_header();
			state.serialize_field("OptionalHeader.Magic", &stringify::OptionalMagic(optional_header.Magic).to_str())?;
			state.serialize_field("OptionalHeader.CheckSum", &Headers { pe: self.pe }.check_sum())?;
			state.serialize_field("OptionalHeader.Subsystem", &stringify::Subsystem(optional_header.Subsystem).to_str())?;
			state.serialize_field("OptionalHeader.DllCharacteristics", &SerdeIter(stringify::DllChars(optional_header.DllCharacteristics).to_strs()))?;

			let data_directory_names = (0..self.pe.data_directory().len()).map(stringify::DirectoryEntry).map(stringify::DirectoryEntry::to_str);
			state.serialize_field("DataDirectory.Names", &SerdeIter(data_directory_names))?;

			let data_directory_sects = self.pe.data_directory().iter().map(|dd| {
				self.pe.section_headers().iter().position(|&sect| dd.VirtualAddress >= sect.VirtualAddress && dd.VirtualAddress < sect.VirtualAddress + sect.VirtualSize)
			});
			state.serialize_field("DataDirectory.Sections", &SerdeIter(data_directory_sects))?;

			let sections_chars = self.pe.section_headers().iter().map(|sect| {
				let section_chars = sect.Characteristics;
				SerdeIter(stringify::SectionChars(section_chars).to_strs())
			});
			state.serialize_field("SectionHeaders.Characteristics", &SerdeIter(sections_chars))?;

			state.end()
		}
	}
}