adjusted gateway probe to allow testing wireguard nodes that are not entries (#1812)

* adjusted gateway probe to allow testing wireguard nodes that are not entries

* updated git ref to make CI pass (hopefully)

* post-rebasing fixes

Author: jstuczyn

nym-vpn-core/Cargo.lock

@@ -168,27 +168,29 @@ windows-sys = "0.52"
 x25519-dalek = "2.0"
 zeroize = "1.6.0"
 
-nym-authenticator-requests = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-bandwidth-controller = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-bin-common = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-client-core = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-compact-ecash = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-config = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-contracts-common = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-credential-proxy-requests = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-credential-storage = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-credentials = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-credentials-interface = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-crypto = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-ecash-time = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-http-api-client = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-ip-packet-requests = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-node-requests = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-pemstore = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-service-provider-requests-common = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-sdk = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-statistics-common = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-task = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-topology = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-validator-client = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
-nym-wireguard-types = { git = "https://github.com/nymtech/nym", branch = "release/2024.15-reeses" }
+# 3d2914b3e5d707cd56e45508cfda6b656d483190 points to the current develop (as of 08.01.25) that contains
+# needed changes to `NymTopology` that are going to be released in Hu
+nym-authenticator-requests = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-bandwidth-controller = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-bin-common = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-client-core = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-compact-ecash = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-config = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-contracts-common = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-credential-proxy-requests = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-credential-storage = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-credentials = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-credentials-interface = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-crypto = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-ecash-time = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-http-api-client = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-ip-packet-requests = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-node-requests = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-pemstore = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-service-provider-requests-common = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-sdk = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-statistics-common = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-task = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-topology = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-validator-client = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }
+nym-wireguard-types = { git = "https://github.com/nymtech/nym", rev = "3d2914b3e5d707cd56e45508cfda6b656d483190" }

nym-vpn-core/Cargo.toml

@@ -735,22 +735,34 @@ impl From<u8> for AuthenticatorVersion {
     }
 }
 
-impl From<Option<String>> for AuthenticatorVersion {
-    fn from(value: Option<String>) -> Self {
+impl From<&str> for AuthenticatorVersion {
+    fn from(value: &str) -> Self {
+        let Ok(semver) = semver::Version::parse(value) else {
+            return Self::UNKNOWN;
+        };
+
+        semver.into()
+    }
+}
+
+impl From<Option<&String>> for AuthenticatorVersion {
+    fn from(value: Option<&String>) -> Self {
         match value {
             None => Self::UNKNOWN,
-            Some(value) => value.into(),
+            Some(value) => value.as_str().into(),
         }
     }
 }
 
 impl From<String> for AuthenticatorVersion {
     fn from(value: String) -> Self {
-        let Ok(semver) = semver::Version::parse(value.as_str()) else {
-            return Self::UNKNOWN;
-        };
+        Self::from(value.as_str())
+    }
+}
 
-        semver.into()
+impl From<Option<String>> for AuthenticatorVersion {
+    fn from(value: Option<String>) -> Self {
+        value.as_ref().into()
     }
 }
 

nym-vpn-core/crates/nym-authenticator-client/src/lib.rs

@@ -53,9 +53,9 @@ impl ExitPoint {
                 let ipr_address = IpPacketRouterAddress(*address);
                 let gateway_address = ipr_address.gateway();
 
-                // Now fetch the gateway that the IPR is connected to, and override it's IPR address
+                // Now fetch the gateway that the IPR is connected to, and override its IPR address
                 let mut gateway = gateways
-                    .gateway_with_identity(gateway_address)
+                    .gateway_with_identity(&gateway_address)
                     .ok_or_else(|| Error::NoMatchingGateway {
                         requested_identity: gateway_address.to_string(),
                     })

nym-vpn-core/crates/nym-gateway-directory/src/entries/exit_point.rs

@@ -1,24 +1,28 @@
 // Copyright 2024 - Nym Technologies SA <[email protected]>
 // SPDX-License-Identifier: GPL-3.0-only
 
-use std::{fmt, net::IpAddr, str::FromStr};
-
 use itertools::Itertools;
 use nym_sdk::mixnet::NodeIdentity;
+use nym_topology::{NodeId, RoutingNode};
 use nym_vpn_api_client::types::Percent;
 use rand::seq::IteratorRandom;
+use std::{fmt, net::IpAddr};
 use tracing::error;
 
 use crate::{error::Result, AuthAddress, Country, Error, IpPacketRouterAddress};
 
+pub type NymNode = Gateway;
+
 #[derive(Clone)]
 pub struct Gateway {
+    pub node_id: NodeId,
     pub identity: NodeIdentity,
     pub location: Option<Location>,
     pub ipr_address: Option<IpPacketRouterAddress>,
     pub authenticator_address: Option<AuthAddress>,
     pub last_probe: Option<Probe>,
-    pub host: Option<nym_topology::NetworkAddress>,
+    pub ips: Vec<IpAddr>,
+    pub host: Option<String>,
     pub clients_ws_port: Option<u16>,
     pub clients_wss_port: Option<u16>,
     pub mixnet_performance: Option<Percent>,
@@ -28,6 +32,7 @@ pub struct Gateway {
 impl fmt::Debug for Gateway {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("Gateway")
+            .field("node_id", &self.node_id)
             .field("identity", &self.identity.to_base58_string())
             .field("location", &self.location)
             .field("ipr_address", &self.ipr_address)
@@ -42,8 +47,12 @@ impl fmt::Debug for Gateway {
 }
 
 impl Gateway {
-    pub fn identity(&self) -> &NodeIdentity {
-        &self.identity
+    pub fn node_id(&self) -> NodeId {
+        self.node_id
+    }
+
+    pub fn identity(&self) -> NodeIdentity {
+        self.identity
     }
 
     pub fn two_letter_iso_country_code(&self) -> Option<&str> {
@@ -64,17 +73,12 @@ impl Gateway {
         self.authenticator_address.is_some()
     }
 
-    pub fn host(&self) -> Option<&nym_topology::NetworkAddress> {
+    pub fn host(&self) -> Option<&String> {
         self.host.as_ref()
     }
 
-    pub async fn lookup_ip(&self) -> Option<IpAddr> {
-        match self.host.clone()? {
-            nym_topology::NetworkAddress::IpAddr(ip) => Some(ip),
-            nym_topology::NetworkAddress::Hostname(hostname) => {
-                crate::helpers::try_resolve_hostname(&hostname).await.ok()
-            }
-        }
+    pub fn lookup_ip(&self) -> Option<IpAddr> {
+        self.ips.first().copied()
     }
 
     pub fn clients_address_no_tls(&self) -> Option<String> {
@@ -218,23 +222,22 @@ impl TryFrom<nym_vpn_api_client::response::NymDirectoryGateway> for Gateway {
             .authenticator
             .and_then(|auth| AuthAddress::try_from_base58_string(&auth.address).ok());
 
-        let hostname = gateway
-            .entry
-            .hostname
-            .map(nym_topology::NetworkAddress::Hostname);
-        let first_ip_address = gateway.ip_addresses.first().cloned().and_then(|ip| {
-            IpAddr::from_str(&ip)
-                .ok()
-                .map(nym_topology::NetworkAddress::IpAddr)
-        });
+        let hostname = gateway.entry.hostname;
+        let first_ip_address = gateway
+            .ip_addresses
+            .first()
+            .cloned()
+            .map(|ip| ip.to_string());
         let host = hostname.or(first_ip_address);
 
         Ok(Gateway {
+            node_id: gateway.node_id,
             identity,
             location: Some(gateway.location.into()),
             ipr_address,
             authenticator_address,
             last_probe: gateway.last_probe.map(Probe::from),
+            ips: gateway.ip_addresses,
             host,
             clients_ws_port: Some(gateway.entry.ws_port),
             clients_wss_port: gateway.entry.wss_port,
@@ -287,19 +290,24 @@ impl TryFrom<nym_validator_client::models::NymNodeDescription> for Gateway {
         } else {
             nym_validator_client::nym_nodes::NodeRole::Inactive
         };
-        let gateway = nym_topology::gateway::LegacyNode::try_from(
-            &node_description.to_skimmed_node(role, Default::default()),
-        )
-        .ok();
-        let host = gateway.clone().map(|g| g.host);
-        let clients_ws_port = gateway.as_ref().map(|g| g.clients_ws_port);
-        let clients_wss_port = gateway.and_then(|g| g.clients_wss_port);
+
+        let gateway =
+            RoutingNode::try_from(&node_description.to_skimmed_node(role, Default::default()))
+                .map_err(|_| Error::MalformedGateway)?;
+
+        let host = gateway.ws_entry_address(false);
+        let entry_info = &gateway.entry;
+        let clients_ws_port = entry_info.as_ref().map(|g| g.clients_ws_port);
+        let clients_wss_port = entry_info.as_ref().and_then(|g| g.clients_wss_port);
+        let ips = node_description.description.host_information.ip_address;
         Ok(Gateway {
+            node_id: gateway.node_id,
             identity,
             location,
             ipr_address,
             authenticator_address,
             last_probe: None,
+            ips,
             host,
             clients_ws_port,
             clients_wss_port,
@@ -309,6 +317,8 @@ impl TryFrom<nym_validator_client::models::NymNodeDescription> for Gateway {
     }
 }
 
+pub type NymNodeList = GatewayList;
+
 #[derive(Debug, Clone)]
 pub struct GatewayList {
     gateways: Vec<Gateway>,
@@ -341,10 +351,14 @@ impl GatewayList {
             .collect()
     }
 
-    pub fn gateway_with_identity(&self, identity: &NodeIdentity) -> Option<&Gateway> {
+    pub fn node_with_identity(&self, identity: &NodeIdentity) -> Option<&NymNode> {
         self.gateways
             .iter()
-            .find(|gateway| gateway.identity() == identity)
+            .find(|node| &node.identity() == identity)
+    }
+
+    pub fn gateway_with_identity(&self, identity: &NodeIdentity) -> Option<&Gateway> {
+        self.node_with_identity(identity)
     }
 
     pub fn gateways_located_at(&self, code: String) -> impl Iterator<Item = &Gateway> {
@@ -425,16 +439,22 @@ impl IntoIterator for GatewayList {
 }
 
 impl nym_client_core::init::helpers::ConnectableGateway for Gateway {
-    fn identity(&self) -> &nym_sdk::mixnet::NodeIdentity {
+    fn node_id(&self) -> NodeId {
+        self.node_id()
+    }
+
+    fn identity(&self) -> nym_sdk::mixnet::NodeIdentity {
         self.identity()
     }
 
-    fn clients_address(&self) -> String {
+    fn clients_address(&self, _prefer_ipv6: bool) -> Option<String> {
         // This is a bit of a sharp edge, but temporary until we can remove Option from host
         // and tls port when we add these to the vpn API endpoints.
-        self.clients_address_tls()
-            .or(self.clients_address_no_tls())
-            .unwrap_or("ws://".to_string())
+        Some(
+            self.clients_address_tls()
+                .or(self.clients_address_no_tls())
+                .unwrap_or("ws://".to_string()),
+        )
     }
 
     fn is_wss(&self) -> bool {

nym-vpn-core/crates/nym-gateway-directory/src/entries/gateway.rs

@@ -32,7 +32,7 @@ impl IpPacketRouterAddress {
         )?))
     }
 
-    pub fn gateway(&self) -> &NodeIdentity {
+    pub fn gateway(&self) -> NodeIdentity {
         self.0.gateway()
     }
 }

nym-vpn-core/crates/nym-gateway-directory/src/entries/ipr_addresses.rs

@@ -36,6 +36,9 @@ pub enum Error {
     #[error("failed to lookup skimmed gateways: {0}")]
     FailedToLookupSkimmedGateways(#[source] nym_validator_client::ValidatorClientError),
 
+    #[error("failed to lookup skimmed nodes: {0}")]
+    FailedToLookupSkimmedNodes(#[source] nym_validator_client::ValidatorClientError),
+
     #[error("requested gateway not found in the remote list: {0}")]
     RequestedGatewayIdNotFound(String),
 
@@ -76,6 +79,9 @@ pub enum Error {
 
     #[error("failed to lookup gateway ip for gateway {0}")]
     FailedToLookupIp(String),
+
+    #[error("the provided gateway information is malformed")]
+    MalformedGateway,
 }
 
 // Result type based on our error type