dns-update 0.4.1

Dynamic DNS update (RFC 2136 and cloud) library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

/*
 * Copyright Stalwart Labs LLC See the COPYING
 * file at the top-level directory of this distribution.
 *
 * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 * https://www.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 crate::{DnsRecord, DnsRecordType, Error, IntoFqdn, http::HttpClientBuilder};
use std::{borrow::Cow, time::Duration};

const DEFAULT_API_ENDPOINT: &str = "https://www.duckdns.org/update";

const DUCKDNS_SUFFIX: &str = "duckdns.org";

#[derive(Clone)]
pub struct DuckDnsProvider {
    client: HttpClientBuilder,
    token: String,
    endpoint: Cow<'static, str>,
}

impl DuckDnsProvider {
    pub(crate) fn new(token: impl AsRef<str>, timeout: Option<Duration>) -> crate::Result<Self> {
        let token = token.as_ref();
        if token.is_empty() {
            return Err(Error::Api("DuckDNS token is empty".to_string()));
        }
        Ok(Self {
            client: HttpClientBuilder::default().with_timeout(timeout),
            token: token.to_string(),
            endpoint: Cow::Borrowed(DEFAULT_API_ENDPOINT),
        })
    }

    #[cfg(test)]
    pub(crate) fn with_endpoint(self, endpoint: impl Into<Cow<'static, str>>) -> Self {
        Self {
            endpoint: endpoint.into(),
            ..self
        }
    }

    pub(crate) async fn create(
        &self,
        name: impl IntoFqdn<'_>,
        record: DnsRecord,
        _ttl: u32,
        _origin: impl IntoFqdn<'_>,
    ) -> crate::Result<()> {
        let domain = main_domain(name.into_name().as_ref())?;
        match record {
            DnsRecord::TXT(value) => self.update_txt(&domain, &value, false).await,
            _ => Err(Error::Api(
                "Only TXT records are supported by DuckDNS".to_string(),
            )),
        }
    }

    pub(crate) async fn update(
        &self,
        name: impl IntoFqdn<'_>,
        record: DnsRecord,
        ttl: u32,
        origin: impl IntoFqdn<'_>,
    ) -> crate::Result<()> {
        self.create(name, record, ttl, origin).await
    }

    pub(crate) async fn delete(
        &self,
        name: impl IntoFqdn<'_>,
        _origin: impl IntoFqdn<'_>,
        record_type: DnsRecordType,
    ) -> crate::Result<()> {
        if record_type != DnsRecordType::TXT {
            return Err(Error::Api(
                "Only TXT records are supported by DuckDNS".to_string(),
            ));
        }
        let domain = main_domain(name.into_name().as_ref())?;
        self.update_txt(&domain, "", true).await
    }

    async fn update_txt(&self, domain: &str, value: &str, clear: bool) -> crate::Result<()> {
        let query = serde_urlencoded::to_string([
            ("domains", domain),
            ("token", self.token.as_str()),
            ("clear", if clear { "true" } else { "false" }),
            ("txt", value),
        ])
        .map_err(|err| Error::Serialize(format!("Failed to encode query: {err}")))?;

        let response = self
            .client
            .get(format!("{}?{}", self.endpoint, query))
            .send_raw()
            .await?;
        if response.trim() == "OK" {
            Ok(())
        } else {
            Err(Error::Api(format!(
                "DuckDNS update did not return OK: {response}"
            )))
        }
    }
}

fn main_domain(name: &str) -> crate::Result<String> {
    let trimmed = name.trim_end_matches('.').to_ascii_lowercase();
    if trimmed.ends_with(DUCKDNS_SUFFIX) {
        let labels: Vec<&str> = trimmed.split('.').collect();
        if labels.len() < 3 {
            return Err(Error::Api(format!(
                "DuckDNS requires a subdomain of {DUCKDNS_SUFFIX}: {name}"
            )));
        }
        let start = labels.len() - 3;
        Ok(labels[start..].join("."))
    } else {
        let labels: Vec<&str> = trimmed.split('.').collect();
        if labels.is_empty() {
            return Err(Error::Api(format!("Invalid domain: {name}")));
        }
        Ok(labels[labels.len() - 1].to_string())
    }
}