Implement socketio auth (1c3t3a#165)

* feat: add socketio auth

* docs: add socketio ClientBuilder.auth docs

* test: add socketio auth test

* ci: add missing docker-compose service

* feat: change auth to Option<serde_json::Value>

* test: fix socket io auth listener edge case

* feat: make auth consume Into again

* fix: remove debug println

Author: marekvospel

.devcontainer/docker-compose.yaml

@@ -32,6 +32,14 @@ services:
             - "4200:4200"
         environment:
             - "DEBUG=*"
+    node-socket-io-auth:
+        build:
+            context: ../ci
+        command: [ "node", "/test/socket-io-auth.js" ]
+        ports:
+            - "4204:4204"
+        environment:
+            - "DEBUG=*"
     rust-client:
         build: 
             context: .. 
@@ -43,6 +51,7 @@ services:
             - "..:/workspace/rust-socketio"
         environment:
             - "SOCKET_IO_SERVER=http://node-socket-io:4200"
+            - "SOCKET_IO_AUTH_SERVER=http://node-socket-io:4204"
             - "ENGINE_IO_SERVER=http://node-engine-io:4201"
             - "ENGINE_IO_SECURE_SERVER=https://node-engine-io-secure:4202"
             - "ENGINE_IO_SECURE_HOST=node-engine-io-secure"

.github/workflows/coverage.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Build docker container
         run: |
           cd ci && docker build -t test_suite:latest .
-          docker run -d --name test_suite -p 4200:4200 -p 4201:4201 -p 4202:4202 -p 4203:4203 test_suite:latest
+          docker run -d --name test_suite -p 4200:4200 -p 4201:4201 -p 4202:4202 -p 4203:4203 -p 4204:4204 test_suite:latest
 
       - uses: actions/cache@v2
         with:

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Build docker container
         run: |
           cd ci && docker build -t test_suite:latest .
-          docker run -d -p 4200:4200 -p 4201:4201 -p 4202:4202 -p 4203:4203 test_suite:latest
+          docker run -d -p 4200:4200 -p 4201:4201 -p 4202:4202 -p 4203:4203 -p 4204:4204 test_suite:latest
 
       - name: Generate Cargo.lock
         run: cargo generate-lockfile

ci/socket-io-auth.js

@@ -0,0 +1,18 @@
+const server = require('http').createServer();
+const io = require('socket.io')(server);
+
+console.log('Started');
+var callback = client => {
+    console.log('Connected!');;
+    client.on('test', function (arg, ack) {
+        console.log('Ack received')
+        if (ack) {
+            const payload = client.handshake.auth.password === '123' ? '456' : '789'
+            ack(payload);
+        }
+    });
+};
+io.on('connection', callback);
+io.of('/admin').on('connection', callback);
+// the socket.io client runs on port 4204
+server.listen(4204);

ci/start_test_server.sh

@@ -23,6 +23,14 @@ if [ $status -ne 0 ]; then
 fi
 echo "Successfully started socket.io instance"
 
+DEBUG=* node socket-io-auth.js &
+status=$?
+if [ $status -ne 0 ]; then
+  echo "Failed to start socket.io auth: $status"
+  exit $status
+fi
+echo "Successfully started socket.io auth instance"
+
 DEBUG=* node engine-io-secure.js &
 status=$?
 if [ $status -ne 0 ]; then

socketio/src/client/builder.rs

@@ -36,6 +36,7 @@ pub struct ClientBuilder {
     tls_config: Option<TlsConnector>,
     opening_headers: Option<HeaderMap>,
     transport_type: TransportType,
+    auth: Option<serde_json::Value>,
 }
 
 impl ClientBuilder {
@@ -77,6 +78,7 @@ impl ClientBuilder {
             tls_config: None,
             opening_headers: None,
             transport_type: TransportType::Any,
+            auth: None,
         }
     }
 
@@ -172,6 +174,26 @@ impl ClientBuilder {
         self
     }
 
+    /// Sets data sent in the opening request.
+    /// # Example
+    /// ```rust
+    /// use rust_socketio::{ClientBuilder};
+    /// use serde_json::json;
+    ///
+    /// let socket = ClientBuilder::new("http://localhost:4204/")
+    ///     .namespace("/admin")
+    ///     .auth(json!({ "password": "1337" }))
+    ///     .on("error", |err, _| eprintln!("Error: {:#?}", err))
+    ///     .connect()
+    ///     .expect("Connection error");
+    ///
+    /// ```
+    pub fn auth<T: Into<serde_json::Value>>(mut self, auth: T) -> Self {
+        self.auth = Some(auth.into());
+
+        self
+    }
+
     /// Specifies which EngineIO [`TransportType`] to use.
     /// # Example
     /// ```rust
@@ -261,7 +283,7 @@ impl ClientBuilder {
 
         let inner_socket = InnerSocket::new(engine_client)?;
 
-        let socket = Client::new(inner_socket, &self.namespace, self.on)?;
+        let socket = Client::new(inner_socket, &self.namespace, self.on, self.auth)?;
         socket.connect()?;
 
         Ok(socket)

socketio/src/client/client.rs

@@ -35,6 +35,8 @@ pub struct Client {
     outstanding_acks: Arc<RwLock<Vec<Ack>>>,
     // namespace, for multiplexing messages
     nsp: String,
+    // Data sent in opening header
+    auth: Option<serde_json::Value>,
 }
 
 impl Client {
@@ -46,12 +48,14 @@ impl Client {
         socket: InnerSocket,
         namespace: T,
         on: HashMap<Event, Callback>,
+        auth: Option<serde_json::Value>,
     ) -> Result<Self> {
         Ok(Client {
             socket,
             nsp: namespace.into(),
             on: Arc::new(RwLock::new(on)),
             outstanding_acks: Arc::new(RwLock::new(Vec::new())),
+            auth,
         })
     }
 
@@ -62,8 +66,10 @@ impl Client {
         // Connect the underlying socket
         self.socket.connect()?;
 
+        let auth = self.auth.as_ref().map(|data| data.to_string());
+
         // construct the opening packet
-        let open_packet = Packet::new(PacketId::Connect, self.nsp.clone(), None, None, 0, None);
+        let open_packet = Packet::new(PacketId::Connect, self.nsp.clone(), auth, None, 0, None);
 
         self.socket.send(open_packet)?;
 
@@ -389,7 +395,7 @@ impl<'a> Iterator for Iter<'a> {
 
 #[cfg(test)]
 mod test {
-
+    use std::sync::mpsc;
     use std::thread::sleep;
 
     use super::*;
@@ -524,6 +530,37 @@ mod test {
         test_socketio_socket(socket, "/admin".to_owned())
     }
 
+    #[test]
+    fn socket_io_auth_builder_integration() -> Result<()> {
+        let url = crate::test::socket_io_auth_server();
+        let socket = ClientBuilder::new(url)
+            .namespace("/admin")
+            .auth(json!({ "password": "123" }))
+            .connect()?;
+
+        let (tx, rx) = mpsc::sync_channel(0);
+
+        // Send emit with ack after 1s, so socketio server has enough time to register it's listeners
+        sleep(Duration::from_secs(1));
+
+        assert!(socket
+            .emit_with_ack(
+                "test",
+                json!({ "msg": "1" }),
+                Duration::from_secs(1),
+                move |payload, _| {
+                    println!("Got ack");
+                    tx.send(Payload::from(json!(["456"])) == payload).unwrap();
+                }
+            )
+            .is_ok());
+
+        let received = rx.recv();
+        assert!(received.is_ok() && received.unwrap());
+
+        Ok(())
+    }
+
     #[test]
     fn socketio_polling_integration() -> Result<()> {
         let url = crate::test::socket_io_server();

socketio/src/lib.rs

@@ -124,4 +124,19 @@ pub(crate) mod test {
 
         url
     }
+
+    // The socket.io auth server for testing runs on port 4204
+    const AUTH_SERVER_URL: &str = "http://localhost:4204";
+
+    pub(crate) fn socket_io_auth_server() -> Url {
+        let url =
+            std::env::var("SOCKET_IO_AUTH_SERVER").unwrap_or_else(|_| AUTH_SERVER_URL.to_owned());
+        let mut url = Url::parse(&url).unwrap();
+
+        if url.path() == "/" {
+            url.set_path("/socket.io/");
+        }
+
+        url
+    }
 }