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
//! Bindings to the [capstone library][upstream] disassembly framework.
//!
//! ```rust
//! extern crate capstone;
//! const CODE: &'static [u8] = b"\x55\x48\x8b\x05\xb8\x13\x00\x00";
//! fn main() {
//!     match capstone::Capstone::new(capstone::Arch::X86) {
//!         Ok(cs) => {
//!             match cs.disassemble(CODE, 0x1000) {
//!                 Ok(insns) => {
//!                     println!("Got {} instructions", insns.len());
//!
//!                     for i in insns.iter() {
//!                         println!("{}", i);
//!                     }
//!                 },
//!                 Err(err) => {
//!                     println!("Error: {}", err)
//!                 }
//!             }
//!         },
//!         Err(err) => {
//!             println!("Error: {}", err)
//!         }
//!     }
//! }
//! ```
//!
//! Produces:
//!
//! ```no_test
//! Got 2 instructions
//! 0x1000: push rbp
//! 0x1001: mov rax, qword ptr [rip + 0x13b8]
//! ```
//!
//! **NOTE** if you want to compile for a different target, you should use the `build_capstone` feature.
//!
//! [upstream]: http://capstone-engine.org/
//!

extern crate libc;
extern crate capstone_sys;

mod capstone;
pub mod instruction;
pub mod error;

pub use capstone::*;

#[cfg(test)]
mod test {
    use super::{capstone, error};
    const X86_CODE: &'static [u8] = b"\x55\x48\x8b\x05\xb8\x13\x00\x00";
    const ARM_CODE: &'static [u8] = b"\x55\x48\x8b\x05\xb8\x13\x00\x00";

     #[test]
     fn test_x86_simple() {
         match capstone::Capstone::new(capstone::Arch::X86) {
             Ok(cs) => {
                 match cs.disassemble(X86_CODE, 0x1000) {
                     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);
                     },
                     Err(err) => {
                         assert!(false, "Couldn't disasm instructions: {}", err)
                     }
                 }
             },
             Err(e) => {
                 assert!(false, "Couldn't create a cs engine: {}", e);
             }
         }
     }

    #[test]
    fn test_arm_simple() {
        match capstone::Capstone::new(capstone::Arch::ARM) {
            Ok(cs) => {
                match cs.disassemble(ARM_CODE, 0x1000) {
                    Ok(insns) => {
                        assert_eq!(insns.len(), 2);
                        let is: Vec<_> = insns.iter().collect();
                        assert_eq!(is[0].mnemonic().unwrap(), "streq");
                        assert_eq!(is[1].mnemonic().unwrap(), "strheq");

                        assert_eq!(is[0].address(), 0x1000);
                        assert_eq!(is[1].address(), 0x1004);
                    },
                    Err(err) => {
                        assert!(false, "Couldn't disasm instructions: {}", err)
                    }
                }
            },
            Err(e) => {
                assert!(false, "Couldn't create a cs engine: {}", e);
            }
        }
    }

    #[test]
    fn test_arm64_none() {
        match capstone::Capstone::new(capstone::Arch::ARM64) {
            Ok(cs) => {
                match cs.disassemble(ARM_CODE, 0x1000) {
                    Ok(insns) => {
                        assert_eq!(insns.len(), 0);
                        let is: Vec<_> = insns.iter().collect();
                        assert!(is.is_empty(), "Instruction vector isn't empty")
                    },
                    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(capstone::Arch::X86) {
             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"),
                 }

                 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 => {},
                 }
             },
             Err(e) => {
                 assert!(false, "Couldn't create a cs engine: {}", e);
             }
         }
     }

    #[test]
    fn test_invalid_mode() {
        match capstone::Capstone::new(capstone::Arch::ALL) {
            Ok(_) => assert!(false, "Invalid open worked"),
            Err(err) => {
                match err {
                    error::Error::Capstone(err) => assert!(err == error::CapstoneError::UnsupportedArch),
                    _ => assert!(false),
                }
            }
        }
    }
}