reference/openssl/functions/openssl-pkey-get-private.xml
497c40ac164d5873fd87f622dfdeb5206392b446
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -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-pkey-get-private">
3
+
<refentry xml:id="function.openssl-pkey-get-private" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_pkey_get_private</refname>
6
6
<refpurpose>Get a private key</refpurpose>
...
...
@@ -9,13 +9,13 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>openssl_pkey_get_private</methodname>
13
-
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter><initializer>""</initializer></methodparam>
12
+
<type class="union"><type>OpenSSLAsymmetricKey</type><type>false</type></type><methodname>openssl_pkey_get_private</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>passphrase</parameter><initializer>&null;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
-
<function>openssl_get_privatekey</function> parses
18
-
<parameter>key</parameter> and prepares it for use by other functions.
17
+
<function>openssl_pkey_get_private</function> parses
18
+
<parameter>private_key</parameter> and prepares it for use by other functions.
19
19
</para>
20
20
</refsect1>
21
21
...
...
@@ -24,17 +24,17 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>key</parameter></term>
27
+
<term><parameter>private_key</parameter></term>
28
28
<listitem>
29
29
<para>
30
-
<parameter>key</parameter> can be one of the following:
30
+
<parameter>private_key</parameter> can be one of the following:
31
31
<orderedlist>
32
32
<listitem><simpara>a string having the format
33
33
<filename>file://path/to/file.pem</filename>. The named file must
34
-
contain a PEM encoded certificate/private key (it may contain both).
34
+
contain a <acronym>PEM</acronym> encoded certificate/private key (it may contain both).
35
35
</simpara>
36
36
</listitem>
37
-
<listitem><simpara>A PEM formatted private key.</simpara></listitem>
37
+
<listitem><simpara>A <acronym>PEM</acronym> formatted private key.</simpara></listitem>
38
38
</orderedlist>
39
39
</para>
40
40
</listitem>
...
...
@@ -55,12 +55,48 @@
55
55
<refsect1 role="returnvalues">
56
56
&reftitle.returnvalues;
57
57
<para>
58
-
Returns a positive key resource identifier on success, or &false; on error.
58
+
Returns an <classname>OpenSSLAsymmetricKey</classname> instance on success, or &false; on error.
59
59
</para>
60
60
</refsect1>
61
61
62
+
<refsect1 role="changelog">
63
+
&reftitle.changelog;
64
+
<informaltable>
65
+
<tgroup cols="2">
66
+
<thead>
67
+
<row>
68
+
<entry>&Version;</entry>
69
+
<entry>&Description;</entry>
70
+
</row>
71
+
</thead>
72
+
<tbody>
73
+
<row>
74
+
<entry>8.0.0</entry>
75
+
<entry>
76
+
On success, this function returns an <classname>OpenSSLAsymmetricKey</classname> instance now;
77
+
previously, a &resource; of type <literal>OpenSSL key</literal> was returned.
78
+
</entry>
79
+
</row>
80
+
<row>
81
+
<entry>8.0.0</entry>
82
+
<entry>
83
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
84
+
or <classname>OpenSSLCertificate</classname> instance now;
85
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
86
+
was accepted.
87
+
</entry>
88
+
</row>
89
+
<row>
90
+
<entry>8.0.0</entry>
91
+
<entry>
92
+
<parameter>passphrase</parameter> is nullable now.
93
+
</entry>
94
+
</row>
95
+
</tbody>
96
+
</tgroup>
97
+
</informaltable>
98
+
</refsect1>
62
99
</refentry>
63
-
64
100
<!-- Keep this comment at the end of the file
65
101
Local variables:
66
102
mode: sgml
67
103