2 * Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 #include "cmp_local.h"
13 #include "internal/cryptlib.h"
15 /* explicit #includes not strictly needed since implied by the above: */
16 #include <openssl/bio.h>
17 #include <openssl/cmp.h>
18 #include <openssl/err.h>
19 #include <openssl/evp.h>
20 #include <openssl/x509v3.h>
22 #include "openssl/cmp_util.h"
24 DEFINE_STACK_OF(OSSL_CRMF_CERTID)
26 #define IS_CREP(t) ((t) == OSSL_CMP_PKIBODY_IP || (t) == OSSL_CMP_PKIBODY_CP \
27 || (t) == OSSL_CMP_PKIBODY_KUP)
30 * Evaluate whether there's an exception (violating the standard) configured for
31 * handling negative responses without protection or with invalid protection.
32 * Returns 1 on acceptance, 0 on rejection, or -1 on (internal) error.
34 static int unprotected_exception(const OSSL_CMP_CTX *ctx,
35 const OSSL_CMP_MSG *rep,
36 int invalid_protection,
37 int expected_type /* ignored here */)
39 int rcvd_type = ossl_cmp_msg_get_bodytype(rep /* may be NULL */);
40 const char *msg_type = NULL;
42 if (!ossl_assert(ctx != NULL && rep != NULL))
45 if (!ctx->unprotectedErrors)
49 case OSSL_CMP_PKIBODY_ERROR:
50 msg_type = "error response";
52 case OSSL_CMP_PKIBODY_RP:
55 ossl_cmp_revrepcontent_get_pkisi(rep->body->value.rp,
60 if (ossl_cmp_pkisi_get_status(si) == OSSL_CMP_PKISTATUS_rejection)
61 msg_type = "revocation response message with rejection status";
64 case OSSL_CMP_PKIBODY_PKICONF:
65 msg_type = "PKI Confirmation message";
68 if (IS_CREP(rcvd_type)) {
69 OSSL_CMP_CERTREPMESSAGE *crepmsg = rep->body->value.ip;
70 OSSL_CMP_CERTRESPONSE *crep =
71 ossl_cmp_certrepmessage_get0_certresponse(crepmsg,
74 if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg->response) > 1)
76 /* TODO: handle potentially multiple CertResponses in CertRepMsg */
79 if (ossl_cmp_pkisi_get_status(crep->status)
80 == OSSL_CMP_PKISTATUS_rejection)
81 msg_type = "CertRepMessage with rejection status";
86 ossl_cmp_log2(WARN, ctx, "ignoring %s protection of %s",
87 invalid_protection ? "invalid" : "missing", msg_type);
92 /* Save error info from PKIStatusInfo field of a certresponse into ctx */
93 static int save_statusInfo(OSSL_CMP_CTX *ctx, OSSL_CMP_PKISI *si)
96 OSSL_CMP_PKIFREETEXT *ss;
98 if (!ossl_assert(ctx != NULL && si != NULL))
101 if ((ctx->status = ossl_cmp_pkisi_get_status(si)) < 0)
104 ctx->failInfoCode = 0;
105 if (si->failInfo != NULL) {
106 for (i = 0; i <= OSSL_CMP_PKIFAILUREINFO_MAX; i++) {
107 if (ASN1_BIT_STRING_get_bit(si->failInfo, i))
108 ctx->failInfoCode |= (1 << i);
112 if (!ossl_cmp_ctx_set0_statusString(ctx, sk_ASN1_UTF8STRING_new_null())
113 || (ctx->statusString == NULL))
116 ss = si->statusString; /* may be NULL */
117 for (i = 0; i < sk_ASN1_UTF8STRING_num(ss); i++) {
118 ASN1_UTF8STRING *str = sk_ASN1_UTF8STRING_value(ss, i);
120 if (!sk_ASN1_UTF8STRING_push(ctx->statusString, ASN1_STRING_dup(str)))
127 * Perform the generic aspects of sending a request and receiving a response.
128 * Returns 1 on success and provides the received PKIMESSAGE in *rep.
129 * Returns 0 on error.
130 * Regardless of success, caller is responsible for freeing *rep (unless NULL).
132 static int send_receive_check(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *req,
133 OSSL_CMP_MSG **rep, int expected_type)
135 const char *req_type_str =
136 ossl_cmp_bodytype_to_string(ossl_cmp_msg_get_bodytype(req));
137 const char *expected_type_str = ossl_cmp_bodytype_to_string(expected_type);
140 time_t now = time(NULL);
142 OSSL_CMP_transfer_cb_t transfer_cb = ctx->transfer_cb;
144 if (transfer_cb == NULL)
145 transfer_cb = OSSL_CMP_MSG_http_perform;
148 msg_timeout = ctx->msg_timeout; /* backup original value */
149 if ((IS_CREP(expected_type) || expected_type == OSSL_CMP_PKIBODY_POLLREP)
150 && ctx->total_timeout > 0 /* timeout is not infinite */) {
151 if (now >= ctx->end_time) {
152 CMPerr(0, CMP_R_TOTAL_TIMEOUT);
155 if (!ossl_assert(ctx->end_time - time(NULL) < INT_MAX)) {
156 /* cannot really happen due to the assignment in do_certreq_seq() */
157 CMPerr(0, CMP_R_INVALID_ARGS);
160 time_left = (int)(ctx->end_time - now);
161 if (ctx->msg_timeout == 0 || time_left < ctx->msg_timeout)
162 ctx->msg_timeout = time_left;
165 /* should print error queue since transfer_cb may call ERR_clear_error() */
166 OSSL_CMP_CTX_print_errors(ctx);
168 ossl_cmp_log1(INFO, ctx, "sending %s", req_type_str);
170 *rep = (*transfer_cb)(ctx, req);
171 ctx->msg_timeout = msg_timeout; /* restore original value */
174 CMPerr(0, CMP_R_TRANSFER_ERROR); /* or receiving response */
175 ERR_add_error_data(2, "request sent: ", req_type_str);
176 ERR_add_error_data(2, ", expected response: ", expected_type_str);
180 bt = ossl_cmp_msg_get_bodytype(*rep);
182 * The body type in the 'bt' variable is not yet verified.
183 * Still we use this preliminary value already for a progress report because
184 * the following msg verification may also produce log entries and may fail.
186 ossl_cmp_log1(INFO, ctx, "received %s", ossl_cmp_bodytype_to_string(bt));
188 /* copy received extraCerts to ctx->extraCertsIn so they can be retrieved */
189 if (bt != OSSL_CMP_PKIBODY_POLLREP && bt != OSSL_CMP_PKIBODY_PKICONF
190 && !ossl_cmp_ctx_set1_extraCertsIn(ctx, (*rep)->extraCerts))
193 if (!ossl_cmp_msg_check_update(ctx, *rep, unprotected_exception,
197 if (bt == expected_type
198 /* as an answer to polling, there could be IP/CP/KUP: */
199 || (IS_CREP(bt) && expected_type == OSSL_CMP_PKIBODY_POLLREP))
202 /* received message type is not one of the expected ones (e.g., error) */
203 CMPerr(0, bt == OSSL_CMP_PKIBODY_ERROR ? CMP_R_RECEIVED_ERROR :
204 CMP_R_UNEXPECTED_PKIBODY); /* in next line for mkerr.pl */
206 if (bt != OSSL_CMP_PKIBODY_ERROR) {
207 ERR_add_error_data(3, "message type is '",
208 ossl_cmp_bodytype_to_string(bt), "'");
210 OSSL_CMP_ERRORMSGCONTENT *emc = (*rep)->body->value.error;
211 OSSL_CMP_PKISI *si = emc->pKIStatusInfo;
212 char buf[OSSL_CMP_PKISI_BUFLEN];
214 if (save_statusInfo(ctx, si)
215 && OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf,
216 sizeof(buf)) != NULL)
217 ERR_add_error_data(1, buf);
218 if (emc->errorCode != NULL
219 && BIO_snprintf(buf, sizeof(buf), "; errorCode: %ld",
220 ASN1_INTEGER_get(emc->errorCode)) > 0)
221 ERR_add_error_data(1, buf);
222 if (emc->errorDetails != NULL) {
223 char *text = sk_ASN1_UTF8STRING2text(emc->errorDetails, ", ",
224 OSSL_CMP_PKISI_BUFLEN - 1);
227 ERR_add_error_data(2, "; errorDetails: ", text);
230 if (ctx->status != OSSL_CMP_PKISTATUS_rejection) {
231 CMPerr(0, CMP_R_UNEXPECTED_PKISTATUS);
232 if (ctx->status == OSSL_CMP_PKISTATUS_waiting)
233 ctx->status = OSSL_CMP_PKISTATUS_rejection;
240 * When a 'waiting' PKIStatus has been received, this function is used to
241 * poll, which should yield a pollRep or finally a CertRepMessage in ip/cp/kup.
242 * On receiving a pollRep, which includes a checkAfter value, it return this
243 * value if sleep == 0, else it sleeps as long as indicated and retries.
245 * A transaction timeout is enabled if ctx->total_timeout is > 0.
246 * In this case polling will continue until the timeout is reached and then
247 * polling is done a last time even if this is before the "checkAfter" time.
249 * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
250 * Returns 1 on success and provides the received PKIMESSAGE in *rep.
251 * In this case the caller is responsible for freeing *rep.
252 * Returns 0 on error (which includes the case that timeout has been reached).
254 static int poll_for_response(OSSL_CMP_CTX *ctx, int sleep, int rid,
255 OSSL_CMP_MSG **rep, int *checkAfter)
257 OSSL_CMP_MSG *preq = NULL;
258 OSSL_CMP_MSG *prep = NULL;
261 "received 'waiting' PKIStatus, starting to poll for response");
264 /* TODO: handle potentially multiple poll requests per message */
265 if ((preq = ossl_cmp_pollReq_new(ctx, rid)) == NULL)
268 if (!send_receive_check(ctx, preq, &prep, OSSL_CMP_PKIBODY_POLLREP))
271 /* handle potential pollRep */
272 if (ossl_cmp_msg_get_bodytype(prep) == OSSL_CMP_PKIBODY_POLLREP) {
273 OSSL_CMP_POLLREPCONTENT *prc = prep->body->value.pollRep;
274 OSSL_CMP_POLLREP *pollRep = NULL;
276 char str[OSSL_CMP_PKISI_BUFLEN];
279 /* TODO: handle potentially multiple elements in pollRep */
280 if (sk_OSSL_CMP_POLLREP_num(prc) > 1) {
281 CMPerr(0, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED);
284 pollRep = ossl_cmp_pollrepcontent_get0_pollrep(prc, rid);
288 if (!ASN1_INTEGER_get_int64(&check_after, pollRep->checkAfter)) {
289 CMPerr(0, CMP_R_BAD_CHECKAFTER_IN_POLLREP);
292 if (check_after < 0 || (uint64_t)check_after
293 > (sleep ? ULONG_MAX / 1000 : INT_MAX)) {
294 CMPerr(0, CMP_R_CHECKAFTER_OUT_OF_RANGE);
295 if (BIO_snprintf(str, OSSL_CMP_PKISI_BUFLEN, "value = %jd",
297 ERR_add_error_data(1, str);
300 if (ctx->total_timeout > 0) { /* timeout is not infinite */
301 const int exp = 5; /* expected max time per msg round trip */
302 int64_t time_left = (int64_t)(ctx->end_time - exp - time(NULL));
304 if (time_left <= 0) {
305 CMPerr(0, CMP_R_TOTAL_TIMEOUT);
308 if (time_left < check_after)
309 check_after = time_left;
310 /* poll one last time just when timeout was reached */
313 if (pollRep->reason == NULL
314 || (len = BIO_snprintf(str, OSSL_CMP_PKISI_BUFLEN,
315 " with reason = '")) < 0) {
318 char *text = sk_ASN1_UTF8STRING2text(pollRep->reason, ", ",
319 sizeof(str) - len - 2);
322 || BIO_snprintf(str + len, sizeof(str) - len,
327 ossl_cmp_log2(INFO, ctx,
328 "received polling response%s; checkAfter = %ld seconds",
331 OSSL_CMP_MSG_free(preq);
333 OSSL_CMP_MSG_free(prep);
336 ossl_sleep((unsigned long)(1000 * check_after));
338 if (checkAfter != NULL)
339 *checkAfter = (int)check_after;
340 return -1; /* exits the loop */
343 ossl_cmp_info(ctx, "received ip/cp/kup after polling");
344 /* any other body type has been rejected by send_receive_check() */
351 OSSL_CMP_MSG_free(preq);
356 OSSL_CMP_MSG_free(preq);
357 OSSL_CMP_MSG_free(prep);
361 /* Send certConf for IR, CR or KUR sequences and check response */
362 int ossl_cmp_exchange_certConf(OSSL_CMP_CTX *ctx, int fail_info,
365 OSSL_CMP_MSG *certConf;
366 OSSL_CMP_MSG *PKIconf = NULL;
369 /* OSSL_CMP_certConf_new() also checks if all necessary options are set */
370 if ((certConf = ossl_cmp_certConf_new(ctx, fail_info, txt)) == NULL)
373 res = send_receive_check(ctx, certConf, &PKIconf, OSSL_CMP_PKIBODY_PKICONF);
376 OSSL_CMP_MSG_free(certConf);
377 OSSL_CMP_MSG_free(PKIconf);
381 /* Send given error and check response */
382 int ossl_cmp_exchange_error(OSSL_CMP_CTX *ctx, int status, int fail_info,
383 const char *txt, int errorCode, const char *details)
385 OSSL_CMP_MSG *error = NULL;
386 OSSL_CMP_PKISI *si = NULL;
387 OSSL_CMP_MSG *PKIconf = NULL;
390 if ((si = OSSL_CMP_STATUSINFO_new(status, fail_info, txt)) == NULL)
392 /* ossl_cmp_error_new() also checks if all necessary options are set */
393 if ((error = ossl_cmp_error_new(ctx, si, errorCode, details, 0)) == NULL)
396 res = send_receive_check(ctx, error, &PKIconf, OSSL_CMP_PKIBODY_PKICONF);
399 OSSL_CMP_MSG_free(error);
400 OSSL_CMP_PKISI_free(si);
401 OSSL_CMP_MSG_free(PKIconf);
406 * Retrieve a copy of the certificate, if any, from the given CertResponse.
407 * Take into account PKIStatusInfo of CertResponse in ctx, report it on error.
408 * Returns NULL if not found or on error.
410 static X509 *get1_cert_status(OSSL_CMP_CTX *ctx, int bodytype,
411 OSSL_CMP_CERTRESPONSE *crep)
413 char buf[OSSL_CMP_PKISI_BUFLEN];
417 if (!ossl_assert(ctx != NULL && crep != NULL))
420 privkey = OSSL_CMP_CTX_get0_newPkey(ctx, 1);
421 switch (ossl_cmp_pkisi_get_status(crep->status)) {
422 case OSSL_CMP_PKISTATUS_waiting:
424 "received \"waiting\" status for cert when actually aiming to extract cert");
425 CMPerr(0, CMP_R_ENCOUNTERED_WAITING);
427 case OSSL_CMP_PKISTATUS_grantedWithMods:
428 ossl_cmp_warn(ctx, "received \"grantedWithMods\" for certificate");
430 case OSSL_CMP_PKISTATUS_accepted:
432 /* get all information in case of a rejection before going to error */
433 case OSSL_CMP_PKISTATUS_rejection:
434 ossl_cmp_err(ctx, "received \"rejection\" status rather than cert");
435 CMPerr(0, CMP_R_REQUEST_REJECTED_BY_SERVER);
437 case OSSL_CMP_PKISTATUS_revocationWarning:
439 "received \"revocationWarning\" - a revocation of the cert is imminent");
441 case OSSL_CMP_PKISTATUS_revocationNotification:
443 "received \"revocationNotification\" - a revocation of the cert has occurred");
445 case OSSL_CMP_PKISTATUS_keyUpdateWarning:
446 if (bodytype != OSSL_CMP_PKIBODY_KUR) {
447 CMPerr(0, CMP_R_ENCOUNTERED_KEYUPDATEWARNING);
452 ossl_cmp_log1(ERROR, ctx,
453 "received unsupported PKIStatus %d for certificate",
455 CMPerr(0, CMP_R_UNKNOWN_PKISTATUS);
458 crt = ossl_cmp_certresponse_get1_cert(crep, ctx, privkey);
459 if (crt == NULL) /* according to PKIStatus, we can expect a cert */
460 CMPerr(0, CMP_R_CERTIFICATE_NOT_FOUND);
465 if (OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf, sizeof(buf)) != NULL)
466 ERR_add_error_data(1, buf);
471 * Callback fn validating that the new certificate can be verified, using
472 * ctx->certConf_cb_arg, which has been initialized using opt_out_trusted, and
473 * ctx->untrusted, which at this point already contains msg->extraCerts.
474 * Returns 0 on acceptance, else a bit field reflecting PKIFailureInfo.
475 * Quoting from RFC 4210 section 5.1. Overall PKI Message:
476 * The extraCerts field can contain certificates that may be useful to
477 * the recipient. For example, this can be used by a CA or RA to
478 * present an end entity with certificates that it needs to verify its
479 * own new certificate (if, for example, the CA that issued the end
480 * entity's certificate is not a root CA for the end entity). Note that
481 * this field does not necessarily contain a certification path; the
482 * recipient may have to sort, select from, or otherwise process the
483 * extra certificates in order to use them.
484 * Note: While often handy, there is no hard requirement by CMP that
485 * an EE must be able to validate the certificates it gets enrolled.
487 int OSSL_CMP_certConf_cb(OSSL_CMP_CTX *ctx, X509 *cert, int fail_info,
490 X509_STORE *out_trusted = OSSL_CMP_CTX_get_certConf_cb_arg(ctx);
491 STACK_OF(X509) *chain = NULL;
492 (void)text; /* make (artificial) use of var to prevent compiler warning */
494 if (fail_info != 0) /* accept any error flagged by CMP core library */
497 ossl_cmp_debug(ctx, "trying to build chain for newly enrolled cert");
498 chain = ossl_cmp_build_cert_chain(ctx->libctx, ctx->propq,
499 out_trusted /* may be NULL */,
500 ctx->untrusted, cert);
501 if (sk_X509_num(chain) > 0)
502 X509_free(sk_X509_shift(chain)); /* remove leaf (EE) cert */
503 if (out_trusted != NULL) {
505 ossl_cmp_err(ctx, "failed building chain for newly enrolled cert");
506 fail_info = 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData;
509 "succeeded building proper chain for newly enrolled cert");
511 } else if (chain == NULL) {
512 ossl_cmp_warn(ctx, "could not build approximate chain for newly enrolled cert, resorting to received extraCerts");
513 chain = OSSL_CMP_CTX_get1_extraCertsIn(ctx);
516 "success building approximate chain for newly enrolled cert");
518 (void)ossl_cmp_ctx_set1_newChain(ctx, chain);
519 sk_X509_pop_free(chain, X509_free);
525 * Perform the generic handling of certificate responses for IR/CR/KUR/P10CR.
526 * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
527 * Returns 1 on success and provides the received PKIMESSAGE in *resp.
528 * Returns 0 on error (which includes the case that timeout has been reached).
529 * Regardless of success, caller is responsible for freeing *resp (unless NULL).
531 static int cert_response(OSSL_CMP_CTX *ctx, int sleep, int rid,
532 OSSL_CMP_MSG **resp, int *checkAfter,
533 int req_type, int expected_type)
535 EVP_PKEY *rkey = OSSL_CMP_CTX_get0_newPkey(ctx /* may be NULL */, 0);
536 int fail_info = 0; /* no failure */
537 const char *txt = NULL;
538 OSSL_CMP_CERTREPMESSAGE *crepmsg;
539 OSSL_CMP_CERTRESPONSE *crep;
540 OSSL_CMP_certConf_cb_t cb;
545 if (!ossl_assert(ctx != NULL))
549 crepmsg = (*resp)->body->value.ip; /* same for cp and kup */
550 if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg->response) > 1) {
551 CMPerr(0, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED);
554 /* TODO: handle potentially multiple CertResponses in CertRepMsg */
555 crep = ossl_cmp_certrepmessage_get0_certresponse(crepmsg, rid);
558 if (!save_statusInfo(ctx, crep->status))
561 /* for OSSL_CMP_PKIBODY_P10CR learn CertReqId from response */
562 rid = ossl_cmp_asn1_get_int(crep->certReqId);
564 CMPerr(0, CMP_R_BAD_REQUEST_ID);
569 if (ossl_cmp_pkisi_get_status(crep->status) == OSSL_CMP_PKISTATUS_waiting) {
570 OSSL_CMP_MSG_free(*resp);
572 if ((ret = poll_for_response(ctx, sleep, rid, resp, checkAfter)) != 0) {
573 if (ret == -1) /* at this point implies sleep == 0 */
574 return ret; /* waiting */
575 goto retry; /* got ip/cp/kup, which may still indicate 'waiting' */
577 CMPerr(0, CMP_R_POLLING_FAILED);
582 cert = get1_cert_status(ctx, (*resp)->body->type, crep);
584 ERR_add_error_data(1, "; cannot extract certificate from response");
587 if (!ossl_cmp_ctx_set0_newCert(ctx, cert))
591 * if the CMP server returned certificates in the caPubs field, copy them
592 * to the context so that they can be retrieved if necessary
594 if (crepmsg->caPubs != NULL
595 && !ossl_cmp_ctx_set1_caPubs(ctx, crepmsg->caPubs))
598 subj = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
600 /* X509_check_private_key() also works if rkey is just public key */
601 && !(X509_check_private_key(ctx->newCert, rkey))) {
602 fail_info = 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData;
603 txt = "public key in new certificate does not match our enrollment key";
605 * not calling (void)ossl_cmp_exchange_error(ctx,
606 * OSSL_CMP_PKISTATUS_rejection, fail_info, txt)
607 * not throwing CMP_R_CERTIFICATE_NOT_ACCEPTED with txt
609 * since we better leave this for the certConf_cb to decide
614 * Execute the certification checking callback function,
615 * which can determine whether to accept a newly enrolled certificate.
616 * It may overrule the pre-decision reflected in 'fail_info' and '*txt'.
618 cb = ctx->certConf_cb != NULL ? ctx->certConf_cb : OSSL_CMP_certConf_cb;
619 if ((fail_info = cb(ctx, ctx->newCert, fail_info, &txt)) != 0
621 txt = "CMP client did not accept it";
622 if (fail_info != 0) /* immediately log error before any certConf exchange */
623 ossl_cmp_log1(ERROR, ctx,
624 "rejecting newly enrolled cert with subject: %s", subj);
627 * TODO: better move certConf exchange to do_certreq_seq() such that
628 * also more low-level errors with CertReqMessages get reported to server
630 if (!ctx->disableConfirm
631 && !ossl_cmp_hdr_has_implicitConfirm((*resp)->header)) {
632 if (!ossl_cmp_exchange_certConf(ctx, fail_info, txt))
636 /* not throwing failure earlier as transfer_cb may call ERR_clear_error() */
637 if (fail_info != 0) {
638 CMPerr(0, CMP_R_CERTIFICATE_NOT_ACCEPTED);
639 ERR_add_error_data(2, "rejecting newly enrolled cert with subject: ",
642 ERR_add_error_txt("; ", txt);
649 int OSSL_CMP_try_certreq(OSSL_CMP_CTX *ctx, int req_type,
650 const OSSL_CRMF_MSG *crm, int *checkAfter)
652 OSSL_CMP_MSG *req = NULL;
653 OSSL_CMP_MSG *rep = NULL;
654 int is_p10 = req_type == OSSL_CMP_PKIBODY_P10CR;
655 int rid = is_p10 ? -1 : OSSL_CMP_CERTREQID;
656 int rep_type = is_p10 ? OSSL_CMP_PKIBODY_CP : req_type + 1;
660 CMPerr(0, CMP_R_NULL_ARGUMENT);
664 if (ctx->status != OSSL_CMP_PKISTATUS_waiting) { /* not polling already */
666 if (!ossl_cmp_ctx_set0_newCert(ctx, NULL))
669 if (ctx->total_timeout > 0) /* else ctx->end_time is not used */
670 ctx->end_time = time(NULL) + ctx->total_timeout;
672 req = ossl_cmp_certreq_new(ctx, req_type, crm);
673 if (req == NULL) /* also checks if all necessary options are set */
676 if (!send_receive_check(ctx, req, &rep, rep_type))
680 return ossl_cmp_exchange_error(ctx, OSSL_CMP_PKISTATUS_rejection,
681 0 /* TODO better fail_info value? */,
682 "polling aborted", 0 /* errorCode */,
684 res = poll_for_response(ctx, 0 /* no sleep */, rid, &rep, checkAfter);
685 if (res <= 0) /* waiting or error */
688 res = cert_response(ctx, 0 /* no sleep */, rid, &rep, checkAfter,
692 OSSL_CMP_MSG_free(req);
693 OSSL_CMP_MSG_free(rep);
698 * Do the full sequence CR/IR/KUR/P10CR, CP/IP/KUP/CP,
699 * certConf, PKIconf, and polling if required.
700 * Will sleep as long as indicated by the server (according to checkAfter).
701 * All enrollment options need to be present in the context.
702 * TODO: another function to request two certificates at once should be created.
703 * Returns pointer to received certificate, or NULL if none was received.
705 X509 *OSSL_CMP_exec_certreq(OSSL_CMP_CTX *ctx, int req_type,
706 const OSSL_CRMF_MSG *crm)
709 OSSL_CMP_MSG *req = NULL;
710 OSSL_CMP_MSG *rep = NULL;
711 int is_p10 = req_type == OSSL_CMP_PKIBODY_P10CR;
712 int rid = is_p10 ? -1 : OSSL_CMP_CERTREQID;
713 int rep_type = is_p10 ? OSSL_CMP_PKIBODY_CP : req_type + 1;
717 CMPerr(0, CMP_R_NULL_ARGUMENT);
720 if (is_p10 && crm != NULL) {
721 CMPerr(0, CMP_R_INVALID_ARGS);
726 if (!ossl_cmp_ctx_set0_newCert(ctx, NULL))
729 if (ctx->total_timeout > 0) /* else ctx->end_time is not used */
730 ctx->end_time = time(NULL) + ctx->total_timeout;
732 /* OSSL_CMP_certreq_new() also checks if all necessary options are set */
733 if ((req = ossl_cmp_certreq_new(ctx, req_type, crm)) == NULL)
736 if (!send_receive_check(ctx, req, &rep, rep_type))
739 if (cert_response(ctx, 1 /* sleep */, rid, &rep, NULL, req_type, rep_type)
743 result = ctx->newCert;
745 OSSL_CMP_MSG_free(req);
746 OSSL_CMP_MSG_free(rep);
750 X509 *OSSL_CMP_exec_RR_ses(OSSL_CMP_CTX *ctx)
752 OSSL_CMP_MSG *rr = NULL;
753 OSSL_CMP_MSG *rp = NULL;
754 const int num_RevDetails = 1;
755 const int rsid = OSSL_CMP_REVREQSID;
756 OSSL_CMP_REVREPCONTENT *rrep = NULL;
757 OSSL_CMP_PKISI *si = NULL;
758 char buf[OSSL_CMP_PKISI_BUFLEN];
762 CMPerr(0, CMP_R_INVALID_ARGS);
765 if (ctx->oldCert == NULL) {
766 CMPerr(0, CMP_R_MISSING_REFERENCE_CERT);
771 /* OSSL_CMP_rr_new() also checks if all necessary options are set */
772 if ((rr = ossl_cmp_rr_new(ctx)) == NULL)
775 if (!send_receive_check(ctx, rr, &rp, OSSL_CMP_PKIBODY_RP))
778 rrep = rp->body->value.rp;
779 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
780 if (sk_OSSL_CMP_PKISI_num(rrep->status) != num_RevDetails) {
781 CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
785 if (sk_OSSL_CMP_PKISI_num(rrep->status) < 1) {
786 CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
791 /* evaluate PKIStatus field */
792 si = ossl_cmp_revrepcontent_get_pkisi(rrep, rsid);
793 if (!save_statusInfo(ctx, si))
795 switch (ossl_cmp_pkisi_get_status(si)) {
796 case OSSL_CMP_PKISTATUS_accepted:
797 ossl_cmp_info(ctx, "revocation accepted (PKIStatus=accepted)");
798 result = ctx->oldCert;
800 case OSSL_CMP_PKISTATUS_grantedWithMods:
801 ossl_cmp_info(ctx, "revocation accepted (PKIStatus=grantedWithMods)");
802 result = ctx->oldCert;
804 case OSSL_CMP_PKISTATUS_rejection:
805 CMPerr(0, CMP_R_REQUEST_REJECTED_BY_SERVER);
807 case OSSL_CMP_PKISTATUS_revocationWarning:
808 ossl_cmp_info(ctx, "revocation accepted (PKIStatus=revocationWarning)");
809 result = ctx->oldCert;
811 case OSSL_CMP_PKISTATUS_revocationNotification:
812 /* interpretation as warning or error depends on CA */
814 "revocation accepted (PKIStatus=revocationNotification)");
815 result = ctx->oldCert;
817 case OSSL_CMP_PKISTATUS_waiting:
818 case OSSL_CMP_PKISTATUS_keyUpdateWarning:
819 CMPerr(0, CMP_R_UNEXPECTED_PKISTATUS);
822 CMPerr(0, CMP_R_UNKNOWN_PKISTATUS);
826 /* check any present CertId in optional revCerts field */
827 if (rrep->revCerts != NULL) {
828 OSSL_CRMF_CERTID *cid;
829 OSSL_CRMF_CERTTEMPLATE *tmpl =
830 sk_OSSL_CMP_REVDETAILS_value(rr->body->value.rr, rsid)->certDetails;
831 const X509_NAME *issuer = OSSL_CRMF_CERTTEMPLATE_get0_issuer(tmpl);
832 ASN1_INTEGER *serial = OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(tmpl);
834 if (sk_OSSL_CRMF_CERTID_num(rrep->revCerts) != num_RevDetails) {
835 CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
839 if ((cid = ossl_cmp_revrepcontent_get_CertId(rrep, rsid)) == NULL) {
843 if (X509_NAME_cmp(issuer, OSSL_CRMF_CERTID_get0_issuer(cid)) != 0) {
844 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
845 CMPerr(0, CMP_R_WRONG_CERTID_IN_RP);
850 if (ASN1_INTEGER_cmp(serial,
851 OSSL_CRMF_CERTID_get0_serialNumber(cid)) != 0) {
852 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
853 CMPerr(0, CMP_R_WRONG_SERIAL_IN_RP);
860 /* check number of any optionally present crls */
861 if (rrep->crls != NULL && sk_X509_CRL_num(rrep->crls) != num_RevDetails) {
862 CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
869 && OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf, sizeof(buf)) != NULL)
870 ERR_add_error_data(1, buf);
873 OSSL_CMP_MSG_free(rr);
874 OSSL_CMP_MSG_free(rp);
878 STACK_OF(OSSL_CMP_ITAV) *OSSL_CMP_exec_GENM_ses(OSSL_CMP_CTX *ctx)
881 OSSL_CMP_MSG *genp = NULL;
882 STACK_OF(OSSL_CMP_ITAV) *rcvd_itavs = NULL;
885 CMPerr(0, CMP_R_INVALID_ARGS);
889 if ((genm = ossl_cmp_genm_new(ctx)) == NULL)
892 if (!send_receive_check(ctx, genm, &genp, OSSL_CMP_PKIBODY_GENP))
895 /* received stack of itavs not to be freed with the genp */
896 rcvd_itavs = genp->body->value.genp;
897 genp->body->value.genp = NULL;
900 OSSL_CMP_MSG_free(genm);
901 OSSL_CMP_MSG_free(genp);
903 return rcvd_itavs; /* recv_itavs == NULL indicates an error */