Crate keystone_engine

Unofficial Rust bindings for the Keystone Engine

These Rust bindings are an alternative to the ones available in the official repository and support version 0.9.2 of the Keystone Engine.

Why Release New Bindings If Official Ones Exist?

To publish a crate on crates.io, all its dependencies must also come from crates.io. There is already a crate providing bindings for Keystone. However, the latest version it supports, is version 0.9.0 of Keystone. This version has bugs, which, fortunately, are fixed in version 0.9.2. For this reason, and because the current crate of Keystone has not been updated for years, these bindings can be used instead.

These bindings are heavily inspired from the official ones and do not alter the API too much compared to the original.

Example

This example, taken from the official repo, should work out of the box.

Add the following dependency to Cargo.toml:

keystone_engine = { version = "0.1.0", features = ["build-from-src"] }

Note: You can use either the build-from-src feature to build the Keystone Engine or use-system-lib if you have already installed Keystone on your system.

You should now be able to run the following code:

use keystone_engine::*;

let engine =
    Keystone::new(Arch::X86, Mode::MODE_32).expect("Could not initialize Keystone engine");

engine
    .option(OptionType::SYNTAX, OptionValue::SYNTAX_NASM)
    .expect("Could not set option to nasm syntax");

let result = engine
    .asm("mov ah, 0x80".to_string(), 0)
    .expect("Could not assemble");

println!("ASM result: {}", result);

if let Err(err) = engine.asm("INVALID".to_string(), 0) {
    println!("Error: {}", err);
}

Credits

• Keystone Assembler Engine by Nguyen Anh Quynh
• Rust bindings by Remco Verhoef

Re-exports

pub use ffi::Arch;

pub use ffi::Error;

pub use ffi::Mode;

pub use ffi::OptionType;

pub use ffi::OptionValue;

Modules

ffi

Unsafe Rust bindings for the Keystone Engine assembler library.

Structs

Keystone

Reprensents a Keystone instance.

KeystoneOutput

Output object created after assembling instructions.

Enums

KeystoneError

Keystone errors.

MiscError

Miscellaneous errors.

Type Aliases

Result

Convenient Result type wrapping Keystone errors.