openssl-seal.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 110ac43250fdb3531fe26d4d29292e33df7855e8 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-seal" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_seal</refname>
  <refpurpose>Scelle des données</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>openssl_seal</methodname>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">sealed_data</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">encrypted_keys</parameter></methodparam>
   <methodparam><type>array</type><parameter>public_key</parameter></methodparam>
   <methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">iv</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   La <function>openssl_seal</function> scelle (chiffre) <parameter>data</parameter> en utilisant le
   <parameter>cipher_algo</parameter> spécifié avec une clé secrète générée aléatoirement. La clé est
   ensuite chiffrée avec chacune des clés publiques dans le tableau <parameter>public_key</parameter>,
   et chaque clé d'enveloppe chiffrée est retournée dans <parameter>encrypted_keys</parameter>. Cela permet
   d'envoyer des données scellées à plusieurs destinataires (à condition que leurs clés publiques soient disponibles).
   Chaque destinataire doit recevoir à la fois les données scellées et la clé d'enveloppe qui a été chiffrée avec
   la clé publique du destinataire. Le VI (vecteur d'initialisation) est généré, et sa valeur est retournée dans
   <parameter>iv</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Les données à sceller
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sealed_data</parameter></term>
     <listitem>
      <para>
       Les données scellées.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encrypted_keys</parameter></term>
     <listitem>
      <para>
       Tableau des clés chiffrées.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>public_key</parameter></term>
     <listitem>
      <para>
       Tableau d'instances <classname>OpenSSLAsymmetricKey</classname>
       contenant les clés publiques.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       La méthode de chiffrement.
       <caution>
        <simpara>
         La valeur par défaut pour les versions de PHP antérieures à 8.0 est (<literal>'RC4'</literal>), qui est
         considérée comme non sécurisée. Il est fortement recommandé de spécifier explicitement une méthode de chiffrement
         sécurisée.
        </simpara>
       </caution>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iv</parameter></term>
     <listitem>
      <para>
       Le vecteur d'initialisation pour le déchiffrement de <parameter>data</parameter>. Il est requis si
       la méthode de chiffrement nécessite un VI. Cela peut être déterminé en appelant
       <function>openssl_cipher_iv_length</function> avec <parameter>cipher_algo</parameter>.
      </para>
      <caution>
       <simpara>
        Le VI ne peut pas être défini explicitement. Toute valeur qui y est définie est écrasée par une valeur
        générée aléatoirement.
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la longueur des données
   scellées en cas de succès, et &false; sinon.
   En cas de succès, les données scellées sont
   placées dans le paramètre <parameter>sealed_data</parameter>,
   et les clés d'enveloppe dans <parameter>encrypted_keys</parameter>.
  </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>public_key</parameter> accepte désormais un &array;
       d'instance de <classname>OpenSSLAsymmetricKey</classname> ;
       auparavant, un &array; de &resource;s de type <literal>OpenSSL key</literal>
       était acceptée.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>cipher_algo</parameter> n'est désormais plus un paramètre optionnel.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>iv</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>openssl_seal</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$data = "test";

// récupérer les clés publiques
$pk1 = openssl_get_publickey("file://cert1.pem");
$pk2 = openssl_get_publickey("file://cert2.pem");


// scelle le message : seuls, les possesseurs de $pk1 et $pk2 peuvent déchiffrer
// le message $sealed avec les clés $ekeys[0] et $ekeys[1] (respectivement).
openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2));

if (openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2), 'AES256', $iv) > 0) {
    // éventuellement stocker les valeurs $sealed et $iv et les utiliser plus tard dans openssl_open
    echo "succès\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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