ios-webkit-debug-proxy 0.1.2

iOS WebKit Debug Proxy - Rust rewrite
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
// RPC module - WebInspector remote procedure call formatter
// Corresponds to the original C code rpc.c / rpc.h

use log::warn;
use uuid::Uuid;

use crate::error::{Error, Result};
use crate::PageType;

/// RPC status
#[allow(dead_code)]
pub(crate) type RpcStatus = Result<()>;

/// App info
#[derive(Debug, Clone)]
pub(crate) struct RpcApp {
    pub(crate) app_id: String,
    #[allow(dead_code)]
    pub(crate) app_name: String,
    #[allow(dead_code)]
    pub(crate) is_proxy: bool,
}

/// Page info
#[derive(Debug, Clone)]
pub(crate) struct RpcPage {
    pub(crate) page_id: u32,
    pub(crate) page_type: PageType,
    pub(crate) connection_id: Option<String>,
    pub(crate) title: Option<String>,
    pub(crate) url: Option<String>,
}

/// Generate a new UUID
pub(crate) fn new_uuid() -> String {
    Uuid::new_v4().to_string().to_uppercase()
}

/// RPC message sender interface
pub(crate) struct RpcSender {
    pub(crate) connection_id: String,
}

impl RpcSender {
    pub(crate) fn new(connection_id: String) -> Self {
        RpcSender { connection_id }
    }

    /// Build RPC message plist dictionary
    fn build_message(&self, selector: &str, args: plist::Dictionary) -> plist::Value {
        let mut rpc_dict = plist::Dictionary::new();
        rpc_dict.insert(
            "__selector".to_string(),
            plist::Value::String(selector.to_string()),
        );
        rpc_dict.insert("__argument".to_string(), plist::Value::Dictionary(args));
        plist::Value::Dictionary(rpc_dict)
    }

    fn new_args(&self) -> plist::Dictionary {
        let mut args = plist::Dictionary::new();
        args.insert(
            "WIRConnectionIdentifierKey".to_string(),
            plist::Value::String(self.connection_id.clone()),
        );
        args
    }

    /// Send _rpc_reportIdentifier
    pub(crate) fn build_report_identifier(&self) -> Vec<u8> {
        let args = self.new_args();
        let msg = self.build_message("_rpc_reportIdentifier:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_getConnectedApplications
    #[allow(dead_code)]
    pub(crate) fn build_get_connected_applications(&self) -> Vec<u8> {
        let args = self.new_args();
        let msg = self.build_message("_rpc_getConnectedApplications:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_forwardGetListing
    pub(crate) fn build_forward_get_listing(&self, app_id: &str) -> Vec<u8> {
        let mut args = self.new_args();
        args.insert(
            "WIRApplicationIdentifierKey".to_string(),
            plist::Value::String(app_id.to_string()),
        );
        let msg = self.build_message("_rpc_forwardGetListing:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_forwardIndicateWebView
    #[allow(dead_code)]
    pub(crate) fn build_forward_indicate_web_view(
        &self,
        app_id: &str,
        page_id: u32,
        is_enabled: bool,
    ) -> Vec<u8> {
        let mut args = self.new_args();
        args.insert(
            "WIRApplicationIdentifierKey".to_string(),
            plist::Value::String(app_id.to_string()),
        );
        args.insert(
            "WIRPageIdentifierKey".to_string(),
            plist::Value::Integer(page_id.into()),
        );
        args.insert(
            "WIRIndicateEnabledKey".to_string(),
            plist::Value::Boolean(is_enabled),
        );
        let msg = self.build_message("_rpc_forwardIndicateWebView:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_forwardSocketSetup
    pub(crate) fn build_forward_socket_setup(
        &self,
        app_id: &str,
        page_id: u32,
        sender_id: &str,
    ) -> Vec<u8> {
        let mut args = self.new_args();
        args.insert(
            "WIRApplicationIdentifierKey".to_string(),
            plist::Value::String(app_id.to_string()),
        );
        args.insert(
            "WIRAutomaticallyPause".to_string(),
            plist::Value::Boolean(false),
        );
        args.insert(
            "WIRPageIdentifierKey".to_string(),
            plist::Value::Integer(page_id.into()),
        );
        args.insert(
            "WIRSenderKey".to_string(),
            plist::Value::String(sender_id.to_string()),
        );
        let msg = self.build_message("_rpc_forwardSocketSetup:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_forwardSocketData
    pub(crate) fn build_forward_socket_data(
        &self,
        app_id: &str,
        page_id: u32,
        sender_id: &str,
        data: &[u8],
    ) -> Vec<u8> {
        let mut args = self.new_args();
        args.insert(
            "WIRApplicationIdentifierKey".to_string(),
            plist::Value::String(app_id.to_string()),
        );
        args.insert(
            "WIRPageIdentifierKey".to_string(),
            plist::Value::Integer(page_id.into()),
        );
        args.insert(
            "WIRSenderKey".to_string(),
            plist::Value::String(sender_id.to_string()),
        );
        args.insert(
            "WIRSocketDataKey".to_string(),
            plist::Value::Data(data.to_vec()),
        );
        let msg = self.build_message("_rpc_forwardSocketData:", args);
        plist_to_bin(&msg)
    }

    /// Send _rpc_forwardDidClose
    pub(crate) fn build_forward_did_close(
        &self,
        app_id: &str,
        page_id: u32,
        sender_id: &str,
    ) -> Vec<u8> {
        let mut args = self.new_args();
        args.insert(
            "WIRApplicationIdentifierKey".to_string(),
            plist::Value::String(app_id.to_string()),
        );
        args.insert(
            "WIRPageIdentifierKey".to_string(),
            plist::Value::Integer(page_id.into()),
        );
        args.insert(
            "WIRSenderKey".to_string(),
            plist::Value::String(sender_id.to_string()),
        );
        let msg = self.build_message("_rpc_forwardDidClose:", args);
        plist_to_bin(&msg)
    }
}

/// RPC message receive type
#[derive(Debug)]
pub(crate) enum RpcMessage {
    ReportSetup,
    ReportConnectedApplicationList(Vec<RpcApp>),
    ApplicationConnected(RpcApp),
    ApplicationDisconnected(RpcApp),
    ApplicationSentListing {
        app_id: String,
        pages: Vec<RpcPage>,
    },
    ApplicationSentData {
        #[allow(dead_code)]
        app_id: String,
        dest_id: String,
        data: Vec<u8>,
    },
    ApplicationUpdated {
        #[allow(dead_code)]
        app_id: String,
        dest_id: String,
    },
    Unknown(String),
}

/// Parse received RPC plist
pub(crate) fn parse_rpc_message(rpc_dict: &plist::Value) -> Result<RpcMessage> {
    let dict = rpc_dict.as_dictionary().ok_or(Error::Rpc("RPC message is not a dictionary".to_string()))?;

    let selector = dict
        .get("__selector")
        .and_then(|v| v.as_string())
        .ok_or(Error::Rpc("Missing __selector".to_string()))?;

    let args = dict
        .get("__argument")
        .and_then(|v| v.as_dictionary())
        .ok_or(Error::Rpc("Missing __argument".to_string()))?;

    match selector {
        "_rpc_reportSetup:" => Ok(RpcMessage::ReportSetup),

        "_rpc_reportConnectedApplicationList:" => {
            let apps = parse_apps(args)?;
            Ok(RpcMessage::ReportConnectedApplicationList(apps))
        }

        "_rpc_applicationConnected:" => {
            let app = parse_app(args)?;
            Ok(RpcMessage::ApplicationConnected(app))
        }

        "_rpc_applicationDisconnected:" => {
            let app = parse_app(args)?;
            Ok(RpcMessage::ApplicationDisconnected(app))
        }

        "_rpc_applicationSentListing:" => {
            let app_id = get_required_string(args, "WIRApplicationIdentifierKey")?;
            let pages = if let Some(listing) = args.get("WIRListingKey") {
                parse_pages(listing)?
            } else {
                Vec::new()
            };
            Ok(RpcMessage::ApplicationSentListing { app_id, pages })
        }

        "_rpc_applicationSentData:" => {
            let app_id = get_required_string(args, "WIRApplicationIdentifierKey")?;
            let dest_id = get_required_string(args, "WIRDestinationKey")?;
            let data = get_required_data(args, "WIRMessageDataKey")?;
            Ok(RpcMessage::ApplicationSentData {
                app_id,
                dest_id,
                data,
            })
        }

        "_rpc_applicationUpdated:" => {
            // May have WIRHostApplicationIdentifierKey or WIRApplicationNameKey
            let app_id = get_required_string(args, "WIRHostApplicationIdentifierKey")
                .or_else(|_| get_required_string(args, "WIRApplicationNameKey"))?;
            let dest_id = get_required_string(args, "WIRApplicationIdentifierKey")?;
            Ok(RpcMessage::ApplicationUpdated { app_id, dest_id })
        }

        "_rpc_reportConnectedDriverList:" | "_rpc_reportCurrentState:" => {
            Ok(RpcMessage::Unknown(selector.to_string()))
        }

        _ => {
            warn!("Unknown RPC selector: {}", selector);
            Ok(RpcMessage::Unknown(selector.to_string()))
        }
    }
}

/// Parse app dictionary
fn parse_apps(args: &plist::Dictionary) -> Result<Vec<RpcApp>> {
    let app_dict = args
        .get("WIRApplicationDictionaryKey")
        .and_then(|v| v.as_dictionary())
        .ok_or(Error::Rpc("Missing WIRApplicationDictionaryKey".to_string()))?;

    let mut apps = Vec::new();
    for (_key, value) in app_dict {
        if let Some(app_info) = value.as_dictionary() {
            if let Ok(app) = parse_app(app_info) {
                apps.push(app);
            }
        }
    }
    Ok(apps)
}

/// Parse a single app
fn parse_app(dict: &plist::Dictionary) -> Result<RpcApp> {
    let app_id = get_required_string(dict, "WIRApplicationIdentifierKey")?;
    let app_name = dict
        .get("WIRApplicationNameKey")
        .and_then(|v| v.as_string())
        .unwrap_or("")
        .to_string();
    let is_proxy = dict
        .get("WIRIsApplicationProxyKey")
        .and_then(|v| v.as_boolean())
        .unwrap_or(false);

    Ok(RpcApp {
        app_id,
        app_name,
        is_proxy,
    })
}

/// Parse page list
fn parse_pages(listing: &plist::Value) -> Result<Vec<RpcPage>> {
    let dict = listing
        .as_dictionary()
        .ok_or(Error::Rpc("WIRListingKey is not a dictionary".to_string()))?;

    let mut pages = Vec::new();
    for (_key, value) in dict {
        if let Some(page_dict) = value.as_dictionary() {
            let page_id = page_dict
                .get("WIRPageIdentifierKey")
                .and_then(|v| v.as_unsigned_integer())
                .ok_or(Error::Rpc("Missing WIRPageIdentifierKey".to_string()))? as u32;

            let page_type = page_dict
                .get("WIRTypeKey")
                .and_then(|v| {
                    let ty = match v.as_string()? {
                        "WIRTypeWebPage" => PageType::WebPage,
                        "WIRTypeJavaScript" => PageType::JavaScript,
                        _ => PageType::Unknown,
                    };
                    Some(ty)
                })
                .unwrap_or(PageType::Unknown);

            let connection_id = page_dict
                .get("WIRConnectionIdentifierKey")
                .and_then(|v| v.as_string())
                .map(String::from);

            let title = page_dict
                .get("WIRTitleKey")
                .and_then(|v| v.as_string())
                .map(String::from);

            let url = page_dict
                .get("WIRURLKey")
                .and_then(|v| v.as_string())
                .map(String::from);

            pages.push(RpcPage {
                page_id,
                page_type: page_type,
                connection_id,
                title,
                url,
            });
        }
    }
    Ok(pages)
}

// Helper functions
fn get_required_string(dict: &plist::Dictionary, key: &str) -> Result<String> {
    dict.get(key)
        .and_then(|v| v.as_string())
        .map(String::from)
        .ok_or_else(|| Error::Rpc(format!("Missing required string field: {}", key)))
}

fn get_required_data(dict: &plist::Dictionary, key: &str) -> Result<Vec<u8>> {
    dict.get(key)
        .and_then(|v| v.as_data())
        .map(|d| d.to_vec())
        .ok_or_else(|| Error::Rpc(format!("Missing required data field: {}", key)))
}

/// Serialize plist Value to binary format
pub(crate) fn plist_to_bin(value: &plist::Value) -> Vec<u8> {
    let mut buf = Vec::new();
    value.to_writer_binary(&mut buf).expect("plist serialization failed");
    buf
}

/// Deserialize plist Value from binary data
#[allow(dead_code)]
pub(crate) fn plist_from_bin(data: &[u8]) -> Result<plist::Value> {
    plist::from_bytes(data).map_err(|e| Error::Plist(format!("plist deserialization failed: {}", e)))
}