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
// Copyright 2015-2017 Benjamin Fry <benjaminfry@me.com>
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//! Configuration for a resolver
use std::fmt;
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
use std::ops::{Deref, DerefMut};
use std::time::Duration;
#[cfg(feature = "dns-over-rustls")]
use std::sync::Arc;
use proto::rr::Name;
#[cfg(feature = "dns-over-rustls")]
use rustls::ClientConfig;
#[cfg(all(feature = "serde-config", feature = "dns-over-rustls"))]
use serde::{
de::{Deserialize as DeserializeT, Deserializer},
ser::{Serialize as SerializeT, Serializer},
};
/// Configuration for the upstream nameservers to use for resolution
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde-config", derive(Serialize, Deserialize))]
pub struct ResolverConfig {
// base search domain
#[cfg_attr(feature = "serde-config", serde(default))]
domain: Option<Name>,
// search domains
#[cfg_attr(feature = "serde-config", serde(default))]
search: Vec<Name>,
// nameservers to use for resolution.
name_servers: NameServerConfigGroup,
}
impl ResolverConfig {
/// Creates a new empty configuration
pub fn new() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::new(),
}
}
/// Creates a default configuration, using `8.8.8.8`, `8.8.4.4` and `2001:4860:4860::8888`, `2001:4860:4860::8844` (thank you, Google).
///
/// Please see Google's [privacy statement](https://developers.google.com/speed/public-dns/privacy) for important information about what they track, many ISP's track similar information in DNS. To use the system configuration see: `Resolver::from_system_conf` and `AsyncResolver::from_system_conf`
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
pub fn google() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::google(),
}
}
/// Creates a default configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare).
///
/// Please see: <https://www.cloudflare.com/dns/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
pub fn cloudflare() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::cloudflare(),
}
}
/// Creates a configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare). This limits the registered connections to just TLS lookups
///
/// Please see: <https://www.cloudflare.com/dns/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
pub fn cloudflare_tls() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::cloudflare_tls(),
}
}
/// Creates a configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare). This limits the registered connections to just HTTPS lookups
///
/// Please see: <https://www.cloudflare.com/dns/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn cloudflare_https() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::cloudflare_https(),
}
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings (thank you, Quad9).
///
/// Please see: <https://www.quad9.net/faq/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
pub fn quad9() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::quad9(),
}
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings. This limits the registered connections to just TLS lookups
///
/// Please see: <https://www.quad9.net/faq/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
pub fn quad9_tls() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::quad9_tls(),
}
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings. This limits the registered connections to just HTTPS lookups
///
/// Please see: <https://www.quad9.net/faq/>
///
/// NameServerConfigGroups can be combined to use a set of different providers, see `NameServerConfigGroup` and `ResolverConfig::from_parts`
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn quad9_https() -> Self {
Self {
// TODO: this should get the hostname and use the basename as the default
domain: None,
search: vec![],
name_servers: NameServerConfigGroup::quad9_https(),
}
}
/// Create a ResolverConfig with all parts specified
///
/// # Arguments
///
/// * `domain` - domain of the entity querying results. If the `Name` being looked up is not an FQDN, then this is the first part appended to attempt a lookup. `ndots` in the `ResolverOption` does take precedence over this.
/// * `search` - additional search domains that are attempted if the `Name` is not found in `domain`, defaults to `vec![]`
/// * `name_servers` - set of name servers to use for lookups, defaults are Google: `8.8.8.8`, `8.8.4.4` and `2001:4860:4860::8888`, `2001:4860:4860::8844`
pub fn from_parts<G: Into<NameServerConfigGroup>>(
domain: Option<Name>,
search: Vec<Name>,
name_servers: G,
) -> Self {
Self {
domain,
search,
name_servers: name_servers.into(),
}
}
/// Returns the local domain
///
/// By default any names will be appended to all non-fully-qualified-domain names, and searched for after any ndots rules
pub fn domain(&self) -> Option<&Name> {
self.domain.as_ref()
}
/// Set the domain of the entity querying results.
pub fn set_domain(&mut self, domain: Name) {
self.domain = Some(domain.clone());
self.search = vec![domain];
}
/// Returns the search domains
///
/// These will be queried after any local domain and then in the order of the set of search domains
pub fn search(&self) -> &[Name] {
&self.search
}
/// Add a search domain
pub fn add_search(&mut self, search: Name) {
self.search.push(search)
}
// TODO: consider allowing options per NameServer... like different timeouts?
/// Add the configuration for a name server
pub fn add_name_server(&mut self, name_server: NameServerConfig) {
self.name_servers.push(name_server);
}
/// Returns a reference to the name servers
pub fn name_servers(&self) -> &[NameServerConfig] {
&self.name_servers
}
/// return the associated TlsClientConfig
#[cfg(feature = "dns-over-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-rustls")))]
pub fn client_config(&self) -> &Option<TlsClientConfig> {
&self.name_servers.1
}
/// adds the `rustls::ClientConf` for every configured NameServer
/// of the Resolver.
///
/// ```
/// use std::sync::Arc;
///
/// use rustls::{ClientConfig, ProtocolVersion, RootCertStore, OwnedTrustAnchor};
/// use trust_dns_resolver::config::ResolverConfig;
/// use webpki_roots;
///
/// let mut root_store = RootCertStore::empty();
/// root_store.add_server_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.0.iter().map(|ta| {
/// OwnedTrustAnchor::from_subject_spki_name_constraints(
/// ta.subject,
/// ta.spki,
/// ta.name_constraints,
/// )
/// }));
///
/// let mut client_config = ClientConfig::builder()
/// .with_safe_default_cipher_suites()
/// .with_safe_default_kx_groups()
/// .with_protocol_versions(&[&rustls::version::TLS12])
/// .unwrap()
/// .with_root_certificates(root_store)
/// .with_no_client_auth();
///
/// let mut resolver_config = ResolverConfig::quad9_tls();
/// resolver_config.set_tls_client_config(Arc::new(client_config));
/// ```
#[cfg(feature = "dns-over-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-rustls")))]
pub fn set_tls_client_config(&mut self, client_config: Arc<ClientConfig>) {
self.name_servers = self.name_servers.clone().with_client_config(client_config);
}
}
impl Default for ResolverConfig {
/// Creates a default configuration, using `8.8.8.8`, `8.8.4.4` and `2001:4860:4860::8888`, `2001:4860:4860::8844` (thank you, Google).
///
/// Please see Google's [privacy statement](https://developers.google.com/speed/public-dns/privacy) for important information about what they track, many ISP's track similar information in DNS. To use the system configuration see: `Resolver::from_system_conf` and `AsyncResolver::from_system_conf`
fn default() -> Self {
Self::google()
}
}
/// The protocol on which a NameServer should be communicated with
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[cfg_attr(
feature = "serde-config",
derive(Serialize, Deserialize),
serde(rename_all = "lowercase")
)]
#[non_exhaustive]
pub enum Protocol {
/// UDP is the traditional DNS port, this is generally the correct choice
Udp,
/// TCP can be used for large queries, but not all NameServers support it
Tcp,
/// Tls for DNS over TLS
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
Tls,
/// Https for DNS over HTTPS
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
Https,
/// mDNS protocol for performing multicast lookups
#[cfg(feature = "mdns")]
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
Mdns,
}
impl fmt::Display for Protocol {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let protocol = match self {
Protocol::Udp => "udp",
Protocol::Tcp => "tcp",
#[cfg(feature = "dns-over-tls")]
Protocol::Tls => "tls",
#[cfg(feature = "dns-over-https")]
Protocol::Https => "https",
#[cfg(feature = "mdns")]
Protocol::Mdns => "mdns",
};
f.write_str(protocol)
}
}
impl Protocol {
/// Returns true if this is a datagram oriented protocol, e.g. UDP
pub fn is_datagram(self) -> bool {
match self {
Protocol::Udp => true,
Protocol::Tcp => false,
#[cfg(feature = "dns-over-tls")]
Protocol::Tls => false,
#[cfg(feature = "dns-over-https")]
Protocol::Https => false,
#[cfg(feature = "mdns")]
Protocol::Mdns => true,
}
}
/// Returns true if this is a stream oriented protocol, e.g. TCP
pub fn is_stream(self) -> bool {
!self.is_datagram()
}
/// Is this an encrypted protocol, i.e. TLS or HTTPS
pub fn is_encrypted(self) -> bool {
match self {
Protocol::Udp => false,
Protocol::Tcp => false,
#[cfg(feature = "dns-over-tls")]
Protocol::Tls => true,
#[cfg(feature = "dns-over-https")]
Protocol::Https => true,
#[cfg(feature = "mdns")]
Protocol::Mdns => false,
}
}
}
impl Default for Protocol {
/// Default protocol should be UDP, which is supported by all DNS servers
fn default() -> Self {
Self::Udp
}
}
/// a compatibility wrapper around rustls
/// ClientConfig
#[cfg(feature = "dns-over-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-rustls")))]
#[derive(Clone)]
pub struct TlsClientConfig(pub Arc<ClientConfig>);
#[cfg(feature = "dns-over-rustls")]
impl std::cmp::PartialEq for TlsClientConfig {
fn eq(&self, other: &Self) -> bool {
Arc::ptr_eq(&self.0, &other.0)
}
}
#[cfg(feature = "dns-over-rustls")]
impl std::cmp::Eq for TlsClientConfig {}
#[cfg(feature = "dns-over-rustls")]
impl std::fmt::Debug for TlsClientConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "rustls client config")
}
}
/// Configuration for the NameServer
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde-config", derive(Serialize, Deserialize))]
pub struct NameServerConfig {
/// The address which the DNS NameServer is registered at.
pub socket_addr: SocketAddr,
/// The protocol to use when communicating with the NameServer.
#[cfg_attr(feature = "serde-config", serde(default))]
pub protocol: Protocol,
/// SPKI name, only relevant for TLS connections
#[cfg_attr(feature = "serde-config", serde(default))]
pub tls_dns_name: Option<String>,
/// Whether to trust `NXDOMAIN` responses from upstream nameservers.
///
/// When this is `true`, and an empty `NXDOMAIN` response is received, the
/// query will not be retried against other configured name servers.
///
/// (On an empty `NoError` response, or a response with any other error
/// response code, the query will still be retried regardless of this
/// configuration setting.)
///
/// Defaults to false.
#[cfg_attr(feature = "serde-config", serde(default))]
pub trust_nx_responses: bool,
#[cfg(feature = "dns-over-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-rustls")))]
#[cfg_attr(feature = "serde-config", serde(skip))]
/// optional configuration for the tls client
pub tls_config: Option<TlsClientConfig>,
/// The client address (IP and port) to use for connecting to the server.
pub bind_addr: Option<SocketAddr>,
}
impl fmt::Display for NameServerConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}:", self.protocol)?;
if let Some(ref tls_dns_name) = self.tls_dns_name {
write!(f, "{}@", tls_dns_name)?;
}
write!(f, "{}", self.socket_addr)
}
}
/// A set of name_servers to associate with a [`ResolverConfig`].
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(
all(feature = "serde-config", not(feature = "dns-over-rustls")),
derive(Serialize, Deserialize)
)]
pub struct NameServerConfigGroup(
Vec<NameServerConfig>,
#[cfg(feature = "dns-over-rustls")] Option<TlsClientConfig>,
);
#[cfg(all(feature = "serde-config", feature = "dns-over-rustls"))]
impl SerializeT for NameServerConfigGroup {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
self.0.serialize(serializer)
}
}
#[cfg(all(feature = "serde-config", feature = "dns-over-rustls"))]
impl<'de> DeserializeT<'de> for NameServerConfigGroup {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
Vec::deserialize(deserializer).map(|nameservers| Self(nameservers, None))
}
}
impl NameServerConfigGroup {
/// Creates a new `NameServerConfigGroup` with a default size of 2
pub fn new() -> Self {
// this might be a nice opportunity for SmallVec
// most name_server configs will be 2.
Self::with_capacity(2)
}
/// Creates a new `NameServiceConfigGroup` with the specified capacity
pub fn with_capacity(capacity: usize) -> Self {
Self(
Vec::with_capacity(capacity),
#[cfg(feature = "dns-over-rustls")]
None,
)
}
/// Configure a NameServer address and port
///
/// This will create UDP and TCP connections, using the same port.
pub fn from_ips_clear(ips: &[IpAddr], port: u16, trust_nx_responses: bool) -> Self {
let mut name_servers = Self::with_capacity(ips.len());
for ip in ips {
let udp = NameServerConfig {
socket_addr: SocketAddr::new(*ip, port),
protocol: Protocol::Udp,
tls_dns_name: None,
trust_nx_responses,
#[cfg(feature = "dns-over-rustls")]
tls_config: None,
bind_addr: None,
};
let tcp = NameServerConfig {
socket_addr: SocketAddr::new(*ip, port),
protocol: Protocol::Tcp,
tls_dns_name: None,
trust_nx_responses,
#[cfg(feature = "dns-over-rustls")]
tls_config: None,
bind_addr: None,
};
name_servers.push(udp);
name_servers.push(tcp);
}
name_servers
}
#[cfg(any(feature = "dns-over-tls", feature = "dns-over-https"))]
fn from_ips_encrypted(
ips: &[IpAddr],
port: u16,
tls_dns_name: String,
protocol: Protocol,
trust_nx_responses: bool,
) -> Self {
assert!(protocol.is_encrypted());
let mut name_servers = Self::with_capacity(ips.len());
for ip in ips {
let config = NameServerConfig {
socket_addr: SocketAddr::new(*ip, port),
protocol,
tls_dns_name: Some(tls_dns_name.clone()),
trust_nx_responses,
#[cfg(feature = "dns-over-rustls")]
tls_config: None,
bind_addr: None,
};
name_servers.push(config);
}
name_servers
}
/// Configure a NameServer address and port for DNS-over-TLS
///
/// This will create a TLS connections.
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
pub fn from_ips_tls(
ips: &[IpAddr],
port: u16,
tls_dns_name: String,
trust_nx_responses: bool,
) -> Self {
Self::from_ips_encrypted(ips, port, tls_dns_name, Protocol::Tls, trust_nx_responses)
}
/// Configure a NameServer address and port for DNS-over-HTTPS
///
/// This will create a HTTPS connections.
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn from_ips_https(
ips: &[IpAddr],
port: u16,
tls_dns_name: String,
trust_nx_responses: bool,
) -> Self {
Self::from_ips_encrypted(ips, port, tls_dns_name, Protocol::Https, trust_nx_responses)
}
/// Creates a default configuration, using `8.8.8.8`, `8.8.4.4` and `2001:4860:4860::8888`, `2001:4860:4860::8844` (thank you, Google).
///
/// Please see Google's [privacy statement](https://developers.google.com/speed/public-dns/privacy) for important information about what they track, many ISP's track similar information in DNS. To use the system configuration see: `Resolver::from_system_conf` and `AsyncResolver::from_system_conf`
pub fn google() -> Self {
Self::from_ips_clear(GOOGLE_IPS, 53, true)
}
/// Creates a default configuration, using `8.8.8.8`, `8.8.4.4` and `2001:4860:4860::8888`, `2001:4860:4860::8844` (thank you, Google). This limits the registered connections to just HTTPS lookups
///
/// Please see Google's [privacy statement](https://developers.google.com/speed/public-dns/privacy) for important information about what they track, many ISP's track similar information in DNS. To use the system configuration see: `Resolver::from_system_conf` and `AsyncResolver::from_system_conf`
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn google_https() -> Self {
Self::from_ips_https(GOOGLE_IPS, 53, "dns.google".to_string(), true)
}
/// Creates a default configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare).
///
/// Please see: <https://www.cloudflare.com/dns/>
pub fn cloudflare() -> Self {
Self::from_ips_clear(CLOUDFLARE_IPS, 53, true)
}
/// Creates a configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare). This limits the registered connections to just TLS lookups
///
/// Please see: <https://www.cloudflare.com/dns/>
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
pub fn cloudflare_tls() -> Self {
Self::from_ips_tls(CLOUDFLARE_IPS, 853, "cloudflare-dns.com".to_string(), true)
}
/// Creates a configuration, using `1.1.1.1`, `1.0.0.1` and `2606:4700:4700::1111`, `2606:4700:4700::1001` (thank you, Cloudflare). This limits the registered connections to just HTTPS lookups
///
/// Please see: <https://www.cloudflare.com/dns/>
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn cloudflare_https() -> Self {
Self::from_ips_https(CLOUDFLARE_IPS, 443, "cloudflare-dns.com".to_string(), true)
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings (thank you, Quad9).
///
/// Please see: <https://www.quad9.net/faq/>
pub fn quad9() -> Self {
Self::from_ips_clear(QUAD9_IPS, 53, true)
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings. This limits the registered connections to just TLS lookups
///
/// Please see: <https://www.quad9.net/faq/>
#[cfg(feature = "dns-over-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-tls")))]
pub fn quad9_tls() -> Self {
Self::from_ips_tls(QUAD9_IPS, 853, "dns.quad9.net".to_string(), true)
}
/// Creates a configuration, using `9.9.9.9`, `149.112.112.112` and `2620:fe::fe`, `2620:fe::fe:9`, the "secure" variants of the quad9 settings. This limits the registered connections to just HTTPS lookups
///
/// Please see: <https://www.quad9.net/faq/>
#[cfg(feature = "dns-over-https")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-https")))]
pub fn quad9_https() -> Self {
Self::from_ips_https(QUAD9_IPS, 443, "dns.quad9.net".to_string(), true)
}
/// Merges this set of [`NameServerConfig`]s with the other
///
/// ```
/// use std::net::{SocketAddr, Ipv4Addr};
/// use trust_dns_resolver::config::NameServerConfigGroup;
///
/// let mut group = NameServerConfigGroup::google();
/// group.merge(NameServerConfigGroup::cloudflare());
/// group.merge(NameServerConfigGroup::quad9());
///
/// assert!(group.iter().any(|c| c.socket_addr == SocketAddr::new(Ipv4Addr::new(8, 8, 8, 8).into(), 53)));
/// assert!(group.iter().any(|c| c.socket_addr == SocketAddr::new(Ipv4Addr::new(1, 1, 1, 1).into(), 53)));
/// assert!(group.iter().any(|c| c.socket_addr == SocketAddr::new(Ipv4Addr::new(9, 9, 9, 9).into(), 53)));
/// ```
pub fn merge(&mut self, mut other: Self) {
#[cfg(not(feature = "dns-over-rustls"))]
{
self.append(&mut other);
}
#[cfg(feature = "dns-over-rustls")]
{
self.0.append(&mut other);
}
}
/// add a [`rustls::ClientConfig`]
#[cfg(feature = "dns-over-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns-over-rustls")))]
pub fn with_client_config(self, client_config: Arc<ClientConfig>) -> Self {
Self(self.0, Some(TlsClientConfig(client_config)))
}
/// Sets the client address (IP and port) to connect from on all name servers.
pub fn with_bind_addr(mut self, bind_addr: Option<SocketAddr>) -> Self {
for server in &mut self.0 {
server.bind_addr = bind_addr;
}
self
}
}
impl Default for NameServerConfigGroup {
fn default() -> Self {
Self::new()
}
}
impl Deref for NameServerConfigGroup {
type Target = Vec<NameServerConfig>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for NameServerConfigGroup {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl From<Vec<NameServerConfig>> for NameServerConfigGroup {
fn from(configs: Vec<NameServerConfig>) -> Self {
#[cfg(not(feature = "dns-over-rustls"))]
{
Self(configs)
}
#[cfg(feature = "dns-over-rustls")]
{
Self(configs, None)
}
}
}
/// The lookup ip strategy
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde-config", derive(Serialize, Deserialize))]
pub enum LookupIpStrategy {
/// Only query for A (Ipv4) records
Ipv4Only,
/// Only query for AAAA (Ipv6) records
Ipv6Only,
/// Query for A and AAAA in parallel
Ipv4AndIpv6,
/// Query for Ipv6 if that fails, query for Ipv4
Ipv6thenIpv4,
/// Query for Ipv4 if that fails, query for Ipv6 (default)
Ipv4thenIpv6,
}
impl Default for LookupIpStrategy {
/// Returns [`LookupIpStrategy::Ipv4thenIpv6`] as the default.
fn default() -> Self {
Self::Ipv4thenIpv6
}
}
/// Configuration for the Resolver
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
#[cfg_attr(
feature = "serde-config",
derive(Serialize, Deserialize),
serde(default)
)]
#[allow(dead_code)] // TODO: remove after all params are supported
#[non_exhaustive]
pub struct ResolverOpts {
/// Sets the number of dots that must appear (unless it's a final dot representing the root)
/// that must appear before a query is assumed to include the TLD. The default is one, which
/// means that `www` would never be assumed to be a TLD, and would always be appended to either
/// the search
pub ndots: usize,
/// Specify the timeout for a request. Defaults to 5 seconds
pub timeout: Duration,
/// Number of retries after lookup failure before giving up. Defaults to 2
pub attempts: usize,
/// Rotate through the resource records in the response (if there is more than one for a given name)
pub rotate: bool,
/// Validate the names in the response, not implemented don't really see the point unless you need to support
/// badly configured DNS
pub check_names: bool,
/// Enable edns, for larger records
pub edns0: bool,
/// Use DNSSec to validate the request
pub validate: bool,
/// The ip_strategy for the Resolver to use when lookup Ipv4 or Ipv6 addresses
pub ip_strategy: LookupIpStrategy,
/// Cache size is in number of records (some records can be large)
pub cache_size: usize,
/// Check /ect/hosts file before dns requery (only works for unix like OS)
pub use_hosts_file: bool,
/// Optional minimum TTL for positive responses.
///
/// If this is set, any positive responses with a TTL lower than this value will have a TTL of
/// `positive_min_ttl` instead. Otherwise, this will default to 0 seconds.
pub positive_min_ttl: Option<Duration>,
/// Optional minimum TTL for negative (`NXDOMAIN`) responses.
///
/// If this is set, any negative responses with a TTL lower than this value will have a TTL of
/// `negative_min_ttl` instead. Otherwise, this will default to 0 seconds.
pub negative_min_ttl: Option<Duration>,
/// Optional maximum TTL for positive responses.
///
/// If this is set, any positive responses with a TTL higher than this value will have a TTL of
/// `positive_max_ttl` instead. Otherwise, this will default to [`MAX_TTL`] seconds.
///
/// [`MAX_TTL`]: ../dns_lru/const.MAX_TTL.html
pub positive_max_ttl: Option<Duration>,
/// Optional maximum TTL for negative (`NXDOMAIN`) responses.
///
/// If this is set, any negative responses with a TTL higher than this value will have a TTL of
/// `negative_max_ttl` instead. Otherwise, this will default to [`MAX_TTL`] seconds.
///
/// [`MAX_TTL`]: ../dns_lru/const.MAX_TTL.html
pub negative_max_ttl: Option<Duration>,
/// Number of concurrent requests per query
///
/// Where more than one nameserver is configured, this configures the resolver to send queries
/// to a number of servers in parallel. Defaults to 2; 0 or 1 will execute requests serially.
pub num_concurrent_reqs: usize,
/// Preserve all intermediate records in the lookup response, suchas CNAME records
pub preserve_intermediates: bool,
/// Try queries over TCP if they fail over UDP.
pub try_tcp_on_error: bool,
}
impl Default for ResolverOpts {
/// Default values for the Resolver configuration.
///
/// This follows the resolv.conf defaults as defined in the [Linux man pages](http://man7.org/linux/man-pages/man5/resolv.conf.5.html)
fn default() -> Self {
Self {
ndots: 1,
timeout: Duration::from_secs(5),
attempts: 2,
rotate: false,
check_names: true,
edns0: false,
validate: false,
ip_strategy: LookupIpStrategy::default(),
cache_size: 32,
use_hosts_file: true,
positive_min_ttl: None,
negative_min_ttl: None,
positive_max_ttl: None,
negative_max_ttl: None,
num_concurrent_reqs: 2,
// Defaults to `true` to match the behavior of dig and nslookup.
preserve_intermediates: true,
try_tcp_on_error: false,
}
}
}
/// IP addresses for Google Public DNS
pub const GOOGLE_IPS: &[IpAddr] = &[
IpAddr::V4(Ipv4Addr::new(8, 8, 8, 8)),
IpAddr::V4(Ipv4Addr::new(8, 8, 4, 4)),
IpAddr::V6(Ipv6Addr::new(0x2001, 0x4860, 0x4860, 0, 0, 0, 0, 0x8888)),
IpAddr::V6(Ipv6Addr::new(0x2001, 0x4860, 0x4860, 0, 0, 0, 0, 0x8844)),
];
/// IP addresses for Cloudflare's 1.1.1.1 DNS service
pub const CLOUDFLARE_IPS: &[IpAddr] = &[
IpAddr::V4(Ipv4Addr::new(1, 1, 1, 1)),
IpAddr::V4(Ipv4Addr::new(1, 0, 0, 1)),
IpAddr::V6(Ipv6Addr::new(0x2606, 0x4700, 0x4700, 0, 0, 0, 0, 0x1111)),
IpAddr::V6(Ipv6Addr::new(0x2606, 0x4700, 0x4700, 0, 0, 0, 0, 0x1001)),
];
/// IP address for the Quad9 DNS service
pub const QUAD9_IPS: &[IpAddr] = &[
IpAddr::V4(Ipv4Addr::new(9, 9, 9, 9)),
IpAddr::V4(Ipv4Addr::new(149, 112, 112, 112)),
IpAddr::V6(Ipv6Addr::new(0x2620, 0x00fe, 0, 0, 0, 0, 0, 0x00fe)),
IpAddr::V6(Ipv6Addr::new(0x2620, 0x00fe, 0, 0, 0, 0, 0x00fe, 0x0009)),
];