openssl-sign.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-sign" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_sign</refname>
  <refpurpose>Signe les données</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_sign</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">signature</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>algorithm</parameter><initializer><constant>OPENSSL_ALGO_SHA1</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_sign</function> calcule la signature des données
   <parameter>data</parameter> en générant une signature digitale cryptographique
   en utilisant la clé privée associée avec le paramètre
   <parameter>private_key</parameter>. Notez que les données elles-mêmes
   ne sont pas chiffrées.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       La chaîne de données que vous souhaitez signer.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signature</parameter></term>
     <listitem>
      <para>
       Si l'appel à la fonction est un succès, la signature sera
       retournée dans le paramètre
       <parameter>signature</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
       <classname>OpenSSLAsymmetricKey</classname> - une clé, retournée par la fonction
       <function>openssl_get_privatekey</function>
      </para>
      <para>
       <type>string</type> - une clé au format <acronym>PEM</acronym>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>algorithm</parameter></term>
     <listitem>
      <para>
       <type>int</type> - une des <link linkend="openssl.signature-algos">signatures d'algorithmes</link>.
      </para>
      <para>
       <type>string</type> - une chaîne valide retournée par la fonction
       <function>openssl_get_md_methods</function>, par exemple : "sha256WithRSAEncryption" ou "sha384".
      </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>private_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="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>openssl_sign</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// On suppose que $data contient les données à signer

// lecture de la clé publique pour chaque destinataire
$pkeyid = openssl_pkey_get_private("file://src/openssl-0.9.6/demos/sign/key.pem");

// calcule de la signature
openssl_sign($data, $signature, $pkeyid);

// libère les clés de la mémoire
openssl_free_key($pkeyid);
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Exemple avec <function>openssl_sign</function></title>
    <programlisting role="php">
<![CDATA[
<?php
//données que vous souhaitez signer
$data = 'my data';

//Crée une nouvelle clé privée et publique
$new_key_pair = openssl_pkey_new(array(
    "private_key_bits" => 2048,
    "private_key_type" => OPENSSL_KEYTYPE_RSA,
));
openssl_pkey_export($new_key_pair, $private_key_pem);

$details = openssl_pkey_get_details($new_key_pair);
$public_key_pem = $details['key'];

//Création de la signature
openssl_sign($data, $signature, $private_key_pem, OPENSSL_ALGO_SHA256);

//Sauvegarde pour utilisation ultérieur
file_put_contents('private_key.pem', $private_key_pem);
file_put_contents('public_key.pem', $public_key_pem);
file_put_contents('signature.dat', $signature);

//Vérification de la signature
$r = openssl_verify($data, $signature, $public_key_pem, "sha256WithRSAEncryption");
var_dump($r);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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