ssh2-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<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>Connexion à un serveur SSH</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>
  <simpara>
   Établit une connexion à un serveur SSH distant.
  </simpara>
  <simpara>
   Une fois connecté, le client doit vérifier la clé hôte du serveur
   en utilisant la fonction <function>ssh2_fingerprint</function>,
   puis s'identifier en utilisant soit un mot de passe, soit une clé publique.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>host</parameter></term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>port</parameter></term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>methods</parameter></term>
    <listitem>
     <simpara>
      <parameter>methods</parameter> doit être un tableau associatif d'au plus
      quatre paramètres, comme décrit ci-dessous. <parameter>methods</parameter>
      peut contenir n'importe quel ou tous les paramètres suivants.
     </simpara>
     <table>
      <title>Options de connexion SSH</title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>Index</entry>
         <entry>Signification</entry>
         <entry>Valeurs supportées *</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>kex</entry>
         <entry>
          La liste des méthodes d'échange à annoncer, séparées par une virgule,
          par ordre de préférence.
         </entry>
         <entry>
          <literal>diffie-hellman-group1-sha1</literal>,
          <literal>diffie-hellman-group14-sha1</literal>, et
          <literal>diffie-hellman-group-exchange-sha1</literal>
         </entry>
        </row>
        <row>
         <entry>hostkey</entry>
         <entry>
          La liste des méthodes de clés d'hôte à annoncer, séparées par
          une virgule, par ordre de préférence.
         </entry>
         <entry>
          <literal>ssh-rsa</literal> et
          <literal>ssh-dss</literal>
         </entry>
        </row>
        <row>
         <entry>client_to_server</entry>
         <entry>
          Tableau associatif contenant les codes des méthodes de chiffrement,
          de compression et de code d'authentification de message (MAC) préférés
          pour l'envoi des messages depuis le client vers le serveur.
         </entry>
         <entry/>
        </row>
        <row>
         <entry>server_to_client</entry>
         <entry>
          Tableau associatif contenant les codes des méthodes de chiffrement,
          de compression et de code d'authentification de message (MAC) préférés
          pour l'envoi des messages depuis le serveur vers le client.
         </entry>
         <entry/>
        </row>
       </tbody>
      </tgroup>
     </table>
     <simpara>
      * - Les valeurs supportées sont dépendantes des méthodes supportées par
      la bibliothèque. Voir la documentation <link xlink:href="&url.libssh2;">libssh2</link>
      pour plus d'informations.
     </simpara>
     <table>
      <title>
       <parameter>client_to_server</parameter> et
       <parameter>server_to_client</parameter> doivent être un tableau associatif
       avec n'importe quel ou tous les paramètres suivants.
      </title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>Index</entry>
         <entry>Signification</entry>
         <entry>Valeurs supportées *</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>crypt</entry>
         <entry>
          Liste des méthodes de chiffrement à annoncer, séparées par une virgule,
          par ordre de préférence.
         </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>, et
          <literal>none**</literal>
         </entry>
        </row>
        <row>
         <entry>comp</entry>
         <entry>
          Liste des méthodes de compression à annoncer, séparées par une virgule,
          par ordre de préférence.
         </entry>
         <entry>
          <literal>zlib</literal> et
          <literal>none</literal>
         </entry>
        </row>
        <row>
         <entry>mac</entry>
         <entry>
          Liste des méthodes MAC à annoncer, séparées par une virgule,
          par ordre de préférence.
         </entry>
         <entry>
          <literal>hmac-sha1</literal>,
          <literal>hmac-sha1-96</literal>,
          <literal>hmac-ripemd160</literal>,
          <literal>hmac-ripemd160@openssh.com</literal>, et
          <literal>none**</literal>
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
     <note>
      <title>Chiffrement et méthode MAC "<literal>none</literal>"</title>
      <simpara>
       Pour des raisons de sécurité, <literal>none</literal> est désactivé par la
       bibliothèque <link xlink:href="&url.libssh2;">libssh2</link> à moins qu'il soit
       activé explicitement durant la compilation en utilisant les options
       appropriées du ./configure. Voir la documentation sur la bibliothèque
       pour plus d'informations.
      </simpara>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callbacks</parameter></term>
    <listitem>
     <para>
      <parameter>callbacks</parameter> doit être un tableau associatif
      contenant n'importe quel ou tous les paramètres suivants.
      <table>
       <title>
        Paramètres de rappel
       </title>
       <tgroup cols="3">
        <thead>
         <row>
          <entry>Index</entry>
          <entry>Signification</entry>
          <entry>Prototype</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>ignore</entry>
          <entry>
           Nom de la fonction à appeler lorsqu'un paquet
           <constant>SSH2_MSG_IGNORE</constant> est reçu
          </entry>
          <entry><literal>void ignore_cb($message)</literal></entry>
         </row>
         <row>
          <entry>debug</entry>
          <entry>
           Nom de la fonction à appeler lorsqu'un paquet
           <constant>SSH2_MSG_DEBUG</constant> est reçu
          </entry>
          <entry><literal>void debug_cb($message, $language, $always_display)</literal></entry>
         </row>
         <row>
          <entry>macerror</entry>
          <entry>
           Nom de la fonction à appeler lorsqu'un paquet est reçu mais que
           le code d'authentification de message échoue. Si la fonction de rappel
           retourne &true;, l'erreur sera ignorée, sinon, la connexion se terminera.
          </entry>
          <entry><literal>bool macerror_cb($packet)</literal></entry>
         </row>
         <row>
          <entry>disconnect</entry>
          <entry>
           Nom de la fonction à appeler lorsqu'un paquet
           <constant>SSH2_MSG_DISCONNECT</constant> est reçu
          </entry>
          <entry><literal>void disconnect_cb($reason, $message, $language)</literal></entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Retourne une ressource en cas de succès, ou &false; si une erreur survient.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>ssh2_connect</function></title>
   <simpara>
    Ouverture d'une connexion forçant 3des-cbc lors de l'envoi de paquets,
    n'importe quel chiffrement AES lors de la réception de paquets,
    aucune compression dans les deux directions, et un échange de clés Group1.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
/* Notification à l'utilisateur si le serveur termine la connexion */
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('Échec de la connexion');
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <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</function></member>
   <member><function>ssh2_auth_pubkey_file</function></member>
   <member><function>ssh2_disconnect</function></member>
  </simplelist>
 </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
-->