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