-
Notifications
You must be signed in to change notification settings - Fork 56
/
sodium-memcmp.xml
86 lines (79 loc) · 2.64 KB
/
sodium-memcmp.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.sodium-memcmp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sodium_memcmp</refname>
<refpurpose>定数時間での文字列の比較</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>sodium_memcmp</methodname>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>string1</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>string2</parameter></methodparam>
</methodsynopsis>
<para>
ふたつの文字列を、定数時間で比較します。
</para>
<para>
実際、ほとんどの場合は
<function>hash_equals</function> を使いたいかもしれません。
なぜなら、同じロジックを提供しているにもかかわらず、
整数型ではなく、<type>bool</type> を返すからです。
しかしながら、タイミング攻撃に敏感な比較計算の結果を扱う場合、
かつ、bool値から整数型への変換の際の、
タイミングに依存した情報のリークを気にする場合、
<function>sodium_memcmp</function>
関数が理想的な代替になります。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>string1</parameter></term>
<listitem>
<para>
比較対象の文字列
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string2</parameter></term>
<listitem>
<para>
もう一つの、比較する文字列
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
双方の文字列が等しければ <literal>0</literal> を返します。
等しくない場合 <literal>-1</literal> を返します。
</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
-->