Table of Contents - net-ssh-2.6.2 Documentation
Pages
README
Net::SSH
DESCRIPTION:
FEATURES:
SYNOPSIS:
REQUIREMENTS:
INSTALL:
RUBY 1.8 SUPPORT
JRUBY 1.6
ARCFOUR SUPPORT:
RUNNING TESTS
EXPECTED RESULTS
PORT FORWARDING TESTS
LICENSE:
Classes/Modules
Net
Net::SSH
"Um, all I want to do is X, just show me how!"
X == "execute a command and capture the output"
X == "forward connections on a local port to a remote host"
X == "forward connections on a remote port to the local host"
Net::SSH::Authentication
Net::SSH::Authentication::Agent
Net::SSH::Authentication::Agent::Comment
Net::SSH::Authentication::AgentError
Net::SSH::Authentication::AgentNotAvailable
Net::SSH::Authentication::Constants
Net::SSH::Authentication::DisallowedMethod
Net::SSH::Authentication::KeyManager
Net::SSH::Authentication::KeyManagerError
Net::SSH::Authentication::Methods
Net::SSH::Authentication::Methods::Abstract
Net::SSH::Authentication::Methods::Hostbased
Net::SSH::Authentication::Methods::KeyboardInteractive
Net::SSH::Authentication::Methods::Password
Net::SSH::Authentication::Methods::Publickey
Net::SSH::Authentication::Session
Net::SSH::AuthenticationFailed
Net::SSH::Buffer
Net::SSH::ChannelOpenFailed
Net::SSH::ChannelRequestFailed
Net::SSH::Compat
Net::SSH::Config
Net::SSH::Connection
Net::SSH::Connection::Channel
Net::SSH::Connection::Constants
Net::SSH::Connection::Session
Net::SSH::Connection::Session::NilChannel
Net::SSH::Connection::Term
Net::SSH::ConnectionTimeout
Net::SSH::Disconnect
Net::SSH::Exception
Net::SSH::HostKeyError
Net::SSH::HostKeyMismatch
Net::SSH::HostKeyUnknown
Net::SSH::KeyFactory
Net::SSH::KnownHosts
Net::SSH::Loggable
Net::SSH::Packet
Net::SSH::PromptMethods
Net::SSH::PromptMethods::Clear
Net::SSH::PromptMethods::Highline
Net::SSH::PromptMethods::Termios
Net::SSH::Proxy
Net::SSH::Proxy::Command
Net::SSH::Proxy::ConnectError
Net::SSH::Proxy::Error
Net::SSH::Proxy::HTTP
Net::SSH::Proxy::SOCKS4
Net::SSH::Proxy::SOCKS5
Net::SSH::Proxy::UnauthorizedError
Net::SSH::Test
Net::SSH::Test::Channel
Net::SSH::Test::Extensions
Net::SSH::Test::Extensions::BufferedIo
Net::SSH::Test::Extensions::Channel
Net::SSH::Test::Extensions::IO
Net::SSH::Test::Extensions::IO::ClassMethods
Net::SSH::Test::Extensions::PacketStream
Net::SSH::Test::Kex
Net::SSH::Test::LocalPacket
Net::SSH::Test::Packet
Net::SSH::Test::RemotePacket
Net::SSH::Test::Script
Net::SSH::Test::Socket
Net::SSH::Transport
Net::SSH::Transport::Algorithms
Net::SSH::Transport::CTR
Net::SSH::Transport::CipherFactory
Net::SSH::Transport::Constants
Net::SSH::Transport::HMAC
Net::SSH::Transport::HMAC::Abstract
Net::SSH::Transport::HMAC::MD5
Net::SSH::Transport::HMAC::MD5_96
Net::SSH::Transport::HMAC::None
Net::SSH::Transport::HMAC::RIPEMD160
Net::SSH::Transport::HMAC::SHA1
Net::SSH::Transport::HMAC::SHA1_96
Net::SSH::Transport::HMAC::SHA2_256
Net::SSH::Transport::HMAC::SHA2_256_96
Net::SSH::Transport::HMAC::SHA2_512
Net::SSH::Transport::HMAC::SHA2_512_96
Net::SSH::Transport::IdentityCipher
Net::SSH::Transport::Kex
Net::SSH::Transport::Kex::DiffieHellmanGroup14SHA1
Net::SSH::Transport::Kex::DiffieHellmanGroup1SHA1
Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA1
Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA256
Net::SSH::Transport::Kex::EcdhSHA2NistP256
Net::SSH::Transport::Kex::EcdhSHA2NistP384
Net::SSH::Transport::Kex::EcdhSHA2NistP521
Net::SSH::Transport::KeyExpander
Net::SSH::Transport::PacketStream
Net::SSH::Transport::ServerVersion
Net::SSH::Transport::Session
Net::SSH::Transport::State
Net::SSH::Verifiers
Net::SSH::Verifiers::Lenient
Net::SSH::Verifiers::Null
Net::SSH::Verifiers::Secure
Net::SSH::Verifiers::Strict
Net::SSH::Version
OpenSSL
OpenSSL::BN
OpenSSL::PKey
OpenSSL::PKey::DH
OpenSSL::PKey::DSA
OpenSSL::PKey::EC
OpenSSL::PKey::OpenSSL
OpenSSL::PKey::OpenSSL::PKey
OpenSSL::PKey::OpenSSL::PKey::OpenSSL
OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey
OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey::ECError
OpenSSL::PKey::PKey
OpenSSL::PKey::RSA
String
Methods
::[] — Net::SSH::Version
::add — Net::SSH::KnownHosts
::allowed_packet? — Net::SSH::Transport::Algorithms
::block_size — Net::SSH::Transport::IdentityCipher
::configuration_for — Net::SSH
::connect — Net::SSH::Authentication::Agent
::decrypt — Net::SSH::Transport::IdentityCipher
::default_files — Net::SSH::Config
::digest_class — Net::SSH::Transport::HMAC::Abstract
::encrypt — Net::SSH::Transport::IdentityCipher
::expand_key — Net::SSH::Transport::KeyExpander
::extended — Net::SSH::Transport::PacketStream
::extended — Net::SSH::Transport::CTR
::final — Net::SSH::Transport::IdentityCipher
::for — Net::SSH::Config
::from — Net::SSH::Buffer
::get — Net::SSH::Transport::HMAC
::get — Net::SSH::KeyFactory
::get — Net::SSH::Transport::CipherFactory
::get_lengths — Net::SSH::Transport::CipherFactory
::hostfiles — Net::SSH::KnownHosts
::io_select — Net::SSH::Compat
::iv= — Net::SSH::Transport::IdentityCipher
::iv_len — Net::SSH::Transport::IdentityCipher
::key_length — Net::SSH::Transport::HMAC::Abstract
::key_length — Net::SSH::Transport::HMAC
::load — Net::SSH::Config
::load_data_private_key — Net::SSH::KeyFactory
::load_data_public_key — Net::SSH::KeyFactory
::load_private_key — Net::SSH::KeyFactory
::load_public_key — Net::SSH::KeyFactory
::mac_length — Net::SSH::Transport::HMAC::Abstract
::name — Net::SSH::Transport::IdentityCipher
::new — Net::SSH::Test::Script
::new — Net::SSH::Authentication::KeyManager
::new — Net::SSH::Transport::Algorithms
::new — Net::SSH::Connection::Channel
::new — Net::SSH::Buffer
::new — Net::SSH::Transport::Kex::EcdhSHA2NistP256
::new — Net::SSH::Transport::Kex::DiffieHellmanGroup1SHA1
::new — Net::SSH::Authentication::Session
::new — Net::SSH::Test::Packet
::new — Net::SSH::Test::Channel
::new — Net::SSH::Test::Socket
::new — Net::SSH::Test::LocalPacket
::new — Net::SSH::Test::Kex
::new — Net::SSH::KnownHosts
::new — Net::SSH::Transport::HMAC::Abstract
::new — Net::SSH::Authentication::Methods::Abstract
::new — Net::SSH::Packet
::new — Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA256
::new — Net::SSH::Transport::Session
::new — Net::SSH::Transport::ServerVersion
::new — Net::SSH::Connection::Session
::new — Net::SSH::ChannelOpenFailed
::new — Net::SSH::Version
::new — Net::SSH::Transport::State
::new — Net::SSH::Connection::Session::NilChannel
::new — Net::SSH::Proxy::SOCKS4
::new — Net::SSH::Proxy::Command
::new — Net::SSH::Proxy::HTTP
::new — Net::SSH::Proxy::SOCKS5
::new — Net::SSH::Authentication::Agent
::read_keyblob — OpenSSL::PKey::EC
::register — Net::SSH::Packet
::reset — Net::SSH::Transport::IdentityCipher
::search_for — Net::SSH::KnownHosts
::search_in — Net::SSH::KnownHosts
::start — Net::SSH
::supported? — Net::SSH::Transport::CipherFactory
::translate — Net::SSH::Config
::update — Net::SSH::Transport::IdentityCipher
#<=> — Net::SSH::Version
#== — Net::SSH::Buffer
#[] — Net::SSH::Packet
#[] — Net::SSH::HostKeyError
#[] — Net::SSH::Connection::Session
#[] — Net::SSH::Connection::Channel
#[] — Net::SSH::Transport::Algorithms
#[]= — Net::SSH::Connection::Session
#[]= — Net::SSH::Connection::Channel
#accept_kexinit — Net::SSH::Transport::Algorithms
#active? — Net::SSH::Connection::Channel
#add — Net::SSH::Authentication::KeyManager
#add — Net::SSH::KnownHosts
#add_key_data — Net::SSH::Authentication::KeyManager
#agent — Net::SSH::Authentication::KeyManager
#allow? — Net::SSH::Transport::Algorithms
#append — Net::SSH::Buffer
#assert_scripted — Net::SSH::Test
#authenticate — Net::SSH::Authentication::Methods::Publickey
#authenticate — Net::SSH::Authentication::Methods::Hostbased
#authenticate — Net::SSH::Authentication::Methods::Password
#authenticate — Net::SSH::Authentication::Methods::KeyboardInteractive
#authenticate — Net::SSH::Authentication::Session
#available — Net::SSH::Buffer
#available_for_read? — Net::SSH::Transport::PacketStream
#busy? — Net::SSH::Connection::Session
#bytesize — String
#cleanup — Net::SSH::Transport::State
#cleanup — Net::SSH::Transport::PacketStream
#clear! — Net::SSH::Buffer
#clear! — Net::SSH::Authentication::KeyManager
#client_name — Net::SSH::Transport::PacketStream
#close — Net::SSH::Connection::Session
#close — Net::SSH::Transport::Session
#close — Net::SSH::Authentication::Agent
#close — Net::SSH::Connection::Channel
#closed? — Net::SSH::Transport::Session
#closed? — Net::SSH::Connection::Session
#closing? — Net::SSH::Connection::Channel
#compress — Net::SSH::Transport::State
#compression? — Net::SSH::Transport::State
#compressor — Net::SSH::Transport::State
#configure_client — Net::SSH::Transport::Session
#configure_server — Net::SSH::Transport::Session
#connect! — Net::SSH::Authentication::Agent
#connection — Net::SSH::Test
#consume! — Net::SSH::Buffer
#curve_name — Net::SSH::Transport::Kex::EcdhSHA2NistP256
#curve_name — Net::SSH::Transport::Kex::EcdhSHA2NistP521
#curve_name — Net::SSH::Transport::Kex::EcdhSHA2NistP384
#debug — Net::SSH::Loggable
#decompress — Net::SSH::Transport::State
#decompressor — Net::SSH::Transport::State
#digest — Net::SSH::Transport::HMAC::None
#digest — Net::SSH::Transport::HMAC::Abstract
#digest_class — Net::SSH::Transport::HMAC::Abstract
#digester — Net::SSH::Transport::Kex::EcdhSHA2NistP384
#digester — Net::SSH::Transport::Kex::EcdhSHA2NistP256
#digester — Net::SSH::Transport::Kex::EcdhSHA2NistP521
#do_close — Net::SSH::Connection::Channel
#do_eof — Net::SSH::Connection::Channel
#do_extended_data — Net::SSH::Connection::Channel
#do_failure — Net::SSH::Connection::Channel
#do_open_failed — Net::SSH::Connection::Channel
#do_success — Net::SSH::Connection::Channel
#each_identity — Net::SSH::Authentication::KeyManager
#empty? — Net::SSH::Buffer
#enqueue_message — Net::SSH::Transport::Session
#enqueue_packet — Net::SSH::Transport::PacketStream
#env — Net::SSH::Connection::Channel
#eof! — Net::SSH::Connection::Channel
#eof? — Net::SSH::Connection::Channel
#eof? — Net::SSH::Buffer
#error — Net::SSH::Loggable
#exchange_keys — Net::SSH::Transport::Kex::DiffieHellmanGroup1SHA1
#exchange_keys — Net::SSH::Test::Kex
#exec — Net::SSH::Connection::Channel
#exec — Net::SSH::Connection::Session
#exec! — Net::SSH::Connection::Session
#expect_message — Net::SSH::Authentication::Session
#fatal — Net::SSH::Loggable
#final_cipher — Net::SSH::Transport::State
#fingerprint — Net::SSH::HostKeyError
#fingerprint — OpenSSL::PKey::PKey
#finish — Net::SSH::Authentication::KeyManager
#forward — Net::SSH::Connection::Session
#getbyte — String
#getpeername — Net::SSH::Test::Socket
#gets — Net::SSH::Test::Script
#gets_channel_close — Net::SSH::Test::Script
#gets_channel_data — Net::SSH::Test::Script
#gets_channel_eof — Net::SSH::Test::Script
#gets_channel_extended_data — Net::SSH::Test::Script
#gets_channel_request — Net::SSH::Test::Script
#gets_close — Net::SSH::Test::Channel
#gets_data — Net::SSH::Test::Channel
#gets_eof — Net::SSH::Test::Channel
#gets_exit_status — Net::SSH::Test::Channel
#gets_extended_data — Net::SSH::Test::Channel
#hint — Net::SSH::Transport::Session
#host — Net::SSH::HostKeyError
#host — Net::SSH::Connection::Session
#host_as_string — Net::SSH::Transport::Session
#identities — Net::SSH::Authentication::Agent
#idle! — Net::SSH::Test::Extensions::PacketStream
#if_needs_rekey? — Net::SSH::Transport::PacketStream
#increment — Net::SSH::Transport::State
#info — Net::SSH::Loggable
#initialize_ssh — Net::SSH::Transport::PacketStream
#initialized? — Net::SSH::Transport::Algorithms
#inject_remote_delay! — Net::SSH::Test::Channel
#instantiate! — Net::SSH::Test::Packet
#ip — Net::SSH::HostKeyError
#key — Net::SSH::HostKeyError
#key= — Net::SSH::Transport::HMAC::Abstract
#key_length — Net::SSH::Transport::HMAC::Abstract
#keys_for — Net::SSH::KnownHosts
#length — Net::SSH::Buffer
#listen_to — Net::SSH::Connection::Session
#local? — Net::SSH::Test::Packet
#local? — Net::SSH::Test::LocalPacket
#local_id — Net::SSH::Test::Channel
#loop — Net::SSH::Connection::Session
#loop_forever — Net::SSH::Connection::Session
#lwarn — Net::SSH::Loggable
#mac_length — Net::SSH::Transport::HMAC::Abstract
#method_missing — Net::SSH::Connection::Session::NilChannel
#needs_rekey? — Net::SSH::Transport::State
#negotiate! — Net::SSH::Authentication::Agent
#next — Net::SSH::Test::Script
#next_message — Net::SSH::Transport::Session
#next_message — Net::SSH::Authentication::Session
#next_packet — Net::SSH::Transport::PacketStream
#on_close — Net::SSH::Connection::Channel
#on_data — Net::SSH::Connection::Channel
#on_eof — Net::SSH::Connection::Channel
#on_extended_data — Net::SSH::Connection::Channel
#on_global_request — Net::SSH::Connection::Session
#on_open_channel — Net::SSH::Connection::Session
#on_open_failed — Net::SSH::Connection::Channel
#on_process — Net::SSH::Connection::Channel
#on_request — Net::SSH::Connection::Channel
#open — Net::SSH::Proxy::SOCKS4
#open — Net::SSH::Proxy::SOCKS5
#open — Net::SSH::Proxy::Command
#open — Net::SSH::Test::Socket
#open — Net::SSH::Proxy::HTTP
#open_channel — Net::SSH::Connection::Session
#opens_channel — Net::SSH::Test::Script
#peer — Net::SSH::Transport::Session
#peer_ip — Net::SSH::Transport::PacketStream
#pending? — Net::SSH::Transport::Algorithms
#poll_message — Net::SSH::Transport::Session
#poll_next_packet — Net::SSH::Transport::PacketStream
#port — Net::SSH::HostKeyError
#postprocess — Net::SSH::Connection::Session
#preprocess — Net::SSH::Connection::Session
#process — Net::SSH::Connection::Channel
#process — Net::SSH::Test::Script
#process — Net::SSH::Test::RemotePacket
#process — Net::SSH::Test::LocalPacket
#process — Net::SSH::Connection::Session
#prompt — Net::SSH::PromptMethods::Clear
#prompt — Net::SSH::PromptMethods::Highline
#prompt — Net::SSH::PromptMethods::Termios
#push — Net::SSH::Transport::Session
#read — Net::SSH::Buffer
#read! — Net::SSH::Buffer
#read_bignum — Net::SSH::Buffer
#read_bool — Net::SSH::Buffer
#read_buffer — Net::SSH::Buffer
#read_byte — Net::SSH::Buffer
#read_int64 — Net::SSH::Buffer
#read_key — Net::SSH::Buffer
#read_keyblob — Net::SSH::Buffer
#read_long — Net::SSH::Buffer
#read_string — Net::SSH::Buffer
#read_to — Net::SSH::Buffer
#readpartial — Net::SSH::Test::Socket
#recv — Net::SSH::Test::Socket
#rekey! — Net::SSH::Transport::Session
#rekey! — Net::SSH::Transport::Algorithms
#rekey_as_needed — Net::SSH::Transport::Session
#remainder_as_buffer — Net::SSH::Buffer
#remember_host! — Net::SSH::HostKeyError
#remote? — Net::SSH::Test::RemotePacket
#remote? — Net::SSH::Test::Packet
#remote_id — Net::SSH::Test::Channel
#request_pty — Net::SSH::Connection::Channel
#reset! — Net::SSH::Transport::State
#reset! — Net::SSH::Buffer
#select_for_read? — Net::SSH::Test::Extensions::BufferedIo
#select_for_test — Net::SSH::Test::Extensions::IO::ClassMethods
#send_channel_request — Net::SSH::Connection::Channel
#send_data — Net::SSH::Connection::Channel
#send_data_for_test — Net::SSH::Test::Extensions::Channel
#send_global_request — Net::SSH::Connection::Session
#send_message — Net::SSH::Connection::Session
#send_message — Net::SSH::Authentication::Methods::Abstract
#send_message — Net::SSH::Transport::Session
#send_packet — Net::SSH::Transport::PacketStream
#sends — Net::SSH::Test::Script
#sends_channel_close — Net::SSH::Test::Script
#sends_channel_data — Net::SSH::Test::Script
#sends_channel_eof — Net::SSH::Test::Script
#sends_channel_request — Net::SSH::Test::Script
#sends_close — Net::SSH::Test::Channel
#sends_data — Net::SSH::Test::Channel
#sends_eof — Net::SSH::Test::Channel
#sends_exec — Net::SSH::Test::Channel
#sends_subsystem — Net::SSH::Test::Channel
#service_request — Net::SSH::Transport::Session
#session_id — Net::SSH::Authentication::Methods::Abstract
#set — Net::SSH::Transport::State
#setbyte — String
#shutdown! — Net::SSH::Connection::Session
#shutdown! — Net::SSH::Transport::Session
#sign — Net::SSH::Authentication::KeyManager
#sign — Net::SSH::Authentication::Agent
#socket — Net::SSH::Test
#ssh_do_sign — OpenSSL::PKey::EC
#ssh_do_sign — OpenSSL::PKey::RSA
#ssh_do_sign — OpenSSL::PKey::DSA
#ssh_do_verify — OpenSSL::PKey::DSA
#ssh_do_verify — OpenSSL::PKey::RSA
#ssh_do_verify — OpenSSL::PKey::EC
#ssh_type — OpenSSL::PKey::EC
#ssh_type — OpenSSL::PKey::DSA
#ssh_type — OpenSSL::PKey::RSA
#stop_listening_to — Net::SSH::Connection::Session
#story — Net::SSH::Test
#subsystem — Net::SSH::Connection::Channel
#test_available_for_read? — Net::SSH::Test::Extensions::PacketStream
#test_enqueue_packet — Net::SSH::Test::Extensions::PacketStream
#test_poll_next_packet — Net::SSH::Test::Extensions::PacketStream
#to_blob — OpenSSL::PKey::EC
#to_blob — OpenSSL::PKey::DSA
#to_blob — OpenSSL::PKey::RSA
#to_i — Net::SSH::Version
#to_s — Net::SSH::Buffer
#to_s — Net::SSH::Version
#to_s — Net::SSH::Test::RemotePacket
#to_ssh — OpenSSL::BN
#transport — Net::SSH::Test
#types — Net::SSH::Test::Packet
#update_cipher — Net::SSH::Transport::State
#use_agent= — Net::SSH::Authentication::KeyManager
#use_agent? — Net::SSH::Authentication::KeyManager
#userauth_request — Net::SSH::Authentication::Methods::Abstract
#valid? — OpenSSL::PKey::DH
#verify — Net::SSH::Verifiers::Strict
#verify — Net::SSH::Verifiers::Secure
#verify — Net::SSH::Verifiers::Lenient
#verify — Net::SSH::Verifiers::Null
#wait — Net::SSH::Transport::Session
#wait — Net::SSH::Connection::Channel
#write — Net::SSH::Buffer
#write — Net::SSH::Test::Socket
#write_bignum — Net::SSH::Buffer
#write_bool — Net::SSH::Buffer
#write_byte — Net::SSH::Buffer
#write_int64 — Net::SSH::Buffer
#write_key — Net::SSH::Buffer
#write_long — Net::SSH::Buffer
#write_string — Net::SSH::Buffer