summaryrefslogtreecommitdiff
path: root/cdl.h
blob: 62db4a44b506ff8d628d3fdb488e97911676c354 (plain)
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
/**
 * @file cdl.h
 * @brief cdl86 (Compact Detours Library) - cdl.h
 *
 * Experimental Linux/Windows x86/x86_64 detours library.
 * Author: Dylan Müller
 *
 * +---------------------------------------+
 * |   .-.         .-.         .-.         |
 * |  /   \       /   \       /   \        |
 * | /     \     /     \     /     \     / |
 * |        \   /       \   /       \   /  |
 * |         "_"         "_"         "_"   |
 * |                                       |
 * |  _   _   _ _  _   _   ___   ___ _  _  |
 * | | | | | | | \| | /_\ | _ \ / __| || | |
 * | | |_| |_| | .` |/ _ \|   /_\__ \ __ | |
 * | |____\___/|_|\_/_/ \_\_|_(_)___/_||_| |
 * |                                       |
 * |                                       |
 * | Lunar RF Labs                         |
 * | https://lunar.sh                      |
 * |                                       |
 * | Research Laboratories                 |
 * | Copyright (C) 2022-2024               |
 * |                                       |
 * +---------------------------------------+
 *
 * Copyright (c) 2022 Lunar RF Labs
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice,
 *       this list of conditions and the following disclaimer in the documentation
 *       and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CDL_H
#define CDL_H

#include <stdbool.h>
#include <stdint.h>

#define __in
#define __out
#define __in_out

/* extern "C" */
#ifdef __cplusplus
#define CDL86_EXTERN_C extern "C"
#else
#define CDL86_EXTERN_C
#endif

/**
 * Intruction probe struct
 *
 * @param size size of instruction (bytes)
 * @param bytes byte array of instruction (uint8_t*)
 */
struct cdl_ins_probe
{
    int size;
    uint8_t* bytes;
};

/**
 * JMP patch info struct
 *
 * @param active is patch active (bool)
 * @param nt_alloc number of bytes allocated to trampoline (int)
 * @param code instructions replaced by JMP patch (uint8_t*)
 * @param target pointer to function pointer (uint8_t**)
 * @param origin pointer to origin(real) target address (uint8_t*)
 * @param trampoline pointer to trampoline (uint8_t*)
 */
struct cdl_jmp_patch
{
    bool active;
    int nt_alloc;
    uint8_t* code;
    uint8_t** target;
    uint8_t* origin;
    uint8_t* trampoline;
};

/**
 * SWBP patch info struct.
 *
 * @param gid global id for SW BP (int)
 * @param active is patch active (bool)
 * @param ns_alloc number of bytes allocated to stub (int)
 * @param code instructions replaced by SWBP patch (uint8_t*)
 * @param target pointer to function pointer (uint8_t**)
 * @param stub pointer to stub (uint8_t*)
 * @param detour pointer to detour function (uint8_t*)
 * @param bp_add address of breakpoint (uint8_t*)
 */
struct cdl_swbp_patch
{
    int gid;
    bool active;
    int ns_alloc;
    uint8_t* code;
    uint8_t** target;
    uint8_t* stub;
    uint8_t* detour;
    uint8_t* bp_addr;
};

/**
 * Attach JMP patch to target funciton.
 *
 * @param target pointer to function pointer to function to hook.
 * @param detour function pointer to detour function
 */
CDL86_EXTERN_C struct cdl_jmp_patch cdl_jmp_attach(
    __in_out void** target,
    __in void* detour
);

/**
 * Attach INT3 patch to target funciton.
 *
 * @param target pointer to function pointer to function to hook.
 * @param detour function pointer to detour function
 */
CDL86_EXTERN_C struct cdl_swbp_patch cdl_swbp_attach(
    __in_out void** target,
    __in void* detour
);

/**
 * Detach JMP patch.
 *
 * @param jmp_patch pointer to cdl_jmp_patch struct.
 */
CDL86_EXTERN_C void cdl_jmp_detach(
    __in_out struct cdl_jmp_patch* jmp_patch
);

/**
 * Detach INT3 patch.
 *
 * @param swbp_patch pointer to cdl_swbp_patch struct.
 */
CDL86_EXTERN_C void cdl_swbp_detach(
   __in_out  struct cdl_swbp_patch* swbp_patch
);

/**
 * Print JMP patch debug info.
 *
 * @param jmp_patch pointer to cdl_jmp_patch struct.
 */
CDL86_EXTERN_C void cdl_jmp_dbg(
    __in struct cdl_jmp_patch* jmp_patch
);

/**
 * Print SW BP debug info.
 *
 * @param jmp_patch pointer to cdl_swbp_patch struct.
 */
CDL86_EXTERN_C void cdl_swbp_dbg(
    __in struct cdl_swbp_patch* swbp_patch
);

#endif