use std::{
collections::{BTreeMap, BTreeSet},
fmt::{self, Display},
hash::Hash,
net::SocketAddr,
str::FromStr,
};
use anyhow::{anyhow, Result};
#[cfg(not(wasm_browser))]
use hickory_resolver::{proto::ProtoError, Name};
use iroh_base::{NodeAddr, NodeId, RelayUrl, SecretKey};
#[cfg(not(wasm_browser))]
use tracing::warn;
use url::Url;
#[cfg(not(wasm_browser))]
use crate::{defaults::timeouts::DNS_TIMEOUT, dns::DnsResolver};
pub const IROH_TXT_NAME: &str = "_iroh";
pub trait NodeIdExt {
fn to_z32(&self) -> String;
fn from_z32(s: &str) -> Result<NodeId>;
}
impl NodeIdExt for NodeId {
fn to_z32(&self) -> String {
z32::encode(self.as_bytes())
}
fn from_z32(s: &str) -> Result<NodeId> {
let bytes = z32::decode(s.as_bytes()).map_err(|_| anyhow!("invalid z32"))?;
let bytes: &[u8; 32] = &bytes.try_into().map_err(|_| anyhow!("not 32 bytes long"))?;
let node_id = NodeId::from_bytes(bytes)?;
Ok(node_id)
}
}
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub struct NodeData {
relay_url: Option<RelayUrl>,
direct_addresses: BTreeSet<SocketAddr>,
user_data: Option<UserData>,
}
impl NodeData {
pub fn new(relay_url: Option<RelayUrl>, direct_addresses: BTreeSet<SocketAddr>) -> Self {
Self {
relay_url,
direct_addresses,
user_data: None,
}
}
pub fn with_relay_url(mut self, relay_url: Option<RelayUrl>) -> Self {
self.relay_url = relay_url;
self
}
pub fn with_direct_addresses(mut self, direct_addresses: BTreeSet<SocketAddr>) -> Self {
self.direct_addresses = direct_addresses;
self
}
pub fn with_user_data(mut self, user_data: Option<UserData>) -> Self {
self.user_data = user_data;
self
}
pub fn relay_url(&self) -> Option<&RelayUrl> {
self.relay_url.as_ref()
}
pub fn user_data(&self) -> Option<&UserData> {
self.user_data.as_ref()
}
pub fn direct_addresses(&self) -> &BTreeSet<SocketAddr> {
&self.direct_addresses
}
pub fn clear_direct_addresses(&mut self) {
self.direct_addresses = Default::default();
}
pub fn add_direct_addresses(&mut self, addrs: impl IntoIterator<Item = SocketAddr>) {
self.direct_addresses.extend(addrs)
}
pub fn set_relay_url(&mut self, relay_url: Option<RelayUrl>) {
self.relay_url = relay_url
}
pub fn set_user_data(&mut self, user_data: Option<UserData>) {
self.user_data = user_data;
}
}
impl From<NodeAddr> for NodeData {
fn from(node_addr: NodeAddr) -> Self {
Self {
relay_url: node_addr.relay_url,
direct_addresses: node_addr.direct_addresses,
user_data: None,
}
}
}
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct UserData(String);
impl UserData {
pub const MAX_LENGTH: usize = 245;
}
#[derive(Debug, thiserror::Error)]
#[error("User-defined data exceeds max length")]
pub struct MaxLengthExceededError;
impl TryFrom<String> for UserData {
type Error = MaxLengthExceededError;
fn try_from(value: String) -> Result<Self, Self::Error> {
if value.len() > Self::MAX_LENGTH {
Err(MaxLengthExceededError)
} else {
Ok(Self(value))
}
}
}
impl FromStr for UserData {
type Err = MaxLengthExceededError;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
if s.len() > Self::MAX_LENGTH {
Err(MaxLengthExceededError)
} else {
Ok(Self(s.to_string()))
}
}
}
impl fmt::Display for UserData {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.0)
}
}
impl AsRef<str> for UserData {
fn as_ref(&self) -> &str {
&self.0
}
}
#[derive(derive_more::Debug, Clone, Eq, PartialEq)]
pub struct NodeInfo {
pub node_id: NodeId,
pub data: NodeData,
}
impl From<TxtAttrs<IrohAttr>> for NodeInfo {
fn from(attrs: TxtAttrs<IrohAttr>) -> Self {
(&attrs).into()
}
}
impl From<&TxtAttrs<IrohAttr>> for NodeInfo {
fn from(attrs: &TxtAttrs<IrohAttr>) -> Self {
let node_id = attrs.node_id();
let attrs = attrs.attrs();
let relay_url = attrs
.get(&IrohAttr::Relay)
.into_iter()
.flatten()
.next()
.and_then(|s| Url::parse(s).ok());
let direct_addresses = attrs
.get(&IrohAttr::Addr)
.into_iter()
.flatten()
.filter_map(|s| SocketAddr::from_str(s).ok())
.collect();
let user_data = attrs
.get(&IrohAttr::UserData)
.into_iter()
.flatten()
.next()
.and_then(|s| UserData::from_str(s).ok());
let data = NodeData {
relay_url: relay_url.map(Into::into),
direct_addresses,
user_data,
};
Self { node_id, data }
}
}
impl From<NodeInfo> for NodeAddr {
fn from(value: NodeInfo) -> Self {
value.into_node_addr()
}
}
impl From<NodeAddr> for NodeInfo {
fn from(addr: NodeAddr) -> Self {
Self::new(addr.node_id)
.with_relay_url(addr.relay_url)
.with_direct_addresses(addr.direct_addresses)
}
}
impl NodeInfo {
pub fn new(node_id: NodeId) -> Self {
Self::from_parts(node_id, Default::default())
}
pub fn from_parts(node_id: NodeId, data: NodeData) -> Self {
Self { node_id, data }
}
pub fn with_relay_url(mut self, relay_url: Option<RelayUrl>) -> Self {
self.data = self.data.with_relay_url(relay_url);
self
}
pub fn with_direct_addresses(mut self, direct_addresses: BTreeSet<SocketAddr>) -> Self {
self.data = self.data.with_direct_addresses(direct_addresses);
self
}
pub fn with_user_data(mut self, user_data: Option<UserData>) -> Self {
self.data = self.data.with_user_data(user_data);
self
}
pub fn to_node_addr(&self) -> NodeAddr {
NodeAddr {
node_id: self.node_id,
relay_url: self.data.relay_url.clone(),
direct_addresses: self.data.direct_addresses.clone(),
}
}
pub fn into_node_addr(self) -> NodeAddr {
NodeAddr {
node_id: self.node_id,
relay_url: self.data.relay_url,
direct_addresses: self.data.direct_addresses,
}
}
fn to_attrs(&self) -> TxtAttrs<IrohAttr> {
self.into()
}
#[cfg(not(wasm_browser))]
pub fn from_txt_lookup(lookup: crate::dns::TxtLookup) -> Result<Self> {
let attrs = TxtAttrs::from_txt_lookup(lookup)?;
Ok(attrs.into())
}
pub fn from_pkarr_signed_packet(packet: &pkarr::SignedPacket) -> Result<Self> {
let attrs = TxtAttrs::from_pkarr_signed_packet(packet)?;
Ok(attrs.into())
}
pub fn to_pkarr_signed_packet(
&self,
secret_key: &SecretKey,
ttl: u32,
) -> Result<pkarr::SignedPacket> {
self.to_attrs().to_pkarr_signed_packet(secret_key, ttl)
}
pub fn to_txt_strings(&self) -> Vec<String> {
self.to_attrs().to_txt_strings().collect()
}
}
impl std::ops::Deref for NodeInfo {
type Target = NodeData;
fn deref(&self) -> &Self::Target {
&self.data
}
}
impl std::ops::DerefMut for NodeInfo {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.data
}
}
#[cfg(not(wasm_browser))]
fn node_id_from_hickory_name(name: &hickory_resolver::proto::rr::Name) -> Option<NodeId> {
if name.num_labels() < 2 {
return None;
}
let mut labels = name.iter();
let label = std::str::from_utf8(labels.next().expect("num_labels checked")).ok()?;
if label != IROH_TXT_NAME {
return None;
}
let label = std::str::from_utf8(labels.next().expect("num_labels checked")).ok()?;
let node_id = NodeId::from_z32(label).ok()?;
Some(node_id)
}
#[derive(
Debug, strum::Display, strum::AsRefStr, strum::EnumString, Hash, Eq, PartialEq, Ord, PartialOrd,
)]
#[strum(serialize_all = "kebab-case")]
pub(crate) enum IrohAttr {
Relay,
Addr,
UserData,
}
#[derive(Debug)]
pub(crate) struct TxtAttrs<T> {
node_id: NodeId,
attrs: BTreeMap<T, Vec<String>>,
}
impl From<&NodeInfo> for TxtAttrs<IrohAttr> {
fn from(info: &NodeInfo) -> Self {
let mut attrs = vec![];
if let Some(relay_url) = &info.data.relay_url {
attrs.push((IrohAttr::Relay, relay_url.to_string()));
}
for addr in &info.data.direct_addresses {
attrs.push((IrohAttr::Addr, addr.to_string()));
}
if let Some(user_data) = &info.data.user_data {
attrs.push((IrohAttr::UserData, user_data.to_string()));
}
Self::from_parts(info.node_id, attrs.into_iter())
}
}
impl<T: FromStr + Display + Hash + Ord> TxtAttrs<T> {
pub(crate) fn from_parts(node_id: NodeId, pairs: impl Iterator<Item = (T, String)>) -> Self {
let mut attrs: BTreeMap<T, Vec<String>> = BTreeMap::new();
for (k, v) in pairs {
attrs.entry(k).or_default().push(v);
}
Self { attrs, node_id }
}
pub(crate) fn from_strings(
node_id: NodeId,
strings: impl Iterator<Item = String>,
) -> Result<Self> {
let mut attrs: BTreeMap<T, Vec<String>> = BTreeMap::new();
for s in strings {
let mut parts = s.split('=');
let (Some(key), Some(value)) = (parts.next(), parts.next()) else {
continue;
};
let Ok(attr) = T::from_str(key) else {
continue;
};
attrs.entry(attr).or_default().push(value.to_string());
}
Ok(Self { attrs, node_id })
}
#[cfg(not(wasm_browser))]
async fn lookup(resolver: &DnsResolver, name: Name) -> Result<Self> {
let name = ensure_iroh_txt_label(name)?;
let lookup = resolver.lookup_txt(name, DNS_TIMEOUT).await?;
let attrs = Self::from_txt_lookup(lookup)?;
Ok(attrs)
}
#[cfg(not(wasm_browser))]
pub(crate) async fn lookup_by_id(
resolver: &DnsResolver,
node_id: &NodeId,
origin: &str,
) -> Result<Self> {
let name = node_domain(node_id, origin)?;
TxtAttrs::lookup(resolver, name).await
}
#[cfg(not(wasm_browser))]
pub(crate) async fn lookup_by_name(resolver: &DnsResolver, name: &str) -> Result<Self> {
let name = Name::from_str(name)?;
TxtAttrs::lookup(resolver, name).await
}
pub(crate) fn attrs(&self) -> &BTreeMap<T, Vec<String>> {
&self.attrs
}
pub(crate) fn node_id(&self) -> NodeId {
self.node_id
}
pub(crate) fn from_pkarr_signed_packet(packet: &pkarr::SignedPacket) -> Result<Self> {
use pkarr::dns::{
rdata::RData,
{self},
};
let pubkey = packet.public_key();
let pubkey_z32 = pubkey.to_z32();
let node_id = NodeId::from(*pubkey.verifying_key());
let zone = dns::Name::new(&pubkey_z32)?;
let txt_data = packet
.all_resource_records()
.filter_map(|rr| match &rr.rdata {
RData::TXT(txt) => match rr.name.without(&zone) {
Some(name) if name.to_string() == IROH_TXT_NAME => Some(txt),
Some(_) | None => None,
},
_ => None,
});
let txt_strs = txt_data.filter_map(|s| String::try_from(s.clone()).ok());
Self::from_strings(node_id, txt_strs)
}
#[cfg(not(wasm_browser))]
pub(crate) fn from_txt_lookup(lookup: crate::dns::TxtLookup) -> Result<Self> {
let queried_node_id = node_id_from_hickory_name(lookup.0.query().name())
.ok_or_else(|| anyhow!("invalid DNS answer: not a query for _iroh.z32encodedpubkey"))?;
let strings = lookup.0.as_lookup().record_iter().filter_map(|record| {
match node_id_from_hickory_name(record.name()) {
Some(n) if n == queried_node_id => match record.data().as_txt() {
Some(txt) => Some(txt.to_string()),
None => {
warn!(
?queried_node_id,
data = ?record.data(),
"unexpected record type for DNS discovery query"
);
None
}
},
Some(answered_node_id) => {
warn!(
?queried_node_id,
?answered_node_id,
"unexpected node ID answered for DNS query"
);
None
}
None => {
warn!(
?queried_node_id,
name = ?record.name(),
"unexpected answer record name for DNS query"
);
None
}
}
});
Self::from_strings(queried_node_id, strings)
}
fn to_txt_strings(&self) -> impl Iterator<Item = String> + '_ {
self.attrs
.iter()
.flat_map(move |(k, vs)| vs.iter().map(move |v| format!("{k}={v}")))
}
pub(crate) fn to_pkarr_signed_packet(
&self,
secret_key: &SecretKey,
ttl: u32,
) -> Result<pkarr::SignedPacket> {
use pkarr::dns::{self, rdata};
let keypair = pkarr::Keypair::from_secret_key(&secret_key.to_bytes());
let name = dns::Name::new(IROH_TXT_NAME)?;
let mut builder = pkarr::SignedPacket::builder();
for s in self.to_txt_strings() {
let mut txt = rdata::TXT::new();
txt.add_string(&s)?;
builder = builder.txt(name.clone(), txt.into_owned(), ttl);
}
let signed_packet = builder.build(&keypair)?;
Ok(signed_packet)
}
}
#[cfg(not(wasm_browser))]
fn ensure_iroh_txt_label(name: Name) -> Result<Name, ProtoError> {
if name.iter().next() == Some(IROH_TXT_NAME.as_bytes()) {
Ok(name)
} else {
Name::parse(IROH_TXT_NAME, Some(&name))
}
}
#[cfg(not(wasm_browser))]
fn node_domain(node_id: &NodeId, origin: &str) -> Result<Name> {
let domain = format!("{}.{}", NodeId::to_z32(node_id), origin);
let domain = Name::from_str(&domain)?;
Ok(domain)
}
#[cfg(test)]
mod tests {
use std::{collections::BTreeSet, str::FromStr, sync::Arc};
use hickory_resolver::{
lookup::Lookup,
proto::{
op::Query,
rr::{
rdata::{A, TXT},
RData, Record, RecordType,
},
},
Name,
};
use iroh_base::{NodeId, SecretKey};
use testresult::TestResult;
use super::{NodeData, NodeIdExt, NodeInfo};
#[test]
fn txt_attr_roundtrip() {
let node_data = NodeData::new(
Some("https://example.com".parse().unwrap()),
["127.0.0.1:1234".parse().unwrap()].into_iter().collect(),
)
.with_user_data(Some("foobar".parse().unwrap()));
let node_id = "vpnk377obfvzlipnsfbqba7ywkkenc4xlpmovt5tsfujoa75zqia"
.parse()
.unwrap();
let expected = NodeInfo::from_parts(node_id, node_data);
let attrs = expected.to_attrs();
let actual = NodeInfo::from(&attrs);
assert_eq!(expected, actual);
}
#[test]
fn signed_packet_roundtrip() {
let secret_key =
SecretKey::from_str("vpnk377obfvzlipnsfbqba7ywkkenc4xlpmovt5tsfujoa75zqia").unwrap();
let node_data = NodeData::new(
Some("https://example.com".parse().unwrap()),
["127.0.0.1:1234".parse().unwrap()].into_iter().collect(),
)
.with_user_data(Some("foobar".parse().unwrap()));
let expected = NodeInfo::from_parts(secret_key.public(), node_data);
let packet = expected.to_pkarr_signed_packet(&secret_key, 30).unwrap();
let actual = NodeInfo::from_pkarr_signed_packet(&packet).unwrap();
assert_eq!(expected, actual);
}
#[test]
fn test_from_hickory_lookup() -> TestResult {
let name = Name::from_utf8(
"_iroh.dgjpkxyn3zyrk3zfads5duwdgbqpkwbjxfj4yt7rezidr3fijccy.dns.iroh.link.",
)?;
let query = Query::query(name.clone(), RecordType::TXT);
let records = [
Record::from_rdata(
name.clone(),
30,
RData::TXT(TXT::new(vec!["addr=192.168.96.145:60165".to_string()])),
),
Record::from_rdata(
name.clone(),
30,
RData::TXT(TXT::new(vec!["addr=213.208.157.87:60165".to_string()])),
),
Record::from_rdata(name.clone(), 30, RData::A(A::new(127, 0, 0, 1))),
Record::from_rdata(
Name::from_utf8(format!(
"_iroh.{}.dns.iroh.link.",
NodeId::from_str(
"a55f26132e5e43de834d534332f66a20d480c3e50a13a312a071adea6569981e"
)?
.to_z32()
))?,
30,
RData::TXT(TXT::new(vec![
"relay=https://euw1-1.relay.iroh.network./".to_string()
])),
),
Record::from_rdata(
Name::from_utf8("dns.iroh.link.")?,
30,
RData::TXT(TXT::new(vec![
"relay=https://euw1-1.relay.iroh.network./".to_string()
])),
),
Record::from_rdata(
name.clone(),
30,
RData::TXT(TXT::new(vec![
"relay=https://euw1-1.relay.iroh.network./".to_string()
])),
),
];
let lookup = Lookup::new_with_max_ttl(query, Arc::new(records));
let lookup = hickory_resolver::lookup::TxtLookup::from(lookup);
let node_info = NodeInfo::from_txt_lookup(lookup.into())?;
let expected_node_info = NodeInfo::new(NodeId::from_str(
"1992d53c02cdc04566e5c0edb1ce83305cd550297953a047a445ea3264b54b18",
)?)
.with_relay_url(Some("https://euw1-1.relay.iroh.network./".parse()?))
.with_direct_addresses(BTreeSet::from([
"192.168.96.145:60165".parse()?,
"213.208.157.87:60165".parse()?,
]));
assert_eq!(node_info, expected_node_info);
Ok(())
}
}