[dragonfly.git] / secure / usr.bin / openssl / man / x509.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
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<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
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
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
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.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
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
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
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'
96 .\}
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 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "X509 1"
127 .TH X509 1 "2014-06-05" "1.0.1h" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 x509 \- Certificate display and signing utility
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBx509\fR
137 [\fB\-inform DER|PEM|NET\fR]
138 [\fB\-outform DER|PEM|NET\fR]
139 [\fB\-keyform DER|PEM\fR]
140 [\fB\-CAform DER|PEM\fR]
141 [\fB\-CAkeyform DER|PEM\fR]
142 [\fB\-in filename\fR]
143 [\fB\-out filename\fR]
144 [\fB\-serial\fR]
145 [\fB\-hash\fR]
146 [\fB\-subject_hash\fR]
147 [\fB\-issuer_hash\fR]
148 [\fB\-subject\fR]
149 [\fB\-issuer\fR]
150 [\fB\-nameopt option\fR]
151 [\fB\-email\fR]
152 [\fB\-ocsp_uri\fR]
153 [\fB\-startdate\fR]
154 [\fB\-enddate\fR]
155 [\fB\-purpose\fR]
156 [\fB\-dates\fR]
157 [\fB\-modulus\fR]
158 [\fB\-pubkey\fR]
159 [\fB\-fingerprint\fR]
160 [\fB\-alias\fR]
161 [\fB\-noout\fR]
162 [\fB\-trustout\fR]
163 [\fB\-clrtrust\fR]
164 [\fB\-clrreject\fR]
165 [\fB\-addtrust arg\fR]
166 [\fB\-addreject arg\fR]
167 [\fB\-setalias arg\fR]
168 [\fB\-days arg\fR]
169 [\fB\-set_serial n\fR]
170 [\fB\-signkey filename\fR]
171 [\fB\-x509toreq\fR]
172 [\fB\-req\fR]
173 [\fB\-CA filename\fR]
174 [\fB\-CAkey filename\fR]
175 [\fB\-CAcreateserial\fR]
176 [\fB\-CAserial filename\fR]
177 [\fB\-text\fR]
178 [\fB\-C\fR]
179 [\fB\-md2|\-md5|\-sha1|\-mdc2\fR]
180 [\fB\-clrext\fR]
181 [\fB\-extfile filename\fR]
182 [\fB\-extensions section\fR]
183 [\fB\-engine id\fR]
185 .IX Header "DESCRIPTION"
186 The \fBx509\fR command is a multi purpose certificate utility. It can be
187 used to display certificate information, convert certificates to
188 various forms, sign certificate requests like a \*(L"mini \s-1CA\s0\*(R" or edit
189 certificate trust settings.
190 .PP
191 Since there are a large number of options they will split up into
192 various sections.
194 .IX Header "OPTIONS"
195 .SS "\s-1INPUT\s0, \s-1OUTPUT\s0 \s-1AND\s0 \s-1GENERAL\s0 \s-1PURPOSE\s0 \s-1OPTIONS\s0"
197 .IP "\fB\-inform DER|PEM|NET\fR" 4
198 .IX Item "-inform DER|PEM|NET"
199 This specifies the input format normally the command will expect an X509
200 certificate but this can change if other options such as \fB\-req\fR are
201 present. The \s-1DER\s0 format is the \s-1DER\s0 encoding of the certificate and \s-1PEM\s0
202 is the base64 encoding of the \s-1DER\s0 encoding with header and footer lines
203 added. The \s-1NET\s0 option is an obscure Netscape server format that is now
204 obsolete.
205 .IP "\fB\-outform DER|PEM|NET\fR" 4
206 .IX Item "-outform DER|PEM|NET"
207 This specifies the output format, the options have the same meaning as the 
208 \&\fB\-inform\fR option.
209 .IP "\fB\-in filename\fR" 4
210 .IX Item "-in filename"
211 This specifies the input filename to read a certificate from or standard input
212 if this option is not specified.
213 .IP "\fB\-out filename\fR" 4
214 .IX Item "-out filename"
215 This specifies the output filename to write to or standard output by
216 default.
217 .IP "\fB\-md2|\-md5|\-sha1|\-mdc2\fR" 4
218 .IX Item "-md2|-md5|-sha1|-mdc2"
219 the digest to use. This affects any signing or display option that uses a message
220 digest, such as the \fB\-fingerprint\fR, \fB\-signkey\fR and \fB\-CA\fR options. If not
221 specified then \s-1SHA1\s0 is used. If the key being used to sign with is a \s-1DSA\s0 key
222 then this option has no effect: \s-1SHA1\s0 is always used with \s-1DSA\s0 keys.
223 .IP "\fB\-engine id\fR" 4
224 .IX Item "-engine id"
225 specifying an engine (by its unique \fBid\fR string) will cause \fBx509\fR
226 to attempt to obtain a functional reference to the specified engine,
227 thus initialising it if needed. The engine will then be set as the default
228 for all available algorithms.
229 .SS "\s-1DISPLAY\s0 \s-1OPTIONS\s0"
230 .IX Subsection "DISPLAY OPTIONS"
231 Note: the \fB\-alias\fR and \fB\-purpose\fR options are also display options
232 but are described in the \fB\s-1TRUST\s0 \s-1SETTINGS\s0\fR section.
233 .IP "\fB\-text\fR" 4
234 .IX Item "-text"
235 prints out the certificate in text form. Full details are output including the
236 public key, signature algorithms, issuer and subject names, serial number
237 any extensions present and any trust settings.
238 .IP "\fB\-certopt option\fR" 4
239 .IX Item "-certopt option"
240 customise the output format used with \fB\-text\fR. The \fBoption\fR argument can be
241 a single option or multiple options separated by commas. The \fB\-certopt\fR switch
242 may be also be used more than once to set multiple options. See the \fB\s-1TEXT\s0 \s-1OPTIONS\s0\fR
243 section for more information.
244 .IP "\fB\-noout\fR" 4
245 .IX Item "-noout"
246 this option prevents output of the encoded version of the request.
247 .IP "\fB\-pubkey\fR" 4
248 .IX Item "-pubkey"
249 outputs the the certificate's SubjectPublicKeyInfo block in \s-1PEM\s0 format.
250 .IP "\fB\-modulus\fR" 4
251 .IX Item "-modulus"
252 this option prints out the value of the modulus of the public key
253 contained in the certificate.
254 .IP "\fB\-serial\fR" 4
255 .IX Item "-serial"
256 outputs the certificate serial number.
257 .IP "\fB\-subject_hash\fR" 4
258 .IX Item "-subject_hash"
259 outputs the \*(L"hash\*(R" of the certificate subject name. This is used in OpenSSL to
260 form an index to allow certificates in a directory to be looked up by subject
261 name.
262 .IP "\fB\-issuer_hash\fR" 4
263 .IX Item "-issuer_hash"
264 outputs the \*(L"hash\*(R" of the certificate issuer name.
265 .IP "\fB\-hash\fR" 4
266 .IX Item "-hash"
267 synonym for \*(L"\-subject_hash\*(R" for backward compatibility reasons.
268 .IP "\fB\-subject_hash_old\fR" 4
269 .IX Item "-subject_hash_old"
270 outputs the \*(L"hash\*(R" of the certificate subject name using the older algorithm
271 as used by OpenSSL versions before 1.0.0.
272 .IP "\fB\-issuer_hash_old\fR" 4
273 .IX Item "-issuer_hash_old"
274 outputs the \*(L"hash\*(R" of the certificate issuer name using the older algorithm
275 as used by OpenSSL versions before 1.0.0.
276 .IP "\fB\-subject\fR" 4
277 .IX Item "-subject"
278 outputs the subject name.
279 .IP "\fB\-issuer\fR" 4
280 .IX Item "-issuer"
281 outputs the issuer name.
282 .IP "\fB\-nameopt option\fR" 4
283 .IX Item "-nameopt option"
284 option which determines how the subject or issuer names are displayed. The
285 \&\fBoption\fR argument can be a single option or multiple options separated by
286 commas.  Alternatively the \fB\-nameopt\fR switch may be used more than once to
287 set multiple options. See the \fB\s-1NAME\s0 \s-1OPTIONS\s0\fR section for more information.
288 .IP "\fB\-email\fR" 4
289 .IX Item "-email"
290 outputs the email address(es) if any.
291 .IP "\fB\-ocsp_uri\fR" 4
292 .IX Item "-ocsp_uri"
293 outputs the \s-1OCSP\s0 responder 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
298 .IX Item "-enddate"
299 prints out the expiry date of the certificate, that is the notAfter date.
300 .IP "\fB\-dates\fR" 4
301 .IX Item "-dates"
302 prints out the start and expiry dates of a certificate.
303 .IP "\fB\-fingerprint\fR" 4
304 .IX Item "-fingerprint"
305 prints out the digest of the \s-1DER\s0 encoded version of the whole certificate
306 (see digest options).
307 .IP "\fB\-C\fR" 4
308 .IX Item "-C"
309 this outputs the certificate in the form of a C source file.
310 .SS "\s-1TRUST\s0 \s-1SETTINGS\s0"
311 .IX Subsection "TRUST SETTINGS"
312 Please note these options are currently experimental and may well change.
313 .PP
314 A \fBtrusted certificate\fR is an ordinary certificate which has several
315 additional pieces of information attached to it such as the permitted
316 and prohibited uses of the certificate and an \*(L"alias\*(R".
317 .PP
318 Normally when a certificate is being verified at least one certificate
319 must be \*(L"trusted\*(R". By default a trusted certificate must be stored
320 locally and must be a root \s-1CA:\s0 any certificate chain ending in this \s-1CA\s0
321 is then usable for any purpose.
322 .PP
323 Trust settings currently are only used with a root \s-1CA\s0. They allow a finer
324 control over the purposes the root \s-1CA\s0 can be used for. For example a \s-1CA\s0
325 may be trusted for \s-1SSL\s0 client but not \s-1SSL\s0 server use.
326 .PP
327 See the description of the \fBverify\fR utility for more information on the
328 meaning of trust settings.
329 .PP
330 Future versions of OpenSSL will recognize trust settings on any
331 certificate: not just root CAs.
332 .IP "\fB\-trustout\fR" 4
333 .IX Item "-trustout"
334 this causes \fBx509\fR to output a \fBtrusted\fR certificate. An ordinary
335 or trusted certificate can be input but by default an ordinary
336 certificate is output and any trust settings are discarded. With the
337 \&\fB\-trustout\fR option a trusted certificate is output. A trusted
338 certificate is automatically output if any trust settings are modified.
339 .IP "\fB\-setalias arg\fR" 4
340 .IX Item "-setalias arg"
341 sets the alias of the certificate. This will allow the certificate
342 to be referred to using a nickname for example \*(L"Steve's Certificate\*(R".
343 .IP "\fB\-alias\fR" 4
344 .IX Item "-alias"
345 outputs the certificate alias, if any.
346 .IP "\fB\-clrtrust\fR" 4
347 .IX Item "-clrtrust"
348 clears all the permitted or trusted uses of the certificate.
349 .IP "\fB\-clrreject\fR" 4
350 .IX Item "-clrreject"
351 clears all the prohibited or rejected uses of the certificate.
352 .IP "\fB\-addtrust arg\fR" 4
353 .IX Item "-addtrust arg"
354 adds a trusted certificate use. Any object name can be used here
355 but currently only \fBclientAuth\fR (\s-1SSL\s0 client use), \fBserverAuth\fR
356 (\s-1SSL\s0 server use) and \fBemailProtection\fR (S/MIME email) are used.
357 Other OpenSSL applications may define additional uses.
358 .IP "\fB\-addreject arg\fR" 4
359 .IX Item "-addreject arg"
360 adds a prohibited use. It accepts the same values as the \fB\-addtrust\fR
361 option.
362 .IP "\fB\-purpose\fR" 4
363 .IX Item "-purpose"
364 this option performs tests on the certificate extensions and outputs
365 the results. For a more complete description see the \fB\s-1CERTIFICATE\s0
366 \&\s-1EXTENSIONS\s0\fR section.
367 .SS "\s-1SIGNING\s0 \s-1OPTIONS\s0"
368 .IX Subsection "SIGNING OPTIONS"
369 The \fBx509\fR utility can be used to sign certificates and requests: it
370 can thus behave like a \*(L"mini \s-1CA\s0\*(R".
371 .IP "\fB\-signkey filename\fR" 4
372 .IX Item "-signkey filename"
373 this option causes the input file to be self signed using the supplied
374 private key.
375 .Sp
376 If the input file is a certificate it sets the issuer name to the
377 subject name (i.e.  makes it self signed) changes the public key to the
378 supplied value and changes the start and end dates. The start date is
379 set to the current time and the end date is set to a value determined
380 by the \fB\-days\fR option. Any certificate extensions are retained unless
381 the \fB\-clrext\fR option is supplied.
382 .Sp
383 If the input is a certificate request then a self signed certificate
384 is created using the supplied private key using the subject name in
385 the request.
386 .IP "\fB\-clrext\fR" 4
387 .IX Item "-clrext"
388 delete any extensions from a certificate. This option is used when a
389 certificate is being created from another certificate (for example with
390 the \fB\-signkey\fR or the \fB\-CA\fR options). Normally all extensions are
391 retained.
392 .IP "\fB\-keyform PEM|DER\fR" 4
393 .IX Item "-keyform PEM|DER"
394 specifies the format (\s-1DER\s0 or \s-1PEM\s0) of the private key file used in the
395 \&\fB\-signkey\fR option.
396 .IP "\fB\-days arg\fR" 4
397 .IX Item "-days arg"
398 specifies the number of days to make a certificate valid for. The default
399 is 30 days.
400 .IP "\fB\-x509toreq\fR" 4
401 .IX Item "-x509toreq"
402 converts a certificate into a certificate request. The \fB\-signkey\fR option
403 is used to pass the required private key.
404 .IP "\fB\-req\fR" 4
405 .IX Item "-req"
406 by default a certificate is expected on input. With this option a
407 certificate request is expected instead.
408 .IP "\fB\-set_serial n\fR" 4
409 .IX Item "-set_serial n"
410 specifies the serial number to use. This option can be used with either
411 the \fB\-signkey\fR or \fB\-CA\fR options. If used in conjunction with the \fB\-CA\fR
412 option the serial number file (as specified by the \fB\-CAserial\fR or
413 \&\fB\-CAcreateserial\fR options) is not used.
414 .Sp
415 The serial number can be decimal or hex (if preceded by \fB0x\fR). Negative
416 serial numbers can also be specified but their use is not recommended.
417 .IP "\fB\-CA filename\fR" 4
418 .IX Item "-CA filename"
419 specifies the \s-1CA\s0 certificate to be used for signing. When this option is
420 present \fBx509\fR behaves like a \*(L"mini \s-1CA\s0\*(R". The input file is signed by this
421 \&\s-1CA\s0 using this option: that is its issuer name is set to the subject name
422 of the \s-1CA\s0 and it is digitally signed using the CAs private key.
423 .Sp
424 This option is normally combined with the \fB\-req\fR option. Without the
425 \&\fB\-req\fR option the input is a certificate which must be self signed.
426 .IP "\fB\-CAkey filename\fR" 4
427 .IX Item "-CAkey filename"
428 sets the \s-1CA\s0 private key to sign a certificate with. If this option is
429 not specified then it is assumed that the \s-1CA\s0 private key is present in
430 the \s-1CA\s0 certificate file.
431 .IP "\fB\-CAserial filename\fR" 4
432 .IX Item "-CAserial filename"
433 sets the \s-1CA\s0 serial number file to use.
434 .Sp
435 When the \fB\-CA\fR option is used to sign a certificate it uses a serial
436 number specified in a file. This file consist of one line containing
437 an even number of hex digits with the serial number to use. After each
438 use the serial number is incremented and written out to the file again.
439 .Sp
440 The default filename consists of the \s-1CA\s0 certificate file base name with
441 \&\*(L".srl\*(R" appended. For example if the \s-1CA\s0 certificate file is called 
442 \&\*(L"mycacert.pem\*(R" it expects to find a serial number file called \*(L"mycacert.srl\*(R".
443 .IP "\fB\-CAcreateserial\fR" 4
444 .IX Item "-CAcreateserial"
445 with this option the \s-1CA\s0 serial number file is created if it does not exist:
446 it will contain the serial number \*(L"02\*(R" and the certificate being signed will
447 have the 1 as its serial number. Normally if the \fB\-CA\fR option is specified
448 and the serial number file does not exist it is an error.
449 .IP "\fB\-extfile filename\fR" 4
450 .IX Item "-extfile filename"
451 file containing certificate extensions to use. If not specified then
452 no extensions are added to the certificate.
453 .IP "\fB\-extensions section\fR" 4
454 .IX Item "-extensions section"
455 the section to add certificate extensions from. If this option is not
456 specified then the extensions should either be contained in the unnamed
457 (default) section or the default section should contain a variable called
458 \&\*(L"extensions\*(R" which contains the section to use. See the
459 \&\fIx509v3_config\fR\|(5) manual page for details of the
460 extension section format.
461 .SS "\s-1NAME\s0 \s-1OPTIONS\s0"
462 .IX Subsection "NAME OPTIONS"
463 The \fBnameopt\fR command line switch determines how the subject and issuer
464 names are displayed. If no \fBnameopt\fR switch is present the default \*(L"oneline\*(R"
465 format is used which is compatible with previous versions of OpenSSL.
466 Each option is described in detail below, all options can be preceded by
467 a \fB\-\fR to turn the option off. Only the first four will normally be used.
468 .IP "\fBcompat\fR" 4
469 .IX Item "compat"
470 use the old format. This is equivalent to specifying no name options at all.
471 .IP "\fB\s-1RFC2253\s0\fR" 4
472 .IX Item "RFC2253"
473 displays names compatible with \s-1RFC2253\s0 equivalent to \fBesc_2253\fR, \fBesc_ctrl\fR,
474 \&\fBesc_msb\fR, \fButf8\fR, \fBdump_nostr\fR, \fBdump_unknown\fR, \fBdump_der\fR,
475 \&\fBsep_comma_plus\fR, \fBdn_rev\fR and \fBsname\fR.
476 .IP "\fBoneline\fR" 4
477 .IX Item "oneline"
478 a oneline format which is more readable than \s-1RFC2253\s0. It is equivalent to
479 specifying the  \fBesc_2253\fR, \fBesc_ctrl\fR, \fBesc_msb\fR, \fButf8\fR, \fBdump_nostr\fR,
480 \&\fBdump_der\fR, \fBuse_quote\fR, \fBsep_comma_plus_space\fR, \fBspace_eq\fR and \fBsname\fR
481 options.
482 .IP "\fBmultiline\fR" 4
483 .IX Item "multiline"
484 a multiline format. It is equivalent \fBesc_ctrl\fR, \fBesc_msb\fR, \fBsep_multiline\fR,
485 \&\fBspace_eq\fR, \fBlname\fR and \fBalign\fR.
486 .IP "\fBesc_2253\fR" 4
487 .IX Item "esc_2253"
488 escape the \*(L"special\*(R" characters required by \s-1RFC2253\s0 in a field That is
489 \&\fB,+"<>;\fR. Additionally \fB#\fR is escaped at the beginning of a string
490 and a space character at the beginning or end of a string.
491 .IP "\fBesc_ctrl\fR" 4
492 .IX Item "esc_ctrl"
493 escape control characters. That is those with \s-1ASCII\s0 values less than
494 0x20 (space) and the delete (0x7f) character. They are escaped using the
495 \&\s-1RFC2253\s0 \eXX notation (where \s-1XX\s0 are two hex digits representing the
496 character value).
497 .IP "\fBesc_msb\fR" 4
498 .IX Item "esc_msb"
499 escape characters with the \s-1MSB\s0 set, that is with \s-1ASCII\s0 values larger than
500 127.
501 .IP "\fBuse_quote\fR" 4
502 .IX Item "use_quote"
503 escapes some characters by surrounding the whole string with \fB"\fR characters,
504 without the option all escaping is done with the \fB\e\fR character.
505 .IP "\fButf8\fR" 4
506 .IX Item "utf8"
507 convert all strings to \s-1UTF8\s0 format first. This is required by \s-1RFC2253\s0. If
508 you are lucky enough to have a \s-1UTF8\s0 compatible terminal then the use
509 of this option (and \fBnot\fR setting \fBesc_msb\fR) may result in the correct
510 display of multibyte (international) characters. Is this option is not
511 present then multibyte characters larger than 0xff will be represented
512 using the format \eUXXXX for 16 bits and \eWXXXXXXXX for 32 bits.
513 Also if this option is off any UTF8Strings will be converted to their
514 character form first.
515 .IP "\fBno_type\fR" 4
516 .IX Item "no_type"
517 this option does not attempt to interpret multibyte characters in any
518 way. That is their content octets are merely dumped as though one octet
519 represents each character. This is useful for diagnostic purposes but
520 will result in rather odd looking output.
521 .IP "\fBshow_type\fR" 4
522 .IX Item "show_type"
523 show the type of the \s-1ASN1\s0 character string. The type precedes the
524 field contents. For example \*(L"\s-1BMPSTRING:\s0 Hello World\*(R".
525 .IP "\fBdump_der\fR" 4
526 .IX Item "dump_der"
527 when this option is set any fields that need to be hexdumped will
528 be dumped using the \s-1DER\s0 encoding of the field. Otherwise just the
529 content octets will be displayed. Both options use the \s-1RFC2253\s0
530 \&\fB#XXXX...\fR format.
531 .IP "\fBdump_nostr\fR" 4
532 .IX Item "dump_nostr"
533 dump non character string types (for example \s-1OCTET\s0 \s-1STRING\s0) if this
534 option is not set then non character string types will be displayed
535 as though each content octet represents a single character.
536 .IP "\fBdump_all\fR" 4
537 .IX Item "dump_all"
538 dump all fields. This option when used with \fBdump_der\fR allows the
539 \&\s-1DER\s0 encoding of the structure to be unambiguously determined.
540 .IP "\fBdump_unknown\fR" 4
541 .IX Item "dump_unknown"
542 dump any field whose \s-1OID\s0 is not recognised by OpenSSL.
543 .IP "\fBsep_comma_plus\fR, \fBsep_comma_plus_space\fR, \fBsep_semi_plus_space\fR, \fBsep_multiline\fR" 4
544 .IX Item "sep_comma_plus, sep_comma_plus_space, sep_semi_plus_space, sep_multiline"
545 these options determine the field separators. The first character is
546 between RDNs and the second between multiple AVAs (multiple AVAs are
547 very rare and their use is discouraged). The options ending in
548 \&\*(L"space\*(R" additionally place a space after the separator to make it
549 more readable. The \fBsep_multiline\fR uses a linefeed character for
550 the \s-1RDN\s0 separator and a spaced \fB+\fR for the \s-1AVA\s0 separator. It also
551 indents the fields by four characters.
552 .IP "\fBdn_rev\fR" 4
553 .IX Item "dn_rev"
554 reverse the fields of the \s-1DN\s0. This is required by \s-1RFC2253\s0. As a side
555 effect this also reverses the order of multiple AVAs but this is
556 permissible.
557 .IP "\fBnofname\fR, \fBsname\fR, \fBlname\fR, \fBoid\fR" 4
558 .IX Item "nofname, sname, lname, oid"
559 these options alter how the field name is displayed. \fBnofname\fR does
560 not display the field at all. \fBsname\fR uses the \*(L"short name\*(R" form
561 (\s-1CN\s0 for commonName for example). \fBlname\fR uses the long form.
562 \&\fBoid\fR represents the \s-1OID\s0 in numerical form and is useful for
563 diagnostic purpose.
564 .IP "\fBalign\fR" 4
565 .IX Item "align"
566 align field values for a more readable output. Only usable with
567 \&\fBsep_multiline\fR.
568 .IP "\fBspace_eq\fR" 4
569 .IX Item "space_eq"
570 places spaces round the \fB=\fR character which follows the field
571 name.
572 .SS "\s-1TEXT\s0 \s-1OPTIONS\s0"
573 .IX Subsection "TEXT OPTIONS"
574 As well as customising the name output format, it is also possible to
575 customise the actual fields printed using the \fBcertopt\fR options when
576 the \fBtext\fR option is present. The default behaviour is to print all fields.
577 .IP "\fBcompatible\fR" 4
578 .IX Item "compatible"
579 use the old format. This is equivalent to specifying no output options at all.
580 .IP "\fBno_header\fR" 4
581 .IX Item "no_header"
582 don't print header information: that is the lines saying \*(L"Certificate\*(R" and \*(L"Data\*(R".
583 .IP "\fBno_version\fR" 4
584 .IX Item "no_version"
585 don't print out the version number.
586 .IP "\fBno_serial\fR" 4
587 .IX Item "no_serial"
588 don't print out the serial number.
589 .IP "\fBno_signame\fR" 4
590 .IX Item "no_signame"
591 don't print out the signature algorithm used.
592 .IP "\fBno_validity\fR" 4
593 .IX Item "no_validity"
594 don't print the validity, that is the \fBnotBefore\fR and \fBnotAfter\fR fields.
595 .IP "\fBno_subject\fR" 4
596 .IX Item "no_subject"
597 don't print out the subject name.
598 .IP "\fBno_issuer\fR" 4
599 .IX Item "no_issuer"
600 don't print out the issuer name.
601 .IP "\fBno_pubkey\fR" 4
602 .IX Item "no_pubkey"
603 don't print out the public key.
604 .IP "\fBno_sigdump\fR" 4
605 .IX Item "no_sigdump"
606 don't give a hexadecimal dump of the certificate signature.
607 .IP "\fBno_aux\fR" 4
608 .IX Item "no_aux"
609 don't print out certificate trust information.
610 .IP "\fBno_extensions\fR" 4
611 .IX Item "no_extensions"
612 don't print out any X509V3 extensions.
613 .IP "\fBext_default\fR" 4
614 .IX Item "ext_default"
615 retain default extension behaviour: attempt to print out unsupported certificate extensions.
616 .IP "\fBext_error\fR" 4
617 .IX Item "ext_error"
618 print an error message for unsupported certificate extensions.
619 .IP "\fBext_parse\fR" 4
620 .IX Item "ext_parse"
621 \&\s-1ASN1\s0 parse unsupported extensions.
622 .IP "\fBext_dump\fR" 4
623 .IX Item "ext_dump"
624 hex dump unsupported extensions.
625 .IP "\fBca_default\fR" 4
626 .IX Item "ca_default"
627 the value used by the \fBca\fR utility, equivalent to \fBno_issuer\fR, \fBno_pubkey\fR, \fBno_header\fR,
628 \&\fBno_version\fR, \fBno_sigdump\fR and \fBno_signame\fR.
630 .IX Header "EXAMPLES"
631 Note: in these examples the '\e' means the example should be all on one
632 line.
633 .PP
634 Display the contents of a certificate:
635 .PP
636 .Vb 1
637 \& openssl x509 \-in cert.pem \-noout \-text
638 .Ve
639 .PP
640 Display the certificate serial number:
641 .PP
642 .Vb 1
643 \& openssl x509 \-in cert.pem \-noout \-serial
644 .Ve
645 .PP
646 Display the certificate subject name:
647 .PP
648 .Vb 1
649 \& openssl x509 \-in cert.pem \-noout \-subject
650 .Ve
651 .PP
652 Display the certificate subject name in \s-1RFC2253\s0 form:
653 .PP
654 .Vb 1
655 \& openssl x509 \-in cert.pem \-noout \-subject \-nameopt RFC2253
656 .Ve
657 .PP
658 Display the certificate subject name in oneline form on a terminal
659 supporting \s-1UTF8:\s0
660 .PP
661 .Vb 1
662 \& openssl x509 \-in cert.pem \-noout \-subject \-nameopt oneline,\-esc_msb
663 .Ve
664 .PP
665 Display the certificate \s-1MD5\s0 fingerprint:
666 .PP
667 .Vb 1
668 \& openssl x509 \-in cert.pem \-noout \-fingerprint
669 .Ve
670 .PP
671 Display the certificate \s-1SHA1\s0 fingerprint:
672 .PP
673 .Vb 1
674 \& openssl x509 \-sha1 \-in cert.pem \-noout \-fingerprint
675 .Ve
676 .PP
677 Convert a certificate from \s-1PEM\s0 to \s-1DER\s0 format:
678 .PP
679 .Vb 1
680 \& openssl x509 \-in cert.pem \-inform PEM \-out cert.der \-outform DER
681 .Ve
682 .PP
683 Convert a certificate to a certificate request:
684 .PP
685 .Vb 1
686 \& openssl x509 \-x509toreq \-in cert.pem \-out req.pem \-signkey key.pem
687 .Ve
688 .PP
689 Convert a certificate request into a self signed certificate using
690 extensions for a \s-1CA:\s0
691 .PP
692 .Vb 2
693 \& openssl x509 \-req \-in careq.pem \-extfile openssl.cnf \-extensions v3_ca \e
694 \&        \-signkey key.pem \-out cacert.pem
695 .Ve
696 .PP
697 Sign a certificate request using the \s-1CA\s0 certificate above and add user
698 certificate extensions:
699 .PP
700 .Vb 2
701 \& openssl x509 \-req \-in req.pem \-extfile openssl.cnf \-extensions v3_usr \e
702 \&        \-CA cacert.pem \-CAkey key.pem \-CAcreateserial
703 .Ve
704 .PP
705 Set a certificate to be trusted for \s-1SSL\s0 client use and change set its alias to
706 \&\*(L"Steve's Class 1 \s-1CA\s0\*(R"
707 .PP
708 .Vb 2
709 \& openssl x509 \-in cert.pem \-addtrust clientAuth \e
710 \&        \-setalias "Steve\*(Aqs Class 1 CA" \-out trust.pem
711 .Ve
712 .SH "NOTES"
713 .IX Header "NOTES"
714 The \s-1PEM\s0 format uses the header and footer lines:
715 .PP
716 .Vb 2
717 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
718 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
719 .Ve
720 .PP
721 it will also handle files containing:
722 .PP
723 .Vb 2
724 \& \-\-\-\-\-BEGIN X509 CERTIFICATE\-\-\-\-\-
725 \& \-\-\-\-\-END X509 CERTIFICATE\-\-\-\-\-
726 .Ve
727 .PP
728 Trusted certificates have the lines
729 .PP
730 .Vb 2
731 \& \-\-\-\-\-BEGIN TRUSTED CERTIFICATE\-\-\-\-\-
732 \& \-\-\-\-\-END TRUSTED CERTIFICATE\-\-\-\-\-
733 .Ve
734 .PP
735 The conversion to \s-1UTF8\s0 format used with the name options assumes that
736 T61Strings use the \s-1ISO8859\-1\s0 character set. This is wrong but Netscape
737 and \s-1MSIE\s0 do this as do many certificates. So although this is incorrect
738 it is more likely to display the majority of certificates correctly.
739 .PP
740 The \fB\-fingerprint\fR option takes the digest of the \s-1DER\s0 encoded certificate.
741 This is commonly called a \*(L"fingerprint\*(R". Because of the nature of message
742 digests the fingerprint of a certificate is unique to that certificate and
743 two certificates with the same fingerprint can be considered to be the same.
744 .PP
745 The Netscape fingerprint uses \s-1MD5\s0 whereas \s-1MSIE\s0 uses \s-1SHA1\s0.
746 .PP
747 The \fB\-email\fR option searches the subject name and the subject alternative
748 name extension. Only unique email addresses will be printed out: it will
749 not print the same address more than once.
752 The \fB\-purpose\fR option checks the certificate extensions and determines
753 what the certificate can be used for. The actual checks done are rather
754 complex and include various hacks and workarounds to handle broken
755 certificates and software.
756 .PP
757 The same code is used when verifying untrusted certificates in chains
758 so this section is useful if a chain is rejected by the verify code.
759 .PP
760 The basicConstraints extension \s-1CA\s0 flag is used to determine whether the
761 certificate can be used as a \s-1CA\s0. If the \s-1CA\s0 flag is true then it is a \s-1CA\s0,
762 if the \s-1CA\s0 flag is false then it is not a \s-1CA\s0. \fBAll\fR CAs should have the
763 \&\s-1CA\s0 flag set to true.
764 .PP
765 If the basicConstraints extension is absent then the certificate is
766 considered to be a \*(L"possible \s-1CA\s0\*(R" other extensions are checked according
767 to the intended use of the certificate. A warning is given in this case
768 because the certificate should really not be regarded as a \s-1CA:\s0 however
769 it is allowed to be a \s-1CA\s0 to work around some broken software.
770 .PP
771 If the certificate is a V1 certificate (and thus has no extensions) and
772 it is self signed it is also assumed to be a \s-1CA\s0 but a warning is again
773 given: this is to work around the problem of Verisign roots which are V1
774 self signed certificates.
775 .PP
776 If the keyUsage extension is present then additional restraints are
777 made on the uses of the certificate. A \s-1CA\s0 certificate \fBmust\fR have the
778 keyCertSign bit set if the keyUsage extension is present.
779 .PP
780 The extended key usage extension places additional restrictions on the
781 certificate uses. If this extension is present (whether critical or not)
782 the key can only be used for the purposes specified.
783 .PP
784 A complete description of each test is given below. The comments about
785 basicConstraints and keyUsage and V1 certificates above apply to \fBall\fR
786 \&\s-1CA\s0 certificates.
787 .IP "\fB\s-1SSL\s0 Client\fR" 4
788 .IX Item "SSL Client"
789 The extended key usage extension must be absent or include the \*(L"web client
790 authentication\*(R" \s-1OID\s0.  keyUsage must be absent or it must have the
791 digitalSignature bit set. Netscape certificate type must be absent or it must
792 have the \s-1SSL\s0 client bit set.
793 .IP "\fB\s-1SSL\s0 Client \s-1CA\s0\fR" 4
794 .IX Item "SSL Client CA"
795 The extended key usage extension must be absent or include the \*(L"web client
796 authentication\*(R" \s-1OID\s0. Netscape certificate type must be absent or it must have
797 the \s-1SSL\s0 \s-1CA\s0 bit set: this is used as a work around if the basicConstraints
798 extension is absent.
799 .IP "\fB\s-1SSL\s0 Server\fR" 4
800 .IX Item "SSL Server"
801 The extended key usage extension must be absent or include the \*(L"web server
802 authentication\*(R" and/or one of the \s-1SGC\s0 OIDs.  keyUsage must be absent or it
803 must have the digitalSignature, the keyEncipherment set or both bits set.
804 Netscape certificate type must be absent or have the \s-1SSL\s0 server bit set.
805 .IP "\fB\s-1SSL\s0 Server \s-1CA\s0\fR" 4
806 .IX Item "SSL Server CA"
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.  Netscape certificate type must
809 be absent or the \s-1SSL\s0 \s-1CA\s0 bit must be set: this is used as a work around if the
810 basicConstraints extension is absent.
811 .IP "\fBNetscape \s-1SSL\s0 Server\fR" 4
812 .IX Item "Netscape SSL Server"
813 For Netscape \s-1SSL\s0 clients to connect to an \s-1SSL\s0 server it must have the
814 keyEncipherment bit set if the keyUsage extension is present. This isn't
815 always valid because some cipher suites use the key for digital signing.
816 Otherwise it is the same as a normal \s-1SSL\s0 server.
817 .IP "\fBCommon S/MIME Client Tests\fR" 4
818 .IX Item "Common S/MIME Client Tests"
819 The extended key usage extension must be absent or include the \*(L"email
820 protection\*(R" \s-1OID\s0. Netscape certificate type must be absent or should have the
821 S/MIME bit set. If the S/MIME bit is not set in netscape certificate type
822 then the \s-1SSL\s0 client bit is tolerated as an alternative but a warning is shown:
823 this is because some Verisign certificates don't set the S/MIME bit.
824 .IP "\fBS/MIME Signing\fR" 4
825 .IX Item "S/MIME Signing"
826 In addition to the common S/MIME client tests the digitalSignature bit must
827 be set if the keyUsage extension is present.
828 .IP "\fBS/MIME Encryption\fR" 4
829 .IX Item "S/MIME Encryption"
830 In addition to the common S/MIME tests the keyEncipherment bit must be set
831 if the keyUsage extension is present.
832 .IP "\fBS/MIME \s-1CA\s0\fR" 4
833 .IX Item "S/MIME CA"
834 The extended key usage extension must be absent or include the \*(L"email
835 protection\*(R" \s-1OID\s0. Netscape certificate type must be absent or must have the
836 S/MIME \s-1CA\s0 bit set: this is used as a work around if the basicConstraints
837 extension is absent.
838 .IP "\fB\s-1CRL\s0 Signing\fR" 4
839 .IX Item "CRL Signing"
840 The keyUsage extension must be absent or it must have the \s-1CRL\s0 signing bit
841 set.
842 .IP "\fB\s-1CRL\s0 Signing \s-1CA\s0\fR" 4
843 .IX Item "CRL Signing CA"
844 The normal \s-1CA\s0 tests apply. Except in this case the basicConstraints extension
845 must be present.
846 .SH "BUGS"
847 .IX Header "BUGS"
848 Extensions in certificates are not transferred to certificate requests and
849 vice versa.
850 .PP
851 It is possible to produce invalid certificates or requests by specifying the
852 wrong private key or using inconsistent options in some cases: these should
853 be checked.
854 .PP
855 There should be options to explicitly set such things as start and end
856 dates rather than an offset from the current time.
857 .PP
858 The code to implement the verify behaviour described in the \fB\s-1TRUST\s0 \s-1SETTINGS\s0\fR
859 is currently being developed. It thus describes the intended behaviour rather
860 than the current behaviour. It is hoped that it will represent reality in
861 OpenSSL 0.9.5 and later.
862 .SH "SEE ALSO"
863 .IX Header "SEE ALSO"
864 \&\fIreq\fR\|(1), \fIca\fR\|(1), \fIgenrsa\fR\|(1),
865 \&\fIgendsa\fR\|(1), \fIverify\fR\|(1),
866 \&\fIx509v3_config\fR\|(5)
868 .IX Header "HISTORY"
869 Before OpenSSL 0.9.8, the default digest for \s-1RSA\s0 keys was \s-1MD5\s0.
870 .PP
871 The hash algorithm used in the \fB\-subject_hash\fR and \fB\-issuer_hash\fR options
872 before OpenSSL 1.0.0 was based on the deprecated \s-1MD5\s0 algorithm and the encoding
873 of the distinguished name. In OpenSSL 1.0.0 and later it is based on a
874 canonical version of the \s-1DN\s0 using \s-1SHA1\s0. This means that any directories using
875 the old form must have their links rebuilt using \fBc_rehash\fR or similar.