Net::SSH2(3)

📦

version 0.74 · 9 versions

🦋 Net::SSH2 💅

okay so bestie, this is the Net::SSH2(3) page from the User Contributed Perl Documentation section — yes that whole vibe. it's a lot, i know. but we're gonna get through it together, no cap. 💖

✨ NAME ✨

Net::SSH2 — support for the SSH 2 protocol via libssh2. that's the whole thing. that's the tweet. 🫶

🎀 SYNOPSIS 🎀

like, here's the whole glow-up in one code block, literally exactly as written:

  use Net::SSH2;

  my $ssh2 = Net::SSH2->new();

  $ssh2->connect('example.com')
    or $ssh2->die_with_error;

  $ssh2->check_hostkey('ask')
    or $ssh2->die_with_error;

  $ssh2->auth_publickey($ENV{USER}, "$ENV{HOME}/.ssh/id_rsa.pub", "$ENV{HOME}/.ssh/id_rsa")
    or $ssh2->die_with_error;

  my $chan = $ssh2->channel()
    or $ssh2->die_with_error;

  $chan->exec('ls')
    or $ssh2->die_with_error;

  print while <$chan>;

  print "EXIT CODE: ", $chan->exit_status, "\n";

  $chan->close;

  my $sftp = $ssh2->sftp()
    or $ssh2->die_with_error;;

  my $fh = $sftp->open('/etc/passwd')
    or $sftp->die_with_error;

  print while <$fh>;

(yes there's a lil double ;; in there, that's canon, we don't touch it 💅)

🌸 DESCRIPTION 🌸

Net::SSH2 is a Perl interface to the libssh2 library (<http://www.libssh2.org>). it does the SSH2 protocol — and bestie, listen, there is no support for SSH1, okay? SSH1 is not invited to the party. but it DOES bring all of the key exchanges, ciphers, and compression of libssh2. ate. 👑

so even though this module can be compiled and linked against really really old versions of the library… nothing below 1.5.0 should actually be used (those older versions were buggy and unreliable, like genuinely a mess 😭) and version 1.7.0 or later is recommended.

💀 Error handling 💀

unless it says otherwise, methods return a true value on success and undef on failure. when that happens, hit up the error method to get the extended error info. iykyk.

Important: methods in Net::SSH2 that are not backed by libssh2 functions (i.e. check_hostkey or the SCP related methods) need libssh2 1.7.0 or later in order to set the error state. that means when one of those methods fails on an older version of the library, error won't return the real code — it'll just hand you some bogus result. 🙈 so watch out for that.

🦋 Typical usage 🦋

the typical order of operations goes like this:

create the SSH2 object by calling new.
configure the session if you need to. like, enabling compression or picking some specific encryption methods.
establish the SSH connection by calling the method connect.
check the remote host public key by calling check_hostkey.
authenticate by calling the required authentication methods.
call channel and related methods to create new bidirectional communication channels over the SSH connection.
close the connection by letting the Net::SSH2 object go out of scope, or by calling disconnect explicitly.

🌈 CONSTANTS 🌈

every single constant defined in libssh2 can be imported from Net::SSH2. periodt.

for instance:

  use Net::SSH2 qw(LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE
                   LIBSSH2_CHANNEL_FLUSH_ALL
                   LIBSSH2_HOSTKEY_POLICY_ASK);

though ngl, most methods accept the uncommon part of the constant name as a string. so like, these two method calls are equivalent:

   $channel->ext_data(LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE);
   $channel->ext_data('merge');

you can use tags to import these constant subsets:

 callback channel error socket trace hash method
 disconnect policy fx fxf sftp

and the tag all imports literally all of them. slay. 💅

👑 METHODS 👑

⭐ new ( %options ) ⭐

creates a brand new Net::SSH2 object that represents an SSH session. main character energy fr.

the accepted options are:

timeout — sets the default timeout in milliseconds. see timeout.
trace — sets tracing. see trace.

example:

    my $ssh2 = Net::SSH2->new(trace => -1);

note that tracing requires a version of libssh2 compiled with debugging support.

debug — enable debugging. see debug.
compress — sets flag LIBSSH2_FLAG_COMPRESS. see flag.
sigpipe — sets flag LIBSSH2_FLAG_SIGPIPE. see flag.

⭐ banner ( text ) ⭐

sets the SSH2 banner text that gets sent to the remote host. it prepends the required SSH-2.0- for you, don't worry. 🎀

⭐ version ⭐

in scalar context, returns the libssh2 version/patch, e.g. 0.18 or 0.18.0-20071110. in list context, it returns that version plus the numeric version (major, minor, and patch, each encoded as 8 bits, e.g. 0x001200 for version 0.18) and the default banner text (e.g. SSH-2.0-libssh2_0.18.0-20071110). ✨

⭐ error ⭐

returns the last error code. in list context, returns (code, error name, error string).

note that the returned error value is only meaningful after some other method indicates an error by returning false. like, it's not just sitting there waiting for you bestie. 💀

⭐ die_with_error ( [message] ) ⭐

calls die with the given message and the error information from the object appended to it.

for instance:

  $ssh2->connect("ajhkfhdklfjhklsjhd", 22)
      or $ssh2->die_with_error;
  # dies as:
  #    Unable to connect to remote host: Invalid argument (-1 LIBSSH2_ERROR_SOCKET_NONE)

⭐ sock ⭐

returns a reference to the underlying IO::Socket object (usually a derived class like IO::Socket::IP or IO::Socket::INET), or undef if it's not connected yet.

⭐ trace ⭐

calls libssh2_trace with the supplied bitmask. to enable all tracing, pass -1 like this:

    $ssh2->trace(-1);

a version of libssh2 compiled with tracing support is required. no tracing support, no trace. that's the rule. 🙈

⭐ timeout ( timeout_ms ) ⭐

enables a global timeout (in milliseconds) which will affect every action. requires libssh2 1.2.9 or later.

by default — or if you set the timeout to zero — Net::SSH2 has no timeout. free spirit. 🦋

note that timeout errors may leave the SSH connection in an inconsistent state, and further operations may fail or behave incorrectly. actually, some methods are able to recover after a timeout error and others are not. 😭

don't hesitate to report any issue you encounter related to this so it can be fixed, or at least documented! 🫶

⭐ method ( type [, values... ] ) ⭐

sets or gets a method preference. for a get, pass in the type only. to set, pass in either a list of values or a comma-separated string. values can only be queried after the session is connected.

the following methods can be set or queried:

LIBSSH2_METHOD_KEX — key exchange method names. supported values:
- diffie-hellman-group1-sha1 — Diffie-Hellman key exchange with SHA-1 as hash, and Oakley Group 2 (see RFC 2409).
- diffie-hellman-group14-sha1 — Diffie-Hellman key exchange with SHA-1 as hash, and Oakley Group 14 (see RFC 3526).
- diffie-hellman-group-exchange-sha1 — Diffie-Hellman key exchange with SHA-1 as hash, using a safe-prime/generator pair (chosen by server) of arbitrary strength (specified by client) (see IETF draft secsh-dh-group-exchange).
LIBSSH2_METHOD_HOSTKEY — public key algorithms. supported values:
- ssh-dss — based on the Digital Signature Standard (FIPS-186-2).
- ssh-rsa — based on PKCS#1 (RFC 3447).
LIBSSH2_METHOD_CRYPT_CS — encryption algorithm from client to server. supported algorithms:
- aes256-cbc — AES in CBC mode, with 256-bit key.
- rijndael-cbc@lysator.liu.se — alias for aes256-cbc.
- aes192-cbc — AES in CBC mode, with 192-bit key.
- aes128-cbc — AES in CBC mode, with 128-bit key.
- blowfish-cbc — Blowfish in CBC mode.
- arcfour — ARCFOUR stream cipher.
- cast128-cbc — CAST-128 in CBC mode.
- 3des-cbc — three-key 3DES in CBC mode.
- none — no encryption.
LIBSSH2_METHOD_CRYPT_SC — encryption algorithm from server to client. see the LIBSSH2_METHOD_CRYPT_CS entry above for the supported algorithms.
LIBSSH2_METHOD_MAC_CS — Message Authentication Code (MAC) algorithms from client to server. supported values:
- hmac-sha1 — SHA-1 with 20-byte digest and key length.
- hmac-sha1-96 — SHA-1 with 20-byte key length and 12-byte digest length.
- hmac-md5 — MD5 with 16-byte digest and key length.
- hmac-md5-96 — MD5 with 16-byte key length and 12-byte digest length.
- hmac-ripemd160 — RIPEMD-160 algorithm with 20-byte digest length.
- hmac-ripemd160@openssh.com — alias for hmac-ripemd160.
- none — no encryption.
LIBSSH2_METHOD_MAC_SC — Message Authentication Code (MAC) algorithms from server to client. see LIBSSH2_METHOD_MAC_CS for the supported algorithms.
LIBSSH2_METHOD_COMP_CS — compression methods from client to server. supported values:
- zlib — the zlib compression method as described in RFC 1950 and RFC 1951.
- none — no compression
LIBSSH2_METHOD_COMP_SC — compression methods from server to client. see LIBSSH2_METHOD_COMP_CS for the supported compression methods.

⭐ connect ( handle | host [, port] ) ⭐

the argument combinations it accepts are:

a glob or IO::* object reference — note that tied file handles are not acceptable. the underlying libssh2 requires real file handles, bestie. 💀
host [, port] — in order to handle IPv6 addresses, the optional module IO::Socket::IP is required. the port number defaults to 22.

this method used to accept a Timeout argument. that feature has been replaced by the constructor timeout option — but heads up, it takes milliseconds instead of seconds! so don't get caught slipping. 😭

⭐ disconnect ( [description [, reason [, language]]] ) ⭐

sends a clean disconnect message to the remote server. the default values are empty strings for description and language, and SSH_DISCONNECT_BY_APPLICATION for the reason. polite exit, we love to see it. 💅

⭐ hostname ⭐

the name of the remote host given at connect time, or retrieved from the TCP layer.

⭐ port ⭐

the port number of the remote SSH server.

⭐ hostkey_hash ( hash type ) ⭐

returns a hash of the host key. note that the key is raw data and may contain nulls or control characters. 🙈

the type may be one of:

LIBSSH2_HOSTKEY_HASH_MD5 — MD5 hash, 16 bytes long (requires libssh2 compiled with MD5 support).
LIBSSH2_HOSTKEY_HASH_SHA1 — SHA1 hash, 20 bytes long.

Note: in previous versions of the module this method was called hostkey.

⭐ remote_hostkey ⭐

returns the public key from the remote host and its type, which is one of LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS, or LIBSSH2_HOSTKEY_TYPE_UNKNOWN.

⭐ check_hostkey( [policy, [known_hosts_path [, comment] ] ] ) ⭐

looks for the remote host key inside the given known host file. it defaults to ~/.ssh/known_hosts.

on success, this method returns the result of the call done under the hood to Net::SSH2::KnownHost::check — i.e. LIBSSH2_KNOWNHOST_CHECK_MATCH, LIBSSH2_KNOWNHOST_CHECK_FAILURE, LIBSSH2_KNOWNHOST_CHECK_NOTFOUND, or LIBSSH2_KNOWNHOST_CHECK_MISMATCH.

on failure it returns undef.

the accepted policies are as follows:

Okay so the hostkey policy vibes are giving security check realness 💅:

LIBSSH2_HOSTKEY_POLICY_STRICT — Only host keys already present in the known hosts file are accepted. This is the default policy. No cap.
LIBSSH2_HOSTKEY_POLICY_ASK — If the host key is not present in the known hosts file, the user is asked if it should be accepted or not. If accepted, the key is added to the known host file with the given comment. Communication is key, bestie 🫶
LIBSSH2_HOSTKEY_POLICY_TOFU — Trust On First Use: if the host key is not present in the known hosts file, it is added there and accepted. First impressions are forever ✨
LIBSSH2_HOSTKEY_POLICY_ADVISORY — The key is always accepted, but it is never saved into the known host file. Look but don't touch energy 💀
callback — If a reference to a subroutine is given, it is called when the key is not present in the known hosts file or a different key is found. The arguments passed to the callback are the session object, the matching error ("LIBSSH2_KNOWNHOST_CHECK_FAILURE", "LIBSSH2_KNOWNHOST_CHECK_NOTFOUND" or "LIBSSH2_KNOWNHOST_CHECK_MISMATCH") and the comment. It's giving "you've got mail" but for crypto 🔥

`auth_list` ( [username] )

Returns the authentication methods accepted by the server. In scalar context the methods are returned as a comma separated string.

When the server accepted an unauthenticated session for the given username, this method returns undef but auth_ok returns true. So like, it's a vibe, not a rejection 💜

`auth_ok`

Returns true when the session is authenticated. Periodt. That's it. That's the method. 👑

`auth_password` ( username [, password [, callback ]] )

Authenticates using a password.

If the password has expired, if a callback code reference was given, it's called as callback($self, $username) and should return a password. If no callback is provided, LIBSSH2_ERROR_PASSWORD_EXPIRED is returned. Expired password? Not the vibe. Get a callback, bestie 😭

`auth_password_interact` ( username [, callback])

Prompts the user for the password interactively (requires Term::ReadKey). Interactive era 🎀

`auth_publickey` ( username, publickey_path, privatekey_path [, passphrase ] )

Authenticate using the given private key and an optional passphrase.

When libssh2 is compiled using OpenSSL as the crypto backend, passing this method undef as the public key argument is acceptable (OpenSSL is able to extract the public key from the private one). OpenSSL said "I got you" 💅

`auth_publickey_frommemory` ( username, publickey_blob, privatekey_blob [, passphrase ] )

Authenticate using the given public/private key and an optional passphrase. The keys must be PEM encoded (requires libssh2 1.6.0 or later with the OpenSSL backend). Memory keys? In this economy? Slay ✨

`auth_hostbased` ( username, publickey, privatekey, hostname, [, local username [, passphrase ]] )

Host-based authentication using an optional passphrase. The local username defaults to be the same as the remote username. Lowkey convenient 🦋

`auth_keyboard` ( username, password | callback )

Authenticate using "keyboard-interactive". Takes either a password, or a callback code reference which is invoked as callback->(self, username, name, instruction, prompt...) (where each prompt is a hash with "text" and "echo" keys, signifying the prompt text and whether the user input should be echoed, respectively) which should return an array of responses.

If only a username is provided, the default callback will handle standard interactive responses (requires Term::ReadKey) Keyboard go brrr ⌨️

`auth_agent` ( username )

Try to authenticate using an SSH agent (requires libssh2 1.2.3). Let the agent handle it 💁‍♀️

`auth` ( ... )

This is a general, prioritizing authentication mechanism that can use any of the previous methods. You provide it some parameters and (optionally) a ranked list of methods you want considered (defaults to all). It will remove any unsupported methods or methods for which it doesn't have parameters (e.g. if you don't give it a public key, it can't use publickey or hostkey), and try the rest, returning whichever one succeeded or undef if they all failed. If a parameter is passed with an undef value, a default value will be supplied if possible. Main character energy: it tries everything until something works 👑

The parameters are:

rank — An optional ranked list of methods to try. The names should be the names of the Net::SSH2 "auth" methods, e.g. "keyboard" or "publickey", with the addition of "keyboard-auto" for automated "keyboard-interactive" and "password-interact" which prompts the user for the password interactively.
username
password
publickey
privatekey — "privatekey" and "publickey" are file paths.
passphrase
hostname
local_username
interact — If this option is set to a true value, interactive methods will be enabled.
fallback — If a password is given but authentication using it fails, the module will fall back to ask the user for another password if this parameter is set to a true value.
cb_keyboard — auth_keyboard callback.
cb_password — auth_password callback.

For historical reasons and in order to maintain backward compatibility with older versions of the module, when the "password" argument is given, it is also used as the passphrase (and a deprecation warning generated). Not the deprecated behavior, bestie 💀

In order to avoid that behaviour the "passphrase" argument must be also passed (it could be undef). For instance:

$ssh2->auth(username => $user,
            privatekey => $privatekey_path,
            publickey => $publickey_path,
            password => $password,
            passphrase => undef);

This work around will be removed in a not too distant future version of the module. So use it while you can, fr fr 🫶

`flag` (key, value)

Sets the given session flag.

The currently supported flag values are:

LIBSSH2_FLAG_COMPRESS — If set before the connection negotiation is performed, compression will be negotiated for this connection. Compression can also be enabled passing option "compress" to the constructor new. Squeeze it in ✨
LIBSSH2_FLAG_SIGPIPE — if set, Net::SSH2/libssh2 will not attempt to block SIGPIPEs but will let them trigger from the underlying socket layer. Let it trigger, honestly 💅

`keepalive_config(want_reply, interval)`

Set how often keepalive messages should be sent.

"want_reply" indicates whether the keepalive messages should request a response from the server. "interval" is number of seconds that can pass without any I/O. Just checking in, bestie 🫶

`keepalive_send`

Send a keepalive message if needed.

On failure returns undef. On success returns how many seconds you can sleep after this call before you need to call it again.

Note that the underlying libssh2 function "libssh2_keepalive_send" can not recover from EAGAIN errors. If this method fails with such error, the SSH connection may become corrupted. ⚠️ This is giving "do not pass go" energy ⚠️

The usage of this function is discouraged. Not me telling you to avoid it or anything 🙈

`channel` ( [type, [window size, [packet size]]] )

Creates and returns a new channel object. See Net::SSH2::Channel.

Type, if given, must be "session" (a reminiscence of an old, more generic, but never working wrapping). We don't talk about the old wrapping 💀

`tcpip` ( host, port [, shost, sport ] )

Creates a TCP connection from the remote host to the given host:port, returning a new channel.

The "shost" and "sport" arguments are merely informative and passed to the remote SSH server as the origin of the connection. They default to 127.0.0.1:22. Informative only, bestie. Don't @ me 💅

Note that this method does not open a new port on the local machine and forwards incoming connections to the remote side. Read that again. No local port. No cap. 🚫

`listen` ( port [, host [, bound port [, queue size ]]] )

Sets up a TCP listening port on the remote host. Host defaults to 0.0.0.0; if bound port is provided, it should be a scalar reference in which the bound port is returned. Queue size specifies the maximum number of queued connections allowed before the server refuses new connections.

Returns a new Net::SSH2::Listener object. Listener era activated 🎧

`scp_get` ( remote_path [, local_path ] )

Retrieve a file with SCP. Local path defaults to basename of remote.

Alternatively, "local_path" may be an already open file handle or an IO::Handle object (e.g. IO::File, IO::Scalar). File handle? Say less. 🍓

`scp_put` ( local_path [, remote_path ] )

Send a file with SCP. Remote path defaults to same as local.

Alternatively, "local_path" may be an already open file handle or a reference to a IO::Handle object (it must have a valid stat method). Stat method required, bestie. No stat, no chat. 💅

`sftp`

Return SecureFTP interface object (see Net::SSH2::SFTP).

Note that SFTP support in libssh2 is pretty rudimentary. You should consider using Net::SFTP::Foreign with the Net::SSH2 backend Net::SFTP::Foreign::Backend::Net_SSH2 instead. Rudimentary? That's a read. 💀

`public_key`

Return public key interface object (see Net::SSH2::PublicKey). Public key, public vibe ✨

`known_hosts`

Returns known hosts interface object (see Net::SSH2::KnownHosts). You already know, bestie 💜

`poll` ( timeout, arrayref of hashes )

Deprecated: the poll functionality in libssh2 is deprecated and its usage disregarded. Session methods "sock" and "block_directions" can be used instead to integrate Net::SSH2 inside an external event loop. Deprecated. Don't use it. I said what I said. 🚫

Pass in a timeout in milliseconds and an arrayref of hashes with the following keys:

handle — May be a Net::SSH2::Channel or Net::SSH2::Listener object, integer file descriptor, or perl file handle.
events — Requested events. Combination of LIBSSH2_POLLFD_* constants (with the POLL prefix stripped if present), or an arrayref of the names ('in', 'hup' etc.).
revents — Returned events. Returns a hash with the (lowercased) names of the received events ('in', 'hup', etc.) as keys with true values, and a "value" key with the integer value.

Returns undef on error, or the number of active objects. If it works, it works. But also, deprecated. 👑

`block_directions`

Get the blocked direction after some method returns "LIBSSH2_ERROR_EAGAIN".

Returns "LIBSSH2_SESSION_BLOCK_INBOUND" or/and "LIBSSH2_SESSION_BLOCK_OUTBOUND". Inbound, outbound, or both? The duality of SSH 💅

`debug` ( state )

Class method (affects all Net::SSH2 objects).

Pass 1 to enable, 0 to disable. Debug output is sent to "STDERR". Turn it on and watch the tea spill 🍵

`blocking` ( flag )

Enable or disable blocking.

A good number of the methods in "Net::SSH2"/"libssh2" can not work in non-blocking mode. Some of them may just forcibly enable blocking during its execution. A few may even corrupt the SSH session or crash the program. ⚠️ Crash the program? Not the vibe. Be careful, bestie. ⚠️

The ones that can be safely called are "read" and, with some caveats, "write". See "write" in Net::SSH2::Channel. Read: safe. Write: kinda safe. Everything else: enter at your own risk. 🦋

Don't hesitate to report any bug you found in that area! If you find a bug, tell someone. You're the main character of that bug report. 👑

🦋 INTEROPERABILITY AND OTHER KNOWN ISSUES 🦋

okay bestie, this is the part where we spill the tea on compatibility and the lil' gremlins you might meet. no cap.

💅 Protocol versions

The underlying libssh2 library does support version 2 of the SSH protocol exclusively (hopefully, version 1 usage is almost extinct.)

The SFTP client implements version 3 of the SFTP protocol.

🔑 Key formats

Private and public keys can be generated and stored using different formats and cyphers. Which ones are accepted by Net::SSH2 depends on the libssh2 version being used and of the underlying crypto backend it was configured to use at build time (OpenSSL libssl or libgcrypt).

An increasingly common problem is that OpenSSH since version 7.8 (released 2018-8-24) generates keys by default using the format RFC4716 which is not supported by the default crypto backend (libssl).

Keys can be converted inplace to the old PEM format using ssh-keygen(1) as follows:

$ ssh-keygen -p -m PEM -N "" -f ~/.ssh/id_rsa

On Windows, PuTTYgen (which is part of the PuTTY distribution) can be used to convert keys.

Another common issue is that in the last years OpenSSH has incorporated several new cyphers that are not supported by any version of libssh2 yet. Currently the best option from an interoperability standpoint is probably to stick to RSA key usage.

🚨 Security

Nowadays libssh2 development is not thrilling; new versions (even minor ones) are being released just every two or three years. On the other hand security issues are found and reported far more frequently. That means that Net::SSH2/libssh2 could be an easy attack vector.

So, Net::SSH2 should be used only in trusted environments. More specifically, using it to connect to untrusted third party computers over the Internet is probably a very bad idea!

bestie, fr fr, do NOT use this to connect to random sketchy hosts on the internet. that's not a vibe, that's a vulnerability. 💀

🌈 SEE ALSO 🌈

Net::SSH2::Channel
Net::SSH2::Listener
Net::SSH2::SFTP
Net::SSH2::File
Net::SSH2::Dir

LibSSH2 documentation at http://www.libssh2.org.

IETF Secure Shell (secsh) working group at http://www.ietf.org/html.charters/secsh-charter.html.

Net::SSH::Any and Net::SFTP::Foreign integrate nicely with Net::SSH2.

Other Perl modules related to SSH you may find interesting: Net::OpenSSH, Net::SSH::Perl, Net::OpenSSH::Parallel, Net::OpenSSH::Compat.

👑 COPYRIGHT AND LICENSE 👑

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or, at your option, any later version of Perl 5 you may have available.

okay that's the whole page, bestie. it came from perl v5.42.0, dated 2025-07-25, and it's Net::SSH2(3). slay, you made it to the end. 💖✨

📦 where this page comes from

fedora 43: perl-Net-SSH2 0.74-4.fc43 · GPL-1.0-or-later OR Artistic-1.0-Perl
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

Net::SSH2(3)

🦋 Net::SSH2 💅

✨ NAME ✨

🎀 SYNOPSIS 🎀

🌸 DESCRIPTION 🌸

💀 Error handling 💀

🦋 Typical usage 🦋

🌈 CONSTANTS 🌈

👑 METHODS 👑

⭐ new ( %options ) ⭐

⭐ banner ( text ) ⭐

⭐ version ⭐

⭐ error ⭐

⭐ die_with_error ( [message] ) ⭐

⭐ sock ⭐

⭐ trace ⭐

⭐ timeout ( timeout_ms ) ⭐

⭐ method ( type [, values... ] ) ⭐

⭐ connect ( handle | host [, port] ) ⭐

⭐ disconnect ( [description [, reason [, language]]] ) ⭐

⭐ hostname ⭐

⭐ port ⭐

⭐ hostkey_hash ( hash type ) ⭐

⭐ remote_hostkey ⭐

⭐ check_hostkey( [policy, [known_hosts_path [, comment] ] ] ) ⭐

auth_list ( [username] )

auth_ok

auth_password ( username [, password [, callback ]] )

auth_password_interact ( username [, callback])

auth_publickey ( username, publickey_path, privatekey_path [, passphrase ] )

auth_publickey_frommemory ( username, publickey_blob, privatekey_blob [, passphrase ] )

auth_hostbased ( username, publickey, privatekey, hostname, [, local username [, passphrase ]] )

auth_keyboard ( username, password | callback )

auth_agent ( username )

auth ( ... )

flag (key, value)

keepalive_config(want_reply, interval)

keepalive_send

channel ( [type, [window size, [packet size]]] )

tcpip ( host, port [, shost, sport ] )

listen ( port [, host [, bound port [, queue size ]]] )

scp_get ( remote_path [, local_path ] )

scp_put ( local_path [, remote_path ] )

sftp

public_key

known_hosts

poll ( timeout, arrayref of hashes )

block_directions

debug ( state )

blocking ( flag )