7e2036e65a6e44a3ac63c3671a01d8adf7c2c27e
[openssl.git] / doc / man / x509.pod
1
2 =pod
3
4 =head1 NAME
5
6 x509 - Certificate display and signing utility
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<x509>
11 [B<-inform DER|PEM|NET>]
12 [B<-outform DER|PEM|NET>]
13 [B<-keyform DER|PEM>]
14 [B<-CAform DER|PEM>]
15 [B<-CAkeyform DER|PEM>]
16 [B<-in filename>]
17 [B<-out filename>]
18 [B<-serial>]
19 [B<-hash>]
20 [B<-subject>]
21 [B<-issuer>]
22 [B<-startdate>]
23 [B<-enddate>]
24 [B<-purpose>]
25 [B<-dates>]
26 [B<-modulus>]
27 [B<-fingerprint>]
28 [B<-alias>]
29 [B<-noout>]
30 [B<-trustout>]
31 [B<-clrtrust>]
32 [B<-clrnotrust>]
33 [B<-addtrust arg>]
34 [B<-addnotrust arg>]
35 [B<-setalias arg>]
36 [B<-days arg>]
37 [B<-signkey filename>]
38 [B<-x509toreq>]
39 [B<-req>]
40 [B<-CA filename>]
41 [B<-CAkey filename>]
42 [B<-CAcreateserial>]
43 [B<-CAserial filename>]
44 [B<-text>]
45 [B<-C>]
46 [B<-md2|-md5|-sha1|-mdc2>]
47 [B<-clrext>]
48 [B<-extfile filename>]
49 [B<-extensions section>]
50
51 =head1 DESCRIPTION
52
53 The B<x509> command is a multi purpose certificate utility. It can be
54 used to display certificate information, convert certificates to
55 various forms, sign certificate requests like a "mini CA" or edit
56 certificate trust settings.
57
58 Since there are a large number of options they will split up into
59 various sections.
60
61
62 =head1 INPUT AND OUTPUT OPTIONS
63
64 =over 4
65
66 =item B<-inform DER|PEM|NET>
67
68 This specifies the input format normally the command will expect an X509
69 certificate but this can change if other options such as B<-req> are
70 present. The DER format is the DER encoding of the certificate and PEM
71 is the base64 encoding of the DER encoding with header and footer lines
72 added. The NET option is an obscure Netscape server format that is now
73 obsolete.
74
75 =item B<-outform DER|PEM|NET>
76
77 This specifies the output format, the options have the same meaning as the 
78 B<-inform> option.
79
80 =item B<-in filename>
81
82 This specifies the input filename to read a certificate from or standard input
83 if this option is not specified.
84
85 =item B<-out filename>
86
87 This specifies the output filename to write to or standard output by
88 default.
89
90 =back
91
92 =head1 DISPLAY OPTIONS
93
94 Note: the B<-alias> and B<-purpose> options are also display options
95 but are desribed in the B<TRUST OPTIONS> section.
96
97 =over 4
98
99 =item B<-text>
100
101 prints out the certificate in text form. Full details are output including the
102 public key, signature algorithms, issuer and subject names, serial number
103 any extensions present and any trust settings.
104
105 =item B<-noout>
106
107 this option prevents output of the encoded version of the request.
108
109 =item B<-modulus>
110
111 this option prints out the value of the modulus of the public key
112 contained in the certificate.
113
114 =item B<-serial>
115
116 outputs the certificate serial number.
117
118 =item B<-hash>
119
120 outputs the "hash" of the certificate subject name. This is used in OpenSSL to
121 form an index to allow certificates in a directory to be looked up by subject
122 name.
123
124 =item B<-subject>
125
126 outputs the subject name.
127
128 =item B<-issuer>
129
130 outputs the issuer name.
131
132 =item B<-startdate>
133
134 prints out the start date of the certificate, that is the notBefore date.
135
136 =item B<-enddate>
137
138 prints out the expiry date of the certificate, that is the notAfter date.
139
140 =item B<-dates>
141
142 prints out the start and expiry dates of a certificate.
143
144 =item B<-fingerprint>
145
146 prints out the MD5 digest of the whole certificate.
147
148 =item B<-C>
149
150 this outputs the certificate in the form of a C source file.
151
152 =back
153
154 =head1 TRUST SETTINGS
155
156 Please note these options are currently experimental and may well change.
157
158 A B<trusted certificate> is an ordinary certificate which has several
159 additional pieces of information attached to it such as the permitted
160 and prohibited uses of the certificate and an "alias".
161
162 Normally when a certificate is being verified at least one certificate
163 must be "trusted". By default a trusted certificate must be stored
164 locally and must be a root CA: any certificate chain ending in this CA
165 is then usable for any purpose.
166
167 Adding trust settings modifies this behaviour: if a certificate is being 
168 verified and one of the certificate chain is marked as trusted for that
169 specific purpose then the verify succeeds without looking up any more
170 certificates. Similarly if the use is prohibited then the certificate
171 is automatically rejected. If a purpose is neither permitted nor prohibited
172 then the certificate extensions are checked for consistency with the required
173 purpose and the process continues.
174
175 If a root CA is reached then it must be marked as trusted for the required
176 purpose or the verify fails.
177
178 See the description of the B<verify> utility for more information on the
179 meaning of trust settings.
180
181 =over 4
182
183 =item B<-trustout>
184
185 this causes B<x509> to output a B<trusted> certificate. An ordinary
186 or trusted certificate can be input but by default an ordinary
187 certificate is output and any trust settings are discarded. With the
188 B<-trustout> option a trusted certificate is output. A trusted
189 certificate is automatically output if any trust settings are modified.
190
191 =item B<-setalias arg>
192
193 sets the alias of the certificate. This will allow the certificate
194 to be reffered to using a nickname for example "Steve's Certificate".
195
196 =item B<-alias>
197
198 outputs the certificate alias, if any.
199
200 =item B<-clrtrust>
201
202 clears all the permitted or trusted uses of the certificate.
203
204 =item B<-clrnotrust>
205
206 clears all the prohibited or untrusted uses of the certificate.
207
208 =item B<-addtrust arg>
209
210 adds a trusted certificate use. Currently acceptable values
211 are all (any purpose), sslclient (SSL client use), sslserver
212 (SSL server use) email (S/MIME email) and objsign (Object signing).
213
214 =item B<-addnotrust arg>
215
216 adds a prohibited use. It accepts the same values as the B<-addtrust>
217 option.
218
219 =item B<-purpose>
220
221 this option performs tests on the certificate extensions and outputs
222 the results. It checks to see if the certificate can be used as an
223 end user or CA certificate for various purposes. Since many commercial
224 certificates have invalid extensions it is possible that warnings will
225 be output for some certificates. Known problems have work arounds added.
226
227 =back
228
229 =head1 SIGNING OPTIONS
230
231 The B<x509> utility can be used to sign certificates and requests: it
232 can thus behave like a "mini CA".
233
234 =over 4
235
236 =item B<-signkey filename>
237
238 this option causes the input file to be self signed using the supplied
239 private key. 
240
241 If the input file is a certificate it sets the issuer name to the
242 subject name (i.e.  makes it self signed) changes the public key to the
243 supplied value and changes the start and end dates. The start date is
244 set to the current time and the end date is set to a value determined
245 by the B<-days> option. Any certificate extensions are retained unless
246 the B<-clrext> option is supplied.
247
248 If the input is a certificate request then a self signed certificate
249 is created using the supplied private key using the subject name in
250 the request.
251
252 =item B<-clrext>
253
254 delete any extensions from a certificate. This option is used when a
255 certificate is being created from another certificate (for example with
256 the B<-signkey> or the B<-CA> options). Normally all extensions are
257 retained.
258
259 =item B<-keyform PEM|DER>
260
261 specifies the format (DER or PEM) of the private key file used in the
262 B<-signkey> option.
263
264 =item B<-days arg>
265
266 specifies the number of days to make a certificate valid for. The default
267 is 30 days.
268
269 =item B<-x509toreq>
270
271 converts a certificate into a certificate request. The B<-signkey> option
272 is used to pass the required private key.
273
274 =item B<-req>
275
276 by default a certificate is expected on input. With this option a
277 certificate request is expected instead.
278
279 =item B<-CA filename>
280
281 specifies the CA certificate to be used for signing. When this option is
282 present B<x509> behaves like a "mini CA". The input file is signed by this
283 CA using this option: that is its issuer name is set to the subject name
284 of the CA and it is digitally signed using the CAs private key.
285
286 This option is normally combined with the B<-req> option. Without the
287 B<-req> option the input is a certificate which must be self signed.
288
289 =item B<-CAkey filename>
290
291 sets the CA private key to sign a certificate with. If this option is
292 not specified then it is assumed that the CA private key is present in
293 the CA certificate file.
294
295 =item B<-CAserial filename>
296
297 sets the CA serial number file to use.
298
299 When the B<-CA> option is used to sign a certificate it uses a serial
300 number specified in a file. This file consist of one line containing
301 an even number of hex digits with the serial number to use. After each
302 use the serial number is incremented and written out to the file again.
303
304 The default filename consists of the CA certificate file base name with
305 ".srl" appended. For example if the CA certificate file is called 
306 "mycacert.pem" it expects to find a serial number file called "mycacert.srl".
307
308 =item B<-CAcreateserial filename>
309
310 with this option the CA serial number file is created if it does not exist:
311 it will contain the serial number "01". Normally if the B<-CA> option is
312 specified and the serial number file does not exist it is an error.
313
314 =item B<-md2|-md5|-sha1|-mdc2>
315
316 the digest to sign with. It affects all commands that sign a certificate
317 or request.
318
319 =item B<-extfile filename>
320
321 file containing certificate extensions to use. If not specified then
322 no extensions are added to the certificate.
323
324 =item B<-extensions section>
325
326 the section to add certificate extensions from. If this option is not
327 specified then the extensions should either be contained in the unnamed
328 (default) section or the default section should contain a variable called
329 "extensions" which contains the section to use.
330
331 =back
332
333 =head1 EXAMPLES
334
335 Note: in these examples the '\' means the example should be all on one
336 line.
337
338 Display the contents of a certificate:
339
340         openssl x509 -in cert.pem -noout -text
341
342 Displa the certificate serial number:
343
344         openssl x509 -in cert.pem -noout -serial
345
346
347 Convert a certificate from PEM to DER format:
348
349         openssl x509 -in cert.pem -inform PEM -out cert.der -outform DER
350
351 Convert a certificate to a certificate request:
352
353         openssl x509 -x509toreq -in cert.pem -out req.pem -signkey key.pem
354
355 Convert a certificate request into a self signed certificate using
356 extensions for a CA:
357
358         openssl x509 -req -in careq.pem -config openssl.cnf -extensions v3_ca \
359                 -signkey key.pem -out cacert.pem
360
361 Sign a certificate request using the CA certifcate above and add user
362 certificate extensions:
363
364         openssl x509 -req -in req.pem -config openssl.cnf -extensions v3_usr \
365                 -CA cacert.pem -CAkey key.pem -CAcreateserial
366
367
368 Set a certificate to be trusted for SSL client use and change set its alias to
369 "Steve's Class 1 CA"
370
371         openssl x509 -in cert.pem -addtrust sslclient \
372                 -alias "Steve's Class 1 CA" -out trust.pem
373
374 =head1 NOTES
375
376 The PEM format uses the header and footer lines:
377
378  -----BEGIN CERTIFICATE----
379  -----END CERTIFICATE----
380
381 it will also handle files containing:
382
383  -----BEGIN X509 CERTIFICATE----
384  -----END X509 CERTIFICATE----
385
386 =head1 BUGS
387
388 The way DNs are printed is in a "historical SSLeay" format which doesn't
389 follow any published standard. It should follow some standard like RFC2253
390 or RFC1779 with options to make the stuff more readable.
391
392 Extensions in certificates are not transferred to certificate requests and
393 vice versa.
394
395 It is possible to produce invalid certificates or requests by specifying the
396 wrong private key or using inconsistent options in some cases: these should
397 be checked.
398
399 There should be options to explicitly set such things are start and end
400 dates rather than an offset from the current time.
401
402 The code to implement the verify behaviour described in the B<TRUST SETTINGS>
403 is currently being developed. It thus describes the intended behavior rather
404 than the current behaviour. It is hoped that it will represent reality in
405 OpenSSL 0.9.5 and later.
406
407
408 =head1 SEE ALSO
409
410 req(1), ca(1), genrsa(1), gendsa(1)
411
412 =cut