feat(upnp): add implementation based on IGD protocol

jxs · web-flow · commit 411a0495c5ba · 2023-09-12T10:29:27.000Z
Implements UPnP via the IGD protocol. The usage of IGD is an implementation detail and is planned to be extended to support NATpnp. Resolves: #3903. Pull-Request: #4156.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@
 - [`libp2p-relay` CHANGELOG](protocols/relay/CHANGELOG.md)
 - [`libp2p-request-response` CHANGELOG](protocols/request-response/CHANGELOG.md)
 - [`libp2p-rendezvous` CHANGELOG](protocols/rendezvous/CHANGELOG.md)
+- [`libp2p-upnp` CHANGELOG](protocols/upnp/CHANGELOG.md)
 
 ## Transport Protocols & Upgrades
 
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,7 @@ members = [
     "examples/ping-example",
     "examples/relay-server",
     "examples/rendezvous",
+    "examples/upnp",
     "identity",
     "interop-tests",
     "misc/allow-block-list",
@@ -40,6 +41,7 @@ members = [
     "protocols/relay",
     "protocols/rendezvous",
     "protocols/request-response",
+    "protocols/upnp",
     "swarm",
     "swarm-derive",
     "swarm-test",
@@ -90,6 +92,7 @@ libp2p-pnet = { version = "0.23.0", path = "transports/pnet" }
 libp2p-quic = { version = "0.9.2", path = "transports/quic" }
 libp2p-relay = { version = "0.16.1", path = "protocols/relay" }
 libp2p-rendezvous = { version = "0.13.0", path = "protocols/rendezvous" }
+libp2p-upnp = { version = "0.1.0", path = "protocols/upnp" }
 libp2p-request-response = { version = "0.25.1", path = "protocols/request-response" }
 libp2p-server = { version = "0.12.3", path = "misc/server" }
 libp2p-swarm = { version = "0.43.4", path = "swarm" }
diff --git a/examples/upnp/Cargo.toml b/examples/upnp/Cargo.toml
@@ -0,0 +1,11 @@
+[package]
+name = "upnp-example"
+version = "0.1.0"
+edition = "2021"
+publish = false
+license = "MIT"
+
+[dependencies]
+tokio = { version = "1", features = [ "rt-multi-thread", "macros"] }
+futures = "0.3.28"
+libp2p = { path = "../../libp2p", features = ["tokio", "dns", "macros", "noise", "ping", "tcp", "websocket", "yamux", "upnp"] }
diff --git a/examples/upnp/README.md b/examples/upnp/README.md
@@ -0,0 +1,23 @@
+## Description
+
+The upnp example showcases how to use the upnp network behaviour to externally open ports on the network gateway.
+
+
+## Usage
+
+To run the example, follow these steps:
+
+1. In a terminal window, run the following command:
+
+   ```sh
+   cargo run
+   ```
+
+2. This command will start the swarm and print the `NewExternalAddr` if the gateway supports `UPnP` or
+   `GatewayNotFound` if it doesn't.
+
+
+## Conclusion
+
+The upnp example demonstrates the usage of **libp2p** to externally open a port on the gateway if it
+supports [`UPnP`](https://en.wikipedia.org/wiki/Universal_Plug_and_Play).
diff --git a/examples/upnp/src/main.rs b/examples/upnp/src/main.rs
@@ -0,0 +1,81 @@
+// Copyright 2023 Protocol Labs.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+
+#![doc = include_str!("../README.md")]
+
+use futures::prelude::*;
+use libp2p::core::upgrade::Version;
+use libp2p::{
+    identity, noise,
+    swarm::{SwarmBuilder, SwarmEvent},
+    tcp, upnp, yamux, Multiaddr, PeerId, Transport,
+};
+use std::error::Error;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn Error>> {
+    let local_key = identity::Keypair::generate_ed25519();
+    let local_peer_id = PeerId::from(local_key.public());
+    println!("Local peer id: {local_peer_id:?}");
+
+    let transport = tcp::tokio::Transport::default()
+        .upgrade(Version::V1Lazy)
+        .authenticate(noise::Config::new(&local_key)?)
+        .multiplex(yamux::Config::default())
+        .boxed();
+
+    let mut swarm = SwarmBuilder::with_tokio_executor(
+        transport,
+        upnp::tokio::Behaviour::default(),
+        local_peer_id,
+    )
+    .build();
+
+    // Tell the swarm to listen on all interfaces and a random, OS-assigned
+    // port.
+    swarm.listen_on("/ip4/0.0.0.0/tcp/0".parse()?)?;
+
+    // Dial the peer identified by the multi-address given as the second
+    // command-line argument, if any.
+    if let Some(addr) = std::env::args().nth(1) {
+        let remote: Multiaddr = addr.parse()?;
+        swarm.dial(remote)?;
+        println!("Dialed {addr}")
+    }
+
+    loop {
+        match swarm.select_next_some().await {
+            SwarmEvent::NewListenAddr { address, .. } => println!("Listening on {address:?}"),
+            SwarmEvent::Behaviour(upnp::Event::NewExternalAddr(addr)) => {
+                println!("New external address: {addr}");
+            }
+            SwarmEvent::Behaviour(upnp::Event::GatewayNotFound) => {
+                println!("Gateway does not support UPnP");
+                break;
+            }
+            SwarmEvent::Behaviour(upnp::Event::NonRoutableGateway) => {
+                println!("Gateway is not exposed directly to the public Internet, i.e. it itself has a private IP address.");
+                break;
+            }
+            _ => {}
+        }
+    }
+    Ok(())
+}
diff --git a/libp2p/CHANGELOG.md b/libp2p/CHANGELOG.md
@@ -10,10 +10,14 @@
 - Add `json` feature which exposes `request_response::json`.
   See [PR 4188].
 
+- Add support for UPnP via the IGD protocol.
+  See [PR 4156].
+
 - Add `libp2p-memory-connection-limits` providing memory usage based connection limit configurations.
   See [PR 4281].
 
 [PR 4188]: https://github.com/libp2p/rust-libp2p/pull/4188
+[PR 4156]: https://github.com/libp2p/rust-libp2p/pull/4156
 [PR 4217]: https://github.com/libp2p/rust-libp2p/pull/4217
 [PR 4281]: https://github.com/libp2p/rust-libp2p/pull/4281
 
diff --git a/libp2p/Cargo.toml b/libp2p/Cargo.toml
@@ -50,6 +50,7 @@ full = [
     "websocket",
     "webtransport-websys",
     "yamux",
+    "upnp"
 ]
 
 async-std = ["libp2p-swarm/async-std", "libp2p-mdns?/async-io", "libp2p-tcp?/async-io", "libp2p-dns?/async-std", "libp2p-quic?/async-std"]
@@ -82,14 +83,15 @@ secp256k1 = ["libp2p-identity/secp256k1"]
 serde = ["libp2p-core/serde", "libp2p-kad?/serde", "libp2p-gossipsub?/serde"]
 tcp = ["dep:libp2p-tcp"]
 tls = ["dep:libp2p-tls"]
-tokio = ["libp2p-swarm/tokio", "libp2p-mdns?/tokio", "libp2p-tcp?/tokio", "libp2p-dns?/tokio", "libp2p-quic?/tokio"]
+tokio = ["libp2p-swarm/tokio", "libp2p-mdns?/tokio", "libp2p-tcp?/tokio", "libp2p-dns?/tokio", "libp2p-quic?/tokio", "libp2p-upnp?/tokio"]
 uds = ["dep:libp2p-uds"]
 wasm-bindgen = ["futures-timer/wasm-bindgen", "instant/wasm-bindgen", "getrandom/js", "libp2p-swarm/wasm-bindgen", "libp2p-gossipsub?/wasm-bindgen"]
 wasm-ext = ["dep:libp2p-wasm-ext"]
 wasm-ext-websocket = ["wasm-ext", "libp2p-wasm-ext?/websocket"]
 websocket = ["dep:libp2p-websocket"]
 webtransport-websys = ["dep:libp2p-webtransport-websys"]
 yamux = ["dep:libp2p-yamux"]
+upnp = ["dep:libp2p-upnp"]
 
 [dependencies]
 bytes = "1"
@@ -133,6 +135,7 @@ libp2p-quic = { workspace = true, optional = true }
 libp2p-tcp = { workspace = true, optional = true }
 libp2p-tls = { workspace = true, optional = true }
 libp2p-uds = { workspace = true, optional = true }
+libp2p-upnp = { workspace = true, optional = true }
 libp2p-websocket = { workspace = true, optional = true }
 
 [dev-dependencies]
diff --git a/libp2p/src/lib.rs b/libp2p/src/lib.rs
@@ -127,6 +127,10 @@ pub use libp2p_tls as tls;
 #[cfg(not(target_arch = "wasm32"))]
 #[doc(inline)]
 pub use libp2p_uds as uds;
+#[cfg(feature = "upnp")]
+#[cfg(not(target_arch = "wasm32"))]
+#[doc(inline)]
+pub use libp2p_upnp as upnp;
 #[cfg(feature = "wasm-ext")]
 #[doc(inline)]
 pub use libp2p_wasm_ext as wasm_ext;
diff --git a/protocols/upnp/CHANGELOG.md b/protocols/upnp/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.1.0 - unreleased
+
+- Initial version
diff --git a/protocols/upnp/Cargo.toml b/protocols/upnp/Cargo.toml
@@ -0,0 +1,25 @@
+[package]
+name = "libp2p-upnp"
+edition = "2021"
+rust-version = "1.60.0"
+description = "UPnP support for libp2p transports"
+version = "0.1.0"
+license = "MIT"
+repository = "https://github.com/libp2p/rust-libp2p"
+keywords = ["peer-to-peer", "libp2p", "networking"]
+categories = ["network-programming", "asynchronous"]
+publish = false
+
+[dependencies]
+futures = "0.3.28"
+futures-timer = "3.0.2"
+igd-next = "0.14.2"
+libp2p-core = { workspace = true }
+libp2p-swarm = { workspace = true }
+log = "0.4.19"
+void = "1.0.2"
+tokio = { version = "1.29", default-features = false, features = ["rt"], optional = true }
+
+[features]
+tokio = ["igd-next/aio_tokio", "dep:tokio"]
+
diff --git a/protocols/upnp/src/behaviour.rs b/protocols/upnp/src/behaviour.rs
diff --git a/protocols/upnp/src/lib.rs b/protocols/upnp/src/lib.rs
diff --git a/protocols/upnp/src/tokio.rs b/protocols/upnp/src/tokio.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.1.0 - unreleased`
	`2`	`+`
	`3`	`+- Initial version`