]>
Commit | Line | Data |
---|---|---|
aba3e65f DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
b6b66573 | 5 | openssl-ca - sample minimal CA application |
aba3e65f DSH |
6 | |
7 | =head1 SYNOPSIS | |
8 | ||
9 | B<openssl> B<ca> | |
169394d4 | 10 | [B<-help>] |
aba3e65f | 11 | [B<-verbose>] |
e8769719 RS |
12 | [B<-config> I<filename>] |
13 | [B<-name> I<section>] | |
aba3e65f | 14 | [B<-gencrl>] |
e8769719 RS |
15 | [B<-revoke> I<file>] |
16 | [B<-valid> I<file>] | |
17 | [B<-status> I<serial>] | |
fc1d88f0 | 18 | [B<-updatedb>] |
e8769719 RS |
19 | [B<-crl_reason> I<reason>] |
20 | [B<-crl_hold> I<instruction>] | |
21 | [B<-crl_compromise> I<time>] | |
22 | [B<-crl_CA_compromise> I<time>] | |
23 | [B<-crldays> I<days>] | |
24 | [B<-crlhours> I<hours>] | |
25 | [B<-crlexts> I<section>] | |
26 | [B<-startdate> I<date>] | |
27 | [B<-enddate> I<date>] | |
28 | [B<-days> I<arg>] | |
29 | [B<-md> I<arg>] | |
30 | [B<-policy> I<arg>] | |
31 | [B<-keyfile> I<arg>] | |
32 | [B<-keyform> B<DER>|B<PEM>] | |
33 | [B<-key> I<arg>] | |
34 | [B<-passin> I<arg>] | |
35 | [B<-cert> I<file>] | |
d6df2b28 | 36 | [B<-selfsign>] |
e8769719 RS |
37 | [B<-in> I<file>] |
38 | [B<-out> I<file>] | |
82fc1d9c | 39 | [B<-notext>] |
e8769719 | 40 | [B<-outdir> I<dir>] |
aba3e65f | 41 | [B<-infiles>] |
e8769719 RS |
42 | [B<-spkac> I<file>] |
43 | [B<-ss_cert> I<file>] | |
aba3e65f | 44 | [B<-preserveDN>] |
89da653f | 45 | [B<-noemailDN>] |
aba3e65f DSH |
46 | [B<-batch>] |
47 | [B<-msie_hack>] | |
e8769719 RS |
48 | [B<-extensions> I<section>] |
49 | [B<-extfile> I<section>] | |
50 | [B<-engine> I<id>] | |
51 | [B<-subj> I<arg>] | |
57eb1d32 | 52 | [B<-utf8>] |
e8769719 | 53 | [B<-sigopt> I<nm>:I<v>] |
6755ff11 | 54 | [B<-create_serial>] |
ffb46830 | 55 | [B<-rand_serial>] |
57eb1d32 | 56 | [B<-multivalue-rdn>] |
e8769719 RS |
57 | [B<-rand> I<file>] |
58 | [B<-writerand> I<file>] | |
59 | [B<-sm2-id> I<string>] | |
60 | [B<-sm2-hex-id> I<hex-string>] | |
aba3e65f | 61 | |
1738c0ce RS |
62 | =for comment ifdef engine sm2-id sm2-hex-id |
63 | ||
aba3e65f DSH |
64 | =head1 DESCRIPTION |
65 | ||
66 | The B<ca> command is a minimal CA application. It can be used | |
67 | to sign certificate requests in a variety of forms and generate | |
68 | CRLs it also maintains a text database of issued certificates | |
69 | and their status. | |
70 | ||
71 | The options descriptions will be divided into each purpose. | |
72 | ||
3dfda1a6 | 73 | =head1 OPTIONS |
aba3e65f DSH |
74 | |
75 | =over 4 | |
76 | ||
6755ff11 MR |
77 | =item B<-help> |
78 | ||
79 | Print out a usage message. | |
80 | ||
81 | =item B<-verbose> | |
82 | ||
c4de074e | 83 | This prints extra details about the operations being performed. |
6755ff11 | 84 | |
e8769719 | 85 | =item B<-config> I<filename> |
aba3e65f | 86 | |
c4de074e | 87 | Specifies the configuration file to use. |
e9681f83 RS |
88 | Optional; for a description of the default value, |
89 | see L<openssl(1)/COMMAND SUMMARY>. | |
aba3e65f | 90 | |
e8769719 | 91 | =item B<-name> I<section> |
8a0a9392 | 92 | |
c4de074e | 93 | Specifies the configuration file section to use (overrides |
8a0a9392 BM |
94 | B<default_ca> in the B<ca> section). |
95 | ||
e8769719 | 96 | =item B<-in> I<filename> |
aba3e65f | 97 | |
c4de074e | 98 | An input filename containing a single certificate request to be |
aba3e65f DSH |
99 | signed by the CA. |
100 | ||
e8769719 | 101 | =item B<-ss_cert> I<filename> |
aba3e65f | 102 | |
c4de074e | 103 | A single self-signed certificate to be signed by the CA. |
aba3e65f | 104 | |
e8769719 | 105 | =item B<-spkac> I<filename> |
aba3e65f | 106 | |
c4de074e | 107 | A file containing a single Netscape signed public key and challenge |
d618f703 | 108 | and additional field values to be signed by the CA. See the B<SPKAC FORMAT> |
fc1d88f0 | 109 | section for information on the required input and output format. |
aba3e65f DSH |
110 | |
111 | =item B<-infiles> | |
112 | ||
c4de074e | 113 | If present this should be the last option, all subsequent arguments |
1bc74519 | 114 | are taken as the names of files containing certificate requests. |
aba3e65f | 115 | |
e8769719 | 116 | =item B<-out> I<filename> |
aba3e65f | 117 | |
c4de074e | 118 | The output file to output certificates to. The default is standard |
aba3e65f | 119 | output. The certificate details will also be printed out to this |
fc1d88f0 | 120 | file in PEM format (except that B<-spkac> outputs DER format). |
aba3e65f | 121 | |
e8769719 | 122 | =item B<-outdir> I<directory> |
aba3e65f | 123 | |
c4de074e | 124 | The directory to output certificates to. The certificate will be |
aba3e65f DSH |
125 | written to a filename consisting of the serial number in hex with |
126 | ".pem" appended. | |
127 | ||
128 | =item B<-cert> | |
129 | ||
c4de074e | 130 | The CA certificate file. |
aba3e65f | 131 | |
e8769719 | 132 | =item B<-keyfile> I<filename> |
aba3e65f | 133 | |
c4de074e | 134 | The private key to sign requests with. |
aba3e65f | 135 | |
e8769719 | 136 | =item B<-keyform> B<DER>|B<PEM> |
fc1d88f0 | 137 | |
c4de074e | 138 | The format of the data in the private key file. |
fc1d88f0 RS |
139 | The default is PEM. |
140 | ||
e8769719 | 141 | =item B<-sigopt> I<nm>:I<v> |
d7b2124a P |
142 | |
143 | Pass options to the signature algorithm during sign or verify operations. | |
144 | Names and values of these options are algorithm-specific. | |
145 | ||
e8769719 | 146 | =item B<-key> I<password> |
aba3e65f | 147 | |
c4de074e | 148 | The password used to encrypt the private key. Since on some |
aba3e65f DSH |
149 | systems the command line arguments are visible (e.g. Unix with |
150 | the 'ps' utility) this option should be used with caution. | |
151 | ||
d6df2b28 RL |
152 | =item B<-selfsign> |
153 | ||
c4de074e | 154 | Indicates the issued certificates are to be signed with the key |
d6df2b28 | 155 | the certificate requests were signed with (given with B<-keyfile>). |
42b91f28 | 156 | Certificate requests signed with a different key are ignored. If |
d6df2b28 RL |
157 | B<-spkac>, B<-ss_cert> or B<-gencrl> are given, B<-selfsign> is |
158 | ignored. | |
159 | ||
160 | A consequence of using B<-selfsign> is that the self-signed | |
161 | certificate appears among the entries in the certificate database | |
162 | (see the configuration option B<database>), and uses the same | |
163 | serial number counter as all other certificates sign with the | |
164 | self-signed certificate. | |
165 | ||
e8769719 | 166 | =item B<-passin> I<arg> |
bd08a2bd | 167 | |
c4de074e | 168 | The key password source. For more information about the format of B<arg> |
e8769719 | 169 | see L<openssl(1)/Pass phrase options>. |
bad40585 | 170 | |
82fc1d9c DSH |
171 | =item B<-notext> |
172 | ||
c4de074e | 173 | Don't output the text form of a certificate to the output file. |
82fc1d9c | 174 | |
e8769719 | 175 | =item B<-startdate> I<date> |
aba3e65f | 176 | |
c4de074e | 177 | This allows the start date to be explicitly set. The format of the |
909873bd PY |
178 | date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or |
179 | YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In | |
a970b14f | 180 | both formats, seconds SS and timezone Z must be present. |
aba3e65f | 181 | |
e8769719 | 182 | =item B<-enddate> I<date> |
aba3e65f | 183 | |
c4de074e | 184 | This allows the expiry date to be explicitly set. The format of the |
909873bd PY |
185 | date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or |
186 | YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In | |
a970b14f | 187 | both formats, seconds SS and timezone Z must be present. |
aba3e65f | 188 | |
e8769719 | 189 | =item B<-days> I<arg> |
aba3e65f | 190 | |
c4de074e | 191 | The number of days to certify the certificate for. |
aba3e65f | 192 | |
e8769719 | 193 | =item B<-md> I<alg> |
aba3e65f | 194 | |
c4de074e | 195 | The message digest to use. |
aabbc24e MC |
196 | Any digest supported by the OpenSSL B<dgst> command can be used. For signing |
197 | algorithms that do not support a digest (i.e. Ed25519 and Ed448) any message | |
198 | digest that is set is ignored. This option also applies to CRLs. | |
aba3e65f | 199 | |
e8769719 | 200 | =item B<-policy> I<arg> |
aba3e65f | 201 | |
c4de074e | 202 | This option defines the CA "policy" to use. This is a section in |
aba3e65f DSH |
203 | the configuration file which decides which fields should be mandatory |
204 | or match the CA certificate. Check out the B<POLICY FORMAT> section | |
205 | for more information. | |
206 | ||
207 | =item B<-msie_hack> | |
208 | ||
a95d7574 | 209 | This is a deprecated option to make B<ca> work with very old versions of |
aba3e65f DSH |
210 | the IE certificate enrollment control "certenr3". It used UniversalStrings |
211 | for almost everything. Since the old control has various security bugs | |
a95d7574 | 212 | its use is strongly discouraged. |
aba3e65f DSH |
213 | |
214 | =item B<-preserveDN> | |
215 | ||
53b1899e | 216 | Normally the DN order of a certificate is the same as the order of the |
1bc74519 | 217 | fields in the relevant policy section. When this option is set the order |
19d2bb57 | 218 | is the same as the request. This is largely for compatibility with the |
53b1899e DSH |
219 | older IE enrollment control which would only accept certificates if their |
220 | DNs match the order of the request. This is not needed for Xenroll. | |
aba3e65f | 221 | |
89da653f BM |
222 | =item B<-noemailDN> |
223 | ||
224 | The DN of a certificate can contain the EMAIL field if present in the | |
225 | request DN, however it is good policy just having the e-mail set into | |
226 | the altName extension of the certificate. When this option is set the | |
227 | EMAIL field is removed from the certificate' subject and set only in | |
228 | the, eventually present, extensions. The B<email_in_dn> keyword can be | |
229 | used in the configuration file to enable this behaviour. | |
230 | ||
aba3e65f DSH |
231 | =item B<-batch> |
232 | ||
c4de074e | 233 | This sets the batch mode. In this mode no questions will be asked |
aba3e65f DSH |
234 | and all certificates will be certified automatically. |
235 | ||
e8769719 | 236 | =item B<-extensions> I<section> |
aba3e65f | 237 | |
c4de074e | 238 | The section of the configuration file containing certificate extensions |
dfebac32 BM |
239 | to be added when a certificate is issued (defaults to B<x509_extensions> |
240 | unless the B<-extfile> option is used). If no extension section is | |
241 | present then, a V1 certificate is created. If the extension section | |
143b6316 | 242 | is present (even if it is empty), then a V3 certificate is created. See the |
9b86974e | 243 | L<x509v3_config(5)> manual page for details of the |
137de5b1 | 244 | extension section format. |
dfebac32 | 245 | |
e8769719 | 246 | =item B<-extfile> I<file> |
dfebac32 | 247 | |
c4de074e | 248 | An additional configuration file to read certificate extensions from |
dfebac32 BM |
249 | (using the default section unless the B<-extensions> option is also |
250 | used). | |
aba3e65f | 251 | |
e8769719 | 252 | =item B<-engine> I<id> |
bfa35550 | 253 | |
c4de074e | 254 | Specifying an engine (by its unique B<id> string) will cause B<ca> |
bfa35550 RL |
255 | to attempt to obtain a functional reference to the specified engine, |
256 | thus initialising it if needed. The engine will then be set as the default | |
257 | for all available algorithms. | |
258 | ||
e8769719 | 259 | =item B<-subj> I<arg> |
57eb1d32 | 260 | |
c4de074e | 261 | Supersedes subject name given in the request. |
3d362f19 BK |
262 | The arg must be formatted as I</type0=value0/type1=value1/type2=...>. |
263 | Keyword characters may be escaped by \ (backslash), and whitespace is retained. | |
264 | Empty values are permitted, but the corresponding type will not be included | |
265 | in the resulting certificate. | |
57eb1d32 NL |
266 | |
267 | =item B<-utf8> | |
268 | ||
c4de074e | 269 | This option causes field values to be interpreted as UTF8 strings, by |
57eb1d32 NL |
270 | default they are interpreted as ASCII. This means that the field |
271 | values, whether prompted from a terminal or obtained from a | |
272 | configuration file, must be valid UTF8 strings. | |
273 | ||
6755ff11 MR |
274 | =item B<-create_serial> |
275 | ||
c4de074e | 276 | If reading serial from the text file as specified in the configuration |
6755ff11 MR |
277 | fails, specifying this option creates a new random serial to be used as next |
278 | serial number. | |
ffb46830 RS |
279 | To get random serial numbers, use the B<-rand_serial> flag instead; this |
280 | should only be used for simple error-recovery. | |
281 | ||
282 | =item B<-rand_serial> | |
283 | ||
284 | Generate a large random number to use as the serial number. | |
285 | This overrides any option or configuration to use a serial number file. | |
6755ff11 | 286 | |
57eb1d32 NL |
287 | =item B<-multivalue-rdn> |
288 | ||
4c583c36 | 289 | This option causes the -subj argument to be interpreted with full |
57eb1d32 NL |
290 | support for multivalued RDNs. Example: |
291 | ||
292 | I</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe> | |
293 | ||
294 | If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>. | |
295 | ||
e8769719 | 296 | =item B<-rand> I<file> |
3ee1eac2 RS |
297 | |
298 | A file or files containing random data used to seed the random number | |
299 | generator. | |
300 | Multiple files can be specified separated by an OS-dependent character. | |
301 | The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for | |
302 | all others. | |
303 | ||
e8769719 | 304 | =item B<-writerand> I<file> |
3ee1eac2 RS |
305 | |
306 | Writes random data to the specified I<file> upon exit. | |
307 | This can be used with a subsequent B<-rand> flag. | |
308 | ||
e8769719 | 309 | =item B<-sm2-id> I<string> |
bc42bd62 PY |
310 | |
311 | Specify the ID string to use when verifying an SM2 certificate. The ID string is | |
312 | required by the SM2 signature algorithm for signing and verification. | |
313 | ||
e8769719 | 314 | =item B<-sm2-hex-id> I<hex-string> |
bc42bd62 PY |
315 | |
316 | Specify a binary ID string to use when signing or verifying using an SM2 | |
317 | certificate. The argument for this option is string of hexadecimal digits. | |
318 | ||
aba3e65f DSH |
319 | =back |
320 | ||
321 | =head1 CRL OPTIONS | |
322 | ||
323 | =over 4 | |
324 | ||
325 | =item B<-gencrl> | |
326 | ||
c4de074e | 327 | This option generates a CRL based on information in the index file. |
aba3e65f | 328 | |
e8769719 | 329 | =item B<-crldays> I<num> |
aba3e65f | 330 | |
c4de074e | 331 | The number of days before the next CRL is due. That is the days from |
aba3e65f DSH |
332 | now to place in the CRL nextUpdate field. |
333 | ||
e8769719 | 334 | =item B<-crlhours> I<num> |
aba3e65f | 335 | |
c4de074e | 336 | The number of hours before the next CRL is due. |
aba3e65f | 337 | |
e8769719 | 338 | =item B<-revoke> I<filename> |
aba3e65f | 339 | |
c4de074e | 340 | A filename containing a certificate to revoke. |
aba3e65f | 341 | |
e8769719 | 342 | =item B<-valid> I<filename> |
b4b42ce6 | 343 | |
c4de074e | 344 | A filename containing a certificate to add a Valid certificate entry. |
b4b42ce6 | 345 | |
e8769719 | 346 | =item B<-status> I<serial> |
fc1d88f0 | 347 | |
c4de074e | 348 | Displays the revocation status of the certificate with the specified |
fc1d88f0 RS |
349 | serial number and exits. |
350 | ||
351 | =item B<-updatedb> | |
352 | ||
353 | Updates the database index to purge expired certificates. | |
354 | ||
e8769719 | 355 | =item B<-crl_reason> I<reason> |
d618f703 | 356 | |
c4de074e | 357 | Revocation reason, where B<reason> is one of: B<unspecified>, B<keyCompromise>, |
d618f703 DSH |
358 | B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>, |
359 | B<certificateHold> or B<removeFromCRL>. The matching of B<reason> is case | |
360 | insensitive. Setting any revocation reason will make the CRL v2. | |
361 | ||
42b91f28 | 362 | In practice B<removeFromCRL> is not particularly useful because it is only used |
d618f703 DSH |
363 | in delta CRLs which are not currently implemented. |
364 | ||
e8769719 | 365 | =item B<-crl_hold> I<instruction> |
d618f703 DSH |
366 | |
367 | This sets the CRL revocation reason code to B<certificateHold> and the hold | |
368 | instruction to B<instruction> which must be an OID. Although any OID can be | |
369 | used only B<holdInstructionNone> (the use of which is discouraged by RFC2459) | |
370 | B<holdInstructionCallIssuer> or B<holdInstructionReject> will normally be used. | |
371 | ||
e8769719 | 372 | =item B<-crl_compromise> I<time> |
d618f703 DSH |
373 | |
374 | This sets the revocation reason to B<keyCompromise> and the compromise time to | |
375 | B<time>. B<time> should be in GeneralizedTime format that is B<YYYYMMDDHHMMSSZ>. | |
376 | ||
e8769719 | 377 | =item B<-crl_CA_compromise> I<time> |
d618f703 DSH |
378 | |
379 | This is the same as B<crl_compromise> except the revocation reason is set to | |
380 | B<CACompromise>. | |
381 | ||
e8769719 | 382 | =item B<-crlexts> I<section> |
aba3e65f | 383 | |
c4de074e | 384 | The section of the configuration file containing CRL extensions to |
aba3e65f DSH |
385 | include. If no CRL extension section is present then a V1 CRL is |
386 | created, if the CRL extension section is present (even if it is | |
387 | empty) then a V2 CRL is created. The CRL extensions specified are | |
388 | CRL extensions and B<not> CRL entry extensions. It should be noted | |
137de5b1 | 389 | that some software (for example Netscape) can't handle V2 CRLs. See |
9b86974e | 390 | L<x509v3_config(5)> manual page for details of the |
137de5b1 | 391 | extension section format. |
aba3e65f DSH |
392 | |
393 | =back | |
394 | ||
395 | =head1 CONFIGURATION FILE OPTIONS | |
396 | ||
8a0a9392 BM |
397 | The section of the configuration file containing options for B<ca> |
398 | is found as follows: If the B<-name> command line option is used, | |
399 | then it names the section to be used. Otherwise the section to | |
400 | be used must be named in the B<default_ca> option of the B<ca> section | |
401 | of the configuration file (or in the default section of the | |
402 | configuration file). Besides B<default_ca>, the following options are | |
403 | read directly from the B<ca> section: | |
404 | RANDFILE | |
405 | preserve | |
406 | msie_hack | |
407 | With the exception of B<RANDFILE>, this is probably a bug and may | |
408 | change in future releases. | |
409 | ||
410 | Many of the configuration file options are identical to command line | |
aba3e65f DSH |
411 | options. Where the option is present in the configuration file |
412 | and the command line the command line value is used. Where an | |
413 | option is described as mandatory then it must be present in | |
414 | the configuration file or the command line equivalent (if | |
415 | any) used. | |
416 | ||
417 | =over 4 | |
418 | ||
5e76807b DSH |
419 | =item B<oid_file> |
420 | ||
421 | This specifies a file containing additional B<OBJECT IDENTIFIERS>. | |
422 | Each line of the file should consist of the numerical form of the | |
423 | object identifier followed by white space then the short name followed | |
1bc74519 | 424 | by white space and finally the long name. |
5e76807b DSH |
425 | |
426 | =item B<oid_section> | |
427 | ||
428 | This specifies a section in the configuration file containing extra | |
429 | object identifiers. Each line should consist of the short name of the | |
430 | object identifier followed by B<=> and the numerical form. The short | |
431 | and long names are the same when this option is used. | |
432 | ||
aba3e65f DSH |
433 | =item B<new_certs_dir> |
434 | ||
c4de074e | 435 | The same as the B<-outdir> command line option. It specifies |
aba3e65f DSH |
436 | the directory where new certificates will be placed. Mandatory. |
437 | ||
438 | =item B<certificate> | |
439 | ||
c4de074e | 440 | The same as B<-cert>. It gives the file containing the CA |
aba3e65f DSH |
441 | certificate. Mandatory. |
442 | ||
443 | =item B<private_key> | |
444 | ||
c4de074e | 445 | Same as the B<-keyfile> option. The file containing the |
aba3e65f DSH |
446 | CA private key. Mandatory. |
447 | ||
448 | =item B<RANDFILE> | |
449 | ||
3ee1eac2 RS |
450 | At startup the specified file is loaded into the random number generator, |
451 | and at exit 256 bytes will be written to it. | |
aba3e65f DSH |
452 | |
453 | =item B<default_days> | |
454 | ||
c4de074e | 455 | The same as the B<-days> option. The number of days to certify |
1bc74519 | 456 | a certificate for. |
aba3e65f DSH |
457 | |
458 | =item B<default_startdate> | |
459 | ||
c4de074e | 460 | The same as the B<-startdate> option. The start date to certify |
aba3e65f DSH |
461 | a certificate for. If not set the current time is used. |
462 | ||
463 | =item B<default_enddate> | |
464 | ||
c4de074e | 465 | The same as the B<-enddate> option. Either this option or |
aba3e65f DSH |
466 | B<default_days> (or the command line equivalents) must be |
467 | present. | |
468 | ||
469 | =item B<default_crl_hours default_crl_days> | |
470 | ||
c4de074e | 471 | The same as the B<-crlhours> and the B<-crldays> options. These |
aba3e65f DSH |
472 | will only be used if neither command line option is present. At |
473 | least one of these must be present to generate a CRL. | |
474 | ||
475 | =item B<default_md> | |
476 | ||
aabbc24e MC |
477 | The same as the B<-md> option. Mandatory except where the signing algorithm does |
478 | not require a digest (i.e. Ed25519 and Ed448). | |
aba3e65f DSH |
479 | |
480 | =item B<database> | |
481 | ||
c4de074e | 482 | The text database file to use. Mandatory. This file must be present |
aba3e65f DSH |
483 | though initially it will be empty. |
484 | ||
d6df2b28 RL |
485 | =item B<unique_subject> |
486 | ||
c4de074e | 487 | If the value B<yes> is given, the valid certificate entries in the |
d6df2b28 RL |
488 | database must have unique subjects. if the value B<no> is given, |
489 | several valid certificate entries may have the exact same subject. | |
490 | The default value is B<yes>, to be compatible with older (pre 0.9.8) | |
491 | versions of OpenSSL. However, to make CA certificate roll-over easier, | |
492 | it's recommended to use the value B<no>, especially if combined with | |
493 | the B<-selfsign> command line option. | |
494 | ||
5af88441 MC |
495 | Note that it is valid in some circumstances for certificates to be created |
496 | without any subject. In the case where there are multiple certificates without | |
df443918 | 497 | subjects this does not count as a duplicate. |
5af88441 | 498 | |
c5aba56c | 499 | =item B<serial> |
aba3e65f | 500 | |
c4de074e | 501 | A text file containing the next serial number to use in hex. Mandatory. |
aba3e65f DSH |
502 | This file must be present and contain a valid serial number. |
503 | ||
8fbb2af3 RL |
504 | =item B<crlnumber> |
505 | ||
c4de074e | 506 | A text file containing the next CRL number to use in hex. The crl number |
8fbb2af3 RL |
507 | will be inserted in the CRLs only if this file exists. If this file is |
508 | present, it must contain a valid CRL number. | |
509 | ||
aba3e65f DSH |
510 | =item B<x509_extensions> |
511 | ||
c4de074e | 512 | The same as B<-extensions>. |
aba3e65f DSH |
513 | |
514 | =item B<crl_extensions> | |
515 | ||
c4de074e | 516 | The same as B<-crlexts>. |
aba3e65f DSH |
517 | |
518 | =item B<preserve> | |
519 | ||
c4de074e | 520 | The same as B<-preserveDN> |
aba3e65f | 521 | |
89da653f BM |
522 | =item B<email_in_dn> |
523 | ||
c4de074e | 524 | The same as B<-noemailDN>. If you want the EMAIL field to be removed |
89da653f BM |
525 | from the DN of the certificate simply set this to 'no'. If not present |
526 | the default is to allow for the EMAIL filed in the certificate's DN. | |
527 | ||
aba3e65f DSH |
528 | =item B<msie_hack> |
529 | ||
c4de074e | 530 | The same as B<-msie_hack> |
aba3e65f DSH |
531 | |
532 | =item B<policy> | |
533 | ||
c4de074e | 534 | The same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section |
aba3e65f DSH |
535 | for more information. |
536 | ||
b325518f | 537 | =item B<name_opt>, B<cert_opt> |
e890dcdb | 538 | |
c4de074e | 539 | These options allow the format used to display the certificate details |
e890dcdb DSH |
540 | when asking the user to confirm signing. All the options supported by |
541 | the B<x509> utilities B<-nameopt> and B<-certopt> switches can be used | |
542 | here, except the B<no_signame> and B<no_sigdump> are permanently set | |
543 | and cannot be disabled (this is because the certificate signature cannot | |
544 | be displayed because the certificate has not been signed at this point). | |
545 | ||
6f2f534b | 546 | For convenience the values B<ca_default> are accepted by both to produce |
e890dcdb DSH |
547 | a reasonable output. |
548 | ||
549 | If neither option is present the format used in earlier versions of | |
550 | OpenSSL is used. Use of the old format is B<strongly> discouraged because | |
551 | it only displays fields mentioned in the B<policy> section, mishandles | |
552 | multicharacter string types and does not display extensions. | |
553 | ||
791bd0cd DSH |
554 | =item B<copy_extensions> |
555 | ||
c4de074e | 556 | Determines how extensions in certificate requests should be handled. |
791bd0cd DSH |
557 | If set to B<none> or this option is not present then extensions are |
558 | ignored and not copied to the certificate. If set to B<copy> then any | |
559 | extensions present in the request that are not already present are copied | |
560 | to the certificate. If set to B<copyall> then all extensions in the | |
561 | request are copied to the certificate: if the extension is already present | |
562 | in the certificate it is deleted first. See the B<WARNINGS> section before | |
563 | using this option. | |
564 | ||
565 | The main use of this option is to allow a certificate request to supply | |
566 | values for certain extensions such as subjectAltName. | |
567 | ||
aba3e65f DSH |
568 | =back |
569 | ||
570 | =head1 POLICY FORMAT | |
571 | ||
572 | The policy section consists of a set of variables corresponding to | |
573 | certificate DN fields. If the value is "match" then the field value | |
574 | must match the same field in the CA certificate. If the value is | |
575 | "supplied" then it must be present. If the value is "optional" then | |
576 | it may be present. Any fields not mentioned in the policy section | |
577 | are silently deleted, unless the B<-preserveDN> option is set but | |
578 | this can be regarded more of a quirk than intended behaviour. | |
579 | ||
580 | =head1 SPKAC FORMAT | |
581 | ||
582 | The input to the B<-spkac> command line option is a Netscape | |
583 | signed public key and challenge. This will usually come from | |
1bc74519 | 584 | the B<KEYGEN> tag in an HTML form to create a new private key. |
aba3e65f DSH |
585 | It is however possible to create SPKACs using the B<spkac> utility. |
586 | ||
587 | The file should contain the variable SPKAC set to the value of | |
588 | the SPKAC and also the required DN components as name value pairs. | |
589 | If you need to include the same component twice then it can be | |
590 | preceded by a number and a '.'. | |
591 | ||
fc1d88f0 RS |
592 | When processing SPKAC format, the output is DER if the B<-out> |
593 | flag is used, but PEM format if sending to stdout or the B<-outdir> | |
594 | flag is used. | |
595 | ||
aba3e65f DSH |
596 | =head1 EXAMPLES |
597 | ||
598 | Note: these examples assume that the B<ca> directory structure is | |
599 | already set up and the relevant files already exist. This usually | |
600 | involves creating a CA certificate and private key with B<req>, a | |
601 | serial number file and an empty index file and placing them in | |
602 | the relevant directories. | |
603 | ||
604 | To use the sample configuration file below the directories demoCA, | |
605 | demoCA/private and demoCA/newcerts would be created. The CA | |
606 | certificate would be copied to demoCA/cacert.pem and its private | |
607 | key to demoCA/private/cakey.pem. A file demoCA/serial would be | |
608 | created containing for example "01" and the empty index file | |
609 | demoCA/index.txt. | |
610 | ||
611 | ||
612 | Sign a certificate request: | |
613 | ||
1675f6eb | 614 | openssl ca -in req.pem -out newcert.pem |
aba3e65f | 615 | |
bc42bd62 PY |
616 | Sign an SM2 certificate request: |
617 | ||
618 | openssl ca -in sm2.csr -out sm2.crt -md sm3 -sigopt "sm2_id:1234567812345678" -sm2-id "1234567812345678" | |
619 | ||
d428bf8c DSH |
620 | Sign a certificate request, using CA extensions: |
621 | ||
622 | openssl ca -in req.pem -extensions v3_ca -out newcert.pem | |
623 | ||
aba3e65f DSH |
624 | Generate a CRL |
625 | ||
1675f6eb | 626 | openssl ca -gencrl -out crl.pem |
aba3e65f DSH |
627 | |
628 | Sign several requests: | |
629 | ||
1675f6eb | 630 | openssl ca -infiles req1.pem req2.pem req3.pem |
aba3e65f DSH |
631 | |
632 | Certify a Netscape SPKAC: | |
633 | ||
1675f6eb | 634 | openssl ca -spkac spkac.txt |
aba3e65f DSH |
635 | |
636 | A sample SPKAC file (the SPKAC line has been truncated for clarity): | |
637 | ||
638 | SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5 | |
639 | CN=Steve Test | |
640 | emailAddress=steve@openssl.org | |
641 | 0.OU=OpenSSL Group | |
642 | 1.OU=Another Group | |
643 | ||
644 | A sample configuration file with the relevant sections for B<ca>: | |
645 | ||
646 | [ ca ] | |
647 | default_ca = CA_default # The default ca section | |
1bc74519 | 648 | |
aba3e65f DSH |
649 | [ CA_default ] |
650 | ||
651 | dir = ./demoCA # top dir | |
652 | database = $dir/index.txt # index file. | |
1bc74519 RS |
653 | new_certs_dir = $dir/newcerts # new certs dir |
654 | ||
aba3e65f DSH |
655 | certificate = $dir/cacert.pem # The CA cert |
656 | serial = $dir/serial # serial no file | |
ffb46830 | 657 | #rand_serial = yes # for random serial#'s |
aba3e65f DSH |
658 | private_key = $dir/private/cakey.pem# CA private key |
659 | RANDFILE = $dir/private/.rand # random number file | |
1bc74519 | 660 | |
aba3e65f DSH |
661 | default_days = 365 # how long to certify for |
662 | default_crl_days= 30 # how long before next CRL | |
663 | default_md = md5 # md to use | |
664 | ||
665 | policy = policy_any # default policy | |
89da653f | 666 | email_in_dn = no # Don't add the email into cert DN |
aba3e65f | 667 | |
1bc74519 RS |
668 | name_opt = ca_default # Subject name display option |
669 | cert_opt = ca_default # Certificate display option | |
670 | copy_extensions = none # Don't copy extensions from request | |
e890dcdb | 671 | |
aba3e65f DSH |
672 | [ policy_any ] |
673 | countryName = supplied | |
674 | stateOrProvinceName = optional | |
675 | organizationName = optional | |
676 | organizationalUnitName = optional | |
677 | commonName = supplied | |
678 | emailAddress = optional | |
679 | ||
aba3e65f DSH |
680 | =head1 FILES |
681 | ||
682 | Note: the location of all files can change either by compile time options, | |
19d2bb57 | 683 | configuration file entries, environment variables or command line options. |
aba3e65f DSH |
684 | The values below reflect the default values. |
685 | ||
686 | /usr/local/ssl/lib/openssl.cnf - master configuration file | |
687 | ./demoCA - main CA directory | |
688 | ./demoCA/cacert.pem - CA certificate | |
689 | ./demoCA/private/cakey.pem - CA private key | |
690 | ./demoCA/serial - CA serial number file | |
691 | ./demoCA/serial.old - CA serial number backup file | |
692 | ./demoCA/index.txt - CA text database file | |
693 | ./demoCA/index.txt.old - CA text database backup file | |
694 | ./demoCA/certs - certificate output file | |
695 | ./demoCA/.rnd - CA random seed information | |
696 | ||
aba3e65f DSH |
697 | =head1 RESTRICTIONS |
698 | ||
1bc74519 | 699 | The text database index file is a critical part of the process and |
aba3e65f DSH |
700 | if corrupted it can be difficult to fix. It is theoretically possible |
701 | to rebuild the index file from all the issued certificates and a current | |
702 | CRL: however there is no option to do this. | |
703 | ||
cb26a20c | 704 | V2 CRL features like delta CRLs are not currently supported. |
aba3e65f DSH |
705 | |
706 | Although several requests can be input and handled at once it is only | |
77a795e4 | 707 | possible to include one SPKAC or self-signed certificate. |
aba3e65f DSH |
708 | |
709 | =head1 BUGS | |
710 | ||
77a795e4 | 711 | The use of an in-memory text database can cause problems when large |
aba3e65f DSH |
712 | numbers of certificates are present because, as the name implies |
713 | the database has to be kept in memory. | |
714 | ||
aba3e65f DSH |
715 | The B<ca> command really needs rewriting or the required functionality |
716 | exposed at either a command or interface level so a more friendly utility | |
be739b0c RS |
717 | (perl script or GUI) can handle things properly. The script |
718 | B<CA.pl> helps a little but not very much. | |
aba3e65f DSH |
719 | |
720 | Any fields in a request that are not present in a policy are silently | |
89da653f BM |
721 | deleted. This does not happen if the B<-preserveDN> option is used. To |
722 | enforce the absence of the EMAIL field within the DN, as suggested by | |
723 | RFCs, regardless the contents of the request' subject the B<-noemailDN> | |
724 | option can be used. The behaviour should be more friendly and | |
725 | configurable. | |
aba3e65f | 726 | |
42b91f28 | 727 | Canceling some commands by refusing to certify a certificate can |
aba3e65f DSH |
728 | create an empty file. |
729 | ||
791bd0cd DSH |
730 | =head1 WARNINGS |
731 | ||
1f309464 LJ |
732 | The B<ca> command is quirky and at times downright unfriendly. |
733 | ||
734 | The B<ca> utility was originally meant as an example of how to do things | |
735 | in a CA. It was not supposed to be used as a full blown CA itself: | |
736 | nevertheless some people are using it for this purpose. | |
737 | ||
738 | The B<ca> command is effectively a single user command: no locking is | |
739 | done on the various files and attempts to run more than one B<ca> command | |
740 | on the same database can have unpredictable results. | |
741 | ||
791bd0cd DSH |
742 | The B<copy_extensions> option should be used with caution. If care is |
743 | not taken then it can be a security risk. For example if a certificate | |
744 | request contains a basicConstraints extension with CA:TRUE and the | |
745 | B<copy_extensions> value is set to B<copyall> and the user does not spot | |
42b91f28 | 746 | this when the certificate is displayed then this will hand the requester |
791bd0cd DSH |
747 | a valid CA certificate. |
748 | ||
749 | This situation can be avoided by setting B<copy_extensions> to B<copy> | |
750 | and including basicConstraints with CA:FALSE in the configuration file. | |
751 | Then if the request contains a basicConstraints extension it will be | |
752 | ignored. | |
753 | ||
754 | It is advisable to also include values for other extensions such | |
755 | as B<keyUsage> to prevent a request supplying its own values. | |
756 | ||
757 | Additional restrictions can be placed on the CA certificate itself. | |
758 | For example if the CA certificate has: | |
759 | ||
760 | basicConstraints = CA:TRUE, pathlen:0 | |
761 | ||
762 | then even if a certificate is issued with CA:TRUE it will not be valid. | |
763 | ||
909873bd PY |
764 | =head1 HISTORY |
765 | ||
766 | Since OpenSSL 1.1.1, the program follows RFC5280. Specifically, | |
767 | certificate validity period (specified by any of B<-startdate>, | |
768 | B<-enddate> and B<-days>) will be encoded as UTCTime if the dates are | |
769 | earlier than year 2049 (included), and as GeneralizedTime if the dates | |
770 | are in year 2050 or later. | |
771 | ||
aba3e65f DSH |
772 | =head1 SEE ALSO |
773 | ||
b6b66573 DMSP |
774 | L<openssl(1)>, |
775 | L<openssl-req(1)>, | |
776 | L<openssl-spkac(1)>, | |
777 | L<openssl-x509(1)>, | |
778 | L<CA.pl(1)>, | |
779 | L<config(5)>, | |
780 | L<x509v3_config(5)> | |
aba3e65f | 781 | |
e2f92610 RS |
782 | =head1 COPYRIGHT |
783 | ||
d7b2124a | 784 | Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 785 | |
449040b4 | 786 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
787 | this file except in compliance with the License. You can obtain a copy |
788 | in the file LICENSE in the source distribution or at | |
789 | L<https://www.openssl.org/source/license.html>. | |
790 | ||
791 | =cut |