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