1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-25 23:52:16 +01:00
Files
archived-doc-ja/reference/mcrypt/functions/mcrypt-generic-init.xml
2026-01-19 03:24:24 +00:00

100 lines
3.5 KiB
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-generic-init">
<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>
<simpara>
<function>mcrypt_generic</function> または
<function>mdecrypt_generic</function> をコールする前に、
常にこの関数をコールする必要があります。
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<simpara>
暗号化記述子。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<simpara>
キーの最大長は、<function>mcrypt_enc_get_key_size</function>
コールした際に得られるキー長であり、この値より小さな値は全て有効です。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>iv</parameter></term>
<listitem>
<simpara>
IV は通常そのアルゴリズムのブロック長と同じ大きさですが、
<function>mcrypt_enc_get_iv_size</function> をコールする
ことにより、その大きさを得る必要があります。IV は ECB では
無視されます。IV は CFB、CBC、STREAM、nOFB では必須です。
IV はランダムで一意である必要があります(しかし、秘密ではある必要は
ありません)。暗号化と復号で同じ IV を使用する必要があります。
IV を使用したくない場合にはゼロに設定しますが、これは推奨されません。
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
この関数は、エラー時に負の値を返します。キー長が不正な場合に
-3、メモリの確保に問題があった場合に -4、そしてそれ以外の戻り値は
その他のエラーとなります。エラーが警告を発生させた場合、それが
表示されます。間違ったパラメータが渡された場合には &false;
が返されます。
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<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
-->