openssl-public-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7da0f9995a1a6928523f8d910898e79d88f45d5f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-public-encrypt" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_public_encrypt</refname>
  <refpurpose>Chiffre des données avec une clé publique</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_public_encrypt</methodname>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">encrypted_data</parameter></methodparam>
   <methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>public_key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer><constant>OPENSSL_PKCS1_PADDING</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_public_encrypt</function> chiffre les données
   <parameter>data</parameter> avec la clé publique
   <parameter>public_key</parameter> et stocke le résultat dans <parameter>encrypted_data</parameter>.
   Les données chiffrées peuvent être déchiffrées avec la fonction
   <function>openssl_private_decrypt</function>.
  </para>
  <para>
   Cette fonction peut être utilisée pour chiffrer un message qui pourra être lu
   uniquement par le propriétaire de la clé privée. Elle peut être également utilisée
   pour stocker des données sécurisées dans une base de données.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encrypted_data</parameter></term>
     <listitem>
      <para>
       Contiendra le résultat du chiffrage.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>public_key</parameter></term>
     <listitem>
      <para>
       <parameter>public_key</parameter> doit être la clé publique correspondant
       à la clé privée qui sera utilisée pour décrypter les données.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>padding</parameter></term>
     <listitem>
      <para>
       <parameter>padding</parameter> peut être
       <constant>OPENSSL_PKCS1_PADDING</constant>,
       <constant>OPENSSL_SSLV23_PADDING</constant>,
       <constant>OPENSSL_PKCS1_OAEP_PADDING</constant> ou
       <constant>OPENSSL_NO_PADDING</constant>.
      </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.0.0</entry>
      <entry>
       <parameter>public_key</parameter> accepte désormais une instance de
       <classname>OpenSSLAsymmetricKey</classname> ou <classname>OpenSSLCertificate</classname> ;
       auparavant, une &resource; de type <literal>OpenSSL key</literal> ou <literal>OpenSSL X.509</literal>
       était acceptée.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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