8a055eb54eb0e1fe96039a310a67a60935152378
[dragonfly.git] / secure / usr.bin / openssl / man / CA.pl.1
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "CA.PL 1"
136 .TH CA.PL 1 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 CA.pl \- friendlier interface for OpenSSL certificate programs
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 \&\fB\s-1CA\s0.pl\fR
146 [\fB\-?\fR]
147 [\fB\-h\fR]
148 [\fB\-help\fR]
149 [\fB\-newcert\fR]
150 [\fB\-newreq\fR]
151 [\fB\-newreq\-nodes\fR]
152 [\fB\-newca\fR]
153 [\fB\-xsign\fR]
154 [\fB\-sign\fR]
155 [\fB\-signreq\fR]
156 [\fB\-signcert\fR]
157 [\fB\-verify\fR]
158 [\fBfiles\fR]
159 .SH "DESCRIPTION"
160 .IX Header "DESCRIPTION"
161 The \fB\s-1CA\s0.pl\fR script is a perl script that supplies the relevant command line
162 arguments to the \fBopenssl\fR command for some common certificate operations.
163 It is intended to simplify the process of certificate creation and management
164 by the use of some simple options.
165 .SH "COMMAND OPTIONS"
166 .IX Header "COMMAND OPTIONS"
167 .IP "\fB?\fR, \fB\-h\fR, \fB\-help\fR" 4
168 .IX Item "?, -h, -help"
169 prints a usage message.
170 .IP "\fB\-newcert\fR" 4
171 .IX Item "-newcert"
172 creates a new self signed certificate. The private key is written to the file
173 \&\*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R".
174 .IP "\fB\-newreq\fR" 4
175 .IX Item "-newreq"
176 creates a new certificate request. The private key is written to the file
177 \&\*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R".
178 .IP "\fB\-newreq\-nodes\fR" 4
179 .IX Item "-newreq-nodes"
180 is like \fB\-newreq\fR except that the private key will not be encrypted.
181 .IP "\fB\-newca\fR" 4
182 .IX Item "-newca"
183 creates a new \s-1CA\s0 hierarchy for use with the \fBca\fR program (or the \fB\-signcert\fR
184 and \fB\-xsign\fR options). The user is prompted to enter the filename of the \s-1CA\s0
185 certificates (which should also contain the private key) or by hitting \s-1ENTER\s0
186 details of the \s-1CA\s0 will be prompted for. The relevant files and directories
187 are created in a directory called \*(L"demoCA\*(R" in the current directory.
188 .IP "\fB\-pkcs12\fR" 4
189 .IX Item "-pkcs12"
190 create a PKCS#12 file containing the user certificate, private key and \s-1CA\s0
191 certificate. It expects the user certificate and private key to be in the
192 file \*(L"newcert.pem\*(R" and the \s-1CA\s0 certificate to be in the file demoCA/cacert.pem,
193 it creates a file \*(L"newcert.p12\*(R". This command can thus be called after the
194 \&\fB\-sign\fR option. The PKCS#12 file can be imported directly into a browser.
195 If there is an additional argument on the command line it will be used as the
196 \&\*(L"friendly name\*(R" for the certificate (which is typically displayed in the browser
197 list box), otherwise the name \*(L"My Certificate\*(R" is used.
198 .IP "\fB\-sign\fR, \fB\-signreq\fR, \fB\-xsign\fR" 4
199 .IX Item "-sign, -signreq, -xsign"
200 calls the \fBca\fR program to sign a certificate request. It expects the request
201 to be in the file \*(L"newreq.pem\*(R". The new certificate is written to the file
202 \&\*(L"newcert.pem\*(R" except in the case of the \fB\-xsign\fR option when it is written
203 to standard output.
204 .IP "\fB\-signCA\fR" 4
205 .IX Item "-signCA"
206 this option is the same as the \fB\-signreq\fR option except it uses the configuration
207 file section \fBv3_ca\fR and so makes the signed request a valid \s-1CA\s0 certificate. This
208 is useful when creating intermediate \s-1CA\s0 from a root \s-1CA.\s0
209 .IP "\fB\-signcert\fR" 4
210 .IX Item "-signcert"
211 this option is the same as \fB\-sign\fR except it expects a self signed certificate
212 to be present in the file \*(L"newreq.pem\*(R".
213 .IP "\fB\-verify\fR" 4
214 .IX Item "-verify"
215 verifies certificates against the \s-1CA\s0 certificate for \*(L"demoCA\*(R". If no certificates
216 are specified on the command line it tries to verify the file \*(L"newcert.pem\*(R".
217 .IP "\fBfiles\fR" 4
218 .IX Item "files"
219 one or more optional certificate file names for use with the \fB\-verify\fR command.
220 .SH "EXAMPLES"
221 .IX Header "EXAMPLES"
222 Create a \s-1CA\s0 hierarchy:
223 .PP
224 .Vb 1
225 \& CA.pl \-newca
226 .Ve
227 .PP
228 Complete certificate creation example: create a \s-1CA,\s0 create a request, sign
229 the request and finally create a PKCS#12 file containing it.
230 .PP
231 .Vb 4
232 \& CA.pl \-newca
233 \& CA.pl \-newreq
234 \& CA.pl \-signreq
235 \& CA.pl \-pkcs12 "My Test Certificate"
236 .Ve
237 .SH "DSA CERTIFICATES"
238 .IX Header "DSA CERTIFICATES"
239 Although the \fB\s-1CA\s0.pl\fR creates \s-1RSA\s0 CAs and requests it is still possible to
240 use it with \s-1DSA\s0 certificates and requests using the \fIreq\fR\|(1) command
241 directly. The following example shows the steps that would typically be taken.
242 .PP
243 Create some \s-1DSA\s0 parameters:
244 .PP
245 .Vb 1
246 \& openssl dsaparam \-out dsap.pem 1024
247 .Ve
248 .PP
249 Create a \s-1DSA CA\s0 certificate and private key:
250 .PP
251 .Vb 1
252 \& openssl req \-x509 \-newkey dsa:dsap.pem \-keyout cacert.pem \-out cacert.pem
253 .Ve
254 .PP
255 Create the \s-1CA\s0 directories and files:
256 .PP
257 .Vb 1
258 \& CA.pl \-newca
259 .Ve
260 .PP
261 enter cacert.pem when prompted for the \s-1CA\s0 file name.
262 .PP
263 Create a \s-1DSA\s0 certificate request and private key (a different set of parameters
264 can optionally be created first):
265 .PP
266 .Vb 1
267 \& openssl req \-out newreq.pem \-newkey dsa:dsap.pem
268 .Ve
269 .PP
270 Sign the request:
271 .PP
272 .Vb 1
273 \& CA.pl \-signreq
274 .Ve
275 .SH "NOTES"
276 .IX Header "NOTES"
277 Most of the filenames mentioned can be modified by editing the \fB\s-1CA\s0.pl\fR script.
278 .PP
279 If the demoCA directory already exists then the \fB\-newca\fR command will not
280 overwrite it and will do nothing. This can happen if a previous call using
281 the \fB\-newca\fR option terminated abnormally. To get the correct behaviour
282 delete the demoCA directory if it already exists.
283 .PP
284 Under some environments it may not be possible to run the \fB\s-1CA\s0.pl\fR script
285 directly (for example Win32) and the default configuration file location may
286 be wrong. In this case the command:
287 .PP
288 .Vb 1
289 \& perl \-S CA.pl
290 .Ve
291 .PP
292 can be used and the \fB\s-1OPENSSL_CONF\s0\fR environment variable changed to point to 
293 the correct path of the configuration file \*(L"openssl.cnf\*(R".
294 .PP
295 The script is intended as a simple front end for the \fBopenssl\fR program for use
296 by a beginner. Its behaviour isn't always what is wanted. For more control over the
297 behaviour of the certificate commands call the \fBopenssl\fR command directly.
298 .SH "ENVIRONMENT VARIABLES"
299 .IX Header "ENVIRONMENT VARIABLES"
300 The variable \fB\s-1OPENSSL_CONF\s0\fR if defined allows an alternative configuration
301 file location to be specified, it should contain the full path to the
302 configuration file, not just its directory.
303 .SH "SEE ALSO"
304 .IX Header "SEE ALSO"
305 \&\fIx509\fR\|(1), \fIca\fR\|(1), \fIreq\fR\|(1), \fIpkcs12\fR\|(1),
306 \&\fIconfig\fR\|(5)