-
Notifications
You must be signed in to change notification settings - Fork 83
Expand file tree
/
Copy pathopenssl-verify.xml
More file actions
217 lines (205 loc) · 6.72 KB
/
openssl-verify.xml
File metadata and controls
217 lines (205 loc) · 6.72 KB
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9a8c593c09cf7d84085989e42f3b2b23536279db Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.openssl-verify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>openssl_verify</refname>
<refpurpose>署名を検証する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_verify</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>signature</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>public_key</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>algorithm</parameter><initializer><constant>OPENSSL_ALGO_SHA1</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_verify</function> は、
<parameter>public_key</parameter> が指す公開鍵を使用し、
指定した <parameter>data</parameter> に関して
<parameter>signature</parameter> が正しいことを確認します。
署名が正しいと判定されるためには、
その公開鍵が署名の際に使用した秘密鍵に対応している必要があります。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
署名を作成するときに使ったデータの文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature</parameter></term>
<listitem>
<para>
生のバイナリ文字列。<function>openssl_sign</function> もしくはそれと同等の手段を使って生成したもの。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_key</parameter></term>
<listitem>
<para>
<classname>OpenSSLAsymmetricKey</classname> - <function>openssl_get_publickey</function> が返す鍵。
</para>
<para>
<type>string</type> - <acronym>PEM</acronym> フォーマットの鍵 (例: <literal>-----BEGIN PUBLIC KEY-----
MIIBCgK...</literal> など)。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<type>int</type> - いずれかの <link linkend="openssl.signature-algos">署名アルゴリズム</link>。
</para>
<para>
<type>string</type> - <function>openssl_get_md_methods</function> が返す文字列 ("sha1WithRSAEncryption" や "sha512" など)。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>padding</parameter></term>
<listitem>
<simpara>使用する RSA PSS パディング。</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
署名 (signature) が正しい場合に 1、正しくない場合に 0、
エラーの場合に -1 または &false; を返します。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
オプションのパラメータ <parameter>padding</parameter> が追加されました。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>public_key</parameter> は、
<classname>OpenSSLAsymmetricKey</classname> または
<classname>OpenSSLCertificate</classname> クラスのインスタンスを受け入れるようになりました。
これより前のバージョンでは、
<literal>OpenSSL key</literal> または
<literal>OpenSSL X.509</literal> 型のリソースを受け入れていました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>openssl_verify</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
// $data および $signature はデータおよび署名が含まれていると仮定
// 認証局から公開鍵を取得し、使用可能にする
$pubkeyid = openssl_pkey_get_public("file://src/openssl-0.9.6/demos/sign/cert.pem");
// 署名が正しいかどうかを確認
$ok = openssl_verify($data, $signature, $pubkeyid);
if ($ok == 1) {
echo "正しいです";
} elseif ($ok == 0) {
echo "正しくありません";
} else {
echo "署名を確認する際にエラーが発生しました";
}
// メモリからキーを開放
openssl_free_key($pubkeyid);
?>
]]>
</programlisting>
</example>
<example>
<title><function>openssl_verify</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
// 署名したいデータ
$data = 'my data';
// 新しい秘密鍵と公開鍵を作成
$private_key_res = openssl_pkey_new(array(
"private_key_bits" => 2048,
"private_key_type" => OPENSSL_KEYTYPE_RSA,
));
$details = openssl_pkey_get_details($private_key_res);
$public_key_res = openssl_pkey_get_public($details['key']);
// 署名を作成
openssl_sign($data, $signature, $private_key_res, "sha256WithRSAEncryption");
// 署名を検証
$ok = openssl_verify($data, $signature, $public_key_res, OPENSSL_ALGO_SHA256);
if ($ok == 1) {
echo "valid";
} elseif ($ok == 0) {
echo "invalid";
} else {
echo "error: ".openssl_error_string();
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openssl_sign</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
-->