1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
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 >0, 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 "2019-09-10" "1.1.1d" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 openssl\-ca, ca \- sample minimal CA application
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBca\fR
148 [\fB\-config filename\fR]
149 [\fB\-name section\fR]
151 [\fB\-revoke file\fR]
153 [\fB\-status serial\fR]
155 [\fB\-crl_reason reason\fR]
156 [\fB\-crl_hold instruction\fR]
157 [\fB\-crl_compromise time\fR]
158 [\fB\-crl_CA_compromise time\fR]
159 [\fB\-crldays days\fR]
160 [\fB\-crlhours hours\fR]
161 [\fB\-crlexts section\fR]
162 [\fB\-startdate date\fR]
163 [\fB\-enddate date\fR]
167 [\fB\-keyfile arg\fR]
168 [\fB\-keyform PEM|DER\fR]
179 [\fB\-ss_cert file\fR]
184 [\fB\-extensions section\fR]
185 [\fB\-extfile section\fR]
189 [\fB\-create_serial\fR]
190 [\fB\-rand_serial\fR]
191 [\fB\-multivalue\-rdn\fR]
192 [\fB\-rand file...\fR]
193 [\fB\-writerand file\fR]
195 .IX Header "DESCRIPTION"
196 The \fBca\fR command is a minimal \s-1CA\s0 application. It can be used
197 to sign certificate requests in a variety of forms and generate
198 CRLs it also maintains a text database of issued certificates
201 The options descriptions will be divided into each purpose.
206 Print out a usage message.
207 .IP "\fB\-verbose\fR" 4
209 This prints extra details about the operations being performed.
210 .IP "\fB\-config filename\fR" 4
211 .IX Item "-config filename"
212 Specifies the configuration file to use.
213 Optional; for a description of the default value,
214 see \*(L"\s-1COMMAND SUMMARY\*(R"\s0 in \fBopenssl\fR\|(1).
215 .IP "\fB\-name section\fR" 4
216 .IX Item "-name section"
217 Specifies the configuration file section to use (overrides
218 \&\fBdefault_ca\fR in the \fBca\fR section).
219 .IP "\fB\-in filename\fR" 4
220 .IX Item "-in filename"
221 An input filename containing a single certificate request to be
222 signed by the \s-1CA.\s0
223 .IP "\fB\-ss_cert filename\fR" 4
224 .IX Item "-ss_cert filename"
225 A single self-signed certificate to be signed by the \s-1CA.\s0
226 .IP "\fB\-spkac filename\fR" 4
227 .IX Item "-spkac filename"
228 A file containing a single Netscape signed public key and challenge
229 and additional field values to be signed by the \s-1CA.\s0 See the \fB\s-1SPKAC FORMAT\s0\fR
230 section for information on the required input and output format.
231 .IP "\fB\-infiles\fR" 4
233 If present this should be the last option, all subsequent arguments
234 are taken as the names of files containing certificate requests.
235 .IP "\fB\-out filename\fR" 4
236 .IX Item "-out filename"
237 The output file to output certificates to. The default is standard
238 output. The certificate details will also be printed out to this
239 file in \s-1PEM\s0 format (except that \fB\-spkac\fR outputs \s-1DER\s0 format).
240 .IP "\fB\-outdir directory\fR" 4
241 .IX Item "-outdir directory"
242 The directory to output certificates to. The certificate will be
243 written to a filename consisting of the serial number in hex with
244 \&\*(L".pem\*(R" appended.
247 The \s-1CA\s0 certificate file.
248 .IP "\fB\-keyfile filename\fR" 4
249 .IX Item "-keyfile filename"
250 The private key to sign requests with.
251 .IP "\fB\-keyform PEM|DER\fR" 4
252 .IX Item "-keyform PEM|DER"
253 The format of the data in the private key file.
254 The default is \s-1PEM.\s0
255 .IP "\fB\-key password\fR" 4
256 .IX Item "-key password"
257 The password used to encrypt the private key. Since on some
258 systems the command line arguments are visible (e.g. Unix with
259 the 'ps' utility) this option should be used with caution.
260 .IP "\fB\-selfsign\fR" 4
262 Indicates the issued certificates are to be signed with the key
263 the certificate requests were signed with (given with \fB\-keyfile\fR).
264 Certificate requests signed with a different key are ignored. If
265 \&\fB\-spkac\fR, \fB\-ss_cert\fR or \fB\-gencrl\fR are given, \fB\-selfsign\fR is
268 A consequence of using \fB\-selfsign\fR is that the self-signed
269 certificate appears among the entries in the certificate database
270 (see the configuration option \fBdatabase\fR), and uses the same
271 serial number counter as all other certificates sign with the
272 self-signed certificate.
273 .IP "\fB\-passin arg\fR" 4
274 .IX Item "-passin arg"
275 The key password source. For more information about the format of \fBarg\fR
276 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
277 .IP "\fB\-notext\fR" 4
279 Don't output the text form of a certificate to the output file.
280 .IP "\fB\-startdate date\fR" 4
281 .IX Item "-startdate date"
282 This allows the start date to be explicitly set. The format of the
283 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure), or
284 \&\s-1YYYYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 GeneralizedTime structure). In
285 both formats, seconds \s-1SS\s0 and timezone Z must be present.
286 .IP "\fB\-enddate date\fR" 4
287 .IX Item "-enddate date"
288 This allows the expiry date to be explicitly set. The format of the
289 date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure), or
290 \&\s-1YYYYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 GeneralizedTime structure). In
291 both formats, seconds \s-1SS\s0 and timezone Z must be present.
292 .IP "\fB\-days arg\fR" 4
294 The number of days to certify the certificate for.
295 .IP "\fB\-md alg\fR" 4
297 The message digest to use.
298 Any digest supported by the OpenSSL \fBdgst\fR command can be used. For signing
299 algorithms that do not support a digest (i.e. Ed25519 and Ed448) any message
300 digest that is set is ignored. This option also applies to CRLs.
301 .IP "\fB\-policy arg\fR" 4
302 .IX Item "-policy arg"
303 This option defines the \s-1CA\s0 \*(L"policy\*(R" to use. This is a section in
304 the configuration file which decides which fields should be mandatory
305 or match the \s-1CA\s0 certificate. Check out the \fB\s-1POLICY FORMAT\s0\fR section
306 for more information.
307 .IP "\fB\-msie_hack\fR" 4
308 .IX Item "-msie_hack"
309 This is a deprecated option to make \fBca\fR work with very old versions of
310 the \s-1IE\s0 certificate enrollment control \*(L"certenr3\*(R". It used UniversalStrings
311 for almost everything. Since the old control has various security bugs
312 its use is strongly discouraged.
313 .IP "\fB\-preserveDN\fR" 4
314 .IX Item "-preserveDN"
315 Normally the \s-1DN\s0 order of a certificate is the same as the order of the
316 fields in the relevant policy section. When this option is set the order
317 is the same as the request. This is largely for compatibility with the
318 older \s-1IE\s0 enrollment control which would only accept certificates if their
319 DNs match the order of the request. This is not needed for Xenroll.
320 .IP "\fB\-noemailDN\fR" 4
321 .IX Item "-noemailDN"
322 The \s-1DN\s0 of a certificate can contain the \s-1EMAIL\s0 field if present in the
323 request \s-1DN,\s0 however it is good policy just having the e\-mail set into
324 the altName extension of the certificate. When this option is set the
325 \&\s-1EMAIL\s0 field is removed from the certificate' subject and set only in
326 the, eventually present, extensions. The \fBemail_in_dn\fR keyword can be
327 used in the configuration file to enable this behaviour.
328 .IP "\fB\-batch\fR" 4
330 This sets the batch mode. In this mode no questions will be asked
331 and all certificates will be certified automatically.
332 .IP "\fB\-extensions section\fR" 4
333 .IX Item "-extensions section"
334 The section of the configuration file containing certificate extensions
335 to be added when a certificate is issued (defaults to \fBx509_extensions\fR
336 unless the \fB\-extfile\fR option is used). If no extension section is
337 present then, a V1 certificate is created. If the extension section
338 is present (even if it is empty), then a V3 certificate is created. See the
339 \&\fBx509v3_config\fR\|(5) manual page for details of the
340 extension section format.
341 .IP "\fB\-extfile file\fR" 4
342 .IX Item "-extfile file"
343 An additional configuration file to read certificate extensions from
344 (using the default section unless the \fB\-extensions\fR option is also
346 .IP "\fB\-engine id\fR" 4
347 .IX Item "-engine id"
348 Specifying an engine (by its unique \fBid\fR string) will cause \fBca\fR
349 to attempt to obtain a functional reference to the specified engine,
350 thus initialising it if needed. The engine will then be set as the default
351 for all available algorithms.
352 .IP "\fB\-subj arg\fR" 4
354 Supersedes subject name given in the request.
355 The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR.
356 Keyword characters may be escaped by \e (backslash), and whitespace is retained.
357 Empty values are permitted, but the corresponding type will not be included
358 in the resulting certificate.
361 This option causes field values to be interpreted as \s-1UTF8\s0 strings, by
362 default they are interpreted as \s-1ASCII.\s0 This means that the field
363 values, whether prompted from a terminal or obtained from a
364 configuration file, must be valid \s-1UTF8\s0 strings.
365 .IP "\fB\-create_serial\fR" 4
366 .IX Item "-create_serial"
367 If reading serial from the text file as specified in the configuration
368 fails, specifying this option creates a new random serial to be used as next
370 To get random serial numbers, use the \fB\-rand_serial\fR flag instead; this
371 should only be used for simple error-recovery.
372 .IP "\fB\-rand_serial\fR" 4
373 .IX Item "-rand_serial"
374 Generate a large random number to use as the serial number.
375 This overrides any option or configuration to use a serial number file.
376 .IP "\fB\-multivalue\-rdn\fR" 4
377 .IX Item "-multivalue-rdn"
378 This option causes the \-subj argument to be interpreted with full
379 support for multivalued RDNs. Example:
381 \&\fI/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\fR
383 If \-multi\-rdn is not used then the \s-1UID\s0 value is \fI123456+CN=John Doe\fR.
384 .IP "\fB\-rand file...\fR" 4
385 .IX Item "-rand file..."
386 A file or files containing random data used to seed the random number
388 Multiple files can be specified separated by an OS-dependent character.
389 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
391 .IP "[\fB\-writerand file\fR]" 4
392 .IX Item "[-writerand file]"
393 Writes random data to the specified \fIfile\fR upon exit.
394 This can be used with a subsequent \fB\-rand\fR flag.
396 .IX Header "CRL OPTIONS"
397 .IP "\fB\-gencrl\fR" 4
399 This option generates a \s-1CRL\s0 based on information in the index file.
400 .IP "\fB\-crldays num\fR" 4
401 .IX Item "-crldays num"
402 The number of days before the next \s-1CRL\s0 is due. That is the days from
403 now to place in the \s-1CRL\s0 nextUpdate field.
404 .IP "\fB\-crlhours num\fR" 4
405 .IX Item "-crlhours num"
406 The number of hours before the next \s-1CRL\s0 is due.
407 .IP "\fB\-revoke filename\fR" 4
408 .IX Item "-revoke filename"
409 A filename containing a certificate to revoke.
410 .IP "\fB\-valid filename\fR" 4
411 .IX Item "-valid filename"
412 A filename containing a certificate to add a Valid certificate entry.
413 .IP "\fB\-status serial\fR" 4
414 .IX Item "-status serial"
415 Displays the revocation status of the certificate with the specified
416 serial number and exits.
417 .IP "\fB\-updatedb\fR" 4
419 Updates the database index to purge expired certificates.
420 .IP "\fB\-crl_reason reason\fR" 4
421 .IX Item "-crl_reason reason"
422 Revocation reason, where \fBreason\fR is one of: \fBunspecified\fR, \fBkeyCompromise\fR,
423 \&\fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR, \fBcessationOfOperation\fR,
424 \&\fBcertificateHold\fR or \fBremoveFromCRL\fR. The matching of \fBreason\fR is case
425 insensitive. Setting any revocation reason will make the \s-1CRL\s0 v2.
427 In practice \fBremoveFromCRL\fR is not particularly useful because it is only used
428 in delta CRLs which are not currently implemented.
429 .IP "\fB\-crl_hold instruction\fR" 4
430 .IX Item "-crl_hold instruction"
431 This sets the \s-1CRL\s0 revocation reason code to \fBcertificateHold\fR and the hold
432 instruction to \fBinstruction\fR which must be an \s-1OID.\s0 Although any \s-1OID\s0 can be
433 used only \fBholdInstructionNone\fR (the use of which is discouraged by \s-1RFC2459\s0)
434 \&\fBholdInstructionCallIssuer\fR or \fBholdInstructionReject\fR will normally be used.
435 .IP "\fB\-crl_compromise time\fR" 4
436 .IX Item "-crl_compromise time"
437 This sets the revocation reason to \fBkeyCompromise\fR and the compromise time to
438 \&\fBtime\fR. \fBtime\fR should be in GeneralizedTime format that is \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
439 .IP "\fB\-crl_CA_compromise time\fR" 4
440 .IX Item "-crl_CA_compromise time"
441 This is the same as \fBcrl_compromise\fR except the revocation reason is set to
442 \&\fBCACompromise\fR.
443 .IP "\fB\-crlexts section\fR" 4
444 .IX Item "-crlexts section"
445 The section of the configuration file containing \s-1CRL\s0 extensions to
446 include. If no \s-1CRL\s0 extension section is present then a V1 \s-1CRL\s0 is
447 created, if the \s-1CRL\s0 extension section is present (even if it is
448 empty) then a V2 \s-1CRL\s0 is created. The \s-1CRL\s0 extensions specified are
449 \&\s-1CRL\s0 extensions and \fBnot\fR \s-1CRL\s0 entry extensions. It should be noted
450 that some software (for example Netscape) can't handle V2 CRLs. See
451 \&\fBx509v3_config\fR\|(5) manual page for details of the
452 extension section format.
453 .SH "CONFIGURATION FILE OPTIONS"
454 .IX Header "CONFIGURATION FILE OPTIONS"
455 The section of the configuration file containing options for \fBca\fR
456 is found as follows: If the \fB\-name\fR command line option is used,
457 then it names the section to be used. Otherwise the section to
458 be used must be named in the \fBdefault_ca\fR option of the \fBca\fR section
459 of the configuration file (or in the default section of the
460 configuration file). Besides \fBdefault_ca\fR, the following options are
461 read directly from the \fBca\fR section:
465 With the exception of \fB\s-1RANDFILE\s0\fR, this is probably a bug and may
466 change in future releases.
468 Many of the configuration file options are identical to command line
469 options. Where the option is present in the configuration file
470 and the command line the command line value is used. Where an
471 option is described as mandatory then it must be present in
472 the configuration file or the command line equivalent (if
474 .IP "\fBoid_file\fR" 4
476 This specifies a file containing additional \fB\s-1OBJECT IDENTIFIERS\s0\fR.
477 Each line of the file should consist of the numerical form of the
478 object identifier followed by white space then the short name followed
479 by white space and finally the long name.
480 .IP "\fBoid_section\fR" 4
481 .IX Item "oid_section"
482 This specifies a section in the configuration file containing extra
483 object identifiers. Each line should consist of the short name of the
484 object identifier followed by \fB=\fR and the numerical form. The short
485 and long names are the same when this option is used.
486 .IP "\fBnew_certs_dir\fR" 4
487 .IX Item "new_certs_dir"
488 The same as the \fB\-outdir\fR command line option. It specifies
489 the directory where new certificates will be placed. Mandatory.
490 .IP "\fBcertificate\fR" 4
491 .IX Item "certificate"
492 The same as \fB\-cert\fR. It gives the file containing the \s-1CA\s0
493 certificate. Mandatory.
494 .IP "\fBprivate_key\fR" 4
495 .IX Item "private_key"
496 Same as the \fB\-keyfile\fR option. The file containing the
497 \&\s-1CA\s0 private key. Mandatory.
498 .IP "\fB\s-1RANDFILE\s0\fR" 4
500 At startup the specified file is loaded into the random number generator,
501 and at exit 256 bytes will be written to it.
502 .IP "\fBdefault_days\fR" 4
503 .IX Item "default_days"
504 The same as the \fB\-days\fR option. The number of days to certify
506 .IP "\fBdefault_startdate\fR" 4
507 .IX Item "default_startdate"
508 The same as the \fB\-startdate\fR option. The start date to certify
509 a certificate for. If not set the current time is used.
510 .IP "\fBdefault_enddate\fR" 4
511 .IX Item "default_enddate"
512 The same as the \fB\-enddate\fR option. Either this option or
513 \&\fBdefault_days\fR (or the command line equivalents) must be
515 .IP "\fBdefault_crl_hours default_crl_days\fR" 4
516 .IX Item "default_crl_hours default_crl_days"
517 The same as the \fB\-crlhours\fR and the \fB\-crldays\fR options. These
518 will only be used if neither command line option is present. At
519 least one of these must be present to generate a \s-1CRL.\s0
520 .IP "\fBdefault_md\fR" 4
521 .IX Item "default_md"
522 The same as the \fB\-md\fR option. Mandatory except where the signing algorithm does
523 not require a digest (i.e. Ed25519 and Ed448).
524 .IP "\fBdatabase\fR" 4
526 The text database file to use. Mandatory. This file must be present
527 though initially it will be empty.
528 .IP "\fBunique_subject\fR" 4
529 .IX Item "unique_subject"
530 If the value \fByes\fR is given, the valid certificate entries in the
531 database must have unique subjects. if the value \fBno\fR is given,
532 several valid certificate entries may have the exact same subject.
533 The default value is \fByes\fR, to be compatible with older (pre 0.9.8)
534 versions of OpenSSL. However, to make \s-1CA\s0 certificate roll-over easier,
535 it's recommended to use the value \fBno\fR, especially if combined with
536 the \fB\-selfsign\fR command line option.
538 Note that it is valid in some circumstances for certificates to be created
539 without any subject. In the case where there are multiple certificates without
540 subjects this does not count as a duplicate.
543 A text file containing the next serial number to use in hex. Mandatory.
544 This file must be present and contain a valid serial number.
545 .IP "\fBcrlnumber\fR" 4
547 A text file containing the next \s-1CRL\s0 number to use in hex. The crl number
548 will be inserted in the CRLs only if this file exists. If this file is
549 present, it must contain a valid \s-1CRL\s0 number.
550 .IP "\fBx509_extensions\fR" 4
551 .IX Item "x509_extensions"
552 The same as \fB\-extensions\fR.
553 .IP "\fBcrl_extensions\fR" 4
554 .IX Item "crl_extensions"
555 The same as \fB\-crlexts\fR.
556 .IP "\fBpreserve\fR" 4
558 The same as \fB\-preserveDN\fR
559 .IP "\fBemail_in_dn\fR" 4
560 .IX Item "email_in_dn"
561 The same as \fB\-noemailDN\fR. If you want the \s-1EMAIL\s0 field to be removed
562 from the \s-1DN\s0 of the certificate simply set this to 'no'. If not present
563 the default is to allow for the \s-1EMAIL\s0 filed in the certificate's \s-1DN.\s0
564 .IP "\fBmsie_hack\fR" 4
566 The same as \fB\-msie_hack\fR
569 The same as \fB\-policy\fR. Mandatory. See the \fB\s-1POLICY FORMAT\s0\fR section
570 for more information.
571 .IP "\fBname_opt\fR, \fBcert_opt\fR" 4
572 .IX Item "name_opt, cert_opt"
573 These options allow the format used to display the certificate details
574 when asking the user to confirm signing. All the options supported by
575 the \fBx509\fR utilities \fB\-nameopt\fR and \fB\-certopt\fR switches can be used
576 here, except the \fBno_signame\fR and \fBno_sigdump\fR are permanently set
577 and cannot be disabled (this is because the certificate signature cannot
578 be displayed because the certificate has not been signed at this point).
580 For convenience the values \fBca_default\fR are accepted by both to produce
583 If neither option is present the format used in earlier versions of
584 OpenSSL is used. Use of the old format is \fBstrongly\fR discouraged because
585 it only displays fields mentioned in the \fBpolicy\fR section, mishandles
586 multicharacter string types and does not display extensions.
587 .IP "\fBcopy_extensions\fR" 4
588 .IX Item "copy_extensions"
589 Determines how extensions in certificate requests should be handled.
590 If set to \fBnone\fR or this option is not present then extensions are
591 ignored and not copied to the certificate. If set to \fBcopy\fR then any
592 extensions present in the request that are not already present are copied
593 to the certificate. If set to \fBcopyall\fR then all extensions in the
594 request are copied to the certificate: if the extension is already present
595 in the certificate it is deleted first. See the \fB\s-1WARNINGS\s0\fR section before
598 The main use of this option is to allow a certificate request to supply
599 values for certain extensions such as subjectAltName.
601 .IX Header "POLICY FORMAT"
602 The policy section consists of a set of variables corresponding to
603 certificate \s-1DN\s0 fields. If the value is \*(L"match\*(R" then the field value
604 must match the same field in the \s-1CA\s0 certificate. If the value is
605 \&\*(L"supplied\*(R" then it must be present. If the value is \*(L"optional\*(R" then
606 it may be present. Any fields not mentioned in the policy section
607 are silently deleted, unless the \fB\-preserveDN\fR option is set but
608 this can be regarded more of a quirk than intended behaviour.
610 .IX Header "SPKAC FORMAT"
611 The input to the \fB\-spkac\fR command line option is a Netscape
612 signed public key and challenge. This will usually come from
613 the \fB\s-1KEYGEN\s0\fR tag in an \s-1HTML\s0 form to create a new private key.
614 It is however possible to create SPKACs using the \fBspkac\fR utility.
616 The file should contain the variable \s-1SPKAC\s0 set to the value of
617 the \s-1SPKAC\s0 and also the required \s-1DN\s0 components as name value pairs.
618 If you need to include the same component twice then it can be
619 preceded by a number and a '.'.
621 When processing \s-1SPKAC\s0 format, the output is \s-1DER\s0 if the \fB\-out\fR
622 flag is used, but \s-1PEM\s0 format if sending to stdout or the \fB\-outdir\fR
625 .IX Header "EXAMPLES"
626 Note: these examples assume that the \fBca\fR directory structure is
627 already set up and the relevant files already exist. This usually
628 involves creating a \s-1CA\s0 certificate and private key with \fBreq\fR, a
629 serial number file and an empty index file and placing them in
630 the relevant directories.
632 To use the sample configuration file below the directories demoCA,
633 demoCA/private and demoCA/newcerts would be created. The \s-1CA\s0
634 certificate would be copied to demoCA/cacert.pem and its private
635 key to demoCA/private/cakey.pem. A file demoCA/serial would be
636 created containing for example \*(L"01\*(R" and the empty index file
639 Sign a certificate request:
642 \& openssl ca \-in req.pem \-out newcert.pem
645 Sign a certificate request, using \s-1CA\s0 extensions:
648 \& openssl ca \-in req.pem \-extensions v3_ca \-out newcert.pem
651 Generate a \s-1CRL\s0
654 \& openssl ca \-gencrl \-out crl.pem
657 Sign several requests:
660 \& openssl ca \-infiles req1.pem req2.pem req3.pem
663 Certify a Netscape \s-1SPKAC:\s0
666 \& openssl ca \-spkac spkac.txt
669 A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity):
672 \& SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
674 \& emailAddress=steve@openssl.org
675 \& 0.OU=OpenSSL Group
676 \& 1.OU=Another Group
679 A sample configuration file with the relevant sections for \fBca\fR:
683 \& default_ca = CA_default # The default ca section
687 \& dir = ./demoCA # top dir
688 \& database = $dir/index.txt # index file.
689 \& new_certs_dir = $dir/newcerts # new certs dir
691 \& certificate = $dir/cacert.pem # The CA cert
692 \& serial = $dir/serial # serial no file
693 \& #rand_serial = yes # for random serial#\*(Aqs
694 \& private_key = $dir/private/cakey.pem# CA private key
695 \& RANDFILE = $dir/private/.rand # random number file
697 \& default_days = 365 # how long to certify for
698 \& default_crl_days= 30 # how long before next CRL
699 \& default_md = md5 # md to use
701 \& policy = policy_any # default policy
702 \& email_in_dn = no # Don\*(Aqt add the email into cert DN
704 \& name_opt = ca_default # Subject name display option
705 \& cert_opt = ca_default # Certificate display option
706 \& copy_extensions = none # Don\*(Aqt copy extensions from request
709 \& countryName = supplied
710 \& stateOrProvinceName = optional
711 \& organizationName = optional
712 \& organizationalUnitName = optional
713 \& commonName = supplied
714 \& emailAddress = optional
718 Note: the location of all files can change either by compile time options,
719 configuration file entries, environment variables or command line options.
720 The values below reflect the default values.
723 \& /usr/local/ssl/lib/openssl.cnf \- master configuration file
724 \& ./demoCA \- main CA directory
725 \& ./demoCA/cacert.pem \- CA certificate
726 \& ./demoCA/private/cakey.pem \- CA private key
727 \& ./demoCA/serial \- CA serial number file
728 \& ./demoCA/serial.old \- CA serial number backup file
729 \& ./demoCA/index.txt \- CA text database file
730 \& ./demoCA/index.txt.old \- CA text database backup file
731 \& ./demoCA/certs \- certificate output file
732 \& ./demoCA/.rnd \- CA random seed information
735 .IX Header "RESTRICTIONS"
736 The text database index file is a critical part of the process and
737 if corrupted it can be difficult to fix. It is theoretically possible
738 to rebuild the index file from all the issued certificates and a current
739 \&\s-1CRL:\s0 however there is no option to do this.
741 V2 \s-1CRL\s0 features like delta CRLs are not currently supported.
743 Although several requests can be input and handled at once it is only
744 possible to include one \s-1SPKAC\s0 or self-signed certificate.
747 The use of an in-memory text database can cause problems when large
748 numbers of certificates are present because, as the name implies
749 the database has to be kept in memory.
751 The \fBca\fR command really needs rewriting or the required functionality
752 exposed at either a command or interface level so a more friendly utility
753 (perl script or \s-1GUI\s0) can handle things properly. The script
754 \&\fB\s-1CA\s0.pl\fR helps a little but not very much.
756 Any fields in a request that are not present in a policy are silently
757 deleted. This does not happen if the \fB\-preserveDN\fR option is used. To
758 enforce the absence of the \s-1EMAIL\s0 field within the \s-1DN,\s0 as suggested by
759 RFCs, regardless the contents of the request' subject the \fB\-noemailDN\fR
760 option can be used. The behaviour should be more friendly and
763 Canceling some commands by refusing to certify a certificate can
764 create an empty file.
766 .IX Header "WARNINGS"
767 The \fBca\fR command is quirky and at times downright unfriendly.
769 The \fBca\fR utility was originally meant as an example of how to do things
770 in a \s-1CA.\s0 It was not supposed to be used as a full blown \s-1CA\s0 itself:
771 nevertheless some people are using it for this purpose.
773 The \fBca\fR command is effectively a single user command: no locking is
774 done on the various files and attempts to run more than one \fBca\fR command
775 on the same database can have unpredictable results.
777 The \fBcopy_extensions\fR option should be used with caution. If care is
778 not taken then it can be a security risk. For example if a certificate
779 request contains a basicConstraints extension with \s-1CA:TRUE\s0 and the
780 \&\fBcopy_extensions\fR value is set to \fBcopyall\fR and the user does not spot
781 this when the certificate is displayed then this will hand the requester
782 a valid \s-1CA\s0 certificate.
784 This situation can be avoided by setting \fBcopy_extensions\fR to \fBcopy\fR
785 and including basicConstraints with \s-1CA:FALSE\s0 in the configuration file.
786 Then if the request contains a basicConstraints extension it will be
789 It is advisable to also include values for other extensions such
790 as \fBkeyUsage\fR to prevent a request supplying its own values.
792 Additional restrictions can be placed on the \s-1CA\s0 certificate itself.
793 For example if the \s-1CA\s0 certificate has:
796 \& basicConstraints = CA:TRUE, pathlen:0
799 then even if a certificate is issued with \s-1CA:TRUE\s0 it will not be valid.
802 Since OpenSSL 1.1.1, the program follows \s-1RFC5280.\s0 Specifically,
803 certificate validity period (specified by any of \fB\-startdate\fR,
804 \&\fB\-enddate\fR and \fB\-days\fR) will be encoded as UTCTime if the dates are
805 earlier than year 2049 (included), and as GeneralizedTime if the dates
806 are in year 2050 or later.
808 .IX Header "SEE ALSO"
809 \&\fBreq\fR\|(1), \fBspkac\fR\|(1), \fBx509\fR\|(1), \s-1\fBCA\s0.pl\fR\|(1),
810 \&\fBconfig\fR\|(5), \fBx509v3_config\fR\|(5)
812 .IX Header "COPYRIGHT"
813 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
815 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
816 this file except in compliance with the License. You can obtain a copy
817 in the file \s-1LICENSE\s0 in the source distribution or at
818 <https://www.openssl.org/source/license.html>.
projects / FreeBSD / FreeBSD.git / blob