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