refactor(iroh-net): portmapper and network monitor are crates

.github/workflows/ci.yml

@@ -190,7 +190,7 @@ jobs:
         # uses: obi1kenobi/cargo-semver-checks-action@v2
         uses: n0-computer/cargo-semver-checks-action@feat-baseline
         with:
-          package: iroh, iroh-base, iroh-cli, iroh-dns-server, iroh-metrics, iroh-net, iroh-net-bench, iroh-router
+          package: iroh, iroh-base, iroh-cli, iroh-dns-server, iroh-metrics, iroh-net, iroh-net-bench, iroh-router, netwatch, portmapper
           baseline-rev: ${{ env.HEAD_COMMIT_SHA }}
           use-cache: false
 

.github/workflows/tests.yaml

@@ -23,7 +23,7 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   SCCACHE_CACHE_SIZE: "50G"
-  CRATES_LIST: "iroh,iroh-metrics,iroh-net,iroh-net-bench,iroh-test,iroh-cli,iroh-dns-server,iroh-router"
+  CRATES_LIST: "iroh,iroh-metrics,iroh-net,iroh-net-bench,iroh-test,iroh-cli,iroh-dns-server,iroh-router,netwatch,portmapper"
   IROH_FORCE_STAGING_RELAYS: "1"
 
 jobs:

Cargo.toml

@@ -9,6 +9,8 @@ members = [
   "iroh-net/bench",
   "iroh-cli",
   "iroh-router",
+  "net-tools/netwatch",
+  "net-tools/portmapper",
 ]
 resolver = "2"
 

iroh-cli/Cargo.toml

@@ -46,6 +46,7 @@ iroh-metrics = { version = "0.27.0" }
 parking_lot = "0.12.1"
 pkarr = { version = "2.2.0", default-features = false }
 portable-atomic = "1"
+portmapper = { version = "0.1.0", path = "../net-tools/portmapper" }
 postcard = "1.0.8"
 quic-rpc = { version = "0.12", features = ["flume-transport", "quinn-transport"] }
 rand = "0.8.5"

iroh-cli/src/commands/doctor.rs

@@ -37,7 +37,7 @@ use iroh::{
         endpoint::{self, Connection, ConnectionTypeStream, RecvStream, RemoteInfo, SendStream},
         key::{PublicKey, SecretKey},
         metrics::MagicsockMetrics,
-        netcheck, portmapper,
+        netcheck,
         relay::{RelayMap, RelayMode, RelayUrl},
         ticket::NodeTicket,
         Endpoint, NodeAddr, NodeId,

iroh-net/Cargo.toml

@@ -75,6 +75,7 @@ webpki = { package = "rustls-webpki", version = "0.102" }
 webpki-roots = "0.26"
 x509-parser = "0.16"
 z32 = "1.0.3"
+portmapper = { path = "../net-tools/portmapper" }
 
 # iroh-relay
 axum = { version = "0.7.4", optional = true }
@@ -94,6 +95,7 @@ swarm-discovery = { version = "0.2.1", optional = true }
 
 # dht_discovery
 genawaiter = { version = "0.99.1", features = ["futures03"], optional = true }
+netwatch = { version = "0.1.0", path = "../net-tools/netwatch" }
 
 [target.'cfg(any(target_os = "linux", target_os = "android"))'.dependencies]
 netlink-packet-core = "0.7.0"
@@ -114,7 +116,6 @@ ntest = "0.9"
 pretty_assertions = "1.4"
 proptest = "1.2.0"
 rand_chacha = "0.3.1"
-testdir = "0.9.1"
 tokio = { version = "1", features = ["io-util", "sync", "rt", "net", "fs", "macros", "time", "test-util"] }
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 iroh-test = "0.27.0"

iroh-net/src/defaults.rs

@@ -162,18 +162,9 @@ pub(crate) mod timeouts {
     /// The amount of time we wait for a hairpinned packet to come back.
     pub(crate) const HAIRPIN_CHECK_TIMEOUT: Duration = Duration::from_millis(100);
 
-    /// Maximum duration a UPnP search can take before timing out.
-    pub(crate) const UPNP_SEARCH_TIMEOUT: Duration = Duration::from_secs(1);
-
-    /// Timeout to receive a response from a PCP server.
-    pub(crate) const PCP_RECV_TIMEOUT: Duration = Duration::from_millis(500);
-
     /// Default Pinger timeout
     pub(crate) const DEFAULT_PINGER_TIMEOUT: Duration = Duration::from_secs(5);
 
-    /// Timeout to receive a response from a NAT-PMP server.
-    pub(crate) const NAT_PMP_RECV_TIMEOUT: Duration = Duration::from_millis(500);
-
     /// Timeouts specifically used in the iroh-relay
     pub(crate) mod relay {
         use super::*;

iroh-net/src/lib.rs

@@ -241,10 +241,8 @@ pub mod dns;
 pub mod endpoint;
 mod magicsock;
 pub mod metrics;
-pub mod net;
 pub mod netcheck;
 pub mod ping;
-pub mod portmapper;
 pub mod relay;
 pub mod stun;
 pub mod ticket;
@@ -253,6 +251,10 @@ pub(crate) mod util;
 
 pub use endpoint::{AddrInfo, Endpoint, NodeAddr};
 pub use iroh_base::{key, key::NodeId};
+// TODO(@divma): re-evaluate this re-export
+pub use netwatch as net;
+// TODO(@divma): re-evaluate this re-export
+pub use portmapper;
 
 #[cfg(any(test, feature = "test-utils"))]
 #[cfg_attr(iroh_docsrs, doc(cfg(any(test, feature = "test-utils"))))]

iroh-net/src/magicsock.rs

@@ -35,6 +35,7 @@ use futures_lite::{FutureExt, Stream, StreamExt};
 use futures_util::stream::BoxStream;
 use iroh_base::key::NodeId;
 use iroh_metrics::{inc, inc_by};
+use netwatch::{interfaces, ip::LocalAddresses, netmon};
 use quinn::AsyncUdpSocket;
 use rand::{seq::SliceRandom, Rng, SeedableRng};
 use smallvec::{smallvec, SmallVec};
@@ -64,8 +65,7 @@ use crate::{
     dns::DnsResolver,
     endpoint::NodeAddr,
     key::{PublicKey, SecretKey, SharedSecret},
-    net::{interfaces, ip::LocalAddresses, netmon},
-    netcheck, portmapper,
+    netcheck,
     relay::{RelayMap, RelayUrl},
     stun, AddrInfo,
 };

iroh-net/src/magicsock/node_map/node_state.rs

@@ -6,6 +6,7 @@ use std::{
 };
 
 use iroh_metrics::inc;
+use netwatch::ip::is_unicast_link_local;
 use serde::{Deserialize, Serialize};
 use tokio::sync::mpsc;
 use tracing::{debug, event, info, instrument, trace, warn, Level};
@@ -22,7 +23,6 @@ use crate::{
     endpoint::AddrInfo,
     key::PublicKey,
     magicsock::{ActorMessage, MagicsockMetrics, QuicMappedAddr, Timer, HEARTBEAT_INTERVAL},
-    net::ip::is_unicast_link_local,
     relay::RelayUrl,
     stun,
     util::relay_only_mode,

iroh-net/src/magicsock/udp_conn.rs

@@ -9,13 +9,12 @@ use std::{
 };
 
 use anyhow::{bail, Context as _};
+use netwatch::UdpSocket;
 use quinn::AsyncUdpSocket;
 use quinn_udp::{Transmit, UdpSockRef};
 use tokio::io::Interest;
 use tracing::{debug, trace};
 
-use crate::net::UdpSocket;
-
 /// A UDP socket implementing Quinn's [`AsyncUdpSocket`].
 #[derive(Clone, Debug)]
 pub struct UdpConn {

iroh-net/src/metrics.rs

@@ -1,8 +1,7 @@
 //! Co-locating all of the iroh-net metrics structs
+pub use portmapper::Metrics as PortmapMetrics;
+
 #[cfg(feature = "iroh-relay")]
 #[cfg_attr(iroh_docsrs, doc(cfg(feature = "iroh-relay")))]
 pub use crate::relay::server::Metrics as RelayMetrics;
-pub use crate::{
-    magicsock::Metrics as MagicsockMetrics, netcheck::Metrics as NetcheckMetrics,
-    portmapper::Metrics as PortmapMetrics,
-};
+pub use crate::{magicsock::Metrics as MagicsockMetrics, netcheck::Metrics as NetcheckMetrics};

iroh-net/src/netcheck.rs

@@ -15,20 +15,18 @@ use std::{
 
 use anyhow::{anyhow, Context as _, Result};
 use bytes::Bytes;
+use hickory_resolver::TokioAsyncResolver as DnsResolver;
 use iroh_metrics::inc;
+use netwatch::{IpFamily, UdpSocket};
 use tokio::{
     sync::{self, mpsc, oneshot},
     time::{Duration, Instant},
 };
 use tokio_util::{sync::CancellationToken, task::AbortOnDropHandle};
 use tracing::{debug, error, info_span, trace, warn, Instrument};
 
-use super::{portmapper, relay::RelayMap, stun};
-use crate::{
-    dns::DnsResolver,
-    net::{IpFamily, UdpSocket},
-    relay::RelayUrl,
-};
+use super::{relay::RelayMap, stun};
+use crate::relay::RelayUrl;
 
 mod metrics;
 mod reportgen;

iroh-net/src/netcheck/reportgen.rs

@@ -26,6 +26,7 @@ use std::{
 
 use anyhow::{anyhow, bail, Context, Result};
 use iroh_metrics::inc;
+use netwatch::{interfaces, UdpSocket};
 use rand::seq::IteratorRandom;
 use tokio::{
     sync::{mpsc, oneshot},
@@ -39,10 +40,8 @@ use super::NetcheckMetrics;
 use crate::{
     defaults::DEFAULT_STUN_PORT,
     dns::{DnsResolver, ResolverExt},
-    net::{interfaces, UdpSocket},
     netcheck::{self, Report},
     ping::{PingError, Pinger},
-    portmapper,
     relay::{RelayMap, RelayNode, RelayUrl},
     stun,
     util::MaybeFuture,

iroh-net/src/netcheck/reportgen/hairpin.rs

@@ -15,13 +15,13 @@
 use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};
 
 use anyhow::{bail, Context, Result};
+use netwatch::UdpSocket;
 use tokio::{sync::oneshot, time::Instant};
 use tokio_util::task::AbortOnDropHandle;
 use tracing::{debug, error, info_span, trace, warn, Instrument};
 
 use crate::{
     defaults::timeouts::HAIRPIN_CHECK_TIMEOUT,
-    net::UdpSocket,
     netcheck::{self, reportgen, Inflight},
     stun,
 };

iroh-net/src/netcheck/reportgen/probes.rs

@@ -7,10 +7,10 @@
 use std::{collections::BTreeSet, fmt, sync::Arc};
 
 use anyhow::{ensure, Result};
+use netwatch::interfaces;
 use tokio::time::Duration;
 
 use crate::{
-    net::interfaces,
     netcheck::Report,
     relay::{RelayMap, RelayNode, RelayUrl},
 };

net-tools/netwatch/Cargo.toml

@@ -0,0 +1,49 @@
+[package]
+name = "netwatch"
+version = "0.1.0"
+readme = "README.md"
+description = "Cross-platform monitoring for network changes"
+license = "MIT OR Apache-2.0"
+authors = ["n0 team"]
+repository = "https://github.com/n0-computer/iroh"
+keywords = ["networking", "interfaces"]
+edition = "2021"
+
+[lints]
+workspace = true
+
+[dependencies]
+anyhow = { version = "1" }
+bytes = "1.7"
+futures-lite = "2.3"
+futures-sink = "0.3.25"
+futures-util = "0.3.25"
+libc = "0.2.139"
+netdev = "0.30.0"
+once_cell = "1.18.0"
+socket2 = "0.5.3"
+thiserror = "1"
+time = "0.3.20"
+tokio = { version = "1", features = ["io-util", "macros", "sync", "rt", "net", "fs", "io-std", "signal", "process", "time"] }
+tracing = "0.1"
+
+[target.'cfg(any(target_os = "linux", target_os = "android"))'.dependencies]
+netlink-packet-core = "0.7.0"
+netlink-packet-route = "0.17.0"
+netlink-sys = "0.8.5"
+rtnetlink = "0.13.0"
+
+[target.'cfg(target_os = "windows")'.dependencies]
+wmi = "0.13"
+windows = { version = "0.51", features = ["Win32_NetworkManagement_IpHelper", "Win32_Foundation", "Win32_NetworkManagement_Ndis", "Win32_Networking_WinSock"] }
+serde = { version = "1", features = ["derive"] }
+derive_more = { version = "1.0.0", features = ["debug"] }
+
+[dev-dependencies]
+tokio = { version = "1", features = ["io-util", "sync", "rt", "net", "fs", "macros", "time", "test-util"] }
+tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+iroh-test = "0.27.0"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "iroh_docsrs"]