-
Notifications
You must be signed in to change notification settings - Fork 146
/
hash-hmac.xml
172 lines (165 loc) · 4.87 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
170
171
172
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 71e12e2df7b0bcf0dc2743681b73790ac0d45ccc Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.hash-hmac" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hash_hmac</refname>
<refpurpose>Génère une valeur de clé de hachage en utilisant la méthode 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>
Nom de l'algorithme de hachage sélectionné (c'est-à-dire "md5",
"sha256", "haval160,4", etc.).
Voir la documentation de la fonction <function>hash_hmac_algos</function>
pour une liste des algorithmes disponible.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Le message qui sera haché.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Clé secrète partagée utilisée pour générer la variance HMAC de
l'empreinte numérique.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>binary</parameter></term>
<listitem>
<para>
Lorsqu'il vaut &true;, la sortie sera des données brutes binaires.
Lorsqu'il vaut &false;, la sortie sera des chiffres hexadécimaux en
minuscule.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne une chaîne de caractères contenant l'empreinte numérique calculée
en chiffre hexadécimal minuscule à moins que
<parameter>binary</parameter> soit fixé à &true;. Dans ce cas, la
représentation brute binaire de l'empreinte numérique est retournée.
</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.
</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>
<function>hash_hmac</function> lance désormais une exception
<classname>ValueError</classname> si l'<parameter>algo</parameter>
est inconnu ou n'est pas une fonction de hachage cryptographique ;
auparavant, &false; était retourné à la place.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
L'utilisation de fonctions de hachage non cryptographiques (adler32,
crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) a été désactivée.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <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_hmac_algos</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
-->