From 944460865144ee5f2f92fe945e2e5061549826aa Mon Sep 17 00:00:00 2001
From: Thomas Rampelberg <thomas@saunter.org>
Date: Wed, 18 Sep 2024 11:51:05 -0700
Subject: [PATCH] Add a way to open an agent forwarding channel (#344)

This works in concert with AgentClient from russh_keys to provide access
to client's ssh agent when agent forwarding is enabled.
---
 russh/src/server/session.rs | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/russh/src/server/session.rs b/russh/src/server/session.rs
index 3868a83..26d8da6 100644
--- a/russh/src/server/session.rs
+++ b/russh/src/server/session.rs
@@ -26,6 +26,9 @@ pub struct Session {
 }
 #[derive(Debug)]
 pub enum Msg {
+    ChannelOpenAgent {
+        channel_ref: ChannelRef,
+    },
     ChannelOpenSession {
         channel_ref: ChannelRef,
     },
@@ -206,6 +209,23 @@ impl Handle {
         }
     }
 
+    /// Open an agent forwarding channel. This can be used once the client has
+    /// confirmed that it allows agent forwarding. See
+    /// [PROTOCOL.agent](https://datatracker.ietf.org/doc/html/draft-miller-ssh-agent).
+    pub async fn channel_open_agent(&self) -> Result<Channel<Msg>, Error> {
+        let (sender, receiver) = unbounded_channel();
+        let channel_ref = ChannelRef::new(sender);
+        let window_size_ref = channel_ref.window_size().clone();
+
+        self.sender
+            .send(Msg::ChannelOpenAgent { channel_ref })
+            .await
+            .map_err(|_| Error::SendError)?;
+
+        self.wait_channel_confirmation(receiver, window_size_ref)
+            .await
+    }
+
     /// Request a session channel (the most basic type of
     /// channel). This function returns `Ok(..)` immediately if the
     /// connection is authenticated, but the channel only becomes
@@ -535,6 +555,10 @@ impl Session {
                         Some(Msg::Channel(id, ChannelMsg::WindowAdjusted { new_size })) => {
                             debug!("window adjusted to {:?} for channel {:?}", new_size, id);
                         }
+                        Some(Msg::ChannelOpenAgent { channel_ref }) => {
+                            let id = self.channel_open_agent()?;
+                            self.channels.insert(id, channel_ref);
+                        }
                         Some(Msg::ChannelOpenSession { channel_ref }) => {
                             let id = self.channel_open_session()?;
                             self.channels.insert(id, channel_ref);