_ Git - dnssec-prover/blob - src/lib.rs

   1 //! The DNS provides a single, global, hierarchical namespace with (when DNSSEC is used)
   2 //! cryptographic guarantees on all of its data.
   3 //!
   4 //! This makes it incredibly powerful for resolving human-readable names into arbitrary, secured
   5 //! data.
   6 //!
   7 //! Unlike TLS, this cryptographic security provides transferable proofs which can convince an
   8 //! offline device, using simple cryptographic primitives and a single root trusted key, of the
   9 //! validity of DNS data.
  10 //!
  11 //! This crate implements the creation and validation of such proofs, using the format from RFC
  12 //! 9102 to create transferable proofs of DNS entries.
  13 //!
  14 //! It is no-std (but requires `alloc`) and seeks to have minimal dependencies and a reasonably
  15 //! conservative MSRV policy, allowing it to be used in as many places as possible.
  16 //!
  17 //! Most of the crate's logic is feature-gated, and *all dependencies are optional*:
  18 //!  * By default, the `validate` feature is set, using `ring` to validate DNSSEC signatures and
  19 //!    proofs using the [`validation`] module.
  20 //!  * The `std` feature enables the [`query`] module, allowing for the building of proofs by
  21 //!    querying a recursive resolver over TCP.
  22 //!  * The `tokio` feature further enables async versions of the [`query`] methods, doing the same
  23 //!    querying async using `tokio`'s TCP streams.
  24 //!  * Finally, the crate can be built as a binary using the `build_server` feature, responding to
  25 //!    queries over HTTP GET calls to `/dnssecproof?d=domain.name.&t=RecordType` with DNSSEC
  26 //!    proofs.
  27 //!
  28 //! Note that this library's MSRV is 1.64 for normal building, however builds fine on 1.63 (and
  29 //! possibly earlier) when `RUSTC_BOOTSTRAP=1` is set, as it relies on the
  30 //! `const_slice_from_raw_parts` feature.
  31
  32 #![deny(missing_docs)]
  33 #![deny(rustdoc::broken_intra_doc_links)]
  34 #![deny(rustdoc::private_intra_doc_links)]
  35
  36 // const_slice_from_raw_parts was stabilized in 1.64, however we support building on 1.63 as well.
  37 // Luckily, it seems to work fine in 1.63 with the feature flag (and RUSTC_BOOTSTRAP=1) enabled.
  38 #![cfg_attr(rust_1_63, feature(const_slice_from_raw_parts))]
  39
  40 #![allow(clippy::new_without_default)] // why is this even a lint
  41 #![allow(clippy::result_unit_err)] // Why in the hell is this a lint?
  42 #![allow(clippy::get_first)] // Sometimes this improves readability
  43 #![allow(clippy::needless_lifetimes)] // lifetimes improve readability
  44 #![allow(clippy::needless_borrow)] // borrows indicate read-only/non-move
  45 #![allow(clippy::too_many_arguments)] // sometimes we don't have an option
  46 #![allow(clippy::identity_op)] // sometimes identities improve readability for repeated actions
  47 #![allow(clippy::erasing_op)] // sometimes identities improve readability for repeated actions
  48
  49 #![cfg_attr(not(feature = "std"), no_std)]
  50 extern crate alloc;
  51
  52 /// The maximum number of requests we will make when building a proof or the maximum number of
  53 /// [`rr::RRSig`] sets we'll validate records from when validating proofs.
  54 // Note that this is duplicated exactly in src/http.rs
  55 pub const MAX_PROOF_STEPS: usize = 20;
  56
  57 #[cfg(feature = "validation")]
  58 mod base32;
  59
  60 #[cfg(all(feature = "validation", any(fuzzing, dnssec_validate_bench)))]
  61 pub mod crypto;
  62 #[cfg(all(feature = "validation", not(any(fuzzing, dnssec_validate_bench))))]
  63 mod crypto;
  64
  65 pub mod rr;
  66 pub mod ser;
  67 pub mod query;
  68
  69 #[cfg(feature = "validation")]
  70 pub mod validation;
  71
  72 #[cfg(all(feature = "std", feature = "validation", test))]
  73 mod test;