sighook 0.10.0

An Apple/Linux/Android runtime instrumentation and inline hooking crate for aarch64 and x86_64.
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

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "macos", target_arch = "x86_64"),
        all(target_os = "linux", target_arch = "aarch64")
    )
))]
use keystone_engine::{Arch, Keystone, KeystoneError, Mode};

#[cfg(all(
    feature = "patch_asm",
    target_arch = "x86_64",
    any(target_os = "linux", target_os = "macos")
))]
use keystone_engine::{Arch, Keystone, KeystoneError, Mode, OptionType, OptionValue};

use crate::error::SigHookError;

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "aarch64")
    )
))]
const PATCH_ASM_WIDTH: usize = 4;

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "aarch64")
    )
))]
pub(crate) fn assemble_patch_opcode(address: u64, asm: &str) -> Result<u32, SigHookError> {
    let bytes = assemble_bytes(address, asm)?;
    to_u32_opcode(bytes)
}

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "macos", target_arch = "x86_64"),
        all(target_os = "linux", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "x86_64")
    )
))]
pub(crate) fn assemble_bytes(address: u64, asm: &str) -> Result<Vec<u8>, SigHookError> {
    let trimmed = asm.trim();
    if trimmed.is_empty() {
        return Err(SigHookError::AsmEmptyInput);
    }

    #[cfg(all(target_arch = "x86_64", any(target_os = "linux", target_os = "macos")))]
    {
        let bytes = assemble_x86_64(trimmed, address)?;
        return Ok(bytes);
    }

    #[cfg(any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "aarch64")
    ))]
    {
        let bytes = assemble_aarch64(trimmed, address)?;
        return Ok(bytes);
    }

    #[allow(unreachable_code)]
    Err(SigHookError::UnsupportedPlatform)
}

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "aarch64")
    )
))]
fn assemble_aarch64(asm: &str, address: u64) -> Result<Vec<u8>, SigHookError> {
    let engine = keystone_engine_init(Arch::ARM64, Mode::LITTLE_ENDIAN)?;
    let output = engine
        .asm(asm.to_string(), address)
        .map_err(map_keystone_error)?;
    Ok(output.bytes)
}

#[cfg(all(
    feature = "patch_asm",
    target_arch = "x86_64",
    any(target_os = "linux", target_os = "macos")
))]
fn assemble_x86_64(asm: &str, address: u64) -> Result<Vec<u8>, SigHookError> {
    let engine = keystone_engine_init(Arch::X86, Mode::MODE_64)?;
    engine
        .option(OptionType::SYNTAX, OptionValue::SYNTAX_ATT)
        .map_err(map_keystone_error)?;

    let output = engine
        .asm(asm.to_string(), address)
        .map_err(map_keystone_error)?;
    Ok(output.bytes)
}

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "macos", target_arch = "x86_64"),
        all(target_os = "linux", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "x86_64")
    )
))]
fn keystone_engine_init(arch: Arch, mode: Mode) -> Result<Keystone, SigHookError> {
    Keystone::new(arch, mode).map_err(map_keystone_error)
}

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "macos", target_arch = "x86_64"),
        all(target_os = "linux", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "x86_64")
    )
))]
fn map_keystone_error(_err: KeystoneError) -> SigHookError {
    SigHookError::AsmAssembleFailed
}

#[cfg(all(
    feature = "patch_asm",
    any(
        all(target_os = "macos", target_arch = "aarch64"),
        all(target_os = "linux", target_arch = "aarch64")
    )
))]
fn to_u32_opcode(bytes: Vec<u8>) -> Result<u32, SigHookError> {
    if bytes.len() != PATCH_ASM_WIDTH {
        return Err(SigHookError::AsmSizeMismatch {
            expected: PATCH_ASM_WIDTH,
            actual: bytes.len(),
        });
    }

    let mut opcode = [0u8; PATCH_ASM_WIDTH];
    opcode.copy_from_slice(&bytes);
    Ok(u32::from_le_bytes(opcode))
}