-
Notifications
You must be signed in to change notification settings - Fork 146
/
hash-init.xml
194 lines (185 loc) · 6.02 KB
/
hash-init.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
192
193
194
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 71e12e2df7b0bcf0dc2743681b73790ac0d45ccc Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.hash-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hash_init</refname>
<refpurpose>Initialise un contexte de hachage incrémental</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>HashContext</type><methodname>hash_init</methodname>
<methodparam><type>string</type><parameter>algo</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algo</parameter></term>
<listitem>
<para>
Nom de l'algorithme de hachage sélectionné (c'est-à-dire "md5",
"sha256", "haval160,4", etc.). Pour une liste des algorithmes
supportés, reportez-vous à la documentation sur la fonction
<function>hash_algos</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Configurations optionnelles pour la génération du hachage, supporte
actuellement seulement une option :
<constant>HASH_HMAC</constant>. Lorsque cette option est spécifiée, le paramètre
<parameter>key</parameter> <emphasis>doit</emphasis> être spécifié.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Lorsque <constant>HASH_HMAC</constant> est spécifiée pour <parameter>flags</parameter>,
une clé secrète partagée qui sera utilisée avec la méthode de hachage
HMAC doit être fournie dans ce paramètre.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Un tableau d'options pour les algorithmes dives de hachage.
Actuellement, seul le paramètre <parameter>"seed"</parameter> est
supporté pour les variantes MurmurHash.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le contexte de hachage HashContext pour utilisation avec
<function>hash_update</function>, <function>hash_update_stream</function>,
<function>hash_update_file</function> et <function>hash_final</function>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Lève une exception <classname>ValueError</classname> si le
paramètre <parameter>algo</parameter> est inconnu ou n'est pas
une fonction de hachage cryptographique, ou si le paramètre
<parameter>key</parameter> est vide.
</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.1.0</entry>
<entry>Le paramètre <parameter>options</parameter> a été ajouté.</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>L'usage de fonction de hachage non-cryptographique (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) avec <constant>HASH_HMAC</constant> a été désactivé.</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
Retourne une <classname>HashContext</classname> au lieu d'une ressource.
</entry>
<entry>8.0.0</entry>
<entry>
Lève une exception <classname>ValueError</classname> dorénavant si le
paramètre <parameter>algo</parameter> est inconnu ou n'est pas
une fonction de hachage cryptographique, ou si le paramètre
<parameter>key</parameter> est vide.
Précédemment, &false; était retourné et un message
<constant>E_WARNING</constant> était emis.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple de hachage incrémental</title>
<programlisting role="php">
<![CDATA[
<?php
$hash = hash('sha256', 'The quick brown fox jumped over the lazy dog.');
$ctx = hash_init('sha256');
hash_update($ctx, 'The quick brown fox ');
hash_update($ctx, 'jumped over the lazy dog.');
$incremental_hash = hash_final($ctx);
echo $incremental_hash, PHP_EOL;
var_dump($hash === $incremental_hash);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hash_algos</function></member>
<member><function>hash_update</function></member>
<member><function>hash_update_file</function></member>
<member><function>hash_update_stream</function></member>
<member><function>hash_final</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
-->