ssh2-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-connect">
 <refnamediv>
  <refname>ssh2_connect</refname>
  <refpurpose>Connect to an SSH server</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_connect</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>22</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>methods</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam>
  </methodsynopsis>
  <para>
   Establish a connection to a remote SSH server.
  </para>
  <para>
   Once connected, the client should verify the server's hostkey using
   <function>ssh2_fingerprint</function>, then authenticate using either
   password or public key.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>host</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>methods</parameter></term>
     <listitem>
      <para>
       <parameter>methods</parameter> may be an associative array with up to four parameters
       as described below.
      </para>
      <para>
       <table>
        <title><parameter>methods</parameter> may be an associative array
               with any or all of the following parameters.</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Index</entry>
           <entry>Meaning</entry>
           <entry>Supported Values*</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>kex</entry>
           <entry>
            List of key exchange methods to advertise, comma separated
            in order of preference.
           </entry>
           <entry>
            <literal>diffie-hellman-group1-sha1</literal>,
            <literal>diffie-hellman-group14-sha1</literal>, and
            <literal>diffie-hellman-group-exchange-sha1</literal>
           </entry>
          </row>
          <row>
           <entry>hostkey</entry>
           <entry>
            List of hostkey methods to advertise, comma separated
            in order of preference.
           </entry>
           <entry>
            <literal>ssh-rsa</literal> and
            <literal>ssh-dss</literal>
           </entry>
          </row>
          <row>
           <entry>client_to_server</entry>
           <entry>
            Associative array containing crypt, compression, and
            message authentication code (MAC) method preferences
            for messages sent from client to server.
           </entry>
           <entry/>
          </row>
          <row>
           <entry>server_to_client</entry>
           <entry>
            Associative array containing crypt, compression, and
            message authentication code (MAC) method preferences
            for messages sent from server to client.
           </entry>
           <entry/>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       * - Supported Values are dependent on methods supported by underlying library.
       See <link xlink:href="&url.libssh2;">libssh2</link> documentation for additional
       information.
      </para>
      <para>
       <table>
        <title>
         <parameter>client_to_server</parameter> and
         <parameter>server_to_client</parameter> may be an associative array
         with any or all of the following parameters.
        </title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Index</entry>
           <entry>Meaning</entry>
           <entry>Supported Values*</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>crypt</entry>
           <entry>List of crypto methods to advertise, comma separated
            in order of preference.</entry>
           <entry>
            <literal>rijndael-cbc@lysator.liu.se</literal>,
            <literal>aes256-cbc</literal>,
            <literal>aes192-cbc</literal>,
            <literal>aes128-cbc</literal>,
            <literal>3des-cbc</literal>,
            <literal>blowfish-cbc</literal>,
            <literal>cast128-cbc</literal>,
            <literal>arcfour</literal>, and
            <literal>none**</literal>
           </entry>
          </row>
          <row>
           <entry>comp</entry>
           <entry>List of compression methods to advertise, comma separated
            in order of preference.</entry>
           <entry>
            <literal>zlib</literal> and
            <literal>none</literal>
           </entry>
          </row>
          <row>
           <entry>mac</entry>
           <entry>List of MAC methods to advertise, comma separated
            in order of preference.</entry>
           <entry>
            <literal>hmac-sha1</literal>,
            <literal>hmac-sha1-96</literal>,
            <literal>hmac-ripemd160</literal>,
            <literal>hmac-ripemd160@openssh.com</literal>, and
            <literal>none**</literal>
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       <note>
        <title>Crypt and MAC method "<literal>none</literal>"</title>
        <para>
         For security reasons, <literal>none</literal> is disabled by the underlying
         <link xlink:href="&url.libssh2;">libssh2</link> library unless explicitly enabled
         during build time by using the appropriate ./configure options.  See documentation
         for the underlying library for more information.
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callbacks</parameter></term>
     <listitem>
      <para>
       <parameter>callbacks</parameter> may be an associative array with any
       or all of the following parameters.
       <table>
        <title>
         Callbacks parameters
        </title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Index</entry>
           <entry>Meaning</entry>
           <entry>Prototype</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>ignore</entry>
           <entry>
            Name of function to call when an
            <constant>SSH2_MSG_IGNORE</constant> packet is received
           </entry>
           <entry>void ignore_cb($message)</entry>
          </row>
          <row>
           <entry>debug</entry>
           <entry>
            Name of function to call when an
            <constant>SSH2_MSG_DEBUG</constant> packet is received
           </entry>
           <entry>void debug_cb($message, $language, $always_display)</entry>
          </row>
          <row>
           <entry>macerror</entry>
           <entry>
            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.
           </entry>
           <entry>bool macerror_cb($packet)</entry>
          </row>
          <row>
           <entry>disconnect</entry>
           <entry>
            Name of function to call when an
            <constant>SSH2_MSG_DISCONNECT</constant> packet is received
           </entry>
           <entry>void disconnect_cb($reason, $message, $language)</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a resource on success, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ssh2_connect</function> example</title>
    <para>
     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.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
/* Notify the user if the server terminates the connection */
function my_ssh_disconnect($reason, $message, $language) {
  printf("Server disconnected with reason code [%d] and message: %s\n",
         $reason, $message);
}

$methods = array(
  'kex' => '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 (!$connection) die('Connection failed');
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ssh2_fingerprint</function></member>
    <member><function>ssh2_auth_none</function></member>
    <member><function>ssh2_auth_password</function></member>
    <member><function>ssh2_auth_pubkey_file</function></member>
    <member><function>ssh2_disconnect</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->