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,
30 OSSL_CMP_CTX_get0_untrusted,
31 OSSL_CMP_CTX_set1_cert,
32 OSSL_CMP_CTX_build_cert_chain,
33 OSSL_CMP_CTX_set1_pkey,
34 OSSL_CMP_CTX_set1_referenceValue,
35 OSSL_CMP_CTX_set1_secretValue,
36 OSSL_CMP_CTX_set1_recipient,
37 OSSL_CMP_CTX_push0_geninfo_ITAV,
38 OSSL_CMP_CTX_set1_extraCertsOut,
39 OSSL_CMP_CTX_set0_newPkey,
40 OSSL_CMP_CTX_get0_newPkey,
41 OSSL_CMP_CTX_set1_issuer,
42 OSSL_CMP_CTX_set1_subjectName,
43 OSSL_CMP_CTX_push1_subjectAltName,
44 OSSL_CMP_CTX_set0_reqExtensions,
45 OSSL_CMP_CTX_reqExtensions_have_SAN,
46 OSSL_CMP_CTX_push0_policy,
47 OSSL_CMP_CTX_set1_oldCert,
48 OSSL_CMP_CTX_set1_p10CSR,
49 OSSL_CMP_CTX_push0_genm_ITAV,
50 OSSL_CMP_certConf_cb_t,
52 OSSL_CMP_CTX_set_certConf_cb,
53 OSSL_CMP_CTX_set_certConf_cb_arg,
54 OSSL_CMP_CTX_get_certConf_cb_arg,
55 OSSL_CMP_CTX_get_status,
56 OSSL_CMP_CTX_get0_statusString,
57 OSSL_CMP_CTX_get_failInfoCode,
58 OSSL_CMP_CTX_get0_newCert,
59 OSSL_CMP_CTX_get1_newChain,
60 OSSL_CMP_CTX_get1_caPubs,
61 OSSL_CMP_CTX_get1_extraCertsIn,
62 OSSL_CMP_CTX_set1_transactionID,
63 OSSL_CMP_CTX_set1_senderNonce
64 - functions for managing the CMP client context data structure
68 #include <openssl/cmp.h>
70 OSSL_CMP_CTX *OSSL_CMP_CTX_new(OPENSSL_CTX *libctx, const char *propq);
71 void OSSL_CMP_CTX_free(OSSL_CMP_CTX *ctx);
72 int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX *ctx);
73 int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX *ctx, int opt, int val);
74 int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX *ctx, int opt);
76 /* logging and error reporting: */
77 int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_log_cb_t cb);
78 #define OSSL_CMP_CTX_set_log_verbosity(ctx, level)
79 void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX *ctx);
81 /* message transfer: */
82 int OSSL_CMP_CTX_set1_serverPath(OSSL_CMP_CTX *ctx, const char *path);
83 int OSSL_CMP_CTX_set1_server(OSSL_CMP_CTX *ctx, const char *address);
84 int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX *ctx, int port);
85 int OSSL_CMP_CTX_set1_proxy(OSSL_CMP_CTX *ctx, const char *name);
86 int OSSL_CMP_CTX_set1_no_proxy(OSSL_CMP_CTX *ctx, const char *names);
87 int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX *ctx, HTTP_bio_cb_t cb);
88 int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
89 void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX *ctx);
90 typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t)(OSSL_CMP_CTX *ctx,
91 const OSSL_CMP_MSG *req);
92 int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX *ctx,
93 OSSL_CMP_transfer_cb_t cb);
94 int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
95 void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX *ctx);
97 /* server authentication: */
98 int OSSL_CMP_CTX_set1_srvCert(OSSL_CMP_CTX *ctx, X509 *cert);
99 int OSSL_CMP_CTX_set1_expected_sender(OSSL_CMP_CTX *ctx,
100 const X509_NAME *name);
101 int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX *ctx, X509_STORE *store);
102 X509_STORE *OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX *ctx);
103 int OSSL_CMP_CTX_set1_untrusted(OSSL_CMP_CTX *ctx, STACK_OF(X509) *certs);
104 STACK_OF(X509) *OSSL_CMP_CTX_get0_untrusted(const OSSL_CMP_CTX *ctx);
106 /* client authentication: */
107 int OSSL_CMP_CTX_set1_cert(OSSL_CMP_CTX *ctx, X509 *cert);
108 int OSSL_CMP_CTX_build_cert_chain(OSSL_CMP_CTX *ctx, X509_STORE *own_trusted,
109 STACK_OF(X509) *candidates);
110 int OSSL_CMP_CTX_set1_pkey(OSSL_CMP_CTX *ctx, EVP_PKEY *pkey);
111 int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX *ctx,
112 const unsigned char *ref, int len);
113 int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX *ctx, const unsigned char *sec,
116 /* CMP message header and extra certificates: */
117 int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name);
118 int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
119 int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx,
120 STACK_OF(X509) *extraCertsOut);
122 /* certificate template: */
123 int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX *ctx, int priv, EVP_PKEY *pkey);
124 EVP_PKEY *OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX *ctx, int priv);
125 int OSSL_CMP_CTX_set1_issuer(OSSL_CMP_CTX *ctx, const X509_NAME *name);
126 int OSSL_CMP_CTX_set1_subjectName(OSSL_CMP_CTX *ctx, const X509_NAME *name);
127 int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX *ctx,
128 const GENERAL_NAME *name);
129 int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX *ctx, X509_EXTENSIONS *exts);
130 int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX *ctx);
131 int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX *ctx, POLICYINFO *pinfo);
132 int OSSL_CMP_CTX_set1_oldCert(OSSL_CMP_CTX *ctx, X509 *cert);
133 int OSSL_CMP_CTX_set1_p10CSR(OSSL_CMP_CTX *ctx, const X509_REQ *csr);
135 /* misc body contents: */
136 int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
138 /* certificate confirmation: */
139 typedef int (*OSSL_CMP_certConf_cb_t)(OSSL_CMP_CTX *ctx, X509 *cert,
140 int fail_info, const char **txt);
141 int OSSL_CMP_certConf_cb(OSSL_CMP_CTX *ctx, X509 *cert, int fail_info,
143 int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_certConf_cb_t cb);
144 int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
145 void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX *ctx);
147 /* result fetching: */
148 int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX *ctx);
149 OSSL_CMP_PKIFREETEXT *OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX *ctx);
150 int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX *ctx);
152 X509 *OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX *ctx);
153 STACK_OF(X509) *OSSL_CMP_CTX_get1_newChain(const OSSL_CMP_CTX *ctx);
154 STACK_OF(X509) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX *ctx);
155 STACK_OF(X509) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX *ctx);
157 /* for testing and debugging purposes: */
158 int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX *ctx,
159 const ASN1_OCTET_STRING *id);
160 int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX *ctx,
161 const ASN1_OCTET_STRING *nonce);
165 This is the context API for using CMP (Certificate Management Protocol) with
168 OSSL_CMP_CTX_new() allocates an B<OSSL_CMP_CTX> structure associated with
169 the library context I<libctx> and property query string I<propq>,
170 both of which may be NULL to select the defaults.
171 It initializes the remaining fields to their default values - for instance,
172 the logging verbosity is set to OSSL_CMP_LOG_INFO,
173 the message timeout is set to 120 seconds,
174 and the proof-of-possession method is set to OSSL_CRMF_POPO_SIGNATURE.
176 OSSL_CMP_CTX_free() deallocates an OSSL_CMP_CTX structure.
178 OSSL_CMP_CTX_reinit() prepares the given B<ctx> for a further transaction by
179 clearing the internal CMP transaction (aka session) status, PKIStatusInfo,
180 and any previous results (newCert, newChain, caPubs, and extraCertsIn)
181 from the last executed transaction.
182 All other field values (i.e., CMP options) are retained for potential re-use.
184 OSSL_CMP_CTX_set_option() sets the given value for the given option
185 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) in the given OSSL_CMP_CTX structure.
187 The following options can be set:
191 =item B<OSSL_CMP_OPT_LOG_VERBOSITY>
193 The level of severity needed for actually outputting log messages
194 due to errors, warnings, general info, debugging, etc.
195 Default is OSSL_CMP_LOG_INFO. See also L<OSSL_CMP_log_open(3)>.
197 =item B<OSSL_CMP_OPT_MSG_TIMEOUT>
199 Number of seconds (or 0 for infinite) a CMP message round trip is
200 allowed to take before a timeout error is returned. Default is 120.
202 =item B<OSSL_CMP_OPT_TOTAL_TIMEOUT>
204 Maximum total number of seconds an enrollment (including polling)
205 may take. Default is 0 (infinite).
207 =item B<OSSL_CMP_OPT_VALIDITY_DAYS>
209 Number of days new certificates are asked to be valid for.
211 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT>
213 Do not take default Subject Alternative Names
214 from the reference certificate.
216 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL>
218 Demand that the given Subject Alternative Names are flagged as critical.
220 =item B<OSSL_CMP_OPT_POLICIES_CRITICAL>
222 Demand that the given policies are flagged as critical.
224 =item B<OSSL_CMP_OPT_POPO_METHOD>
226 Select the proof of possession method to use. Possible values are:
228 OSSL_CRMF_POPO_NONE - ProofOfPossession field omitted
229 OSSL_CRMF_POPO_RAVERIFIED - assert that the RA has already
231 OSSL_CRMF_POPO_SIGNATURE - sign a value with private key,
232 which is the default.
233 OSSL_CRMF_POPO_KEYENC - decrypt the encrypted certificate
236 Note that a signature-based POPO can only be produced if a private key
237 is provided as the newPkey or client pkey component of the CMP context.
239 =item B<OSSL_CMP_OPT_DIGEST_ALGNID>
241 The NID of the digest algorithm to be used in RFC 4210's MSG_SIG_ALG
242 for signature-based message protection and Proof-of-Possession (POPO).
245 =item B<OSSL_CMP_OPT_OWF_ALGNID>
246 The NID of the digest algorithm to be used as one-way function (OWF)
247 in RFC 4210's MSG_MAC_ALG for PBM-based message protection.
250 =item B<OSSL_CMP_OPT_MAC_ALGNID>
251 The NID of the MAC algorithm to be used in RFC 4210's MSG_MAC_ALG
252 for PBM-based message protection.
253 Default is HMAC-SHA1 as per RFC 4210.
255 =item B<OSSL_CMP_OPT_REVOCATION_REASON>
257 The reason code to be included in a Revocation Request (RR);
258 values: 0..10 (RFC 5210, 5.3.1) or -1 for none, which is the default.
260 =item B<OSSL_CMP_OPT_IMPLICIT_CONFIRM>
262 Request server to enable implicit confirm mode, where the client
263 does not need to send confirmation upon receiving the
264 certificate. If the server does not enable implicit confirmation
265 in the return message, then confirmation is sent anyway.
267 =item B<OSSL_CMP_OPT_DISABLE_CONFIRM>
269 Do not confirm enrolled certificates, to cope with broken servers
270 not supporting implicit confirmation correctly.
271 B<WARNING:> This setting leads to unspecified behavior and it is meant
272 exclusively to allow interoperability with server implementations violating
275 =item B<OSSL_CMP_OPT_UNPROTECTED_SEND>
277 Send messages without CMP-level protection.
279 =item B<OSSL_CMP_OPT_UNPROTECTED_ERRORS>
281 Accept unprotected error responses which are either explicitly
282 unprotected or where protection verification failed. Applies to regular
283 error messages as well as certificate responses (IP/CP/KUP) and
284 revocation responses (RP) with rejection.
285 B<WARNING:> This setting leads to unspecified behavior and it is meant
286 exclusively to allow interoperability with server implementations violating
289 =item B<OSSL_CMP_OPT_IGNORE_KEYUSAGE>
291 Ignore key usage restrictions in signer certificate when
292 validating signature-based protection in received CMP messages.
293 Else, 'digitalSignature' must be allowed by CMP signer certificates.
295 =item B<OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR>
297 Allow retrieving a trust anchor from extraCerts and using that
298 to validate the certificate chain of an IP message.
302 OSSL_CMP_CTX_get_option() reads the current value of the given option
303 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) from the given OSSL_CMP_CTX structure.
305 OSSL_CMP_CTX_set_log_cb() sets in B<ctx> the callback function C<cb>
306 for handling error queue entries and logging messages.
307 When C<cb> is NULL errors are printed to STDERR (if available, else ignored)
308 any log messages are ignored.
309 Alternatively, L<OSSL_CMP_log_open(3)> may be used to direct logging to STDOUT.
311 OSSL_CMP_CTX_set_log_verbosity() is a macro setting the
312 OSSL_CMP_OPT_LOG_VERBOSITY context option to the given level.
314 OSSL_CMP_CTX_print_errors() outputs any entries in the OpenSSL error queue.
315 It is similar to B<ERR_print_errors_cb()> but uses the CMP log callback function
316 if set in the C<ctx> for uniformity with CMP logging if given. Otherwise it uses
317 B<ERR_print_errors(3)> to print to STDERR (unless OPENSSL_NO_STDIO is defined).
319 OSSL_CMP_CTX_set1_serverPath() sets the HTTP path of the CMP server on the host,
320 also known as "CMP alias".
323 OSSL_CMP_CTX_set1_server() sets the given server B<address>
324 (which may be a hostname or IP address or NULL) in the given B<ctx>.
326 OSSL_CMP_CTX_set_serverPort() sets the port of the CMP server to connect to.
327 If not used or the B<port> argument is 0
328 the default port applies, which is 80 for HTTP and 443 for HTTPS.
330 OSSL_CMP_CTX_set1_proxy() sets the HTTP proxy to be used for connecting to
331 the given CMP server unless overruled by any "no_proxy" settings (see below).
332 If TLS is not used this defaults to the value of
333 the environment variable B<http_proxy> if set, else B<HTTP_PROXY>.
334 Otherwise defaults to the value of B<https_proxy> if set, else B<HTTPS_PROXY>.
335 An empty proxy string specifies not to use a proxy.
336 Else the format is I<[http[s]://]address[:port][/path]>,
337 where any path given is ignored.
338 The default port number is 80, or 443 in case I<https:> is given.
340 OSSL_CMP_CTX_set1_no_proxy() sets the list of server hostnames not to use
341 an HTTP proxy for. The names may be separated by commas and/or whitespace.
342 Defaults to the environment variable B<no_proxy> if set, else B<NO_PROXY>.
344 OSSL_CMP_CTX_set_http_cb() sets the optional BIO connect/disconnect callback
345 function, which has the prototype
347 typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail);
349 The callback may modify the BIO B<bio> provided by OSSL_CMP_MSG_http_perform(),
350 whereby it may make use of a custom defined argument B<ctx>
351 stored in the OSSL_CMP_CTX by means of OSSL_CMP_CTX_set_http_cb_arg().
352 During connection establishment, just after calling BIO_do_connect_retry(),
353 the function is invoked with the B<connect> argument being 1 and the B<detail>
354 argument being 1 if HTTPS is requested, i.e., SSL/TLS should be enabled. On
355 disconnect B<connect> is 0 and B<detail> is 1 in case no error occurred, else 0.
356 For instance, on connect the function may prepend a TLS BIO to implement HTTPS;
357 after disconnect it may do some diagnostic output and/or specific cleanup.
358 The function should return NULL to indicate failure.
359 After disconnect the modified BIO will be deallocated using BIO_free_all().
361 OSSL_CMP_CTX_set_http_cb_arg() sets an argument, respectively a pointer to
362 a structure containing arguments,
363 optionally to be used by the http connect/disconnect callback function.
364 B<arg> is not consumed, and it must therefore explicitly be freed when not
365 needed any more. B<arg> may be NULL to clear the entry.
367 OSSL_CMP_CTX_get_http_cb_arg() gets the argument, respectively the pointer to a
368 structure containing arguments, previously set by
369 OSSL_CMP_CTX_set_http_cb_arg() or NULL if unset.
371 OSSL_CMP_CTX_set_transfer_cb() sets the message transfer callback function,
374 typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx,
375 const OSSL_CMP_MSG *req);
377 Returns 1 on success, 0 on error.
379 Default is NULL, which implies the use of L<OSSL_CMP_MSG_http_perform(3)>.
380 The callback should send the CMP request message it obtains via the B<req>
381 parameter and on success return the response, else it must return NULL.
382 The transfer callback may make use of a custom defined argument stored in
383 the ctx by means of OSSL_CMP_CTX_set_transfer_cb_arg(), which may be retrieved
384 again through OSSL_CMP_CTX_get_transfer_cb_arg().
386 OSSL_CMP_CTX_set_transfer_cb_arg() sets an argument, respectively a pointer to a
387 structure containing arguments, optionally to be used by the transfer callback.
388 B<arg> is not consumed, and it must therefore explicitly be freed when not
389 needed any more. B<arg> may be NULL to clear the entry.
391 OSSL_CMP_CTX_get_transfer_cb_arg() gets the argument, respectively the pointer
392 to a structure containing arguments, previously set by
393 OSSL_CMP_CTX_set_transfer_cb_arg() or NULL if unset.
395 OSSL_CMP_CTX_set1_srvCert() sets the expected server cert B<srvCert> and trusts
396 it directly (even if it is expired) when verifying signed response messages.
397 May be used alternatively to OSSL_CMP_CTX_set0_trustedStore()
398 to pin the accepted server.
399 Any previously set value is freed.
400 The B<cert> argument may be NULL to clear the entry.
401 If set, the subject of the certificate is also used
402 as default value for the recipient of CMP requests
403 and as default value for the expected sender of CMP responses.
405 OSSL_CMP_CTX_set1_expected_sender() sets the Distinguished Name (DN)
406 expected in the sender field of CMP response messages.
407 Defaults to the subject of the pinned server certificate B<-srvcert>, if any.
408 This can be used to make sure that only a particular entity is accepted as
409 CMP message signer, and attackers are not able to use arbitrary certificates
410 of a trusted PKI hierarchy to fraudulently pose as CMP server.
411 Note that this gives slightly more freedom than OSSL_CMP_CTX_set1_srvCert(),
412 which pins the server to the holder of a particular certificate, while the
413 expected sender name will continue to match after updates of the server cert.
415 OSSL_CMP_CTX_set0_trustedStore() sets the certificate store of type X509_STORE
416 containing trusted (root) CA certificates.
417 The store may also hold CRLs and
418 a certificate verification callback function used for CMP server authentication.
419 Any store entry already set before is freed.
420 When given a NULL parameter the entry is cleared.
422 OSSL_CMP_CTX_get0_trustedStore() returns a pointer to the currently set
423 certificate store containing trusted cert etc., or an empty store if unset.
425 OSSL_CMP_CTX_set1_untrusted() sets up a list of non-trusted certificates
426 of intermediate CAs that may be useful for path construction for the CMP client
427 certificate, for the TLS client certificate (if any), when verifying
428 the CMP server certificate, and when verifying newly enrolled certificates.
429 The reference counts of those certificates handled successfully are increased.
431 OSSL_CMP_CTX_get0_untrusted(OSSL_CMP_CTX *ctx) returns a pointer to the
432 list of untrusted certs, which may be empty if unset.
434 OSSL_CMP_CTX_set1_cert() sets the certificate used for CMP message protection.
435 The public key of this B<cert> must correspond to
436 the private key set before or thereafter via B<OSSL_CMP_CTX_set1_pkey()>.
437 When using signature-based protection of CMP request messages
438 this "protection certificate" will be included first in the extraCerts field.
439 The subject of this B<cert> will be used as the sender field of outgoing
440 messages, while the subject of any cert set via B<OSSL_CMP_CTX_set1_oldCert()>
441 and any value set via B<OSSL_CMP_CTX_set1_subjectName()> are used as fallback.
442 The B<cert> argument may be NULL to clear the entry.
444 OSSL_CMP_CTX_build_cert_chain() builds a certificate chain for the CMP signer
445 certificate previously set in the B<ctx>. It adds the optional B<candidates>,
446 a list of intermediate CA certs that may already constitute the targeted chain,
447 to the untrusted certs that may already exist in the B<ctx>.
448 Then the function uses this augumented set of certs for chain construction.
449 If I<own_trusted> is NULL it builds the chain as far down as possible and
450 ignores any verification errors. Else the CMP signer certificate must be
451 verifiable where the chain reaches a trust anchor contained in I<own_trusted>.
452 On success the function stores the resulting chain in B<ctx>
453 for inclusion in the extraCerts field of signature-protected messages.
454 Calling this function is optional; by default a chain construction
455 is performed on demand that is equivalent to calling this function
456 with the B<candidates> and I<own_trusted> arguments being NULL.
458 OSSL_CMP_CTX_set1_pkey() sets the private key corresponding to the
459 protection certificate B<cert> set via B<OSSL_CMP_CTX_set1_cert()>.
460 This key is used create signature-based protection (protectionAlg = MSG_SIG_ALG)
462 unless a PBM secret has been set via B<OSSL_CMP_CTX_set1_secretValue()>.
463 The B<pkey> argument may be NULL to clear the entry.
465 OSSL_CMP_CTX_set1_secretValue() sets the byte string B<sec> with length B<len>
466 as PBM secret in the given B<ctx> or clears it if the B<sec> argument is NULL.
467 If present, this secret is used to create PBM-based protection of outgoing
468 messages and to verify any PBM-based protection of incoming messages
469 (protectionAlg = MSG_MAC_ALG). PBM stands for Password-Based MAC.
470 PBM-based protection takes precedence over signature-based protection.
472 OSSL_CMP_CTX_set1_referenceValue() sets the given referenceValue B<ref> with
473 length B<len> in the given B<ctx> or clears it if the B<ref> argument is NULL.
474 According to RFC 4210 section 5.1.1, if no value for the sender field in
475 CMP message headers can be determined (i.e., no protection certificate B<cert>
476 and no B<subjectName> is given) then the sender field will contain the NULL-DN
477 and the senderKID field of the CMP message header must be set.
478 When signature-based protection is used the senderKID will be set to
479 the subjectKeyIdentifier of the protection B<cert> as far as present.
480 If not present or when PBM-based protection is used
481 the B<ref> value is taken as the fallback value for the senderKID.
483 OSSL_CMP_CTX_set1_recipient() sets the recipient name that will be used in the
484 PKIHeader of CMP request messages, i.e. the X509 name of the (CA) server.
486 The recipient field in the header of a CMP message is mandatory.
487 If not given explicitly the recipient is determined in the following order:
488 the subject of the CMP server certificate set using OSSL_CMP_CTX_set1_srvCert(),
489 the value set using OSSL_CMP_CTX_set1_issuer(),
490 the issuer of the certificate set using OSSL_CMP_CTX_set1_oldCert(),
491 the issuer of the protection certificate (B<cert>),
492 as far as any of those is present, else the NULL-DN as last resort.
494 OSSL_CMP_CTX_push0_geninfo_ITAV() adds B<itav> to the stack in the B<ctx> to be
495 added to the GeneralInfo field of the CMP PKIMessage header of a request
496 message sent with this context.
498 OSSL_CMP_CTX_set1_extraCertsOut() sets the stack of extraCerts that will be
501 OSSL_CMP_CTX_set0_newPkey() can be used to explicitly set the given EVP_PKEY
502 structure as the private or public key to be certified in the CMP context.
503 The B<priv> parameter must be 0 if and only if the given key is a public key.
505 OSSL_CMP_CTX_get0_newPkey() gives the key to use for certificate enrollment
506 dependent on fields of the CMP context structure:
507 the newPkey (which may be a private or public key) if present,
508 else the public key in the p10CSR if present, else the client private key.
509 If the B<priv> parameter is not 0 and the selected key does not have a
510 private component then NULL is returned.
512 OSSL_CMP_CTX_set1_issuer() sets the name of the intended issuer that
513 will be set in the CertTemplate, i.e., the X509 name of the CA server.
515 OSSL_CMP_CTX_set1_subjectName() sets the subject DN that will be used in
516 the CertTemplate structure when requesting a new cert. For Key Update Requests
517 (KUR), it defaults to the subject DN of the B<reference certificate>,
518 see B<OSSL_CMP_CTX_set1_oldCert()>. This default is used for Initialization
519 Requests (IR) and Certification Requests (CR) only if no SANs are set.
520 The B<subjectName> is also used as fallback for the sender field
521 of outgoing CMP messages if no B<cert> and no B<oldcert> are available.
523 OSSL_CMP_CTX_push1_subjectAltName() adds the given X509 name to the list of
524 alternate names on the certificate template request. This cannot be used if
525 any Subject Alternative Name extension is set via
526 OSSL_CMP_CTX_set0_reqExtensions().
527 By default, unless OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT has been set,
528 the Subject Alternative Names are copied from the B<reference certificate>,
529 see B<OSSL_CMP_CTX_set1_oldCert()>.
530 If set and the subject DN is not set with OSSL_CMP_CTX_set1_subjectName(), then
531 the certificate template of an IR and CR will not be filled with the default
532 subject DN from the B<reference certificate>.
533 If a subject DN is desired it needs to be set explicitly with
534 OSSL_CMP_CTX_set1_subjectName().
536 OSSL_CMP_CTX_set0_reqExtensions() sets the X.509v3 extensions to be used in
539 OSSL_CMP_CTX_reqExtensions_have_SAN() returns 1 if the context contains
540 a Subject Alternative Name extension, else 0 or -1 on error.
542 OSSL_CMP_CTX_push0_policy() adds the certificate policy info object
543 to the X509_EXTENSIONS of the requested certificate template.
545 OSSL_CMP_CTX_set1_oldCert() sets the old certificate to be updated in
546 Key Update Requests (KUR) or to be revoked in Revocation Requests (RR).
547 It must be given for RR, else it defaults to the protection B<cert>.
548 The B<reference certificate> determined in this way, if any, is also used for
549 deriving default subject DN and Subject Alternative Names for IR, CR, and KUR.
550 Its subject is used as sender in CMP message headers if no protection cert is given.
551 Its issuer is used as default recipient in CMP message headers.
553 OSSL_CMP_CTX_set1_p10CSR() sets the PKCS#10 CSR to be used in P10CR.
555 OSSL_CMP_CTX_push0_genm_ITAV() adds B<itav> to the stack in the B<ctx> which
556 will be the body of a General Message sent with this context.
558 OSSL_CMP_certConf_cb() is the default certificate confirmation callback function.
559 If the callback argument is not NULL it must point to a trust store.
560 In this case the function checks that the newly enrolled certificate can be
561 verified using this trust store and untrusted certificates from the B<ctx>,
562 which have been augmented by the list of extraCerts received.
563 If the callback argument is NULL the function tries building an approximate
564 chain as far as possible using the same untrusted certificates from the B<ctx>,
565 and if this fails it takes the received extraCerts as fallback.
566 The resulting cert chain can be retrieved using OSSL_CMP_CTX_get1_newChain().
568 OSSL_CMP_CTX_set_certConf_cb() sets the callback used for evaluating the newly
569 enrolled certificate before the library sends, depending on its result,
570 a positive or negative certConf message to the server. The callback has type
572 typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert,
573 int fail_info, const char **txt);
575 and should inspect the certificate it obtains via the B<cert> parameter and may
576 overrule the pre-decision given in the B<fail_info> and B<*txt> parameters.
577 If it accepts the certificate it must return 0, indicating success. Else it must
578 return a bit field reflecting PKIFailureInfo with at least one failure bit and
579 may set the B<*txt> output parameter to point to a string constant with more
580 detail. The transfer callback may make use of a custom defined argument stored
581 in the B<ctx> by means of OSSL_CMP_CTX_set_certConf_cb_arg(), which may be
582 retrieved again through OSSL_CMP_CTX_get_certConf_cb_arg().
583 Typically, the callback will check at least that the certificate can be verified
584 using a set of trusted certificates.
585 It also could compare the subject DN and other fields of the newly
586 enrolled certificate with the certificate template of the request.
588 OSSL_CMP_CTX_set_certConf_cb_arg() sets an argument, respectively a pointer to a
589 structure containing arguments, optionally to be used by the certConf callback.
590 B<arg> is not consumed, and it must therefore explicitly be freed when not
591 needed any more. B<arg> may be NULL to clear the entry.
593 OSSL_CMP_CTX_get_certConf_cb_arg() gets the argument, respectively the pointer
594 to a structure containing arguments, previously set by
595 OSSL_CMP_CTX_set_certConf_cb_arg(), or NULL if unset.
597 OSSL_CMP_CTX_get_status() returns the PKIstatus from the last received
598 CertRepMessage or Revocation Response or error message, or -1 if unset.
600 OSSL_CMP_CTX_get0_statusString() returns the statusString from the last received
601 CertRepMessage or Revocation Response or error message, or NULL if unset.
603 OSSL_CMP_CTX_get_failInfoCode() returns the error code from the failInfo field
604 of the last received CertRepMessage or Revocation Response or error message.
605 This is a bit field and the flags for it are specified in the header file
606 F<< <openssl/cmp.h> >>.
607 The flags start with OSSL_CMP_CTX_FAILINFO, for example:
608 OSSL_CMP_CTX_FAILINFO_badAlg. Returns -1 if the failInfoCode field is unset.
610 OSSL_CMP_CTX_get0_newCert() returns the pointer to the newly obtained
611 certificate in case it is available, else NULL.
613 OSSL_CMP_CTX_get1_newChain() returns a pointer to a duplicate of the stack of
614 X.509 certificates computed by OSSL_CMP_certConf_cb() (if this function has
615 been called) on the last received certificate response message IP/CP/KUP.
617 OSSL_CMP_CTX_get1_caPubs() returns a pointer to a duplicate of the stack of
618 X.509 certificates received in the caPubs field of last received certificate
619 response message IP/CP/KUP.
621 OSSL_CMP_CTX_get1_extraCertsIn() returns a pointer to a duplicate of the stack
622 of X.509 certificates received in the last received nonempty extraCerts field.
623 Returns an empty stack if no extraCerts have been received in the current
626 OSSL_CMP_CTX_set1_transactionID() sets the given transaction ID in the given
627 OSSL_CMP_CTX structure.
629 OSSL_CMP_CTX_set1_senderNonce() stores the last sent sender B<nonce> in
630 the B<ctx>. This will be used to validate the recipNonce in incoming messages.
634 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
638 OSSL_CMP_CTX_free() and OSSL_CMP_CTX_print_errors() do not return anything.
641 OSSL_CMP_CTX_get_http_cb_arg(),
642 OSSL_CMP_CTX_get_transfer_cb_arg(),
643 OSSL_CMP_CTX_get0_trustedStore(),
644 OSSL_CMP_CTX_get0_untrusted(),
645 OSSL_CMP_CTX_get0_newPkey(),
646 OSSL_CMP_CTX_get_certConf_cb_arg(),
647 OSSL_CMP_CTX_get0_statusString(),
648 OSSL_CMP_CTX_get0_newCert(),
649 OSSL_CMP_CTX_get0_newChain(),
650 OSSL_CMP_CTX_get1_caPubs(), and
651 OSSL_CMP_CTX_get1_extraCertsIn()
652 return the intended pointer value as described above or NULL on error.
654 OSSL_CMP_CTX_get_option(),
655 OSSL_CMP_CTX_reqExtensions_have_SAN(),
656 OSSL_CMP_CTX_get_status(), and
657 OSSL_CMP_CTX_get_failInfoCode()
658 return the intended value as described above or -1 on error.
660 OSSL_CMP_certConf_cb() returns B<fail_info> if it is not equal to B<0>,
661 else B<0> on successful validation,
662 or else a bit field with the B<OSSL_CMP_PKIFAILUREINFO_incorrectData> bit set.
664 All other functions return 1 on success, 0 on error.
668 The following code omits error handling.
670 Set up a CMP client context for sending requests and verifying responses:
672 cmp_ctx = OSSL_CMP_CTX_new();
673 OSSL_CMP_CTX_set1_server(cmp_ctx, name_or_address);
674 OSSL_CMP_CTX_set1_serverPort(cmp_ctx, port_string);
675 OSSL_CMP_CTX_set1_serverPath(cmp_ctx, path_or_alias);
676 OSSL_CMP_CTX_set0_trustedStore(cmp_ctx, ts);
678 Set up client credentials for password-based protection (PBM):
680 OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
681 OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
683 Set up the details for certificate requests:
685 OSSL_CMP_CTX_set1_subjectName(cmp_ctx, name);
686 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, initialKey);
688 Perform an Initialization Request transaction:
690 initialCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
692 Reset the transaction state of the CMP context and the credentials:
694 OSSL_CMP_CTX_reinit(cmp_ctx);
695 OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, NULL, 0);
696 OSSL_CMP_CTX_set1_secretValue(cmp_ctx, NULL, 0);
698 Perform a Certification Request transaction, making use of the new credentials:
700 OSSL_CMP_CTX_set1_cert(cmp_ctx, initialCert);
701 OSSL_CMP_CTX_set1_pkey(cmp_ctx, initialKey);
702 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, curentKey);
703 currentCert = OSSL_CMP_exec_CR_ses(cmp_ctx);
705 Perform a Key Update Request, signed using the cert (and key) to be updated:
707 OSSL_CMP_CTX_reinit(cmp_ctx);
708 OSSL_CMP_CTX_set1_cert(cmp_ctx, currentCert);
709 OSSL_CMP_CTX_set1_pkey(cmp_ctx, currentKey);
710 OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, updatedKey);
711 currentCert = OSSL_CMP_exec_KUR_ses(cmp_ctx);
712 currentKey = updatedKey;
714 Perform a General Message transaction including, as an example,
715 the id-it-signKeyPairTypes OID and prints info on the General Response contents:
717 OSSL_CMP_CTX_reinit(cmp_ctx);
719 ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
720 OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new(type, NULL);
721 OSSL_CMP_CTX_push0_genm_ITAV(cmp_ctx, itav);
723 STACK_OF(OSSL_CMP_ITAV) *itavs;
724 itavs = OSSL_CMP_exec_GENM_ses(cmp_ctx);
726 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
730 L<OSSL_CMP_exec_IR_ses(3)>, L<OSSL_CMP_exec_CR_ses(3)>,
731 L<OSSL_CMP_exec_KUR_ses(3)>, L<OSSL_CMP_exec_GENM_ses(3)>,
732 L<OSSL_CMP_exec_certreq(3)>
736 The OpenSSL CMP support was added in OpenSSL 3.0.
740 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
742 Licensed under the Apache License 2.0 (the "License"). You may not use
743 this file except in compliance with the License. You can obtain a copy
744 in the file LICENSE in the source distribution or at
745 L<https://www.openssl.org/source/license.html>.