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