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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338

/// Google Cloud DNS Provider implementation.
/// This module provides DNS record management for Google Cloud DNS using the Cloud DNS REST API.
use crate::challenge::DnsProvider;
use crate::error::{AcmeError, Result};
use async_trait::async_trait;

/// Google Cloud DNS Provider for handling DNS-01 challenges.
#[derive(Debug, Clone)]
pub struct GoogleCloudDnsProvider {
    /// Google Cloud Project ID.
    project_id: String,
    /// Path to the service account JSON file (optional).
    #[allow(dead_code)]
    service_account_json: Option<String>,
    /// Whether to use Application Default Credentials (ADC).
    #[allow(dead_code)]
    use_default_credentials: bool,
    /// Internal HTTP client.
    client: reqwest::Client,
}

impl GoogleCloudDnsProvider {
    /// Creates a new `GoogleCloudDnsProvider` instance for the specified project.
    pub fn new(project_id: String) -> Self {
        tracing::debug!(
            "Initializing GoogleCloudDnsProvider for Project: {}",
            project_id
        );
        Self {
            project_id,
            service_account_json: None,
            use_default_credentials: true,
            client: reqwest::Client::new(),
        }
    }

    /// Configures the provider to use a specific service account JSON file.
    pub fn with_service_account(mut self, json_path: String) -> Self {
        self.service_account_json = Some(json_path);
        self.use_default_credentials = false;
        self
    }

    /// Configures the provider to use Application Default Credentials (ADC).
    pub fn with_default_credentials(mut self) -> Self {
        self.use_default_credentials = true;
        self
    }

    /// Obtains a Google Cloud access token.
    /// Currently supports environment variables and the GCP metadata server.
    async fn get_access_token(&self) -> Result<String> {
        tracing::debug!("Attempting to obtain Google Cloud access token");
        // Check environment variable first
        if let Ok(token) = std::env::var("GOOGLE_OAUTH_ACCESS_TOKEN") {
            tracing::debug!(
                "Using access token from GOOGLE_OAUTH_ACCESS_TOKEN environment variable"
            );
            return Ok(token);
        }

        // Fallback to metadata server (GCP environment)
        tracing::debug!("Attempting to fetch token from GCP metadata server");
        let metadata_url = "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/token";
        let response = self
            .client
            .get(metadata_url)
            .header("Metadata-Flavor", "Google")
            .send()
            .await;

        match response {
            Ok(resp) if resp.status().is_success() => {
                let body: serde_json::Value = resp.json().await.map_err(|e| {
                    tracing::error!("Failed to parse metadata server response: {}", e);
                    AcmeError::protocol(format!("Failed to parse metadata token: {}", e))
                })?;
                body["access_token"]
                    .as_str()
                    .map(|s| s.to_string())
                    .ok_or_else(|| {
                        tracing::error!("'access_token' missing in metadata server response");
                        AcmeError::protocol(
                            "access_token not found in metadata response".to_string(),
                        )
                    })
            }
            _ => {
                tracing::error!(
                    "Google Cloud credentials not found. Set GOOGLE_OAUTH_ACCESS_TOKEN or run on GCP."
                );
                Err(AcmeError::configuration("Google Cloud credentials not found. Please set GOOGLE_OAUTH_ACCESS_TOKEN or run on GCP.".to_string()))
            }
        }
    }

    /// Finds the managed zone ID for a given domain.
    async fn get_managed_zone(&self, domain: &str) -> Result<String> {
        let token = self.get_access_token().await?;

        // Extract zone name from domain (e.g., _acme-challenge.example.com -> example.com)
        let parts: Vec<&str> = domain.split('.').collect();
        let zone_dns_name = if parts.len() > 2 {
            format!("{}.", parts[parts.len() - 2..].join("."))
        } else {
            format!("{}.", domain)
        };

        tracing::debug!(
            "Searching for Google Cloud DNS managed zone for: {}",
            zone_dns_name
        );

        let api_url = format!(
            "https://dns.googleapis.com/dns/v1/projects/{}/managedZones",
            self.project_id
        );

        let response = self
            .client
            .get(&api_url)
            .bearer_auth(&token)
            .send()
            .await
            .map_err(|e| {
                tracing::error!("Network error while listing Google Cloud DNS zones: {}", e);
                AcmeError::transport(format!("Google API list zones failed: {}", e))
            })?;

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

        if let Some(zones) = body["managedZones"].as_array() {
            for zone in zones {
                if let Some(dns_name) = zone["dnsName"].as_str()
                    && dns_name == zone_dns_name
                {
                    let name = zone["name"].as_str().unwrap_or_default().to_string();
                    tracing::debug!("Found managed zone: {} for DNS name: {}", name, dns_name);
                    return Ok(name);
                }
            }
        }

        tracing::error!(
            "No managed zone found in GCP project {} matching {}",
            self.project_id,
            zone_dns_name
        );
        Err(AcmeError::protocol(format!(
            "Managed zone not found for domain: {}",
            domain
        )))
    }
}

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

        let zone_name = self.get_managed_zone(domain).await?;
        let token = self.get_access_token().await?;
        let record_name = format!("{}.", domain);

        let api_url = format!(
            "https://dns.googleapis.com/dns/v1/projects/{}/managedZones/{}/changes",
            self.project_id, zone_name
        );

        let payload = serde_json::json!({
            "additions": [
                {
                    "name": record_name,
                    "type": "TXT",
                    "ttl": 300,
                    "rrdatas": [format!("\"{}\"", value)]
                }
            ]
        });

        let response = self
            .client
            .post(&api_url)
            .bearer_auth(&token)
            .json(&payload)
            .send()
            .await
            .map_err(|e| {
                tracing::error!(
                    "Network error during Google Cloud DNS record creation: {}",
                    e
                );
                AcmeError::transport(format!("Google API create record failed: {}", e))
            })?;

        if !response.status().is_success() {
            let err_text = response.text().await.unwrap_or_default();
            tracing::error!("Google Cloud DNS API error: {}", err_text);
            return Err(AcmeError::protocol(format!("GCP DNS error: {}", err_text)));
        }

        tracing::info!(
            "Successfully created Google Cloud DNS TXT record in zone: {}",
            zone_name
        );
        // Return zone_name as record_id for deletion
        Ok(zone_name)
    }

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

        let token = self.get_access_token().await?;
        let record_name = format!("{}.", domain);
        let zone_name = record_id; // We stored zone_name as record_id

        // Fetch the current rrsets to find the exact record to delete
        let list_url = format!(
            "https://dns.googleapis.com/dns/v1/projects/{}/managedZones/{}/rrsets?name={}&type=TXT",
            self.project_id, zone_name, record_name
        );

        let list_resp = self
            .client
            .get(&list_url)
            .bearer_auth(&token)
            .send()
            .await
            .map_err(|e| {
                tracing::error!("Network error while listing Google Cloud DNS rrsets: {}", e);
                AcmeError::transport(format!("GCP list rrsets failed: {}", e))
            })?;

        let body: serde_json::Value = list_resp.json().await.unwrap_or_default();
        let rrsets = body["rrsets"].as_array().ok_or_else(|| {
            tracing::error!("No TXT rrsets found for deletion in Google Cloud DNS");
            AcmeError::protocol("No rrsets found for deletion".to_string())
        })?;

        let api_url = format!(
            "https://dns.googleapis.com/dns/v1/projects/{}/managedZones/{}/changes",
            self.project_id, zone_name
        );

        let payload = serde_json::json!({
            "deletions": rrsets
        });

        let response = self
            .client
            .post(&api_url)
            .bearer_auth(&token)
            .json(&payload)
            .send()
            .await
            .map_err(|e| {
                tracing::error!(
                    "Network error during Google Cloud DNS record deletion: {}",
                    e
                );
                AcmeError::transport(format!("Google API delete record failed: {}", e))
            })?;

        if !response.status().is_success() {
            tracing::error!(
                "Google Cloud DNS API deletion failed with status: {}",
                response.status()
            );
            return Err(AcmeError::protocol("GCP DNS delete failed".to_string()));
        }

        tracing::info!("Successfully deleted Google Cloud DNS TXT record");
        Ok(())
    }

    /// Verifies the existence of a TXT record in Google Cloud DNS.
    async fn verify_record(&self, domain: &str, value: &str) -> Result<bool> {
        tracing::debug!(
            "Verifying TXT record in Google Cloud DNS for domain: {}",
            domain
        );
        let zone_name = match self.get_managed_zone(domain).await {
            Ok(name) => name,
            Err(_) => return Ok(false),
        };
        let token = self.get_access_token().await?;
        let record_name = format!("{}.", domain);

        let api_url = format!(
            "https://dns.googleapis.com/dns/v1/projects/{}/managedZones/{}/rrsets?name={}&type=TXT",
            self.project_id, zone_name, record_name
        );

        let response = self
            .client
            .get(&api_url)
            .bearer_auth(&token)
            .send()
            .await
            .map_err(|e| {
                tracing::error!(
                    "Network error during Google Cloud DNS record verification: {}",
                    e
                );
                AcmeError::transport(format!("GCP verify failed: {}", e))
            })?;

        let body: serde_json::Value = response.json().await.unwrap_or_default();
        let quoted_value = format!("\"{}\"", value);

        if let Some(rrsets) = body["rrsets"].as_array() {
            for rrset in rrsets {
                if let Some(rrdatas) = rrset["rrdatas"].as_array() {
                    for data in rrdatas {
                        if data.as_str() == Some(&quoted_value) {
                            tracing::debug!("Google Cloud DNS record verification successful");
                            return Ok(true);
                        }
                    }
                }
            }
        }

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