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
|
use crate::download::{CustomDownloadInstance, DownloadInstance};
use crate::rc::{Array, CoreArrayProvider, CoreArrayProviderInner, Guard, Ref};
use crate::settings::Settings;
use crate::string::IntoCStr;
use binaryninjacore_sys::*;
use std::ffi::c_void;
use std::mem::MaybeUninit;
/// Register a new download provider type, which is used by the core (and other plugins) to make HTTP requests.
pub fn register_download_provider<C>(name: &str) -> &'static mut C
where
C: CustomDownloadProvider,
{
let name = name.to_cstr();
let provider_uninit = MaybeUninit::uninit();
// SAFETY: Download provider is never freed
let leaked_provider = Box::leak(Box::new(provider_uninit));
let result = unsafe {
BNRegisterDownloadProvider(
name.as_ptr(),
&mut BNDownloadProviderCallbacks {
context: leaked_provider as *mut _ as *mut c_void,
createInstance: Some(cb_create_instance::<C>),
},
)
};
let provider_core = DownloadProvider::from_raw(result);
// We now have the core provider so we can actually construct the object.
leaked_provider.write(C::from_core(provider_core));
unsafe { leaked_provider.assume_init_mut() }
}
pub trait CustomDownloadProvider: 'static + Sync {
type Instance: CustomDownloadInstance;
fn handle(&self) -> DownloadProvider;
/// Called to construct this provider object with the given core object.
fn from_core(core: DownloadProvider) -> Self;
fn create_instance(&self) -> Result<Ref<DownloadInstance>, ()> {
Self::Instance::new_with_provider(self.handle())
}
}
#[derive(Copy, Clone)]
pub struct DownloadProvider {
pub(crate) handle: *mut BNDownloadProvider,
}
impl DownloadProvider {
pub(crate) fn from_raw(handle: *mut BNDownloadProvider) -> DownloadProvider {
Self { handle }
}
pub fn get(name: &str) -> Option<DownloadProvider> {
let name = name.to_cstr();
let result = unsafe { BNGetDownloadProviderByName(name.as_ptr()) };
if result.is_null() {
return None;
}
Some(DownloadProvider { handle: result })
}
pub fn list() -> Result<Array<DownloadProvider>, ()> {
let mut count = 0;
let list: *mut *mut BNDownloadProvider = unsafe { BNGetDownloadProviderList(&mut count) };
if list.is_null() {
return Err(());
}
Ok(unsafe { Array::new(list, count, ()) })
}
/// TODO: We may want to `impl Default`, error checking might be preventing us from doing so
pub fn try_default() -> Result<DownloadProvider, ()> {
let s = Settings::new();
let dp_name = s.get_string("network.downloadProviderName");
Self::get(&dp_name).ok_or(())
}
pub fn create_instance(&self) -> Result<Ref<DownloadInstance>, ()> {
let result: *mut BNDownloadInstance =
unsafe { BNCreateDownloadProviderInstance(self.handle) };
if result.is_null() {
return Err(());
}
Ok(unsafe { DownloadInstance::ref_from_raw(result) })
}
}
impl CoreArrayProvider for DownloadProvider {
type Raw = *mut BNDownloadProvider;
type Context = ();
type Wrapped<'a> = Guard<'a, DownloadProvider>;
}
unsafe impl CoreArrayProviderInner for DownloadProvider {
unsafe fn free(raw: *mut Self::Raw, _count: usize, _context: &Self::Context) {
BNFreeDownloadProviderList(raw);
}
unsafe fn wrap_raw<'a>(raw: &'a Self::Raw, _context: &'a Self::Context) -> Self::Wrapped<'a> {
Guard::new(DownloadProvider::from_raw(*raw), &())
}
}
unsafe impl Send for DownloadProvider {}
unsafe impl Sync for DownloadProvider {}
unsafe extern "C" fn cb_create_instance<C: CustomDownloadProvider>(
ctxt: *mut c_void,
) -> *mut BNDownloadInstance {
ffi_wrap!("CustomDownloadProvider::cb_create_instance", unsafe {
let provider = &*(ctxt as *const C);
match provider.create_instance() {
Ok(instance) => Ref::into_raw(instance).handle,
Err(_) => std::ptr::null_mut(),
}
})
}
|