973 lines
28 KiB
HTML
973 lines
28 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of REQ</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>REQ</H1>
|
|
Section: OpenSSL (1SSL)<BR>Updated: 2021-03-22<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
openssl-req, req - PKCS#10 certificate request and certificate generating utility
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
<B>openssl</B> <B>req</B>
|
|
[<B>-help</B>]
|
|
[<B>-inform PEM|DER</B>]
|
|
[<B>-outform PEM|DER</B>]
|
|
[<B>-in filename</B>]
|
|
[<B>-passin arg</B>]
|
|
[<B>-out filename</B>]
|
|
[<B>-passout arg</B>]
|
|
[<B>-text</B>]
|
|
[<B>-pubkey</B>]
|
|
[<B>-noout</B>]
|
|
[<B>-verify</B>]
|
|
[<B>-modulus</B>]
|
|
[<B>-new</B>]
|
|
[<B>-rand file...</B>]
|
|
[<B>-writerand file</B>]
|
|
[<B>-newkey rsa:bits</B>]
|
|
[<B>-newkey alg:file</B>]
|
|
[<B>-nodes</B>]
|
|
[<B>-key filename</B>]
|
|
[<B>-keyform PEM|DER</B>]
|
|
[<B>-keyout filename</B>]
|
|
[<B>-keygen_engine id</B>]
|
|
[<B>-</B>digest<B></B>]
|
|
[<B>-config filename</B>]
|
|
[<B>-multivalue-rdn</B>]
|
|
[<B>-x509</B>]
|
|
[<B>-days n</B>]
|
|
[<B>-set_serial n</B>]
|
|
[<B>-newhdr</B>]
|
|
[<B>-addext ext</B>]
|
|
[<B>-extensions section</B>]
|
|
[<B>-reqexts section</B>]
|
|
[<B>-precert</B>]
|
|
[<B>-utf8</B>]
|
|
[<B>-nameopt</B>]
|
|
[<B>-reqopt</B>]
|
|
[<B>-subject</B>]
|
|
[<B>-subj arg</B>]
|
|
[<B>-sigopt nm:v</B>]
|
|
[<B>-batch</B>]
|
|
[<B>-verbose</B>]
|
|
[<B>-engine id</B>]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
The <B>req</B> command primarily creates and processes certificate requests
|
|
in PKCS#10 format. It can additionally create self signed certificates
|
|
for use as root CAs for example.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-help</B><DD>
|
|
|
|
|
|
Print out a usage message.
|
|
<DT id="2"><B>-inform DER|PEM</B><DD>
|
|
|
|
|
|
This specifies the input format. The <B></B><FONT SIZE="-1"><B>DER</B></FONT><B></B> option uses an <FONT SIZE="-1">ASN1 DER</FONT> encoded
|
|
form compatible with the PKCS#10. The <B></B><FONT SIZE="-1"><B>PEM</B></FONT><B></B> form is the default format: it
|
|
consists of the <B></B><FONT SIZE="-1"><B>DER</B></FONT><B></B> format base64 encoded with additional header and
|
|
footer lines.
|
|
<DT id="3"><B>-outform DER|PEM</B><DD>
|
|
|
|
|
|
This specifies the output format, the options have the same meaning and default
|
|
as the <B>-inform</B> option.
|
|
<DT id="4"><B>-in filename</B><DD>
|
|
|
|
|
|
This specifies the input filename to read a request from or standard input
|
|
if this option is not specified. A request is only read if the creation
|
|
options (<B>-new</B> and <B>-newkey</B>) are not specified.
|
|
<DT id="5"><B>-sigopt nm:v</B><DD>
|
|
|
|
|
|
Pass options to the signature algorithm during sign or verify operations.
|
|
Names and values of these options are algorithm-specific.
|
|
<DT id="6"><B>-passin arg</B><DD>
|
|
|
|
|
|
The input file password source. For more information about the format of <B>arg</B>
|
|
see the <B></B><FONT SIZE="-1"><B>PASS PHRASE ARGUMENTS</B></FONT><B></B> section in <B><A HREF="/cgi-bin/man/man2html?1+openssl">openssl</A></B>(1).
|
|
<DT id="7"><B>-out filename</B><DD>
|
|
|
|
|
|
This specifies the output filename to write to or standard output by
|
|
default.
|
|
<DT id="8"><B>-passout arg</B><DD>
|
|
|
|
|
|
The output file password source. For more information about the format of <B>arg</B>
|
|
see the <B></B><FONT SIZE="-1"><B>PASS PHRASE ARGUMENTS</B></FONT><B></B> section in <B><A HREF="/cgi-bin/man/man2html?1+openssl">openssl</A></B>(1).
|
|
<DT id="9"><B>-text</B><DD>
|
|
|
|
|
|
Prints out the certificate request in text form.
|
|
<DT id="10"><B>-subject</B><DD>
|
|
|
|
|
|
Prints out the request subject (or certificate subject if <B>-x509</B> is
|
|
specified)
|
|
<DT id="11"><B>-pubkey</B><DD>
|
|
|
|
|
|
Outputs the public key.
|
|
<DT id="12"><B>-noout</B><DD>
|
|
|
|
|
|
This option prevents output of the encoded version of the request.
|
|
<DT id="13"><B>-modulus</B><DD>
|
|
|
|
|
|
This option prints out the value of the modulus of the public key
|
|
contained in the request.
|
|
<DT id="14"><B>-verify</B><DD>
|
|
|
|
|
|
Verifies the signature on the request.
|
|
<DT id="15"><B>-new</B><DD>
|
|
|
|
|
|
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.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
If the <B>-key</B> option is not used it will generate a new <FONT SIZE="-1">RSA</FONT> private
|
|
key using information specified in the configuration file.
|
|
<DT id="16"><B>-rand file...</B><DD>
|
|
|
|
|
|
A file or files containing random data used to seed the random number
|
|
generator.
|
|
Multiple files can be specified separated by an OS-dependent character.
|
|
The separator is <B>;</B> for MS-Windows, <B>,</B> for OpenVMS, and <B>:</B> for
|
|
all others.
|
|
<DT id="17">[<B>-writerand file</B>]<DD>
|
|
|
|
|
|
Writes random data to the specified <I>file</I> upon exit.
|
|
This can be used with a subsequent <B>-rand</B> flag.
|
|
<DT id="18"><B>-newkey arg</B><DD>
|
|
|
|
|
|
This option creates a new certificate request and a new private
|
|
key. The argument takes one of several forms. <B>rsa:nbits</B>, where
|
|
<B>nbits</B> is the number of bits, generates an <FONT SIZE="-1">RSA</FONT> key <B>nbits</B>
|
|
in size. If <B>nbits</B> is omitted, i.e. <B>-newkey rsa</B> specified,
|
|
the default key size, specified in the configuration file is used.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
All other algorithms support the <B>-newkey alg:file</B> form, where file may be
|
|
an algorithm parameter file, created by the <B>genpkey -genparam</B> command
|
|
or and X.509 certificate for a key with appropriate algorithm.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
<B>param:file</B> generates a key using the parameter file or certificate <B>file</B>,
|
|
the algorithm is determined by the parameters. <B>algname:file</B> use algorithm
|
|
<B>algname</B> and parameter file <B>file</B>: the two algorithms must match or an
|
|
error occurs. <B>algname</B> just uses algorithm <B>algname</B>, and parameters,
|
|
if necessary should be specified via <B>-pkeyopt</B> parameter.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
<B>dsa:filename</B> generates a <FONT SIZE="-1">DSA</FONT> key using the parameters
|
|
in the file <B>filename</B>. <B>ec:filename</B> generates <FONT SIZE="-1">EC</FONT> key (usable both with
|
|
<FONT SIZE="-1">ECDSA</FONT> or <FONT SIZE="-1">ECDH</FONT> algorithms), <B>gost2001:filename</B> generates <FONT SIZE="-1">GOST R
|
|
34.10-2001</FONT> key (requires <B>ccgost</B> engine configured in the configuration
|
|
file). If just <B>gost2001</B> is specified a parameter set should be
|
|
specified by <B>-pkeyopt paramset:X</B>
|
|
<DT id="19"><B>-pkeyopt opt:value</B><DD>
|
|
|
|
|
|
Set the public key algorithm option <B>opt</B> to <B>value</B>. The precise set of
|
|
options supported depends on the public key algorithm used and its
|
|
implementation. See <B></B><FONT SIZE="-1"><B>KEY GENERATION OPTIONS</B></FONT><B></B> in the <B>genpkey</B> manual page
|
|
for more details.
|
|
<DT id="20"><B>-key filename</B><DD>
|
|
|
|
|
|
This specifies the file to read the private key from. It also
|
|
accepts PKCS#8 format private keys for <FONT SIZE="-1">PEM</FONT> format files.
|
|
<DT id="21"><B>-keyform PEM|DER</B><DD>
|
|
|
|
|
|
The format of the private key file specified in the <B>-key</B>
|
|
argument. <FONT SIZE="-1">PEM</FONT> is the default.
|
|
<DT id="22"><B>-keyout filename</B><DD>
|
|
|
|
|
|
This gives the filename to write the newly created private key to.
|
|
If this option is not specified then the filename present in the
|
|
configuration file is used.
|
|
<DT id="23"><B>-nodes</B><DD>
|
|
|
|
|
|
If this option is specified then if a private key is created it
|
|
will not be encrypted.
|
|
<DT id="24"><B>-</B>digest<B></B><DD>
|
|
|
|
|
|
This specifies the message digest to sign the request.
|
|
Any digest supported by the OpenSSL <B>dgst</B> command can be used.
|
|
This overrides the digest algorithm specified in
|
|
the configuration file.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Some public key algorithms may override this choice. For instance, <FONT SIZE="-1">DSA</FONT>
|
|
signatures always use <FONT SIZE="-1">SHA1, GOST R 34.10</FONT> signatures always use
|
|
<FONT SIZE="-1">GOST R 34.11-94</FONT> (<B>-md_gost94</B>), Ed25519 and Ed448 never use any digest.
|
|
<DT id="25"><B>-config filename</B><DD>
|
|
|
|
|
|
This allows an alternative configuration file to be specified.
|
|
Optional; for a description of the default value,
|
|
see ``<FONT SIZE="-1">COMMAND SUMMARY''</FONT> in <B><A HREF="/cgi-bin/man/man2html?1+openssl">openssl</A></B>(1).
|
|
<DT id="26"><B>-subj arg</B><DD>
|
|
|
|
|
|
Sets subject name for new request or supersedes the subject name
|
|
when processing a request.
|
|
The arg must be formatted as <I>/type0=value0/type1=value1/type2=...</I>.
|
|
Keyword characters may be escaped by \ (backslash), and whitespace is retained.
|
|
Empty values are permitted, but the corresponding type will not be included
|
|
in the request.
|
|
<DT id="27"><B>-multivalue-rdn</B><DD>
|
|
|
|
|
|
This option causes the -subj argument to be interpreted with full
|
|
support for multivalued RDNs. Example:
|
|
|
|
|
|
<P>
|
|
|
|
|
|
<I>/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe</I>
|
|
|
|
|
|
<P>
|
|
|
|
|
|
If -multi-rdn is not used then the <FONT SIZE="-1">UID</FONT> value is <I>123456+CN=John Doe</I>.
|
|
<DT id="28"><B>-x509</B><DD>
|
|
|
|
|
|
This option outputs a self signed certificate instead of a certificate
|
|
request. This is typically used to generate a test certificate or
|
|
a self signed root <FONT SIZE="-1">CA.</FONT> The extensions added to the certificate
|
|
(if any) are specified in the configuration file. Unless specified
|
|
using the <B>set_serial</B> option, a large random number will be used for
|
|
the serial number.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
If existing request is specified with the <B>-in</B> option, it is converted
|
|
to the self signed certificate otherwise new request is created.
|
|
<DT id="29"><B>-days n</B><DD>
|
|
|
|
|
|
When the <B>-x509</B> option is being used this specifies the number of
|
|
days to certify the certificate for, otherwise it is ignored. <B>n</B> should
|
|
be a positive integer. The default is 30 days.
|
|
<DT id="30"><B>-set_serial n</B><DD>
|
|
|
|
|
|
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 <B>0x</B>.
|
|
<DT id="31"><B>-addext ext</B><DD>
|
|
|
|
|
|
Add a specific extension to the certificate (if the <B>-x509</B> option is
|
|
present) or certificate request. The argument must have the form of
|
|
a key=value pair as it would appear in a config file.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
This option can be given multiple times.
|
|
<DT id="32"><B>-extensions section</B><DD>
|
|
|
|
|
|
|
|
<DT id="33"><B>-reqexts section</B><DD>
|
|
|
|
|
|
|
|
These options specify alternative sections to include certificate
|
|
extensions (if the <B>-x509</B> option is present) or certificate
|
|
request extensions. This allows several different sections to
|
|
be used in the same configuration file to specify requests for
|
|
a variety of purposes.
|
|
<DT id="34"><B>-precert</B><DD>
|
|
|
|
|
|
A poison extension will be added to the certificate, making it a
|
|
``pre-certificate'' (see <FONT SIZE="-1">RFC6962</FONT>). 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.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
This implies the <B>-new</B> flag.
|
|
<DT id="35"><B>-utf8</B><DD>
|
|
|
|
|
|
This option causes field values to be interpreted as <FONT SIZE="-1">UTF8</FONT> strings, by
|
|
default they are interpreted as <FONT SIZE="-1">ASCII.</FONT> This means that the field
|
|
values, whether prompted from a terminal or obtained from a
|
|
configuration file, must be valid <FONT SIZE="-1">UTF8</FONT> strings.
|
|
<DT id="36"><B>-nameopt option</B><DD>
|
|
|
|
|
|
Option which determines how the subject or issuer names are displayed. The
|
|
<B>option</B> argument can be a single option or multiple options separated by
|
|
commas. Alternatively the <B>-nameopt</B> switch may be used more than once to
|
|
set multiple options. See the <B><A HREF="/cgi-bin/man/man2html?1+x509">x509</A></B>(1) manual page for details.
|
|
<DT id="37"><B>-reqopt</B><DD>
|
|
|
|
|
|
Customise the output format used with <B>-text</B>. The <B>option</B> argument can be
|
|
a single option or multiple options separated by commas.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
See discussion of the <B>-certopt</B> parameter in the <B><A HREF="/cgi-bin/man/man2html?1+x509">x509</A></B>(1)
|
|
command.
|
|
<DT id="38"><B>-newhdr</B><DD>
|
|
|
|
|
|
Adds the word <B></B><FONT SIZE="-1"><B>NEW</B></FONT><B></B> to the <FONT SIZE="-1">PEM</FONT> file header and footer lines on the outputted
|
|
request. Some software (Netscape certificate server) and some CAs need this.
|
|
<DT id="39"><B>-batch</B><DD>
|
|
|
|
|
|
Non-interactive mode.
|
|
<DT id="40"><B>-verbose</B><DD>
|
|
|
|
|
|
Print extra details about the operations being performed.
|
|
<DT id="41"><B>-engine id</B><DD>
|
|
|
|
|
|
Specifying an engine (by its unique <B>id</B> string) will cause <B>req</B>
|
|
to attempt to obtain a functional reference to the specified engine,
|
|
thus initialising it if needed. The engine will then be set as the default
|
|
for all available algorithms.
|
|
<DT id="42"><B>-keygen_engine id</B><DD>
|
|
|
|
|
|
Specifies an engine (by its unique <B>id</B> string) which would be used
|
|
for key generation operations.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CONFIGURATION FILE FORMAT</H2>
|
|
|
|
|
|
|
|
The configuration options are specified in the <B>req</B> section of
|
|
the configuration file. As with all configuration files if no
|
|
value is specified in the specific section (i.e. <B>req</B>) then
|
|
the initial unnamed or <B>default</B> section is searched too.
|
|
<P>
|
|
|
|
The options available are described in detail below.
|
|
<DL COMPACT>
|
|
<DT id="43"><B>input_password output_password</B><DD>
|
|
|
|
|
|
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 <B>passin</B> and <B>passout</B> override the
|
|
configuration file values.
|
|
<DT id="44"><B>default_bits</B><DD>
|
|
|
|
|
|
Specifies the default key size in bits.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
This option is used in conjunction with the <B>-new</B> option to generate
|
|
a new key. It can be overridden by specifying an explicit key size in
|
|
the <B>-newkey</B> option. The smallest accepted key size is 512 bits. If
|
|
no key size is specified then 2048 bits is used.
|
|
<DT id="45"><B>default_keyfile</B><DD>
|
|
|
|
|
|
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 <B>-keyout</B> option.
|
|
<DT id="46"><B>oid_file</B><DD>
|
|
|
|
|
|
This specifies a file containing additional <B></B><FONT SIZE="-1"><B>OBJECT IDENTIFIERS</B></FONT><B></B>.
|
|
Each line of the file should consist of the numerical form of the
|
|
object identifier followed by white space then the short name followed
|
|
by white space and finally the long name.
|
|
<DT id="47"><B>oid_section</B><DD>
|
|
|
|
|
|
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 <B>=</B> and the numerical form. The short
|
|
and long names are the same when this option is used.
|
|
<DT id="48"><B></B><FONT SIZE="-1"><B>RANDFILE</B></FONT><B></B><DD>
|
|
|
|
|
|
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.
|
|
<DT id="49"><B>encrypt_key</B><DD>
|
|
|
|
|
|
If this is set to <B>no</B> then if a private key is generated it is
|
|
<B>not</B> encrypted. This is equivalent to the <B>-nodes</B> command line
|
|
option. For compatibility <B>encrypt_rsa_key</B> is an equivalent option.
|
|
<DT id="50"><B>default_md</B><DD>
|
|
|
|
|
|
This option specifies the digest algorithm to use. Any digest supported by the
|
|
OpenSSL <B>dgst</B> 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.
|
|
<DT id="51"><B>string_mask</B><DD>
|
|
|
|
|
|
This option masks out the use of certain string types in certain
|
|
fields. Most users will not need to change this option.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
It can be set to several values <B>default</B> which is also the default
|
|
option uses PrintableStrings, T61Strings and BMPStrings if the
|
|
<B>pkix</B> value is used then only PrintableStrings and BMPStrings will
|
|
be used. This follows the <FONT SIZE="-1">PKIX</FONT> recommendation in <FONT SIZE="-1">RFC2459.</FONT> If the
|
|
<B>utf8only</B> option is used then only UTF8Strings will be used: this
|
|
is the <FONT SIZE="-1">PKIX</FONT> recommendation in <FONT SIZE="-1">RFC2459</FONT> after 2003. Finally the <B>nombstr</B>
|
|
option just uses PrintableStrings and T61Strings: certain software has
|
|
problems with BMPStrings and UTF8Strings: in particular Netscape.
|
|
<DT id="52"><B>req_extensions</B><DD>
|
|
|
|
|
|
This specifies the configuration file section containing a list of
|
|
extensions to add to the certificate request. It can be overridden
|
|
by the <B>-reqexts</B> command line switch. See the
|
|
<B><A HREF="/cgi-bin/man/man2html?5+x509v3_config">x509v3_config</A></B>(5) manual page for details of the
|
|
extension section format.
|
|
<DT id="53"><B>x509_extensions</B><DD>
|
|
|
|
|
|
This specifies the configuration file section containing a list of
|
|
extensions to add to certificate generated when the <B>-x509</B> switch
|
|
is used. It can be overridden by the <B>-extensions</B> command line switch.
|
|
<DT id="54"><B>prompt</B><DD>
|
|
|
|
|
|
If set to the value <B>no</B> this disables prompting of certificate fields
|
|
and just takes values from the config file directly. It also changes the
|
|
expected format of the <B>distinguished_name</B> and <B>attributes</B> sections.
|
|
<DT id="55"><B>utf8</B><DD>
|
|
|
|
|
|
If set to the value <B>yes</B> then field values to be interpreted as <FONT SIZE="-1">UTF8</FONT>
|
|
strings, by default they are interpreted as <FONT SIZE="-1">ASCII.</FONT> This means that
|
|
the field values, whether prompted from a terminal or obtained from a
|
|
configuration file, must be valid <FONT SIZE="-1">UTF8</FONT> strings.
|
|
<DT id="56"><B>attributes</B><DD>
|
|
|
|
|
|
This specifies the section containing any request attributes: its format
|
|
is the same as <B>distinguished_name</B>. 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.
|
|
<DT id="57"><B>distinguished_name</B><DD>
|
|
|
|
|
|
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.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT</H2>
|
|
|
|
|
|
|
|
There are two separate formats for the distinguished name and attribute
|
|
sections. If the <B>prompt</B> option is set to <B>no</B> then these sections
|
|
just consist of field names and values: for example,
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
CN=My Name
|
|
OU=My Organization
|
|
emailAddress=<A HREF="mailto:someone@somewhere.org">someone@somewhere.org</A>
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
This allows external programs (e.g. <FONT SIZE="-1">GUI</FONT> based) to generate a template file
|
|
with all the field names and values and just pass it to <B>req</B>. An example
|
|
of this kind of configuration file is contained in the <B></B><FONT SIZE="-1"><B>EXAMPLES</B></FONT><B></B> section.
|
|
<P>
|
|
|
|
Alternatively if the <B>prompt</B> option is absent or not set to <B>no</B> then the
|
|
file contains field prompting information. It consists of lines of the form:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
fieldName="prompt"
|
|
fieldName_default="default field value"
|
|
fieldName_min= 2
|
|
fieldName_max= 4
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
``fieldName'' is the field name being used, for example commonName (or <FONT SIZE="-1">CN</FONT>).
|
|
The ``prompt'' 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.
|
|
<P>
|
|
|
|
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).
|
|
<P>
|
|
|
|
Some fields (such as organizationName) can be used more than once
|
|
in a <FONT SIZE="-1">DN.</FONT> 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 ``1.organizationName''.
|
|
<P>
|
|
|
|
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.
|
|
<P>
|
|
|
|
Additional object identifiers can be defined with the <B>oid_file</B> or
|
|
<B>oid_section</B> options in the configuration file. Any additional fields
|
|
will be treated as though they were a DirectoryString.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
|
|
|
|
Examine and verify certificate request:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
openssl req -in req.pem -text -verify -noout
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Create a private key and then generate a certificate request from it:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
openssl genrsa -out key.pem 2048
|
|
openssl req -new -key key.pem -out req.pem
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
The same but just using req:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
openssl req -newkey rsa:2048 -keyout key.pem -out req.pem
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Generate a self signed root certificate:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out req.pem
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Example of a file pointed to by the <B>oid_file</B> option:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
1.2.3.4 shortName A longer Name
|
|
1.2.3.6 otherName Other longer Name
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Example of a section pointed to by <B>oid_section</B> making use of variable
|
|
expansion:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
testoid1=1.2.3.5
|
|
testoid2=${testoid1}.6
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Sample configuration file prompting for field values:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
[ 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
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Sample configuration containing all field values:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
RANDFILE = $ENV::HOME/.rnd
|
|
|
|
[ 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 = <A HREF="mailto:test@email.address">test@email.address</A>
|
|
|
|
[ req_attributes ]
|
|
challengePassword = A challenge password
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
Example of giving the most common attributes (subject and extensions)
|
|
on the command line:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
openssl req -new -subj "/C=GB/CN=foo" \
|
|
-addext "subjectAltName = DNS:foo.co.uk" \
|
|
-addext "certificatePolicies = 1.2.3.4" \
|
|
-newkey rsa:2048 -keyout key.pem -out req.pem
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
|
|
|
|
The header and footer lines in the <B></B><FONT SIZE="-1"><B>PEM</B></FONT><B></B> format are normally:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
-----BEGIN CERTIFICATE REQUEST-----
|
|
-----END CERTIFICATE REQUEST-----
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
some software (some versions of Netscape certificate server) instead needs:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
-----BEGIN NEW CERTIFICATE REQUEST-----
|
|
-----END NEW CERTIFICATE REQUEST-----
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
which is produced with the <B>-newhdr</B> option but is otherwise compatible.
|
|
Either form is accepted transparently on input.
|
|
<P>
|
|
|
|
The certificate requests generated by <B>Xenroll</B> with <FONT SIZE="-1">MSIE</FONT> have extensions
|
|
added. It includes the <B>keyUsage</B> extension which determines the type of
|
|
key (signature only or general purpose) and any additional OIDs entered
|
|
by the script in an extendedKeyUsage extension.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>DIAGNOSTICS</H2>
|
|
|
|
|
|
|
|
The following messages are frequently asked about:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
Using configuration from /some/path/openssl.cnf
|
|
Unable to load config info
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
This is followed some time later by...
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
unable to find 'distinguished_name' in config
|
|
problems making Certificate Request
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
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.
|
|
<P>
|
|
|
|
Another puzzling message is this:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
Attributes:
|
|
a0:00
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
this is displayed when no attributes are present and the request includes
|
|
the correct empty <B></B><FONT SIZE="-1"><B>SET OF</B></FONT><B></B> structure (the <FONT SIZE="-1">DER</FONT> encoding of which is 0xa0
|
|
0x00). If you just see:
|
|
<P>
|
|
|
|
|
|
|
|
<PRE>
|
|
Attributes:
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
then the <B></B><FONT SIZE="-1"><B>SET OF</B></FONT><B></B> is missing and the encoding is technically invalid (but
|
|
it is tolerated). See the description of the command line option <B>-asn1-kludge</B>
|
|
for more information.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
|
|
|
|
OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively
|
|
treats them as <FONT SIZE="-1">ISO-8859-1</FONT> (Latin 1), Netscape and <FONT SIZE="-1">MSIE</FONT> 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.
|
|
<P>
|
|
|
|
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 <FONT SIZE="-1">MSIE</FONT> then you currently need to use the invalid T61String form.
|
|
<P>
|
|
|
|
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.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+x509">x509</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+ca">ca</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+genrsa">genrsa</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gendsa">gendsa</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?5+config">config</A></B>(5),
|
|
<B><A HREF="/cgi-bin/man/man2html?5+x509v3_config">x509v3_config</A></B>(5)
|
|
<A NAME="lbAM"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
<P>
|
|
|
|
Licensed under the OpenSSL license (the ``License''). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file <FONT SIZE="-1">LICENSE</FONT> in the source distribution or at
|
|
<<A HREF="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</A>>.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="58"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="59"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="60"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="61"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="62"><A HREF="#lbAF">CONFIGURATION FILE FORMAT</A><DD>
|
|
<DT id="63"><A HREF="#lbAG">DISTINGUISHED NAME AND ATTRIBUTE SECTION FORMAT</A><DD>
|
|
<DT id="64"><A HREF="#lbAH">EXAMPLES</A><DD>
|
|
<DT id="65"><A HREF="#lbAI">NOTES</A><DD>
|
|
<DT id="66"><A HREF="#lbAJ">DIAGNOSTICS</A><DD>
|
|
<DT id="67"><A HREF="#lbAK">BUGS</A><DD>
|
|
<DT id="68"><A HREF="#lbAL">SEE ALSO</A><DD>
|
|
<DT id="69"><A HREF="#lbAM">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:26 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|