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
use std::{collections::BTreeSet, fmt, net::SocketAddr, ops::Deref, str::FromStr};
use anyhow::Context;
use serde::{Deserialize, Serialize};
use url::Url;
use crate::key::{NodeId, PublicKey};
/// A peer and it's addressing information.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct NodeAddr {
/// The node's public key.
pub node_id: PublicKey,
/// Addressing information to connect to [`Self::node_id`].
pub info: AddrInfo,
}
impl NodeAddr {
/// Create a new [`NodeAddr`] with empty [`AddrInfo`].
pub fn new(node_id: PublicKey) -> Self {
NodeAddr {
node_id,
info: Default::default(),
}
}
/// Add a relay url to the peer's [`AddrInfo`].
pub fn with_relay_url(mut self, relay_url: RelayUrl) -> Self {
self.info.relay_url = Some(relay_url);
self
}
/// Add the given direct addresses to the peer's [`AddrInfo`].
pub fn with_direct_addresses(
mut self,
addresses: impl IntoIterator<Item = SocketAddr>,
) -> Self {
self.info.direct_addresses = addresses.into_iter().collect();
self
}
/// Apply the options to `self`.
pub fn apply_options(&mut self, opts: AddrInfoOptions) {
self.info.apply_options(opts);
}
/// Get the direct addresses of this peer.
pub fn direct_addresses(&self) -> impl Iterator<Item = &SocketAddr> {
self.info.direct_addresses.iter()
}
/// Get the relay url of this peer.
pub fn relay_url(&self) -> Option<&RelayUrl> {
self.info.relay_url.as_ref()
}
}
impl From<(PublicKey, Option<RelayUrl>, &[SocketAddr])> for NodeAddr {
fn from(value: (PublicKey, Option<RelayUrl>, &[SocketAddr])) -> Self {
let (node_id, relay_url, direct_addresses_iter) = value;
NodeAddr {
node_id,
info: AddrInfo {
relay_url,
direct_addresses: direct_addresses_iter.iter().copied().collect(),
},
}
}
}
impl From<NodeId> for NodeAddr {
fn from(node_id: NodeId) -> Self {
NodeAddr::new(node_id)
}
}
/// Addressing information to connect to a peer.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct AddrInfo {
/// The peer's home relay url.
pub relay_url: Option<RelayUrl>,
/// Socket addresses where the peer might be reached directly.
pub direct_addresses: BTreeSet<SocketAddr>,
}
impl AddrInfo {
/// Return whether this addressing information is empty.
pub fn is_empty(&self) -> bool {
self.relay_url.is_none() && self.direct_addresses.is_empty()
}
/// Apply the options to `self`.
pub fn apply_options(&mut self, opts: AddrInfoOptions) {
match opts {
AddrInfoOptions::Id => {
self.direct_addresses.clear();
self.relay_url = None;
}
AddrInfoOptions::RelayAndAddresses => {
// nothing to do
}
AddrInfoOptions::Relay => {
self.direct_addresses.clear();
}
AddrInfoOptions::Addresses => {
self.relay_url = None;
}
}
}
}
impl NodeAddr {
/// Create a new [`NodeAddr`] from its parts.
pub fn from_parts(
node_id: PublicKey,
relay_url: Option<RelayUrl>,
direct_addresses: Vec<SocketAddr>,
) -> Self {
Self {
node_id,
info: AddrInfo {
relay_url,
direct_addresses: direct_addresses.into_iter().collect(),
},
}
}
}
/// Options to configure what is included in a `NodeAddr`.
#[derive(
Copy,
Clone,
PartialEq,
Eq,
Default,
Debug,
derive_more::Display,
derive_more::FromStr,
Serialize,
Deserialize,
)]
pub enum AddrInfoOptions {
/// Only the Node ID is added.
///
/// This usually means that iroh-dns discovery is used to find address information.
#[default]
Id,
/// Include both the relay URL and the direct addresses.
RelayAndAddresses,
/// Only include the relay URL.
Relay,
/// Only include the direct addresses.
Addresses,
}
/// A URL identifying a relay server.
///
/// This is but a wrapper around [`Url`], with a few custom tweaks:
///
/// - A relay URL is never a relative URL, so an implicit `.` is added at the end of the
/// domain name if missing.
///
/// - [`fmt::Debug`] is implemented so it prints the URL rather than the URL struct fields.
/// Useful when logging e.g. `Option<RelayUrl>`.
///
/// To create a [`RelayUrl`] use the `From<Url>` implementation.
#[derive(
Clone, derive_more::Display, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
)]
pub struct RelayUrl(Url);
impl From<Url> for RelayUrl {
fn from(mut url: Url) -> Self {
if let Some(domain) = url.domain() {
if !domain.ends_with('.') {
let domain = String::from(domain) + ".";
// This can fail, though it is unlikely the resulting URL is usable as a
// relay URL, probably it has the wrong scheme or is not a base URL or the
// like. We don't do full URL validation however, so just silently leave
// this bad URL in place. Something will fail later.
url.set_host(Some(&domain)).ok();
}
}
Self(url)
}
}
/// This is a convenience only to directly parse strings.
///
/// If you need more control over the error first create a [`Url`] and use [`RelayUrl::from`]
/// instead.
impl FromStr for RelayUrl {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let inner = Url::from_str(s).context("invalid URL")?;
Ok(RelayUrl::from(inner))
}
}
impl From<RelayUrl> for Url {
fn from(value: RelayUrl) -> Self {
value.0
}
}
/// Dereference to the wrapped [`Url`].
///
/// Note that [`DerefMut`] is not implemented on purpose, so this type has more flexibility
/// to change the inner later.
///
/// [`DerefMut`]: std::ops::DerefMut
impl Deref for RelayUrl {
type Target = Url;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl fmt::Debug for RelayUrl {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("RelayUrl")
.field(&DbgStr(self.0.as_str()))
.finish()
}
}
/// Helper struct to format a &str without allocating a String.
///
/// Maybe this is entirely unneeded and the compiler would be smart enough to never allocate
/// the String anyway. Who knows. Writing this was faster than checking the assembler
/// output.
struct DbgStr<'a>(&'a str);
impl<'a> fmt::Debug for DbgStr<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, r#""{}""#, self.0)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_relay_url_debug_display() {
let url = RelayUrl::from(Url::parse("https://example.com").unwrap());
assert_eq!(format!("{url:?}"), r#"RelayUrl("https://example.com./")"#);
assert_eq!(format!("{url}"), "https://example.com./");
}
#[test]
fn test_relay_url_absolute() {
let url = RelayUrl::from(Url::parse("https://example.com").unwrap());
assert_eq!(url.domain(), Some("example.com."));
let url1 = RelayUrl::from(Url::parse("https://example.com.").unwrap());
assert_eq!(url, url1);
let url2 = RelayUrl::from(Url::parse("https://example.com./").unwrap());
assert_eq!(url, url2);
let url3 = RelayUrl::from(Url::parse("https://example.com/").unwrap());
assert_eq!(url, url3);
}
}