New functions BN_CTX_start(), BN_CTX_get(), BN_CTX_end() to access
[openssl.git] / doc / apps / ca.pod
1
2 =pod
3
4 =head1 NAME
5
6 ca - sample minimal CA application
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<ca>
11 [B<-verbose>]
12 [B<-config filename>]
13 [B<-name section>]
14 [B<-gencrl>]
15 [B<-revoke file>]
16 [B<-crldays days>]
17 [B<-crlhours hours>]
18 [B<-crlexts section>]
19 [B<-startdate date>]
20 [B<-enddate date>]
21 [B<-days arg>]
22 [B<-md arg>]
23 [B<-policy arg>]
24 [B<-keyfile arg>]
25 [B<-key arg>]
26 [B<-cert file>]
27 [B<-in file>]
28 [B<-out file>]
29 [B<-notext>]
30 [B<-outdir dir>]
31 [B<-infiles>]
32 [B<-spkac file>]
33 [B<-ss_cert file>]
34 [B<-preserveDN>]
35 [B<-batch>]
36 [B<-msie_hack>]
37 [B<-extensions section>]
38
39 =head1 DESCRIPTION
40
41 The B<ca> command is a minimal CA application. It can be used
42 to sign certificate requests in a variety of forms and generate
43 CRLs it also maintains a text database of issued certificates
44 and their status.
45
46 The options descriptions will be divided into each purpose.
47
48 =head1 CA OPTIONS
49
50 =over 4
51
52 =item B<-config filename>
53
54 specifies the configuration file to use.
55
56 =item B<-in filename>
57
58 an input filename containing a single certificate request to be
59 signed by the CA.
60
61 =item B<-ss_cert filename>
62
63 a single self signed certificate to be signed by the CA.
64
65 =item B<-spkac filename>
66
67 a file containing a single Netscape signed public key and challenge
68 and additional field values to be signed by the CA. See the B<NOTES>
69 section for information on the required format.
70
71 =item B<-infiles>
72
73 if present this should be the last option, all subsequent arguments
74 are assumed to the the names of files containing certificate requests. 
75
76 =item B<-out filename>
77
78 the output file to output certificates to. The default is standard
79 output. The certificate details will also be printed out to this
80 file.
81
82 =item B<-outdir directory>
83
84 the directory to output certificates to. The certificate will be
85 written to a filename consisting of the serial number in hex with
86 ".pem" appended.
87
88 =item B<-cert>
89
90 the CA certificate file.
91
92 =item B<-keyfile filename>
93
94 the private key to sign requests with.
95
96 =item B<-key password>
97
98 the password used to encrypt the private key. Since on some
99 systems the command line arguments are visible (e.g. Unix with
100 the 'ps' utility) this option should be used with caution.
101
102 =item B<-verbose>
103
104 this prints extra details about the operations being performed.
105
106 =item B<-notext>
107
108 don't output the text form of a certificate to the output file.
109
110 =item B<-startdate date>
111
112 this allows the start date to be explicitly set. The format of the
113 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure).
114
115 =item B<-enddate date>
116
117 this allows the expiry date to be explicitly set. The format of the
118 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure).
119
120 =item B<-days arg>
121
122 the number of days to certify the certificate for.
123
124 =item B<-md alg>
125
126 the message digest to use. Possible values include md5, sha1 and mdc2.
127 This option also applies to CRLs.
128
129 =item B<-policy arg>
130
131 this option defines the CA "policy" to use. This is a section in
132 the configuration file which decides which fields should be mandatory
133 or match the CA certificate. Check out the B<POLICY FORMAT> section
134 for more information.
135
136 =item B<-msie_hack>
137
138 this is a legacy option to make B<ca> work with very old versions of
139 the IE certificate enrollment control "certenr3". It used UniversalStrings
140 for almost everything. Since the old control has various security bugs
141 its use is strongly discouraged. The newer control "Xenroll" does not
142 need this option.
143
144 =item B<-preserveDN>
145
146 Normally the DN order of a certificate is the same as the order of the
147 fields in the relevant policy section. When this option is set the order 
148 is the same as the request. This is largely for compatibility with the
149 older IE enrollment control which would only accept certificates if their
150 DNs match the order of the request. This is not needed for Xenroll.
151
152 =item B<-batch>
153
154 this sets the batch mode. In this mode no questions will be asked
155 and all certificates will be certified automatically.
156
157 =item B<-extensions section>
158
159 the section of the configuration file containing certificate extensions
160 to be added when a certificate is issued. If no extension section is
161 present then a V1 certificate is created. If the extension section
162 is present (even if it is empty) then a V3 certificate is created.
163
164 =back
165
166 =head1 CRL OPTIONS
167
168 =over 4
169
170 =item B<-gencrl>
171
172 this option generates a CRL based on information in the index file.
173
174 =item B<-crldays num>
175
176 the number of days before the next CRL is due. That is the days from
177 now to place in the CRL nextUpdate field.
178
179 =item B<-crlhours num>
180
181 the number of hours before the next CRL is due.
182
183 =item B<-revoke filename>
184
185 a filename containing a certificate to revoke.
186
187 =item B<-crlexts section>
188
189 the section of the configuration file containing CRL extensions to
190 include. If no CRL extension section is present then a V1 CRL is
191 created, if the CRL extension section is present (even if it is
192 empty) then a V2 CRL is created. The CRL extensions specified are
193 CRL extensions and B<not> CRL entry extensions.  It should be noted
194 that some software (for example Netscape) can't handle V2 CRLs. 
195
196 =back
197
198 =head1 CONFIGURATION FILE OPTIONS
199
200 The options for B<ca> are contained in the B<ca> section of the
201 configuration file. Many of these are identical to command line
202 options. Where the option is present in the configuration file
203 and the command line the command line value is used. Where an
204 option is described as mandatory then it must be present in
205 the configuration file or the command line equivalent (if
206 any) used.
207
208 =over 4
209
210 =item B<oid_file>
211
212 This specifies a file containing additional B<OBJECT IDENTIFIERS>.
213 Each line of the file should consist of the numerical form of the
214 object identifier followed by white space then the short name followed
215 by white space and finally the long name. 
216
217 =item B<oid_section>
218
219 This specifies a section in the configuration file containing extra
220 object identifiers. Each line should consist of the short name of the
221 object identifier followed by B<=> and the numerical form. The short
222 and long names are the same when this option is used.
223
224 =item B<new_certs_dir>
225
226 the same as the B<-outdir> command line option. It specifies
227 the directory where new certificates will be placed. Mandatory.
228
229 =item B<certificate>
230
231 the same as B<-cert>. It gives the file containing the CA
232 certificate. Mandatory.
233
234 =item B<private_key>
235
236 same as the B<-keyfile> option. The file containing the
237 CA private key. Mandatory.
238
239 =item B<RANDFILE>
240
241 a file used to read and write random number seed information.
242
243 =item B<default_days>
244
245 the same as the B<-days> option. The number of days to certify
246 a certificate for. 
247
248 =item B<default_startdate>
249
250 the same as the B<-startdate> option. The start date to certify
251 a certificate for. If not set the current time is used.
252
253 =item B<default_enddate>
254
255 the same as the B<-enddate> option. Either this option or
256 B<default_days> (or the command line equivalents) must be
257 present.
258
259 =item B<default_crl_hours default_crl_days>
260
261 the same as the B<-crlhours> and the B<-crldays> options. These
262 will only be used if neither command line option is present. At
263 least one of these must be present to generate a CRL.
264
265 =item B<default_md>
266
267 the same as the B<-md> option. The message digest to use. Mandatory.
268
269 =item B<database>
270
271 the text database file to use. Mandatory. This file must be present
272 though initially it will be empty.
273
274 =item B<serialfile>
275
276 a text file containing the next serial number to use in hex. Mandatory.
277 This file must be present and contain a valid serial number.
278
279 =item B<x509_extensions>
280
281 the same as B<-extensions>.
282
283 =item B<crl_extensions>
284
285 the same as B<-crlexts>.
286
287 =item B<preserve>
288
289 the same as B<-preserveDN>
290
291 =item B<msie_hack>
292
293 the same as B<-msie_hack>
294
295 =item B<policy>
296
297 the same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section
298 for more information.
299
300 =back
301
302 =head1 POLICY FORMAT
303
304 The policy section consists of a set of variables corresponding to
305 certificate DN fields. If the value is "match" then the field value
306 must match the same field in the CA certificate. If the value is
307 "supplied" then it must be present. If the value is "optional" then
308 it may be present. Any fields not mentioned in the policy section
309 are silently deleted, unless the B<-preserveDN> option is set but
310 this can be regarded more of a quirk than intended behaviour.
311
312 =head1 SPKAC FORMAT
313
314 The input to the B<-spkac> command line option is a Netscape
315 signed public key and challenge. This will usually come from
316 the B<KEYGEN> tag in an HTML form to create a new private key. 
317 It is however possible to create SPKACs using the B<spkac> utility.
318
319 The file should contain the variable SPKAC set to the value of
320 the SPKAC and also the required DN components as name value pairs.
321 If you need to include the same component twice then it can be
322 preceded by a number and a '.'.
323
324 =head1 EXAMPLES
325
326 Note: these examples assume that the B<ca> directory structure is
327 already set up and the relevant files already exist. This usually
328 involves creating a CA certificate and private key with B<req>, a
329 serial number file and an empty index file and placing them in
330 the relevant directories.
331
332 To use the sample configuration file below the directories demoCA,
333 demoCA/private and demoCA/newcerts would be created. The CA
334 certificate would be copied to demoCA/cacert.pem and its private
335 key to demoCA/private/cakey.pem. A file demoCA/serial would be
336 created containing for example "01" and the empty index file
337 demoCA/index.txt.
338
339
340 Sign a certificate request:
341
342  openssl ca -in req.pem -out newcert.pem
343
344 Generate a CRL
345
346  openssl ca -gencrl -out crl.pem
347
348 Sign several requests:
349
350  openssl ca -infiles req1.pem req2.pem req3.pem
351
352 Certify a Netscape SPKAC:
353
354  openssl ca -spkac spkac.txt
355
356 A sample SPKAC file (the SPKAC line has been truncated for clarity):
357
358  SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
359  CN=Steve Test
360  emailAddress=steve@openssl.org
361  0.OU=OpenSSL Group
362  1.OU=Another Group
363
364 A sample configuration file with the relevant sections for B<ca>:
365
366  [ ca ]
367  default_ca      = CA_default            # The default ca section
368  
369  [ CA_default ]
370
371  dir            = ./demoCA              # top dir
372  database       = $dir/index.txt        # index file.
373  new_certs_dir  = $dir/newcerts         # new certs dir
374  
375  certificate    = $dir/cacert.pem       # The CA cert
376  serial         = $dir/serial           # serial no file
377  private_key    = $dir/private/cakey.pem# CA private key
378  RANDFILE       = $dir/private/.rand    # random number file
379  
380  default_days   = 365                   # how long to certify for
381  default_crl_days= 30                   # how long before next CRL
382  default_md     = md5                   # md to use
383
384  policy         = policy_any            # default policy
385
386  [ policy_any ]
387  countryName            = supplied
388  stateOrProvinceName    = optional
389  organizationName       = optional
390  organizationalUnitName = optional
391  commonName             = supplied
392  emailAddress           = optional
393
394 =head1 WARNINGS
395
396 The B<ca> command is quirky and at times downright unfriendly.
397
398 The B<ca> utility was originally meant as an example of how to do things
399 in a CA. It was not supposed be be used as a full blown CA itself:
400 nevertheless some people are using it for this purpose.
401
402 The B<ca> command is effectively a single user command: no locking is
403 done on the various files and attempts to run more than one B<ca> command
404 on the same database can have unpredictable results.
405
406 =head1 FILES
407
408 Note: the location of all files can change either by compile time options,
409 configuration file entries, environment variables or command line options.
410 The values below reflect the default values.
411
412  /usr/local/ssl/lib/openssl.cnf - master configuration file
413  ./demoCA                       - main CA directory
414  ./demoCA/cacert.pem            - CA certificate
415  ./demoCA/private/cakey.pem     - CA private key
416  ./demoCA/serial                - CA serial number file
417  ./demoCA/serial.old            - CA serial number backup file
418  ./demoCA/index.txt             - CA text database file
419  ./demoCA/index.txt.old         - CA text database backup file
420  ./demoCA/certs                 - certificate output file
421  ./demoCA/.rnd                  - CA random seed information
422
423 =head1 ENVIRONMENT VARIABLES
424
425 B<OPENSSL_CONF> reflects the location of master configuration file it can
426 be overridden by the B<-config> command line option.
427
428 =head1 RESTRICTIONS
429
430 The text database index file is a critical part of the process and 
431 if corrupted it can be difficult to fix. It is theoretically possible
432 to rebuild the index file from all the issued certificates and a current
433 CRL: however there is no option to do this.
434
435 CRL entry extensions cannot currently be created: only CRL extensions
436 can be added.
437
438 V2 CRL features like delta CRL support and CRL numbers are not currently
439 supported.
440
441 Although several requests can be input and handled at once it is only
442 possible to include one SPKAC or self signed certificate.
443
444 =head1 BUGS
445
446 The use of an in memory text database can cause problems when large
447 numbers of certificates are present because, as the name implies
448 the database has to be kept in memory.
449
450 Certificate request extensions are ignored: some kind of "policy" should
451 be included to use certain static extensions and certain extensions
452 from the request.
453
454 It is not possible to certify two certificates with the same DN: this
455 is a side effect of how the text database is indexed and it cannot easily
456 be fixed without introducing other problems. Some S/MIME clients can use
457 two certificates with the same DN for separate signing and encryption
458 keys.
459
460 The B<ca> command really needs rewriting or the required functionality
461 exposed at either a command or interface level so a more friendly utility
462 (perl script or GUI) can handle things properly. The scripts B<CA.sh> and
463 B<CA.pl> help a little but not very much.
464
465 Any fields in a request that are not present in a policy are silently
466 deleted. This does not happen if the B<-preserveDN> option is used but
467 the extra fields are not displayed when the user is asked to certify
468 a request. The behaviour should be more friendly and configurable.
469
470 Cancelling some commands by refusing to certify a certificate can
471 create an empty file.
472
473 =head1 SEE ALSO
474
475 L<req(1)|req(1)>, L<spkac(1)|spkac(1)>, L<x509(1)|x509(1)>, L<CA.pl(1)|CA.pl(1)>,
476 L<config(5)|config(5)>
477
478 =cut