acmex 0.8.0

AcmeX: High-performance, extensible ACME v2 (RFC 8555) client and server in Rust, supporting multiple DNS providers, storage backends, and crypto libraries.
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

/// Alibaba Cloud DNS Provider implementation.
/// This module provides DNS record management for Alibaba Cloud DNS (Alidns)
/// using the Alibaba Cloud POP RPC API style.
use crate::challenge::DnsProvider;
use crate::error::{AcmeError, Result};
use async_trait::async_trait;
use base64::Engine;
use hmac::{Hmac, KeyInit, Mac};
use jiff::Zoned;
use sha1::Sha1;
use std::collections::BTreeMap;

/// Alibaba Cloud DNS Provider for handling DNS-01 challenges.
#[derive(Debug, Clone)]
pub struct AlibabaCloudDnsProvider {
    /// Alibaba Cloud Access Key ID.
    access_key_id: String,
    /// Alibaba Cloud Access Key Secret.
    access_key_secret: String,
    /// Target region (e.g., "cn-hangzhou").
    #[allow(dead_code)]
    region: String,
    /// Internal HTTP client.
    client: reqwest::Client,
}

impl AlibabaCloudDnsProvider {
    /// Creates a new `AlibabaCloudDnsProvider` instance.
    pub fn new(access_key_id: String, access_key_secret: String, region: String) -> Self {
        tracing::debug!(
            "Initializing AlibabaCloudDnsProvider for region: {}",
            region
        );
        Self {
            access_key_id,
            access_key_secret,
            region,
            client: reqwest::Client::new(),
        }
    }

    /// Signs the request for Alibaba Cloud API using HMAC-SHA1 (POP RPC Style).
    fn sign_request(&self, method: &str, params: &BTreeMap<String, String>) -> String {
        // 1. Sort parameters and build canonical query string
        let canonical_query_string = params
            .iter()
            .map(|(k, v)| format!("{}={}", self.percent_encode(k), self.percent_encode(v)))
            .collect::<Vec<_>>()
            .join("&");

        // 2. Build string to sign
        let string_to_sign = format!(
            "{}&%2F&{}",
            method.to_uppercase(),
            self.percent_encode(&canonical_query_string)
        );

        // 3. Calculate HMAC-SHA1 signature
        type HmacSha1 = Hmac<Sha1>;

        let secret = format!("{}&", self.access_key_secret);
        let mut mac =
            HmacSha1::new_from_slice(secret.as_bytes()).expect("HMAC can take key of any size");
        mac.update(string_to_sign.as_bytes());

        base64::engine::general_purpose::STANDARD.encode(mac.finalize().into_bytes())
    }

    /// Performs percent-encoding according to Alibaba Cloud's specific requirements.
    fn percent_encode(&self, s: &str) -> String {
        urlencoding::encode(s)
            .replace("+", "%20")
            .replace("*", "%2A")
            .replace("%7E", "~")
    }

    /// Extracts the root domain name from a full domain string.
    fn get_domain_name(&self, domain: &str) -> String {
        let parts: Vec<&str> = domain.split('.').collect();
        if parts.len() > 2 {
            parts[parts.len() - 2..].join(".")
        } else {
            domain.to_string()
        }
    }

    /// Extracts the record name (RR) from a full domain string.
    fn get_record_name(&self, domain: &str) -> String {
        let domain_name = self.get_domain_name(domain);
        let name = domain
            .strip_suffix(&format!(".{}", domain_name))
            .unwrap_or("")
            .to_string();
        if name.is_empty() && domain != domain_name {
            domain
                .strip_suffix(&domain_name)
                .unwrap_or("")
                .trim_end_matches('.')
                .to_string()
        } else {
            name
        }
    }

    /// Executes a signed request to the Alibaba Cloud DNS API.
    async fn do_request(&self, mut params: BTreeMap<String, String>) -> Result<serde_json::Value> {
        params.insert("Format".to_string(), "JSON".to_string());
        params.insert("Version".to_string(), "2015-01-09".to_string());
        params.insert("AccessKeyId".to_string(), self.access_key_id.clone());
        params.insert("SignatureMethod".to_string(), "HMAC-SHA1".to_string());
        params.insert("SignatureVersion".to_string(), "1.0".to_string());
        params.insert(
            "SignatureNonce".to_string(),
            rand::random::<u64>().to_string(),
        );
        params.insert(
            "Timestamp".to_string(),
            Zoned::now().strftime("%Y-%m-%dT%H:%M:%SZ").to_string(),
        );

        let signature = self.sign_request("GET", &params);
        params.insert("Signature".to_string(), signature);

        let query = params
            .iter()
            .map(|(k, v)| format!("{}={}", self.percent_encode(k), self.percent_encode(v)))
            .collect::<Vec<_>>()
            .join("&");

        let url = format!("https://alidns.aliyuncs.com/?{}", query);

        let response = self.client.get(url).send().await.map_err(|e| {
            tracing::error!("Network error during Alibaba Cloud API call: {}", e);
            AcmeError::transport(format!("Alibaba API failed: {}", e))
        })?;

        let status = response.status();
        let body: serde_json::Value = response.json().await.map_err(|e| {
            tracing::error!("Failed to parse Alibaba Cloud API response: {}", e);
            AcmeError::protocol(format!("Failed to parse Alibaba response: {}", e))
        })?;

        if !status.is_success() {
            let code = body["Code"].as_str().unwrap_or("Unknown");
            let message = body["Message"].as_str().unwrap_or("");
            tracing::error!("Alibaba Cloud DNS API error ({}): {}", code, message);
            return Err(AcmeError::protocol(format!(
                "Alibaba DNS error: {} - {}",
                code, message
            )));
        }

        Ok(body)
    }
}

#[async_trait]
impl DnsProvider for AlibabaCloudDnsProvider {
    /// Creates a TXT record in Alibaba Cloud DNS.
    async fn create_txt_record(&self, domain: &str, value: &str) -> Result<String> {
        tracing::info!(
            "Creating TXT record in Alibaba Cloud DNS for domain: {}",
            domain
        );

        let domain_name = self.get_domain_name(domain);
        let record_name = self.get_record_name(domain);

        let mut params = BTreeMap::new();
        params.insert("Action".to_string(), "AddDomainRecord".to_string());
        params.insert("DomainName".to_string(), domain_name);
        params.insert("RR".to_string(), record_name);
        params.insert("Type".to_string(), "TXT".to_string());
        params.insert("Value".to_string(), value.to_string());
        params.insert("TTL".to_string(), "600".to_string());

        let body = self.do_request(params).await?;

        let record_id = body["RecordId"]
            .as_str()
            .map(|s| s.to_string())
            .ok_or_else(|| {
                tracing::error!("RecordId missing in Alibaba Cloud AddDomainRecord response");
                AcmeError::protocol("RecordId not found in response".to_string())
            })?;

        tracing::info!(
            "Successfully created Alibaba Cloud TXT record with ID: {}",
            record_id
        );
        Ok(record_id)
    }

    /// Deletes a TXT record from Alibaba Cloud DNS.
    async fn delete_txt_record(&self, _domain: &str, record_id: &str) -> Result<()> {
        tracing::info!(
            "Deleting TXT record from Alibaba Cloud DNS, ID: {}",
            record_id
        );

        let mut params = BTreeMap::new();
        params.insert("Action".to_string(), "DeleteDomainRecord".to_string());
        params.insert("RecordId".to_string(), record_id.to_string());

        self.do_request(params).await?;
        tracing::info!(
            "Successfully deleted Alibaba Cloud TXT record: {}",
            record_id
        );
        Ok(())
    }

    /// Verifies the existence of a TXT record in Alibaba Cloud DNS.
    async fn verify_record(&self, domain: &str, value: &str) -> Result<bool> {
        tracing::debug!(
            "Verifying TXT record in Alibaba Cloud DNS for domain: {}",
            domain
        );
        let domain_name = self.get_domain_name(domain);
        let record_name = self.get_record_name(domain);

        let mut params = BTreeMap::new();
        params.insert("Action".to_string(), "DescribeDomainRecords".to_string());
        params.insert("DomainName".to_string(), domain_name);
        params.insert("RRKeyWord".to_string(), record_name);
        params.insert("TypeKeyWord".to_string(), "TXT".to_string());

        let body = self.do_request(params).await?;

        if let Some(domain_records) = body["DomainRecords"]["Record"].as_array() {
            for record in domain_records {
                if record["Value"].as_str() == Some(value) {
                    tracing::debug!("Alibaba Cloud record verification successful");
                    return Ok(true);
                }
            }
        }

        tracing::warn!("Alibaba Cloud record verification failed: value not found");
        Ok(false)
    }
}