gnupg-verify.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 766fa972bca0f6ea8711f6e27d68278be41db17a Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.gnupg-verify" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gnupg_verify</refname>
  <refpurpose>Vérifie un texte signé</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>gnupg_verify</methodname>
   <methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>signed_text</parameter></methodparam>
   <methodparam><type>string</type><parameter>signature</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">plaintext</parameter></methodparam>
  </methodsynopsis>
  <para>
   Vérifie le paramètre <parameter>signed_text</parameter> et retourne les
   informations à propos de la signature.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>identifier</parameter></term>
     <listitem>
      &gnupg.identifier;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signed_text</parameter></term>
     <listitem>
      <para>
       Le texte signé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signature</parameter></term>
     <listitem>
      <para>
       La signature. Pour vérifier un texte signé en clair, fixez la signature
       à &false;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>plaintext</parameter></term>
     <listitem>
      <para>
       Le texte. Si ce paramètre optionnel est passé, il
       est rempli avec le <parameter>plaintext</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   En cas de succès, cette fonction retourne des informations à propos de la
   signature.
   En cas d'échec, cette fonction retourne &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>gnupg_verify</function> (Style procédural)</title>
    <programlisting role="php">
<![CDATA[
<?php
$plaintext = "";
$res = gnupg_init();
// signé en clair
$info = gnupg_verify($res,$signed_text,false,$plaintext);
print_r($info);
// signature détachée
$info = gnupg_verify($res,$signed_text,$signature);
print_r($info);
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Exemple avec <function>gnupg_verify</function> (Style orienté objet)</title>
    <programlisting role="php">
<![CDATA[
<?php
$plaintext = "";
$gpg = new gnupg();
// signé en clair
$info = $gpg->verify($signed_text,false,$plaintext);
print_r($info);
// signature détachée
$info = $gpg->verify($signed_text,$signature);
print_r($info);
?>
]]>
    </programlisting>
   </example>
  </para>
 </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
-->