reference/openssl/functions/openssl-x509-check-private-key.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-x509-check-private-key">
3
+
<refentry xml:id="function.openssl-x509-check-private-key" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_x509_check_private_key</refname>
6
6
<refpurpose>Checks if a private key corresponds to a certificate</refpurpose>
...
...
@@ -10,21 +10,21 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_x509_check_private_key</methodname>
13
-
<methodparam><type>mixed</type><parameter>cert</parameter></methodparam>
14
-
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
13
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
14
+
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
-
Checks whether the given <parameter>key</parameter> is the private key
18
-
that corresponds to <parameter>cert</parameter>.
17
+
Checks whether the given <parameter>private_key</parameter> is the private key
18
+
that corresponds to <parameter>certificate</parameter>.
19
19
</para>
20
20
<warning>
21
21
<para>
22
-
The function does not check if <parameter>key</parameter> is indeed a private key or not.
22
+
The function does not check if <parameter>private_key</parameter> is indeed a private key or not.
23
23
It merely compares the public materials (e.g. exponent and modulus of an RSA key)
24
24
and/or key parameters (e.g. EC params of an EC key) of a key pair.
25
25
</para>
26
26
<para>
27
-
This means, for example, that a public key could be given for <parameter>key</parameter>
27
+
This means, for example, that a public key could be given for <parameter>private_key</parameter>
28
28
and the function may return &true;.
29
29
</para>
30
30
</warning>
...
...
@@ -35,7 +35,7 @@
35
35
<para>
36
36
<variablelist>
37
37
<varlistentry>
38
-
<term><parameter>cert</parameter></term>
38
+
<term><parameter>certificate</parameter></term>
39
39
<listitem>
40
40
<para>
41
41
The certificate.
...
...
@@ -43,7 +43,7 @@
43
43
</listitem>
44
44
</varlistentry>
45
45
<varlistentry>
46
-
<term><parameter>key</parameter></term>
46
+
<term><parameter>private_key</parameter></term>
47
47
<listitem>
48
48
<para>
49
49
The private key.
...
...
@@ -57,13 +57,43 @@
57
57
<refsect1 role="returnvalues">
58
58
&reftitle.returnvalues;
59
59
<para>
60
-
Returns &true; if <parameter>key</parameter> is the private key that
61
-
corresponds to <parameter>cert</parameter>, or &false; otherwise.
60
+
Returns &true; if <parameter>private_key</parameter> is the private key that
61
+
corresponds to <parameter>certificate</parameter>, or &false; otherwise.
62
62
</para>
63
63
</refsect1>
64
64
65
+
<refsect1 role="changelog">
66
+
&reftitle.changelog;
67
+
<informaltable>
68
+
<tgroup cols="2">
69
+
<thead>
70
+
<row>
71
+
<entry>&Version;</entry>
72
+
<entry>&Description;</entry>
73
+
</row>
74
+
</thead>
75
+
<tbody>
76
+
<row>
77
+
<entry>8.0.0</entry>
78
+
<entry>
79
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
80
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
81
+
</entry>
82
+
</row>
83
+
<row>
84
+
<entry>8.0.0</entry>
85
+
<entry>
86
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
87
+
or <classname>OpenSSLCertificate</classname> instance now;
88
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
89
+
was accepted.
90
+
</entry>
91
+
</row>
92
+
</tbody>
93
+
</tgroup>
94
+
</informaltable>
95
+
</refsect1>
65
96
</refentry>
66
-
67
97
<!-- Keep this comment at the end of the file
68
98
Local variables:
69
99
mode: sgml
70
100