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