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<i r|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>]
25 [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>]
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>]
46 [B<-revreason> I<number>]
48 Message transfer options:
50 [B<-server> I<[http[s]://]address[:port][/path]>]
51 [B<-path> I<remote_path>]
52 [B<-proxy> I<[http[s]://]address[:port][/path]>]
53 [B<-no_proxy> I<addresses>]
54 [B<-msg_timeout> I<seconds>]
55 [B<-total_timeout> I<seconds>]
57 Server authentication options:
59 [B<-trusted> I<filenames>]
60 [B<-untrusted> I<sources>]
61 [B<-srvcert> I<filename>]
62 [B<-recipient> I<name>]
63 [B<-expect_sender> I<name>]
65 [B<-unprotected_errors>]
66 [B<-extracertsout> I<filename>]
67 [B<-cacertsout> I<filename>]
69 Client authentication options:
73 [B<-cert> I<filename>]
74 [B<-own_trusted> I<filenames>]
79 [B<-extracerts> I<sources>]
80 [B<-unprotected_requests>]
82 Credentials format options:
84 [B<-certform> I<PEM|DER>]
85 [B<-keyform> I<PEM|DER|P12|ENGINE>]
86 [B<-otherpass> I<arg>]
87 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
89 TLS connection options:
92 [B<-tls_cert> I<filename>]
93 [B<-tls_key> I<filename>]
94 [B<-tls_keypass> I<arg>]
95 [B<-tls_extra> I<filenames>]
96 [B<-tls_trusted> I<filenames>]
97 [B<-tls_host> I<name>]
99 Client-side debugging options:
102 [B<-repeat> I<number>]
103 [B<-reqin>] I<filenames>
105 [B<-reqout>] I<filenames>
106 [B<-rspin>] I<filenames>
107 [B<-rspout>] I<filenames>
113 [B<-max_msgs> I<number>]
114 [B<-srv_ref> I<value>]
115 [B<-srv_secret> I<arg>]
116 [B<-srv_cert> I<filename>]
117 [B<-srv_key> I<filename>]
118 [B<-srv_keypass> I<arg>]
119 [B<-srv_trusted> I<filenames>]
120 [B<-srv_untrusted> I<filenames>]
121 [B<-rsp_cert> I<filename>]
122 [B<-rsp_extracerts> I<filenames>]
123 [B<-rsp_capubs> I<filenames>]
124 [B<-poll_count> I<number>]
125 [B<-check_after> I<number>]
126 [B<-grant_implicitconf>]
127 [B<-pkistatus> I<number>]
128 [B<-failure> I<number>]
129 [B<-failurebits> I<number>]
130 [B<-statusstring> I<arg>]
132 [B<-send_unprotected>]
133 [B<-send_unprot_err>]
134 [B<-accept_unprotected>]
135 [B<-accept_unprot_err>]
136 [B<-accept_raverified>]
138 Certificate verification options, for both CMP and TLS:
140 {- $OpenSSL::safe::opt_v_synopsis -}
144 The B<cmp> command is a client implementation for the Certificate
145 Management Protocol (CMP) as defined in RFC4210.
146 It can be used to request certificates from a CA server,
147 update their certificates,
148 request certificates to be revoked, and perform other types of CMP requests.
156 Display a summary of all options
158 =item B<-config> I<filename>
160 Configuration file to use.
161 An empty string C<""> means none.
162 Default filename is from the environment variable C<OPENSSL_CONF>.
164 =item B<-section> I<names>
166 Section(s) to use within config file defining CMP options.
167 An empty string C<""> means no specific section.
170 Multiple section names may be given, separated by commas and/or whitespace
171 (where in the latter case the whole argument must be enclosed in "...").
172 Contents of sections named later may override contents of sections named before.
173 In any case, as usual, the C<[default]> section and finally the unnamed
174 section (as far as present) can provide per-option fallback values.
176 =item B<-verbosity> I<level>
178 Level of verbosity for logging, error output, etc.
179 0 = EMERG, 1 = ALERT, 2 = CRIT, 3 = ERR, 4 = WARN, 5 = NOTE,
180 6 = INFO, 7 = DEBUG, 8 = TRACE.
181 Defaults to 6 = INFO.
185 =head2 Generic message options
189 =item B<-cmd> I<ir|cr|kur|p10cr|rr|genm>
191 CMP command to execute.
192 Currently implemented commands are:
196 =item ir E<nbsp> - Initialization Request
198 =item cr E<nbsp> - Certificate Request
200 =item p10cr - PKCS#10 Certification Request (for legacy support)
202 =item kur E<nbsp>E<nbsp>- Key Update Request
204 =item rr E<nbsp> - Revocation Request
206 =item genm - General Message
210 B<ir> requests initialization of an End Entity into a PKI hierarchy
211 by issuing a first certificate.
213 B<cr> requests issuing an additional certificate for an End Entity already
214 initialized to the PKI hierarchy.
216 B<p10cr> requests issuing an additional certificate similarly to B<cr>
217 but uses PKCS#10 CSR format.
219 B<kur> requests a (key) update for an existing, given certificate.
221 B<rr> requests revocation of an existing, given certificate.
223 B<genm> requests information using a General Message, where optionally
224 included B<InfoTypeAndValue>s may be used to state which info is of interest.
225 Upon receipt of the General Response, information about all received
226 ITAV B<infoType>s is printed to stdout.
228 =item B<-infotype> I<name>
230 Set InfoType name to use for requesting specific info in B<genm>,
231 e.g., C<signKeyPairTypes>.
233 =item B<-geninfo> I<OID:int:N>
235 generalInfo integer values to place in request PKIHeader with given OID,
236 e.g., C<1.2.3.4:int:56789>.
240 =head2 Certificate enrollment options
244 =item B<-newkey> I<filename>
246 The file containing the private or public key for the certificate requested
247 in Initialization Request (IR), Certification Request(CR), or
248 Key Update Request (KUR).
249 Default is the public key in the PKCS#10 CSR given with the B<-csr> option,
250 if any, or else the current client key, if given.
252 =item B<-newkeypass> I<arg>
254 Pass phrase source for the key given with the B<-newkey> option.
255 If not given here, the password will be prompted for if needed.
257 For more information about the format of B<arg> see the
258 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
260 =item B<-subject> I<name>
262 X509 Distinguished Name (DN) of subject to use in the requested certificate
264 For KUR, it defaults to the subject DN of the reference certificate
266 This default is used for IR and CR only if no SANs are set.
268 The subject DN is also used as fallback sender of outgoing CMP messages
269 if no B<-cert> and no B<-oldcert> are given.
271 The argument must be formatted as I</type0=value0/type1=value1/type2=...>.
272 Special characters may be escaped by C<\> (backslash), whitespace is retained.
273 Empty values are permitted, but the corresponding type will not be included.
274 Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
275 Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
276 between the AttributeValueAssertions (AVAs) that specify the members of the set.
279 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
281 =item B<-issuer> I<name>
283 X509 issuer Distinguished Name (DN) of the CA server
284 to place in the requested certificate template in IR/CR/KUR.
286 If neither B<-srvcert> nor B<-recipient> is available,
287 the name given in this option is also set as the recipient of the CMP message.
289 =item B<-days> I<number>
291 Number of days the new certificate is requested to be valid for, counting from
292 the current time of the host.
293 Also triggers the explicit request that the
294 validity period starts from the current time (as seen by the host).
296 =item B<-reqexts> I<name>
298 Name of section in OpenSSL config file defining certificate request extensions.
300 =item B<-sans> I<spec>
302 One or more IP addresses, DNS names, or URIs separated by commas or whitespace
303 (where in the latter case the whole argument must be enclosed in "...")
304 to add as Subject Alternative Name(s) (SAN) certificate request extension.
305 If the special element "critical" is given the SANs are flagged as critical.
306 Cannot be used if any Subject Alternative Name extension is set via B<-reqexts>.
308 =item B<-san_nodefault>
310 When Subject Alternative Names are not given via B<-sans>
311 nor defined via B<-reqexts>,
312 they are copied by default from the reference certificate (see B<-oldcert>).
313 This can be disabled by giving the B<-san_nodefault> option.
315 =item B<-policies> I<name>
317 Name of section in OpenSSL config file defining policies to be set
318 as certificate request extension.
319 This option cannot be used together with B<-policy_oids>.
321 =item B<-policy_oids> I<names>
323 One or more OID(s), separated by commas and/or whitespace
324 (where in the latter case the whole argument must be enclosed in "...")
325 to add as certificate policies request extension.
326 This option cannot be used together with B<-policies>.
328 =item B<-policy_oids_critical>
330 Flag the policies given with B<-policy_oids> as critical.
332 =item B<-popo> I<number>
334 Proof-of-Possession (POPO) method to use for IR/CR/KUR; values: C<-1>..<2> where
335 C<-1> = NONE, C<0> = RAVERIFIED, C<1> = SIGNATURE (default), C<2> = KEYENC.
337 Note that a signature-based POPO can only be produced if a private key
338 is provided via the B<-newkey> or B<-key> options.
340 =item B<-csr> I<filename>
342 PKCS#10 CSR in PEM or DER format to use in legacy P10CR messages.
344 =item B<-out_trusted> I<filenames>
346 Trusted certificate(s) to use for verifying the newly enrolled certificate.
348 Multiple filenames may be given, separated by commas and/or whitespace
349 (where in the latter case the whole argument must be enclosed in "...").
350 Each source may contain multiple certificates.
352 The certificate verification options
353 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
354 only affect the certificate verification enabled via this option.
356 =item B<-implicit_confirm>
358 Request implicit confirmation of newly enrolled certificates.
360 =item B<-disable_confirm>
362 Do not send certificate confirmation message for newly enrolled certificate
363 without requesting implicit confirmation
364 to cope with broken servers not supporting implicit confirmation correctly.
365 B<WARNING:> This leads to behavior violating RFC 4210.
367 =item B<-certout> I<filename>
369 The file where the newly enrolled certificate should be saved.
371 =item B<-chainout> I<filename>
373 The file where the chain of the newly enrolled certificate should be saved.
377 =head2 Certificate enrollment and revocation options
381 =item B<-oldcert> I<filename>
383 The certificate to be updated (i.e., renewed or re-keyed) in Key Update Request
384 (KUR) messages or to be revoked in Revocation Request (RR) messages.
385 It must be given for RR, while for KUR it defaults to B<-cert>.
387 The reference certificate determined in this way, if any, is also used for
388 deriving default subject DN and Subject Alternative Names and the
389 default issuer entry in the requested certificate template of IR/CR/KUR.
390 Its subject is used as sender of outgoing messages if B<-cert> is not given.
391 Its issuer is used as default recipient in CMP message headers
392 if neither B<-recipient>, B<-srvcert>, nor B<-issuer> is given.
394 =item B<-revreason> I<number>
396 Set CRLReason to be included in revocation request (RR); values: C<0>..C<10>
397 or C<-1> for none (which is the default).
399 Reason numbers defined in RFC 5280 are:
401 CRLReason ::= ENUMERATED {
405 affiliationChanged (3),
407 cessationOfOperation (5),
409 -- value 7 is not used
411 privilegeWithdrawn (9),
417 =head2 Message transfer options
421 =item B<-server> I<[http[s]://]address[:port][/path]>
423 The IP address or DNS hostname and optionally port (defaulting to 80 or 443)
424 of the CMP server to connect to using HTTP(S) transport.
425 The optional I<http://> or I<https://> prefix is ignored.
426 If a path is included it provides the default value for the B<-path> option.
428 =item B<-path> I<remote_path>
430 HTTP path at the CMP server (aka CMP alias) to use for POST requests.
431 Defaults to any path given with B<-server>, else C<"/">.
433 =item B<-proxy> I<[http[s]://]address[:port][/path]>
435 The HTTP(S) proxy server to use for reaching the CMP server unless B<no_proxy>
437 The optional I<http://> or I<https://> prefix and any trailing path are ignored.
438 Defaults to the environment variable C<http_proxy> if set, else C<HTTP_PROXY>
439 in case no TLS is used, otherwise C<https_proxy> if set, else C<HTTPS_PROXY>.
441 =item B<-no_proxy> I<addresses>
443 List of IP addresses and/or DNS names of servers
444 not to use an HTTP(S) proxy for, separated by commas and/or whitespace
445 (where in the latter case the whole argument must be enclosed in "...").
446 Default is from the environment variable C<no_proxy> if set, else C<NO_PROXY>.
448 =item B<-msg_timeout> I<seconds>
450 Number of seconds (or 0 for infinite) a CMP request-response message round trip
451 is allowed to take before a timeout error is returned.
454 =item B<-total_timeout> I<seconds>
456 Maximum number seconds an overall enrollment transaction may take,
457 including attempts polling for certificates on C<waiting> PKIStatus.
458 Default is 0 (infinite).
462 =head2 Server authentication options
466 =item B<-trusted> I<filenames>
468 When verifying signature-based protection of CMP response messages,
469 these are the CA certificate(s) to trust while checking certificate chains
470 during CMP server authentication.
471 This option gives more flexibility than the B<-srvcert> option because the
472 server-side CMP signer certificate is not pinned but may be any certificate
473 for which a chain to one of the given trusted certificates can be constructed.
475 If no B<-trusted>, B<-srvcert>, and B<-secret> option is given
476 then protected response messages from the server are not authenticated.
478 Multiple filenames may be given, separated by commas and/or whitespace
479 (where in the latter case the whole argument must be enclosed in "...").
480 Each source may contain multiple certificates.
482 The certificate verification options
483 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
484 have no effect on the certificate verification enabled via this option.
486 =item B<-untrusted> I<sources>
488 Non-trusted intermediate CA certificate(s).
489 Any extra certificates given with the B<-cert> option are appended to it.
490 All these certificates may be useful for cert path construction
491 for the CMP client certificate (to include in the extraCerts field of outgoing
492 messages) and for the TLS client certificate (if TLS is enabled)
493 as well as for chain building
494 when verifying the CMP server certificate (checking signature-based
495 CMP message protection) and when verifying newly enrolled certificates.
497 Multiple filenames may be given, separated by commas and/or whitespace.
498 Each file may contain multiple certificates.
500 =item B<-srvcert> I<filename>
502 The specific CMP server certificate to expect and directly trust (even if it is
503 expired) when verifying signature-based protection of CMP response messages.
504 May be set alternatively to the B<-trusted> option to pin the accepted server.
506 If set, the subject of the certificate is also used
507 as default value for the recipient of CMP requests
508 and as default value for the expected sender of incoming CMP messages.
510 =item B<-recipient> I<name>
512 Distinguished Name (DN) to use in the recipient field of CMP request messages,
513 i.e., the CMP server (usually the addressed CA).
515 The recipient field in the header of a CMP message is mandatory.
516 If not given explicitly the recipient is determined in the following order:
517 the subject of the CMP server certificate given with the B<-srvcert> option,
518 the B<-issuer> option,
519 the issuer of the certificate given with the B<-oldcert> option,
520 the issuer of the CMP client certificate (B<-cert> option),
521 as far as any of those is present, else the NULL-DN as last resort.
523 =item B<-expect_sender> I<name>
525 Distinguished Name (DN) expected in the sender field of incoming CMP messages.
526 Defaults to the subject DN of the pinned B<-srvcert>, if any.
528 This can be used to make sure that only a particular entity is accepted as
529 CMP message signer, and attackers are not able to use arbitrary certificates
530 of a trusted PKI hierarchy to fraudulently pose as a CMP server.
531 Note that this option gives slightly more freedom than setting the B<-srvcert>,
532 which pins the server to the holder of a particular certificate, while the
533 expected sender name will continue to match after updates of the server cert.
535 =item B<-ignore_keyusage>
537 Ignore key usage restrictions in CMP signer certificates when verifying
538 signature-based protection of incoming CMP messages,
539 else C<digitalSignature> must be allowed for signer certificate.
541 =item B<-unprotected_errors>
543 Accept missing or invalid protection of negative responses from the server.
544 This applies to the following message types and contents:
548 =item * error messages
550 =item * negative certificate responses (IP/CP/KUP)
552 =item * negative revocation responses (RP)
554 =item * negative PKIConf messages
558 B<WARNING:> This setting leads to unspecified behavior and it is meant
559 exclusively to allow interoperability with server implementations violating
564 =item * section 5.1.3.1 allows exceptions from protecting only for special
566 "There MAY be cases in which the PKIProtection BIT STRING is deliberately not
567 used to protect a message [...] because other protection, external to PKIX, will
570 =item * section 5.3.21 is clear on ErrMsgContent: "The CA MUST always sign it
571 with a signature key."
573 =item * appendix D.4 shows PKIConf message having protection
577 =item B<-extracertsout> I<filename>
579 The file where to save all certificates contained in the extraCerts field
580 of the last received response message (except for pollRep and PKIConf).
582 =item B<-cacertsout> I<filename>
584 The file where to save any CA certificates contained in the caPubs field of
585 the last received certificate response (i.e., IP, CP, or KUP) message.
589 =head2 Client authentication options
593 =item B<-ref> I<value>
595 Reference number/string/value to use as fallback senderKID; this is required
596 if no sender name can be determined from the B<-cert> or <-subject> options and
597 is typically used when authenticating with pre-shared key (password-based MAC).
599 =item B<-secret> I<arg>
601 Prefer PBM-based message protection with given source of a secret value.
602 The secret is used for creating PBM-based protection of outgoing messages
603 and (as far as needed) for verifying PBM-based protection of incoming messages.
604 PBM stands for Password-Based Message Authentication Code.
605 This takes precedence over the B<-cert> and B<-key> options.
607 For more information about the format of B<arg> see the
608 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
610 =item B<-cert> I<filename>
612 The client's current CMP signer certificate.
613 Requires the corresponding key to be given with B<-key>.
614 The subject of this certificate will be used as sender of outgoing CMP messages,
615 while the subject of B<-oldcert> or B<-subjectName> may provide fallback values.
616 The issuer of this certificate is used as one of the recipient fallback values
617 and as fallback issuer entry in the certificate template of IR/CR/KUR.
618 When using signature-based message protection, this "protection certificate"
619 will be included first in the extraCerts field of outgoing messages
620 and the signature is done with the corresponding key.
621 In Initialization Request (IR) messages this can be used for authenticating
622 using an external entity certificate as defined in appendix E.7 of RFC 4210.
623 For Key Update Request (KUR) messages this is also used as
624 the certificate to be updated if the B<-oldcert> option is not given.
625 If the file includes further certs, they are appended to the untrusted certs
626 because they typically constitute the chain of the client certificate, which
627 is included in the extraCerts field in signature-protected request messages.
629 =item B<-own_trusted> I<filenames>
631 If this list of certificates is provided then the chain built for
632 the client-side CMP signer certificate given with the B<-cert> option
633 is verified using the given certificates as trust anchors.
635 Multiple filenames may be given, separated by commas and/or whitespace
636 (where in the latter case the whole argument must be enclosed in "...").
637 Each source may contain multiple certificates.
639 The certificate verification options
640 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
641 have no effect on the certificate verification enabled via this option.
643 =item B<-key> I<filename>
645 The corresponding private key file for the client's current certificate given in
647 This will be used for signature-based message protection unless
648 the B<-secret> option indicating PBM or B<-unprotected_requests> is given.
650 =item B<-keypass> I<arg>
652 Pass phrase source for the private key given with the B<-key> option.
653 Also used for B<-cert> and B<-oldcert> in case it is an encrypted PKCS#12 file.
654 If not given here, the password will be prompted for if needed.
656 For more information about the format of B<arg> see the
657 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
659 =item B<-digest> I<name>
661 Specifies name of supported digest to use in RFC 4210's MSG_SIG_ALG
662 and as the one-way function (OWF) in MSG_MAC_ALG.
663 If applicable, this is used for message protection and
664 Proof-of-Possession (POPO) signatures.
665 To see the list of supported digests, use B<openssl list -digest-commands>.
666 Defaults to C<sha256>.
668 =item B<-mac> I<name>
670 Specifies the name of the MAC algorithm in MSG_MAC_ALG.
671 To get the names of supported MAC algorithms use B<openssl list -mac-algorithms>
672 and possibly combine such a name with the name of a supported digest algorithm,
673 e.g., hmacWithSHA256.
674 Defaults to C<hmac-sha1> as per RFC 4210.
676 =item B<-extracerts> I<sources>
678 Certificates to append in the extraCerts field when sending messages.
679 They can be used as the default CMP signer certificate chain to include.
681 Multiple filenames or URLs may be given, separated by commas and/or whitespace
682 (where in the latter case the whole argument must be enclosed in "...").
683 Each source may contain multiple certificates.
685 =item B<-unprotected_requests>
687 Send messages without CMP-level protection.
691 =head2 Credentials format options
695 =item B<-certform> I<PEM|DER>
697 File format to use when saving a certificate to a file.
698 Default value is PEM.
700 =item B<-keyform> I<PEM|DER|P12|ENGINE>
702 The format of the key input.
703 The only value with effect is B<ENGINE>.
705 =item B<-otherpass> I<arg>
707 Pass phrase source for certificate given with the B<-trusted>, B<-untrusted>,
708 B<-own_trusted>, B<-srvcert>, B<-out_trusted>, B<-extracerts>,
709 B<-srv_trusted>, B<-srv_untrusted>, B<-rsp_extracerts>, B<-rsp_capubs>,
710 B<-tls_extra>, and B<-tls_trusted> options.
711 If not given here, the password will be prompted for if needed.
713 For more information about the format of B<arg> see the
714 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
715 {- output_off() if $disabled{"deprecated-3.0"}; "" -}
717 =item B<-engine> I<id>
719 Specifying a crypto engine B<id> will lead to obtaining a functional
720 reference to the specified engine, initializing it if needed.
721 The engine will be used for all algorithms supported for keys
722 prefixed by C<engine:>.
723 Engines may be defined in the OpenSSL config file as usual in an engine section.
725 Options specifying keys, like B<-key>, B<-newkey>, B<-tls_key> can prefix
726 C<engine:> to engine-specific identifiers for security tokens objects held by
728 The following example utilizes the RFC 7512 PKCS #11 URI scheme
729 as supported, e.g., by libp11:
730 C<-key engine:pkcs11:object=my-private-key;type=private;pin-value=1234>
732 {- output_on() if $disabled{"deprecated-3.0"}; "" -}
733 {- $OpenSSL::safe::opt_provider_item -}
737 =head2 TLS connection options
743 Enable using TLS (even when other TLS_related options are not set)
744 when connecting to CMP server.
746 =item B<-tls_cert> I<filename>
748 Client's TLS certificate.
749 If the file includes further certs they are used (along with B<-untrusted>
750 certs) for constructing the client cert chain provided to the TLS server.
752 =item B<-tls_key> I<filename>
754 Private key for the client's TLS certificate.
756 =item B<-tls_keypass> I<arg>
758 Pass phrase source for client's private TLS key B<tls_key>.
759 Also used for B<-tls_cert> in case it is an encrypted PKCS#12 file.
760 If not given here, the password will be prompted for if needed.
762 For more information about the format of B<arg> see the
763 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
765 =item B<-tls_extra> I<filenames>
767 Extra certificates to provide to TLS server during TLS handshake
769 =item B<-tls_trusted> I<filenames>
771 Trusted certificate(s) to use for verifying the TLS server certificate.
772 This implies hostname validation.
774 Multiple filenames may be given, separated by commas and/or whitespace
775 (where in the latter case the whole argument must be enclosed in "...").
776 Each source may contain multiple certificates.
778 The certificate verification options
779 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
780 have no effect on the certificate verification enabled via this option.
782 =item B<-tls_host> I<name>
784 Address to be checked during hostname validation.
785 This may be a DNS name or an IP address.
786 If not given it defaults to the B<-server> address.
790 =head2 Client-side debugging options
796 Do not interactively prompt for input, for instance when a password is needed.
797 This can be useful for batch processing and testing.
799 =item B<-repeat> I<number>
801 Invoke the command the given number of times with the same parameters.
802 Default is one invocation.
804 =item B<-reqin> I<filenames>
806 Take sequence of CMP requests from file(s).
808 Multiple filenames may be given, separated by commas and/or whitespace
809 (where in the latter case the whole argument must be enclosed in "...").
810 As many files are read as needed for a complete transaction.
812 =item B<-reqin_new_tid>
814 Use a fresh transactionID for CMP request messages read using B<-reqin>,
815 which requires re-protecting them as far as they were protected before.
816 This may be needed in case the sequence of requests is reused
817 and the CMP server complains that the transaction ID has already been used.
819 =item B<-reqout> I<filenames>
821 Save sequence of CMP requests to file(s).
823 Multiple filenames may be given, separated by commas and/or whitespace.
824 As many files are written as needed to store the complete transaction.
826 =item B<-rspin> I<filenames>
828 Process sequence of CMP responses provided in file(s), skipping server.
830 Multiple filenames may be given, separated by commas and/or whitespace.
831 As many files are read as needed for the complete transaction.
833 =item B<-rspout> I<filenames>
835 Save sequence of CMP responses to file(s).
837 Multiple filenames may be given, separated by commas and/or whitespace.
838 As many files are written as needed to store the complete transaction.
840 =item B<-use_mock_srv>
842 Use the internal mock server for testing the client.
843 This works at API level, bypassing HTTP transport.
847 =head2 Mock server options
851 =item B<-port> I<number>
853 Act as CMP HTTP server mock-up listening on the given port.
855 =item B<-max_msgs> I<number>
857 Maximum number of CMP (request) messages the CMP HTTP server mock-up
858 should handle, which must be nonnegative.
859 The default value is 0, which means that no limit is imposed.
860 In any case the server terminates on internal errors, but not when it
861 detects a CMP-level error that it can successfully answer with an error message.
863 =item B<-srv_ref> I<value>
865 Reference value to use as senderKID of server in case no B<-srv_cert> is given.
867 =item B<-srv_secret> I<arg>
869 Password source for server authentication with a pre-shared key (secret).
871 =item B<-srv_cert> I<filename>
873 Certificate of the server.
875 =item B<-srv_key> I<filename>
877 Private key used by the server for signing messages.
879 =item B<-srv_keypass> I<arg>
881 Server private key (and cert) file pass phrase source.
883 =item B<-srv_trusted> I<filenames>
885 Trusted certificates for client authentication.
887 The certificate verification options
888 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
889 have no effect on the certificate verification enabled via this option.
891 =item B<-srv_untrusted> I<filenames>
893 Intermediate CA certs that may be useful when verifying client certificates.
895 =item B<-rsp_cert> I<filename>
897 Certificate to be returned as mock enrollment result.
899 =item B<-rsp_extracerts> I<filenames>
901 Extra certificates to be included in mock certification responses.
903 =item B<-rsp_capubs> I<filenames>
905 CA certificates to be included in mock Initialization Response (IP) message.
907 =item B<-poll_count> I<number>
909 Number of times the client must poll before receiving a certificate.
911 =item B<-check_after> I<number>
913 The checkAfter value (number of seconds to wait) to include in poll response.
915 =item B<-grant_implicitconf>
917 Grant implicit confirmation of newly enrolled certificate.
919 =item B<-pkistatus> I<number>
921 PKIStatus to be included in server response.
922 Valid range is 0 (accepted) .. 6 (keyUpdateWarning).
924 =item B<-failure> I<number>
926 A single failure info bit number to be included in server response.
927 Valid range is 0 (badAlg) .. 26 (duplicateCertReq).
929 =item B<-failurebits> I<number>
930 Number representing failure bits to be included in server response.
931 Valid range is 0 .. 2^27 - 1.
933 =item B<-statusstring> I<arg>
935 Text to be included as status string in server response.
939 Force server to reply with error message.
941 =item B<-send_unprotected>
943 Send response messages without CMP-level protection.
945 =item B<-send_unprot_err>
947 In case of negative responses, server shall send unprotected error messages,
948 certificate responses (IP/CP/KUP), and revocation responses (RP).
949 WARNING: This setting leads to behavior violating RFC 4210.
951 =item B<-accept_unprotected>
953 Accept missing or invalid protection of requests.
955 =item B<-accept_unprot_err>
957 Accept unprotected error messages from client.
959 =item B<-accept_raverified>
961 Accept RAVERIFED as proof-of-possession (POPO).
965 =head2 Certificate verification options, for both CMP and TLS
969 {- $OpenSSL::safe::opt_v_item -}
971 The certificate verification options
972 B<-verify_hostname>, B<-verify_ip>, and B<-verify_email>
973 only affect the certificate verification enabled via the B<-out_trusted> option.
979 When setting up CMP configurations and experimenting with enrollment options
980 typically various errors occur until the configuration is correct and complete.
981 When the CMP server reports an error the client will by default
982 check the protection of the CMP response message.
983 Yet some CMP services tend not to protect negative responses.
984 In this case the client will reject them, and thus their contents are not shown
985 although they usually contain hints that would be helpful for diagnostics.
986 For assisting in such cases the CMP client offers a workaround via the
987 B<-unprotected_errors> option, which allows accepting such negative messages.
991 =head2 Simple examples using the default OpenSSL configuration file
993 This CMP client implementation comes with demonstrative CMP sections
994 in the example configuration file F<openssl/apps/openssl.cnf>,
995 which can be used to interact conveniently with the Insta Demo CA.
997 In order to enroll an initial certificate from that CA it is sufficient
998 to issue the following shell commands.
1001 export OPENSSL_CONF=openssl.cnf
1005 wget 'http://pki.certificate.fi:8081/install-ca-cert.html/ca-certificate.crt\
1006 ?ca-id=632&download-certificate=1' -O insta.ca.crt
1010 openssl genrsa -out insta.priv.pem
1011 openssl cmp -section insta
1013 This should produce the file F<insta.cert.pem> containing a new certificate
1014 for the private key held in F<insta.priv.pem>.
1015 It can be viewed using, e.g.,
1017 openssl x509 -noout -text -in insta.cert.pem
1019 In case the network setup requires using an HTTP proxy it may be given as usual
1020 via the environment variable B<http_proxy> or via the B<proxy> option or
1021 the CMP command-line argument B<-proxy>, for example
1023 -proxy http://192.168.1.1:8080
1025 In the Insta Demo CA scenario both clients and the server may use the pre-shared
1026 secret I<insta> and the reference value I<3078> to authenticate to each other.
1028 Alternatively, CMP messages may be protected in signature-based manner,
1029 where the trust anchor in this case is F<insta.ca.crt>
1030 and the client may use any certificate already obtained from that CA,
1031 as specified in the B<[signature]> section of the example configuration.
1032 This can be used in combination with the B<[insta]> section simply by
1034 openssl cmp -section insta,signature
1036 By default the CMP IR message type is used, yet CR works equally here.
1037 This may be specified directly at the command line:
1039 openssl cmp -section insta -cmd cr
1041 or by referencing in addition the B<[cr]> section of the example configuration:
1043 openssl cmp -section insta,cr
1045 In order to update the enrolled certificate one may call
1047 openssl cmp -section insta,kur
1049 using with PBM-based protection or
1051 openssl cmp -section insta,kur,signature
1053 using signature-based protection.
1055 In a similar way any previously enrolled certificate may be revoked by
1057 openssl cmp -section insta,rr -trusted insta.ca.crt
1061 openssl cmp -section insta,rr,signature
1063 Many more options can be used in the configuration file
1064 and/or on the command line.
1065 For instance, the B<-reqexts> CLI option may refer to a section in the
1066 configuration file defining X.509 extensions to use in certificate requests,
1067 such as B<v3_req> in F<openssl/apps/openssl.cnf>:
1069 openssl cmp -section insta,cr -reqexts v3_req
1071 =head2 Certificate enrollment
1073 The following examples at first do not make use of a configuration file.
1074 They assume that a CMP server can be contacted on the local TCP port 80
1075 and accepts requests under the alias I</pkix/>.
1077 For enrolling its very first certificate the client generates a first client key
1078 and sends an initial request message to the local CMP server
1079 using a pre-shared secret key for mutual authentication.
1080 In this example the client does not have the CA certificate yet,
1081 so we specify the name of the CA with the B<-recipient> option
1082 and save any CA certificates that we may receive in the C<capubs.pem> file.
1084 In below command line usage examples the C<\> at line ends is just used
1085 for formatting; each of the command invocations should be on a single line.
1087 openssl genrsa -out cl_key.pem
1088 openssl cmp -cmd ir -server 127.0.0.1:80/pkix/ \
1089 -ref 1234 -secret pass:1234-5678-1234-5678 \
1090 -recipient "/CN=CMPserver" \
1091 -newkey cl_key.pem -subject "/CN=MyName" \
1092 -cacertsout capubs.pem -certout cl_cert.pem
1094 =head2 Certificate update
1096 Then, when the client certificate and its related key pair needs to be updated,
1097 the client can send a key update request taking the certs in C<capubs.pem>
1098 as trusted for authenticating the server and using the previous cert and key
1099 for its own authentication.
1100 Then it can start using the new cert and key.
1102 openssl genrsa -out cl_key_new.pem
1103 openssl cmp -cmd kur -server 127.0.0.1:80/pkix/ \
1104 -trusted capubs.pem \
1105 -cert cl_cert.pem -key cl_key.pem \
1106 -newkey cl_key_new.pem -certout cl_cert.pem
1107 cp cl_key_new.pem cl_key.pem
1109 This command sequence can be repated as often as needed.
1111 =head2 Requesting information from CMP server
1113 Requesting "all relevant information" with an empty General Message.
1114 This prints information about all received ITAV B<infoType>s to stdout.
1116 openssl cmp -cmd genm -server 127.0.0.1/pkix/ \
1117 -ref 1234 -secret pass:1234-5678-1234-5678 \
1118 -recipient "/CN=CMPserver"
1120 =head2 Using a custom configuration file
1122 For CMP client invocations, in particular for certificate enrollment,
1123 usually many parameters need to be set, which is tedious and error-prone to do
1124 on the command line.
1125 Therefore, the client offers the possibility to read
1126 options from sections of the OpenSSL config file, usually called B<openssl.cnf>.
1127 The values found there can still be extended and even overridden by any
1128 subsequently loaded sections and on the command line.
1130 After including in the configuration file the following sections:
1135 trusted = capubs.pem
1139 certout = cl_cert.pem
1142 recipient = "/CN=CMPserver"
1147 secret = pass:1234-5678-1234-567
1148 subject = "/CN=MyName"
1149 cacertsout = capubs.pem
1151 the above enrollment invocations reduce to
1153 openssl cmp -section cmp,cmp-init
1154 openssl cmp -cmd kur -newkey cl_key_new.pem
1156 and the above genm call reduces to
1158 openssl cmp -section cmp,cmp-init -cmd genm
1162 L<openssl-genrsa(1)>, L<openssl-ecparam(1)>, L<openssl-list(1)>,
1163 L<openssl-req(1)>, L<openssl-x509(1)>, L<x509v3_config(5)>
1167 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
1169 Licensed under the OpenSSL license (the "License"). You may not use
1170 this file except in compliance with the License. You can obtain a copy
1171 in the file LICENSE in the source distribution or at
1172 L<https://www.openssl.org/source/license.html>.