1 .\" Automatically generated by Pod::Man 2.28 (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 X509 1 "2015-12-03" "0.9.8zh" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 x509 \- Certificate display and signing utility
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBx509\fR
146 [\fB\-inform DER|PEM|NET\fR]
147 [\fB\-outform DER|PEM|NET\fR]
148 [\fB\-keyform DER|PEM\fR]
149 [\fB\-CAform DER|PEM\fR]
150 [\fB\-CAkeyform DER|PEM\fR]
151 [\fB\-in filename\fR]
152 [\fB\-out filename\fR]
155 [\fB\-subject_hash\fR]
156 [\fB\-issuer_hash\fR]
160 [\fB\-nameopt option\fR]
166 [\fB\-checkend num\fR]
168 [\fB\-fingerprint\fR]
174 [\fB\-addtrust arg\fR]
175 [\fB\-addreject arg\fR]
176 [\fB\-setalias arg\fR]
178 [\fB\-set_serial n\fR]
179 [\fB\-signkey filename\fR]
183 [\fB\-CA filename\fR]
184 [\fB\-CAkey filename\fR]
185 [\fB\-CAcreateserial\fR]
186 [\fB\-CAserial filename\fR]
188 [\fB\-certopt option\fR]
190 [\fB\-md2|\-md5|\-sha1|\-mdc2\fR]
192 [\fB\-extfile filename\fR]
193 [\fB\-extensions section\fR]
196 .IX Header "DESCRIPTION"
197 The \fBx509\fR command is a multi purpose certificate utility. It can be
198 used to display certificate information, convert certificates to
199 various forms, sign certificate requests like a \*(L"mini \s-1CA\*(R"\s0 or edit
200 certificate trust settings.
202 Since there are a large number of options they will split up into
206 .SS "\s-1INPUT, OUTPUT AND GENERAL PURPOSE OPTIONS\s0"
207 .IX Subsection "INPUT, OUTPUT AND GENERAL PURPOSE OPTIONS"
208 .IP "\fB\-inform DER|PEM|NET\fR" 4
209 .IX Item "-inform DER|PEM|NET"
210 This specifies the input format normally the command will expect an X509
211 certificate but this can change if other options such as \fB\-req\fR are
212 present. The \s-1DER\s0 format is the \s-1DER\s0 encoding of the certificate and \s-1PEM\s0
213 is the base64 encoding of the \s-1DER\s0 encoding with header and footer lines
214 added. The \s-1NET\s0 option is an obscure Netscape server format that is now
216 .IP "\fB\-outform DER|PEM|NET\fR" 4
217 .IX Item "-outform DER|PEM|NET"
218 This specifies the output format, the options have the same meaning as the
219 \&\fB\-inform\fR option.
220 .IP "\fB\-in filename\fR" 4
221 .IX Item "-in filename"
222 This specifies the input filename to read a certificate from or standard input
223 if this option is not specified.
224 .IP "\fB\-out filename\fR" 4
225 .IX Item "-out filename"
226 This specifies the output filename to write to or standard output by
228 .IP "\fB\-md2|\-md5|\-sha1|\-mdc2\fR" 4
229 .IX Item "-md2|-md5|-sha1|-mdc2"
230 the digest to use. This affects any signing or display option that uses a message
231 digest, such as the \fB\-fingerprint\fR, \fB\-signkey\fR and \fB\-CA\fR options. If not
232 specified then \s-1SHA1\s0 is used. If the key being used to sign with is a \s-1DSA\s0 key
233 then this option has no effect: \s-1SHA1\s0 is always used with \s-1DSA\s0 keys.
234 .IP "\fB\-engine id\fR" 4
235 .IX Item "-engine id"
236 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
237 to attempt to obtain a functional reference to the specified engine,
238 thus initialising it if needed. The engine will then be set as the default
239 for all available algorithms.
240 .SS "\s-1DISPLAY OPTIONS\s0"
241 .IX Subsection "DISPLAY OPTIONS"
242 Note: the \fB\-alias\fR and \fB\-purpose\fR options are also display options
243 but are described in the \fB\s-1TRUST SETTINGS\s0\fR section.
246 prints out the certificate in text form. Full details are output including the
247 public key, signature algorithms, issuer and subject names, serial number
248 any extensions present and any trust settings.
249 .IP "\fB\-certopt option\fR" 4
250 .IX Item "-certopt option"
251 customise the output format used with \fB\-text\fR. The \fBoption\fR argument can be
252 a single option or multiple options separated by commas. The \fB\-certopt\fR switch
253 may be also be used more than once to set multiple options. See the \fB\s-1TEXT OPTIONS\s0\fR
254 section for more information.
255 .IP "\fB\-noout\fR" 4
257 this option prevents output of the encoded version of the request.
258 .IP "\fB\-modulus\fR" 4
260 this option prints out the value of the modulus of the public key
261 contained in the certificate.
262 .IP "\fB\-serial\fR" 4
264 outputs the certificate serial number.
265 .IP "\fB\-subject_hash\fR" 4
266 .IX Item "-subject_hash"
267 outputs the \*(L"hash\*(R" of the certificate subject name. This is used in OpenSSL to
268 form an index to allow certificates in a directory to be looked up by subject
270 .IP "\fB\-issuer_hash\fR" 4
271 .IX Item "-issuer_hash"
272 outputs the \*(L"hash\*(R" of the certificate issuer name.
273 .IP "\fB\-ocspid\fR" 4
275 outputs the \s-1OCSP\s0 hash values for the subject name and public key.
278 synonym for \*(L"\-subject_hash\*(R" for backward compatibility reasons.
279 .IP "\fB\-subject\fR" 4
281 outputs the subject name.
282 .IP "\fB\-issuer\fR" 4
284 outputs the issuer name.
285 .IP "\fB\-nameopt option\fR" 4
286 .IX Item "-nameopt option"
287 option which determines how the subject or issuer names are displayed. The
288 \&\fBoption\fR argument can be a single option or multiple options separated by
289 commas. Alternatively the \fB\-nameopt\fR switch may be used more than once to
290 set multiple options. See the \fB\s-1NAME OPTIONS\s0\fR section for more information.
291 .IP "\fB\-email\fR" 4
293 outputs the email address(es) if any.
294 .IP "\fB\-startdate\fR" 4
295 .IX Item "-startdate"
296 prints out the start date of the certificate, that is the notBefore date.
297 .IP "\fB\-enddate\fR" 4
299 prints out the expiry date of the certificate, that is the notAfter date.
300 .IP "\fB\-dates\fR" 4
302 prints out the start and expiry dates of a certificate.
303 .IP "\fB\-checkend arg\fR" 4
304 .IX Item "-checkend arg"
305 checks if the certificate expires within the next \fBarg\fR seconds and exits
306 non-zero if yes it will expire or zero if not.
307 .IP "\fB\-fingerprint\fR" 4
308 .IX Item "-fingerprint"
309 prints out the digest of the \s-1DER\s0 encoded version of the whole certificate
310 (see digest options).
313 this outputs the certificate in the form of a C source file.
314 .SS "\s-1TRUST SETTINGS\s0"
315 .IX Subsection "TRUST SETTINGS"
316 Please note these options are currently experimental and may well change.
318 A \fBtrusted certificate\fR is an ordinary certificate which has several
319 additional pieces of information attached to it such as the permitted
320 and prohibited uses of the certificate and an \*(L"alias\*(R".
322 Normally when a certificate is being verified at least one certificate
323 must be \*(L"trusted\*(R". By default a trusted certificate must be stored
324 locally and must be a root \s-1CA:\s0 any certificate chain ending in this \s-1CA\s0
325 is then usable for any purpose.
327 Trust settings currently are only used with a root \s-1CA.\s0 They allow a finer
328 control over the purposes the root \s-1CA\s0 can be used for. For example a \s-1CA\s0
329 may be trusted for \s-1SSL\s0 client but not \s-1SSL\s0 server use.
331 See the description of the \fBverify\fR utility for more information on the
332 meaning of trust settings.
334 Future versions of OpenSSL will recognize trust settings on any
335 certificate: not just root CAs.
336 .IP "\fB\-trustout\fR" 4
338 this causes \fBx509\fR to output a \fBtrusted\fR certificate. An ordinary
339 or trusted certificate can be input but by default an ordinary
340 certificate is output and any trust settings are discarded. With the
341 \&\fB\-trustout\fR option a trusted certificate is output. A trusted
342 certificate is automatically output if any trust settings are modified.
343 .IP "\fB\-setalias arg\fR" 4
344 .IX Item "-setalias arg"
345 sets the alias of the certificate. This will allow the certificate
346 to be referred to using a nickname for example \*(L"Steve's Certificate\*(R".
347 .IP "\fB\-alias\fR" 4
349 outputs the certificate alias, if any.
350 .IP "\fB\-clrtrust\fR" 4
352 clears all the permitted or trusted uses of the certificate.
353 .IP "\fB\-clrreject\fR" 4
354 .IX Item "-clrreject"
355 clears all the prohibited or rejected uses of the certificate.
356 .IP "\fB\-addtrust arg\fR" 4
357 .IX Item "-addtrust arg"
358 adds a trusted certificate use. Any object name can be used here
359 but currently only \fBclientAuth\fR (\s-1SSL\s0 client use), \fBserverAuth\fR
360 (\s-1SSL\s0 server use) and \fBemailProtection\fR (S/MIME email) are used.
361 Other OpenSSL applications may define additional uses.
362 .IP "\fB\-addreject arg\fR" 4
363 .IX Item "-addreject arg"
364 adds a prohibited use. It accepts the same values as the \fB\-addtrust\fR
366 .IP "\fB\-purpose\fR" 4
368 this option performs tests on the certificate extensions and outputs
369 the results. For a more complete description see the \fB\s-1CERTIFICATE
370 EXTENSIONS\s0\fR section.
371 .SS "\s-1SIGNING OPTIONS\s0"
372 .IX Subsection "SIGNING OPTIONS"
373 The \fBx509\fR utility can be used to sign certificates and requests: it
374 can thus behave like a \*(L"mini \s-1CA\*(R".\s0
375 .IP "\fB\-signkey filename\fR" 4
376 .IX Item "-signkey filename"
377 this option causes the input file to be self signed using the supplied
380 If the input file is a certificate it sets the issuer name to the
381 subject name (i.e. makes it self signed) changes the public key to the
382 supplied value and changes the start and end dates. The start date is
383 set to the current time and the end date is set to a value determined
384 by the \fB\-days\fR option. Any certificate extensions are retained unless
385 the \fB\-clrext\fR option is supplied.
387 If the input is a certificate request then a self signed certificate
388 is created using the supplied private key using the subject name in
390 .IP "\fB\-passin arg\fR" 4
391 .IX Item "-passin arg"
392 the key password source. For more information about the format of \fBarg\fR
393 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
394 .IP "\fB\-clrext\fR" 4
396 delete any extensions from a certificate. This option is used when a
397 certificate is being created from another certificate (for example with
398 the \fB\-signkey\fR or the \fB\-CA\fR options). Normally all extensions are
400 .IP "\fB\-keyform PEM|DER\fR" 4
401 .IX Item "-keyform PEM|DER"
402 specifies the format (\s-1DER\s0 or \s-1PEM\s0) of the private key file used in the
403 \&\fB\-signkey\fR option.
404 .IP "\fB\-days arg\fR" 4
406 specifies the number of days to make a certificate valid for. The default
408 .IP "\fB\-x509toreq\fR" 4
409 .IX Item "-x509toreq"
410 converts a certificate into a certificate request. The \fB\-signkey\fR option
411 is used to pass the required private key.
414 by default a certificate is expected on input. With this option a
415 certificate request is expected instead.
416 .IP "\fB\-set_serial n\fR" 4
417 .IX Item "-set_serial n"
418 specifies the serial number to use. This option can be used with either
419 the \fB\-signkey\fR or \fB\-CA\fR options. If used in conjunction with the \fB\-CA\fR
420 option the serial number file (as specified by the \fB\-CAserial\fR or
421 \&\fB\-CAcreateserial\fR options) is not used.
423 The serial number can be decimal or hex (if preceded by \fB0x\fR). Negative
424 serial numbers can also be specified but their use is not recommended.
425 .IP "\fB\-CA filename\fR" 4
426 .IX Item "-CA filename"
427 specifies the \s-1CA\s0 certificate to be used for signing. When this option is
428 present \fBx509\fR behaves like a \*(L"mini \s-1CA\*(R".\s0 The input file is signed by this
429 \&\s-1CA\s0 using this option: that is its issuer name is set to the subject name
430 of the \s-1CA\s0 and it is digitally signed using the CAs private key.
432 This option is normally combined with the \fB\-req\fR option. Without the
433 \&\fB\-req\fR option the input is a certificate which must be self signed.
434 .IP "\fB\-CAkey filename\fR" 4
435 .IX Item "-CAkey filename"
436 sets the \s-1CA\s0 private key to sign a certificate with. If this option is
437 not specified then it is assumed that the \s-1CA\s0 private key is present in
438 the \s-1CA\s0 certificate file.
439 .IP "\fB\-CAserial filename\fR" 4
440 .IX Item "-CAserial filename"
441 sets the \s-1CA\s0 serial number file to use.
443 When the \fB\-CA\fR option is used to sign a certificate it uses a serial
444 number specified in a file. This file consist of one line containing
445 an even number of hex digits with the serial number to use. After each
446 use the serial number is incremented and written out to the file again.
448 The default filename consists of the \s-1CA\s0 certificate file base name with
449 \&\*(L".srl\*(R" appended. For example if the \s-1CA\s0 certificate file is called
450 \&\*(L"mycacert.pem\*(R" it expects to find a serial number file called \*(L"mycacert.srl\*(R".
451 .IP "\fB\-CAcreateserial\fR" 4
452 .IX Item "-CAcreateserial"
453 with this option the \s-1CA\s0 serial number file is created if it does not exist:
454 it will contain the serial number \*(L"02\*(R" and the certificate being signed will
455 have the 1 as its serial number. Normally if the \fB\-CA\fR option is specified
456 and the serial number file does not exist it is an error.
457 .IP "\fB\-extfile filename\fR" 4
458 .IX Item "-extfile filename"
459 file containing certificate extensions to use. If not specified then
460 no extensions are added to the certificate.
461 .IP "\fB\-extensions section\fR" 4
462 .IX Item "-extensions section"
463 the section to add certificate extensions from. If this option is not
464 specified then the extensions should either be contained in the unnamed
465 (default) section or the default section should contain a variable called
466 \&\*(L"extensions\*(R" which contains the section to use.
467 .SS "\s-1NAME OPTIONS\s0"
468 .IX Subsection "NAME OPTIONS"
469 The \fBnameopt\fR command line switch determines how the subject and issuer
470 names are displayed. If no \fBnameopt\fR switch is present the default \*(L"oneline\*(R"
471 format is used which is compatible with previous versions of OpenSSL.
472 Each option is described in detail below, all options can be preceded by
473 a \fB\-\fR to turn the option off. Only the first four will normally be used.
476 use the old format. This is equivalent to specifying no name options at all.
477 .IP "\fB\s-1RFC2253\s0\fR" 4
479 displays names compatible with \s-1RFC2253\s0 equivalent to \fBesc_2253\fR, \fBesc_ctrl\fR,
480 \&\fBesc_msb\fR, \fButf8\fR, \fBdump_nostr\fR, \fBdump_unknown\fR, \fBdump_der\fR,
481 \&\fBsep_comma_plus\fR, \fBdn_rev\fR and \fBsname\fR.
482 .IP "\fBoneline\fR" 4
484 a oneline format which is more readable than \s-1RFC2253.\s0 It is equivalent to
485 specifying the \fBesc_2253\fR, \fBesc_ctrl\fR, \fBesc_msb\fR, \fButf8\fR, \fBdump_nostr\fR,
486 \&\fBdump_der\fR, \fBuse_quote\fR, \fBsep_comma_plus_space\fR, \fBspace_eq\fR and \fBsname\fR
488 .IP "\fBmultiline\fR" 4
490 a multiline format. It is equivalent \fBesc_ctrl\fR, \fBesc_msb\fR, \fBsep_multiline\fR,
491 \&\fBspace_eq\fR, \fBlname\fR and \fBalign\fR.
492 .IP "\fBesc_2253\fR" 4
494 escape the \*(L"special\*(R" characters required by \s-1RFC2253\s0 in a field That is
495 \&\fB,+"<>;\fR. Additionally \fB#\fR is escaped at the beginning of a string
496 and a space character at the beginning or end of a string.
497 .IP "\fBesc_ctrl\fR" 4
499 escape control characters. That is those with \s-1ASCII\s0 values less than
500 0x20 (space) and the delete (0x7f) character. They are escaped using the
501 \&\s-1RFC2253\s0 \eXX notation (where \s-1XX\s0 are two hex digits representing the
503 .IP "\fBesc_msb\fR" 4
505 escape characters with the \s-1MSB\s0 set, that is with \s-1ASCII\s0 values larger than
507 .IP "\fBuse_quote\fR" 4
509 escapes some characters by surrounding the whole string with \fB"\fR characters,
510 without the option all escaping is done with the \fB\e\fR character.
513 convert all strings to \s-1UTF8\s0 format first. This is required by \s-1RFC2253.\s0 If
514 you are lucky enough to have a \s-1UTF8\s0 compatible terminal then the use
515 of this option (and \fBnot\fR setting \fBesc_msb\fR) may result in the correct
516 display of multibyte (international) characters. Is this option is not
517 present then multibyte characters larger than 0xff will be represented
518 using the format \eUXXXX for 16 bits and \eWXXXXXXXX for 32 bits.
519 Also if this option is off any UTF8Strings will be converted to their
520 character form first.
521 .IP "\fBignore_type\fR" 4
522 .IX Item "ignore_type"
523 this option does not attempt to interpret multibyte characters in any
524 way. That is their content octets are merely dumped as though one octet
525 represents each character. This is useful for diagnostic purposes but
526 will result in rather odd looking output.
527 .IP "\fBshow_type\fR" 4
529 show the type of the \s-1ASN1\s0 character string. The type precedes the
530 field contents. For example \*(L"\s-1BMPSTRING:\s0 Hello World\*(R".
531 .IP "\fBdump_der\fR" 4
533 when this option is set any fields that need to be hexdumped will
534 be dumped using the \s-1DER\s0 encoding of the field. Otherwise just the
535 content octets will be displayed. Both options use the \s-1RFC2253
536 \&\s0\fB#XXXX...\fR format.
537 .IP "\fBdump_nostr\fR" 4
538 .IX Item "dump_nostr"
539 dump non character string types (for example \s-1OCTET STRING\s0) if this
540 option is not set then non character string types will be displayed
541 as though each content octet represents a single character.
542 .IP "\fBdump_all\fR" 4
544 dump all fields. This option when used with \fBdump_der\fR allows the
545 \&\s-1DER\s0 encoding of the structure to be unambiguously determined.
546 .IP "\fBdump_unknown\fR" 4
547 .IX Item "dump_unknown"
548 dump any field whose \s-1OID\s0 is not recognised by OpenSSL.
549 .IP "\fBsep_comma_plus\fR, \fBsep_comma_plus_space\fR, \fBsep_semi_plus_space\fR, \fBsep_multiline\fR" 4
550 .IX Item "sep_comma_plus, sep_comma_plus_space, sep_semi_plus_space, sep_multiline"
551 these options determine the field separators. The first character is
552 between RDNs and the second between multiple AVAs (multiple AVAs are
553 very rare and their use is discouraged). The options ending in
554 \&\*(L"space\*(R" additionally place a space after the separator to make it
555 more readable. The \fBsep_multiline\fR uses a linefeed character for
556 the \s-1RDN\s0 separator and a spaced \fB+\fR for the \s-1AVA\s0 separator. It also
557 indents the fields by four characters.
560 reverse the fields of the \s-1DN.\s0 This is required by \s-1RFC2253.\s0 As a side
561 effect this also reverses the order of multiple AVAs but this is
563 .IP "\fBnofname\fR, \fBsname\fR, \fBlname\fR, \fBoid\fR" 4
564 .IX Item "nofname, sname, lname, oid"
565 these options alter how the field name is displayed. \fBnofname\fR does
566 not display the field at all. \fBsname\fR uses the \*(L"short name\*(R" form
567 (\s-1CN\s0 for commonName for example). \fBlname\fR uses the long form.
568 \&\fBoid\fR represents the \s-1OID\s0 in numerical form and is useful for
572 align field values for a more readable output. Only usable with
573 \&\fBsep_multiline\fR.
574 .IP "\fBspace_eq\fR" 4
576 places spaces round the \fB=\fR character which follows the field
578 .SS "\s-1TEXT OPTIONS\s0"
579 .IX Subsection "TEXT OPTIONS"
580 As well as customising the name output format, it is also possible to
581 customise the actual fields printed using the \fBcertopt\fR options when
582 the \fBtext\fR option is present. The default behaviour is to print all fields.
583 .IP "\fBcompatible\fR" 4
584 .IX Item "compatible"
585 use the old format. This is equivalent to specifying no output options at all.
586 .IP "\fBno_header\fR" 4
588 don't print header information: that is the lines saying \*(L"Certificate\*(R" and \*(L"Data\*(R".
589 .IP "\fBno_version\fR" 4
590 .IX Item "no_version"
591 don't print out the version number.
592 .IP "\fBno_serial\fR" 4
594 don't print out the serial number.
595 .IP "\fBno_signame\fR" 4
596 .IX Item "no_signame"
597 don't print out the signature algorithm used.
598 .IP "\fBno_validity\fR" 4
599 .IX Item "no_validity"
600 don't print the validity, that is the \fBnotBefore\fR and \fBnotAfter\fR fields.
601 .IP "\fBno_subject\fR" 4
602 .IX Item "no_subject"
603 don't print out the subject name.
604 .IP "\fBno_issuer\fR" 4
606 don't print out the issuer name.
607 .IP "\fBno_pubkey\fR" 4
609 don't print out the public key.
610 .IP "\fBno_sigdump\fR" 4
611 .IX Item "no_sigdump"
612 don't give a hexadecimal dump of the certificate signature.
615 don't print out certificate trust information.
616 .IP "\fBno_extensions\fR" 4
617 .IX Item "no_extensions"
618 don't print out any X509V3 extensions.
619 .IP "\fBext_default\fR" 4
620 .IX Item "ext_default"
621 retain default extension behaviour: attempt to print out unsupported certificate extensions.
622 .IP "\fBext_error\fR" 4
624 print an error message for unsupported certificate extensions.
625 .IP "\fBext_parse\fR" 4
627 \&\s-1ASN1\s0 parse unsupported extensions.
628 .IP "\fBext_dump\fR" 4
630 hex dump unsupported extensions.
631 .IP "\fBca_default\fR" 4
632 .IX Item "ca_default"
633 the value used by the \fBca\fR utility, equivalent to \fBno_issuer\fR, \fBno_pubkey\fR, \fBno_header\fR,
634 \&\fBno_version\fR, \fBno_sigdump\fR and \fBno_signame\fR.
636 .IX Header "EXAMPLES"
637 Note: in these examples the '\e' means the example should be all on one
640 Display the contents of a certificate:
643 \& openssl x509 \-in cert.pem \-noout \-text
646 Display the certificate serial number:
649 \& openssl x509 \-in cert.pem \-noout \-serial
652 Display the certificate subject name:
655 \& openssl x509 \-in cert.pem \-noout \-subject
658 Display the certificate subject name in \s-1RFC2253\s0 form:
661 \& openssl x509 \-in cert.pem \-noout \-subject \-nameopt RFC2253
664 Display the certificate subject name in oneline form on a terminal
665 supporting \s-1UTF8:\s0
668 \& openssl x509 \-in cert.pem \-noout \-subject \-nameopt oneline,\-esc_msb
671 Display the certificate \s-1MD5\s0 fingerprint:
674 \& openssl x509 \-in cert.pem \-noout \-fingerprint
677 Display the certificate \s-1SHA1\s0 fingerprint:
680 \& openssl x509 \-sha1 \-in cert.pem \-noout \-fingerprint
683 Convert a certificate from \s-1PEM\s0 to \s-1DER\s0 format:
686 \& openssl x509 \-in cert.pem \-inform PEM \-out cert.der \-outform DER
689 Convert a certificate to a certificate request:
692 \& openssl x509 \-x509toreq \-in cert.pem \-out req.pem \-signkey key.pem
695 Convert a certificate request into a self signed certificate using
696 extensions for a \s-1CA:\s0
699 \& openssl x509 \-req \-in careq.pem \-extfile openssl.cnf \-extensions v3_ca \e
700 \& \-signkey key.pem \-out cacert.pem
703 Sign a certificate request using the \s-1CA\s0 certificate above and add user
704 certificate extensions:
707 \& openssl x509 \-req \-in req.pem \-extfile openssl.cnf \-extensions v3_usr \e
708 \& \-CA cacert.pem \-CAkey key.pem \-CAcreateserial
711 Set a certificate to be trusted for \s-1SSL\s0 client use and change set its alias to
712 \&\*(L"Steve's Class 1 \s-1CA\*(R"\s0
715 \& openssl x509 \-in cert.pem \-addtrust clientAuth \e
716 \& \-setalias "Steve\*(Aqs Class 1 CA" \-out trust.pem
720 The \s-1PEM\s0 format uses the header and footer lines:
723 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
724 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
727 it will also handle files containing:
730 \& \-\-\-\-\-BEGIN X509 CERTIFICATE\-\-\-\-\-
731 \& \-\-\-\-\-END X509 CERTIFICATE\-\-\-\-\-
734 Trusted certificates have the lines
737 \& \-\-\-\-\-BEGIN TRUSTED CERTIFICATE\-\-\-\-\-
738 \& \-\-\-\-\-END TRUSTED CERTIFICATE\-\-\-\-\-
741 The conversion to \s-1UTF8\s0 format used with the name options assumes that
742 T61Strings use the \s-1ISO8859\-1\s0 character set. This is wrong but Netscape
743 and \s-1MSIE\s0 do this as do many certificates. So although this is incorrect
744 it is more likely to display the majority of certificates correctly.
746 The \fB\-fingerprint\fR option takes the digest of the \s-1DER\s0 encoded certificate.
747 This is commonly called a \*(L"fingerprint\*(R". Because of the nature of message
748 digests the fingerprint of a certificate is unique to that certificate and
749 two certificates with the same fingerprint can be considered to be the same.
751 The Netscape fingerprint uses \s-1MD5\s0 whereas \s-1MSIE\s0 uses \s-1SHA1.\s0
753 The \fB\-email\fR option searches the subject name and the subject alternative
754 name extension. Only unique email addresses will be printed out: it will
755 not print the same address more than once.
756 .SH "CERTIFICATE EXTENSIONS"
757 .IX Header "CERTIFICATE EXTENSIONS"
758 The \fB\-purpose\fR option checks the certificate extensions and determines
759 what the certificate can be used for. The actual checks done are rather
760 complex and include various hacks and workarounds to handle broken
761 certificates and software.
763 The same code is used when verifying untrusted certificates in chains
764 so this section is useful if a chain is rejected by the verify code.
766 The basicConstraints extension \s-1CA\s0 flag is used to determine whether the
767 certificate can be used as a \s-1CA.\s0 If the \s-1CA\s0 flag is true then it is a \s-1CA,\s0
768 if the \s-1CA\s0 flag is false then it is not a \s-1CA. \s0\fBAll\fR CAs should have the
769 \&\s-1CA\s0 flag set to true.
771 If the basicConstraints extension is absent then the certificate is
772 considered to be a \*(L"possible \s-1CA\*(R"\s0 other extensions are checked according
773 to the intended use of the certificate. A warning is given in this case
774 because the certificate should really not be regarded as a \s-1CA:\s0 however
775 it is allowed to be a \s-1CA\s0 to work around some broken software.
777 If the certificate is a V1 certificate (and thus has no extensions) and
778 it is self signed it is also assumed to be a \s-1CA\s0 but a warning is again
779 given: this is to work around the problem of Verisign roots which are V1
780 self signed certificates.
782 If the keyUsage extension is present then additional restraints are
783 made on the uses of the certificate. A \s-1CA\s0 certificate \fBmust\fR have the
784 keyCertSign bit set if the keyUsage extension is present.
786 The extended key usage extension places additional restrictions on the
787 certificate uses. If this extension is present (whether critical or not)
788 the key can only be used for the purposes specified.
790 A complete description of each test is given below. The comments about
791 basicConstraints and keyUsage and V1 certificates above apply to \fBall\fR
792 \&\s-1CA\s0 certificates.
793 .IP "\fB\s-1SSL\s0 Client\fR" 4
794 .IX Item "SSL Client"
795 The extended key usage extension must be absent or include the \*(L"web client
796 authentication\*(R" \s-1OID. \s0 keyUsage must be absent or it must have the
797 digitalSignature bit set. Netscape certificate type must be absent or it must
798 have the \s-1SSL\s0 client bit set.
799 .IP "\fB\s-1SSL\s0 Client \s-1CA\s0\fR" 4
800 .IX Item "SSL Client CA"
801 The extended key usage extension must be absent or include the \*(L"web client
802 authentication\*(R" \s-1OID.\s0 Netscape certificate type must be absent or it must have
803 the \s-1SSL CA\s0 bit set: this is used as a work around if the basicConstraints
805 .IP "\fB\s-1SSL\s0 Server\fR" 4
806 .IX Item "SSL Server"
807 The extended key usage extension must be absent or include the \*(L"web server
808 authentication\*(R" and/or one of the \s-1SGC\s0 OIDs. keyUsage must be absent or it
809 must have the digitalSignature, the keyEncipherment set or both bits set.
810 Netscape certificate type must be absent or have the \s-1SSL\s0 server bit set.
811 .IP "\fB\s-1SSL\s0 Server \s-1CA\s0\fR" 4
812 .IX Item "SSL Server CA"
813 The extended key usage extension must be absent or include the \*(L"web server
814 authentication\*(R" and/or one of the \s-1SGC\s0 OIDs. Netscape certificate type must
815 be absent or the \s-1SSL CA\s0 bit must be set: this is used as a work around if the
816 basicConstraints extension is absent.
817 .IP "\fBNetscape \s-1SSL\s0 Server\fR" 4
818 .IX Item "Netscape SSL Server"
819 For Netscape \s-1SSL\s0 clients to connect to an \s-1SSL\s0 server it must have the
820 keyEncipherment bit set if the keyUsage extension is present. This isn't
821 always valid because some cipher suites use the key for digital signing.
822 Otherwise it is the same as a normal \s-1SSL\s0 server.
823 .IP "\fBCommon S/MIME Client Tests\fR" 4
824 .IX Item "Common S/MIME Client Tests"
825 The extended key usage extension must be absent or include the \*(L"email
826 protection\*(R" \s-1OID.\s0 Netscape certificate type must be absent or should have the
827 S/MIME bit set. If the S/MIME bit is not set in netscape certificate type
828 then the \s-1SSL\s0 client bit is tolerated as an alternative but a warning is shown:
829 this is because some Verisign certificates don't set the S/MIME bit.
830 .IP "\fBS/MIME Signing\fR" 4
831 .IX Item "S/MIME Signing"
832 In addition to the common S/MIME client tests the digitalSignature bit must
833 be set if the keyUsage extension is present.
834 .IP "\fBS/MIME Encryption\fR" 4
835 .IX Item "S/MIME Encryption"
836 In addition to the common S/MIME tests the keyEncipherment bit must be set
837 if the keyUsage extension is present.
838 .IP "\fBS/MIME \s-1CA\s0\fR" 4
840 The extended key usage extension must be absent or include the \*(L"email
841 protection\*(R" \s-1OID.\s0 Netscape certificate type must be absent or must have the
842 S/MIME \s-1CA\s0 bit set: this is used as a work around if the basicConstraints
844 .IP "\fB\s-1CRL\s0 Signing\fR" 4
845 .IX Item "CRL Signing"
846 The keyUsage extension must be absent or it must have the \s-1CRL\s0 signing bit
848 .IP "\fB\s-1CRL\s0 Signing \s-1CA\s0\fR" 4
849 .IX Item "CRL Signing CA"
850 The normal \s-1CA\s0 tests apply. Except in this case the basicConstraints extension
854 Extensions in certificates are not transferred to certificate requests and
857 It is possible to produce invalid certificates or requests by specifying the
858 wrong private key or using inconsistent options in some cases: these should
861 There should be options to explicitly set such things as start and end
862 dates rather than an offset from the current time.
864 The code to implement the verify behaviour described in the \fB\s-1TRUST SETTINGS\s0\fR
865 is currently being developed. It thus describes the intended behaviour rather
866 than the current behaviour. It is hoped that it will represent reality in
867 OpenSSL 0.9.5 and later.
869 .IX Header "SEE ALSO"
870 \&\fIreq\fR\|(1), \fIca\fR\|(1), \fIgenrsa\fR\|(1),
871 \&\fIgendsa\fR\|(1), \fIverify\fR\|(1)
874 Before OpenSSL 0.9.8, the default digest for \s-1RSA\s0 keys was \s-1MD5.\s0
projects / FreeBSD / releng / 9.3.git / blob