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