logo
  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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
// Copyright 2021-2022 Vector 35 Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![doc(html_favicon_url = "../favicon.ico")]
#![doc(html_logo_url = "../logo.png")]
#![doc(issue_tracker_base_url = "https://github.com/Vector35/binaryninja-api/issues/")]

//! # Warning
//! <img align="right" src="../under_construction.png" width="175" height="175">
//!
//! > ⚠️ **These bindings are in a very early beta, only have partial support for the core APIs and are still actively under development. Compatibility _will_ break and conventions _will_ change! They are being used for core Binary Ninja features however, so we expect much of what is already there to be reliable enough to build on, just don't be surprised if your plugins/scripts need to hit a moving target.**
//!
//! > ⚠️ This project runs on Rust version `stable-2022-04-07`

#[macro_use]
extern crate log;
#[doc(hidden)]
pub extern crate binaryninjacore_sys;
extern crate libc;
#[cfg(feature = "rayon")]
extern crate rayon;

// TODO
// move some options to results
// replace `fn handle` with `AsRef` bounds
// possible values
// arch rework
// cc possible values
// bv reorg
// core fileaccessor (for bv saving)
// headless wrapper for shutdown
// platform cc

#[macro_use]
mod ffi;

pub mod architecture;
pub mod backgroundtask;
pub mod basicblock;
pub mod binaryreader;
pub mod binaryview;
pub mod binarywriter;
pub mod callingconvention;
pub mod command;
pub mod custombinaryview;
pub mod databuffer;
pub mod debuginfo;
pub mod demangle;
pub mod disassembly;
pub mod fileaccessor;
pub mod filemetadata;
pub mod flowgraph;
pub mod function;
pub mod headless;
pub mod interaction;
pub mod linearview;
pub mod llil;
pub mod platform;
pub mod rc;
pub mod section;
pub mod segment;
pub mod settings;
pub mod string;
pub mod symbol;
pub mod tags;
pub mod types;

use std::collections::HashMap;
use std::fs::File;
use std::io::Read;
use std::path::Path;

pub use binaryninjacore_sys::BNBranchType as BranchType;
pub use binaryninjacore_sys::BNEndianness as Endianness;

// Commented out to suppress unused warnings
// const BN_MAX_INSTRUCTION_LENGTH: u64 = 256;
// const BN_DEFAULT_INSTRUCTION_LENGTH: u64 = 16;
// const BN_DEFAULT_OPCODE_DISPLAY: u64 = 8;
// const BN_MAX_INSTRUCTION_BRANCHES: u64 = 3;
// const BN_MAX_STORED_DATA_LENGTH: u64 = 0x3fffffff;
// const BN_NULL_ID: i64 = -1;
// const BN_INVALID_REGISTER: usize = 0xffffffff;
// const BN_AUTOCOERCE_EXTERN_PTR: u64 = 0xfffffffd;
// const BN_NOCOERCE_EXTERN_PTR: u64 = 0xfffffffe;
// const BN_INVALID_OPERAND: u64 = 0xffffffff;
// const BN_MAX_STRING_LENGTH: u64 = 128;
// const BN_MAX_VARIABLE_OFFSET: u64 = 0x7fffffffff;
// const BN_MAX_VARIABLE_INDEX: u64 = 0xfffff;
// const BN_MINIMUM_CONFIDENCE: u8 = 1;
// const BN_HEURISTIC_CONFIDENCE: u8 = 192;

const BN_FULL_CONFIDENCE: u8 = 255;
const BN_INVALID_EXPR: usize = usize::MAX;

pub mod logger {
    use std::os::raw::{c_char, c_void};

    use log;

    use crate::string::BnStr;

    pub use binaryninjacore_sys::BNLogLevel as Level;
    use binaryninjacore_sys::{BNLogListener, BNUpdateLogListeners};

    struct Logger;
    static LOGGER: Logger = Logger;

    impl log::Log for Logger {
        fn enabled(&self, _metadata: &log::Metadata) -> bool {
            true
        }

        fn log(&self, record: &log::Record) {
            use self::Level::*;
            use binaryninjacore_sys::BNLog;
            use log::Level;
            use std::ffi::CString;

            let level = match record.level() {
                Level::Error => ErrorLog,
                Level::Warn => WarningLog,
                Level::Info => InfoLog,
                Level::Debug | Level::Trace => DebugLog,
            };

            if let Ok(msg) = CString::new(format!("{}", record.args())) {
                unsafe {
                    BNLog(0, level, std::ptr::null(), 0, msg.as_ptr());
                }
            };
        }

        fn flush(&self) {}
    }

    /// Uses BinaryNinja's logging functionality as the sink for
    /// Rust's `log` crate.
    pub fn init(filter: log::LevelFilter) -> Result<(), log::SetLoggerError> {
        log::set_max_level(filter);
        log::set_logger(&LOGGER)
    }

    pub trait LogListener: 'static + Sync {
        fn log(&self, session: usize, level: Level, msg: &BnStr, logger_name: &BnStr, tid: usize);
        fn level(&self) -> Level;
        fn close(&self) {}
    }

    pub struct LogGuard<L: LogListener> {
        ctxt: *mut L,
    }

    impl<L: LogListener> Drop for LogGuard<L> {
        fn drop(&mut self) {
            use binaryninjacore_sys::BNUnregisterLogListener;

            let mut bn_obj = BNLogListener {
                context: self.ctxt as *mut _,
                log: Some(cb_log::<L>),
                close: Some(cb_close::<L>),
                getLogLevel: Some(cb_level::<L>),
            };

            unsafe {
                BNUnregisterLogListener(&mut bn_obj);
                BNUpdateLogListeners();

                let _listener = Box::from_raw(self.ctxt);
            }
        }
    }

    pub fn register_listener<L: LogListener>(listener: L) -> LogGuard<L> {
        use binaryninjacore_sys::BNRegisterLogListener;

        let raw = Box::into_raw(Box::new(listener));
        let mut bn_obj = BNLogListener {
            context: raw as *mut _,
            log: Some(cb_log::<L>),
            close: Some(cb_close::<L>),
            getLogLevel: Some(cb_level::<L>),
        };

        unsafe {
            BNRegisterLogListener(&mut bn_obj);
            BNUpdateLogListeners();
        }

        LogGuard { ctxt: raw }
    }

    extern "C" fn cb_log<L>(
        ctxt: *mut c_void,
        session: usize,
        level: Level,
        msg: *const c_char,
        logger_name: *const c_char,
        tid: usize,
    ) where
        L: LogListener,
    {
        ffi_wrap!("LogListener::log", unsafe {
            let listener = &*(ctxt as *const L);
            listener.log(
                session,
                level,
                BnStr::from_raw(msg),
                BnStr::from_raw(logger_name),
                tid,
            );
        })
    }

    extern "C" fn cb_close<L>(ctxt: *mut c_void)
    where
        L: LogListener,
    {
        ffi_wrap!("LogListener::close", unsafe {
            let listener = &*(ctxt as *const L);
            listener.close();
        })
    }

    extern "C" fn cb_level<L>(ctxt: *mut c_void) -> Level
    where
        L: LogListener,
    {
        ffi_wrap!("LogListener::log", unsafe {
            let listener = &*(ctxt as *const L);
            listener.level()
        })
    }
}

pub fn open_view<F: AsRef<Path>>(filename: F) -> Result<rc::Ref<binaryview::BinaryView>, String> {
    use crate::binaryview::BinaryViewExt;
    use crate::custombinaryview::BinaryViewTypeExt;

    let filename = filename.as_ref();

    let mut metadata = filemetadata::FileMetadata::with_filename(filename.to_str().unwrap());

    let (is_bndb, view) = if filename
        .extension()
        .map(|ext| ext == "bndb")
        .unwrap_or(false)
    {
        let mut file = File::open(filename).or(Err("Could not open file".to_string()))?;

        let mut buf = [0; 15];
        file.read_exact(&mut buf)
            .or(Err("Not a valid BNDB (too small)".to_string()))?;
        let sqlite_string = "SQLite format 3";
        if buf != sqlite_string.as_bytes() {
            return Err("Not a valid BNDB (invalid magic)".to_string());
        }
        (true, metadata.open_database(filename.to_str().unwrap()))
    } else {
        (
            false,
            binaryview::BinaryView::from_filename(&mut metadata, filename.to_str().unwrap()),
        )
    };
    let view = view.or(Err("Unable to open file".to_string()))?;

    let bv = custombinaryview::BinaryViewType::list_valid_types_for(&view)
        .iter()
        .filter_map(|available_view| {
            if **available_view.name() == *"Raw" {
                return None;
            }
            if is_bndb {
                return Some(
                    view.metadata()
                        .get_view_of_type(available_view.name())
                        .unwrap(),
                );
            } else {
                // TODO : add log prints
                println!("Opening view of type: `{}`", available_view.name());
                return Some(available_view.open(&view).unwrap());
            }
        })
        .next()
        .or(None);

    let bv = bv.map_or_else(
        || {
            if is_bndb {
                view.metadata()
                    .get_view_of_type("Raw")
                    .or(Err("Could not get raw view from bndb".to_string()))
            } else {
                custombinaryview::BinaryViewType::by_name("Raw")
                    .unwrap()
                    .open(&view)
                    .or(Err("Could not open raw view".to_string()))
            }
        },
        Ok,
    );
    let bv = bv?;

    bv.update_analysis_and_wait();
    Ok(bv)
}

pub fn open_view_with_options<F: AsRef<Path>>(
    filename: F,
    update_analysis_and_wait: bool,
    options: Option<HashMap<&str, &str>>,
) -> Result<rc::Ref<binaryview::BinaryView>, String> {
    //! This is incomplete, but should work in most cases:
    //! ```
    //! let settings = [("analysis.linearSweep.autorun", "false")]
    //!     .iter()
    //!     .cloned()
    //!     .collect();
    //!
    //! let bv = binaryninja::open_view_with_options("/bin/cat", true, Some(settings))
    //!     .expect("Couldn't open `/bin/cat`");
    //! ```

    use crate::binaryview::BinaryViewExt;
    use crate::custombinaryview::{BinaryViewTypeBase, BinaryViewTypeExt};

    let filename = filename.as_ref();

    let mut metadata = filemetadata::FileMetadata::with_filename(filename.to_str().unwrap());

    let mut is_bndb = false;
    let view = match match filename.ends_with(".bndb") {
        true => {
            match File::open(filename) {
                Ok(mut file) => {
                    let mut buf = [0; 15];
                    match file.read_exact(&mut buf) {
                        Ok(_) => {
                            let sqlite_string = "SQLite format 3";
                            if buf != sqlite_string.as_bytes() {
                                return Err("Not a valid BNDB (invalid magic)".to_string());
                            }
                        }
                        _ => return Err("Not a valid BNDB (too small)".to_string()),
                    }
                }
                _ => return Err("Could not open file".to_string()),
            }
            is_bndb = true;
            metadata.open_database_for_configuration(filename.to_str().unwrap())
        }
        false => binaryview::BinaryView::from_filename(&mut metadata, filename.to_str().unwrap()),
    } {
        Ok(view) => view,
        _ => return Err("Unable to open file".to_string()),
    };

    let mut universal_view_type = None;
    let mut view_type = None;
    for available_view in custombinaryview::BinaryViewType::list_valid_types_for(&view).iter() {
        if available_view.name().as_ref() == "Universal".as_bytes() {
            universal_view_type = Some(available_view);
        } else if view_type.is_none() && **available_view.name() != *"Raw" {
            view_type = Some(available_view);
        }
    }

    let view_type = match view_type {
        None => custombinaryview::BinaryViewType::by_name("Mapped").unwrap(),
        Some(view_type) => view_type,
    };

    let setting_id = format!("{}{}", view_type.name(), "_settings");
    let default_settings = settings::Settings::new(setting_id);
    default_settings.deserialize_schema(settings::Settings::new("").serialize_schema());
    default_settings.set_resource_id(view_type.name());

    let mut load_settings = match (is_bndb, view.load_settings(view_type.name())) {
        (true, Ok(settings)) => Some(settings),
        _ => None,
    };

    if load_settings.is_none() {
        // TODO : The Python version has a "fixme" here but I have no idea why
        if universal_view_type.is_some()
            && options.is_some()
            && options
                .as_ref()
                .unwrap()
                .contains_key("files.universal.architecturePreference")
        {
            load_settings = match universal_view_type
                .unwrap()
                .load_settings_for_data(view.as_ref())
            {
                Ok(settings) => Some(settings),
                _ => return Err("Could not load settings for universal view data".to_string()),
            };

            // let arch_list = load_settings.as_ref().unwrap().get_string(
            //     "loader.universal.architectures",
            //     None,
            //     None,
            // );

            // TODO : Need json support
            // let arch_list = arch_list.as_str();
            // let arch_list = arch_list[1..arch_list.len()].split("'");
            // arch_entry = [entry for entry in arch_list if entry['architecture'] == options['files.universal.architecturePreference'][0]]
            // if not arch_entry:
            //     log.log_error(f"Could not load {options['files.universal.architecturePreference'][0]} from Universal image. Entry not found!")
            //     return None

            // let tmp_load_settings = settings::Settings::new(BNGetUniqueIdentifierString());
            // tmp_load_settings.deserialize_schema(arch_entry[0]['loadSchema']);
            // load_settings = Some(tmp_load_settings);
        } else {
            load_settings = match view_type.load_settings_for_data(view.as_ref()) {
                Ok(settings) => Some(settings),
                _ => None,
            };
        }
    }
    if load_settings.is_none() {
        // log.log_error(f"Could not get load settings for binary view of type `{bvt.name}`")
        return Ok(view);
    }
    let load_settings = load_settings.unwrap();
    load_settings.set_resource_id(view_type.name());
    view.set_load_settings(view_type.name(), load_settings.as_ref());

    match options {
        Some(options) => {
            for (setting, value) in options {
                if load_settings.contains(setting) {
                    if !load_settings.set_json(setting, value, Some(view.as_ref()), None) {
                        return Err(format!("Setting: {} set operation failed!", setting));
                    }
                } else if default_settings.contains(setting) {
                    if !default_settings.set_json(setting, value, Some(view.as_ref()), None) {
                        return Err(format!("Setting: {} set operation failed!", setting));
                    }
                } else {
                    return Err(format!("Setting: {} not available!", setting));
                }
            }
        }
        None => (),
    }

    if is_bndb {
        let view = view
            .metadata()
            .open_database(filename.to_str().unwrap())
            .expect("Couldn't open database");
        let view_type_name = view_type.name();

        let bv = match view.metadata().get_view_of_type(view_type_name) {
            Ok(bv) => bv,
            _ => view,
        };

        if update_analysis_and_wait {
            bv.update_analysis_and_wait();
        }
        Ok(bv)
    } else {
        match view_type.open(&view) {
            Ok(bv) => {
                if update_analysis_and_wait {
                    bv.update_analysis_and_wait();
                }
                Ok(bv)
            }
            _ => Ok(view),
        }
    }
}

pub fn version() -> string::BnString {
    unsafe { string::BnString::from_raw(binaryninjacore_sys::BNGetVersionString()) }
}

pub fn plugin_abi_version() -> u32 {
    binaryninjacore_sys::BN_CURRENT_CORE_ABI_VERSION
}

pub fn plugin_abi_minimum_version() -> u32 {
    binaryninjacore_sys::BN_MINIMUM_CORE_ABI_VERSION
}

pub fn core_abi_version() -> u32 {
    unsafe { binaryninjacore_sys::BNGetCurrentCoreABIVersion() }
}

pub fn core_abi_minimum_version() -> u32 {
    unsafe { binaryninjacore_sys::BNGetMinimumCoreABIVersion() }
}

pub fn plugin_ui_abi_version() -> u32 {
    binaryninjacore_sys::BN_CURRENT_UI_ABI_VERSION
}

pub fn plugin_ui_abi_minimum_version() -> u32 {
    binaryninjacore_sys::BN_MINIMUM_UI_ABI_VERSION
}

// Provide ABI version automatically so that the core can verify binary compatibility
#[no_mangle]
#[allow(non_snake_case)]
pub extern "C" fn CorePluginABIVersion() -> u32 {
    plugin_abi_version()
}

#[no_mangle]
pub extern "C" fn UIPluginABIVersion() -> u32 {
    plugin_ui_abi_version()
}