reference/openssl/functions/openssl-pkcs12-export.xml
1869f4c8728cfe9223173a086369b2f2e1b22dad
1869f4c8728cfe9223173a086369b2f2e1b22dad
...
...
@@ -1,25 +1,25 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs12-export">
3
+
<refentry xml:id="function.openssl-pkcs12-export" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_pkcs12_export</refname>
6
-
<refpurpose>Exports a PKCS#12 Compatible Certificate Store File to variable.</refpurpose>
6
+
<refpurpose>Exports a <acronym>PKCS</acronym>#12 Compatible Certificate Store File to variable</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_pkcs12_export</methodname>
13
-
<methodparam><type>mixed</type><parameter>x509</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter role="reference">out</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>priv_key</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>pass</parameter></methodparam>
17
-
<methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam>
13
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter role="reference">output</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><type>string</type><parameter>passphrase</parameter></methodparam>
17
+
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
18
18
</methodsynopsis>
19
19
<para>
20
20
<function>openssl_pkcs12_export</function> stores
21
-
<parameter>x509</parameter> into a string named by
22
-
<parameter>out</parameter> in a PKCS#12 file format.
21
+
<parameter>certificate</parameter> into a string named by
22
+
<parameter>output</parameter> in a <acronym>PKCS</acronym>#12 file format.
23
23
</para>
24
24
</refsect1>
25
25
...
...
@@ -29,33 +29,55 @@
29
29
<variablelist>
30
30
&openssl.param.x509;
31
31
<varlistentry>
32
-
<term><parameter>out</parameter></term>
32
+
<term><parameter>output</parameter></term>
33
33
<listitem>
34
34
<para>
35
-
On success, this will hold the PKCS#12.
35
+
On success, this will hold the <acronym>PKCS</acronym>#12.
36
36
</para>
37
37
</listitem>
38
38
</varlistentry>
39
39
<varlistentry>
40
-
<term><parameter>priv_key</parameter></term>
40
+
<term><parameter>private_key</parameter></term>
41
41
<listitem>
42
42
<para>
43
-
Private key component of PKCS#12 file.
43
+
Private key component of <acronym>PKCS</acronym>#12 file.
44
+
See <link linkend="openssl.certparams">Public/Private Key parameters</link> for a list of valid values.
44
45
</para>
45
46
</listitem>
46
47
</varlistentry>
47
48
<varlistentry>
48
-
<term><parameter>pass</parameter></term>
49
+
<term><parameter>passphrase</parameter></term>
49
50
<listitem>
50
51
<para>
51
-
Encryption password for unlocking the PKCS#12 file.
52
+
Encryption password for unlocking the <acronym>PKCS</acronym>#12 file.
52
53
</para>
53
54
</listitem>
54
55
</varlistentry>
55
56
<varlistentry>
56
-
<term><parameter>args</parameter></term>
57
+
<term><parameter>options</parameter></term>
57
58
<listitem>
58
59
<para>
60
+
Optional array, other keys will be ignored.
61
+
<informaltable>
62
+
<tgroup cols="2">
63
+
<thead>
64
+
<row>
65
+
<entry>Key</entry>
66
+
<entry>&Description;</entry>
67
+
</row>
68
+
</thead>
69
+
<tbody>
70
+
<row>
71
+
<entry><literal>"extracerts"</literal></entry>
72
+
<entry>array of extra certificates or a single certificate to be included in the <acronym>PKCS</acronym>#12 file.</entry>
73
+
</row>
74
+
<row>
75
+
<entry><literal>"friendly_name"</literal></entry>
76
+
<entry>string to be used for the supplied certificate and key</entry>
77
+
</row>
78
+
</tbody>
79
+
</tgroup>
80
+
</informaltable>
59
81
</para>
60
82
</listitem>
61
83
</varlistentry>
...
...
@@ -70,8 +92,38 @@
70
92
</para>
71
93
</refsect1>
72
94
95
+
<refsect1 role="changelog">
96
+
&reftitle.changelog;
97
+
<informaltable>
98
+
<tgroup cols="2">
99
+
<thead>
100
+
<row>
101
+
<entry>&Version;</entry>
102
+
<entry>&Description;</entry>
103
+
</row>
104
+
</thead>
105
+
<tbody>
106
+
<row>
107
+
<entry>8.0.0</entry>
108
+
<entry>
109
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
110
+
previously, a &resource; of type <literal>OpenSSL X.509 CSR</literal> was accepted.
111
+
</entry>
112
+
</row>
113
+
<row>
114
+
<entry>8.0.0</entry>
115
+
<entry>
116
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
117
+
or <classname>OpenSSLCertificate</classname> instance now;
118
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
119
+
was accepted.
120
+
</entry>
121
+
</row>
122
+
</tbody>
123
+
</tgroup>
124
+
</informaltable>
125
+
</refsect1>
73
126
</refentry>
74
-
75
127
<!-- Keep this comment at the end of the file
76
128
Local variables:
77
129
mode: sgml
78
130