Feature/explicit gateway addressing (#239)

* validator: fixing a warning, untestify this when you need it for real code

* webassembly: minor readme changes.

* README changes in wasm

* Updated wasm version

* clients/webassembly: security vuln updates

* typo fix

* WIP commit

* Significantly simplified the API

* Changed switch to have default branch

* Managed to get rid of `this` bind

* Moved 'Recipient' definition

* Examples update

* Slightly more generalised 'try_from_string' for recipient

* Updated to use client@gateway addressing

* Updated tests

Co-authored-by: Dave Hrycyszyn <futurechimp@users.noreply.github.com>

Author: jstuczyn

clients/desktop/examples/websocket_filesend.rs

@@ -1,6 +1,6 @@
 use futures::{SinkExt, StreamExt};
-use nym_client::client::Recipient;
 use nym_client::websocket::{BinaryClientRequest, ClientRequest, ServerResponse};
+use nymsphinx::addressing::clients::Recipient;
 use std::convert::TryFrom;
 use tokio_tungstenite::{connect_async, tungstenite::protocol::Message};
 

clients/desktop/examples/websocket_textsend.rs

@@ -2,6 +2,7 @@ use futures::{SinkExt, StreamExt};
 use nym_client::websocket::{ClientRequest, ServerResponse};
 use std::convert::TryFrom;
 use tokio_tungstenite::{connect_async, tungstenite::protocol::Message};
+
 #[tokio::main]
 async fn main() {
     let message = "Hello Nym!".to_string();

clients/desktop/src/client/cover_traffic_stream.rs

@@ -12,12 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::client::inbound_messages::Recipient;
 use crate::client::mix_traffic::{MixMessage, MixMessageSender};
 use crate::client::topology_control::TopologyAccessor;
 use futures::task::{Context, Poll};
 use futures::{Future, Stream, StreamExt};
 use log::*;
+use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::utils::{encapsulation, poisson};
 use std::pin::Pin;
 use std::time::Duration;

clients/desktop/src/client/inbound_messages.rs

@@ -1,8 +1,5 @@
 use futures::channel::mpsc;
-use nymsphinx::{
-    DestinationAddressBytes, Error, NodeAddressBytes, DESTINATION_ADDRESS_LENGTH,
-    NODE_ADDRESS_LENGTH,
-};
+use nymsphinx::addressing::clients::Recipient;
 
 pub(crate) type InputMessageSender = mpsc::UnboundedSender<InputMessage>;
 pub(crate) type InputMessageReceiver = mpsc::UnboundedReceiver<InputMessage>;
@@ -23,83 +20,3 @@ impl InputMessage {
         (self.recipient, self.data)
     }
 }
-
-#[derive(Debug)]
-pub struct RecipientFormattingError;
-
-impl From<nymsphinx::Error> for RecipientFormattingError {
-    fn from(_: Error) -> Self {
-        Self
-    }
-}
-
-// TODO: this should a different home... somewhere, but where?
-#[derive(Clone, Debug)]
-pub struct Recipient {
-    destination: DestinationAddressBytes,
-    gateway: NodeAddressBytes,
-}
-
-impl Recipient {
-    pub const LEN: usize = DESTINATION_ADDRESS_LENGTH + NODE_ADDRESS_LENGTH;
-
-    pub fn new(destination: DestinationAddressBytes, gateway: NodeAddressBytes) -> Self {
-        Recipient {
-            destination,
-            gateway,
-        }
-    }
-
-    pub fn destination(&self) -> DestinationAddressBytes {
-        self.destination.clone()
-    }
-
-    pub fn gateway(&self) -> NodeAddressBytes {
-        self.gateway.clone()
-    }
-
-    pub fn into_bytes(self) -> [u8; Self::LEN] {
-        let mut out = [0u8; Self::LEN];
-        out[..DESTINATION_ADDRESS_LENGTH].copy_from_slice(self.destination.as_bytes());
-        out[DESTINATION_ADDRESS_LENGTH..].copy_from_slice(self.gateway.as_bytes());
-
-        out
-    }
-
-    pub fn from_bytes(bytes: [u8; Self::LEN]) -> Self {
-        let mut destination_bytes = [0u8; DESTINATION_ADDRESS_LENGTH];
-        destination_bytes.copy_from_slice(&bytes[..DESTINATION_ADDRESS_LENGTH]);
-
-        let mut gateway_address_bytes = [0u8; NODE_ADDRESS_LENGTH];
-        gateway_address_bytes.copy_from_slice(&bytes[DESTINATION_ADDRESS_LENGTH..]);
-
-        let destination = DestinationAddressBytes::from_bytes(destination_bytes);
-        let gateway = NodeAddressBytes::from_bytes(gateway_address_bytes);
-
-        Self {
-            destination,
-            gateway,
-        }
-    }
-
-    pub fn try_from_string(full_address: String) -> Result<Self, RecipientFormattingError> {
-        let split: Vec<_> = full_address.split("@").collect();
-        if split.len() != 2 {
-            return Err(RecipientFormattingError);
-        }
-        let destination = DestinationAddressBytes::try_from_base58_string(split[0])?;
-        let gateway = NodeAddressBytes::try_from_base58_string(split[1])?;
-        Ok(Recipient {
-            destination,
-            gateway,
-        })
-    }
-
-    pub fn to_string(&self) -> String {
-        format!(
-            "{}@{}",
-            self.destination.to_base58_string(),
-            self.gateway.to_base58_string()
-        )
-    }
-}

clients/desktop/src/client/mod.rs

@@ -29,6 +29,7 @@ use futures::channel::mpsc;
 use gateway_client::{GatewayClient, SphinxPacketReceiver, SphinxPacketSender};
 use gateway_requests::auth_token::AuthToken;
 use log::*;
+use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::chunking::split_and_prepare_payloads;
 use nymsphinx::NodeAddressBytes;
 use received_buffer::{ReceivedBufferMessage, ReconstructedMessagesReceiver};
@@ -42,11 +43,6 @@ mod real_traffic_stream;
 pub(crate) mod received_buffer;
 pub(crate) mod topology_control;
 
-// I'm not sure if that is the right place for it to live, but I could not find a better one...
-// (it definitely can't be in websocket, because it's not websocket specific; neither can it just
-// live in common/nymsphinx, as it's sphinx related at all, it's only for client-client communication)
-pub use inbound_messages::Recipient;
-
 pub struct NymClient {
     config: Config,
     runtime: Runtime,

clients/desktop/src/client/real_traffic_stream.rs

@@ -12,13 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::client::inbound_messages::{InputMessage, Recipient};
+use crate::client::inbound_messages::InputMessage;
 use crate::client::mix_traffic::MixMessage;
 use crate::client::topology_control::TopologyAccessor;
 use futures::channel::mpsc;
 use futures::task::{Context, Poll};
 use futures::{Future, Stream, StreamExt};
 use log::{error, info, trace, warn};
+use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::utils::{encapsulation, poisson};
 use std::pin::Pin;
 use std::time::Duration;

clients/desktop/src/websocket/handler.rs

@@ -14,7 +14,7 @@
 
 use super::types::{BinaryClientRequest, ClientRequest, ServerResponse};
 use crate::client::{
-    inbound_messages::{InputMessage, InputMessageSender, Recipient},
+    inbound_messages::{InputMessage, InputMessageSender},
     received_buffer::{
         ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructedMessagesReceiver,
     },
@@ -23,6 +23,7 @@ use crate::client::{
 use futures::channel::mpsc;
 use futures::{SinkExt, StreamExt};
 use log::*;
+use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::chunking::split_and_prepare_payloads;
 use std::convert::TryFrom;
 use tokio::net::TcpStream;

clients/desktop/src/websocket/types.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::client::inbound_messages::Recipient;
+use nymsphinx::addressing::clients::Recipient;
 use serde::{Deserialize, Serialize};
 use std::convert::TryFrom;
 use tokio_tungstenite::tungstenite::protocol::Message;

clients/webassembly/client.js

@@ -11,7 +11,6 @@ export class Identity {
 }
 
 export class Client {
-    // constructor(gateway_url, ownAddress, registeredCallback) {
     constructor(directoryUrl, identity, authToken) {
         this.authToken = authToken
         this.gateway = null; // {socketAddress, mixAddress, conn}
@@ -20,6 +19,10 @@ export class Client {
         this.topologyEndpoint = directoryUrl + "/api/presence/topology";
     }
 
+    formatAsRecipient() {
+        return `${this.identity.address}@${this.gateway.mixAddress}`
+    }
+
     async start() {
         await this.updateTopology();
         this._getInitialGateway();
@@ -206,7 +209,6 @@ export class Client {
     }
 }
 
-
 function makeRegisterRequest(address) {
     return JSON.stringify({ "type": "register", "address": address });
 }

clients/webassembly/js-example/index.html

@@ -9,14 +9,14 @@
 
 <body>
   <p>
-    <label for="fname">Our address: </label><input disabled="true" size="40" type="text" id="sender" value="">
+    <label for="fname">Our address: </label><input disabled="true" size="120" type="text" id="sender" value="">
   </p>
 
   <p>
-    <label for="fname">Recipient address: </label><input size="40" type="text" id="recipient" value="">
+    <label for="fname">Recipient address: </label><input size="120" type="text" id="recipient" value="">
   </p>
   <label for="fname">Text to send: </label><input type="text" id="sendtext" value="Hello mixnet!">
-  <button id="send-button">Send</button><button id="refresh-button">Refresh</button>
+  <button id="send-button">Send</button>
 
 
   <p>Send messages to the mixnet using the "send" button.</p>

clients/webassembly/js-example/index.js

@@ -17,17 +17,16 @@ import {
     Identity
 } from "nym-client-wasm/client"
 
-
 async function main() {
     let directory = "https://qa-directory.nymtech.net";
-    // let identity = new Identity(); // or load one from storage if you have one already
-    // because I'm about to make a new PR tomorrow, just hardcode it to not recreate client every single recompilation
-    let identity = { address: "7mVwY9uFRBBTW91dAWaDtuusSpzc16ZwANLSXxXVYT7M", privateKey: "H4cp7DFMsPXD4Qm7ZW3TgsJETr2CpJhxmBJohko7HrDE", publicKey: "7mVwY9uFRBBTW91dAWaDtuusSpzc16ZwANLSXxXVYT7M" }
+    let identity = new Identity(); // or load one from storage if you have one already
 
-    document.getElementById("sender").value = identity.address;
+    document.getElementById("sender").value = "loading...";
 
     let nymClient = new Client(directory, identity, null); // provide your authToken if you've registered before
+    nymClient.onEstablishedGatewayConnection = (_) => document.getElementById("sender").value = nymClient.formatAsRecipient() // overwrite default behaviour with our implementation
     nymClient.onParsedBlobResponse = displayReceived // overwrite default behaviour with our implementation
+    nymClient.onErrorResponse = (event) => alert("Received invalid gateway response", event.data)
     await nymClient.start();
 
     const sendButton = document.querySelector('#send-button');