archived-doc-ru/reference/mcrypt/functions/mcrypt-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e849a6c4225bd992474793ec6983df7898cae0be Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-encrypt">
 <refnamediv>
  <refname>mcrypt_encrypt</refname>
  <refpurpose>Шифрует текст с заданными параметрами</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mcrypt_encrypt</methodname>
   <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Шифрует данные.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>cipher</parameter></term>
    <listitem>
     &mcrypt.parameter.cipher;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>key</parameter></term>
    <listitem>
     <simpara>
      Ключ, с которым будут шифроваться данные. Если длина ключа не соответствует
      требованием шифра, то будет возвращено &false; и выдано предупреждение.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <simpara>
      Данные, которые будут зашифрованы с помощью шифра <parameter>cipher</parameter>
      и режима <parameter>mode</parameter>. Если размер данных не кратен размеру
      блока, то они будут дополнены символами '<literal>\0</literal>'.
     </simpara>
     <simpara>
      Размер возвращаемого текста может быть больше размера
      исходных данных <parameter>data</parameter>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     &mcrypt.parameter.mode;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>iv</parameter></term>
    <listitem>
     &mcrypt.parameter.iv.strict;
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Возвращает строку с зашифрованными данными&return.falseforfailure;.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования <function>mcrypt_encrypt</function></title>
   <programlisting role="php">
<![CDATA[
<?php
    # --- ШИФРОВАНИЕ ---

    # ключ должен представлять собой случайную бинарную строку.
    # Для преобразовангия строки в ключ используйте scrypt, bcrypt или PBKDF2
    # Ключ задаётся в виде строки шестнадцатеричных чисел
    $key = pack('H*', "bcb04b7e103a0cd8b54763051cef08bc55abe029fdebae5e1d417e2ffb2a00a3");

    # Показываем длину ключа.
    # Длина ключа должна быть 16, 24 или 32 байт для AES-128, 192 и 256 соответственно
    $key_size =  strlen($key);
    echo "Длина ключа: " . $key_size . "\n";

    $plaintext = "This string was AES-256 / CBC / ZeroBytePadding encrypted.";

    # Создаём случайный инициализирующий вектор используя режим CBC
    $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
    $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);

    # Создаём шифрованный текст совместимыс с AES (размер блока = 128)
    # Подходит только для строк не заканчивающихся на 00h
    # (потому как это символ дополнения по умолчанию)
    $ciphertext = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key,
                                 $plaintext, MCRYPT_MODE_CBC, $iv);

    # Добавляем инициализирующий вектор в начало, чтобы он был доступен для расшифровки
    $ciphertext = $iv . $ciphertext;

    # перекодируем зашифрованный текст в base64
    $ciphertext_base64 = base64_encode($ciphertext);

    echo  $ciphertext_base64 . "\n";

    # === ВНИМАНИЕ ===

    # Результирующий шифрованный текст не имеет целостности или аутентичности и не
    # защищён от атак padding oracle.

    # --- ДЕШИФРОВКА ---

    $ciphertext_dec = base64_decode($ciphertext_base64);

    # Извлекаем инициализирующий вектор. Длина вектора ($iv_size) должна совпадать
    # с тем, что возвращает функция mcrypt_get_iv_size()
    $iv_dec = substr($ciphertext_dec, 0, $iv_size);

    # Извлекаем зашифрованный текст
    $ciphertext_dec = substr($ciphertext_dec, $iv_size);

    # Отбрасываем завершающие символы 00h
    $plaintext_dec = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key,
                                    $ciphertext_dec, MCRYPT_MODE_CBC, $iv_dec);

    echo  $plaintext_dec . "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
Длина ключа: 32
ENJW8mS2KaJoNB5E5CoSAAu0xARgsR1bdzFWpEn+poYw45q+73az5kYi4j+0haevext1dGrcW8Qi59txfCBV8BBj3bzRP3dFCp3CPQSJ8eU=
This string was AES-256 / CBC / ZeroBytePadding encrypted.
]]>
   </screen>
  </example>
 </refsect1>

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