ssh2-auth-pubkey-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8269f33ca8b41d78961b45886bae92d3700bbf2f Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey-file">
 <refnamediv>
  <refname>ssh2_auth_pubkey_file</refname>
  <refpurpose>Identification en utilisant une clé publique</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>
   Identification en utilisant une clé publique, lue depuis un fichier.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>session</parameter></term>
     <listitem>
      <para>
       Un identifiant de connexion SSH, obtenu depuis la fonction
       <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>
       Le fichier contenant la clé publique doit être au format
       OpenSSH. Il doit ressembler à ceci :
      </para>
      <para>
       ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>privkeyfile</parameter></term>
     <listitem>
      <para>
         La clé privée doit être au format PEM
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
       Si <parameter>privkeyfile</parameter> est chiffré (et doit l'être),
       la passe-phrase doit être fournie.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Identification en utilisant une clé publique</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 "Identification réussie en utilisant une clé publique\n";
} else {
  die('Echec de l\'identification en utilisant une clé publique');
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
<refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    La bibliothèque libssh sous-jacente ne supporte pas très proprement les 
    authentifications partielles. C'est à dire que si vous devez fournir à la 
    fois une clé publique et un mot de passe alors cela apparaitra comme si 
    la fonction est en erreur. Dans ce cas particulier, une erreur sur cet 
    appel peut juste signifier que l'authentification n'est pas encore terminée. 
    Vous devez ignorer cette erreur et continuer avec l'appel 
    <function>ssh2_auth_password</function> pour terminer l'authentification.
   </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
-->