2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-cmp - Certificate Management Protocol (CMP, RFC 4210) application
12 [B<-config> I<filename>]
13 [B<-section> I<names>]
14 [B<-verbosity> I<level>]
16 Generic message options:
18 [B<-cmd> I<ir|cr|kur|p10cr|rr|genm>]
19 [B<-infotype> I<name>]
21 [B<-geninfo> I<values>]
23 Certificate enrollment options:
25 [B<-newkey> I<filename>|I<uri>]
26 [B<-newkeypass> I<arg>]
32 [B<-policies> I<name>]
33 [B<-policy_oids> I<names>]
34 [B<-policy_oids_critical>]
37 [B<-out_trusted> I<filenames>|I<uris>]
38 [B<-implicit_confirm>]
40 [B<-certout> I<filename>]
41 [B<-chainout> I<filename>]
43 Certificate enrollment and revocation options:
45 [B<-oldcert> I<filename>|I<uri>]
47 [B<-serial> I<number>]
48 [B<-revreason> I<number>]
50 Message transfer options:
52 [B<-server> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>]
53 [B<-proxy> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>]
54 [B<-no_proxy> I<addresses>]
55 [B<-recipient> I<name>]
56 [B<-path> I<remote_path>]
57 [B<-keep_alive> I<value>]
58 [B<-msg_timeout> I<seconds>]
59 [B<-total_timeout> I<seconds>]
61 Server authentication options:
63 [B<-trusted> I<filenames>|I<uris>]
64 [B<-untrusted> I<filenames>|I<uris>]
65 [B<-srvcert> I<filename>|I<uri>]
66 [B<-expect_sender> I<name>]
68 [B<-unprotected_errors>]
69 [B<-no_cache_extracerts>]
70 [B<-srvcertout> I<filename>]
71 [B<-extracertsout> I<filename>]
72 [B<-cacertsout> I<filename>]
73 [B<-oldwithold> I<filename>]
74 [B<-newwithnew> I<filename>]
75 [B<-newwithold> I<filename>]
76 [B<-oldwithnew> I<filename>]
78 Client authentication and protection options:
82 [B<-cert> I<filename>|I<uri>]
83 [B<-own_trusted> I<filenames>|I<uris>]
84 [B<-key> I<filename>|I<uri>]
88 [B<-extracerts> I<filenames>|I<uris>]
89 [B<-unprotected_requests>]
91 Credentials format options:
93 [B<-certform> I<PEM|DER>]
94 [B<-keyform> I<PEM|DER|P12|ENGINE>]
95 [B<-otherpass> I<arg>]
96 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
100 {- $OpenSSL::safe::opt_r_synopsis -}
102 TLS connection options:
105 [B<-tls_cert> I<filename>|I<uri>]
106 [B<-tls_key> I<filename>|I<uri>]
107 [B<-tls_keypass> I<arg>]
108 [B<-tls_extra> I<filenames>|I<uris>]
109 [B<-tls_trusted> I<filenames>|I<uris>]
110 [B<-tls_host> I<name>]
112 Client-side debugging options:
115 [B<-repeat> I<number>]
116 [B<-reqin> I<filenames>]
118 [B<-reqout> I<filenames>]
119 [B<-reqout_only> I<filename>]
120 [B<-rspin> I<filenames>]
121 [B<-rspout> I<filenames>]
127 [B<-max_msgs> I<number>]
128 [B<-srv_ref> I<value>]
129 [B<-srv_secret> I<arg>]
130 [B<-srv_cert> I<filename>|I<uri>]
131 [B<-srv_key> I<filename>|I<uri>]
132 [B<-srv_keypass> I<arg>]
133 [B<-srv_trusted> I<filenames>|I<uris>]
134 [B<-srv_untrusted> I<filenames>|I<uris>]
135 [B<-ref_cert> I<filename>|I<uri>]
136 [B<-rsp_cert> I<filename>|I<uri>]
137 [B<-rsp_extracerts> I<filenames>|I<uris>]
138 [B<-rsp_capubs> I<filenames>|I<uris>]
139 [B<-rsp_newwithnew> I<filename>|I<uri>]
140 [B<-rsp_newwithold> I<filename>|I<uri>]
141 [B<-rsp_oldwithnew> I<filename>|I<uri>]
142 [B<-poll_count> I<number>]
143 [B<-check_after> I<number>]
144 [B<-grant_implicitconf>]
145 [B<-pkistatus> I<number>]
146 [B<-failure> I<number>]
147 [B<-failurebits> I<number>]
148 [B<-statusstring> I<arg>]
150 [B<-send_unprotected>]
151 [B<-send_unprot_err>]
152 [B<-accept_unprotected>]
153 [B<-accept_unprot_err>]
154 [B<-accept_raverified>]
156 Certificate verification options, for both CMP and TLS:
158 {- $OpenSSL::safe::opt_v_synopsis -}
162 The B<cmp> command is a client implementation for the Certificate
163 Management Protocol (CMP) as defined in RFC4210.
164 It can be used to request certificates from a CA server,
165 update their certificates,
166 request certificates to be revoked, and perform other types of CMP requests.
174 Display a summary of all options
176 =item B<-config> I<filename>
178 Configuration file to use.
179 An empty string C<""> means none.
180 Default filename is from the environment variable C<OPENSSL_CONF>.
182 =item B<-section> I<names>
184 Section(s) to use within config file defining CMP options.
185 An empty string C<""> means no specific section.
188 Multiple section names may be given, separated by commas and/or whitespace
189 (where in the latter case the whole argument must be enclosed in "...").
190 Contents of sections named later may override contents of sections named before.
191 In any case, as usual, the C<[default]> section and finally the unnamed
192 section (as far as present) can provide per-option fallback values.
194 =item B<-verbosity> I<level>
196 Level of verbosity for logging, error output, etc.
197 0 = EMERG, 1 = ALERT, 2 = CRIT, 3 = ERR, 4 = WARN, 5 = NOTE,
198 6 = INFO, 7 = DEBUG, 8 = TRACE.
199 Defaults to 6 = INFO.
203 =head2 Generic message options
207 =item B<-cmd> I<ir|cr|kur|p10cr|rr|genm>
209 CMP command to execute.
210 Currently implemented commands are:
214 =item ir E<nbsp> - Initialization Request
216 =item cr E<nbsp> - Certificate Request
218 =item p10cr - PKCS#10 Certification Request (for legacy support)
220 =item kur E<nbsp>E<nbsp>- Key Update Request
222 =item rr E<nbsp> - Revocation Request
224 =item genm - General Message
228 B<ir> requests initialization of an end entity into a PKI hierarchy
229 by issuing a first certificate.
231 B<cr> requests issuing an additional certificate for an end entity already
232 initialized to the PKI hierarchy.
234 B<p10cr> requests issuing an additional certificate similarly to B<cr>
235 but using legacy PKCS#10 CSR format.
237 B<kur> requests a (key) update for an existing certificate.
239 B<rr> requests revocation of an existing certificate.
241 B<genm> requests information using a General Message, where optionally
242 included B<InfoTypeAndValue>s may be used to state which info is of interest.
243 Upon receipt of the General Response, information about all received
244 ITAV B<infoType>s is printed to stdout.
246 =item B<-infotype> I<name>
248 Set InfoType name to use for requesting specific info in B<genm>,
249 e.g., C<signKeyPairTypes>.
250 So far, there is specific support for C<caCerts> and C<rootCaCert>.
252 =item B<-profile> I<name>
254 Name of a certificate profile to place in
255 the PKIHeader generalInfo field of request messages.
257 =item B<-geninfo> I<values>
259 A comma-separated list of InfoTypeAndValue to place in
260 the generalInfo field of the PKIHeader of requests messages.
261 Each InfoTypeAndValue gives an OID and an integer or string value
262 of the form I<OID>:int:I<number> or I<OID>:str:I<text>,
263 e.g., C<'1.2.3.4:int:56789, id-kp:str:name'>.
267 =head2 Certificate enrollment options
271 =item B<-newkey> I<filename>|I<uri>
273 The source of the private or public key for the certificate being requested.
274 Defaults to the public key in the PKCS#10 CSR given with the B<-csr> option,
275 the public key of the reference certificate, or the current client key.
277 The public portion of the key is placed in the certification request.
279 Unless B<-cmd> I<p10cr>, B<-popo> I<-1>, or B<-popo> I<0> is given, the
280 private key will be needed as well to provide the proof of possession (POPO),
281 where the B<-key> option may provide a fallback.
283 =item B<-newkeypass> I<arg>
285 Pass phrase source for the key given with the B<-newkey> option.
286 If not given here, the password will be prompted for if needed.
288 For more information about the format of I<arg> see
289 L<openssl-passphrase-options(1)>.
291 =item B<-subject> I<name>
293 X.509 Distinguished Name (DN) to use as subject field
294 in the requested certificate template in IR/CR/KUR messages.
295 If the NULL-DN (C</>) is given then no subject is placed in the template.
296 Default is the subject DN of any PKCS#10 CSR given with the B<-csr> option.
297 For KUR, a further fallback is the subject DN
298 of the reference certificate (see B<-oldcert>) if provided.
299 This fallback is used for IR and CR only if no SANs are set.
301 If provided and neither of B<-cert>, B<-oldcert>, or B<-csr> is given,
302 the subject DN is used as fallback sender of outgoing CMP messages.
304 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
305 Special characters may be escaped by C<\> (backslash); whitespace is retained.
306 Empty values are permitted, but the corresponding type will not be included.
307 Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
308 Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
309 between the AttributeValueAssertions (AVAs) that specify the members of the set.
312 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
314 =item B<-days> I<number>
316 Number of days the new certificate is requested to be valid for, counting from
317 the current time of the host.
318 Also triggers the explicit request that the
319 validity period starts from the current time (as seen by the host).
321 =item B<-reqexts> I<name>
323 Name of section in OpenSSL config file defining certificate request extensions.
324 If the B<-csr> option is present, these extensions augment the extensions
325 contained the given PKCS#10 CSR, overriding any extensions with same OIDs.
327 =item B<-sans> I<spec>
329 One or more IP addresses, email addresses, DNS names, or URIs
330 separated by commas or whitespace
331 (where in the latter case the whole argument must be enclosed in "...")
332 to add as Subject Alternative Name(s) (SAN) certificate request extension.
333 If the special element "critical" is given the SANs are flagged as critical.
334 Cannot be used if any Subject Alternative Name extension is set via B<-reqexts>.
336 =item B<-san_nodefault>
338 When Subject Alternative Names are not given via B<-sans>
339 nor defined via B<-reqexts>,
340 they are copied by default from the reference certificate (see B<-oldcert>).
341 This can be disabled by giving the B<-san_nodefault> option.
343 =item B<-policies> I<name>
345 Name of section in OpenSSL config file defining policies to be set
346 as certificate request extension.
347 This option cannot be used together with B<-policy_oids>.
349 =item B<-policy_oids> I<names>
351 One or more OID(s), separated by commas and/or whitespace
352 (where in the latter case the whole argument must be enclosed in "...")
353 to add as certificate policies request extension.
354 This option cannot be used together with B<-policies>.
356 =item B<-policy_oids_critical>
358 Flag the policies given with B<-policy_oids> as critical.
360 =item B<-popo> I<number>
362 Proof-of-possession (POPO) method to use for IR/CR/KUR; values: C<-1>..<2> where
363 C<-1> = NONE, C<0> = RAVERIFIED, C<1> = SIGNATURE (default), C<2> = KEYENC.
365 Note that a signature-based POPO can only be produced if a private key
366 is provided via the B<-newkey> or B<-key> options.
368 =item B<-csr> I<filename>
370 PKCS#10 CSR in PEM or DER format containing a certificate request.
371 With B<-cmd> I<p10cr> it is used directly in a legacy P10CR message.
373 When used with B<-cmd> I<ir>, I<cr>, or I<kur>,
374 it is transformed into the respective regular CMP request.
375 In this case, a private key must be provided (with B<-newkey> or B<-key>)
376 for the proof of possession (unless B<-popo> I<-1> or B<-popo> I<0> is used)
377 and the respective public key is placed in the certification request
378 (rather than taking over the public key contained in the PKCS#10 CSR).
380 PKCS#10 CSR input may also be used with B<-cmd> I<rr>
381 to specify the certificate to be revoked
382 via the included subject name and public key.
383 Its subject is used as fallback sender in CMP message headers
384 if B<-cert> and B<-oldcert> are not given.
386 =item B<-out_trusted> I<filenames>|I<uris>
388 Trusted certificate(s) to use for validating the newly enrolled certificate.
389 During this verification, any certificate status checking is disabled.
391 Multiple sources may be given, separated by commas and/or whitespace
392 (where in the latter case the whole argument must be enclosed in "...").
393 Each source may contain multiple certificates.
395 The certificate verification options
396 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
397 only affect the certificate verification enabled via this option.
399 =item B<-implicit_confirm>
401 Request implicit confirmation of newly enrolled certificates.
403 =item B<-disable_confirm>
405 Do not send certificate confirmation message for newly enrolled certificate
406 without requesting implicit confirmation
407 to cope with broken servers not supporting implicit confirmation correctly.
408 B<WARNING:> This leads to behavior violating RFC 4210.
410 =item B<-certout> I<filename>
412 The file where any newly enrolled certificate should be saved.
414 =item B<-chainout> I<filename>
416 The file where the chain of any newly enrolled certificate should be saved.
420 =head2 Certificate enrollment and revocation options
424 =item B<-oldcert> I<filename>|I<uri>
426 The certificate to be updated (i.e., renewed or re-keyed) in Key Update Request
427 (KUR) messages or to be revoked in Revocation Request (RR) messages.
428 For KUR the certificate to be updated defaults to B<-cert>,
429 and the resulting certificate is called I<reference certificate>.
430 For RR the certificate to be revoked can also be specified using B<-csr>.
431 B<-oldcert> and B<-csr> is ignored if B<-issuer> and B<-serial> is provided.
433 The reference certificate, if any, is also used for
434 deriving default subject DN and Subject Alternative Names and the
435 default issuer entry in the requested certificate template of an IR/CR/KUR.
436 Its public key is used as a fallback in the template of certification requests.
437 Its subject is used as sender of outgoing messages if B<-cert> is not given.
438 Its issuer is used as default recipient in CMP message headers
439 if neither B<-recipient>, B<-srvcert>, nor B<-issuer> is given.
441 =item B<-issuer> I<name>
443 X.509 Distinguished Name (DN) use as issuer field
444 in the requested certificate template in IR/CR/KUR/RR messages.
445 If the NULL-DN (C</>) is given then no issuer is placed in the template.
447 If provided and neither B<-recipient> nor B<-srvcert> is given,
448 the issuer DN is used as fallback recipient of outgoing CMP messages.
450 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
451 For details see the description of the B<-subject> option.
453 =item B<-serial> I<number>
455 Specify the Serial number of certificate to be revoked in revocation request.
456 The serial number can be decimal or hex (if preceded by C<0x>)
458 =item B<-revreason> I<number>
460 Set CRLReason to be included in revocation request (RR); values: C<0>..C<10>
461 or C<-1> for none (which is the default).
463 Reason numbers defined in RFC 5280 are:
465 CRLReason ::= ENUMERATED {
469 affiliationChanged (3),
471 cessationOfOperation (5),
473 -- value 7 is not used
475 privilegeWithdrawn (9),
481 =head2 Message transfer options
485 =item B<-server> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>
487 The I<host> domain name or IP address and optionally I<port>
488 of the CMP server to connect to using HTTP(S).
489 IP address may be for v4 or v6, such as C<127.0.0.1> or C<[::1]> for localhost.
491 This option excludes I<-port> and I<-use_mock_srv>.
492 It is ignored if I<-rspin> is given with enough filename arguments.
494 If the scheme C<https> is given, the B<-tls_used> option is implied.
495 When TLS is used, the default port is 443, otherwise 80.
496 The optional userinfo and fragment components are ignored.
497 Any given query component is handled as part of the path component.
498 If a path is included it provides the default value for the B<-path> option.
500 =item B<-proxy> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>
502 The HTTP(S) proxy server to use for reaching the CMP server unless B<-no_proxy>
504 The proxy port defaults to 80 or 443 if the scheme is C<https>; apart from that
505 the optional C<http://> or C<https://> prefix is ignored (note that using TLS
506 may be required by B<-tls_used> or B<-server> with the prefix C<https>),
507 as well as any path, userinfo, and query, and fragment components.
508 Defaults to the environment variable C<http_proxy> if set, else C<HTTP_PROXY>
509 in case no TLS is used, otherwise C<https_proxy> if set, else C<HTTPS_PROXY>.
510 This option is ignored if I<-server> is not given.
512 =item B<-no_proxy> I<addresses>
514 List of IP addresses and/or DNS names of servers
515 not to use an HTTP(S) proxy for, separated by commas and/or whitespace
516 (where in the latter case the whole argument must be enclosed in "...").
517 Default is from the environment variable C<no_proxy> if set, else C<NO_PROXY>.
518 This option is ignored if I<-server> is not given.
520 =item B<-recipient> I<name>
522 Distinguished Name (DN) to use in the recipient field of CMP request message
523 headers, i.e., the CMP server (usually the addressed CA).
525 The recipient field in the header of a CMP message is mandatory.
526 If not given explicitly the recipient is determined in the following order:
527 the subject of the CMP server certificate given with the B<-srvcert> option,
528 the B<-issuer> option,
529 the issuer of the certificate given with the B<-oldcert> option,
530 the issuer of the CMP client certificate (B<-cert> option),
531 as far as any of those is present, else the NULL-DN as last resort.
533 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
534 For details see the description of the B<-subject> option.
536 =item B<-path> I<remote_path>
538 HTTP path at the CMP server (aka CMP alias) to use for POST requests.
539 Defaults to any path given with B<-server>, else C<"/">.
541 =item B<-keep_alive> I<value>
543 If the given value is 0 then HTTP connections are closed after each response
544 (which would be the default behavior of HTTP 1.0)
545 even if a CMP transaction needs more than one round trip.
546 If the value is 1 or 2
547 then for each transaction a persistent connection is requested.
548 If the value is 2 then a persistent connection is required,
549 i.e., an error occurs if the server does not grant it.
550 The default value is 1, which means preferring to keep the connection open.
552 =item B<-msg_timeout> I<seconds>
554 Number of seconds a CMP request-response message round trip
555 is allowed to take before a timeout error is returned.
556 A value <= 0 means no limitation (waiting indefinitely).
557 Default is to use the B<-total_timeout> setting.
559 =item B<-total_timeout> I<seconds>
561 Maximum total number of seconds a transaction may take,
562 including polling etc.
563 A value <= 0 means no limitation (waiting indefinitely).
568 =head2 Server authentication options
572 =item B<-trusted> I<filenames>|I<uris>
574 The certificate(s), typically of root CAs, the client shall use as trust anchors
575 when validating signature-based protection of CMP response messages.
576 This option is ignored if the B<-srvcert> option is given as well.
577 It provides more flexibility than B<-srvcert> because the CMP protection
578 certificate of the server is not pinned but may be any certificate
579 from which a chain to one of the given trust anchors can be constructed.
581 If none of B<-trusted>, B<-srvcert>, and B<-secret> is given, message validation
582 errors will be thrown unless B<-unprotected_errors> permits an exception.
584 Multiple sources may be given, separated by commas and/or whitespace
585 (where in the latter case the whole argument must be enclosed in "...").
586 Each source may contain multiple certificates.
588 The certificate verification options
589 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
590 have no effect on the certificate verification enabled via this option.
592 =item B<-untrusted> I<filenames>|I<uris>
594 Non-trusted intermediate CA certificate(s).
595 Any extra certificates given with the B<-cert> option are appended to it.
596 All these certificates may be useful for cert path construction
597 for the own CMP signer certificate (to include in the extraCerts field of
598 request messages) and for the TLS client certificate (if TLS is used)
599 as well as for chain building
600 when validating server certificates (checking signature-based
601 CMP message protection) and when validating newly enrolled certificates.
603 Multiple sources may be given, separated by commas and/or whitespace
604 (where in the latter case the whole argument must be enclosed in "...").
605 Each source may contain multiple certificates.
607 =item B<-srvcert> I<filename>|I<uri>
609 The specific CMP server certificate to expect and directly trust (even if it is
610 expired) when verifying signature-based protection of CMP response messages.
611 This pins the accepted server and results in ignoring the B<-trusted> option.
613 If set, the subject of the certificate is also used
614 as default value for the recipient of CMP requests
615 and as default value for the expected sender of CMP responses.
617 =item B<-expect_sender> I<name>
619 Distinguished Name (DN) expected in the sender field of incoming CMP messages.
620 Defaults to the subject DN of the pinned B<-srvcert>, if any.
622 This can be used to make sure that only a particular entity is accepted as
623 CMP message signer, and attackers are not able to use arbitrary certificates
624 of a trusted PKI hierarchy to fraudulently pose as a CMP server.
625 Note that this option gives slightly more freedom than setting the B<-srvcert>,
626 which pins the server to the holder of a particular certificate, while the
627 expected sender name will continue to match after updates of the server cert.
629 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
630 For details see the description of the B<-subject> option.
632 =item B<-ignore_keyusage>
634 Ignore key usage restrictions in CMP signer certificates when validating
635 signature-based protection of incoming CMP messages.
636 By default, C<digitalSignature> must be allowed by CMP signer certificates.
637 This option applies to both CMP clients and the mock server.
639 =item B<-unprotected_errors>
641 Accept missing or invalid protection of negative responses from the server.
642 This applies to the following message types and contents:
646 =item * error messages
648 =item * negative certificate responses (IP/CP/KUP)
650 =item * negative revocation responses (RP)
652 =item * negative PKIConf messages
656 B<WARNING:> This setting leads to unspecified behavior and it is meant
657 exclusively to allow interoperability with server implementations violating
662 =item * section 5.1.3.1 allows exceptions from protecting only for special
664 "There MAY be cases in which the PKIProtection BIT STRING is deliberately not
665 used to protect a message [...] because other protection, external to PKIX, will
668 =item * section 5.3.21 is clear on ErrMsgContent: "The CA MUST always sign it
669 with a signature key."
671 =item * appendix D.4 shows PKIConf message having protection
675 =item B<-no_cache_extracerts>
677 Do not cache certificates in the extraCerts field of CMP messages received.
678 By default, they are kept as they may be helful for validating further messages.
679 This option applies to both CMP clients and the mock server.
681 =item B<-srvcertout> I<filename>
683 The file where to save the successfully validated certificate, if any,
684 that the CMP server used for signature-based response message protection.
685 If there is no such certificate, typically because the protection was MAC-based,
686 this is indicated by deleting the file (if it existed).
688 =item B<-extracertsout> I<filename>
690 The file where to save the list of certificates contained in the extraCerts
691 field of the last received response message that is not a pollRep nor PKIConf.
693 =item B<-cacertsout> I<filename>
695 The file where to save the list of CA certificates contained in the caPubs field
696 if a positive certificate response (i.e., IP, CP, or KUP) message was received
697 or contained in a general response (genp) message with infoType C<caCerts>.
699 =item B<-oldwithold> I<filename>
701 The root CA certificate to include in a genm request of infoType C<rootCaCert>.
702 If present and the optional oldWithNew certificate is received,
703 it is verified using the newWithNew certificate as the (only) trust anchor.
705 =item B<-newwithnew> I<filename>
707 This option must be provided when B<-infotype> I<rootCaCert> is given.
708 It specifies the file to save the newWithNew certificate
709 received in a genp message of type C<rootCaKeyUpdate>.
710 If on success no such cert was received, this file (if present) is deleted
711 to indicate that the requested root CA certificate update is not available.
713 Any received newWithNew certificate is verified
714 using any received newWithOld certificate as untrusted intermediate certificate
715 and the certificate provided with B<-oldwithold> as the (only) trust anchor,
716 or if not provided, using the certificates given with the B<-trusted> option.
719 The newWithNew certificate is meant to be a certificate that will be trusted.
720 The trust placed in it cannot be stronger than the trust placed in
721 the B<-oldwithold> certificate if present, otherwise it cannot be stronger than
722 the weakest trust placed in any of the B<-trusted> certificates.
724 =item B<-newwithold> I<filename>
726 The file to save any newWithOld certificate
727 received in a genp message of infoType C<rootCaKeyUpdate>.
728 If on success no such cert was received, this is indicated by deleting the file.
730 =item B<-oldwithnew> I<filename>
732 The file to save any oldWithNew certificate
733 received in a genp message of infoType C<rootCaKeyUpdate>.
734 If on success no such cert was received, this is indicated by deleting the file.
738 =head2 Client authentication options
742 =item B<-ref> I<value>
744 Reference number/string/value to use as fallback senderKID; this is required
745 if no sender name can be determined from the B<-cert> or <-subject> options and
746 is typically used when authenticating with pre-shared key (password-based MAC).
748 =item B<-secret> I<arg>
750 Provides the source of a secret value to use with MAC-based message protection.
751 This takes precedence over the B<-cert> and B<-key> options.
752 The secret is used for creating MAC-based protection of outgoing messages
753 and for validating incoming messages that have MAC-based protection.
754 The algorithm used by default is Password-Based Message Authentication Code (PBM)
755 as defined in RFC 4210 section 5.1.3.1.
757 For more information about the format of I<arg> see
758 L<openssl-passphrase-options(1)>.
760 =item B<-cert> I<filename>|I<uri>
762 The client's current CMP signer certificate.
763 Requires the corresponding key to be given with B<-key>.
765 The subject and the public key contained in this certificate
766 serve as fallback values in the certificate template of IR/CR/KUR messages.
768 The subject of this certificate will be used as sender of outgoing CMP messages,
769 while the subject of B<-oldcert> or B<-subjectName> may provide fallback values.
771 The issuer of this certificate is used as one of the recipient fallback values
772 and as fallback issuer entry in the certificate template of IR/CR/KUR messages.
774 When performing signature-based message protection,
775 this "protection certificate", also called "signer certificate",
776 will be included first in the extraCerts field of outgoing messages
777 and the signature is done with the corresponding key.
778 In Initialization Request (IR) messages this can be used for authenticating
779 using an external entity certificate as defined in appendix E.7 of RFC 4210.
781 For Key Update Request (KUR) messages this is also used as
782 the certificate to be updated if the B<-oldcert> option is not given.
784 If the file includes further certs, they are appended to the untrusted certs
785 because they typically constitute the chain of the client certificate, which
786 is included in the extraCerts field in signature-protected request messages.
788 =item B<-own_trusted> I<filenames>|I<uris>
790 If this list of certificates is provided then the chain built for
791 the client-side CMP signer certificate given with the B<-cert> option
792 is verified using the given certificates as trust anchors.
794 Multiple sources may be given, separated by commas and/or whitespace
795 (where in the latter case the whole argument must be enclosed in "...").
796 Each source may contain multiple certificates.
798 The certificate verification options
799 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
800 have no effect on the certificate verification enabled via this option.
802 =item B<-key> I<filename>|I<uri>
804 The corresponding private key file for the client's current certificate given in
806 This will be used for signature-based message protection unless the B<-secret>
807 option indicating MAC-based protection or B<-unprotected_requests> is given.
809 It is also used as a fallback for the B<-newkey> option with IR/CR/KUR messages.
811 =item B<-keypass> I<arg>
813 Pass phrase source for the private key given with the B<-key> option.
814 Also used for B<-cert> and B<-oldcert> in case it is an encrypted PKCS#12 file.
815 If not given here, the password will be prompted for if needed.
817 For more information about the format of I<arg> see
818 L<openssl-passphrase-options(1)>.
820 =item B<-digest> I<name>
822 Specifies name of supported digest to use in RFC 4210's MSG_SIG_ALG
823 and as the one-way function (OWF) in C<MSG_MAC_ALG>.
824 If applicable, this is used for message protection and
825 proof-of-possession (POPO) signatures.
826 To see the list of supported digests, use C<openssl list -digest-commands>.
827 Defaults to C<sha256>.
829 =item B<-mac> I<name>
831 Specifies the name of the MAC algorithm in C<MSG_MAC_ALG>.
832 To get the names of supported MAC algorithms use C<openssl list -mac-algorithms>
833 and possibly combine such a name with the name of a supported digest algorithm,
834 e.g., hmacWithSHA256.
835 Defaults to C<hmac-sha1> as per RFC 4210.
837 =item B<-extracerts> I<filenames>|I<uris>
839 Certificates to append in the extraCerts field when sending messages.
840 They can be used as the default CMP signer certificate chain to include.
842 Multiple sources may be given, separated by commas and/or whitespace
843 (where in the latter case the whole argument must be enclosed in "...").
844 Each source may contain multiple certificates.
846 =item B<-unprotected_requests>
848 Send request messages without CMP-level protection.
852 =head2 Credentials format options
856 =item B<-certform> I<PEM|DER>
858 File format to use when saving a certificate to a file.
859 Default value is PEM.
861 =item B<-keyform> I<PEM|DER|P12|ENGINE>
863 The format of the key input; unspecified by default.
864 See L<openssl(1)/Format Options> for details.
866 =item B<-otherpass> I<arg>
868 Pass phrase source for certificate given with the B<-trusted>, B<-untrusted>,
869 B<-own_trusted>, B<-srvcert>, B<-out_trusted>, B<-extracerts>,
870 B<-srv_trusted>, B<-srv_untrusted>, B<-ref_cert>, B<-rsp_cert>,
871 B<-rsp_extracerts>, B<-rsp_capubs>,
872 B<-rsp_newwithnew>, B<-rsp_newwithold>, B<-rsp_oldwithnew>,
873 B<-tls_extra>, and B<-tls_trusted> options.
874 If not given here, the password will be prompted for if needed.
876 For more information about the format of I<arg> see
877 L<openssl-passphrase-options(1)>.
879 {- $OpenSSL::safe::opt_engine_item -}
881 {- output_off() if $disabled{"deprecated-3.0"}; "" -}
882 As an alternative to using this combination:
884 -engine {engineid} -key {keyid} -keyform ENGINE
886 ... it's also possible to just give the key ID in URI form to B<-key>,
889 -key org.openssl.engine:{engineid}:{keyid}
891 This applies to all options specifying keys: B<-key>, B<-newkey>, and
893 {- output_on() if $disabled{"deprecated-3.0"}; "" -}
897 =head2 Provider options
901 {- $OpenSSL::safe::opt_provider_item -}
905 =head2 Random state options
909 {- $OpenSSL::safe::opt_r_item -}
913 =head2 TLS connection options
919 Make the CMP client use TLS (regardless if other TLS-related options are set)
920 for message exchange with the server via HTTP.
921 This option is not supported with the I<-port> option.
922 It is implied if the B<-server> option is given with the scheme C<https>.
923 It is ignored if the B<-server> option is not given or B<-use_mock_srv> is given
924 or B<-rspin> is given with enough filename arguments.
926 The following TLS-related options are ignored if TLS is not used.
928 =item B<-tls_cert> I<filename>|I<uri>
930 Client's TLS certificate to use for authenticating to the TLS server.
931 If the source includes further certs they are used (along with B<-untrusted>
932 certs) for constructing the client cert chain provided to the TLS server.
934 =item B<-tls_key> I<filename>|I<uri>
936 Private key for the client's TLS certificate.
938 =item B<-tls_keypass> I<arg>
940 Pass phrase source for client's private TLS key B<-tls_key>.
941 Also used for B<-tls_cert> in case it is an encrypted PKCS#12 file.
942 If not given here, the password will be prompted for if needed.
944 For more information about the format of I<arg> see
945 L<openssl-passphrase-options(1)>.
947 =item B<-tls_extra> I<filenames>|I<uris>
949 Extra certificates to provide to the TLS server during handshake.
951 =item B<-tls_trusted> I<filenames>|I<uris>
953 Trusted certificate(s) to use for validating the TLS server certificate.
954 This implies hostname validation.
956 Multiple sources may be given, separated by commas and/or whitespace
957 (where in the latter case the whole argument must be enclosed in "...").
958 Each source may contain multiple certificates.
960 The certificate verification options
961 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
962 have no effect on the certificate verification enabled via this option.
964 =item B<-tls_host> I<name>
966 Address to be checked during hostname validation.
967 This may be a DNS name or an IP address.
968 If not given it defaults to the B<-server> address.
972 =head2 Client-side options for debugging and offline scenarios
978 Do not interactively prompt for input, for instance when a password is needed.
979 This can be useful for batch processing and testing.
981 =item B<-repeat> I<number>
983 Invoke the command the given positive number of times with the same parameters.
984 Default is one invocation.
986 =item B<-reqin> I<filenames>
988 Take the sequence of CMP requests to send to the server from the given file(s)
989 rather than from the sequence of requests produced internally.
991 This option is useful for supporting offline scenarios where the certificate
992 request (or any other CMP request) is produced beforehand and sent out later.
994 This option is ignored if the B<-rspin> option is given
995 because in the latter case no requests are actually sent.
997 Note that in any case the client produces internally its sequence
998 of CMP request messages. Thus, all options required for doing this
999 (such as B<-cmd> and all options providing the required parameters)
1000 need to be given also when the B<-reqin> option is present.
1002 If the B<-reqin> option is given for a certificate request
1003 and no B<-newkey>, B<-key>, B<-oldcert>, or B<-csr> option is given,
1004 a fallback public key is taken from the request message file
1005 (if it is included in the certificate template).
1007 Hint: In case the B<-reqin> option is given for a certificate request, there are
1008 situations where the client has access to the public key to be certified but
1009 not to the private key that by default will be needed for proof of possession.
1010 In this case the POPO is not actually needed (because the internally produced
1011 certificate request message will not be sent), and its generation
1012 can be disabled using the options B<-popo> I<-1> or B<-popo> I<0>.
1014 Multiple filenames may be given, separated by commas and/or whitespace
1015 (where in the latter case the whole argument must be enclosed in "...").
1017 The files are read as far as needed to complete the transaction
1018 and filenames have been provided. If more requests are needed,
1019 the remaining ones are taken from the items at the respective position
1020 in the sequence of requests produced internally.
1022 The client needs to update the recipNonce field in the given requests (except
1023 for the first one) in order to satisfy the checks to be performed by the server.
1024 This causes re-protection (if protecting requests is required).
1026 =item B<-reqin_new_tid>
1028 Use a fresh transactionID for CMP request messages read using B<-reqin>,
1029 which causes their reprotection (if protecting requests is required).
1030 This may be needed in case the sequence of requests is reused
1031 and the CMP server complains that the transaction ID has already been used.
1033 =item B<-reqout> I<filenames>
1035 Save the sequence of CMP requests created by the client to the given file(s).
1036 These requests are not sent to the server if the B<-reqin> option is used, too.
1038 Multiple filenames may be given, separated by commas and/or whitespace.
1040 Files are written as far as needed to save the transaction
1041 and filenames have been provided.
1042 If the transaction contains more requests, the remaining ones are not saved.
1044 =item B<-reqout_only> I<filename>
1046 Save the first CMP requests created by the client to the given file and exit.
1047 Any options related to CMP servers and their reponses are ignored.
1049 This option is useful for supporting offline scenarios where the certificate
1050 request (or any other CMP request) is produced beforehand and sent out later.
1052 =item B<-rspin> I<filenames>
1054 Process the sequence of CMP responses provided in the given file(s),
1055 not contacting any given server,
1056 as long as enough filenames are provided to complete the transaction.
1058 Multiple filenames may be given, separated by commas and/or whitespace.
1060 Any server specified via the I<-server> or I<-use_mock_srv> options is contacted
1061 only if more responses are needed to complete the transaction.
1062 In this case the transaction will fail
1063 unless the server has been prepared to continue the already started transaction.
1065 =item B<-rspout> I<filenames>
1067 Save the sequence of actually used CMP responses to the given file(s).
1068 These have been received from the server unless B<-rspin> takes effect.
1070 Multiple filenames may be given, separated by commas and/or whitespace.
1072 Files are written as far as needed to save the responses
1073 contained in the transaction and filenames have been provided.
1074 If the transaction contains more responses, the remaining ones are not saved.
1076 =item B<-use_mock_srv>
1078 Test the client using the internal CMP server mock-up at API level,
1079 bypassing socket-based transfer via HTTP.
1080 This excludes the B<-server> and B<-port> options.
1084 =head2 Mock server options
1088 =item B<-port> I<number>
1090 Act as HTTP-based CMP server mock-up listening on the given local port.
1091 The client may address the server via, e.g., C<127.0.0.1> or C<[::1]>.
1092 This option excludes the B<-server> and B<-use_mock_srv> options.
1093 The B<-rspin>, B<-rspout>, B<-reqin>, and B<-reqout> options
1094 so far are not supported in this mode.
1096 =item B<-max_msgs> I<number>
1098 Maximum number of CMP (request) messages the CMP HTTP server mock-up
1099 should handle, which must be nonnegative.
1100 The default value is 0, which means that no limit is imposed.
1101 In any case the server terminates on internal errors, but not when it
1102 detects a CMP-level error that it can successfully answer with an error message.
1104 =item B<-srv_ref> I<value>
1106 Reference value to use as senderKID of server in case no B<-srv_cert> is given.
1108 =item B<-srv_secret> I<arg>
1110 Password source for server authentication with a pre-shared key (secret).
1112 =item B<-srv_cert> I<filename>|I<uri>
1114 Certificate of the server.
1116 =item B<-srv_key> I<filename>|I<uri>
1118 Private key used by the server for signing messages.
1120 =item B<-srv_keypass> I<arg>
1122 Server private key (and cert) file pass phrase source.
1124 =item B<-srv_trusted> I<filenames>|I<uris>
1126 Trusted certificates for client authentication.
1128 The certificate verification options
1129 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
1130 have no effect on the certificate verification enabled via this option.
1132 =item B<-srv_untrusted> I<filenames>|I<uris>
1134 Intermediate CA certs that may be useful when validating client certificates.
1136 =item B<-ref_cert> I<filename>|I<uri>
1138 Certificate to be expected for RR messages and any oldCertID in KUR messages.
1140 =item B<-rsp_cert> I<filename>|I<uri>
1142 Certificate to be returned as mock enrollment result.
1144 =item B<-rsp_extracerts> I<filenames>|I<uris>
1146 Extra certificates to be included in mock certification responses.
1148 =item B<-rsp_capubs> I<filenames>|I<uris>
1150 CA certificates to be included in mock Initialization Response (IP) message.
1152 =item B<-rsp_newwithnew> I<filename>|I<uri>
1154 Certificate to be returned in newWithNew field of genp of type rootCaKeyUpdate.
1156 =item B<-rsp_newwithold> I<filename>|I<uri>
1158 Certificate to be returned in newWithOld field of genp of type rootCaKeyUpdate.
1160 =item B<-rsp_oldwithnew> I<filename>|I<uri>
1162 Certificate to be returned in oldWithNew field of genp of type rootCaKeyUpdate.
1164 =item B<-poll_count> I<number>
1166 Number of times the client must poll before receiving a certificate.
1168 =item B<-check_after> I<number>
1170 The checkAfter value (number of seconds to wait) to include in poll response.
1172 =item B<-grant_implicitconf>
1174 Grant implicit confirmation of newly enrolled certificate.
1176 =item B<-pkistatus> I<number>
1178 PKIStatus to be included in server response.
1179 Valid range is 0 (accepted) .. 6 (keyUpdateWarning).
1181 =item B<-failure> I<number>
1183 A single failure info bit number to be included in server response.
1184 Valid range is 0 (badAlg) .. 26 (duplicateCertReq).
1186 =item B<-failurebits> I<number>
1187 Number representing failure bits to be included in server response.
1188 Valid range is 0 .. 2^27 - 1.
1190 =item B<-statusstring> I<arg>
1192 Text to be included as status string in server response.
1194 =item B<-send_error>
1196 Force server to reply with error message.
1198 =item B<-send_unprotected>
1200 Send response messages without CMP-level protection.
1202 =item B<-send_unprot_err>
1204 In case of negative responses, server shall send unprotected error messages,
1205 certificate responses (IP/CP/KUP), and revocation responses (RP).
1206 WARNING: This setting leads to behavior violating RFC 4210.
1208 =item B<-accept_unprotected>
1210 Accept missing or invalid protection of requests.
1212 =item B<-accept_unprot_err>
1214 Accept unprotected error messages from client.
1215 So far this has no effect because the server does not accept any error messages.
1217 =item B<-accept_raverified>
1219 Accept RAVERIFED as proof of possession (POPO).
1223 =head2 Certificate verification options, for both CMP and TLS
1227 {- $OpenSSL::safe::opt_v_item -}
1229 The certificate verification options
1230 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
1231 only affect the certificate verification enabled via the B<-out_trusted> option.
1237 When a client obtains, from a CMP server, CA certificates that it is going to
1238 trust, for instance via the C<caPubs> field of a certificate response
1239 or using general messages with infoType C<caCerts> or C<rootCaCert>,
1240 authentication of the CMP server is particularly critical.
1241 So special care must be taken setting up server authentication
1242 using B<-trusted> and related options for certificate-based authentication
1243 or B<-secret> for MAC-based protection.
1244 If authentication is certificate-based, the B<-srvcertout> option
1245 should be used to obtain the validated server certificate
1246 and perform an authorization check based on it.
1248 When setting up CMP configurations and experimenting with enrollment options
1249 typically various errors occur until the configuration is correct and complete.
1250 When the CMP server reports an error the client will by default
1251 check the protection of the CMP response message.
1252 Yet some CMP services tend not to protect negative responses.
1253 In this case the client will reject them, and thus their contents are not shown
1254 although they usually contain hints that would be helpful for diagnostics.
1255 For assisting in such cases the CMP client offers a workaround via the
1256 B<-unprotected_errors> option, which allows accepting such negative messages.
1258 If OpenSSL was built with trace support enabled (e.g., C<./config enable-trace>)
1259 and the environment variable B<OPENSSL_TRACE> includes B<HTTP>,
1260 the requests and the response headers transferred via HTTP are printed.
1264 =head2 Simple examples using the default OpenSSL configuration file
1266 This CMP client implementation comes with demonstrative CMP sections
1267 in the example configuration file F<openssl/apps/openssl.cnf>,
1268 which can be used to interact conveniently with the Insta Demo CA.
1270 In order to enroll an initial certificate from that CA it is sufficient
1271 to issue the following shell commands.
1273 export OPENSSL_CONF=/path/to/openssl/apps/openssl.cnf
1277 wget 'http://pki.certificate.fi:8081/install-ca-cert.html/ca-certificate.crt\
1278 ?ca-id=632&download-certificate=1' -O insta.ca.crt
1282 openssl genrsa -out insta.priv.pem
1283 openssl cmp -section insta
1285 This should produce the file F<insta.cert.pem> containing a new certificate
1286 for the private key held in F<insta.priv.pem>.
1287 It can be viewed using, e.g.,
1289 openssl x509 -noout -text -in insta.cert.pem
1291 In case the network setup requires using an HTTP proxy it may be given as usual
1292 via the environment variable B<http_proxy> or via the B<-proxy> option in the
1293 configuration file or the CMP command-line argument B<-proxy>, for example
1295 -proxy http://192.168.1.1:8080
1297 In the Insta Demo CA scenario both clients and the server may use the pre-shared
1298 secret I<insta> and the reference value I<3078> to authenticate to each other.
1300 Alternatively, CMP messages may be protected in signature-based manner,
1301 where the trust anchor in this case is F<insta.ca.crt>
1302 and the client may use any certificate already obtained from that CA,
1303 as specified in the B<[signature]> section of the example configuration.
1304 This can be used in combination with the B<[insta]> section simply by
1306 openssl cmp -section insta,signature
1308 By default the CMP IR message type is used, yet CR works equally here.
1309 This may be specified directly at the command line:
1311 openssl cmp -section insta -cmd cr
1313 or by referencing in addition the B<[cr]> section of the example configuration:
1315 openssl cmp -section insta,cr
1317 In order to update the enrolled certificate one may call
1319 openssl cmp -section insta,kur
1321 using MAC-based protection with PBM or
1323 openssl cmp -section insta,kur,signature
1325 using signature-based protection.
1327 In a similar way any previously enrolled certificate may be revoked by
1329 openssl cmp -section insta,rr -trusted insta.ca.crt
1333 openssl cmp -section insta,rr,signature
1335 Many more options can be given in the configuration file
1336 and/or on the command line.
1337 For instance, the B<-reqexts> CLI option may refer to a section in the
1338 configuration file defining X.509 extensions to use in certificate requests,
1339 such as C<v3_req> in F<openssl/apps/openssl.cnf>:
1341 openssl cmp -section insta,cr -reqexts v3_req
1343 =head2 Certificate enrollment
1345 The following examples do not make use of a configuration file at first.
1346 They assume that a CMP server can be contacted on the local TCP port 80
1347 and accepts requests under the alias I</pkix/>.
1349 For enrolling its very first certificate the client generates a client key
1350 and sends an initial request message to the local CMP server
1351 using a pre-shared secret key for mutual authentication.
1352 In this example the client does not have the CA certificate yet,
1353 so we specify the name of the CA with the B<-recipient> option
1354 and save any CA certificates that we may receive in the C<capubs.pem> file.
1356 In below command line usage examples the C<\> at line ends is used just
1357 for formatting; each of the command invocations should be on a single line.
1359 openssl genrsa -out cl_key.pem
1360 openssl cmp -cmd ir -server 127.0.0.1:80/pkix/ -recipient "/CN=CMPserver" \
1361 -ref 1234 -secret pass:1234-5678 \
1362 -newkey cl_key.pem -subject "/CN=MyName" \
1363 -cacertsout capubs.pem -certout cl_cert.pem
1365 =head2 Certificate update
1367 Then, when the client certificate and its related key pair needs to be updated,
1368 the client can send a key update request taking the certs in C<capubs.pem>
1369 as trusted for authenticating the server and using the previous cert and key
1370 for its own authentication.
1371 Then it can start using the new cert and key.
1373 openssl genrsa -out cl_key_new.pem
1374 openssl cmp -cmd kur -server 127.0.0.1:80/pkix/ \
1375 -trusted capubs.pem \
1376 -cert cl_cert.pem -key cl_key.pem \
1377 -newkey cl_key_new.pem -certout cl_cert.pem
1378 cp cl_key_new.pem cl_key.pem
1380 This command sequence can be repeated as often as needed.
1382 =head2 Requesting information from CMP server
1384 Requesting "all relevant information" with an empty General Message.
1385 This prints information about all received ITAV B<infoType>s to stdout.
1387 openssl cmp -cmd genm -server 127.0.0.1/pkix/ -recipient "/CN=CMPserver" \
1388 -ref 1234 -secret pass:1234-5678
1390 =head2 Using a custom configuration file
1392 For CMP client invocations, in particular for certificate enrollment,
1393 usually many parameters need to be set, which is tedious and error-prone to do
1394 on the command line.
1395 Therefore, the client offers the possibility to read
1396 options from sections of the OpenSSL config file, usually called F<openssl.cnf>.
1397 The values found there can still be extended and even overridden by any
1398 subsequently loaded sections and on the command line.
1400 After including in the configuration file the following sections:
1405 trusted = capubs.pem
1409 certout = cl_cert.pem
1412 recipient = "/CN=CMPserver"
1417 secret = pass:1234-5678-1234-567
1418 subject = "/CN=MyName"
1419 cacertsout = capubs.pem
1421 the above enrollment transactions reduce to
1423 openssl cmp -section cmp,init
1424 openssl cmp -cmd kur -newkey cl_key_new.pem
1426 and the above transaction using a general message reduces to
1428 openssl cmp -section cmp,init -cmd genm
1432 L<openssl-genrsa(1)>, L<openssl-ecparam(1)>, L<openssl-list(1)>,
1433 L<openssl-req(1)>, L<openssl-x509(1)>, L<x509v3_config(5)>
1437 The B<cmp> application was added in OpenSSL 3.0.
1439 The B<-engine> option was deprecated in OpenSSL 3.0.
1441 The B<-profile> option was added in OpenSSL 3.3.
1445 Copyright 2007-2023 The OpenSSL Project Authors. All Rights Reserved.
1447 Licensed under the Apache License 2.0 (the "License"). You may not use
1448 this file except in compliance with the License. You can obtain a copy
1449 in the file LICENSE in the source distribution or at
1450 L<https://www.openssl.org/source/license.html>.