secure/lib/libcrypto/man/req.1

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