diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-cmp.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-cmp.1 | 171 |
1 files changed, 91 insertions, 80 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-cmp.1 b/secure/usr.bin/openssl/man/openssl-cmp.1 index e28310ecd79e..948df496e68b 100644 --- a/secure/usr.bin/openssl/man/openssl-cmp.1 +++ b/secure/usr.bin/openssl/man/openssl-cmp.1 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,16 +52,19 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "OPENSSL-CMP 1ossl" -.TH OPENSSL-CMP 1ossl 2025-09-30 3.5.4 OpenSSL +.TH OPENSSL-CMP 1ossl 2026-04-07 3.5.6 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 -openssl\-cmp \- Certificate Management Protocol (CMP, RFC 4210) application +openssl\-cmp \- Certificate Management Protocol (CMP, RFCs 9810 and 9811) application .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBcmp\fR @@ -179,7 +182,7 @@ TLS connection options: [\fB\-tls_trusted\fR \fIfilenames\fR|\fIuris\fR] [\fB\-tls_host\fR \fIname\fR] .PP -Client-side debugging options: +Client\-side debugging options: .PP [\fB\-batch\fR] [\fB\-repeat\fR \fInumber\fR] @@ -261,7 +264,8 @@ Certificate verification options, for both CMP and TLS: .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBcmp\fR command is a client implementation for the Certificate -Management Protocol (CMP) as defined in RFC4210. +Management Protocol (CMP) as defined in RFCs 9810 and +its HTTP(S) transfer as defined in RFC 9811. It can be used to request certificates from a CA server, update their certificates, request certificates to be revoked, and perform other types of CMP requests. @@ -285,7 +289,7 @@ Multiple section names may be given, separated by commas and/or whitespace (where in the latter case the whole argument must be enclosed in "..."). Contents of sections named later may override contents of sections named before. In any case, as usual, the \f(CW\*(C`[default]\*(C'\fR section and finally the unnamed -section (as far as present) can provide per-option fallback values. +section (as far as present) can provide per\-option fallback values. .IP "\fB\-verbosity\fR \fIlevel\fR" 4 .IX Item "-verbosity level" Level of verbosity for logging, error output, etc. @@ -300,21 +304,21 @@ CMP command to execute. Currently implemented commands are: .RS 4 .IP "ir \ \- Initialization Request" 8 -.IX Item "ir \ - Initialization Request" +.IX Item "ir - Initialization Request" .PD 0 .IP "cr \ \- Certificate Request" 8 -.IX Item "cr \ - Certificate Request" +.IX Item "cr - Certificate Request" .IP "p10cr \- PKCS#10 Certification Request (for legacy support)" 8 .IX Item "p10cr - PKCS#10 Certification Request (for legacy support)" .IP "kur \ \ \- Key Update Request" 8 -.IX Item "kur \ \ - Key Update Request" +.IX Item "kur - Key Update Request" .IP "rr \ \- Revocation Request" 8 -.IX Item "rr \ - Revocation Request" +.IX Item "rr - Revocation Request" .IP "genm \- General Message" 8 .IX Item "genm - General Message" +.PD .RE .RS 4 -.PD .Sp \&\fBir\fR requests initialization of an end entity into a PKI hierarchy by issuing a first certificate. @@ -346,7 +350,7 @@ Name of a certificate profile to place in the PKIHeader generalInfo field of request messages. .IP "\fB\-geninfo\fR \fIvalues\fR" 4 .IX Item "-geninfo values" -A comma-separated list of InfoTypeAndValue to place in +A comma\-separated list of InfoTypeAndValue to place in the generalInfo field of the PKIHeader of requests messages. Each InfoTypeAndValue gives an OID and an integer or string value of the form \fIOID\fR:int:\fInumber\fR or \fIOID\fR:str:\fItext\fR, @@ -354,11 +358,11 @@ e.g., \f(CW\*(Aq1.2.3.4:int:56789, id\-kp:str:name\*(Aq\fR. .IP "\fB\-template\fR \fIfilename\fR" 4 .IX Item "-template filename" The file to save any CRMF certTemplate in DER format -received in a genp message with id-it-certReqTemplate. +received in a genp message with id\-it\-certReqTemplate. .IP "\fB\-keyspec\fR \fIfilename\fR" 4 .IX Item "-keyspec filename" It is optional and used to specify the file to save any keySpec if -present in a genp message with id-it-keyGenParameters. +present in a genp message with id\-it\-keyGenParameters. .Sp Note: any keySpec field contents received are logged as INFO. .SS "Certificate enrollment options" @@ -392,7 +396,7 @@ File to save centrally generated private key, in PEM format. .IX Item "-subject name" X.509 Distinguished Name (DN) to use as subject field in the requested certificate template in IR/CR/KUR messages. -If the NULL-DN (\f(CW\*(C`/\*(C'\fR) is given then no subject is placed in the template. +If the NULL\-DN (\f(CW\*(C`/\*(C'\fR) is given then no subject is placed in the template. Default is the subject DN of any PKCS#10 CSR given with the \fB\-csr\fR option. For KUR, a further fallback is the subject DN of the reference certificate (see \fB\-oldcert\fR) if provided. @@ -404,8 +408,8 @@ the subject DN is used as fallback sender of outgoing CMP messages. The argument must be formatted as \fI/type0=value0/type1=value1/type2=...\fR. Special characters may be escaped by \f(CW\*(C`\e\*(C'\fR (backslash); whitespace is retained. Empty values are permitted, but the corresponding type will not be included. -Giving a single \f(CW\*(C`/\*(C'\fR will lead to an empty sequence of RDNs (a NULL-DN). -Multi-valued RDNs can be formed by placing a \f(CW\*(C`+\*(C'\fR character instead of a \f(CW\*(C`/\*(C'\fR +Giving a single \f(CW\*(C`/\*(C'\fR will lead to an empty sequence of RDNs (a NULL\-DN). +Multi\-valued RDNs can be formed by placing a \f(CW\*(C`+\*(C'\fR character instead of a \f(CW\*(C`/\*(C'\fR between the AttributeValueAssertions (AVAs) that specify the members of the set. Example: .Sp @@ -451,11 +455,11 @@ This option cannot be used together with \fB\-policies\fR. Flag the policies given with \fB\-policy_oids\fR as critical. .IP "\fB\-popo\fR \fInumber\fR" 4 .IX Item "-popo number" -Proof-of-possession (POPO) method to use for IR/CR/KUR; values: \f(CW\-1\fR..<2> where +Proof\-of\-possession (POPO) method to use for IR/CR/KUR; values: \f(CW\-1\fR..<2> where \&\f(CW\-1\fR = NONE, which implies central key generation, \&\f(CW0\fR = RAVERIFIED, \f(CW1\fR = SIGNATURE (default), \f(CW2\fR = KEYENC. .Sp -Note that a signature-based POPO can only be produced if a private key +Note that a signature\-based POPO can only be produced if a private key is provided via the \fB\-newkey\fR or \fB\-key\fR options. .IP "\fB\-csr\fR \fIfilename\fR" 4 .IX Item "-csr filename" @@ -494,7 +498,7 @@ Request implicit confirmation of newly enrolled certificates. Do not send certificate confirmation message for newly enrolled certificate without requesting implicit confirmation to cope with broken servers not supporting implicit confirmation correctly. -\&\fBWARNING:\fR This leads to behavior violating RFC 4210. +\&\fBWARNING:\fR This leads to behavior violating RFC 9810. .IP "\fB\-certout\fR \fIfilename\fR" 4 .IX Item "-certout filename" The file where any newly enrolled certificate should be saved. @@ -511,7 +515,7 @@ the newly enrolled certificate followed by its chain. .IX Subsection "Certificate enrollment and revocation options" .IP "\fB\-oldcert\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-oldcert filename|uri" -The certificate to be updated (i.e., renewed or re-keyed) in Key Update Request +The certificate to be updated (i.e., renewed or re\-keyed) in Key Update Request (KUR) messages or to be revoked in Revocation Request (RR) messages. For KUR the certificate to be updated defaults to \fB\-cert\fR, and the resulting certificate is called \fIreference certificate\fR. @@ -529,7 +533,7 @@ if neither \fB\-recipient\fR, \fB\-srvcert\fR, nor \fB\-issuer\fR is given. .IX Item "-issuer name" X.509 Distinguished Name (DN) to place as the issuer field in the requested certificate template in IR/CR/KUR/RR messages. -If the NULL-DN (\f(CW\*(C`/\*(C'\fR) is given then no issuer is placed in the template. +If the NULL\-DN (\f(CW\*(C`/\*(C'\fR) is given then no issuer is placed in the template. .Sp If provided and neither \fB\-recipient\fR nor \fB\-srvcert\fR is given, the issuer DN is used as fallback recipient of outgoing CMP messages. @@ -609,7 +613,7 @@ the subject of the CMP server certificate given with the \fB\-srvcert\fR option, the \fB\-issuer\fR option, the issuer of the certificate given with the \fB\-oldcert\fR option, the issuer of the CMP client certificate (\fB\-cert\fR option), -as far as any of those is present, else the NULL-DN as last resort. +as far as any of those is present, else the NULL\-DN as last resort. .Sp The argument must be formatted as \fI/type0=value0/type1=value1/type2=...\fR. For details see the description of the \fB\-subject\fR option. @@ -629,7 +633,7 @@ i.e., an error occurs if the server does not grant it. The default value is 1, which means preferring to keep the connection open. .IP "\fB\-msg_timeout\fR \fIseconds\fR" 4 .IX Item "-msg_timeout seconds" -Number of seconds a CMP request-response message round trip +Number of seconds a CMP request\-response message round trip is allowed to take before a timeout error is returned. A value <= 0 means no limitation (waiting indefinitely). Default is to use the \fB\-total_timeout\fR setting. @@ -644,7 +648,7 @@ Default is 0. .IP "\fB\-trusted\fR \fIfilenames\fR|\fIuris\fR" 4 .IX Item "-trusted filenames|uris" The certificate(s), typically of root CAs, the client shall use as trust anchors -when validating signature-based protection of CMP response messages. +when validating signature\-based protection of CMP response messages. This option is ignored if the \fB\-srvcert\fR option is given as well. It provides more flexibility than \fB\-srvcert\fR because the CMP protection certificate of the server is not pinned but may be any certificate @@ -662,13 +666,13 @@ The certificate verification options have no effect on the certificate verification enabled via this option. .IP "\fB\-untrusted\fR \fIfilenames\fR|\fIuris\fR" 4 .IX Item "-untrusted filenames|uris" -Non-trusted intermediate CA certificate(s). +Non\-trusted intermediate CA certificate(s). Any extra certificates given with the \fB\-cert\fR option are appended to it. All these certificates may be useful for cert path construction for the own CMP signer certificate (to include in the extraCerts field of request messages) and for the TLS client certificate (if TLS is used) as well as for chain building -when validating server certificates (checking signature-based +when validating server certificates (checking signature\-based CMP message protection) and when validating newly enrolled certificates. .Sp Multiple sources may be given, separated by commas and/or whitespace @@ -677,7 +681,7 @@ Each source may contain multiple certificates. .IP "\fB\-srvcert\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-srvcert filename|uri" The specific CMP server certificate to expect and directly trust (even if it is -expired) when verifying signature-based protection of CMP response messages. +expired) when verifying signature\-based protection of CMP response messages. This pins the accepted server and results in ignoring the \fB\-trusted\fR option. .Sp If set, the subject of the certificate is also used @@ -700,7 +704,7 @@ For details see the description of the \fB\-subject\fR option. .IP \fB\-ignore_keyusage\fR 4 .IX Item "-ignore_keyusage" Ignore key usage restrictions in CMP signer certificates when validating -signature-based protection of incoming CMP messages. +signature\-based protection of incoming CMP messages. By default, \f(CW\*(C`digitalSignature\*(C'\fR must be allowed by CMP signer certificates. This option applies to both CMP clients and the mock server. .IP \fB\-unprotected_errors\fR 4 @@ -721,7 +725,7 @@ negative PKIConf messages .Sp \&\fBWARNING:\fR This setting leads to unspecified behavior and it is meant exclusively to allow interoperability with server implementations violating -RFC 4210, e.g.: +RFC 9810, e.g.: .IP \(bu 4 section 5.1.3.1 allows exceptions from protecting only for special cases: @@ -739,13 +743,19 @@ appendix D.4 shows PKIConf message having protection .IP \fB\-no_cache_extracerts\fR 4 .IX Item "-no_cache_extracerts" Do not cache certificates in the extraCerts field of CMP messages received. -By default, they are kept as they may be helful for validating further messages. +By default, they are kept as they may be helpful for validating further messages. This option applies to both CMP clients and the mock server. +.Sp +In any case, after successfully validating an incoming message, its protection +certificate (if any) is cached for reuse with validation of subsequent messages. +This is done not only for efficiency but also +to eliminate the need for the sender to include its certificate and related chain +in the extraCerts field of subsequent messages of the same transaction. .IP "\fB\-srvcertout\fR \fIfilename\fR" 4 .IX Item "-srvcertout filename" The file where to save the successfully validated certificate, if any, -that the CMP server used for signature-based response message protection. -If there is no such certificate, typically because the protection was MAC-based, +that the CMP server used for signature\-based response message protection. +If there is no such certificate, typically because the protection was MAC\-based, this is indicated by deleting the file (if it existed). .IP "\fB\-extracertsout\fR \fIfilename\fR" 4 .IX Item "-extracertsout filename" @@ -811,21 +821,21 @@ If on success no such CRL was received, this is indicated by deleting the file. .IX Item "-ref value" Reference number/string/value to use as fallback senderKID; this is required if no sender name can be determined from the \fB\-cert\fR or <\-subject> options and -is typically used when authenticating with pre-shared key (password-based MAC). +is typically used when authenticating with pre\-shared key (password\-based MAC). .IP "\fB\-secret\fR \fIarg\fR" 4 .IX Item "-secret arg" -Provides the source of a secret value to use with MAC-based message protection. +Provides the source of a secret value to use with MAC\-based message protection. This takes precedence over the \fB\-cert\fR and \fB\-key\fR options. -The secret is used for creating MAC-based protection of outgoing messages -and for validating incoming messages that have MAC-based protection. -The algorithm used by default is Password-Based Message Authentication Code (PBM) -as defined in RFC 4210 section 5.1.3.1. +The secret is used for creating MAC\-based protection of outgoing messages +and for validating incoming messages that have MAC\-based protection. +The algorithm used by default is Password\-Based Message Authentication Code (PBM) +as defined in RFC 9810 section 5.1.3.1. .Sp For more information about the format of \fIarg\fR see \&\fBopenssl\-passphrase\-options\fR\|(1). .IP "\fB\-cert\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-cert filename|uri" -The client's current CMP signer certificate. +The client\*(Aqs current CMP signer certificate. Requires the corresponding key to be given with \fB\-key\fR. .Sp The subject and the public key contained in this certificate @@ -837,23 +847,23 @@ while the subject of \fB\-oldcert\fR or \fB\-subjectName\fR may provide fallback The issuer of this certificate is used as one of the recipient fallback values and as fallback issuer entry in the certificate template of IR/CR/KUR messages. .Sp -When performing signature-based message protection, +When performing signature\-based message protection, this "protection certificate", also called "signer certificate", will be included first in the extraCerts field of outgoing messages and the signature is done with the corresponding key. In Initialization Request (IR) messages this can be used for authenticating -using an external entity certificate as defined in appendix E.7 of RFC 4210. +using an external entity certificate as defined in appendix D.7 of RFC 9810. .Sp For Key Update Request (KUR) messages this is also used as the certificate to be updated if the \fB\-oldcert\fR option is not given. .Sp If the file includes further certs, they are appended to the untrusted certs because they typically constitute the chain of the client certificate, which -is included in the extraCerts field in signature-protected request messages. +is included in the extraCerts field in signature\-protected request messages. .IP "\fB\-own_trusted\fR \fIfilenames\fR|\fIuris\fR" 4 .IX Item "-own_trusted filenames|uris" If this list of certificates is provided then the chain built for -the client-side CMP signer certificate given with the \fB\-cert\fR option +the client\-side CMP signer certificate given with the \fB\-cert\fR option is verified using the given certificates as trust anchors. .Sp Multiple sources may be given, separated by commas and/or whitespace @@ -865,10 +875,10 @@ The certificate verification options have no effect on the certificate verification enabled via this option. .IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-key filename|uri" -The corresponding private key file for the client's current certificate given in +The corresponding private key file for the client\*(Aqs current certificate given in the \fB\-cert\fR option. -This will be used for signature-based message protection unless the \fB\-secret\fR -option indicating MAC-based protection or \fB\-unprotected_requests\fR is given. +This will be used for signature\-based message protection unless the \fB\-secret\fR +option indicating MAC\-based protection or \fB\-unprotected_requests\fR is given. .Sp It is also used as a fallback for the \fB\-newkey\fR option with IR/CR/KUR messages. .IP "\fB\-keypass\fR \fIarg\fR" 4 @@ -881,10 +891,10 @@ For more information about the format of \fIarg\fR see \&\fBopenssl\-passphrase\-options\fR\|(1). .IP "\fB\-digest\fR \fIname\fR" 4 .IX Item "-digest name" -Specifies name of supported digest to use in RFC 4210's MSG_SIG_ALG -and as the one-way function (OWF) in \f(CW\*(C`MSG_MAC_ALG\*(C'\fR. +Specifies name of supported digest to use in RFC 9810\*(Aqs MSG_SIG_ALG +and as the one\-way function (OWF) in \f(CW\*(C`MSG_MAC_ALG\*(C'\fR. If applicable, this is used for message protection and -proof-of-possession (POPO) signatures. +proof\-of\-possession (POPO) signatures. To see the list of supported digests, use \f(CW\*(C`openssl list \-digest\-commands\*(C'\fR. Defaults to \f(CW\*(C`sha256\*(C'\fR. .IP "\fB\-mac\fR \fIname\fR" 4 @@ -893,7 +903,7 @@ Specifies the name of the MAC algorithm in \f(CW\*(C`MSG_MAC_ALG\*(C'\fR. To get the names of supported MAC algorithms use \f(CW\*(C`openssl list \-mac\-algorithms\*(C'\fR and possibly combine such a name with the name of a supported digest algorithm, e.g., hmacWithSHA256. -Defaults to \f(CW\*(C`hmac\-sha1\*(C'\fR as per RFC 4210. +Defaults to \f(CW\*(C`hmac\-sha1\*(C'\fR, for backward compatibility with RFC 4210. .IP "\fB\-extracerts\fR \fIfilenames\fR|\fIuris\fR" 4 .IX Item "-extracerts filenames|uris" Certificates to append in the extraCerts field when sending messages. @@ -904,7 +914,7 @@ Multiple sources may be given, separated by commas and/or whitespace Each source may contain multiple certificates. .IP \fB\-unprotected_requests\fR 4 .IX Item "-unprotected_requests" -Send request messages without CMP-level protection. +Send request messages without CMP\-level protection. .SS "Credentials format options" .IX Subsection "Credentials format options" .IP "\fB\-certform\fR \fIPEM|DER\fR" 4 @@ -944,7 +954,7 @@ As an alternative to using this combination: \& \-engine {engineid} \-key {keyid} \-keyform ENGINE .Ve .Sp -\&... it's also possible to just give the key ID in URI form to \fB\-key\fR, +\&... it\*(Aqs also possible to just give the key ID in URI form to \fB\-key\fR, like this: .Sp .Vb 1 @@ -975,25 +985,25 @@ See "Random State Options" in \fBopenssl\fR\|(1) for details. .IX Subsection "TLS connection options" .IP \fB\-tls_used\fR 4 .IX Item "-tls_used" -Make the CMP client use TLS (regardless if other TLS-related options are set) +Make the CMP client use TLS (regardless if other TLS\-related options are set) for message exchange with the server via HTTP. This option is not supported with the \fI\-port\fR option. It is implied if the \fB\-server\fR option is given with the scheme \f(CW\*(C`https\*(C'\fR. It is ignored if the \fB\-server\fR option is not given or \fB\-use_mock_srv\fR is given or \fB\-rspin\fR is given with enough filename arguments. .Sp -The following TLS-related options are ignored if TLS is not used. +The following TLS\-related options are ignored if TLS is not used. .IP "\fB\-tls_cert\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-tls_cert filename|uri" -Client's TLS certificate to use for authenticating to the TLS server. +Client\*(Aqs TLS certificate to use for authenticating to the TLS server. If the source includes further certs they are used (along with \fB\-untrusted\fR certs) for constructing the client cert chain provided to the TLS server. .IP "\fB\-tls_key\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-tls_key filename|uri" -Private key for the client's TLS certificate. +Private key for the client\*(Aqs TLS certificate. .IP "\fB\-tls_keypass\fR \fIarg\fR" 4 .IX Item "-tls_keypass arg" -Pass phrase source for client's private TLS key \fB\-tls_key\fR. +Pass phrase source for client\*(Aqs private TLS key \fB\-tls_key\fR. Also used for \fB\-tls_cert\fR in case it is an encrypted PKCS#12 file. If not given here, the password will be prompted for if needed. .Sp @@ -1019,7 +1029,7 @@ have no effect on the certificate verification enabled via this option. Address to be checked during hostname validation. This may be a DNS name or an IP address. If not given it defaults to the \fB\-server\fR address. -.SS "Client-side options for debugging and offline scenarios" +.SS "Client\-side options for debugging and offline scenarios" .IX Subsection "Client-side options for debugging and offline scenarios" .IP \fB\-batch\fR 4 .IX Item "-batch" @@ -1067,7 +1077,7 @@ in the sequence of requests produced internally. .Sp The client needs to update the recipNonce field in the given requests (except for the first one) in order to satisfy the checks to be performed by the server. -This causes re-protection (if protecting requests is required). +This causes re\-protection (if protecting requests is required). .IP \fB\-reqin_new_tid\fR 4 .IX Item "-reqin_new_tid" Use a fresh transactionID for CMP request messages read using \fB\-reqin\fR, @@ -1088,6 +1098,7 @@ If the transaction contains more requests, the remaining ones are not saved. .IX Item "-reqout_only filename" Save the first CMP requests created by the client to the given file and exit. Any options related to CMP servers and their responses are ignored. +This option does not combine with the \fB\-port\fR option. .Sp This option is useful for supporting offline scenarios where the certificate request (or any other CMP request) is produced beforehand and sent out later. @@ -1115,31 +1126,31 @@ contained in the transaction and filenames have been provided. If the transaction contains more responses, the remaining ones are not saved. .IP \fB\-use_mock_srv\fR 4 .IX Item "-use_mock_srv" -Test the client using the internal CMP server mock-up at API level, -bypassing socket-based transfer via HTTP. +Test the client using the internal CMP server mock\-up at API level, +bypassing socket\-based transfer via HTTP. This excludes the \fB\-server\fR and \fB\-port\fR options. .SS "Mock server options" .IX Subsection "Mock server options" .IP "\fB\-port\fR \fInumber\fR" 4 .IX Item "-port number" -Act as HTTP-based CMP server mock-up listening on the given local port. +Act as HTTP\-based CMP server mock\-up listening on the given local port. The client may address the server via, e.g., \f(CW127.0.0.1\fR or \f(CW\*(C`[::1]\*(C'\fR. This option excludes the \fB\-server\fR and \fB\-use_mock_srv\fR options. The \fB\-rspin\fR, \fB\-rspout\fR, \fB\-reqin\fR, and \fB\-reqout\fR options so far are not supported in this mode. .IP "\fB\-max_msgs\fR \fInumber\fR" 4 .IX Item "-max_msgs number" -Maximum number of CMP (request) messages the CMP HTTP server mock-up +Maximum number of CMP (request) messages the CMP HTTP server mock\-up should handle, which must be nonnegative. The default value is 0, which means that no limit is imposed. In any case the server terminates on internal errors, but not when it -detects a CMP-level error that it can successfully answer with an error message. +detects a CMP\-level error that it can successfully answer with an error message. .IP "\fB\-srv_ref\fR \fIvalue\fR" 4 .IX Item "-srv_ref value" Reference value to use as senderKID of server in case no \fB\-srv_cert\fR is given. .IP "\fB\-srv_secret\fR \fIarg\fR" 4 .IX Item "-srv_secret arg" -Password source for server authentication with a pre-shared key (secret). +Password source for server authentication with a pre\-shared key (secret). .IP "\fB\-srv_cert\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-srv_cert filename|uri" Certificate of the server. @@ -1218,12 +1229,12 @@ Text to be included as status string in server response. Force server to reply with error message. .IP \fB\-send_unprotected\fR 4 .IX Item "-send_unprotected" -Send response messages without CMP-level protection. +Send response messages without CMP\-level protection. .IP \fB\-send_unprot_err\fR 4 .IX Item "-send_unprot_err" In case of negative responses, server shall send unprotected error messages, certificate responses (IP/CP/KUP), and revocation responses (RP). -WARNING: This setting leads to behavior violating RFC 4210. +WARNING: This setting leads to behavior violating RFC 9810. .IP \fB\-accept_unprotected\fR 4 .IX Item "-accept_unprotected" Accept missing or invalid protection of requests. @@ -1233,7 +1244,7 @@ Accept unprotected error messages from client. So far this has no effect because the server does not accept any error messages. .IP \fB\-accept_raverified\fR 4 .IX Item "-accept_raverified" -Accept RAVERIFED as proof of possession (POPO). +Accept RAVERIFIED as proof of possession (POPO). .SS "Certificate verification options, for both CMP and TLS" .IX Subsection "Certificate verification options, for both CMP and TLS" .IP "\fB\-allow_proxy_certs\fR, \fB\-attime\fR, \fB\-no_check_time\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR \fB\-issuer_checks\fR" 4 @@ -1251,9 +1262,9 @@ trust, for instance via the \f(CW\*(C`caPubs\*(C'\fR field of a certificate resp or using general messages with infoType \f(CW\*(C`caCerts\*(C'\fR or \f(CW\*(C`rootCaCert\*(C'\fR, authentication of the CMP server is particularly critical. So special care must be taken setting up server authentication -using \fB\-trusted\fR and related options for certificate-based authentication -or \fB\-secret\fR for MAC-based protection. -If authentication is certificate-based, the \fB\-srvcertout\fR option +using \fB\-trusted\fR and related options for certificate\-based authentication +or \fB\-secret\fR for MAC\-based protection. +If authentication is certificate\-based, the \fB\-srvcertout\fR option should be used to obtain the validated server certificate and perform an authorization check based on it. .PP @@ -1300,16 +1311,16 @@ It can be viewed using, e.g., .PP In case the network setup requires using an HTTP proxy it may be given as usual via the environment variable \fBhttp_proxy\fR or via the \fB\-proxy\fR option in the -configuration file or the CMP command-line argument \fB\-proxy\fR, for example +configuration file or the CMP command\-line argument \fB\-proxy\fR, for example .PP .Vb 1 \& \-proxy http://192.168.1.1:8080 .Ve .PP -In the Insta Demo CA scenario both clients and the server may use the pre-shared +In the Insta Demo CA scenario both clients and the server may use the pre\-shared secret \fIinsta\fR and the reference value \fI3078\fR to authenticate to each other. .PP -Alternatively, CMP messages may be protected in signature-based manner, +Alternatively, CMP messages may be protected in signature\-based manner, where the trust anchor in this case is \fIinsta.ca.crt\fR and the client may use any certificate already obtained from that CA, as specified in the \fB[signature]\fR section of the example configuration. @@ -1338,8 +1349,8 @@ In order to update the enrolled certificate one may call \& openssl cmp \-section insta,kur,signature .Ve .PP -using signature-based protection with the certificate that is to be updated. -For certificate updates, MAC-based protection should generally not be used. +using signature\-based protection with the certificate that is to be updated. +For certificate updates, MAC\-based protection should generally not be used. .PP In a similar way any previously enrolled certificate may be revoked by .PP @@ -1370,7 +1381,7 @@ and accepts requests under the alias \fI/pkix/\fR. .PP For enrolling its very first certificate the client generates a client key and sends an initial request message to the local CMP server -using a pre-shared secret key for mutual authentication. +using a pre\-shared secret key for mutual authentication. In this example the client does not have the CA certificate yet, so we specify the name of the CA with the \fB\-recipient\fR option and save any CA certificates that we may receive in the \f(CW\*(C`capubs.pem\*(C'\fR file. @@ -1415,7 +1426,7 @@ This prints information about all received ITAV \fBinfoType\fRs to stdout. .SS "Using a custom configuration file" .IX Subsection "Using a custom configuration file" For CMP client invocations, in particular for certificate enrollment, -usually many parameters need to be set, which is tedious and error-prone to do +usually many parameters need to be set, which is tedious and error\-prone to do on the command line. Therefore, the client offers the possibility to read options from sections of the OpenSSL config file, usually called \fIopenssl.cnf\fR. @@ -1482,7 +1493,7 @@ and \fB\-rsp_crl\fR options were added in OpenSSL 3.4. \&\fB\-rsp_keypass\fR were added in OpenSSL 3.5. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2007\-2025 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2007\-2026 The OpenSSL Project Authors. All Rights Reserved. .PP 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 |