doc-fr/reference/openssl/functions/openssl-pkcs7-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0773339dce767078f1ee0e55cc1c0428e02ae0ad Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-pkcs7-encrypt" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkcs7_encrypt</refname>
  <refpurpose>Chiffre un message S/MIME</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs7_encrypt</methodname>
   <methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs7_encrypt</function> prend le contenu du fichier
   <parameter>input_filename</parameter> et le chiffre en utilisant un
   chiffrement RC2 à 40-bit, de manière que le message ne puisse
   être lu que par le possesseur de <parameter>certificate</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>input_filename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output_filename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       Soit un certificat X.509, soit un tableau de certificats X.509.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>headers</parameter></term>
     <listitem>
      <para>
       <parameter>headers</parameter> est un tableau d'en-têtes qui seront
       ajoutés en tête de message, une fois que les données auront été
       chiffrées.
      </para>
      <para>
       <parameter>headers</parameter> peut être un tableau associatif, dont
       les clés sont les noms d'en-tête, ou bien un tableau indexé dont chaque
       ligne contient un en-tête complet.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> peut être utilisé pour spécifier
       des options qui affecteront le chiffrement (voir les
       <link linkend="openssl.pkcs7.flags">constantes PKCS7</link>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       Une des <link linkend="openssl.ciphers">constantes cipher</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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.1.0</entry>
      <entry>
       L'algorithme de chiffrement par défaut (<parameter>cipher_algo</parameter>)
       est désormais AES-128-CBC (<constant>OPENSSL_CIPHER_AES_128_CBC</constant>).
       Auparavant, PKCS7/CMS était utilisé (<constant>OPENSSL_CIPHER_RC2_40</constant>).
      </entry>
     </row>
     <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 CSR</literal> était acceptée.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>openssl_pkcs7_encrypt</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// le message que vous souhaitez chiffrer et envoyer à votre agent secret
// en mission commandée, appelé "nighthawk". Vous avez son certificat
// dans le fichier "nighthawk.pem"
$data = <<<EOD
Nighthawk,

Top secret, uniquement votre lecture !

L'ennemi approche! Rendez-vous au café à 8 h 30,
pour votre faux passeport.

HQ
EOD;

// Chargement de la clé
$key = file_get_contents("nighthawk.pem");

// Sauvegarde du message dans un fichier
$fp = fopen("msg.txt", "w");
fwrite($fp, $data);
fclose($fp);

// Chiffrons-le
if (openssl_pkcs7_encrypt("msg.txt", "enc.txt", $key,
    array("To" => "nighthawk@example.com", // syntaxe sous forme de clé
          "From: HQ <hq@example.com>", // syntaxe sous forme d'indexe
          "Subject" => "Que pour vos yeux !"))) {
    // message chiffré - envoyez-le !
    exec(ini_get("sendmail_path") . " < enc.txt");
}
?>
]]>
    </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
-->