feat: add rust-libp2p-server to monorepo

.github/workflows/ci.yml

@@ -63,6 +63,7 @@ jobs:
           crate: ${{ env.CRATE }}
 
       - name: Enforce no dependency on meta crate
+        if: env.CRATE != 'libp2p-server'
         run: |
           cargo metadata --format-version=1 --no-deps | \
           jq -e -r '.packages[] | select(.name == "'"$CRATE"'") | .dependencies | all(.name != "libp2p")'

.github/workflows/docker-image.yml

@@ -0,0 +1,35 @@
+name: Publish docker images
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - 'libp2p-server-**'
+
+jobs:
+  server:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Get branch or tag name
+        id: ref-name
+        run: echo ::set-output name=ref::${GITHUB_REF#refs/*/}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./misc/server/Dockerfile
+          push: true
+          tags: ghcr.io/${{ github.repository }}-server:${{ steps.ref-name.outputs.ref }}

Cargo.toml

@@ -24,6 +24,7 @@ members = [
     "misc/quick-protobuf-codec",
     "misc/quickcheck-ext",
     "misc/rw-stream-sink",
+    "misc/server",
     "muxers/mplex",
     "muxers/test-harness",
     "muxers/yamux",
@@ -89,6 +90,7 @@ 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-request-response = { version = "0.25.1", path = "protocols/request-response" }
+libp2p-server = { version = "0.12.1", path = "misc/server" }
 libp2p-swarm = { version = "0.43.3", path = "swarm" }
 libp2p-swarm-derive = { version = "0.33.0", path = "swarm-derive" }
 libp2p-swarm-test = { version = "0.2.0", path = "swarm-test" }

misc/server/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.12.1] - unreleased
+
+### Changed
+- Move to tokio and hyper.
+  See [PR 4311].
+- Move to distroless Docker base image.
+  See [PR 4311].
+
+[PR 4311]: https://github.com/libp2p/rust-libp2p/pull/4311
+
+## [0.8.0]
+### Changed
+- Remove mplex support.
+
+## [0.7.0]
+### Changed
+- Update to libp2p v0.47.0.
+
+## [0.6.0] - [2022-05-05]
+### Changed
+- Update to libp2p v0.44.0.
+
+## [0.5.4] - [2022-01-11]
+### Changed
+- Pull latest autonat changes.
+
+## [0.5.3] - [2021-12-25]
+### Changed
+- Update dependencies.
+- Pull in autonat fixes.
+
+## [0.5.2] - [2021-12-20]
+### Added
+- Add support for libp2p autonat protocol via `--enable-autonat`.
+
+## [0.5.1] - [2021-12-20]
+### Fixed
+- Update dependencies.
+- Fix typo in command line flag `--enable-kademlia`.
+
+## [0.5.0] - 2021-11-18
+### Changed
+- Disable Kademlia protocol by default.
+
+## [0.4.0] - 2021-11-18
+### Fixed
+- Update dependencies.

misc/server/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "libp2p-server"
+version = "0.12.1"
+authors = ["Max Inden <[email protected]>"]
+edition = "2021"
+rust-version = { workspace = true }
+description = "A rust-libp2p server binary."
+license = "MIT"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+base64 = "0.21"
+clap = { version = "4.3.12", features = ["derive"] }
+env_logger = "0.10.0"
+futures = "0.3"
+futures-timer = "3"
+hyper = { version = "0.14", features = ["server", "tcp", "http1"] }
+libp2p = { path = "../../libp2p", features = ["autonat", "dns", "tokio", "noise", "tcp", "yamux", "identify", "kad", "ping", "relay", "metrics", "rsa", "macros", "quic"] }
+log = "0.4"
+prometheus-client = "0.21.2"
+serde = "1.0.183"
+serde_derive = "1.0.125"
+serde_json = "1.0"
+tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
+zeroize = "1"

misc/server/Dockerfile

@@ -0,0 +1,16 @@
+FROM rust:1.66-bullseye as builder
+WORKDIR /usr/src/rust-libp2p-server
+
+# Run with access to the target cache to speed up builds
+WORKDIR /workspace
+ADD . .
+RUN --mount=type=cache,target=./target \
+    --mount=type=cache,target=/usr/local/cargo/registry \
+    cargo build --release --package libp2p-server
+
+RUN --mount=type=cache,target=./target \
+    mv ./target/release/libp2p-server /usr/local/bin/libp2p-server
+
+FROM gcr.io/distroless/cc
+COPY --from=builder /usr/local/bin/libp2p-server /usr/local/bin/libp2p-server
+CMD ["libp2p-server"]

misc/server/README.md

@@ -0,0 +1,35 @@
+# Rust libp2p Server
+
+A rust-libp2p based server implementation running:
+
+- the [Kademlia protocol](https://github.com/libp2p/specs/tree/master/kad-dht)
+
+- the [Circuit Relay v2 protocol](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md)
+
+- the [AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md)
+
+## Usage
+
+```
+cargo run -- --help
+
+A rust-libp2p server binary.
+
+Usage: libp2p-server [OPTIONS] --config <CONFIG>
+
+Options:
+      --config <CONFIG>              Path to IPFS config file
+      --metrics-path <METRICS_PATH>  Metric endpoint path [default: /metrics]
+      --enable-kademlia              Whether to run the libp2p Kademlia protocol and join the IPFS DHT
+      --enable-autonat               Whether to run the libp2p Autonat protocol
+  -h, --help                         Print help
+```
+
+
+```
+cargo run -- --config ~/.ipfs/config
+
+Local peer id: PeerId("12D3KooWSa1YEeQVSwvoqAMhwjKQ6kqZQckhWPb3RWEGV3sZGU6Z")
+Listening on "/ip4/127.0.0.1/udp/4001/quic"
+[...]
+```

misc/server/src/behaviour.rs

@@ -0,0 +1,78 @@
+use libp2p::autonat;
+use libp2p::identify;
+use libp2p::kad::{record::store::MemoryStore, Kademlia, KademliaConfig};
+use libp2p::ping;
+use libp2p::relay;
+use libp2p::swarm::behaviour::toggle::Toggle;
+use libp2p::{identity, swarm::NetworkBehaviour, Multiaddr, PeerId};
+use std::str::FromStr;
+use std::time::Duration;
+
+const BOOTNODES: [&str; 4] = [
+    "QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
+    "QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
+    "QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb",
+    "QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt",
+];
+
+#[derive(NetworkBehaviour)]
+pub(crate) struct Behaviour {
+    relay: relay::Behaviour,
+    ping: ping::Behaviour,
+    identify: identify::Behaviour,
+    pub(crate) kademlia: Toggle<Kademlia<MemoryStore>>,
+    autonat: Toggle<autonat::Behaviour>,
+}
+
+impl Behaviour {
+    pub(crate) fn new(
+        pub_key: identity::PublicKey,
+        enable_kademlia: bool,
+        enable_autonat: bool,
+    ) -> Self {
+        let kademlia = if enable_kademlia {
+            let mut kademlia_config = KademliaConfig::default();
+            // Instantly remove records and provider records.
+            //
+            // TODO: Replace hack with option to disable both.
+            kademlia_config.set_record_ttl(Some(Duration::from_secs(0)));
+            kademlia_config.set_provider_record_ttl(Some(Duration::from_secs(0)));
+            let mut kademlia = Kademlia::with_config(
+                pub_key.to_peer_id(),
+                MemoryStore::new(pub_key.to_peer_id()),
+                kademlia_config,
+            );
+            let bootaddr = Multiaddr::from_str("/dnsaddr/bootstrap.libp2p.io").unwrap();
+            for peer in &BOOTNODES {
+                kademlia.add_address(&PeerId::from_str(peer).unwrap(), bootaddr.clone());
+            }
+            kademlia.bootstrap().unwrap();
+            Some(kademlia)
+        } else {
+            None
+        }
+        .into();
+
+        let autonat = if enable_autonat {
+            Some(autonat::Behaviour::new(
+                PeerId::from(pub_key.clone()),
+                Default::default(),
+            ))
+        } else {
+            None
+        }
+        .into();
+
+        Self {
+            relay: relay::Behaviour::new(PeerId::from(pub_key.clone()), Default::default()),
+            ping: ping::Behaviour::new(ping::Config::new()),
+            identify: identify::Behaviour::new(
+                identify::Config::new("ipfs/0.1.0".to_string(), pub_key).with_agent_version(
+                    format!("rust-libp2p-server/{}", env!("CARGO_PKG_VERSION")),
+                ),
+            ),
+            kademlia,
+            autonat,
+        }
+    }
+}

misc/server/src/config.rs

@@ -0,0 +1,39 @@
+use libp2p::Multiaddr;
+use serde_derive::Deserialize;
+use std::error::Error;
+use std::path::Path;
+
+#[derive(Clone, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub(crate) struct Config {
+    pub(crate) identity: Identity,
+    pub(crate) addresses: Addresses,
+}
+
+impl Config {
+    pub(crate) fn from_file(path: &Path) -> Result<Self, Box<dyn Error>> {
+        Ok(serde_json::from_str(&std::fs::read_to_string(path)?)?)
+    }
+}
+
+#[derive(Clone, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub(crate) struct Identity {
+    #[serde(rename = "PeerID")]
+    pub(crate) peer_id: String,
+    pub(crate) priv_key: String,
+}
+
+#[derive(Clone, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub(crate) struct Addresses {
+    pub(crate) swarm: Vec<Multiaddr>,
+    pub(crate) append_announce: Vec<Multiaddr>,
+}
+
+impl zeroize::Zeroize for Config {
+    fn zeroize(&mut self) {
+        self.identity.peer_id.zeroize();
+        self.identity.priv_key.zeroize();
+    }
+}