reference/openssl/functions/openssl-csr-get-public-key.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -1,17 +1,17 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-csr-get-public-key">
3
+
<refentry xml:id="function.openssl-csr-get-public-key" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_csr_get_public_key</refname>
6
-
<refpurpose>Returns the public key of a CSR</refpurpose>
6
+
<refpurpose>Returns the public key of a <acronym>CSR</acronym></refpurpose>
7
7
</refnamediv>
8
8

9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>openssl_csr_get_public_key</methodname>
13
-
<methodparam><type>mixed</type><parameter>csr</parameter></methodparam>
14
-
<methodparam choice="opt"><type>bool</type><parameter>use_shortnames</parameter><initializer>true</initializer></methodparam>
12
+
<type class="union"><type>OpenSSLAsymmetricKey</type><type>false</type></type><methodname>openssl_csr_get_public_key</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
14
+
<methodparam choice="opt"><type>bool</type><parameter>short_names</parameter><initializer>&true;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>openssl_csr_get_public_key</function> extracts the public key
...
...
@@ -25,7 +25,7 @@
25
25
<variablelist>
26
26
&openssl.param.csr;
27
27
<varlistentry>
28
-
<term><parameter>use_shortnames</parameter></term>
28
+
<term><parameter>short_names</parameter></term>
29
29
<listitem>
30
30
<warning>
31
31
<para>
...
...
@@ -41,10 +41,40 @@
41
41
<refsect1 role="returnvalues">
42
42
&reftitle.returnvalues;
43
43
<para>
44
-
Returns a positive key resource identifier on success, or FALSE on error.
44
+
Returns an <classname>OpenSSLAsymmetricKey</classname> on success, or &false; on error.
45
45
</para>
46
46
</refsect1>
47
47

48
+
<refsect1 role="changelog">
49
+
&reftitle.changelog;
50
+
<informaltable>
51
+
<tgroup cols="2">
52
+
<thead>
53
+
<row>
54
+
<entry>&Version;</entry>
55
+
<entry>&Description;</entry>
56
+
</row>
57
+
</thead>
58
+
<tbody>
59
+
<row>
60
+
<entry>8.0.0</entry>
61
+
<entry>
62
+
On success, this function returns an <classname>OpenSSLAsymmetricKey</classname> instance now;
63
+
previously, a &resource; of type <literal>OpenSSL key</literal> was returned.
64
+
</entry>
65
+
</row>
66
+
<row>
67
+
<entry>8.0.0</entry>
68
+
<entry>
69
+
<parameter>csr</parameter> accepts an <classname>OpenSSLCertificateSigningRequest</classname> instance now;
70
+
previously, a &resource; of type <literal>OpenSSL X.509 CSR</literal> was accepted.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+
48
78
<refsect1 role="examples">
49
79
&reftitle.examples;
50
80
<para>
...
...
@@ -86,7 +116,6 @@ echo $info['key'];
86
116
</refsect1>
87
117
88
118
</refentry>
89
-

90
119
<!-- Keep this comment at the end of the file
91
120
Local variables:
92
121
mode: sgml
93
122