Crate makiko

Asynchronous SSH client library in pure Rust.

You may want to read the tutorial to get started with Makiko.

• Entry point for making SSH connections is the Client.
• Functions for decoding keys are in the keys module.
• Support for the known_hosts file is in the host_file module.

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

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

Structs

• AcceptChannel
  Tell us whether to accept a channel opened by the server (low level API).
• AcceptPubkey
  Tell us whether the server public key is valid.
• AcceptTunnel
  Tell us whether to accept a tunnel opened by the server.
• AlgoNegotiateError
  Error that occured because we could not negotiate an algorithm.
• AuthBanner
  Banner message sent by the SSH server.
• AuthFailure
  Message sent by the server when authentication attempt fails.
• AuthPasswordPrompt
  Prompt that the server sends when asking you to change your password.
• Channel
  Handle to an SSH channel (low level API).
• ChannelConfig
  Configuration of a Channel (or a Session).
• ChannelOpenError
  Error that occured when opening a channel.
• ChannelReceiver
  Receiving half of a Channel (low level API).
• ChannelReq
  Request on an SSH channel (low level API).
• Client
  Handle to an SSH connection.
• ClientConfig
  Configuration of a Client.
• ClientFuture
  Future that drives the connection state machine.
• ClientReceiver
  Receiving half of a Client.
• ClientResp
  Future server response to a global request.
• DebugMsg
  Debugging message sent by the SSH server.
• DisconnectError
  Error that describes SSH disconnection.
• ExitSignal
  Information about a process that terminated due to a signal.
• GlobalReq
  Global request on an SSH connection (low level API).
• PacketDecode
  Decoding of SSH packets and other payloads (low level API).
• PacketEncode
  Encoding of SSH packets and other payloads (low level API).
• PtyRequest
  Pseudo-terminal request.
• PtyTerminalModes
  Terminal modes for a PtyRequest.
• Session
  Handle to an SSH session.
• SessionReceiver
  Receiving half of a Session.
• SessionResp
  Future server response to a Session request.
• Tunnel
  Handle to an SSH tunnel (TCP/IP forwarding channel).
• TunnelReceiver
  Receiving half of a Tunnel.
• WindowChange
  Change of terminal window dimensions.

Enums

• AuthNoneResult
  Result of the “none” authentication method.
• AuthPasswordResult
  Result of the “password” authentication method.
• AuthPubkeyResult
  Result of the “publickey” authentication method.
• ChannelEvent
  An event returned from ChannelReceiver (low level API).
• ChannelReply
  Reply to a request on an SSH channel (low level API).
• ClientEvent
  An event returned from ClientReceiver.
• DataType
  Type of data sent over an SSH channel (low level API).
• Error
  Error that occured while handling SSH connection.
• GlobalReply
  Reply to global request on an SSH connection (low level API).
• SessionEvent
  An event returned from SessionReceiver.
• TunnelEvent
  An event returned from TunnelReceiver.

Constants

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

Type Definitions

• Result
  Result type for our Error.