Prepare 0.24 release with branding change to Hickory DNS (#2054)

* update all READMEs with notices about the name change

* update changelog for 0.24

* bump crate versions to 0.24

* update version notice information

* update readmes to back reference trust-dns

* rename all crates to hickory counterparts

* replace all Trust-DNS references in code and comments with Hickory DNS

* rename all Trust-DNS references to Hickory DNS in non-code

* rename all trust-dns-resolver references to hickory-resolver

* rename all trust-dns-client references to hickory-client

* rename all trust-dns-proto references to hickory-proto

* rename all trust-dns-server references to hickory-server

* rename all trust-dns-compatibility references to hickory-compatability

* rename all trust-dns-integration references to hickory-integration

* rename all trust-dns-util references to hickory-util

* Update MIT licenses to reference Hickory DNS

* update all trust-dns references to hickory-dns

* update all bluejekyll github references to hickorydns org

* Update name in Changelog

* make sure hickory-dns logs during tests

* add changelogs for recent main additions

* fix references to trust-dns and hickory in architecture

* update a few trust-dns references in READMEs

* fixup some dangling trust_dns references

* replace fka with formerly in change log

* replace all hickoydns org references to hickory-dns

* replace all http links with https

* update logos

* update hickorydns to hickory-dns for all other org references

* fix Notices of Trust-DNS to Hickory in each Readme
This commit is contained in:
Benjamin Fry
2023-10-13 21:39:28 -04:00
committed by GitHub
parent dac1009503
commit 408d0baca0
369 changed files with 2241 additions and 1905 deletions

View File

@@ -4,7 +4,7 @@ name = "async-std-resolver"
# A short blurb about the package. This is not rendered in any format when
# uploaded to crates.io (aka this is not markdown)
description = """
Trust-DNS is a safe and secure DNS library, for async-std. This Resolver library uses the trust-dns-proto library to perform all DNS queries. The Resolver is intended to be a high-level library for any DNS record resolution see Resolver and AsyncResolver for supported resolution types. The Client can be used for other queries.
Hickory DNS is a safe and secure DNS library, for async-std. This Resolver library uses the hickory-proto library to perform all DNS queries. The Resolver is intended to be a high-level library for any DNS record resolution see Resolver and AsyncResolver for supported resolution types. The Client can be used for other queries.
"""
# These URLs point to more information about the repository
@@ -25,32 +25,32 @@ categories.workspace = true
license.workspace = true
[badges]
#github-actions = { repository = "bluejekyll/trust-dns", branch = "main", workflow = "test" }
codecov = { repository = "bluejekyll/trust-dns", branch = "main", service = "github" }
#github-actions = { repository = "bluejekyll/hickory", branch = "main", workflow = "test" }
codecov = { repository = "hickory-dns/hickory-dns", branch = "main", service = "github" }
maintenance = { status = "actively-developed" }
[features]
default = ["system-config"]
# resolver configuration
system-config = ["trust-dns-resolver/system-config"]
system-config = ["hickory-resolver/system-config"]
####
# TODO: These next features are common across the trust-dns crates, but they are not ready for use here
# TODO: These next features are common across the hickory crates, but they are not ready for use here
####
#dns-over-native-tls = ["dns-over-tls", "trust-dns-resolver/dns-over-native-tls"]
#dns-over-native-tls = ["dns-over-tls", "hickory-resolver/dns-over-native-tls"]
# DNS over TLS with OpenSSL currently needs a good way to set default CAs, use rustls or native-tls
#dns-over-openssl = ["dns-over-tls", "trust-dns-resolver/dns-over-openssl"]
#dns-over-rustls = ["dns-over-tls", "trust-dns-resolver/dns-over-rustls"]
#dns-over-openssl = ["dns-over-tls", "hickory-resolver/dns-over-openssl"]
#dns-over-rustls = ["dns-over-tls", "hickory-resolver/dns-over-rustls"]
#dns-over-tls = []
# This requires some TLS library, currently only rustls is supported
#dns-over-https-rustls = ["trust-dns-resolver/dns-over-https-rustls"]
#dns-over-https-rustls = ["hickory-resolver/dns-over-https-rustls"]
#dns-over-https = []
#dnssec-openssl = ["dnssec", "trust-dns-resolver/dnssec-openssl"]
#dnssec-ring = ["dnssec", "trust-dns-resolver/dnssec-ring"]
#dnssec-openssl = ["dnssec", "hickory-resolver/dnssec-openssl"]
#dnssec-ring = ["dnssec", "hickory-resolver/dnssec-ring"]
#dnssec = []
[lib]
@@ -61,11 +61,15 @@ path = "src/lib.rs"
async-std = { workspace = true, features = ["unstable"] }
async-trait.workspace = true
futures-io = { workspace = true, default-features = false, features = ["std"] }
futures-util = { workspace = true, default-features = false, features = ["std"] }
futures-util = { workspace = true, default-features = false, features = [
"std",
] }
pin-utils.workspace = true
trust-dns-resolver = { workspace = true, default-features = false }
hickory-resolver = { workspace = true, default-features = false }
socket2.workspace = true
[dev-dependencies]
async-std = { workspace = true, features = ["attributes"] }
trust-dns-resolver = { workspace = true, default-features = false, features = ["testing"] }
hickory-resolver = { workspace = true, default-features = false, features = [
"testing",
] }

View File

@@ -1,6 +1,6 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
https://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

View File

@@ -1,4 +1,4 @@
Copyright (c) 2015 The trust-dns Developers
Copyright (c) 2015 The Hickory DNS Developers
Copyright (c) 2017 Google LLC.
Permission is hereby granted, free of charge, to any person obtaining a copy

View File

@@ -1,8 +1,10 @@
# Overview
Trust-DNS Async-Std Resolver is a library which implements the DNS resolver using the Trust-DNS Resolver library.
Hickory DNS Async-Std Resolver is a library which implements the DNS resolver using the Hickory DNS Resolver library.
This library contains implementations for IPv4 (A) and IPv6 (AAAA) resolution, more features are in the works. It is built on top of the [async-std](https://async.rs) async-io project, this allows it to be integrated into other systems using the async-std and futures libraries. The Trust-DNS [project](https://github.com/bluejekyll/trust-dns) contains other libraries for DNS: a [client library](https://crates.io/crates/trust-dns-client) for raw protocol usage, a [server library](https://crates.io/crates/trust-dns-server) for hosting zones, and variations on the TLS implementation over [rustls](https://crates.io/crates/trust-dns-rustls) and [native-tls](https://crates.io/crates/trust-dns-native-tls).
This library contains implementations for IPv4 (A) and IPv6 (AAAA) resolution, more features are in the works. It is built on top of the [async-std](https://async.rs) async-io project, this allows it to be integrated into other systems using the async-std and futures libraries. The Hickory DNS [project](https://github.com/hickory-dns/hickory-dns) contains other libraries for DNS: a [client library](https://crates.io/crates/hickory-client) for raw protocol usage, a [server library](https://crates.io/crates/hickory-server) for hosting zones, and variations on the TLS implementation over [rustls](https://crates.io/crates/hickory-dns-rustls) and [native-tls](https://crates.io/crates/hickory-dns-native-tls).
**NOTICE** This project was rebranded from Trust-DNS to Hickory DNS and has been moved to the https://github.com/hickory-dns/hickory-dns organization and repo, from `0.24` and onward.
## Features
@@ -55,4 +57,4 @@ The current minimum rustc version for this project is `1.67`
## Versioning
Trust-DNS does its best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.
Hickory DNS does its best job to follow semver. Hickory DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Hickory DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Hickory DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

View File

@@ -1,8 +1,8 @@
// Copyright 2015-2020 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
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
// LIBRARY WARNINGS
@@ -25,11 +25,11 @@
//!
//! This is a 100% in process DNS resolver. It *does not* use the Host OS' resolver. If what is desired is to use the Host OS' resolver, generally in the system's libc, then the `std::net::ToSocketAddrs` variant over `&str` should be used.
//!
//! Unlike the `trust-dns-client`, this tries to provide a simpler interface to perform DNS queries. For update options, i.e. Dynamic DNS, the `trust-dns-client` crate must be used instead. The Resolver library is capable of searching multiple domains (this can be disabled by using an FQDN during lookup), dual-stack IPv4/IPv6 lookups, performing chained CNAME lookups, and features connection metric tracking for attempting to pick the best upstream DNS resolver.
//! Unlike the `hickory-client`, this tries to provide a simpler interface to perform DNS queries. For update options, i.e. Dynamic DNS, the `hickory-client` crate must be used instead. The Resolver library is capable of searching multiple domains (this can be disabled by using an FQDN during lookup), dual-stack IPv4/IPv6 lookups, performing chained CNAME lookups, and features connection metric tracking for attempting to pick the best upstream DNS resolver.
//!
//! Use [`AsyncResolver`](crate::AsyncResolver) for performing DNS queries. `AsyncResolver` is a `async-std` based async resolver, and can be used inside any `asyn-std` based system.
//!
//! This as best as possible attempts to abide by the DNS RFCs, please file issues at <https://github.com/bluejekyll/trust-dns>.
//! This as best as possible attempts to abide by the DNS RFCs, please file issues at <https://github.com/hickory-dns/hickory-dns>.
//!
//! # Usage
//!
@@ -94,7 +94,7 @@
//! }
//! ```
use trust_dns_resolver::AsyncResolver;
use hickory_resolver::AsyncResolver;
use crate::runtime::AsyncStdConnectionProvider;
@@ -104,11 +104,11 @@ mod runtime;
mod tests;
mod time;
pub use trust_dns_resolver::config;
pub use trust_dns_resolver::error::ResolveError;
pub use trust_dns_resolver::lookup;
pub use trust_dns_resolver::lookup_ip;
pub use trust_dns_resolver::proto;
pub use hickory_resolver::config;
pub use hickory_resolver::error::ResolveError;
pub use hickory_resolver::lookup;
pub use hickory_resolver::lookup_ip;
pub use hickory_resolver::proto;
/// An AsyncResolver used with async_std
pub type AsyncStdResolver = AsyncResolver<AsyncStdConnectionProvider>;

View File

@@ -1,8 +1,8 @@
// Copyright 2015-2020 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
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
use std::io;
@@ -14,10 +14,10 @@ use async_std::task::spawn_blocking;
use async_trait::async_trait;
use futures_io::{AsyncRead, AsyncWrite};
use futures_util::future::FutureExt;
use hickory_resolver::proto::tcp::{Connect, DnsTcpStream};
use hickory_resolver::proto::udp::{DnsUdpSocket, QuicLocalAddr, UdpSocket};
use pin_utils::pin_mut;
use socket2::{Domain, Protocol, Socket, Type};
use trust_dns_resolver::proto::tcp::{Connect, DnsTcpStream};
use trust_dns_resolver::proto::udp::{DnsUdpSocket, QuicLocalAddr, UdpSocket};
use crate::time::AsyncStdTime;

View File

@@ -1,21 +1,19 @@
// Copyright 2015-2020 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
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
use hickory_resolver::config::{NameServerConfig, ResolverOpts};
use std::future::Future;
use std::net::SocketAddr;
use std::pin::Pin;
use trust_dns_resolver::config::{NameServerConfig, ResolverOpts};
use trust_dns_resolver::proto::error::ProtoError;
use trust_dns_resolver::proto::Executor;
use hickory_resolver::proto::error::ProtoError;
use hickory_resolver::proto::Executor;
use trust_dns_resolver::name_server::{
ConnectionProvider, GenericConnector, RuntimeProvider, Spawn,
};
use hickory_resolver::name_server::{ConnectionProvider, GenericConnector, RuntimeProvider, Spawn};
use crate::net::{AsyncStdTcpStream, AsyncStdUdpSocket};
use crate::proto::tcp::Connect;

View File

@@ -1,7 +1,7 @@
#![allow(clippy::extra_unused_type_parameters)]
use trust_dns_resolver::name_server::GenericConnection;
use trust_dns_resolver::testing;
use hickory_resolver::name_server::GenericConnection;
use hickory_resolver::testing;
use crate::config::{ResolverConfig, ResolverOpts};
use crate::lookup::LookupFuture;

View File

@@ -1,15 +1,15 @@
// Copyright 2015-2020 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
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
use std::future::Future;
use std::time::Duration;
use async_trait::async_trait;
use trust_dns_resolver::proto::Time;
use hickory_resolver::proto::Time;
/// AsyncStd backed timer implementation
#[derive(Clone, Copy)]