openssl-cmp - Certificate Management Protocol (CMP, RFC 4210) application
| Use Case | Command | Description |
|---|---|---|
| Initial enrollment | openssl cmp -cmd ir -server 127.0.0.1:80/pkix/ -recipient "/CN=CMPserver" -ref 1234 -secret pass:1234-5678 -newkey cl_key.pem -subject "/CN=MyName" -certout cl_cert.pem | Request first certificate from a CMP server using PBM-based authentication |
| Certificate update (KUR) | openssl cmp -cmd kur -server 127.0.0.1:80/pkix/ -trusted capubs.pem -cert cl_cert.pem -key cl_key.pem -newkey cl_key_new.pem -certout cl_cert.pem | Update (renew/re-key) an existing certificate with signature-based protection |
| Revocation | openssl cmp -cmd rr -server 127.0.0.1:80/pkix/ -trusted capubs.pem -cert cl_cert.pem -key cl_key.pem -oldcert cl_cert.pem -revreason 1 | Revoke a certificate (e.g., keyCompromise reason 1) |
| General Message | openssl cmp -cmd genm -server 127.0.0.1:80/pkix/ -recipient "/CN=CMPserver" -ref 1234 -secret pass:1234-5678 | Request information from CMP server (e.g., supported key types) |
| Using config file sections | openssl cmp -section cmp,init | Load options from config file sections (e.g., [cmp] and [init]) |
| Enroll with PKCS#10 CSR | openssl cmp -cmd p10cr -server ... -csr request.csr | Legacy PKCS#10 Certification Request |
openssl cmp [-help] [-config filename] [-section names] [-verbosity level]
Generic message options:
[-cmd ir|cr|kur|p10cr|rr|genm] [-infotype name] [-geninfo OID:int:N]
Certificate enrollment options:
[-newkey filename|uri] [-newkeypass arg] [-subject name] [-issuer name] [-days number] [-reqexts name] [-sans spec] [-san_nodefault] [-policies name] [-policy_oids names] [-policy_oids_critical] [-popo number] [-csr filename] [-out_trusted filenames|uris] [-implicit_confirm] [-disable_confirm] [-certout filename] [-chainout filename]
Certificate enrollment and revocation options:
[-oldcert filename|uri] [-revreason number]
Message transfer options:
[-server [http[s]://][userinfo@]host[:port][/path][?query][#fragment]] [-proxy [http[s]://][userinfo@]host[:port][/path][?query][#fragment]] [-no_proxy addresses] [-recipient name] [-path remote_path] [-keep_alive value] [-msg_timeout seconds] [-total_timeout seconds]
Server authentication options:
[-trusted filenames|uris] [-untrusted filenames|uris] [-srvcert filename|uri] [-expect_sender name] [-ignore_keyusage] [-unprotected_errors] [-extracertsout filename] [-cacertsout filename]
Client authentication and protection options:
[-ref value] [-secret arg] [-cert filename|uri] [-own_trusted filenames|uris] [-key filename|uri] [-keypass arg] [-digest name] [-mac name] [-extracerts filenames|uris] [-unprotected_requests]
Credentials format options:
[-certform PEM|DER] [-keyform PEM|DER|P12|ENGINE] [-otherpass arg] [-engine id] [-provider name] [-provider-path path] [-propquery propq]
Random state options:
[-rand files] [-writerand file]
TLS connection options:
[-tls_used] [-tls_cert filename|uri] [-tls_key filename|uri] [-tls_keypass arg] [-tls_extra filenames|uris] [-tls_trusted filenames|uris] [-tls_host name]
Client-side debugging options:
[-batch] [-repeat number] [-reqin filenames] [-reqin_new_tid] [-reqout filenames] [-rspin filenames] [-rspout filenames] [-use_mock_srv]
Mock server options:
[-port number] [-max_msgs number] [-srv_ref value] [-srv_secret arg] [-srv_cert filename|uri] [-srv_key filename|uri] [-srv_keypass arg] [-srv_trusted filenames|uris] [-srv_untrusted filenames|uris] [-rsp_cert filename|uri] [-rsp_extracerts filenames|uris] [-rsp_capubs filenames|uris] [-poll_count number] [-check_after number] [-grant_implicitconf] [-pkistatus number] [-failure number] [-failurebits number] [-statusstring arg] [-send_error] [-send_unprotected] [-send_unprot_err] [-accept_unprotected] [-accept_unprot_err] [-accept_raverified]
Certificate verification options, for both CMP and TLS:
[-allow_proxy_certs] [-attime timestamp] [-no_check_time] [-check_ss_sig] [-crl_check] [-crl_check_all] [-explicit_policy] [-extended_crl] [-ignore_critical] [-inhibit_any] [-inhibit_map] [-partial_chain] [-policy arg] [-policy_check] [-policy_print] [-purpose purpose] [-suiteB_128] [-suiteB_128_only] [-suiteB_192] [-trusted_first] [-no_alt_chains] [-use_deltas] [-auth_level num] [-verify_depth num] [-verify_email email] [-verify_hostname hostname] [-verify_ip ip] [-verify_name name] [-x509_strict] [-issuer_checks]
The cmp command is a client implementation for the Certificate Management Protocol (CMP) as defined in RFC4210. 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.
-help — Display a summary of all options-config filename — Configuration file to use. An empty string "" means none. Default filename is from the environment variable "OPENSSL_CONF".-section names — Section(s) to use within config file defining CMP options. An empty string "" means no specific section. Default is "cmp". Multiple section names may be given, separated by commas and/or whitespace. Contents of sections named later may override contents of sections named before.-verbosity level — Level of verbosity for logging, error output, etc. 0 = EMERG, 1 = ALERT, 2 = CRIT, 3 = ERR, 4 = WARN, 5 = NOTE, 6 = INFO, 7 = DEBUG, 8 = TRACE. Defaults to 6 = INFO.-cmd ir|cr|kur|p10cr|rr|genm — CMP command to execute. Currently implemented commands: ir (Initialization Request), cr (Certificate Request), p10cr (PKCS#10 Certification Request for legacy support), kur (Key Update Request), rr (Revocation Request), genm (General Message).-infotype name — Set InfoType name to use for requesting specific info in genm, e.g., "signKeyPairTypes".-geninfo OID:int:N — generalInfo integer values to place in request PKIHeader with given OID, e.g., "1.2.3.4:int:56789".-newkey filename|uri — Source of the private or public key for the certificate requested in IR, CR, or KUR. Defaults to the public key in the PKCS#10 CSR given with -csr, the public key of the reference certificate, or the current client key.-newkeypass arg — Pass phrase source for the key given with -newkey. If not given here, the password will be prompted for if needed. See openssl-passphrase-options(1).-subject name — X509 Distinguished Name of subject to use in the requested certificate template. For KUR, it defaults to the public key in the PKCS#10 CSR or of the reference certificate. For IR and CR only if no SANs are set. If the NULL-DN ("/") is given then no subject is placed. If provided and neither -cert nor -oldcert is given, the subject DN is used as fallback sender.-issuer name — X509 issuer Distinguished Name of the CA server to place in the requested certificate template. If the NULL-DN ("/") is given then no issuer is placed. If provided and neither -recipient nor -srvcert is given, the issuer DN is used as fallback recipient.-days number — Number of days the new certificate is requested to be valid for, counting from the current time of the host. Also triggers explicit request that the validity period starts from the current time.-reqexts name — Name of section in OpenSSL config file defining certificate request extensions. If -csr is present, these extensions augment the extensions contained in the PKCS#10 CSR, overriding any extensions with same OIDs.-sans spec — One or more IP addresses, DNS names, or URIs separated by commas or whitespace to add as Subject Alternative Name(s) (SAN) certificate request extension. If the special element "critical" is given the SANs are flagged as critical.-san_nodefault — When Subject Alternative Names are not given via -sans nor defined via -reqexts, they are copied by default from the reference certificate. This can be disabled by giving this option.-policies name — Name of section in OpenSSL config file defining policies to be set as certificate request extension. Cannot be used together with -policy_oids.-policy_oids names — One or more OID(s) separated by commas and/or whitespace to add as certificate policies request extension. Cannot be used together with -policies.-policy_oids_critical — Flag the policies given with -policy_oids as critical.-popo number — Proof-of-Possession method to use for IR/CR/KUR; values: "-1"..<2> where "-1" = NONE, 0 = RAVERIFIED, 1 = SIGNATURE (default), 2 = KEYENC. Note that a signature-based POPO can only be produced if a private key is provided via -newkey or -key.-csr filename — PKCS#10 CSR in PEM or DER format containing a certificate request. With -cmd p10cr it is used directly. When used with -cmd ir, cr, or kur, it is transformed into the respective regular CMP request. It may also be used with -cmd rr to specify the certificate to be revoked via the included subject name and public key.-out_trusted filenames|uris — Trusted certificate(s) to use for validating the newly enrolled certificate. Multiple sources may be given. The certificate verification options -verify_hostname, -verify_ip, and -verify_email only affect the certificate verification enabled via this option.-implicit_confirm — Request implicit confirmation of newly enrolled certificates.-disable_confirm — Do not send certificate confirmation message for newly enrolled certificate without requesting implicit confirmation. WARNING: This leads to behavior violating RFC 4210.-certout filename — The file where the newly enrolled certificate should be saved.-chainout filename — The file where the chain of the newly enrolled certificate should be saved.-oldcert filename|uri — The certificate to be updated (renewed or re-keyed) in KUR messages or to be revoked in RR messages. For KUR defaults to -cert. For RR can also be specified using -csr. The reference certificate is also used for deriving default subject DN, Subject Alternative Names, and default issuer entry in the requested certificate template.-revreason number — Set CRLReason to be included in revocation request (RR); values: 0..10 or "-1" for none (default). Reason numbers defined in RFC 5280: unspecified (0), keyCompromise (1), cACompromise (2), affiliationChanged (3), superseded (4), cessationOfOperation (5), certificateHold (6), removeFromCRL (8), privilegeWithdrawn (9), aACompromise (10).-server [http[s]://][userinfo@]host[:port][/path][?query][#fragment] — DNS hostname or IP address and optionally port of the CMP server to connect to using HTTP(S). Excludes -port and -use_mock_srv and is ignored with -rspin. Default port 443 if https and -tls_used, else 80.-proxy [http[s]://][userinfo@]host[:port][/path][?query][#fragment] — HTTP(S) proxy server to use for reaching the CMP server. Defaults to environment variable "http_proxy" or "HTTP_PROXY" (no TLS) or "https_proxy"/"HTTPS_PROXY" (with TLS). Ignored if -server is not given.-no_proxy addresses — List of IP addresses and/or DNS names of servers not to use an HTTP(S) proxy for. Default from environment variable "no_proxy" or "NO_PROXY".-recipient name — Distinguished Name to use in the recipient field of CMP request message headers. If not given, determined in order: subject of -srvcert, -issuer, issuer of -oldcert, issuer of -cert, else NULL-DN.-path remote_path — HTTP path at the CMP server (aka CMP alias) to use for POST requests. Defaults to any path given with -server, else "/".-keep_alive value — If 0, HTTP connections are not kept open (HTTP 1.0 behavior). If 1 or 2, persistent connections are requested. If 2, required. Default is 1.-msg_timeout seconds — Number of seconds (or 0 for infinite) a CMP request-response round trip is allowed to take. Default is to use -total_timeout.-total_timeout seconds — Maximum number of seconds an overall enrollment transaction may take, including polling. Default is 0 (infinite).-trusted filenames|uris — CA certificate(s) to trust while checking certificate chains during CMP server authentication. Gives more flexibility than -srvcert because the server-side CMP signer certificate is not pinned.-untrusted filenames|uris — Non-trusted intermediate CA certificate(s). Any extra certificates given with -cert are appended.-srvcert filename|uri — The specific CMP server certificate to expect and directly trust (even if expired) when validating signature-based protection. If set, the subject is also used as default recipient and expected sender.-expect_sender name — Distinguished Name expected in the sender field of incoming CMP messages. Defaults to the subject DN of the pinned -srvcert, if any.-ignore_keyusage — Ignore key usage restrictions in CMP signer certificates when validating signature-based protection.-unprotected_errors — Accept missing or invalid protection of negative responses from the server. WARNING: This leads to unspecified behavior and is meant exclusively for interoperability with servers violating RFC 4210.-extracertsout filename — The file where to save all certificates contained in the extraCerts field of the last received response message (except for pollRep and PKIConf).-cacertsout filename — The file where to save any CA certificates contained in the caPubs field of the last received certificate response (IP, CP, or KUP).-ref value — Reference number/string/value to use as fallback senderKID; typically used when authenticating with pre-shared key (password-based MAC).-secret arg — Prefer PBM-based message protection with given source of a secret value. Takes precedence over -cert and -key. See openssl-passphrase-options(1).-cert filename|uri — The client's current CMP signer certificate. Requires the corresponding key with -key. The subject will be used as sender. The issuer is used as one of the recipient fallback values. When using signature-based protection, this "protection certificate" will be included first in the extraCerts field.-own_trusted filenames|uris — If provided, the chain built for the client-side CMP signer certificate is verified using these as trust anchors.-key filename|uri — The corresponding private key file for the client's current certificate given in -cert. Used for signature-based message protection unless -secret or -unprotected_requests is given.-keypass arg — Pass phrase source for the private key given with -key. Also used for -cert and -oldcert in case it is an encrypted PKCS#12 file. See openssl-passphrase-options(1).-digest name — Specifies name of supported digest to use in MSG_SIG_ALG and as OWF in MSG_MAC_ALG. Defaults to "sha256".-mac name — Specifies the name of the MAC algorithm in MSG_MAC_ALG. Defaults to "hmac-sha1" as per RFC 4210.-extracerts filenames|uris — Certificates to append in the extraCerts field when sending messages. Can be used as the default CMP signer certificate chain.-unprotected_requests — Send messages without CMP-level protection.-certform PEM|DER — File format to use when saving a certificate to a file. Default is PEM.-keyform PEM|DER|P12|ENGINE — The format of the key input; unspecified by default. See "Format Options" in openssl(1).-otherpass arg — Pass phrase source for certificates given with -trusted, -untrusted, -own_trusted, -srvcert, -out_trusted, -extracerts, -srv_trusted, -srv_untrusted, -rsp_extracerts, -rsp_capubs, -tls_extra, and -tls_trusted. See openssl-passphrase-options(1).-engine id — See "Engine Options" in openssl(1). Deprecated.-provider name-provider-path path-propquery propq — See "Provider Options" in openssl(1), provider(7), and property(7).-rand files, -writerand file — See "Random State Options" in openssl(1).-tls_used — Enable using TLS when connecting to CMP server via HTTP. Not supported with -port and ignored with -use_mock_srv or -rspin.-tls_cert filename|uri — Client's TLS certificate. If the source includes further certs, they are used for constructing the client cert chain provided to the TLS server.-tls_key filename|uri — Private key for the client's TLS certificate.-tls_keypass arg — Pass phrase source for client's private TLS key -tls_key. Also used for -tls_cert if encrypted PKCS#12. See openssl-passphrase-options(1).-tls_extra filenames|uris — Extra certificates to provide to TLS server during TLS handshake.-tls_trusted filenames|uris — Trusted certificate(s) to use for validating the TLS server certificate. Implies hostname validation.-tls_host name — Address to be checked during hostname validation. Defaults to the -server address.-batch — Do not interactively prompt for input, e.g., when a password is needed.-repeat number — Invoke the command the given positive number of times with the same parameters. Default is one invocation.-reqin filenames — Take sequence of CMP requests from file(s). Multiple filenames may be given.-reqin_new_tid — Use a fresh transactionID for CMP request messages read using -reqin.-reqout filenames — Save sequence of CMP requests to file(s).-rspin filenames — Process sequence of CMP responses provided in file(s), skipping server. Excludes -server, -port, and -use_mock_srv.-rspout filenames — Save sequence of CMP responses to file(s).-use_mock_srv — Test the client using the internal CMP server mock-up at API level, bypassing socket-based transfer via HTTP. Excludes -server, -port, and -rspin.-port number — Act as HTTP-based CMP server mock-up listening on the given port. Excludes -server, -rspin, and -use_mock_srv.-max_msgs number — Maximum number of CMP request messages the mock-up should handle. Default 0 (unlimited).-srv_ref value — Reference value to use as senderKID of server in case no -srv_cert is given.-srv_secret arg — Password source for server authentication with a pre-shared key.-srv_cert filename|uri — Certificate of the server.-srv_key filename|uri — Private key used by the server for signing messages.-srv_keypass arg — Server private key (and cert) file pass phrase source.-srv_trusted filenames|uris — Trusted certificates for client authentication.-srv_untrusted filenames|uris — Intermediate CA certs that may be useful when validating client certificates.-rsp_cert filename|uri — Certificate to be returned as mock enrollment result.-rsp_extracerts filenames|uris — Extra certificates to be included in mock certification responses.-rsp_capubs filenames|uris — CA certificates to be included in mock IP message.-poll_count number — Number of times the client must poll before receiving a certificate.-check_after number — The checkAfter value (seconds) to include in poll response.-grant_implicitconf — Grant implicit confirmation of newly enrolled certificate.-pkistatus number — PKIStatus to be included in server response. Valid range 0 (accepted) .. 6 (keyUpdateWarning).-failure number — A single failure info bit number to be included in server response. Valid range 0 (badAlg) .. 26 (duplicateCertReq).-failurebits number — Number representing failure bits to be included in server response. Valid range 0 .. 2^27 - 1.-statusstring arg — Text to be included as status string in server response.-send_error — Force server to reply with error message.-send_unprotected — Send response messages without CMP-level protection.-send_unprot_err — In case of negative responses, server shall send unprotected error messages. WARNING: Violates RFC 4210.-accept_unprotected — Accept missing or invalid protection of requests.-accept_unprot_err — Accept unprotected error messages from client.-accept_raverified — Accept RAVERIFED as proof-of-possession (POPO).-allow_proxy_certs, -attime, -no_check_time, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict, -issuer_checks — Set various options of certificate chain verification. See openssl-verification-options(1) for details. The options -verify_hostname, -verify_ip, and -verify_email only affect the certificate verification enabled via the -out_trusted option.When setting up CMP configurations and experimenting with enrollment options, typically various errors occur until the configuration is correct and complete. When the CMP server reports an error, the client will by default check the protection of the CMP response message. Yet some CMP services tend not to protect negative responses. In this case the client will reject them, and thus their contents are not shown although they usually contain hints that would be helpful for diagnostics. For assisting in such cases, the CMP client offers a workaround via the -unprotected_errors option, which allows accepting such negative messages.
This CMP client implementation comes with demonstrative CMP sections in the example configuration file openssl/apps/openssl.cnf, which can be used to interact conveniently with the Insta Demo CA.
In order to enroll an initial certificate from that CA, it is sufficient to issue the following shell commands:
export OPENSSL_CONF=/path/to/openssl/apps/openssl.cnf
openssl genrsa -out insta.priv.pem
openssl cmp -section insta
This should produce the file insta.cert.pem containing a new certificate for the private key held in insta.priv.pem. It can be viewed using, e.g.,
openssl x509 -noout -text -in insta.cert.pem
In case the network setup requires using an HTTP proxy, it may be given as usual via the environment variable http_proxy or via the -proxy option in the configuration file or the command-line argument -proxy, for example:
-proxy http://192.168.1.1:8080
In the Insta Demo CA scenario, both clients and the server may use the pre-shared secret insta and the reference value 3078 to authenticate to each other.
Alternatively, CMP messages may be protected in signature-based manner, where the trust anchor in this case is insta.ca.crt and the client may use any certificate already obtained from that CA, as specified in the [signature] section of the example configuration. This can be used in combination with the [insta] section simply by:
openssl cmp -section insta,signature
By default the CMP IR message type is used, yet CR works equally here. This may be specified directly at the command line:
openssl cmp -section insta -cmd cr
or by referencing in addition the [cr] section of the example configuration:
openssl cmp -section insta,cr
In order to update the enrolled certificate, one may call:
openssl cmp -section insta,kur
using PBM-based protection or
openssl cmp -section insta,kur,signature
using signature-based protection.
In a similar way, any previously enrolled certificate may be revoked by:
openssl cmp -section insta,rr -trusted insta.ca.crt
or
openssl cmp -section insta,rr,signature
Many more options can be given in the configuration file and/or on the command line. For instance, the -reqexts CLI option may refer to a section in the configuration file defining X.509 extensions to use in certificate requests, such as "v3_req" in openssl/apps/openssl.cnf:
openssl cmp -section insta,cr -reqexts v3_req
The following examples do not make use of a configuration file at first. They assume that a CMP server can be contacted on the local TCP port 80 and accepts requests under the alias /pkix/.
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. In this example the client does not have the CA certificate yet, so we specify the name of the CA with the -recipient option and save any CA certificates that we may receive in the "capubs.pem" file.
In below command line usage examples, the "\" at line ends is used just for formatting; each of the command invocations should be on a single line.
openssl genrsa -out cl_key.pem
openssl cmp -cmd ir -server 127.0.0.1:80/pkix/ -recipient "/CN=CMPserver" \
-ref 1234 -secret pass:1234-5678 \
-newkey cl_key.pem -subject "/CN=MyName" \
-cacertsout capubs.pem -certout cl_cert.pem
Then, when the client certificate and its related key pair needs to be updated, the client can send a key update request taking the certs in "capubs.pem" as trusted for authenticating the server and using the previous cert and key for its own authentication. Then it can start using the new cert and key.
openssl genrsa -out cl_key_new.pem
openssl cmp -cmd kur -server 127.0.0.1:80/pkix/ \
-trusted capubs.pem \
-cert cl_cert.pem -key cl_key.pem \
-newkey cl_key_new.pem -certout cl_cert.pem
cp cl_key_new.pem cl_key.pem
This command sequence can be repeated as often as needed.
Requesting "all relevant information" with an empty General Message. This prints information about all received ITAV infoTypes to stdout.
openssl cmp -cmd genm -server 127.0.0.1/pkix/ -recipient "/CN=CMPserver" \
-ref 1234 -secret pass:1234-5678
For CMP client invocations, in particular for certificate enrollment, 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 openssl.cnf. The values found there can still be extended and even overridden by any subsequently loaded sections and on the command line.
After including in the configuration file the following sections:
[cmp]
server = 127.0.0.1
path = pkix/
trusted = capubs.pem
cert = cl_cert.pem
key = cl_key.pem
newkey = cl_key.pem
certout = cl_cert.pem
[init]
recipient = "/CN=CMPserver"
trusted =
cert =
key =
ref = 1234
secret = pass:1234-5678-1234-567
subject = "/CN=MyName"
cacertsout = capubs.pem
The above enrollment transactions reduce to
openssl cmp -section cmp,init
openssl cmp -cmd kur -newkey cl_key_new.pem
and the above transaction using a general message reduces to
openssl cmp -section cmp,init -cmd genm
openssl-genrsa(1), openssl-ecparam(1), openssl-list(1), openssl-req(1), openssl-x509(1), x509v3_config(5)
The cmp application was added in OpenSSL 3.0. The -engine option was deprecated in OpenSSL 3.0.
Copyright 2007-2022 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.
Generated by phpman v4.9.26-1-g511901d Author: Che Dong Under GNU General Public License
2026-08-08 10:43 @216.73.216.229
CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Enhanced by LLM: deepseek-v4-flash / taotoken.net / www.chedong.com - original format