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