Add --name option, default user@hostname (#91)

* Add --name option, default user@hostname

This appears in the title of the browser tab. If not specified, it will default to detecting the user and hostname of your machine using OS APIs.

This change is backwards-compatible and forwards-compatible between old clients and old server versions.

Resolves #90 and #85.

* Remove console.log()

* Fix clippy issue

Author: ekzhang

Cargo.lock

@@ -3,7 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.2.3"
+version = "0.2.4"
 authors = ["Eric Zhang <[email protected]>"]
 license = "MIT"
 description = "A secure web-based, collaborative terminal."
@@ -17,7 +17,7 @@ clap = { version = "4.4.2", features = ["derive", "env"] }
 prost = "0.12.0"
 rand = "0.8.5"
 serde = { version = "1.0.188", features = ["derive", "rc"] }
-sshx-core = { version = "0.2.3", path = "crates/sshx-core" }
+sshx-core = { version = "0.2.4", path = "crates/sshx-core" }
 tokio = { version = "1.32.0", features = ["full"] }
 tokio-stream = { version = "0.1.14", features = ["sync"] }
 tonic = { version = "0.10.0", features = ["tls", "tls-webpki-roots"] }

Cargo.toml

@@ -40,6 +40,7 @@ message TerminalSize {
 message OpenRequest {
   string origin = 1;         // Web origin of the server.
   bytes encrypted_zeros = 2; // Encrypted zero block, for client verification.
+  string name = 3;           // Name of the session (user@hostname).
 }
 
 // Details of a newly-created sshx session.
@@ -101,6 +102,7 @@ message SerializedSession {
   map<uint32, SerializedShell> shells = 2;
   uint32 next_sid = 3;
   uint32 next_uid = 4;
+  string name = 5;
 }
 
 message SerializedShell {

crates/sshx-core/proto/sshx.proto

@@ -55,6 +55,7 @@ impl SshxService for GrpcServer {
             None => {
                 let metadata = Metadata {
                     encrypted_zeros: request.encrypted_zeros,
+                    name: request.name,
                 };
                 self.0.insert(&name, Arc::new(Session::new(metadata)));
             }

crates/sshx-server/src/grpc.rs

@@ -30,6 +30,9 @@ const SHELL_STORED_BYTES: u64 = 1 << 21; // 2 MiB
 pub struct Metadata {
     /// Used to validate that clients have the correct encryption key.
     pub encrypted_zeros: Bytes,
+
+    /// Name of the session (human-readable).
+    pub name: String,
 }
 
 /// In-memory state for a single sshx session.

crates/sshx-server/src/session.rs

@@ -61,6 +61,7 @@ impl Session {
                 .collect(),
             next_sid: ids.0 .0,
             next_uid: ids.1 .0,
+            name: self.metadata().name.clone(),
         };
         let data = message.encode_to_vec();
         ensure!(data.len() < MAX_SNAPSHOT_SIZE, "snapshot too large");
@@ -73,6 +74,7 @@ impl Session {
         let message = SerializedSession::decode(&*data)?;
         let metadata = Metadata {
             encrypted_zeros: message.encrypted_zeros,
+            name: message.name,
         };
 
         let session = Self::new(metadata);

crates/sshx-server/src/session/snapshot.rs

@@ -46,7 +46,7 @@ pub struct WsUser {
 #[serde(rename_all = "camelCase")]
 pub enum WsServer {
     /// Initial server message, with the user's ID and session metadata.
-    Hello(Uid),
+    Hello(Uid, String),
     /// The user's authentication was invalid.
     InvalidAuth(),
     /// A snapshot of all current users in the session.

crates/sshx-server/src/web/protocol.rs

@@ -90,12 +90,13 @@ async fn handle_socket(socket: &mut WebSocket, session: Arc<Session>) -> Result<
         })
     }
 
+    let metadata = session.metadata();
     let user_id = session.counter().next_uid();
     session.sync_now();
-    send(socket, WsServer::Hello(user_id)).await?;
+    send(socket, WsServer::Hello(user_id, metadata.name.clone())).await?;
 
     match recv(socket).await? {
-        Some(WsClient::Authenticate(bytes)) if bytes == session.metadata().encrypted_zeros => {}
+        Some(WsClient::Authenticate(bytes)) if bytes == metadata.encrypted_zeros => {}
         _ => {
             send(socket, WsServer::InvalidAuth()).await?;
             return Ok(());

crates/sshx-server/src/web/socket.rs

@@ -154,7 +154,7 @@ impl ClientSocket {
         let flush_task = async {
             while let Some(msg) = self.recv().await {
                 match msg {
-                    WsServer::Hello(user_id) => self.user_id = user_id,
+                    WsServer::Hello(user_id, _) => self.user_id = user_id,
                     WsServer::InvalidAuth() => panic!("invalid authentication"),
                     WsServer::Users(users) => self.users = BTreeMap::from_iter(users),
                     WsServer::UserDiff(id, maybe_user) => {

crates/sshx-server/tests/common/mod.rs

@@ -14,6 +14,7 @@ async fn test_rpc() -> Result<()> {
     let req = OpenRequest {
         origin: "sshx.io".into(),
         encrypted_zeros: Encrypt::new("").zeros().into(),
+        name: String::new(),
     };
     let resp = client.open(req).await?;
     assert!(!resp.into_inner().name.is_empty());