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