reference/openssl/functions/openssl-x509-checkpurpose.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-x509-checkpurpose">
3
+
<refentry xml:id="function.openssl-x509-checkpurpose" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_x509_checkpurpose</refname>
6
6
<refpurpose>Verifies if a certificate can be used for a particular purpose</refpurpose>
...
...
@@ -9,11 +9,11 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>openssl_x509_checkpurpose</methodname>
13
-
<methodparam><type>mixed</type><parameter>x509cert</parameter></methodparam>
12
+
<type class="union"><type>bool</type><type>int</type></type><methodname>openssl_x509_checkpurpose</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>purpose</parameter></methodparam>
15
-
<methodparam choice="opt"><type>array</type><parameter>cainfo</parameter><initializer>array()</initializer></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>untrustedfile</parameter></methodparam>
15
+
<methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_file</parameter><initializer>&null;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
<function>openssl_x509_checkpurpose</function> examines a certificate to
...
...
@@ -26,7 +26,7 @@
26
26
<para>
27
27
<variablelist>
28
28
<varlistentry>
29
-
<term><parameter>x509cert</parameter></term>
29
+
<term><parameter>certificate</parameter></term>
30
30
<listitem>
31
31
<para>
32
32
The examined certificate.
...
...
@@ -86,20 +86,20 @@
86
86
</listitem>
87
87
</varlistentry>
88
88
<varlistentry>
89
-
<term><parameter>cainfo</parameter></term>
89
+
<term><parameter>ca_info</parameter></term>
90
90
<listitem>
91
91
<para>
92
-
<parameter>cainfo</parameter> should be an array of trusted CA files/dirs
92
+
<parameter>ca_info</parameter> should be an array of trusted CA files/dirs
93
93
as described in <link linkend="openssl.cert.verification">Certificate
94
94
Verification</link>.
95
95
</para>
96
96
</listitem>
97
97
</varlistentry>
98
98
<varlistentry>
99
-
<term><parameter>untrustedfile</parameter></term>
99
+
<term><parameter>untrusted_certificates_file</parameter></term>
100
100
<listitem>
101
101
<para>
102
-
If specified, this should be the name of a PEM encoded file holding
102
+
If specified, this should be the name of a <acronym>PEM</acronym> encoded file holding
103
103
certificates that can be used to help verify the certificate, although
104
104
no trust is placed in the certificates that come from that file.
105
105
</para>
...
...
@@ -117,8 +117,35 @@
117
117
</para>
118
118
</refsect1>
119
119
120
+
<refsect1 role="changelog">
121
+
&reftitle.changelog;
122
+
<informaltable>
123
+
<tgroup cols="2">
124
+
<thead>
125
+
<row>
126
+
<entry>&Version;</entry>
127
+
<entry>&Description;</entry>
128
+
</row>
129
+
</thead>
130
+
<tbody>
131
+
<row>
132
+
<entry>8.0.0</entry>
133
+
<entry>
134
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
135
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
136
+
</entry>
137
+
</row>
138
+
<row>
139
+
<entry>8.0.0</entry>
140
+
<entry>
141
+
<parameter>untrusted_certificates_file</parameter> is nullable now.
142
+
</entry>
143
+
</row>
144
+
</tbody>
145
+
</tgroup>
146
+
</informaltable>
147
+
</refsect1>
120
148
</refentry>
121
-
122
149
<!-- Keep this comment at the end of the file
123
150
Local variables:
124
151
mode: sgml
125
152