openssl-x509-checkpurpose.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 497c40ac164d5873fd87f622dfdeb5206392b446 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-x509-checkpurpose" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_x509_checkpurpose</refname>
  <refpurpose>Vérifie l'usage d'un certificat</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>bool</type><type>int</type></type><methodname>openssl_x509_checkpurpose</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type>int</type><parameter>purpose</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_file</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_x509_checkpurpose</function> examine le certificat
   spécifié par <parameter>certificate</parameter>, pour voir s'il peut être
   utilisé pour une opération particulière <parameter>purpose</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       Le certificat examiné.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>purpose</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Utilisation de <function>openssl_x509_checkpurpose</function></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Constante</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>X509_PURPOSE_SSL_CLIENT</entry>
           <entry>
            Est-ce que le certificat peut être utilisé avec le client d'une
            connexion SSL ?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SSL_SERVER</entry>
           <entry>
            Est-ce que le certificat peut être utilisé avec le serveur d'une
            connexion SSL ?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_NS_SSL_SERVER</entry>
           <entry>
            Est-ce que le certificat peut être utilisé avec un serveur
            Netscape d'une connexion SSL ?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_SIGN</entry>
           <entry>
            Est-ce que le certificat peut être utilisé pour signer des
            courriers à la norme S/MIME ?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_ENCRYPT</entry>
           <entry>
            Est-ce que le certificat peut être utilisé pour
            chiffrer un courrier au format S/MIME ?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_CRL_SIGN</entry>
           <entry>
            Est-ce que le certificat peut être utilisé pour
            chiffrer une liste de révocation de certificats ?
            (CRL)?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_ANY</entry>
           <entry>
            Est-ce que le certificat peut être utilisé pour
            n'importe lequel de ces cas ?
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
       Ces options ne sont pas des champs de bits :  vous ne pouvez en
       passer qu'une seule à la fois.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ca_info</parameter></term>
     <listitem>
      <para>
       <parameter>ca_info</parameter> doit être un tableau de dossiers/fichiers
       de CA de confiance comme décrit dans la
       <link linkend="openssl.cert.verification">Vérification des certificats</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>untrusted_certificates_file</parameter></term>
     <listitem>
      <para>
       Si spécifié, est le nom d'un fichier au format <acronym>PEM</acronym> contenant les
       certificats qui pourront aider lors de la vérification du certificat,
       même si une confiance limitée doit leur être portée.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne &true; si le certificat peut être utilisé pour un but particulier,
   &false; s'il ne le peut pas, ou -1 si une erreur survient.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>certificate</parameter> accepte désormais une instance de
       <classname>OpenSSLCertificate</classname> ;
       auparavant, une &resource; de type <literal>OpenSSL X.509</literal> était acceptée.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>untrusted_certificates_file</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->