-
Notifications
You must be signed in to change notification settings - Fork 56
/
hash-hmac.xml
169 lines (162 loc) · 5.01 KB
/
hash-hmac.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.hash-hmac" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hash_hmac</refname>
<refpurpose>HMAC 方式を使用してハッシュ値を生成する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hash_hmac</methodname>
<methodparam><type>string</type><parameter>algo</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algo</parameter></term>
<listitem>
<para>
選択したアルゴリズムの名前 (すなわち "md5"、"sha256"、"haval160,4" など…)。
サポートするアルゴリズムの一覧は <function>hash_hmac_algos</function> を参照ください。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
ハッシュするメッセージ。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
HMAC 方式でのメッセージダイジェストを生成するために使用する
共有の秘密鍵。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>binary</parameter></term>
<listitem>
<para>
&true; を設定すると、生のバイナリデータを出力します。
&false; の場合は小文字の 16 進数値となります。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<parameter>binary</parameter> が true に設定されていない場合は、
メッセージダイジェストの計算結果を小文字の 16 進数値形式の文字列で
返します。もし true に設定されていた場合は、メッセージダイジェストが
そのままのバイナリ形式で返されます。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<parameter>algo</parameter> が不明な場合や、
暗号に適さないハッシュ関数の場合、
<classname>ValueError</classname> がスローされます。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>algo</parameter> が不明な場合や、
暗号に適さないハッシュ関数の場合に
<classname>ValueError</classname> をスローするようになりました。
これより前のバージョンでは、&false; を返していました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>暗号に適さないハッシュ関数 (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) は使えなくなりました。</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>hash_hmac</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
echo hash_hmac('sha256', 'The quick brown fox jumped over the lazy dog.', 'secret');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
9c5c42422b03f0ee32949920649445e417b2c634050833c5165704b825c2a53b
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hash</function></member>
<member><function>hash_hmac_algos</function></member>
<member><function>hash_init</function></member>
<member><function>hash_hmac_file</function></member>
<member><function>hash_equals</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
-->