mcrypt-generic-init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.mcrypt-generic-init" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_generic_init</refname>
  <refpurpose>暗号化に必要な全てのバッファを初期化する</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>mcrypt_generic_init</methodname>
   <methodparam><type>resource</type><parameter>td</parameter></methodparam>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam><type>string</type><parameter>iv</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mcrypt_generic</function> または
   <function>mdecrypt_generic</function> をコールする前に、
   常にこの関数をコールする必要があります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>td</parameter></term>
     <listitem>
      <para>
       暗号化記述子。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       キーの最大長は、<function>mcrypt_enc_get_key_size</function> を
       コールした際に得られるキー長であり、この値より小さな値は全て有効です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iv</parameter></term>
     <listitem>
      <para>
       IV は通常そのアルゴリズムのブロック長と同じ大きさですが、
       <function>mcrypt_enc_get_iv_size</function> をコールする
       ことにより、その大きさを得る必要があります。IV は ECB では
       無視されます。IV は CFB、CBC、STREAM、nOFB では必須です。
       IV はランダムで一意である必要があります(しかし、秘密ではある必要は
       ありません)。暗号化と復号で同じ IV を使用する必要があります。
       IV を使用したくない場合にはゼロに設定しますが、これは推奨されません。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   この関数は、エラー時に負の値を返します。キー長が不正な場合に
   -3、メモリの確保に問題があった場合に -4、そしてそれ以外の戻り値は
   その他のエラーとなります。エラーが警告を発生させた場合、それが
   表示されます。間違ったパラメータが渡された場合には &false;
   が返されます。
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mcrypt_module_open</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
-->