secure/usr.bin/openssl/man/req.1

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "REQ 1"
 136 .TH REQ 1 "2015-12-03" "0.9.8zh" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 req \- PKCS#10 certificate request and certificate generating utility.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBreq\fR
 146 [\fB\-inform PEM|DER\fR]
 147 [\fB\-outform PEM|DER\fR]
 148 [\fB\-in filename\fR]
 149 [\fB\-passin arg\fR]
 150 [\fB\-out filename\fR]
 151 [\fB\-passout arg\fR]
 152 [\fB\-text\fR]
 153 [\fB\-pubkey\fR]
 154 [\fB\-noout\fR]
 155 [\fB\-verify\fR]
 156 [\fB\-modulus\fR]
 157 [\fB\-new\fR]
 158 [\fB\-rand file(s)\fR]
 159 [\fB\-newkey rsa:bits\fR]
 160 [\fB\-newkey dsa:file\fR]
 161 [\fB\-nodes\fR]
 162 [\fB\-key filename\fR]
 163 [\fB\-keyform PEM|DER\fR]
 164 [\fB\-keyout filename\fR]
 165 [\fB\-[md5|sha1|md2|mdc2]\fR]
 166 [\fB\-config filename\fR]
 167 [\fB\-subj arg\fR]
 168 [\fB\-multivalue\-rdn\fR]
 169 [\fB\-x509\fR]
 170 [\fB\-days n\fR]
 171 [\fB\-set_serial n\fR]
 172 [\fB\-asn1\-kludge\fR]
 173 [\fB\-newhdr\fR]
 174 [\fB\-extensions section\fR]
 175 [\fB\-reqexts section\fR]
 176 [\fB\-utf8\fR]
 177 [\fB\-nameopt\fR]
 178 [\fB\-batch\fR]
 179 [\fB\-verbose\fR]
 180 [\fB\-engine id\fR]
 181 .SH "DESCRIPTION"
 182 .IX Header "DESCRIPTION"
 183 The \fBreq\fR command primarily creates and processes certificate requests
 184 in PKCS#10 format. It can additionally create self signed certificates
 185 for use as root CAs for example.
 186 .SH "COMMAND OPTIONS"
 187 .IX Header "COMMAND OPTIONS"
 188 .IP "\fB\-inform DER|PEM\fR" 4
 189 .IX Item "-inform DER|PEM"
 190 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 191 form compatible with the PKCS#10. The \fB\s-1PEM\s0\fR form is the default format: it
 192 consists of the \fB\s-1DER\s0\fR format base64 encoded with additional header and
 193 footer lines.
 194 .IP "\fB\-outform DER|PEM\fR" 4
 195 .IX Item "-outform DER|PEM"
 196 This specifies the output format, the options have the same meaning as the
 197 \&\fB\-inform\fR option.
 198 .IP "\fB\-in filename\fR" 4
 199 .IX Item "-in filename"
 200 This specifies the input filename to read a request from or standard input
 201 if this option is not specified. A request is only read if the creation
 202 options (\fB\-new\fR and \fB\-newkey\fR) are not specified.
 203 .IP "\fB\-passin arg\fR" 4
 204 .IX Item "-passin arg"
 205 the input file password source. For more information about the format of \fBarg\fR
 206 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 207 .IP "\fB\-out filename\fR" 4
 208 .IX Item "-out filename"
 209 This specifies the output filename to write to or standard output by
 210 default.
 211 .IP "\fB\-passout arg\fR" 4
 212 .IX Item "-passout arg"
 213 the output file password source. For more information about the format of \fBarg\fR
 214 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 215 .IP "\fB\-text\fR" 4
 216 .IX Item "-text"
 217 prints out the certificate request in text form.
 218 .IP "\fB\-pubkey\fR" 4
 219 .IX Item "-pubkey"
 220 outputs the public key.
 221 .IP "\fB\-noout\fR" 4
 222 .IX Item "-noout"
 223 this option prevents output of the encoded version of the request.
 224 .IP "\fB\-modulus\fR" 4
 225 .IX Item "-modulus"
 226 this option prints out the value of the modulus of the public key
 227 contained in the request.
 228 .IP "\fB\-verify\fR" 4
 229 .IX Item "-verify"
 230 verifies the signature on the request.
 231 .IP "\fB\-new\fR" 4
 232 .IX Item "-new"
 233 this option generates a new certificate request. It will prompt
 234 the user for the relevant field values. The actual fields
 235 prompted for and their maximum and minimum sizes are specified
 236 in the configuration file and any requested extensions.
 237 .Sp
 238 If the \fB\-key\fR option is not used it will generate a new \s-1RSA\s0 private
 239 key using information specified in the configuration file.
 240 .IP "\fB\-rand file(s)\fR" 4
 241 .IX Item "-rand file(s)"
 242 a file or files containing random data used to seed the random number
 243 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 244 Multiple files can be specified separated by a OS-dependent character.
 245 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 246 all others.
 247 .IP "\fB\-newkey arg\fR" 4
 248 .IX Item "-newkey arg"
 249 this option creates a new certificate request and a new private
 250 key. The argument takes one of two forms. \fBrsa:nbits\fR, where
 251 \&\fBnbits\fR is the number of bits, generates an \s-1RSA\s0 key \fBnbits\fR
 252 in size. \fBdsa:filename\fR generates a \s-1DSA\s0 key using the parameters
 253 in the file \fBfilename\fR.
 254 .IP "\fB\-key filename\fR" 4
 255 .IX Item "-key filename"
 256 This specifies the file to read the private key from. It also
 257 accepts PKCS#8 format private keys for \s-1PEM\s0 format files.
 258 .IP "\fB\-keyform PEM|DER\fR" 4
 259 .IX Item "-keyform PEM|DER"
 260 the format of the private key file specified in the \fB\-key\fR
 261 argument. \s-1PEM\s0 is the default.
 262 .IP "\fB\-keyout filename\fR" 4
 263 .IX Item "-keyout filename"
 264 this gives the filename to write the newly created private key to.
 265 If this option is not specified then the filename present in the
 266 configuration file is used.
 267 .IP "\fB\-nodes\fR" 4
 268 .IX Item "-nodes"
 269 if this option is specified then if a private key is created it
 270 will not be encrypted.
 271 .IP "\fB\-[md5|sha1|md2|mdc2]\fR" 4
 272 .IX Item "-[md5|sha1|md2|mdc2]"
 273 this specifies the message digest to sign the request with. This
 274 overrides the digest algorithm specified in the configuration file.
 275 This option is ignored for \s-1DSA\s0 requests: they always use \s-1SHA1.\s0
 276 .IP "\fB\-config filename\fR" 4
 277 .IX Item "-config filename"
 278 this allows an alternative configuration file to be specified,
 279 this overrides the compile time filename or any specified in
 280 the \fB\s-1OPENSSL_CONF\s0\fR environment variable.
 281 .IP "\fB\-subj arg\fR" 4
 282 .IX Item "-subj arg"
 283 sets subject name for new request or supersedes the subject name
 284 when processing a request.
 285 The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR,
 286 characters may be escaped by \e (backslash), no spaces are skipped.
 287 .IP "\fB\-multivalue\-rdn\fR" 4
 288 .IX Item "-multivalue-rdn"
 289 this option causes the \-subj argument to be interpreted with full
 290 support for multivalued RDNs. Example:
 291 .Sp
 292 \&\fI/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\fR
 293 .Sp
 294 If \-multi\-rdn is not used then the \s-1UID\s0 value is \fI123456+CN=John Doe\fR.
 295 .IP "\fB\-x509\fR" 4
 296 .IX Item "-x509"
 297 this option outputs a self signed certificate instead of a certificate
 298 request. This is typically used to generate a test certificate or
 299 a self signed root \s-1CA.\s0 The extensions added to the certificate
 300 (if any) are specified in the configuration file. Unless specified
 301 using the \fBset_serial\fR option \fB0\fR will be used for the serial
 302 number.
 303 .IP "\fB\-days n\fR" 4
 304 .IX Item "-days n"
 305 when the \fB\-x509\fR option is being used this specifies the number of
 306 days to certify the certificate for. The default is 30 days.
 307 .IP "\fB\-set_serial n\fR" 4
 308 .IX Item "-set_serial n"
 309 serial number to use when outputting a self signed certificate. This
 310 may be specified as a decimal value or a hex value if preceded by \fB0x\fR.
 311 It is possible to use negative serial numbers but this is not recommended.
 312 .IP "\fB\-extensions section\fR" 4
 313 .IX Item "-extensions section"
 314 .PD 0
 315 .IP "\fB\-reqexts section\fR" 4
 316 .IX Item "-reqexts section"
 317 .PD
 318 these options specify alternative sections to include certificate
 319 extensions (if the \fB\-x509\fR option is present) or certificate
 320 request extensions. This allows several different sections to
 321 be used in the same configuration file to specify requests for
 322 a variety of purposes.
 323 .IP "\fB\-utf8\fR" 4
 324 .IX Item "-utf8"
 325 this option causes field values to be interpreted as \s-1UTF8\s0 strings, by
 326 default they are interpreted as \s-1ASCII.\s0 This means that the field
 327 values, whether prompted from a terminal or obtained from a
 328 configuration file, must be valid \s-1UTF8\s0 strings.
 329 .IP "\fB\-nameopt option\fR" 4
 330 .IX Item "-nameopt option"
 331 option which determines how the subject or issuer names are displayed. The
 332 \&\fBoption\fR argument can be a single option or multiple options separated by
 333 commas.  Alternatively the \fB\-nameopt\fR switch may be used more than once to
 334 set multiple options. See the \fIx509\fR\|(1) manual page for details.
 335 .IP "\fB\-asn1\-kludge\fR" 4
 336 .IX Item "-asn1-kludge"
 337 by default the \fBreq\fR command outputs certificate requests containing
 338 no attributes in the correct PKCS#10 format. However certain CAs will only
 339 accept requests containing no attributes in an invalid form: this
 340 option produces this invalid format.
 341 .Sp
 342 More precisely the \fBAttributes\fR in a PKCS#10 certificate request
 343 are defined as a \fB\s-1SET OF\s0 Attribute\fR. They are \fBnot \s-1OPTIONAL\s0\fR so
 344 if no attributes are present then they should be encoded as an
 345 empty \fB\s-1SET OF\s0\fR. The invalid form does not include the empty
 346 \&\fB\s-1SET OF\s0\fR whereas the correct form does.
 347 .Sp
 348 It should be noted that very few CAs still require the use of this option.
 349 .IP "\fB\-newhdr\fR" 4
 350 .IX Item "-newhdr"
 351 Adds the word \fB\s-1NEW\s0\fR to the \s-1PEM\s0 file header and footer lines on the outputed
 352 request. Some software (Netscape certificate server) and some CAs need this.
 353 .IP "\fB\-batch\fR" 4
 354 .IX Item "-batch"
 355 non-interactive mode.
 356 .IP "\fB\-verbose\fR" 4
 357 .IX Item "-verbose"
 358 print extra details about the operations being performed.
 359 .IP "\fB\-engine id\fR" 4
 360 .IX Item "-engine id"
 361 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
 362 to attempt to obtain a functional reference to the specified engine,
 363 thus initialising it if needed. The engine will then be set as the default
 364 for all available algorithms.
 365 .SH "CONFIGURATION FILE FORMAT"
 366 .IX Header "CONFIGURATION FILE FORMAT"
 367 The configuration options are specified in the \fBreq\fR section of
 368 the configuration file. As with all configuration files if no
 369 value is specified in the specific section (i.e. \fBreq\fR) then
 370 the initial unnamed or \fBdefault\fR section is searched too.
 371 .PP
 372 The options available are described in detail below.
 373 .IP "\fBinput_password output_password\fR" 4
 374 .IX Item "input_password output_password"
 375 The passwords for the input private key file (if present) and
 376 the output private key file (if one will be created). The
 377 command line options \fBpassin\fR and \fBpassout\fR override the
 378 configuration file values.
 379 .IP "\fBdefault_bits\fR" 4
 380 .IX Item "default_bits"
 381 This specifies the default key size in bits. If not specified then
 382 512 is used. It is used if the \fB\-new\fR option is used. It can be
 383 overridden by using the \fB\-newkey\fR option.
 384 .IP "\fBdefault_keyfile\fR" 4
 385 .IX Item "default_keyfile"
 386 This is the default filename to write a private key to. If not
 387 specified the key is written to standard output. This can be
 388 overridden by the \fB\-keyout\fR option.
 389 .IP "\fBoid_file\fR" 4
 390 .IX Item "oid_file"
 391 This specifies a file containing additional \fB\s-1OBJECT IDENTIFIERS\s0\fR.
 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 .IP "\fBoid_section\fR" 4
 396 .IX Item "oid_section"
 397 This specifies a section in the configuration file containing extra
 398 object identifiers. Each line should consist of the short name of the
 399 object identifier followed by \fB=\fR and the numerical form. The short
 400 and long names are the same when this option is used.
 401 .IP "\fB\s-1RANDFILE\s0\fR" 4
 402 .IX Item "RANDFILE"
 403 This specifies a filename in which random number seed information is
 404 placed and read from, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 405 It is used for private key generation.
 406 .IP "\fBencrypt_key\fR" 4
 407 .IX Item "encrypt_key"
 408 If this is set to \fBno\fR then if a private key is generated it is
 409 \&\fBnot\fR encrypted. This is equivalent to the \fB\-nodes\fR command line
 410 option. For compatibility \fBencrypt_rsa_key\fR is an equivalent option.
 411 .IP "\fBdefault_md\fR" 4
 412 .IX Item "default_md"
 413 This option specifies the digest algorithm to use. Possible values
 414 include \fBmd5 sha1 mdc2\fR. If not present then \s-1MD5\s0 is used. This
 415 option can be overridden on the command line.
 416 .IP "\fBstring_mask\fR" 4
 417 .IX Item "string_mask"
 418 This option masks out the use of certain string types in certain
 419 fields. Most users will not need to change this option.
 420 .Sp
 421 It can be set to several values \fBdefault\fR which is also the default
 422 option uses PrintableStrings, T61Strings and BMPStrings if the
 423 \&\fBpkix\fR value is used then only PrintableStrings and BMPStrings will
 424 be used. This follows the \s-1PKIX\s0 recommendation in \s-1RFC2459.\s0 If the
 425 \&\fButf8only\fR option is used then only UTF8Strings will be used: this
 426 is the \s-1PKIX\s0 recommendation in \s-1RFC2459\s0 after 2003. Finally the \fBnombstr\fR
 427 option just uses PrintableStrings and T61Strings: certain software has
 428 problems with BMPStrings and UTF8Strings: in particular Netscape.
 429 .IP "\fBreq_extensions\fR" 4
 430 .IX Item "req_extensions"
 431 this specifies the configuration file section containing a list of
 432 extensions to add to the certificate request. It can be overridden
 433 by the \fB\-reqexts\fR command line switch.
 434 .IP "\fBx509_extensions\fR" 4
 435 .IX Item "x509_extensions"
 436 this specifies the configuration file section containing a list of
 437 extensions to add to certificate generated when the \fB\-x509\fR switch
 438 is used. It can be overridden by the \fB\-extensions\fR command line switch.
 439 .IP "\fBprompt\fR" 4
 440 .IX Item "prompt"
 441 if set to the value \fBno\fR this disables prompting of certificate fields
 442 and just takes values from the config file directly. It also changes the
 443 expected format of the \fBdistinguished_name\fR and \fBattributes\fR sections.
 444 .IP "\fButf8\fR" 4
 445 .IX Item "utf8"
 446 if set to the value \fByes\fR then field values to be interpreted as \s-1UTF8\s0
 447 strings, by default they are interpreted as \s-1ASCII.\s0 This means that
 448 the field values, whether prompted from a terminal or obtained from a
 449 configuration file, must be valid \s-1UTF8\s0 strings.
 450 .IP "\fBattributes\fR" 4
 451 .IX Item "attributes"
 452 this specifies the section containing any request attributes: its format
 453 is the same as \fBdistinguished_name\fR. Typically these may contain the
 454 challengePassword or unstructuredName types. They are currently ignored
 455 by OpenSSL's request signing utilities but some CAs might want them.
 456 .IP "\fBdistinguished_name\fR" 4
 457 .IX Item "distinguished_name"
 458 This specifies the section containing the distinguished name fields to
 459 prompt for when generating a certificate or certificate request. The format
 460 is described in the next section.
 461 .SH "DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT"
 462 .IX Header "DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT"
 463 There are two separate formats for the distinguished name and attribute
 464 sections. If the \fBprompt\fR option is set to \fBno\fR then these sections
 465 just consist of field names and values: for example,
 466 .PP
 467 .Vb 3
 468 \& CN=My Name
 469 \& OU=My Organization
 470 \& emailAddress=someone@somewhere.org
 471 .Ve
 472 .PP
 473 This allows external programs (e.g. \s-1GUI\s0 based) to generate a template file
 474 with all the field names and values and just pass it to \fBreq\fR. An example
 475 of this kind of configuration file is contained in the \fB\s-1EXAMPLES\s0\fR section.
 476 .PP
 477 Alternatively if the \fBprompt\fR option is absent or not set to \fBno\fR then the
 478 file contains field prompting information. It consists of lines of the form:
 479 .PP
 480 .Vb 4
 481 \& fieldName="prompt"
 482 \& fieldName_default="default field value"
 483 \& fieldName_min= 2
 484 \& fieldName_max= 4
 485 .Ve
 486 .PP
 487 \&\*(L"fieldName\*(R" is the field name being used, for example commonName (or \s-1CN\s0).
 488 The \*(L"prompt\*(R" string is used to ask the user to enter the relevant
 489 details. If the user enters nothing then the default value is used if no
 490 default value is present then the field is omitted. A field can
 491 still be omitted if a default value is present if the user just
 492 enters the '.' character.
 493 .PP
 494 The number of characters entered must be between the fieldName_min and
 495 fieldName_max limits: there may be additional restrictions based
 496 on the field being used (for example countryName can only ever be
 497 two characters long and must fit in a PrintableString).
 498 .PP
 499 Some fields (such as organizationName) can be used more than once
 500 in a \s-1DN.\s0 This presents a problem because configuration files will
 501 not recognize the same name occurring twice. To avoid this problem
 502 if the fieldName contains some characters followed by a full stop
 503 they will be ignored. So for example a second organizationName can
 504 be input by calling it \*(L"1.organizationName\*(R".
 505 .PP
 506 The actual permitted field names are any object identifier short or
 507 long names. These are compiled into OpenSSL and include the usual
 508 values such as commonName, countryName, localityName, organizationName,
 509 organizationUnitName, stateOrProvinceName. Additionally emailAddress
 510 is include as well as name, surname, givenName initials and dnQualifier.
 511 .PP
 512 Additional object identifiers can be defined with the \fBoid_file\fR or
 513 \&\fBoid_section\fR options in the configuration file. Any additional fields
 514 will be treated as though they were a DirectoryString.
 515 .SH "EXAMPLES"
 516 .IX Header "EXAMPLES"
 517 Examine and verify certificate request:
 518 .PP
 519 .Vb 1
 520 \& openssl req \-in req.pem \-text \-verify \-noout
 521 .Ve
 522 .PP
 523 Create a private key and then generate a certificate request from it:
 524 .PP
 525 .Vb 2
 526 \& openssl genrsa \-out key.pem 1024
 527 \& openssl req \-new \-key key.pem \-out req.pem
 528 .Ve
 529 .PP
 530 The same but just using req:
 531 .PP
 532 .Vb 1
 533 \& openssl req \-newkey rsa:1024 \-keyout key.pem \-out req.pem
 534 .Ve
 535 .PP
 536 Generate a self signed root certificate:
 537 .PP
 538 .Vb 1
 539 \& openssl req \-x509 \-newkey rsa:1024 \-keyout key.pem \-out req.pem
 540 .Ve
 541 .PP
 542 Example of a file pointed to by the \fBoid_file\fR option:
 543 .PP
 544 .Vb 2
 545 \& 1.2.3.4        shortName       A longer Name
 546 \& 1.2.3.6        otherName       Other longer Name
 547 .Ve
 548 .PP
 549 Example of a section pointed to by \fBoid_section\fR making use of variable
 550 expansion:
 551 .PP
 552 .Vb 2
 553 \& testoid1=1.2.3.5
 554 \& testoid2=${testoid1}.6
 555 .Ve
 556 .PP
 557 Sample configuration file prompting for field values:
 558 .PP
 559 .Vb 6
 560 \& [ req ]
 561 \& default_bits           = 1024
 562 \& default_keyfile        = privkey.pem
 563 \& distinguished_name     = req_distinguished_name
 564 \& attributes             = req_attributes
 565 \& x509_extensions        = v3_ca
 566 \&
 567 \& dirstring_type = nobmp
 568 \&
 569 \& [ req_distinguished_name ]
 570 \& countryName                    = Country Name (2 letter code)
 571 \& countryName_default            = AU
 572 \& countryName_min                = 2
 573 \& countryName_max                = 2
 574 \&
 575 \& localityName                   = Locality Name (eg, city)
 576 \&
 577 \& organizationalUnitName         = Organizational Unit Name (eg, section)
 578 \&
 579 \& commonName                     = Common Name (eg, YOUR name)
 580 \& commonName_max                 = 64
 581 \&
 582 \& emailAddress                   = Email Address
 583 \& emailAddress_max               = 40
 584 \&
 585 \& [ req_attributes ]
 586 \& challengePassword              = A challenge password
 587 \& challengePassword_min          = 4
 588 \& challengePassword_max          = 20
 589 \&
 590 \& [ v3_ca ]
 591 \&
 592 \& subjectKeyIdentifier=hash
 593 \& authorityKeyIdentifier=keyid:always,issuer:always
 594 \& basicConstraints = CA:true
 595 .Ve
 596 .PP
 597 Sample configuration containing all field values:
 598 .PP
 599 .Vb 1
 600 \& RANDFILE               = $ENV::HOME/.rnd
 601 \&
 602 \& [ req ]
 603 \& default_bits           = 1024
 604 \& default_keyfile        = keyfile.pem
 605 \& distinguished_name     = req_distinguished_name
 606 \& attributes             = req_attributes
 607 \& prompt                 = no
 608 \& output_password        = mypass
 609 \&
 610 \& [ req_distinguished_name ]
 611 \& C                      = GB
 612 \& ST                     = Test State or Province
 613 \& L                      = Test Locality
 614 \& O                      = Organization Name
 615 \& OU                     = Organizational Unit Name
 616 \& CN                     = Common Name
 617 \& emailAddress           = test@email.address
 618 \&
 619 \& [ req_attributes ]
 620 \& challengePassword              = A challenge password
 621 .Ve
 622 .SH "NOTES"
 623 .IX Header "NOTES"
 624 The header and footer lines in the \fB\s-1PEM\s0\fR format are normally:
 625 .PP
 626 .Vb 2
 627 \& \-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-
 628 \& \-\-\-\-\-END CERTIFICATE REQUEST\-\-\-\-\-
 629 .Ve
 630 .PP
 631 some software (some versions of Netscape certificate server) instead needs:
 632 .PP
 633 .Vb 2
 634 \& \-\-\-\-\-BEGIN NEW CERTIFICATE REQUEST\-\-\-\-\-
 635 \& \-\-\-\-\-END NEW CERTIFICATE REQUEST\-\-\-\-\-
 636 .Ve
 637 .PP
 638 which is produced with the \fB\-newhdr\fR option but is otherwise compatible.
 639 Either form is accepted transparently on input.
 640 .PP
 641 The certificate requests generated by \fBXenroll\fR with \s-1MSIE\s0 have extensions
 642 added. It includes the \fBkeyUsage\fR extension which determines the type of
 643 key (signature only or general purpose) and any additional OIDs entered
 644 by the script in an extendedKeyUsage extension.
 645 .SH "DIAGNOSTICS"
 646 .IX Header "DIAGNOSTICS"
 647 The following messages are frequently asked about:
 648 .PP
 649 .Vb 2
 650 \&        Using configuration from /some/path/openssl.cnf
 651 \&        Unable to load config info
 652 .Ve
 653 .PP
 654 This is followed some time later by...
 655 .PP
 656 .Vb 2
 657 \&        unable to find \*(Aqdistinguished_name\*(Aq in config
 658 \&        problems making Certificate Request
 659 .Ve
 660 .PP
 661 The first error message is the clue: it can't find the configuration
 662 file! Certain operations (like examining a certificate request) don't
 663 need a configuration file so its use isn't enforced. Generation of
 664 certificates or requests however does need a configuration file. This
 665 could be regarded as a bug.
 666 .PP
 667 Another puzzling message is this:
 668 .PP
 669 .Vb 2
 670 \&        Attributes:
 671 \&            a0:00
 672 .Ve
 673 .PP
 674 this is displayed when no attributes are present and the request includes
 675 the correct empty \fB\s-1SET OF\s0\fR structure (the \s-1DER\s0 encoding of which is 0xa0
 676 0x00). If you just see:
 677 .PP
 678 .Vb 1
 679 \&        Attributes:
 680 .Ve
 681 .PP
 682 then the \fB\s-1SET OF\s0\fR is missing and the encoding is technically invalid (but
 683 it is tolerated). See the description of the command line option \fB\-asn1\-kludge\fR
 684 for more information.
 685 .SH "ENVIRONMENT VARIABLES"
 686 .IX Header "ENVIRONMENT VARIABLES"
 687 The variable \fB\s-1OPENSSL_CONF\s0\fR if defined allows an alternative configuration
 688 file location to be specified, it will be overridden by the \fB\-config\fR command
 689 line switch if it is present. For compatibility reasons the \fB\s-1SSLEAY_CONF\s0\fR
 690 environment variable serves the same purpose but its use is discouraged.
 691 .SH "BUGS"
 692 .IX Header "BUGS"
 693 OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
 694 treats them as \s-1ISO\-8859\-1 \s0(Latin 1), Netscape and \s-1MSIE\s0 have similar behaviour.
 695 This can cause problems if you need characters that aren't available in
 696 PrintableStrings and you don't want to or can't use BMPStrings.
 697 .PP
 698 As a consequence of the T61String handling the only correct way to represent
 699 accented characters in OpenSSL is to use a BMPString: unfortunately Netscape
 700 currently chokes on these. If you have to use accented characters with Netscape
 701 and \s-1MSIE\s0 then you currently need to use the invalid T61String form.
 702 .PP
 703 The current prompting is not very friendly. It doesn't allow you to confirm what
 704 you've just entered. Other things like extensions in certificate requests are
 705 statically defined in the configuration file. Some of these: like an email
 706 address in subjectAltName should be input by the user.
 707 .SH "SEE ALSO"
 708 .IX Header "SEE ALSO"
 709 \&\fIx509\fR\|(1), \fIca\fR\|(1), \fIgenrsa\fR\|(1),
 710 \&\fIgendsa\fR\|(1), \fIconfig\fR\|(5)