qbase 0.5.0

Core structure of the QUIC protocol, a part of dquic
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

use std::net::SocketAddr;

use derive_more::Deref;

use super::{
    EncodeSize, GetFrameType,
    io::{WriteFrame, WriteFrameType},
};
use crate::{
    net::{AddrFamily, Family, NatType, be_socket_addr},
    varint::{VarInt, WriteVarInt, be_varint},
};

/// PUNCH_ME_NOW Frame
///
///```text
/// PUNCH_ME_NOW Frame {
///     Type (i) = 0x3d7e92,0x3d7e93
///     Local Sequence Number (i),
///     Remote Sequence Number (i),
///     [ IPv4 (32) ],
///     [ IPv6 (128) ],
///     Port (16),
///     Tire (i),
///     Nat type (i),
/// }
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deref)]
pub struct PunchMeNowFrame {
    local_seq: VarInt,
    remote_seq: VarInt,
    #[deref]
    address: SocketAddr,
    tire: VarInt,
    nat_type: NatType,
}

pub(crate) fn be_punch_me_now_frame(
    family: Family,
) -> impl Fn(&[u8]) -> nom::IResult<&[u8], PunchMeNowFrame> {
    move |input| {
        let (remain, local_seq) = be_varint(input)?;
        let (remain, remote_seq) = be_varint(remain)?;
        let (remain, address) = be_socket_addr(remain, family)?;
        let (remain, tire) = be_varint(remain)?;
        let (remain, nat_type) = be_varint(remain)?;
        let nat_type = NatType::try_from(nat_type).map_err(|_| {
            nom::Err::Error(nom::error::Error::new(
                remain,
                nom::error::ErrorKind::Verify,
            ))
        })?;
        Ok((
            remain,
            PunchMeNowFrame {
                local_seq,
                remote_seq,
                address,
                tire,
                nat_type,
            },
        ))
    }
}

impl GetFrameType for PunchMeNowFrame {
    fn frame_type(&self) -> super::FrameType {
        super::FrameType::PunchMeNow(self.address.family())
    }
}

impl EncodeSize for PunchMeNowFrame {
    fn max_encoding_size(&self) -> usize {
        4 + 8 + 8 + self.address.max_encoding_size() + 8 + 8
    }

    fn encoding_size(&self) -> usize {
        VarInt::from(self.frame_type()).encoding_size()
            + self.local_seq.encoding_size()
            + self.remote_seq.encoding_size()
            + self.address.encoding_size()
            + self.tire.encoding_size()
            + VarInt::from(self.nat_type).encoding_size()
    }
}

impl PunchMeNowFrame {
    pub fn new(
        local_seq: u32,
        remote_seq: u32,
        address: SocketAddr,
        tire: u32,
        nat_type: NatType,
    ) -> Self {
        Self {
            local_seq: VarInt::from_u32(local_seq),
            remote_seq: VarInt::from_u32(remote_seq),
            address,
            tire: VarInt::from_u32(tire),
            nat_type,
        }
    }

    pub fn local_seq(&self) -> u32 {
        self.local_seq.into_inner() as u32
    }

    pub fn remote_seq(&self) -> u32 {
        self.remote_seq.into_inner() as u32
    }

    pub fn nat_type(&self) -> NatType {
        self.nat_type
    }

    pub fn set_addr(&mut self, addr: SocketAddr) {
        self.address = addr;
    }

    pub fn address(&self) -> SocketAddr {
        self.address
    }

    pub fn tire(&self) -> u32 {
        self.tire.into_inner() as u32
    }
}

impl<T: bytes::BufMut> WriteFrame<PunchMeNowFrame> for T {
    fn put_frame(&mut self, frame: &PunchMeNowFrame) {
        self.put_frame_type(frame.frame_type());
        self.put_varint(&frame.local_seq);
        self.put_varint(&frame.remote_seq);
        self.put_u16(frame.address.port());
        match frame.address.ip() {
            std::net::IpAddr::V4(ipv4) => self.put_slice(&ipv4.octets()),
            std::net::IpAddr::V6(ipv6) => self.put_slice(&ipv6.octets()),
        }
        self.put_varint(&frame.tire);
        self.put_varint(&VarInt::from(frame.nat_type));
    }
}

#[cfg(test)]
mod tests {
    use bytes::BytesMut;

    use super::*;
    use crate::frame::{GetFrameType, be_frame_type, io::WriteFrame};

    #[test]
    fn test_punch_me_now_frame() {
        let frame = PunchMeNowFrame {
            local_seq: VarInt::from_u32(1),
            remote_seq: VarInt::from_u32(2),
            address: "127.0.0.1:12345".parse().unwrap(),
            tire: VarInt::from_u32(0x01u32),
            nat_type: NatType::FullCone,
        };
        let mut buf = BytesMut::with_capacity(frame.max_encoding_size());
        buf.put_frame(&frame);
        let (remain, frame_type) = be_frame_type(&buf).unwrap();
        assert_eq!(frame_type, frame.frame_type());
        let frame2 = be_punch_me_now_frame(Family::V4)(remain).unwrap().1;
        assert_eq!(frame, frame2);
    }
}