archived-doc-es/reference/ssh2/functions/ssh2-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: PhilDaiguille 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>Conexión a un servidor 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>
   Establece una conexión a un servidor SSH remoto.
  </simpara>
  <simpara>
   Una vez conectado, el cliente debe verificar la clave de host del servidor
   utilizando la función <function>ssh2_fingerprint</function>,
   luego identificarse utilizando un password o una clave pública.
  </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> puede ser un array asociativo de hasta
      cuatro parámetros, como se describe a continuación.
     </simpara>
     <table>
      <title><parameter>methods</parameter> puede ser un array asociativo
             con cualquiera o todos los parámetros siguientes.</title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>Índice</entry>
         <entry>Significado</entry>
         <entry>Valores soportados *</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>kex</entry>
         <entry>
          La lista de métodos de intercambio a anunciar, separados por una coma,
          por orden de preferencia.
         </entry>
         <entry>
          <literal>diffie-hellman-group1-sha1</literal>,
          <literal>diffie-hellman-group14-sha1</literal>, y
          <literal>diffie-hellman-group-exchange-sha1</literal>
         </entry>
        </row>
        <row>
         <entry>hostkey</entry>
         <entry>
          La lista de métodos de claves de host a anunciar, separados por
          una coma, por orden de preferencia.
         </entry>
         <entry>
          <literal>ssh-rsa</literal> y
          <literal>ssh-dss</literal>
         </entry>
        </row>
        <row>
         <entry>client_to_server</entry>
         <entry>
          Array asociativo que contiene los códigos de los métodos de cifrado,
          compresión y mensajes de autenticación (MAC) preferidos
          para el envío de mensajes desde el cliente al servidor.
         </entry>
         <entry/>
        </row>
        <row>
         <entry>server_to_client</entry>
         <entry>
          Array asociativo que contiene los códigos de los métodos de cifrado,
          compresión y mensajes de autenticación (MAC) preferidos
          para el envío de mensajes desde el servidor al cliente.
         </entry>
         <entry/>
        </row>
       </tbody>
      </tgroup>
     </table>
     <simpara>
      * - Los valores soportados dependen de los métodos soportados por
      la biblioteca. Consulte la documentación <link xlink:href="&url.libssh2;">libssh2</link>
      para más información.
     </simpara>
     <table>
      <title>
       <parameter>client_to_server</parameter> y
       <parameter>server_to_client</parameter> deben ser un array asociativo
       con cualquiera o todos los parámetros siguientes.
      </title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>Índice</entry>
         <entry>Significado</entry>
         <entry>Valores soportados *</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>crypt</entry>
         <entry>
          Lista de métodos de cifrado a anunciar, separados por una coma,
          por orden de preferencia.
         </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>, y
          <literal>none**</literal>
         </entry>
        </row>
        <row>
         <entry>comp</entry>
         <entry>
          Lista de métodos de compresión a anunciar, separados por una coma,
          por orden de preferencia.
         </entry>
         <entry>
          <literal>zlib</literal> y
          <literal>none</literal>
         </entry>
        </row>
        <row>
         <entry>mac</entry>
         <entry>
          Lista de métodos MAC a anunciar, separados por una coma,
          por orden de preferencia.
         </entry>
         <entry>
          <literal>hmac-sha1</literal>,
          <literal>hmac-sha1-96</literal>,
          <literal>hmac-ripemd160</literal>,
          <literal>hmac-ripemd160@openssh.com</literal>, y
          <literal>none**</literal>
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
     <note>
      <title>Cifrado y método MAC "<literal>none</literal>"</title>
      <simpara>
       Por razones de seguridad, <literal>none</literal> está desactivado por la
       biblioteca <link xlink:href="&url.libssh2;">libssh2</link> a menos que se
       active explícitamente durante la compilación utilizando las opciones
       apropiadas de ./configure. Consulte la documentación de la biblioteca
       para más información.
      </simpara>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callbacks</parameter></term>
    <listitem>
     <para>
      <parameter>callbacks</parameter> debe ser un array asociativo
      que contiene cualquiera o todos los parámetros siguientes.
      <table>
       <title>
        Parámetros de retrollamada
       </title>
       <tgroup cols="3">
        <thead>
         <row>
          <entry>Índice</entry>
          <entry>Significado</entry>
          <entry>Prototipo</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>ignore</entry>
          <entry>
           Nombre de la función a llamar cuando se recibe un paquete
           <constant>SSH2_MSG_IGNORE</constant>
          </entry>
          <entry><literal>void ignore_cb($message)</literal></entry>
         </row>
         <row>
          <entry>debug</entry>
          <entry>
           Nombre de la función a llamar cuando se recibe un paquete
           <constant>SSH2_MSG_DEBUG</constant>
          </entry>
          <entry><literal>void debug_cb($message, $language, $always_display)</literal></entry>
         </row>
         <row>
          <entry>macerror</entry>
          <entry>
           Nombre de la función a llamar cuando se recibe un paquete pero el
           código de mensaje de autenticación falla. Si la función de retrollamada
           devuelve &true;, el error será ignorado, de lo contrario, la conexión terminará.
          </entry>
          <entry><literal>bool macerror_cb($packet)</literal></entry>
         </row>
         <row>
          <entry>disconnect</entry>
          <entry>
           Nombre de la función a llamar cuando se recibe un paquete
           <constant>SSH2_MSG_DISCONNECT</constant>
          </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>
   Devuelve un recurso en caso de éxito, o &false; en caso de error.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo con <function>ssh2_connect</function></title>
   <simpara>
    Apertura de una conexión forzando 3des-cbc al enviar paquetes,
    cualquier cifrado AES al recibir paquetes,
    ninguna compresión en ambas direcciones, y un intercambio de claves Group1.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
/* Notificación al usuario si el servidor termina la conexión */
function my_ssh_disconnect($reason, $message, $language) {
  printf("Servidor desconectado con código de razón [%d] y mensaje: %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('Fallo en la conexión');
?>
]]>
   </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
-->