bhook 0.1.1

Lightweight hook crate with no_std support that works on x86, x86_64, arm and aarch64
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

use crate::raw::BACKUP_LEN;
use region::{Protection, protect_with_handle};

/// Handle memory protection and save backup bytes before doing branch hooking.
/// You can use 'unsetup_hook' to call the original function using this
///
/// # Safety
///
/// Same requirements as 'raw_hook' but the target address must be able to be safely
/// written to by disabling write protection
pub unsafe fn setup_hook(
    orig_fn: *mut u8,
    hook_fn: *const u8,
) -> Result<[u8; BACKUP_LEN], region::Error> {
    unsafe {
        #[cfg(not(target_arch = "arm"))]
        let offset_fn = orig_fn;
        #[cfg(target_arch = "arm")]
        let offset_fn = orig_fn.offset(-1);
        let _handle = protect_with_handle(offset_fn, BACKUP_LEN, Protection::READ_WRITE_EXECUTE)?;
        let result = offset_fn.cast::<[u8; BACKUP_LEN]>().read_unaligned();
        crate::raw_hook(orig_fn, hook_fn as usize);
        Ok(result)
    }
}

/// Handle memory protection and then write back the backup bytes.
///
/// # Safety
///
/// Dont copy the backup bytes to somewhere they dont belong, ever
pub unsafe fn unsetup_hook(
    orig_fn: *mut u8,
    orig_code: [u8; BACKUP_LEN],
) -> Result<(), region::Error> {
    unsafe {
        #[cfg(target_arch = "arm")]
        let orig_fn = orig_fn.offset(-1);
        let _handle = protect_with_handle(orig_fn, BACKUP_LEN, Protection::READ_WRITE_EXECUTE)?;
        orig_fn
            .cast::<[u8; BACKUP_LEN]>()
            .write_unaligned(orig_code);
        crate::clean_cache(orig_fn.cast_const(), BACKUP_LEN);
    }
    Ok(())
}

#[macro_export]
macro_rules! hook_fn {
    (fn $name:ident($($arg_name:ident : $arg_ty:ty),*) -> $ret_type:ty = $body:expr )  => {
        mod $name {
            static mut CONTEXT: Option<HookCtx> = None;
            struct HookCtx {
                original: *mut u8,
                hook: *const u8,
                backup: [u8; bhook::BACKUP_LEN]
            }
                pub unsafe fn hook_address(original_addr: *mut u8) {
                    unsafe {
                        let backup = bhook::setup_hook(original_addr, mainhook as *const u8);
                        CONTEXT = Some(HookCtx {
                            original: original_addr,
                            hook: mainhook as *const u8,
                            backup: backup.unwrap(),
                        })
                    }
                }

            #[allow(dead_code)]
            unsafe fn call_original($($arg_name : $arg_ty), *) -> $ret_type {
                unsafe {
                    let sus = CONTEXT.as_ref().unwrap();
                    bhook::unsetup_hook(sus.original, sus.backup).unwrap();
                    let original = core::mem::transmute::<*mut u8, fn($($arg_ty),*) -> $ret_type>(sus.original);
                    let result = original($($arg_name),*);
                    bhook::setup_hook(sus.original, sus.hook).unwrap();
                    result
                }
            }
            unsafe fn self_disable() {
                unsafe {
                let sus = CONTEXT.as_ref().unwrap();
                bhook::unsetup_hook(sus.original, sus.backup).unwrap();
                }
            }
            unsafe extern "C" fn mainhook( $($arg_name: $arg_ty),*) -> $ret_type {unsafe {$body }}
        }
    };
}