Struct Session

pub struct Session(/* private fields */);

A single SSH session to a remote host.

You can use command to start a new command on the connected machine.

When the Session is dropped, the connection to the remote host is severed, and any errors silently ignored. To disconnect and be alerted to errors, use close.

Implementations

impl Session

pub fn new_native_mux(tempdir: TempDir) -> Self

The method for creating a Session and externally control the creation of TempDir.

By using the built-in SessionBuilder in openssh, or a custom SessionBuilder, create a TempDir.

Examples

use openssh::{Session, Stdio, SessionBuilder};
use openssh_sftp_client::Sftp;

let builder = SessionBuilder::default();
let (builder, destination) = builder.resolve("ssh://jon@ssh.thesquareplanet.com:222");
let tempdir = builder.launch_master(destination).await?;

let session = Session::new_native_mux(tempdir);
let mut child = session
    .subsystem("sftp")
    .stdin(Stdio::piped())
    .stdout(Stdio::piped())
    .spawn()
    .await?;

Sftp::new(
    child.stdin().take().unwrap(),
    child.stdout().take().unwrap(),
    Default::default(),
)
.await?
.close()
.await?;

pub fn resume_mux(ctl: Box<Path>, master_log: Option<Box<Path>>) -> Self

Same as [Session::resume] except that it connects to the ssh multiplex master using native mux impl.

pub async fn connect_mux<S: AsRef<str>>( destination: S, check: KnownHosts, ) -> Result<Self, Error>

Connect to the host at the given host over SSH using native mux impl, which will create a new socket connection for each Child created.

See the crate-level documentation for more details on the difference between native and process-based mux.

The format of destination is the same as the destination argument to ssh. It may be specified as either [user@]hostname or a URI of the form ssh://[user@]hostname[:port].

If connecting requires interactive authentication based on STDIN (such as reading a password), the connection will fail. Consider setting up keypair-based authentication instead.

For more options, see SessionBuilder.

pub async fn check(&self) -> Result<(), Error>

Check the status of the underlying SSH connection.

pub fn control_socket(&self) -> &Path

Get the SSH connection’s control socket path.

pub fn command<'a, S: Into<Cow<'a, str>>>( &self, program: S, ) -> OwningCommand<&Self>

Constructs a new OwningCommand for launching the program at path program on the remote host.

Before it is passed to the remote host, program is escaped so that special characters aren’t evaluated by the remote shell. If you do not want this behavior, use raw_command.

The returned OwningCommand is a builder, with the following default configuration:

• No arguments to the program
• Empty stdin and discard stdout/stderr for spawn or status, but create output pipes for output

Builder methods are provided to change these defaults and otherwise configure the process.

If program is not an absolute path, the PATH will be searched in an OS-defined way on the host.

pub fn raw_command<S: AsRef<OsStr>>(&self, program: S) -> OwningCommand<&Self>

Constructs a new OwningCommand for launching the program at path program on the remote host.

Unlike command, this method does not shell-escape program, so it may be evaluated in unforeseen ways by the remote shell.

The returned OwningCommand is a builder, with the following default configuration:

• No arguments to the program
• Empty stdin and dsicard stdout/stderr for spawn or status, but create output pipes for output

Builder methods are provided to change these defaults and otherwise configure the process.

If program is not an absolute path, the PATH will be searched in an OS-defined way on the host.

pub fn arc_command<'a, P: Into<Cow<'a, str>>>( self: Arc<Session>, program: P, ) -> OwningCommand<Arc<Session>>

Version of command which stores an Arc<Session> instead of a reference, making the resulting OwningCommand independent from the source Session and simplifying lifetime management and concurrent usage:

let session = Arc::new(Session::connect_mux("me@ssh.example.com", KnownHosts::Strict).await?);

let mut log = session.arc_command("less").arg("+F").arg("./some-log-file").spawn().await?;
tokio::spawn(async move {
    // can move the child around
    let mut stdout = log.stdout().take().unwrap();
    let mut buf = vec![0;100];
    loop {
        let n = stdout.read(&mut buf).await?;
        if n == 0 {
            return Ok(())
        }
        println!("read {:?}", &buf[..n]);
    }
});

pub fn arc_raw_command<P: AsRef<OsStr>>( self: Arc<Session>, program: P, ) -> OwningCommand<Arc<Session>>

Version of raw_command which stores an Arc<Session>, similar to arc_command.

pub fn to_command<'a, S, P>(session: S, program: P) -> OwningCommand<S>

where P: Into<Cow<'a, str>>, S: Deref<Target = Session> + Clone,

Version of command which stores an arbitrary shared-ownership smart pointer to a Session, more generic but less convenient than arc_command.

pub fn to_raw_command<S, P>(session: S, program: P) -> OwningCommand<S>

where P: AsRef<OsStr>, S: Deref<Target = Session> + Clone,

Version of raw_command which stores an arbitrary shared-ownership smart pointer to a Session, more generic but less convenient than arc_raw_command.

pub fn subsystem<S: AsRef<OsStr>>(&self, program: S) -> OwningCommand<&Self>

Constructs a new OwningCommand for launching subsystem program on the remote host.

Unlike command, this method does not shell-escape program, so it may be evaluated in unforeseen ways by the remote shell.

The returned OwningCommand is a builder, with the following default configuration:

• No arguments to the program
• Empty stdin and dsicard stdout/stderr for spawn or status, but create output pipes for output

Builder methods are provided to change these defaults and otherwise configure the process.

Sftp subsystem

To use the sftp subsystem, you’ll want to use openssh-sftp-client, then use the following code to construct a sftp instance:

use openssh::{Session, KnownHosts, Stdio};
use openssh_sftp_client::Sftp;

let session = Session::connect_mux("me@ssh.example.com", KnownHosts::Strict).await?;

let mut child = session
    .subsystem("sftp")
    .stdin(Stdio::piped())
    .stdout(Stdio::piped())
    .spawn()
    .await?;

Sftp::new(
    child.stdin().take().unwrap(),
    child.stdout().take().unwrap(),
    Default::default(),
)
.await?
.close()
.await?;

pub fn to_subsystem<S, P>(session: S, program: P) -> OwningCommand<S>

where P: AsRef<OsStr>, S: Deref<Target = Session> + Clone,

Version of subsystem which stores an arbitrary shared-ownership pointer to a session making the resulting OwningCommand independent from the source Session and simplifying lifetime management and concurrent usage:

pub fn shell<S: AsRef<str>>(&self, command: S) -> OwningCommand<&Self>

Constructs a new OwningCommand that runs the provided shell command on the remote host.

The provided command is passed as a single, escaped argument to sh -c, and from that point forward the behavior is up to sh. Since this executes a shell command, keep in mind that you are subject to the shell’s rules around argument parsing, such as whitespace splitting, variable expansion, and other funkyness. I highly recommend you read this article if you observe strange things.

While the returned OwningCommand is a builder, like for command, you should not add additional arguments to it, since the arguments are already passed within the shell command.

Non-standard Remote Shells

It is worth noting that there are really two shells at work here: the one that sshd launches for the session, and that launches are command; and the instance of sh that we launch in that session. This method tries hard to ensure that the provided command is passed exactly as-is to sh, but this is complicated by the presence of the “outer” shell. That outer shell may itself perform argument splitting, variable expansion, and the like, which might produce unintuitive results. For example, the outer shell may try to expand a variable that is only defined in the inner shell, and simply produce an empty string in the variable’s place by the time it gets to sh.

To counter this, this method assumes that the remote shell (the one launched by sshd) is POSIX compliant. This is more or less equivalent to “supports bash syntax” if you don’t look too closely. It uses shell-escape to escape command before sending it to the remote shell, with the expectation that the remote shell will only end up undoing that one “level” of escaping, thus producing the original command as an argument to sh. This works most of the time.

With sufficiently complex or weird commands, the escaping of shell-escape may not fully match the “un-escaping” of the remote shell. This will manifest as escape characters appearing in the sh command that you did not intend to be there. If this happens, try changing the remote shell if you can, or fall back to command and do the escaping manually instead.

pub async fn request_port_forward( &self, forward_type: impl Into<ForwardType>, listen_socket: impl Into<Socket<'_>>, connect_socket: impl Into<Socket<'_>>, ) -> Result<(), Error>

Request to open a local/remote port forwarding. The Socket can be either a unix socket or a tcp socket.

If forward_type == Local, then listen_socket on local machine will be forwarded to connect_socket on remote machine.

Otherwise, listen_socket on the remote machine will be forwarded to connect_socket on the local machine.

pub async fn close_port_forward( &self, forward_type: impl Into<ForwardType>, listen_socket: impl Into<Socket<'_>>, connect_socket: impl Into<Socket<'_>>, ) -> Result<(), Error>

Close a previously established local/remote port forwarding.

The same set of arguments should be passed as when the port forwarding was requested.

pub async fn close(self) -> Result<(), Error>

Terminate the remote connection.

This destructor terminates the ssh multiplex server regardless of how it was created.

pub fn detach(self) -> (Box<Path>, Option<Box<Path>>)

Detach the lifetime of underlying ssh multiplex master from this Session.

Return (path to control socket, path to ssh multiplex output log)

Trait Implementations

impl Debug for Session

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.