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>]
20 [B<-geninfo> I<OID:int:N>]
22 Certificate enrollment options:
24 [B<-newkey> I<filename>|I<uri>]
25 [B<-newkeypass> I<arg>]
31 [B<-policies> I<name>]
32 [B<-policy_oids> I<names>]
33 [B<-policy_oids_critical>]
36 [B<-out_trusted> I<filenames>|I<uris>]
37 [B<-implicit_confirm>]
39 [B<-certout> I<filename>]
40 [B<-chainout> I<filename>]
42 Certificate enrollment and revocation options:
44 [B<-oldcert> I<filename>|I<uri>]
46 [B<-serial> I<number>]
47 [B<-revreason> I<number>]
49 Message transfer options:
51 [B<-server> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>]
52 [B<-proxy> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>]
53 [B<-no_proxy> I<addresses>]
54 [B<-recipient> I<name>]
55 [B<-path> I<remote_path>]
56 [B<-keep_alive> I<value>]
57 [B<-msg_timeout> I<seconds>]
58 [B<-total_timeout> I<seconds>]
60 Server authentication options:
62 [B<-trusted> I<filenames>|I<uris>]
63 [B<-untrusted> I<filenames>|I<uris>]
64 [B<-srvcert> I<filename>|I<uri>]
65 [B<-expect_sender> I<name>]
67 [B<-unprotected_errors>]
68 [B<-srvcertout> I<filename>]
69 [B<-extracertsout> I<filename>]
70 [B<-cacertsout> I<filename>]
71 [B<-oldwithold> I<filename>]
72 [B<-newwithnew> I<filename>]
73 [B<-newwithold> I<filename>]
74 [B<-oldwithnew> I<filename>]
76 Client authentication and protection options:
80 [B<-cert> I<filename>|I<uri>]
81 [B<-own_trusted> I<filenames>|I<uris>]
82 [B<-key> I<filename>|I<uri>]
86 [B<-extracerts> I<filenames>|I<uris>]
87 [B<-unprotected_requests>]
89 Credentials format options:
91 [B<-certform> I<PEM|DER>]
92 [B<-keyform> I<PEM|DER|P12|ENGINE>]
93 [B<-otherpass> I<arg>]
94 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
98 {- $OpenSSL::safe::opt_r_synopsis -}
100 TLS connection options:
103 [B<-tls_cert> I<filename>|I<uri>]
104 [B<-tls_key> I<filename>|I<uri>]
105 [B<-tls_keypass> I<arg>]
106 [B<-tls_extra> I<filenames>|I<uris>]
107 [B<-tls_trusted> I<filenames>|I<uris>]
108 [B<-tls_host> I<name>]
110 Client-side debugging options:
113 [B<-repeat> I<number>]
114 [B<-reqin> I<filenames>]
116 [B<-reqout> I<filenames>]
117 [B<-rspin> I<filenames>]
118 [B<-rspout> I<filenames>]
124 [B<-max_msgs> I<number>]
125 [B<-srv_ref> I<value>]
126 [B<-srv_secret> I<arg>]
127 [B<-srv_cert> I<filename>|I<uri>]
128 [B<-srv_key> I<filename>|I<uri>]
129 [B<-srv_keypass> I<arg>]
130 [B<-srv_trusted> I<filenames>|I<uris>]
131 [B<-srv_untrusted> I<filenames>|I<uris>]
132 [B<-ref_cert> I<filename>|I<uri>]
133 [B<-rsp_cert> I<filename>|I<uri>]
134 [B<-rsp_extracerts> I<filenames>|I<uris>]
135 [B<-rsp_capubs> I<filenames>|I<uris>]
136 [B<-rsp_newwithnew> I<filename>|I<uri>]
137 [B<-rsp_newwithold> I<filename>|I<uri>]
138 [B<-rsp_oldwithnew> I<filename>|I<uri>]
139 [B<-poll_count> I<number>]
140 [B<-check_after> I<number>]
141 [B<-grant_implicitconf>]
142 [B<-pkistatus> I<number>]
143 [B<-failure> I<number>]
144 [B<-failurebits> I<number>]
145 [B<-statusstring> I<arg>]
147 [B<-send_unprotected>]
148 [B<-send_unprot_err>]
149 [B<-accept_unprotected>]
150 [B<-accept_unprot_err>]
151 [B<-accept_raverified>]
153 Certificate verification options, for both CMP and TLS:
155 {- $OpenSSL::safe::opt_v_synopsis -}
159 The B<cmp> command is a client implementation for the Certificate
160 Management Protocol (CMP) as defined in RFC4210.
161 It can be used to request certificates from a CA server,
162 update their certificates,
163 request certificates to be revoked, and perform other types of CMP requests.
171 Display a summary of all options
173 =item B<-config> I<filename>
175 Configuration file to use.
176 An empty string C<""> means none.
177 Default filename is from the environment variable C<OPENSSL_CONF>.
179 =item B<-section> I<names>
181 Section(s) to use within config file defining CMP options.
182 An empty string C<""> means no specific section.
185 Multiple section names may be given, separated by commas and/or whitespace
186 (where in the latter case the whole argument must be enclosed in "...").
187 Contents of sections named later may override contents of sections named before.
188 In any case, as usual, the C<[default]> section and finally the unnamed
189 section (as far as present) can provide per-option fallback values.
191 =item B<-verbosity> I<level>
193 Level of verbosity for logging, error output, etc.
194 0 = EMERG, 1 = ALERT, 2 = CRIT, 3 = ERR, 4 = WARN, 5 = NOTE,
195 6 = INFO, 7 = DEBUG, 8 = TRACE.
196 Defaults to 6 = INFO.
200 =head2 Generic message options
204 =item B<-cmd> I<ir|cr|kur|p10cr|rr|genm>
206 CMP command to execute.
207 Currently implemented commands are:
211 =item ir E<nbsp> - Initialization Request
213 =item cr E<nbsp> - Certificate Request
215 =item p10cr - PKCS#10 Certification Request (for legacy support)
217 =item kur E<nbsp>E<nbsp>- Key Update Request
219 =item rr E<nbsp> - Revocation Request
221 =item genm - General Message
225 B<ir> requests initialization of an end entity into a PKI hierarchy
226 by issuing a first certificate.
228 B<cr> requests issuing an additional certificate for an end entity already
229 initialized to the PKI hierarchy.
231 B<p10cr> requests issuing an additional certificate similarly to B<cr>
232 but using legacy PKCS#10 CSR format.
234 B<kur> requests a (key) update for an existing certificate.
236 B<rr> requests revocation of an existing certificate.
238 B<genm> requests information using a General Message, where optionally
239 included B<InfoTypeAndValue>s may be used to state which info is of interest.
240 Upon receipt of the General Response, information about all received
241 ITAV B<infoType>s is printed to stdout.
243 =item B<-infotype> I<name>
245 Set InfoType name to use for requesting specific info in B<genm>,
246 e.g., C<signKeyPairTypes>.
247 So far, there is specific support for C<caCerts> and C<rootCaCert>.
249 =item B<-geninfo> I<OID:int:N>
251 generalInfo integer values to place in request PKIHeader with given OID,
252 e.g., C<1.2.3.4:int:56789>.
256 =head2 Certificate enrollment options
260 =item B<-newkey> I<filename>|I<uri>
262 The source of the private or public key for the certificate being requested.
263 Defaults to the public key in the PKCS#10 CSR given with the B<-csr> option,
264 the public key of the reference certificate, or the current client key.
266 The public portion of the key is placed in the certification request.
268 Unless B<-cmd> I<p10cr>, B<-popo> I<-1>, or B<-popo> I<0> is given, the
269 private key will be needed as well to provide the proof of possession (POPO),
270 where the B<-key> option may provide a fallback.
272 =item B<-newkeypass> I<arg>
274 Pass phrase source for the key given with the B<-newkey> option.
275 If not given here, the password will be prompted for if needed.
277 For more information about the format of I<arg> see
278 L<openssl-passphrase-options(1)>.
280 =item B<-subject> I<name>
282 X.509 Distinguished Name (DN) to use as subject field
283 in the requested certificate template in IR/CR/KUR messages.
284 If the NULL-DN (C</>) is given then no subject is placed in the template.
285 Default is the subject DN of any PKCS#10 CSR given with the B<-csr> option.
286 For KUR, a further fallback is the subject DN
287 of the reference certificate (see B<-oldcert>) if provided.
288 This fallback is used for IR and CR only if no SANs are set.
290 If provided and neither of B<-cert>, B<-oldcert>, or B<-csr> is given,
291 the subject DN is used as fallback sender of outgoing CMP messages.
293 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
294 Special characters may be escaped by C<\> (backslash); whitespace is retained.
295 Empty values are permitted, but the corresponding type will not be included.
296 Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
297 Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
298 between the AttributeValueAssertions (AVAs) that specify the members of the set.
301 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
303 =item B<-days> I<number>
305 Number of days the new certificate is requested to be valid for, counting from
306 the current time of the host.
307 Also triggers the explicit request that the
308 validity period starts from the current time (as seen by the host).
310 =item B<-reqexts> I<name>
312 Name of section in OpenSSL config file defining certificate request extensions.
313 If the B<-csr> option is present, these extensions augment the extensions
314 contained the given PKCS#10 CSR, overriding any extensions with same OIDs.
316 =item B<-sans> I<spec>
318 One or more IP addresses, email addresses, DNS names, or URIs
319 separated by commas or whitespace
320 (where in the latter case the whole argument must be enclosed in "...")
321 to add as Subject Alternative Name(s) (SAN) certificate request extension.
322 If the special element "critical" is given the SANs are flagged as critical.
323 Cannot be used if any Subject Alternative Name extension is set via B<-reqexts>.
325 =item B<-san_nodefault>
327 When Subject Alternative Names are not given via B<-sans>
328 nor defined via B<-reqexts>,
329 they are copied by default from the reference certificate (see B<-oldcert>).
330 This can be disabled by giving the B<-san_nodefault> option.
332 =item B<-policies> I<name>
334 Name of section in OpenSSL config file defining policies to be set
335 as certificate request extension.
336 This option cannot be used together with B<-policy_oids>.
338 =item B<-policy_oids> I<names>
340 One or more OID(s), separated by commas and/or whitespace
341 (where in the latter case the whole argument must be enclosed in "...")
342 to add as certificate policies request extension.
343 This option cannot be used together with B<-policies>.
345 =item B<-policy_oids_critical>
347 Flag the policies given with B<-policy_oids> as critical.
349 =item B<-popo> I<number>
351 Proof-of-possession (POPO) method to use for IR/CR/KUR; values: C<-1>..<2> where
352 C<-1> = NONE, C<0> = RAVERIFIED, C<1> = SIGNATURE (default), C<2> = KEYENC.
354 Note that a signature-based POPO can only be produced if a private key
355 is provided via the B<-newkey> or B<-key> options.
357 =item B<-csr> I<filename>
359 PKCS#10 CSR in PEM or DER format containing a certificate request.
360 With B<-cmd> I<p10cr> it is used directly in a legacy P10CR message.
362 When used with B<-cmd> I<ir>, I<cr>, or I<kur>,
363 it is transformed into the respective regular CMP request.
364 In this case, a private key must be provided (with B<-newkey> or B<-key>)
365 for the proof of possession (unless B<-popo> I<-1> or B<-popo> I<0> is used)
366 and the respective public key is placed in the certification request
367 (rather than taking over the public key contained in the PKCS#10 CSR).
369 PKCS#10 CSR input may also be used with B<-cmd> I<rr>
370 to specify the certificate to be revoked
371 via the included subject name and public key.
372 Its subject is used as fallback sender in CMP message headers
373 if B<-cert> and B<-oldcert> are not given.
375 =item B<-out_trusted> I<filenames>|I<uris>
377 Trusted certificate(s) to use for validating the newly enrolled certificate.
378 During this verification, any certificate status checking is disabled.
380 Multiple sources may be given, separated by commas and/or whitespace
381 (where in the latter case the whole argument must be enclosed in "...").
382 Each source may contain multiple certificates.
384 The certificate verification options
385 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
386 only affect the certificate verification enabled via this option.
388 =item B<-implicit_confirm>
390 Request implicit confirmation of newly enrolled certificates.
392 =item B<-disable_confirm>
394 Do not send certificate confirmation message for newly enrolled certificate
395 without requesting implicit confirmation
396 to cope with broken servers not supporting implicit confirmation correctly.
397 B<WARNING:> This leads to behavior violating RFC 4210.
399 =item B<-certout> I<filename>
401 The file where any newly enrolled certificate should be saved.
403 =item B<-chainout> I<filename>
405 The file where the chain of any newly enrolled certificate should be saved.
409 =head2 Certificate enrollment and revocation options
413 =item B<-oldcert> I<filename>|I<uri>
415 The certificate to be updated (i.e., renewed or re-keyed) in Key Update Request
416 (KUR) messages or to be revoked in Revocation Request (RR) messages.
417 For KUR the certificate to be updated defaults to B<-cert>,
418 and the resulting certificate is called I<reference certificate>.
419 For RR the certificate to be revoked can also be specified using B<-csr>.
420 B<-oldcert> and B<-csr> is ignored if B<-issuer> and B<-serial> is provided.
422 The reference certificate, if any, is also used for
423 deriving default subject DN and Subject Alternative Names and the
424 default issuer entry in the requested certificate template of an IR/CR/KUR.
425 Its public key is used as a fallback in the template of certification requests.
426 Its subject is used as sender of outgoing messages if B<-cert> is not given.
427 Its issuer is used as default recipient in CMP message headers
428 if neither B<-recipient>, B<-srvcert>, nor B<-issuer> is given.
430 =item B<-issuer> I<name>
432 X.509 Distinguished Name (DN) use as issuer field
433 in the requested certificate template in IR/CR/KUR/RR messages.
434 If the NULL-DN (C</>) is given then no issuer is placed in the template.
436 If provided and neither B<-recipient> nor B<-srvcert> is given,
437 the issuer DN is used as fallback recipient of outgoing CMP messages.
439 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
440 For details see the description of the B<-subject> option.
442 =item B<-serial> I<number>
444 Specify the Serial number of certificate to be revoked in revocation request.
445 The serial number can be decimal or hex (if preceded by C<0x>)
447 =item B<-revreason> I<number>
449 Set CRLReason to be included in revocation request (RR); values: C<0>..C<10>
450 or C<-1> for none (which is the default).
452 Reason numbers defined in RFC 5280 are:
454 CRLReason ::= ENUMERATED {
458 affiliationChanged (3),
460 cessationOfOperation (5),
462 -- value 7 is not used
464 privilegeWithdrawn (9),
470 =head2 Message transfer options
474 =item B<-server> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>
476 The I<host> domain name or IP address and optionally I<port>
477 of the CMP server to connect to using HTTP(S).
478 IP address may be for v4 or v6, such as C<127.0.0.1> or C<[::]> for localhost.
480 This option excludes I<-port> and I<-use_mock_srv>.
481 It is ignored if I<-rspin> is given with enough filename arguments.
483 The scheme C<https> may be given only if the B<-tls_used> option is provided.
484 In this case the default port is 443, else 80.
485 The optional userinfo and fragment components are ignored.
486 Any given query component is handled as part of the path component.
487 If a path is included it provides the default value for the B<-path> option.
489 =item B<-proxy> I<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>
491 The HTTP(S) proxy server to use for reaching the CMP server unless B<-no_proxy>
493 The proxy port defaults to 80 or 443 if the scheme is C<https>; apart from that
494 the optional C<http://> or C<https://> prefix is ignored (note that TLS may be
495 enabled by B<-tls_used>), as well as any path, userinfo, and query, and fragment
497 Defaults to the environment variable C<http_proxy> if set, else C<HTTP_PROXY>
498 in case no TLS is used, otherwise C<https_proxy> if set, else C<HTTPS_PROXY>.
499 This option is ignored if I<-server> is not given.
501 =item B<-no_proxy> I<addresses>
503 List of IP addresses and/or DNS names of servers
504 not to use an HTTP(S) proxy for, separated by commas and/or whitespace
505 (where in the latter case the whole argument must be enclosed in "...").
506 Default is from the environment variable C<no_proxy> if set, else C<NO_PROXY>.
507 This option is ignored if I<-server> is not given.
509 =item B<-recipient> I<name>
511 Distinguished Name (DN) to use in the recipient field of CMP request message
512 headers, i.e., the CMP server (usually the addressed CA).
514 The recipient field in the header of a CMP message is mandatory.
515 If not given explicitly the recipient is determined in the following order:
516 the subject of the CMP server certificate given with the B<-srvcert> option,
517 the B<-issuer> option,
518 the issuer of the certificate given with the B<-oldcert> option,
519 the issuer of the CMP client certificate (B<-cert> option),
520 as far as any of those is present, else the NULL-DN as last resort.
522 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
523 For details see the description of the B<-subject> option.
525 =item B<-path> I<remote_path>
527 HTTP path at the CMP server (aka CMP alias) to use for POST requests.
528 Defaults to any path given with B<-server>, else C<"/">.
530 =item B<-keep_alive> I<value>
532 If the given value is 0 then HTTP connections are closed after each response
533 (which would be the default behavior of HTTP 1.0)
534 even if a CMP transaction needs more than one round trip.
535 If the value is 1 or 2
536 then for each transaction a persistent connection is requested.
537 If the value is 2 then a persistent connection is required,
538 i.e., an error occurs if the server does not grant it.
539 The default value is 1, which means preferring to keep the connection open.
541 =item B<-msg_timeout> I<seconds>
543 Number of seconds a CMP request-response message round trip
544 is allowed to take before a timeout error is returned.
545 A value <= 0 means no limitation (waiting indefinitely).
546 Default is to use the B<-total_timeout> setting.
548 =item B<-total_timeout> I<seconds>
550 Maximum total number of seconds a transaction may take,
551 including polling etc.
552 A value <= 0 means no limitation (waiting indefinitely).
557 =head2 Server authentication options
561 =item B<-trusted> I<filenames>|I<uris>
563 The certificate(s), typically of root CAs, the client shall use as trust anchors
564 when validating signature-based protection of CMP response messages.
565 This option is ignored if the B<-srvcert> option is given as well.
566 It provides more flexibility than B<-srvcert> because the CMP protection
567 certificate of the server is not pinned but may be any certificate
568 from which a chain to one of the given trust anchors can be constructed.
570 If none of B<-trusted>, B<-srvcert>, and B<-secret> is given, message validation
571 errors will be thrown unless B<-unprotected_errors> permits an exception.
573 Multiple sources may be given, separated by commas and/or whitespace
574 (where in the latter case the whole argument must be enclosed in "...").
575 Each source may contain multiple certificates.
577 The certificate verification options
578 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
579 have no effect on the certificate verification enabled via this option.
581 =item B<-untrusted> I<filenames>|I<uris>
583 Non-trusted intermediate CA certificate(s).
584 Any extra certificates given with the B<-cert> option are appended to it.
585 All these certificates may be useful for cert path construction
586 for the own CMP signer certificate (to include in the extraCerts field of
587 request messages) and for the TLS client certificate (if TLS is enabled)
588 as well as for chain building
589 when validating server certificates (checking signature-based
590 CMP message protection) and when validating newly enrolled certificates.
592 Multiple sources may be given, separated by commas and/or whitespace
593 (where in the latter case the whole argument must be enclosed in "...").
594 Each source may contain multiple certificates.
596 =item B<-srvcert> I<filename>|I<uri>
598 The specific CMP server certificate to expect and directly trust (even if it is
599 expired) when verifying signature-based protection of CMP response messages.
600 This pins the accepted server and results in ignoring the B<-trusted> option.
602 If set, the subject of the certificate is also used
603 as default value for the recipient of CMP requests
604 and as default value for the expected sender of CMP responses.
606 =item B<-expect_sender> I<name>
608 Distinguished Name (DN) expected in the sender field of incoming CMP messages.
609 Defaults to the subject DN of the pinned B<-srvcert>, if any.
611 This can be used to make sure that only a particular entity is accepted as
612 CMP message signer, and attackers are not able to use arbitrary certificates
613 of a trusted PKI hierarchy to fraudulently pose as a CMP server.
614 Note that this option gives slightly more freedom than setting the B<-srvcert>,
615 which pins the server to the holder of a particular certificate, while the
616 expected sender name will continue to match after updates of the server cert.
618 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
619 For details see the description of the B<-subject> option.
621 =item B<-ignore_keyusage>
623 Ignore key usage restrictions in CMP signer certificates when validating
624 signature-based protection of incoming CMP messages.
625 By default, C<digitalSignature> must be allowed by CMP signer certificates.
627 =item B<-unprotected_errors>
629 Accept missing or invalid protection of negative responses from the server.
630 This applies to the following message types and contents:
634 =item * error messages
636 =item * negative certificate responses (IP/CP/KUP)
638 =item * negative revocation responses (RP)
640 =item * negative PKIConf messages
644 B<WARNING:> This setting leads to unspecified behavior and it is meant
645 exclusively to allow interoperability with server implementations violating
650 =item * section 5.1.3.1 allows exceptions from protecting only for special
652 "There MAY be cases in which the PKIProtection BIT STRING is deliberately not
653 used to protect a message [...] because other protection, external to PKIX, will
656 =item * section 5.3.21 is clear on ErrMsgContent: "The CA MUST always sign it
657 with a signature key."
659 =item * appendix D.4 shows PKIConf message having protection
663 =item B<-srvcertout> I<filename>
665 The file where to save the successfully validated certificate, if any,
666 that the CMP server used for signature-based response message protection.
667 If there is no such certificate, typically because the protection was MAC-based,
668 this is indicated by deleting the file (if it existed).
670 =item B<-extracertsout> I<filename>
672 The file where to save the list of certificates contained in the extraCerts
673 field of the last received response message that is not a pollRep nor PKIConf.
675 =item B<-cacertsout> I<filename>
677 The file where to save the list of CA certificates contained in the caPubs field
678 if a positive certificate response (i.e., IP, CP, or KUP) message was received
679 or contained in a general response (genp) message with infoType C<caCerts>.
681 =item B<-oldwithold> I<filename>
683 The root CA certificate to include in a genm request of infoType C<rootCaCert>.
684 If present and the optional oldWithNew certificate is received,
685 it is verified using the newWithNew certificate as the (only) trust anchor.
687 =item B<-newwithnew> I<filename>
689 This option must be provided when B<-infotype> I<rootCaCert> is given.
690 It specifies the file to save the newWithNew certificate
691 received in a genp message of type C<rootCaKeyUpdate>.
692 If on success no such cert was received, this file (if present) is deleted
693 to indicate that the requested root CA certificate update is not available.
695 Any received newWithNew certificate is verified
696 using any received newWithOld certificate as untrusted intermediate certificate
697 and the certificate provided with B<-oldwithold> as the (only) trust anchor,
698 or if not provided, using the certificates given with the B<-trusted> option.
701 The newWithNew certificate is meant to be a certificate that will be trusted.
702 The trust placed in it cannot be stronger than the trust placed in
703 the B<-oldwithold> certificate if present, otherwise it cannot be stronger than
704 the weakest trust placed in any of the B<-trusted> certificates.
706 =item B<-newwithold> I<filename>
708 The file to save any newWithOld certificate
709 received in a genp message of infoType C<rootCaKeyUpdate>.
710 If on success no such cert was received, this is indicated by deleting the file.
712 =item B<-oldwithnew> I<filename>
714 The file to save any oldWithNew certificate
715 received in a genp message of infoType C<rootCaKeyUpdate>.
716 If on success no such cert was received, this is indicated by deleting the file.
720 =head2 Client authentication options
724 =item B<-ref> I<value>
726 Reference number/string/value to use as fallback senderKID; this is required
727 if no sender name can be determined from the B<-cert> or <-subject> options and
728 is typically used when authenticating with pre-shared key (password-based MAC).
730 =item B<-secret> I<arg>
732 Provides the source of a secret value to use with MAC-based message protection.
733 This takes precedence over the B<-cert> and B<-key> options.
734 The secret is used for creating MAC-based protection of outgoing messages
735 and for validating incoming messages that have MAC-based protection.
736 The algorithm used by default is Password-Based Message Authentication Code (PBM)
737 as defined in RFC 4210 section 5.1.3.1.
739 For more information about the format of I<arg> see
740 L<openssl-passphrase-options(1)>.
742 =item B<-cert> I<filename>|I<uri>
744 The client's current CMP signer certificate.
745 Requires the corresponding key to be given with B<-key>.
747 The subject and the public key contained in this certificate
748 serve as fallback values in the certificate template of IR/CR/KUR messages.
750 The subject of this certificate will be used as sender of outgoing CMP messages,
751 while the subject of B<-oldcert> or B<-subjectName> may provide fallback values.
753 The issuer of this certificate is used as one of the recipient fallback values
754 and as fallback issuer entry in the certificate template of IR/CR/KUR messages.
756 When performing signature-based message protection,
757 this "protection certificate", also called "signer certificate",
758 will be included first in the extraCerts field of outgoing messages
759 and the signature is done with the corresponding key.
760 In Initialization Request (IR) messages this can be used for authenticating
761 using an external entity certificate as defined in appendix E.7 of RFC 4210.
763 For Key Update Request (KUR) messages this is also used as
764 the certificate to be updated if the B<-oldcert> option is not given.
766 If the file includes further certs, they are appended to the untrusted certs
767 because they typically constitute the chain of the client certificate, which
768 is included in the extraCerts field in signature-protected request messages.
770 =item B<-own_trusted> I<filenames>|I<uris>
772 If this list of certificates is provided then the chain built for
773 the client-side CMP signer certificate given with the B<-cert> option
774 is verified using the given certificates as trust anchors.
776 Multiple sources may be given, separated by commas and/or whitespace
777 (where in the latter case the whole argument must be enclosed in "...").
778 Each source may contain multiple certificates.
780 The certificate verification options
781 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
782 have no effect on the certificate verification enabled via this option.
784 =item B<-key> I<filename>|I<uri>
786 The corresponding private key file for the client's current certificate given in
788 This will be used for signature-based message protection unless the B<-secret>
789 option indicating MAC-based protection or B<-unprotected_requests> is given.
791 It is also used as a fallback for the B<-newkey> option with IR/CR/KUR messages.
793 =item B<-keypass> I<arg>
795 Pass phrase source for the private key given with the B<-key> option.
796 Also used for B<-cert> and B<-oldcert> in case it is an encrypted PKCS#12 file.
797 If not given here, the password will be prompted for if needed.
799 For more information about the format of I<arg> see
800 L<openssl-passphrase-options(1)>.
802 =item B<-digest> I<name>
804 Specifies name of supported digest to use in RFC 4210's MSG_SIG_ALG
805 and as the one-way function (OWF) in C<MSG_MAC_ALG>.
806 If applicable, this is used for message protection and
807 proof-of-possession (POPO) signatures.
808 To see the list of supported digests, use C<openssl list -digest-commands>.
809 Defaults to C<sha256>.
811 =item B<-mac> I<name>
813 Specifies the name of the MAC algorithm in C<MSG_MAC_ALG>.
814 To get the names of supported MAC algorithms use C<openssl list -mac-algorithms>
815 and possibly combine such a name with the name of a supported digest algorithm,
816 e.g., hmacWithSHA256.
817 Defaults to C<hmac-sha1> as per RFC 4210.
819 =item B<-extracerts> I<filenames>|I<uris>
821 Certificates to append in the extraCerts field when sending messages.
822 They can be used as the default CMP signer certificate chain to include.
824 Multiple sources may be given, separated by commas and/or whitespace
825 (where in the latter case the whole argument must be enclosed in "...").
826 Each source may contain multiple certificates.
828 =item B<-unprotected_requests>
830 Send request messages without CMP-level protection.
834 =head2 Credentials format options
838 =item B<-certform> I<PEM|DER>
840 File format to use when saving a certificate to a file.
841 Default value is PEM.
843 =item B<-keyform> I<PEM|DER|P12|ENGINE>
845 The format of the key input; unspecified by default.
846 See L<openssl(1)/Format Options> for details.
848 =item B<-otherpass> I<arg>
850 Pass phrase source for certificate given with the B<-trusted>, B<-untrusted>,
851 B<-own_trusted>, B<-srvcert>, B<-out_trusted>, B<-extracerts>,
852 B<-srv_trusted>, B<-srv_untrusted>, B<-ref_cert>, B<-rsp_cert>,
853 B<-rsp_extracerts>, B<-rsp_capubs>,
854 B<-rsp_newwithnew>, B<-rsp_newwithold>, B<-rsp_oldwithnew>,
855 B<-tls_extra>, and B<-tls_trusted> options.
856 If not given here, the password will be prompted for if needed.
858 For more information about the format of I<arg> see
859 L<openssl-passphrase-options(1)>.
861 {- $OpenSSL::safe::opt_engine_item -}
863 {- output_off() if $disabled{"deprecated-3.0"}; "" -}
864 As an alternative to using this combination:
866 -engine {engineid} -key {keyid} -keyform ENGINE
868 ... it's also possible to just give the key ID in URI form to B<-key>,
871 -key org.openssl.engine:{engineid}:{keyid}
873 This applies to all options specifying keys: B<-key>, B<-newkey>, and
875 {- output_on() if $disabled{"deprecated-3.0"}; "" -}
879 =head2 Provider options
883 {- $OpenSSL::safe::opt_provider_item -}
887 =head2 Random state options
891 {- $OpenSSL::safe::opt_r_item -}
895 =head2 TLS connection options
901 Enable using TLS (even when other TLS-related options are not set)
902 for message exchange with CMP server via HTTP.
903 This option is not supported with the I<-port> option.
904 It is ignored if the I<-server> option is not given or I<-use_mock_srv> is given
905 or I<-rspin> is given with enough filename arguments.
907 The following TLS-related options are ignored
908 if B<-tls_used> is not given or does not take effect.
910 =item B<-tls_cert> I<filename>|I<uri>
912 Client's TLS certificate to use for authenticating to the TLS server.
913 If the source includes further certs they are used (along with B<-untrusted>
914 certs) for constructing the client cert chain provided to the TLS server.
916 =item B<-tls_key> I<filename>|I<uri>
918 Private key for the client's TLS certificate.
920 =item B<-tls_keypass> I<arg>
922 Pass phrase source for client's private TLS key B<-tls_key>.
923 Also used for B<-tls_cert> in case it is an encrypted PKCS#12 file.
924 If not given here, the password will be prompted for if needed.
926 For more information about the format of I<arg> see
927 L<openssl-passphrase-options(1)>.
929 =item B<-tls_extra> I<filenames>|I<uris>
931 Extra certificates to provide to the TLS server during handshake.
933 =item B<-tls_trusted> I<filenames>|I<uris>
935 Trusted certificate(s) to use for validating the TLS server certificate.
936 This implies hostname validation.
938 Multiple sources may be given, separated by commas and/or whitespace
939 (where in the latter case the whole argument must be enclosed in "...").
940 Each source may contain multiple certificates.
942 The certificate verification options
943 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
944 have no effect on the certificate verification enabled via this option.
946 =item B<-tls_host> I<name>
948 Address to be checked during hostname validation.
949 This may be a DNS name or an IP address.
950 If not given it defaults to the B<-server> address.
954 =head2 Client-side debugging options
960 Do not interactively prompt for input, for instance when a password is needed.
961 This can be useful for batch processing and testing.
963 =item B<-repeat> I<number>
965 Invoke the command the given positive number of times with the same parameters.
966 Default is one invocation.
968 =item B<-reqin> I<filenames>
970 Take the sequence of CMP requests to send to the server from the given file(s)
971 rather than from the sequence of requests produced internally.
973 This option is ignored if the B<-rspin> option is given
974 because in the latter case no requests are actually sent.
976 Multiple filenames may be given, separated by commas and/or whitespace
977 (where in the latter case the whole argument must be enclosed in "...").
979 The files are read as far as needed to complete the transaction
980 and filenames have been provided. If more requests are needed,
981 the remaining ones are taken from the items at the respective position
982 in the sequence of requests produced internally.
984 The client needs to update the recipNonce field in the given requests (except
985 for the first one) in order to satisfy the checks to be performed by the server.
986 This causes re-protection (if protecting requests is required).
988 =item B<-reqin_new_tid>
990 Use a fresh transactionID for CMP request messages read using B<-reqin>,
991 which causes their reprotection (if protecting requests is required).
992 This may be needed in case the sequence of requests is reused
993 and the CMP server complains that the transaction ID has already been used.
995 =item B<-reqout> I<filenames>
997 Save the sequence of CMP requests created by the client to the given file(s).
998 These requests are not sent to the server if the B<-reqin> option is used, too.
1000 Multiple filenames may be given, separated by commas and/or whitespace.
1002 Files are written as far as needed to save the transaction
1003 and filenames have been provided.
1004 If the transaction contains more requests, the remaining ones are not saved.
1006 =item B<-rspin> I<filenames>
1008 Process the sequence of CMP responses provided in the given file(s),
1009 not contacting any given server,
1010 as long as enough filenames are provided to complete the transaction.
1012 Multiple filenames may be given, separated by commas and/or whitespace.
1014 Any server specified via the I<-server> or I<-use_mock_srv> options is contacted
1015 only if more responses are needed to complete the transaction.
1016 In this case the transaction will fail
1017 unless the server has been prepared to continue the already started transaction.
1019 =item B<-rspout> I<filenames>
1021 Save the sequence of actually used CMP responses to the given file(s).
1022 These have been received from the server unless B<-rspin> takes effect.
1024 Multiple filenames may be given, separated by commas and/or whitespace.
1026 Files are written as far as needed to save the responses
1027 contained in the transaction and filenames have been provided.
1028 If the transaction contains more responses, the remaining ones are not saved.
1030 =item B<-use_mock_srv>
1032 Test the client using the internal CMP server mock-up at API level,
1033 bypassing socket-based transfer via HTTP.
1034 This excludes the B<-server> and B<-port> options.
1038 =head2 Mock server options
1042 =item B<-port> I<number>
1044 Act as HTTP-based CMP server mock-up listening on the given local port.
1045 The client may address the server via, e.g., C<127.0.0.1> or C<[::]>.
1046 This option excludes the B<-server> and B<-use_mock_srv> options.
1047 The B<-rspin>, B<-rspout>, B<-reqin>, and B<-reqout> options
1048 so far are not supported in this mode.
1050 =item B<-max_msgs> I<number>
1052 Maximum number of CMP (request) messages the CMP HTTP server mock-up
1053 should handle, which must be nonnegative.
1054 The default value is 0, which means that no limit is imposed.
1055 In any case the server terminates on internal errors, but not when it
1056 detects a CMP-level error that it can successfully answer with an error message.
1058 =item B<-srv_ref> I<value>
1060 Reference value to use as senderKID of server in case no B<-srv_cert> is given.
1062 =item B<-srv_secret> I<arg>
1064 Password source for server authentication with a pre-shared key (secret).
1066 =item B<-srv_cert> I<filename>|I<uri>
1068 Certificate of the server.
1070 =item B<-srv_key> I<filename>|I<uri>
1072 Private key used by the server for signing messages.
1074 =item B<-srv_keypass> I<arg>
1076 Server private key (and cert) file pass phrase source.
1078 =item B<-srv_trusted> I<filenames>|I<uris>
1080 Trusted certificates for client authentication.
1082 The certificate verification options
1083 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
1084 have no effect on the certificate verification enabled via this option.
1086 =item B<-srv_untrusted> I<filenames>|I<uris>
1088 Intermediate CA certs that may be useful when validating client certificates.
1090 =item B<-ref_cert> I<filename>|I<uri>
1092 Certificate to be expected for RR messages and any oldCertID in KUR messages.
1094 =item B<-rsp_cert> I<filename>|I<uri>
1096 Certificate to be returned as mock enrollment result.
1098 =item B<-rsp_extracerts> I<filenames>|I<uris>
1100 Extra certificates to be included in mock certification responses.
1102 =item B<-rsp_capubs> I<filenames>|I<uris>
1104 CA certificates to be included in mock Initialization Response (IP) message.
1106 =item B<-rsp_newwithnew> I<filename>|I<uri>
1108 Certificate to be returned in newWithNew field of genp of type rootCaKeyUpdate.
1110 =item B<-rsp_newwithold> I<filename>|I<uri>
1112 Certificate to be returned in newWithOld field of genp of type rootCaKeyUpdate.
1114 =item B<-rsp_oldwithnew> I<filename>|I<uri>
1116 Certificate to be returned in oldWithNew field of genp of type rootCaKeyUpdate.
1118 =item B<-poll_count> I<number>
1120 Number of times the client must poll before receiving a certificate.
1122 =item B<-check_after> I<number>
1124 The checkAfter value (number of seconds to wait) to include in poll response.
1126 =item B<-grant_implicitconf>
1128 Grant implicit confirmation of newly enrolled certificate.
1130 =item B<-pkistatus> I<number>
1132 PKIStatus to be included in server response.
1133 Valid range is 0 (accepted) .. 6 (keyUpdateWarning).
1135 =item B<-failure> I<number>
1137 A single failure info bit number to be included in server response.
1138 Valid range is 0 (badAlg) .. 26 (duplicateCertReq).
1140 =item B<-failurebits> I<number>
1141 Number representing failure bits to be included in server response.
1142 Valid range is 0 .. 2^27 - 1.
1144 =item B<-statusstring> I<arg>
1146 Text to be included as status string in server response.
1148 =item B<-send_error>
1150 Force server to reply with error message.
1152 =item B<-send_unprotected>
1154 Send response messages without CMP-level protection.
1156 =item B<-send_unprot_err>
1158 In case of negative responses, server shall send unprotected error messages,
1159 certificate responses (IP/CP/KUP), and revocation responses (RP).
1160 WARNING: This setting leads to behavior violating RFC 4210.
1162 =item B<-accept_unprotected>
1164 Accept missing or invalid protection of requests.
1166 =item B<-accept_unprot_err>
1168 Accept unprotected error messages from client.
1169 So far this has no effect because the server does not accept any error messages.
1171 =item B<-accept_raverified>
1173 Accept RAVERIFED as proof of possession (POPO).
1177 =head2 Certificate verification options, for both CMP and TLS
1181 {- $OpenSSL::safe::opt_v_item -}
1183 The certificate verification options
1184 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
1185 only affect the certificate verification enabled via the B<-out_trusted> option.
1191 When a client obtains, from a CMP server, CA certificates that it is going to
1192 trust, for instance via the C<caPubs> field of a certificate response
1193 or using general messages with infoType C<caCerts> or C<rootCaCert>,
1194 authentication of the CMP server is particularly critical.
1195 So special care must be taken setting up server authentication
1196 using B<-trusted> and related options for certificate-based authentication
1197 or B<-secret> for MAC-based protection.
1198 If authentication is certificate-based, the B<-srvcertout> option
1199 should be used to obtain the validated server certificate
1200 and perform an authorization check based on it.
1202 When setting up CMP configurations and experimenting with enrollment options
1203 typically various errors occur until the configuration is correct and complete.
1204 When the CMP server reports an error the client will by default
1205 check the protection of the CMP response message.
1206 Yet some CMP services tend not to protect negative responses.
1207 In this case the client will reject them, and thus their contents are not shown
1208 although they usually contain hints that would be helpful for diagnostics.
1209 For assisting in such cases the CMP client offers a workaround via the
1210 B<-unprotected_errors> option, which allows accepting such negative messages.
1212 If OpenSSL was built with trace support enabled (e.g., C<./config enable-trace>)
1213 and the environment variable B<OPENSSL_TRACE> includes B<HTTP>,
1214 the requests and the response headers transferred via HTTP are printed.
1218 =head2 Simple examples using the default OpenSSL configuration file
1220 This CMP client implementation comes with demonstrative CMP sections
1221 in the example configuration file F<openssl/apps/openssl.cnf>,
1222 which can be used to interact conveniently with the Insta Demo CA.
1224 In order to enroll an initial certificate from that CA it is sufficient
1225 to issue the following shell commands.
1227 export OPENSSL_CONF=/path/to/openssl/apps/openssl.cnf
1231 wget 'http://pki.certificate.fi:8081/install-ca-cert.html/ca-certificate.crt\
1232 ?ca-id=632&download-certificate=1' -O insta.ca.crt
1236 openssl genrsa -out insta.priv.pem
1237 openssl cmp -section insta
1239 This should produce the file F<insta.cert.pem> containing a new certificate
1240 for the private key held in F<insta.priv.pem>.
1241 It can be viewed using, e.g.,
1243 openssl x509 -noout -text -in insta.cert.pem
1245 In case the network setup requires using an HTTP proxy it may be given as usual
1246 via the environment variable B<http_proxy> or via the B<-proxy> option in the
1247 configuration file or the CMP command-line argument B<-proxy>, for example
1249 -proxy http://192.168.1.1:8080
1251 In the Insta Demo CA scenario both clients and the server may use the pre-shared
1252 secret I<insta> and the reference value I<3078> to authenticate to each other.
1254 Alternatively, CMP messages may be protected in signature-based manner,
1255 where the trust anchor in this case is F<insta.ca.crt>
1256 and the client may use any certificate already obtained from that CA,
1257 as specified in the B<[signature]> section of the example configuration.
1258 This can be used in combination with the B<[insta]> section simply by
1260 openssl cmp -section insta,signature
1262 By default the CMP IR message type is used, yet CR works equally here.
1263 This may be specified directly at the command line:
1265 openssl cmp -section insta -cmd cr
1267 or by referencing in addition the B<[cr]> section of the example configuration:
1269 openssl cmp -section insta,cr
1271 In order to update the enrolled certificate one may call
1273 openssl cmp -section insta,kur
1275 using with MAC-based protection with PBM or
1277 openssl cmp -section insta,kur,signature
1279 using signature-based protection.
1281 In a similar way any previously enrolled certificate may be revoked by
1283 openssl cmp -section insta,rr -trusted insta.ca.crt
1287 openssl cmp -section insta,rr,signature
1289 Many more options can be given in the configuration file
1290 and/or on the command line.
1291 For instance, the B<-reqexts> CLI option may refer to a section in the
1292 configuration file defining X.509 extensions to use in certificate requests,
1293 such as C<v3_req> in F<openssl/apps/openssl.cnf>:
1295 openssl cmp -section insta,cr -reqexts v3_req
1297 =head2 Certificate enrollment
1299 The following examples do not make use of a configuration file at first.
1300 They assume that a CMP server can be contacted on the local TCP port 80
1301 and accepts requests under the alias I</pkix/>.
1303 For enrolling its very first certificate the client generates a client key
1304 and sends an initial request message to the local CMP server
1305 using a pre-shared secret key for mutual authentication.
1306 In this example the client does not have the CA certificate yet,
1307 so we specify the name of the CA with the B<-recipient> option
1308 and save any CA certificates that we may receive in the C<capubs.pem> file.
1310 In below command line usage examples the C<\> at line ends is used just
1311 for formatting; each of the command invocations should be on a single line.
1313 openssl genrsa -out cl_key.pem
1314 openssl cmp -cmd ir -server 127.0.0.1:80/pkix/ -recipient "/CN=CMPserver" \
1315 -ref 1234 -secret pass:1234-5678 \
1316 -newkey cl_key.pem -subject "/CN=MyName" \
1317 -cacertsout capubs.pem -certout cl_cert.pem
1319 =head2 Certificate update
1321 Then, when the client certificate and its related key pair needs to be updated,
1322 the client can send a key update request taking the certs in C<capubs.pem>
1323 as trusted for authenticating the server and using the previous cert and key
1324 for its own authentication.
1325 Then it can start using the new cert and key.
1327 openssl genrsa -out cl_key_new.pem
1328 openssl cmp -cmd kur -server 127.0.0.1:80/pkix/ \
1329 -trusted capubs.pem \
1330 -cert cl_cert.pem -key cl_key.pem \
1331 -newkey cl_key_new.pem -certout cl_cert.pem
1332 cp cl_key_new.pem cl_key.pem
1334 This command sequence can be repeated as often as needed.
1336 =head2 Requesting information from CMP server
1338 Requesting "all relevant information" with an empty General Message.
1339 This prints information about all received ITAV B<infoType>s to stdout.
1341 openssl cmp -cmd genm -server 127.0.0.1/pkix/ -recipient "/CN=CMPserver" \
1342 -ref 1234 -secret pass:1234-5678
1344 =head2 Using a custom configuration file
1346 For CMP client invocations, in particular for certificate enrollment,
1347 usually many parameters need to be set, which is tedious and error-prone to do
1348 on the command line.
1349 Therefore, the client offers the possibility to read
1350 options from sections of the OpenSSL config file, usually called F<openssl.cnf>.
1351 The values found there can still be extended and even overridden by any
1352 subsequently loaded sections and on the command line.
1354 After including in the configuration file the following sections:
1359 trusted = capubs.pem
1363 certout = cl_cert.pem
1366 recipient = "/CN=CMPserver"
1371 secret = pass:1234-5678-1234-567
1372 subject = "/CN=MyName"
1373 cacertsout = capubs.pem
1375 the above enrollment transactions reduce to
1377 openssl cmp -section cmp,init
1378 openssl cmp -cmd kur -newkey cl_key_new.pem
1380 and the above transaction using a general message reduces to
1382 openssl cmp -section cmp,init -cmd genm
1386 L<openssl-genrsa(1)>, L<openssl-ecparam(1)>, L<openssl-list(1)>,
1387 L<openssl-req(1)>, L<openssl-x509(1)>, L<x509v3_config(5)>
1391 The B<cmp> application was added in OpenSSL 3.0.
1393 The B<-engine option> was deprecated in OpenSSL 3.0.
1397 Copyright 2007-2022 The OpenSSL Project Authors. All Rights Reserved.
1399 Licensed under the Apache License 2.0 (the "License"). You may not use
1400 this file except in compliance with the License. You can obtain a copy
1401 in the file LICENSE in the source distribution or at
1402 L<https://www.openssl.org/source/license.html>.