reference/openssl/functions/openssl-pkcs7-verify.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-pkcs7-verify">
3
+
<refentry xml:id="function.openssl-pkcs7-verify" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_pkcs7_verify</refname>
6
6
<refpurpose>Verifies the signature of an S/MIME signed message</refpurpose>
...
...
@@ -9,13 +9,14 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>mixed</type><methodname>openssl_pkcs7_verify</methodname>
13
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
12
+
<type class="union"><type>bool</type><type>int</type></type><methodname>openssl_pkcs7_verify</methodname>
13
+
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>outfilename</parameter></methodparam>
16
-
<methodparam choice="opt"><type>array</type><parameter>cainfo</parameter></methodparam>
17
-
<methodparam choice="opt"><type>string</type><parameter>extracerts</parameter></methodparam>
18
-
<methodparam choice="opt"><type>string</type><parameter>content</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>signers_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
16
+
<methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
17
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
18
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>content</parameter><initializer>&null;</initializer></methodparam>
19
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>output_filename</parameter><initializer>&null;</initializer></methodparam>
19
20
</methodsynopsis>
20
21
<para>
21
22
<function>openssl_pkcs7_verify</function> reads the S/MIME message
...
...
@@ -28,7 +29,7 @@
28
29
<para>
29
30
<variablelist>
30
31
<varlistentry>
31
-
<term><parameter>filename</parameter></term>
32
+
<term><parameter>input_filename</parameter></term>
32
33
<listitem>
33
34
<para>
34
35
Path to the message.
...
...
@@ -46,20 +47,20 @@
46
47
</listitem>
47
48
</varlistentry>
48
49
<varlistentry>
49
-
<term><parameter>outfilename</parameter></term>
50
+
<term><parameter>signers_certificates_filename</parameter></term>
50
51
<listitem>
51
52
<para>
52
-
If the <parameter>outfilename</parameter> is specified, it should be a
53
+
If the <parameter>signers_certificates_filename</parameter> is specified, it should be a
53
54
string holding the name of a file into which the certificates of the
54
-
persons that signed the messages will be stored in PEM format.
55
+
persons that signed the messages will be stored in <acronym>PEM</acronym> format.
55
56
</para>
56
57
</listitem>
57
58
</varlistentry>
58
59
<varlistentry>
59
-
<term><parameter>cainfo</parameter></term>
60
+
<term><parameter>ca_info</parameter></term>
60
61
<listitem>
61
62
<para>
62
-
If the <parameter>cainfo</parameter> is specified, it should hold
63
+
If the <parameter>ca_info</parameter> is specified, it should hold
63
64
information about the trusted CA certificates to use in the verification
64
65
process - see <link linkend="openssl.cert.verification">certificate
65
66
verification</link> for more information about this parameter.
...
...
@@ -67,10 +68,10 @@
67
68
</listitem>
68
69
</varlistentry>
69
70
<varlistentry>
70
-
<term><parameter>extracerts</parameter></term>
71
+
<term><parameter>untrusted_certificates_filename</parameter></term>
71
72
<listitem>
72
73
<para>
73
-
If the <parameter>extracerts</parameter> is specified, it is the filename
74
+
If the <parameter>untrusted_certificates_filename</parameter> is specified, it is the filename
74
75
of a file containing a bunch of certificates to use as untrusted CAs.
75
76
</para>
76
77
</listitem>
...
...
@@ -85,6 +86,14 @@
85
86
</para>
86
87
</listitem>
87
88
</varlistentry>
89
+
<varlistentry>
90
+
<term><parameter>output_filename</parameter></term>
91
+
<listitem>
92
+
<para>
93
+
94
+
</para>
95
+
</listitem>
96
+
</varlistentry>
88
97
</variablelist>
89
98
</para>
90
99
</refsect1>
...
...
@@ -100,26 +109,31 @@
100
109
101
110
<refsect1 role="changelog">
102
111
&reftitle.changelog;
103
-
<para>
104
-
<informaltable>
105
-
<tgroup cols="2">
106
-
<thead>
107
-
<row>
108
-
<entry>&Version;</entry>
109
-
<entry>&Description;</entry>
110
-
</row>
111
-
</thead>
112
-
<tbody>
113
-
<row>
114
-
<entry>5.1.0</entry>
115
-
<entry>
116
-
The <parameter>content</parameter> parameter was added.
117
-
</entry>
118
-
</row>
119
-
</tbody>
120
-
</tgroup>
121
-
</informaltable>
122
-
</para>
112
+
<informaltable>
113
+
<tgroup cols="2">
114
+
<thead>
115
+
<row>
116
+
<entry>&Version;</entry>
117
+
<entry>&Description;</entry>
118
+
</row>
119
+
</thead>
120
+
<tbody>
121
+
<row>
122
+
<entry>8.0.0</entry>
123
+
<entry>
124
+
<parameter>signers_certificates_filename</parameter>, <parameter>untrusted_certificates_filename</parameter>,
125
+
<parameter>content</parameter> and <parameter>output_filename</parameter> are nullable now.
126
+
</entry>
127
+
</row>
128
+
<row>
129
+
<entry>7.2.0</entry>
130
+
<entry>
131
+
The <parameter>output_filename</parameter> parameter was added.
132
+
</entry>
133
+
</row>
134
+
</tbody>
135
+
</tgroup>
136
+
</informaltable>
123
137
</refsect1>
124
138
125
139
<refsect1 role="notes">
...
...
@@ -127,13 +141,12 @@
127
141
<note>
128
142
<simpara>
129
143
As specified in RFC 2045, lines may not be longer than 76 characters
130
-
in the <parameter>filename</parameter> parameter.
144
+
in the <parameter>input_filename</parameter> parameter.
131
145
</simpara>
132
146
</note>
133
147
</refsect1>
134
148
135
149
</refentry>
136
-
137
150
<!-- Keep this comment at the end of the file
138
151
Local variables:
139
152
mode: sgml
140
153