jets 0.4.3

A Rust rule-based tunnel
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
// https://datatracker.ietf.org/doc/html/rfc1928

use super::super::net_manager::UdpInboundWrite;
use super::super::{Outbound, ProxySocket, ProxyStream};
use crate::app::config::{OutboundProtocolOption, SocksUser};
use crate::app::connect_tcp_host;
use crate::app::dns::DnsManager;
use crate::app::Context as AppContext;
use crate::common::{copy_bidirectional, invalid_data_error, Address, MAXIMUM_UDP_PAYLOAD_SIZE};
use crate::pre_check_addr;
use crate::proxy::net_manager::NatManager;
use crate::transport::raw::UdpSocket;
use crate::transport::TransportSettings;
use async_trait::async_trait;
use bytes::{BufMut, BytesMut};
use futures::ready;
use shadowsocks::relay::socks5::{
    self, Command, HandshakeRequest, HandshakeResponse, PasswdAuthRequest, PasswdAuthResponse,
    Reply, TcpRequestHeader, TcpResponseHeader, UdpAssociateHeader,
};
use std::collections::HashMap;
use std::io::{Cursor, Read, Result};
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
use std::sync::Arc;
use std::task::{Context, Poll};
use tokio::io::{AsyncReadExt, ReadBuf};
use tokio::net::TcpStream as TokioTcpStream;
use tokio::time::{interval, sleep, Duration};

#[derive(Clone, Debug)]
pub struct Socks5Inbound {
    addr: SocketAddr,
    accounts: HashMap<String, String>,
    udp_enabled: bool,
}

impl Socks5Inbound {
    pub fn new(addr: SocketAddr, accounts: HashMap<String, String>, udp_enabled: bool) -> Self {
        Self {
            addr,
            accounts,
            udp_enabled,
        }
    }

    fn auth(&self, user: &String, pass: &String) -> bool {
        if self.accounts.is_empty() {
            true
        } else {
            if let Some(stored_pass) = self.accounts.get(user) {
                return stored_pass == pass;
            }
            false
        }
    }

    pub async fn handle_tcp(
        &self,
        mut stream: TokioTcpStream,
        peer_addr: SocketAddr,
        context: AppContext,
    ) -> Result<()> {
        // 1. Handshake
        let request = match HandshakeRequest::read_from(&mut stream).await {
            Ok(r) => r,
            Err(err) => {
                return Err(err.into());
            }
        };

        match request.methods.first() {
            Some(&socks5::SOCKS5_AUTH_METHOD_NONE) => {
                if !self.accounts.is_empty() {
                    return Err(invalid_data_error("Socks5 authentication is enabled"));
                }
                let response = HandshakeResponse::new(socks5::SOCKS5_AUTH_METHOD_NONE);
                response.write_to(&mut stream).await?;
            }
            Some(&socks5::SOCKS5_AUTH_METHOD_PASSWORD) => {
                let response = HandshakeResponse::new(socks5::SOCKS5_AUTH_METHOD_PASSWORD);
                response.write_to(&mut stream).await?;
                let request = match PasswdAuthRequest::read_from(&mut stream).await {
                    Ok(p) => p,
                    Err(err) => {
                        let response = PasswdAuthResponse::new(err.as_reply().as_u8());
                        let _ = response.write_to(&mut stream).await;
                        return Err(invalid_data_error(format!(
                            "Socks5 authentication request failed: {err}"
                        )));
                    }
                };
                const PASSWORD_AUTH_STATUS_FAILURE: u8 = 255;
                let user_name = match String::from_utf8(request.uname) {
                    Ok(u) => u,
                    Err(..) => {
                        let response = PasswdAuthResponse::new(PASSWORD_AUTH_STATUS_FAILURE);
                        let _ = response.write_to(&mut stream).await;
                        return Err(invalid_data_error(
                            "Socks5 Username/Password Authentication Initial request uname contains invalid characters",
                        ));
                    }
                };

                let password = match String::from_utf8(request.passwd) {
                    Ok(u) => u,
                    Err(..) => {
                        let response = PasswdAuthResponse::new(PASSWORD_AUTH_STATUS_FAILURE);
                        let _ = response.write_to(&mut stream).await;
                        return Err(invalid_data_error(
                            "Socks5 Username/Password Authentication Initial request passwd contains invalid characters",
                        ));
                    }
                };
                if self.auth(&user_name, &password) {
                    let response = PasswdAuthResponse::new(0);
                    response.write_to(&mut stream).await?;
                } else {
                    let response = PasswdAuthResponse::new(PASSWORD_AUTH_STATUS_FAILURE);
                    response.write_to(&mut stream).await?;
                    return Err(invalid_data_error(format!(
                        "Socks5 Username/Password Authentication failed, user: {user_name}, password: {password}"
                    )));
                }
            }
            method => {
                let response = HandshakeResponse::new(socks5::SOCKS5_AUTH_METHOD_NOT_ACCEPTABLE);
                response.write_to(&mut stream).await?;
                return Err(invalid_data_error(format!(
                    "Unsupported socks5 authentication method {:?}",
                    method
                )));
            }
        }

        // 2. Fetch headers
        let request = match TcpRequestHeader::read_from(&mut stream).await {
            Ok(h) => h,
            Err(err) => {
                let response =
                    TcpResponseHeader::new(err.as_reply(), Address::SocketAddress(peer_addr));
                response.write_to(&mut stream).await?;
                return Err(err.into());
            }
        };
        let address = request.address;

        // 3. Handle Command
        match request.command {
            Command::TcpConnect => {
                let mut down_stream = match connect_tcp_host(&peer_addr, address, context).await {
                    Ok(s) => {
                        let response = TcpResponseHeader::new(
                            Reply::Succeeded,
                            Address::SocketAddress(s.local_addr()?),
                        );
                        response.write_to(&mut stream).await?;
                        s
                    }
                    Err(e) => {
                        let dummy_address = SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), 0);
                        let response = TcpResponseHeader::new(
                            Reply::NetworkUnreachable,
                            Address::SocketAddress(dummy_address),
                        );
                        response.write_to(&mut stream).await?;
                        return Err(e);
                    }
                };
                let mut stream = Box::new(stream);
                copy_bidirectional(&mut stream, &mut down_stream)
                    .await
                    .map(|_| ())
            }
            Command::UdpAssociate => {
                if !self.udp_enabled {
                    let response = TcpResponseHeader::new(Reply::CommandNotSupported, address);
                    response.write_to(&mut stream).await?;
                    return Ok(());
                }
                let response = TcpResponseHeader::new(Reply::Succeeded, self.addr.into());
                response.write_to(&mut stream).await?;

                // Hold connection until EOF
                let mut buffer = [0u8; 2048];
                loop {
                    let n = stream.read(&mut buffer).await?;
                    if n == 0 {
                        break;
                    }
                }
                Ok(())
            }
            Command::TcpBind => {
                let response = TcpResponseHeader::new(Reply::CommandNotSupported, address);
                response.write_to(&mut stream).await?;
                Err(invalid_data_error("Socks5 tcp bind is not supported"))
            }
        }
    }

    pub async fn handle_udp(&self, socket: Arc<UdpSocket>, context: AppContext) -> Result<()> {
        let (mut manager, cleanup_interval, mut keepalive_rx) = NatManager::new(
            Socks5UdpInboundWriter {
                inbound: socket.clone(),
            },
            context,
        );
        let mut buffer = [0u8; MAXIMUM_UDP_PAYLOAD_SIZE];
        let mut cleanup_timer = interval(cleanup_interval);
        loop {
            tokio::select! {
                recv_result = socket.recv_from(&mut buffer) => {
                    let (n, peer_addr) = match recv_result {
                        Ok(s) => s,
                        Err(err) => {
                            log::error!("udp server recv_from failed with error: {}", err);
                            sleep(Duration::from_secs(1)).await;
                            continue;
                        }
                    };

                    let data = &buffer[..n];

                    // PKT = UdpAssociateHeader + PAYLOAD
                    let mut cur = Cursor::new(data);
                    let header = match UdpAssociateHeader::read_from(&mut cur).await {
                        Ok(h) => h,
                        Err(..) => {
                            log::error!("received invalid UDP associate packet");
                            continue;
                        }
                    };

                    if header.frag != 0 {
                        log::error!("received UDP associate with frag != 0, which is not supported");
                        continue;
                    }

                    let pos = cur.position() as usize;
                    let payload = &data[pos..];

                    log::trace!(
                        "UDP ASSOCIATE {} -> {}, {} bytes",
                        peer_addr,
                        header.address,
                        payload.len()
                    );

                    if let Err(err) = manager.send_to(peer_addr, header.address, payload).await {
                        log::error!(
                            "udp packet from {} relay {} bytes failed, error: {}",
                            peer_addr,
                            data.len(),
                            err
                        );
                    }
                }

                _ = cleanup_timer.tick() => {
                    // cleanup expired associations. iter() will remove expired elements
                    manager.cleanup_expired().await;
                }

                peer_addr_opt = keepalive_rx.recv() => {
                    let peer_addr = peer_addr_opt.expect("keep-alive channel closed unexpectly");
                    manager.keep_alive(&peer_addr).await;
                }
            }
        }
    }
}

#[derive(Clone)]
struct Socks5UdpInboundWriter {
    inbound: Arc<UdpSocket>,
}

impl UdpInboundWrite for Socks5UdpInboundWriter {
    async fn send_to(
        &self,
        peer_addr: SocketAddr,
        remote_addr: &Address,
        data: &[u8],
    ) -> Result<()> {
        let remote_addr = match remote_addr {
            Address::SocketAddress(sa) => {
                // Try to convert IPv4 mapped IPv6 address if server is running on dual-stack mode
                let saddr = match *sa {
                    SocketAddr::V4(..) => *sa,
                    SocketAddr::V6(ref v6) => match Ipv6Addr::to_ipv4_mapped(v6.ip()) {
                        Some(v4) => SocketAddr::new(IpAddr::from(v4), v6.port()),
                        None => *sa,
                    },
                };

                Address::SocketAddress(saddr)
            }
            daddr => daddr.clone(),
        };

        // Reassemble packet
        let mut payload_buffer = BytesMut::new();
        let header = UdpAssociateHeader::new(0, remote_addr.clone());
        payload_buffer.reserve(header.serialized_len() + data.len());

        header.write_to_buf(&mut payload_buffer);
        payload_buffer.put_slice(data);

        self.inbound
            .send_to(&payload_buffer, peer_addr)
            .await
            .map(|_| ())
    }
}

#[derive(Clone, Debug)]
pub struct Socks5Outbound {
    addr: Address,
    accounts: HashMap<String, String>,
    transport_settings: TransportSettings,
}

impl Socks5Outbound {
    pub fn new(
        addr: Address,
        accounts: Vec<SocksUser>,
        transport_settings: TransportSettings,
    ) -> Self {
        let accounts: HashMap<_, _> = accounts.into_iter().map(|s| (s.user, s.pass)).collect();
        Self {
            addr,
            accounts,
            transport_settings,
        }
    }

    pub async fn connect(
        &self,
        server_addr: &SocketAddr,
        command: Command,
        target: Address,
    ) -> Result<(TcpResponseHeader, Box<dyn ProxyStream>)> {
        let mut stream = self
            .transport_settings
            .connect_tcp(server_addr, false)
            .await?;

        let mut auth_method = socks5::SOCKS5_AUTH_METHOD_NONE;
        if !self.accounts.is_empty() {
            auth_method = socks5::SOCKS5_AUTH_METHOD_PASSWORD;
        }
        let request = HandshakeRequest::new(vec![auth_method]);
        request.write_to(&mut stream).await?;
        let response = HandshakeResponse::read_from(&mut stream).await?;

        if response.chosen_method != auth_method {
            return Err(invalid_data_error("Socks5 handshake method dose not match"));
        }

        if auth_method == socks5::SOCKS5_AUTH_METHOD_PASSWORD {
            todo!("socks5 auth");
        }

        // 2. Send request header
        let request = TcpRequestHeader::new(command, target);
        request.write_to(&mut stream).await?;
        let response = TcpResponseHeader::read_from(&mut stream).await?;
        Ok((response, stream))
    }
}

#[async_trait]
impl Outbound for Socks5Outbound {
    fn protocol(&self) -> OutboundProtocolOption {
        OutboundProtocolOption::Socks
    }

    async fn pre_connect(&self, dns: &DnsManager) -> Result<Option<Box<dyn Outbound>>> {
        if matches!(self.addr, Address::DomainNameAddress(_, _)) {
            let addr = dns.resolve(&self.addr).await?;
            let mut outbound = self.clone();
            outbound.addr = Address::SocketAddress(addr);
            Ok(Some(Box::new(outbound) as Box<dyn Outbound>))
        } else {
            Ok(None)
        }
    }

    async fn connect_tcp(&self, addr: Address) -> Result<Box<dyn ProxyStream>> {
        let server_addr = pre_check_addr!(self.addr);
        let (response, stream) = self.connect(server_addr, Command::TcpConnect, addr).await?;

        match response.reply {
            Reply::Succeeded => {
                log::debug!("Connected to socks5 tcp server: {}", response.address);
                Ok(stream)
            }
            reply => Err(invalid_data_error(format!(
                "Unable to connect to socks, reply error: {}",
                reply
            ))),
        }
    }

    async fn bind(&self, _peer: SocketAddr, _target: Address) -> Result<Box<dyn ProxySocket>> {
        let server_addr = pre_check_addr!(self.addr);
        let socket = UdpSocket::connect_any_with_opts(
            server_addr,
            self.transport_settings.get_connect_opts(),
        )
        .await?;
        let addr = socket.local_addr()?;
        let (response, stream) = self
            .connect(server_addr, Command::UdpAssociate, addr.into())
            .await?;
        match response.reply {
            Reply::Succeeded => {
                match response.address {
                    Address::SocketAddress(addr) => {
                        socket.connect(addr).await?;
                    }
                    Address::DomainNameAddress(_, _) => unimplemented!(),
                }
                log::debug!("Connected to socks5 udp server: {}", response.address);

                let socks5_socket = Socks5Socket::new(socket, stream);
                Ok(Box::new(socks5_socket) as Box<dyn ProxySocket>)
            }
            reply => Err(invalid_data_error(format!(
                "Inable to bind sock, reply error: {}",
                reply
            ))),
        }
    }
}

pub struct Socks5Socket {
    socket: UdpSocket,
    // Socks5 protocol requires to keep the TcpStream open
    _stream: Box<dyn ProxyStream>,
}

impl Socks5Socket {
    pub fn new(socket: UdpSocket, _stream: Box<dyn ProxyStream>) -> Self {
        Self { socket, _stream }
    }
}

impl ProxySocket for Socks5Socket {
    fn poll_recv_from(&self, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>) -> Poll<Result<Address>> {
        let mut cache = vec![0u8; buf.remaining()];
        let mut buffer = ReadBuf::new(cache.as_mut());
        ready!(self.socket.poll_recv(cx, &mut buffer))?;
        let cache_len = buffer.filled().len();
        let mut cur = Cursor::new(buffer.filled());
        let mut buffer = [0u8; 3];
        Read::read_exact(&mut cur, &mut buffer)?;
        //let frag = buffer[2];
        let address = Address::read_cursor(&mut cur)?;
        let pos = cur.position() as usize;
        buf.put_slice(&cache[pos..cache_len]);
        Ok(address).into()
    }

    fn poll_send_to(
        &self,
        cx: &mut Context<'_>,
        buf: &[u8],
        target: Address,
    ) -> Poll<Result<usize>> {
        // TODO: support frag
        let header = UdpAssociateHeader::new(0, target);
        let header_len = header.serialized_len();
        let mut send_buf = BytesMut::with_capacity(header.serialized_len() + buf.len());
        header.write_to_buf(&mut send_buf);
        send_buf.put_slice(buf);
        self.socket
            .poll_send(cx, &send_buf)
            .map_ok(|n| n.saturating_sub(header_len))
    }
}