Merge branch 'vendor/DIFFUTILS'
[dragonfly.git] / secure / usr.bin / openssl / man / ca.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.14)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "CA 1"
127 .TH CA 1 "2011-09-06" "1.0.0e" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 ca \- sample minimal CA application
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBca\fR
137 [\fB\-verbose\fR]
138 [\fB\-config filename\fR]
139 [\fB\-name section\fR]
140 [\fB\-gencrl\fR]
141 [\fB\-revoke file\fR]
142 [\fB\-crl_reason reason\fR]
143 [\fB\-crl_hold instruction\fR]
144 [\fB\-crl_compromise time\fR]
145 [\fB\-crl_CA_compromise time\fR]
146 [\fB\-crldays days\fR]
147 [\fB\-crlhours hours\fR]
148 [\fB\-crlexts section\fR]
149 [\fB\-startdate date\fR]
150 [\fB\-enddate date\fR]
151 [\fB\-days arg\fR]
152 [\fB\-md arg\fR]
153 [\fB\-policy arg\fR]
154 [\fB\-keyfile arg\fR]
155 [\fB\-key arg\fR]
156 [\fB\-passin arg\fR]
157 [\fB\-cert file\fR]
158 [\fB\-selfsign\fR]
159 [\fB\-in file\fR]
160 [\fB\-out file\fR]
161 [\fB\-notext\fR]
162 [\fB\-outdir dir\fR]
163 [\fB\-infiles\fR]
164 [\fB\-spkac file\fR]
165 [\fB\-ss_cert file\fR]
166 [\fB\-preserveDN\fR]
167 [\fB\-noemailDN\fR]
168 [\fB\-batch\fR]
169 [\fB\-msie_hack\fR]
170 [\fB\-extensions section\fR]
171 [\fB\-extfile section\fR]
172 [\fB\-engine id\fR]
173 [\fB\-subj arg\fR]
174 [\fB\-utf8\fR]
175 [\fB\-multivalue\-rdn\fR]
176 .SH "DESCRIPTION"
177 .IX Header "DESCRIPTION"
178 The \fBca\fR command is a minimal \s-1CA\s0 application. It can be used
179 to sign certificate requests in a variety of forms and generate
180 CRLs it also maintains a text database of issued certificates
181 and their status.
182 .PP
183 The options descriptions will be divided into each purpose.
184 .SH "CA OPTIONS"
185 .IX Header "CA OPTIONS"
186 .IP "\fB\-config filename\fR" 4
187 .IX Item "-config filename"
188 specifies the configuration file to use.
189 .IP "\fB\-name section\fR" 4
190 .IX Item "-name section"
191 specifies the configuration file section to use (overrides
192 \&\fBdefault_ca\fR in the \fBca\fR section).
193 .IP "\fB\-in filename\fR" 4
194 .IX Item "-in filename"
195 an input filename containing a single certificate request to be
196 signed by the \s-1CA\s0.
197 .IP "\fB\-ss_cert filename\fR" 4
198 .IX Item "-ss_cert filename"
199 a single self signed certificate to be signed by the \s-1CA\s0.
200 .IP "\fB\-spkac filename\fR" 4
201 .IX Item "-spkac filename"
202 a file containing a single Netscape signed public key and challenge
203 and additional field values to be signed by the \s-1CA\s0. See the \fB\s-1SPKAC\s0 \s-1FORMAT\s0\fR
204 section for information on the required format.
205 .IP "\fB\-infiles\fR" 4
206 .IX Item "-infiles"
207 if present this should be the last option, all subsequent arguments
208 are assumed to the the names of files containing certificate requests.
209 .IP "\fB\-out filename\fR" 4
210 .IX Item "-out filename"
211 the output file to output certificates to. The default is standard
212 output. The certificate details will also be printed out to this
213 file.
214 .IP "\fB\-outdir directory\fR" 4
215 .IX Item "-outdir directory"
216 the directory to output certificates to. The certificate will be
217 written to a filename consisting of the serial number in hex with
218 \&\*(L".pem\*(R" appended.
219 .IP "\fB\-cert\fR" 4
220 .IX Item "-cert"
221 the \s-1CA\s0 certificate file.
222 .IP "\fB\-keyfile filename\fR" 4
223 .IX Item "-keyfile filename"
224 the private key to sign requests with.
225 .IP "\fB\-key password\fR" 4
226 .IX Item "-key password"
227 the password used to encrypt the private key. Since on some
228 systems the command line arguments are visible (e.g. Unix with
229 the 'ps' utility) this option should be used with caution.
230 .IP "\fB\-selfsign\fR" 4
231 .IX Item "-selfsign"
232 indicates the issued certificates are to be signed with the key
233 the certificate requests were signed with (given with \fB\-keyfile\fR).
234 Cerificate requests signed with a different key are ignored.  If
235 \&\fB\-spkac\fR, \fB\-ss_cert\fR or \fB\-gencrl\fR are given, \fB\-selfsign\fR is
236 ignored.
237 .Sp
238 A consequence of using \fB\-selfsign\fR is that the self-signed
239 certificate appears among the entries in the certificate database
240 (see the configuration option \fBdatabase\fR), and uses the same
241 serial number counter as all other certificates sign with the
242 self-signed certificate.
243 .IP "\fB\-passin arg\fR" 4
244 .IX Item "-passin arg"
245 the key password source. For more information about the format of \fBarg\fR
246 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
247 .IP "\fB\-verbose\fR" 4
248 .IX Item "-verbose"
249 this prints extra details about the operations being performed.
250 .IP "\fB\-notext\fR" 4
251 .IX Item "-notext"
252 don't output the text form of a certificate to the output file.
253 .IP "\fB\-startdate date\fR" 4
254 .IX Item "-startdate date"
255 this allows the start date to be explicitly set. The format of the
256 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
257 .IP "\fB\-enddate date\fR" 4
258 .IX Item "-enddate date"
259 this allows the expiry date to be explicitly set. The format of the
260 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
261 .IP "\fB\-days arg\fR" 4
262 .IX Item "-days arg"
263 the number of days to certify the certificate for.
264 .IP "\fB\-md alg\fR" 4
265 .IX Item "-md alg"
266 the message digest to use. Possible values include md5, sha1 and mdc2.
267 This option also applies to CRLs.
268 .IP "\fB\-policy arg\fR" 4
269 .IX Item "-policy arg"
270 this option defines the \s-1CA\s0 \*(L"policy\*(R" to use. This is a section in
271 the configuration file which decides which fields should be mandatory
272 or match the \s-1CA\s0 certificate. Check out the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
273 for more information.
274 .IP "\fB\-msie_hack\fR" 4
275 .IX Item "-msie_hack"
276 this is a legacy option to make \fBca\fR work with very old versions of
277 the \s-1IE\s0 certificate enrollment control \*(L"certenr3\*(R". It used UniversalStrings
278 for almost everything. Since the old control has various security bugs
279 its use is strongly discouraged. The newer control \*(L"Xenroll\*(R" does not
280 need this option.
281 .IP "\fB\-preserveDN\fR" 4
282 .IX Item "-preserveDN"
283 Normally the \s-1DN\s0 order of a certificate is the same as the order of the
284 fields in the relevant policy section. When this option is set the order 
285 is the same as the request. This is largely for compatibility with the
286 older \s-1IE\s0 enrollment control which would only accept certificates if their
287 DNs match the order of the request. This is not needed for Xenroll.
288 .IP "\fB\-noemailDN\fR" 4
289 .IX Item "-noemailDN"
290 The \s-1DN\s0 of a certificate can contain the \s-1EMAIL\s0 field if present in the
291 request \s-1DN\s0, however it is good policy just having the e\-mail set into
292 the altName extension of the certificate. When this option is set the
293 \&\s-1EMAIL\s0 field is removed from the certificate' subject and set only in
294 the, eventually present, extensions. The \fBemail_in_dn\fR keyword can be
295 used in the configuration file to enable this behaviour.
296 .IP "\fB\-batch\fR" 4
297 .IX Item "-batch"
298 this sets the batch mode. In this mode no questions will be asked
299 and all certificates will be certified automatically.
300 .IP "\fB\-extensions section\fR" 4
301 .IX Item "-extensions section"
302 the section of the configuration file containing certificate extensions
303 to be added when a certificate is issued (defaults to \fBx509_extensions\fR
304 unless the \fB\-extfile\fR option is used). If no extension section is
305 present then, a V1 certificate is created. If the extension section
306 is present (even if it is empty), then a V3 certificate is created. See the:w
307 \&\fIx509v3_config\fR\|(5) manual page for details of the
308 extension section format.
309 .IP "\fB\-extfile file\fR" 4
310 .IX Item "-extfile file"
311 an additional configuration file to read certificate extensions from
312 (using the default section unless the \fB\-extensions\fR option is also
313 used).
314 .IP "\fB\-engine id\fR" 4
315 .IX Item "-engine id"
316 specifying an engine (by its unique \fBid\fR string) will cause \fBca\fR
317 to attempt to obtain a functional reference to the specified engine,
318 thus initialising it if needed. The engine will then be set as the default
319 for all available algorithms.
320 .IP "\fB\-subj arg\fR" 4
321 .IX Item "-subj arg"
322 supersedes subject name given in the request.
323 The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR,
324 characters may be escaped by \e (backslash), no spaces are skipped.
325 .IP "\fB\-utf8\fR" 4
326 .IX Item "-utf8"
327 this option causes field values to be interpreted as \s-1UTF8\s0 strings, by 
328 default they are interpreted as \s-1ASCII\s0. This means that the field
329 values, whether prompted from a terminal or obtained from a
330 configuration file, must be valid \s-1UTF8\s0 strings.
331 .IP "\fB\-multivalue\-rdn\fR" 4
332 .IX Item "-multivalue-rdn"
333 this option causes the \-subj argument to be interpretedt with full
334 support for multivalued RDNs. Example:
335 .Sp
336 \&\fI/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\fR
337 .Sp
338 If \-multi\-rdn is not used then the \s-1UID\s0 value is \fI123456+CN=John Doe\fR.
339 .SH "CRL OPTIONS"
340 .IX Header "CRL OPTIONS"
341 .IP "\fB\-gencrl\fR" 4
342 .IX Item "-gencrl"
343 this option generates a \s-1CRL\s0 based on information in the index file.
344 .IP "\fB\-crldays num\fR" 4
345 .IX Item "-crldays num"
346 the number of days before the next \s-1CRL\s0 is due. That is the days from
347 now to place in the \s-1CRL\s0 nextUpdate field.
348 .IP "\fB\-crlhours num\fR" 4
349 .IX Item "-crlhours num"
350 the number of hours before the next \s-1CRL\s0 is due.
351 .IP "\fB\-revoke filename\fR" 4
352 .IX Item "-revoke filename"
353 a filename containing a certificate to revoke.
354 .IP "\fB\-crl_reason reason\fR" 4
355 .IX Item "-crl_reason reason"
356 revocation reason, where \fBreason\fR is one of: \fBunspecified\fR, \fBkeyCompromise\fR,
357 \&\fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR, \fBcessationOfOperation\fR,
358 \&\fBcertificateHold\fR or \fBremoveFromCRL\fR. The matching of \fBreason\fR is case
359 insensitive. Setting any revocation reason will make the \s-1CRL\s0 v2.
360 .Sp
361 In practive \fBremoveFromCRL\fR is not particularly useful because it is only used
362 in delta CRLs which are not currently implemented.
363 .IP "\fB\-crl_hold instruction\fR" 4
364 .IX Item "-crl_hold instruction"
365 This sets the \s-1CRL\s0 revocation reason code to \fBcertificateHold\fR and the hold
366 instruction to \fBinstruction\fR which must be an \s-1OID\s0. Although any \s-1OID\s0 can be
367 used only \fBholdInstructionNone\fR (the use of which is discouraged by \s-1RFC2459\s0)
368 \&\fBholdInstructionCallIssuer\fR or \fBholdInstructionReject\fR will normally be used.
369 .IP "\fB\-crl_compromise time\fR" 4
370 .IX Item "-crl_compromise time"
371 This sets the revocation reason to \fBkeyCompromise\fR and the compromise time to
372 \&\fBtime\fR. \fBtime\fR should be in GeneralizedTime format that is \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
373 .IP "\fB\-crl_CA_compromise time\fR" 4
374 .IX Item "-crl_CA_compromise time"
375 This is the same as \fBcrl_compromise\fR except the revocation reason is set to
376 \&\fBCACompromise\fR.
377 .IP "\fB\-crlexts section\fR" 4
378 .IX Item "-crlexts section"
379 the section of the configuration file containing \s-1CRL\s0 extensions to
380 include. If no \s-1CRL\s0 extension section is present then a V1 \s-1CRL\s0 is
381 created, if the \s-1CRL\s0 extension section is present (even if it is
382 empty) then a V2 \s-1CRL\s0 is created. The \s-1CRL\s0 extensions specified are
383 \&\s-1CRL\s0 extensions and \fBnot\fR \s-1CRL\s0 entry extensions.  It should be noted
384 that some software (for example Netscape) can't handle V2 CRLs. See
385 \&\fIx509v3_config\fR\|(5) manual page for details of the
386 extension section format.
387 .SH "CONFIGURATION FILE OPTIONS"
388 .IX Header "CONFIGURATION FILE OPTIONS"
389 The section of the configuration file containing options for \fBca\fR
390 is found as follows: If the \fB\-name\fR command line option is used,
391 then it names the section to be used. Otherwise the section to
392 be used must be named in the \fBdefault_ca\fR option of the \fBca\fR section
393 of the configuration file (or in the default section of the
394 configuration file). Besides \fBdefault_ca\fR, the following options are
395 read directly from the \fBca\fR section:
396  \s-1RANDFILE\s0
397  preserve
398  msie_hack
399 With the exception of \fB\s-1RANDFILE\s0\fR, this is probably a bug and may
400 change in future releases.
401 .PP
402 Many of the configuration file options are identical to command line
403 options. Where the option is present in the configuration file
404 and the command line the command line value is used. Where an
405 option is described as mandatory then it must be present in
406 the configuration file or the command line equivalent (if
407 any) used.
408 .IP "\fBoid_file\fR" 4
409 .IX Item "oid_file"
410 This specifies a file containing additional \fB\s-1OBJECT\s0 \s-1IDENTIFIERS\s0\fR.
411 Each line of the file should consist of the numerical form of the
412 object identifier followed by white space then the short name followed
413 by white space and finally the long name.
414 .IP "\fBoid_section\fR" 4
415 .IX Item "oid_section"
416 This specifies a section in the configuration file containing extra
417 object identifiers. Each line should consist of the short name of the
418 object identifier followed by \fB=\fR and the numerical form. The short
419 and long names are the same when this option is used.
420 .IP "\fBnew_certs_dir\fR" 4
421 .IX Item "new_certs_dir"
422 the same as the \fB\-outdir\fR command line option. It specifies
423 the directory where new certificates will be placed. Mandatory.
424 .IP "\fBcertificate\fR" 4
425 .IX Item "certificate"
426 the same as \fB\-cert\fR. It gives the file containing the \s-1CA\s0
427 certificate. Mandatory.
428 .IP "\fBprivate_key\fR" 4
429 .IX Item "private_key"
430 same as the \fB\-keyfile\fR option. The file containing the
431 \&\s-1CA\s0 private key. Mandatory.
432 .IP "\fB\s-1RANDFILE\s0\fR" 4
433 .IX Item "RANDFILE"
434 a file used to read and write random number seed information, or
435 an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
436 .IP "\fBdefault_days\fR" 4
437 .IX Item "default_days"
438 the same as the \fB\-days\fR option. The number of days to certify
439 a certificate for.
440 .IP "\fBdefault_startdate\fR" 4
441 .IX Item "default_startdate"
442 the same as the \fB\-startdate\fR option. The start date to certify
443 a certificate for. If not set the current time is used.
444 .IP "\fBdefault_enddate\fR" 4
445 .IX Item "default_enddate"
446 the same as the \fB\-enddate\fR option. Either this option or
447 \&\fBdefault_days\fR (or the command line equivalents) must be
448 present.
449 .IP "\fBdefault_crl_hours default_crl_days\fR" 4
450 .IX Item "default_crl_hours default_crl_days"
451 the same as the \fB\-crlhours\fR and the \fB\-crldays\fR options. These
452 will only be used if neither command line option is present. At
453 least one of these must be present to generate a \s-1CRL\s0.
454 .IP "\fBdefault_md\fR" 4
455 .IX Item "default_md"
456 the same as the \fB\-md\fR option. The message digest to use. Mandatory.
457 .IP "\fBdatabase\fR" 4
458 .IX Item "database"
459 the text database file to use. Mandatory. This file must be present
460 though initially it will be empty.
461 .IP "\fBunique_subject\fR" 4
462 .IX Item "unique_subject"
463 if the value \fByes\fR is given, the valid certificate entries in the
464 database must have unique subjects.  if the value \fBno\fR is given,
465 several valid certificate entries may have the exact same subject.
466 The default value is \fByes\fR, to be compatible with older (pre 0.9.8)
467 versions of OpenSSL.  However, to make \s-1CA\s0 certificate roll-over easier,
468 it's recommended to use the value \fBno\fR, especially if combined with
469 the \fB\-selfsign\fR command line option.
470 .IP "\fBserial\fR" 4
471 .IX Item "serial"
472 a text file containing the next serial number to use in hex. Mandatory.
473 This file must be present and contain a valid serial number.
474 .IP "\fBcrlnumber\fR" 4
475 .IX Item "crlnumber"
476 a text file containing the next \s-1CRL\s0 number to use in hex. The crl number
477 will be inserted in the CRLs only if this file exists. If this file is
478 present, it must contain a valid \s-1CRL\s0 number.
479 .IP "\fBx509_extensions\fR" 4
480 .IX Item "x509_extensions"
481 the same as \fB\-extensions\fR.
482 .IP "\fBcrl_extensions\fR" 4
483 .IX Item "crl_extensions"
484 the same as \fB\-crlexts\fR.
485 .IP "\fBpreserve\fR" 4
486 .IX Item "preserve"
487 the same as \fB\-preserveDN\fR
488 .IP "\fBemail_in_dn\fR" 4
489 .IX Item "email_in_dn"
490 the same as \fB\-noemailDN\fR. If you want the \s-1EMAIL\s0 field to be removed
491 from the \s-1DN\s0 of the certificate simply set this to 'no'. If not present
492 the default is to allow for the \s-1EMAIL\s0 filed in the certificate's \s-1DN\s0.
493 .IP "\fBmsie_hack\fR" 4
494 .IX Item "msie_hack"
495 the same as \fB\-msie_hack\fR
496 .IP "\fBpolicy\fR" 4
497 .IX Item "policy"
498 the same as \fB\-policy\fR. Mandatory. See the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
499 for more information.
500 .IP "\fBname_opt\fR, \fBcert_opt\fR" 4
501 .IX Item "name_opt, cert_opt"
502 these options allow the format used to display the certificate details
503 when asking the user to confirm signing. All the options supported by
504 the \fBx509\fR utilities \fB\-nameopt\fR and \fB\-certopt\fR switches can be used
505 here, except the \fBno_signame\fR and \fBno_sigdump\fR are permanently set
506 and cannot be disabled (this is because the certificate signature cannot
507 be displayed because the certificate has not been signed at this point).
508 .Sp
509 For convenience the values \fBca_default\fR are accepted by both to produce
510 a reasonable output.
511 .Sp
512 If neither option is present the format used in earlier versions of
513 OpenSSL is used. Use of the old format is \fBstrongly\fR discouraged because
514 it only displays fields mentioned in the \fBpolicy\fR section, mishandles
515 multicharacter string types and does not display extensions.
516 .IP "\fBcopy_extensions\fR" 4
517 .IX Item "copy_extensions"
518 determines how extensions in certificate requests should be handled.
519 If set to \fBnone\fR or this option is not present then extensions are
520 ignored and not copied to the certificate. If set to \fBcopy\fR then any
521 extensions present in the request that are not already present are copied
522 to the certificate. If set to \fBcopyall\fR then all extensions in the
523 request are copied to the certificate: if the extension is already present
524 in the certificate it is deleted first. See the \fB\s-1WARNINGS\s0\fR section before
525 using this option.
526 .Sp
527 The main use of this option is to allow a certificate request to supply
528 values for certain extensions such as subjectAltName.
529 .SH "POLICY FORMAT"
530 .IX Header "POLICY FORMAT"
531 The policy section consists of a set of variables corresponding to
532 certificate \s-1DN\s0 fields. If the value is \*(L"match\*(R" then the field value
533 must match the same field in the \s-1CA\s0 certificate. If the value is
534 \&\*(L"supplied\*(R" then it must be present. If the value is \*(L"optional\*(R" then
535 it may be present. Any fields not mentioned in the policy section
536 are silently deleted, unless the \fB\-preserveDN\fR option is set but
537 this can be regarded more of a quirk than intended behaviour.
538 .SH "SPKAC FORMAT"
539 .IX Header "SPKAC FORMAT"
540 The input to the \fB\-spkac\fR command line option is a Netscape
541 signed public key and challenge. This will usually come from
542 the \fB\s-1KEYGEN\s0\fR tag in an \s-1HTML\s0 form to create a new private key. 
543 It is however possible to create SPKACs using the \fBspkac\fR utility.
544 .PP
545 The file should contain the variable \s-1SPKAC\s0 set to the value of
546 the \s-1SPKAC\s0 and also the required \s-1DN\s0 components as name value pairs.
547 If you need to include the same component twice then it can be
548 preceded by a number and a '.'.
549 .SH "EXAMPLES"
550 .IX Header "EXAMPLES"
551 Note: these examples assume that the \fBca\fR directory structure is
552 already set up and the relevant files already exist. This usually
553 involves creating a \s-1CA\s0 certificate and private key with \fBreq\fR, a
554 serial number file and an empty index file and placing them in
555 the relevant directories.
556 .PP
557 To use the sample configuration file below the directories demoCA,
558 demoCA/private and demoCA/newcerts would be created. The \s-1CA\s0
559 certificate would be copied to demoCA/cacert.pem and its private
560 key to demoCA/private/cakey.pem. A file demoCA/serial would be
561 created containing for example \*(L"01\*(R" and the empty index file
562 demoCA/index.txt.
563 .PP
564 Sign a certificate request:
565 .PP
566 .Vb 1
567 \& openssl ca \-in req.pem \-out newcert.pem
568 .Ve
569 .PP
570 Sign a certificate request, using \s-1CA\s0 extensions:
571 .PP
572 .Vb 1
573 \& openssl ca \-in req.pem \-extensions v3_ca \-out newcert.pem
574 .Ve
575 .PP
576 Generate a \s-1CRL\s0
577 .PP
578 .Vb 1
579 \& openssl ca \-gencrl \-out crl.pem
580 .Ve
581 .PP
582 Sign several requests:
583 .PP
584 .Vb 1
585 \& openssl ca \-infiles req1.pem req2.pem req3.pem
586 .Ve
587 .PP
588 Certify a Netscape \s-1SPKAC:\s0
589 .PP
590 .Vb 1
591 \& openssl ca \-spkac spkac.txt
592 .Ve
593 .PP
594 A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity):
595 .PP
596 .Vb 5
597 \& SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
598 \& CN=Steve Test
599 \& emailAddress=steve@openssl.org
600 \& 0.OU=OpenSSL Group
601 \& 1.OU=Another Group
602 .Ve
603 .PP
604 A sample configuration file with the relevant sections for \fBca\fR:
605 .PP
606 .Vb 2
607 \& [ ca ]
608 \& default_ca      = CA_default            # The default ca section
609 \& 
610 \& [ CA_default ]
611 \&
612 \& dir            = ./demoCA              # top dir
613 \& database       = $dir/index.txt        # index file.
614 \& new_certs_dir  = $dir/newcerts         # new certs dir
615 \& 
616 \& certificate    = $dir/cacert.pem       # The CA cert
617 \& serial         = $dir/serial           # serial no file
618 \& private_key    = $dir/private/cakey.pem# CA private key
619 \& RANDFILE       = $dir/private/.rand    # random number file
620 \& 
621 \& default_days   = 365                   # how long to certify for
622 \& default_crl_days= 30                   # how long before next CRL
623 \& default_md     = md5                   # md to use
624 \&
625 \& policy         = policy_any            # default policy
626 \& email_in_dn    = no                    # Don\*(Aqt add the email into cert DN
627 \&
628 \& name_opt       = ca_default            # Subject name display option
629 \& cert_opt       = ca_default            # Certificate display option
630 \& copy_extensions = none                 # Don\*(Aqt copy extensions from request
631 \&
632 \& [ policy_any ]
633 \& countryName            = supplied
634 \& stateOrProvinceName    = optional
635 \& organizationName       = optional
636 \& organizationalUnitName = optional
637 \& commonName             = supplied
638 \& emailAddress           = optional
639 .Ve
640 .SH "FILES"
641 .IX Header "FILES"
642 Note: the location of all files can change either by compile time options,
643 configuration file entries, environment variables or command line options.
644 The values below reflect the default values.
645 .PP
646 .Vb 10
647 \& /usr/local/ssl/lib/openssl.cnf \- master configuration file
648 \& ./demoCA                       \- main CA directory
649 \& ./demoCA/cacert.pem            \- CA certificate
650 \& ./demoCA/private/cakey.pem     \- CA private key
651 \& ./demoCA/serial                \- CA serial number file
652 \& ./demoCA/serial.old            \- CA serial number backup file
653 \& ./demoCA/index.txt             \- CA text database file
654 \& ./demoCA/index.txt.old         \- CA text database backup file
655 \& ./demoCA/certs                 \- certificate output file
656 \& ./demoCA/.rnd                  \- CA random seed information
657 .Ve
658 .SH "ENVIRONMENT VARIABLES"
659 .IX Header "ENVIRONMENT VARIABLES"
660 \&\fB\s-1OPENSSL_CONF\s0\fR reflects the location of master configuration file it can
661 be overridden by the \fB\-config\fR command line option.
662 .SH "RESTRICTIONS"
663 .IX Header "RESTRICTIONS"
664 The text database index file is a critical part of the process and 
665 if corrupted it can be difficult to fix. It is theoretically possible
666 to rebuild the index file from all the issued certificates and a current
667 \&\s-1CRL:\s0 however there is no option to do this.
668 .PP
669 V2 \s-1CRL\s0 features like delta CRLs are not currently supported.
670 .PP
671 Although several requests can be input and handled at once it is only
672 possible to include one \s-1SPKAC\s0 or self signed certificate.
673 .SH "BUGS"
674 .IX Header "BUGS"
675 The use of an in memory text database can cause problems when large
676 numbers of certificates are present because, as the name implies
677 the database has to be kept in memory.
678 .PP
679 The \fBca\fR command really needs rewriting or the required functionality
680 exposed at either a command or interface level so a more friendly utility
681 (perl script or \s-1GUI\s0) can handle things properly. The scripts \fB\s-1CA\s0.sh\fR and
682 \&\fB\s-1CA\s0.pl\fR help a little but not very much.
683 .PP
684 Any fields in a request that are not present in a policy are silently
685 deleted. This does not happen if the \fB\-preserveDN\fR option is used. To
686 enforce the absence of the \s-1EMAIL\s0 field within the \s-1DN\s0, as suggested by
687 RFCs, regardless the contents of the request' subject the \fB\-noemailDN\fR
688 option can be used. The behaviour should be more friendly and
689 configurable.
690 .PP
691 Cancelling some commands by refusing to certify a certificate can
692 create an empty file.
693 .SH "WARNINGS"
694 .IX Header "WARNINGS"
695 The \fBca\fR command is quirky and at times downright unfriendly.
696 .PP
697 The \fBca\fR utility was originally meant as an example of how to do things
698 in a \s-1CA\s0. It was not supposed to be used as a full blown \s-1CA\s0 itself:
699 nevertheless some people are using it for this purpose.
700 .PP
701 The \fBca\fR command is effectively a single user command: no locking is
702 done on the various files and attempts to run more than one \fBca\fR command
703 on the same database can have unpredictable results.
704 .PP
705 The \fBcopy_extensions\fR option should be used with caution. If care is
706 not taken then it can be a security risk. For example if a certificate
707 request contains a basicConstraints extension with \s-1CA:TRUE\s0 and the
708 \&\fBcopy_extensions\fR value is set to \fBcopyall\fR and the user does not spot
709 this when the certificate is displayed then this will hand the requestor
710 a valid \s-1CA\s0 certificate.
711 .PP
712 This situation can be avoided by setting \fBcopy_extensions\fR to \fBcopy\fR
713 and including basicConstraints with \s-1CA:FALSE\s0 in the configuration file.
714 Then if the request contains a basicConstraints extension it will be
715 ignored.
716 .PP
717 It is advisable to also include values for other extensions such
718 as \fBkeyUsage\fR to prevent a request supplying its own values.
719 .PP
720 Additional restrictions can be placed on the \s-1CA\s0 certificate itself.
721 For example if the \s-1CA\s0 certificate has:
722 .PP
723 .Vb 1
724 \& basicConstraints = CA:TRUE, pathlen:0
725 .Ve
726 .PP
727 then even if a certificate is issued with \s-1CA:TRUE\s0 it will not be valid.
728 .SH "SEE ALSO"
729 .IX Header "SEE ALSO"
730 \&\fIreq\fR\|(1), \fIspkac\fR\|(1), \fIx509\fR\|(1), \s-1\fICA\s0.pl\fR\|(1),
731 \&\fIconfig\fR\|(5), \fIx509v3_config\fR\|(5)