<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.openssl-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>openssl_decrypt</refname>

<refpurpose>Déchiffre les données</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>openssl_decrypt</methodname>

<methodparam><type>string</type><parameter>data</parameter></methodparam>

<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>

<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><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 class="union"><type>string</type><type>null</type></type><parameter>tag</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>

</methodsynopsis>

<para>

Prend une chaîne brute ou base64 encodée et la déchiffre en utilisant

la méthode et la passe de phrase passées.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>data</parameter></term>

<listitem>

<para>

Le message chiffré à déchiffrer.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>cipher_algo</parameter></term>

<listitem>

<para>

L'algorithme de chiffrement. Pour la liste des algorithmes de chiffrement

disponible, utiliser <function>openssl_get_cipher_methods</function>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>passphrase</parameter></term>

<listitem>

<para>

La phrase de passe. Si la phrase de passe est plus courte que prévu, elle est silencieusement

complétée avec des caractères <literal>NUL</literal> ; si la phrase de passe est plus longue que prévu,

elle est silencieusement tronquée.

</para>

<caution>

<simpara>

Il n'y a pas de fonction de dérivation de clé utilisée pour le paramètre <parameter>passphrase</parameter>

comme son nom pourrait le suggérer. La seule opération utilisée est le remplissage avec des caractères

<literal>NUL</literal> ou la troncature si la longueur est différente de celle attendue.

</simpara>

</caution>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>options</parameter></term>

<listitem>

<para>

Le paramètre <parameter>options</parameter> peut

prendre comme valeur

<constant>OPENSSL_RAW_DATA</constant> ou

<constant>OPENSSL_ZERO_PADDING</constant>

ou <constant>OPENSSL_DONT_ZERO_PAD_KEY</constant>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>iv</parameter></term>

<listitem>

<para>

Un vecteur d'initialisation non-&null;. Si le VI est plus court que prévu, il est complété avec

des caractères <literal>NUL</literal> et un avertissement est émis ; si le VI est plus long

que prévu, il est tronqué et un avertissement est émis.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>tag</parameter></term>

<listitem>

<para>

La balise d'authentification en mode de chiffrement AEAD. Si elle est incorrecte, l'authentification échoue et la fonction retourne &false;.

</para>

<caution>

<simpara>

La longueur de <parameter>tag</parameter> n'est pas vérifiée par la fonction.

C'est la responsabilité de l'appelant de s'assurer que la longueur du

tag correspond à la longueur du tag reçu quand

<function>openssl_encrypt</function> a été appelée. Sinon, le

déchiffrement peut réussir si le début du tag donné correspond au début

du vrai tag.

</simpara>

</caution>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>aad</parameter></term>

<listitem>

<para>

Données supplémentaires authentifiées.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

La chaîne dé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é via <parameter>cipher_algo</parameter>.

</para>

<para>

Émet une erreur de niveau <constant>E_WARNING</constant> si une valeur

vide est passée 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>8.1.0</entry>

<entry><parameter>tag</parameter> est désormais nullable.</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>Les paramètres <parameter>tag</parameter> et <parameter>aad</parameter> ont été ajoutés.</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>openssl_encrypt</function></member>

</simplelist>

</para>

</refsect1>

</refentry>