rust_p2p_core/punch/
mod.rs

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
use std::collections::{HashMap, HashSet};
use std::hash::Hash;
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};
use std::ops;
use std::ops::{Div, Mul};
use std::str::FromStr;
use std::sync::Arc;
use std::time::Duration;

use parking_lot::Mutex;
use rand::seq::SliceRandom;
use rand::Rng;
use serde::{Deserialize, Serialize};

use crate::nat::{NatInfo, NatType};
use crate::pipe::tcp_pipe::TcpPipeWriter;
use crate::pipe::udp_pipe::UdpPipeWriter;
use crate::pipe::Pipe;
use crate::route::route_table::RouteTable;

#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug, Serialize, Deserialize)]
pub enum PunchModel {
    IPv4Tcp,
    IPv4Udp,
    IPv6Tcp,
    IPv6Udp,
}

impl ops::BitOr<PunchModel> for PunchModel {
    type Output = PunchModelBox;

    fn bitor(self, rhs: PunchModel) -> Self::Output {
        let mut model = PunchModelBox::empty();
        model.or(self);
        model.or(rhs);
        model
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct PunchModelBox {
    models: HashSet<PunchModel>,
}

impl Default for PunchModelBox {
    fn default() -> Self {
        PunchModelBox::all()
    }
}

impl ops::BitOr<PunchModel> for PunchModelBox {
    type Output = PunchModelBox;

    fn bitor(mut self, rhs: PunchModel) -> Self::Output {
        self.or(rhs);
        self
    }
}

impl PunchModelBox {
    pub fn all() -> Self {
        PunchModel::IPv4Tcp | PunchModel::IPv4Udp | PunchModel::IPv6Tcp | PunchModel::IPv6Udp
    }
    pub fn ipv4() -> Self {
        PunchModel::IPv4Tcp | PunchModel::IPv4Udp
    }
    pub fn ipv6() -> Self {
        PunchModel::IPv6Tcp | PunchModel::IPv6Udp
    }
    pub fn empty() -> Self {
        Self {
            models: Default::default(),
        }
    }
    pub fn or(&mut self, punch_model: PunchModel) {
        self.models.insert(punch_model);
    }
    pub fn is_match(&self, punch_model: PunchModel) -> bool {
        self.models.contains(&punch_model)
    }
}

#[derive(Clone, Debug)]
pub struct PunchModelBoxes {
    boxes: Vec<PunchModelBox>,
}

impl ops::BitAnd<PunchModelBox> for PunchModelBox {
    type Output = PunchModelBoxes;

    fn bitand(self, rhs: PunchModelBox) -> Self::Output {
        let mut boxes = PunchModelBoxes::empty();
        boxes.and(rhs);
        boxes
    }
}

impl PunchModelBoxes {
    pub fn all() -> Self {
        Self {
            boxes: vec![PunchModelBox::all()],
        }
    }
    pub fn empty() -> Self {
        Self { boxes: Vec::new() }
    }
    pub fn and(&mut self, punch_model_box: PunchModelBox) {
        self.boxes.push(punch_model_box)
    }
    pub fn is_match(&self, punch_model: PunchModel) -> bool {
        if self.boxes.is_empty() {
            return false;
        }
        for x in &self.boxes {
            if !x.is_match(punch_model) {
                return false;
            }
        }
        true
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct PunchConsultInfo {
    pub peer_punch_model: PunchModelBox,
    pub peer_nat_info: NatInfo,
}

impl PunchConsultInfo {
    pub fn new(peer_punch_model: PunchModelBox, peer_nat_info: NatInfo) -> Self {
        Self {
            peer_punch_model,
            peer_nat_info,
        }
    }
}

#[derive(Clone, Debug)]
pub struct PunchInfo {
    initiate_by_oneself: bool,
    punch_model: PunchModelBoxes,
    peer_nat_info: NatInfo,
}

impl PunchInfo {
    pub fn new(
        initiate_by_oneself: bool,
        punch_model: PunchModelBoxes,
        peer_nat_info: NatInfo,
    ) -> Self {
        Self {
            initiate_by_oneself,
            punch_model,
            peer_nat_info,
        }
    }
    pub fn new_by_oneself(punch_model: PunchModelBoxes, peer_nat_info: NatInfo) -> Self {
        Self {
            initiate_by_oneself: true,
            punch_model,
            peer_nat_info,
        }
    }
    pub fn new_by_other(punch_model: PunchModelBoxes, peer_nat_info: NatInfo) -> Self {
        Self {
            initiate_by_oneself: false,
            punch_model,
            peer_nat_info,
        }
    }
    pub(crate) fn use_ttl(&self) -> bool {
        self.initiate_by_oneself ^ (self.peer_nat_info.seq % 2 == 0)
    }
}

impl FromStr for PunchModel {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().trim() {
            "ipv4-tcp" => Ok(PunchModel::IPv4Tcp),
            "ipv4-udp" => Ok(PunchModel::IPv4Udp),
            "ipv6-tcp" => Ok(PunchModel::IPv6Tcp),
            "ipv6-udp" => Ok(PunchModel::IPv6Udp),
            _ => Err(format!(
                "not match '{}', enum: ipv4-tcp/ipv4-udp/ipv6-tcp/ipv6-udp",
                s
            )),
        }
    }
}

#[derive(Clone)]
pub struct Puncher<PeerID> {
    route_table: RouteTable<PeerID>,
    // 端口顺序
    port_vec: Vec<u16>,
    // 指定IP的打洞记录
    sym_record: Arc<Mutex<HashMap<PeerID, usize>>>,
    count_record: Arc<Mutex<HashMap<PeerID, (usize, usize)>>>,
    udp_pipe_writer: Option<UdpPipeWriter>,
    tcp_pipe_writer: Option<TcpPipeWriter>,
}

impl<PeerID> From<&Pipe<PeerID>> for Puncher<PeerID> {
    fn from(value: &Pipe<PeerID>) -> Self {
        let writer_ref = value.writer_ref();
        let tcp_pipe_writer = writer_ref.tcp_pipe_writer_ref().map(|v| v.to_owned());
        let udp_pipe_writer = writer_ref.udp_pipe_writer_ref().map(|v| v.to_owned());
        Self::new(
            value.route_table().clone(),
            udp_pipe_writer,
            tcp_pipe_writer,
        )
    }
}

impl<PeerID> Puncher<PeerID> {
    pub fn new(
        route_table: RouteTable<PeerID>,
        udp_pipe_writer: Option<UdpPipeWriter>,
        tcp_pipe_writer: Option<TcpPipeWriter>,
    ) -> Puncher<PeerID> {
        let mut port_vec: Vec<u16> = (1..=65535).collect();
        let mut rng = rand::thread_rng();
        port_vec.shuffle(&mut rng);
        Self {
            route_table,
            port_vec,
            sym_record: Arc::new(Mutex::new(HashMap::new())),
            count_record: Arc::new(Mutex::new(HashMap::new())),
            udp_pipe_writer,
            tcp_pipe_writer,
        }
    }
}

impl<PeerID: Hash + Eq + Clone> Puncher<PeerID> {
    pub fn reset_all(&self) {
        self.sym_record.lock().clear();
        self.count_record.lock().clear();
    }
    pub fn reset_record(&self, peer_id: &PeerID) {
        self.sym_record.lock().remove(peer_id);
        self.count_record.lock().remove(peer_id);
    }
    /// Call `need_punch` at a certain frequency, and call [`punch_now`](Self::punch_now) after getting true.
    /// Determine whether punching is needed.
    pub fn need_punch(&self, id: &PeerID) -> bool {
        let need = self.route_table.need_punch(id);
        if !need {
            self.reset_record(id);
            return false;
        }
        let (count, _) = *self
            .count_record
            .lock()
            .entry(id.clone())
            .and_modify(|(v, _)| *v += 1)
            .or_insert((0, 0));
        if count > 8 {
            //降低频率
            let interval = count / 8;
            return count % interval.min(360) == 0;
        }
        true
    }

    /// Call `punch` at a certain frequency
    pub async fn punch(
        &self,
        peer_id: PeerID,
        buf: &[u8],
        punch_info: PunchInfo,
    ) -> anyhow::Result<()> {
        if !self.need_punch(&peer_id) {
            return Ok(());
        }
        self.punch_now(peer_id, buf, punch_info).await
    }
    pub async fn punch_now(
        &self,
        peer_id: PeerID,
        buf: &[u8],
        punch_info: PunchInfo,
    ) -> anyhow::Result<()> {
        let (_, count) = *self
            .count_record
            .lock()
            .entry(peer_id.clone())
            .and_modify(|(_, v)| *v += 1)
            .or_insert((0, 0));
        let ttl = if punch_info.use_ttl() && count < 255 {
            Some(count.max(2) as u32)
        } else {
            None
        };
        let peer_nat_info = punch_info.peer_nat_info;
        let punch_model = punch_info.punch_model;

        async_scoped::TokioScope::scope_and_block(|s| {
            if let Some(tcp_pipe_writer) = self.tcp_pipe_writer.as_ref() {
                for addr in &peer_nat_info.mapping_tcp_addr {
                    s.spawn(async move {
                        Self::connect_tcp(tcp_pipe_writer, buf, *addr, ttl).await;
                    })
                }
                if punch_model.is_match(PunchModel::IPv4Tcp) {
                    if let Some(addr) = peer_nat_info.local_ipv4_tcp() {
                        s.spawn(async move {
                            Self::connect_tcp(tcp_pipe_writer, buf, addr, ttl).await;
                        })
                    }
                    for addr in peer_nat_info.public_ipv4_tcp() {
                        s.spawn(async move {
                            Self::connect_tcp(tcp_pipe_writer, buf, addr, ttl).await;
                        })
                    }
                }
                if punch_model.is_match(PunchModel::IPv6Tcp) {
                    if let Some(addr) = peer_nat_info.ipv6_tcp_addr() {
                        s.spawn(async move {
                            Self::connect_tcp(tcp_pipe_writer, buf, addr, ttl).await;
                        })
                    }
                }
            }
        });
        self.punch_udp(peer_id, count, buf, &peer_nat_info, &punch_model)
            .await?;

        Ok(())
    }
    async fn connect_tcp(
        tcp_pipe_writer: &TcpPipeWriter,
        buf: &[u8],
        addr: SocketAddr,
        ttl: Option<u32>,
    ) {
        match tokio::time::timeout(
            Duration::from_secs(3),
            tcp_pipe_writer.send_to_addr_multi0(buf.into(), addr, ttl),
        )
        .await
        {
            Ok(rs) => {
                if let Err(e) = rs {
                    log::warn!("tcp connect {addr},{e:?}");
                }
            }
            Err(_) => {
                log::warn!("tcp connect timeout {addr}");
            }
        }
    }
    async fn punch_udp(
        &self,
        peer_id: PeerID,
        count: usize,
        buf: &[u8],
        peer_nat_info: &NatInfo,
        punch_model: &PunchModelBoxes,
    ) -> anyhow::Result<()> {
        let udp_pipe_writer = if let Some(udp_pipe_writer) = self.udp_pipe_writer.as_ref() {
            udp_pipe_writer
        } else {
            return Ok(());
        };
        if !peer_nat_info.mapping_udp_addr.is_empty() {
            let mapping_udp_v4_addr: Vec<SocketAddr> = peer_nat_info
                .mapping_udp_addr
                .iter()
                .filter(|a| a.is_ipv4())
                .copied()
                .collect();
            udp_pipe_writer.try_main_send_to_addr(buf, &mapping_udp_v4_addr);

            let mapping_udp_v6_addr: Vec<SocketAddr> = peer_nat_info
                .mapping_udp_addr
                .iter()
                .filter(|a| a.is_ipv6())
                .copied()
                .collect();
            udp_pipe_writer.try_main_send_to_addr(buf, &mapping_udp_v6_addr);
        }
        let local_ipv4_addrs = peer_nat_info.local_ipv4_addrs();
        if !local_ipv4_addrs.is_empty() {
            udp_pipe_writer.try_main_send_to_addr(buf, &local_ipv4_addrs);
        }

        if punch_model.is_match(PunchModel::IPv6Udp) {
            let v6_addr = peer_nat_info.ipv6_addr();
            udp_pipe_writer.try_main_send_to_addr(buf, &v6_addr);
        }
        if !punch_model.is_match(PunchModel::IPv4Udp) {
            return Ok(());
        }
        if peer_nat_info.public_ips.is_empty() {
            return Ok(());
        }

        match peer_nat_info.nat_type {
            NatType::Symmetric => {
                // 假设对方绑定n个端口,通过NAT对外映射出n个 公网ip:公网端口,自己随机尝试k次的情况下
                // 猜中的概率 p = 1-((65535-n)/65535)*((65535-n-1)/(65535-1))*...*((65535-n-k+1)/(65535-k+1))
                // n取76,k取600,猜中的概率就超过50%了
                // 前提 自己是锥形网络,否则猜中了也通信不了

                //预测范围内最多发送max_k1个包
                let max_k1 = 60;
                //全局最多发送max_k2个包
                let mut max_k2: usize = rand::thread_rng().gen_range(600..800);
                if count > 8 {
                    //递减探测规模
                    max_k2 = max_k2.mul(8).div(count).max(max_k1 as usize);
                }
                let port = peer_nat_info.public_ports.first().copied().unwrap_or(0);
                if peer_nat_info.public_port_range < max_k1 * 3 {
                    //端口变化不大时,在预测的范围内随机发送
                    let min_port = if port > peer_nat_info.public_port_range {
                        port - peer_nat_info.public_port_range
                    } else {
                        1
                    };
                    let (max_port, overflow) =
                        port.overflowing_add(peer_nat_info.public_port_range);
                    let max_port = if overflow { 65535 } else { max_port };
                    let k = if max_port - min_port + 1 > max_k1 {
                        max_k1 as usize
                    } else {
                        (max_port - min_port + 1) as usize
                    };
                    let mut nums: Vec<u16> = (min_port..=max_port).collect();
                    nums.shuffle(&mut rand::thread_rng());
                    self.punch_symmetric(
                        udp_pipe_writer,
                        &nums[..k],
                        buf,
                        &peer_nat_info.public_ips,
                        max_k1 as usize,
                    )
                    .await?;
                }
                let start = self
                    .sym_record
                    .lock()
                    .get(&peer_id)
                    .cloned()
                    .unwrap_or_default();
                let mut end = start + max_k2;
                if end > self.port_vec.len() {
                    end = self.port_vec.len();
                }
                let mut index = start
                    + self
                        .punch_symmetric(
                            udp_pipe_writer,
                            &self.port_vec[start..end],
                            buf,
                            &peer_nat_info.public_ips,
                            max_k2,
                        )
                        .await?;
                if index >= self.port_vec.len() {
                    index = 0
                }
                // 记录这个IP的打洞记录
                self.sym_record.lock().insert(peer_id, index);
            }
            NatType::Cone => {
                let addr = peer_nat_info.public_ipv4_addr();
                if addr.is_empty() {
                    return Ok(());
                }
                udp_pipe_writer.try_main_send_to_addr(buf, &addr);
                udp_pipe_writer.try_sub_send_to_addr_v4(buf, addr[0]);
            }
        }
        Ok(())
    }

    async fn punch_symmetric(
        &self,
        udp_pipe_writer: &UdpPipeWriter,
        ports: &[u16],
        buf: &[u8],
        ips: &Vec<Ipv4Addr>,
        max: usize,
    ) -> anyhow::Result<usize> {
        let mut count = 0;
        for (index, port) in ports.iter().enumerate() {
            for pub_ip in ips {
                count += 1;
                if count == max {
                    return Ok(index);
                }
                let addr: SocketAddr = SocketAddr::V4(SocketAddrV4::new(*pub_ip, *port));
                if let Err(e) = udp_pipe_writer.try_send_to_addr(buf, addr) {
                    log::info!("{addr},{e:?}");
                }
                tokio::time::sleep(Duration::from_millis(2)).await
            }
        }
        Ok(ports.len())
    }
}