reference/openssl/functions/openssl-pkcs7-decrypt.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
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-pkcs7-decrypt">
3
+
<refentry xml:id="function.openssl-pkcs7-decrypt" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_pkcs7_decrypt</refname>
6
6
<refpurpose>Decrypts an S/MIME encrypted message</refpurpose>
...
...
@@ -10,16 +10,16 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_pkcs7_decrypt</methodname>
13
-
<methodparam><type>string</type><parameter>infilename</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>recipcert</parameter></methodparam>
16
-
<methodparam choice="opt"><type>mixed</type><parameter>recipkey</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
15
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type><type>null</type></type><parameter>private_key</parameter><initializer>&null;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
Decrypts the S/MIME encrypted message contained in the file specified by
20
-
<parameter>infilename</parameter> using the certificate and its
21
-
associated private key specified by <parameter>recipcert</parameter> and
22
-
<parameter>recipkey</parameter>.
20
+
<parameter>input_filename</parameter> using the certificate and its
21
+
associated private key specified by <parameter>certificate</parameter> and
22
+
<parameter>private_key</parameter>.
23
23
</para>
24
24
</refsect1>
25
25
...
...
@@ -28,30 +28,30 @@
28
28
<para>
29
29
<variablelist>
30
30
<varlistentry>
31
-
<term><parameter>infilename</parameter></term>
31
+
<term><parameter>input_filename</parameter></term>
32
32
<listitem>
33
33
<para>
34
34
</para>
35
35
</listitem>
36
36
</varlistentry>
37
37
<varlistentry>
38
-
<term><parameter>outfilename</parameter></term>
38
+
<term><parameter>output_filename</parameter></term>
39
39
<listitem>
40
40
<para>
41
41
The decrypted message is written to the file specified by
42
-
<parameter>outfilename</parameter>.
42
+
<parameter>output_filename</parameter>.
43
43
</para>
44
44
</listitem>
45
45
</varlistentry>
46
46
<varlistentry>
47
-
<term><parameter>recipcert</parameter></term>
47
+
<term><parameter>certificate</parameter></term>
48
48
<listitem>
49
49
<para>
50
50
</para>
51
51
</listitem>
52
52
</varlistentry>
53
53
<varlistentry>
54
-
<term><parameter>recipkey</parameter></term>
54
+
<term><parameter>private_key</parameter></term>
55
55
<listitem>
56
56
<para>
57
57
</para>
...
...
@@ -68,6 +68,31 @@
68
68
</para>
69
69
</refsect1>
70
70
71
+
<refsect1 role="changelog">
72
+
&reftitle.changelog;
73
+
<informaltable>
74
+
<tgroup cols="2">
75
+
<thead>
76
+
<row>
77
+
<entry>&Version;</entry>
78
+
<entry>&Description;</entry>
79
+
</row>
80
+
</thead>
81
+
<tbody>
82
+
<row>
83
+
<entry>8.0.0</entry>
84
+
<entry>
85
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
86
+
or <classname>OpenSSLCertificate</classname> instance now;
87
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509 CSR</literal>
88
+
was accepted.
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
94
+
</refsect1>
95
+
71
96
<refsect1 role="examples">
72
97
&reftitle.examples;
73
98
<para>
...
...
@@ -94,7 +119,6 @@ if (openssl_pkcs7_decrypt($infilename, $outfilename, $cert, $key)) {
94
119
</refsect1>
95
120
96
121
</refentry>
97
-
98
122
<!-- Keep this comment at the end of the file
99
123
Local variables:
100
124
mode: sgml
101
125