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
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
use super::config::{DnsConfig, QueryStrategy};
use super::dat::GeoSiteList;
use super::env_vars::RESOURCES_DIR;
use super::router::{Domain, MatchType, Router};
use crate::app::proxy::Outbounds;
use crate::common::{
    far_future_instant, invalid_data_error, invalid_input_error, Address, MAXIMUM_UDP_PAYLOAD_SIZE,
};
use crate::proxy::{Outbound, ProxySocket, ProxyStream};
use futures::ready;
use hickory_resolver::config::{
    LookupIpStrategy, NameServerConfig, NameServerConfigGroup, ResolverConfig, ResolverOpts,
};
use hickory_resolver::name_server::GenericConnector;
use hickory_resolver::proto::op::Message as DnsMessage;
use hickory_resolver::proto::runtime::iocompat::AsyncIoTokioAsStd;
use hickory_resolver::proto::runtime::{RuntimeProvider, TokioHandle, TokioTime};
use hickory_resolver::proto::xfer::Protocol;
use hickory_resolver::system_conf::read_system_conf;
use hickory_resolver::IntoName;
use hickory_resolver::Resolver;
use prost::Message;
use regex::Regex;
use std::cell::LazyCell;
use std::collections::HashMap;
use std::future::{poll_fn, Future};
use std::io::{Error, ErrorKind, Result};
use std::net::{IpAddr, SocketAddr};
use std::path::PathBuf;
use std::pin::Pin;
use std::str::FromStr;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::io::ReadBuf;
use tokio::sync::RwLock;

pub struct DnsManager {
    // TODO: replace with other Cache
    cache: RwLock<HashMap<String, (Instant, IpAddr)>>,
    hosts: Vec<(Domain, Vec<IpAddr>)>,
    // Try to use these resolvers if domain matches
    servers_pior: Vec<(Domain, DnsServer)>,
    servers: Vec<DnsServer>,
}

#[derive(Clone)]
struct DnsServer {
    pub resolver: Arc<DnsResolver>,
    pub outbound: Arc<Box<dyn Outbound>>,
    pub addr: SocketAddr,
}

impl DnsManager {
    pub async fn new(config: DnsConfig, outbounds: &Outbounds, router: &Router) -> Result<Self> {
        let mut cache: HashMap<String, (Instant, IpAddr)> = HashMap::new();
        let mut hosts: Vec<(Domain, Vec<IpAddr>)> = Vec::new();
        for host in config.hosts {
            let mut ips: Vec<IpAddr> = Vec::new();
            for ip in host.1 {
                let ip = ip
                    .parse()
                    .map_err(|_| invalid_input_error(format!("Invalid ip: {}", ip)))?;
                ips.push(ip);
            }
            let domains = parse_domain(host.0)?;
            for domain in domains.into_iter() {
                match domain.match_type {
                    MatchType::FullDomain(domain) => {
                        cache.insert(domain, (far_future_instant(), pick_up_ip(ips.clone())?));
                    }
                    _ => hosts.push((domain, ips.clone())),
                }
            }
        }

        let mut servers_pior = Vec::new();
        let mut servers = Vec::new();

        if config.servers.is_empty() {
            if let Ok((sys_config, sys_opts)) = read_system_conf() {
                let mut resolvers = Vec::new();
                for server in sys_config.name_servers() {
                    let mut resolver_config = ResolverConfig::from_parts(
                        sys_config.domain().cloned(),
                        sys_config.search().to_owned(),
                        NameServerConfigGroup::new(),
                    );
                    resolver_config.add_name_server(server.clone());
                    resolvers.push(
                        build_resolver(
                            false,
                            server.socket_addr,
                            &config.tag,
                            &config.local_outbound_tag,
                            outbounds,
                            router,
                            resolver_config,
                            sys_opts.clone(),
                        )
                        .await?,
                    );
                }
                resolvers
                    .into_iter()
                    .for_each(|resolver| servers.push(resolver));
            }
        }

        let mut options = ResolverOpts::default();
        options.edns0 = true;
        options.ip_strategy = LookupIpStrategy::from(config.query_strategy);

        // TODO: Support pre-defined dns config e.g. google/cloudflare/quad9 https/tls
        for server in config.servers {
            let mut resolver_config = ResolverConfig::new();

            let resolvers = if let Some(i) = server.address.find("://") {
                let prefix = server.address[..i].to_string();
                let addr = format!("{}:{}", &server.address[(i + 3)..], server.port);
                let addr = SocketAddr::from_str(&addr).map_err(|_| {
                    invalid_input_error(format!("Invalid socket address: {}", addr))
                })?;
                let routable = !prefix.contains("local");
                let protocol = if prefix == "local" {
                    Protocol::Udp
                } else if prefix.contains("tcp") {
                    Protocol::Tcp
                } else if prefix.contains("udp") {
                    Protocol::Udp
                } else {
                    todo!("support doh/doq")
                };
                let name_server = NameServerConfig::new(addr, protocol);
                resolver_config.add_name_server(name_server);
                vec![
                    build_resolver(
                        routable,
                        addr,
                        &config.tag,
                        &config.local_outbound_tag,
                        outbounds,
                        router,
                        resolver_config,
                        options.clone(),
                    )
                    .await?,
                ]
            } else if server.address == "localhost" {
                let mut output = Vec::new();
                if let Ok((sys_config, sys_opts)) = read_system_conf() {
                    for server in sys_config.name_servers() {
                        let mut resolver_config = ResolverConfig::from_parts(
                            sys_config.domain().cloned(),
                            sys_config.search().to_owned(),
                            NameServerConfigGroup::new(),
                        );
                        resolver_config.add_name_server(server.clone());
                        output.push(
                            build_resolver(
                                false,
                                server.socket_addr,
                                &config.tag,
                                &config.local_outbound_tag,
                                outbounds,
                                router,
                                resolver_config,
                                sys_opts.clone(),
                            )
                            .await?,
                        );
                    }
                }
                output
            } else {
                let addr = format!("{}:{}", server.address, server.port);
                let addr = SocketAddr::from_str(&addr).map_err(|_| {
                    invalid_input_error(format!("Invalid socket address: {}", addr))
                })?;
                let protocol = Protocol::Udp;
                let name_server = NameServerConfig::new(addr, protocol);
                resolver_config.add_name_server(name_server);
                vec![
                    build_resolver(
                        true,
                        addr,
                        &config.tag,
                        &config.local_outbound_tag,
                        outbounds,
                        router,
                        resolver_config,
                        options.clone(),
                    )
                    .await?,
                ]
            };

            if server.domains.is_empty() {
                resolvers
                    .into_iter()
                    .for_each(|resolver| servers.push(resolver));
            } else {
                for domain in server.domains {
                    let domains = parse_domain(domain)?;
                    domains.into_iter().for_each(|d: Domain| {
                        resolvers
                            .iter()
                            .for_each(|resolver| servers_pior.push((d.clone(), resolver.clone())));
                    });
                }
            }
        }
        Ok(Self {
            cache: RwLock::new(cache),
            hosts,
            servers_pior,
            servers,
        })
    }

    pub async fn resolve(&self, addr: &Address) -> Result<SocketAddr> {
        let (domain, port) = match addr {
            Address::DomainNameAddress(domain, port) => (domain, port),
            Address::SocketAddress(addr) => return Ok(*addr),
        };
        let read_lock = self.cache.read().await;
        let ip_entry = read_lock.get(domain).map(|v| v.to_owned());
        drop(read_lock);

        if let Some(v) = ip_entry {
            if v.0 < Instant::now() {
                self.cache.write().await.remove(domain);
            } else {
                log::debug!("Hit dns cache {} for domain {}", v.1, domain);
                let addr = SocketAddr::new(v.1, *port);
                return Ok(addr);
            }
        }
        for host in self.hosts.iter() {
            if host.0.matches(domain, None) {
                let ip = pick_up_ip(host.1.clone())?;
                log::debug!("Found static dns record {} for domain {}", ip, domain,);
                self.cache
                    .write()
                    .await
                    .insert(domain.clone(), (far_future_instant(), ip));
                let addr = SocketAddr::new(ip, *port);
                return Ok(addr);
            }
        }
        for server in self.servers_pior.iter() {
            if server.0.matches(domain, None) {
                let name = format!("{}.", domain);
                let name = name.into_name()?;
                match server.1.resolver.lookup_ip(name).await {
                    Ok(result) => {
                        let validity: Instant = result.valid_until();
                        let ips: Vec<IpAddr> = result.into_iter().collect();
                        let ip = pick_up_ip(ips)?;
                        log::debug!("Got dns record {} for domain {}", ip, domain);
                        self.cache
                            .write()
                            .await
                            .insert(domain.clone(), (validity, ip));
                        let addr = SocketAddr::new(ip, *port);
                        return Ok(addr);
                    }
                    Err(e) => {
                        log::warn!("Failed to lookup ip for {}, error: {}", domain, e)
                    }
                }
            }
        }
        for server in self.servers.iter() {
            let name = format!("{}.", domain);
            let name = name.into_name()?;
            match server.resolver.lookup_ip(name).await {
                Ok(result) => {
                    let validity: Instant = result.valid_until();
                    let ips: Vec<IpAddr> = result.into_iter().collect();
                    let ip = pick_up_ip(ips)?;
                    log::debug!("Got dns record {} for domain {}", ip, domain);
                    self.cache
                        .write()
                        .await
                        .insert(domain.clone(), (validity, ip));
                    let addr = SocketAddr::new(ip, *port);
                    return Ok(addr);
                }
                Err(e) => {
                    log::warn!("Failed to lookup ip for {}, error: {}", domain, e)
                }
            }
        }

        Err(Error::new(
            ErrorKind::NotFound,
            format!("Unable to resolve ip for addr: {}:{}", domain, port),
        ))
    }

    pub async fn query(&self, peer_addr: SocketAddr, request: &DnsMessage) -> Result<DnsMessage> {
        let query = &request.queries()[0];
        let domain = query.name().to_string().trim_end_matches('.').to_string();
        for server in self.servers_pior.iter() {
            if server.0.matches(&domain, None) {
                match query_message(
                    &server.1.outbound,
                    peer_addr,
                    server.1.addr,
                    request.clone(),
                )
                .await
                {
                    Ok(message) => {
                        return Ok(message);
                    }
                    Err(e) => {
                        log::warn!(
                            "Failed to query dns message for {}, error: {}",
                            peer_addr,
                            e
                        )
                    }
                }
            }
        }
        for server in self.servers.iter() {
            match query_message(&server.outbound, peer_addr, server.addr, request.clone()).await {
                Ok(message) => {
                    return Ok(message);
                }
                Err(e) => {
                    log::warn!(
                        "Failed to query dns message for {}, error: {}",
                        peer_addr,
                        e
                    )
                }
            }
        }
        Err(invalid_data_error("Failed to query dns message"))
    }
}

fn pick_up_ip(ips: Vec<IpAddr>) -> Result<IpAddr> {
    // TODO:
    // Happy Eyeballs, RFC6555, RFC8305
    //
    // RFC6555 gives an example that Chrome and Firefox uses 300ms
    if ips.is_empty() {
        Err(invalid_input_error("Unable to pick up an ip address"))
    } else {
        for ip in ips {
            if ip.is_ipv4() {
                return Ok(ip);
            }
        }
        Err(invalid_input_error("Unable to pick up an ipv4 adress"))
    }
}

async fn query_message(
    outbound: &Arc<Box<dyn Outbound>>,
    peer_addr: SocketAddr,
    target_addr: SocketAddr,
    request: DnsMessage,
) -> Result<DnsMessage> {
    let socket = outbound
        .bind(peer_addr, Address::SocketAddress(target_addr))
        .await?;
    poll_fn(|cx| socket.poll_send_to(cx, &request.to_vec()?, target_addr)).await?;
    let mut buf = [0u8; MAXIMUM_UDP_PAYLOAD_SIZE];
    let (n, _) = poll_fn(|cx| socket.poll_recv_from(cx, &mut buf)).await?;
    let message = DnsMessage::from_vec(&buf[..n])?;
    Ok(message)
}

#[allow(clippy::too_many_arguments)]
async fn build_resolver(
    routable: bool,
    dns_server_addr: SocketAddr,
    dns_tag: &Option<String>,
    dns_outbound_tag: &Option<String>,
    outbounds: &Outbounds,
    router: &Router,
    resolver_config: ResolverConfig,
    resolver_opts: ResolverOpts,
) -> Result<DnsServer> {
    let outbound = if routable {
        let addr = Address::SocketAddress(dns_server_addr);
        let tag = router.pick_as_is(&addr, dns_tag).await;
        outbounds.get(&tag).unwrap().clone()
    } else if let Some(tag) = dns_outbound_tag {
        outbounds
            .get(tag)
            .ok_or_else(|| {
                invalid_input_error(format!("Invalid local outbound tag of {} set for dns", tag))
            })?
            .clone()
    } else {
        outbounds.first_freedom().ok_or_else(|| {
            invalid_input_error("Freedom outbound is required for current dns config")
        })?
    };
    let name_server = resolver_config.name_servers().first().unwrap();
    let target_addr = name_server.socket_addr;
    Ok(DnsServer {
        resolver: Arc::new(create_resolver(
            resolver_config,
            resolver_opts,
            outbound.clone(),
        )),
        outbound,
        addr: target_addr,
    })
}

impl From<QueryStrategy> for LookupIpStrategy {
    fn from(value: QueryStrategy) -> Self {
        match value {
            QueryStrategy::UseIP => LookupIpStrategy::Ipv4AndIpv6,
            QueryStrategy::UseIPv4 => LookupIpStrategy::Ipv4Only,
            QueryStrategy::UseIPv6 => LookupIpStrategy::Ipv6Only,
        }
    }
}

fn parse_domain(mut domain: String) -> Result<Vec<Domain>> {
    let geo_site_list: LazyCell<GeoSiteList> = LazyCell::new(|| {
        let path = PathBuf::from(std::env::var(RESOURCES_DIR).expect(RESOURCES_DIR));
        let bytes = std::fs::read(path.join("geosite.dat")).expect("geosite.dat");
        GeoSiteList::decode(bytes.as_ref()).expect("geo_site_list")
    });
    let domains = if domain.starts_with("regexp:") {
        let regex = domain.split_off(7).to_lowercase();
        let regex = Regex::new(&regex)
            .map_err(|_| invalid_input_error(format!("Invalid regex value of {}", regex)))?;
        vec![Domain::new(MatchType::Regex(regex))]
    } else if domain.starts_with("domain:") {
        let domain = domain.split_off(7).to_lowercase();
        vec![Domain::new(MatchType::SubDomain(domain))]
    } else if domain.starts_with("keyword:") {
        let domain = domain.split_off(8).to_lowercase();
        vec![Domain::new(MatchType::Substr(domain))]
    } else if domain.starts_with("geosite:") {
        let code = domain.split_off(8).to_lowercase();
        match geo_site_list
            .entry
            .iter()
            .find(|item| item.country_code.to_lowercase() == code)
        {
            Some(geo_site) => {
                let mut domains = Vec::<Domain>::new();
                for item in geo_site.domain.iter() {
                    match Domain::try_from(item.to_owned()) {
                        Ok(domain) => {
                            domains.push(domain);
                        }
                        Err(e) => {
                            log::warn!(
                                "Invalid domain {} in code {}, error: {}",
                                item.value,
                                code,
                                e
                            );
                        }
                    }
                }
                domains
            }
            None => {
                return Err(invalid_input_error(format!(
                    "Geosite does not contain the code of {}",
                    code
                )))
            }
        }
    } else {
        vec![Domain::new(MatchType::FullDomain(domain))]
    };
    Ok(domains)
}

#[derive(Clone)]
struct DnsRuntimeProvider {
    handle: TokioHandle,
    outbound: Arc<Box<dyn Outbound>>,
}

impl DnsRuntimeProvider {
    pub fn new(outbound: Arc<Box<dyn Outbound>>) -> Self {
        Self {
            handle: TokioHandle::default(),
            outbound,
        }
    }
}

impl RuntimeProvider for DnsRuntimeProvider {
    type Handle = TokioHandle;
    //type Tcp = AsyncIoTokioAsStd<SyncProxyStream<Box<dyn ProxyStream>>>;
    type Tcp = AsyncIoTokioAsStd<Box<dyn ProxyStream>>;
    type Timer = TokioTime;
    type Udp = Box<dyn ProxySocket>;

    fn create_handle(&self) -> Self::Handle {
        self.handle.clone()
    }

    fn connect_tcp(
        &self,
        server_addr: SocketAddr,
        _bind_addr: Option<SocketAddr>,
        wait_for: Option<Duration>,
    ) -> Pin<Box<dyn Send + Future<Output = Result<Self::Tcp>>>> {
        let wait_for = wait_for.unwrap_or_else(|| Duration::from_secs(5));
        let outbound = self.outbound.clone();

        Box::pin(async move {
            let addr = Address::SocketAddress(server_addr);
            let stream = match tokio::time::timeout(wait_for, outbound.connect_tcp(addr)).await {
                Ok(Ok(s)) => s,
                Ok(Err(err)) => return Err(err),
                Err(_) => return Err(ErrorKind::TimedOut.into()),
            };
            //let stream = SyncProxyStream::new(stream);
            Ok(AsyncIoTokioAsStd(stream))
        })
    }

    fn bind_udp(
        &self,
        local_addr: SocketAddr,
        server_addr: SocketAddr,
    ) -> Pin<Box<dyn Send + Future<Output = Result<Self::Udp>>>> {
        let outbound = self.outbound.clone();
        Box::pin(async move {
            // It doesn't matter what passed as peer to outbound.bind, as:
            // 1. NAT type doesn't matter
            // 2. It is one-time back and forth communication
            // so just pass local_addr to meet the requirement
            let target = Address::SocketAddress(server_addr);
            let udp = outbound.bind(local_addr, target).await?;
            Ok(udp)
        })
    }
}

type DnsConnectionProvider = GenericConnector<DnsRuntimeProvider>;
type DnsResolver = Resolver<DnsConnectionProvider>;

fn create_resolver(
    config: ResolverConfig,
    options: ResolverOpts,
    outbound: Arc<Box<dyn Outbound>>,
) -> DnsResolver {
    let mut builder = DnsResolver::builder_with_config(
        config,
        DnsConnectionProvider::new(DnsRuntimeProvider::new(outbound)),
    );
    *builder.options_mut() = options;
    builder.build()
}

use hickory_resolver::proto::udp::DnsUdpSocket;
use std::task::{Context, Poll};
impl DnsUdpSocket for Box<dyn ProxySocket> {
    type Time = hickory_resolver::proto::runtime::TokioTime;

    fn poll_recv_from(
        &self,
        cx: &mut Context<'_>,
        buf: &mut [u8],
    ) -> Poll<Result<(usize, SocketAddr)>> {
        let mut buffer = ReadBuf::new(buf);
        let addr = ready!(ProxySocket::poll_recv_from(self.as_ref(), cx, &mut buffer))?;
        let len = buffer.filled().len();
        let socket_addr = match addr {
            Address::SocketAddress(addr) => addr,
            Address::DomainNameAddress(_, _) => unreachable!(),
        };
        Poll::Ready(Ok((len, socket_addr)))
    }

    fn poll_send_to(
        &self,
        cx: &mut Context<'_>,
        buf: &[u8],
        target: SocketAddr,
    ) -> Poll<Result<usize>> {
        ProxySocket::poll_send_to(self.as_ref(), cx, buf, Address::SocketAddress(target))
    }
}