reference/openssl/functions/openssl-private-decrypt.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-private-decrypt">
3
+
<refentry xml:id="function.openssl-private-decrypt" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_private_decrypt</refname>
6
6
<refpurpose>Decrypts data with private key </refpurpose>
...
...
@@ -11,19 +11,18 @@
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_private_decrypt</methodname>
13
13
<methodparam><type>string</type><parameter>data</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter role="reference">decrypted</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
16
-
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer>OPENSSL_PKCS1_PADDING</initializer></methodparam>
14
+
<methodparam><type>string</type><parameter role="reference">decrypted_data</parameter></methodparam>
15
+
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
16
+
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer><constant>OPENSSL_PKCS1_PADDING</constant></initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
<function>openssl_private_decrypt</function> decrypts
20
-
<parameter>data</parameter> that was previous encrypted via
20
+
<parameter>data</parameter> that was previously encrypted via
21
21
<function>openssl_public_encrypt</function> and stores the result into
22
-
<parameter>decrypted</parameter>.
22
+
<parameter>decrypted_data</parameter>.
23
23
</para>
24
24
<para>
25
-
You can use this function e.g. to decrypt data which were supposed only to
26
-
you.
25
+
You can use this function e.g. to decrypt data which is supposed to only be available to you.
27
26
</para>
28
27
</refsect1>
29
28

...
...
@@ -39,17 +38,17 @@
39
38
</listitem>
40
39
</varlistentry>
41
40
<varlistentry>
42
-
<term><parameter>decrypted</parameter></term>
41
+
<term><parameter>decrypted_data</parameter></term>
43
42
<listitem>
44
43
<para>
45
44
</para>
46
45
</listitem>
47
46
</varlistentry>
48
47
<varlistentry>
49
-
<term><parameter>key</parameter></term>
48
+
<term><parameter>private_key</parameter></term>
50
49
<listitem>
51
50
<para>
52
-
<parameter>key</parameter> must be the private key corresponding that
51
+
<parameter>private_key</parameter> must be the private key corresponding that
53
52
was used to encrypt the data.
54
53
</para>
55
54
</listitem>
...
...
@@ -77,6 +76,31 @@
77
76
</para>
78
77
</refsect1>
79
78

79
+
<refsect1 role="changelog">
80
+
&reftitle.changelog;
81
+
<informaltable>
82
+
<tgroup cols="2">
83
+
<thead>
84
+
<row>
85
+
<entry>&Version;</entry>
86
+
<entry>&Description;</entry>
87
+
</row>
88
+
</thead>
89
+
<tbody>
90
+
<row>
91
+
<entry>8.0.0</entry>
92
+
<entry>
93
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
94
+
or <classname>OpenSSLCertificate</classname> instance now;
95
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
96
+
was accepted.
97
+
</entry>
98
+
</row>
99
+
</tbody>
100
+
</tgroup>
101
+
</informaltable>
102
+
</refsect1>
103
+

80
104
<refsect1 role="seealso">
81
105
&reftitle.seealso;
82
106
<para>
...
...
@@ -88,7 +112,6 @@
88
112
</refsect1>
89
113

90
114
</refentry>
91
-

92
115
<!-- Keep this comment at the end of the file
93
116
Local variables:
94
117
mode: sgml
95
118