domain/

lib.rs

//! A DNS library for Rust.
//!
//! This crate provides a number of building blocks for developing
//! functionality related to the [Domain Name System (DNS)][dns].
//!
//! [dns]: https://www.rfc-editor.org/rfc/rfc9499.html
//!
//! The crate uses feature flags to allow you to select only those modules
//! you need for your particular project. In most cases, the feature names
//! are equal to the module they enable.
//!
//! # Modules
//!
//! A set of modules providing fundamental types and functionality is always
//! enabled:
//!
//! * [base] contains a wide variety of types, traits, and functionality
//!   to deal with DNS data, and
//! * [rdata] contains types and implementations for a growing number of
//!   record types.
//!
//! The following additional modules exist, although they are gated behind
//! feature flags (with the same names as the modules):
//!
#![cfg_attr(feature = "net", doc = "* [net]:")]
#![cfg_attr(not(feature = "net"), doc = "* net:")]
//!   Sending and receiving DNS messages.
#![cfg_attr(feature = "resolv", doc = "* [resolv]:")]
#![cfg_attr(not(feature = "resolv"), doc = "* resolv:")]
//!   An asynchronous DNS resolver based on the
//!   [Tokio](https://tokio.rs/) async runtime.
#![cfg_attr(feature = "unstable-crypto", doc = "* [crypto]:")]
#![cfg_attr(not(feature = "unstable-crypto"), doc = "* crypto:")]
//!   Experimental support for cryptographic backends, key generation and
//!   import.  Gated behind the `unstable-crypto` flag.
//! * [dnssec]: DNSSEC signing and validation.
#![cfg_attr(feature = "tsig", doc = "* [tsig]:")]
#![cfg_attr(not(feature = "tsig"), doc = "* tsig:")]
//!   Support for securing DNS transactions with TSIG records.
#![cfg_attr(feature = "zonefile", doc = "* [zonefile]:")]
#![cfg_attr(not(feature = "zonefile"), doc = "* zonefile:")]
//!   Experimental reading and writing of zone files, i.e. the textual
//!   representation of DNS data.
#![cfg_attr(feature = "unstable-zonetree", doc = "* [zonetree]:")]
#![cfg_attr(not(feature = "unstable-zonetree"), doc = "* zonetree:")]
//!   Experimental storing and querying of zone trees.  Gated behind the
//!   `unstable-zonetree` flag.
//!
//! Finally, the [dep] module contains re-exports of some important
//! dependencies to help avoid issues with multiple versions of a crate.
//!
//! # The `new` Module
//!
//! The API of `domain` is undergoing several large-scale changes, that are
//! collected under the `new` module.  It is gated behind the `unstable-new`
//! flag.
#![cfg_attr(
    feature = "unstable-new",
    doc = "See [its documentation][new] for more information."
)]
//!
//! # Reference of feature flags
//!
//! Several feature flags simply enable support for other crates, e.g. by
//! adding `impl`s for their types.  They are optional and do not introduce
//! new functionality into this crate.
//!
//! * `bytes`: Enables using the types `Bytes` and `BytesMut` from the
//!   [bytes](https://github.com/tokio-rs/bytes) crate as octet sequences.
//!
//! * `heapless`: enables the use of the `Vec` type from the
//!   [heapless](https://github.com/japaric/heapless) crate as octet
//!   sequences.
//!
//! * `smallvec`: enables the use of the `Smallvec` type from the
//!   [smallvec](https://github.com/servo/rust-smallvec) crate as octet
//!   sequences.
//!
//! Some flags enable support for specific kinds of operations that are not
//! otherwise possible.  They are gated as they may not always be necessary
//! and they may introduce new dependencies.
//!
//! * `chrono`: Adds the [chrono](https://github.com/chronotope/chrono)
//!   crate as a dependency. This adds support for generating serial numbers
//!   from time stamps.
//!
//! * `rand`: Enables a number of methods that rely on a random number
//!   generator being available in the system.
//!
//! * `serde`: Enables serde serialization for a number of basic types.
//!
//! * `siphasher`: enables the dependency on the
//!   [siphasher](https://github.com/jedisct1/rust-siphash) crate which allows
//!   generating and checking hashes in [standard server
//!   cookies][crate::base::opt::cookie::StandardServerCookie].
//!
//! * `std`: support for the Rust std library. This feature is enabled by
//!   default.
//!
//! A special case here is cryptographic backends.  Certain modules (e.g. for
//! DNSSEC signing and validation) require a backend to provide cryptography.
//! At least one such module should be enabled.
//!
//! * `openssl`: Enables crypto functionality via OpenSSL through the
//!   [rust-openssl](https://github.com/sfackler/rust-openssl) crate.
//!
//! * `ring`: Enables crypto functionality via the
//!   [ring](https://github.com/briansmith/ring) crate.
//!
//! Some flags represent entire categories of functionality within this crate.
//! Each flag is associated with a particular module.  Note that some of these
//! modules are under heavy development, and so have unstable feature flags
//! which are categorized separately.
//!
//! * `net`: Enables sending and receiving DNS messages via the
#![cfg_attr(feature = "net", doc = "  [net]")]
#![cfg_attr(not(feature = "net"), doc = "  net")]
//!   module.
//!
//! * `resolv`: Enables the asynchronous stub resolver via the
#![cfg_attr(feature = "resolv", doc = "  [resolv]")]
#![cfg_attr(not(feature = "resolv"), doc = "  resolv")]
//!   module.
//!
//!   * `resolv-sync`: Enables the synchronous version of the stub resolver.
//!
//! * `tsig`: support for signing and validating message exchanges via TSIG
//!   signatures. This enables the
#![cfg_attr(feature = "tsig", doc = "  [tsig]")]
#![cfg_attr(not(feature = "tsig"), doc = "  tsig")]
//!   module and currently enables `bytes`, `ring`, and `smallvec`.
//!
//! * `zonefile`: reading and writing of zonefiles. This feature enables the
#![cfg_attr(feature = "zonefile", doc = "  [zonefile]")]
#![cfg_attr(not(feature = "zonefile"), doc = "  zonefile")]
//!   module and currently also enables `bytes`, `serde`, and `std`.
//!
//! # Unstable features
//!
//! When adding new functionality to the crate, practical experience is
//! necessary to arrive at a good, user friendly design. Unstable features
//! allow adding and rapidly changing new code without having to release
//! versions allowing breaking changes all the time. If you use unstable
//! features, it is best to specify a concrete version as a dependency in
//! `Cargo.toml` using the `=` operator, e.g.:
//!
//! ```text
//! [dependencies]
//! domain = "=0.9.3"
//! ```
//!
//! Currently, the following unstable features exist:
//!
//! * `unstable-client-transport`: sending and receiving DNS messages from
//!   a client perspective; primarily the `net::client` module.
//! * `unstable-server-transport`: receiving and sending DNS messages from
//!   a server perspective; primarily the `net::server` module.
//! * `unstable-crypto`: this feature flag needs to be combined with one or
//!   more feature flags that enable cryptographic backends (currently `ring`
//!   and `openssl`). This feature flags enables all parts of the crypto
//!   module except for private key generation and signing.
//! * `unstable-crypto-sign`: this feature flag needs to be combined with one
//!   or more feature flags that enable cryptographic backends. This feature
//!   flag enables all parts of the crypto module.
//! * `unstable-sign`: basic DNSSEC signing support. This will enable the
//!   `dnssec::sign`
//!   module and requires the `std` feature. In order to actually perform any
//!   signing, also enable one or more cryptographic backend modules (`ring`
//!   and `openssl`). Enabling this will also enable `unstable-crypto-sign`.
//! * `unstable-validator`: a DNSSEC validator, primarily the `validator`
//!   and the `net::client::validator` modules.
//! * `unstable-xfr`: zone transfer related functionality..
//! * `unstable-zonetree`: building & querying zone trees; primarily the
//!   `zonetree` module.
//!
//! Note: Some functionality is currently informally marked as
//! “experimental” since it was introduced before adoption of the concept
//! of unstable features. These will follow proper Semver practice but may
//! change significantly in releases with breaking changes.

#![no_std]
#![allow(renamed_and_removed_lints)]
#![allow(clippy::unknown_clippy_lints)]
#![allow(clippy::uninlined_format_args)]
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "std")]
#[allow(unused_imports)] // Import macros even if unused.
#[macro_use]
extern crate std;

// The 'domain-macros' crate introduces 'derive' macros which can be used by
// users of the 'domain' crate, but also by the 'domain' crate itself.  Within
// those macros, references to declarations in the 'domain' crate are written
// as '::domain::*' ... but this doesn't work when those proc macros are used
// in the 'domain' crate itself.  The alias introduced here fixes this: now
// '::domain' means the same thing within this crate as in dependents of it.
extern crate self as domain;

// Re-export 'core' for use in macros.
#[doc(hidden)]
pub use core as __core;

pub mod base;
pub mod crypto;
pub mod dep;
pub mod dnssec;
pub mod net;
pub mod rdata;
pub mod resolv;
pub mod stelline;
pub mod tsig;
pub mod utils;
pub mod zonefile;
pub mod zonetree;

#[cfg(feature = "unstable-new")]
pub mod new;

mod logging;