hickory-util 0.26.1

// Copyright 2015-2022 Benjamin Fry <benjaminfry@me.com>
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// 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.

//! The dns client program

use std::net::SocketAddr;
#[cfg(feature = "__tls")]
use std::sync::Arc;
#[cfg(feature = "__dnssec")]
use std::{fs::OpenOptions, io::Write, path::PathBuf};

use clap::{Args, Parser, Subcommand, ValueEnum};
#[cfg(feature = "__tls")]
use rustls::{
    ClientConfig, DigitallySignedStruct,
    client::danger::{HandshakeSignatureValid, ServerCertVerified},
    pki_types::{CertificateDer, ServerName, UnixTime},
};

#[cfg(feature = "__https")]
use hickory_net::h2::HttpsClientStream;
#[cfg(feature = "__h3")]
use hickory_net::h3::H3ClientStream;
#[cfg(feature = "__quic")]
use hickory_net::quic::QuicClientStream;
#[cfg(any(feature = "__tls", feature = "__https"))]
use hickory_net::tls::client_config;
#[cfg(feature = "__tls")]
use hickory_net::tls::tls_client_connect;
use hickory_net::{
    NetError,
    client::{Client, ClientHandle},
    runtime::{RuntimeProvider, TokioRuntimeProvider},
    tcp::TcpClientStream,
    udp::UdpClientStream,
};
#[cfg(feature = "__dnssec")]
use hickory_proto::{
    dnssec::{Algorithm, PublicKey, TrustAnchors, Verifier, rdata::DNSKEY},
    rr::Record,
};
use hickory_proto::{
    op::DnsResponse,
    rr::{DNSClass, Name, RData, RecordSet, RecordType},
};

/// A CLI interface for the hickory-client.
///
/// This utility directly uses the hickory-client to perform actions with a single
/// DNS server
#[derive(Debug, Parser)]
#[clap(name = "hickory dns client", version)]
struct Opts {
    /// Specify a nameserver to use, ip and port e.g. 8.8.8.8:53 or \[2001:4860:4860::8888\]:53 (port required)
    #[clap(short = 'n', long)]
    nameserver: SocketAddr,

    /// Protocol type to use for the communication
    #[clap(short = 'p', long, default_value = "udp", value_enum)]
    protocol: Protocol,

    /// TLS endpoint name, i.e. the name in the certificate presented by the remote server
    #[clap(short = 't', long, required_if_eq_any = [("protocol", "tls"), ("protocol", "https"), ("protocol", "quic")])]
    tls_dns_name: Option<String>,

    /// HTTP endpoint path. Relevant only to DNS-over-HTTPS. Defaults to `/dns-query`.
    #[clap(short = 'e', long, default_value = "/dns-query")]
    http_endpoint: Option<String>,

    /// For TLS, HTTPS, QUIC and H3 a custom ALPN code can be supplied
    ///
    /// Defaults: none for TLS (`dot` has been suggested), `h2` for HTTPS, `doq` for QUIC, and `h3` for H3
    #[clap(short = 'a',
        long,
        default_value_ifs = [("protocol", "tls", None), ("protocol", "https", Some("h2")), ("protocol", "quic", Some("doq")), ("protocol", "h3", Some("h3"))]
    )]
    alpn: Option<String>,

    // TODO: put this behind a feature gate
    /// DANGER: do not verify remote nameserver
    #[clap(long)]
    do_not_verify_nameserver_cert: bool,

    /// The Class of the record
    #[clap(long, default_value_t = DNSClass::IN)]
    class: DNSClass,

    /// Configure log verbosity.
    #[clap(flatten)]
    log_config: hickory_util::LogConfig,

    /// Command to execute
    #[clap(subcommand)]
    command: Command,
}

#[derive(Clone, Debug, ValueEnum)]
enum Protocol {
    Udp,
    Tcp,
    Tls,
    Https,
    Quic,
    H3,
}

#[derive(Debug, Subcommand)]
enum Command {
    Query(QueryOpt),
    Notify(NotifyOpt),
    Create(CreateOpt),
    Append(AppendOpt),
    // CompareAndSwap(),
    DeleteRecord(DeleteRecordOpt),
    // DeleteRecordSet,
    // DeleteAll,
    // ZoneTransfer,
    // Raw?
    #[cfg(feature = "__dnssec")]
    FetchKeys(FetchKeysOpt),
}

/// Query a name server for the record of the given type
#[derive(Debug, Args)]
struct QueryOpt {
    /// Name of the record to query
    name: Name,

    /// Type of DNS record to notify
    #[clap(name = "TYPE")]
    ty: RecordType,
}

impl QueryOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<DnsResponse, NetError> {
        let Self { name, ty } = self;
        println!("; sending query: {name} {class} {ty}");
        client.query(name, class, ty).await
    }
}

/// Notify a nameserver that a record has been updated
#[derive(Debug, Args)]

struct NotifyOpt {
    /// Name associated to the record that is being notified
    name: Name,

    /// Type of DNS record to notify
    #[clap(name = "TYPE")]
    ty: RecordType,

    /// Optional record data to associate
    rdata: Vec<String>,
}

impl NotifyOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<DnsResponse, NetError> {
        let Self { name, ty, rdata } = self;
        let rdata = if rdata.is_empty() {
            None
        } else {
            let ttl = 0;
            Some(record_set_from(name.clone(), class, ty, ttl, rdata))
        };

        println!("; sending notify: {name} {class} {ty}");
        client.notify(name, class, ty, rdata).await
    }
}

/// Create a new record in the target zone
#[derive(Debug, Args)]
struct CreateOpt {
    /// Name associated to the record to create
    name: Name,

    /// Type of DNS record to create
    #[clap(name = "TYPE")]
    ty: RecordType,

    /// Time to live value for the record
    ttl: u32,

    /// Zone, required for dynamic DNS updates, e.g. example.com if updating www.example.com
    #[clap(short = 'z', long)]
    zone: Name,

    /// Record data to associate
    #[clap(required = true)]
    rdata: Vec<String>,
}

impl CreateOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<DnsResponse, NetError> {
        let Self {
            name,
            ty,
            ttl,
            zone,
            rdata,
        } = self;
        let rdata = record_set_from(name.clone(), class, ty, ttl, rdata);

        println!("; sending create: {name} {class} {ty} in {zone}");
        client.create(rdata, zone).await
    }
}

/// Append record data to a record set
#[derive(Debug, Args)]
struct AppendOpt {
    /// If true, then the record must exist for the append to succeed
    #[clap(long)]
    must_exist: bool,

    /// Name associated to the record that is being updated
    name: Name,

    /// Type of DNS record to update
    #[clap(name = "TYPE")]
    ty: RecordType,

    /// Time to live value for the record
    ttl: u32,

    /// Zone, required for dynamic DNS updates, e.g. example.com if updating www.example.com
    #[clap(short = 'z', long)]
    zone: Name,

    /// Record data to associate
    #[clap(required = true)]
    rdata: Vec<String>,
}

impl AppendOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<DnsResponse, NetError> {
        let Self {
            must_exist,
            name,
            ty,
            ttl,
            zone,
            rdata,
        } = self;
        let rdata = record_set_from(name.clone(), class, ty, ttl, rdata);

        println!("; sending append: {name} {class} {ty} in {zone} and must_exist({must_exist})");
        client.append(rdata, zone, must_exist).await
    }
}

/// Delete a single record from a zone, the data must match the record
#[derive(Debug, Args)]
struct DeleteRecordOpt {
    /// Name associated to the record that is being updated
    name: Name,

    /// Type of DNS record to update
    #[clap(name = "TYPE")]
    ty: RecordType,

    /// Zone, required for dynamic DNS updates, e.g. example.com if updating www.example.com
    #[clap(short = 'z', long)]
    zone: Name,

    /// Record data to associate
    #[clap(required = true)]
    rdata: Vec<String>,
}

impl DeleteRecordOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<DnsResponse, NetError> {
        let Self {
            name,
            ty,
            zone,
            rdata,
        } = self;
        let ttl = 0;
        let rdata = record_set_from(name.clone(), class, ty, ttl, rdata);

        println!("; sending delete-record: {name} {class} {ty} from {zone}");
        client.delete_by_rdata(rdata, zone).await
    }
}

/// Fetch the dnskeys (key-signing-keys) from a zone, if zone is not specified it defaults to the Root, `.`
#[cfg(feature = "__dnssec")]
#[derive(Debug, Args)]
struct FetchKeysOpt {
    /// Zone, required for dynamic DNS updates, e.g. example.com if updating www.example.com
    #[clap(short = 'z', long)]
    zone: Name,

    /// If specified, files of Keys not in the Hickory TrustAnchor will be written to this path
    output_dir: Option<PathBuf>,
}

#[cfg(feature = "__dnssec")]
impl FetchKeysOpt {
    async fn run(
        self,
        class: DNSClass,
        mut client: impl ClientHandle,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let Self { zone, output_dir } = self;

        println!("; querying {zone} for key-signing-dnskeys, KSKs");

        let record_type = RecordType::DNSKEY;
        let response = client.query(zone, class, record_type).await?;
        let response = response.into_message();

        println!("; received response");
        println!("{response}");

        let trust_anchor = TrustAnchors::default();

        for dnskey in response
            .answers
            .iter()
            .filter_map(Record::try_borrow::<DNSKEY>)
            .filter(|dnskey| dnskey.data().secure_entry_point() && dnskey.data().zone_key())
        {
            let key_tag = dnskey.data().calculate_key_tag().expect("key_tag failed");
            let algorithm = dnskey.data().algorithm();
            let in_trust_anchor = trust_anchor.contains(dnskey.data().public_key());

            if !dnskey.data().algorithm().is_supported() {
                println!(
                    "; ignoring {key_tag}, unsupported algorithm {algorithm}: {}",
                    dnskey.data()
                );

                continue;
            }

            println!(
                "; found dnskey: {key_tag}, {algorithm}, in Hickory TrustAnchor: {in_trust_anchor}",
            );
            let Some(path) = &output_dir else {
                continue;
            };

            // only write unknown files
            if in_trust_anchor {
                println!("; skipping key in TrustAnchor");
                continue;
            }

            #[allow(deprecated)]
            let extension = match dnskey.data().algorithm() {
                Algorithm::RSASHA1
                | Algorithm::RSASHA1NSEC3SHA1
                | Algorithm::RSASHA256
                | Algorithm::RSASHA512 => String::from("rsa"),
                Algorithm::ECDSAP256SHA256 | Algorithm::ECDSAP384SHA384 => String::from("ecdsa"),
                Algorithm::ED25519 => String::from("ed25519"),
                Algorithm::Unknown(v) => format!("unknown_{v}"),
                alg => panic!("unknown Algorithm {alg:?}"),
            };

            let mut path = path.clone();
            path.push(format!("{key_tag}"));
            path.set_extension(extension);

            let mut file = OpenOptions::new();
            let mut file = file
                .write(true)
                .read(false)
                .truncate(true)
                .create(true)
                .open(&path)
                .expect("couldn't open file for writing");

            file.write_all(dnskey.data().public_key().public_bytes())
                .expect("failed to write to file");
            println!("; wrote dnskey {key_tag} to: {}", path.display());
        }

        Ok(())
    }
}

/// Run the resolve program
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let opts: Opts = Opts::parse();

    // enable logging early
    hickory_util::logger(env!("CARGO_BIN_NAME"), opts.log_config.level());

    // TODO: need to cleanup all of ClientHandle and the Client in general to make it dynamically usable.
    let provider = TokioRuntimeProvider::new();
    match opts.protocol {
        Protocol::Udp => udp(opts, provider).await?,
        Protocol::Tcp => tcp(opts, provider).await?,
        Protocol::Tls => tls(opts, provider).await?,
        Protocol::Https => https(opts, provider).await?,
        Protocol::Quic => quic(opts).await?,
        Protocol::H3 => h3(opts).await?,
    };

    Ok(())
}

async fn udp<P: RuntimeProvider>(
    opts: Opts,
    provider: P,
) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;

    println!("; using udp:{nameserver}");
    let stream = UdpClientStream::builder(nameserver, provider).build();
    let (client, bg) = Client::<P>::from_sender(stream);
    let handle = tokio::spawn(bg);
    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

async fn tcp<P: RuntimeProvider>(
    opts: Opts,
    provider: P,
) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;

    println!("; using tcp:{nameserver}");
    let (future, sender) = TcpClientStream::new(nameserver, None, None, provider);
    let (client, bg) = Client::<P>::new(future.await?, sender);

    let handle = tokio::spawn(bg);
    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

#[cfg(not(feature = "__tls"))]
async fn tls(
    _opts: Opts,
    _provider: impl RuntimeProvider,
) -> Result<(), Box<dyn std::error::Error>> {
    panic!("`tls-aws-lc-rs` or `tls-ring` feature is required during compilation");
}

#[cfg(feature = "__tls")]
async fn tls<P: RuntimeProvider>(
    opts: Opts,
    provider: P,
) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;
    let alpn = opts.alpn.map(String::into_bytes);
    let dns_name = opts
        .tls_dns_name
        .expect("tls_dns_name is required tls connections");
    println!("; using tls:{nameserver} dns_name:{dns_name}");

    let mut config = client_config()?;
    if opts.do_not_verify_nameserver_cert {
        do_not_verify_nameserver_cert(&mut config);
    }
    if let Some(alpn) = alpn {
        config.alpn_protocols.push(alpn);
    }

    let config = Arc::new(config);
    let server_name =
        ServerName::try_from(dns_name).expect("failed to parse tls_dns_name as ServerName");
    let (future, sender) = tls_client_connect(nameserver, server_name, config, provider);
    let (client, bg) = Client::<P>::new(future.await?, sender);

    let handle = tokio::spawn(bg);
    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

#[cfg(not(feature = "__https"))]
async fn https(
    _opts: Opts,
    _provider: impl RuntimeProvider,
) -> Result<(), Box<dyn std::error::Error>> {
    panic!("`https-aws-lc-rs` or `https-ring` feature is required during compilation");
}

#[cfg(feature = "__https")]
async fn https<P: RuntimeProvider>(
    opts: Opts,
    provider: P,
) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;
    let alpn = opts
        .alpn
        .map(String::into_bytes)
        .expect("ALPN is required for HTTPS");
    let dns_name = opts
        .tls_dns_name
        .expect("tls_dns_name is required for https connections");
    let http_endpoint = opts
        .http_endpoint
        .expect("http_endpoint is required for https connections");
    println!("; using https:{nameserver} dns_name:{dns_name}");

    let mut config = client_config()?;
    if opts.do_not_verify_nameserver_cert {
        do_not_verify_nameserver_cert(&mut config);
    }
    config.alpn_protocols.push(alpn);
    let config = Arc::new(config);

    let sender = HttpsClientStream::builder(config, provider)
        .build(nameserver, Arc::from(dns_name), Arc::from(http_endpoint))
        .await?;
    let (client, bg) = Client::<P>::from_sender(sender);
    let handle = tokio::spawn(bg);

    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

#[cfg(not(feature = "__quic"))]
async fn quic(_opts: Opts) -> Result<(), Box<dyn std::error::Error>> {
    panic!("`quic-aws-lc-rs` or `quic-ring` feature is required during compilation");
}

#[cfg(feature = "__quic")]
async fn quic(opts: Opts) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;
    let alpn = opts
        .alpn
        .map(String::into_bytes)
        .expect("ALPN is required for QUIC");
    let dns_name = opts
        .tls_dns_name
        .expect("tls_dns_name is required quic connections");
    println!("; using quic:{nameserver} dns_name:{dns_name}");

    let mut config = client_config()?;
    if opts.do_not_verify_nameserver_cert {
        do_not_verify_nameserver_cert(&mut config);
    }
    config.alpn_protocols.push(alpn);

    let sender = QuicClientStream::builder()
        .crypto_config(config)
        .build(nameserver, Arc::from(dns_name))
        .await?;
    let (client, bg) = Client::<TokioRuntimeProvider>::from_sender(sender);
    let handle = tokio::spawn(bg);

    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

#[cfg(not(feature = "__h3"))]
async fn h3(_opts: Opts) -> Result<(), Box<dyn std::error::Error>> {
    panic!("`h3-aws-lc-rs` or `h3-ring` feature is required during compilation");
}

#[cfg(feature = "__h3")]
async fn h3(opts: Opts) -> Result<(), Box<dyn std::error::Error>> {
    let nameserver = opts.nameserver;
    let alpn = opts
        .alpn
        .map(String::into_bytes)
        .expect("ALPN is required for H3");
    let dns_name = opts
        .tls_dns_name
        .expect("tls_dns_name is required for H3 connections");
    let http_endpoint = opts
        .http_endpoint
        .expect("http_endpoint is required for H3 connections");
    println!("; using h3:{nameserver} dns_name:{dns_name}");

    let mut config = client_config()?;
    if opts.do_not_verify_nameserver_cert {
        do_not_verify_nameserver_cert(&mut config);
    }
    config.alpn_protocols.push(alpn);

    let sender = H3ClientStream::builder()
        .crypto_config(config)
        .build(nameserver, Arc::from(dns_name), Arc::from(http_endpoint))
        .await?;
    let (client, bg) = Client::<TokioRuntimeProvider>::from_sender(sender);
    let handle = tokio::spawn(bg);

    handle_request(opts.class, opts.command, client).await?;
    drop(handle);

    Ok(())
}

async fn handle_request(
    class: DNSClass,
    command: Command,
    client: impl ClientHandle,
) -> Result<(), Box<dyn std::error::Error>> {
    let response = match command {
        Command::Query(opt) => opt.run(class, client).await?,
        Command::Notify(opt) => opt.run(class, client).await?,
        Command::Create(opt) => opt.run(class, client).await?,
        Command::Append(opt) => opt.run(class, client).await?,
        Command::DeleteRecord(opt) => opt.run(class, client).await?,
        #[cfg(feature = "__dnssec")]
        Command::FetchKeys(opt) => {
            opt.run(class, client).await?;
            return Ok(());
        }
    };

    let response = response.into_message();
    println!("; received response");
    println!("{response}");
    Ok(())
}

fn record_set_from(
    name: Name,
    class: DNSClass,
    record_type: RecordType,
    ttl: u32,
    rdata: Vec<String>,
) -> RecordSet {
    let rdata = rdata
        .iter()
        .map(|r| RData::try_from_str(record_type, r).expect("failed to parse rdata"));

    let mut record_set = RecordSet::with_ttl(name, record_type, ttl);
    record_set.set_dns_class(class);

    for data in rdata {
        record_set.add_rdata(data);
    }

    record_set
}

#[cfg(feature = "__tls")]
fn do_not_verify_nameserver_cert(tls_config: &mut ClientConfig) {
    let provider = tls_config.crypto_provider().clone();
    tls_config
        .dangerous()
        .set_certificate_verifier(Arc::new(DangerousVerifier { provider }));
}

#[cfg(feature = "__tls")]
#[derive(Debug)]
struct DangerousVerifier {
    provider: Arc<rustls::crypto::CryptoProvider>,
}

#[cfg(feature = "__tls")]
impl rustls::client::danger::ServerCertVerifier for DangerousVerifier {
    fn verify_server_cert(
        &self,
        _end_entity: &CertificateDer<'_>,
        _intermediates: &[CertificateDer<'_>],
        _server_name: &ServerName<'_>,
        _ocsp_response: &[u8],
        _now: UnixTime,
    ) -> Result<ServerCertVerified, rustls::Error> {
        println!(";!!!NOT VERIFYING THE SERVER TLS CERTIFICATE!!!");
        Ok(ServerCertVerified::assertion())
    }

    fn verify_tls12_signature(
        &self,
        _message: &[u8],
        _cert: &CertificateDer<'_>,
        _dss: &DigitallySignedStruct,
    ) -> Result<HandshakeSignatureValid, rustls::Error> {
        println!(";!!!NOT VERIFYING THE SERVER TLS CERTIFICATE!!!");
        Ok(HandshakeSignatureValid::assertion())
    }

    fn verify_tls13_signature(
        &self,
        _message: &[u8],
        _cert: &CertificateDer<'_>,
        _dss: &DigitallySignedStruct,
    ) -> Result<HandshakeSignatureValid, rustls::Error> {
        println!(";!!!NOT VERIFYING THE SERVER TLS CERTIFICATE!!!");
        Ok(HandshakeSignatureValid::assertion())
    }

    fn supported_verify_schemes(&self) -> Vec<rustls::SignatureScheme> {
        self.provider
            .signature_verification_algorithms
            .supported_schemes()
    }
}