1 .\" Automatically generated by Pod::Man 2.25 (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
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
53 . tm Index:\\$1\t\\n%\t"\\$2"
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
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
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'
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 \
124 .\" ========================================================================
127 .TH CA 1 "2014-10-15" "0.9.8zc" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 ca \- sample minimal CA application
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBca\fR
138 [\fB\-config filename\fR]
139 [\fB\-name section\fR]
141 [\fB\-revoke file\fR]
142 [\fB\-status serial\fR]
144 [\fB\-crl_reason reason\fR]
145 [\fB\-crl_hold instruction\fR]
146 [\fB\-crl_compromise time\fR]
147 [\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]
157 [\fB\-keyform PEM|DER\fR]
168 [\fB\-ss_cert file\fR]
173 [\fB\-extensions section\fR]
174 [\fB\-extfile section\fR]
178 [\fB\-multivalue\-rdn\fR]
180 .IX Header "DESCRIPTION"
181 The \fBca\fR command is a minimal \s-1CA\s0 application. It can be used
182 to sign certificate requests in a variety of forms and generate
183 CRLs it also maintains a text database of issued certificates
186 The options descriptions will be divided into each purpose.
188 .IX Header "CA OPTIONS"
189 .IP "\fB\-config filename\fR" 4
190 .IX Item "-config filename"
191 specifies the configuration file to use.
192 .IP "\fB\-name section\fR" 4
193 .IX Item "-name section"
194 specifies the configuration file section to use (overrides
195 \&\fBdefault_ca\fR in the \fBca\fR section).
196 .IP "\fB\-in filename\fR" 4
197 .IX Item "-in filename"
198 an input filename containing a single certificate request to be
199 signed by the \s-1CA\s0.
200 .IP "\fB\-ss_cert filename\fR" 4
201 .IX Item "-ss_cert filename"
202 a single self signed certificate to be signed by the \s-1CA\s0.
203 .IP "\fB\-spkac filename\fR" 4
204 .IX Item "-spkac filename"
205 a file containing a single Netscape signed public key and challenge
206 and additional field values to be signed by the \s-1CA\s0. See the \fB\s-1SPKAC\s0 \s-1FORMAT\s0\fR
207 section for information on the required input and output format.
208 .IP "\fB\-infiles\fR" 4
210 if present this should be the last option, all subsequent arguments
211 are assumed to be the names of files containing certificate requests.
212 .IP "\fB\-out filename\fR" 4
213 .IX Item "-out filename"
214 the output file to output certificates to. The default is standard
215 output. The certificate details will also be printed out to this
216 file in \s-1PEM\s0 format (except that \fB\-spkac\fR outputs \s-1DER\s0 format).
217 .IP "\fB\-outdir directory\fR" 4
218 .IX Item "-outdir directory"
219 the directory to output certificates to. The certificate will be
220 written to a filename consisting of the serial number in hex with
221 \&\*(L".pem\*(R" appended.
224 the \s-1CA\s0 certificate file.
225 .IP "\fB\-keyfile filename\fR" 4
226 .IX Item "-keyfile filename"
227 the private key to sign requests with.
228 .IP "\fB\-keyform PEM|DER\fR" 4
229 .IX Item "-keyform PEM|DER"
230 the format of the data in the private key file.
231 The default is \s-1PEM\s0.
232 .IP "\fB\-key password\fR" 4
233 .IX Item "-key password"
234 the password used to encrypt the private key. Since on some
235 systems the command line arguments are visible (e.g. Unix with
236 the 'ps' utility) this option should be used with caution.
237 .IP "\fB\-selfsign\fR" 4
239 indicates the issued certificates are to be signed with the key
240 the certificate requests were signed with (given with \fB\-keyfile\fR).
241 Cerificate requests signed with a different key are ignored. If
242 \&\fB\-spkac\fR, \fB\-ss_cert\fR or \fB\-gencrl\fR are given, \fB\-selfsign\fR is
245 A consequence of using \fB\-selfsign\fR is that the self-signed
246 certificate appears among the entries in the certificate database
247 (see the configuration option \fBdatabase\fR), and uses the same
248 serial number counter as all other certificates sign with the
249 self-signed certificate.
250 .IP "\fB\-passin arg\fR" 4
251 .IX Item "-passin arg"
252 the key password source. For more information about the format of \fBarg\fR
253 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
254 .IP "\fB\-verbose\fR" 4
256 this prints extra details about the operations being performed.
257 .IP "\fB\-notext\fR" 4
259 don't output the text form of a certificate to the output file.
260 .IP "\fB\-startdate date\fR" 4
261 .IX Item "-startdate date"
262 this allows the start date to be explicitly set. The format of the
263 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
264 .IP "\fB\-enddate date\fR" 4
265 .IX Item "-enddate date"
266 this allows the expiry date to be explicitly set. The format of the
267 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure).
268 .IP "\fB\-days arg\fR" 4
270 the number of days to certify the certificate for.
271 .IP "\fB\-md alg\fR" 4
273 the message digest to use. Possible values include md5, sha1 and mdc2.
274 This option also applies to CRLs.
275 .IP "\fB\-policy arg\fR" 4
276 .IX Item "-policy arg"
277 this option defines the \s-1CA\s0 \*(L"policy\*(R" to use. This is a section in
278 the configuration file which decides which fields should be mandatory
279 or match the \s-1CA\s0 certificate. Check out the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
280 for more information.
281 .IP "\fB\-msie_hack\fR" 4
282 .IX Item "-msie_hack"
283 this is a legacy option to make \fBca\fR work with very old versions of
284 the \s-1IE\s0 certificate enrollment control \*(L"certenr3\*(R". It used UniversalStrings
285 for almost everything. Since the old control has various security bugs
286 its use is strongly discouraged. The newer control \*(L"Xenroll\*(R" does not
288 .IP "\fB\-preserveDN\fR" 4
289 .IX Item "-preserveDN"
290 Normally the \s-1DN\s0 order of a certificate is the same as the order of the
291 fields in the relevant policy section. When this option is set the order
292 is the same as the request. This is largely for compatibility with the
293 older \s-1IE\s0 enrollment control which would only accept certificates if their
294 DNs match the order of the request. This is not needed for Xenroll.
295 .IP "\fB\-noemailDN\fR" 4
296 .IX Item "-noemailDN"
297 The \s-1DN\s0 of a certificate can contain the \s-1EMAIL\s0 field if present in the
298 request \s-1DN\s0, however it is good policy just having the e\-mail set into
299 the altName extension of the certificate. When this option is set the
300 \&\s-1EMAIL\s0 field is removed from the certificate' subject and set only in
301 the, eventually present, extensions. The \fBemail_in_dn\fR keyword can be
302 used in the configuration file to enable this behaviour.
303 .IP "\fB\-batch\fR" 4
305 this sets the batch mode. In this mode no questions will be asked
306 and all certificates will be certified automatically.
307 .IP "\fB\-extensions section\fR" 4
308 .IX Item "-extensions section"
309 the section of the configuration file containing certificate extensions
310 to be added when a certificate is issued (defaults to \fBx509_extensions\fR
311 unless the \fB\-extfile\fR option is used). If no extension section is
312 present then, a V1 certificate is created. If the extension section
313 is present (even if it is empty), then a V3 certificate is created.
314 .IP "\fB\-extfile file\fR" 4
315 .IX Item "-extfile file"
316 an additional configuration file to read certificate extensions from
317 (using the default section unless the \fB\-extensions\fR option is also
319 .IP "\fB\-engine id\fR" 4
320 .IX Item "-engine id"
321 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
322 to attempt to obtain a functional reference to the specified engine,
323 thus initialising it if needed. The engine will then be set as the default
324 for all available algorithms.
325 .IP "\fB\-subj arg\fR" 4
327 supersedes subject name given in the request.
328 The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR,
329 characters may be escaped by \e (backslash), no spaces are skipped.
332 this option causes field values to be interpreted as \s-1UTF8\s0 strings, by
333 default they are interpreted as \s-1ASCII\s0. This means that the field
334 values, whether prompted from a terminal or obtained from a
335 configuration file, must be valid \s-1UTF8\s0 strings.
336 .IP "\fB\-multivalue\-rdn\fR" 4
337 .IX Item "-multivalue-rdn"
338 this option causes the \-subj argument to be interpretedt with full
339 support for multivalued RDNs. Example:
341 \&\fI/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\fR
343 If \-multi\-rdn is not used then the \s-1UID\s0 value is \fI123456+CN=John Doe\fR.
345 .IX Header "CRL OPTIONS"
346 .IP "\fB\-gencrl\fR" 4
348 this option generates a \s-1CRL\s0 based on information in the index file.
349 .IP "\fB\-crldays num\fR" 4
350 .IX Item "-crldays num"
351 the number of days before the next \s-1CRL\s0 is due. That is the days from
352 now to place in the \s-1CRL\s0 nextUpdate field.
353 .IP "\fB\-crlhours num\fR" 4
354 .IX Item "-crlhours num"
355 the number of hours before the next \s-1CRL\s0 is due.
356 .IP "\fB\-revoke filename\fR" 4
357 .IX Item "-revoke filename"
358 a filename containing a certificate to revoke.
359 .IP "\fB\-status serial\fR" 4
360 .IX Item "-status serial"
361 displays the revocation status of the certificate with the specified
362 serial number and exits.
363 .IP "\fB\-updatedb\fR" 4
365 Updates the database index to purge expired certificates.
366 .IP "\fB\-crl_reason reason\fR" 4
367 .IX Item "-crl_reason reason"
368 revocation reason, where \fBreason\fR is one of: \fBunspecified\fR, \fBkeyCompromise\fR,
369 \&\fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR, \fBcessationOfOperation\fR,
370 \&\fBcertificateHold\fR or \fBremoveFromCRL\fR. The matching of \fBreason\fR is case
371 insensitive. Setting any revocation reason will make the \s-1CRL\s0 v2.
373 In practive \fBremoveFromCRL\fR is not particularly useful because it is only used
374 in delta CRLs which are not currently implemented.
375 .IP "\fB\-crl_hold instruction\fR" 4
376 .IX Item "-crl_hold instruction"
377 This sets the \s-1CRL\s0 revocation reason code to \fBcertificateHold\fR and the hold
378 instruction to \fBinstruction\fR which must be an \s-1OID\s0. Although any \s-1OID\s0 can be
379 used only \fBholdInstructionNone\fR (the use of which is discouraged by \s-1RFC2459\s0)
380 \&\fBholdInstructionCallIssuer\fR or \fBholdInstructionReject\fR will normally be used.
381 .IP "\fB\-crl_compromise time\fR" 4
382 .IX Item "-crl_compromise time"
383 This sets the revocation reason to \fBkeyCompromise\fR and the compromise time to
384 \&\fBtime\fR. \fBtime\fR should be in GeneralizedTime format that is \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
385 .IP "\fB\-crl_CA_compromise time\fR" 4
386 .IX Item "-crl_CA_compromise time"
387 This is the same as \fBcrl_compromise\fR except the revocation reason is set to
388 \&\fBCACompromise\fR.
389 .IP "\fB\-crlexts section\fR" 4
390 .IX Item "-crlexts section"
391 the section of the configuration file containing \s-1CRL\s0 extensions to
392 include. If no \s-1CRL\s0 extension section is present then a V1 \s-1CRL\s0 is
393 created, if the \s-1CRL\s0 extension section is present (even if it is
394 empty) then a V2 \s-1CRL\s0 is created. The \s-1CRL\s0 extensions specified are
395 \&\s-1CRL\s0 extensions and \fBnot\fR \s-1CRL\s0 entry extensions. It should be noted
396 that some software (for example Netscape) can't handle V2 CRLs.
397 .SH "CONFIGURATION FILE OPTIONS"
398 .IX Header "CONFIGURATION FILE OPTIONS"
399 The section of the configuration file containing options for \fBca\fR
400 is found as follows: If the \fB\-name\fR command line option is used,
401 then it names the section to be used. Otherwise the section to
402 be used must be named in the \fBdefault_ca\fR option of the \fBca\fR section
403 of the configuration file (or in the default section of the
404 configuration file). Besides \fBdefault_ca\fR, the following options are
405 read directly from the \fBca\fR section:
409 With the exception of \fB\s-1RANDFILE\s0\fR, this is probably a bug and may
410 change in future releases.
412 Many of the configuration file options are identical to command line
413 options. Where the option is present in the configuration file
414 and the command line the command line value is used. Where an
415 option is described as mandatory then it must be present in
416 the configuration file or the command line equivalent (if
418 .IP "\fBoid_file\fR" 4
420 This specifies a file containing additional \fB\s-1OBJECT\s0 \s-1IDENTIFIERS\s0\fR.
421 Each line of the file should consist of the numerical form of the
422 object identifier followed by white space then the short name followed
423 by white space and finally the long name.
424 .IP "\fBoid_section\fR" 4
425 .IX Item "oid_section"
426 This specifies a section in the configuration file containing extra
427 object identifiers. Each line should consist of the short name of the
428 object identifier followed by \fB=\fR and the numerical form. The short
429 and long names are the same when this option is used.
430 .IP "\fBnew_certs_dir\fR" 4
431 .IX Item "new_certs_dir"
432 the same as the \fB\-outdir\fR command line option. It specifies
433 the directory where new certificates will be placed. Mandatory.
434 .IP "\fBcertificate\fR" 4
435 .IX Item "certificate"
436 the same as \fB\-cert\fR. It gives the file containing the \s-1CA\s0
437 certificate. Mandatory.
438 .IP "\fBprivate_key\fR" 4
439 .IX Item "private_key"
440 same as the \fB\-keyfile\fR option. The file containing the
441 \&\s-1CA\s0 private key. Mandatory.
442 .IP "\fB\s-1RANDFILE\s0\fR" 4
444 a file used to read and write random number seed information, or
445 an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
446 .IP "\fBdefault_days\fR" 4
447 .IX Item "default_days"
448 the same as the \fB\-days\fR option. The number of days to certify
450 .IP "\fBdefault_startdate\fR" 4
451 .IX Item "default_startdate"
452 the same as the \fB\-startdate\fR option. The start date to certify
453 a certificate for. If not set the current time is used.
454 .IP "\fBdefault_enddate\fR" 4
455 .IX Item "default_enddate"
456 the same as the \fB\-enddate\fR option. Either this option or
457 \&\fBdefault_days\fR (or the command line equivalents) must be
459 .IP "\fBdefault_crl_hours default_crl_days\fR" 4
460 .IX Item "default_crl_hours default_crl_days"
461 the same as the \fB\-crlhours\fR and the \fB\-crldays\fR options. These
462 will only be used if neither command line option is present. At
463 least one of these must be present to generate a \s-1CRL\s0.
464 .IP "\fBdefault_md\fR" 4
465 .IX Item "default_md"
466 the same as the \fB\-md\fR option. The message digest to use. Mandatory.
467 .IP "\fBdatabase\fR" 4
469 the text database file to use. Mandatory. This file must be present
470 though initially it will be empty.
471 .IP "\fBunique_subject\fR" 4
472 .IX Item "unique_subject"
473 if the value \fByes\fR is given, the valid certificate entries in the
474 database must have unique subjects. if the value \fBno\fR is given,
475 several valid certificate entries may have the exact same subject.
476 The default value is \fByes\fR, to be compatible with older (pre 0.9.8)
477 versions of OpenSSL. However, to make \s-1CA\s0 certificate roll-over easier,
478 it's recommended to use the value \fBno\fR, especially if combined with
479 the \fB\-selfsign\fR command line option.
482 a text file containing the next serial number to use in hex. Mandatory.
483 This file must be present and contain a valid serial number.
484 .IP "\fBcrlnumber\fR" 4
486 a text file containing the next \s-1CRL\s0 number to use in hex. The crl number
487 will be inserted in the CRLs only if this file exists. If this file is
488 present, it must contain a valid \s-1CRL\s0 number.
489 .IP "\fBx509_extensions\fR" 4
490 .IX Item "x509_extensions"
491 the same as \fB\-extensions\fR.
492 .IP "\fBcrl_extensions\fR" 4
493 .IX Item "crl_extensions"
494 the same as \fB\-crlexts\fR.
495 .IP "\fBpreserve\fR" 4
497 the same as \fB\-preserveDN\fR
498 .IP "\fBemail_in_dn\fR" 4
499 .IX Item "email_in_dn"
500 the same as \fB\-noemailDN\fR. If you want the \s-1EMAIL\s0 field to be removed
501 from the \s-1DN\s0 of the certificate simply set this to 'no'. If not present
502 the default is to allow for the \s-1EMAIL\s0 filed in the certificate's \s-1DN\s0.
503 .IP "\fBmsie_hack\fR" 4
505 the same as \fB\-msie_hack\fR
508 the same as \fB\-policy\fR. Mandatory. See the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section
509 for more information.
510 .IP "\fBname_opt\fR, \fBcert_opt\fR" 4
511 .IX Item "name_opt, cert_opt"
512 these options allow the format used to display the certificate details
513 when asking the user to confirm signing. All the options supported by
514 the \fBx509\fR utilities \fB\-nameopt\fR and \fB\-certopt\fR switches can be used
515 here, except the \fBno_signame\fR and \fBno_sigdump\fR are permanently set
516 and cannot be disabled (this is because the certificate signature cannot
517 be displayed because the certificate has not been signed at this point).
519 For convenience the values \fBca_default\fR are accepted by both to produce
522 If neither option is present the format used in earlier versions of
523 OpenSSL is used. Use of the old format is \fBstrongly\fR discouraged because
524 it only displays fields mentioned in the \fBpolicy\fR section, mishandles
525 multicharacter string types and does not display extensions.
526 .IP "\fBcopy_extensions\fR" 4
527 .IX Item "copy_extensions"
528 determines how extensions in certificate requests should be handled.
529 If set to \fBnone\fR or this option is not present then extensions are
530 ignored and not copied to the certificate. If set to \fBcopy\fR then any
531 extensions present in the request that are not already present are copied
532 to the certificate. If set to \fBcopyall\fR then all extensions in the
533 request are copied to the certificate: if the extension is already present
534 in the certificate it is deleted first. See the \fB\s-1WARNINGS\s0\fR section before
537 The main use of this option is to allow a certificate request to supply
538 values for certain extensions such as subjectAltName.
540 .IX Header "POLICY FORMAT"
541 The policy section consists of a set of variables corresponding to
542 certificate \s-1DN\s0 fields. If the value is \*(L"match\*(R" then the field value
543 must match the same field in the \s-1CA\s0 certificate. If the value is
544 \&\*(L"supplied\*(R" then it must be present. If the value is \*(L"optional\*(R" then
545 it may be present. Any fields not mentioned in the policy section
546 are silently deleted, unless the \fB\-preserveDN\fR option is set but
547 this can be regarded more of a quirk than intended behaviour.
549 .IX Header "SPKAC FORMAT"
550 The input to the \fB\-spkac\fR command line option is a Netscape
551 signed public key and challenge. This will usually come from
552 the \fB\s-1KEYGEN\s0\fR tag in an \s-1HTML\s0 form to create a new private key.
553 It is however possible to create SPKACs using the \fBspkac\fR utility.
555 The file should contain the variable \s-1SPKAC\s0 set to the value of
556 the \s-1SPKAC\s0 and also the required \s-1DN\s0 components as name value pairs.
557 If you need to include the same component twice then it can be
558 preceded by a number and a '.'.
560 When processing \s-1SPKAC\s0 format, the output is \s-1DER\s0 if the \fB\-out\fR
561 flag is used, but \s-1PEM\s0 format if sending to stdout or the \fB\-outdir\fR
564 .IX Header "EXAMPLES"
565 Note: these examples assume that the \fBca\fR directory structure is
566 already set up and the relevant files already exist. This usually
567 involves creating a \s-1CA\s0 certificate and private key with \fBreq\fR, a
568 serial number file and an empty index file and placing them in
569 the relevant directories.
571 To use the sample configuration file below the directories demoCA,
572 demoCA/private and demoCA/newcerts would be created. The \s-1CA\s0
573 certificate would be copied to demoCA/cacert.pem and its private
574 key to demoCA/private/cakey.pem. A file demoCA/serial would be
575 created containing for example \*(L"01\*(R" and the empty index file
578 Sign a certificate request:
581 \& openssl ca \-in req.pem \-out newcert.pem
584 Sign a certificate request, using \s-1CA\s0 extensions:
587 \& openssl ca \-in req.pem \-extensions v3_ca \-out newcert.pem
590 Generate a \s-1CRL\s0
593 \& openssl ca \-gencrl \-out crl.pem
596 Sign several requests:
599 \& openssl ca \-infiles req1.pem req2.pem req3.pem
602 Certify a Netscape \s-1SPKAC:\s0
605 \& openssl ca \-spkac spkac.txt
608 A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity):
611 \& SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
613 \& emailAddress=steve@openssl.org
614 \& 0.OU=OpenSSL Group
615 \& 1.OU=Another Group
618 A sample configuration file with the relevant sections for \fBca\fR:
622 \& default_ca = CA_default # The default ca section
626 \& dir = ./demoCA # top dir
627 \& database = $dir/index.txt # index file.
628 \& new_certs_dir = $dir/newcerts # new certs dir
630 \& certificate = $dir/cacert.pem # The CA cert
631 \& serial = $dir/serial # serial no file
632 \& private_key = $dir/private/cakey.pem# CA private key
633 \& RANDFILE = $dir/private/.rand # random number file
635 \& default_days = 365 # how long to certify for
636 \& default_crl_days= 30 # how long before next CRL
637 \& default_md = md5 # md to use
639 \& policy = policy_any # default policy
640 \& email_in_dn = no # Don\*(Aqt add the email into cert DN
642 \& name_opt = ca_default # Subject name display option
643 \& cert_opt = ca_default # Certificate display option
644 \& copy_extensions = none # Don\*(Aqt copy extensions from request
647 \& countryName = supplied
648 \& stateOrProvinceName = optional
649 \& organizationName = optional
650 \& organizationalUnitName = optional
651 \& commonName = supplied
652 \& emailAddress = optional
656 Note: the location of all files can change either by compile time options,
657 configuration file entries, environment variables or command line options.
658 The values below reflect the default values.
661 \& /usr/local/ssl/lib/openssl.cnf \- master configuration file
662 \& ./demoCA \- main CA directory
663 \& ./demoCA/cacert.pem \- CA certificate
664 \& ./demoCA/private/cakey.pem \- CA private key
665 \& ./demoCA/serial \- CA serial number file
666 \& ./demoCA/serial.old \- CA serial number backup file
667 \& ./demoCA/index.txt \- CA text database file
668 \& ./demoCA/index.txt.old \- CA text database backup file
669 \& ./demoCA/certs \- certificate output file
670 \& ./demoCA/.rnd \- CA random seed information
672 .SH "ENVIRONMENT VARIABLES"
673 .IX Header "ENVIRONMENT VARIABLES"
674 \&\fB\s-1OPENSSL_CONF\s0\fR reflects the location of master configuration file it can
675 be overridden by the \fB\-config\fR command line option.
677 .IX Header "RESTRICTIONS"
678 The text database index file is a critical part of the process and
679 if corrupted it can be difficult to fix. It is theoretically possible
680 to rebuild the index file from all the issued certificates and a current
681 \&\s-1CRL:\s0 however there is no option to do this.
683 V2 \s-1CRL\s0 features like delta CRLs are not currently supported.
685 Although several requests can be input and handled at once it is only
686 possible to include one \s-1SPKAC\s0 or self signed certificate.
689 The use of an in memory text database can cause problems when large
690 numbers of certificates are present because, as the name implies
691 the database has to be kept in memory.
693 The \fBca\fR command really needs rewriting or the required functionality
694 exposed at either a command or interface level so a more friendly utility
695 (perl script or \s-1GUI\s0) can handle things properly. The scripts \fB\s-1CA\s0.sh\fR and
696 \&\fB\s-1CA\s0.pl\fR help a little but not very much.
698 Any fields in a request that are not present in a policy are silently
699 deleted. This does not happen if the \fB\-preserveDN\fR option is used. To
700 enforce the absence of the \s-1EMAIL\s0 field within the \s-1DN\s0, as suggested by
701 RFCs, regardless the contents of the request' subject the \fB\-noemailDN\fR
702 option can be used. The behaviour should be more friendly and
705 Cancelling some commands by refusing to certify a certificate can
706 create an empty file.
708 .IX Header "WARNINGS"
709 The \fBca\fR command is quirky and at times downright unfriendly.
711 The \fBca\fR utility was originally meant as an example of how to do things
712 in a \s-1CA\s0. It was not supposed to be used as a full blown \s-1CA\s0 itself:
713 nevertheless some people are using it for this purpose.
715 The \fBca\fR command is effectively a single user command: no locking is
716 done on the various files and attempts to run more than one \fBca\fR command
717 on the same database can have unpredictable results.
719 The \fBcopy_extensions\fR option should be used with caution. If care is
720 not taken then it can be a security risk. For example if a certificate
721 request contains a basicConstraints extension with \s-1CA:TRUE\s0 and the
722 \&\fBcopy_extensions\fR value is set to \fBcopyall\fR and the user does not spot
723 this when the certificate is displayed then this will hand the requestor
724 a valid \s-1CA\s0 certificate.
726 This situation can be avoided by setting \fBcopy_extensions\fR to \fBcopy\fR
727 and including basicConstraints with \s-1CA:FALSE\s0 in the configuration file.
728 Then if the request contains a basicConstraints extension it will be
731 It is advisable to also include values for other extensions such
732 as \fBkeyUsage\fR to prevent a request supplying its own values.
734 Additional restrictions can be placed on the \s-1CA\s0 certificate itself.
735 For example if the \s-1CA\s0 certificate has:
738 \& basicConstraints = CA:TRUE, pathlen:0
741 then even if a certificate is issued with \s-1CA:TRUE\s0 it will not be valid.
743 .IX Header "SEE ALSO"
744 \&\fIreq\fR\|(1), \fIspkac\fR\|(1), \fIx509\fR\|(1), \s-1\fICA\s0.pl\fR\|(1),
projects / FreeBSD / stable / 9.git / blob