ios-core 0.1.7

High-level device API, pairing transport, and discovery for iOS devices
Documentation
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
//! XPC client: high-level wrapper around XpcConnection for service calls.

use std::net::{Ipv6Addr, SocketAddr};

use tokio::io::{AsyncRead, AsyncWrite};
use tokio::net::TcpStream;

use crate::xpc::h2_raw::H2Framer;
use crate::xpc::message::{flags, XpcMessage, XpcValue};
use crate::xpc::rsd::{initialize_xpc_connection_on_framer, XpcConnection};
use crate::xpc::XpcError;

trait XpcStream: AsyncRead + AsyncWrite + Unpin + Send {}
impl<T> XpcStream for T where T: AsyncRead + AsyncWrite + Unpin + Send {}

type DynStream = Box<dyn XpcStream>;

/// High-level XPC client for iOS 17+ services.
pub struct XpcClient {
    inner: XpcConnection<DynStream>,
}

impl XpcClient {
    /// Connect to an XPC service at the given IPv6 address and port.
    pub async fn connect(addr: Ipv6Addr, port: u16) -> Result<Self, XpcError> {
        let sock_addr = SocketAddr::new(addr.into(), port);
        let stream = TcpStream::connect(sock_addr).await?;
        Self::connect_stream(stream).await
    }

    /// Connect to an XPC service over an already-established stream.
    pub async fn connect_stream<S>(stream: S) -> Result<Self, XpcError>
    where
        S: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    {
        let stream: DynStream = Box::new(stream);
        let mut framer = H2Framer::connect(stream)
            .await
            .map_err(|e| XpcError::Tls(format!("H2: {e}")))?;
        initialize_xpc_connection_on_framer(&mut framer).await?;
        Ok(Self {
            inner: XpcConnection::new(framer),
        })
    }

    /// Send an XPC dictionary and receive the response.
    pub async fn call(&mut self, body: XpcValue) -> Result<XpcMessage, XpcError> {
        let msg_id = self
            .inner
            .send_with_flags(body, flags::WANTING_REPLY)
            .await?;
        self.inner
            .recv_reply_on_stream(crate::xpc::h2_raw::STREAM_SERVER_CLIENT, msg_id)
            .await
    }

    /// Send an XPC dictionary and receive the response from stream 1.
    pub async fn call_recv_client_server(
        &mut self,
        body: XpcValue,
    ) -> Result<XpcMessage, XpcError> {
        let msg_id = self
            .inner
            .send_with_flags(body, flags::WANTING_REPLY)
            .await?;
        self.inner
            .recv_reply_on_stream(crate::xpc::h2_raw::STREAM_CLIENT_SERVER, msg_id)
            .await
    }

    /// Send without waiting for a response.
    pub async fn send(&mut self, body: XpcValue) -> Result<(), XpcError> {
        self.inner.send(body).await
    }

    /// Receive the next XPC message.
    pub async fn recv(&mut self) -> Result<XpcMessage, XpcError> {
        self.inner.recv().await
    }

    /// Receive the next XPC message from stream 1.
    pub async fn recv_client_server(&mut self) -> Result<XpcMessage, XpcError> {
        self.inner.recv_client_server().await
    }
}

#[cfg(test)]
mod tests {
    use bytes::Bytes;
    use indexmap::IndexMap;
    use tokio::io::{duplex, AsyncReadExt, AsyncWriteExt};
    use tokio::time::{timeout, Duration};

    use super::*;
    use crate::xpc::message::{encode_message, flags, XpcMessage, XpcValue};

    const FRAME_DATA: u8 = 0x00;
    const FRAME_HEADERS: u8 = 0x01;
    const FRAME_SETTINGS: u8 = 0x04;
    const FLAG_END_HEADERS: u8 = 0x04;
    const FLAG_SETTINGS_ACK: u8 = 0x01;
    const STREAM_INIT: u32 = 0;
    const STREAM_CLIENT_SERVER: u32 = 1;
    const STREAM_SERVER_CLIENT: u32 = 3;

    fn build_frame(frame_type: u8, flags: u8, stream_id: u32, payload: &[u8]) -> Vec<u8> {
        let len = payload.len();
        let mut out = Vec::with_capacity(9 + len);
        out.push(((len >> 16) & 0xFF) as u8);
        out.push(((len >> 8) & 0xFF) as u8);
        out.push((len & 0xFF) as u8);
        out.push(frame_type);
        out.push(flags);
        out.extend_from_slice(&(stream_id & 0x7FFF_FFFF).to_be_bytes());
        out.extend_from_slice(payload);
        out
    }

    fn settings_frame() -> Vec<u8> {
        build_frame(FRAME_SETTINGS, 0, STREAM_INIT, &[])
    }

    fn settings_ack_frame() -> Vec<u8> {
        build_frame(FRAME_SETTINGS, FLAG_SETTINGS_ACK, STREAM_INIT, &[])
    }

    fn headers_frame(stream_id: u32) -> Vec<u8> {
        build_frame(FRAME_HEADERS, FLAG_END_HEADERS, stream_id, &[])
    }

    fn data_frame(stream_id: u32, payload: &[u8]) -> Vec<u8> {
        build_frame(FRAME_DATA, 0, stream_id, payload)
    }

    fn empty_message(flags: u32) -> Bytes {
        encode_message(&XpcMessage {
            flags,
            msg_id: 0,
            body: Some(XpcValue::Dictionary(IndexMap::new()))
                .filter(|_| flags == flags::ALWAYS_SET),
        })
        .expect("message should encode")
    }

    #[tokio::test]
    async fn connect_stream_bootstraps_remote_xpc_before_returning() {
        let (client, mut server) = duplex(4096);

        let msg1 = empty_message(flags::ALWAYS_SET);
        let msg2 = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET,
            msg_id: 0,
            body: None,
        })
        .expect("message should encode");
        let msg3 = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET,
            msg_id: 0,
            body: None,
        })
        .expect("message should encode");

        let server_task = tokio::spawn(async move {
            let mut preface = [0u8; 24];
            server.read_exact(&mut preface).await.unwrap();
            assert_eq!(&preface, crate::xpc::h2_raw::H2_PREFACE);

            let mut settings = [0u8; 21];
            server.read_exact(&mut settings).await.unwrap();
            assert_eq!(settings[3], FRAME_SETTINGS);

            let mut window_update = [0u8; 13];
            server.read_exact(&mut window_update).await.unwrap();
            assert_eq!(window_update[3], 0x08);

            server.write_all(&settings_frame()).await.unwrap();
            server.flush().await.unwrap();

            let mut ack = [0u8; 9];
            server.read_exact(&mut ack).await.unwrap();
            assert_eq!(ack, settings_ack_frame().as_slice());

            let mut cs_headers = [0u8; 9];
            server.read_exact(&mut cs_headers).await.unwrap();
            assert_eq!(cs_headers, headers_frame(STREAM_CLIENT_SERVER).as_slice());

            let mut cs_msg1_header = [0u8; 9];
            server.read_exact(&mut cs_msg1_header).await.unwrap();
            assert_eq!(cs_msg1_header[3], FRAME_DATA);
            let cs_msg1_len = ((cs_msg1_header[0] as usize) << 16)
                | ((cs_msg1_header[1] as usize) << 8)
                | (cs_msg1_header[2] as usize);
            let mut cs_msg1 = vec![0u8; cs_msg1_len];
            server.read_exact(&mut cs_msg1).await.unwrap();
            assert_eq!(cs_msg1, msg1);

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &msg2))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut sc_headers = [0u8; 9];
            server.read_exact(&mut sc_headers).await.unwrap();
            assert_eq!(sc_headers, headers_frame(STREAM_SERVER_CLIENT).as_slice());

            let mut sc_msg2_header = [0u8; 9];
            server.read_exact(&mut sc_msg2_header).await.unwrap();
            assert_eq!(sc_msg2_header[3], FRAME_DATA);
            let sc_msg2_len = ((sc_msg2_header[0] as usize) << 16)
                | ((sc_msg2_header[1] as usize) << 8)
                | (sc_msg2_header[2] as usize);
            let mut sc_msg2 = vec![0u8; sc_msg2_len];
            server.read_exact(&mut sc_msg2).await.unwrap();
            assert_eq!(
                decode_message_payload(&sc_msg2),
                (flags::INIT_HANDSHAKE | flags::ALWAYS_SET, 0)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &msg2))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut cs_msg3_header = [0u8; 9];
            server.read_exact(&mut cs_msg3_header).await.unwrap();
            assert_eq!(cs_msg3_header[3], FRAME_DATA);
            let cs_msg3_len = ((cs_msg3_header[0] as usize) << 16)
                | ((cs_msg3_header[1] as usize) << 8)
                | (cs_msg3_header[2] as usize);
            let mut cs_msg3 = vec![0u8; cs_msg3_len];
            server.read_exact(&mut cs_msg3).await.unwrap();
            assert_eq!(
                decode_message_payload(&cs_msg3),
                (flags::ALWAYS_SET | 0x200, 0)
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &msg3))
                .await
                .unwrap();
            server.flush().await.unwrap();
        });

        timeout(Duration::from_secs(1), XpcClient::connect_stream(client))
            .await
            .expect("connect timed out")
            .expect("connect should succeed");

        server_task.await.unwrap();
    }

    #[tokio::test]
    async fn call_sets_wanting_reply_on_outgoing_request() {
        let (client, mut server) = duplex(4096);

        let empty = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET,
            msg_id: 0,
            body: None,
        })
        .expect("message should encode");
        let reply = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET | flags::REPLY | flags::DATA,
            msg_id: 1,
            body: Some(XpcValue::Dictionary(IndexMap::new())),
        })
        .expect("message should encode");

        let server_task = tokio::spawn(async move {
            let mut preface = [0u8; 24];
            server.read_exact(&mut preface).await.unwrap();
            assert_eq!(&preface, crate::xpc::h2_raw::H2_PREFACE);

            let mut settings = [0u8; 21];
            server.read_exact(&mut settings).await.unwrap();
            assert_eq!(settings[3], FRAME_SETTINGS);

            let mut window_update = [0u8; 13];
            server.read_exact(&mut window_update).await.unwrap();
            assert_eq!(window_update[3], 0x08);

            server.write_all(&settings_frame()).await.unwrap();
            server.flush().await.unwrap();

            let mut ack = [0u8; 9];
            server.read_exact(&mut ack).await.unwrap();
            assert_eq!(ack, settings_ack_frame().as_slice());

            let mut cs_headers = [0u8; 9];
            server.read_exact(&mut cs_headers).await.unwrap();
            assert_eq!(cs_headers, headers_frame(STREAM_CLIENT_SERVER).as_slice());

            let mut cs_msg1_header = [0u8; 9];
            server.read_exact(&mut cs_msg1_header).await.unwrap();
            let cs_msg1_len = ((cs_msg1_header[0] as usize) << 16)
                | ((cs_msg1_header[1] as usize) << 8)
                | (cs_msg1_header[2] as usize);
            let mut cs_msg1 = vec![0u8; cs_msg1_len];
            server.read_exact(&mut cs_msg1).await.unwrap();
            assert_eq!(
                cs_msg1.as_slice(),
                empty_message(flags::ALWAYS_SET).as_ref()
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut sc_headers = [0u8; 9];
            server.read_exact(&mut sc_headers).await.unwrap();
            assert_eq!(sc_headers, headers_frame(STREAM_SERVER_CLIENT).as_slice());

            let mut sc_msg2_header = [0u8; 9];
            server.read_exact(&mut sc_msg2_header).await.unwrap();
            let sc_msg2_len = ((sc_msg2_header[0] as usize) << 16)
                | ((sc_msg2_header[1] as usize) << 8)
                | (sc_msg2_header[2] as usize);
            let mut sc_msg2 = vec![0u8; sc_msg2_len];
            server.read_exact(&mut sc_msg2).await.unwrap();
            assert_eq!(
                decode_message_payload(&sc_msg2),
                (flags::INIT_HANDSHAKE | flags::ALWAYS_SET, 0)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut cs_msg3_header = [0u8; 9];
            server.read_exact(&mut cs_msg3_header).await.unwrap();
            let cs_msg3_len = ((cs_msg3_header[0] as usize) << 16)
                | ((cs_msg3_header[1] as usize) << 8)
                | (cs_msg3_header[2] as usize);
            let mut cs_msg3 = vec![0u8; cs_msg3_len];
            server.read_exact(&mut cs_msg3).await.unwrap();
            assert_eq!(
                decode_message_payload(&cs_msg3),
                (flags::ALWAYS_SET | 0x200, 0)
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut request_header = [0u8; 9];
            server.read_exact(&mut request_header).await.unwrap();
            assert_eq!(request_header[3], FRAME_DATA);
            let request_len = ((request_header[0] as usize) << 16)
                | ((request_header[1] as usize) << 8)
                | (request_header[2] as usize);
            let mut request = vec![0u8; request_len];
            server.read_exact(&mut request).await.unwrap();
            assert_eq!(
                decode_message_payload(&request),
                (flags::ALWAYS_SET | flags::DATA | flags::WANTING_REPLY, 1)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &reply))
                .await
                .unwrap();
            server.flush().await.unwrap();
        });

        let mut client = timeout(Duration::from_secs(1), XpcClient::connect_stream(client))
            .await
            .expect("connect timed out")
            .expect("connect should succeed");

        let response = timeout(
            Duration::from_secs(1),
            client.call(XpcValue::Dictionary(IndexMap::new())),
        )
        .await
        .expect("call timed out")
        .expect("call should succeed");

        assert_eq!(
            response.flags,
            flags::ALWAYS_SET | flags::REPLY | flags::DATA
        );
        assert_eq!(response.msg_id, 1);

        server_task.await.unwrap();
    }

    #[tokio::test]
    async fn call_recv_client_server_reads_reply_from_stream_1() {
        let (client, mut server) = duplex(4096);

        let empty = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET,
            msg_id: 0,
            body: None,
        })
        .expect("message should encode");
        let reply = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET | flags::REPLY | flags::DATA,
            msg_id: 1,
            body: Some(XpcValue::Dictionary(IndexMap::from([(
                "FileList".to_string(),
                XpcValue::Array(vec![XpcValue::String("Documents".into())]),
            )]))),
        })
        .expect("message should encode");

        let server_task = tokio::spawn(async move {
            let mut preface = [0u8; 24];
            server.read_exact(&mut preface).await.unwrap();
            assert_eq!(&preface, crate::xpc::h2_raw::H2_PREFACE);

            let mut settings = [0u8; 21];
            server.read_exact(&mut settings).await.unwrap();
            assert_eq!(settings[3], FRAME_SETTINGS);

            let mut window_update = [0u8; 13];
            server.read_exact(&mut window_update).await.unwrap();
            assert_eq!(window_update[3], 0x08);

            server.write_all(&settings_frame()).await.unwrap();
            server.flush().await.unwrap();

            let mut ack = [0u8; 9];
            server.read_exact(&mut ack).await.unwrap();
            assert_eq!(ack, settings_ack_frame().as_slice());

            let mut cs_headers = [0u8; 9];
            server.read_exact(&mut cs_headers).await.unwrap();
            assert_eq!(cs_headers, headers_frame(STREAM_CLIENT_SERVER).as_slice());

            let mut cs_msg1_header = [0u8; 9];
            server.read_exact(&mut cs_msg1_header).await.unwrap();
            let cs_msg1_len = ((cs_msg1_header[0] as usize) << 16)
                | ((cs_msg1_header[1] as usize) << 8)
                | (cs_msg1_header[2] as usize);
            let mut cs_msg1 = vec![0u8; cs_msg1_len];
            server.read_exact(&mut cs_msg1).await.unwrap();
            assert_eq!(
                cs_msg1.as_slice(),
                empty_message(flags::ALWAYS_SET).as_ref()
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut sc_headers = [0u8; 9];
            server.read_exact(&mut sc_headers).await.unwrap();
            assert_eq!(sc_headers, headers_frame(STREAM_SERVER_CLIENT).as_slice());

            let mut sc_msg2_header = [0u8; 9];
            server.read_exact(&mut sc_msg2_header).await.unwrap();
            let sc_msg2_len = ((sc_msg2_header[0] as usize) << 16)
                | ((sc_msg2_header[1] as usize) << 8)
                | (sc_msg2_header[2] as usize);
            let mut sc_msg2 = vec![0u8; sc_msg2_len];
            server.read_exact(&mut sc_msg2).await.unwrap();
            assert_eq!(
                decode_message_payload(&sc_msg2),
                (flags::INIT_HANDSHAKE | flags::ALWAYS_SET, 0)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut cs_msg3_header = [0u8; 9];
            server.read_exact(&mut cs_msg3_header).await.unwrap();
            let cs_msg3_len = ((cs_msg3_header[0] as usize) << 16)
                | ((cs_msg3_header[1] as usize) << 8)
                | (cs_msg3_header[2] as usize);
            let mut cs_msg3 = vec![0u8; cs_msg3_len];
            server.read_exact(&mut cs_msg3).await.unwrap();
            assert_eq!(
                decode_message_payload(&cs_msg3),
                (flags::ALWAYS_SET | 0x200, 0)
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut request_header = [0u8; 9];
            server.read_exact(&mut request_header).await.unwrap();
            assert_eq!(request_header[3], FRAME_DATA);
            let request_len = ((request_header[0] as usize) << 16)
                | ((request_header[1] as usize) << 8)
                | (request_header[2] as usize);
            let mut request = vec![0u8; request_len];
            server.read_exact(&mut request).await.unwrap();
            assert_eq!(
                decode_message_payload(&request),
                (flags::ALWAYS_SET | flags::DATA | flags::WANTING_REPLY, 1)
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &reply))
                .await
                .unwrap();
            server.flush().await.unwrap();
        });

        let mut client = timeout(Duration::from_secs(1), XpcClient::connect_stream(client))
            .await
            .expect("connect timed out")
            .expect("connect should succeed");

        let response = timeout(
            Duration::from_secs(1),
            client.call_recv_client_server(XpcValue::Dictionary(IndexMap::new())),
        )
        .await
        .expect("call timed out")
        .expect("call should succeed");

        assert_eq!(response.msg_id, 1);
        let body = response.body.and_then(|value| match value {
            XpcValue::Dictionary(dict) => Some(dict),
            _ => None,
        });
        assert!(body.unwrap().contains_key("FileList"));

        server_task.await.unwrap();
    }

    #[tokio::test]
    async fn call_waits_for_matching_reply_id_and_buffers_early_replies() {
        let (client, mut server) = duplex(4096);

        let empty = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET,
            msg_id: 0,
            body: None,
        })
        .expect("message should encode");
        let early_reply = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET | flags::REPLY | flags::DATA,
            msg_id: 2,
            body: Some(XpcValue::Dictionary(IndexMap::from([(
                "kind".to_string(),
                XpcValue::String("early".into()),
            )]))),
        })
        .expect("message should encode");
        let matching_reply = encode_message(&XpcMessage {
            flags: flags::ALWAYS_SET | flags::REPLY | flags::DATA,
            msg_id: 1,
            body: Some(XpcValue::Dictionary(IndexMap::from([(
                "kind".to_string(),
                XpcValue::String("matching".into()),
            )]))),
        })
        .expect("message should encode");

        let server_task = tokio::spawn(async move {
            let mut preface = [0u8; 24];
            server.read_exact(&mut preface).await.unwrap();
            assert_eq!(&preface, crate::xpc::h2_raw::H2_PREFACE);

            let mut settings = [0u8; 21];
            server.read_exact(&mut settings).await.unwrap();
            assert_eq!(settings[3], FRAME_SETTINGS);

            let mut window_update = [0u8; 13];
            server.read_exact(&mut window_update).await.unwrap();
            assert_eq!(window_update[3], 0x08);

            server.write_all(&settings_frame()).await.unwrap();
            server.flush().await.unwrap();

            let mut ack = [0u8; 9];
            server.read_exact(&mut ack).await.unwrap();
            assert_eq!(ack, settings_ack_frame().as_slice());

            let mut cs_headers = [0u8; 9];
            server.read_exact(&mut cs_headers).await.unwrap();
            assert_eq!(cs_headers, headers_frame(STREAM_CLIENT_SERVER).as_slice());

            let mut cs_msg1_header = [0u8; 9];
            server.read_exact(&mut cs_msg1_header).await.unwrap();
            let cs_msg1_len = ((cs_msg1_header[0] as usize) << 16)
                | ((cs_msg1_header[1] as usize) << 8)
                | (cs_msg1_header[2] as usize);
            let mut cs_msg1 = vec![0u8; cs_msg1_len];
            server.read_exact(&mut cs_msg1).await.unwrap();
            assert_eq!(
                cs_msg1.as_slice(),
                empty_message(flags::ALWAYS_SET).as_ref()
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut sc_headers = [0u8; 9];
            server.read_exact(&mut sc_headers).await.unwrap();
            assert_eq!(sc_headers, headers_frame(STREAM_SERVER_CLIENT).as_slice());

            let mut sc_msg2_header = [0u8; 9];
            server.read_exact(&mut sc_msg2_header).await.unwrap();
            let sc_msg2_len = ((sc_msg2_header[0] as usize) << 16)
                | ((sc_msg2_header[1] as usize) << 8)
                | (sc_msg2_header[2] as usize);
            let mut sc_msg2 = vec![0u8; sc_msg2_len];
            server.read_exact(&mut sc_msg2).await.unwrap();
            assert_eq!(
                decode_message_payload(&sc_msg2),
                (flags::INIT_HANDSHAKE | flags::ALWAYS_SET, 0)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut cs_msg3_header = [0u8; 9];
            server.read_exact(&mut cs_msg3_header).await.unwrap();
            let cs_msg3_len = ((cs_msg3_header[0] as usize) << 16)
                | ((cs_msg3_header[1] as usize) << 8)
                | (cs_msg3_header[2] as usize);
            let mut cs_msg3 = vec![0u8; cs_msg3_len];
            server.read_exact(&mut cs_msg3).await.unwrap();
            assert_eq!(
                decode_message_payload(&cs_msg3),
                (flags::ALWAYS_SET | 0x200, 0)
            );

            server
                .write_all(&data_frame(STREAM_CLIENT_SERVER, &empty))
                .await
                .unwrap();
            server.flush().await.unwrap();

            let mut request_header = [0u8; 9];
            server.read_exact(&mut request_header).await.unwrap();
            assert_eq!(request_header[3], FRAME_DATA);
            let request_len = ((request_header[0] as usize) << 16)
                | ((request_header[1] as usize) << 8)
                | (request_header[2] as usize);
            let mut request = vec![0u8; request_len];
            server.read_exact(&mut request).await.unwrap();
            assert_eq!(
                decode_message_payload(&request),
                (flags::ALWAYS_SET | flags::DATA | flags::WANTING_REPLY, 1)
            );

            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &early_reply))
                .await
                .unwrap();
            server
                .write_all(&data_frame(STREAM_SERVER_CLIENT, &matching_reply))
                .await
                .unwrap();
            server.flush().await.unwrap();
        });

        let mut client = timeout(Duration::from_secs(1), XpcClient::connect_stream(client))
            .await
            .expect("connect timed out")
            .expect("connect should succeed");

        let response = timeout(
            Duration::from_secs(1),
            client.call(XpcValue::Dictionary(IndexMap::new())),
        )
        .await
        .expect("call timed out")
        .expect("call should succeed");

        assert_eq!(response.msg_id, 1);
        let response_kind = response
            .body
            .as_ref()
            .and_then(XpcValue::as_dict)
            .and_then(|dict| dict.get("kind"))
            .and_then(XpcValue::as_str);
        assert_eq!(response_kind, Some("matching"));

        let buffered = client.recv().await.expect("early reply should be buffered");
        assert_eq!(buffered.msg_id, 2);
        let buffered_kind = buffered
            .body
            .as_ref()
            .and_then(XpcValue::as_dict)
            .and_then(|dict| dict.get("kind"))
            .and_then(XpcValue::as_str);
        assert_eq!(buffered_kind, Some("early"));

        server_task.await.unwrap();
    }

    fn decode_message_payload(bytes: &[u8]) -> (u32, u64) {
        let msg = crate::xpc::message::decode_message(Bytes::copy_from_slice(bytes)).unwrap();
        (msg.flags, msg.msg_id)
    }
}