use crate::utils::build_caa;
use crate::utils::strip_trailing_dot;
use crate::utils::{
decode_hex, tlsa_cert_usage_from_u8, tlsa_matching_from_u8, tlsa_selector_from_u8,
};
use crate::{
DnsRecord, DnsRecordType, Error, IntoFqdn, MXRecord, SRVRecord, TLSARecord,
http::{HttpClient, HttpClientBuilder},
utils::strip_origin_from_name,
};
use base64::{Engine as _, engine::general_purpose::STANDARD};
use serde::{Deserialize, Serialize};
use std::net::{Ipv4Addr, Ipv6Addr};
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};
const DEFAULT_API_ENDPOINT: &str = "https://api.mythic-beasts.com/dns/v2";
const DEFAULT_AUTH_ENDPOINT: &str = "https://auth.mythic-beasts.com/login";
#[derive(Clone)]
pub struct MythicBeastsProvider {
auth: Arc<Mutex<AuthState>>,
username: String,
password: String,
api_endpoint: String,
auth_endpoint: String,
client: HttpClient,
}
struct AuthState {
token: Option<(String, Instant)>,
zones: Option<(Vec<String>, Instant)>,
}
#[derive(Deserialize, Debug)]
struct ZonesResponse {
#[serde(default)]
zones: Vec<String>,
}
#[derive(Deserialize, Debug)]
struct TokenResponse {
access_token: String,
expires_in: u64,
#[serde(default)]
token_type: String,
}
#[derive(Serialize, Debug)]
struct RecordsBody {
records: Vec<RecordPayload>,
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
struct RecordPayload {
host: String,
ttl: u32,
#[serde(rename = "type")]
record_type: String,
data: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
mx_priority: Option<u16>,
#[serde(default, skip_serializing_if = "Option::is_none")]
srv_priority: Option<u16>,
#[serde(default, skip_serializing_if = "Option::is_none")]
srv_weight: Option<u16>,
#[serde(default, skip_serializing_if = "Option::is_none")]
srv_port: Option<u16>,
#[serde(default, skip_serializing_if = "Option::is_none")]
caa_flags: Option<u8>,
#[serde(default, skip_serializing_if = "Option::is_none")]
caa_tag: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
tlsa_usage: Option<u8>,
#[serde(default, skip_serializing_if = "Option::is_none")]
tlsa_selector: Option<u8>,
#[serde(default, skip_serializing_if = "Option::is_none")]
tlsa_matching: Option<u8>,
}
#[derive(Deserialize, Debug)]
struct ListResponse {
#[serde(default)]
records: Vec<RecordPayload>,
}
#[derive(Deserialize, Debug)]
#[allow(dead_code)]
struct MutationResponse {
#[serde(default)]
records_added: i64,
#[serde(default)]
records_removed: i64,
#[serde(default)]
message: String,
}
impl MythicBeastsProvider {
pub(crate) fn new(
username: impl AsRef<str>,
password: impl AsRef<str>,
timeout: Option<Duration>,
) -> crate::Result<Self> {
let username = username.as_ref().to_string();
let password = password.as_ref().to_string();
if username.is_empty() || password.is_empty() {
return Err(Error::Api(
"Mythic Beasts username and password must not be empty".to_string(),
));
}
let client = HttpClientBuilder::default()
.with_header("Accept", "application/json")
.with_timeout(timeout)
.build();
Ok(Self {
auth: Arc::new(Mutex::new(AuthState {
token: None,
zones: None,
})),
username,
password,
api_endpoint: DEFAULT_API_ENDPOINT.to_string(),
auth_endpoint: DEFAULT_AUTH_ENDPOINT.to_string(),
client,
})
}
#[cfg(test)]
pub(crate) fn with_endpoint(self, endpoint: impl AsRef<str>) -> Self {
let base = endpoint.as_ref().trim_end_matches('/').to_string();
Self {
api_endpoint: format!("{base}/dns/v2"),
auth_endpoint: format!("{base}/auth/login"),
..self
}
}
async fn ensure_token(&self) -> crate::Result<String> {
{
let guard = self
.auth
.lock()
.map_err(|_| Error::Client("Mythic Beasts token lock poisoned".to_string()))?;
if let Some((token, expiry)) = &guard.token
&& Instant::now() < *expiry
{
return Ok(token.clone());
}
}
let credentials = STANDARD.encode(format!("{}:{}", self.username, self.password));
let body: TokenResponse = self
.client
.post(self.auth_endpoint.clone())
.with_header("Authorization", format!("Basic {credentials}"))
.with_header("Content-Type", "application/x-www-form-urlencoded")
.with_raw_body("grant_type=client_credentials".to_string())
.send()
.await?;
if !body.token_type.eq_ignore_ascii_case("bearer") && !body.token_type.is_empty() {
return Err(Error::Api(format!(
"Unexpected token type: {}",
body.token_type
)));
}
let expiry = Instant::now() + Duration::from_secs(body.expires_in.saturating_sub(60));
let mut guard = self
.auth
.lock()
.map_err(|_| Error::Client("Mythic Beasts token lock poisoned".to_string()))?;
guard.token = Some((body.access_token.clone(), expiry));
Ok(body.access_token)
}
async fn resolve_zone(&self, origin: &str, token: &str) -> crate::Result<String> {
let origin = origin.trim_end_matches('.');
{
let guard = self
.auth
.lock()
.map_err(|_| Error::Client("Mythic Beasts zone lock poisoned".to_string()))?;
if let Some((zones, expiry)) = &guard.zones
&& Instant::now() < *expiry
{
return Ok(match_zone(zones, origin).unwrap_or_else(|| origin.to_string()));
}
}
let zones = match self
.client
.get(format!("{}/zones", self.api_endpoint))
.with_header("Authorization", format!("Bearer {token}"))
.send::<ZonesResponse>()
.await
{
Ok(response) => response.zones,
Err(_) => return Ok(origin.to_string()),
};
let resolved = match_zone(&zones, origin).unwrap_or_else(|| origin.to_string());
let expiry = Instant::now() + Duration::from_secs(300);
if let Ok(mut guard) = self.auth.lock() {
guard.zones = Some((zones, expiry));
}
Ok(resolved)
}
fn rrset_url(&self, zone: &str, host: &str, record_type: DnsRecordType) -> String {
format!(
"{}/zones/{}/records/{}/{}",
self.api_endpoint,
zone,
host,
record_type.as_str(),
)
}
pub(crate) async fn set_rrset(
&self,
name: impl IntoFqdn<'_>,
record_type: DnsRecordType,
ttl: u32,
records: Vec<DnsRecord>,
origin: impl IntoFqdn<'_>,
) -> crate::Result<()> {
let name = name.into_name();
let domain = origin.into_name();
ensure_uniform_type(record_type, &records)?;
let token = self.ensure_token().await?;
let zone = self.resolve_zone(&domain, &token).await?;
let subdomain = strip_origin_from_name(&name, &zone, Some("@"));
let payloads = build_payloads(&subdomain, record_type, ttl, records)?;
let url = self.rrset_url(&zone, &subdomain, record_type);
if payloads.is_empty() {
return match self
.client
.delete(url)
.with_header("Authorization", format!("Bearer {token}"))
.send_raw()
.await
{
Ok(_) => Ok(()),
Err(Error::NotFound) => Ok(()),
Err(e) => Err(e),
};
}
let body = RecordsBody { records: payloads };
let _: MutationResponse = self
.client
.put(url)
.with_header("Authorization", format!("Bearer {token}"))
.with_body(body)?
.send()
.await?;
Ok(())
}
pub(crate) async fn add_to_rrset(
&self,
name: impl IntoFqdn<'_>,
record_type: DnsRecordType,
ttl: u32,
records: Vec<DnsRecord>,
origin: impl IntoFqdn<'_>,
) -> crate::Result<()> {
let name = name.into_name();
let domain = origin.into_name();
ensure_uniform_type(record_type, &records)?;
if records.is_empty() {
return Ok(());
}
let token = self.ensure_token().await?;
let zone = self.resolve_zone(&domain, &token).await?;
let subdomain = strip_origin_from_name(&name, &zone, Some("@"));
let payloads = build_payloads(&subdomain, record_type, ttl, records)?;
if payloads.is_empty() {
return Ok(());
}
let url = self.rrset_url(&zone, &subdomain, record_type);
let existing = match self
.client
.get(url.clone())
.with_header("Authorization", format!("Bearer {token}"))
.send::<ListResponse>()
.await
{
Ok(r) => r.records,
Err(Error::NotFound) => Vec::new(),
Err(e) => return Err(e),
};
let to_add: Vec<RecordPayload> = payloads
.into_iter()
.filter(|payload| !existing.iter().any(|e| rdata_matches(e, payload)))
.collect();
if to_add.is_empty() {
return Ok(());
}
let body = RecordsBody { records: to_add };
let _: MutationResponse = self
.client
.post(url)
.with_header("Authorization", format!("Bearer {token}"))
.with_body(body)?
.send()
.await?;
Ok(())
}
pub(crate) async fn remove_from_rrset(
&self,
name: impl IntoFqdn<'_>,
record_type: DnsRecordType,
records: Vec<DnsRecord>,
origin: impl IntoFqdn<'_>,
) -> crate::Result<()> {
let name = name.into_name();
let domain = origin.into_name();
ensure_uniform_type(record_type, &records)?;
if records.is_empty() {
return Ok(());
}
let token = self.ensure_token().await?;
let zone = self.resolve_zone(&domain, &token).await?;
let subdomain = strip_origin_from_name(&name, &zone, Some("@"));
let to_remove = build_payloads(&subdomain, record_type, 0, records)?;
if to_remove.is_empty() {
return Ok(());
}
let url = self.rrset_url(&zone, &subdomain, record_type);
let current = match self
.client
.get(url.clone())
.with_header("Authorization", format!("Bearer {token}"))
.send::<ListResponse>()
.await
{
Ok(r) => r.records,
Err(Error::NotFound) => return Ok(()),
Err(e) => return Err(e),
};
let remaining: Vec<RecordPayload> = current
.into_iter()
.filter(|existing| {
!to_remove
.iter()
.any(|target| rdata_matches(existing, target))
})
.collect();
if remaining.is_empty() {
return match self
.client
.delete(url)
.with_header("Authorization", format!("Bearer {token}"))
.send_raw()
.await
{
Ok(_) => Ok(()),
Err(Error::NotFound) => Ok(()),
Err(e) => Err(e),
};
}
let body = RecordsBody { records: remaining };
let _: MutationResponse = self
.client
.put(url)
.with_header("Authorization", format!("Bearer {token}"))
.with_body(body)?
.send()
.await?;
Ok(())
}
pub(crate) async fn list_rrset(
&self,
name: impl IntoFqdn<'_>,
record_type: DnsRecordType,
origin: impl IntoFqdn<'_>,
) -> crate::Result<Vec<DnsRecord>> {
let name = name.into_name();
let domain = origin.into_name();
let token = self.ensure_token().await?;
let zone = self.resolve_zone(&domain, &token).await?;
let subdomain = strip_origin_from_name(&name, &zone, Some("@"));
let url = self.rrset_url(&zone, &subdomain, record_type);
let response = match self
.client
.get(url)
.with_header("Authorization", format!("Bearer {token}"))
.send::<ListResponse>()
.await
{
Ok(r) => r,
Err(Error::NotFound) => return Ok(Vec::new()),
Err(e) => return Err(e),
};
let expected = record_type.as_str();
response
.records
.into_iter()
.filter(|r| r.record_type.eq_ignore_ascii_case(expected))
.map(payload_to_record)
.collect()
}
}
fn rdata_matches(a: &RecordPayload, b: &RecordPayload) -> bool {
a.record_type.eq_ignore_ascii_case(&b.record_type)
&& a.host == b.host
&& a.data == b.data
&& a.mx_priority == b.mx_priority
&& a.srv_priority == b.srv_priority
&& a.srv_weight == b.srv_weight
&& a.srv_port == b.srv_port
&& a.caa_flags == b.caa_flags
&& a.caa_tag == b.caa_tag
&& a.tlsa_usage == b.tlsa_usage
&& a.tlsa_selector == b.tlsa_selector
&& a.tlsa_matching == b.tlsa_matching
}
fn match_zone(zones: &[String], origin: &str) -> Option<String> {
let mut candidate = origin;
loop {
if let Some(zone) = zones
.iter()
.find(|zone| zone.trim_end_matches('.').eq_ignore_ascii_case(candidate))
{
return Some(zone.trim_end_matches('.').to_string());
}
match candidate.split_once('.') {
Some((_, rest)) if rest.contains('.') => candidate = rest,
_ => return None,
}
}
}
fn ensure_uniform_type(expected_type: DnsRecordType, records: &[DnsRecord]) -> crate::Result<()> {
for record in records {
if record.as_type() != expected_type {
return Err(Error::Api(format!(
"RRSet record type mismatch: expected {}, got {}",
expected_type.as_str(),
record.as_type().as_str(),
)));
}
}
Ok(())
}
fn build_payloads(
host: &str,
expected_type: DnsRecordType,
ttl: u32,
records: Vec<DnsRecord>,
) -> crate::Result<Vec<RecordPayload>> {
ensure_uniform_type(expected_type, &records)?;
let mut out = Vec::with_capacity(records.len());
for record in records {
out.push(build_payload(host, record, ttl)?);
}
Ok(out)
}
fn build_payload(host: &str, record: DnsRecord, ttl: u32) -> crate::Result<RecordPayload> {
let record_type = record.as_type().as_str().to_string();
let mut payload = RecordPayload {
host: host.to_string(),
ttl,
record_type,
data: String::new(),
mx_priority: None,
srv_priority: None,
srv_weight: None,
srv_port: None,
caa_flags: None,
caa_tag: None,
tlsa_usage: None,
tlsa_selector: None,
tlsa_matching: None,
};
match record {
DnsRecord::A(addr) => {
payload.data = addr.to_string();
}
DnsRecord::AAAA(addr) => {
payload.data = addr.to_string();
}
DnsRecord::CNAME(content) => {
payload.data = content.into_fqdn().into_owned();
}
DnsRecord::NS(content) => {
payload.data = content.into_fqdn().into_owned();
}
DnsRecord::MX(mx) => {
payload.mx_priority = Some(mx.priority);
payload.data = mx.exchange.into_fqdn().into_owned();
}
DnsRecord::TXT(content) => {
payload.data = content;
}
DnsRecord::SRV(srv) => {
payload.srv_priority = Some(srv.priority);
payload.srv_weight = Some(srv.weight);
payload.srv_port = Some(srv.port);
payload.data = srv.target.into_fqdn().into_owned();
}
DnsRecord::TLSA(tlsa) => {
payload.tlsa_usage = Some(u8::from(tlsa.cert_usage));
payload.tlsa_selector = Some(u8::from(tlsa.selector));
payload.tlsa_matching = Some(u8::from(tlsa.matching));
payload.data = tlsa.cert_data.iter().map(|b| format!("{b:02x}")).collect();
}
DnsRecord::CAA(caa) => {
let (flags, tag, value) = caa.decompose();
payload.caa_flags = Some(flags);
payload.caa_tag = Some(tag);
payload.data = value;
}
}
Ok(payload)
}
fn payload_to_record(payload: RecordPayload) -> crate::Result<DnsRecord> {
let upper = payload.record_type.to_ascii_uppercase();
Ok(match upper.as_str() {
"A" => DnsRecord::A(
payload
.data
.parse::<Ipv4Addr>()
.map_err(|e| Error::Parse(format!("Invalid A record: {e}")))?,
),
"AAAA" => DnsRecord::AAAA(
payload
.data
.parse::<Ipv6Addr>()
.map_err(|e| Error::Parse(format!("Invalid AAAA record: {e}")))?,
),
"CNAME" => DnsRecord::CNAME(strip_trailing_dot(&payload.data).to_string()),
"NS" => DnsRecord::NS(strip_trailing_dot(&payload.data).to_string()),
"MX" => DnsRecord::MX(MXRecord {
priority: payload.mx_priority.unwrap_or(0),
exchange: strip_trailing_dot(&payload.data).to_string(),
}),
"TXT" => DnsRecord::TXT(payload.data),
"SRV" => DnsRecord::SRV(SRVRecord {
priority: payload.srv_priority.unwrap_or(0),
weight: payload.srv_weight.unwrap_or(0),
port: payload.srv_port.unwrap_or(0),
target: strip_trailing_dot(&payload.data).to_string(),
}),
"TLSA" => DnsRecord::TLSA(TLSARecord {
cert_usage: tlsa_cert_usage_from_u8(payload.tlsa_usage.unwrap_or(0))?,
selector: tlsa_selector_from_u8(payload.tlsa_selector.unwrap_or(0))?,
matching: tlsa_matching_from_u8(payload.tlsa_matching.unwrap_or(0))?,
cert_data: decode_hex(&payload.data)?,
}),
"CAA" => DnsRecord::CAA(build_caa(
payload.caa_flags.unwrap_or(0),
&payload.caa_tag.unwrap_or_default(),
&payload.data,
)?),
other => {
return Err(Error::Api(format!(
"Unsupported record type from Mythic Beasts: {other}"
)));
}
})
}