Struct Session

pub struct Session { /* private fields */ }

Implementations

impl Session

pub fn new() -> Result<Session, ()>

pub fn set_host(&mut self, v: &str) -> Result<(), Error>

pub fn set_port(&mut self, v: usize) -> Result<(), Error>

pub fn set_username(&mut self, v: &str) -> Result<(), Error>

pub fn set_ssh_dir<P: AsRef<Path>>(&mut self, v: P) -> Result<(), Error>

Set the location of the “.ssh” directory, where the config file and keys can be found (it may include “%s”, which will be replaced by the user home directory).

pub fn set_knownhosts<P: AsRef<Path>>(&mut self, v: P) -> Result<(), Error>

Set the location of the “knownhosts” file (it may include “%s”, which will be replaced by the user home directory).

pub fn set_identity<P: AsRef<Path>>(&mut self, v: P) -> Result<(), Error>

Set the location of the key to be used for authentication (it may include “%s”, which will be replaced by the user home directory).

pub fn set_ssh1(&mut self, v: bool) -> Result<(), Error>

Allow version 1 of the protocol (default unspecified).

pub fn set_ssh2(&mut self, v: bool) -> Result<(), Error>

Allow version 1 of the protocol (default unspecified).

pub fn parse_config(&mut self, path: Option<&Path>) -> Result<(), Error>

Parse configuration file. If the path is None, then ~/.ssh/config is read.

pub fn is_server_known(&mut self) -> Result<ServerKnown, Error>

Check whether the remote server’s key is known.

pub fn write_knownhost(&mut self) -> Result<(), Error>

Accept the remote server’s key.

pub fn get_pubkey_hash(&mut self) -> Result<Vec<u8>, Error>

Get a hash of the server’s public key

pub fn connect(&mut self) -> Result<(), Error>

pub fn disconnect(&mut self) -> Result<(), Error>

Disconnect the session. The session can be reused later to open a new session.

pub fn userauth_password(&mut self, p: &str) -> Result<(), Error>

Authenticate with a password.

pub fn userauth_kbdint(&mut self, user: Option<&str>) -> Result<(), Error>

Print a prompt on the standard output, and then ask the user a password on the standard input. The typed password is not echoed.

pub fn userauth_publickey_auto(&mut self, p: Option<&str>) -> Result<(), Error>

Print a prompt on the standard output, and then ask the user a password on the standard input. The typed password is not echoed.

pub fn scp_new<'b, P: AsRef<Path>>( &'b mut self, mode: Mode, v: P, ) -> Result<Scp<'b>, Error>

Start an SCP connection.

pub fn channel_new<'b>(&'b mut self) -> Result<Channel<'b>, Error>

Start a channel to issue remote commands.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Drop for Session

fn drop(&mut self)

Executes the destructor for this type.