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
extern crate libc;
extern crate num;
#[macro_use]
extern crate enum_primitive;
pub mod instruction;
pub mod constants;
mod ffi;
pub mod capstone;
pub use instruction::*;
pub use constants::*;
pub use capstone::Capstone;
#[allow(non_camel_case_types)]
type csh = libc::size_t;
#[cfg(test)]
mod test {
use std::collections::HashSet;
use super::*;
static CODE: &'static [u8] = b"\x55\x48\x8b\x05\xb8\x13\x00\x00";
#[test]
fn test_x86_simple() {
match capstone::Capstone::new(constants::CsArch::ARCH_X86, constants::CsMode::MODE_64) {
Ok(cs) => {
match cs.disasm(CODE, 0x1000, 0) {
Ok(insns) => {
assert_eq!(insns.len(), 2);
let is: Vec<_> = insns.iter().collect();
assert_eq!(is[0].mnemonic().unwrap(), "push");
assert_eq!(is[1].mnemonic().unwrap(), "mov");
assert_eq!(is[0].address, 0x1000);
assert_eq!(is[1].address, 0x1001);
assert_eq!(is[0].bytes(), b"\x55");
assert_eq!(is[1].bytes(), b"\x48\x8b\x05\xb8\x13\x00\x00");
}
Err(err) => assert!(false, "Couldn't disasm instructions: {}", err),
}
}
Err(e) => {
assert!(false, "Couldn't create a cs engine: {}", e);
}
}
}
#[test]
fn test_x86_names() {
match capstone::Capstone::new(constants::CsArch::ARCH_X86, constants::CsMode::MODE_64) {
Ok(cs) => {
let reg_id = 1;
match cs.reg_name(reg_id) {
Some(reg_name) => assert_eq!(reg_name, "ah"),
None => assert!(false, "Couldn't get register name"),
}
let insn_id = 1;
match cs.insn_name(insn_id) {
Some(insn_name) => assert_eq!(insn_name, "aaa"),
None => assert!(false, "Couldn't get instruction name"),
}
assert_eq!(cs.group_name(1), Some(String::from("jump")));
let reg_id = 6000;
match cs.reg_name(reg_id) {
Some(_) => assert!(false, "invalid register worked"),
None => {}
}
let insn_id = 6000;
match cs.insn_name(insn_id) {
Some(_) => assert!(false, "invalid instruction worked"),
None => {}
}
assert_eq!(cs.group_name(6000), None);
}
Err(e) => {
assert!(false, "Couldn't create a cs engine: {}", e);
}
}
}
#[test]
fn test_detail_false_fail() {
let mut cs = capstone::Capstone::new(constants::CsArch::ARCH_X86,
constants::CsMode::MODE_64)
.unwrap();
cs.set_detail(false).unwrap();
let insns: Vec<_> = cs.disasm(CODE, 0x1000, 0).unwrap().iter().collect();
assert_eq!(cs.insn_belongs_to_group(&insns[0], 0),
Err(CsErr::CS_ERR_DETAIL));
assert_eq!(cs.insn_belongs_to_group(&insns[1], 0),
Err(CsErr::CS_ERR_DETAIL));
}
#[test]
fn test_detail_true() {
let mut cs = capstone::Capstone::new(constants::CsArch::ARCH_X86,
constants::CsMode::MODE_64)
.unwrap();
cs.set_detail(true).unwrap();
let insns: Vec<_> = cs.disasm(CODE, 0x1000, 0).unwrap().iter().collect();
let insn_group_ids = [CsGroupType::CS_GRP_JUMP,
CsGroupType::CS_GRP_CALL,
CsGroupType::CS_GRP_RET,
CsGroupType::CS_GRP_INT,
CsGroupType::CS_GRP_IRET];
for insn_idx in 0..1 + 1 {
for insn_group_id in &insn_group_ids {
assert_eq!(cs.insn_belongs_to_group(&insns[insn_idx], *insn_group_id as u64),
Ok(false));
}
}
}
fn test_x86_instruction_detail_helper(mnemonic_name: &str,
bytes: &[u8],
expected_groups: &[CsGroupType]) {
let mut cs = capstone::Capstone::new(constants::CsArch::ARCH_X86,
constants::CsMode::MODE_64)
.expect("Failed to create capstone handle");
cs.set_detail(true).unwrap();
let insns: Vec<_> = cs.disasm(bytes, 0x1000, 0)
.expect("Failed to disassemble")
.iter()
.collect();
assert_eq!(insns.len(), 1, "Expected exactly 1 instruction");
let insn = &insns[0];
assert_eq!(mnemonic_name,
cs.insn_name(insn.id() as u64)
.expect("Failed to get instruction name"));
let instruction_group_ids: HashSet<u8> = cs.insn_group_ids(&insn)
.expect("failed to get instruction groups")
.iter()
.map(|&x| x)
.collect();
let expected_groups_ids: HashSet<u8> = expected_groups.iter().map(|&x| x as u8).collect();
assert!(expected_groups_ids.is_subset(&instruction_group_ids),
"Expected groups {:?} does NOT match computed insn groups {:?} with ",
expected_groups_ids,
instruction_group_ids);
let instruction_groups_set: HashSet<CsGroupType> = cs.insn_groups(&insn)
.expect("failed to get instruction groups")
.iter()
.map(|&x| x)
.collect();
let expected_groups_set: HashSet<CsGroupType> =
expected_groups.iter().map(|&x| x).collect();
assert!(expected_groups_set.is_subset(&instruction_groups_set),
"Expected groups {:?} does NOT match computed insn groups {:?}",
expected_groups_set,
instruction_groups_set);
let instruction_types: HashSet<CsGroupType> = [CsGroupType::CS_GRP_JUMP,
CsGroupType::CS_GRP_CALL,
CsGroupType::CS_GRP_RET,
CsGroupType::CS_GRP_INT,
CsGroupType::CS_GRP_IRET]
.iter()
.cloned()
.collect();
let expected_groups_set: HashSet<CsGroupType> =
expected_groups.iter().map(|&x| x).collect();
let not_belong_groups = instruction_types.difference(&expected_groups_set);
for &belong_group in expected_groups {
assert_eq!(Ok(true),
cs.insn_belongs_to_group(&insn, belong_group as u64),
"{:?} does NOT BELONG to group {:?}, but the instruction SHOULD",
insn,
belong_group);
}
for ¬_belong_group in not_belong_groups {
assert_eq!(Ok(false),
cs.insn_belongs_to_group(&insn, not_belong_group as u64),
"{:?} BELONGS to group {:?}, but the instruction SHOULD NOT",
insn,
not_belong_group);
}
}
#[test]
fn test_instruction_group_ids() {
let jump = CsGroupType::CS_GRP_JUMP;
let call = CsGroupType::CS_GRP_CALL;
let ret = CsGroupType::CS_GRP_RET;
let int = CsGroupType::CS_GRP_INT;
let iret = CsGroupType::CS_GRP_IRET;
test_x86_instruction_detail_helper("nop", b"\x90", &[]);
test_x86_instruction_detail_helper("je", b"\x74\x05", &[jump]);
test_x86_instruction_detail_helper("call", b"\xe8\x28\x07\x00\x00", &[call]);
test_x86_instruction_detail_helper("ret", b"\xc3", &[ret]);
test_x86_instruction_detail_helper("syscall", b"\x0f\x05", &[int]);
test_x86_instruction_detail_helper("iretd", b"\xcf", &[iret]);
test_x86_instruction_detail_helper("sub", b"\x48\x83\xec\x08", &[]);
test_x86_instruction_detail_helper("test", b"\x48\x85\xc0", &[]);
test_x86_instruction_detail_helper("mov", b"\x48\x8b\x05\x95\x4a\x4d\x00", &[]);
test_x86_instruction_detail_helper("mov", b"\xb9\x04\x02\x00\x00", &[]);
}
#[test]
fn test_invalid_mode() {
match capstone::Capstone::new(constants::CsArch::ARCH_ALL, constants::CsMode::MODE_64) {
Ok(_) => assert!(false, "Invalid open worked"),
Err(err) => assert!(err == constants::CsErr::CS_ERR_ARCH),
}
}
#[test]
fn test_capstone_version() {
let (major, minor) = Capstone::lib_version();
println!("Capstone lib version: ({}, {})", major, minor);
assert!(major > 0 && major < 100, "Invalid major version {}", major);
assert!(minor < 500, "Invalid minor version {}", minor);
}
#[test]
fn test_capstone_supports_arch() {
let architectures = vec![CsArch::ARCH_ARM,
CsArch::ARCH_ARM64,
CsArch::ARCH_MIPS,
CsArch::ARCH_X86,
CsArch::ARCH_PPC,
CsArch::ARCH_SPARC,
CsArch::ARCH_SYSZ,
CsArch::ARCH_XCORE,
CsArch::CS_ARCH_M68K];
println!("Supported architectures");
for arch in architectures {
let supports_arch = Capstone::supports_arch(arch);
println!(" {:?}: {}", arch, if supports_arch { "yes" } else { "no" });
}
}
#[test]
fn test_capstone_is_diet() {
println!("Capstone is diet: {}", Capstone::is_diet());
}
}