Expand description

Asynchronous SSH client library for Rust.

The entry point for making SSH connections is the Client.

Re-exports

pub use self::cipher::CipherAlgo;
pub use self::kex::KexAlgo;
pub use self::mac::MacAlgo;
pub use self::pubkey::PubkeyAlgo;
pub use self::pubkey::Pubkey;
pub use self::pubkey::Privkey;
pub use bytes;
pub use ecdsa;
pub use ecdsa::elliptic_curve;
pub use ed25519_dalek;
pub use p256;
pub use p384;
pub use pem;
pub use rsa;

Modules

Encryption and decryption algorithms.
Various codes from the SSH protocol.
Support for OpenSSH-compatible known_hosts file.
Key exchange algorithms.
Encoding and decoding of keys.
Message authentication algorithms.
Public key algorithms.

Structs

Tell us whether to accept a channel opened by the server (low level API).
Tell us whether the server public key is valid.
Tell us whether to accept a tunnel opened by the server.
Error that occured because we could not negotiate an algorithm.
Message sent by the server when authentication attempt fails.
Prompt that the server sends when asking you to change your password.
Handle to an SSH channel (low level API).
Configuration of a Channel (or a Session).
Error that occured when opening a channel.
Receiving half of a Channel (low level API).
Request on an SSH channel (low level API).
Handle to an SSH connection.
Configuration of a Client.
Future that drives the connection state machine.
Receiving half of a Client.
Error that describes SSH disconnection.
Information about a process that terminated due to a signal.
Global request on an SSH connection (low level API).
Decoding of SSH packets and other payloads (low level API).
Encoding of SSH packets and other payloads (low level API).
Pseudo-terminal request.
Terminal modes for a PtyRequest.
Handle to an SSH session.
Receiving half of a Session.
Future server response to a Session request.
Handle to an SSH tunnel (TCP/IP forwarding channel).
Receiving half of a Tunnel.
Change of terminal window dimensions.

Enums

Result of the “none” authentication method.
Result of the “password” authentication method.
Result of the “publickey” authentication method.
An event returned from ChannelReceiver (low level API).
Reply to a request on an SSH channel (low level API).
An event returned from ClientReceiver.
Type of data sent over an SSH channel (low level API).
Error that occured while handling SSH connection.
Reply to global request on an SSH connection (low level API).
An event returned from SessionReceiver.
An event returned from TunnelReceiver.

Constants

Shorthand for DataType::Standard (low level API).
Shorthand for DataType::Extended(1) (low level API).

Type Definitions

Result type for our Error.