mcrypt-module-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f27cfeeefc13717f86a53d7fefa0ce54f7bfaaaf Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.mcrypt-module-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_module_open</refname>
  <refpurpose>Открывает модуль шифрования с использованием указанных алгоритма и режима</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>mcrypt_module_open</methodname>
   <methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
   <methodparam><type>string</type><parameter>algorithm_directory</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode_directory</parameter></methodparam>
  </methodsynopsis>
  <para>
   Открывает модуль шифрования с использованием указанных алгоритма и режима.
   Имя алгоритма задаётся его именем, например <literal>"twofish"</literal>, или
   с помощью константы <constant>MCRYPT_ciphername</constant>.  Закрыть модуль
   можно с помощью функции <function>mcrypt_module_close</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algorithm</parameter></term>
     <listitem>
      &mcrypt.parameter.cipher;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>algorithm_directory</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>algorithm_directory</parameter> используется для
       задания местонахождения модуля шифрования. Если передать пустую строку, то
       (<literal>""</literal>), то будет использовано значение директивы
       <literal>mcrypt.algorithms_dir</literal> из &php.ini;. Если же оно тоже не
       задано, то будет использована стандартная директория с которой
       компилировался libmcrypt (обычно <filename>/usr/local/lib/libmcrypt</filename>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      &mcrypt.parameter.mode;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode_directory</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>mode_directory</parameter> используется для
       задания местонахождения модуля режима. Если передать пустую строку, то
       (<literal>""</literal>), то будет использовано значение директивы
       <literal>mcrypt.modes_dir</literal> из &php.ini;. Если же оно тоже не
       задано, то будет использована стандартная директория, с которой
       компилировался libmcrypt (обычно <filename>/usr/local/lib/libmcrypt</filename>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Обычно возвращается дескриптор шифрования или &false; в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>mcrypt_module_open</function></title>
    <programlisting role="php">
<![CDATA[
<?php
    $td = mcrypt_module_open(MCRYPT_DES, '',
        MCRYPT_MODE_ECB, '/usr/lib/mcrypt-modes');

    $td = mcrypt_module_open('rijndael-256', '', 'ofb', '');
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   В первой строке примера мы пробуем открыть шифр <literal>DES</literal> из
   директории по умолчанию и использовать режим <literal>ECB</literal> из директории
   <filename>/usr/lib/mcrypt-modes</filename>. Во втором примере используем
   строковые имена шифра и режима, что работает только с модулем, собранным
   с библиотекой libmcrypt 2.4.x or 2.5.x.
  </para>

  <para>
   <example>
    <title>Пример использования <function>mcrypt_module_open</function></title>
    <programlisting role="php">
<![CDATA[
<?php
    /* Открываем модуль шифрования */
    $td = mcrypt_module_open('rijndael-256', '', 'ofb', '');

    /* Создаём инициализирующий вектор и определяем длину ключа.
     * Для ОС Windows указываем MCRYPT_RAND */
    $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_DEV_RANDOM);
    $ks = mcrypt_enc_get_key_size($td);

     /* Создаём ключ (только как пример: алгортим MD5 — плохой алгоритм хеширования для хранения секретов) */
    $key = substr(hash('md5', 'very secret key'), 0, $ks);

    /* Инициализируем шифрование */
    mcrypt_generic_init($td, $key, $iv);

    /* Шифруем данные */
    $encrypted = mcrypt_generic($td, 'This is very important data');

    /* Деинициализируем обработчик шифрования */
    mcrypt_generic_deinit($td);

    /* Инициализируем модуль дешифровки */
    mcrypt_generic_init($td, $key, $iv);

    /* Дешифруем данные */
    $decrypted = mdecrypt_generic($td, $encrypted);

    /* Деинициализируем обработчик дешифровки и закрываем модуль */
    mcrypt_generic_deinit($td);
    mcrypt_module_close($td);

    /* Печатаем строку */
    echo trim($decrypted) . "\n";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mcrypt_module_close</function></member>
    <member><function>mcrypt_generic</function></member>
    <member><function>mdecrypt_generic</function></member>
    <member><function>mcrypt_generic_init</function></member>
    <member><function>mcrypt_generic_deinit</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
-->