idalib/
lib.rs

1//! # idalib
2//!
3//! idalib is a Rust library providing idiomatic bindings for the IDA SDK, enabling the development
4//! of standalone analysis tools using IDA v9.x’s idalib.
5//!
6//! ## Usage
7//!
8//! To use idalib, add it as a dependency in your `Cargo.toml` and include a `build.rs` file in
9//! your project to properly link against IDA:
10//!
11//! ```toml
12//! [dependencies]
13//! idalib = "0.9"
14//!
15//! [build-dependencies]
16//! idalib-build = "0.9"
17//! ```
18//!
19//! Here is a basic example of a `build.rs` file:
20//!
21//! ```rust,ignore
22//! fn main() -> Result<(), Box<dyn std::error::Error>> {
23//!     idalib_build::configure_linkage()?;
24//!     Ok(())
25//! }
26//! ```
27//!
28//! This script uses the `idalib-build` crate to automatically configure the linkage against IDA.
29//! If IDA is installed in a non-default location, ensure that `IDADIR` is set to point to your
30//! installation directory, if you are linking against IDA's shared libraries, as opposed to the
31//! stub libraries distributed with the SDK.
32//!
33//! ## Setting Environment Variables
34//!
35//! ### On Linux/macOS
36//!
37//! You can set the environment variables in your terminal session or add them to your shell
38//! configuration file (e.g., `.bashrc`, `.zshrc`):
39//!
40//! ```sh,ignore
41//! export IDADIR=/path/to/ida/installation
42//! ```
43//!
44//! ### On Windows
45//!
46//! Set environment variables using Command Prompt, PowerShell, or System Properties.
47//!
48//! **Command Prompt:**
49//! ```cmd
50//! set IDADIR=C:\path\to\ida\installation
51//! ```
52//!
53//! **PowerShell:**
54//! ```powershell,ignore
55//! $env:IDADIR = "C:\path\to\ida\installation"
56//! ```
57//!
58//! **System Properties:**
59//! Go to "Environment Variables" in System Properties and add `IDADIR`.
60//!
61//! ## Example
62//!
63//! Here's a simple example of how to use idalib:
64//!
65//! ```rust,ignore
66//! use idalib::idb::IDB;
67//!
68//! fn main() -> Result<(), Box<dyn std::error::Error>> {
69//!     let idb = IDB::open("/path/to/binary")?;
70//!     // Perform analysis...
71//!     Ok(())
72//! }
73//! ```
74//!
75#![allow(clippy::needless_lifetimes)]
76
77use std::marker::PhantomData;
78use std::sync::{Mutex, MutexGuard, OnceLock};
79
80pub mod bookmarks;
81pub mod decompiler;
82pub mod func;
83pub mod idb;
84pub mod insn;
85pub mod license;
86pub mod meta;
87pub mod name;
88pub mod plugin;
89pub mod processor;
90pub mod segment;
91pub mod strings;
92pub mod xref;
93
94pub use idalib_sys as ffi;
95
96pub use ffi::IDAError;
97pub use idb::IDB;
98#[cfg(not(feature = "plugin"))]
99pub use idb::IDBOpenOptions;
100pub use license::{LicenseId, is_valid_license, license_id};
101#[cfg(feature = "plugin")]
102pub use plugin::{IDAPlugin, PluginFlags};
103
104#[cfg(feature = "plugin")]
105pub use idalib_macros::plugin;
106
107pub type Address = u64;
108pub struct AddressFlags<'a> {
109    flags: ffi::bytes::flags64_t,
110    _marker: PhantomData<&'a IDB>,
111}
112
113impl<'a> AddressFlags<'a> {
114    pub(crate) fn new(flags: ffi::bytes::flags64_t) -> Self {
115        Self {
116            flags,
117            _marker: PhantomData,
118        }
119    }
120
121    pub fn is_code(&self) -> bool {
122        unsafe { ffi::bytes::is_code(self.flags) }
123    }
124
125    pub fn is_data(&self) -> bool {
126        unsafe { ffi::bytes::is_data(self.flags) }
127    }
128}
129
130pub struct IDA;
131
132impl IDA {
133    pub fn new(_: &IDB) -> Self {
134        // NOTE: we take the IDB as an argument to ensure that the caller has access to it,
135        // therefore ensuring the library is correctly initialised.
136        Self
137    }
138
139    pub fn msg(&self, message: impl AsRef<str>) -> Result<(), IDAError> {
140        unsafe { ffi::ida::msg(message) }
141    }
142}
143
144#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
145pub struct IDAVersion {
146    major: i32,
147    minor: i32,
148    build: i32,
149}
150
151impl IDAVersion {
152    pub fn major(&self) -> i32 {
153        self.major
154    }
155
156    pub fn minor(&self) -> i32 {
157        self.minor
158    }
159
160    pub fn build(&self) -> i32 {
161        self.build
162    }
163}
164
165static INIT: OnceLock<Mutex<()>> = OnceLock::new();
166
167#[cfg(not(any(target_os = "windows", feature = "plugin")))]
168unsafe extern "C" {
169    static mut batch: std::ffi::c_char;
170}
171
172pub(crate) type IDARuntimeHandle = MutexGuard<'static, ()>;
173
174#[cfg(not(feature = "plugin"))]
175pub fn force_batch_mode() {
176    #[cfg(not(target_os = "windows"))]
177    unsafe {
178        batch = 1;
179    }
180}
181
182#[cfg(feature = "plugin")]
183pub fn init_library() -> &'static Mutex<()> {
184    INIT.get_or_init(|| Mutex::new(()))
185}
186
187#[cfg(not(feature = "plugin"))]
188pub fn init_library() -> &'static Mutex<()> {
189    INIT.get_or_init(|| {
190        force_batch_mode();
191        ffi::ida::init_library().expect("IDA initialised successfully");
192        Mutex::new(())
193    })
194}
195
196pub(crate) fn prepare_library() -> IDARuntimeHandle {
197    let mutex = init_library();
198    mutex.lock().unwrap()
199}
200
201#[cfg(not(feature = "plugin"))]
202pub fn enable_console_messages(enabled: bool) {
203    init_library();
204    ffi::ida::enable_console_messages(enabled);
205}
206
207pub fn version() -> Result<IDAVersion, IDAError> {
208    ffi::ida::library_version().map(|(major, minor, build)| IDAVersion {
209        major,
210        minor,
211        build,
212    })
213}
idalib/lib.rs

idalib/
lib.rs
