archived-doc-fr/reference/ssh2/functions/ssh2-auth-pubkey.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey">
 <refnamediv>
  <refname>ssh2_auth_pubkey</refname>
  <refpurpose>Identification en utilisant une clé publique depuis une variable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ssh2_auth_pubkey</methodname>
   <methodparam><type>resource</type><parameter>session</parameter></methodparam>
   <methodparam><type>string</type><parameter>username</parameter></methodparam>
   <methodparam><type>string</type><parameter>pubkey</parameter></methodparam>
   <methodparam><type>string</type><parameter>privkey</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Identification en utilisant une clé publique depuis une variable.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>session</parameter></term>
    <listitem>
     <simpara>
      Un identifiant de connexion SSH, obtenu depuis la fonction
      <function>ssh2_connect</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>username</parameter></term>
    <listitem>
     <simpara>
       Nom de l'utilisateur à authentifier sur le serveur distant.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pubkey</parameter></term>
    <listitem>
     <simpara>
      La clé publique au format OpenSSH. Elle devrait ressembler à ceci :
      <literal>ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110</literal>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privkey</parameter></term>
    <listitem>
     <simpara>
      La clé privée au format OpenSSH. Elle devrait commencer par :
      <literal>-----BEGIN RSA PRIVATE KEY-----</literal>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>passphrase</parameter></term>
    <listitem>
     <simpara>
      Si <parameter>privkey</parameter> est chiffré (et devrait l'être),
      la passe-phrase doit être fournie.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <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'));
$publicKey = file_get_contents('/home/username/.ssh/id_rsa.pub');
$privateKey = file_get_contents('/home/username/.ssh/id_rsa');

if (ssh2_auth_pubkey($connection, 'username',
                     $publicKey,
                     $privateKey, 'secret')) {
  echo "Identification réussie en utilisant une clé publique\n";
} else {
  die('Échec de l\'identification en utilisant une clé publique');
}
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    La bibliothèque libssh sous-jacente ne supporte pas très proprement les
    authentifications partielles.
    C'est-à-dire que si l'on doit 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.
    Il faut ignorer cette erreur et continuer avec l'appel
    <function>ssh2_auth_password</function> pour terminer l'authentification.
   </simpara>
  </note>
 </refsect1>

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