fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-25 08:51:20 +00:00
Code Issues Projects Releases Wiki Activity

transports/dns: Document caveats of using the trust-dns-resolver crate (#2114)

Browse Source 
Ref https://github.com/libp2p/rust-libp2p/issues/2064
This commit is contained in:
Oliver Wangler 2021-06-30 21:02:20 +02:00 committed by GitHub
parent b96996febf
commit e038f87c60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
transports/dns/src/lib.rs
View File

@ -36,6 +36,22 @@
//! features. For more information about these features, please
//! refer to the documentation of [trust-dns-resolver].
//!
//! On Unix systems, if no custom configuration is given, [trust-dns-resolver]
//! will try to parse the `/etc/resolv.conf` file. This approach comes with a
//! few caveats to be aware of:
//! 1) This fails (panics even!) if `/etc/resolv.conf` does not exist. This is
//! the case on all versions of Android.
//! 2) DNS configuration is only evaluated during startup. Runtime changes are
//! thus ignored.
//! 3) DNS resolution is obviously done in process and consequently not using
//! any system APIs (like libc's `gethostbyname`). Again this is
//! problematic on platforms like Android, where there's a lot of
//! complexity hidden behind the system APIs.
//! If the implementation requires different characteristics, one should
//! consider providing their own implementation of [`GenDnsConfig`] or use
//! platform specific APIs to extract the host's DNS configuration (if possible)
//! and provide a custom [`ResolverConfig`].
//!
//![trust-dns-resolver]: https://docs.rs/trust-dns-resolver/latest/trust_dns_resolver/#dns-over-tls-and-dns-over-https
use futures::{prelude::*, future::BoxFuture};