17ffe9ade68f4bb91819c457144e33f732b16139
[openssl.git] / doc / man1 / openssl-req.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-req - PKCS#10 certificate request and certificate generating utility
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<req>
11 [B<-help>]
12 [B<-inform> B<DER>|B<PEM>]
13 [B<-outform> B<DER>|B<PEM>]
14 [B<-in> I<filename>]
15 [B<-passin> I<arg>]
16 [B<-out> I<filename>]
17 [B<-passout> I<arg>]
18 [B<-text>]
19 [B<-pubkey>]
20 [B<-noout>]
21 [B<-verify>]
22 [B<-modulus>]
23 [B<-new>]
24 [B<-newkey> I<arg>]
25 [B<-nodes>]
26 [B<-key> I<filename>]
27 [B<-keyform> B<DER>|B<PEM>]
28 [B<-keyout> I<filename>]
29 [B<-keygen_engine> I<id>]
30 [B<-I<digest>>]
31 [B<-config> I<filename>]
32 [B<-multivalue-rdn>]
33 [B<-x509>]
34 [B<-days> I<n>]
35 [B<-set_serial> I<n>]
36 [B<-newhdr>]
37 [B<-addext> I<ext>]
38 [B<-extensions> I<section>]
39 [B<-reqexts> I<section>]
40 [B<-precert>]
41 [B<-utf8>]
42 [B<-reqopt>]
43 [B<-subject>]
44 [B<-subj> I<arg>]
45 [B<-sigopt> I<nm>:I<v>]
46 [B<-batch>]
47 [B<-verbose>]
48 [B<-engine> I<id>]
49 [B<-sm2-id> I<string>]
50 [B<-sm2-hex-id> I<hex-string>]
51 {- $OpenSSL::safe::opt_name_synopsis -}
52 {- $OpenSSL::safe::opt_r_synopsis -}
53
54 =for openssl ifdef engine keygen_engine sm2-id sm2-hex-id
55
56 =head1 DESCRIPTION
57
58 This command primarily creates and processes certificate requests
59 in PKCS#10 format. It can additionally create self signed certificates
60 for use as root CAs for example.
61
62 =head1 OPTIONS
63
64 =over 4
65
66 =item B<-help>
67
68 Print out a usage message.
69
70 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
71
72 The input and formats; the default is B<PEM>.
73 See L<openssl(1)/Format Options> for details.
74
75 The data is a PKCS#10 object.
76
77 =item B<-in> I<filename>
78
79 This specifies the input filename to read a request from or standard input
80 if this option is not specified. A request is only read if the creation
81 options (B<-new> and B<-newkey>) are not specified.
82
83 =item B<-sigopt> I<nm>:I<v>
84
85 Pass options to the signature algorithm during sign or verify operations.
86 Names and values of these options are algorithm-specific.
87
88 =item B<-passin> I<arg>, B<-passout> I<arg>
89
90 The password source for the input and output file.
91 For more information about the format of B<arg>
92 see L<openssl(1)/Pass Phrase Options>.
93
94 =item B<-out> I<filename>
95
96 This specifies the output filename to write to or standard output by
97 default.
98
99 =item B<-text>
100
101 Prints out the certificate request in text form.
102
103 =item B<-subject>
104
105 Prints out the request subject (or certificate subject if B<-x509> is
106 specified)
107
108 =item B<-pubkey>
109
110 Outputs the public key.
111
112 =item B<-noout>
113
114 This option prevents output of the encoded version of the request.
115
116 =item B<-modulus>
117
118 This option prints out the value of the modulus of the public key
119 contained in the request.
120
121 =item B<-verify>
122
123 Verifies the signature on the request.
124
125 =item B<-new>
126
127 This option generates a new certificate request. It will prompt
128 the user for the relevant field values. The actual fields
129 prompted for and their maximum and minimum sizes are specified
130 in the configuration file and any requested extensions.
131
132 If the B<-key> option is not used it will generate a new RSA private
133 key using information specified in the configuration file.
134
135 =item B<-newkey> I<arg>
136
137 This option creates a new certificate request and a new private
138 key. The argument takes one of several forms.
139
140 B<rsa:>I<nbits>, where
141 I<nbits> is the number of bits, generates an RSA key I<nbits>
142 in size. If I<nbits> is omitted, i.e. B<-newkey> I<rsa> specified,
143 the default key size, specified in the configuration file is used.
144
145 All other algorithms support the B<-newkey> I<alg>:I<file> form, where file
146 may be an algorithm parameter file, created with C<openssl genpkey -genparam>
147 or an X.509 certificate for a key with appropriate algorithm.
148
149 B<param:>I<file> generates a key using the parameter file or certificate
150 I<file>, the algorithm is determined by the parameters. I<algname>:I<file>
151 use algorithm I<algname> and parameter file I<file>: the two algorithms must
152 match or an error occurs. I<algname> just uses algorithm I<algname>, and
153 parameters, if necessary should be specified via B<-pkeyopt> parameter.
154
155 B<dsa:>I<filename> generates a DSA key using the parameters
156 in the file I<filename>. B<ec:>I<filename> generates EC key (usable both with
157 ECDSA or ECDH algorithms), B<gost2001:>I<filename> generates GOST R
158 34.10-2001 key (requires B<gost> engine configured in the configuration
159 file). If just B<gost2001> is specified a parameter set should be
160 specified by B<-pkeyopt> I<paramset:X>
161
162 =item B<-pkeyopt> I<opt>:I<value>
163
164 Set the public key algorithm option I<opt> to I<value>. The precise set of
165 options supported depends on the public key algorithm used and its
166 implementation.
167 See L<openssl-genpkey(1)/KEY GENERATION OPTIONS> for more details.
168
169 =item B<-key> I<filename>
170
171 This specifies the file to read the private key from. It also
172 accepts PKCS#8 format private keys for PEM format files.
173
174 =item B<-keyform> B<DER>|B<PEM>
175
176 The format of the private key; the default is B<PEM>.
177 See L<openssl(1)/Format Options> for details.
178
179 =item B<-keyout> I<filename>
180
181 This gives the filename to write the newly created private key to.
182 If this option is not specified then the filename present in the
183 configuration file is used.
184
185 =item B<-nodes>
186
187 If this option is specified then if a private key is created it
188 will not be encrypted.
189
190 =item B<-I<digest>>
191
192 This specifies the message digest to sign the request.
193 Any digest supported by the OpenSSL B<dgst> command can be used.
194 This overrides the digest algorithm specified in
195 the configuration file.
196
197 Some public key algorithms may override this choice. For instance, DSA
198 signatures always use SHA1, GOST R 34.10 signatures always use
199 GOST R 34.11-94 (B<-md_gost94>), Ed25519 and Ed448 never use any digest.
200
201 =item B<-config> I<filename>
202
203 This allows an alternative configuration file to be specified.
204 Optional; for a description of the default value,
205 see L<openssl(1)/COMMAND SUMMARY>.
206
207 =item B<-subj> I<arg>
208
209 Sets subject name for new request or supersedes the subject name
210 when processing a request.
211 The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
212 Keyword characters may be escaped by \ (backslash), and whitespace is retained.
213 Empty values are permitted, but the corresponding type will not be included
214 in the request.
215
216 =item B<-multivalue-rdn>
217
218 This option causes the -subj argument to be interpreted with full
219 support for multivalued RDNs. Example:
220
221 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
222
223 If -multi-rdn is not used then the UID value is C<123456+CN=John Doe>.
224
225 =item B<-x509>
226
227 This option outputs a self signed certificate instead of a certificate
228 request. This is typically used to generate a test certificate or
229 a self signed root CA. The extensions added to the certificate
230 (if any) are specified in the configuration file. Unless specified
231 using the B<-set_serial> option, a large random number will be used for
232 the serial number.
233
234 If existing request is specified with the B<-in> option, it is converted
235 to the self signed certificate otherwise new request is created.
236
237 =item B<-days> I<n>
238
239 When the B<-x509> option is being used this specifies the number of
240 days to certify the certificate for, otherwise it is ignored. I<n> should
241 be a positive integer. The default is 30 days.
242
243 =item B<-set_serial> I<n>
244
245 Serial number to use when outputting a self signed certificate. This
246 may be specified as a decimal value or a hex value if preceded by C<0x>.
247
248 =item B<-addext> I<ext>
249
250 Add a specific extension to the certificate (if the B<-x509> option is
251 present) or certificate request.  The argument must have the form of
252 a key=value pair as it would appear in a config file.
253
254 This option can be given multiple times.
255
256 =item B<-extensions> I<section>
257
258 =item B<-reqexts> I<section>
259
260 These options specify alternative sections to include certificate
261 extensions (if the B<-x509> option is present) or certificate
262 request extensions. This allows several different sections to
263 be used in the same configuration file to specify requests for
264 a variety of purposes.
265
266 =item B<-precert>
267
268 A poison extension will be added to the certificate, making it a
269 "pre-certificate" (see RFC6962). This can be submitted to Certificate
270 Transparency logs in order to obtain signed certificate timestamps (SCTs).
271 These SCTs can then be embedded into the pre-certificate as an extension, before
272 removing the poison and signing the certificate.
273
274 This implies the B<-new> flag.
275
276 =item B<-utf8>
277
278 This option causes field values to be interpreted as UTF8 strings, by
279 default they are interpreted as ASCII. This means that the field
280 values, whether prompted from a terminal or obtained from a
281 configuration file, must be valid UTF8 strings.
282
283 =item B<-reqopt> I<option>
284
285 Customise the output format used with B<-text>. The I<option> argument can be
286 a single option or multiple options separated by commas.
287
288 See discussion of the  B<-certopt> parameter in the L<openssl-x509(1)>
289 command.
290
291 =item B<-newhdr>
292
293 Adds the word B<NEW> to the PEM file header and footer lines on the outputted
294 request. Some software (Netscape certificate server) and some CAs need this.
295
296 =item B<-batch>
297
298 Non-interactive mode.
299
300 =item B<-verbose>
301
302 Print extra details about the operations being performed.
303
304 =item B<-engine> I<id>
305
306 Specifying an engine (by its unique I<id> string) will cause this command
307 to attempt to obtain a functional reference to the specified engine,
308 thus initialising it if needed. The engine will then be set as the default
309 for all available algorithms.
310
311 =item B<-keygen_engine> I<id>
312
313 Specifies an engine (by its unique I<id> string) which would be used
314 for key generation operations.
315
316 =item B<-sm2-id>
317
318 Specify the ID string to use when verifying an SM2 certificate request. The ID
319 string is required by the SM2 signature algorithm for signing and verification.
320
321 =item B<-sm2-hex-id>
322
323 Specify a binary ID string to use when verifying an SM2 certificate request. The
324 argument for this option is string of hexadecimal digits.
325
326 {- $OpenSSL::safe::opt_name_item -}
327
328 {- $OpenSSL::safe::opt_r_item -}
329
330 =back
331
332 =head1 CONFIGURATION FILE FORMAT
333
334 The configuration options are specified in the B<req> section of
335 the configuration file. As with all configuration files if no
336 value is specified in the specific section (i.e. B<req>) then
337 the initial unnamed or B<default> section is searched too.
338
339 The options available are described in detail below.
340
341 =over 4
342
343 =item B<input_password output_password>
344
345 The passwords for the input private key file (if present) and
346 the output private key file (if one will be created). The
347 command line options B<passin> and B<passout> override the
348 configuration file values.
349
350 =item B<default_bits>
351
352 Specifies the default key size in bits.
353
354 This option is used in conjunction with the B<-new> option to generate
355 a new key. It can be overridden by specifying an explicit key size in
356 the B<-newkey> option. The smallest accepted key size is 512 bits. If
357 no key size is specified then 2048 bits is used.
358
359 =item B<default_keyfile>
360
361 This is the default filename to write a private key to. If not
362 specified the key is written to standard output. This can be
363 overridden by the B<-keyout> option.
364
365 =item B<oid_file>
366
367 This specifies a file containing additional B<OBJECT IDENTIFIERS>.
368 Each line of the file should consist of the numerical form of the
369 object identifier followed by white space then the short name followed
370 by white space and finally the long name.
371
372 =item B<oid_section>
373
374 This specifies a section in the configuration file containing extra
375 object identifiers. Each line should consist of the short name of the
376 object identifier followed by B<=> and the numerical form. The short
377 and long names are the same when this option is used.
378
379 =item B<RANDFILE>
380
381 At startup the specified file is loaded into the random number generator,
382 and at exit 256 bytes will be written to it.
383 It is used for private key generation.
384
385 =item B<encrypt_key>
386
387 If this is set to B<no> then if a private key is generated it is
388 B<not> encrypted. This is equivalent to the B<-nodes> command line
389 option. For compatibility B<encrypt_rsa_key> is an equivalent option.
390
391 =item B<default_md>
392
393 This option specifies the digest algorithm to use. Any digest supported by the
394 OpenSSL B<dgst> command can be used. This option can be overridden on the
395 command line. Certain signing algorithms (i.e. Ed25519 and Ed448) will ignore
396 any digest that has been set.
397
398 =item B<string_mask>
399
400 This option masks out the use of certain string types in certain
401 fields. Most users will not need to change this option.
402
403 It can be set to several values B<default> which is also the default
404 option uses PrintableStrings, T61Strings and BMPStrings if the
405 B<pkix> value is used then only PrintableStrings and BMPStrings will
406 be used. This follows the PKIX recommendation in RFC2459. If the
407 B<utf8only> option is used then only UTF8Strings will be used: this
408 is the PKIX recommendation in RFC2459 after 2003. Finally the B<nombstr>
409 option just uses PrintableStrings and T61Strings: certain software has
410 problems with BMPStrings and UTF8Strings: in particular Netscape.
411
412 =item B<req_extensions>
413
414 This specifies the configuration file section containing a list of
415 extensions to add to the certificate request. It can be overridden
416 by the B<-reqexts> command line switch. See the
417 L<x509v3_config(5)> manual page for details of the
418 extension section format.
419
420 =item B<x509_extensions>
421
422 This specifies the configuration file section containing a list of
423 extensions to add to certificate generated when the B<-x509> switch
424 is used. It can be overridden by the B<-extensions> command line switch.
425
426 =item B<prompt>
427
428 If set to the value B<no> this disables prompting of certificate fields
429 and just takes values from the config file directly. It also changes the
430 expected format of the B<distinguished_name> and B<attributes> sections.
431
432 =item B<utf8>
433
434 If set to the value B<yes> then field values to be interpreted as UTF8
435 strings, by default they are interpreted as ASCII. This means that
436 the field values, whether prompted from a terminal or obtained from a
437 configuration file, must be valid UTF8 strings.
438
439 =item B<attributes>
440
441 This specifies the section containing any request attributes: its format
442 is the same as B<distinguished_name>. Typically these may contain the
443 challengePassword or unstructuredName types. They are currently ignored
444 by OpenSSL's request signing utilities but some CAs might want them.
445
446 =item B<distinguished_name>
447
448 This specifies the section containing the distinguished name fields to
449 prompt for when generating a certificate or certificate request. The format
450 is described in the next section.
451
452 =back
453
454 =head1 DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT
455
456 There are two separate formats for the distinguished name and attribute
457 sections. If the B<prompt> option is set to B<no> then these sections
458 just consist of field names and values: for example,
459
460  CN=My Name
461  OU=My Organization
462  emailAddress=someone@somewhere.org
463
464 This allows external programs (e.g. GUI based) to generate a template file with
465 all the field names and values and just pass it to this command. An example
466 of this kind of configuration file is contained in the B<EXAMPLES> section.
467
468 Alternatively if the B<prompt> option is absent or not set to B<no> then the
469 file contains field prompting information. It consists of lines of the form:
470
471  fieldName="prompt"
472  fieldName_default="default field value"
473  fieldName_min= 2
474  fieldName_max= 4
475
476 "fieldName" is the field name being used, for example commonName (or CN).
477 The "prompt" string is used to ask the user to enter the relevant
478 details. If the user enters nothing then the default value is used if no
479 default value is present then the field is omitted. A field can
480 still be omitted if a default value is present if the user just
481 enters the '.' character.
482
483 The number of characters entered must be between the fieldName_min and
484 fieldName_max limits: there may be additional restrictions based
485 on the field being used (for example countryName can only ever be
486 two characters long and must fit in a PrintableString).
487
488 Some fields (such as organizationName) can be used more than once
489 in a DN. This presents a problem because configuration files will
490 not recognize the same name occurring twice. To avoid this problem
491 if the fieldName contains some characters followed by a full stop
492 they will be ignored. So for example a second organizationName can
493 be input by calling it "1.organizationName".
494
495 The actual permitted field names are any object identifier short or
496 long names. These are compiled into OpenSSL and include the usual
497 values such as commonName, countryName, localityName, organizationName,
498 organizationalUnitName, stateOrProvinceName. Additionally emailAddress
499 is included as well as name, surname, givenName, initials, and dnQualifier.
500
501 Additional object identifiers can be defined with the B<oid_file> or
502 B<oid_section> options in the configuration file. Any additional fields
503 will be treated as though they were a DirectoryString.
504
505
506 =head1 EXAMPLES
507
508 Examine and verify certificate request:
509
510  openssl req -in req.pem -text -verify -noout
511
512 Create a private key and then generate a certificate request from it:
513
514  openssl genrsa -out key.pem 2048
515  openssl req -new -key key.pem -out req.pem
516
517 The same but just using req:
518
519  openssl req -newkey rsa:2048 -keyout key.pem -out req.pem
520
521 Generate a self signed root certificate:
522
523  openssl req -x509 -newkey rsa:2048 -keyout key.pem -out req.pem
524
525 Create an SM2 private key and then generate a certificate request from it:
526
527  openssl ecparam -genkey -name SM2 -out sm2.key
528  openssl req -new -key sm2.key -out sm2.csr -sm3 -sigopt "sm2_id:1234567812345678"
529
530 Examine and verify an SM2 certificate request:
531
532  openssl req -verify -in sm2.csr -sm3 -sm2-id 1234567812345678
533
534 Example of a file pointed to by the B<oid_file> option:
535
536  1.2.3.4        shortName       A longer Name
537  1.2.3.6        otherName       Other longer Name
538
539 Example of a section pointed to by B<oid_section> making use of variable
540 expansion:
541
542  testoid1=1.2.3.5
543  testoid2=${testoid1}.6
544
545 Sample configuration file prompting for field values:
546
547  [ req ]
548  default_bits           = 2048
549  default_keyfile        = privkey.pem
550  distinguished_name     = req_distinguished_name
551  attributes             = req_attributes
552  req_extensions         = v3_ca
553
554  dirstring_type = nobmp
555
556  [ req_distinguished_name ]
557  countryName                    = Country Name (2 letter code)
558  countryName_default            = AU
559  countryName_min                = 2
560  countryName_max                = 2
561
562  localityName                   = Locality Name (eg, city)
563
564  organizationalUnitName         = Organizational Unit Name (eg, section)
565
566  commonName                     = Common Name (eg, YOUR name)
567  commonName_max                 = 64
568
569  emailAddress                   = Email Address
570  emailAddress_max               = 40
571
572  [ req_attributes ]
573  challengePassword              = A challenge password
574  challengePassword_min          = 4
575  challengePassword_max          = 20
576
577  [ v3_ca ]
578
579  subjectKeyIdentifier=hash
580  authorityKeyIdentifier=keyid:always,issuer:always
581  basicConstraints = critical, CA:true
582
583 Sample configuration containing all field values:
584
585
586  [ req ]
587  default_bits           = 2048
588  default_keyfile        = keyfile.pem
589  distinguished_name     = req_distinguished_name
590  attributes             = req_attributes
591  prompt                 = no
592  output_password        = mypass
593
594  [ req_distinguished_name ]
595  C                      = GB
596  ST                     = Test State or Province
597  L                      = Test Locality
598  O                      = Organization Name
599  OU                     = Organizational Unit Name
600  CN                     = Common Name
601  emailAddress           = test@email.address
602
603  [ req_attributes ]
604  challengePassword              = A challenge password
605
606 Example of giving the most common attributes (subject and extensions)
607 on the command line:
608
609  openssl req -new -subj "/C=GB/CN=foo" \
610                   -addext "subjectAltName = DNS:foo.co.uk" \
611                   -addext "certificatePolicies = 1.2.3.4" \
612                   -newkey rsa:2048 -keyout key.pem -out req.pem
613
614
615 =head1 NOTES
616
617 The certificate requests generated by B<Xenroll> with MSIE have extensions
618 added. It includes the B<keyUsage> extension which determines the type of
619 key (signature only or general purpose) and any additional OIDs entered
620 by the script in an B<extendedKeyUsage> extension.
621
622 =head1 DIAGNOSTICS
623
624 The following messages are frequently asked about:
625
626         Using configuration from /some/path/openssl.cnf
627         Unable to load config info
628
629 This is followed some time later by:
630
631         unable to find 'distinguished_name' in config
632         problems making Certificate Request
633
634 The first error message is the clue: it can't find the configuration
635 file! Certain operations (like examining a certificate request) don't
636 need a configuration file so its use isn't enforced. Generation of
637 certificates or requests however does need a configuration file. This
638 could be regarded as a bug.
639
640 Another puzzling message is this:
641
642         Attributes:
643             a0:00
644
645 this is displayed when no attributes are present and the request includes
646 the correct empty B<SET OF> structure (the DER encoding of which is 0xa0
647 0x00). If you just see:
648
649         Attributes:
650
651 then the B<SET OF> is missing and the encoding is technically invalid (but
652 it is tolerated). See the description of the command line option B<-asn1-kludge>
653 for more information.
654
655 =head1 BUGS
656
657 OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
658 treats them as ISO-8859-1 (Latin 1), Netscape and MSIE have similar behaviour.
659 This can cause problems if you need characters that aren't available in
660 PrintableStrings and you don't want to or can't use BMPStrings.
661
662 As a consequence of the T61String handling the only correct way to represent
663 accented characters in OpenSSL is to use a BMPString: unfortunately Netscape
664 currently chokes on these. If you have to use accented characters with Netscape
665 and MSIE then you currently need to use the invalid T61String form.
666
667 The current prompting is not very friendly. It doesn't allow you to confirm what
668 you've just entered. Other things like extensions in certificate requests are
669 statically defined in the configuration file. Some of these: like an email
670 address in subjectAltName should be input by the user.
671
672 =head1 SEE ALSO
673
674 L<openssl(1)>,
675 L<openssl-x509(1)>,
676 L<openssl-ca(1)>,
677 L<openssl-genrsa(1)>,
678 L<openssl-gendsa(1)>,
679 L<config(5)>,
680 L<x509v3_config(5)>
681
682 =head1 COPYRIGHT
683
684 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
685
686 Licensed under the Apache License 2.0 (the "License").  You may not use
687 this file except in compliance with the License.  You can obtain a copy
688 in the file LICENSE in the source distribution or at
689 L<https://www.openssl.org/source/license.html>.
690
691 =cut