Struct Session

pub struct Session { /* private fields */ }

See Session.

Implementations

impl Session

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

See new.

pub async fn set_banner(&self, banner: &str) -> Result<(), Error>

See set_banner.

pub fn set_allow_sigpipe(&self, block: bool)

See set_allow_sigpipe.

pub fn set_compress(&self, compress: bool)

See set_allow_sigpipe.

pub fn is_blocking(&self) -> bool

See is_blocking.

pub fn set_timeout(&self, timeout_ms: u32)

See set_timeout.

pub fn timeout(&self) -> u32

See timeout.

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

See handshake.

pub fn set_tcp_stream(&mut self, stream: Async<TcpStream>) -> Result<(), Error>

Sets the tcp stream for the underlying ssh2 lib.

use async_ssh2::Session;
use std::net::TcpStream;
use smol::Async;

#[tokio::main]
async fn main() {
    let stream = Async::<TcpStream>::connect("127.0.0.1:22").await.unwrap();
    let mut sess = async_ssh2::Session::new().unwrap();
    sess.set_tcp_stream(stream).unwrap();
}

pub async fn userauth_password( &self, username: &str, password: &str, ) -> Result<(), Error>

See userauth_password.

pub fn userauth_keyboard_interactive<P: KeyboardInteractivePrompt>( &self, _username: &str, _prompter: &mut P, ) -> Result<(), Error>

See userauth_keyboard_interactive.

pub async fn userauth_agent(&self, username: &str) -> Result<(), Error>

See userauth_agent.

pub async fn userauth_pubkey_file( &self, username: &str, pubkey: Option<&Path>, privatekey: &Path, passphrase: Option<&str>, ) -> Result<(), Error>

See userauth_pubkey_file.

pub async fn userauth_pubkey_memory( &self, username: &str, pubkeydata: Option<&str>, privatekeydata: &str, passphrase: Option<&str>, ) -> Result<(), Error>

See userauth_pubkey_memory.

pub async fn userauth_hostbased_file( &self, username: &str, publickey: &Path, privatekey: &Path, passphrase: Option<&str>, hostname: &str, local_username: Option<&str>, ) -> Result<(), Error>

See userauth_hostbased_file.

pub fn authenticated(&self) -> bool

See authenticated.

pub async fn auth_methods(&self, username: &str) -> Result<&str, Error>

See auth_methods.

pub fn method_pref( &self, method_type: MethodType, prefs: &str, ) -> Result<(), Error>

See method_pref.

pub fn methods(&self, method_type: MethodType) -> Option<&str>

See methods.

pub fn supported_algs( &self, method_type: MethodType, ) -> Result<Vec<&'static str>, Error>

See supported_algs.

pub fn agent(&self) -> Result<Agent, Error>

See agent.

pub fn known_hosts(&self) -> Result<KnownHosts, Error>

See known_hosts.

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

See channel_session.

pub async fn channel_direct_tcpip( &self, host: &str, port: u16, src: Option<(&str, u16)>, ) -> Result<Channel, Error>

See channel_direct_tcpip.

pub async fn channel_forward_listen( &self, remote_port: u16, host: Option<&str>, queue_maxsize: Option<u32>, ) -> Result<(Listener, u16), Error>

See channel_forward_listen.

pub async fn scp_recv( &self, path: &Path, ) -> Result<(Channel, ScpFileStat), Error>

See scp_recv.

pub async fn scp_send( &self, remote_path: &Path, mode: i32, size: u64, times: Option<(u64, u64)>, ) -> Result<Channel, Error>

See scp_send.

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

See sftp.

pub async fn channel_open( &self, channel_type: &str, window_size: u32, packet_size: u32, message: Option<&str>, ) -> Result<Channel, Error>

See channel_open.

pub fn banner(&self) -> Option<&str>

See banner.

pub fn banner_bytes(&self) -> Option<&[u8]>

See banner_bytes.

pub fn host_key(&self) -> Option<(&[u8], HostKeyType)>

See host_key.

pub fn host_key_hash(&self, hash: HashType) -> Option<&[u8]>

See host_key_hash.

pub fn set_keepalive(&self, want_reply: bool, interval: u32)

See set_keepalive.

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

See keepalive_send.

pub async fn disconnect( &self, reason: Option<DisconnectCode>, description: &str, lang: Option<&str>, ) -> Result<(), Error>

See disconnect.

Trait Implementations

impl AsRawFd for Session

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.