diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-req.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-req.1 | 420 |
1 files changed, 214 insertions, 206 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-req.1 b/secure/usr.bin/openssl/man/openssl-req.1 index 1a5d3263c608..d17c946ef90f 100644 --- a/secure/usr.bin/openssl/man/openssl-req.1 +++ b/secure/usr.bin/openssl/man/openssl-req.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. 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\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,23 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. 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 -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. 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 -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OPENSSL-REQ 1ossl" -.TH OPENSSL-REQ 1ossl "2023-09-22" "3.0.11" "OpenSSL" +.TH OPENSSL-REQ 1ossl 2025-07-24 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME openssl\-req \- PKCS#10 certificate request and certificate generating command -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBreq\fR [\fB\-help\fR] -[\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] -[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] +[\fB\-cipher\fR] +[\fB\-inform\fR \fBDER\fR|\fBPEM\fR] +[\fB\-outform\fR \fBDER\fR|\fBPEM\fR] [\fB\-in\fR \fIfilename\fR] [\fB\-passin\fR \fIarg\fR] [\fB\-out\fR \fIfilename\fR] @@ -159,22 +84,25 @@ openssl\-req \- PKCS#10 certificate request and certificate generating command [\fB\-noenc\fR] [\fB\-nodes\fR] [\fB\-key\fR \fIfilename\fR|\fIuri\fR] -[\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR] +[\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] [\fB\-keyout\fR \fIfilename\fR] [\fB\-keygen_engine\fR \fIid\fR] -[\fB\-\f(BIdigest\fB\fR] +[\fB\-\fR\f(BIdigest\fR] [\fB\-config\fR \fIfilename\fR] [\fB\-section\fR \fIname\fR] [\fB\-x509\fR] +[\fB\-x509v1\fR] [\fB\-CA\fR \fIfilename\fR|\fIuri\fR] [\fB\-CAkey\fR \fIfilename\fR|\fIuri\fR] +[\fB\-not_before\fR \fIdate\fR] +[\fB\-not_after\fR \fIdate\fR] [\fB\-days\fR \fIn\fR] [\fB\-set_serial\fR \fIn\fR] [\fB\-newhdr\fR] [\fB\-copy_extensions\fR \fIarg\fR] -[\fB\-addext\fR \fIext\fR] [\fB\-extensions\fR \fIsection\fR] [\fB\-reqexts\fR \fIsection\fR] +[\fB\-addext\fR \fIext\fR] [\fB\-precert\fR] [\fB\-utf8\fR] [\fB\-reqopt\fR] @@ -185,29 +113,40 @@ openssl\-req \- PKCS#10 certificate request and certificate generating command [\fB\-vfyopt\fR \fInm\fR:\fIv\fR] [\fB\-batch\fR] [\fB\-verbose\fR] +[\fB\-quiet\fR] [\fB\-nameopt\fR \fIoption\fR] [\fB\-rand\fR \fIfiles\fR] [\fB\-writerand\fR \fIfile\fR] [\fB\-engine\fR \fIid\fR] [\fB\-provider\fR \fIname\fR] [\fB\-provider\-path\fR \fIpath\fR] +[\fB\-provparam\fR \fI[name:]key=value\fR] [\fB\-propquery\fR \fIpropq\fR] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX 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. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" -.IP "\fB\-help\fR" 4 +.IP \fB\-help\fR 4 .IX Item "-help" Print out a usage message. -.IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR, \fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 -.IX Item "-inform DER|PEM, -outform DER|PEM" -The input and output formats; unspecified by default. +.IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR" 4 +.IX Item "-inform DER|PEM" +The CSR input file format to use; by default PEM is tried first. +See \fBopenssl\-format\-options\fR\|(1) for details. +.IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4 +.IX Item "-outform DER|PEM" +The output format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. .Sp The data is a PKCS#10 object. +.IP "\fB\-cipher\fR \fIname\fR" 4 +.IX Item "-cipher name" +Specify the cipher to be used for encrypting the private key. +If no cipher is specified, AES\-256\-CBC will be used by default. +You can override this by providing any valid OpenSSL cipher name. .IP "\fB\-in\fR \fIfilename\fR" 4 .IX Item "-in filename" This specifies the input filename to read a request from. @@ -235,26 +174,28 @@ see \fBopenssl\-passphrase\-options\fR\|(1). .IP "\fB\-out\fR \fIfilename\fR" 4 .IX Item "-out filename" This specifies the output filename to write to or standard output by default. -.IP "\fB\-text\fR" 4 +.IP \fB\-text\fR 4 .IX Item "-text" Prints out the certificate request in text form. -.IP "\fB\-subject\fR" 4 +.IP \fB\-subject\fR 4 .IX Item "-subject" Prints out the certificate request subject (or certificate subject if \fB\-x509\fR is in use). -.IP "\fB\-pubkey\fR" 4 +.IP \fB\-pubkey\fR 4 .IX Item "-pubkey" Prints out the public key. -.IP "\fB\-noout\fR" 4 +.IP \fB\-noout\fR 4 .IX Item "-noout" This option prevents output of the encoded version of the certificate request. -.IP "\fB\-modulus\fR" 4 +.IP \fB\-modulus\fR 4 .IX Item "-modulus" Prints out the value of the modulus of the public key contained in the request. -.IP "\fB\-verify\fR" 4 +.IP \fB\-verify\fR 4 .IX Item "-verify" -Verifies the self-signature on the request. -.IP "\fB\-new\fR" 4 +Verifies the self-signature on the request. If the verification fails, +the program will immediately exit, i.e. further option processing +(e.g. \fB\-text\fR) is skipped. +.IP \fB\-new\fR 4 .IX Item "-new" This option generates a new certificate request. It will prompt the user for the relevant field values. The actual fields @@ -264,18 +205,18 @@ in the configuration file and any requested extensions. If the \fB\-key\fR option is not given it will generate a new private key using information specified in the configuration file or given with the \fB\-newkey\fR and \fB\-pkeyopt\fR options, -else by default an \s-1RSA\s0 key with 2048 bits length. +else by default an RSA key with 2048 bits length. .IP "\fB\-newkey\fR \fIarg\fR" 4 .IX Item "-newkey arg" This option is used to generate a new private key unless \fB\-key\fR is given. It is subsequently used as if it was given using the \fB\-key\fR option. .Sp This option implies the \fB\-new\fR flag to create a new certificate request -or a new certificate in case \fB\-x509\fR is given. +or a new certificate in case \fB\-x509\fR is used. .Sp The argument takes one of several forms. .Sp -[\fBrsa:\fR]\fInbits\fR generates an \s-1RSA\s0 key \fInbits\fR in size. +[\fBrsa:\fR]\fInbits\fR generates an RSA key \fInbits\fR in size. If \fInbits\fR is omitted, i.e., \fB\-newkey\fR \fBrsa\fR is specified, the default key size specified in the configuration file with the \fBdefault_bits\fR option is used if present, else 2048. @@ -293,10 +234,10 @@ are used, where the algorithm parameters must match \fIalgname\fR. If algorithm parameters are not given, any necessary parameters should be specified via the \fB\-pkeyopt\fR option. .Sp -\&\fBdsa:\fR\fIfilename\fR generates a \s-1DSA\s0 key using the parameters -in the file \fIfilename\fR. \fBec:\fR\fIfilename\fR generates \s-1EC\s0 key (usable both with -\&\s-1ECDSA\s0 or \s-1ECDH\s0 algorithms), \fBgost2001:\fR\fIfilename\fR generates \s-1GOST R -34.10\-2001\s0 key (requires \fBgost\fR engine configured in the configuration +\&\fBdsa:\fR\fIfilename\fR generates a DSA key using the parameters +in the file \fIfilename\fR. \fBec:\fR\fIfilename\fR generates EC key (usable both with +ECDSA or ECDH algorithms), \fBgost2001:\fR\fIfilename\fR generates GOST R +34.10\-2001 key (requires \fBgost\fR engine configured in the configuration file). If just \fBgost2001\fR is specified a parameter set should be specified by \fB\-pkeyopt\fR \fIparamset:X\fR .IP "\fB\-pkeyopt\fR \fIopt\fR:\fIvalue\fR" 4 @@ -304,7 +245,7 @@ specified by \fB\-pkeyopt\fR \fIparamset:X\fR Set the public key algorithm option \fIopt\fR to \fIvalue\fR. 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 \fBopenssl\-genpkey\fR\|(1) for more details. +See "KEY GENERATION OPTIONS" in \fBopenssl\-genpkey\fR\|(1) for more details. .IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-key filename|uri" This option provides the private key for signing a new certificate or @@ -314,8 +255,8 @@ the new certificate or certificate request, resulting in a self-signature. .Sp For certificate signing this option is overridden by the \fB\-CA\fR option. .Sp -This option also accepts PKCS#8 format private keys for \s-1PEM\s0 format files. -.IP "\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4 +This option also accepts PKCS#8 format private keys for PEM format files. +.IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 .IX Item "-keyform DER|PEM|P12|ENGINE" The format of the private key; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. @@ -328,28 +269,28 @@ are given then the filename specified in the configuration file with the private key and the \fB\-key\fR option is provided, you should provide the \&\fB\-keyout\fR option explicitly. If a new key is generated and no filename is specified the key is written to standard output. -.IP "\fB\-noenc\fR" 4 +.IP \fB\-noenc\fR 4 .IX Item "-noenc" If this option is specified then if a private key is created it will not be encrypted. -.IP "\fB\-nodes\fR" 4 +.IP \fB\-nodes\fR 4 .IX Item "-nodes" This option is deprecated since OpenSSL 3.0; use \fB\-noenc\fR instead. -.IP "\fB\-\f(BIdigest\fB\fR" 4 +.IP \fB\-\fR\f(BIdigest\fR 4 .IX Item "-digest" This specifies the message digest to sign the request. Any digest supported by the OpenSSL \fBdgst\fR 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 (\fB\-md_gost94\fR), Ed25519 and Ed448 never use any digest. +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 (\fB\-md_gost94\fR), Ed25519 and Ed448 never use any digest. .IP "\fB\-config\fR \fIfilename\fR" 4 .IX 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 \fBopenssl\fR\|(1). +see "COMMAND SUMMARY" in \fBopenssl\fR\|(1). .IP "\fB\-section\fR \fIname\fR" 4 .IX Item "-section name" Specifies the name of the section to use; the default is \fBreq\fR. @@ -368,10 +309,10 @@ 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'\fR -.IP "\fB\-multivalue\-rdn\fR" 4 +.IP \fB\-multivalue\-rdn\fR 4 .IX Item "-multivalue-rdn" This option has been deprecated and has no effect. -.IP "\fB\-x509\fR" 4 +.IP \fB\-x509\fR 4 .IX Item "-x509" This option outputs a certificate instead of a certificate request. This is typically used to generate test certificates. @@ -380,7 +321,7 @@ It is implied by the \fB\-CA\fR option. This option implies the \fB\-new\fR flag if \fB\-in\fR is not given. .Sp If an existing request is specified with the \fB\-in\fR option, it is converted -to the a certificate; otherwise a request is created from scratch. +to a certificate; otherwise a request is created from scratch. .Sp Unless specified using the \fB\-set_serial\fR option, a large random number will be used for the serial number. @@ -388,25 +329,58 @@ a large random number will be used for the serial number. Unless the \fB\-copy_extensions\fR 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 \fB\-addext\fR option. +X.509 extensions to be added can be specified in the configuration file, +possibly using the \fB\-config\fR and \fB\-extensions\fR options, +and/or using the \fB\-addext\fR option. +.Sp +Unless \fB\-x509v1\fR is given, generated certificates bear X.509 version 3. +Unless specified otherwise, +key identifier extensions are included as described in \fBx509v3_config\fR\|(5). +.IP \fB\-x509v1\fR 4 +.IX Item "-x509v1" +Request generation of certificates with X.509 version 1. +This implies \fB\-x509\fR. +If X.509 extensions are given, anyway X.509 version 3 is set. .IP "\fB\-CA\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-CA filename|uri" -Specifies the \*(L"\s-1CA\*(R"\s0 certificate to be used for signing a new certificate +Specifies the "CA" certificate to be used for signing a new certificate and implies use of \fB\-x509\fR. -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. +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. .IP "\fB\-CAkey\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-CAkey filename|uri" -Sets the \*(L"\s-1CA\*(R"\s0 private key to sign a certificate with. +Sets the "CA" private key to sign a certificate with. The private key must match the public key of the certificate given with \fB\-CA\fR. If this option is not provided then the key must be present in the \fB\-CA\fR input. +.IP "\fB\-not_before\fR \fIdate\fR" 4 +.IX Item "-not_before date" +When \fB\-x509\fR is in use this allows the start date to be explicitly set, +otherwise it is ignored. The format of \fIdate\fR is YYMMDDHHMMSSZ (the +same as an ASN1 UTCTime structure), or YYYYMMDDHHMMSSZ (the same as an +ASN1 GeneralizedTime structure). In both formats, seconds SS and +timezone Z must be present. +Alternatively, you can also use "today". +.IP "\fB\-not_after\fR \fIdate\fR" 4 +.IX Item "-not_after date" +When \fB\-x509\fR is in use this allows the expiry date to be explicitly +set, otherwise it is ignored. The format of \fIdate\fR is YYMMDDHHMMSSZ +(the same as an ASN1 UTCTime structure), or YYYYMMDDHHMMSSZ (the same as +an ASN1 GeneralizedTime structure). In both formats, seconds SS and +timezone Z must be present. +Alternatively, you can also use "today". +.Sp +This overrides the \fB\-days\fR option. .IP "\fB\-days\fR \fIn\fR" 4 .IX Item "-days n" -When \fB\-x509\fR is in use this specifies the number of -days to certify the certificate for, otherwise it is ignored. \fIn\fR should +When \fB\-x509\fR is in use this specifies the number of days from today to +certify the certificate for, otherwise it is ignored. \fIn\fR should be a positive integer. The default is 30 days. +.Sp +Regardless of the option \fB\-not_before\fR, the days are always counted from +today. +When used together with the option \fB\-not_after\fR, the explicit expiry +date takes precedence. .IP "\fB\-set_serial\fR \fIn\fR" 4 .IX Item "-set_serial n" Serial number to use when outputting a self-signed certificate. @@ -422,39 +396,39 @@ 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. +.IP "\fB\-extensions\fR \fIsection\fR, \fB\-reqexts\fR \fIsection\fR" 4 +.IX Item "-extensions section, -reqexts section" +Can be used to override the name of the configuration file section +from which X.509 extensions are included +in the certificate (when \fB\-x509\fR is in use) or certificate request. +This allows several different sections to be used in the same configuration +file to specify requests for a variety of purposes. .IP "\fB\-addext\fR \fIext\fR" 4 .IX Item "-addext ext" Add a specific extension to the certificate (if \fB\-x509\fR 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. +a \f(CW\*(C`key=value\*(C'\fR pair as it would appear in a config file. +.Sp +If an extension is added using this option that has the same OID as one +defined in the extension section of the config file, it overrides that one. .Sp This option can be given multiple times. -.IP "\fB\-extensions\fR \fIsection\fR" 4 -.IX Item "-extensions section" -.PD 0 -.IP "\fB\-reqexts\fR \fIsection\fR" 4 -.IX Item "-reqexts section" -.PD -These options specify alternative sections to include certificate -extensions (if \fB\-x509\fR 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. -.IP "\fB\-precert\fR" 4 +Doing so, the same key most not be given more than once. +.IP \fB\-precert\fR 4 .IX 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 +"pre-certificate" (see RFC6962). 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 \fB\-new\fR flag. -.IP "\fB\-utf8\fR" 4 +.IP \fB\-utf8\fR 4 .IX 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 +This option causes field values to be interpreted as UTF8 strings, by +default they are interpreted as ASCII. This means that the field values, whether prompted from a terminal or obtained from a -configuration file, must be valid \s-1UTF8\s0 strings. +configuration file, must be valid UTF8 strings. .IP "\fB\-reqopt\fR \fIoption\fR" 4 .IX Item "-reqopt option" Customise the printing format used with \fB\-text\fR. The \fIoption\fR argument can be @@ -462,16 +436,21 @@ a single option or multiple options separated by commas. .Sp See discussion of the \fB\-certopt\fR parameter in the \fBopenssl\-x509\fR\|(1) command. -.IP "\fB\-newhdr\fR" 4 +.IP \fB\-newhdr\fR 4 .IX Item "-newhdr" -Adds the word \fB\s-1NEW\s0\fR to the \s-1PEM\s0 file header and footer lines on the outputted +Adds the word \fBNEW\fR to the PEM file header and footer lines on the outputted request. Some software (Netscape certificate server) and some CAs need this. -.IP "\fB\-batch\fR" 4 +.IP \fB\-batch\fR 4 .IX Item "-batch" Non-interactive mode. -.IP "\fB\-verbose\fR" 4 +.IP \fB\-verbose\fR 4 .IX Item "-verbose" Print extra details about the operations being performed. +.IP \fB\-quiet\fR 4 +.IX Item "-quiet" +Print fewer details about the operations being performed, which may be +handy during batch scripts or pipelines (specifically "progress dots" +during key generation are suppressed). .IP "\fB\-keygen_engine\fR \fIid\fR" 4 .IX Item "-keygen_engine id" Specifies an engine (by its unique \fIid\fR string) which would be used @@ -482,20 +461,22 @@ This specifies how the subject or issuer names are displayed. See \fBopenssl\-namedisplay\-options\fR\|(1) for details. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4 .IX Item "-rand files, -writerand file" -See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details. +See "Random State Options" in \fBopenssl\fR\|(1) for details. .IP "\fB\-engine\fR \fIid\fR" 4 .IX Item "-engine id" -See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1). +See "Engine Options" in \fBopenssl\fR\|(1). This option is deprecated. .IP "\fB\-provider\fR \fIname\fR" 4 .IX Item "-provider name" .PD 0 .IP "\fB\-provider\-path\fR \fIpath\fR" 4 .IX Item "-provider-path path" +.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 +.IX Item "-provparam [name:]key=value" .IP "\fB\-propquery\fR \fIpropq\fR" 4 .IX Item "-propquery propq" .PD -See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). .SH "CONFIGURATION FILE FORMAT" .IX Header "CONFIGURATION FILE FORMAT" The configuration options are specified in the \fBreq\fR section of @@ -512,7 +493,7 @@ 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 \fBpassin\fR and \fBpassout\fR override the configuration file values. -.IP "\fBdefault_bits\fR" 4 +.IP \fBdefault_bits\fR 4 .IX Item "default_bits" Specifies the default key size in bits. .Sp @@ -520,82 +501,93 @@ This option is used in conjunction with the \fB\-new\fR option to generate a new key. It can be overridden by specifying an explicit key size in the \fB\-newkey\fR option. The smallest accepted key size is 512 bits. If no key size is specified then 2048 bits is used. -.IP "\fBdefault_keyfile\fR" 4 +.IP \fBdefault_keyfile\fR 4 .IX 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 \fB\-keyout\fR option. -.IP "\fBoid_file\fR" 4 +.IP \fBoid_file\fR 4 .IX Item "oid_file" -This specifies a file containing additional \fB\s-1OBJECT IDENTIFIERS\s0\fR. +This specifies a file containing additional \fBOBJECT IDENTIFIERS\fR. 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. -.IP "\fBoid_section\fR" 4 +.IP \fBoid_section\fR 4 .IX 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 \fB=\fR and the numerical form. The short and long names are the same when this option is used. -.IP "\fB\s-1RANDFILE\s0\fR" 4 +.IP \fBRANDFILE\fR 4 .IX 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. -.IP "\fBencrypt_key\fR" 4 +.IP \fBencrypt_key\fR 4 .IX Item "encrypt_key" If this is set to \fBno\fR then if a private key is generated it is \&\fBnot\fR encrypted. This is equivalent to the \fB\-noenc\fR command line option. For compatibility \fBencrypt_rsa_key\fR is an equivalent option. -.IP "\fBdefault_md\fR" 4 +.IP \fBdefault_md\fR 4 .IX Item "default_md" This option specifies the digest algorithm to use. Any digest supported by the OpenSSL \fBdgst\fR 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. -.IP "\fBstring_mask\fR" 4 +.IP \fBstring_mask\fR 4 .IX 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. +fields. Most users will not need to change this option. It can be set to +several values: +.RS 4 +.IP "\fButf8only\fR \- only UTF8Strings are used (this is the default value)" 4 +.IX Item "utf8only - only UTF8Strings are used (this is the default value)" +.PD 0 +.IP "\fBpkix\fR \- any string type except T61Strings" 4 +.IX Item "pkix - any string type except T61Strings" +.IP "\fBnombstr\fR \- any string type except BMPStrings and UTF8Strings" 4 +.IX Item "nombstr - any string type except BMPStrings and UTF8Strings" +.IP "\fBdefault\fR \- any kind of string type" 4 +.IX Item "default - any kind of string type" +.RE +.RS 4 +.PD .Sp -It can be set to several values \fBdefault\fR which is also the default -option uses PrintableStrings, T61Strings and BMPStrings if the -\&\fBpkix\fR 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\fR option is used then only UTF8Strings will be used: this -is the \s-1PKIX\s0 recommendation in \s-1RFC2459\s0 after 2003. Finally the \fBnombstr\fR -option just uses PrintableStrings and T61Strings: certain software has -problems with BMPStrings and UTF8Strings: in particular Netscape. -.IP "\fBreq_extensions\fR" 4 +Note that \fButf8only\fR is the PKIX recommendation in RFC2459 after 2003, and the +default \fBstring_mask\fR; \fBdefault\fR is not the default option. The \fBnombstr\fR +value is a workaround for some software that has problems with variable-sized +BMPStrings and UTF8Strings. +.RE +.IP \fBreq_extensions\fR 4 .IX 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 \fB\-reqexts\fR command line switch. See the +by the \fB\-reqexts\fR (or \fB\-extensions\fR) command line switch. See the \&\fBx509v3_config\fR\|(5) manual page for details of the extension section format. -.IP "\fBx509_extensions\fR" 4 +.IP \fBx509_extensions\fR 4 .IX Item "x509_extensions" This specifies the configuration file section containing a list of extensions to add to certificate generated when \fB\-x509\fR is in use. It can be overridden by the \fB\-extensions\fR command line switch. -.IP "\fBprompt\fR" 4 +.IP \fBprompt\fR 4 .IX Item "prompt" If set to the value \fBno\fR this disables prompting of certificate fields and just takes values from the config file directly. It also changes the expected format of the \fBdistinguished_name\fR and \fBattributes\fR sections. -.IP "\fButf8\fR" 4 +.IP \fButf8\fR 4 .IX Item "utf8" -If set to the value \fByes\fR then field values to be interpreted as \s-1UTF8\s0 -strings, by default they are interpreted as \s-1ASCII.\s0 This means that +If set to the value \fByes\fR then field values to be interpreted as UTF8 +strings, by default they are interpreted as ASCII. This means that the field values, whether prompted from a terminal or obtained from a -configuration file, must be valid \s-1UTF8\s0 strings. -.IP "\fBattributes\fR" 4 +configuration file, must be valid UTF8 strings. +.IP \fBattributes\fR 4 .IX Item "attributes" This specifies the section containing any request attributes: its format is the same as \fBdistinguished_name\fR. 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. -.IP "\fBdistinguished_name\fR" 4 +.IP \fBdistinguished_name\fR 4 .IX Item "distinguished_name" This specifies the section containing the distinguished name fields to prompt for when generating a certificate or certificate request. The format @@ -612,9 +604,9 @@ just consist of field names and values: for example, \& emailAddress=someone@somewhere.org .Ve .PP -This allows external programs (e.g. \s-1GUI\s0 based) to generate a template file with +This allows external programs (e.g. GUI 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 \fB\s-1EXAMPLES\s0\fR section. +of this kind of configuration file is contained in the \fBEXAMPLES\fR section. .PP Alternatively if the \fBprompt\fR option is absent or not set to \fBno\fR then the file contains field prompting information. It consists of lines of the form: @@ -626,8 +618,8 @@ file contains field prompting information. It consists of lines of the form: \& fieldName_max= 4 .Ve .PP -\&\*(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 +"fieldName" is the field name being used, for example commonName (or CN). +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 @@ -639,11 +631,11 @@ on the field being used (for example countryName can only ever be two characters long and must fit in a PrintableString). .PP Some fields (such as organizationName) can be used more than once -in a \s-1DN.\s0 This presents a problem because configuration files will +in a DN. 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". +be input by calling it "1.organizationName". .PP The actual permitted field names are any object identifier short or long names. These are compiled into OpenSSL and include the usual @@ -654,7 +646,7 @@ is included as well as name, surname, givenName, initials, and dnQualifier. Additional object identifiers can be defined with the \fBoid_file\fR or \&\fBoid_section\fR options in the configuration file. Any additional fields will be treated as though they were a DirectoryString. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" Examine and verify certificate request: .PP @@ -662,6 +654,12 @@ Examine and verify certificate request: \& openssl req \-in req.pem \-text \-verify \-noout .Ve .PP +Specify the cipher to be used for encrypting the private key: +.PP +.Vb 1 +\& openssl req \-newkey rsa:2048 \-keyout privatekey.pem \-out request.csr \-cipher aes\-256\-cbc +.Ve +.PP Create a private key and then generate a certificate request from it: .PP .Vb 2 @@ -681,14 +679,14 @@ Generate a self-signed root certificate: \& openssl req \-x509 \-newkey rsa:2048 \-keyout key.pem \-out req.pem .Ve .PP -Create an \s-1SM2\s0 private key and then generate a certificate request from it: +Create an SM2 private key and then generate a certificate request from it: .PP .Vb 2 \& openssl ecparam \-genkey \-name SM2 \-out sm2.key \& openssl req \-new \-key sm2.key \-out sm2.csr \-sm3 \-sigopt "distid:1234567812345678" .Ve .PP -Examine and verify an \s-1SM2\s0 certificate request: +Examine and verify an SM2 certificate request: .PP .Vb 1 \& openssl req \-verify \-in sm2.csr \-sm3 \-vfyopt "distid:1234567812345678" @@ -719,7 +717,7 @@ Sample configuration file prompting for field values: \& attributes = req_attributes \& req_extensions = v3_ca \& -\& dirstring_type = nobmp +\& dirstring_type = nombstr \& \& [ req_distinguished_name ] \& countryName = Country Name (2 letter code) @@ -782,13 +780,13 @@ on the command line: \& \-addext "certificatePolicies = 1.2.3.4" \e \& \-newkey rsa:2048 \-keyout key.pem \-out req.pem .Ve -.SH "NOTES" +.SH NOTES .IX Header "NOTES" -The certificate requests generated by \fBXenroll\fR with \s-1MSIE\s0 have extensions +The certificate requests generated by \fBXenroll\fR with MSIE have extensions added. It includes the \fBkeyUsage\fR extension which determines the type of key (signature only or general purpose) and any additional OIDs entered by the script in an \fBextendedKeyUsage\fR extension. -.SH "DIAGNOSTICS" +.SH DIAGNOSTICS .IX Header "DIAGNOSTICS" The following messages are frequently asked about: .PP @@ -818,27 +816,27 @@ Another puzzling message is this: .Ve .PP this is displayed when no attributes are present and the request includes -the correct empty \fB\s-1SET OF\s0\fR structure (the \s-1DER\s0 encoding of which is 0xa0 +the correct empty \fBSET OF\fR structure (the DER encoding of which is 0xa0 0x00). If you just see: .PP .Vb 1 \& Attributes: .Ve .PP -then the \fB\s-1SET OF\s0\fR is missing and the encoding is technically invalid (but +then the \fBSET OF\fR is missing and the encoding is technically invalid (but it is tolerated). See the description of the command line option \fB\-asn1\-kludge\fR for more information. -.SH "BUGS" +.SH BUGS .IX 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. +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. .PP 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. +and MSIE then you currently need to use the invalid T61String form. .PP 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 @@ -853,8 +851,10 @@ address in subjectAltName should be input by the user. \&\fBopenssl\-gendsa\fR\|(1), \&\fBconfig\fR\|(5), \&\fBx509v3_config\fR\|(5) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" +The default encryption cipher was changed from 3DES to AES\-256 in OpenSSL 3.5. +.PP The \fB\-section\fR option was added in OpenSSL 3.0.0. .PP The \fB\-multivalue\-rdn\fR option has become obsolete in OpenSSL 3.0.0 and @@ -862,11 +862,19 @@ has no effect. .PP The \fB\-engine\fR option was deprecated in OpenSSL 3.0. The <\-nodes> option was deprecated in OpenSSL 3.0, too; use \fB\-noenc\fR instead. -.SH "COPYRIGHT" +.PP +The \fB\-reqexts\fR option has been made an alias of \fB\-extensions\fR in OpenSSL 3.2. +.PP +Since OpenSSL 3.2, +generated certificates bear X.509 version 3 unless \fB\-x509v1\fR is given, +and key identifier extensions are included by default. +.PP +Since OpenSSL 3.3, the \fB\-verify\fR option will exit with 1 on failure. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +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 \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |