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
// Prepare to be boarded
use std::os::raw::c_char;
use crate::{
bindings as unsafe_bindings, error::PreboardError, idevice::Device,
services::lockdownd::LockdowndService,
};
use plist_plus::Plist;
/// A service that manages data at the first unlock screen after boot.
/// Prepare to be boarded!
pub struct PreboardClient<'a> {
pub(crate) pointer: unsafe_bindings::preboard_client_t,
phantom: std::marker::PhantomData<&'a Device>,
}
impl PreboardClient<'_> {
/// Creates a preboard client from a lockdown service
/// # Arguments
/// * `device` - The device to connect to
/// * `descriptor` - The lockdown service to connect on
/// # Returns
/// A struct containing the handle to the connection
///
/// ***Verified:*** False
pub fn new(device: &Device, descriptor: LockdowndService) -> Result<Self, PreboardError> {
let mut pointer = std::ptr::null_mut();
let result = unsafe {
unsafe_bindings::preboard_client_new(device.pointer, descriptor.pointer, &mut pointer)
}
.into();
if result != PreboardError::Success {
return Err(result);
}
Ok(Self {
pointer,
phantom: std::marker::PhantomData,
})
}
/// Starts a new connection and adds a preboard client to it
/// # Arguments
/// * `device` - The device to connect to
/// * `label` - The label for the connection
/// # Returns
/// A struct containing the handle to the connection
///
/// ***Verified:*** False
pub fn start_service(device: &Device, label: impl Into<String>) -> Result<Self, PreboardError> {
let mut pointer = std::ptr::null_mut();
let result = unsafe {
unsafe_bindings::preboard_client_start_service(
device.pointer,
&mut pointer,
label.into().as_ptr() as *const c_char,
)
}
.into();
if result != PreboardError::Success {
return Err(result);
}
Ok(Self {
pointer,
phantom: std::marker::PhantomData,
})
}
/// Sends data to the client
/// # Arguments
/// * `data` - The data to send
/// # Returns
/// *none*
///
/// ***Verified:*** False
pub fn send(&self, data: Plist) -> Result<(), PreboardError> {
let result =
unsafe { unsafe_bindings::preboard_send(self.pointer, data.get_pointer()) }.into();
if result != PreboardError::Success {
return Err(result);
}
Ok(())
}
/// Receives data from the client
/// Blocks until a full plist is sent
/// # Arguments
/// * `timeout` - How long to wait for the data. If 0, this will block indefinitely
/// # Returns
/// A plist containing the data
///
/// ***Verified:*** False
pub fn receive(&self, timeout: u32) -> Result<Plist, PreboardError> {
let mut plist = std::ptr::null_mut();
let result = if timeout == 0 {
unsafe { unsafe_bindings::preboard_receive(self.pointer, &mut plist) }.into()
} else {
unsafe {
unsafe_bindings::preboard_receive_with_timeout(self.pointer, &mut plist, timeout)
}
.into()
};
if result != PreboardError::Success {
return Err(result);
}
Ok(plist.into())
}
/// Creates a stashbag on the device
/// # Arguments
/// * `manifest` - The options to use while creating the stashbag
/// # Returns
/// *none*
pub fn create_stashbag(&self, manifest: Option<Plist>) -> Result<(), PreboardError> {
let result = unsafe {
unsafe_bindings::preboard_create_stashbag(
self.pointer,
manifest
.map(|p| p.get_pointer())
.unwrap_or(std::ptr::null_mut()),
None,
std::ptr::null_mut(),
)
}
.into();
if result != PreboardError::Success {
return Err(result);
}
Ok(())
}
/// Commands preboard to commit a previously created stashbag
/// # Arguments
/// * `manifest` - The manifest used for creating the stashbag
/// # Returns
/// *none*
///
/// ***Verified:*** False
pub fn commit_stashbag(&self, manifest: Option<Plist>) -> Result<(), PreboardError> {
let result = unsafe {
unsafe_bindings::preboard_commit_stashbag(
self.pointer,
manifest
.map(|p| p.get_pointer())
.unwrap_or(std::ptr::null_mut()),
None,
std::ptr::null_mut(),
)
}
.into();
if result != PreboardError::Success {
return Err(result);
}
Ok(())
}
}
impl Drop for PreboardClient<'_> {
fn drop(&mut self) {
unsafe {
unsafe_bindings::preboard_client_free(self.pointer);
}
}
}