You must have an empty line between =item's
[openssl.git] / doc / apps / req.pod
1
2 =pod
3
4 =head1 NAME
5
6 req - PKCS#10 certificate and certificate generating utility.
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<req>
11 [B<-inform PEM|DER>]
12 [B<-outform PEM|DER>]
13 [B<-in filename>]
14 [B<-passin arg>]
15 [B<-out filename>]
16 [B<-passout arg>]
17 [B<-text>]
18 [B<-noout>]
19 [B<-verify>]
20 [B<-modulus>]
21 [B<-new>]
22 [B<-newkey rsa:bits>]
23 [B<-newkey dsa:file>]
24 [B<-nodes>]
25 [B<-key filename>]
26 [B<-keyform PEM|DER>]
27 [B<-keyout filename>]
28 [B<-[md5|sha1|md2|mdc2]>]
29 [B<-config filename>]
30 [B<-x509>]
31 [B<-days n>]
32 [B<-asn1-kludge>]
33 [B<-newhdr>]
34 [B<-extensions section>]
35 [B<-reqexts section>]
36
37 =head1 DESCRIPTION
38
39 The B<req> command primarily creates and processes certificate requests
40 in PKCS#10 format. It can additionally create self signed certificates
41 for use as root CAs for example.
42
43 =head1 COMMAND OPTIONS
44
45 =over 4
46
47 =item B<-inform DER|PEM>
48
49 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
50 form compatible with the PKCS#10. The B<PEM> form is the default format: it
51 consists of the B<DER> format base64 encoded with additional header and
52 footer lines.
53
54 =item B<-outform DER|PEM>
55
56 This specifies the output format, the options have the same meaning as the 
57 B<-inform> option.
58
59 =item B<-in filename>
60
61 This specifies the input filename to read a request from or standard input
62 if this option is not specified. A request is only read if the creation
63 options (B<-new> and B<-newkey>) are not specified.
64
65 =item B<-passin arg>
66
67 the input file password source. For more information about the format of B<arg>
68 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
69
70 =item B<-out filename>
71
72 This specifies the output filename to write to or standard output by
73 default.
74
75 =item B<-passout arg>
76
77 the output file password source. For more information about the format of B<arg>
78 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
79
80 =item B<-text>
81
82 prints out the certificate request in text form.
83
84 =item B<-noout>
85
86 this option prevents output of the encoded version of the request.
87
88 =item B<-modulus>
89
90 this option prints out the value of the modulus of the public key
91 contained in the request.
92
93 =item B<-verify>
94
95 verifies the signature on the request.
96
97 =item B<-new>
98
99 this option generates a new certificate request. It will prompt
100 the user for the relevant field values. The actual fields
101 prompted for and their maximum and minimum sizes are specified
102 in the configuration file and any requested extensions.
103
104 If the B<-key> option is not used it will generate a new RSA private
105 key using information specified in the configuration file.
106
107 =item B<-newkey arg>
108
109 this option creates a new certificate request and a new private
110 key. The argument takes one of two forms. B<rsa:nbits>, where
111 B<nbits> is the number of bits, generates an RSA key B<nbits>
112 in size. B<dsa:filename> generates a DSA key using the parameters
113 in the file B<filename>.
114
115 =item B<-key filename>
116
117 This specifies the file to read the private key from. It also
118 accepts PKCS#8 format private keys for PEM format files.
119
120 =item B<-keyform PEM|DER>
121
122 the format of the private key file specified in the B<-key>
123 argument. PEM is the default.
124
125 =item B<-keyout filename>
126
127 this gives the filename to write the newly created private key to.
128 If this option is not specified then the filename present in the
129 configuration file is used.
130
131 =item B<-nodes>
132
133 if this option is specified then if a private key is created it
134 will not be encrypted.
135
136 =item B<-[md5|sha1|md2|mdc2]>
137
138 this specifies the message digest to sign the request with. This
139 overrides the digest algorithm specified in the configuration file.
140 This option is ignored for DSA requests: they always use SHA1.
141
142 =item B<-config filename>
143
144 this allows an alternative configuration file to be specified,
145 this overrides the compile time filename or any specified in
146 the B<OPENSSL_CONF> environment variable.
147
148 =item B<-x509>
149
150 this option outputs a self signed certificate instead of a certificate
151 request. This is typically used to generate a test certificate or
152 a self signed root CA. The extensions added to the certificate
153 (if any) are specified in the configuration file.
154
155 =item B<-days n>
156
157 when the B<-x509> option is being used this specifies the number of
158 days to certify the certificate for. The default is 30 days.
159
160 =item B<-extensions section>
161
162 =item B<-reqexts section>
163
164 these options specify alternative sections to include certificate
165 extensions (if the B<-x509> option is present) or certificate
166 request extensions. This allows several different sections to
167 be used in the same configuration file to specify requests for
168 a variety of purposes.
169
170 =item B<-asn1-kludge>
171
172 by default the B<req> command outputs certificate requests containing
173 no attributes in the correct PKCS#10 format. However certain CAs will only
174 accept requests containing no attributes in an invalid form: this
175 option produces this invalid format.
176
177 More precisely the B<Attributes> in a PKCS#10 certificate request
178 are defined as a B<SET OF Attribute>. They are B<not OPTIONAL> so
179 if no attributes are present then they should be encoded as an
180 empty B<SET OF>. The invalid form does not include the empty
181 B<SET OF> whereas the correct form does.
182
183 It should be noted that very few CAs still require the use of this option.
184
185 =item B<-newhdr>
186
187 Adds the word B<NEW> to the PEM file header and footer lines on the outputed
188 request. Some software (Netscape certificate server) and some CAs need this.
189
190 =back
191
192 =head1 CONFIGURATION FILE FORMAT
193
194 The configuration options are specified in the B<req> section of
195 the configuration file. As with all configuration files if no
196 value is specified in the specific section (i.e. B<req>) then
197 the initial unnamed or B<default> section is searched too.
198
199 The options available are described in detail below.
200
201 =over 4
202
203 =item B<input_password output_password>
204
205 The passwords for the input private key file (if present) and
206 the output private key file (if one will be created). The
207 command line options B<passin> and B<passout> override the
208 configuration file values.
209
210 =item B<default_bits>
211
212 This specifies the default key size in bits. If not specified then
213 512 is used. It is used if the B<-new> option is used. It can be
214 overridden by using the B<-newkey> option.
215
216 =item B<default_keyfile>
217
218 This is the default filename to write a private key to. If not
219 specified the key is written to standard output. This can be
220 overridden by the B<-keyout> option.
221
222 =item B<oid_file>
223
224 This specifies a file containing additional B<OBJECT IDENTIFIERS>.
225 Each line of the file should consist of the numerical form of the
226 object identifier followed by white space then the short name followed
227 by white space and finally the long name. 
228
229 =item B<oid_section>
230
231 This specifies a section in the configuration file containing extra
232 object identifiers. Each line should consist of the short name of the
233 object identifier followed by B<=> and the numerical form. The short
234 and long names are the same when this option is used.
235
236 =item B<RANDFILE>
237
238 This specifies a filename in which random number seed information is
239 placed and read from, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
240 It is used for private key generation.
241
242 =item B<encrypt_key>
243
244 If this is set to B<no> then if a private key is generated it is
245 B<not> encrypted. This is equivalent to the B<-nodes> command line
246 option. For compatibility B<encrypt_rsa_key> is an equivalent option.
247
248 =item B<default_md>
249
250 This option specifies the digest algorithm to use. Possible values
251 include B<md5 sha1 mdc2>. If not present then MD5 is used. This
252 option can be overridden on the command line.
253
254 =item B<string_mask>
255
256 This option masks out the use of certain string types in certain
257 fields. Most users will not need to change this option.
258
259 It can be set to several values B<default> which is also the default
260 option uses PrintableStrings, T61Strings and BMPStrings if the 
261 B<pkix> value is used then only PrintableStrings and BMPStrings will
262 be used. This follows the PKIX recommendation in RFC2459. If the
263 B<utf8only> option is used then only UTF8Strings will be used: this
264 is the PKIX recommendation in RFC2459 after 2003. Finally the B<nombstr>
265 option just uses PrintableStrings and T61Strings: certain software has
266 problems with BMPStrings and UTF8Strings: in particular Netscape.
267
268 =item B<req_extensions>
269
270 this specifies the configuration file section containing a list of
271 extensions to add to the certificate request. It can be overridden
272 by the B<-reqexts> command line switch.
273
274 =item B<x509_extensions>
275
276 this specifies the configuration file section containing a list of
277 extensions to add to certificate generated when the B<-x509> switch
278 is used. It can be overridden by the B<-extensions> command line switch.
279
280 =item B<prompt>
281
282 if set to the value B<no> this disables prompting of certificate fields
283 and just takes values from the config file directly. It also changes the
284 expected format of the B<distinguished_name> and B<attributes> sections.
285
286 =item B<attributes>
287
288 this specifies the section containing any request attributes: its format
289 is the same as B<distinguished_name>. Typically these may contain the
290 challengePassword or unstructuredName types. They are currently ignored
291 by OpenSSL's request signing utilities but some CAs might want them.
292
293 =item B<distinguished_name>
294
295 This specifies the section containing the distinguished name fields to
296 prompt for when generating a certificate or certificate request. The format
297 is described in the next section.
298
299 =back
300
301 =head1 DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT
302
303 There are two separate formats for the distinguished name and attribute
304 sections. If the B<prompt> option is set to B<no> then these sections
305 just consist of field names and values: for example,
306
307  CN=My Name
308  OU=My Organization
309  emailAddress=someone@somewhere.org
310
311 This allows external programs (e.g. GUI based) to generate a template file
312 with all the field names and values and just pass it to B<req>. An example
313 of this kind of configuration file is contained in the B<EXAMPLES> section.
314
315 Alternatively if the B<prompt> option is absent or not set to B<no> then the
316 file contains field prompting information. It consists of lines of the form:
317
318  fieldName="prompt"
319  fieldName_default="default field value"
320  fieldName_min= 2
321  fieldName_max= 4
322
323 "fieldName" is the field name being used, for example commonName (or CN).
324 The "prompt" string is used to ask the user to enter the relevant
325 details. If the user enters nothing then the default value is used if no
326 default value is present then the field is omitted. A field can
327 still be omitted if a default value is present if the user just
328 enters the '.' character.
329
330 The number of characters entered must be between the fieldName_min and
331 fieldName_max limits: there may be additional restrictions based
332 on the field being used (for example countryName can only ever be
333 two characters long and must fit in a PrintableString).
334
335 Some fields (such as organizationName) can be used more than once
336 in a DN. This presents a problem because configuration files will
337 not recognize the same name occurring twice. To avoid this problem
338 if the fieldName contains some characters followed by a full stop
339 they will be ignored. So for example a second organizationName can
340 be input by calling it "1.organizationName".
341
342 The actual permitted field names are any object identifier short or
343 long names. These are compiled into OpenSSL and include the usual
344 values such as commonName, countryName, localityName, organizationName,
345 organizationUnitName, stateOrPrivinceName. Additionally emailAddress
346 is include as well as name, surname, givenName initials and dnQualifier.
347
348 Additional object identifiers can be defined with the B<oid_file> or
349 B<oid_section> options in the configuration file. Any additional fields
350 will be treated as though they were a DirectoryString.
351
352
353 =head1 EXAMPLES
354
355 Examine and verify certificate request:
356
357  openssl req -in req.pem -text -verify -noout
358
359 Create a private key and then generate a certificate request from it:
360
361  openssl genrsa -out key.pem 1024
362  openssl req -new -key key.pem -out req.pem
363
364 The same but just using req:
365
366  openssl req -newkey rsa:1024 -keyout key.pem -out req.pem
367
368 Generate a self signed root certificate:
369
370  openssl req -x509 -newkey rsa:1024 -keyout key.pem -out req.pem
371
372 Example of a file pointed to by the B<oid_file> option:
373
374  1.2.3.4        shortName       A longer Name
375  1.2.3.6        otherName       Other longer Name
376
377 Example of a section pointed to by B<oid_section> making use of variable
378 expansion:
379
380  testoid1=1.2.3.5
381  testoid2=${testoid1}.6
382
383 Sample configuration file prompting for field values:
384
385  [ req ]
386  default_bits           = 1024
387  default_keyfile        = privkey.pem
388  distinguished_name     = req_distinguished_name
389  attributes             = req_attributes
390  x509_extensions        = v3_ca
391
392  dirstring_type = nobmp
393
394  [ req_distinguished_name ]
395  countryName                    = Country Name (2 letter code)
396  countryName_default            = AU
397  countryName_min                = 2
398  countryName_max                = 2
399
400  localityName                   = Locality Name (eg, city)
401
402  organizationalUnitName         = Organizational Unit Name (eg, section)
403
404  commonName                     = Common Name (eg, YOUR name)
405  commonName_max                 = 64
406
407  emailAddress                   = Email Address
408  emailAddress_max               = 40
409
410  [ req_attributes ]
411  challengePassword              = A challenge password
412  challengePassword_min          = 4
413  challengePassword_max          = 20
414
415  [ v3_ca ]
416
417  subjectKeyIdentifier=hash
418  authorityKeyIdentifier=keyid:always,issuer:always
419  basicConstraints = CA:true
420
421 Sample configuration containing all field values:
422
423
424  RANDFILE               = $ENV::HOME/.rnd
425
426  [ req ]
427  default_bits           = 1024
428  default_keyfile        = keyfile.pem
429  distinguished_name     = req_distinguished_name
430  attributes             = req_attributes
431  prompt                 = no
432  output_password        = mypass
433
434  [ req_distinguished_name ]
435  C                      = GB
436  ST                     = Test State or Province
437  L                      = Test Locality
438  O                      = Organization Name
439  OU                     = Organizational Unit Name
440  CN                     = Common Name
441  emailAddress           = test@email.address
442
443  [ req_attributes ]
444  challengePassword              = A challenge password
445
446
447 =head1 NOTES
448
449 The header and footer lines in the B<PEM> format are normally:
450
451  -----BEGIN CERTIFICATE REQUEST----
452  -----END CERTIFICATE REQUEST----
453
454 some software (some versions of Netscape certificate server) instead needs:
455
456  -----BEGIN NEW CERTIFICATE REQUEST----
457  -----END NEW CERTIFICATE REQUEST----
458
459 which is produced with the B<-newhdr> option but is otherwise compatible.
460 Either form is accepted transparently on input.
461
462 The certificate requests generated by B<Xenroll> with MSIE have extensions
463 added. It includes the B<keyUsage> extension which determines the type of
464 key (signature only or general purpose) and any additional OIDs entered
465 by the script in an extendedKeyUsage extension.
466
467 =head1 DIAGNOSTICS
468
469 The following messages are frequently asked about:
470
471         Using configuration from /some/path/openssl.cnf
472         Unable to load config info
473
474 This is followed some time later by...
475
476         unable to find 'distinguished_name' in config
477         problems making Certificate Request
478
479 The first error message is the clue: it can't find the configuration
480 file! Certain operations (like examining a certificate request) don't
481 need a configuration file so its use isn't enforced. Generation of
482 certificates or requests however does need a configuration file. This
483 could be regarded as a bug.
484
485 Another puzzling message is this:
486
487         Attributes:
488             a0:00
489
490 this is displayed when no attributes are present and the request includes
491 the correct empty B<SET OF> structure (the DER encoding of which is 0xa0
492 0x00). If you just see:
493
494         Attributes:
495
496 then the B<SET OF> is missing and the encoding is technically invalid (but
497 it is tolerated). See the description of the command line option B<-asn1-kludge>
498 for more information.
499
500 =head1 ENVIRONMENT VARIABLES
501
502 The variable B<OPENSSL_CONF> if defined allows an alternative configuration
503 file location to be specified, it will be overridden by the B<-config> command
504 line switch if it is present. For compatibility reasons the B<SSLEAY_CONF>
505 environment variable serves the same purpose but its use is discouraged.
506
507 =head1 BUGS
508
509 OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
510 treats them as ISO-8859-1 (Latin 1), Netscape and MSIE have similar behaviour.
511 This can cause problems if you need characters that aren't available in
512 PrintableStrings and you don't want to or can't use BMPStrings.
513
514 As a consequence of the T61String handling the only correct way to represent
515 accented characters in OpenSSL is to use a BMPString: unfortunately Netscape
516 currently chokes on these. If you have to use accented characters with Netscape
517 and MSIE then you currently need to use the invalid T61String form.
518
519 The current prompting is not very friendly. It doesn't allow you to confirm what
520 you've just entered. Other things like extensions in certificate requests are
521 statically defined in the configuration file. Some of these: like an email
522 address in subjectAltName should be input by the user.
523
524 =head1 SEE ALSO
525
526 L<x509(1)|x509(1)>, L<ca(1)|ca(1)>, L<genrsa(1)|genrsa(1)>,
527 L<gendsa(1)|gendsa(1)>, L<config(5)|config(5)>
528
529 =cut