From 9066a2ede4b5760a09004060c5502836c58ffa64 Mon Sep 17 00:00:00 2001 From: Sara Golemon Date: Mon, 27 Dec 2004 23:18:43 +0000 Subject: [PATCH] Flesh out ssh2_connect() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175728 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ssh2/functions/ssh2-connect.xml | 246 +++++++++++++++++++++- 1 file changed, 244 insertions(+), 2 deletions(-) diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml index a4eee75d1c..11b6784db2 100644 --- a/reference/ssh2/functions/ssh2-connect.xml +++ b/reference/ssh2/functions/ssh2-connect.xml @@ -1,5 +1,5 @@ - + @@ -18,10 +18,252 @@ arraycallbacks - + Establish a connection to a remote SSH server and return a resource on success, false on error + + + + methods may be an associative array with up to four parameters + as described below. + + + + + <parameter>methods</parameter> may be an associative array + with any or all of the following parameters. + + + + Index + Meaning + Supported Values* + + + + + kex + + List of key exchange methods to advertise, coma separated + in order of preference. + + + diffie-hellman-group1-sha1, + diffie-hellman-group4-sha1, and + diffie-hellman-group-exchange-sha1 + + + + hostkey + + List of hostkey methods to advertise, come separated + in order of preference. + + + ssh-rsa and + ssh-dss + + + + client_to_server + + Associative array containing crypt, compression, and + message authentication code (MAC) method preferences + for messages sent from client to server. + + + + + server_to_client + + Associative array containing crypt, compression, and + message authentication code (MAC) method preferences + for messages sent from client to server. + + + + + +
+ + * - Supported Values are dependent on methods supported by underlying library. + See libssh2 documentation for additional + information. + + + + + + <parameter>client_to_server</parameter> and + <parameter>server_to_client</parameter> may be an associative array + with any or all of the following parameters. + + + + + Index + Meaning + Supported Values* + + + + + crypt + List of crypto methods to advertise, coma separated + in order of preference. + + rijndael-cbc@lysator.liu.se, + aes256-cbc, + aes192-cbc, + aes128-cbc, + 3des-cbc, + blowfish-cbc, + cast128-cbc, + arcfour, and + none** + + + + comp + List of compression methods to advertise, coma separated + in order of preference. + + zlib and + none + + + + mac + List of MAC methods to advertise, come separated + in order of preference. + + hmac-sha1, + hmac-sha1-96, + hmac-ripemd160, + hmac-ripemd160@openssh.com, and + none** + + + + +
+ + + + Crypt and MAC method "<literal>none</literal>" + + For security reasons, none is disabled by the underlying + libssh2 library unless explicitly enabled + during build time by using the appropriate ./configure options. See documentation + for the underlying library for more information. + + + + + + <parameter>callbackss</parameter> may be an associative array + with any or all of the following parameters. + + + + Index + Meaning + Prototype + + + + + ignore + + Name of function to call when an + SSH2_MSG_IGNORE + packet is received + + void ignore_cb($message) + + + debug + + Name of function to call when an + SSH2_MSG_DEBUG + packet is received + + void debug_cb($message, $language, $always_display) + + + macerror + + Name of function to call when a + packet is received but the message authentication + code failed. If the callback returns &true;, + the mismatch will be ignored, otherwise the + connection will be terminated. + + bool macerror_cb($packet) + + + disconnect + + Name of function to call when an + SSH2_MSG_DISCONNECT + packet is received + + void disconnect_cb($reason, $message, $language) + + + +
+ + + + + Open a connection forcing 3des-cbc when sending packets, + any strength aes cipher when receiving packets, + no compression in either direction, + and Group1 key exchange. + + + 'diffie-hellman-group1-sha1', + 'client_to_server' => array( + 'crypt' => '3des-cbc', + 'comp' => 'none'), + 'server_to_client' => array( + 'crypt' => 'aes256-cbc,aes192-cbc,aes128-cbc', + 'comp' => 'none')); + +$callbacks = array('disconnect' => 'my_ssh_disconnect'); + +$connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks); +if (!$connect) die('Connection failed'); +?> +]]> + + + + + Once connected, the client should verify the server's hostkey + using ssh2_fingerprint, then authenticate + using either password or public key. + + + + See Also: + ssh2_fingerprint, + ssh2_auth_none, + ssh2_auth_password, and + ssh2_auth_pubkey_file + +