kdeconnect-embassy 0.2.0

An implementation of the IO abstraction required to run kdeconnect-proto on embedded devices using embassy
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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
use core::{
    cell::OnceCell,
    net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr},
    ops::ControlFlow,
    task::{Context, Poll},
};

use alloc::{boxed::Box, format, sync::Arc};
use embassy_executor::Spawner;
use embassy_net::{Stack, dns::DnsQueryType, udp::PacketMetadata};
use kdeconnect_proto::{
    device::Device,
    error::Result,
    io::{
        IoImpl, KnownFunctionName, TcpListenerImpl, TcpStreamImpl, TlsStreamImpl,
        UdpSocketImpl,
        rustls::{
            ClientConfig, CommonState, ServerConfig,
            client::UnbufferedClientConnection,
            pki_types::ServerName,
            server::UnbufferedServerConnection,
            unbuffered::{AppDataRecord, ConnectionState, UnbufferedStatus, WriteTraffic},
        },
    },
};

use crate::slot_list::SlotList;

/// The maximum number of devices that can be connected at once to this device.
///
/// It controls how much buffer memory is allocated.
///
/// Default value: 4 devices
/// Environment variable to set: KDECONNECT_MAX_SIMULTANEOUS_DEVICES
pub const MAX_SIMULTANEOUS_DEVICES: usize = const {
    if let Some(str_value) = option_env!("KDECONNECT_MAX_SIMULTANEOUS_DEVICES") {
        if let Ok(value) = usize::from_str_radix(str_value, 10) {
            value
        } else {
            panic!("Failed to parse environment variable `KDECONNECT_MAX_SIMULTANEOUS_DEVICES`");
        }
    } else {
        4
    }
};

const UDP_META_BUFFER_SIZE: usize = 8;

// Maximum size of the internal buffer used by UDP sockets
// If this value is less than kdeconnect_proto::config::UDP_BUFFER_SIZE, the packet contents will
// need to be read piece by piece
const UDP_BUFFER_SIZE: usize = 512;

// Maximum size of the internal buffer used by TCP sockets
// If this value is less than kdeconnect_proto::config::TCP_BUFFER_SIZE, the packet contents will
// need to be read piece by piece
const TCP_BUFFER_SIZE: usize = 2500;

// Maximum size of the internal buffer used by TLS sockets
// If this value is less than kdeconnect_proto::config::TLS_BUFFER_SIZE, the packet contents will
// need to be read piece by piece
const TLS_BUFFER_SIZE: usize = 3000;

const NUM_UDP_CONNS: usize = 2 + MAX_SIMULTANEOUS_DEVICES;
static mut UDP_BUFFERS: SlotList<([u8; UDP_BUFFER_SIZE], [u8; UDP_BUFFER_SIZE]), NUM_UDP_CONNS> =
    SlotList::new();
static mut UDP_META_BUFFERS: SlotList<
    (
        [PacketMetadata; UDP_META_BUFFER_SIZE],
        [PacketMetadata; UDP_META_BUFFER_SIZE],
    ),
    NUM_UDP_CONNS,
> = SlotList::new();

static mut TCP_BUFFERS: SlotList<
    ([u8; TCP_BUFFER_SIZE], [u8; TCP_BUFFER_SIZE]),
    MAX_SIMULTANEOUS_DEVICES,
> = SlotList::new();

static mut TLS_BUFFERS: SlotList<
    ([u8; TLS_BUFFER_SIZE], [u8; TLS_BUFFER_SIZE]),
    MAX_SIMULTANEOUS_DEVICES,
> = SlotList::new();

#[embassy_executor::task]
async fn exec_setup_udp(
    device: Arc<Device<EmbassyIoImpl, UdpSocket, TcpStream, TcpListener, TlsStream>>,
) {
    kdeconnect_proto::transport::udp::setup_udp(device).await
}

#[embassy_executor::task]
async fn exec_setup_mdns(
    device: Arc<Device<EmbassyIoImpl, UdpSocket, TcpStream, TcpListener, TlsStream>>,
) {
    kdeconnect_proto::transport::mdns::setup_mdns(device).await
}

#[embassy_executor::task]
async fn exec_setup_tcp(
    device: Arc<Device<EmbassyIoImpl, UdpSocket, TcpStream, TcpListener, TlsStream>>,
) {
    kdeconnect_proto::transport::tcp::setup_tcp(device).await
}

#[embassy_executor::task(pool_size = MAX_SIMULTANEOUS_DEVICES)]
async fn exec_per_tcp_stream(
    stream: TcpStream,
    device: Arc<Device<EmbassyIoImpl, UdpSocket, TcpStream, TcpListener, TlsStream>>,
) {
    kdeconnect_proto::transport::tcp::per_tcp_stream(stream, device).await
}

fn encrypt<Data>(
    buf: &[u8],
    may_encrypt: &mut WriteTraffic<'_, Data>,
    tls_tx_buffer: &mut [u8],
    tls_tx_used: &mut usize,
) -> bool {
    // TODO: avoid panicking on error
    let written = may_encrypt
        .encrypt(buf, &mut tls_tx_buffer[*tls_tx_used..])
        .expect("encrypted packet does not fit in `outgoing_tls`");
    *tls_tx_used += written;

    written != 0
}

pub struct EmbassyIoImpl {
    spawner: Spawner,
    stack: Stack<'static>,
    time_at_startup: OnceCell<u64>,
}

impl EmbassyIoImpl {
    pub fn new(spawner: Spawner, stack: Stack<'static>) -> Self {
        Self {
            spawner,
            stack,
            time_at_startup: OnceCell::new(),
        }
    }
}

impl IoImpl<UdpSocket, TcpStream, TcpListener, TlsStream> for EmbassyIoImpl {
    async fn bind_udp(&self, addr: SocketAddr) -> Result<UdpSocket> {
        let mut socket = UdpSocket::new(self.stack).ok_or("no udp connection slot remaining")?;
        let mut endpoint = embassy_net::IpListenEndpoint::from(addr);
        if addr.ip() == Ipv4Addr::UNSPECIFIED || addr.ip() == Ipv6Addr::UNSPECIFIED {
            endpoint.addr = None;
        }

        // TODO: error management
        socket.inner.bind(endpoint).unwrap();

        Ok(socket)
    }

    async fn bind_udp_reuse_v4(&self, addr: SocketAddr) -> Result<UdpSocket> {
        let mut socket = UdpSocket::new(self.stack).ok_or("no udp connection slot remaining")?;
        let mut endpoint = embassy_net::IpListenEndpoint::from(addr);
        if addr.ip() == Ipv4Addr::UNSPECIFIED || addr.ip() == Ipv6Addr::UNSPECIFIED {
            endpoint.addr = None;
        }

        socket.inner.bind(endpoint).unwrap();

        Ok(socket)
    }

    async fn bind_udp_reuse_multicast_v4(
        &self,
        addr: SocketAddr,
        multicast_addr: (Ipv4Addr, Ipv4Addr),
    ) -> Result<UdpSocket> {
        self.stack.join_multicast_group(multicast_addr.0).unwrap();
        let mut socket = UdpSocket::new(self.stack).ok_or("no udp connection slot remaining")?;
        let mut endpoint = embassy_net::IpListenEndpoint::from(addr);
        if addr.ip() == Ipv4Addr::UNSPECIFIED || addr.ip() == Ipv6Addr::UNSPECIFIED {
            endpoint.addr = None;
        }

        socket.inner.bind(endpoint).unwrap();

        Ok(socket)
    }

    async fn listen_tcp(&self, addr: SocketAddr) -> Result<TcpListener> {
        Ok(TcpListener::new(addr, self.stack))
    }

    async fn connect_tcp(&self, addr: SocketAddr) -> Result<TcpStream> {
        let mut stream = TcpStream::new(self.stack).ok_or("no tcp connection slot remaining")?;

        stream
            .inner
            .connect(embassy_net::IpEndpoint::from(addr))
            .await
            .unwrap();

        Ok(stream)
    }

    async fn accept_server_tls(
        &self,
        config: ServerConfig,
        stream: TcpStream,
    ) -> Result<TlsStream> {
        Ok(TlsStream::new(
            UnbufferedConnection::Server(
                UnbufferedServerConnection::new(Arc::new(config)).unwrap(),
            ),
            stream,
        )
        .ok_or("no tls connection slot remaining")?)
    }

    async fn connect_client_tls(
        &self,
        config: ClientConfig,
        server_name: ServerName<'static>,
        stream: TcpStream,
    ) -> Result<TlsStream> {
        Ok(TlsStream::new(
            UnbufferedConnection::Client(
                UnbufferedClientConnection::new(Arc::new(config), server_name).unwrap(),
            ),
            stream,
        )
        .ok_or("no tls connection slot remaining")?)
    }

    async fn get_host_addresses(&self) -> (Option<Ipv4Addr>, Option<Ipv6Addr>) {
        (
            self.stack.config_v4().map(|c| c.address.address()),
            self.stack.config_v6().map(|c| c.address.address()),
        )
    }

    async fn sleep(&self, duration: core::time::Duration) {
        embassy_time::Timer::after_millis(duration.as_millis() as u64).await;
    }

    fn spawn(
        &self,
        name: KnownFunctionName<TcpStream>,
        device: Arc<Device<Self, UdpSocket, TcpStream, TcpListener, TlsStream>>,
    ) {
        match name {
            KnownFunctionName::SetupUdp => {
                self.spawner
                    .spawn(exec_setup_udp(device))
                    .expect("failed to spawn setup udp task");
            }
            KnownFunctionName::SetupMdns => {
                self.spawner
                    .spawn(exec_setup_mdns(device))
                    .expect("failed to spawn setup mdns task");
            }
            KnownFunctionName::PerTcpStream(stream) => {
                self.spawner
                    .spawn(exec_per_tcp_stream(stream, device))
                    .expect("failed to spawn per tcp stream task");
            }
        };
    }

    fn start(
        &self,
        device: alloc::sync::Arc<Device<Self, UdpSocket, TcpStream, TcpListener, TlsStream>>,
    ) {
        self.spawner
            .spawn(exec_setup_tcp(device))
            .expect("failed to spawn setup tcp task");
    }

    async fn get_current_timestamp(&self) -> u64 {
        const NTP_SERVER_HOST: &str = "pool.ntp.org";
        const NTP_SERVER_PORT: u16 = 123;
        const NTP_TIMESTAMP_DELTA: u32 = 2_208_988_800;

        #[derive(PartialEq, Eq, Debug, Default, Clone)]
        #[repr(C)]
        struct NtpPacket {
            meta: u8,
            stratum: u8,
            poll: i8,
            precision: i8,
            root_delay: u32,
            root_dispersion: u32,
            reference_id: u32,
            reference_timestamp: u64,
            origin_timestamp: u64,
            receive_timestamp: u64,
            transmit_timestamp: u64,
        }

        impl NtpPacket {
            pub fn with_leap(mut self, leap: u8) -> Self {
                assert!(leap <= 0b11, "leap indicator should be two bytes at most");
                self.meta |= leap << 6;
                self
            }

            pub fn with_version(mut self, version: u8) -> Self {
                assert!(version <= 0b111, "version should be three bytes at most");
                self.meta |= version << 3;
                self
            }

            pub fn with_mode(mut self, mode: u8) -> Self {
                assert!(mode <= 0b111, "mode should be three bytes at most");
                self.meta |= mode;
                self
            }

            pub fn get_timestamp_seconds(&self) -> u32 {
                (self.transmit_timestamp >> 32) as u32 - NTP_TIMESTAMP_DELTA
            }

            pub fn deserialize(buf: [u8; 48]) -> Self {
                Self {
                    meta: buf[0],
                    stratum: buf[1],
                    poll: buf[2] as i8,
                    precision: buf[3] as i8,
                    root_delay: u32::from_be_bytes(buf[4..8].try_into().unwrap()),
                    root_dispersion: u32::from_be_bytes(buf[8..12].try_into().unwrap()),
                    reference_id: u32::from_be_bytes(buf[12..16].try_into().unwrap()),
                    reference_timestamp: u64::from_be_bytes(buf[16..24].try_into().unwrap()),
                    origin_timestamp: u64::from_be_bytes(buf[24..32].try_into().unwrap()),
                    receive_timestamp: u64::from_be_bytes(buf[32..40].try_into().unwrap()),
                    transmit_timestamp: u64::from_be_bytes(buf[40..48].try_into().unwrap()),
                }
            }

            pub fn serialize(self) -> [u8; 48] {
                let mut tmp_buf = [0u8; size_of::<NtpPacket>()];
                tmp_buf[0] = self.meta;
                tmp_buf[1] = self.stratum;
                tmp_buf[2] = self.poll as u8;
                tmp_buf[3] = self.precision as u8;
                tmp_buf[4..8].copy_from_slice(&self.root_delay.to_be_bytes());
                tmp_buf[8..12].copy_from_slice(&self.root_dispersion.to_be_bytes());
                tmp_buf[12..16].copy_from_slice(&self.reference_id.to_be_bytes());
                tmp_buf[16..24].copy_from_slice(&self.reference_timestamp.to_be_bytes());
                tmp_buf[24..32].copy_from_slice(&self.origin_timestamp.to_be_bytes());
                tmp_buf[32..40].copy_from_slice(&self.receive_timestamp.to_be_bytes());
                tmp_buf[40..48].copy_from_slice(&self.transmit_timestamp.to_be_bytes());
                tmp_buf
            }
        }

        let time_at_startup = if let Some(time_at_startup) = self.time_at_startup.get() {
            *time_at_startup
        } else {
            let mut rx_meta = [PacketMetadata::EMPTY; 16];
            let mut rx_buffer = [0; 4096];
            let mut tx_meta = [PacketMetadata::EMPTY; 16];
            let mut tx_buffer = [0; 4096];

            let mut socket = embassy_net::udp::UdpSocket::new(
                self.stack,
                &mut rx_meta,
                &mut rx_buffer,
                &mut tx_meta,
                &mut tx_buffer,
            );
            socket.bind(0).unwrap();

            let ntp_addrs = self
                .stack
                .dns_query(NTP_SERVER_HOST, DnsQueryType::A)
                .await
                .expect("failed to resolve DNS to connect to the NTP server");
            if ntp_addrs.is_empty() {
                log::error!("failed to resolve DNS to connect to the NTP server");
                return 0;
            }

            let addr = SocketAddr::from((IpAddr::from(ntp_addrs[0]), NTP_SERVER_PORT));

            let buf = NtpPacket::default()
                .with_leap(0)
                .with_version(4)
                .with_mode(3)
                .serialize();
            socket.send_to(&buf, addr).await.unwrap();

            let mut buf = [0; 48];
            socket.recv_from(&mut buf).await.unwrap();

            let packet = NtpPacket::deserialize(buf);
            let timestamp = packet.get_timestamp_seconds();
            log::info!("NTP server successfully queried, current timestamp: {timestamp}");

            let time_at_startup = timestamp as u64 - embassy_time::Instant::now().as_secs();
            // If this function is called twice asynchronously, the set can happen twice
            // so the error in this case should be ignored
            let _ = self.time_at_startup.set(time_at_startup);
            time_at_startup
        };

        time_at_startup + embassy_time::Instant::now().as_secs()
    }
}

pub struct UdpSocket {
    inner: embassy_net::udp::UdpSocket<'static>,
    udp_buffer_index: usize,
    udp_meta_buffer_index: usize,
}

impl UdpSocket {
    fn new(stack: Stack<'static>) -> Option<Self> {
        let Some((udp_buffer_index, (udp_rx_buffer, udp_tx_buffer))) = (unsafe {
            #[allow(static_mut_refs)]
            UDP_BUFFERS.insert_in_free_slot(([0; UDP_BUFFER_SIZE], [0; UDP_BUFFER_SIZE]))
        }) else {
            log::warn!(
                "no udp connection slot remaining: the maximum number of simultaneously connected devices is reached"
            );
            return None;
        };

        let Some((udp_meta_buffer_index, (udp_rx_meta_buffer, udp_tx_meta_buffer))) = (unsafe {
            #[allow(static_mut_refs)]
            UDP_META_BUFFERS.insert_in_free_slot((
                [PacketMetadata::EMPTY; UDP_META_BUFFER_SIZE],
                [PacketMetadata::EMPTY; UDP_META_BUFFER_SIZE],
            ))
        }) else {
            log::warn!(
                "no udp metadata connection slot remaining: the maximum number of simultaneously connected devices is reached"
            );
            return None;
        };

        let inner = embassy_net::udp::UdpSocket::new(
            stack,
            udp_rx_meta_buffer,
            udp_rx_buffer,
            udp_tx_meta_buffer,
            udp_tx_buffer,
        );

        Some(Self {
            inner,
            udp_buffer_index,
            udp_meta_buffer_index,
        })
    }
}

impl Drop for UdpSocket {
    fn drop(&mut self) {
        #[allow(static_mut_refs)]
        unsafe {
            UDP_BUFFERS.free_slot(self.udp_buffer_index);
            UDP_META_BUFFERS.free_slot(self.udp_meta_buffer_index);
        }
    }
}

impl UdpSocketImpl for UdpSocket {
    fn set_broadcast(&self, _on: bool) -> Result<()> {
        // Nothing to do
        Ok(())
    }

    fn poll_recv(&self, cx: &mut Context, buf: &mut [u8]) -> Poll<Result<()>> {
        match self.inner.poll_recv_from(buf, cx) {
            Poll::Ready(Ok(_)) => Poll::Ready(Ok(())),
            Poll::Ready(Err(e)) => Poll::Ready(Err(format!("{e:?}").into())),
            Poll::Pending => Poll::Pending,
        }
    }

    async fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)> {
        match self.inner.recv_from(buf).await {
            Ok(r) => {
                let endpoint = r.1.endpoint;
                let ip = match endpoint.addr {
                    embassy_net::IpAddress::Ipv4(ipv4_addr) => IpAddr::V4(ipv4_addr),
                    embassy_net::IpAddress::Ipv6(ipv6_addr) => IpAddr::V6(ipv6_addr),
                };
                Ok((r.0, SocketAddr::new(ip, endpoint.port)))
            }
            Err(e) => Err(format!("{e:?}").into()),
        }
    }

    async fn send_to(&mut self, buf: &[u8], addr: SocketAddr) -> Result<usize> {
        // TODO: how to get the number of bytes written?
        match self.inner.send_to(buf, addr).await {
            Ok(_) => {
                self.inner.flush().await;
                Ok(buf.len())
            }
            Err(e) => Err(format!("{e:?}").into()),
        }
    }
}

pub struct TcpStream {
    inner: embassy_net::tcp::TcpSocket<'static>,
    tcp_buffer_index: usize,
}

impl TcpStream {
    pub fn new(stack: Stack<'static>) -> Option<Self> {
        let Some((tcp_buffer_index, (tcp_rx_buffer, tcp_tx_buffer))) = (unsafe {
            #[allow(static_mut_refs)]
            TCP_BUFFERS.insert_in_free_slot(([0; TCP_BUFFER_SIZE], [0; TCP_BUFFER_SIZE]))
        }) else {
            log::warn!(
                "no tcp connection slot remaining: the maximum number of simultaneously connected devices is reached"
            );
            return None;
        };

        let inner = embassy_net::tcp::TcpSocket::new(stack, tcp_rx_buffer, tcp_tx_buffer);

        Some(Self {
            inner,
            tcp_buffer_index,
        })
    }
}

impl Drop for TcpStream {
    fn drop(&mut self) {
        #[allow(static_mut_refs)]
        unsafe {
            TCP_BUFFERS.free_slot(self.tcp_buffer_index);
        }
    }
}

impl TcpStreamImpl for TcpStream {
    async fn read(&mut self, buf: &mut [u8]) -> Result<usize> {
        self.inner
            .read(buf)
            .await
            .map_err(|e| format!("{e:?}").into())
    }

    async fn writable(&self) -> Result<()> {
        self.inner.wait_write_ready().await;
        Ok(())
    }

    async fn write_all(&mut self, src: &[u8]) -> Result<()> {
        match self.inner.write(src).await {
            Ok(_) => Ok(()),
            Err(e) => Err(format!("{e:?}").into()),
        }
    }
}

enum UnbufferedConnection {
    Client(UnbufferedClientConnection),
    Server(UnbufferedServerConnection),
}

#[allow(clippy::too_many_arguments)]
async fn handle_tls_state<T>(
    discard: &mut usize,
    state: ConnectionState<'_, '_, T>,
    tls_tx_buffer: &mut [u8],
    tls_tx_used: &mut usize,
    tls_rx_buffer: &mut [u8],
    tls_rx_used: &mut usize,
    socket: &mut embassy_net::tcp::TcpSocket<'static>,
    mut buf_read: Option<&mut [u8]>,
    buf_write: Option<&[u8]>,
) -> ControlFlow<Result<usize>> {
    match state {
        // Used for handshaking
        ConnectionState::EncodeTlsData(mut state) => {
            let len = state.encode(&mut tls_tx_buffer[*tls_tx_used..]).unwrap();
            *tls_tx_used += len;
        }
        ConnectionState::TransmitTlsData(state) => {
            match socket.write(&tls_tx_buffer[..*tls_tx_used]).await {
                Ok(_) => *tls_tx_used = 0,
                Err(e) => return ControlFlow::Break(Err(Box::new(e))),
            }
            state.done();
        }
        ConnectionState::BlockedHandshake { .. } => {
            // NOTE: `tls_rx_buffer` starts at `tls_rx_used`, because it was splitted before calling the
            // function, because `state` mutably depends on the slice of `tls_rx_buffer` before `tls_rx_used`
            match socket.read(tls_rx_buffer).await {
                Ok(read) => *tls_rx_used += read,
                Err(e) => return ControlFlow::Break(Err(Box::new(e))),
            }
        }

        // Used for the application data
        ConnectionState::ReadTraffic(mut state) => {
            let mut total_len = 0;

            while let Some(res) = state.next_record() {
                let AppDataRecord {
                    discard: new_discard,
                    payload,
                    ..
                } = res.unwrap();
                *discard += new_discard;

                if let Some(buf) = buf_read.as_mut() {
                    // TODO: make sure the buffer has enough space
                    let len = payload.len();
                    buf[total_len..total_len + len].copy_from_slice(payload);
                    total_len += len;
                }
            }

            if buf_read.is_some() {
                return ControlFlow::Break(Ok(total_len));
            } else {
                log::warn!("Ready to read traffic but no read buffer given");
            }
        }
        ConnectionState::WriteTraffic(mut may_encrypt) => {
            if let Some(buf) = buf_write
                && encrypt(buf, &mut may_encrypt, tls_tx_buffer, tls_tx_used)
            {
                match socket.write(&tls_tx_buffer[..*tls_tx_used]).await {
                    Ok(n) => {
                        *tls_tx_used = 0;
                        return ControlFlow::Break(Ok(n));
                    }
                    Err(e) => return ControlFlow::Break(Err(Box::new(e))),
                }
            }

            // NOTE: `tls_rx_buffer` starts at `tls_rx_used`, because it was splitted before calling the
            // function, because `state` mutably depends on the slice of `tls_rx_buffer` before `tls_rx_used`
            if buf_read.is_some() {
                match socket.read(tls_rx_buffer).await {
                    Ok(read) => {
                        if read == 0 {
                            return ControlFlow::Break(Ok(0));
                        }

                        *tls_rx_used += read;
                    }
                    Err(e) => return ControlFlow::Break(Err(Box::new(e))),
                }
            }
        }
        ConnectionState::Closed | ConnectionState::PeerClosed => {
            // TODO: should we return an error?
            return ControlFlow::Break(Ok(0));
        }
        _ => log::warn!("Unhandled TLS state: {state:?}"),
    }

    ControlFlow::Continue(())
}

pub struct TlsStream {
    inner: UnbufferedConnection,
    stream: TcpStream,
    tls_buffer_index: usize,
    tls_rx_buffer: &'static mut [u8; TLS_BUFFER_SIZE],
    tls_tx_buffer: &'static mut [u8; TLS_BUFFER_SIZE],
    tls_rx_used: usize,
    tls_tx_used: usize,
}

impl TlsStream {
    fn new(inner: UnbufferedConnection, stream: TcpStream) -> Option<Self> {
        let Some((tls_buffer_index, (tls_rx_buffer, tls_tx_buffer))) = (unsafe {
            #[allow(static_mut_refs)]
            TLS_BUFFERS.insert_in_free_slot(([0; TLS_BUFFER_SIZE], [0; TLS_BUFFER_SIZE]))
        }) else {
            log::warn!(
                "no tls connection slot remaining: the maximum number of simultaneously connected devices is reached"
            );
            return None;
        };

        Some(Self {
            inner,
            stream,
            tls_buffer_index,
            tls_rx_buffer,
            tls_tx_buffer,
            tls_rx_used: 0,
            tls_tx_used: 0,
        })
    }
}

impl Drop for TlsStream {
    fn drop(&mut self) {
        #[allow(static_mut_refs)]
        unsafe {
            TLS_BUFFERS.free_slot(self.tls_buffer_index);
        }
    }
}

impl TlsStreamImpl for TlsStream {
    fn get_common_state(&self) -> &CommonState {
        match &self.inner {
            UnbufferedConnection::Client(conn) => conn as &CommonState,
            UnbufferedConnection::Server(conn) => conn as &CommonState,
        }
    }

    async fn read(&mut self, buf: &mut [u8]) -> Result<usize> {
        loop {
            let (tls_rx_buffer_used, tls_rx_buffer_free) =
                self.tls_rx_buffer.split_at_mut(self.tls_rx_used);

            let (res, discard) = match &mut self.inner {
                UnbufferedConnection::Client(conn) => {
                    let UnbufferedStatus {
                        mut discard, state, ..
                    } = conn.process_tls_records(tls_rx_buffer_used);

                    let res = handle_tls_state(
                        &mut discard,
                        state.unwrap(),
                        self.tls_tx_buffer,
                        &mut self.tls_tx_used,
                        tls_rx_buffer_free,
                        &mut self.tls_rx_used,
                        &mut self.stream.inner,
                        Some(buf),
                        None,
                    )
                    .await;
                    (res, discard)
                }
                UnbufferedConnection::Server(conn) => {
                    let UnbufferedStatus {
                        mut discard, state, ..
                    } = conn.process_tls_records(tls_rx_buffer_used);

                    let res = handle_tls_state(
                        &mut discard,
                        state.unwrap(),
                        self.tls_tx_buffer,
                        &mut self.tls_tx_used,
                        tls_rx_buffer_free,
                        &mut self.tls_rx_used,
                        &mut self.stream.inner,
                        Some(buf),
                        None,
                    )
                    .await;
                    (res, discard)
                }
            };

            // Handle discard
            if discard != 0 {
                assert!(discard <= self.tls_rx_used);

                self.tls_rx_buffer.copy_within(discard..self.tls_rx_used, 0);
                self.tls_rx_used -= discard;
            }

            if let ControlFlow::Break(v) = res {
                break v;
            }

            embassy_time::Timer::after_millis(100).await;
        }
    }

    async fn write_all(&mut self, src: &[u8]) -> Result<()> {
        loop {
            let (tls_rx_buffer_used, tls_rx_buffer_free) =
                self.tls_rx_buffer.split_at_mut(self.tls_rx_used);

            let (res, discard) = match &mut self.inner {
                UnbufferedConnection::Client(conn) => {
                    let UnbufferedStatus {
                        mut discard, state, ..
                    } = conn.process_tls_records(tls_rx_buffer_used);

                    let res = handle_tls_state(
                        &mut discard,
                        state.unwrap(),
                        self.tls_tx_buffer,
                        &mut self.tls_tx_used,
                        tls_rx_buffer_free,
                        &mut self.tls_rx_used,
                        &mut self.stream.inner,
                        None,
                        Some(src),
                    )
                    .await;
                    (res, discard)
                }
                UnbufferedConnection::Server(conn) => {
                    let UnbufferedStatus {
                        mut discard, state, ..
                    } = conn.process_tls_records(tls_rx_buffer_used);

                    let res = handle_tls_state(
                        &mut discard,
                        state.unwrap(),
                        self.tls_tx_buffer,
                        &mut self.tls_tx_used,
                        tls_rx_buffer_free,
                        &mut self.tls_rx_used,
                        &mut self.stream.inner,
                        None,
                        Some(src),
                    )
                    .await;
                    (res, discard)
                }
            };

            // Handle discard
            if discard != 0 {
                assert!(discard <= self.tls_rx_used);

                self.tls_rx_buffer.copy_within(discard..self.tls_rx_used, 0);
                self.tls_rx_used -= discard;
            }

            if let ControlFlow::Break(_) = res {
                break Ok(());
            }

            embassy_time::Timer::after_millis(100).await;
        }
    }
}

pub struct TcpListener {
    addr: SocketAddr,
    stack: Stack<'static>,
}

impl TcpListener {
    pub fn new(addr: SocketAddr, stack: Stack<'static>) -> Self {
        Self { addr, stack }
    }
}

impl TcpListenerImpl<TcpStream> for TcpListener {
    async fn accept(&self) -> Result<TcpStream> {
        let mut stream = TcpStream::new(self.stack).ok_or("no tcp connection slot remaining")?;
        let mut endpoint = embassy_net::IpListenEndpoint::from(self.addr);
        if self.addr.ip() == Ipv4Addr::UNSPECIFIED || self.addr.ip() == Ipv6Addr::UNSPECIFIED {
            endpoint.addr = None;
        }

        stream.inner.accept(endpoint).await.unwrap();
        Ok(stream)
    }
}