OPENSSL-REQ(1ossl)
okay bestie, welcome to OPENSSL-REQ(1ossl) β the OpenSSL manual page for openssl-req, and she is literally serving PKCS#10 realness. No cap, this is the certificate-request-and-certificate-generating command, and we're gonna get you comfy with her. π
π NAME π
openssl-req β PKCS#10 certificate request and certificate generating command. That's the whole name vibe, and she contains multitudes. β¨
β¨ SYNOPSIS β¨
Here's the full invocation, bestie β every bracket exactly where it belongs:
openssl req [-help] [-cipher] [-inform DER|PEM] [-outform DER|PEM] [-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 DER|PEM|P12|ENGINE]
[-keyout filename] [-keygen_engine id] [-digest] [-config filename]
[-section name] [-x509] [-x509v1] [-CA filename|uri] [-CAkey
filename|uri] [-not_before date] [-not_after date] [-days n]
[-set_serial n] [-newhdr] [-copy_extensions arg] [-extensions section]
[-reqexts section] [-addext ext] [-precert] [-utf8] [-reqopt] [-subject]
[-subj arg] [-multivalue-rdn] [-sigopt nm:v] [-vfyopt nm:v] [-batch]
[-verbose] [-quiet] [-nameopt option] [-rand files] [-writerand file]
[-engine id] [-provider name] [-provider-path path] [-provparam
[name:]key=value] [-propquery propq]
πΈ DESCRIPTION πΈ
The main-character job: she primarily creates and processes certificate requests (CSRs) in PKCS#10 format. As a bonus, she can additionally create self-signed certificates, like for use as root CAs for example. π«Ά
π OPTIONS π
Okay, option-by-option, no skips, no βomg I'll read it later.β We keep every detail. π§
-helpβ Print out a usage message. Helpful queen behavior. π-inform DER|PEMβ The CSR input file format to use; by defaultPEMis tried first. Seeopenssl-format-options(1)for details. π¦-outform DER|PEMβ The output format; unspecified by default. Seeopenssl-format-options(1)for details. The data is aPKCS#10object. β¨-cipher nameβ Specify the cipher to be used for encrypting the private key. If no cipher is specified,AES-256-CBCwill be used by default. You can override this by providing any valid OpenSSL cipher name. π-in filenameβ This specifies the input filename to read a request from. This defaults to standard input unless-x509or-CAis specified. A request is only read if the creation options (-newor-newkeyor-precert) are not specified. π₯-sigopt nm:vβ Pass options to the signature algorithm during sign operations. Names and values of these options are algorithm-specific. βοΈ-vfyopt nm:vβ Pass options to the signature algorithm during verify operations. Names and values of these options are algorithm-specific. π-passin argβ The password source for private key and certificate input. For more information about the format ofargseeopenssl-passphrase-options(1). ποΈ-passout argβ The password source for the output file. For more information about the format ofargseeopenssl-passphrase-options(1). π-out filenameβ This specifies the output filename to write to or standard output by default. π€-textβ Prints out the certificate request in text form. Read her like a book. π-subjectβ Prints out the certificate request subject (or certificate subject if-x509is in use). πͺͺ-pubkeyβ Prints out the public key. Public key said hi. π-nooutβ This option prevents output of the encoded version of the certificate request. π«-modulusβ Prints out the value of the modulus of the public key contained in the request. Big number energy. π’-verifyβ Verifies the self-signature on the request. If the verification fails, the program will immediately exit, i.e. further option processing (e.g.-text) is skipped. β οΈ-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.
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 RSA key with 2048 bits length. π±
-newkey argβ This option is used to generate a new private key unless-keyis given. It is subsequently used as if it was given using the-keyoption.
This option implies the -new flag to create a new certificate request or a new certificate in case -x509 is used.
The argument takes one of several forms:
[rsa:]nbitsgenerates an RSA keynbitsin size. Ifnbitsis omitted, i.e.,-newkey rsais specified, the default key size specified in the configuration file with thedefault_bitsoption is used if present, else2048.- All other algorithms support the
-newkey algname:fileform, wherefileis an algorithm parameter file, created withopenssl genpkey -genparamor an X.509 certificate for a key with appropriate algorithm. param:filegenerates a key using the parameter file or certificate file, the algorithm is determined by the parameters.algname[:file]generates a key using the given algorithmalgname. If a parameter filefileis given then the parameters specified there are used, where the algorithm parameters must matchalgname. If algorithm parameters are not given, any necessary parameters should be specified via the-pkeyoptoption.dsa:filenamegenerates a DSA key using the parameters in the filefilename.ec:filenamegenerates EC key (usable both with ECDSA or ECDH algorithms),gost2001:filenamegenerates GOST R 34.10-2001 key (requires gost engine configured in the configuration file). If justgost2001is specified a parameter set should be specified by-pkeyopt paramset:X. π
-pkeyopt opt:valueβ Set the public key algorithm optionopttovalue. The precise set of options supported depends on the public key algorithm used and its implementation. See"KEY GENERATION OPTIONS" in openssl-genpkey(1)for more details. π οΈ-key filename|uriβ This option provides the private key for signing a new certificate or certificate request. Unless-inis given, the corresponding public key is placed in the new certificate or certificate request, resulting in a self-signature.
For certificate signing this option is overridden by the -CA option.
This option also accepts PKCS#8 format private keys for PEM format files. ποΈ
-keyform DER|PEM|P12|ENGINEβ The format of the private key; unspecified by default. Seeopenssl-format-options(1)for details. π¦-keyout filenameβ This gives the filename to write any private key to that has been newly created or read from-key. If neither the-keyoutoption nor the-keyoption are given then the filename specified in the configuration file with thedefault_keyfileoption is used, if present. Thus, if you want to write the private key and the-keyoption is provided, you should provide the-keyoutoption explicitly. If a new key is generated and no filename is specified the key is written to standard output. πΎ-noencβ If this option is specified then if a private key is created it will not be encrypted. π-nodesβ This option is deprecated since OpenSSL 3.0; use-noencinstead. π¨-digestβ This specifies the message digest to sign the request. Any digest supported by the OpenSSLdgstcommand can be used. This overrides the digest algorithm specified in the configuration file.
Some public key algorithms may override this choice. For instance, DSA signatures always use SHA1, GOST R 34.10 signatures always use GOST R 34.11-94 (-md_gost94), Ed25519 and Ed448 never use any digest. π§¬
-config filenameβ This allows an alternative configuration file to be specified. Optional; for a description of the default value, see"COMMAND SUMMARY" in openssl(1). π-section nameβ Specifies the name of the section to use; the default isreq. π·οΈ-subj argβ Sets subject name for new request or supersedes the subject name when processing a certificate request.
The arg must be formatted as "/type0=value0/type1=value1/type2=...". Special characters may be escaped by \ (backslash), whitespace is retained. Empty values are permitted, but the corresponding type will not be included in the request. Giving a single "/" will lead to an empty sequence of RDNs (a NULL-DN). Multi-valued RDNs can be formed by placing a "+" character instead of a "/" between the AttributeValueAssertions (AVAs) that specify the members of the set. Example: "/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe". πͺͺ
-multivalue-rdnβ This option has been deprecated and has no effect. π-x509β This option outputs a certificate instead of a certificate request. This is typically used to generate test certificates. It is implied by the-CAoption.
This option implies the -new flag if -in is not given.
If an existing request is specified with the -in option, it is converted to a certificate; otherwise a request is created from scratch.
Unless specified using the -set_serial option, a large random number will be used for the serial number.
Unless the -copy_extensions option is used, X.509 extensions are not copied from any provided request input file.
X.509 extensions to be added can be specified in the configuration file, possibly using the -config and -extensions options, and/or using the -addext option.
Unless -x509v1 is given, generated certificates bear X.509 version 3. Unless specified otherwise, key identifier extensions are included as described in x509v3_config(5). π
-x509v1β Request generation of certificates with X.509 version 1. This implies-x509. If X.509 extensions are given, anyway X.509 version 3 is set. 1οΈβ£-CA filename|uriβ Specifies the"CA"certificate to be used for signing a new certificate and implies use of-x509. When present, this behaves like a"micro CA"as follows: The subject name of the"CA"certificate is placed as issuer name in the new certificate, which is then signed using the"CA"key given as specified below. π-CAkey filename|uriβ Sets the"CA"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-CAinput. π-not_before dateβ When-x509is in use this allows the start date to be explicitly set, otherwise it is ignored. The format ofdateisYYMMDDHHMMSSZ(the same as an ASN1UTCTimestructure), orYYYYMMDDHHMMSSZ(the same as an ASN1GeneralizedTimestructure). In both formats, secondsSSand timezoneZmust be present. Alternatively, you can also use"today". π-not_afterdate β okay so when you're using-x509, this lets you literally set the expiry date yourself instead of letting the tool vibe-check it for you. If-x509isn't in play? Ignored, bestie, it just sits there. π
The format of date is YYMMDDHHMMSSZ (same energy as an ASN1 UTCTime structure), or YYYYMMDDHHMMSSZ (that's the ASN1 GeneralizedTime structure flavor). In both formats the seconds SS and the timezone Z have to be there β no skipping, no cap. π«Ά
Alternatively you can just write "today" and call it a day.
Heads up: this overrides the -days option. Like, completely.
-daysn β when-x509is in use, this says how many days from today the certificate should be valid for. Otherwise it's ignored, periodt. n should be a positive integer, and the default is30days. β
Regardless of the option -not_before, the days are always counted from today. And if you use it together with -not_after, the explicit expiry date wins. π₯
-set_serialn β the serial number to use when outputting a self-signed certificate. You can give it as a decimal value, or as a hex value if you stick0xin front. If you don't give one at all, a big random number gets used instead (main character energy fr). π²-copy_extensionsarg β controls how X.509 extensions in certificate requests get handled when-x509is in use. If arg isnone, or you just don't pass the option, then extensions are ignored, no thoughts head empty. If arg iscopyorcopyall, then all extensions in the request get copied over to the certificate. β¨
The main use of this option is letting a certificate request supply values for certain extensions such as subjectAltName.
-extensionssection,-reqextssection β these override the name of the config file section that X.509 extensions get pulled from β either for the certificate (when-x509is in use) or for the certificate request. Which means you can have several different sections in the same config file for requests of various purposes. Slay, organization. π-addextext β adds a specific extension to the certificate (if-x509is in use) or to the certificate request. The argument has to look like a"key=value"pair, exactly like it would appear in a config file.
If an extension you add this way has the same OID as one defined in the extension section of the config file, it overrides that one.
You can give this option multiple times β just don't give the same key more than once, that's the rule. π
-precertβ adds a poison extension to the certificate, which makes it a "pre-certificate" (peep RFC6962). You can submit this to Certificate Transparency logs to get signed certificate timestamps (SCTs). Then those SCTs can be embedded into the pre-certificate as an extension, before the poison gets removed and the certificate gets signed. π
This implies the -new flag.
-utf8β makes field values be interpreted as UTF8 strings. By default they're interpreted as ASCII. So the field values β whether they get prompted from a terminal or read from a config file β have to be valid UTF8 strings. π-reqoptoption β customizes the printing format used with-text. The option argument can be one single option, or multiple options separated by commas.
See the discussion of the -certopt parameter in the openssl-x509(1) command. iykyk.
-newhdrβ adds the wordNEWto the PEM file header and footer lines on the outputted request. Some software (like the Netscape certificate server) and some CAs need this. Retro, honestly. π-batchβ non-interactive mode. That's it, that's the whole vibe.-verboseβ prints extra details about the operations being performed. Give me the lore. π-quietβ prints fewer details about the operations being performed, which may be handy during batch scripts or pipelines. Specifically, the "progress dots" during key generation get suppressed. π€«-keygen_engineid β specifies an engine (by its unique id string) that would be used for key generation operations.-nameoptoption β specifies how the subject or issuer names are displayed. Seeopenssl-namedisplay-options(1)for the details. π¦-randfiles,-writerandfile β see "Random State Options" inopenssl(1)for details.-engineid β see "Engine Options" inopenssl(1).
Careful, bestie: this option is deprecated.
-providername,-provider-pathpath,-provparam[name:]key=value,-propquerypropq β see "Provider Options" inopenssl(1),provider(7), andproperty(7). π§
π CONFIGURATION FILE FORMAT π
The configuration options live in the req section of the configuration file. You can specify an alternate name by using the -section option. And, like with all configuration files, if no value is specified in the specific section then the initial unnamed or default section gets searched too. Fingers crossed it's there. π
The options available are described in detail below. Get comfy. π
input_password,output_passwordβ the passwords for the input private key file (if there is one) and the output private key file (if one is going to be created). The command line optionspassinandpassoutoverride the configuration file values. πdefault_bitsβ specifies the default key size in bits.
This option is used together 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β the default filename to write a private key to. If it's not specified, the key gets written to standard output. This can be overridden by the-keyoutoption.oid_fileβ specifies a file containing additionalOBJECT IDENTIFIERS. 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. Don't forget the whitespace, it's doing unpaid labor. πoid_sectionβ 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.RANDFILEβ at startup the specified file is loaded into the random number generator, and at exit256bytes get written to it. It's used for private key generation. π²encrypt_keyβ if this is set tonothen, if a private key is generated, it is not encrypted. This is equivalent to the-noenccommand line option. For compatibility,encrypt_rsa_keyis an equivalent option. β¨default_mdβ specifies the digest algorithm to use. Any digest supported by the OpenSSLdgstcommand can be used. This option can be overridden on the command line. Certain signing algorithms (i.e.Ed25519andEd448) will ignore any digest that has been set. Rude, but okay. πstring_maskβ masks out the use of certain string types in certain fields. Most users will not need to change this option. It can be set to several values:utf8onlyβ onlyUTF8Stringsare used (this is the default value)pkixβ any string type exceptT61Stringsnombstrβ any string type exceptBMPStringsandUTF8Stringsdefaultβ any kind of string type
Note that utf8only is the PKIX recommendation in RFC2459 after 2003, and it's the default string_mask. default is not the default option (iconic naming choice, honestly). The nombstr value is a workaround for some software that has problems with variable-sized BMPStrings and UTF8Strings. π«Ά
req_extensionsβ specifies the configuration file section containing a list of extensions to add to the certificate request. It can be overridden by the-reqexts(or-extensions) command line switch. See thex509v3_config(5)manual page for the details of the extension section format. πΈx509_extensionsβ specifies the configuration file section containing a list of extensions to add to the certificate generated when-x509is in use. It can be overridden by the-extensionscommand line switch.promptβ if set to the valueno, this disables prompting of certificate fields and just takes values from the config file directly. It also changes the expected format of thedistinguished_nameandattributessections. No questions, just vibes. π¦utf8β if set to the valueyesthen field values get interpreted as UTF8 strings. By default they're interpreted as ASCII. This means that the field values β whether prompted from a terminal or obtained from a configuration file β must be valid UTF8 strings. πattributesβ specifies the section containing any request attributes; its format is the same asdistinguished_name. Typically these may contain thechallengePasswordorunstructuredNametypes. They're currently ignored by OpenSSL's request signing utilities, but some CAs might want them. πdistinguished_nameβ 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 π
okay so bestie, here's the tea: there are two separate formats for the distinguished name and attribute sections, and which one you get depends on the prompt option. wild, right?
If prompt is set to no, then these sections literally just consist of field names and values. like, that's it. for example:
CN=My Name
OU=My Organization
emailAddress=someone@somewhere.org
this slaps because it lets external programs (think GUI-based ones π) generate a template file with all the field names and values, and just pass it straight to this command. iykyk. there's an example of exactly this kind of configuration file down in the EXAMPLES section, so keep reading π
Alternatively β if the prompt option is absent or just not set to no β then the file contains field prompting information instead. it consists of lines of the form:
fieldName="prompt"
fieldName_default="default field value"
fieldName_min= 2
fieldName_max= 4
so fieldName is the field name being used, for example commonName (or CN). The prompt string is what's used to ask the user to enter the relevant details. If the user enters nothing, then the default value is used β and if no default value is present, then the field is omitted. and here's a cute trick: a field can still be omitted even if a default value is present, if the user just enters the . character. periodt. β¨
The number of characters entered must be between the fieldName_min and fieldName_max limits β though ngl 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, no cap).
Some fields (such as organizationName) can be used more than once in a DN. this presents a problem because configuration files will not recognize the same name occurring twice π. so 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". slay, problem solved π«Ά
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. iconic lineup honestly π
Additional object identifiers can be defined with the oid_file or oid_section options in the configuration file. any additional fields will be treated as though they were a DirectoryString.
π EXAMPLES π
Examine and verify certificate request:
openssl req -in req.pem -text -verify -noout
Specify the cipher to be used for encrypting the private key:
openssl req -newkey rsa:2048 -keyout privatekey.pem -out request.csr -cipher aes-256-cbc
Create a private key and then generate a certificate request from it:
openssl genrsa -out key.pem 2048
openssl req -new -key key.pem -out req.pem
The same but just using req:
openssl req -newkey rsa:2048 -keyout key.pem -out req.pem
Generate a self-signed root certificate:
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out req.pem
Create an SM2 private key and then generate a certificate request from it:
openssl ecparam -genkey -name SM2 -out sm2.key
openssl req -new -key sm2.key -out sm2.csr -sm3 -sigopt "distid:1234567812345678"
Examine and verify an SM2 certificate request:
openssl req -verify -in sm2.csr -sm3 -vfyopt "distid:1234567812345678"
Example of a file pointed to by the oid_file option:
1.2.3.4 shortName A longer Name
1.2.3.6 otherName Other longer Name
Example of a section pointed to by oid_section making use of variable expansion:
testoid1=1.2.3.5
testoid2=${testoid1}.6
Sample configuration file prompting for field values:
[ req ]
default_bits = 2048
default_keyfile = privkey.pem
distinguished_name = req_distinguished_name
attributes = req_attributes
req_extensions = v3_ca
dirstring_type = nombstr
[ 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
Sample configuration containing all field values:
[ 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
Example of giving the most common attributes (subject and extensions) on the command line:
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
π¦ NOTES π¦
The certificate requests generated by Xenroll with MSIE 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. history lesson, but make it cute π
π DIAGNOSTICS π
The following messages are frequently asked about:
Using configuration from /some/path/openssl.cnf
Unable to load config info
This is followed some time later by:
unable to find 'distinguished_name' in config
problems making Certificate Request
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:
Attributes:
a0:00
this is displayed when no attributes are present and the request includes the correct empty SET OF structure (the DER encoding of which is 0xa0 0x00). If you just see:
Attributes:
then the SET OF 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. lowkey mysterious but we move π§
π BUGS π
OpenSSL's handling of T61Strings (aka TeletexStrings) is broken: it effectively treats them as ISO-8859-1 (Latin 1), Netscape and MSIE 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. not the vibe, but it is what it is π
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 MSIE then you currently need to use the invalid T61String form. tragic, fr fr.
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. we're manifesting better prompting in a future version β¨
πΈ SEE ALSO πΈ
openssl(1), openssl-x509(1), openssl-ca(1), openssl-genrsa(1), openssl-gendsa(1), config(5), x509v3_config(5)
go read those next, bestie, they're all part of the same cinematic universe π
π HISTORY π
- The default encryption cipher was changed from
3DEStoAES-256in OpenSSL 3.5. - The
-sectionoption was added in OpenSSL 3.0.0. - The
-multivalue-rdnoption has become obsolete in OpenSSL 3.0.0 and has no effect. - The
-engineoption was deprecated in OpenSSL 3.0. The<-nodes>option was deprecated in OpenSSL 3.0, too; use-noencinstead. - The
-reqextsoption has been made an alias of-extensionsin OpenSSL 3.2. - Since OpenSSL 3.2, generated certificates bear X.509 version 3 unless
-x509v1is given, and key identifier extensions are included by default. - Since OpenSSL 3.3, the
-verifyoption will exit with1on failure.
π COPYRIGHT π
Copyright 2000-2025 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
and that's the whole page bestie!! π«Ά this one's from OpenSSL 3.5.9, dated 2026-09-29, for OPENSSL-REQ(1ossl) β go forth and generate those CSRs, you absolute icon π
β¨π
π¦ where this page comes from
- alpine 3.23: openssl-doc 3.5.9-r0 Β· Apache-2.0
- alpine 3.24: openssl-doc 3.5.9-r0 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms