proc_mem 0.1.6

manage processes, modules and read/write their memory on windows
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
mod handle;
mod tlhelp32;
mod module;

use std::{process::Command, os::windows::process::CommandExt, mem::size_of};

use crate::ProcMemError;
use handle::Handle;
use tlhelp32::*;
pub use module::{Module, Signature};

use winapi::{um::{tlhelp32::{TH32CS_SNAPPROCESS, TH32CS_SNAPMODULE, TH32CS_SNAPMODULE32}, 
                  winbase::CREATE_NO_WINDOW, 
                  memoryapi::{ReadProcessMemory, WriteProcessMemory, VirtualProtect},
                  wow64apiset::IsWow64Process,
                 }, 
             shared::{minwindef::{FALSE, LPCVOID, LPVOID, BOOL, PBOOL}, basetsd::SIZE_T}
            };

#[derive(Debug, Clone)]

/// contains name, pid and handle of a process 
pub struct Process {
    pub process_name: String,
    /// unique identifier if the process
    pub process_id: u32,
    /// used when desired data is not inside a loaded module
    pub process_base_address: usize,
    /// either PROCESS_ALL_ACCESS or PROCESS_VM_READ | PROCESS_VM_WRITE
    pub process_handle: Handle,
    /// is x32 or x64
    pub iswow64: bool
}

impl Process {


    /// returns the desired process with the provided pid
    /// 
    /// ```rust
    /// use proc_mem::{Process, ProcMemError};
    /// let process: Result<Process,ProcMemError> = Process::with_pid(12345);
    /// ```
    pub fn with_pid(pid: u32) -> Result<Self,ProcMemError> {
        let h_snap = create_snapshot(TH32CS_SNAPPROCESS, 0)?;

        let mut pe32 = new_pe32w();

        if !process32first(&h_snap, &mut pe32) { return Err(ProcMemError::IterateSnapshotFailure);}

        loop {
            if pid.eq(&pe32.th32ProcessID) {
                let process_name = String::from_utf16_lossy(&pe32.szExeFile).trim_end_matches('\u{0}').to_string();

                let mut proc = Process {
                    process_name: String::from(&process_name), 
                    process_id: pid,
                    process_base_address: 0,
                    process_handle: Handle::read_write(pid)?,
                    iswow64: false,
                };
                
                proc.process_base_address = proc.module(&process_name)?.base_address();
                proc.iswow64 = proc.iswow64();

                return Ok(proc)
            }

            if !process32next(&h_snap, &mut pe32) {break;}
        }
        Err(ProcMemError::ProcessNotFound)
    }


    /// returns the desired process with the provided name
    /// 
    /// ```rust
    /// use proc_mem::{Process, ProcMemError};
    /// let process: Result<Process,ProcMemError> = Process::with_name("process.exe");
    /// ```
    pub fn with_name(name: &str) -> Result<Self,ProcMemError> {
        let h_snap = create_snapshot(TH32CS_SNAPPROCESS, 0)?;

        let mut pe32 = new_pe32w();

        if !process32first(&h_snap, &mut pe32) { return Err(ProcMemError::IterateSnapshotFailure);}

        loop {
            let process_name = String::from_utf16_lossy(&pe32.szExeFile).trim_end_matches('\u{0}').to_string();
            if process_name.eq(&name) {

                let mut proc = Process {
                    process_name: String::from(&process_name), 
                    process_id: pe32.th32ProcessID,
                    process_base_address: 0,
                    process_handle: Handle::read_write(pe32.th32ProcessID)?,
                    iswow64: false, 
                };
                
                proc.process_base_address = proc.module(&process_name)?.base_address();
                proc.iswow64 = proc.iswow64();

                return Ok(proc)
            }

            if !process32next(&h_snap, &mut pe32) {break;}
        }
        Err(ProcMemError::ProcessNotFound)
    }


    /// returns a Vec<Process> where all processes share the provided name
    /// 
    /// ```rust
    /// use proc_mem::{Process, ProcMemError};
    /// let processes: Result<Vec<Process>,ProcMemError> = Process::all_with_name("process.exe");
    /// ```
    pub fn all_with_name(name: &str) -> Result<Vec<Process>,ProcMemError> {
        let mut results: Vec<Process> = Vec::new();

        let h_snap = create_snapshot(TH32CS_SNAPPROCESS, 0)?;

        let mut pe32 = new_pe32w();

        if !process32first(&h_snap, &mut pe32) { return Err(ProcMemError::IterateSnapshotFailure);}

        loop {
            let process_name = String::from_utf16_lossy(&pe32.szExeFile).trim_end_matches('\u{0}').to_string();
            if process_name.eq(&name) {

                let mut proc = Process {
                    process_name: String::from(&process_name), 
                    process_id: pe32.th32ProcessID,
                    process_base_address: 0,
                    process_handle: Handle::read_write(pe32.th32ProcessID)?,
                    iswow64: false 
                };

                proc.process_base_address = proc.module(&process_name)?.base_address();
                proc.iswow64 = proc.iswow64();

                results.push(proc);
            }

            if !process32next(&h_snap, &mut pe32) {break;}
        }

        match results.is_empty() {
            true => return Err(ProcMemError::ProcessNotFound),
            false => return Ok(results)
        }
    }


    /// returns an instance of module including its base address in memory
    /// 
    /// ```rust
    /// use proc_mem::{Process, Module, ProcMemError};
    /// let process = Process::with_name("process.exe")?;
    /// let module: Result<Module,ProcMemError> = process.module("module.dll");
    /// ```
    pub fn module(&self, name: &str) -> Result<Module, ProcMemError> {
        let h_snap = create_snapshot(TH32CS_SNAPMODULE | TH32CS_SNAPMODULE32, *self.pid())?;

        let mut me32 = new_me32w();

        if !module32first(&h_snap, &mut me32) { return Err(ProcMemError::IterateSnapshotFailure);}
        
        loop {
            let module_name = String::from_utf16_lossy(&me32.szModule).trim_end_matches('\u{0}').to_string();

            if module_name.eq(name) {
                let module_path = String::from_utf16_lossy(&me32.szExePath).trim_end_matches('\u{0}').to_string();
                return Ok(Module::new(
                    module_name,
                    module_path,
                    *self.pid(),
                    me32.modBaseAddr as usize,
                    me32.modBaseSize as usize,
                    &self
                ))
            }

            if !module32next(&h_snap, &mut me32){break;}
        }
        Err(ProcMemError::ModuleNotFound)
    }


    /// returns true if the process was terminated, otherwise will return false
    /// 
    /// ```rust
    /// use proc_mem::{Process};
    /// let process = Process::with_name("process.exe")?;
    /// let did_terminate: bool = process.kill();
    /// ```
    pub fn kill(&self) -> bool {
        let output = Command::new("taskkill.exe")
        .arg("/PID")
        .arg(&self.process_id.to_string())
        .arg("/F")
        .creation_flags(CREATE_NO_WINDOW)
        .output()
        .expect("");

        if output.status.success() {
            println!("Process with PID {} was terminated", &self.process_id);
            true
        } else {
            println!(
                "Error killing process with PID {}: {}",
                &self.process_id,
                String::from_utf8_lossy(&output.stderr)
            );
            false
        }
    }


    /// This function takes a type and the address to read.
    /// On success the read value will be returned.
    /// ```rust
    /// use proc_mem::{Process, Module, ProcMemError};
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// let read_value: Result<T, ProcMemError> = chrome.read_mem::<T>(module.base_address() + 0x1337);
    /// ```
    pub fn read_mem<T: Default>(&self, address: usize) -> Result<T,ProcMemError> {
        let mut out:T = Default::default();

        unsafe {
            return if ReadProcessMemory(
                *self.process_handle, 
                address as *const _, 
                &mut out as *mut T as *mut _, 
                std::mem::size_of::<T>(), 
                std::ptr::null_mut::<SIZE_T>()
            ) == FALSE {
                println!("ReadProcessMemory failed. Error: {:?}", std::io::Error::last_os_error());
                return Err(ProcMemError::ReadMemoryError);
            } else {Ok(out)};
        } 
    }


    /// This function takes a type and a Vec of addresses/offsets,
    /// the first entry being the base address to start from.
    /// On success the read value will be returned.
    /// ```rust
    /// use proc_mem::{Process, Module, ProcMemError};
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// let chain: Vec<usize> = vec![module.base_address(), 0xDEA964, 0x100]
    /// let read_value: Result<T, ProcMemError> = chrome.read_mem_chain::<T>(chain);
    /// ```
    pub fn read_mem_chain<T: Default>(&self, mut chain: Vec<usize>) -> Result<T,ProcMemError> {
        let mut address = chain.remove(0);

        while chain.len() != 1 {
            address += chain.remove(0);
            address = if self.iswow64 {
                self.read_mem::<u32>(address)? as usize
            } else {
                self.read_mem::<u64>(address)? as usize
            }
        }

        let ret = self.read_mem::<T>(address + chain.remove(0))?;

        return Ok(ret);
    }


    /// This function takes a type and a Vec of addresses/offsets,
    /// the first entry being the base address to start from.
    /// On success the address at the end of the chain will be returned.
    /// ```rust
    /// use proc_mem::{Process, Module, ProcMemError};
    /// let some_game = Process::with_name("some_game.exe")?;
    /// let module = some_game.module("client.dll")?;
    /// let chain: Vec<usize> = vec![module.base_address(), 0xDEA964, 0x100]
    /// let desired_address: Result<usize, ProcMemError> = chrome.read_ptr_chain(chain);
    /// ```
    pub fn read_ptr_chain(&self, mut chain: Vec<usize>) -> Result<usize,ProcMemError> {
        let mut address = chain.remove(0);
        

        while chain.len() != 1 {
            address += chain.remove(0);
            address = if self.iswow64 {
                self.read_mem::<u32>(address)? as usize
            } else {
                self.read_mem::<u64>(address)? as usize
            }
        }

        return Ok(address + chain.remove(0));
    }


    /// This function takes a type and the address to write to.
    /// The returned boolean will be true on success and false on failure
    /// ```rust
    /// use proc_mem::{Process, Module};
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// let mut value_to_write: i32 = 1337;
    /// let write_result: bool = chrome.write_mem(module.base_address() + 0x1337, value_to_write);
    /// ```
    pub fn write_mem<T: Default>(&self, address: usize, mut value: T) -> bool {
        unsafe {
            WriteProcessMemory(
                *self.process_handle, 
                address as *mut  _, 
                &mut value as *mut T as *mut _, 
                std::mem::size_of::<T>(), 
                std::ptr::null_mut::<SIZE_T>()
            ) != FALSE
        }
    }

    /// With this function someone can write multiple bytes to a specified address.
    /// The returned boolean will be true on success and false on failure
    /// ```rust
    /// use proc_mem::{Process, Module};
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// let mut bytes_to_write: Vec<u8> = [ 0x48, 0xC7, 0xC0, 0x0A, 0x00, 0x00, 0x00 ].to_vec();
    /// let write_result: bool = chrome.write_bytes(module.base_address() + 0x1337, bytes_to_write.as_mut_ptr(), bytes_to_write.len());
    /// ```
    pub fn write_bytes(&self, address: usize, buf: *mut u8, size: usize) -> bool {
        unsafe {
            WriteProcessMemory(
                *self.process_handle,
                address as *mut _,
                buf as *mut _,
                size as SIZE_T,
                std::ptr::null_mut::<SIZE_T>()
            ) != FALSE
        }
    }

    /// C style method to read memory
    /// Third argument is the multiplicator of the Size of "T"
    /// for example if someone would want to read multiple bytes
    /// ```rust
    /// use proc_mem::{Process, Module}
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// let mut value_buffer: i32 = 0;
    /// if !chrome.read_ptr(&mut value_buffer, module.base_address() + 0x1337, None) {
    ///     println!("ReadMemory Failure");
    /// } else {
    ///     println!("ReadMemory Success");
    /// }
    /// ```
    pub fn read_ptr<T: Copy>(&self, buf: *mut T, address: usize) -> bool {
        unsafe {
            ReadProcessMemory(
                *self.process_handle,
                address as LPCVOID,
                buf as *mut T as LPVOID,
                std::mem::size_of::<T>() as SIZE_T,
                std::ptr::null_mut::<SIZE_T>(),
            ) != FALSE
        }
    }

    /// C style method to read multiple bytes from memory
    /// ```rust
    /// use proc_mem::{Process, Module}
    /// let chrome = Process::with_name("chrome.exe")?;
    /// let module = chrome.module("kernel32.dll")?;
    /// 
    /// let rsize = 10;
    /// let mut bytes_buffer: Vec<u8> = vec![0u8;rsize];
    /// if !chrome.read_bytes(module.base_address() + 0x1337, bytes_buffer.as_mut_ptr(), rsize) {
    ///     println!("ReadMemory Failure");
    /// } else {
    ///     println!("ReadMemory Success");
    /// }
    /// ```
    pub fn read_bytes(&self, address: usize, buf: *mut u8, size: usize) -> bool {
        unsafe {
            ReadProcessMemory(
                *self.process_handle,
                address as LPCVOID,
                buf as LPVOID,
                size as SIZE_T,
                std::ptr::null_mut::<SIZE_T>(),
            ) != FALSE
        }
    }

    /// Returns a string slice of the process name
    pub fn name(&self) -> &str {
        &self.process_name
    }
    /// Returns the unique identifier aka. process id of the process
    pub fn pid(&self) -> &u32 {
        &self.process_id
    }
    // Determines whether the specified process is running under WOW64 or an Intel64 of x64 processor.
    pub fn iswow64(&self) -> bool {
        let mut tmp: BOOL = 0;
        unsafe {IsWow64Process(*self.process_handle, &mut tmp as PBOOL)};
        match tmp {
            FALSE => false,
            _ => true
        }
    }

    /// Returns "TRUE" specified Memory Protection was changed successfully
    pub fn protect_mem(&self, address: usize, size: usize, new_protect: u32, old_protect: *mut u32) -> bool
    {
       let mut _result: BOOL = FALSE;
        unsafe {
            _result = VirtualProtect(address as LPVOID, size, new_protect, old_protect);
        }
        match _result {
            FALSE => false,
            _ => true
        }
    }

    fn read_module(&self, address: usize, msize: usize) -> Result<Vec<u8>, ProcMemError> {
        let mut out = vec![0u8;msize];
        let out_ptr = out.as_mut_ptr();
        unsafe{
            if ReadProcessMemory(
                *self.process_handle, 
                address as LPCVOID, 
                out_ptr as LPVOID, 
                size_of::<u8>() as SIZE_T * msize, 
                std::ptr::null_mut::<SIZE_T>()
            ) == FALSE {
                Err(ProcMemError::ReadMemoryError)
            } else {
                Ok(out)
            }
        }    
    }
}

unsafe impl Send for Process {}
unsafe impl Sync for Process {}