zlayer-overlay 0.10.80

Encrypted overlay networking for containers using boringtun userspace WireGuard
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
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
//! Custom `ZLayer` relay protocol client.
//!
//! Implements a lightweight relay client using BLAKE2b-256 authentication
//! instead of full RFC 5766 TURN. `ZLayer` nodes only talk to other `ZLayer`
//! nodes, so standard TURN interoperability is unnecessary.
//!
//! # Protocol
//!
//! All messages are big-endian:
//! - Header: 1 byte type + 2 bytes payload length + payload
//! - Control types: `AllocateReq`(0x01), `AllocateResp`(0x02), `AllocateErr`(0x03),
//!   `PermissionReq`(0x04), `PermissionResp`(0x05), `RefreshReq`(0x06),
//!   `RefreshResp`(0x07), `Deallocate`(0x08)
//! - Data type: `Data`(0x80) -- 1 byte type + 2 bytes length + 6 bytes peer addr
//!   (4 IPv4 + 2 port) + raw data
//!
//! # Authentication
//!
//! BLAKE2b-256 MAC. Key = BLAKE2b-256(credential). Auth tag =
//! `Blake2bMac256`(key, `message_bytes_before_tag`). The 32-byte tag is
//! appended to control messages.

use crate::error::OverlayError;
use crate::nat::candidate::{Candidate, CandidateType};
use crate::nat::config::TurnServerConfig;

use std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4};
use std::sync::Arc;
use std::time::Instant;

use blake2::digest::consts::U32;
use blake2::digest::{Digest, KeyInit, Mac};
use blake2::{Blake2b, Blake2bMac};
use tokio::net::UdpSocket;
use tracing::{debug, warn};

// ---- Protocol message types ------------------------------------------------

/// Control message types for the `ZLayer` relay protocol.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MsgType {
    AllocateReq = 0x01,
    AllocateResp = 0x02,
    AllocateErr = 0x03,
    PermissionReq = 0x04,
    PermissionResp = 0x05,
    RefreshReq = 0x06,
    RefreshResp = 0x07,
    Deallocate = 0x08,
    Data = 0x80,
}

impl MsgType {
    /// Parse a byte into a message type.
    #[must_use]
    pub fn from_byte(b: u8) -> Option<Self> {
        match b {
            0x01 => Some(Self::AllocateReq),
            0x02 => Some(Self::AllocateResp),
            0x03 => Some(Self::AllocateErr),
            0x04 => Some(Self::PermissionReq),
            0x05 => Some(Self::PermissionResp),
            0x06 => Some(Self::RefreshReq),
            0x07 => Some(Self::RefreshResp),
            0x08 => Some(Self::Deallocate),
            0x80 => Some(Self::Data),
            _ => None,
        }
    }
}

/// BLAKE2b-256 MAC type alias.
type Blake2bMac256 = Blake2bMac<U32>;

/// BLAKE2b-256 hash type alias.
type Blake2b256 = Blake2b<U32>;

/// Size of the BLAKE2b-256 auth tag appended to control messages.
pub(crate) const AUTH_TAG_LEN: usize = 32;

/// Minimum relay protocol header: 1 byte type + 2 bytes length.
pub(crate) const HEADER_LEN: usize = 3;

/// Size of an encoded IPv4 peer address (4 IP + 2 port).
pub(crate) const PEER_ADDR_LEN: usize = 6;

/// Size of a family-tagged IPv4 peer address (1 family + 4 IP + 2 port).
pub(crate) const PEER_ADDR_V4_TAGGED_LEN: usize = 7;

/// Size of a family-tagged IPv6 peer address (1 family + 16 IP + 2 port).
pub(crate) const PEER_ADDR_V6_TAGGED_LEN: usize = 19;

// ---- Auth helpers -----------------------------------------------------------

/// Derive an auth key from a credential string via BLAKE2b-256 hashing.
#[must_use]
pub fn derive_auth_key(credential: &str) -> [u8; 32] {
    let hash = Blake2b256::digest(credential.as_bytes());
    let mut key = [0u8; 32];
    key.copy_from_slice(&hash);
    key
}

/// Compute a BLAKE2b-256 MAC tag over `data` using `key`.
///
/// # Panics
///
/// Panics if BLAKE2b-256 MAC initialization fails (should never happen with a 32-byte key).
#[must_use]
pub fn compute_auth_tag(key: &[u8; 32], data: &[u8]) -> [u8; 32] {
    let mut mac = <Blake2bMac256 as KeyInit>::new_from_slice(key)
        .expect("BLAKE2bMac256 accepts 32-byte keys");
    mac.update(data);
    let result = mac.finalize();
    let mut tag = [0u8; 32];
    tag.copy_from_slice(&result.into_bytes());
    tag
}

/// Verify a BLAKE2b-256 MAC tag. Returns `true` if valid.
///
/// # Panics
///
/// Panics if BLAKE2b-256 MAC initialization fails (should never happen with a 32-byte key).
#[must_use]
pub fn verify_auth_tag(key: &[u8; 32], data: &[u8], tag: &[u8]) -> bool {
    let mut mac = <Blake2bMac256 as KeyInit>::new_from_slice(key)
        .expect("BLAKE2bMac256 accepts 32-byte keys");
    mac.update(data);
    mac.verify_slice(tag).is_ok()
}

// ---- Message building / parsing helpers ------------------------------------

/// Encode a `SocketAddrV4` into 6 bytes (4 IP + 2 port, big-endian).
#[must_use]
pub fn encode_addr_v4(addr: SocketAddrV4) -> [u8; PEER_ADDR_LEN] {
    let mut buf = [0u8; PEER_ADDR_LEN];
    buf[..4].copy_from_slice(&addr.ip().octets());
    buf[4..6].copy_from_slice(&addr.port().to_be_bytes());
    buf
}

/// Decode a `SocketAddrV4` from 6 bytes (4 IP + 2 port, big-endian).
#[must_use]
pub fn decode_addr_v4(buf: &[u8]) -> Option<SocketAddrV4> {
    if buf.len() < PEER_ADDR_LEN {
        return None;
    }
    let ip = Ipv4Addr::new(buf[0], buf[1], buf[2], buf[3]);
    let port = u16::from_be_bytes([buf[4], buf[5]]);
    Some(SocketAddrV4::new(ip, port))
}

/// Encode a `SocketAddr` (IPv4 or IPv6) into a family-tagged byte sequence.
///
/// Layout: `[family: 1] [ip: 4 or 16] [port: 2]`
///   - Family 0x01 = IPv4 (total 7 bytes)
///   - Family 0x02 = IPv6 (total 19 bytes)
#[must_use]
pub fn encode_addr(addr: SocketAddr) -> Vec<u8> {
    match addr {
        SocketAddr::V4(v4) => {
            let mut buf = Vec::with_capacity(PEER_ADDR_V4_TAGGED_LEN);
            buf.push(0x01); // IPv4 family
            buf.extend_from_slice(&v4.ip().octets());
            buf.extend_from_slice(&v4.port().to_be_bytes());
            buf
        }
        SocketAddr::V6(v6) => {
            let mut buf = Vec::with_capacity(PEER_ADDR_V6_TAGGED_LEN);
            buf.push(0x02); // IPv6 family
            buf.extend_from_slice(&v6.ip().octets());
            buf.extend_from_slice(&v6.port().to_be_bytes());
            buf
        }
    }
}

/// Decode a family-tagged `SocketAddr` from bytes.
///
/// Returns `(decoded_addr, bytes_consumed)` or `None` if the buffer is too short
/// or the family byte is unrecognized.
#[must_use]
pub fn decode_addr(buf: &[u8]) -> Option<(SocketAddr, usize)> {
    if buf.is_empty() {
        return None;
    }
    match buf[0] {
        0x01 => {
            // IPv4: 1 family + 4 IP + 2 port = 7 bytes
            if buf.len() < PEER_ADDR_V4_TAGGED_LEN {
                return None;
            }
            let ip = Ipv4Addr::new(buf[1], buf[2], buf[3], buf[4]);
            let port = u16::from_be_bytes([buf[5], buf[6]]);
            Some((SocketAddr::new(ip.into(), port), PEER_ADDR_V4_TAGGED_LEN))
        }
        0x02 => {
            // IPv6: 1 family + 16 IP + 2 port = 19 bytes
            if buf.len() < PEER_ADDR_V6_TAGGED_LEN {
                return None;
            }
            let mut ip_bytes = [0u8; 16];
            ip_bytes.copy_from_slice(&buf[1..17]);
            let ip = Ipv6Addr::from(ip_bytes);
            let port = u16::from_be_bytes([buf[17], buf[18]]);
            Some((SocketAddr::new(ip.into(), port), PEER_ADDR_V6_TAGGED_LEN))
        }
        _ => None,
    }
}

/// Build an authenticated control message.
///
/// Layout: `[type: 1] [payload_len: 2] [payload] [auth_tag: 32]`
///
/// The auth tag covers `[type + payload_len + payload]`.
#[must_use]
#[allow(clippy::cast_possible_truncation)]
pub fn build_control_msg(msg_type: MsgType, payload: &[u8], key: &[u8; 32]) -> Vec<u8> {
    let payload_len = payload.len() as u16;
    let total = HEADER_LEN + payload.len() + AUTH_TAG_LEN;
    let mut buf = Vec::with_capacity(total);
    buf.push(msg_type as u8);
    buf.extend_from_slice(&payload_len.to_be_bytes());
    buf.extend_from_slice(payload);

    // Auth tag covers everything before the tag itself
    let tag = compute_auth_tag(key, &buf);
    buf.extend_from_slice(&tag);
    buf
}

/// Build a DATA message (no auth tag needed -- relay already authenticated).
///
/// Layout: `[0x80: 1] [length: 2] [peer_addr: 6] [raw_data]`
///
/// This function accepts only IPv4 addresses. For dual-stack support, use
/// [`build_data_msg_tagged`].
#[must_use]
#[allow(clippy::cast_possible_truncation)]
pub fn build_data_msg(peer_addr: SocketAddrV4, data: &[u8]) -> Vec<u8> {
    let inner_len = (PEER_ADDR_LEN + data.len()) as u16;
    let total = HEADER_LEN + PEER_ADDR_LEN + data.len();
    let mut buf = Vec::with_capacity(total);
    buf.push(MsgType::Data as u8);
    buf.extend_from_slice(&inner_len.to_be_bytes());
    buf.extend_from_slice(&encode_addr_v4(peer_addr));
    buf.extend_from_slice(data);
    buf
}

/// Build a DATA message with family-tagged peer address (IPv4 or IPv6).
///
/// Layout: `[0x80: 1] [length: 2] [peer_addr: 7 or 19] [raw_data]`
#[must_use]
#[allow(clippy::cast_possible_truncation)]
pub fn build_data_msg_tagged(peer_addr: SocketAddr, data: &[u8]) -> Vec<u8> {
    let encoded_addr = encode_addr(peer_addr);
    let inner_len = (encoded_addr.len() + data.len()) as u16;
    let total = HEADER_LEN + encoded_addr.len() + data.len();
    let mut buf = Vec::with_capacity(total);
    buf.push(MsgType::Data as u8);
    buf.extend_from_slice(&inner_len.to_be_bytes());
    buf.extend_from_slice(&encoded_addr);
    buf.extend_from_slice(data);
    buf
}

/// Parse a relay protocol message header. Returns (type, payload).
///
/// For control messages, the payload includes the auth tag at the end.
/// For data messages, the payload includes the peer addr + raw data.
#[must_use]
pub fn parse_msg(buf: &[u8]) -> Option<(MsgType, &[u8])> {
    if buf.len() < HEADER_LEN {
        return None;
    }
    let msg_type = MsgType::from_byte(buf[0])?;
    let payload_len = u16::from_be_bytes([buf[1], buf[2]]) as usize;
    let expected = HEADER_LEN + payload_len;

    if msg_type == MsgType::Data {
        // Data messages have no auth tag
        if buf.len() < expected {
            return None;
        }
        Some((msg_type, &buf[HEADER_LEN..expected]))
    } else {
        // Control messages have a 32-byte auth tag after the payload
        let expected_with_tag = expected + AUTH_TAG_LEN;
        if buf.len() < expected_with_tag {
            return None;
        }
        Some((msg_type, &buf[HEADER_LEN..expected_with_tag]))
    }
}

/// Parse and verify a control message. Returns the payload (without auth tag).
#[must_use]
pub fn parse_and_verify_control(buf: &[u8], key: &[u8; 32]) -> Option<(MsgType, Vec<u8>)> {
    if buf.len() < HEADER_LEN {
        return None;
    }
    let msg_type = MsgType::from_byte(buf[0])?;
    if msg_type == MsgType::Data {
        return None; // Data messages are not control messages
    }
    let payload_len = u16::from_be_bytes([buf[1], buf[2]]) as usize;
    let msg_end = HEADER_LEN + payload_len;
    let total_end = msg_end + AUTH_TAG_LEN;

    if buf.len() < total_end {
        return None;
    }

    let msg_bytes = &buf[..msg_end];
    let tag = &buf[msg_end..total_end];

    if !verify_auth_tag(key, msg_bytes, tag) {
        return None;
    }

    Some((msg_type, buf[HEADER_LEN..msg_end].to_vec()))
}

/// Parse a DATA message payload into `(peer_addr, raw_data)`.
///
/// Expects the legacy 6-byte untagged IPv4 encoding. For dual-stack
/// payloads, use [`parse_data_payload_tagged`].
#[must_use]
pub fn parse_data_payload(payload: &[u8]) -> Option<(SocketAddrV4, &[u8])> {
    if payload.len() < PEER_ADDR_LEN {
        return None;
    }
    let addr = decode_addr_v4(&payload[..PEER_ADDR_LEN])?;
    Some((addr, &payload[PEER_ADDR_LEN..]))
}

/// Parse a family-tagged DATA message payload into `(peer_addr, raw_data)`.
///
/// Supports both IPv4 (family 0x01) and IPv6 (family 0x02) peer addresses.
#[must_use]
pub fn parse_data_payload_tagged(payload: &[u8]) -> Option<(SocketAddr, &[u8])> {
    let (addr, consumed) = decode_addr(payload)?;
    Some((addr, &payload[consumed..]))
}

// ---- Relay allocation -------------------------------------------------------

/// Active relay allocation state.
#[allow(clippy::struct_field_names)]
struct RelayAllocation {
    /// The address the relay server allocated for us.
    relay_addr: SocketAddr,
    /// Server-assigned allocation ID (16 bytes).
    allocation_id: [u8; 16],
    /// When this allocation expires.
    expires_at: Instant,
    /// Allocation lifetime in seconds.
    lifetime_secs: u32,
}

// ---- Relay client -----------------------------------------------------------

/// Client for the `ZLayer` custom relay protocol.
///
/// Connects to a relay server, allocates a relay address, and runs a local
/// UDP proxy that bridges `WireGuard` traffic through the relay.
pub struct RelayClient {
    server_addr: SocketAddr,
    username: String,
    auth_key: [u8; 32],
    allocation: Option<RelayAllocation>,
    socket: Option<Arc<UdpSocket>>,
    local_proxy_addr: Option<SocketAddr>,
    proxy_handle: Option<tokio::task::JoinHandle<()>>,
}

impl RelayClient {
    /// Create a new relay client from a turn server config.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] if the server address cannot be parsed.
    pub fn new(config: &TurnServerConfig) -> Result<Self, OverlayError> {
        let server_addr: SocketAddr = config
            .address
            .parse()
            .map_err(|e| OverlayError::TurnRelay(format!("Invalid relay server address: {e}")))?;

        let auth_key = derive_auth_key(&config.credential);

        Ok(Self {
            server_addr,
            username: config.username.clone(),
            auth_key,
            allocation: None,
            socket: None,
            local_proxy_addr: None,
            proxy_handle: None,
        })
    }

    /// Allocate a relay address from the server.
    ///
    /// Sends an `AllocateReq` with the username, receives an `AllocateResp`
    /// containing the relay address and allocation ID.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] on network or protocol errors.
    pub async fn allocate(&mut self) -> Result<SocketAddr, OverlayError> {
        // Bind a UDP socket for communication with the relay server,
        // matching the server's address family
        let bind_addr = if self.server_addr.is_ipv4() {
            "0.0.0.0:0"
        } else {
            "[::]:0"
        };
        let socket = UdpSocket::bind(bind_addr)
            .await
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to bind relay socket: {e}")))?;

        // Build AllocateReq payload: [username_len: 1] [username: N]
        let username_bytes = self.username.as_bytes();
        let mut payload = Vec::with_capacity(1 + username_bytes.len());
        payload.push(
            username_bytes
                .len()
                .try_into()
                .map_err(|_| OverlayError::TurnRelay("Username too long".to_string()))?,
        );
        payload.extend_from_slice(username_bytes);

        let msg = build_control_msg(MsgType::AllocateReq, &payload, &self.auth_key);
        socket
            .send_to(&msg, self.server_addr)
            .await
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to send AllocateReq: {e}")))?;

        // Wait for response (5 second timeout)
        let mut buf = [0u8; 1024];
        let n = tokio::time::timeout(std::time::Duration::from_secs(5), socket.recv(&mut buf))
            .await
            .map_err(|_| OverlayError::TurnRelay("AllocateReq timed out".to_string()))?
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to recv AllocateResp: {e}")))?;

        let (msg_type, resp_payload) = parse_and_verify_control(&buf[..n], &self.auth_key)
            .ok_or_else(|| {
                OverlayError::TurnRelay("Invalid or unauthenticated AllocateResp".to_string())
            })?;

        match msg_type {
            MsgType::AllocateResp => {
                // Payload: [relay_addr: 7 or 19 (tagged)] [allocation_id: 16] [lifetime: 4]
                // Minimum size: 7 (IPv4 tagged) + 16 + 4 = 27
                if resp_payload.len() < PEER_ADDR_V4_TAGGED_LEN + 16 + 4 {
                    return Err(OverlayError::TurnRelay(
                        "AllocateResp payload too short".to_string(),
                    ));
                }

                let (relay_addr, addr_len) = decode_addr(&resp_payload).ok_or_else(|| {
                    OverlayError::TurnRelay("Failed to decode relay address".to_string())
                })?;

                if resp_payload.len() < addr_len + 16 + 4 {
                    return Err(OverlayError::TurnRelay(
                        "AllocateResp payload too short for allocation data".to_string(),
                    ));
                }

                let mut allocation_id = [0u8; 16];
                allocation_id.copy_from_slice(&resp_payload[addr_len..addr_len + 16]);

                let lifetime_secs = u32::from_be_bytes([
                    resp_payload[addr_len + 16],
                    resp_payload[addr_len + 17],
                    resp_payload[addr_len + 18],
                    resp_payload[addr_len + 19],
                ]);

                debug!(
                    relay_addr = %relay_addr,
                    lifetime = lifetime_secs,
                    "Relay allocation succeeded"
                );

                self.allocation = Some(RelayAllocation {
                    relay_addr,
                    allocation_id,
                    expires_at: Instant::now()
                        + std::time::Duration::from_secs(u64::from(lifetime_secs)),
                    lifetime_secs,
                });

                self.socket = Some(Arc::new(socket));
                Ok(relay_addr)
            }
            MsgType::AllocateErr => {
                let err_msg = String::from_utf8_lossy(&resp_payload);
                Err(OverlayError::TurnRelay(format!(
                    "Allocation rejected: {err_msg}"
                )))
            }
            other => Err(OverlayError::TurnRelay(format!(
                "Unexpected response type: {other:?}"
            ))),
        }
    }

    /// Create a permission for a peer address on the relay server.
    ///
    /// The relay will only forward data to/from peers with active permissions.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] if no allocation is active or
    /// the server rejects the permission.
    pub async fn create_permission(&mut self, peer_addr: SocketAddr) -> Result<(), OverlayError> {
        let allocation = self
            .allocation
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No active allocation".to_string()))?;

        let socket = self
            .socket
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No relay socket".to_string()))?;

        // Payload: [allocation_id: 16] [peer_addr: 7 or 19 (family-tagged)]
        let encoded_peer = encode_addr(peer_addr);
        let mut payload = Vec::with_capacity(16 + encoded_peer.len());
        payload.extend_from_slice(&allocation.allocation_id);
        payload.extend_from_slice(&encoded_peer);

        let msg = build_control_msg(MsgType::PermissionReq, &payload, &self.auth_key);
        socket
            .send_to(&msg, self.server_addr)
            .await
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to send PermissionReq: {e}")))?;

        // Wait for response
        let mut buf = [0u8; 512];
        let n = tokio::time::timeout(std::time::Duration::from_secs(5), socket.recv(&mut buf))
            .await
            .map_err(|_| OverlayError::TurnRelay("PermissionReq timed out".to_string()))?
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to recv PermissionResp: {e}")))?;

        let (msg_type, _) = parse_and_verify_control(&buf[..n], &self.auth_key)
            .ok_or_else(|| OverlayError::TurnRelay("Invalid PermissionResp".to_string()))?;

        if msg_type != MsgType::PermissionResp {
            return Err(OverlayError::TurnRelay(format!(
                "Expected PermissionResp, got {msg_type:?}"
            )));
        }

        debug!(peer = %peer_addr, "Relay permission created");
        Ok(())
    }

    /// Start a local UDP proxy that bridges `WireGuard` traffic through the relay.
    ///
    /// Returns the local proxy address. Set the `WireGuard` peer endpoint to this
    /// address so WG sends packets to the proxy, which forwards them through
    /// the relay to the remote peer.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] if no allocation is active.
    pub async fn start_proxy(&mut self, wg_port: u16) -> Result<SocketAddr, OverlayError> {
        let relay_socket = self
            .socket
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No relay socket".to_string()))?
            .clone();

        let allocation = self
            .allocation
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No active allocation".to_string()))?;

        let relay_addr = allocation.relay_addr;
        let server_addr = self.server_addr;

        // Bind local proxy on loopback with ephemeral port
        let proxy_socket =
            Arc::new(UdpSocket::bind("127.0.0.1:0").await.map_err(|e| {
                OverlayError::TurnRelay(format!("Failed to bind proxy socket: {e}"))
            })?);
        let proxy_addr = proxy_socket
            .local_addr()
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to get proxy addr: {e}")))?;

        let wg_dest: SocketAddr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), wg_port);

        debug!(
            proxy_addr = %proxy_addr,
            relay_addr = %relay_addr,
            "Starting relay proxy"
        );

        // Spawn proxy task: bidirectional forwarding
        // Two separate buffers to avoid double mutable borrow in tokio::select!
        let proxy_read = proxy_socket.clone();
        let relay_read = relay_socket.clone();

        let handle = tokio::spawn(async move {
            #[allow(clippy::large_stack_arrays)]
            let mut proxy_buf = [0u8; 65536];
            #[allow(clippy::large_stack_arrays)]
            let mut relay_buf = [0u8; 65536];

            loop {
                tokio::select! {
                    // WG -> proxy -> relay server (wrap as DATA)
                    result = proxy_read.recv_from(&mut proxy_buf) => {
                        match result {
                            Ok((n, _from)) => {
                                // Destination is the relay_addr (the peer's relay allocation)
                                let data_msg = build_data_msg_tagged(relay_addr, &proxy_buf[..n]);
                                if let Err(e) = relay_read.send_to(&data_msg, server_addr).await {
                                    warn!(error = %e, "Failed to send data through relay");
                                }
                            }
                            Err(e) => {
                                warn!(error = %e, "Proxy recv error");
                                break;
                            }
                        }
                    }
                    // Relay server -> proxy -> WG
                    result = relay_read.recv_from(&mut relay_buf) => {
                        match result {
                            Ok((n, _from)) => {
                                if let Some(MsgType::Data) = relay_buf.first().and_then(|&b| MsgType::from_byte(b)) {
                                    if let Some((_, raw_data)) = parse_msg(&relay_buf[..n])
                                        .and_then(|(_, payload)| parse_data_payload_tagged(payload))
                                    {
                                        if let Err(e) = proxy_read.send_to(raw_data, wg_dest).await {
                                            warn!(error = %e, "Failed to forward to WG");
                                        }
                                    }
                                }
                                // Ignore non-DATA messages in proxy loop
                            }
                            Err(e) => {
                                warn!(error = %e, "Relay recv error");
                                break;
                            }
                        }
                    }
                }
            }
        });

        self.proxy_handle = Some(handle);
        self.local_proxy_addr = Some(proxy_addr);

        Ok(proxy_addr)
    }

    /// Refresh the relay allocation before it expires.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] if no allocation exists or refresh fails.
    pub async fn refresh(&mut self) -> Result<(), OverlayError> {
        let allocation = self
            .allocation
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No active allocation".to_string()))?;

        let socket = self
            .socket
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No relay socket".to_string()))?;

        // Payload: [allocation_id: 16] [lifetime: 4]
        let mut payload = Vec::with_capacity(20);
        payload.extend_from_slice(&allocation.allocation_id);
        payload.extend_from_slice(&allocation.lifetime_secs.to_be_bytes());

        let msg = build_control_msg(MsgType::RefreshReq, &payload, &self.auth_key);
        socket
            .send_to(&msg, self.server_addr)
            .await
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to send RefreshReq: {e}")))?;

        // Wait for response
        let mut buf = [0u8; 512];
        let n = tokio::time::timeout(std::time::Duration::from_secs(5), socket.recv(&mut buf))
            .await
            .map_err(|_| OverlayError::TurnRelay("RefreshReq timed out".to_string()))?
            .map_err(|e| OverlayError::TurnRelay(format!("Failed to recv RefreshResp: {e}")))?;

        let (msg_type, resp_payload) = parse_and_verify_control(&buf[..n], &self.auth_key)
            .ok_or_else(|| OverlayError::TurnRelay("Invalid RefreshResp".to_string()))?;

        if msg_type != MsgType::RefreshResp {
            return Err(OverlayError::TurnRelay(format!(
                "Expected RefreshResp, got {msg_type:?}"
            )));
        }

        // Parse new lifetime from response
        if resp_payload.len() >= 4 {
            let new_lifetime = u32::from_be_bytes([
                resp_payload[0],
                resp_payload[1],
                resp_payload[2],
                resp_payload[3],
            ]);

            if let Some(ref mut alloc) = self.allocation {
                alloc.lifetime_secs = new_lifetime;
                alloc.expires_at =
                    Instant::now() + std::time::Duration::from_secs(u64::from(new_lifetime));
            }

            debug!(lifetime = new_lifetime, "Relay allocation refreshed");
        }

        Ok(())
    }

    /// Deallocate the relay address.
    ///
    /// # Errors
    ///
    /// Returns [`OverlayError::TurnRelay`] if no allocation exists or deallocation fails.
    pub async fn deallocate(&mut self) -> Result<(), OverlayError> {
        let allocation = self
            .allocation
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No active allocation".to_string()))?;

        let socket = self
            .socket
            .as_ref()
            .ok_or_else(|| OverlayError::TurnRelay("No relay socket".to_string()))?;

        // Payload: [allocation_id: 16]
        let msg = build_control_msg(
            MsgType::Deallocate,
            &allocation.allocation_id,
            &self.auth_key,
        );
        // Best-effort send, don't block on response
        let _ = socket.send_to(&msg, self.server_addr).await;

        // Clean up
        if let Some(handle) = self.proxy_handle.take() {
            handle.abort();
        }
        self.allocation = None;
        self.local_proxy_addr = None;

        debug!("Relay allocation deallocated");
        Ok(())
    }

    /// Get the local proxy address (what WG peer endpoint should be set to).
    #[must_use]
    pub fn proxy_addr(&self) -> Option<SocketAddr> {
        self.local_proxy_addr
    }

    /// Check if the allocation is active (exists and has not expired).
    #[must_use]
    pub fn is_active(&self) -> bool {
        self.allocation
            .as_ref()
            .is_some_and(|a| Instant::now() < a.expires_at)
    }

    /// Build a Relay candidate using the local proxy address.
    ///
    /// Returns `None` if no proxy is running.
    #[must_use]
    pub fn candidate(&self) -> Option<Candidate> {
        self.local_proxy_addr
            .map(|addr| Candidate::new(CandidateType::Relay, addr))
    }
}

impl Drop for RelayClient {
    fn drop(&mut self) {
        if let Some(handle) = self.proxy_handle.take() {
            handle.abort();
        }
    }
}

// ---- Tests ------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::{Ipv4Addr, SocketAddrV4};

    #[test]
    fn test_derive_auth_key() {
        let key1 = derive_auth_key("my_secret");
        let key2 = derive_auth_key("my_secret");
        assert_eq!(key1, key2, "Same credential must produce same key");

        let key3 = derive_auth_key("different_secret");
        assert_ne!(
            key1, key3,
            "Different credentials must produce different keys"
        );
    }

    #[test]
    fn test_auth_tag_roundtrip() {
        let key = derive_auth_key("test_credential");
        let data = b"hello relay world";
        let tag = compute_auth_tag(&key, data);

        assert!(verify_auth_tag(&key, data, &tag), "Tag should verify");
        assert!(
            !verify_auth_tag(&key, b"wrong data", &tag),
            "Tag should fail with wrong data"
        );

        let wrong_key = derive_auth_key("wrong_credential");
        assert!(
            !verify_auth_tag(&wrong_key, data, &tag),
            "Tag should fail with wrong key"
        );
    }

    #[test]
    fn test_encode_decode_addr_v4() {
        let addr = SocketAddrV4::new(Ipv4Addr::new(192, 168, 1, 100), 51820);
        let encoded = encode_addr_v4(addr);
        let decoded = decode_addr_v4(&encoded).unwrap();
        assert_eq!(addr, decoded);
    }

    #[test]
    fn test_encode_decode_addr_v4_edge_cases() {
        // Broadcast
        let addr = SocketAddrV4::new(Ipv4Addr::BROADCAST, 65535);
        let encoded = encode_addr_v4(addr);
        let decoded = decode_addr_v4(&encoded).unwrap();
        assert_eq!(addr, decoded);

        // All zeros
        let addr = SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0);
        let encoded = encode_addr_v4(addr);
        let decoded = decode_addr_v4(&encoded).unwrap();
        assert_eq!(addr, decoded);
    }

    #[test]
    fn test_decode_addr_v4_too_short() {
        assert!(decode_addr_v4(&[1, 2, 3]).is_none());
    }

    #[test]
    fn test_build_and_parse_control_msg() {
        let key = derive_auth_key("test");
        let payload = b"test_payload";
        let msg = build_control_msg(MsgType::AllocateReq, payload, &key);

        // Should parse and verify
        let (msg_type, parsed_payload) = parse_and_verify_control(&msg, &key).unwrap();
        assert_eq!(msg_type, MsgType::AllocateReq);
        assert_eq!(&parsed_payload, payload);

        // Should fail with wrong key
        let wrong_key = derive_auth_key("wrong");
        assert!(parse_and_verify_control(&msg, &wrong_key).is_none());
    }

    #[test]
    fn test_build_and_parse_data_msg() {
        let peer_addr = SocketAddrV4::new(Ipv4Addr::new(10, 0, 0, 1), 3478);
        let raw_data = b"wireguard_packet_data";
        let msg = build_data_msg(peer_addr, raw_data);

        let (msg_type, payload) = parse_msg(&msg).unwrap();
        assert_eq!(msg_type, MsgType::Data);

        let (parsed_addr, parsed_data) = parse_data_payload(payload).unwrap();
        assert_eq!(parsed_addr, peer_addr);
        assert_eq!(parsed_data, raw_data);
    }

    #[test]
    fn test_msg_type_from_byte() {
        assert_eq!(MsgType::from_byte(0x01), Some(MsgType::AllocateReq));
        assert_eq!(MsgType::from_byte(0x02), Some(MsgType::AllocateResp));
        assert_eq!(MsgType::from_byte(0x03), Some(MsgType::AllocateErr));
        assert_eq!(MsgType::from_byte(0x04), Some(MsgType::PermissionReq));
        assert_eq!(MsgType::from_byte(0x05), Some(MsgType::PermissionResp));
        assert_eq!(MsgType::from_byte(0x06), Some(MsgType::RefreshReq));
        assert_eq!(MsgType::from_byte(0x07), Some(MsgType::RefreshResp));
        assert_eq!(MsgType::from_byte(0x08), Some(MsgType::Deallocate));
        assert_eq!(MsgType::from_byte(0x80), Some(MsgType::Data));
        assert_eq!(MsgType::from_byte(0xFF), None);
    }

    #[test]
    fn test_parse_msg_too_short() {
        assert!(parse_msg(&[]).is_none());
        assert!(parse_msg(&[0x01]).is_none());
        assert!(parse_msg(&[0x01, 0x00]).is_none());
    }

    #[test]
    fn test_relay_client_new() {
        let config = TurnServerConfig {
            address: "127.0.0.1:3478".to_string(),
            username: "testuser".to_string(),
            credential: "testpass".to_string(),
            region: None,
        };
        let client = RelayClient::new(&config).unwrap();
        assert_eq!(client.server_addr, "127.0.0.1:3478".parse().unwrap());
        assert_eq!(client.username, "testuser");
        assert!(!client.is_active());
        assert!(client.proxy_addr().is_none());
        assert!(client.candidate().is_none());
    }

    #[test]
    fn test_relay_client_invalid_address() {
        let config = TurnServerConfig {
            address: "not_a_valid_address".to_string(),
            username: "user".to_string(),
            credential: "pass".to_string(),
            region: None,
        };
        assert!(RelayClient::new(&config).is_err());
    }

    #[test]
    fn test_control_msg_all_types() {
        let key = derive_auth_key("k");
        for msg_type in [
            MsgType::AllocateReq,
            MsgType::AllocateResp,
            MsgType::AllocateErr,
            MsgType::PermissionReq,
            MsgType::PermissionResp,
            MsgType::RefreshReq,
            MsgType::RefreshResp,
            MsgType::Deallocate,
        ] {
            let msg = build_control_msg(msg_type, b"p", &key);
            let (parsed, payload) = parse_and_verify_control(&msg, &key).unwrap();
            assert_eq!(parsed, msg_type);
            assert_eq!(payload, b"p");
        }
    }

    #[test]
    fn test_allocation_id_in_control_msg() {
        let key = derive_auth_key("test");
        let allocation_id: [u8; 16] = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
        let msg = build_control_msg(MsgType::RefreshReq, &allocation_id, &key);

        let (_, payload) = parse_and_verify_control(&msg, &key).unwrap();
        assert_eq!(payload.len(), 16);
        assert_eq!(payload.as_slice(), &allocation_id);
    }

    // ---- IPv6 / dual-stack tests --------------------------------------------

    #[test]
    fn test_encode_decode_addr_ipv4() {
        let addr = SocketAddr::new(Ipv4Addr::new(192, 168, 1, 100).into(), 51820);
        let encoded = encode_addr(addr);
        assert_eq!(encoded.len(), PEER_ADDR_V4_TAGGED_LEN);
        assert_eq!(encoded[0], 0x01); // IPv4 family
        let (decoded, consumed) = decode_addr(&encoded).unwrap();
        assert_eq!(decoded, addr);
        assert_eq!(consumed, PEER_ADDR_V4_TAGGED_LEN);
    }

    #[test]
    fn test_encode_decode_addr_ipv6() {
        let addr = SocketAddr::new(
            Ipv6Addr::new(0x2001, 0x0db8, 0, 0, 0, 0, 0, 1).into(),
            51820,
        );
        let encoded = encode_addr(addr);
        assert_eq!(encoded.len(), PEER_ADDR_V6_TAGGED_LEN);
        assert_eq!(encoded[0], 0x02); // IPv6 family
        let (decoded, consumed) = decode_addr(&encoded).unwrap();
        assert_eq!(decoded, addr);
        assert_eq!(consumed, PEER_ADDR_V6_TAGGED_LEN);
    }

    #[test]
    fn test_encode_decode_addr_ipv6_link_local() {
        let addr = SocketAddr::new(Ipv6Addr::new(0xFE80, 0, 0, 0, 0, 0, 0, 1).into(), 3478);
        let encoded = encode_addr(addr);
        let (decoded, _) = decode_addr(&encoded).unwrap();
        assert_eq!(decoded, addr);
    }

    #[test]
    fn test_decode_addr_too_short() {
        assert!(decode_addr(&[]).is_none());
        // IPv4 family but only 3 bytes total (need 7)
        assert!(decode_addr(&[0x01, 1, 2]).is_none());
        // IPv6 family but only 5 bytes total (need 19)
        assert!(decode_addr(&[0x02, 1, 2, 3, 4]).is_none());
        // Unknown family
        assert!(decode_addr(&[0x03, 1, 2, 3, 4, 5, 6]).is_none());
    }

    #[test]
    fn test_build_and_parse_data_msg_tagged_ipv4() {
        let peer_addr = SocketAddr::new(Ipv4Addr::new(10, 0, 0, 1).into(), 3478);
        let raw_data = b"wireguard_packet_data";
        let msg = build_data_msg_tagged(peer_addr, raw_data);

        let (msg_type, payload) = parse_msg(&msg).unwrap();
        assert_eq!(msg_type, MsgType::Data);

        let (parsed_addr, parsed_data) = parse_data_payload_tagged(payload).unwrap();
        assert_eq!(parsed_addr, peer_addr);
        assert_eq!(parsed_data, raw_data);
    }

    #[test]
    fn test_build_and_parse_data_msg_tagged_ipv6() {
        let peer_addr = SocketAddr::new(
            Ipv6Addr::new(0x2001, 0x0db8, 0xABCD, 0, 0, 0, 0, 0x42).into(),
            51820,
        );
        let raw_data = b"wireguard_ipv6_packet_data";
        let msg = build_data_msg_tagged(peer_addr, raw_data);

        let (msg_type, payload) = parse_msg(&msg).unwrap();
        assert_eq!(msg_type, MsgType::Data);

        let (parsed_addr, parsed_data) = parse_data_payload_tagged(payload).unwrap();
        assert_eq!(parsed_addr, peer_addr);
        assert_eq!(parsed_data, raw_data);
    }

    #[test]
    fn test_parse_data_payload_tagged_too_short() {
        assert!(parse_data_payload_tagged(&[]).is_none());
        assert!(parse_data_payload_tagged(&[0x01]).is_none());
        assert!(parse_data_payload_tagged(&[0x02, 0, 0]).is_none());
    }

    #[test]
    fn test_relay_client_new_ipv6() {
        let config = TurnServerConfig {
            address: "[::1]:3478".to_string(),
            username: "testuser".to_string(),
            credential: "testpass".to_string(),
            region: None,
        };
        let client = RelayClient::new(&config).unwrap();
        assert_eq!(
            client.server_addr,
            SocketAddr::new(Ipv6Addr::LOCALHOST.into(), 3478)
        );
        assert!(!client.is_active());
    }
}