ssh2-auth-pubkey-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8269f33ca8b41d78961b45886bae92d3700bbf2f Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey-file">
 <refnamediv>
  <refname>ssh2_auth_pubkey_file</refname>
  <refpurpose>Identificación utilizando una clave pública</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ssh2_auth_pubkey_file</methodname>
   <methodparam><type>resource</type><parameter>session</parameter></methodparam>
   <methodparam><type>string</type><parameter>username</parameter></methodparam>
   <methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam>
   <methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
  </methodsynopsis>
  <para>
   Identificación utilizando una clave pública, leída desde un fichero.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>session</parameter></term>
     <listitem>
      <para>
       Un identificador de conexión SSH, obtenido desde la función
       <function>ssh2_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pubkeyfile</parameter></term>
     <listitem>
      <para>
       El fichero que contiene la clave pública debe estar en formato
       OpenSSH. Debe parecerse a esto:
      </para>
      <para>
       ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>privkeyfile</parameter></term>
     <listitem>
      <para>
         La clave privada debe estar en formato PEM.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
       Si <parameter>privkeyfile</parameter> está cifrado (y debe estarlo),
       la frase de paso debe ser proporcionada.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Identificación utilizando una clave pública</title>
    <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));

if (ssh2_auth_pubkey_file($connection, 'username',
                          '/home/username/.ssh/id_rsa.pub',
                          '/home/username/.ssh/id_rsa', 'secret')) {
  echo "Identificación exitosa utilizando una clave pública\n";
} else {
  die('Fallo en la identificación utilizando una clave pública');
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
<refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    La biblioteca libssh subyacente no soporta muy limpiamente las
    autenticaciones parciales. Es decir, que si debe proporcionar a la
    vez una clave pública y una contraseña, entonces parecerá como si
    la función estuviera en error. En este caso particular, un error en esta
    llamada puede simplemente significar que la autenticación no está aún terminada.
    Debe ignorar este error y continuar con la llamada
    <function>ssh2_auth_password</function> para terminar la autenticación.
   </para>
  </note>
 </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
-->