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

ekzhang · web-flow · commit c1b3556b49d4 · 2024-05-04T22:37:06.000-04:00
* 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
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.2.3"
+version = "0.2.4"
 authors = ["Eric Zhang <ekzhang1@gmail.com>"]
 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"] }
diff --git a/crates/sshx-core/proto/sshx.proto b/crates/sshx-core/proto/sshx.proto
@@ -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 {
diff --git a/crates/sshx-server/src/grpc.rs b/crates/sshx-server/src/grpc.rs
@@ -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)));
             }
diff --git a/crates/sshx-server/src/session.rs b/crates/sshx-server/src/session.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.
diff --git a/crates/sshx-server/src/session/snapshot.rs b/crates/sshx-server/src/session/snapshot.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);
diff --git a/crates/sshx-server/src/web/protocol.rs b/crates/sshx-server/src/web/protocol.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.
diff --git a/crates/sshx-server/src/web/socket.rs b/crates/sshx-server/src/web/socket.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(());
diff --git a/crates/sshx-server/tests/common/mod.rs b/crates/sshx-server/tests/common/mod.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) => {
diff --git a/crates/sshx-server/tests/simple.rs b/crates/sshx-server/tests/simple.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());
diff --git a/crates/sshx-server/tests/snapshot.rs b/crates/sshx-server/tests/snapshot.rs
@@ -16,7 +16,7 @@ pub mod common;
 async fn test_basic_restore() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
diff --git a/crates/sshx-server/tests/with_client.rs b/crates/sshx-server/tests/with_client.rs
@@ -14,7 +14,7 @@ pub mod common;
 #[tokio::test]
 async fn test_handshake() -> Result<()> {
     let server = TestServer::new().await;
-    let controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     controller.close().await?;
     Ok(())
 }
@@ -23,7 +23,7 @@ async fn test_handshake() -> Result<()> {
 async fn test_command() -> Result<()> {
     let server = TestServer::new().await;
     let runner = Runner::Shell("/bin/bash".into());
-    let mut controller = Controller::new(&server.endpoint(), runner).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", runner).await?;
 
     let session = server
         .state()
@@ -69,7 +69,7 @@ async fn test_ws_missing() -> Result<()> {
 async fn test_ws_basic() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
@@ -101,7 +101,7 @@ async fn test_ws_basic() -> Result<()> {
 async fn test_ws_resize() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
@@ -145,7 +145,7 @@ async fn test_ws_resize() -> Result<()> {
 async fn test_users_join() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
@@ -174,7 +174,7 @@ async fn test_users_join() -> Result<()> {
 async fn test_users_metadata() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
@@ -199,7 +199,7 @@ async fn test_users_metadata() -> Result<()> {
 async fn test_chat_messages() -> Result<()> {
     let server = TestServer::new().await;
 
-    let mut controller = Controller::new(&server.endpoint(), Runner::Echo).await?;
+    let mut controller = Controller::new(&server.endpoint(), "", Runner::Echo).await?;
     let name = controller.name().to_owned();
     let key = controller.encryption_key().to_owned();
     tokio::spawn(async move { controller.run().await });
diff --git a/crates/sshx/Cargo.toml b/crates/sshx/Cargo.toml
@@ -26,3 +26,4 @@ tokio-stream.workspace = true
 tonic.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
+whoami = { version = "1.5.1", default-features = false }
diff --git a/crates/sshx/src/controller.rs b/crates/sshx/src/controller.rs
@@ -46,19 +46,21 @@ pub struct Controller {
 
 impl Controller {
     /// Construct a new controller, connecting to the remote server.
-    pub async fn new(origin: &str, runner: Runner) -> Result<Self> {
+    pub async fn new(origin: &str, name: &str, runner: Runner) -> Result<Self> {
         debug!(%origin, "connecting to server");
         let encryption_key = rand_alphanumeric(14); // 83.3 bits of entropy
 
-        let encryption_key2 = encryption_key.clone();
-        let kdf_task = task::spawn_blocking(move || Encrypt::new(&encryption_key2));
-
+        let kdf_task = {
+            let encryption_key = encryption_key.clone();
+            task::spawn_blocking(move || Encrypt::new(&encryption_key))
+        };
         let mut client = Self::connect(origin).await?;
         let encrypt = kdf_task.await?;
 
         let req = OpenRequest {
             origin: origin.into(),
             encrypted_zeros: encrypt.zeros().into(),
+            name: name.into(),
         };
         let mut resp = client.open(req).await?.into_inner();
         resp.url = resp.url + "#" + &encryption_key;
diff --git a/crates/sshx/src/main.rs b/crates/sshx/src/main.rs
@@ -22,6 +22,10 @@ struct Args {
     /// Quiet mode, only prints the URL to stdout.
     #[clap(short, long)]
     quiet: bool,
+
+    /// Session name displayed in the title (defaults to user@hostname).
+    #[clap(long)]
+    name: Option<String>,
 }
 
 fn print_greeting(shell: &str, controller: &Controller) {
@@ -52,8 +56,19 @@ async fn start(args: Args) -> Result<()> {
         None => get_default_shell().await,
     };
 
+    let name = args.name.unwrap_or_else(|| {
+        let mut name = whoami::username();
+        if let Ok(host) = whoami::fallible::hostname() {
+            // Trim domain information like .lan or .local
+            let host = host.split('.').next().unwrap_or(&host);
+            name += "@";
+            name += host;
+        }
+        name
+    });
+
     let runner = Runner::Shell(shell.clone());
-    let mut controller = Controller::new(&args.server, runner).await?;
+    let mut controller = Controller::new(&args.server, &name, runner).await?;
     if args.quiet {
         println!("{}", controller.url());
     } else {
diff --git a/src/lib/Session.svelte b/src/lib/Session.svelte
@@ -1,5 +1,12 @@
 <script lang="ts">
-  import { onDestroy, onMount, tick, beforeUpdate, afterUpdate } from "svelte";
+  import {
+    onDestroy,
+    onMount,
+    tick,
+    beforeUpdate,
+    afterUpdate,
+    createEventDispatcher,
+  } from "svelte";
   import { fade } from "svelte/transition";
   import { debounce, throttle } from "lodash-es";
 
@@ -24,6 +31,8 @@
 
   export let id: string;
 
+  const dispatch = createEventDispatcher<{ receiveName: string }>();
+
   // The magic numbers "left" and "top" are used to approximately center the
   // terminal at the time that it is first created.
   //
@@ -128,7 +137,8 @@
     srocket = new Srocket<WsServer, WsClient>(`/api/s/${id}`, {
       onMessage(message) {
         if (message.hello) {
-          userId = message.hello;
+          userId = message.hello[0];
+          dispatch("receiveName", message.hello[1]);
           makeToast({
             kind: "success",
             message: `Connected to the server.`,
diff --git a/src/lib/protocol.ts b/src/lib/protocol.ts
@@ -18,7 +18,7 @@ export type WsUser = {
 
 /** Server message type, see the Rust version. */
 export type WsServer = {
-  hello?: Uid;
+  hello?: [Uid, string];
   invalidAuth?: [];
   users?: [Uid, WsUser][];
   userDiff?: [Uid, WsUser | null];
diff --git a/src/routes/s/[id]/+page.svelte b/src/routes/s/[id]/+page.svelte
diff --git a/vite.config.ts b/vite.config.ts

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ message TerminalSize {`
`40`	`40`	`message OpenRequest {`
`41`	`41`	`string origin = 1; // Web origin of the server.`
`42`	`42`	`bytes encrypted_zeros = 2; // Encrypted zero block, for client verification.`
	`43`	`+ string name = 3; // Name of the session (user@hostname).`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`// Details of a newly-created sshx session.`
`@@ -101,6 +102,7 @@ message SerializedSession {`
`101`	`102`	`map<uint32, SerializedShell> shells = 2;`
`102`	`103`	`uint32 next_sid = 3;`
`103`	`104`	`uint32 next_uid = 4;`
	`105`	`+ string name = 5;`
`104`	`106`	`}`
`105`	`107`
`106`	`108`	`message SerializedShell {`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ impl SshxService for GrpcServer {`
`55`	`55`	`None => {`
`56`	`56`	`let metadata = Metadata {`
`57`	`57`	`encrypted_zeros: request.encrypted_zeros,`
	`58`	`+ name: request.name,`
`58`	`59`	`};`
`59`	`60`	`self.0.insert(&name, Arc::new(Session::new(metadata)));`
`60`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@ const SHELL_STORED_BYTES: u64 = 1 << 21; // 2 MiB`
`30`	`30`	`pub struct Metadata {`
`31`	`31`	`/// Used to validate that clients have the correct encryption key.`
`32`	`32`	`pub encrypted_zeros: Bytes,`
	`33`	`+`
	`34`	`+ /// Name of the session (human-readable).`
	`35`	`+ pub name: String,`
`33`	`36`	`}`
`34`	`37`
`35`	`38`	`/// In-memory state for a single sshx session.`