1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
#![forbid(unsafe_code)]
use super::{constants, default_config, utils::MaybeOwned, NonZeroByteSlice};
use std::{borrow::Cow, path::Path};
use serde::{Serialize, Serializer};
use typed_builder::TypedBuilder;
#[derive(Copy, Clone, Debug)]
pub(crate) enum Request {
/// Response with `Response::Hello`.
Hello { version: u32 },
/// Server replied with `Response::Alive`.
AliveCheck { request_id: u32 },
/// For opening a new multiplexed session in passenger mode,
/// send this variant and then sends stdin, stdout and stderr fd.
///
/// If successful, the server will reply with `Response::SessionOpened`.
///
/// Otherwise it will reply with an error:
/// - `Response::PermissionDenied`;
/// - `Response::Failure`.
///
/// The client now waits for the session to end. When it does, the server
/// will send `Response::ExitMessage`.
///
/// Two additional cases that the client must cope with are it receiving
/// a signal itself and the server disconnecting without sending an exit message.
///
/// A master may also send a `Response::TtyAllocFail` before
/// `Response::ExitMessage` if remote TTY allocation was unsuccessful.
///
/// The client may use this to return its local tty to "cooked" mode.
NewSession {
request_id: u32,
session: SessionZeroCopy,
},
/// A server may reply with `Response::Ok`, `Response::RemotePort`,
/// `Response::PermissionDenied`, or `Response::Failure`.
///
/// For dynamically allocated listen port the server replies with
/// `Request::RemotePort`.
OpenFwd { request_id: u32, fwd_mode: u32 },
/// A client may request the master to stop accepting new multiplexing requests
/// and remove its listener socket.
///
/// A server may reply with `Response::Ok`, `Response::PermissionDenied` or
/// `Response::Failure`.
StopListening { request_id: u32 },
}
impl Serialize for Request {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
use constants::*;
use Request::*;
match self {
Hello { version } => {
serializer.serialize_newtype_variant("Request", MUX_MSG_HELLO, "Hello", version)
}
AliveCheck { request_id } => serializer.serialize_newtype_variant(
"Request",
MUX_C_ALIVE_CHECK,
"AliveCheck",
request_id,
),
NewSession {
request_id,
session,
} => serializer.serialize_newtype_variant(
"Request",
MUX_C_NEW_SESSION,
"NewSession",
&(*request_id, "", *session),
),
OpenFwd {
request_id,
fwd_mode,
} => serializer.serialize_newtype_variant(
"Request",
MUX_C_OPEN_FWD,
"OpenFwd",
&(*request_id, fwd_mode),
),
StopListening { request_id } => serializer.serialize_newtype_variant(
"Request",
MUX_C_STOP_LISTENING,
"StopListening",
request_id,
),
}
}
}
/// Zero copy version of [`Session`]
#[derive(Copy, Clone, Debug, Serialize)]
pub(crate) struct SessionZeroCopy {
pub tty: bool,
pub x11_forwarding: bool,
pub agent: bool,
pub subsystem: bool,
pub escape_ch: char,
}
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, TypedBuilder)]
#[builder(doc)]
pub struct Session<'a> {
#[builder(default = false)]
pub tty: bool,
#[builder(default = false)]
pub x11_forwarding: bool,
#[builder(default = false)]
pub agent: bool,
#[builder(default = false)]
pub subsystem: bool,
/// Set to `0xffffffff`(`char::MAX`) to disable escape character
#[builder(default = char::MAX)]
pub escape_ch: char,
/// Generally set to `$TERM`.
#[builder(default_code = r#"Cow::Borrowed(default_config::get_term())"#)]
pub term: Cow<'a, NonZeroByteSlice>,
pub cmd: Cow<'a, NonZeroByteSlice>,
}
#[derive(Copy, Clone, Debug)]
pub enum Fwd<'a> {
Local {
listen_socket: &'a Socket<'a>,
connect_socket: &'a Socket<'a>,
},
Remote {
listen_socket: &'a Socket<'a>,
connect_socket: &'a Socket<'a>,
},
Dynamic {
listen_socket: &'a Socket<'a>,
},
}
impl<'a> Fwd<'a> {
pub(crate) fn as_serializable(&self) -> (u32, &'a Socket<'a>, MaybeOwned<'a, Socket<'a>>) {
use Fwd::*;
match *self {
Local {
listen_socket,
connect_socket,
} => (
constants::MUX_FWD_LOCAL,
listen_socket,
MaybeOwned::Borrowed(connect_socket),
),
Remote {
listen_socket,
connect_socket,
} => (
constants::MUX_FWD_REMOTE,
listen_socket,
MaybeOwned::Borrowed(connect_socket),
),
Dynamic { listen_socket } => (
constants::MUX_FWD_DYNAMIC,
listen_socket,
MaybeOwned::Owned(Socket::UnixSocket {
path: Path::new("").into(),
}),
),
}
}
}
impl<'a> Serialize for Fwd<'a> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
self.as_serializable().serialize(serializer)
}
}
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub enum Socket<'a> {
UnixSocket { path: Cow<'a, Path> },
TcpSocket { port: u32, host: Cow<'a, str> },
}
impl Socket<'_> {
pub(crate) fn as_serializable(&self) -> (Cow<'_, str>, u32) {
use Socket::*;
let unix_socket_port: i32 = -2;
match self {
// Serialize impl for Path calls to_str and ret err if failed,
// so calling to_string_lossy is OK as it does not break backward
// compatibility.
UnixSocket { path } => (path.to_string_lossy(), unix_socket_port as u32),
TcpSocket { port, host } => (Cow::Borrowed(host), *port),
}
}
}
impl<'a> Serialize for Socket<'a> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
self.as_serializable().serialize(serializer)
}
}