-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathmcrypt-module-open.xml
191 lines (175 loc) · 6.85 KB
/
mcrypt-module-open.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f27cfeeefc13717f86a53d7fefa0ce54f7bfaaaf Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<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_暗号名</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>)を指定した場合、&php.ini; ディレクティブ
<parameter>mcrypt.algorithms_dir</parameter> に設定された値を使います。
これらが設定されていない場合、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>)を指定した場合、&php.ini; ディレクティブ
<literal>mcrypt.modes_dir</literal> に設定された値を使います。
これらが設定されていない場合、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> 暗号化を、
そして <filename>/usr/lib/mcrypt-modes</filename> から <literal>ECB</literal> モードの
オープンを試みます。2 行目の例では暗号化形式とモードを文字列で
指定しています。これは、libmcrypt 2.4.x あるいは 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', '');
/* 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>
</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
-->