Add protocol type in req/resp messages

nymtech · Sep 23, 2024 · e1ff05c · e1ff05c
1 parent 5f6456f
commit e1ff05c
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 9 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -81,6 +81,7 @@ members = [
     "common/nyxd-scraper",
     "common/pemstore",
     "common/serde-helpers",
+    "common/service-provider-requests-common",
     "common/socks5-client-core",
     "common/socks5/proxy-helpers",
     "common/socks5/requests",

diff --git a/common/authenticator-requests/Cargo.toml b/common/authenticator-requests/Cargo.toml
@@ -17,6 +17,7 @@ thiserror = { workspace = true }
 
 nym-credentials-interface = { path = "../credentials-interface" }
 nym-crypto = { path = "../crypto", features = ["asymmetric"] }
+nym-service-provider-requests-common = { path = "../service-provider-requests-common" }
 nym-sphinx = { path = "../nymsphinx" }
 nym-wireguard-types = { path = "../wireguard-types" }
 

diff --git a/common/authenticator-requests/src/v1/request.rs b/common/authenticator-requests/src/v1/request.rs
@@ -83,3 +83,24 @@ pub enum AuthenticatorRequestData {
     Final(GatewayClient),
     QueryBandwidth(PeerPublicKey),
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::str::FromStr;
+
+    #[test]
+    fn check_first_byte_version() {
+        let version = 2;
+        let data = AuthenticatorRequest {
+            version,
+            data: AuthenticatorRequestData::Initial(InitMessage::new(
+                PeerPublicKey::from_str("yvNUDpT5l7W/xDhiu6HkqTHDQwbs/B3J5UrLmORl1EQ=").unwrap(),
+            )),
+            reply_to: Recipient::try_from_base58_string("D1rrpsysCGCYXy9saP8y3kmNpGtJZUXN9SvFoUcqAsM9.9Ssso1ea5NfkbMASdiseDSjTN1fSWda5SgEVjdSN4CvV@GJqd3ZxpXWSNxTfx7B1pPtswpetH4LnJdFeLeuY5KUuN").unwrap(),
+            request_id: 1,
+        };
+        let bytes = data.to_bytes().unwrap();
+        assert_eq!(*bytes.first().unwrap(), version);
+    }
+}
diff --git a/common/authenticator-requests/src/v2/conversion.rs b/common/authenticator-requests/src/v2/conversion.rs
@@ -1,12 +1,17 @@
 // Copyright 2024 - Nym Technologies SA <[email protected]>
 // SPDX-License-Identifier: Apache-2.0
 
+use nym_service_provider_requests_common::{Protocol, ServiceProviderType};
+
 use crate::{v1, v2};
 
 impl From<v1::request::AuthenticatorRequest> for v2::request::AuthenticatorRequest {
     fn from(authenticator_request: v1::request::AuthenticatorRequest) -> Self {
         Self {
-            version: 2,
+            protocol: Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator,
+            },
             data: authenticator_request.data.into(),
             reply_to: authenticator_request.reply_to,
             request_id: authenticator_request.request_id,

diff --git a/common/authenticator-requests/src/v2/request.rs b/common/authenticator-requests/src/v2/request.rs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use super::registration::{FinalMessage, InitMessage};
+use nym_service_provider_requests_common::{Protocol, ServiceProviderType};
 use nym_sphinx::addressing::Recipient;
 use nym_wireguard_types::PeerPublicKey;
 use serde::{Deserialize, Serialize};
@@ -18,7 +19,7 @@ fn generate_random() -> u64 {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct AuthenticatorRequest {
-    pub version: u8,
+    pub protocol: Protocol,
     pub data: AuthenticatorRequestData,
     pub reply_to: Recipient,
     pub request_id: u64,
@@ -36,7 +37,10 @@ impl AuthenticatorRequest {
         let request_id = generate_random();
         (
             Self {
-                version: VERSION,
+                protocol: Protocol {
+                    service_provider_type: ServiceProviderType::Authenticator,
+                    version: VERSION,
+                },
                 data: AuthenticatorRequestData::Initial(init_message),
                 reply_to,
                 request_id,
@@ -49,7 +53,10 @@ impl AuthenticatorRequest {
         let request_id = generate_random();
         (
             Self {
-                version: VERSION,
+                protocol: Protocol {
+                    service_provider_type: ServiceProviderType::Authenticator,
+                    version: VERSION,
+                },
                 data: AuthenticatorRequestData::Final(Box::new(final_message)),
                 reply_to,
                 request_id,
@@ -62,7 +69,10 @@ impl AuthenticatorRequest {
         let request_id = generate_random();
         (
             Self {
-                version: VERSION,
+                protocol: Protocol {
+                    service_provider_type: ServiceProviderType::Authenticator,
+                    version: VERSION,
+                },
                 data: AuthenticatorRequestData::QueryBandwidth(peer_public_key),
                 reply_to,
                 request_id,
@@ -83,3 +93,27 @@ pub enum AuthenticatorRequestData {
     Final(Box<FinalMessage>),
     QueryBandwidth(PeerPublicKey),
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::str::FromStr;
+
+    #[test]
+    fn check_first_byte_version() {
+        let version = 2;
+        let data = AuthenticatorRequest {
+            protocol: Protocol {
+                version,
+                service_provider_type: ServiceProviderType::Authenticator,
+            },
+            data: AuthenticatorRequestData::Initial(InitMessage::new(
+                PeerPublicKey::from_str("yvNUDpT5l7W/xDhiu6HkqTHDQwbs/B3J5UrLmORl1EQ=").unwrap(),
+            )),
+            reply_to: Recipient::try_from_base58_string("D1rrpsysCGCYXy9saP8y3kmNpGtJZUXN9SvFoUcqAsM9.9Ssso1ea5NfkbMASdiseDSjTN1fSWda5SgEVjdSN4CvV@GJqd3ZxpXWSNxTfx7B1pPtswpetH4LnJdFeLeuY5KUuN").unwrap(),
+            request_id: 1,
+        };
+        let bytes = data.to_bytes().unwrap();
+        assert_eq!(*bytes.first().unwrap(), version);
+    }
+}
diff --git a/common/authenticator-requests/src/v2/response.rs b/common/authenticator-requests/src/v2/response.rs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use super::registration::{RegistrationData, RegistredData, RemainingBandwidthData};
+use nym_service_provider_requests_common::{Protocol, ServiceProviderType};
 use nym_sphinx::addressing::Recipient;
 use serde::{Deserialize, Serialize};
 
@@ -11,7 +12,7 @@ use super::VERSION;
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct AuthenticatorResponse {
-    pub version: u8,
+    pub protocol: Protocol,
     pub data: AuthenticatorResponseData,
     pub reply_to: Recipient,
 }
@@ -23,7 +24,10 @@ impl AuthenticatorResponse {
         reply_to: Recipient,
     ) -> Self {
         Self {
-            version: VERSION,
+            protocol: Protocol {
+                service_provider_type: ServiceProviderType::Authenticator,
+                version: VERSION,
+            },
             data: AuthenticatorResponseData::PendingRegistration(PendingRegistrationResponse {
                 reply: registration_data,
                 reply_to,
@@ -39,7 +43,10 @@ impl AuthenticatorResponse {
         request_id: u64,
     ) -> Self {
         Self {
-            version: VERSION,
+            protocol: Protocol {
+                service_provider_type: ServiceProviderType::Authenticator,
+                version: VERSION,
+            },
             data: AuthenticatorResponseData::Registered(RegisteredResponse {
                 reply: registred_data,
                 reply_to,
@@ -55,7 +62,10 @@ impl AuthenticatorResponse {
         request_id: u64,
     ) -> Self {
         Self {
-            version: VERSION,
+            protocol: Protocol {
+                service_provider_type: ServiceProviderType::Authenticator,
+                version: VERSION,
+            },
             data: AuthenticatorResponseData::RemainingBandwidth(RemainingBandwidthResponse {
                 reply: remaining_bandwidth_data,
                 reply_to,

diff --git a/common/service-provider-requests-common/Cargo.toml b/common/service-provider-requests-common/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+name = "nym-service-provider-requests-common"
+version = "0.1.0"
+authors.workspace = true
+repository.workspace = true
+homepage.workspace = true
+documentation.workspace = true
+edition.workspace = true
+license.workspace = true
+rust-version.workspace = true
+readme.workspace = true
+
+[dependencies]
+serde = { workspace = true, features = ["derive"] }
diff --git a/common/service-provider-requests-common/src/lib.rs b/common/service-provider-requests-common/src/lib.rs
@@ -0,0 +1,17 @@
+// Copyright 2024 - Nym Technologies SA <[email protected]>
+// SPDX-License-Identifier: Apache-2.0
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub enum ServiceProviderType {
+    Authenticator,
+    IpPacketRouter,
+    NetworkRequester,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct Protocol {
+    pub version: u8,
+    pub service_provider_type: ServiceProviderType,
+}