8 OSSL_CMP_CTX_set_option,
9 OSSL_CMP_CTX_get_option,
10 OSSL_CMP_CTX_set_log_cb,
11 OSSL_CMP_CTX_set_log_verbosity,
12 OSSL_CMP_CTX_print_errors,
13 OSSL_CMP_CTX_set1_serverPath,
14 OSSL_CMP_CTX_set1_server,
15 OSSL_CMP_CTX_set_serverPort,
16 OSSL_CMP_CTX_set1_proxy,
17 OSSL_CMP_CTX_set1_no_proxy,
18 OSSL_CMP_CTX_set_http_cb,
19 OSSL_CMP_CTX_set_http_cb_arg,
20 OSSL_CMP_CTX_get_http_cb_arg,
21 OSSL_CMP_transfer_cb_t,
22 OSSL_CMP_CTX_set_transfer_cb,
23 OSSL_CMP_CTX_set_transfer_cb_arg,
24 OSSL_CMP_CTX_get_transfer_cb_arg,
25 OSSL_CMP_CTX_set1_srvCert,
26 OSSL_CMP_CTX_set1_expected_sender,
27 OSSL_CMP_CTX_set0_trustedStore,
28 OSSL_CMP_CTX_get0_trustedStore,
29 OSSL_CMP_CTX_set1_untrusted_certs,
30 OSSL_CMP_CTX_get0_untrusted_certs,
31 OSSL_CMP_CTX_set1_cert,
32 OSSL_CMP_CTX_set1_pkey,
33 OSSL_CMP_CTX_set1_referenceValue,
34 OSSL_CMP_CTX_set1_secretValue,
35 OSSL_CMP_CTX_set1_recipient,
36 OSSL_CMP_CTX_push0_geninfo_ITAV,
37 OSSL_CMP_CTX_set1_extraCertsOut,
38 OSSL_CMP_CTX_set0_newPkey,
39 OSSL_CMP_CTX_get0_newPkey,
40 OSSL_CMP_CTX_set1_issuer,
41 OSSL_CMP_CTX_set1_subjectName,
42 OSSL_CMP_CTX_push1_subjectAltName,
43 OSSL_CMP_CTX_set0_reqExtensions,
44 OSSL_CMP_CTX_reqExtensions_have_SAN,
45 OSSL_CMP_CTX_push0_policy,
46 OSSL_CMP_CTX_set1_oldCert,
47 OSSL_CMP_CTX_set1_p10CSR,
48 OSSL_CMP_CTX_push0_genm_ITAV,
49 OSSL_CMP_certConf_cb_t,
50 OSSL_CMP_CTX_set_certConf_cb,
51 OSSL_CMP_CTX_set_certConf_cb_arg,
52 OSSL_CMP_CTX_get_certConf_cb_arg,
53 OSSL_CMP_CTX_get_status,
54 OSSL_CMP_CTX_get0_statusString,
55 OSSL_CMP_CTX_get_failInfoCode,
56 OSSL_CMP_CTX_get0_newCert,
57 OSSL_CMP_CTX_get1_newChain,
58 OSSL_CMP_CTX_get1_caPubs,
59 OSSL_CMP_CTX_get1_extraCertsIn,
60 OSSL_CMP_CTX_set1_transactionID,
61 OSSL_CMP_CTX_set1_senderNonce
62 - functions for managing the CMP client context data structure
66 #include <openssl/cmp.h>
68 OSSL_CMP_CTX *OSSL_CMP_CTX_new(OPENSSL_CTX *libctx, const char *propq);
69 void OSSL_CMP_CTX_free(OSSL_CMP_CTX *ctx);
70 int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX *ctx);
71 int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX *ctx, int opt, int val);
72 int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX *ctx, int opt);
74 /* logging and error reporting: */
75 int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_log_cb_t cb);
76 #define OSSL_CMP_CTX_set_log_verbosity(ctx, level)
77 void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX *ctx);
79 /* message transfer: */
80 int OSSL_CMP_CTX_set1_serverPath(OSSL_CMP_CTX *ctx, const char *path);
81 int OSSL_CMP_CTX_set1_server(OSSL_CMP_CTX *ctx, const char *address);
82 int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX *ctx, int port);
83 int OSSL_CMP_CTX_set1_proxy(OSSL_CMP_CTX *ctx, const char *name);
84 int OSSL_CMP_CTX_set1_no_proxy(OSSL_CMP_CTX *ctx, const char *names);
85 int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX *ctx, HTTP_bio_cb_t cb);
86 int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
87 void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX *ctx);
88 typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t)(OSSL_CMP_CTX *ctx,
89 const OSSL_CMP_MSG *req);
90 int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX *ctx,
91 OSSL_CMP_transfer_cb_t cb);
92 int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
93 void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX *ctx);
95 /* server authentication: */
96 int OSSL_CMP_CTX_set1_srvCert(OSSL_CMP_CTX *ctx, X509 *cert);
97 int OSSL_CMP_CTX_set1_expected_sender(OSSL_CMP_CTX *ctx,
98 const X509_NAME *name);
99 int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX *ctx, X509_STORE *store);
100 X509_STORE *OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX *ctx);
101 int OSSL_CMP_CTX_set1_untrusted_certs(OSSL_CMP_CTX *ctx,
102 STACK_OF(X509) *certs);
103 STACK_OF(X509) *OSSL_CMP_CTX_get0_untrusted_certs(const OSSL_CMP_CTX *ctx);
105 /* client authentication: */
106 int OSSL_CMP_CTX_set1_cert(OSSL_CMP_CTX *ctx, X509 *cert);
107 int OSSL_CMP_CTX_set1_pkey(OSSL_CMP_CTX *ctx, EVP_PKEY *pkey);
108 int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX *ctx,
109 const unsigned char *ref, int len);
110 int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX *ctx, const unsigned char *sec,
113 /* CMP message header and extra certificates: */
114 int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name);
115 int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
116 int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx,
117 STACK_OF(X509) *extraCertsOut);
119 /* certificate template: */
120 int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX *ctx, int priv, EVP_PKEY *pkey);
121 EVP_PKEY *OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX *ctx, int priv);
122 int OSSL_CMP_CTX_set1_issuer(OSSL_CMP_CTX *ctx, const X509_NAME *name);
123 int OSSL_CMP_CTX_set1_subjectName(OSSL_CMP_CTX *ctx, const X509_NAME *name);
124 int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX *ctx,
125 const GENERAL_NAME *name);
126 int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX *ctx, X509_EXTENSIONS *exts);
127 int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX *ctx);
128 int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX *ctx, POLICYINFO *pinfo);
129 int OSSL_CMP_CTX_set1_oldCert(OSSL_CMP_CTX *ctx, X509 *cert);
130 int OSSL_CMP_CTX_set1_p10CSR(OSSL_CMP_CTX *ctx, const X509_REQ *csr);
132 /* misc body contents: */
133 int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
135 /* certificate confirmation: */
136 typedef int (*OSSL_CMP_certConf_cb_t)(OSSL_CMP_CTX *ctx, X509 *cert,
137 int fail_info, const char **txt);
138 int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_certConf_cb_t cb);
139 int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
140 void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX *ctx);
142 /* result fetching: */
143 int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX *ctx);
144 OSSL_CMP_PKIFREETEXT *OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX *ctx);
145 int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX *ctx);
147 X509 *OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX *ctx);
148 STACK_OF(X509) *OSSL_CMP_CTX_get1_newChain(const OSSL_CMP_CTX *ctx);
149 STACK_OF(X509) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX *ctx);
150 STACK_OF(X509) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX *ctx);
152 /* for testing and debugging purposes: */
153 int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX *ctx,
154 const ASN1_OCTET_STRING *id);
155 int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX *ctx,
156 const ASN1_OCTET_STRING *nonce);
160 This is the context API for using CMP (Certificate Management Protocol) with
163 OSSL_CMP_CTX_new() allocates an B<OSSL_CMP_CTX> structure associated with
164 the library context I<libctx> and property query string I<propq>,
165 both of which may be NULL to select the defaults.
166 It initializes the remaining fields to their default values - for instance,
167 the logging verbosity is set to OSSL_CMP_LOG_INFO,
168 the message timeout is set to 120 seconds,
169 and the proof-of-possession method is set to OSSL_CRMF_POPO_SIGNATURE.
171 OSSL_CMP_CTX_free() deallocates an OSSL_CMP_CTX structure.
173 OSSL_CMP_CTX_reinit() prepares the given B<ctx> for a further transaction by
174 clearing the internal CMP transaction (aka session) status, PKIStatusInfo,
175 and any previous results (newCert, newChain, caPubs, and extraCertsIn)
176 from the last executed transaction.
177 All other field values (i.e., CMP options) are retained for potential re-use.
179 OSSL_CMP_CTX_set_option() sets the given value for the given option
180 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) in the given OSSL_CMP_CTX structure.
182 The following options can be set:
186 =item B<OSSL_CMP_OPT_LOG_VERBOSITY>
188 The level of severity needed for actually outputting log messages
189 due to errors, warnings, general info, debugging, etc.
190 Default is OSSL_CMP_LOG_INFO. See also L<OSSL_CMP_log_open(3)>.
192 =item B<OSSL_CMP_OPT_MSG_TIMEOUT>
194 Number of seconds (or 0 for infinite) a CMP message round trip is
195 allowed to take before a timeout error is returned. Default is 120.
197 =item B<OSSL_CMP_OPT_TOTAL_TIMEOUT>
199 Maximum total number of seconds an enrollment (including polling)
200 may take. Default is 0 (infinite).
202 =item B<OSSL_CMP_OPT_VALIDITY_DAYS>
204 Number of days new certificates are asked to be valid for.
206 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT>
208 Do not take default Subject Alternative Names
209 from the reference certificate.
211 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL>
213 Demand that the given Subject Alternative Names are flagged as critical.
215 =item B<OSSL_CMP_OPT_POLICIES_CRITICAL>
217 Demand that the given policies are flagged as critical.
219 =item B<OSSL_CMP_OPT_POPO_METHOD>
221 Select the proof of possession method to use. Possible values are:
223 OSSL_CRMF_POPO_NONE - ProofOfPossession field omitted
224 OSSL_CRMF_POPO_RAVERIFIED - assert that the RA has already
226 OSSL_CRMF_POPO_SIGNATURE - sign a value with private key,
227 which is the default.
228 OSSL_CRMF_POPO_KEYENC - decrypt the encrypted certificate
231 Note that a signature-based POPO can only be produced if a private key
232 is provided as the newPkey or client pkey component of the CMP context.
234 =item B<OSSL_CMP_OPT_DIGEST_ALGNID>
236 The NID of the digest algorithm to be used in RFC 4210's MSG_SIG_ALG
237 for signature-based message protection and Proof-of-Possession (POPO).
240 =item B<OSSL_CMP_OPT_OWF_ALGNID>
241 The NID of the digest algorithm to be used as one-way function (OWF)
242 in RFC 4210's MSG_MAC_ALG for PBM-based message protection.
245 =item B<OSSL_CMP_OPT_MAC_ALGNID>
246 The NID of the MAC algorithm to be used in RFC 4210's MSG_MAC_ALG
247 for PBM-based message protection.
248 Default is HMAC-SHA1 as per RFC 4210.
250 =item B<OSSL_CMP_OPT_REVOCATION_REASON>
252 The reason code to be included in a Revocation Request (RR);
253 values: 0..10 (RFC 5210, 5.3.1) or -1 for none, which is the default.
255 =item B<OSSL_CMP_OPT_IMPLICIT_CONFIRM>
257 Request server to enable implicit confirm mode, where the client
258 does not need to send confirmation upon receiving the
259 certificate. If the server does not enable implicit confirmation
260 in the return message, then confirmation is sent anyway.
262 =item B<OSSL_CMP_OPT_DISABLE_CONFIRM>
264 Do not confirm enrolled certificates, to cope with broken servers
265 not supporting implicit confirmation correctly.
266 B<WARNING:> This setting leads to unspecified behavior and it is meant
267 exclusively to allow interoperability with server implementations violating
270 =item B<OSSL_CMP_OPT_UNPROTECTED_SEND>
272 Send messages without CMP-level protection.
274 =item B<OSSL_CMP_OPT_UNPROTECTED_ERRORS>
276 Accept unprotected error responses which are either explicitly
277 unprotected or where protection verification failed. Applies to regular
278 error messages as well as certificate responses (IP/CP/KUP) and
279 revocation responses (RP) with rejection.
280 B<WARNING:> This setting leads to unspecified behavior and it is meant
281 exclusively to allow interoperability with server implementations violating
284 =item B<OSSL_CMP_OPT_IGNORE_KEYUSAGE>
286 Ignore key usage restrictions in signer certificate when
287 validating signature-based protection in received CMP messages.
288 Else, 'digitalSignature' must be allowed by CMP signer certificates.
290 =item B<OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR>
292 Allow retrieving a trust anchor from extraCerts and using that
293 to validate the certificate chain of an IP message.
297 OSSL_CMP_CTX_get_option() reads the current value of the given option
298 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) from the given OSSL_CMP_CTX structure.
300 OSSL_CMP_CTX_set_log_cb() sets in B<ctx> the callback function C<cb>
301 for handling error queue entries and logging messages.
302 When C<cb> is NULL errors are printed to STDERR (if available, else ignored)
303 any log messages are ignored.
304 Alternatively, L<OSSL_CMP_log_open(3)> may be used to direct logging to STDOUT.
306 OSSL_CMP_CTX_set_log_verbosity() is a macro setting the
307 OSSL_CMP_OPT_LOG_VERBOSITY context option to the given level.
309 OSSL_CMP_CTX_print_errors() outputs any entries in the OpenSSL error queue.
310 It is similar to B<ERR_print_errors_cb()> but uses the CMP log callback function
311 if set in the C<ctx> for uniformity with CMP logging if given. Otherwise it uses
312 B<ERR_print_errors(3)> to print to STDERR (unless OPENSSL_NO_STDIO is defined).
314 OSSL_CMP_CTX_set1_serverPath() sets the HTTP path of the CMP server on the host,
315 also known as "CMP alias".
318 OSSL_CMP_CTX_set1_server() sets the given server B<address>
319 (which may be a hostname or IP address or NULL) in the given B<ctx>.
321 OSSL_CMP_CTX_set_serverPort() sets the port of the CMP server to connect to.
322 If not used or the B<port> argument is 0
323 the default port applies, which is 80 for HTTP and 443 for HTTPS.
325 OSSL_CMP_CTX_set1_proxy() sets the HTTP proxy to be used for connecting to
326 the given CMP server unless overruled by any "no_proxy" settings (see below).
327 If TLS is not used this defaults to the value of
328 the environment variable B<http_proxy> if set, else B<HTTP_PROXY>.
329 Otherwise defaults to the value of B<https_proxy> if set, else B<HTTPS_PROXY>.
330 An empty proxy string specifies not to use a proxy.
331 Else the format is I<[http[s]://]address[:port][/path]>,
332 where any path given is ignored.
333 The default port number is 80, or 443 in case I<https:> is given.
335 OSSL_CMP_CTX_set1_no_proxy() sets the list of server hostnames not to use
336 an HTTP proxy for. The names may be separated by commas and/or whitespace.
337 Defaults to the environment variable B<no_proxy> if set, else B<NO_PROXY>.
339 OSSL_CMP_CTX_set_http_cb() sets the optional BIO connect/disconnect callback
340 function, which has the prototype
342 typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail);
344 The callback may modify the BIO B<bio> provided by OSSL_CMP_MSG_http_perform(),
345 whereby it may make use of a custom defined argument B<ctx>
346 stored in the OSSL_CMP_CTX by means of OSSL_CMP_CTX_set_http_cb_arg().
347 During connection establishment, just after calling BIO_do_connect_retry(),
348 the function is invoked with the B<connect> argument being 1 and the B<detail>
349 argument being 1 if HTTPS is requested, i.e., SSL/TLS should be enabled. On
350 disconnect B<connect> is 0 and B<detail> is 1 in case no error occurred, else 0.
351 For instance, on connect the function may prepend a TLS BIO to implement HTTPS;
352 after disconnect it may do some diagnostic output and/or specific cleanup.
353 The function should return NULL to indicate failure.
354 After disconnect the modified BIO will be deallocated using BIO_free_all().
356 OSSL_CMP_CTX_set_http_cb_arg() sets an argument, respectively a pointer to
357 a structure containing arguments,
358 optionally to be used by the http connect/disconnect callback function.
359 B<arg> is not consumed, and it must therefore explicitly be freed when not
360 needed any more. B<arg> may be NULL to clear the entry.
362 OSSL_CMP_CTX_get_http_cb_arg() gets the argument, respectively the pointer to a
363 structure containing arguments, previously set by
364 OSSL_CMP_CTX_set_http_cb_arg() or NULL if unset.
366 OSSL_CMP_CTX_set_transfer_cb() sets the message transfer callback function,
369 typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx,
370 const OSSL_CMP_MSG *req);
372 Returns 1 on success, 0 on error.
374 Default is NULL, which implies the use of L<OSSL_CMP_MSG_http_perform(3)>.
375 The callback should send the CMP request message it obtains via the B<req>
376 parameter and on success return the response, else it must return NULL.
377 The transfer callback may make use of a custom defined argument stored in
378 the ctx by means of OSSL_CMP_CTX_set_transfer_cb_arg(), which may be retrieved
379 again through OSSL_CMP_CTX_get_transfer_cb_arg().
381 OSSL_CMP_CTX_set_transfer_cb_arg() sets an argument, respectively a pointer to a
382 structure containing arguments, optionally to be used by the transfer callback.
383 B<arg> is not consumed, and it must therefore explicitly be freed when not
384 needed any more. B<arg> may be NULL to clear the entry.
386 OSSL_CMP_CTX_get_transfer_cb_arg() gets the argument, respectively the pointer
387 to a structure containing arguments, previously set by
388 OSSL_CMP_CTX_set_transfer_cb_arg() or NULL if unset.
390 OSSL_CMP_CTX_set1_srvCert() sets the expected server cert B<srvCert> and trusts
391 it directly (even if it is expired) when verifying signed response messages.
392 May be used alternatively to OSSL_CMP_CTX_set0_trustedStore()
393 to pin the accepted server.
394 Any previously set value is freed.
395 The B<cert> argument may be NULL to clear the entry.
396 If set, the subject of the certificate is also used
397 as default value for the recipient of CMP requests
398 and as default value for the expected sender of CMP responses.
400 OSSL_CMP_CTX_set1_expected_sender() sets the Distinguished Name (DN)
401 expected in the sender field of CMP response messages.
402 Defaults to the subject of the pinned server certificate B<-srvcert>, if any.
403 This can be used to make sure that only a particular entity is accepted as
404 CMP message signer, and attackers are not able to use arbitrary certificates
405 of a trusted PKI hierarchy to fraudulently pose as CMP server.
406 Note that this gives slightly more freedom than OSSL_CMP_CTX_set1_srvCert(),
407 which pins the server to the holder of a particular certificate, while the
408 expected sender name will continue to match after updates of the server cert.
410 OSSL_CMP_CTX_set0_trustedStore() sets the certificate store of type X509_STORE
411 containing trusted (root) CA certificates.
412 The store may also hold CRLs and
413 a certificate verification callback function used for CMP server authentication.
414 Any store entry already set before is freed.
415 When given a NULL parameter the entry is cleared.
417 OSSL_CMP_CTX_get0_trustedStore() returns a pointer to the currently set
418 certificate store containing trusted cert etc., or an empty store if unset.
420 OSSL_CMP_CTX_set1_untrusted_certs() sets up a list of non-trusted certificates
421 of intermediate CAs that may be useful for path construction for the CMP client
422 certificate, for the TLS client certificate (if any), when verifying
423 the CMP server certificate, and when verifying newly enrolled certificates.
424 The reference counts of those certificates handled successfully are increased.
426 OSSL_CMP_CTX_get0_untrusted_certs(OSSL_CMP_CTX *ctx) returns a pointer to the
427 list of untrusted certs, which may be empty if unset.
429 OSSL_CMP_CTX_set1_cert() sets the certificate used for CMP message protection.
430 The public key of this B<cert> must correspond to
431 the private key set via B<OSSL_CMP_CTX_set1_pkey()>.
432 When using signature-based protection of CMP request messages
433 this "protection certificate" will be included first in the extraCerts field.
434 The subject of this B<cert> will be used as the sender field of outgoing
435 messages, while the subject of any cert set via B<OSSL_CMP_CTX_set1_oldCert()>
436 and any value set via B<OSSL_CMP_CTX_set1_subjectName()> are used as fallback.
437 The B<cert> argument may be NULL to clear the entry.
439 OSSL_CMP_CTX_set1_pkey() sets the private key corresponding to the
440 protection certificate B<cert> set via B<OSSL_CMP_CTX_set1_cert()>.
441 This key is used create signature-based protection (protectionAlg = MSG_SIG_ALG)
443 unless a PBM secret has been set via B<OSSL_CMP_CTX_set1_secretValue()>.
444 The B<pkey> argument may be NULL to clear the entry.
446 OSSL_CMP_CTX_set1_secretValue() sets the byte string B<sec> with length B<len>
447 as PBM secret in the given B<ctx> or clears it if the B<sec> argument is NULL.
448 If present, this secret is used to create PBM-based protection of outgoing
449 messages and to verify any PBM-based protection of incoming messages
450 (protectionAlg = MSG_MAC_ALG). PBM stands for Password-Based MAC.
451 PBM-based protection takes precedence over signature-based protection.
453 OSSL_CMP_CTX_set1_referenceValue() sets the given referenceValue B<ref> with
454 length B<len> in the given B<ctx> or clears it if the B<ref> argument is NULL.
455 According to RFC 4210 section 5.1.1, if no value for the sender field in
456 CMP message headers can be determined (i.e., no protection certificate B<cert>
457 and no B<subjectName> is given) then the sender field will contain the NULL-DN
458 and the senderKID field of the CMP message header must be set.
459 When signature-based protection is used the senderKID will be set to
460 the subjectKeyIdentifier of the protection B<cert> as far as present.
461 If not present or when PBM-based protection is used
462 the B<ref> value is taken as the fallback value for the senderKID.
464 OSSL_CMP_CTX_set1_recipient() sets the recipient name that will be used in the
465 PKIHeader of CMP request messages, i.e. the X509 name of the (CA) server.
467 The recipient field in the header of a CMP message is mandatory.
468 If not given explicitly the recipient is determined in the following order:
469 the subject of the CMP server certificate set using OSSL_CMP_CTX_set1_srvCert(),
470 the value set using OSSL_CMP_CTX_set1_issuer(),
471 the issuer of the certificate set using OSSL_CMP_CTX_set1_oldCert(),
472 the issuer of the protection certificate (B<cert>),
473 as far as any of those is present, else the NULL-DN as last resort.
475 OSSL_CMP_CTX_push0_geninfo_ITAV() adds B<itav> to the stack in the B<ctx> to be
476 added to the GeneralInfo field of the CMP PKIMessage header of a request
477 message sent with this context.
479 OSSL_CMP_CTX_set1_extraCertsOut() sets the stack of extraCerts that will be
482 OSSL_CMP_CTX_set0_newPkey() can be used to explicitly set the given EVP_PKEY
483 structure as the private or public key to be certified in the CMP context.
484 The B<priv> parameter must be 0 if and only if the given key is a public key.
486 OSSL_CMP_CTX_get0_newPkey() gives the key to use for certificate enrollment
487 dependent on fields of the CMP context structure:
488 the newPkey (which may be a private or public key) if present,
489 else the public key in the p10CSR if present, else the client private key.
490 If the B<priv> parameter is not 0 and the selected key does not have a
491 private component then NULL is returned.
493 OSSL_CMP_CTX_set1_issuer() sets the name of the intended issuer that
494 will be set in the CertTemplate, i.e., the X509 name of the CA server.
496 OSSL_CMP_CTX_set1_subjectName() sets the subject DN that will be used in
497 the CertTemplate structure when requesting a new cert. For Key Update Requests
498 (KUR), it defaults to the subject DN of the B<reference certificate>,
499 see B<OSSL_CMP_CTX_set1_oldCert()>. This default is used for Initialization
500 Requests (IR) and Certification Requests (CR) only if no SANs are set.
501 The B<subjectName> is also used as fallback for the sender field
502 of outgoing CMP messages if no B<cert> and no B<oldcert> are available.
504 OSSL_CMP_CTX_push1_subjectAltName() adds the given X509 name to the list of
505 alternate names on the certificate template request. This cannot be used if
506 any Subject Alternative Name extension is set via
507 OSSL_CMP_CTX_set0_reqExtensions().
508 By default, unless OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT has been set,
509 the Subject Alternative Names are copied from the B<reference certificate>,
510 see B<OSSL_CMP_CTX_set1_oldCert()>.
511 If set and the subject DN is not set with OSSL_CMP_CTX_set1_subjectName(), then
512 the certificate template of an IR and CR will not be filled with the default
513 subject DN from the B<reference certificate>.
514 If a subject DN is desired it needs to be set explicitly with
515 OSSL_CMP_CTX_set1_subjectName().
517 OSSL_CMP_CTX_set0_reqExtensions() sets the X.509v3 extensions to be used in
520 OSSL_CMP_CTX_reqExtensions_have_SAN() returns 1 if the context contains
521 a Subject Alternative Name extension, else 0 or -1 on error.
523 OSSL_CMP_CTX_push0_policy() adds the certificate policy info object
524 to the X509_EXTENSIONS of the requested certificate template.
526 OSSL_CMP_CTX_set1_oldCert() sets the old certificate to be updated in
527 Key Update Requests (KUR) or to be revoked in Revocation Requests (RR).
528 It must be given for RR, else it defaults to the protection B<cert>.
529 The B<reference certificate> determined in this way, if any, is also used for
530 deriving default subject DN and Subject Alternative Names for IR, CR, and KUR.
531 Its subject is used as sender in CMP message headers if no protection cert is given.
532 Its issuer is used as default recipient in CMP message headers.
534 OSSL_CMP_CTX_set1_p10CSR() sets the PKCS#10 CSR to be used in P10CR.
536 OSSL_CMP_CTX_push0_genm_ITAV() adds B<itav> to the stack in the B<ctx> which
537 will be the body of a General Message sent with this context.
539 OSSL_CMP_CTX_set_certConf_cb() sets the callback used for evaluating the newly
540 enrolled certificate before the library sends, depending on its result,
541 a positive or negative certConf message to the server. The callback has type
543 typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert,
544 int fail_info, const char **txt);
546 and should inspect the certificate it obtains via the B<cert> parameter and may
547 overrule the pre-decision given in the B<fail_info> and B<*txt> parameters.
548 If it accepts the certificate it must return 0, indicating success. Else it must
549 return a bit field reflecting PKIFailureInfo with at least one failure bit and
550 may set the B<*txt> output parameter to point to a string constant with more
551 detail. The transfer callback may make use of a custom defined argument stored
552 in the B<ctx> by means of OSSL_CMP_CTX_set_certConf_cb_arg(), which may be
553 retrieved again through OSSL_CMP_CTX_get_certConf_cb_arg().
554 Typically, the callback will check at least that the certificate can be verified
555 using a set of trusted certificates.
556 It also could compare the subject DN and other fields of the newly
557 enrolled certificate with the certificate template of the request.
559 OSSL_CMP_CTX_set_certConf_cb_arg() sets an argument, respectively a pointer to a
560 structure containing arguments, optionally to be used by the certConf callback.
561 B<arg> is not consumed, and it must therefore explicitly be freed when not
562 needed any more. B<arg> may be NULL to clear the entry.
564 OSSL_CMP_CTX_get_certConf_cb_arg() gets the argument, respectively the pointer
565 to a structure containing arguments, previously set by
566 OSSL_CMP_CTX_set_certConf_cb_arg(), or NULL if unset.
568 OSSL_CMP_CTX_get_status() returns the PKIstatus from the last received
569 CertRepMessage or Revocation Response or error message, or -1 if unset.
571 OSSL_CMP_CTX_get0_statusString() returns the statusString from the last received
572 CertRepMessage or Revocation Response or error message, or NULL if unset.
574 OSSL_CMP_CTX_get_failInfoCode() returns the error code from the failInfo field
575 of the last received CertRepMessage or Revocation Response or error message.
576 This is a bit field and the flags for it are specified in the header file
577 F<< <openssl/cmp.h> >>.
578 The flags start with OSSL_CMP_CTX_FAILINFO, for example:
579 OSSL_CMP_CTX_FAILINFO_badAlg. Returns -1 if the failInfoCode field is unset.
581 OSSL_CMP_CTX_get0_newCert() returns the pointer to the newly obtained
582 certificate in case it is available, else NULL.
584 OSSL_CMP_CTX_get1_newChain() returns a pointer to a duplicate of the stack of
585 X.509 certificates computed by OSSL_CMP_certConf_cb() (if this function has
586 been called) on the last received certificate response message IP/CP/KUP.
588 OSSL_CMP_CTX_get1_caPubs() returns a pointer to a duplicate of the stack of
589 X.509 certificates received in the caPubs field of last received certificate
590 response message IP/CP/KUP.
592 OSSL_CMP_CTX_get1_extraCertsIn() returns a pointer to a duplicate of the stack
593 of X.509 certificates received in the last received nonempty extraCerts field.
594 Returns an empty stack if no extraCerts have been received in the current
597 OSSL_CMP_CTX_set1_transactionID() sets the given transaction ID in the given
598 OSSL_CMP_CTX structure.
600 OSSL_CMP_CTX_set1_senderNonce() stores the last sent sender B<nonce> in
601 the B<ctx>. This will be used to validate the recipNonce in incoming messages.
605 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
609 OSSL_CMP_CTX_free() and OSSL_CMP_CTX_print_errors() do not return anything.
612 OSSL_CMP_CTX_get_http_cb_arg(),
613 OSSL_CMP_CTX_get_transfer_cb_arg(),
614 OSSL_CMP_CTX_get0_trustedStore(),
615 OSSL_CMP_CTX_get0_untrusted_certs(),
616 OSSL_CMP_CTX_get0_newPkey(),
617 OSSL_CMP_CTX_get_certConf_cb_arg(),
618 OSSL_CMP_CTX_get0_statusString(),
619 OSSL_CMP_CTX_get0_newCert(),
620 OSSL_CMP_CTX_get0_newChain(),
621 OSSL_CMP_CTX_get1_caPubs(), and
622 OSSL_CMP_CTX_get1_extraCertsIn()
623 return the intended pointer value as described above or NULL on error.
625 OSSL_CMP_CTX_get_option(),
626 OSSL_CMP_CTX_reqExtensions_have_SAN(),
627 OSSL_CMP_CTX_get_status(), and
628 OSSL_CMP_CTX_get_failInfoCode()
629 return the intended value as described above or -1 on error.
631 All other functions return 1 on success, 0 on error.
635 The following code omits error handling.
637 Set up a CMP client context for sending requests and verifying responses:
639 cmp_ctx = OSSL_CMP_CTX_new();
640 OSSL_CMP_CTX_set1_server(cmp_ctx, name_or_address);
641 OSSL_CMP_CTX_set1_serverPort(cmp_ctx, port_string);
642 OSSL_CMP_CTX_set1_serverPath(cmp_ctx, path_or_alias);
643 OSSL_CMP_CTX_set0_trustedStore(cmp_ctx, ts);
645 Set up client credentials for password-based protection (PBM):
647 OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
648 OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
650 Set up the details for certificate requests:
652 OSSL_CMP_CTX_set1_subjectName(cmp_ctx, name);
653 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, initialKey);
655 Perform an Initialization Request transaction:
657 initialCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
659 Reset the transaction state of the CMP context and the credentials:
661 OSSL_CMP_CTX_reinit(cmp_ctx);
662 OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, NULL, 0);
663 OSSL_CMP_CTX_set1_secretValue(cmp_ctx, NULL, 0);
665 Perform a Certification Request transaction, making use of the new credentials:
667 OSSL_CMP_CTX_set1_cert(cmp_ctx, initialCert);
668 OSSL_CMP_CTX_set1_pkey(cmp_ctx, initialKey);
669 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, curentKey);
670 currentCert = OSSL_CMP_exec_CR_ses(cmp_ctx);
672 Perform a Key Update Request, signed using the cert (and key) to be updated:
674 OSSL_CMP_CTX_reinit(cmp_ctx);
675 OSSL_CMP_CTX_set1_cert(cmp_ctx, currentCert);
676 OSSL_CMP_CTX_set1_pkey(cmp_ctx, currentKey);
677 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, updatedKey);
678 currentCert = OSSL_CMP_exec_KUR_ses(cmp_ctx);
679 currentKey = updatedKey;
681 Perform a General Message transaction including, as an example,
682 the id-it-signKeyPairTypes OID and prints info on the General Response contents:
684 OSSL_CMP_CTX_reinit(cmp_ctx);
686 ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
687 OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new(type, NULL);
688 OSSL_CMP_CTX_push0_genm_ITAV(cmp_ctx, itav);
690 STACK_OF(OSSL_CMP_ITAV) *itavs;
691 itavs = OSSL_CMP_exec_GENM_ses(cmp_ctx);
693 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
697 L<OSSL_CMP_exec_IR_ses(3)>, L<OSSL_CMP_exec_CR_ses(3)>,
698 L<OSSL_CMP_exec_KUR_ses(3)>, L<OSSL_CMP_exec_GENM_ses(3)>,
699 L<OSSL_CMP_exec_certreq(3)>
703 The OpenSSL CMP support was added in OpenSSL 3.0.
707 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
709 Licensed under the Apache License 2.0 (the "License"). You may not use
710 this file except in compliance with the License. You can obtain a copy
711 in the file LICENSE in the source distribution or at
712 L<https://www.openssl.org/source/license.html>.