Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) Standard preamble: ========================================================================..
..
..
Set up some character translations and predefined strings. \*(-- will give an unbreakable dash, \*(PI will give pi, \*(L" will give a left double quote, and \*(R" will give a right double quote. \*(C+ will give a nicer C++. Capital omega is used to do unbreakable dashes and therefore won't be available. \*(C` and \*(C' expand to `' in nroff, nothing in troff, for use with C<>..tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
======================================================================== Title "OPENSSL-REQ 1" OPENSSL-REQ 1 "2023-06-02" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. "NAME"
openssl-req - PKCS#10 certificate request and certificate generating command
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl
req
[
-help]
[
-inform \s-1DER\s0|
\s-1PEM\s0]
[
-outform \s-1DER\s0|
\s-1PEM\s0]
[
-in filename]
[
-passin arg]
[
-out filename]
[
-passout arg]
[
-text]
[
-pubkey]
[
-noout]
[
-verify]
[
-modulus]
[
-new]
[
-newkey arg]
[
-pkeyopt opt:
value]
[
-noenc]
[
-nodes]
[
-key filename|
uri]
[
-keyform \s-1DER\s0|
\s-1PEM\s0|
P12|
\s-1ENGINE\s0]
[
-keyout filename]
[
-keygen_engine id]
[
-\f(BIdigest]
[-config filename]
[-section name]
[-x509]
[-CA filename|uri]
[-CAkey filename|uri]
[-days n]
[-set_serial n]
[-newhdr]
[-copy_extensions arg]
[-addext ext]
[-extensions section]
[-reqexts section]
[-precert]
[-utf8]
[-reqopt]
[-subject]
[-subj arg]
[-multivalue-rdn]
[-sigopt nm:v]
[-vfyopt nm:v]
[-batch]
[-verbose]
[-nameopt option]
[-rand files]
[-writerand file]
[-engine id]
[-provider name]
[-provider-path path]
[-propquery propq]
"DESCRIPTION"
Header "DESCRIPTION" This command primarily creates and processes certificate requests (CSRs)
in PKCS#10 format. It can additionally create self-signed certificates
for use as root CAs for example.
"OPTIONS"
Header "OPTIONS" "-help" 4
Item "-help" Print out a usage message.
"-inform \s-1DER\s0|\s-1PEM\s0, -outform \s-1DER\s0|\s-1PEM\s0" 4
Item "-inform DER|PEM, -outform DER|PEM" The input and output formats; unspecified by default.
See
openssl-format-options\|(1) for details.
.Sp
The data is a PKCS#10 object.
"-in filename" 4
Item "-in filename" This specifies the input filename to read a request from.
This defaults to standard input unless
-x509 or
-CA is specified.
A request is only read if the creation options
(
-new or
-newkey or
-precert) are not specified.
"-sigopt nm:v" 4
Item "-sigopt nm:v" Pass options to the signature algorithm during sign operations.
Names and values of these options are algorithm-specific.
"-vfyopt nm:v" 4
Item "-vfyopt nm:v" Pass options to the signature algorithm during verify operations.
Names and values of these options are algorithm-specific.
"-passin arg" 4
Item "-passin arg" The password source for private key and certificate input.
For more information about the format of
arg
see
openssl-passphrase-options\|(1).
"-passout arg" 4
Item "-passout arg" The password source for the output file.
For more information about the format of
arg
see
openssl-passphrase-options\|(1).
"-out filename" 4
Item "-out filename" This specifies the output filename to write to or standard output by default.
"-text" 4
Item "-text" Prints out the certificate request in text form.
"-subject" 4
Item "-subject" Prints out the certificate request subject
(or certificate subject if
-x509 is in use).
"-pubkey" 4
Item "-pubkey" Prints out the public key.
"-noout" 4
Item "-noout" This option prevents output of the encoded version of the certificate request.
"-modulus" 4
Item "-modulus" Prints out the value of the modulus of the public key contained in the request.
"-verify" 4
Item "-verify" Verifies the self-signature on the request.
"-new" 4
Item "-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.
.Sp
If the
-key option is not given it will generate a new private key
using information specified in the configuration file or given with
the
-newkey and
-pkeyopt options,
else by default an \s-1RSA\s0 key with 2048 bits length.
"-newkey arg" 4
Item "-newkey arg" This option is used to generate a new private key unless
-key is given.
It is subsequently used as if it was given using the
-key option.
.Sp
This option implies the
-new flag to create a new certificate request
or a new certificate in case
-x509 is given.
.Sp
The argument takes one of several forms.
.Sp
[
rsa:]
nbits generates an \s-1RSA\s0 key
nbits in size.
If
nbits is omitted, i.e.,
-newkey rsa is specified,
the default key size specified in the configuration file
with the
default_bits option is used if present, else 2048.
.Sp
All other algorithms support the
-newkey algname:
file form, where
\fIfile is an algorithm parameter file, created with
\*(C`openssl genpkey -genparam\*(C'
or an X.509 certificate for a key with appropriate algorithm.
.Sp
\fBparam:
file generates a key using the parameter file or certificate
\fIfile, the algorithm is determined by the parameters.
.Sp
\fIalgname[:
file] generates a key using the given algorithm
algname.
If a parameter file
file is given then the parameters specified there
are used, where the algorithm parameters must match
algname.
If algorithm parameters are not given,
any necessary parameters should be specified via the
-pkeyopt option.
.Sp
\fBdsa:
filename generates a \s-1DSA\s0 key using the parameters
in the file
filename.
ec:filename generates \s-1EC\s0 key (usable both with
\s-1ECDSA\s0 or \s-1ECDH\s0 algorithms),
gost2001:filename generates \s-1GOST R
34.10-2001\s0 key (requires
gost engine configured in the configuration
file). If just
gost2001 is specified a parameter set should be
specified by
-pkeyopt paramset:X
"-pkeyopt opt:value" 4
Item "-pkeyopt opt:value" Set the public key algorithm option
opt to
value. The precise set of
options supported depends on the public key algorithm used and its
implementation.
See \*(L"\s-1KEY GENERATION OPTIONS\*(R"\s0 in
openssl-genpkey\|(1) for more details.
"-key filename|uri" 4
Item "-key filename|uri" This option provides the private key for signing a new certificate or
certificate request.
Unless
-in is given, the corresponding public key is placed in
the new certificate or certificate request, resulting in a self-signature.
.Sp
For certificate signing this option is overridden by the
-CA option.
.Sp
This option also accepts PKCS#8 format private keys for \s-1PEM\s0 format files.
"-keyform \s-1DER\s0|\s-1PEM\s0|P12|\s-1ENGINE\s0" 4
Item "-keyform DER|PEM|P12|ENGINE" The format of the private key; unspecified by default.
See
openssl-format-options\|(1) for details.
"-keyout filename" 4
Item "-keyout filename" This gives the filename to write any private key to that has been newly created
or read from
-key. If neither the
-keyout option nor the
-key option
are given then the filename specified in the configuration file with the
\fBdefault_keyfile option is used, if present. Thus, if you want to write the
private key and the
-key option is provided, you should provide the
\fB-keyout option explicitly. If a new key is generated and no filename is
specified the key is written to standard output.
"-noenc" 4
Item "-noenc" If this option is specified then if a private key is created it
will not be encrypted.
"-nodes" 4
Item "-nodes" This option is deprecated since OpenSSL 3.0; use
-noenc instead.
"-\f(BIdigest" 4
Item "-digest" This specifies the message digest to sign the request.
Any digest supported by the OpenSSL
dgst command can be used.
This overrides the digest algorithm specified in
the configuration file.
.Sp
Some public key algorithms may override this choice. For instance, \s-1DSA\s0
signatures always use \s-1SHA1, GOST R 34.10\s0 signatures always use
\s-1GOST R 34.11-94\s0 (
-md_gost94), Ed25519 and Ed448 never use any digest.
"-config filename" 4
Item "-config filename" This allows an alternative configuration file to be specified.
Optional; for a description of the default value,
see \*(L"\s-1COMMAND SUMMARY\*(R"\s0 in
openssl\|(1).
"-section name" 4
Item "-section name" Specifies the name of the section to use; the default is
req.
"-subj arg" 4
Item "-subj arg" Sets subject name for new request or supersedes the subject name
when processing a certificate request.
.Sp
The arg must be formatted as
\*(C`/type0=value0/type1=value1/type2=...\*(C'.
Special characters may be escaped by
\*(C`\e\*(C' (backslash), whitespace is retained.
Empty values are permitted, but the corresponding type will not be included
in the request.
Giving a single
\*(C`/\*(C' will lead to an empty sequence of RDNs (a NULL-DN).
Multi-valued RDNs can be formed by placing a
\*(C`+\*(C' character instead of a
\*(C`/\*(C'
between the AttributeValueAssertions (AVAs) that specify the members of the set.
Example:
.Sp
\f(CW\*(C`/DC=
org/
DC=
OpenSSL/
DC=
users/
UID=123456+CN=John Doe\*(C'
"-multivalue-rdn" 4
Item "-multivalue-rdn" This option has been deprecated and has no effect.
"-x509" 4
Item "-x509" This option outputs a certificate instead of a certificate request.
This is typically used to generate test certificates.
It is implied by the
-CA option.
.Sp
This option implies the
-new flag if
-in is not given.
.Sp
If an existing request is specified with the
-in option, it is converted
to the a certificate; otherwise a request is created from scratch.
.Sp
Unless specified using the
-set_serial option,
a large random number will be used for the serial number.
.Sp
Unless the
-copy_extensions option is used,
X.509 extensions are not copied from any provided request input file.
.Sp
X.509 extensions to be added can be specified in the configuration file
or using the
-addext option.
"-CA filename|uri" 4
Item "-CA filename|uri" Specifies the \*(L"\s-1CA\*(R"\s0 certificate to be used for signing a new certificate
and implies use of
-x509.
When present, this behaves like a \*(L"micro \s-1CA\*(R"\s0 as follows:
The subject name of the \*(L"\s-1CA\*(R"\s0 certificate is placed as issuer name in the new
certificate, which is then signed using the \*(L"\s-1CA\*(R"\s0 key given as specified below.
"-CAkey filename|uri" 4
Item "-CAkey filename|uri" Sets the \*(L"\s-1CA\*(R"\s0 private key to sign a certificate with.
The private key must match the public key of the certificate given with
-CA.
If this option is not provided then the key must be present in the
-CA input.
"-days n" 4
Item "-days n" When
-x509 is in use this specifies the number of
days to certify the certificate for, otherwise it is ignored.
n should
be a positive integer. The default is 30 days.
"-set_serial n" 4
Item "-set_serial n" Serial number to use when outputting a self-signed certificate.
This may be specified as a decimal value or a hex value if preceded by
\*(C`0x\*(C'.
If not given, a large random number will be used.
"-copy_extensions arg" 4
Item "-copy_extensions arg" Determines how X.509 extensions in certificate requests should be handled
when
-x509 is in use.
If
arg is
none or this option is not present then extensions are ignored.
If
arg is
copy or
copyall then
all extensions in the request are copied to the certificate.
.Sp
The main use of this option is to allow a certificate request to supply
values for certain extensions such as subjectAltName.
"-addext ext" 4
Item "-addext ext" Add a specific extension to the certificate (if
-x509 is in use)
or certificate request. The argument must have the form of
a key=value pair as it would appear in a config file.
.Sp
This option can be given multiple times.
"-extensions section" 4
Item "-extensions section" 0
"-reqexts section" 4
Item "-reqexts section"
These options specify alternative sections to include certificate
extensions (if -x509 is in use) 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.
"-precert" 4
Item "-precert" A poison extension will be added to the certificate, making it a
\*(L"pre-certificate\*(R" (see \s-1RFC6962\s0). This can be submitted to Certificate
Transparency logs in order to obtain signed certificate timestamps (SCTs).
These SCTs can then be embedded into the pre-certificate as an extension, before
removing the poison and signing the certificate.
.Sp
This implies the
-new flag.
"-utf8" 4
Item "-utf8" This option causes field values to be interpreted as \s-1UTF8\s0 strings, by
default they are interpreted as \s-1ASCII.\s0 This means that the field
values, whether prompted from a terminal or obtained from a
configuration file, must be valid \s-1UTF8\s0 strings.
"-reqopt option" 4
Item "-reqopt option" Customise the printing format used with
-text. The
option argument can be
a single option or multiple options separated by commas.
.Sp
See discussion of the
-certopt parameter in the
openssl-x509\|(1)
command.
"-newhdr" 4
Item "-newhdr" Adds the word
\s-1NEW\s0 to the \s-1PEM\s0 file header and footer lines on the outputted
request. Some software (Netscape certificate server) and some CAs need this.
"-batch" 4
Item "-batch" Non-interactive mode.
"-verbose" 4
Item "-verbose" Print extra details about the operations being performed.
"-keygen_engine id" 4
Item "-keygen_engine id" Specifies an engine (by its unique
id string) which would be used
for key generation operations.
"-nameopt option" 4
Item "-nameopt option" This specifies how the subject or issuer names are displayed.
See
openssl-namedisplay-options\|(1) for details.
"-rand files, -writerand file" 4
Item "-rand files, -writerand file" See \*(L"Random State Options\*(R" in
openssl\|(1) for details.
"-engine id" 4
Item "-engine id" See \*(L"Engine Options\*(R" in
openssl\|(1).
This option is deprecated.
"-provider name" 4
Item "-provider name" 0
"-provider-path path" 4
Item "-provider-path path" "-propquery propq" 4
Item "-propquery propq"
See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).
"CONFIGURATION FILE FORMAT"
Header "CONFIGURATION FILE FORMAT" The configuration options are specified in the
req section of
the configuration file. An alternate name be specified by using the
\fB-section option.
As with all configuration files, if no
value is specified in the specific section then
the initial unnamed or
default section is searched too.
The options available are described in detail below.
"input_password, output_password" 4
Item "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
command line options
passin and
passout override the
configuration file values.
"default_bits" 4
Item "default_bits" Specifies the default key size in bits.
.Sp
This option is used in conjunction with the
-new option to generate
a new key. It can be overridden by specifying an explicit key size in
the
-newkey option. The smallest accepted key size is 512 bits. If
no key size is specified then 2048 bits is used.
"default_keyfile" 4
Item "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
overridden by the
-keyout option.
"oid_file" 4
Item "oid_file" This specifies a file containing additional
\s-1OBJECT IDENTIFIERS\s0.
Each line of the file should consist of the numerical form of the
object identifier followed by whitespace then the short name followed
by whitespace and finally the long name.
"oid_section" 4
Item "oid_section" This specifies a section in the configuration file containing extra
object identifiers. Each line should consist of the short name of the
object identifier followed by
= and the numerical form. The short
and long names are the same when this option is used.
"\s-1RANDFILE\s0" 4
Item "RANDFILE" At startup the specified file is loaded into the random number generator,
and at exit 256 bytes will be written to it.
It is used for private key generation.
"encrypt_key" 4
Item "encrypt_key" If this is set to
no then if a private key is generated it is
\fBnot encrypted. This is equivalent to the
-noenc command line
option. For compatibility
encrypt_rsa_key is an equivalent option.
"default_md" 4
Item "default_md" This option specifies the digest algorithm to use. Any digest supported by the
OpenSSL
dgst command can be used. This option can be overridden on the
command line. Certain signing algorithms (i.e. Ed25519 and Ed448) will ignore
any digest that has been set.
"string_mask" 4
Item "string_mask" This option masks out the use of certain string types in certain
fields. Most users will not need to change this option.
.Sp
It can be set to several values
default which is also the default
option uses PrintableStrings, T61Strings and BMPStrings if the
\fBpkix value is used then only PrintableStrings and BMPStrings will
be used. This follows the \s-1PKIX\s0 recommendation in \s-1RFC2459.\s0 If the
\fButf8only option is used then only UTF8Strings will be used: this
is the \s-1PKIX\s0 recommendation in \s-1RFC2459\s0 after 2003. Finally the
nombstr
option just uses PrintableStrings and T61Strings: certain software has
problems with BMPStrings and UTF8Strings: in particular Netscape.
"req_extensions" 4
Item "req_extensions" This specifies the configuration file section containing a list of
extensions to add to the certificate request. It can be overridden
by the
-reqexts command line switch. See the
\fBx509v3_config\|(5) manual page for details of the
extension section format.
"x509_extensions" 4
Item "x509_extensions" This specifies the configuration file section containing a list of
extensions to add to certificate generated when
-x509 is in use.
It can be overridden by the
-extensions command line switch.
"prompt" 4
Item "prompt" If set to the value
no this disables prompting of certificate fields
and just takes values from the config file directly. It also changes the
expected format of the
distinguished_name and
attributes sections.
"utf8" 4
Item "utf8" If set to the value
yes then field values to be interpreted as \s-1UTF8\s0
strings, by default they are interpreted as \s-1ASCII.\s0 This means that
the field values, whether prompted from a terminal or obtained from a
configuration file, must be valid \s-1UTF8\s0 strings.
"attributes" 4
Item "attributes" This specifies the section containing any request attributes: its format
is the same as
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.
"distinguished_name" 4
Item "distinguished_name" This specifies the section containing the distinguished name fields to
prompt for when generating a certificate or certificate request. The format
is described in the next section.
"DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT"
Header "DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT" There are two separate formats for the distinguished name and attribute
sections. If the
prompt option is set to
no then these sections
just consist of field names and values: for example,
.Vb 3
CN=My Name
OU=My Organization
emailAddress=someone@somewhere.org
.Ve
This allows external programs (e.g. \s-1GUI\s0 based) to generate a template file with
all the field names and values and just pass it to this command. An example
of this kind of configuration file is contained in the \s-1EXAMPLES\s0 section.
Alternatively if the prompt option is absent or not set to no then the
file contains field prompting information. It consists of lines of the form:
.Vb 4
fieldName="prompt"
fieldName_default="default field value"
fieldName_min= 2
fieldName_max= 4
.Ve
\*(L"fieldName\*(R" is the field name being used, for example commonName (or \s-1CN\s0).
The \*(L"prompt\*(R" string is used to ask the user to enter the relevant
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 \s-1DN.\s0 This presents a problem because configuration files will
not recognize the same name occurring twice. To avoid this problem
if the fieldName contains some characters followed by a full stop
they will be ignored. So for example a second organizationName can
be input by calling it \*(L"1.organizationName\*(R".
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,
organizationalUnitName, stateOrProvinceName. Additionally emailAddress
is included as well as name, surname, givenName, initials, and dnQualifier.
Additional object identifiers can be defined with the oid_file or
\fBoid_section options in the configuration file. Any additional fields
will be treated as though they were a DirectoryString.
"EXAMPLES"
Header "EXAMPLES" Examine and verify certificate request:
.Vb 1
openssl req -in req.pem -text -verify -noout
.Ve
Create a private key and then generate a certificate request from it:
.Vb 2
openssl genrsa -out key.pem 2048
openssl req -new -key key.pem -out req.pem
.Ve
The same but just using req:
.Vb 1
openssl req -newkey rsa:2048 -keyout key.pem -out req.pem
.Ve
Generate a self-signed root certificate:
.Vb 1
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out req.pem
.Ve
Create an \s-1SM2\s0 private key and then generate a certificate request from it:
.Vb 2
openssl ecparam -genkey -name SM2 -out sm2.key
openssl req -new -key sm2.key -out sm2.csr -sm3 -sigopt "distid:1234567812345678"
.Ve
Examine and verify an \s-1SM2\s0 certificate request:
.Vb 1
openssl req -verify -in sm2.csr -sm3 -vfyopt "distid:1234567812345678"
.Ve
Example of a file pointed to by the oid_file option:
.Vb 2
1.2.3.4 shortName A longer Name
1.2.3.6 otherName Other longer Name
.Ve
Example of a section pointed to by oid_section making use of variable
expansion:
.Vb 2
testoid1=1.2.3.5
testoid2=${testoid1}.6
.Ve
Sample configuration file prompting for field values:
.Vb 6
[ req ]
default_bits = 2048
default_keyfile = privkey.pem
distinguished_name = req_distinguished_name
attributes = req_attributes
req_extensions = v3_ca
\&
dirstring_type = nobmp
\&
[ req_distinguished_name ]
countryName = Country Name (2 letter code)
countryName_default = AU
countryName_min = 2
countryName_max = 2
\&
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 = critical, CA:true
.Ve
Sample configuration containing all field values:
.Vb 7
[ req ]
default_bits = 2048
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
.Ve
Example of giving the most common attributes (subject and extensions)
on the command line:
.Vb 4
openssl req -new -subj "/C=GB/CN=foo" \e
-addext "subjectAltName = DNS:foo.co.uk" \e
-addext "certificatePolicies = 1.2.3.4" \e
-newkey rsa:2048 -keyout key.pem -out req.pem
.Ve
"NOTES"
Header "NOTES" The certificate requests generated by
Xenroll with \s-1MSIE\s0 have extensions
added. It includes the
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.
"DIAGNOSTICS"
Header "DIAGNOSTICS" The following messages are frequently asked about:
.Vb 2
Using configuration from /some/path/openssl.cnf
Unable to load config info
.Ve
This is followed some time later by:
.Vb 2
unable to find \*(Aqdistinguished_name\*(Aq in config
problems making Certificate Request
.Ve
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
certificates or requests however does need a configuration file. This
could be regarded as a bug.
Another puzzling message is this:
.Vb 2
Attributes:
a0:00
.Ve
this is displayed when no attributes are present and the request includes
the correct empty \s-1SET OF\s0 structure (the \s-1DER\s0 encoding of which is 0xa0
0x00). If you just see:
.Vb 1
Attributes:
.Ve
then the \s-1SET OF\s0 is missing and the encoding is technically invalid (but
it is tolerated). See the description of the command line option -asn1-kludge
for more information.
"BUGS"
Header "BUGS" OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
treats them as \s-1ISO-8859-1\s0 (Latin 1), Netscape and \s-1MSIE\s0 have similar behaviour.
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 \s-1MSIE\s0 then you currently need to use the invalid T61String form.
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.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1),
\fBopenssl-x509\|(1),
\fBopenssl-ca\|(1),
\fBopenssl-genrsa\|(1),
\fBopenssl-gendsa\|(1),
\fBconfig\|(5),
\fBx509v3_config\|(5)
"HISTORY"
Header "HISTORY" The
-section option was added in OpenSSL 3.0.0.
The -multivalue-rdn option has become obsolete in OpenSSL 3.0.0 and
has no effect.
The -engine option was deprecated in OpenSSL 3.0.
The <-nodes> option was deprecated in OpenSSL 3.0, too; use -noenc instead.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.