reference/openssl/functions/openssl-csr-sign.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -1,25 +1,24 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-csr-sign">
3
+
<refentry xml:id="function.openssl-csr-sign" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_csr_sign</refname>
6
-
<refpurpose>Sign a CSR with another certificate (or itself) and generate a certificate</refpurpose>
6
+
<refpurpose>Sign a <acronym>CSR</acronym> with another certificate (or itself) and generate a certificate</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>openssl_csr_sign</methodname>
13
-
<methodparam><type>mixed</type><parameter>csr</parameter></methodparam>
14
-
<methodparam><type>mixed</type><parameter>cacert</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>priv_key</parameter></methodparam>
12
+
<type class="union"><type>OpenSSLCertificate</type><type>false</type></type><methodname>openssl_csr_sign</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
14
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type><type>null</type></type><parameter>ca_certificate</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
16
<methodparam><type>int</type><parameter>days</parameter></methodparam>
17
-
<methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam>
17
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
18
18
<methodparam choice="opt"><type>int</type><parameter>serial</parameter><initializer>0</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<para>
21
-
<function>openssl_csr_sign</function> generates an x509 certificate
22
-
resource from the given CSR.
21
+
<function>openssl_csr_sign</function> generates an x509 certificate from the given <acronym>CSR</acronym>.
23
22
</para>
24
23
&note.openssl.cnf;
25
24
</refsect1>
...
...
@@ -32,29 +31,29 @@
32
31
<term><parameter>csr</parameter></term>
33
32
<listitem>
34
33
<para>
35
-
A CSR previously generated by <function>openssl_csr_new</function>.
36
-
It can also be the path to a PEM encoded CSR when specified as
34
+
A <acronym>CSR</acronym> previously generated by <function>openssl_csr_new</function>.
35
+
It can also be the path to a <acronym>PEM</acronym> encoded <acronym>CSR</acronym> when specified as
37
36
<filename>file://path/to/csr</filename> or an exported string generated
38
37
by <function>openssl_csr_export</function>.
39
38
</para>
40
39
</listitem>
41
40
</varlistentry>
42
41
<varlistentry>
43
-
<term><parameter>cacert</parameter></term>
42
+
<term><parameter>ca_certificate</parameter></term>
44
43
<listitem>
45
44
<para>
46
-
The generated certificate will be signed by <parameter>cacert</parameter>.
47
-
If <parameter>cacert</parameter> is &null;, the generated certificate
45
+
The generated certificate will be signed by <parameter>ca_certificate</parameter>.
46
+
If <parameter>ca_certificate</parameter> is &null;, the generated certificate
48
47
will be a self-signed certificate.
49
48
</para>
50
49
</listitem>
51
50
</varlistentry>
52
51
<varlistentry>
53
-
<term><parameter>priv_key</parameter></term>
52
+
<term><parameter>private_key</parameter></term>
54
53
<listitem>
55
54
<para>
56
-
<parameter>priv_key</parameter> is the private key that corresponds to
57
-
<parameter>cacert</parameter>.
55
+
<parameter>private_key</parameter> is the private key that corresponds to
56
+
<parameter>ca_certificate</parameter>.
58
57
</para>
59
58
</listitem>
60
59
</varlistentry>
...
...
@@ -68,12 +67,12 @@
68
67
</listitem>
69
68
</varlistentry>
70
69
<varlistentry>
71
-
<term><parameter>configargs</parameter></term>
70
+
<term><parameter>options</parameter></term>
72
71
<listitem>
73
72
<para>
74
-
You can finetune the CSR signing by <parameter>configargs</parameter>.
73
+
You can finetune the <acronym>CSR</acronym> signing by <parameter>options</parameter>.
75
74
See <function>openssl_csr_new</function> for more information about
76
-
<parameter>configargs</parameter>.
75
+
<parameter>options</parameter>.
77
76
</para>
78
77
</listitem>
79
78
</varlistentry>
...
...
@@ -93,16 +92,62 @@
93
92
<refsect1 role="returnvalues">
94
93
&reftitle.returnvalues;
95
94
<para>
96
-
Returns an x509 certificate resource on success, &false; on failure.
95
+
Returns an <classname>OpenSSLCertificate</classname> on success, &false; on failure.
97
96
</para>
98
97
</refsect1>
99
98

99
+
<refsect1 role="changelog">
100
+
&reftitle.changelog;
101
+
<informaltable>
102
+
<tgroup cols="2">
103
+
<thead>
104
+
<row>
105
+
<entry>&Version;</entry>
106
+
<entry>&Description;</entry>
107
+
</row>
108
+
</thead>
109
+
<tbody>
110
+
<row>
111
+
<entry>8.0.0</entry>
112
+
<entry>
113
+
On success, this function returns an <classname>OpenSSLCertificate</classname> instance now;
114
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was returned.
115
+
</entry>
116
+
</row>
117
+
<row>
118
+
<entry>8.0.0</entry>
119
+
<entry>
120
+
<parameter>csr</parameter> accepts an <classname>OpenSSLCertificateSigningRequest</classname> instance now;
121
+
previously, a &resource; of type <literal>OpenSSL X.509 CSR</literal> was accepted.
122
+
</entry>
123
+
</row>
124
+
<row>
125
+
<entry>8.0.0</entry>
126
+
<entry>
127
+
<parameter>ca_certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
128
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
129
+
</entry>
130
+
</row>
131
+
<row>
132
+
<entry>8.0.0</entry>
133
+
<entry>
134
+
<parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
135
+
or <classname>OpenSSLCertificate</classname> instance now;
136
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
137
+
was accepted.
138
+
</entry>
139
+
</row>
140
+
</tbody>
141
+
</tgroup>
142
+
</informaltable>
143
+
</refsect1>
144
+

100
145
<refsect1 role="examples">
101
146
&reftitle.examples;
102
147
<para>
103
148
<example>
104
149
<title><function>openssl_csr_sign</function> example - signing a
105
-
CSR (how to implement your own CA)</title>
150
+
<acronym>CSR</acronym> (how to implement your own CA)</title>
106
151
<programlisting role="php">
107
152
<![CDATA[
108
153
<?php
...
...
@@ -139,7 +184,6 @@ while (($e = openssl_error_string()) !== false) {
139
184
</refsect1>
140
185

141
186
</refentry>
142
-

143
187
<!-- Keep this comment at the end of the file
144
188
Local variables:
145
189
mode: sgml
146
190



Tools (Chinese (Simplified) Manual)