openssl-cms-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96263b14054f0f102fcc653688ff3ed99f9df858 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.openssl-cms-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>openssl_cms_encrypt</refname>
  <refpurpose>Chiffre un message CMS</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_cms_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>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Cette fonction chiffre le contenu pour un ou plusieurs destinataires,
   basé sur les certificats qui lui sont passés.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>input_filename</parameter></term>
    <listitem>
     <para>
       Le fichier à chiffrer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>output_filename</parameter></term>
    <listitem>
     <para>
      Le fichier de sortie.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>certificate</parameter></term>
    <listitem>
     <para>
      Les destinataires à chiffrer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>headers</parameter></term>
    <listitem>
     <para>
      Les en-têtes à inclure lors de l'utilisation de S/MIME.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Les drapeaux à passer à CMS_sign.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      Un encodage de sortie. Une des constantes <constant>OPENSSL_ENCODING_SMIME</constant>,
      <constant>OPENSSL_ENCODING_DER</constant> ou <constant>OPENSSL_ENCODING_PEM</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>cipher_algo</parameter></term>
    <listitem>
     <para>
      Le chiffrement à utiliser.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </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 maintenant
       AES-128-CBC (<constant>OPENSSL_CIPHER_AES_128_CBC</constant>). Précédemment,
       PKCS7/CMS était utilisé (<constant>OPENSSL_CIPHER_RC2_40</constant>).
      </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
-->