1use std::{
2 fmt::{Display, Formatter},
3 net::SocketAddr,
4 str::FromStr,
5};
6
7use hickory_resolver::{AsyncResolver, name_server::ConnectionProvider};
8use hopr_crypto_packet::{HoprSurb, prelude::HoprSenderId};
9use hopr_crypto_random::Randomizable;
10use hopr_internal_types::prelude::HoprPseudonym;
11pub use hopr_path::ValidatedPath;
12use hopr_primitive_types::{
13 bounded::{BoundedSize, BoundedVec},
14 prelude::Address,
15};
16use libp2p_identity::PeerId;
17
18use crate::errors::NetworkTypeError;
19
20#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, strum::Display, strum::EnumString)]
22#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
23#[strum(serialize_all = "lowercase", ascii_case_insensitive)]
24#[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))]
25pub enum IpProtocol {
26 TCP,
27 UDP,
28}
29
30#[derive(Debug, Clone, PartialEq, Eq, Hash)]
37#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
38pub enum IpOrHost {
39 Dns(String, u16),
41 Ip(std::net::SocketAddr),
43}
44
45impl Display for IpOrHost {
46 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
47 match &self {
48 IpOrHost::Dns(host, port) => write!(f, "{host}:{port}"),
49 IpOrHost::Ip(ip) => write!(f, "{ip}"),
50 }
51 }
52}
53
54impl FromStr for IpOrHost {
55 type Err = NetworkTypeError;
56
57 fn from_str(s: &str) -> Result<Self, Self::Err> {
58 if let Ok(addr) = std::net::SocketAddr::from_str(s) {
59 Ok(IpOrHost::Ip(addr))
60 } else {
61 s.split_once(":")
62 .ok_or(NetworkTypeError::Other("missing port delimiter".into()))
63 .and_then(|(host, port_str)| {
64 u16::from_str(port_str)
65 .map(|port| IpOrHost::Dns(host.to_string(), port))
66 .map_err(|_| NetworkTypeError::Other("invalid port number".into()))
67 })
68 }
69 }
70}
71
72impl From<std::net::SocketAddr> for IpOrHost {
73 fn from(value: std::net::SocketAddr) -> Self {
74 IpOrHost::Ip(value)
75 }
76}
77
78impl IpOrHost {
79 #[cfg(feature = "runtime-tokio")]
84 pub async fn resolve_tokio(self) -> std::io::Result<Vec<SocketAddr>> {
85 cfg_if::cfg_if! {
86 if #[cfg(test)] {
87 let config = hickory_resolver::config::ResolverConfig::new();
90 let options = hickory_resolver::config::ResolverOpts::default();
91 let resolver = hickory_resolver::AsyncResolver::tokio(config, options);
92 } else {
93 let resolver = hickory_resolver::AsyncResolver::tokio_from_system_conf()?;
94 }
95 };
96
97 self.resolve(resolver).await
98 }
99
100 pub async fn resolve<P: ConnectionProvider>(self, resolver: AsyncResolver<P>) -> std::io::Result<Vec<SocketAddr>> {
103 match self {
104 IpOrHost::Dns(name, port) => Ok(resolver
105 .lookup_ip(name)
106 .await?
107 .into_iter()
108 .map(|ip| SocketAddr::new(ip, port))
109 .collect()),
110 IpOrHost::Ip(addr) => Ok(vec![addr]),
111 }
112 }
113
114 pub fn port(&self) -> u16 {
116 match &self {
117 IpOrHost::Dns(_, port) => *port,
118 IpOrHost::Ip(addr) => addr.port(),
119 }
120 }
121
122 pub fn host(&self) -> String {
124 match &self {
125 IpOrHost::Dns(host, _) => host.clone(),
126 IpOrHost::Ip(addr) => addr.ip().to_string(),
127 }
128 }
129
130 pub fn is_dns(&self) -> bool {
132 matches!(self, IpOrHost::Dns(..))
133 }
134
135 pub fn is_ipv4(&self) -> bool {
141 matches!(self, IpOrHost::Ip(addr) if addr.is_ipv4())
142 }
143
144 pub fn is_ipv6(&self) -> bool {
150 matches!(self, IpOrHost::Ip(addr) if addr.is_ipv6())
151 }
152
153 pub fn is_loopback_ip(&self) -> bool {
159 matches!(self, IpOrHost::Ip(addr) if addr.ip().is_loopback())
160 }
161}
162
163#[derive(Debug, Clone, PartialEq, Eq, Hash, strum::EnumTryAs)]
209#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
210pub enum SealedHost {
211 Plain(IpOrHost),
213 Sealed(Box<[u8]>),
215}
216
217impl SealedHost {
218 const MAX_LEN_WITH_PADDING: usize = 50;
219 pub const PADDING_CHAR: char = '@';
224
225 pub fn seal(host: IpOrHost, peer_id: PeerId) -> crate::errors::Result<Self> {
227 let mut host_str = host.to_string();
228
229 if host_str.len() < Self::MAX_LEN_WITH_PADDING {
231 let pad_len = hopr_crypto_random::random_integer(0, (Self::MAX_LEN_WITH_PADDING as u64).into());
232 for _ in 0..pad_len {
233 host_str.push(Self::PADDING_CHAR);
234 }
235 }
236
237 hopr_crypto_types::seal::seal_data(host_str.as_bytes(), peer_id)
238 .map(Self::Sealed)
239 .map_err(|e| NetworkTypeError::Other(e.to_string()))
240 }
241
242 pub fn unseal(self, key: &hopr_crypto_types::keypairs::OffchainKeypair) -> crate::errors::Result<IpOrHost> {
245 match self {
246 SealedHost::Plain(host) => Ok(host),
247 SealedHost::Sealed(enc) => hopr_crypto_types::seal::unseal_data(&enc, key)
248 .map_err(|e| NetworkTypeError::Other(e.to_string()))
249 .and_then(|data| {
250 String::from_utf8(data.into_vec())
251 .map_err(|e| NetworkTypeError::Other(e.to_string()))
252 .and_then(|s| IpOrHost::from_str(s.trim_end_matches(Self::PADDING_CHAR)))
253 }),
254 }
255 }
256}
257
258impl From<IpOrHost> for SealedHost {
259 fn from(value: IpOrHost) -> Self {
260 Self::Plain(value)
261 }
262}
263
264impl TryFrom<SealedHost> for IpOrHost {
265 type Error = NetworkTypeError;
266
267 fn try_from(value: SealedHost) -> Result<Self, Self::Error> {
268 match value {
269 SealedHost::Plain(host) => Ok(host),
270 SealedHost::Sealed(_) => Err(NetworkTypeError::SealedTarget),
271 }
272 }
273}
274
275impl std::fmt::Display for SealedHost {
276 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
277 match self {
278 SealedHost::Plain(h) => write!(f, "{h}"),
279 SealedHost::Sealed(_) => write!(f, "<redacted host>"),
280 }
281 }
282}
283
284#[derive(Debug, Clone, PartialEq, Eq)]
286#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
287pub enum RoutingOptions {
288 IntermediatePath(BoundedVec<Address, { RoutingOptions::MAX_INTERMEDIATE_HOPS }>),
290 Hops(BoundedSize<{ RoutingOptions::MAX_INTERMEDIATE_HOPS }>),
293}
294
295impl RoutingOptions {
296 pub const MAX_INTERMEDIATE_HOPS: usize = 3;
298
299 pub fn invert(self) -> RoutingOptions {
302 match self {
303 RoutingOptions::IntermediatePath(v) => RoutingOptions::IntermediatePath(v.into_iter().rev().collect()),
304 _ => self,
305 }
306 }
307
308 pub fn count_hops(&self) -> usize {
311 match &self {
312 RoutingOptions::IntermediatePath(v) => v.as_ref().len(),
313 RoutingOptions::Hops(h) => (*h).into(),
314 }
315 }
316}
317
318#[derive(Clone, Debug, Copy, PartialEq, Eq)]
320#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
321pub enum SurbMatcher {
322 Exact(HoprSenderId),
324 Pseudonym(HoprPseudonym),
326}
327
328impl SurbMatcher {
329 pub fn pseudonym(&self) -> HoprPseudonym {
331 match self {
332 SurbMatcher::Exact(id) => id.pseudonym(),
333 SurbMatcher::Pseudonym(p) => *p,
334 }
335 }
336}
337
338#[derive(Debug, Clone, PartialEq, Eq, strum::EnumIs)]
345#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
346pub enum DestinationRouting {
347 Forward {
350 destination: Address,
352 pseudonym: Option<HoprPseudonym>,
356 forward_options: RoutingOptions,
358 return_options: Option<RoutingOptions>,
360 },
361 Return(SurbMatcher),
365}
366
367impl DestinationRouting {
368 pub fn forward_only(destination: Address, forward_options: RoutingOptions) -> Self {
370 Self::Forward {
371 destination,
372 pseudonym: None,
373 forward_options,
374 return_options: None,
375 }
376 }
377}
378
379#[derive(Clone, Debug, strum::EnumIs)]
387pub enum ResolvedTransportRouting {
388 Forward {
390 pseudonym: HoprPseudonym,
392 forward_path: ValidatedPath,
394 return_paths: Vec<ValidatedPath>,
396 },
397 Return(HoprSenderId, HoprSurb),
399}
400
401impl ResolvedTransportRouting {
402 pub fn forward_only(forward_path: ValidatedPath) -> Self {
404 Self::Forward {
405 pseudonym: HoprPseudonym::random(),
406 forward_path,
407 return_paths: vec![],
408 }
409 }
410}
411
412#[cfg(test)]
413mod tests {
414 use std::net::SocketAddr;
415
416 use anyhow::anyhow;
417 use hopr_crypto_types::prelude::{Keypair, OffchainKeypair};
418
419 use super::*;
420
421 #[tokio::test]
422 async fn ip_or_host_must_resolve_dns_name() -> anyhow::Result<()> {
423 match IpOrHost::Dns("localhost".to_string(), 1000)
424 .resolve_tokio()
425 .await?
426 .first()
427 .ok_or(anyhow!("must resolve"))?
428 {
429 SocketAddr::V4(addr) => assert_eq!(*addr, "127.0.0.1:1000".parse()?),
430 SocketAddr::V6(addr) => assert_eq!(*addr, "::1:1000".parse()?),
431 }
432 Ok(())
433 }
434
435 #[tokio::test]
436 async fn ip_or_host_must_resolve_ip_address() -> anyhow::Result<()> {
437 let actual = IpOrHost::Ip("127.0.0.1:1000".parse()?).resolve_tokio().await?;
438
439 let actual = actual.first().ok_or(anyhow!("must resolve"))?;
440
441 let expected: SocketAddr = "127.0.0.1:1000".parse()?;
442
443 assert_eq!(*actual, expected);
444 Ok(())
445 }
446
447 #[test]
448 fn ip_or_host_should_parse_from_string() -> anyhow::Result<()> {
449 assert_eq!(
450 IpOrHost::Dns("some.dns.name.info".into(), 1234),
451 IpOrHost::from_str("some.dns.name.info:1234")?
452 );
453 assert_eq!(
454 IpOrHost::Ip("1.2.3.4:1234".parse()?),
455 IpOrHost::from_str("1.2.3.4:1234")?
456 );
457 Ok(())
458 }
459
460 #[test]
461 fn sealing_adds_padding_to_hide_length() -> anyhow::Result<()> {
462 let peer_id: PeerId = OffchainKeypair::random().public().into();
463 let last_len = SealedHost::seal("127.0.0.1:1234".parse()?, peer_id)?
464 .try_as_sealed()
465 .unwrap()
466 .len();
467 for _ in 0..20 {
468 let current_len = SealedHost::seal("127.0.0.1:1234".parse()?, peer_id)?
469 .try_as_sealed()
470 .unwrap()
471 .len();
472 if current_len != last_len {
473 return Ok(());
474 }
475 }
476
477 anyhow::bail!("sealed length not randomized");
478 }
479}