Skip to content

Commit

Permalink
Add a way to open an agent forwarding channel (#344)
Browse files Browse the repository at this point in the history
This works in concert with AgentClient from russh_keys to provide access
to client's ssh agent when agent forwarding is enabled.
  • Loading branch information
grampelberg authored Sep 18, 2024
1 parent 4d54f0c commit 9444608
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions russh/src/server/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ pub struct Session {
}
#[derive(Debug)]
pub enum Msg {
ChannelOpenAgent {
channel_ref: ChannelRef,
},
ChannelOpenSession {
channel_ref: ChannelRef,
},
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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);
Expand Down

0 comments on commit 9444608

Please sign in to comment.