archived-doc-ja/reference/mcrypt/functions/mcrypt-module-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e849a6c4225bd992474793ec6983df7898cae0be Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-open">
 <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>
  <simpara>
   この関数は、使用するアルゴリズムおよびモードのモジュールをオープン
   します。アルゴリズム名は、たとえば "<literal>twofish</literal>"
   のように名前で指定するか定数 <constant>MCRYPT_暗号名</constant> のいずれかを使用して指定します。
   ライブラリは <function>mcrypt_module_close</function> をコールする
   ことによりクローズされます。
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>algorithm</parameter></term>
    <listitem>
     &mcrypt.parameter.cipher;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>algorithm_directory</parameter></term>
    <listitem>
     <simpara>
      暗号化モジュールの位置を指定する際には
      <parameter>algorithm_directory</parameter> を使います。
      ディレクトリ名を指定した場合には、これが使用されます。
      これらの一つに空の文字列(<literal>""</literal>)を指定した場合、&php.ini; ディレクティブ
      <parameter>mcrypt.algorithms_dir</parameter> に設定された値を使います。
      これらが設定されていない場合、libmcrypt をコンパイルした際の
      デフォルトのディレクトリ (通常は<filename>/usr/local/lib/libmcrypt</filename>)
      を使います。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     &mcrypt.parameter.mode;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode_directory</parameter></term>
    <listitem>
     <simpara>
      暗号化モジュールの位置を指定する際には
      <parameter>mode_directory</parameter> を使います。
      ディレクトリ名を指定した場合には、これが使用されます。
      これらの一つに空の文字列(<literal>""</literal>)を指定した場合、&php.ini; ディレクティブ
      <literal>mcrypt.modes_dir</literal> に設定された値を使います。
      これらが設定されていない場合、libmcrypt をコンパイルした際の
      デフォルトのディレクトリ (通常は<filename>/usr/local/lib/libmcrypt</filename>)
      を使います。
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   通常は暗号化記述子を返します。エラー時は &false; を返します。
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <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>
  <simpara>
   上の例の最初の行では、デフォルトのディレクトリから <literal>DES</literal> 暗号化を、
   そして <filename>/usr/lib/mcrypt-modes</filename> から <literal>ECB</literal> モードの
   オープンを試みます。2 行目の例では暗号化形式とモードを文字列で
   指定しています。これは、libmcrypt 2.4.x あるいは 2.5.x に対して
   拡張モジュールがリンクされている場合にのみ使用可能です。
  </simpara>

  <example>
   <title><function>mcrypt_module_open</function> を暗号化で使用する</title>
   <programlisting role="php">
<![CDATA[
<?php
    /* 暗号モジュールをオープンします */
    $td = mcrypt_module_open('rijndael-256', '', 'ofb', '');

    /* IV を作成し、キー長を定義します。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>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <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>
 </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
-->