pb-mapper-protocol 0.5.0

Message framing and authenticated sessions for pb-mapper
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
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
use bytes::Bytes;
use snafu::ResultExt;
use std::future::Future;
use std::pin::Pin;
use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::time::Instant;

use super::{
    CodecMessageReader, CodecMessageWriter, MessageReader, MessageWriter, NormalMessageReader,
    NormalMessageWriter,
};
use crate::buffer::{BufferReader, BufferedReader};
use pb_mapper_core::checksum::AesKeyType;
use pb_mapper_core::codec::{Decryptor, Encryptor};
use pb_mapper_core::config::duration_from_env;
use pb_mapper_core::error::{FwdNetworkWriteWithNormalSnafu, Result};
use pb_mapper_core::snafu_error_get_or_return_ok;
use uni_stream::stream::{StreamSplit, TcpStreamImpl, UdpStreamImpl};
use uni_stream::udp::{UdpStreamReadHalf, UdpStreamWriteHalf};

pub trait ForwardReader {
    async fn read(&mut self) -> Result<&'_ [u8]>;
}

pub trait ForwardWriter {
    async fn write(&mut self, src: &[u8]) -> Result<()>;

    // Gracefully close the write side to support half-closed TCP streams.
    async fn shutdown(&mut self);
}

pub trait DatagramReader {
    async fn recv(&mut self) -> Result<Bytes>;
}

pub trait DatagramWriter {
    async fn send(&mut self, src: &[u8]) -> Result<()>;
}

const DEFAULT_TUNNEL_IDLE_TIMEOUT: Duration = Duration::from_secs(60 * 60);
const DEFAULT_HALF_CLOSE_IDLE_TIMEOUT: Duration = Duration::from_secs(60);
const PB_MAPPER_TUNNEL_IDLE_TIMEOUT: &str = "PB_MAPPER_TUNNEL_IDLE_TIMEOUT";
const PB_MAPPER_HALF_CLOSE_IDLE_TIMEOUT: &str = "PB_MAPPER_HALF_CLOSE_IDLE_TIMEOUT";

#[derive(Debug, Clone, Copy)]
struct ForwardTimeoutConfig {
    tunnel_idle_timeout: Duration,
    half_close_idle_timeout: Duration,
}

impl ForwardTimeoutConfig {
    fn from_env() -> Self {
        Self {
            tunnel_idle_timeout: duration_from_env(
                PB_MAPPER_TUNNEL_IDLE_TIMEOUT,
                DEFAULT_TUNNEL_IDLE_TIMEOUT,
            ),
            half_close_idle_timeout: duration_from_env(
                PB_MAPPER_HALF_CLOSE_IDLE_TIMEOUT,
                DEFAULT_HALF_CLOSE_IDLE_TIMEOUT,
            ),
        }
    }
}

pub struct NormalForwardReader<'a, T> {
    buffered_reader: BufferReader<'a, T>,
}

impl<'a, T: AsyncReadExt + Unpin + Send> NormalForwardReader<'a, T> {
    pub fn new(reader: &'a mut T) -> Self {
        Self {
            buffered_reader: BufferReader::new(reader),
        }
    }
}

impl<'a, T: AsyncReadExt + Unpin + Send> ForwardReader for NormalForwardReader<'a, T> {
    async fn read(&mut self) -> Result<&'_ [u8]> {
        self.buffered_reader.read().await
    }
}

pub struct NormalDatagramReader<'a, T: AsyncReadExt + Unpin> {
    reader: NormalMessageReader<'a, T>,
}

impl<'a, T: AsyncReadExt + Unpin + Send> NormalDatagramReader<'a, T> {
    pub fn new(reader: &'a mut T) -> Self {
        Self {
            reader: NormalMessageReader::new(reader),
        }
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self {
            reader: self.reader.with_checksum_key(key),
        }
    }
}

impl<'a, T: AsyncReadExt + Unpin + Send> DatagramReader for NormalDatagramReader<'a, T> {
    async fn recv(&mut self) -> Result<Bytes> {
        let msg = self.reader.read_msg().await?;
        Ok(Bytes::copy_from_slice(msg))
    }
}

pub struct NormalForwardWriter<'a, T> {
    writer: &'a mut T,
}

impl<'a, T: AsyncWriteExt + Unpin + Send> NormalForwardWriter<'a, T> {
    pub fn new(writer: &'a mut T) -> Self {
        Self { writer }
    }

    async fn write_inner(&mut self, src: &[u8]) -> Result<()> {
        self.writer
            .write_all(src)
            .await
            .context(FwdNetworkWriteWithNormalSnafu)
    }
}

impl<'a, T: AsyncWriteExt + Unpin + Send> ForwardWriter for NormalForwardWriter<'a, T> {
    async fn write(&mut self, src: &[u8]) -> Result<()> {
        self.write_inner(src).await
    }

    async fn shutdown(&mut self) {
        let _ = self.writer.shutdown().await;
    }
}

pub struct NormalDatagramWriter<'a, T: AsyncWriteExt + Unpin> {
    writer: NormalMessageWriter<'a, T>,
}

impl<'a, T: AsyncWriteExt + Unpin + Send> NormalDatagramWriter<'a, T> {
    pub fn new(writer: &'a mut T) -> Self {
        Self {
            writer: NormalMessageWriter::new(writer),
        }
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self {
            writer: self.writer.with_checksum_key(key),
        }
    }
}

impl<'a, T: AsyncWriteExt + Unpin + Send> DatagramWriter for NormalDatagramWriter<'a, T> {
    async fn send(&mut self, src: &[u8]) -> Result<()> {
        self.writer.write_msg(src).await
    }
}

pub struct CodecForwardReader<'a, T: AsyncReadExt + Unpin + Send, D: Decryptor>(
    CodecMessageReader<'a, T, D>,
);

impl<'a, T: AsyncReadExt + Send + Unpin, D: Decryptor> CodecForwardReader<'a, T, D> {
    pub fn new(reader: &'a mut T, decryptor: D) -> Self {
        Self(CodecMessageReader::new(reader, decryptor))
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self(self.0.with_checksum_key(key))
    }
}

impl<'a, T: AsyncReadExt + Send + Unpin, D: Decryptor> ForwardReader
    for CodecForwardReader<'a, T, D>
{
    async fn read(&mut self) -> Result<&'_ [u8]> {
        self.0.read_msg().await
    }
}

pub struct CodecDatagramReader<'a, T: AsyncReadExt + Unpin + Send, D: Decryptor>(
    CodecMessageReader<'a, T, D>,
);

impl<'a, T: AsyncReadExt + Send + Unpin, D: Decryptor> CodecDatagramReader<'a, T, D> {
    pub fn new(reader: &'a mut T, decryptor: D) -> Self {
        Self(CodecMessageReader::new(reader, decryptor))
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self(self.0.with_checksum_key(key))
    }
}

impl<'a, T: AsyncReadExt + Send + Unpin, D: Decryptor> DatagramReader
    for CodecDatagramReader<'a, T, D>
{
    async fn recv(&mut self) -> Result<Bytes> {
        let msg = self.0.read_msg().await?;
        Ok(Bytes::copy_from_slice(msg))
    }
}

pub struct CodecForwardWriter<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor>(
    CodecMessageWriter<'a, T, E>,
);

impl<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor> CodecForwardWriter<'a, T, E> {
    pub fn new(writer: &'a mut T, encryptor: E) -> Self {
        Self(CodecMessageWriter::new(writer, encryptor))
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self(self.0.with_checksum_key(key))
    }
}

impl<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor> ForwardWriter
    for CodecForwardWriter<'a, T, E>
{
    /// SAFETY: Same as [`CodecMessageWriter`]
    async fn write(&mut self, src: &[u8]) -> Result<()> {
        self.0.write_msg(src).await
    }

    async fn shutdown(&mut self) {
        let _ = self.0.shutdown().await;
    }
}

pub struct CodecDatagramWriter<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor>(
    CodecMessageWriter<'a, T, E>,
);

impl<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor> CodecDatagramWriter<'a, T, E> {
    pub fn new(writer: &'a mut T, encryptor: E) -> Self {
        Self(CodecMessageWriter::new(writer, encryptor))
    }

    pub fn with_checksum_key(self, key: AesKeyType) -> Self {
        Self(self.0.with_checksum_key(key))
    }
}

impl<'a, T: AsyncWriteExt + Send + Unpin, E: Encryptor> DatagramWriter
    for CodecDatagramWriter<'a, T, E>
{
    async fn send(&mut self, src: &[u8]) -> Result<()> {
        let buf = src.to_vec();
        self.0.write_msg(&buf).await
    }
}

pub async fn copy<R: ForwardReader, W: ForwardWriter>(
    mut reader: R,
    mut writer: W,
) -> Result<usize> {
    let mut length: usize = 0;
    loop {
        let src = reader.read().await?;
        let n = src.len();
        if n == 0 {
            break;
        }
        writer.write(src).await?;
        length += n;
    }
    writer.shutdown().await;
    Ok(length)
}

pub async fn transfer_datagrams<R: DatagramReader, W: DatagramWriter>(
    label: &'static str,
    mut reader: R,
    mut writer: W,
) -> Result<usize> {
    let mut _length: usize = 0;
    loop {
        let src = reader.recv().await?;
        let n = src.len();
        tracing::debug!("datagram forward {label} {n} bytes");
        writer.send(&src).await?;
        _length += n;
    }
}

pub async fn start_forward<
    ClientReader: ForwardReader,
    ClientWriter: ForwardWriter,
    ServerReader: ForwardReader,
    ServerWriter: ForwardWriter,
>(
    client_reader: ClientReader,
    client_writer: ClientWriter,
    server_reader: ServerReader,
    server_writer: ServerWriter,
) {
    start_forward_with_config(
        client_reader,
        client_writer,
        server_reader,
        server_writer,
        ForwardTimeoutConfig::from_env(),
    )
    .await
}

#[derive(Default)]
struct ForwardDirectionState {
    len: usize,
    result: Option<Result<usize>>,
}

impl ForwardDirectionState {
    fn is_done(&self) -> bool {
        self.result.is_some()
    }
}

#[derive(Clone, Copy)]
struct ForwardActivity {
    bytes: usize,
    at: Instant,
}

async fn copy_with_activity<R: ForwardReader, W: ForwardWriter>(
    mut reader: R,
    mut writer: W,
    activity_tx: tokio::sync::mpsc::UnboundedSender<ForwardActivity>,
) -> Result<usize> {
    let mut length = 0;
    loop {
        let src = reader.read().await?;
        let n = src.len();
        if n == 0 {
            break;
        }
        writer.write(src).await?;
        length += n;
        let _ = activity_tx.send(ForwardActivity {
            bytes: n,
            at: Instant::now(),
        });
    }
    writer.shutdown().await;
    Ok(length)
}

async fn start_forward_with_config<
    ClientReader: ForwardReader,
    ClientWriter: ForwardWriter,
    ServerReader: ForwardReader,
    ServerWriter: ForwardWriter,
>(
    client_reader: ClientReader,
    client_writer: ClientWriter,
    server_reader: ServerReader,
    server_writer: ServerWriter,
    timeout_config: ForwardTimeoutConfig,
) {
    let tunnel_idle_enabled = !timeout_config.tunnel_idle_timeout.is_zero();
    let half_close_idle_enabled = !timeout_config.half_close_idle_timeout.is_zero();
    let tunnel_idle_sleep = tokio::time::sleep(timeout_config.tunnel_idle_timeout);
    let half_close_idle_sleep = tokio::time::sleep(timeout_config.half_close_idle_timeout);
    tokio::pin!(tunnel_idle_sleep);
    tokio::pin!(half_close_idle_sleep);

    let (client_activity_tx, mut client_activity_rx) = tokio::sync::mpsc::unbounded_channel();
    let (server_activity_tx, mut server_activity_rx) = tokio::sync::mpsc::unbounded_channel();
    // Keep each direction as one pinned future. Recreating a combined read/write future in every
    // `select!` iteration can cancel it after the read consumed bytes but before the write
    // completed, silently dropping a response tail when the peer direction finishes first.
    let client_to_server = copy_with_activity(client_reader, server_writer, client_activity_tx);
    let server_to_client = copy_with_activity(server_reader, client_writer, server_activity_tx);
    tokio::pin!(client_to_server);
    tokio::pin!(server_to_client);

    let mut client_state = ForwardDirectionState::default();
    let mut server_state = ForwardDirectionState::default();

    loop {
        let client_done = client_state.is_done();
        let server_done = server_state.is_done();
        let half_closed = client_done ^ server_done;
        if client_done && server_done {
            break;
        }

        tokio::select! {
            biased;

            result = &mut client_to_server, if !client_done => {
                let failed = result.is_err();
                client_state.result = Some(result);
                reset_sleep(&mut half_close_idle_sleep, timeout_config.half_close_idle_timeout);
                if failed {
                    break;
                }
            }
            result = &mut server_to_client, if !server_done => {
                let failed = result.is_err();
                server_state.result = Some(result);
                reset_sleep(&mut half_close_idle_sleep, timeout_config.half_close_idle_timeout);
                if failed {
                    break;
                }
            }
            Some(activity) = client_activity_rx.recv(), if !client_done => {
                record_forward_activity(
                    activity,
                    &mut client_state,
                    &mut tunnel_idle_sleep,
                    timeout_config.tunnel_idle_timeout,
                    &mut half_close_idle_sleep,
                    timeout_config.half_close_idle_timeout,
                    server_done,
                );
            }
            Some(activity) = server_activity_rx.recv(), if !server_done => {
                record_forward_activity(
                    activity,
                    &mut server_state,
                    &mut tunnel_idle_sleep,
                    timeout_config.tunnel_idle_timeout,
                    &mut half_close_idle_sleep,
                    timeout_config.half_close_idle_timeout,
                    client_done,
                );
            }
            _ = &mut tunnel_idle_sleep, if tunnel_idle_enabled && !half_closed => {
                tracing::debug!(
                    "forward tunnel idle timeout after {:?}",
                    timeout_config.tunnel_idle_timeout
                );
                break;
            }
            _ = &mut half_close_idle_sleep, if half_close_idle_enabled && half_closed => {
                tracing::debug!(
                    "forward half-close idle timeout after {:?}",
                    timeout_config.half_close_idle_timeout
                );
                break;
            }
        }
    }

    let client_len = client_state.len;
    let server_len = server_state.len;
    handle_forward_final_result(client_state.result, client_len, "client->server");
    handle_forward_final_result(server_state.result, server_len, "server->client");
}

fn record_forward_activity(
    activity: ForwardActivity,
    state: &mut ForwardDirectionState,
    tunnel_idle_sleep: &mut Pin<&mut tokio::time::Sleep>,
    tunnel_idle_timeout: Duration,
    half_close_idle_sleep: &mut Pin<&mut tokio::time::Sleep>,
    half_close_idle_timeout: Duration,
    peer_done: bool,
) {
    state.len += activity.bytes;
    reset_sleep_at(tunnel_idle_sleep, tunnel_idle_timeout, activity.at);
    if peer_done {
        reset_sleep_at(half_close_idle_sleep, half_close_idle_timeout, activity.at);
    }
}

fn reset_sleep(sleep: &mut Pin<&mut tokio::time::Sleep>, timeout: Duration) {
    if !timeout.is_zero() {
        sleep.as_mut().reset(Instant::now() + timeout);
    }
}

fn reset_sleep_at(
    sleep: &mut Pin<&mut tokio::time::Sleep>,
    timeout: Duration,
    activity_at: Instant,
) {
    if !timeout.is_zero() {
        sleep.as_mut().reset(activity_at + timeout);
    }
}

fn handle_forward_final_result(result: Option<Result<usize>>, len: usize, detail: &'static str) {
    if let Some(result) = result {
        handle_forward_result(result, detail);
    } else {
        tracing::debug!("forward stopped before peer closed; we send {len} bytes,detail:{detail}");
    }
}

pub async fn start_datagram_forward<
    ClientReader: DatagramReader,
    ClientWriter: DatagramWriter,
    ServerReader: DatagramReader,
    ServerWriter: DatagramWriter,
>(
    client_reader: ClientReader,
    client_writer: ClientWriter,
    server_reader: ServerReader,
    server_writer: ServerWriter,
) {
    let client_to_server = transfer_datagrams("udp->tcp", client_reader, server_writer);
    let server_to_client = transfer_datagrams("tcp->udp", server_reader, client_writer);
    tokio::select! {
        result = client_to_server =>{
            handle_forward_result( result,"udp->tcp");
        },
        result = server_to_client =>{
            handle_forward_result( result,"tcp->udp");
        }
    }
}

fn handle_forward_result(result: Result<usize>, detail: &'static str) {
    match result {
        Ok(len) => tracing::info!("forward finish! we send {len} bytes,detail:{detail}"),
        Err(e) => {
            // Treat peer-initiated shutdowns as expected to avoid noisy error logs.
            if e.is_expected_disconnect() {
                tracing::debug!("forward closed by peer:{e},detail:{detail}");
            } else {
                tracing::error!("got forward error:{e},detail:{detail}");
            }
        }
    }
}

impl DatagramReader for UdpStreamReadHalf {
    async fn recv(&mut self) -> Result<Bytes> {
        self.recv_datagram()
            .await
            .map_err(|e| pb_mapper_core::error::Error::MsgForward {
                action: "read",
                source: e,
            })
    }
}

impl DatagramWriter for UdpStreamWriteHalf<'_> {
    async fn send(&mut self, src: &[u8]) -> Result<()> {
        self.send_datagram(src)
            .await
            .map_err(|e| pb_mapper_core::error::Error::MsgForward {
                action: "write",
                source: e,
            })
    }
}

pub trait StreamForward: StreamSplit + Sized {
    fn forward_local_to_remote<'a, R, W>(
        codec_key: Option<AesKeyType>,
        framing_key: AesKeyType,
        local_reader: Self::ReaderRef<'a>,
        local_writer: Self::WriterRef<'a>,
        remote_reader: R,
        remote_writer: W,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>>
    where
        R: AsyncReadExt + Unpin + Send + 'a,
        W: AsyncWriteExt + Unpin + Send + 'a;
}

impl StreamForward for TcpStreamImpl {
    fn forward_local_to_remote<'a, R, W>(
        codec_key: Option<AesKeyType>,
        framing_key: AesKeyType,
        local_reader: Self::ReaderRef<'a>,
        local_writer: Self::WriterRef<'a>,
        remote_reader: R,
        remote_writer: W,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>>
    where
        R: AsyncReadExt + Unpin + Send + 'a,
        W: AsyncWriteExt + Unpin + Send + 'a,
    {
        Box::pin(async move {
            let mut local_reader = local_reader;
            let mut local_writer = local_writer;
            let mut remote_reader = remote_reader;
            let mut remote_writer = remote_writer;
            match codec_key {
                Some(key) => {
                    start_forward(
                        NormalForwardReader::new(&mut local_reader),
                        NormalForwardWriter::new(&mut local_writer),
                        CodecForwardReader::new(
                            &mut remote_reader,
                            snafu_error_get_or_return_ok!(
                                super::get_decodec(&key),
                                "failed to create decoder when remote forward"
                            ),
                        )
                        .with_checksum_key(framing_key),
                        CodecForwardWriter::new(
                            &mut remote_writer,
                            snafu_error_get_or_return_ok!(
                                super::get_encodec(&key),
                                "failed to create encoder when remote forward"
                            ),
                        )
                        .with_checksum_key(framing_key),
                    )
                    .await;
                }
                None => {
                    start_forward(
                        NormalForwardReader::new(&mut local_reader),
                        NormalForwardWriter::new(&mut local_writer),
                        NormalForwardReader::new(&mut remote_reader),
                        NormalForwardWriter::new(&mut remote_writer),
                    )
                    .await;
                }
            }
            Ok(())
        })
    }
}

impl StreamForward for UdpStreamImpl {
    fn forward_local_to_remote<'a, R, W>(
        codec_key: Option<AesKeyType>,
        framing_key: AesKeyType,
        local_reader: Self::ReaderRef<'a>,
        local_writer: Self::WriterRef<'a>,
        remote_reader: R,
        remote_writer: W,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>>
    where
        R: AsyncReadExt + Unpin + Send + 'a,
        W: AsyncWriteExt + Unpin + Send + 'a,
    {
        Box::pin(async move {
            let mut remote_reader = remote_reader;
            let mut remote_writer = remote_writer;
            match codec_key {
                Some(key) => {
                    start_datagram_forward(
                        local_reader,
                        local_writer,
                        CodecDatagramReader::new(
                            &mut remote_reader,
                            snafu_error_get_or_return_ok!(
                                super::get_decodec(&key),
                                "failed to create decoder when datagram forward"
                            ),
                        )
                        .with_checksum_key(framing_key),
                        CodecDatagramWriter::new(
                            &mut remote_writer,
                            snafu_error_get_or_return_ok!(
                                super::get_encodec(&key),
                                "failed to create encoder when datagram forward"
                            ),
                        )
                        .with_checksum_key(framing_key),
                    )
                    .await;
                }
                None => {
                    start_datagram_forward(
                        local_reader,
                        local_writer,
                        NormalDatagramReader::new(&mut remote_reader)
                            .with_checksum_key(framing_key),
                        NormalDatagramWriter::new(&mut remote_writer)
                            .with_checksum_key(framing_key),
                    )
                    .await;
                }
            }
            Ok(())
        })
    }
}

#[cfg(test)]
mod tests {
    use std::collections::VecDeque;
    use std::io;
    use std::sync::Arc;

    use parking_lot::Mutex;
    use std::time::Duration;

    use super::*;
    use pb_mapper_core::config::parse_duration;
    use pb_mapper_core::error::Error;
    use tokio::sync::Notify;

    enum ReadAction {
        Data(Vec<u8>),
        Eof,
        Pending,
        Error(io::ErrorKind),
    }

    struct ScriptedReader {
        actions: VecDeque<ReadAction>,
        current: Vec<u8>,
    }

    impl ScriptedReader {
        fn new(actions: impl IntoIterator<Item = ReadAction>) -> Self {
            Self {
                actions: actions.into_iter().collect(),
                current: Vec::new(),
            }
        }
    }

    impl ForwardReader for ScriptedReader {
        async fn read(&mut self) -> Result<&'_ [u8]> {
            match self.actions.pop_front().unwrap_or(ReadAction::Pending) {
                ReadAction::Data(data) => {
                    self.current = data;
                    Ok(&self.current)
                }
                ReadAction::Eof => {
                    self.current.clear();
                    Ok(&self.current)
                }
                ReadAction::Pending => std::future::pending().await,
                ReadAction::Error(kind) => Err(Error::MsgForward {
                    action: "read",
                    source: io::Error::new(kind, "scripted read error"),
                }),
            }
        }
    }

    #[derive(Default)]
    struct WriterState {
        chunks: Vec<Vec<u8>>,
        shutdowns: usize,
    }

    #[derive(Clone, Default)]
    struct ScriptedWriter {
        state: Arc<Mutex<WriterState>>,
    }

    impl ScriptedWriter {
        fn chunks(&self) -> Vec<Vec<u8>> {
            self.state.lock().chunks.clone()
        }

        fn shutdowns(&self) -> usize {
            self.state.lock().shutdowns
        }
    }

    impl ForwardWriter for ScriptedWriter {
        async fn write(&mut self, src: &[u8]) -> Result<()> {
            self.state.lock().chunks.push(src.to_vec());
            Ok(())
        }

        async fn shutdown(&mut self) {
            self.state.lock().shutdowns += 1;
        }
    }

    struct EofAfterWriteStartsReader {
        write_started: Arc<Notify>,
        returned_eof: bool,
        empty: Vec<u8>,
    }

    impl EofAfterWriteStartsReader {
        fn new(write_started: Arc<Notify>) -> Self {
            Self {
                write_started,
                returned_eof: false,
                empty: Vec::new(),
            }
        }
    }

    impl ForwardReader for EofAfterWriteStartsReader {
        async fn read(&mut self) -> Result<&'_ [u8]> {
            if self.returned_eof {
                return std::future::pending().await;
            }
            self.write_started.notified().await;
            self.returned_eof = true;
            Ok(&self.empty)
        }
    }

    #[derive(Clone)]
    struct DelayedWriter {
        state: Arc<Mutex<WriterState>>,
        write_started: Arc<Notify>,
        delay: Duration,
    }

    impl DelayedWriter {
        fn new(write_started: Arc<Notify>, delay: Duration) -> Self {
            Self {
                state: Arc::new(Mutex::new(WriterState::default())),
                write_started,
                delay,
            }
        }

        fn chunks(&self) -> Vec<Vec<u8>> {
            self.state.lock().chunks.clone()
        }
    }

    impl ForwardWriter for DelayedWriter {
        async fn write(&mut self, src: &[u8]) -> Result<()> {
            self.write_started.notify_one();
            tokio::time::sleep(self.delay).await;
            self.state.lock().chunks.push(src.to_vec());
            Ok(())
        }

        async fn shutdown(&mut self) {
            self.state.lock().shutdowns += 1;
        }
    }

    #[test]
    fn parse_duration_accepts_suffixes_and_plain_seconds() {
        assert_eq!(parse_duration("42"), Some(Duration::from_secs(42)));
        assert_eq!(parse_duration("500ms"), Some(Duration::from_millis(500)));
        assert_eq!(parse_duration("2s"), Some(Duration::from_secs(2)));
        assert_eq!(parse_duration("3m"), Some(Duration::from_secs(180)));
        assert_eq!(parse_duration("1h"), Some(Duration::from_secs(3600)));
        assert_eq!(parse_duration(""), None);
        assert_eq!(parse_duration("bad"), None);
        assert_eq!(parse_duration("18446744073709551615h"), None);
    }

    #[tokio::test]
    async fn half_close_idle_timeout_closes_stalled_peer() {
        let client_reader = ScriptedReader::new([ReadAction::Eof]);
        let client_writer = ScriptedWriter::default();
        let server_reader = ScriptedReader::new([ReadAction::Pending]);
        let server_writer = ScriptedWriter::default();
        let server_writer_state = server_writer.clone();

        tokio::time::timeout(
            Duration::from_millis(200),
            start_forward_with_config(
                client_reader,
                client_writer,
                server_reader,
                server_writer,
                ForwardTimeoutConfig {
                    tunnel_idle_timeout: Duration::from_secs(60 * 60),
                    half_close_idle_timeout: Duration::from_millis(20),
                },
            ),
        )
        .await
        .expect("half-closed tunnel did not stop after half-close idle timeout");

        assert_eq!(server_writer_state.shutdowns(), 1);
    }

    #[tokio::test]
    async fn expected_disconnect_stops_waiting_for_pending_peer() {
        let client_reader =
            ScriptedReader::new([ReadAction::Error(io::ErrorKind::ConnectionReset)]);
        let client_writer = ScriptedWriter::default();
        let server_reader = ScriptedReader::new([ReadAction::Pending]);
        let server_writer = ScriptedWriter::default();

        tokio::time::timeout(
            Duration::from_millis(200),
            start_forward_with_config(
                client_reader,
                client_writer,
                server_reader,
                server_writer,
                ForwardTimeoutConfig {
                    tunnel_idle_timeout: Duration::from_secs(60 * 60),
                    half_close_idle_timeout: Duration::from_secs(60),
                },
            ),
        )
        .await
        .expect("expected disconnect did not stop the tunnel");
    }

    #[tokio::test]
    async fn half_closed_tunnel_drains_peer_before_timeout() {
        let client_reader = ScriptedReader::new([ReadAction::Eof]);
        let client_writer = ScriptedWriter::default();
        let client_writer_state = client_writer.clone();
        let server_reader =
            ScriptedReader::new([ReadAction::Data(b"response".to_vec()), ReadAction::Eof]);
        let server_writer = ScriptedWriter::default();

        tokio::time::timeout(
            Duration::from_millis(200),
            start_forward_with_config(
                client_reader,
                client_writer,
                server_reader,
                server_writer,
                ForwardTimeoutConfig {
                    tunnel_idle_timeout: Duration::from_secs(60 * 60),
                    half_close_idle_timeout: Duration::from_millis(200),
                },
            ),
        )
        .await
        .expect("half-closed tunnel failed to drain the peer");

        assert_eq!(client_writer_state.chunks(), vec![b"response".to_vec()]);
        assert_eq!(client_writer_state.shutdowns(), 1);
    }

    #[tokio::test]
    async fn delayed_tail_write_survives_peer_half_close() {
        let write_started = Arc::new(Notify::new());
        let client_reader = EofAfterWriteStartsReader::new(write_started.clone());
        let client_writer = DelayedWriter::new(write_started, Duration::from_millis(20));
        let client_writer_state = client_writer.clone();
        let tail = vec![0x5a; 499];
        let server_reader = ScriptedReader::new([ReadAction::Data(tail.clone()), ReadAction::Eof]);
        let server_writer = ScriptedWriter::default();

        tokio::time::timeout(
            Duration::from_millis(300),
            start_forward_with_config(
                client_reader,
                client_writer,
                server_reader,
                server_writer,
                ForwardTimeoutConfig {
                    tunnel_idle_timeout: Duration::from_secs(60 * 60),
                    half_close_idle_timeout: Duration::from_millis(200),
                },
            ),
        )
        .await
        .expect("delayed response tail was lost after the peer half-closed");

        assert_eq!(client_writer_state.chunks(), vec![tail]);
    }

    #[tokio::test]
    async fn open_tunnel_idle_timeout_closes_inactive_tunnel() {
        let client_reader = ScriptedReader::new([ReadAction::Pending]);
        let client_writer = ScriptedWriter::default();
        let server_reader = ScriptedReader::new([ReadAction::Pending]);
        let server_writer = ScriptedWriter::default();

        tokio::time::timeout(
            Duration::from_millis(200),
            start_forward_with_config(
                client_reader,
                client_writer,
                server_reader,
                server_writer,
                ForwardTimeoutConfig {
                    tunnel_idle_timeout: Duration::from_millis(20),
                    half_close_idle_timeout: Duration::from_secs(60),
                },
            ),
        )
        .await
        .expect("inactive open tunnel did not stop after tunnel idle timeout");
    }
}