hickory-dns

Crates.iohickory-dns
lib.rshickory-dns
version
sourcesrc
created_at2023-05-17 01:39:42.97261
updated_at2024-11-28 17:03:07.623254
descriptionHickory DNS is a safe and secure DNS server with DNSSEC support. Eventually this could be a replacement for BIND9. The DNSSEC support allows for live signing of all records, in it does not currently support records signed offline. The server supports dynamic DNS with SIG0 authenticated requests. Hickory DNS is based on the Tokio and Futures libraries, which means it should be easily integrated into other software that also use those libraries.
homepagehttps://hickory-dns.org/
repositoryhttps://github.com/hickory-dns/hickory-dns
max_upload_size
id866507
Cargo.toml error:TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Benjamin Fry (bluejekyll)

documentation

https://docs.rs/hickory-dns

README

Overview

Hickory DNS provides a binary for hosting or forwarding DNS zones.

This a named implementation for DNS zone hosting, stub resolvers, and recursive resolvers. It is capable of performing signing all records in the zone for server DNSSEC RRSIG records associated with all records in a zone. There is also a hickory-dns binary that can be generated from the library with cargo install hickory-dns. Dynamic updates are supported via SIG0 (an mTLS authentication method is under development).

NOTICE This project was rebranded fromt Trust-DNS to Hickory DNS and has been moved to the https://github.com/hickory-dns/hickory-dns organization and repo, this crate/binary has been moved to hickory-dns, from 0.24 and onward, for prior versions see trust-dns.

Features

  • Dynamic Update with sqlite journaling backend (SIG0)
  • DNSSEC online signing (with NSEC and NSEC3)
  • DNS over TLS (DoT)
  • DNS over HTTPS/2 (DoH)
  • DNS over HTTPS/3 (DoH3)
  • DNS over Quic (DoQ)
  • Forwarding stub resolver
  • ANAME resolution, for zone mapping aliases to A and AAAA records
  • Additionals section generation for aliasing record types

DNS-over-TLS and DNS-over-HTTPS

Support of TLS on the Server is managed through a pkcs12 der file. The documentation is captured in the example test config file, example.toml. A registered certificate to the server can be pinned to the Client with the add_ca() method. Alternatively, as the client uses the rust-native-tls library, it should work with certificate signed by any standard CA.

DoT and DoH are supported. This is accomplished through the use of one of native-tls, openssl, or rustls (only rustls is currently supported for DoH). The Resolver requires valid DoT or DoH resolvers being registered in order to be used.

Client authentication/mTLS is currently not supported, there are some issues still being worked on. TLS is useful for Server authentication and connection privacy.

To enable DoT, one of the features dns-over-native-tls, dns-over-openssl, or dns-over-rustls must be enabled. dns-over-https-rustls is used for DoH.

DNSSEC status

The current root key is bundled into the system, and used by default. This gives validation of DNSKEY and DS records back to the root. NSEC and NSEC3 are implemented.

Zones will be automatically resigned on any record updates via dynamic DNS. To enable DNSSEC, one of the features dnssec-openssl or dnssec-ring must be enabled.

Future goals

  • Distributed dynamic DNS updates, with consensus
  • mTLS based authorization for Dynamic Updates
  • Online NSEC creation for queries
  • Maybe NSEC5 support

Minimum Rust Version

The current minimum rustc version for this project is 1.70

Versioning

Hickory DNS does it's 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.

Commit count: 3529

cargo fmt