ssl.xml

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

<refentry xml:id="context.ssl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="verify_info:false">
 <refnamediv>
  <refname>Options de contexte SSL</refname>
  <refpurpose>Liste des options de contexte SSL</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   Options de contexte pour les protocoles <literal>ssl://</literal>
   et <literal>tls://</literal>.
  </para>
 </refsect1>
 
 <refsect1 role="options"><!-- {{{ -->
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.ssl.peer-name">
     <term>
      <parameter>peer_name</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Nom de paires à utiliser. Si cette valeur n'est pas définie, alors le
       nom sera deviné en se basant sur le nom d'hôte utilisé lors de
       l'ouverture du flux.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.verify-peer">
     <term>
      <parameter>verify_peer</parameter>
      <type>&boolean;</type>
     </term>
     <listitem>
      <para>
       Nécessite une vérification du certificat SSL utilisé.
      </para>
      <para>
       Par défaut, vaut &true;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.verify-peer-name">
     <term>
      <parameter>verify_peer_name</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Nécessite la vérification du nom de paires.
      </para>
      <para>
       Par défaut, vaut &true;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.allow-self-signed">
     <term>
      <parameter>allow_self_signed</parameter>
      <type>&boolean;</type>
     </term>
     <listitem>
      <para>
       Permet les certificats autosignés. Requière le
       paramètre <link linkend="context.ssl.verify-peer"><parameter>verify_peer</parameter></link>.
      </para>
      <para>
       Par défaut, vaut &false;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.cafile">
     <term>
      <parameter>cafile</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Endroit où se trouve le fichier de l'autorité du certificat
       sur le système de fichiers local et qui devra être utilisé
       avec l'option de contexte <literal>verify_peer</literal>
       pour identifier le pair distant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.capath">
     <term>
      <parameter>capath</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Si <literal>cafile</literal> n'est pas spécifié ou si le certificat
       n'a pas été trouvé, une recherche dans le dossier pointé par
       <literal>capath</literal> sera effectuée afin d'y trouver un certificat
       valide. <literal>capath</literal> doit être un dossier de certificat valide.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.local-cert">
     <term>
      <parameter>local_cert</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Chemin vers le certificat local, sur le système de fichiers.
       Ce doit être un fichier encodé <acronym>PEM</acronym> qui contient votre certificat
       et votre clé privée. Il peut, optionnellement, contenir la
       chaîne de certification de l'émetteur.
       La clé privée peut également être contenue dans un fichier distinct 
       spécifié par <literal>local_pk</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.local-pk">
     <term>
      <parameter>local_pk</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Chemin d'accès au fichier de clé privée locale sur le système de 
       fichiers dans le cas de fichiers distincts pour le certificat 
       (<literal>local_cert</literal>) et la clé privée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.passphrase">
     <term>
      <parameter>passphrase</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       La phrase passe avec laquelle votre fichier
       <literal>local_cert</literal> a été encodé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.verify-depth">
     <term>
      <parameter>verify_depth</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       Échoue si la chaîne de certification est trop profonde.
      </para>
      <para>
       Par défaut, aucune vérification.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.ciphers">
     <term>
      <parameter>ciphers</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Définit la liste des chiffrements. Le format de la chaîne est décrite
       sur la page <link xlink:href="&url.openssl.ciphers;">ciphers(1)</link>.
      </para>
      <para>
       Par défaut, vaut <literal>DEFAULT</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.capture-peer-cert">
     <term>
      <parameter>capture_peer_cert</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Si définit à &true;, un option de contexte <literal>peer_certificate</literal>
       sera créée, contenant le certificat de l'émetteur.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.capture-peer-cert-chain">
     <term>
      <parameter>capture_peer_cert_chain</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Si définit à &true;, une option de contexte <literal>peer_certificate_chain</literal>
       sera créée, contenant la chaîne de certification.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.sni-enabled">
     <term>
      <parameter>SNI_enabled</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Si vaut &true;, l'indication sur le nom du serveur sera activée.
       Le fait d'activer SNI permet d'utiliser plusieurs certificats
       sur la même adresse IP.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.disable-compression">
     <term>
      <parameter>disable_compression</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Si défini, la compression TLS sera désactivée.
       Cela peut aider à mitiger le vecteur d'attaque CRIME.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.peer-fingerprint">
     <term>
      <parameter>peer_fingerprint</parameter>
      <type>string</type> | <type>array</type>
     </term>
     <listitem>
      <para>
       Stop lorsque le certificat digest distant ne correspond pas au hash spécifié.
      </para>
      <para>
       Lorsqu'une &string; est utilisée, la longueur va déterminer l'algorithme
       de hachage utilisé, soit "md5" (32), soit "sha1" (40).
      </para>
      <para>
       Lorsqu'un &array; est utilisé, la clé indique le nom de l'algorithme de
       hachage, et chaque valeur correspondante représente le digest attendu.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ssl.security-level">
     <term>
      <parameter>security_level</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       Définie le niveau de sécurité. Si non spécifié le niveau de sécurité par
       défaut est utilisé.
       Les niveaux de sécurités sont décrit dans 
       <link xlink:href="&url.openssl.security-level;">SSL_CTX_get_security_level(3)</link>.
      </para>
      <para>
       Disponible à partir de PHP 7.2.0 et OpenSSL 1.1.0.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Ajout de <parameter>security_level</parameter>. Requit OpenSSL &gt;= 1.1.0.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    Vu que <literal>ssl://</literal> est un protocole sous-jacent pour
    les gestionnaires <link linkend="wrappers.http"><literal>https://</literal></link> et
    <link linkend="wrappers.ftp"><literal>ftps://</literal></link>,
    toutes les options de contexte appliquées à <literal>ssl://</literal>
    seront également appliquées à <literal>https://</literal> et <literal>ftps://</literal>.
   </simpara>
  </note>
  <note>
   <simpara>
    Afin que SNI (Server Name Indication) soit disponible, PHP doit
    être compilé avec OpenSSL 0.9.8j ou supérieur. Utilisez la
    constante <constant>OPENSSL_TLSEXT_SERVER_NAME</constant> pour
    déterminer si SNI est supporté ou non.
   </simpara>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="context.socket" /></member>
   </simplelist>
  </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
-->