reference/openssl/functions/openssl-seal.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-seal">
3
+
<refentry xml:id="function.openssl-seal" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_seal</refname>
6
6
<refpurpose>Seal (encrypt) data</refpurpose>
...
...
@@ -9,21 +9,21 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>openssl_seal</methodname>
12
+
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_seal</methodname>
13
13
<methodparam><type>string</type><parameter>data</parameter></methodparam>
14
14
<methodparam><type>string</type><parameter role="reference">sealed_data</parameter></methodparam>
15
-
<methodparam><type>array</type><parameter role="reference">env_keys</parameter></methodparam>
16
-
<methodparam><type>array</type><parameter>pub_key_ids</parameter></methodparam>
17
-
<methodparam choice="opt"><type>string</type><parameter>method</parameter><initializer>"RC4"</initializer></methodparam>
18
-
<methodparam choice="opt"><type>string</type><parameter role="reference">iv</parameter></methodparam>
15
+
<methodparam><type>array</type><parameter role="reference">encrypted_keys</parameter></methodparam>
16
+
<methodparam><type>array</type><parameter>public_key</parameter></methodparam>
17
+
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
18
+
<methodparam choice="opt"><type>string</type><parameter role="reference">iv</parameter><initializer>&null;</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<para>
21
21
<function>openssl_seal</function> seals (encrypts)
22
-
<parameter>data</parameter> by using the given <parameter>method</parameter> with a randomly generated
22
+
<parameter>data</parameter> by using the given <parameter>cipher_algo</parameter> with a randomly generated
23
23
secret key. The key is encrypted with each of the public keys
24
-
associated with the identifiers in <parameter>pub_key_ids</parameter>
24
+
associated with the identifiers in <parameter>public_key</parameter>
25
25
and each encrypted key is returned
26
-
in <parameter>env_keys</parameter>. This means that one can send
26
+
in <parameter>encrypted_keys</parameter>. This means that one can send
27
27
sealed data to multiple recipients (provided one has obtained their
28
28
public keys). Each recipient must receive both the sealed data and
29
29
the envelope key that was encrypted with the recipient's public key.
...
...
@@ -51,7 +51,7 @@
51
51
</listitem>
52
52
</varlistentry>
53
53
<varlistentry>
54
-
<term><parameter>env_keys</parameter></term>
54
+
<term><parameter>encrypted_keys</parameter></term>
55
55
<listitem>
56
56
<para>
57
57
Array of encrypted keys.
...
...
@@ -59,18 +59,24 @@
59
59
</listitem>
60
60
</varlistentry>
61
61
<varlistentry>
62
-
<term><parameter>pub_key_ids</parameter></term>
62
+
<term><parameter>public_key</parameter></term>
63
63
<listitem>
64
64
<para>
65
-
Array of public key resource identifiers.
65
+
Array of <classname>OpenSSLAsymmetricKey</classname> instances containing public keys.
66
66
</para>
67
67
</listitem>
68
68
</varlistentry>
69
69
<varlistentry>
70
-
<term><parameter>method</parameter></term>
70
+
<term><parameter>cipher_algo</parameter></term>
71
71
<listitem>
72
72
<para>
73
73
The cipher method.
74
+
<caution>
75
+
<simpara>
76
+
The default value (<literal>'RC4'</literal>) is considered insecure.
77
+
It is strongly recommended to explicitly specify a secure cipher method.
78
+
</simpara>
79
+
</caution>
74
80
</para>
75
81
</listitem>
76
82
</varlistentry>
...
...
@@ -92,11 +98,11 @@
92
98
Returns the length of the sealed data on success, or &false; on error.
93
99
If successful the sealed data is returned in
94
100
<parameter>sealed_data</parameter>, and the envelope keys in
95
-
<parameter>env_keys</parameter>.
101
+
<parameter>encrypted_keys</parameter>.
96
102
</para>
97
103
</refsect1>
98
104

99
-
<refsect1 role="changelog"><!-- {{{ -->
105
+
<refsect1 role="changelog">
100
106
&reftitle.changelog;
101
107
<informaltable>
102
108
<tgroup cols="2">
...
...
@@ -108,21 +114,30 @@
108
114
</thead>
109
115
<tbody>
110
116
<row>
111
-
<entry>7.0.0</entry>
117
+
<entry>8.0.0</entry>
112
118
<entry>
113
-
The <parameter>iv</parameter> has been added.
119
+
<parameter>public_key</parameter> accepts an &array; of
120
+
<classname>OpenSSLAsymmetricKey</classname> instances now;
121
+
previously, an &array; of &resource;s of type <literal>OpenSSL key</literal>
122
+
was accepted.
114
123
</entry>
115
124
</row>
116
125
<row>
117
-
<entry>5.3.0</entry>
126
+
<entry>8.0.0</entry>
118
127
<entry>
119
-
The <parameter>method</parameter> has been added.
128
+
<parameter>cipher_algo</parameter> is no longer an optional parameter.
129
+
</entry>
130
+
</row>
131
+
<row>
132
+
<entry>8.0.0</entry>
133
+
<entry>
134
+
<parameter>iv</parameter> is nullable now.
120
135
</entry>
121
136
</row>
122
137
</tbody>
123
138
</tgroup>
124
139
</informaltable>
125
-
</refsect1><!-- }}} -->
140
+
</refsect1>
126
141

127
142
<refsect1 role="examples">
128
143
&reftitle.examples;
...
...
@@ -169,7 +184,6 @@ openssl_free_key($pk2);
169
184
</refsect1>
170
185

171
186
</refentry>
172
-

173
187
<!-- Keep this comment at the end of the file
174
188
Local variables:
175
189
mode: sgml
176
190