openssl-decrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e5ab2937efd9b1d7184993e0fdfa957893f7f827 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>Расшифровывает данные</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>
   Функция берёт необработанную или кодированную в base64 строку и расшифровывает её
   заданным методом и кодовой фразой.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Данные для расшифровки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       Метод шифрования. Список доступных методов возвращает функция
       <function>openssl_get_cipher_methods</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
       Кодовая фраза. Если кодовая фраза короче, чем ожидалось, она заполняется символами <literal>NUL</literal>;
       если кодовая фраза длиннее, чем ожидалось, она усекается.
      </para>
      <caution>
       <simpara>
        Для параметра <parameter>passphrase</parameter> не используется функция извлечения ключа,
        как можно предположить из его названия.
        Единственная операция, которая используется, – это заполнение символами
        <literal>NUL</literal> или усечение, если длина отличается от ожидаемой.
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       <parameter>options</parameter> можно задать одной из констант:
       <constant>OPENSSL_RAW_DATA</constant>,
       <constant>OPENSSL_ZERO_PADDING</constant>
       или <constant>OPENSSL_DONT_ZERO_PAD_KEY</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iv</parameter></term>
     <listitem>
      <para>
       Ненулевой (non-&null;) инициализирующий вектор.
       Если IV короче, чем ожидалось, он заполняется символами <literal>NUL</literal>
       и выдаётся предупреждение;
       если кодовая фраза длиннее, чем ожидалось, он усекается и выдаётся предупреждение.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>tag</parameter></term>
     <listitem>
      <para>
       Тег аутентификации в режиме шифрования AEAD. Если он некорректен, то
       аутентификация завершится неудачей и функция вернёт &false;.
      </para>
      <caution>
       <simpara>
        Длина <parameter>tag</parameter> не проверяется функцией.
        Вызывающая сторона несёт ответственность за то, чтобы длина тега
        соответствовала длине тега, полученного при вызове <function>openssl_encrypt</function>.
        В противном случае дешифрование может быть успешным, если данный тег
        совпадает только с началом правильного тега.
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>aad</parameter></term>
     <listitem>
      <para>
       Дополнительные аутентифицированные данные.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает расшифрованную строку&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выдаёт ошибку уровня <constant>E_WARNING</constant>, если в параметр
   <parameter>cipher_algo</parameter> передали неизвестный алгоритм шифрования.
  </para>
  <para>
   Функция выдаёт ошибку уровня <constant>E_WARNING</constant>, если в параметр
   <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> теперь принимает значение null.
      </entry>
     </row>
     <row>
      <entry>7.1.0</entry>
      <entry>Добавили параметры <parameter>tag</parameter> и <parameter>aad</parameter>.</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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