reference/openssl/functions/openssl-x509-parse.xml
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-parse">
3
+
<refentry xml:id="function.openssl-x509-parse" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_x509_parse</refname>
6
6
<refpurpose>Parse an X509 certificate and return the information as an array</refpurpose>
...
...
@@ -9,13 +9,13 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>array</type><methodname>openssl_x509_parse</methodname>
13
-
<methodparam><type>mixed</type><parameter>x509cert</parameter></methodparam>
14
-
<methodparam choice="opt"><type>bool</type><parameter>shortnames</parameter><initializer>&true;</initializer></methodparam>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>openssl_x509_parse</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</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_x509_parse</function> returns information about the
18
-
supplied <parameter>x509cert</parameter>, including fields such as subject
18
+
supplied <parameter>certificate</parameter>, including fields such as subject
19
19
name, issuer name, purposes, valid from and valid to dates etc.
20
20
</para>
21
21
</refsect1>
...
...
@@ -25,18 +25,19 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>x509cert</parameter></term>
28
+
<term><parameter>certificate</parameter></term>
29
29
<listitem>
30
30
<para>
31
+
X509 certificate. See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
31
32
</para>
32
33
</listitem>
33
34
</varlistentry>
34
35
<varlistentry>
35
-
<term><parameter>shortnames</parameter></term>
36
+
<term><parameter>short_names</parameter></term>
36
37
<listitem>
37
38
<para>
38
-
<parameter>shortnames</parameter> controls how the data is indexed in the
39
-
array - if <parameter>shortnames</parameter> is &true; (the default) then
39
+
<parameter>short_names</parameter> controls how the data is indexed in the
40
+
array - if <parameter>short_names</parameter> is &true; (the default) then
40
41
fields will be indexed with the short name form, otherwise, the long name
41
42
form will be used - e.g.: CN is the shortname form of commonName.
42
43
</para>
...
...
@@ -54,8 +55,29 @@
54
55
</para>
55
56
</refsect1>
56
57

58
+
<refsect1 role="changelog">
59
+
&reftitle.changelog;
60
+
<informaltable>
61
+
<tgroup cols="2">
62
+
<thead>
63
+
<row>
64
+
<entry>&Version;</entry>
65
+
<entry>&Description;</entry>
66
+
</row>
67
+
</thead>
68
+
<tbody>
69
+
<row>
70
+
<entry>8.0.0</entry>
71
+
<entry>
72
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
73
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
74
+
</entry>
75
+
</row>
76
+
</tbody>
77
+
</tgroup>
78
+
</informaltable>
79
+
</refsect1>
57
80
</refentry>
58
-

59
81
<!-- Keep this comment at the end of the file
60
82
Local variables:
61
83
mode: sgml
62
84