1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
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 \
129 .\" ========================================================================
132 .TH CA 1 "2005-07-06" "0.9.8" "OpenSSL"
134 ca \- sample minimal CA application
136 .IX Header "SYNOPSIS"
137 \&\fBopenssl\fR \fBca\fR
139 [\fB\-config filename\fR]
140 [\fB\-name section\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]
148 [\fB\-crldays days\fR]
149 [\fB\-crlhours hours\fR]
150 [\fB\-crlexts section\fR]
151 [\fB\-startdate date\fR]
152 [\fB\-enddate date\fR]
156 [\fB\-keyfile arg\fR]
167 [\fB\-ss_cert file\fR]
172 [\fB\-extensions section\fR]
173 [\fB\-extfile section\fR]
176 .IX Header "DESCRIPTION"
177 The \fBca\fR command is a minimal \s-1CA\s0 application. It can be used
178 to sign certificate requests in a variety of forms and generate
179 CRLs it also maintains a text database of issued certificates
182 The options descriptions will be divided into each purpose.
184 .IX Header "CA OPTIONS"
185 .IP "\fB\-config filename\fR" 4
186 .IX Item "-config filename"
187 specifies the configuration file to use.
188 .IP "\fB\-name section\fR" 4
189 .IX Item "-name section"
190 specifies the configuration file section to use (overrides
191 \&\fBdefault_ca\fR in the \fBca\fR section).
192 .IP "\fB\-in filename\fR" 4
193 .IX Item "-in filename"
194 an input filename containing a single certificate request to be
195 signed by the \s-1CA\s0.
196 .IP "\fB\-ss_cert filename\fR" 4
197 .IX Item "-ss_cert filename"
198 a single self signed certificate to be signed by the \s-1CA\s0.
199 .IP "\fB\-spkac filename\fR" 4
200 .IX Item "-spkac filename"
201 a file containing a single Netscape signed public key and challenge
202 and additional field values to be signed by the \s-1CA\s0. See the \fB\s-1SPKAC\s0 \s-1FORMAT\s0\fR
203 section for information on the required format.
204 .IP "\fB\-infiles\fR" 4
206 if present this should be the last option, all subsequent arguments
207 are assumed to the the names of files containing certificate requests.
208 .IP "\fB\-out filename\fR" 4
209 .IX Item "-out filename"
210 the output file to output certificates to. The default is standard
211 output. The certificate details will also be printed out to this
213 .IP "\fB\-outdir directory\fR" 4
214 .IX Item "-outdir directory"
215 the directory to output certificates to. The certificate will be
216 written to a filename consisting of the serial number in hex with
217 \&\*(L".pem\*(R" appended.
220 the \s-1CA\s0 certificate file.
221 .IP "\fB\-keyfile filename\fR" 4
222 .IX Item "-keyfile filename"
223 the private key to sign requests with.
224 .IP "\fB\-key password\fR" 4
225 .IX Item "-key password"
226 the password used to encrypt the private key. Since on some
227 systems the command line arguments are visible (e.g. Unix with
228 the 'ps' utility) this option should be used with caution.
229 .IP "\fB\-selfsign\fR" 4
231 indicates the issued certificates are to be signed with the key
232 the certificate requests were signed with (given with \fB\-keyfile\fR).
233 Cerificate requests signed with a different key are ignored. If
234 \&\fB\-spkac\fR, \fB\-ss_cert\fR or \fB\-gencrl\fR are given, \fB\-selfsign\fR is
237 A consequence of using \fB\-selfsign\fR is that the self-signed
238 certificate appears among the entries in the certificate database
239 (see the configuration option \fBdatabase\fR), and uses the same
240 serial number counter as all other certificates sign with the
241 self-signed certificate.
242 .IP "\fB\-passin arg\fR" 4
243 .IX Item "-passin arg"
244 the key password source. For more information about the format of \fBarg\fR
245 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
246 .IP "\fB\-verbose\fR" 4
248 this prints extra details about the operations being performed.
249 .IP "\fB\-notext\fR" 4
251 don't output the text form of a certificate to the output file.
252 .IP "\fB\-startdate date\fR" 4
253 .IX Item "-startdate date"
254 this allows the start date to be explicitly set. The format of the
255 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
256 .IP "\fB\-enddate date\fR" 4
257 .IX Item "-enddate date"
258 this allows the expiry date to be explicitly set. The format of the
259 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
260 .IP "\fB\-days arg\fR" 4
262 the number of days to certify the certificate for.
263 .IP "\fB\-md alg\fR" 4
265 the message digest to use. Possible values include md5, sha1 and mdc2.
266 This option also applies to CRLs.
267 .IP "\fB\-policy arg\fR" 4
268 .IX Item "-policy arg"
269 this option defines the \s-1CA\s0 \*(L"policy\*(R" to use. This is a section in
270 the configuration file which decides which fields should be mandatory
271 or match the \s-1CA\s0 certificate. Check out the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
272 for more information.
273 .IP "\fB\-msie_hack\fR" 4
274 .IX Item "-msie_hack"
275 this is a legacy option to make \fBca\fR work with very old versions of
276 the \s-1IE\s0 certificate enrollment control \*(L"certenr3\*(R". It used UniversalStrings
277 for almost everything. Since the old control has various security bugs
278 its use is strongly discouraged. The newer control \*(L"Xenroll\*(R" does not
280 .IP "\fB\-preserveDN\fR" 4
281 .IX Item "-preserveDN"
282 Normally the \s-1DN\s0 order of a certificate is the same as the order of the
283 fields in the relevant policy section. When this option is set the order
284 is the same as the request. This is largely for compatibility with the
285 older \s-1IE\s0 enrollment control which would only accept certificates if their
286 DNs match the order of the request. This is not needed for Xenroll.
287 .IP "\fB\-noemailDN\fR" 4
288 .IX Item "-noemailDN"
289 The \s-1DN\s0 of a certificate can contain the \s-1EMAIL\s0 field if present in the
290 request \s-1DN\s0, however it is good policy just having the e\-mail set into
291 the altName extension of the certificate. When this option is set the
292 \&\s-1EMAIL\s0 field is removed from the certificate' subject and set only in
293 the, eventually present, extensions. The \fBemail_in_dn\fR keyword can be
294 used in the configuration file to enable this behaviour.
295 .IP "\fB\-batch\fR" 4
297 this sets the batch mode. In this mode no questions will be asked
298 and all certificates will be certified automatically.
299 .IP "\fB\-extensions section\fR" 4
300 .IX Item "-extensions section"
301 the section of the configuration file containing certificate extensions
302 to be added when a certificate is issued (defaults to \fBx509_extensions\fR
303 unless the \fB\-extfile\fR option is used). If no extension section is
304 present then, a V1 certificate is created. If the extension section
305 is present (even if it is empty), then a V3 certificate is created.
306 .IP "\fB\-extfile file\fR" 4
307 .IX Item "-extfile file"
308 an additional configuration file to read certificate extensions from
309 (using the default section unless the \fB\-extensions\fR option is also
311 .IP "\fB\-engine id\fR" 4
312 .IX Item "-engine id"
313 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
314 to attempt to obtain a functional reference to the specified engine,
315 thus initialising it if needed. The engine will then be set as the default
316 for all available algorithms.
318 .IX Header "CRL OPTIONS"
319 .IP "\fB\-gencrl\fR" 4
321 this option generates a \s-1CRL\s0 based on information in the index file.
322 .IP "\fB\-crldays num\fR" 4
323 .IX Item "-crldays num"
324 the number of days before the next \s-1CRL\s0 is due. That is the days from
325 now to place in the \s-1CRL\s0 nextUpdate field.
326 .IP "\fB\-crlhours num\fR" 4
327 .IX Item "-crlhours num"
328 the number of hours before the next \s-1CRL\s0 is due.
329 .IP "\fB\-revoke filename\fR" 4
330 .IX Item "-revoke filename"
331 a filename containing a certificate to revoke.
332 .IP "\fB\-crl_reason reason\fR" 4
333 .IX Item "-crl_reason reason"
334 revocation reason, where \fBreason\fR is one of: \fBunspecified\fR, \fBkeyCompromise\fR,
335 \&\fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR, \fBcessationOfOperation\fR,
336 \&\fBcertificateHold\fR or \fBremoveFromCRL\fR. The matching of \fBreason\fR is case
337 insensitive. Setting any revocation reason will make the \s-1CRL\s0 v2.
339 In practive \fBremoveFromCRL\fR is not particularly useful because it is only used
340 in delta CRLs which are not currently implemented.
341 .IP "\fB\-crl_hold instruction\fR" 4
342 .IX Item "-crl_hold instruction"
343 This sets the \s-1CRL\s0 revocation reason code to \fBcertificateHold\fR and the hold
344 instruction to \fBinstruction\fR which must be an \s-1OID\s0. Although any \s-1OID\s0 can be
345 used only \fBholdInstructionNone\fR (the use of which is discouraged by \s-1RFC2459\s0)
346 \&\fBholdInstructionCallIssuer\fR or \fBholdInstructionReject\fR will normally be used.
347 .IP "\fB\-crl_compromise time\fR" 4
348 .IX Item "-crl_compromise time"
349 This sets the revocation reason to \fBkeyCompromise\fR and the compromise time to
350 \&\fBtime\fR. \fBtime\fR should be in GeneralizedTime format that is \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
351 .IP "\fB\-crl_CA_compromise time\fR" 4
352 .IX Item "-crl_CA_compromise time"
353 This is the same as \fBcrl_compromise\fR except the revocation reason is set to
354 \&\fBCACompromise\fR.
355 .IP "\fB\-subj arg\fR" 4
357 supersedes subject name given in the request.
358 The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR,
359 characters may be escaped by \e (backslash), no spaces are skipped.
360 .IP "\fB\-crlexts section\fR" 4
361 .IX Item "-crlexts section"
362 the section of the configuration file containing \s-1CRL\s0 extensions to
363 include. If no \s-1CRL\s0 extension section is present then a V1 \s-1CRL\s0 is
364 created, if the \s-1CRL\s0 extension section is present (even if it is
365 empty) then a V2 \s-1CRL\s0 is created. The \s-1CRL\s0 extensions specified are
366 \&\s-1CRL\s0 extensions and \fBnot\fR \s-1CRL\s0 entry extensions. It should be noted
367 that some software (for example Netscape) can't handle V2 CRLs.
368 .SH "CONFIGURATION FILE OPTIONS"
369 .IX Header "CONFIGURATION FILE OPTIONS"
370 The section of the configuration file containing options for \fBca\fR
371 is found as follows: If the \fB\-name\fR command line option is used,
372 then it names the section to be used. Otherwise the section to
373 be used must be named in the \fBdefault_ca\fR option of the \fBca\fR section
374 of the configuration file (or in the default section of the
375 configuration file). Besides \fBdefault_ca\fR, the following options are
376 read directly from the \fBca\fR section:
380 With the exception of \fB\s-1RANDFILE\s0\fR, this is probably a bug and may
381 change in future releases.
383 Many of the configuration file options are identical to command line
384 options. Where the option is present in the configuration file
385 and the command line the command line value is used. Where an
386 option is described as mandatory then it must be present in
387 the configuration file or the command line equivalent (if
389 .IP "\fBoid_file\fR" 4
391 This specifies a file containing additional \fB\s-1OBJECT\s0 \s-1IDENTIFIERS\s0\fR.
392 Each line of the file should consist of the numerical form of the
393 object identifier followed by white space then the short name followed
394 by white space and finally the long name.
395 .IP "\fBoid_section\fR" 4
396 .IX Item "oid_section"
397 This specifies a section in the configuration file containing extra
398 object identifiers. Each line should consist of the short name of the
399 object identifier followed by \fB=\fR and the numerical form. The short
400 and long names are the same when this option is used.
401 .IP "\fBnew_certs_dir\fR" 4
402 .IX Item "new_certs_dir"
403 the same as the \fB\-outdir\fR command line option. It specifies
404 the directory where new certificates will be placed. Mandatory.
405 .IP "\fBcertificate\fR" 4
406 .IX Item "certificate"
407 the same as \fB\-cert\fR. It gives the file containing the \s-1CA\s0
408 certificate. Mandatory.
409 .IP "\fBprivate_key\fR" 4
410 .IX Item "private_key"
411 same as the \fB\-keyfile\fR option. The file containing the
412 \&\s-1CA\s0 private key. Mandatory.
413 .IP "\fB\s-1RANDFILE\s0\fR" 4
415 a file used to read and write random number seed information, or
416 an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
417 .IP "\fBdefault_days\fR" 4
418 .IX Item "default_days"
419 the same as the \fB\-days\fR option. The number of days to certify
421 .IP "\fBdefault_startdate\fR" 4
422 .IX Item "default_startdate"
423 the same as the \fB\-startdate\fR option. The start date to certify
424 a certificate for. If not set the current time is used.
425 .IP "\fBdefault_enddate\fR" 4
426 .IX Item "default_enddate"
427 the same as the \fB\-enddate\fR option. Either this option or
428 \&\fBdefault_days\fR (or the command line equivalents) must be
430 .IP "\fBdefault_crl_hours default_crl_days\fR" 4
431 .IX Item "default_crl_hours default_crl_days"
432 the same as the \fB\-crlhours\fR and the \fB\-crldays\fR options. These
433 will only be used if neither command line option is present. At
434 least one of these must be present to generate a \s-1CRL\s0.
435 .IP "\fBdefault_md\fR" 4
436 .IX Item "default_md"
437 the same as the \fB\-md\fR option. The message digest to use. Mandatory.
438 .IP "\fBdatabase\fR" 4
440 the text database file to use. Mandatory. This file must be present
441 though initially it will be empty.
442 .IP "\fBunique_subject\fR" 4
443 .IX Item "unique_subject"
444 if the value \fByes\fR is given, the valid certificate entries in the
445 database must have unique subjects. if the value \fBno\fR is given,
446 several valid certificate entries may have the exact same subject.
447 The default value is \fByes\fR, to be compatible with older (pre 0.9.8)
448 versions of OpenSSL. However, to make \s-1CA\s0 certificate roll-over easier,
449 it's recommended to use the value \fBno\fR, especially if combined with
450 the \fB\-selfsign\fR command line option.
453 a text file containing the next serial number to use in hex. Mandatory.
454 This file must be present and contain a valid serial number.
455 .IP "\fBcrlnumber\fR" 4
457 a text file containing the next \s-1CRL\s0 number to use in hex. The crl number
458 will be inserted in the CRLs only if this file exists. If this file is
459 present, it must contain a valid \s-1CRL\s0 number.
460 .IP "\fBx509_extensions\fR" 4
461 .IX Item "x509_extensions"
462 the same as \fB\-extensions\fR.
463 .IP "\fBcrl_extensions\fR" 4
464 .IX Item "crl_extensions"
465 the same as \fB\-crlexts\fR.
466 .IP "\fBpreserve\fR" 4
468 the same as \fB\-preserveDN\fR
469 .IP "\fBemail_in_dn\fR" 4
470 .IX Item "email_in_dn"
471 the same as \fB\-noemailDN\fR. If you want the \s-1EMAIL\s0 field to be removed
472 from the \s-1DN\s0 of the certificate simply set this to 'no'. If not present
473 the default is to allow for the \s-1EMAIL\s0 filed in the certificate's \s-1DN\s0.
474 .IP "\fBmsie_hack\fR" 4
476 the same as \fB\-msie_hack\fR
479 the same as \fB\-policy\fR. Mandatory. See the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
480 for more information.
481 .IP "\fBname_opt\fR, \fBcert_opt\fR" 4
482 .IX Item "name_opt, cert_opt"
483 these options allow the format used to display the certificate details
484 when asking the user to confirm signing. All the options supported by
485 the \fBx509\fR utilities \fB\-nameopt\fR and \fB\-certopt\fR switches can be used
486 here, except the \fBno_signame\fR and \fBno_sigdump\fR are permanently set
487 and cannot be disabled (this is because the certificate signature cannot
488 be displayed because the certificate has not been signed at this point).
490 For convenience the values \fBca_default\fR are accepted by both to produce
493 If neither option is present the format used in earlier versions of
494 OpenSSL is used. Use of the old format is \fBstrongly\fR discouraged because
495 it only displays fields mentioned in the \fBpolicy\fR section, mishandles
496 multicharacter string types and does not display extensions.
497 .IP "\fBcopy_extensions\fR" 4
498 .IX Item "copy_extensions"
499 determines how extensions in certificate requests should be handled.
500 If set to \fBnone\fR or this option is not present then extensions are
501 ignored and not copied to the certificate. If set to \fBcopy\fR then any
502 extensions present in the request that are not already present are copied
503 to the certificate. If set to \fBcopyall\fR then all extensions in the
504 request are copied to the certificate: if the extension is already present
505 in the certificate it is deleted first. See the \fB\s-1WARNINGS\s0\fR section before
508 The main use of this option is to allow a certificate request to supply
509 values for certain extensions such as subjectAltName.
511 .IX Header "POLICY FORMAT"
512 The policy section consists of a set of variables corresponding to
513 certificate \s-1DN\s0 fields. If the value is \*(L"match\*(R" then the field value
514 must match the same field in the \s-1CA\s0 certificate. If the value is
515 \&\*(L"supplied\*(R" then it must be present. If the value is \*(L"optional\*(R" then
516 it may be present. Any fields not mentioned in the policy section
517 are silently deleted, unless the \fB\-preserveDN\fR option is set but
518 this can be regarded more of a quirk than intended behaviour.
520 .IX Header "SPKAC FORMAT"
521 The input to the \fB\-spkac\fR command line option is a Netscape
522 signed public key and challenge. This will usually come from
523 the \fB\s-1KEYGEN\s0\fR tag in an \s-1HTML\s0 form to create a new private key.
524 It is however possible to create SPKACs using the \fBspkac\fR utility.
526 The file should contain the variable \s-1SPKAC\s0 set to the value of
527 the \s-1SPKAC\s0 and also the required \s-1DN\s0 components as name value pairs.
528 If you need to include the same component twice then it can be
529 preceded by a number and a '.'.
531 .IX Header "EXAMPLES"
532 Note: these examples assume that the \fBca\fR directory structure is
533 already set up and the relevant files already exist. This usually
534 involves creating a \s-1CA\s0 certificate and private key with \fBreq\fR, a
535 serial number file and an empty index file and placing them in
536 the relevant directories.
538 To use the sample configuration file below the directories demoCA,
539 demoCA/private and demoCA/newcerts would be created. The \s-1CA\s0
540 certificate would be copied to demoCA/cacert.pem and its private
541 key to demoCA/private/cakey.pem. A file demoCA/serial would be
542 created containing for example \*(L"01\*(R" and the empty index file
545 Sign a certificate request:
548 \& openssl ca -in req.pem -out newcert.pem
551 Sign a certificate request, using \s-1CA\s0 extensions:
554 \& openssl ca -in req.pem -extensions v3_ca -out newcert.pem
557 Generate a \s-1CRL\s0
560 \& openssl ca -gencrl -out crl.pem
563 Sign several requests:
566 \& openssl ca -infiles req1.pem req2.pem req3.pem
569 Certify a Netscape \s-1SPKAC:\s0
572 \& openssl ca -spkac spkac.txt
575 A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity):
578 \& SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
580 \& emailAddress=steve@openssl.org
581 \& 0.OU=OpenSSL Group
582 \& 1.OU=Another Group
585 A sample configuration file with the relevant sections for \fBca\fR:
589 \& default_ca = CA_default # The default ca section
597 \& dir = ./demoCA # top dir
598 \& database = $dir/index.txt # index file.
599 \& new_certs_dir = $dir/newcerts # new certs dir
603 \& certificate = $dir/cacert.pem # The CA cert
604 \& serial = $dir/serial # serial no file
605 \& private_key = $dir/private/cakey.pem# CA private key
606 \& RANDFILE = $dir/private/.rand # random number file
610 \& default_days = 365 # how long to certify for
611 \& default_crl_days= 30 # how long before next CRL
612 \& default_md = md5 # md to use
616 \& policy = policy_any # default policy
617 \& email_in_dn = no # Don't add the email into cert DN
621 \& name_opt = ca_default # Subject name display option
622 \& cert_opt = ca_default # Certificate display option
623 \& copy_extensions = none # Don't copy extensions from request
628 \& countryName = supplied
629 \& stateOrProvinceName = optional
630 \& organizationName = optional
631 \& organizationalUnitName = optional
632 \& commonName = supplied
633 \& emailAddress = optional
637 Note: the location of all files can change either by compile time options,
638 configuration file entries, environment variables or command line options.
639 The values below reflect the default values.
642 \& /usr/local/ssl/lib/openssl.cnf - master configuration file
643 \& ./demoCA - main CA directory
644 \& ./demoCA/cacert.pem - CA certificate
645 \& ./demoCA/private/cakey.pem - CA private key
646 \& ./demoCA/serial - CA serial number file
647 \& ./demoCA/serial.old - CA serial number backup file
648 \& ./demoCA/index.txt - CA text database file
649 \& ./demoCA/index.txt.old - CA text database backup file
650 \& ./demoCA/certs - certificate output file
651 \& ./demoCA/.rnd - CA random seed information
653 .SH "ENVIRONMENT VARIABLES"
654 .IX Header "ENVIRONMENT VARIABLES"
655 \&\fB\s-1OPENSSL_CONF\s0\fR reflects the location of master configuration file it can
656 be overridden by the \fB\-config\fR command line option.
658 .IX Header "RESTRICTIONS"
659 The text database index file is a critical part of the process and
660 if corrupted it can be difficult to fix. It is theoretically possible
661 to rebuild the index file from all the issued certificates and a current
662 \&\s-1CRL:\s0 however there is no option to do this.
664 V2 \s-1CRL\s0 features like delta CRLs are not currently supported.
666 Although several requests can be input and handled at once it is only
667 possible to include one \s-1SPKAC\s0 or self signed certificate.
670 The use of an in memory text database can cause problems when large
671 numbers of certificates are present because, as the name implies
672 the database has to be kept in memory.
674 The \fBca\fR command really needs rewriting or the required functionality
675 exposed at either a command or interface level so a more friendly utility
676 (perl script or \s-1GUI\s0) can handle things properly. The scripts \fB\s-1CA\s0.sh\fR and
677 \&\fB\s-1CA\s0.pl\fR help a little but not very much.
679 Any fields in a request that are not present in a policy are silently
680 deleted. This does not happen if the \fB\-preserveDN\fR option is used. To
681 enforce the absence of the \s-1EMAIL\s0 field within the \s-1DN\s0, as suggested by
682 RFCs, regardless the contents of the request' subject the \fB\-noemailDN\fR
683 option can be used. The behaviour should be more friendly and
686 Cancelling some commands by refusing to certify a certificate can
687 create an empty file.
689 .IX Header "WARNINGS"
690 The \fBca\fR command is quirky and at times downright unfriendly.
692 The \fBca\fR utility was originally meant as an example of how to do things
693 in a \s-1CA\s0. It was not supposed to be used as a full blown \s-1CA\s0 itself:
694 nevertheless some people are using it for this purpose.
696 The \fBca\fR command is effectively a single user command: no locking is
697 done on the various files and attempts to run more than one \fBca\fR command
698 on the same database can have unpredictable results.
700 The \fBcopy_extensions\fR option should be used with caution. If care is
701 not taken then it can be a security risk. For example if a certificate
702 request contains a basicConstraints extension with \s-1CA:TRUE\s0 and the
703 \&\fBcopy_extensions\fR value is set to \fBcopyall\fR and the user does not spot
704 this when the certificate is displayed then this will hand the requestor
705 a valid \s-1CA\s0 certificate.
707 This situation can be avoided by setting \fBcopy_extensions\fR to \fBcopy\fR
708 and including basicConstraints with \s-1CA:FALSE\s0 in the configuration file.
709 Then if the request contains a basicConstraints extension it will be
712 It is advisable to also include values for other extensions such
713 as \fBkeyUsage\fR to prevent a request supplying its own values.
715 Additional restrictions can be placed on the \s-1CA\s0 certificate itself.
716 For example if the \s-1CA\s0 certificate has:
719 \& basicConstraints = CA:TRUE, pathlen:0
722 then even if a certificate is issued with \s-1CA:TRUE\s0 it will not be valid.
724 .IX Header "SEE ALSO"
725 \&\fIreq\fR\|(1), \fIspkac\fR\|(1), \fIx509\fR\|(1), \s-1\fICA\s0.pl\fR\|(1),
projects / dragonfly.git / blob