mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 09:22:07 +01:00
237 lines
7.5 KiB
XML
237 lines
7.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 9fc8bcc0836f56a98cf432c8f933e0d96c8d680a Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<refentry xml:id="function.openssl-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>openssl_encrypt</refname>
|
|
<refpurpose>Chiffre les données</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_encrypt</methodname>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>passphrase</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>iv</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter role="reference">tag</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>tag_length</parameter><initializer>16</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Chiffre les données passées avec la méthode et la clé précisées. Retourne une
|
|
&string; brute ou encodé en base64.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Les données du message en texte brut à chiffrer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>cipher_algo</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La méthode de cipher. Pour une liste des méthodes de cipher disponible,
|
|
utiliser <function>openssl_get_cipher_methods</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>passphrase</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La passphrase. Si la passphrase est plus courte qu'attendu, elle est silencieusement
|
|
capitonné avec des caractères <literal>NUL</literal>; si la passphrase est plus longue
|
|
qu'attendu, elle est silencieusement tronqué.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>options</parameter> est une disjonction au niveau des bits des drapeaux
|
|
<constant>OPENSSL_RAW_DATA</constant> et
|
|
<constant>OPENSSL_ZERO_PADDING</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>iv</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Un vecteur d'initialisation non-nul.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>tag</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le tag d'authentification passé par référence lors de l'utilisation du mode
|
|
cipher AEAD (GCM ou CCM).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>aad</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Données supplémentaires authentifiées.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>tag_length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La longueur du <parameter>tag</parameter> d'authentification.
|
|
Sa valeur peut être entre 4 et 16 pour le mode GCM.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne la chaine chiffrée en cas de succès &return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Émet une erreur de niveau <constant>E_WARNING</constant> si un algorithme cipher
|
|
inconnu est passé comme paramètre <parameter>cipher_algo</parameter>.
|
|
</para>
|
|
<para>
|
|
Émet une erreur de niveau <constant>E_WARNING</constant> si une valeur
|
|
vide est passé comme paramètre <parameter>iv</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>7.1.0</entry>
|
|
<entry>Les paramètres <parameter>tag</parameter>, <parameter>aad</parameter> et <parameter>tag_length</parameter> ont été ajoutés.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Exemple de chiffrement authentifié AES en mode GCM pour PHP 7.1+</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
//$key devrait être généré précédemment d'une manière cryptographique, tel que openssl_random_pseudo_bytes
|
|
$plaintext = "message to be encrypted";
|
|
$cipher = "aes-128-gcm";
|
|
if (in_array($cipher, openssl_get_cipher_methods()))
|
|
{
|
|
$ivlen = openssl_cipher_iv_length($cipher);
|
|
$iv = openssl_random_pseudo_bytes($ivlen);
|
|
$ciphertext = openssl_encrypt($plaintext, $cipher, $key, $options=0, $iv, $tag);
|
|
//store $cipher, $iv, and $tag for decryption later
|
|
$original_plaintext = openssl_decrypt($ciphertext, $cipher, $key, $options=0, $iv, $tag);
|
|
echo $original_plaintext."\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Exemple de chiffrement authentifié AES en mode GCM antérieur à PHP 7.1</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
//$key devrait être généré précédemment d'une manière cryptographique, tel que openssl_random_pseudo_bytes
|
|
$plaintext = "message to be encrypted";
|
|
$ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC");
|
|
$iv = openssl_random_pseudo_bytes($ivlen);
|
|
$ciphertext_raw = openssl_encrypt($plaintext, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv);
|
|
$hmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true);
|
|
$ciphertext = base64_encode( $iv.$hmac.$ciphertext_raw );
|
|
|
|
// déchiffrer plus tard ...
|
|
$c = base64_decode($ciphertext);
|
|
$ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC");
|
|
$iv = substr($c, 0, $ivlen);
|
|
$hmac = substr($c, $ivlen, $sha2len=32);
|
|
$ciphertext_raw = substr($c, $ivlen+$sha2len);
|
|
$original_plaintext = openssl_decrypt($ciphertext_raw, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv);
|
|
$calcmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true);
|
|
if (hash_equals($hmac, $calcmac))// timing attack safe comparison
|
|
{
|
|
echo $original_plaintext."\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>openssl_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
|
|
-->
|