req.pod 20.4 KB
Newer Older
1 2 3 4 5

=pod

=head1 NAME

D
Dr. Stephen Henson 已提交
6
req - PKCS#10 certificate request and certificate generating utility.
7 8 9 10

=head1 SYNOPSIS

B<openssl> B<req>
11
[B<-help>]
12 13 14
[B<-inform PEM|DER>]
[B<-outform PEM|DER>]
[B<-in filename>]
D
Dr. Stephen Henson 已提交
15
[B<-passin arg>]
16
[B<-out filename>]
D
Dr. Stephen Henson 已提交
17
[B<-passout arg>]
18
[B<-text>]
19
[B<-pubkey>]
20 21 22 23
[B<-noout>]
[B<-verify>]
[B<-modulus>]
[B<-new>]
R
Richard Levitte 已提交
24
[B<-rand file(s)>]
25
[B<-newkey rsa:bits>]
D
Dr. Stephen Henson 已提交
26
[B<-newkey alg:file>]
27 28 29 30
[B<-nodes>]
[B<-key filename>]
[B<-keyform PEM|DER>]
[B<-keyout filename>]
D
Dr. Stephen Henson 已提交
31 32
[B<-keygen_engine id>]
[B<-[digest]>]
33
[B<-config filename>]
34
[B<-multivalue-rdn>]
35 36
[B<-x509>]
[B<-days n>]
D
Dr. Stephen Henson 已提交
37
[B<-set_serial n>]
38
[B<-newhdr>]
39 40
[B<-extensions section>]
[B<-reqexts section>]
41
[B<-utf8>]
42
[B<-nameopt>]
D
Dr. Stephen Henson 已提交
43 44 45
[B<-reqopt>]
[B<-subject>]
[B<-subj arg>]
46 47
[B<-batch>]
[B<-verbose>]
48
[B<-engine id>]
49 50 51 52 53 54 55 56 57 58 59

=head1 DESCRIPTION

The B<req> command primarily creates and processes certificate requests
in PKCS#10 format. It can additionally create self signed certificates
for use as root CAs for example.

=head1 COMMAND OPTIONS

=over 4

60 61 62 63
=item B<-help>

Print out a usage message.

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
=item B<-inform DER|PEM>

This specifies the input format. The B<DER> option uses an ASN1 DER encoded
form compatible with the PKCS#10. The B<PEM> form is the default format: it
consists of the B<DER> format base64 encoded with additional header and
footer lines.

=item B<-outform DER|PEM>

This specifies the output format, the options have the same meaning as the 
B<-inform> option.

=item B<-in filename>

This specifies the input filename to read a request from or standard input
if this option is not specified. A request is only read if the creation
options (B<-new> and B<-newkey>) are not specified.

D
Dr. Stephen Henson 已提交
82
=item B<-passin arg>
83

D
Dr. Stephen Henson 已提交
84
the input file password source. For more information about the format of B<arg>
R
Rich Salz 已提交
85
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
86

87 88 89 90 91
=item B<-out filename>

This specifies the output filename to write to or standard output by
default.

D
Dr. Stephen Henson 已提交
92
=item B<-passout arg>
93

D
Dr. Stephen Henson 已提交
94
the output file password source. For more information about the format of B<arg>
R
Rich Salz 已提交
95
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
96

97 98 99 100
=item B<-text>

prints out the certificate request in text form.

D
Dr. Stephen Henson 已提交
101 102 103 104 105
=item B<-subject>

prints out the request subject (or certificate subject if B<-x509> is
specified)

106 107 108 109
=item B<-pubkey>

outputs the public key.

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
=item B<-noout>

this option prevents output of the encoded version of the request.

=item B<-modulus>

this option prints out the value of the modulus of the public key
contained in the request.

=item B<-verify>

verifies the signature on the request.

=item B<-new>

this option generates a new certificate request. It will prompt
the user for the relevant field values. The actual fields
prompted for and their maximum and minimum sizes are specified
in the configuration file and any requested extensions.

If the B<-key> option is not used it will generate a new RSA private
key using information specified in the configuration file.

R
Richard Levitte 已提交
133 134 135
=item B<-rand file(s)>

a file or files containing random data used to seed the random number
R
Rich Salz 已提交
136
generator, or an EGD socket (see L<RAND_egd(3)>).
R
Richard Levitte 已提交
137 138 139 140
Multiple files can be specified separated by a OS-dependent character.
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
all others.

141 142 143
=item B<-newkey arg>

this option creates a new certificate request and a new private
D
Dr. Stephen Henson 已提交
144
key. The argument takes one of several forms. B<rsa:nbits>, where
145
B<nbits> is the number of bits, generates an RSA key B<nbits>
D
Dr. Stephen Henson 已提交
146 147 148 149 150
in size. If B<nbits> is omitted, i.e. B<-newkey rsa> specified,
the default key size, specified in the configuration file is used.

All other algorithms support the B<-newkey alg:file> form, where file may be
an algorithm parameter file, created by the B<genpkey -genparam> command
A
Alok Menghrajani 已提交
151
or and X.509 certificate for a key with appropriate algorithm.
D
Dr. Stephen Henson 已提交
152 153 154 155 156

B<param:file> generates a key using the parameter file or certificate B<file>,
the algorithm is determined by the parameters. B<algname:file> use algorithm
B<algname> and parameter file B<file>: the two algorithms must match or an
error occurs. B<algname> just uses algorithm B<algname>, and parameters,
157
if necessary should be specified via B<-pkeyopt> parameter.
D
Dr. Stephen Henson 已提交
158 159 160 161 162 163 164 165

B<dsa:filename> generates a DSA key using the parameters
in the file B<filename>. B<ec:filename> generates EC key (usable both with
ECDSA or ECDH algorithms), B<gost2001:filename> generates GOST R
34.10-2001 key (requires B<ccgost> engine configured in the configuration
file). If just B<gost2001> is specified a parameter set should be
specified by B<-pkeyopt paramset:X>

D
Dr. Stephen Henson 已提交
166 167 168 169 170 171 172

=item B<-pkeyopt opt:value>

set the public key algorithm option B<opt> to B<value>. The precise set of
options supported depends on the public key algorithm used and its
implementation. See B<KEY GENERATION OPTIONS> in the B<genpkey> manual page
for more details.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

=item B<-key filename>

This specifies the file to read the private key from. It also
accepts PKCS#8 format private keys for PEM format files.

=item B<-keyform PEM|DER>

the format of the private key file specified in the B<-key>
argument. PEM is the default.

=item B<-keyout filename>

this gives the filename to write the newly created private key to.
If this option is not specified then the filename present in the
configuration file is used.

=item B<-nodes>

if this option is specified then if a private key is created it
will not be encrypted.

D
Dr. Stephen Henson 已提交
195 196
=item B<-[digest]>

R
Rich Salz 已提交
197 198 199
this specifies the message digest to sign the request.
Any digest supported by the OpenSSL B<dgst> command can be used.
This overrides the digest algorithm specified in
D
Dr. Stephen Henson 已提交
200
the configuration file.
201

D
Dr. Stephen Henson 已提交
202 203 204
Some public key algorithms may override this choice. For instance, DSA
signatures always use SHA1, GOST R 34.10 signatures always use
GOST R 34.11-94 (B<-md_gost94>).
205 206 207 208 209 210 211

=item B<-config filename>

this allows an alternative configuration file to be specified,
this overrides the compile time filename or any specified in
the B<OPENSSL_CONF> environment variable.

212 213 214 215
=item B<-subj arg>

sets subject name for new request or supersedes the subject name
when processing a request.
216 217
The arg must be formatted as I</type0=value0/type1=value1/type2=...>,
characters may be escaped by \ (backslash), no spaces are skipped.
218

219 220 221 222 223 224 225 226 227
=item B<-multivalue-rdn>

this option causes the -subj argument to be interpreted with full
support for multivalued RDNs. Example:

I</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>

If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>.

228 229 230 231 232
=item B<-x509>

this option outputs a self signed certificate instead of a certificate
request. This is typically used to generate a test certificate or
a self signed root CA. The extensions added to the certificate
D
Dr. Stephen Henson 已提交
233
(if any) are specified in the configuration file. Unless specified
234 235
using the B<set_serial> option, a large random number will be used for
the serial number.
236 237 238 239 240 241

=item B<-days n>

when the B<-x509> option is being used this specifies the number of
days to certify the certificate for. The default is 30 days.

D
Dr. Stephen Henson 已提交
242 243
=item B<-set_serial n>

U
ispell  
Ulf Möller 已提交
244
serial number to use when outputting a self signed certificate. This
D
Dr. Stephen Henson 已提交
245 246 247
may be specified as a decimal value or a hex value if preceded by B<0x>.
It is possible to use negative serial numbers but this is not recommended.

248
=item B<-extensions section>
249

250 251 252 253 254 255 256 257
=item B<-reqexts section>

these options specify alternative sections to include certificate
extensions (if the B<-x509> option is present) or certificate
request extensions. This allows several different sections to
be used in the same configuration file to specify requests for
a variety of purposes.

258 259 260 261 262 263 264
=item B<-utf8>

this option causes field values to be interpreted as UTF8 strings, by 
default they are interpreted as ASCII. This means that the field
values, whether prompted from a terminal or obtained from a
configuration file, must be valid UTF8 strings.

265 266 267 268 269
=item B<-nameopt option>

option which determines how the subject or issuer names are displayed. The
B<option> argument can be a single option or multiple options separated by
commas.  Alternatively the B<-nameopt> switch may be used more than once to
R
Rich Salz 已提交
270
set multiple options. See the L<x509(1)> manual page for details.
271

D
Dr. Stephen Henson 已提交
272 273 274 275 276
=item B<-reqopt>

customise the output format used with B<-text>. The B<option> argument can be
a single option or multiple options separated by commas. 

R
Rich Salz 已提交
277
See discussion of the  B<-certopt> parameter in the L<x509(1)>
D
Dr. Stephen Henson 已提交
278 279
command.

280 281
=item B<-newhdr>

S
Scott Schaefer 已提交
282
Adds the word B<NEW> to the PEM file header and footer lines on the outputted
283 284
request. Some software (Netscape certificate server) and some CAs need this.

285 286 287 288 289 290 291 292
=item B<-batch>

non-interactive mode.

=item B<-verbose>

print extra details about the operations being performed.

293 294
=item B<-engine id>

D
Dr. Stephen Henson 已提交
295
specifying an engine (by its unique B<id> string) will cause B<req>
296 297 298 299
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.

D
Dr. Stephen Henson 已提交
300 301 302 303 304
=item B<-keygen_engine id>

specifies an engine (by its unique B<id> string) which would be used
for key generation operations.

305 306 307 308
=back

=head1 CONFIGURATION FILE FORMAT

309
The configuration options are specified in the B<req> section of
310 311 312 313 314 315 316 317
the configuration file. As with all configuration files if no
value is specified in the specific section (i.e. B<req>) then
the initial unnamed or B<default> section is searched too.

The options available are described in detail below.

=over 4

318 319 320 321
=item B<input_password output_password>

The passwords for the input private key file (if present) and
the output private key file (if one will be created). The
D
Dr. Stephen Henson 已提交
322 323
command line options B<passin> and B<passout> override the
configuration file values.
324

325 326 327 328
=item B<default_bits>

This specifies the default key size in bits. If not specified then
512 is used. It is used if the B<-new> option is used. It can be
329
overridden by using the B<-newkey> option.
330 331 332 333 334

=item B<default_keyfile>

This is the default filename to write a private key to. If not
specified the key is written to standard output. This can be
335
overridden by the B<-keyout> option.
336 337 338 339 340 341 342 343 344 345 346

=item B<oid_file>

This specifies a file containing additional B<OBJECT IDENTIFIERS>.
Each line of the file should consist of the numerical form of the
object identifier followed by white space then the short name followed
by white space and finally the long name. 

=item B<oid_section>

This specifies a section in the configuration file containing extra
347 348
object identifiers. Each line should consist of the short name of the
object identifier followed by B<=> and the numerical form. The short
349 350 351 352 353
and long names are the same when this option is used.

=item B<RANDFILE>

This specifies a filename in which random number seed information is
R
Rich Salz 已提交
354
placed and read from, or an EGD socket (see L<RAND_egd(3)>).
U
Ulf Möller 已提交
355
It is used for private key generation.
356

357
=item B<encrypt_key>
358 359 360

If this is set to B<no> then if a private key is generated it is
B<not> encrypted. This is equivalent to the B<-nodes> command line
361
option. For compatibility B<encrypt_rsa_key> is an equivalent option.
362 363 364

=item B<default_md>

R
Rich Salz 已提交
365 366 367 368
This option specifies the digest algorithm to use.
Any digest supported by the OpenSSL B<dgst> command can be used.
If not present then MD5 is used.
This option can be overridden on the command line.
369

370
=item B<string_mask>
371

372 373
This option masks out the use of certain string types in certain
fields. Most users will not need to change this option.
374 375 376 377 378 379

It can be set to several values B<default> which is also the default
option uses PrintableStrings, T61Strings and BMPStrings if the 
B<pkix> value is used then only PrintableStrings and BMPStrings will
be used. This follows the PKIX recommendation in RFC2459. If the
B<utf8only> option is used then only UTF8Strings will be used: this
380
is the PKIX recommendation in RFC2459 after 2003. Finally the B<nombstr>
381
option just uses PrintableStrings and T61Strings: certain software has
382
problems with BMPStrings and UTF8Strings: in particular Netscape.
383 384 385 386 387

=item B<req_extensions>

this specifies the configuration file section containing a list of
extensions to add to the certificate request. It can be overridden
388
by the B<-reqexts> command line switch. See the 
R
Rich Salz 已提交
389
L<x509v3_config(5)> manual page for details of the
390
extension section format.
391 392 393 394 395 396 397

=item B<x509_extensions>

this specifies the configuration file section containing a list of
extensions to add to certificate generated when the B<-x509> switch
is used. It can be overridden by the B<-extensions> command line switch.

398 399 400 401 402 403
=item B<prompt>

if set to the value B<no> this disables prompting of certificate fields
and just takes values from the config file directly. It also changes the
expected format of the B<distinguished_name> and B<attributes> sections.

404 405 406 407 408 409 410
=item B<utf8>

if set to the value B<yes> then field values to be interpreted as UTF8
strings, by default they are interpreted as ASCII. This means that
the field values, whether prompted from a terminal or obtained from a
configuration file, must be valid UTF8 strings.

411 412 413
=item B<attributes>

this specifies the section containing any request attributes: its format
414 415 416
is the same as B<distinguished_name>. Typically these may contain the
challengePassword or unstructuredName types. They are currently ignored
by OpenSSL's request signing utilities but some CAs might want them.
417 418 419

=item B<distinguished_name>

420
This specifies the section containing the distinguished name fields to
421 422 423 424 425 426 427 428 429 430
prompt for when generating a certificate or certificate request. The format
is described in the next section.

=back

=head1 DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT

There are two separate formats for the distinguished name and attribute
sections. If the B<prompt> option is set to B<no> then these sections
just consist of field names and values: for example,
431

432 433
 CN=My Name
 OU=My Organization
U
Ulf Möller 已提交
434
 emailAddress=someone@somewhere.org
435 436 437

This allows external programs (e.g. GUI based) to generate a template file
with all the field names and values and just pass it to B<req>. An example
438
of this kind of configuration file is contained in the B<EXAMPLES> section.
439

440
Alternatively if the B<prompt> option is absent or not set to B<no> then the
441 442 443 444 445 446
file contains field prompting information. It consists of lines of the form:

 fieldName="prompt"
 fieldName_default="default field value"
 fieldName_min= 2
 fieldName_max= 4
447

448
"fieldName" is the field name being used, for example commonName (or CN).
449
The "prompt" string is used to ask the user to enter the relevant
450 451 452 453 454 455 456 457 458 459 460 461
details. If the user enters nothing then the default value is used if no
default value is present then the field is omitted. A field can
still be omitted if a default value is present if the user just
enters the '.' character.

The number of characters entered must be between the fieldName_min and
fieldName_max limits: there may be additional restrictions based
on the field being used (for example countryName can only ever be
two characters long and must fit in a PrintableString).

Some fields (such as organizationName) can be used more than once
in a DN. This presents a problem because configuration files will
462
not recognize the same name occurring twice. To avoid this problem
463
if the fieldName contains some characters followed by a full stop
464 465 466 467 468 469
they will be ignored. So for example a second organizationName can
be input by calling it "1.organizationName".

The actual permitted field names are any object identifier short or
long names. These are compiled into OpenSSL and include the usual
values such as commonName, countryName, localityName, organizationName,
470
organizationalUnitName, stateOrProvinceName. Additionally emailAddress
471
is include as well as name, surname, givenName initials and dnQualifier.
472 473 474 475 476

Additional object identifiers can be defined with the B<oid_file> or
B<oid_section> options in the configuration file. Any additional fields
will be treated as though they were a DirectoryString.

477

478 479 480 481
=head1 EXAMPLES

Examine and verify certificate request:

482
 openssl req -in req.pem -text -verify -noout
483 484 485

Create a private key and then generate a certificate request from it:

486
 openssl genrsa -out key.pem 2048
487
 openssl req -new -key key.pem -out req.pem
488 489 490

The same but just using req:

491
 openssl req -newkey rsa:2048 -keyout key.pem -out req.pem
492 493 494

Generate a self signed root certificate:

495
 openssl req -x509 -newkey rsa:2048 -keyout key.pem -out req.pem
496 497 498 499 500 501 502 503 504 505 506 507

Example of a file pointed to by the B<oid_file> option:

 1.2.3.4	shortName	A longer Name
 1.2.3.6	otherName	Other longer Name

Example of a section pointed to by B<oid_section> making use of variable
expansion:

 testoid1=1.2.3.5
 testoid2=${testoid1}.6

508
Sample configuration file prompting for field values:
509 510

 [ req ]
511
 default_bits		= 2048
512 513 514
 default_keyfile 	= privkey.pem
 distinguished_name	= req_distinguished_name
 attributes		= req_attributes
515
 req_extensions		= v3_ca
516 517 518 519 520 521

 dirstring_type = nobmp

 [ req_distinguished_name ]
 countryName			= Country Name (2 letter code)
 countryName_default		= AU
522 523
 countryName_min		= 2
 countryName_max		= 2
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

 localityName			= Locality Name (eg, city)

 organizationalUnitName		= Organizational Unit Name (eg, section)

 commonName			= Common Name (eg, YOUR name)
 commonName_max			= 64

 emailAddress			= Email Address
 emailAddress_max		= 40

 [ req_attributes ]
 challengePassword		= A challenge password
 challengePassword_min		= 4
 challengePassword_max		= 20

 [ v3_ca ]

 subjectKeyIdentifier=hash
 authorityKeyIdentifier=keyid:always,issuer:always
 basicConstraints = CA:true
545

546 547 548 549 550 551
Sample configuration containing all field values:


 RANDFILE		= $ENV::HOME/.rnd

 [ req ]
552
 default_bits		= 2048
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
 default_keyfile 	= keyfile.pem
 distinguished_name	= req_distinguished_name
 attributes		= req_attributes
 prompt			= no
 output_password	= mypass

 [ req_distinguished_name ]
 C			= GB
 ST			= Test State or Province
 L			= Test Locality
 O			= Organization Name
 OU			= Organizational Unit Name
 CN			= Common Name
 emailAddress		= test@email.address

 [ req_attributes ]
 challengePassword		= A challenge password


572 573
=head1 NOTES

574
The header and footer lines in the B<PEM> format are normally:
575

D
Typo  
Dr. Stephen Henson 已提交
576 577
 -----BEGIN CERTIFICATE REQUEST-----
 -----END CERTIFICATE REQUEST-----
578 579 580

some software (some versions of Netscape certificate server) instead needs:

D
Typo  
Dr. Stephen Henson 已提交
581 582
 -----BEGIN NEW CERTIFICATE REQUEST-----
 -----END NEW CERTIFICATE REQUEST-----
583

584 585
which is produced with the B<-newhdr> option but is otherwise compatible.
Either form is accepted transparently on input.
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

The certificate requests generated by B<Xenroll> with MSIE have extensions
added. It includes the B<keyUsage> extension which determines the type of
key (signature only or general purpose) and any additional OIDs entered
by the script in an extendedKeyUsage extension.

=head1 DIAGNOSTICS

The following messages are frequently asked about:

	Using configuration from /some/path/openssl.cnf
	Unable to load config info

This is followed some time later by...

	unable to find 'distinguished_name' in config
	problems making Certificate Request

The first error message is the clue: it can't find the configuration
file! Certain operations (like examining a certificate request) don't
need a configuration file so its use isn't enforced. Generation of
607
certificates or requests however does need a configuration file. This
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
could be regarded as a bug.

Another puzzling message is this:

        Attributes:
            a0:00

this is displayed when no attributes are present and the request includes
the correct empty B<SET OF> structure (the DER encoding of which is 0xa0
0x00). If you just see:

        Attributes:

then the B<SET OF> is missing and the encoding is technically invalid (but
it is tolerated). See the description of the command line option B<-asn1-kludge>
for more information.

=head1 ENVIRONMENT VARIABLES

The variable B<OPENSSL_CONF> if defined allows an alternative configuration
file location to be specified, it will be overridden by the B<-config> command
R
Rich Salz 已提交
629
line switch if it is present.
630 631 632

=head1 BUGS

633 634
OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
treats them as ISO-8859-1 (Latin 1), Netscape and MSIE have similar behaviour.
635 636 637 638 639 640 641 642
This can cause problems if you need characters that aren't available in
PrintableStrings and you don't want to or can't use BMPStrings.

As a consequence of the T61String handling the only correct way to represent
accented characters in OpenSSL is to use a BMPString: unfortunately Netscape
currently chokes on these. If you have to use accented characters with Netscape
and MSIE then you currently need to use the invalid T61String form.

643 644 645 646
The current prompting is not very friendly. It doesn't allow you to confirm what
you've just entered. Other things like extensions in certificate requests are
statically defined in the configuration file. Some of these: like an email
address in subjectAltName should be input by the user.
647 648 649

=head1 SEE ALSO

R
Rich Salz 已提交
650 651 652
L<x509(1)>, L<ca(1)>, L<genrsa(1)>,
L<gendsa(1)>, L<config(5)>,
L<x509v3_config(5)> 
653 654

=cut