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