Allow subject of CMP -oldcert as sender unless protection cert is given
[openssl.git] / doc / man1 / openssl-cmp.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-cmp - client for the Certificate Management Protocol (CMP, RFC 4210)
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<cmp>
11 [B<-help>]
12 [B<-config> I<filename>]
13 [B<-section> I<names>]
14
15 [B<-server> I<address[:port]>]
16 [B<-proxy> I<[http[s]://]address[:port][/path]>]
17 [B<-no_proxy> I<addresses>]
18 [B<-path> I<remote_path>]
19 [B<-msg_timeout> I<seconds>]
20 [B<-total_timeout> I<seconds>]
21
22 [B<-trusted> I<filenames>]
23 [B<-untrusted> I<sources>]
24 [B<-srvcert> I<filename>]
25 [B<-recipient> I<name>]
26 [B<-expect_sender> I<name>]
27 [B<-ignore_keyusage>]
28 [B<-unprotected_errors>]
29 [B<-extracertsout> I<filename>]
30 [B<-cacertsout> I<filename>]
31
32 [B<-ref> I<value>]
33 [B<-secret> I<arg>]
34 [B<-cert> I<filename>]
35 [B<-key> I<filename>]
36 [B<-keypass> I<arg>]
37 [B<-digest> I<name>]
38 [B<-mac> I<name>]
39 [B<-extracerts> I<sources>]
40 [B<-unprotected_requests>]
41
42 [B<-cmd> I<ir|cr|kur|p10cr|rr|genm>]
43 [B<-infotype> I<name>]
44 [B<-geninfo> I<OID:int:N>]
45
46 [B<-newkey> I<filename>]
47 [B<-newkeypass> I<arg>]
48 [B<-subject> I<name>]
49 [B<-issuer> I<name>]
50 [B<-days> I<number>]
51 [B<-reqexts> I<name>]
52 [B<-sans> I<spec>]
53 [B<-san_nodefault>]
54 [B<-policies> I<name>]
55 [B<-policy_oids> I<names>]
56 [B<-policy_oids_critical>]
57 [B<-popo> I<number>]
58 [B<-csr> I<filename>]
59 [B<-out_trusted> I<filenames>]
60 [B<-verify_hostname> I<cn>]
61 [B<-verify_ip> I<ip>]
62 [B<-verify_email> I<email>]
63 [B<-implicit_confirm>]
64 [B<-disable_confirm>]
65 [B<-certout> I<filename>]
66
67 [B<-oldcert> I<filename>]
68 [B<-revreason> I<number>]
69
70 [B<-certform> I<PEM|DER>]
71 [B<-keyform> I<PEM|DER|P12|ENGINE>]
72 [B<-certsform> I<PEM|DER|P12>]
73 [B<-otherpass> I<arg>]
74 [B<-engine> I<id>]
75 {- $OpenSSL::safe::opt_provider_synopsis -}
76
77 [B<-tls_used>]
78 [B<-tls_cert> I<filename>]
79 [B<-tls_key> I<filename>]
80 [B<-tls_keypass> I<arg>]
81 [B<-tls_extra> I<filenames>]
82 [B<-tls_trusted> I<filenames>]
83 [B<-tls_host> I<name>]
84
85 [B<-batch>]
86 [B<-repeat> I<number>]
87 [B<-reqin>] I<filenames>
88 [B<-reqin_new_tid>]
89 [B<-reqout>] I<filenames>
90 [B<-rspin>] I<filenames>
91 [B<-rspout>] I<filenames>
92 [B<-use_mock_srv>]
93
94 [B<-policy> I<arg>]
95 [B<-purpose> I<purpose>]
96 [B<-verify_name> I<name>]
97 [B<-verify_depth> I<num>]
98 [B<-auth_level> I<level>]
99 [B<-attime> I<timestamp>]
100 [B<-ignore_critical>]
101 [B<-issuer_checks>]
102 [B<-policy_check>]
103 [B<-explicit_policy>]
104 [B<-inhibit_any>]
105 [B<-inhibit_map>]
106 [B<-x509_strict>]
107 [B<-extended_crl>]
108 [B<-use_deltas>]
109 [B<-policy_print>]
110 [B<-check_ss_sig>]
111 [B<-crl_check>]
112 [B<-crl_check_all>]
113 [B<-trusted_first>]
114 [B<-suiteB_128_only>]
115 [B<-suiteB_128>]
116 [B<-suiteB_192>]
117 [B<-partial_chain>]
118 [B<-no_alt_chains>]
119 [B<-no_check_time>]
120 [B<-allow_proxy_certs>]
121
122 [B<-port> I<number>]
123 [B<-max_msgs> I<number>]
124 [B<-srv_ref> I<value>]
125 [B<-srv_secret> I<arg>]
126 [B<-srv_cert> I<filename>]
127 [B<-srv_key> I<filename>]
128 [B<-srv_keypass> I<arg>]
129 [B<-srv_trusted> I<filenames>]
130 [B<-srv_untrusted> I<filenames>]
131 [B<-rsp_cert> I<filename>]
132 [B<-rsp_extracerts> I<filenames>]
133 [B<-rsp_capubs> I<filenames>]
134 [B<-poll_count> I<number>]
135 [B<-check_after> I<number>]
136 [B<-grant_implicitconf>]
137 [B<-pkistatus> I<number>]
138 [B<-failure> I<number>]
139 [B<-failurebits> I<number>]
140 [B<-statusstring> I<arg>]
141 [B<-send_error>]
142 [B<-send_unprotected>]
143 [B<-send_unprot_err>]
144 [B<-accept_unprotected>]
145 [B<-accept_unprot_err>]
146 [B<-accept_raverified>]
147
148 =head1 DESCRIPTION
149
150 The B<cmp> command is a client implementation for the Certificate
151 Management Protocol (CMP) as defined in RFC4210.
152 It can be used to request certificates from a CA server,
153 update their certificates,
154 request certificates to be revoked, and perform other CMP requests.
155
156 =head1 OPTIONS
157
158 =over 4
159
160 =item B<-help>
161
162 Display a summary of all options
163
164 =item B<-config> I<filename>
165
166 Configuration file to use.
167 An empty string C<""> means none.
168 Default filename is from the environment variable C<OPENSSL_CONF>.
169
170 =item B<-section> I<names>
171
172 Section(s) to use within config file defining CMP options.
173 An empty string C<""> means no specific section.
174 Default is C<cmp>.
175 Multiple section names may be given, separated by commas and/or whitespace
176 (where in the latter case the whole argument must be enclosed in "...").
177 Contents of sections named later may override contents of sections named before.
178 In any case, as usual, the C<[default]> section and finally the unnamed
179 section (as far as present) can provide per-option fallback values.
180
181 =back
182
183
184 =head2 Generic message options
185
186 =over 4
187
188 =item B<-cmd> I<ir|cr|kur|p10cr|rr|genm>
189
190 CMP command to execute.
191 Currently implemented commands are:
192
193 =over 8
194
195 =item  ir E<nbsp>  - Initialization Request
196
197 =item  cr E<nbsp>  - Certificate Request
198
199 =item  p10cr - PKCS#10 Certification Request (for legacy support)
200
201 =item  kur E<nbsp>E<nbsp>- Key Update Request
202
203 =item  rr E<nbsp>  - Revocation Request
204
205 =item  genm  - General Message
206
207 =back
208
209 B<ir> requests initialization of an End Entity into a PKI hierarchy by means of
210 issuance of a first certificate.
211
212 B<cr> requests issuance of an additional certificate for an End Entity already
213 initialized to the PKI hierarchy.
214
215 B<p10cr> requests issuance of an additional certificate similarly to B<cr>
216 but uses PKCS#10 CSR format.
217
218 B<kur> requests (key) update for an existing, given certificate.
219
220 B<rr> requests revocation of an existing, given certificate.
221
222 B<genm> requests information using a General Message, where optionally
223 included B<InfoTypeAndValue>s may be used to state which info is of interest.
224 Upon receipt of the General Response, information about all received
225 ITAV B<infoType>s is printed to stdout.
226
227 =item B<-infotype> I<name>
228
229 Set InfoType name to use for requesting specific info in B<genm>,
230 e.g., C<signKeyPairTypes>.
231
232 =item B<-geninfo> I<OID:int:N>
233
234 generalInfo integer values to place in request PKIHeader with given OID,
235 e.g., C<1.2.3:int:987>.
236
237 =back
238
239
240 =head2 Certificate request options
241
242 =over 4
243
244 =item B<-newkey> I<filename>
245
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.
251
252 =item B<-newkeypass> I<arg>
253
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.
256
257 For more information about the format of B<arg> see the
258 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
259
260 =item B<-subject> I<name>
261
262 X509 Distinguished Name (DN) of subject to use in the requested certificate
263 template.
264 For KUR, it defaults to the subject DN of the reference certificate
265 (see B<-oldcert>).
266 This default is used for IR and CR only if no SANs are set.
267
268 The argument must be formatted as I</type0=value0/type1=value1/type2=...>,
269 characters may be escaped by C<\>E<nbsp>(backslash), no spaces are skipped.
270
271 The subject DN is also used as fallback sender of outgoing CMP messages
272 if no B<-cert> and no B<-oldcert> are given.
273
274 =item B<-issuer> I<name>
275
276 X509 issuer Distinguished Name (DN) of the CA server
277 to place in the requested certificate template in IR/CR/KUR.
278
279 The argument must be formatted as I</type0=value0/type1=value1/type2=...>,
280 characters may be escaped by C<\>E<nbsp>(backslash), no spaces are skipped.
281
282 If neither B<-srvcert> nor B<-recipient> is available,
283 the name given in this option is also set as the recipient of the CMP message.
284
285 =item B<-days> I<number>
286
287 Number of days the new certificate is requested to be valid for, counting from
288 the current time of the host.
289 Also triggers the explicit request that the
290 validity period starts from the current time (as seen by the host).
291
292 =item B<-reqexts> I<name>
293
294 Name of section in OpenSSL config file defining certificate request extensions.
295
296 =item B<-sans> I<spec>
297
298 One or more IP addresses, DNS names, or URIs separated by commas or whitespace
299 (where in the latter case the whole argument must be enclosed in "...")
300 to add as Subject Alternative Name(s) (SAN) certificate request extension.
301 If the special element "critical" is given the SANs are flagged as critical.
302 Cannot be used if any Subject Alternative Name extension is set via B<-reqexts>.
303
304 =item B<-san_nodefault>
305
306 When Subject Alternative Names are not given via B<-sans>
307 nor defined via B<-reqexts>,
308 they are copied by default from the reference certificate (see B<-oldcert>).
309 This can be disabled by giving the B<-san_nodefault> option.
310
311 =item B<-policies> I<name>
312
313 Name of section in OpenSSL config file defining policies to be set
314 as certificate request extension.
315 This option cannot be used together with B<-policy_oids>.
316
317 =item B<-policy_oids> I<names>
318
319 One or more OID(s), separated by commas and/or whitespace
320 (where in the latter case the whole argument must be enclosed in "...")
321 to add as certificate policies request extension.
322 This option cannot be used together with B<-policies>.
323
324 =item B<-policy_oids_critical>
325
326 Flag the policies given with B<-policy_oids> as critical.
327
328 =item B<-popo> I<number>
329
330 Proof-of-Possession (POPO) method to use for IR/CR/KUR; values: C<-1>..<2> where
331 C<-1> = NONE, C<0> = RAVERIFIED, C<1> = SIGNATURE (default), C<2> = KEYENC.
332
333 Note that a signature-based POPO can only be produced if a private key
334 is provided via the B<-newkey> or B<-key> options.
335
336 =item B<-csr> I<filename>
337
338 CSR in PKCS#10 format to use in legacy P10CR messages.
339
340 =item B<-out_trusted> I<filenames>
341
342 Trusted certificate(s) to use for verifying the newly enrolled certificate.
343
344 Multiple filenames may be given, separated by commas and/or whitespace
345 (where in the latter case the whole argument must be enclosed in "...").
346 Each source may contain multiple certificates.
347
348 =item B<-verify_hostname> I<name>
349
350 When verification of the newly enrolled certificate is enabled (with the
351 B<-out_trusted> option), check if any DNS Subject Alternative Name (or if no
352 DNS SAN is included, the Common Name in the subject) equals the given B<name>.
353
354 =item B<-verify_ip> I<ip>
355
356 When verification of the newly enrolled certificate is enabled (with the
357 B<-out_trusted> option), check if there is
358 an IP address Subject Alternative Name matching the given IP address.
359
360 =item B<-verify_email> I<email>
361
362 When verification of the newly enrolled certificate is enabled (with the
363 B<-out_trusted> option), check if there is
364 an email address Subject Alternative Name matching the given email address.
365
366 =item B<-implicit_confirm>
367
368 Request implicit confirmation of newly enrolled certificates.
369
370 =item B<-disable_confirm>
371
372 Do not send certificate confirmation message for newly enrolled certificate
373 without requesting implicit confirmation
374 to cope with broken servers not supporting implicit confirmation correctly.
375 B<WARNING:> This leads to behavior violating RFC 4210.
376
377 =item B<-certout> I<filename>
378
379 The file where the newly enrolled certificate should be saved.
380
381 =back
382
383
384 =head2 Certificate revocation options
385
386 =over 4
387
388 =item B<-oldcert> I<filename>
389
390 The certificate to be updated (i.e., renewed or re-keyed) in Key Update Request
391 (KUR) messages or to be revoked in Revocation Request (RR) messages.
392 It must be given for RR, while for KUR it defaults to B<-cert>.
393
394 The reference certificate determined in this way, if any, is also used for
395 deriving default subject DN and Subject Alternative Names for IR, CR, and KUR.
396 Its subject is used as sender in CMP message headers if B<-cert> is not given.
397 Its issuer is used as default recipient in CMP message headers
398 if neither B<-recipient>, B<-srvcert>, nor B<-issuer> is given.
399
400 =item B<-revreason> I<number>
401
402 Set CRLReason to be included in revocation request (RR); values: C<0>..C<10>
403 or C<-1> for none (which is the default).
404
405 Reason numbers defined in RFC 5280 are:
406
407    CRLReason ::= ENUMERATED {
408         unspecified             (0),
409         keyCompromise           (1),
410         cACompromise            (2),
411         affiliationChanged      (3),
412         superseded              (4),
413         cessationOfOperation    (5),
414         certificateHold         (6),
415         -- value 7 is not used
416         removeFromCRL           (8),
417         privilegeWithdrawn      (9),
418         aACompromise           (10)
419     }
420
421 =back
422
423
424 =head2 Message transfer options
425
426 =over 4
427
428 =item B<-server> I<[http[s]://]address[:port]>
429
430 The IP address or DNS hostname and optionally port (defaulting to 80 or 443)
431 of the CMP server to connect to using HTTP(S) transport.
432 The optional "http://" or "https://" prefix is ignored.
433
434 =item B<-proxy> I<[http[s]://]address[:port][/path]>
435
436 The HTTP(S) proxy server to use for reaching the CMP server unless B<no_proxy>
437 applies, see below.
438 The optional "http://" or "https://" prefix and any trailing path are ignored.
439 Defaults to the environment variable C<http_proxy> if set, else C<HTTP_PROXY>
440 in case no TLS is used, otherwise C<https_proxy> if set, else C<HTTPS_PROXY>.
441
442 =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>.
447
448 =item B<-path> I<remote_path>
449
450 HTTP path at the CMP server (aka CMP alias) to use for POST requests.
451 Defaults to "/".
452
453 =item B<-msg_timeout> I<seconds>
454
455 Number of seconds (or 0 for infinite) a CMP request-response message round trip
456 is allowed to take before a timeout error is returned.
457 Default is 120.
458
459 =item B<-total_timeout> I<seconds>
460
461 Maximum number seconds an overall enrollment transaction may take,
462 including attempts polling for certificates on C<waiting> PKIStatus.
463 Default is 0 (infinite).
464
465 =back
466
467
468 =head2 Server authentication options
469
470 =over 4
471
472 =item B<-trusted> I<filenames>
473
474 When verifying signature-based protection of CMP response messages,
475 these are the CA certificate(s) to trust while checking certificate chains
476 during CMP server authentication.
477 This option gives more flexibility than the B<-srvcert> option because the
478 protection certificate is not pinned but may be any certificate
479 for which a chain to one of the given trusted certificates can be constructed.
480
481 Multiple filenames may be given, separated by commas and/or whitespace
482 (where in the latter case the whole argument must be enclosed in "...").
483 Each source may contain multiple certificates.
484
485 =item B<-untrusted> I<sources>
486
487 Non-trusted intermediate certificate(s) that may be useful
488 for constructing the TLS client certificate chain (if TLS is enabled) and
489 for building certificate chains while verifying the CMP server certificate
490 (when checking signature-based CMP message protection)
491 and while verifying the newly enrolled certificate.
492 These may get added to the extraCerts field sent in requests as far as needed.
493
494 Multiple filenames may be given, separated by commas and/or whitespace.
495 Each file may contain multiple certificates.
496
497 =item B<-srvcert> I<filename>
498
499 The specific CMP server certificate to expect and directly trust (even if it is
500 expired) when verifying signature-based protection of CMP response messages.
501 May be set alternatively to the B<-trusted> option to pin the accepted server.
502
503 If set, the subject of the certificate is also used
504 as default value for the recipient of CMP requests
505 and as default value for the expected sender of CMP responses.
506
507 =item B<-recipient> I<name>
508
509 Distinguished Name (DN) to use in the recipient field of CMP request messages,
510 i.e., the CMP server (usually a CA or RA entity).
511
512 The argument must be formatted as I</type0=value0/type1=value1/type2=...>,
513 characters may be escaped by C<\>E<nbsp>(backslash), no spaces are skipped.
514
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.
522
523 =item B<-expect_sender> I<name>
524
525 Distinguished Name (DN) expected in the sender field of CMP response messages.
526 Defaults to the subject DN of the pinned B<-srvcert>, if any.
527
528 The argument must be formatted as I</type0=value0/type1=value1/type2=...>,
529 characters may be escaped by C<\>E<nbsp>(backslash), no spaces are skipped.
530
531 This can be used to make sure that only a particular entity is accepted as
532 CMP message signer, and attackers are not able to use arbitrary certificates
533 of a trusted PKI hierarchy to fraudulently pose as a CMP server.
534 Note that this option gives slightly more freedom than setting the B<-srvcert>,
535 which pins the server to the holder of a particular certificate, while the
536 expected sender name will continue to match after updates of the server cert.
537
538 =item B<-ignore_keyusage>
539
540 Ignore key usage restrictions in CMP signer certificates when verifying
541 signature-based protection of incoming CMP messages,
542 else C<digitalSignature> must be allowed for signer certificate.
543
544 =item B<-unprotected_errors>
545
546 Accept missing or invalid protection of negative responses from the server.
547 This applies to the following message types and contents:
548
549 =over 4
550
551 =item * error messages
552
553 =item * negative certificate responses (IP/CP/KUP)
554
555 =item * negative revocation responses (RP)
556
557 =item * negative PKIConf messages
558
559 =back
560
561 B<WARNING:> This setting leads to unspecified behavior and it is meant
562 exclusively to allow interoperability with server implementations violating
563 RFC 4210, e.g.:
564
565 =over 4
566
567 =item * section 5.1.3.1 allows exceptions from protecting only for special
568 cases:
569 "There MAY be cases in which the PKIProtection BIT STRING is deliberately not
570 used to protect a message [...] because other protection, external to PKIX, will
571 be applied instead."
572
573 =item * section 5.3.21 is clear on ErrMsgContent: "The CA MUST always sign it
574 with a signature key."
575
576 =item * appendix D.4 shows PKIConf message having protection
577
578 =back
579
580 =item B<-extracertsout> I<filename>
581
582 The file where to save any extra certificates received in the extraCerts field
583 of response messages.
584
585 =item B<-cacertsout> I<filename>
586
587 The file where to save any CA certificates received in the caPubs field of
588 Initializiation Response (IP) messages.
589
590 =back
591
592
593 =head2 Client authentication options
594
595 =over 4
596
597 =item B<-ref> I<value>
598
599 Reference number/string/value to use as fallback senderKID; this is required
600 if no sender name can be determined from the B<-cert> or <-subject> options and
601 is typically used when authenticating with pre-shared key (password-based MAC).
602
603 =item B<-secret> I<arg>
604
605 Source of secret value to use for creating PBM-based protection of outgoing
606 messages and for verifying any PBM-based protection of incoming messages.
607 PBM stands for Password-Based Message Authentication Code.
608 This takes precedence over the B<-cert> option.
609
610 For more information about the format of B<arg> see the
611 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
612
613 =item B<-cert> I<filename>
614
615 The client's current certificate.
616 Requires the corresponding key to be given with B<-key>.
617 The subject of this certificate will be used as the "sender" field
618 of outgoing CMP messages, while B<-subjectName> may provide a fallback value.
619 When using signature-based message protection, this "protection certificate"
620 will be included first in the extraCerts field of outgoing messages.
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 These may get added to the extraCerts field sent in requests as far as needed.
627
628 =item B<-key> I<filename>
629
630 The corresponding private key file for the client's current certificate given in
631 the B<-cert> option.
632 This will be used for signature-based message protection unless
633 the B<-secret> option indicating PBM or B<-unprotected_requests> is given.
634
635 =item B<-keypass> I<arg>
636
637 Pass phrase source for the private key given with the B<-key> option.
638 Also used for B<-cert> and B<-oldcert> in case it is an encrypted PKCS#12 file.
639 If not given here, the password will be prompted for if needed.
640
641 For more information about the format of B<arg> see the
642 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
643
644 =item B<-digest> I<name>
645
646 Specifies name of supported digest to use in RFC 4210's MSG_SIG_ALG
647 and as the one-way function (OWF) in MSG_MAC_ALG.
648 If applicable, this is used for message protection and
649 Proof-of-Possession (POPO) signatures.
650 To see the list of supported digests, use B<openssl list -digest-commands>.
651 Defaults to C<sha256>.
652
653 =item B<-mac> I<name>
654
655 Specifies the name of the MAC algorithm in MSG_MAC_ALG.
656 To get the names of supported MAC algorithms use B<openssl list -mac-algorithms>
657 and possibly combine such a name with the name of a supported digest algorithm,
658 e.g., hmacWithSHA256.
659 Defaults to C<hmac-sha1> as per RFC 4210.
660
661 =item B<-extracerts> I<sources>
662
663 Certificates to append in the extraCerts field when sending messages.
664
665 Multiple filenames or URLs may be given, separated by commas and/or whitespace
666 (where in the latter case the whole argument must be enclosed in "...").
667 Each source may contain multiple certificates.
668
669 =item B<-unprotected_requests>
670
671 Send messages without CMP-level protection.
672
673 =back
674
675
676 =head2 Credentials format options
677
678 =over 4
679
680 =item B<-certform> I<PEM|DER>
681
682 File format to use when saving a certificate to a file.
683 Default value is PEM.
684
685 =item B<-keyform> I<PEM|DER|P12>
686
687 Format to assume when reading key files.
688 Default value is PEM.
689
690 =item B<-certsform> I<PEM|DER|P12>
691
692 Format to try first when reading multiple certificates from file(s).
693 Default value is PEM.
694
695 =item B<-otherpass> I<arg>
696
697 Pass phrase source for certificate given with the B<-trusted>, B<-untrusted>,
698 B<-out_trusted>, B<-extracerts>, B<-tls_extra>, or B<-tls_trusted> options.
699 If not given here, the password will be prompted for if needed.
700
701 For more information about the format of B<arg> see the
702 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
703
704 =item B<-engine> I<id>
705
706 Specifying a crypto engine B<id> will lead to obtaining a functional
707 reference to the specified engine, initializing it if needed.
708 The engine will be used for all algorithms supported for keys
709 prefixed by C<engine:>.
710 Engines may be defined in the OpenSSL config file as usual in an engine section.
711
712 Options specifying keys, like B<-key>, B<-newkey>, B<-tls_key> can prefix
713 C<engine:> to engine-specific identifiers for security tokens objects held by
714 the engine.
715  The following example utilizes the RFC 7512 PKCS #11 URI scheme
716 as supported, e.g., by libp11:
717 C<-key engine:pkcs11:object=my-private-key;type=private;pin-value=1234>
718
719 {- $OpenSSL::safe::opt_provider_item -}
720
721 =back
722
723
724 =head2 TLS options
725
726 =over 4
727
728 =item B<-tls_used>
729
730 Enable using TLS (even when other TLS_related options are not set)
731 when connecting to CMP server.
732
733 =item B<-tls_cert> I<filename>
734
735 Client's TLS certificate.
736 If the file includes further certificates,
737 they are used for constructing the client cert chain provided to the TLS server.
738
739 =item B<-tls_key> I<filename>
740
741 Private key for the client's TLS certificate.
742
743 =item B<-tls_keypass> I<arg>
744
745 Pass phrase source for client's private TLS key B<tls_key>.
746 Also used for B<-tls_cert> in case it is an encrypted PKCS#12 file.
747 If not given here, the password will be prompted for if needed.
748
749 For more information about the format of B<arg> see the
750 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
751
752 =item B<-tls_extra> I<filenames>
753
754 Extra certificates to provide to TLS server during TLS handshake
755
756 =item B<-tls_trusted> I<filenames>
757
758 Trusted certificate(s) to use for verifying the TLS server certificate.
759 This implies hostname validation.
760
761 Multiple filenames may be given, separated by commas and/or whitespace
762 (where in the latter case the whole argument must be enclosed in "...").
763 Each source may contain multiple certificates.
764
765 =item B<-tls_host> I<name>
766
767 Address to be checked during hostname validation. 
768 This may be a DNS name or an IP address.
769 If not given it defaults to the B<-server> address.
770
771 =back
772
773
774 =head2 Client-side debugging options
775
776 =over 4
777
778 =item B<-batch>
779
780 Do not interactively prompt for input, for instance when a password is needed.
781 This can be useful for batch processing and testing.
782
783 =item B<-repeat> I<number>
784
785 Invoke the command the given number of times with the same parameters.
786 Default is one invocation.
787
788 =item B<-reqin> I<filenames>
789
790 Take sequence of CMP requests from file(s).
791 Multiple filenames may be given, separated by commas and/or whitespace
792 (where in the latter case the whole argument must be enclosed in "...").
793 As many files are read as needed for a complete transaction.
794
795 =item B<-reqin_new_tid>
796
797 Use a fresh transactionID for CMP request messages read using B<-reqin>,
798 which requires re-protecting them as far as they were protected before.
799 This may be needed in case the sequence of requests is reused
800 and the CMP server complains that the transaction ID has already been used.
801
802 =item B<-reqout> I<filenames>
803
804 Save sequence of CMP requests to file(s).
805 Multiple filenames may be given, separated by commas and/or whitespace.
806 As many files are written as needed to store the complete transaction.
807
808 =item B<-rspin> I<filenames>
809
810 Process sequence of CMP responses provided in file(s), skipping server.
811 Multiple filenames may be given, separated by commas and/or whitespace.
812 As many files are read as needed for the complete transaction.
813
814 =item B<-rspout> I<filenames>
815
816 Save sequence of CMP responses to file(s).
817 Multiple filenames may be given, separated by commas and/or whitespace.
818 As many files are written as needed to store the complete transaction.
819
820 =item B<-use_mock_srv>
821
822 Use the internal mock server for testing the client.
823 This works at API level, bypassing HTTP transport.
824
825 =back
826
827
828 =head2 Certificate verification options, for both CMP and TLS
829
830 =over 4
831
832 =item B<-policy>, B<-purpose>, B<-verify_name>, B<-verify_depth>,
833 B<-attime>,
834 B<-ignore_critical>, B<-issuer_checks>,
835 B<-policy_check>,
836 B<-explicit_policy>, B<-inhibit_any>, B<-inhibit_map>,
837 B<-x509_strict>, B<-extended_crl>, B<-use_deltas>,
838 B<-policy_print>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
839 B<-trusted_first>,
840 B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192>,
841 B<-partial_chain>, B<-no_alt_chains>, B<-no_check_time>,
842 B<-auth_level>,
843 B<-allow_proxy_certs>
844
845 Set various options of certificate chain verification.
846 See L<openssl(1)/Verification Options> for details.
847
848 =back
849
850
851 =head2 Mock server options, for testing purposes only
852
853 =over 4
854
855 =item B<-port> I<number>
856
857 Act as CMP HTTP server mock-up listening on the given port.
858
859 =item B<-max_msgs> I<number>
860
861 Maximum number of CMP (request) messages the CMP HTTP server mock-up
862 should handle, which must be non-negative.
863 The default value is 0, which means that no limit is imposed.
864 In any case the server terminates on internal errors, but not when it
865 detects a CMP-level error that it can successfully answer with an error message.
866
867 =item B<-srv_ref> I<value>
868
869 Reference value to use as senderKID of server in case no B<-srv_cert> is given.
870
871 =item B<-srv_secret> I<arg>
872
873 Password source for server authentication with a pre-shared key (secret).
874
875 =item B<-srv_cert> I<filename>
876
877 Certificate of the server.
878
879 =item B<-srv_key> I<filename>
880
881 Private key used by the server for signing messages.
882
883 =item B<-srv_keypass> I<arg>
884
885 Server private key (and cert) file pass phrase source.
886
887 =item B<-srv_trusted> I<filenames>
888
889 Trusted certificates for client authentication.
890
891 =item B<-srv_untrusted> I<filenames>
892
893 Intermediate CA certs that may be useful when verifying client certificates.
894
895 =item B<-rsp_cert> I<filename>
896
897 Certificate to be returned as mock enrollment result.
898
899 =item B<-rsp_extracerts> I<filenames>
900
901 Extra certificates to be included in mock certification responses.
902
903 =item B<-rsp_capubs> I<filenames>
904
905 CA certificates to be included in mock Initialization Response (IP) message.
906
907 =item B<-poll_count> I<number>
908
909 Number of times the client must poll before receiving a certificate.
910
911 =item B<-check_after> I<number>
912
913 The checkAfter value (number of seconds to wait) to include in poll response.
914
915
916 =item B<-grant_implicitconf>
917
918 Grant implicit confirmation of newly enrolled certificate.
919
920 =item B<-pkistatus> I<number>
921
922 PKIStatus to be included in server response.
923 Valid range is 0 (accepted) .. 6 (keyUpdateWarning).
924
925 =item B<-failure> I<number>
926
927 A single failure info bit number to be included in server response.
928 Valid range is 0 (badAlg) .. 26 (duplicateCertReq).
929
930 =item B<-failurebits> I<number>
931 Number representing failure bits to be included in server response.
932 Valid range is 0 .. 2^27 - 1.
933
934 =item B<-statusstring> I<arg>
935
936 Text to be included as status string in server response.
937
938 =item B<-send_error>
939
940 Force server to reply with error message.
941
942 =item B<-send_unprotected>
943
944 Send response messages without CMP-level protection.
945
946 =item B<-send_unprot_err>
947
948 In case of negative responses, server shall send unprotected error messages,
949 certificate responses (IP/CP/KUP), and revocation responses (RP).
950 WARNING: This setting leads to behavior violating RFC 4210.
951
952 =item B<-accept_unprotected>
953
954 Accept missing or invalid protection of requests.
955
956 =item B<-accept_unprot_err>
957
958 Accept unprotected error messages from client.
959
960 =item B<-accept_raverified>
961
962 Accept RAVERIFED as proof-of-possession (POPO).
963
964 =back
965
966
967 =head1 NOTES
968
969 When setting up CMP configurations and experimenting with enrollment options
970 typically various errors occur until the configuration is correct and complete.
971 When the CMP server reports an error the client will by default
972 check the protection of the CMP response message.
973 Yet some CMP services tend not to protect negative responses.
974 In this case the client will reject them, and thus their contents are not shown
975 although they usually contain hints that would be helpful for diagnostics.
976 For assisting in such cases the CMP client offers a workaround via the
977 B<-unprotected_errors> option, which allows accepting such negative messages.
978
979
980 =head1 EXAMPLES
981
982 =head2 Simple examples using the default OpenSSL configuration file
983
984 This CMP client implementation comes with demonstrative CMP sections
985 in the example configuration file F<openssl/apps/openssl.cnf>,
986 which can be used to interact conveniently with the Insta Demo CA.
987
988 In order to enroll an initial certificate from that CA it is sufficient
989 to issue the following shell commands.
990
991   cd /path/to/openssl
992   export OPENSSL_CONF=openssl.cnf
993   wget 'http://pki.certificate.fi:8080/install-ca-cert.html/ca-certificate.crt\
994         ?ca-id=632&download-certificate=1' -O insta.ca.crt
995   openssl genrsa -out insta.priv.pem
996   openssl cmp -section insta
997
998 This should produce the file F<insta.cert.pem> containing a new certificate
999 for the private key held in F<insta.priv.pem>.
1000 It can be viewed using, e.g.,
1001
1002   openssl x509 -noout -text -in insta.cert.pem
1003
1004 In case the network setup requires using an HTTP proxy it may be given as usual
1005 via the environment variable B<http_proxy> or via the B<proxy> option or
1006 the CMP command-line argument B<-proxy>, for example
1007
1008   -proxy http://192.168.1.1:8080
1009
1010 In the Insta Demo CA scenario both clients and the server may use the pre-shared
1011 secret "insta" and the reference value "3078" to authenticate to each other.
1012
1013 Alternatively, CMP messages may be protected in signature-based manner,
1014 where the trust anchor in this case is F<insta.ca.crt>
1015 and the client may use any certificate already obtained from that CA,
1016 as specified in the B<[signature]> section of the example configuration.
1017 This can be used in combination with the B<[insta]> section simply by
1018
1019   openssl cmp -section insta,signature
1020
1021 By default the CMP IR message type is used, yet CR works equally here.
1022 This may be specified directly at the command line:
1023
1024   openssl cmp -section insta -cmd cr
1025
1026 or by referencing in addition the B<[cr]> section of the example configuration:
1027
1028   openssl cmp -section insta,cr
1029
1030 In order to update the enrolled certificate one may call
1031
1032   openssl cmp -section insta,kur
1033
1034 using with PBM-based protection or
1035
1036   openssl cmp -section insta,kur,signature
1037
1038 using signature-based protection.
1039
1040 In a similar way any previously enrolled certificate may be revoked by
1041
1042   openssl cmp -section insta,rr -trusted insta.ca.crt
1043
1044 or
1045
1046   openssl cmp -section insta,rr,signature
1047
1048 Many more options can be used in the configuration file
1049 and/or on the command line.
1050
1051
1052 =head2 Certificate enrollment
1053
1054 The following examples at first do not make use of a configuration file.
1055 They assume that a CMP server can be contacted on the local TCP port 80
1056 and accepts requests under the alias "/pkix/".
1057
1058 For enrolling its very first certificate the client generates a first client key
1059 and sends an initial request message to the local CMP server
1060 using a pre-shared secret key for mutual authentication.
1061 In this example the client does not have the CA certificate yet,
1062 so we specify the name of the CA with the B<-recipient> option
1063 and save any CA certificates that we may receive in the C<capubs.pem> file.
1064
1065 In below command line usage examples the C<\> at line ends is just used
1066 for formatting; each of the command invocations should be on a single line.
1067
1068   openssl genrsa -out cl_key.pem
1069   openssl cmp -cmd ir -server 127.0.0.1:80 -path pkix/ \
1070     -ref 1234 -secret pass:1234-5678-1234-5678 \
1071     -recipient "/CN=CMPserver" \
1072     -newkey cl_key.pem -subject "/CN=MyName" \
1073     -cacertsout capubs.pem -certout cl_cert.pem
1074
1075
1076 =head2 Certificate update
1077
1078 Then, when the client certificate and its related key pair needs to be updated,
1079 the client can send a key update request taking the certs in C<capubs.pem>
1080 as trusted for authenticating the server and using the previous cert and key
1081 for its own authentication.
1082 Then it can start using the new cert and key.
1083
1084   openssl genrsa -out cl_key_new.pem
1085   openssl cmp -cmd kur -server 127.0.0.1:80 -path pkix/ \
1086     -trusted capubs.pem \
1087     -cert cl_cert.pem -key cl_key.pem \
1088     -newkey cl_key_new.pem -certout cl_cert.pem
1089   cp cl_key_new.pem cl_key.pem
1090
1091 This command sequence can be repated as often as needed.
1092
1093
1094 =head2 Requesting information from CMP server
1095
1096 Requesting "all relevant information" with an empty General Message.
1097 This prints information about all received ITAV B<infoType>s to stdout.
1098
1099   openssl cmp -cmd genm -server 127.0.0.1 -path pkix/ \
1100     -ref 1234 -secret pass:1234-5678-1234-5678 \
1101     -recipient "/CN=CMPserver"
1102
1103
1104 =head2 Using a custom configuration file
1105
1106 For CMP client invocations, in particular for certificate enrollment,
1107 usually many parameters need to be set, which is tedious and error-prone to do
1108 on the command line.
1109 Therefore the client offers the possibility to read
1110 options from sections of the OpenSSL config file, usually called B<openssl.cnf>.
1111 The values found there can still be extended and even overridden by any
1112 subsequently loaded sections and on the command line.
1113
1114 After including in the configuration file the following sections:
1115
1116   [cmp]
1117   server = 127.0.0.1
1118   path = pkix/
1119   trusted = capubs.pem
1120   cert = cl_cert.pem
1121   key = cl_key.pem
1122   newkey = cl_key.pem
1123   certout = cl_cert.pem
1124
1125   [cmp-init]
1126   recipient = "/CN=CMPserver"
1127   trusted =
1128   cert =
1129   key =
1130   ref = 1234
1131   secret = pass:1234-5678-1234-567
1132   subject = "/CN=MyName"
1133   cacertsout = capubs.pem
1134
1135 the above enrollment invocations reduce to
1136
1137   openssl cmp -section cmp,cmp-init
1138   openssl cmp -cmd kur -newkey cl_key_new.pem
1139
1140 and the above genm call reduces to
1141
1142   openssl cmp -section cmp,cmp-init -cmd genm
1143
1144 =head1 SEE ALSO
1145
1146 L<openssl-genrsa(1)>, L<openssl-ecparam(1)>, L<openssl-list(1)>,
1147 L<openssl-req(1)>, L<openssl-x509(1)>, L<x509v3_config(5)>
1148
1149 =head1 COPYRIGHT
1150
1151 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
1152
1153 Licensed under the OpenSSL license (the "License").  You may not use
1154 this file except in compliance with the License.  You can obtain a copy
1155 in the file LICENSE in the source distribution or at
1156 L<https://www.openssl.org/source/license.html>.
1157
1158 =cut