1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
//! Rust bindings to libssh2, an SSH client library. //! //! This library intends to provide a safe interface to the libssh2 library. It //! will build the library if it's not available on the local system, and //! otherwise link to an installed copy. //! //! Note that libssh2 only supports SSH *clients*, not SSH *servers*. //! Additionally it only supports protocol v2, not protocol v1. //! //! # Examples //! //! ## Inspecting ssh-agent //! //! ```no_run //! use ssh2::Session; //! //! // Almost all APIs require a `Session` to be available //! let sess = Session::new().unwrap(); //! let mut agent = sess.agent().unwrap(); //! //! // Connect the agent and request a list of identities //! agent.connect().unwrap(); //! agent.list_identities().unwrap(); //! //! for identity in agent.identities().unwrap() { //! println!("{}", identity.comment()); //! let pubkey = identity.blob(); //! } //! ``` //! //! ## Authenticating with ssh-agent //! //! ```no_run //! use std::net::TcpStream; //! use ssh2::Session; //! //! // Connect to the local SSH server //! let tcp = TcpStream::connect("127.0.0.1:22").unwrap(); //! let mut sess = Session::new().unwrap(); //! sess.set_tcp_stream(tcp); //! sess.handshake().unwrap(); //! //! // Try to authenticate with the first identity in the agent. //! sess.userauth_agent("username").unwrap(); //! //! // Make sure we succeeded //! assert!(sess.authenticated()); //! ``` //! //! ## Authenticating with a password //! //! ```no_run //! use std::net::TcpStream; //! use ssh2::Session; //! //! // Connect to the local SSH server //! let tcp = TcpStream::connect("127.0.0.1:22").unwrap(); //! let mut sess = Session::new().unwrap(); //! sess.set_tcp_stream(tcp); //! sess.handshake().unwrap(); //! //! sess.userauth_password("username", "password").unwrap(); //! assert!(sess.authenticated()); //! ``` //! //! ## Run a command //! //! ```no_run //! use std::io::prelude::*; //! use std::net::{TcpStream}; //! use ssh2::Session; //! //! // Connect to the local SSH server //! let tcp = TcpStream::connect("127.0.0.1:22").unwrap(); //! let mut sess = Session::new().unwrap(); //! sess.set_tcp_stream(tcp); //! sess.handshake().unwrap(); //! sess.userauth_agent("username").unwrap(); //! //! let mut channel = sess.channel_session().unwrap(); //! channel.exec("ls").unwrap(); //! let mut s = String::new(); //! channel.read_to_string(&mut s).unwrap(); //! println!("{}", s); //! channel.wait_close(); //! println!("{}", channel.exit_status().unwrap()); //! ``` //! //! ## Upload a file //! //! ```no_run //! use std::io::prelude::*; //! use std::net::TcpStream; //! use std::path::Path; //! use ssh2::Session; //! //! // Connect to the local SSH server //! let tcp = TcpStream::connect("127.0.0.1:22").unwrap(); //! let mut sess = Session::new().unwrap(); //! sess.set_tcp_stream(tcp); //! sess.handshake().unwrap(); //! sess.userauth_agent("username").unwrap(); //! //! let mut remote_file = sess.scp_send(Path::new("remote"), //! 0o644, 10, None).unwrap(); //! remote_file.write(b"1234567890").unwrap(); //! ``` //! //! ## Download a file //! //! ```no_run //! use std::io::prelude::*; //! use std::net::TcpStream; //! use std::path::Path; //! use ssh2::Session; //! //! // Connect to the local SSH server //! let tcp = TcpStream::connect("127.0.0.1:22").unwrap(); //! let mut sess = Session::new().unwrap(); //! sess.set_tcp_stream(tcp); //! sess.handshake().unwrap(); //! sess.userauth_agent("username").unwrap(); //! //! let (mut remote_file, stat) = sess.scp_recv(Path::new("remote")).unwrap(); //! println!("remote file size: {}", stat.size()); //! let mut contents = Vec::new(); //! remote_file.read_to_end(&mut contents).unwrap(); //! // ... //! ``` #![doc(html_root_url = "https://docs.rs/ssh2")] #![allow(trivial_numeric_casts)] #![deny(missing_docs, unused_results)] #![cfg_attr(test, deny(warnings))] extern crate libc; extern crate libssh2_sys as raw; #[macro_use] extern crate bitflags; extern crate parking_lot; use std::ffi::CStr; pub use agent::{Agent, PublicKey}; pub use channel::{Channel, ExitSignal, ReadWindow, Stream, WriteWindow}; pub use error::Error; pub use knownhosts::{Host, KnownHosts}; pub use listener::Listener; use session::SessionInner; pub use session::{BlockDirections, KeyboardInteractivePrompt, Prompt, ScpFileStat, Session}; pub use sftp::{File, FileStat, FileType, OpenType}; pub use sftp::{OpenFlags, RenameFlags, Sftp}; pub use DisconnectCode::{AuthCancelledByUser, TooManyConnections}; pub use DisconnectCode::{ByApplication, ConnectionLost, HostKeyNotVerifiable}; pub use DisconnectCode::{CompressionError, KeyExchangeFailed, MacError, Reserved}; pub use DisconnectCode::{HostNotAllowedToConnect, ProtocolError}; pub use DisconnectCode::{IllegalUserName, NoMoreAuthMethodsAvailable}; pub use DisconnectCode::{ProtocolVersionNotSupported, ServiceNotAvailable}; mod agent; mod channel; mod error; mod knownhosts; mod listener; mod session; mod sftp; mod util; /// Initialize the libssh2 library. /// /// This is optional, it is lazily invoked. pub fn init() { raw::init(); } unsafe fn opt_bytes<'a, T>(_: &'a T, c: *const libc::c_char) -> Option<&'a [u8]> { if c.is_null() { None } else { Some(CStr::from_ptr(c).to_bytes()) } } #[allow(missing_docs)] #[derive(Copy, Clone)] pub enum DisconnectCode { HostNotAllowedToConnect = raw::SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT as isize, ProtocolError = raw::SSH_DISCONNECT_PROTOCOL_ERROR as isize, KeyExchangeFailed = raw::SSH_DISCONNECT_KEY_EXCHANGE_FAILED as isize, Reserved = raw::SSH_DISCONNECT_RESERVED as isize, MacError = raw::SSH_DISCONNECT_MAC_ERROR as isize, CompressionError = raw::SSH_DISCONNECT_COMPRESSION_ERROR as isize, ServiceNotAvailable = raw::SSH_DISCONNECT_SERVICE_NOT_AVAILABLE as isize, ProtocolVersionNotSupported = raw::SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED as isize, HostKeyNotVerifiable = raw::SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE as isize, ConnectionLost = raw::SSH_DISCONNECT_CONNECTION_LOST as isize, ByApplication = raw::SSH_DISCONNECT_BY_APPLICATION as isize, TooManyConnections = raw::SSH_DISCONNECT_TOO_MANY_CONNECTIONS as isize, AuthCancelledByUser = raw::SSH_DISCONNECT_AUTH_CANCELLED_BY_USER as isize, NoMoreAuthMethodsAvailable = raw::SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE as isize, IllegalUserName = raw::SSH_DISCONNECT_ILLEGAL_USER_NAME as isize, } #[allow(missing_docs)] #[derive(Copy, Clone, Debug)] pub enum HostKeyType { Unknown = raw::LIBSSH2_HOSTKEY_TYPE_UNKNOWN as isize, Rsa = raw::LIBSSH2_HOSTKEY_TYPE_RSA as isize, Dss = raw::LIBSSH2_HOSTKEY_TYPE_DSS as isize, Ecdsa256 = raw::LIBSSH2_HOSTKEY_TYPE_ECDSA_256 as isize, Ecdsa384 = raw::LIBSSH2_HOSTKEY_TYPE_ECDSA_384 as isize, Ecdsa521 = raw::LIBSSH2_HOSTKEY_TYPE_ECDSA_521 as isize, Ed255219 = raw::LIBSSH2_HOSTKEY_TYPE_ED25519 as isize, } #[allow(missing_docs)] #[derive(Copy, Clone)] pub enum MethodType { Kex = raw::LIBSSH2_METHOD_KEX as isize, HostKey = raw::LIBSSH2_METHOD_HOSTKEY as isize, CryptCs = raw::LIBSSH2_METHOD_CRYPT_CS as isize, CryptSc = raw::LIBSSH2_METHOD_CRYPT_SC as isize, MacCs = raw::LIBSSH2_METHOD_MAC_CS as isize, MacSc = raw::LIBSSH2_METHOD_MAC_SC as isize, CompCs = raw::LIBSSH2_METHOD_COMP_CS as isize, CompSc = raw::LIBSSH2_METHOD_COMP_SC as isize, LangCs = raw::LIBSSH2_METHOD_LANG_CS as isize, LangSc = raw::LIBSSH2_METHOD_LANG_SC as isize, } /// When passed to `Channel::flush_stream`, flushes all extended data /// substreams. pub static FLUSH_EXTENDED_DATA: i32 = -1; /// When passed to `Channel::flush_stream`, flushes all substream. pub static FLUSH_ALL: i32 = -2; /// Stream ID of the stderr channel for stream-related methods on `Channel` pub static EXTENDED_DATA_STDERR: i32 = 1; #[allow(missing_docs)] #[derive(Copy, Clone, Debug)] pub enum HashType { Md5 = raw::LIBSSH2_HOSTKEY_HASH_MD5 as isize, Sha1 = raw::LIBSSH2_HOSTKEY_HASH_SHA1 as isize, Sha256 = raw::LIBSSH2_HOSTKEY_HASH_SHA256 as isize, } #[allow(missing_docs)] #[derive(Copy, Clone, Debug)] pub enum KnownHostFileKind { OpenSSH = raw::LIBSSH2_KNOWNHOST_FILE_OPENSSH as isize, } /// Possible results of a call to `KnownHosts::check` #[derive(Copy, Clone, Debug)] pub enum CheckResult { /// Hosts and keys match Match = raw::LIBSSH2_KNOWNHOST_CHECK_MATCH as isize, /// Host was found, but the keys didn't match! Mismatch = raw::LIBSSH2_KNOWNHOST_CHECK_MISMATCH as isize, /// No host match was found NotFound = raw::LIBSSH2_KNOWNHOST_CHECK_NOTFOUND as isize, /// Something prevented the check to be made Failure = raw::LIBSSH2_KNOWNHOST_CHECK_FAILURE as isize, } #[allow(missing_docs)] #[derive(Copy, Clone, Debug)] pub enum KnownHostKeyFormat { Unknown = raw::LIBSSH2_KNOWNHOST_KEY_UNKNOWN as isize, Rsa1 = raw::LIBSSH2_KNOWNHOST_KEY_RSA1 as isize, SshRsa = raw::LIBSSH2_KNOWNHOST_KEY_SSHRSA as isize, SshDss = raw::LIBSSH2_KNOWNHOST_KEY_SSHDSS as isize, Ecdsa256 = raw::LIBSSH2_KNOWNHOST_KEY_ECDSA_256 as isize, Ecdsa384 = raw::LIBSSH2_KNOWNHOST_KEY_ECDSA_384 as isize, Ecdsa521 = raw::LIBSSH2_KNOWNHOST_KEY_ECDSA_521 as isize, Ed255219 = raw::LIBSSH2_KNOWNHOST_KEY_ED25519 as isize, } impl From<HostKeyType> for KnownHostKeyFormat { fn from(host_type: HostKeyType) -> KnownHostKeyFormat { match host_type { HostKeyType::Unknown => KnownHostKeyFormat::Unknown, HostKeyType::Rsa => KnownHostKeyFormat::SshRsa, HostKeyType::Dss => KnownHostKeyFormat::SshDss, HostKeyType::Ecdsa256 => KnownHostKeyFormat::Ecdsa256, HostKeyType::Ecdsa384 => KnownHostKeyFormat::Ecdsa384, HostKeyType::Ecdsa521 => KnownHostKeyFormat::Ecdsa521, HostKeyType::Ed255219 => KnownHostKeyFormat::Ed255219, } } } /// How to handle extended data streams, such as stderr #[derive(Copy, Clone, Debug)] pub enum ExtendedData { /// Queue extended data for eventual reading Normal = raw::LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL as isize, /// Treat extended data and ordinary data the same. Merge all substreams such that calls to /// read will pull from all substreams on a first-in/first-out basis. Merge = raw::LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE as isize, /// Discard all extended data as it arrives. Ignore = raw::LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE as isize, } /// The modes described in <https://tools.ietf.org/html/rfc4250#section-4.5.2> #[allow(non_camel_case_types)] #[derive(Debug, Clone, Copy, Eq, PartialEq)] pub enum PtyModeOpcode { /// Indicates end of options. TTY_OP_END = 0, /// Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems. VINTR = 1, /// The quit character (sends SIGQUIT signal on POSIX systems). VQUIT = 2, /// Erase the character to left of the cursor. VERASE = 3, /// Kill the current input line. VKILL = 4, /// End-of-file character (sends EOF from the terminal). VEOF = 5, /// End-of-line character in addition to carriage return and/or linefeed. VEOL = 6, /// Additional end-of-line character. VEOL2 = 7, /// Continues paused output (normally control-Q). VSTART = 8, /// Pauses output (normally control-S). VSTOP = 9, /// Suspends the current program. VSUSP = 10, /// Another suspend character. VDSUSP = 11, /// Reprints the current input line. VREPRINT = 12, /// Erases a word left of cursor. VWERASE = 13, /// Enter the next character typed literally, even if it is a special character VLNEXT = 14, /// Character to flush output. VFLUSH = 15, /// Switch to a different shell layer. VSWTCH = 16, /// Prints system status line (load, command, pid, etc). VSTATUS = 17, /// Toggles the flushing of terminal output. VDISCARD = 18, /// The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE. IGNPAR = 30, /// Mark parity and framing errors. PARMRK = 31, /// Enable checking of parity errors. INPCK = 32, /// Strip 8th bit off characters. ISTRIP = 33, /// Map NL into CR on input. INLCR = 34, /// Ignore CR on input. IGNCR = 35, /// Map CR to NL on input. ICRNL = 36, /// Translate uppercase characters to lowercase. IUCLC = 37, /// Enable output flow control. IXON = 38, /// Any char will restart after stop. IXANY = 39, /// Enable input flow control. IXOFF = 49, /// Ring bell on input queue full. IMAXBEL = 41, /// Enable signals INTR, QUIT, [D]SUSP. ISIG = 50, /// Canonicalize input lines. ICANON = 51, /// Enable input and output of uppercase characters by preceding their lowercase equivalents with "\". XCASE = 52, /// Enable echoing. ECHO = 53, /// Visually erase chars. ECHOE = 54, /// Kill character discards current line. ECHOK = 55, /// Echo NL even if ECHO is off. ECHONL = 56, /// Don't flush after interrupt. NOFLSH = 57, /// Stop background jobs from output. TOSTOP = 58, /// Enable extensions. IEXTEN = 59, /// Echo control characters as ^(Char). ECHOCTL = 60, /// Visual erase for line kill. ECHOKE = 61, /// Retype pending input. PENDIN = 62, /// Enable output processing. OPOST = 70, /// Convert lowercase to uppercase. OLCUC = 71, /// Map NL to CR-NL. ONLCR = 72, /// Translate carriage return to newline (output). OCRNL = 73, /// Translate newline to carriage return-newline (output). ONOCR = 74, /// Newline performs a carriage return (output). ONLRET = 75, /// 7 bit mode. CS7 = 90, /// 8 bit mode. CS8 = 91, /// Parity enable. PARENB = 92, /// Odd parity, else even. PARODD = 93, /// Specifies the input baud rate in bits per second. TTY_OP_ISPEED = 128, /// Specifies the output baud rate in bits per second. TTY_OP_OSPEED = 129, } /// An opcode for setting a Pty terminal mode #[derive(Debug, Clone, Copy, Eq, PartialEq)] pub enum ExtensiblePtyModeOpcode { /// Use one of the modes specified by RFC 4250 Mode(PtyModeOpcode), /// Use a mode not reflected by RFC 4250 Extended(u8), } impl From<PtyModeOpcode> for ExtensiblePtyModeOpcode { fn from(op: PtyModeOpcode) -> ExtensiblePtyModeOpcode { ExtensiblePtyModeOpcode::Mode(op) } } impl From<u8> for ExtensiblePtyModeOpcode { fn from(op: u8) -> ExtensiblePtyModeOpcode { ExtensiblePtyModeOpcode::Extended(op) } } impl ExtensiblePtyModeOpcode { fn as_opcode(&self) -> u8 { match self { ExtensiblePtyModeOpcode::Mode(m) => *m as u8, ExtensiblePtyModeOpcode::Extended(op) => *op, } } } /// Encodes modes for Pty allocation requests. /// The modes documented in <https://tools.ietf.org/html/rfc4250#section-4.5> /// are supported. #[derive(Debug, Clone)] pub struct PtyModes { data: Vec<u8>, } impl PtyModes { /// Construct a PtyModes instance so that you can specify values for /// various modes pub fn new() -> Self { Self { data: vec![] } } /// Set a mode to an arbitrary u32 value pub fn set_u32<O: Into<ExtensiblePtyModeOpcode>>(&mut self, option: O, value: u32) { let data = [ option.into().as_opcode(), ((value >> 24) & 0xff) as u8, ((value >> 16) & 0xff) as u8, ((value >> 8) & 0xff) as u8, (value & 0xff) as u8, ]; self.data.extend_from_slice(&data); } /// Set a mode to a boolean value pub fn set_boolean<O: Into<ExtensiblePtyModeOpcode>>(&mut self, option: O, value: bool) { self.set_u32(option, if value { 1 } else { 0 }) } /// Set a mode to a character value. /// If the character is None it is set to 255 to indicate that it /// is disabled. /// While this interface and the protocol accept unicode characters /// of up to 32 bits in width, these options likely only work for /// characters in the 7-bit ascii range. pub fn set_character<O: Into<ExtensiblePtyModeOpcode>>(&mut self, option: O, c: Option<char>) { self.set_u32(option, c.map(|c| c as u32).unwrap_or(255)) } /// Finish accumulating modes and return the encoded /// byte stream suitable for use in the ssh2 protocol pub fn finish(mut self) -> Vec<u8> { self.data.push(PtyModeOpcode::TTY_OP_END as u8); self.data } }