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