crypto/cmp/cmp_client.c

   1 /*
   2  * Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright Nokia 2007-2019
   4  * Copyright Siemens AG 2015-2019
   5  *
   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
  10  */
  11
  12 #include "cmp_local.h"
  13 #include "internal/cryptlib.h"
  14
  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>
  21
  22 #include "openssl/cmp_util.h"
  23
  24 DEFINE_STACK_OF(ASN1_UTF8STRING)
  25 DEFINE_STACK_OF(X509_CRL)
  26 DEFINE_STACK_OF(OSSL_CMP_CERTRESPONSE)
  27 DEFINE_STACK_OF(OSSL_CMP_PKISI)
  28 DEFINE_STACK_OF(OSSL_CRMF_CERTID)
  29
  30 #define IS_CREP(t) ((t) == OSSL_CMP_PKIBODY_IP || (t) == OSSL_CMP_PKIBODY_CP \
  31                         || (t) == OSSL_CMP_PKIBODY_KUP)
  32
  33 /*-
  34  * Evaluate whether there's an exception (violating the standard) configured for
  35  * handling negative responses without protection or with invalid protection.
  36  * Returns 1 on acceptance, 0 on rejection, or -1 on (internal) error.
  37  */
  38 static int unprotected_exception(const OSSL_CMP_CTX *ctx,
  39                                  const OSSL_CMP_MSG *rep,
  40                                  int invalid_protection,
  41                                  int expected_type /* ignored here */)
  42 {
  43     int rcvd_type = ossl_cmp_msg_get_bodytype(rep /* may be NULL */);
  44     const char *msg_type = NULL;
  45
  46     if (!ossl_assert(ctx != NULL && rep != NULL))
  47         return -1;
  48
  49     if (!ctx->unprotectedErrors)
  50         return 0;
  51
  52     switch (rcvd_type) {
  53     case OSSL_CMP_PKIBODY_ERROR:
  54         msg_type = "error response";
  55         break;
  56     case OSSL_CMP_PKIBODY_RP:
  57         {
  58             OSSL_CMP_PKISI *si =
  59                 ossl_cmp_revrepcontent_get_pkisi(rep->body->value.rp,
  60                                                  OSSL_CMP_REVREQSID);
  61
  62             if (si == NULL)
  63                 return -1;
  64             if (ossl_cmp_pkisi_get_status(si) == OSSL_CMP_PKISTATUS_rejection)
  65                 msg_type = "revocation response message with rejection status";
  66             break;
  67         }
  68     case OSSL_CMP_PKIBODY_PKICONF:
  69         msg_type = "PKI Confirmation message";
  70         break;
  71     default:
  72         if (IS_CREP(rcvd_type)) {
  73             OSSL_CMP_CERTREPMESSAGE *crepmsg = rep->body->value.ip;
  74             OSSL_CMP_CERTRESPONSE *crep =
  75                 ossl_cmp_certrepmessage_get0_certresponse(crepmsg,
  76                                                           -1 /* any rid */);
  77
  78             if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg->response) > 1)
  79                 return -1;
  80             /* TODO: handle potentially multiple CertResponses in CertRepMsg */
  81             if (crep == NULL)
  82                 return -1;
  83             if (ossl_cmp_pkisi_get_status(crep->status)
  84                 == OSSL_CMP_PKISTATUS_rejection)
  85                 msg_type = "CertRepMessage with rejection status";
  86         }
  87     }
  88     if (msg_type == NULL)
  89         return 0;
  90     ossl_cmp_log2(WARN, ctx, "ignoring %s protection of %s",
  91                   invalid_protection ? "invalid" : "missing", msg_type);
  92     return 1;
  93 }
  94
  95
  96 /* Save error info from PKIStatusInfo field of a certresponse into ctx */
  97 static int save_statusInfo(OSSL_CMP_CTX *ctx, OSSL_CMP_PKISI *si)
  98 {
  99     int i;
 100     OSSL_CMP_PKIFREETEXT *ss;
 101
 102     if (!ossl_assert(ctx != NULL && si != NULL))
 103         return 0;
 104
 105     if ((ctx->status = ossl_cmp_pkisi_get_status(si)) < 0)
 106         return 0;
 107
 108     ctx->failInfoCode = 0;
 109     if (si->failInfo != NULL) {
 110         for (i = 0; i <= OSSL_CMP_PKIFAILUREINFO_MAX; i++) {
 111             if (ASN1_BIT_STRING_get_bit(si->failInfo, i))
 112                 ctx->failInfoCode |= (1 << i);
 113         }
 114     }
 115
 116     if (!ossl_cmp_ctx_set0_statusString(ctx, sk_ASN1_UTF8STRING_new_null())
 117             || (ctx->statusString == NULL))
 118         return 0;
 119
 120     ss = si->statusString; /* may be NULL */
 121     for (i = 0; i < sk_ASN1_UTF8STRING_num(ss); i++) {
 122         ASN1_UTF8STRING *str = sk_ASN1_UTF8STRING_value(ss, i);
 123
 124         if (!sk_ASN1_UTF8STRING_push(ctx->statusString, ASN1_STRING_dup(str)))
 125             return 0;
 126     }
 127     return 1;
 128 }
 129
 130 /*-
 131  * Perform the generic aspects of sending a request and receiving a response.
 132  * Returns 1 on success and provides the received PKIMESSAGE in *rep.
 133  * Returns 0 on error.
 134  * Regardless of success, caller is responsible for freeing *rep (unless NULL).
 135  */
 136 static int send_receive_check(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *req,
 137                               OSSL_CMP_MSG **rep, int expected_type)
 138 {
 139     const char *req_type_str =
 140         ossl_cmp_bodytype_to_string(ossl_cmp_msg_get_bodytype(req));
 141     const char *expected_type_str = ossl_cmp_bodytype_to_string(expected_type);
 142     int msg_timeout;
 143     int bt;
 144     time_t now = time(NULL);
 145     int time_left;
 146     OSSL_CMP_transfer_cb_t transfer_cb = ctx->transfer_cb;
 147
 148     if (transfer_cb == NULL)
 149         transfer_cb = OSSL_CMP_MSG_http_perform;
 150
 151     *rep = NULL;
 152     msg_timeout = ctx->msg_timeout; /* backup original value */
 153     if ((IS_CREP(expected_type) || expected_type == OSSL_CMP_PKIBODY_POLLREP)
 154             && ctx->total_timeout > 0 /* timeout is not infinite */) {
 155         if (now >= ctx->end_time) {
 156             CMPerr(0, CMP_R_TOTAL_TIMEOUT);
 157             return 0;
 158         }
 159         if (!ossl_assert(ctx->end_time - time(NULL) < INT_MAX)) {
 160             /* cannot really happen due to the assignment in do_certreq_seq() */
 161             CMPerr(0, CMP_R_INVALID_ARGS);
 162             return 0;
 163         }
 164         time_left = (int)(ctx->end_time - now);
 165         if (ctx->msg_timeout == 0 || time_left < ctx->msg_timeout)
 166             ctx->msg_timeout = time_left;
 167     }
 168
 169     /* should print error queue since transfer_cb may call ERR_clear_error() */
 170     OSSL_CMP_CTX_print_errors(ctx);
 171
 172     ossl_cmp_log1(INFO, ctx, "sending %s", req_type_str);
 173
 174     *rep = (*transfer_cb)(ctx, req);
 175     ctx->msg_timeout = msg_timeout; /* restore original value */
 176
 177     if (*rep == NULL) {
 178         CMPerr(0, CMP_R_TRANSFER_ERROR); /* or receiving response */
 179         ERR_add_error_data(2, "request sent: ", req_type_str);
 180         ERR_add_error_data(2, ", expected response: ", expected_type_str);
 181         return 0;
 182     }
 183
 184     bt = ossl_cmp_msg_get_bodytype(*rep);
 185     /*
 186      * The body type in the 'bt' variable is not yet verified.
 187      * Still we use this preliminary value already for a progress report because
 188      * the following msg verification may also produce log entries and may fail.
 189      */
 190     ossl_cmp_log1(INFO, ctx, "received %s", ossl_cmp_bodytype_to_string(bt));
 191
 192     if (!ossl_cmp_msg_check_update(ctx, *rep, unprotected_exception,
 193                                    expected_type))
 194         return 0;
 195
 196     if (bt == expected_type
 197         /* as an answer to polling, there could be IP/CP/KUP: */
 198             || (IS_CREP(bt) && expected_type == OSSL_CMP_PKIBODY_POLLREP))
 199         return 1;
 200
 201     /* received message type is not one of the expected ones (e.g., error) */
 202     CMPerr(0, bt == OSSL_CMP_PKIBODY_ERROR ? CMP_R_RECEIVED_ERROR :
 203            CMP_R_UNEXPECTED_PKIBODY); /* in next line for mkerr.pl */
 204
 205     if (bt != OSSL_CMP_PKIBODY_ERROR) {
 206         ERR_add_error_data(3, "message type is '",
 207                            ossl_cmp_bodytype_to_string(bt), "'");
 208     } else {
 209         OSSL_CMP_ERRORMSGCONTENT *emc = (*rep)->body->value.error;
 210         OSSL_CMP_PKISI *si = emc->pKIStatusInfo;
 211         char buf[OSSL_CMP_PKISI_BUFLEN];
 212
 213         if (save_statusInfo(ctx, si)
 214                 && OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf,
 215                                                   sizeof(buf)) != NULL)
 216             ERR_add_error_data(1, buf);
 217         if (emc->errorCode != NULL
 218                 && BIO_snprintf(buf, sizeof(buf), "; errorCode: %ld",
 219                                 ASN1_INTEGER_get(emc->errorCode)) > 0)
 220             ERR_add_error_data(1, buf);
 221         if (emc->errorDetails != NULL) {
 222             char *text = sk_ASN1_UTF8STRING2text(emc->errorDetails, ", ",
 223                                                  OSSL_CMP_PKISI_BUFLEN - 1);
 224
 225             if (text != NULL)
 226                 ERR_add_error_data(2, "; errorDetails: ", text);
 227             OPENSSL_free(text);
 228         }
 229         if (ctx->status != OSSL_CMP_PKISTATUS_rejection) {
 230             CMPerr(0, CMP_R_UNEXPECTED_PKISTATUS);
 231             if (ctx->status == OSSL_CMP_PKISTATUS_waiting)
 232                 ctx->status = OSSL_CMP_PKISTATUS_rejection;
 233         }
 234     }
 235     return 0;
 236 }
 237
 238 /*-
 239  * When a 'waiting' PKIStatus has been received, this function is used to
 240  * poll, which should yield a pollRep or finally a CertRepMessage in ip/cp/kup.
 241  * On receiving a pollRep, which includes a checkAfter value, it return this
 242  * value if sleep == 0, else it sleeps as long as indicated and retries.
 243  *
 244  * A transaction timeout is enabled if ctx->total_timeout is > 0.
 245  * In this case polling will continue until the timeout is reached and then
 246  * polling is done a last time even if this is before the "checkAfter" time.
 247  *
 248  * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
 249  * Returns 1 on success and provides the received PKIMESSAGE in *rep.
 250  *           In this case the caller is responsible for freeing *rep.
 251  * Returns 0 on error (which includes the case that timeout has been reached).
 252  */
 253 static int poll_for_response(OSSL_CMP_CTX *ctx, int sleep, int rid,
 254                              OSSL_CMP_MSG **rep, int *checkAfter)
 255 {
 256     OSSL_CMP_MSG *preq = NULL;
 257     OSSL_CMP_MSG *prep = NULL;
 258
 259     ossl_cmp_info(ctx,
 260                   "received 'waiting' PKIStatus, starting to poll for response");
 261     *rep = NULL;
 262     for (;;) {
 263         /* TODO: handle potentially multiple poll requests per message */
 264         if ((preq = ossl_cmp_pollReq_new(ctx, rid)) == NULL)
 265             goto err;
 266
 267         if (!send_receive_check(ctx, preq, &prep, OSSL_CMP_PKIBODY_POLLREP))
 268             goto err;
 269
 270         /* handle potential pollRep */
 271         if (ossl_cmp_msg_get_bodytype(prep) == OSSL_CMP_PKIBODY_POLLREP) {
 272             OSSL_CMP_POLLREPCONTENT *prc = prep->body->value.pollRep;
 273             OSSL_CMP_POLLREP *pollRep = NULL;
 274             int64_t check_after;
 275             char str[OSSL_CMP_PKISI_BUFLEN];
 276             int len;
 277
 278             /* TODO: handle potentially multiple elements in pollRep */
 279             if (sk_OSSL_CMP_POLLREP_num(prc) > 1) {
 280                 CMPerr(0, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED);
 281                 goto err;
 282             }
 283             pollRep = ossl_cmp_pollrepcontent_get0_pollrep(prc, rid);
 284             if (pollRep == NULL)
 285                 goto err;
 286
 287             if (!ASN1_INTEGER_get_int64(&check_after, pollRep->checkAfter)) {
 288                 CMPerr(0, CMP_R_BAD_CHECKAFTER_IN_POLLREP);
 289                 goto err;
 290             }
 291             if (check_after < 0 || (uint64_t)check_after
 292                 > (sleep ? ULONG_MAX / 1000 : INT_MAX)) {
 293                 CMPerr(0, CMP_R_CHECKAFTER_OUT_OF_RANGE);
 294                 if (BIO_snprintf(str, OSSL_CMP_PKISI_BUFLEN, "value = %jd",
 295                                  check_after) >= 0)
 296                     ERR_add_error_data(1, str);
 297                 goto err;
 298             }
 299             if (ctx->total_timeout > 0) { /* timeout is not infinite */
 300                 const int exp = 5; /* expected max time per msg round trip */
 301                 int64_t time_left = (int64_t)(ctx->end_time - exp - time(NULL));
 302
 303                 if (time_left <= 0) {
 304                     CMPerr(0, CMP_R_TOTAL_TIMEOUT);
 305                     goto err;
 306                 }
 307                 if (time_left < check_after)
 308                     check_after = time_left;
 309                 /* poll one last time just when timeout was reached */
 310             }
 311
 312             if (pollRep->reason == NULL
 313                     || (len = BIO_snprintf(str, OSSL_CMP_PKISI_BUFLEN,
 314                                            " with reason = '")) < 0) {
 315                 *str = '\0';
 316             } else {
 317                 char *text = sk_ASN1_UTF8STRING2text(pollRep->reason, ", ",
 318                                                      sizeof(str) - len - 2);
 319
 320                 if (text == NULL
 321                         || BIO_snprintf(str + len, sizeof(str) - len,
 322                                         "%s'", text) < 0)
 323                     *str = '\0';
 324                 OPENSSL_free(text);
 325             }
 326             ossl_cmp_log2(INFO, ctx,
 327                           "received polling response%s; checkAfter = %ld seconds",
 328                           str, check_after);
 329
 330             OSSL_CMP_MSG_free(preq);
 331             preq = NULL;
 332             OSSL_CMP_MSG_free(prep);
 333             prep = NULL;
 334             if (sleep) {
 335                 ossl_sleep((unsigned long)(1000 * check_after));
 336             } else {
 337                 if (checkAfter != NULL)
 338                     *checkAfter = (int)check_after;
 339                 return -1; /* exits the loop */
 340             }
 341         } else {
 342             ossl_cmp_info(ctx, "received ip/cp/kup after polling");
 343             /* any other body type has been rejected by send_receive_check() */
 344             break;
 345         }
 346     }
 347     if (prep == NULL)
 348         goto err;
 349
 350     OSSL_CMP_MSG_free(preq);
 351     *rep = prep;
 352
 353     return 1;
 354  err:
 355     OSSL_CMP_MSG_free(preq);
 356     OSSL_CMP_MSG_free(prep);
 357     return 0;
 358 }
 359
 360 /* Send certConf for IR, CR or KUR sequences and check response */
 361 int ossl_cmp_exchange_certConf(OSSL_CMP_CTX *ctx, int fail_info,
 362                                const char *txt)
 363 {
 364     OSSL_CMP_MSG *certConf;
 365     OSSL_CMP_MSG *PKIconf = NULL;
 366     int res = 0;
 367
 368     /* OSSL_CMP_certConf_new() also checks if all necessary options are set */
 369     if ((certConf = ossl_cmp_certConf_new(ctx, fail_info, txt)) == NULL)
 370         goto err;
 371
 372     res = send_receive_check(ctx, certConf, &PKIconf, OSSL_CMP_PKIBODY_PKICONF);
 373
 374  err:
 375     OSSL_CMP_MSG_free(certConf);
 376     OSSL_CMP_MSG_free(PKIconf);
 377     return res;
 378 }
 379
 380 /* Send given error and check response */
 381 int ossl_cmp_exchange_error(OSSL_CMP_CTX *ctx, int status, int fail_info,
 382                             const char *txt, int errorCode, const char *details)
 383 {
 384     OSSL_CMP_MSG *error = NULL;
 385     OSSL_CMP_PKISI *si = NULL;
 386     OSSL_CMP_MSG *PKIconf = NULL;
 387     int res = 0;
 388
 389     if ((si = OSSL_CMP_STATUSINFO_new(status, fail_info, txt)) == NULL)
 390         goto err;
 391     /* ossl_cmp_error_new() also checks if all necessary options are set */
 392     if ((error = ossl_cmp_error_new(ctx, si, errorCode, details, 0)) == NULL)
 393         goto err;
 394
 395     res = send_receive_check(ctx, error, &PKIconf, OSSL_CMP_PKIBODY_PKICONF);
 396
 397  err:
 398     OSSL_CMP_MSG_free(error);
 399     OSSL_CMP_PKISI_free(si);
 400     OSSL_CMP_MSG_free(PKIconf);
 401     return res;
 402 }
 403
 404 /*-
 405  * Retrieve a copy of the certificate, if any, from the given CertResponse.
 406  * Take into account PKIStatusInfo of CertResponse in ctx, report it on error.
 407  * Returns NULL if not found or on error.
 408  */
 409 static X509 *get1_cert_status(OSSL_CMP_CTX *ctx, int bodytype,
 410                               OSSL_CMP_CERTRESPONSE *crep)
 411 {
 412     char buf[OSSL_CMP_PKISI_BUFLEN];
 413     X509 *crt = NULL;
 414     EVP_PKEY *privkey;
 415
 416     if (!ossl_assert(ctx != NULL && crep != NULL))
 417         return NULL;
 418
 419     privkey = OSSL_CMP_CTX_get0_newPkey(ctx, 1);
 420     switch (ossl_cmp_pkisi_get_status(crep->status)) {
 421     case OSSL_CMP_PKISTATUS_waiting:
 422         ossl_cmp_err(ctx,
 423                      "received \"waiting\" status for cert when actually aiming to extract cert");
 424         CMPerr(0, CMP_R_ENCOUNTERED_WAITING);
 425         goto err;
 426     case OSSL_CMP_PKISTATUS_grantedWithMods:
 427         ossl_cmp_warn(ctx, "received \"grantedWithMods\" for certificate");
 428         break;
 429     case OSSL_CMP_PKISTATUS_accepted:
 430         break;
 431         /* get all information in case of a rejection before going to error */
 432     case OSSL_CMP_PKISTATUS_rejection:
 433         ossl_cmp_err(ctx, "received \"rejection\" status rather than cert");
 434         CMPerr(0, CMP_R_REQUEST_REJECTED_BY_SERVER);
 435         goto err;
 436     case OSSL_CMP_PKISTATUS_revocationWarning:
 437         ossl_cmp_warn(ctx,
 438                       "received \"revocationWarning\" - a revocation of the cert is imminent");
 439         break;
 440     case OSSL_CMP_PKISTATUS_revocationNotification:
 441         ossl_cmp_warn(ctx,
 442                       "received \"revocationNotification\" - a revocation of the cert has occurred");
 443         break;
 444     case OSSL_CMP_PKISTATUS_keyUpdateWarning:
 445         if (bodytype != OSSL_CMP_PKIBODY_KUR) {
 446             CMPerr(0, CMP_R_ENCOUNTERED_KEYUPDATEWARNING);
 447             goto err;
 448         }
 449         break;
 450     default:
 451         ossl_cmp_log1(ERROR, ctx,
 452                       "received unsupported PKIStatus %d for certificate",
 453                       ctx->status);
 454         CMPerr(0, CMP_R_UNKNOWN_PKISTATUS);
 455         goto err;
 456     }
 457     crt = ossl_cmp_certresponse_get1_cert(crep, ctx, privkey);
 458     if (crt == NULL) /* according to PKIStatus, we can expect a cert */
 459         CMPerr(0, CMP_R_CERTIFICATE_NOT_FOUND);
 460
 461     return crt;
 462
 463  err:
 464     if (OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf, sizeof(buf)) != NULL)
 465         ERR_add_error_data(1, buf);
 466     return NULL;
 467 }
 468
 469 /*-
 470  * Callback fn validating that the new certificate can be verified, using
 471  * ctx->certConf_cb_arg, which has been initialized using opt_out_trusted, and
 472  * ctx->untrusted, which at this point already contains ctx->extraCertsIn.
 473  * Returns 0 on acceptance, else a bit field reflecting PKIFailureInfo.
 474  * Quoting from RFC 4210 section 5.1. Overall PKI Message:
 475  *     The extraCerts field can contain certificates that may be useful to
 476  *     the recipient.  For example, this can be used by a CA or RA to
 477  *     present an end entity with certificates that it needs to verify its
 478  *     own new certificate (if, for example, the CA that issued the end
 479  *     entity's certificate is not a root CA for the end entity).  Note that
 480  *     this field does not necessarily contain a certification path; the
 481  *     recipient may have to sort, select from, or otherwise process the
 482  *     extra certificates in order to use them.
 483  * Note: While often handy, there is no hard requirement by CMP that
 484  * an EE must be able to validate the certificates it gets enrolled.
 485  */
 486 int OSSL_CMP_certConf_cb(OSSL_CMP_CTX *ctx, X509 *cert, int fail_info,
 487                          const char **text)
 488 {
 489     X509_STORE *out_trusted = OSSL_CMP_CTX_get_certConf_cb_arg(ctx);
 490     (void)text; /* make (artificial) use of var to prevent compiler warning */
 491
 492     if (fail_info != 0) /* accept any error flagged by CMP core library */
 493         return fail_info;
 494
 495     if (out_trusted != NULL
 496             && !OSSL_CMP_validate_cert_path(ctx, out_trusted, cert))
 497         fail_info = 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData;
 498
 499     return fail_info;
 500 }
 501
 502 /*-
 503  * Perform the generic handling of certificate responses for IR/CR/KUR/P10CR.
 504  * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
 505  * Returns 1 on success and provides the received PKIMESSAGE in *resp.
 506  * Returns 0 on error (which includes the case that timeout has been reached).
 507  * Regardless of success, caller is responsible for freeing *resp (unless NULL).
 508  */
 509 static int cert_response(OSSL_CMP_CTX *ctx, int sleep, int rid,
 510                          OSSL_CMP_MSG **resp, int *checkAfter,
 511                          int req_type, int expected_type)
 512 {
 513     EVP_PKEY *rkey = OSSL_CMP_CTX_get0_newPkey(ctx /* may be NULL */, 0);
 514     int fail_info = 0; /* no failure */
 515     const char *txt = NULL;
 516     OSSL_CMP_CERTREPMESSAGE *crepmsg;
 517     OSSL_CMP_CERTRESPONSE *crep;
 518     X509 *cert;
 519     char *subj = NULL;
 520     int ret = 1;
 521
 522  retry:
 523     crepmsg = (*resp)->body->value.ip; /* same for cp and kup */
 524     if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg->response) > 1) {
 525         CMPerr(0, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED);
 526         return 0;
 527     }
 528     /* TODO: handle potentially multiple CertResponses in CertRepMsg */
 529     crep = ossl_cmp_certrepmessage_get0_certresponse(crepmsg, rid);
 530     if (crep == NULL)
 531         return 0;
 532     if (!save_statusInfo(ctx, crep->status))
 533         return 0;
 534     if (rid == -1) {
 535         /* for OSSL_CMP_PKIBODY_P10CR learn CertReqId from response */
 536         rid = ossl_cmp_asn1_get_int(crep->certReqId);
 537         if (rid == -1) {
 538             CMPerr(0, CMP_R_BAD_REQUEST_ID);
 539             return 0;
 540         }
 541     }
 542
 543     if (ossl_cmp_pkisi_get_status(crep->status) == OSSL_CMP_PKISTATUS_waiting) {
 544         OSSL_CMP_MSG_free(*resp);
 545         *resp = NULL;
 546         if ((ret = poll_for_response(ctx, sleep, rid, resp, checkAfter)) != 0) {
 547             if (ret == -1) /* at this point implies sleep == 0 */
 548                 return ret; /* waiting */
 549             goto retry; /* got ip/cp/kup, which may still indicate 'waiting' */
 550         } else {
 551             CMPerr(0, CMP_R_POLLING_FAILED);
 552             return 0;
 553         }
 554     }
 555
 556     cert = get1_cert_status(ctx, (*resp)->body->type, crep);
 557     if (cert == NULL) {
 558         ERR_add_error_data(1, "; cannot extract certificate from response");
 559         return 0;
 560     }
 561     if (!ossl_cmp_ctx_set0_newCert(ctx, cert))
 562         return 0;
 563
 564     /*
 565      * if the CMP server returned certificates in the caPubs field, copy them
 566      * to the context so that they can be retrieved if necessary
 567      */
 568     if (crepmsg->caPubs != NULL
 569             && !ossl_cmp_ctx_set1_caPubs(ctx, crepmsg->caPubs))
 570         return 0;
 571
 572     /* copy received extraCerts to ctx->extraCertsIn so they can be retrieved */
 573     if (!ossl_cmp_ctx_set1_extraCertsIn(ctx, (*resp)->extraCerts))
 574         return 0;
 575
 576     subj = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
 577     if (rkey != NULL
 578         /* X509_check_private_key() also works if rkey is just public key */
 579             && !(X509_check_private_key(ctx->newCert, rkey))) {
 580         fail_info = 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData;
 581         txt = "public key in new certificate does not match our enrollment key";
 582         /*-
 583          * not callling (void)ossl_cmp_exchange_error(ctx,
 584          *                    OSSL_CMP_PKISTATUS_rejection, fail_info, txt)
 585          * not throwing CMP_R_CERTIFICATE_NOT_ACCEPTED with txt
 586          * not returning 0
 587          * since we better leave this for any ctx->certConf_cb to decide
 588          */
 589     }
 590
 591     /*
 592      * Execute the certification checking callback function possibly set in ctx,
 593      * which can determine whether to accept a newly enrolled certificate.
 594      * It may overrule the pre-decision reflected in 'fail_info' and '*txt'.
 595      */
 596     if (ctx->certConf_cb
 597             && (fail_info = ctx->certConf_cb(ctx, ctx->newCert,
 598                                              fail_info, &txt)) != 0) {
 599         if (txt == NULL)
 600             txt = "CMP client application did not accept it";
 601     }
 602     if (fail_info != 0) /* immediately log error before any certConf exchange */
 603         ossl_cmp_log1(ERROR, ctx,
 604                       "rejecting newly enrolled cert with subject: %s", subj);
 605
 606     /*
 607      * TODO: better move certConf exchange to do_certreq_seq() such that
 608      * also more low-level errors with CertReqMessages get reported to server
 609      */
 610     if (!ctx->disableConfirm
 611             && !ossl_cmp_hdr_has_implicitConfirm((*resp)->header)) {
 612         if (!ossl_cmp_exchange_certConf(ctx, fail_info, txt))
 613             ret = 0;
 614     }
 615
 616     /* not throwing failure earlier as transfer_cb may call ERR_clear_error() */
 617     if (fail_info != 0) {
 618         CMPerr(0, CMP_R_CERTIFICATE_NOT_ACCEPTED);
 619         ERR_add_error_data(2, "rejecting newly enrolled cert with subject: ",
 620                            subj);
 621         if (txt != NULL)
 622             ERR_add_error_txt("; ", txt);
 623         ret = 0;
 624     }
 625     OPENSSL_free(subj);
 626     return ret;
 627 }
 628
 629 int OSSL_CMP_try_certreq(OSSL_CMP_CTX *ctx, int req_type,
 630                          const OSSL_CRMF_MSG *crm, int *checkAfter)
 631 {
 632     OSSL_CMP_MSG *req = NULL;
 633     OSSL_CMP_MSG *rep = NULL;
 634     int is_p10 = req_type == OSSL_CMP_PKIBODY_P10CR;
 635     int rid = is_p10 ? -1 : OSSL_CMP_CERTREQID;
 636     int rep_type = is_p10 ? OSSL_CMP_PKIBODY_CP : req_type + 1;
 637     int res = 0;
 638
 639     if (ctx == NULL) {
 640         CMPerr(0, CMP_R_NULL_ARGUMENT);
 641         return 0;
 642     }
 643
 644     if (ctx->status != OSSL_CMP_PKISTATUS_waiting) { /* not polling already */
 645         ctx->status = -1;
 646         if (!ossl_cmp_ctx_set0_newCert(ctx, NULL))
 647             return 0;
 648
 649         if (ctx->total_timeout > 0) /* else ctx->end_time is not used */
 650             ctx->end_time = time(NULL) + ctx->total_timeout;
 651
 652         req = ossl_cmp_certreq_new(ctx, req_type, crm);
 653         if (req == NULL) /* also checks if all necessary options are set */
 654             return 0;
 655
 656         if (!send_receive_check(ctx, req, &rep, rep_type))
 657             goto err;
 658     } else {
 659         if (req_type < 0)
 660             return ossl_cmp_exchange_error(ctx, OSSL_CMP_PKISTATUS_rejection,
 661                                            0 /* TODO better fail_info value? */,
 662                                            "polling aborted", 0 /* errorCode */,
 663                                            "by application");
 664         res = poll_for_response(ctx, 0 /* no sleep */, rid, &rep, checkAfter);
 665         if (res <= 0) /* waiting or error */
 666             return res;
 667     }
 668     res = cert_response(ctx, 0 /* no sleep */, rid, &rep, checkAfter,
 669                         req_type, rep_type);
 670
 671  err:
 672     OSSL_CMP_MSG_free(req);
 673     OSSL_CMP_MSG_free(rep);
 674     return res;
 675 }
 676
 677 /*-
 678  * Do the full sequence CR/IR/KUR/P10CR, CP/IP/KUP/CP,
 679  * certConf, PKIconf, and polling if required.
 680  * Will sleep as long as indicated by the server (according to checkAfter).
 681  * All enrollment options need to be present in the context.
 682  * TODO: another function to request two certificates at once should be created.
 683  * Returns pointer to received certificate, or NULL if none was received.
 684  */
 685 X509 *OSSL_CMP_exec_certreq(OSSL_CMP_CTX *ctx, int req_type,
 686                             const OSSL_CRMF_MSG *crm)
 687 {
 688
 689     OSSL_CMP_MSG *req = NULL;
 690     OSSL_CMP_MSG *rep = NULL;
 691     int is_p10 = req_type == OSSL_CMP_PKIBODY_P10CR;
 692     int rid = is_p10 ? -1 : OSSL_CMP_CERTREQID;
 693     int rep_type = is_p10 ? OSSL_CMP_PKIBODY_CP : req_type + 1;
 694     X509 *result = NULL;
 695
 696     if (ctx == NULL) {
 697         CMPerr(0, CMP_R_NULL_ARGUMENT);
 698         return NULL;
 699     }
 700     if (is_p10 && crm != NULL) {
 701         CMPerr(0, CMP_R_INVALID_ARGS);
 702         return NULL;
 703     }
 704
 705     ctx->status = -1;
 706     if (!ossl_cmp_ctx_set0_newCert(ctx, NULL))
 707         return NULL;
 708
 709     if (ctx->total_timeout > 0) /* else ctx->end_time is not used */
 710         ctx->end_time = time(NULL) + ctx->total_timeout;
 711
 712     /* OSSL_CMP_certreq_new() also checks if all necessary options are set */
 713     if ((req = ossl_cmp_certreq_new(ctx, req_type, crm)) == NULL)
 714         goto err;
 715
 716     if (!send_receive_check(ctx, req, &rep, rep_type))
 717         goto err;
 718
 719     if (cert_response(ctx, 1 /* sleep */, rid, &rep, NULL, req_type, rep_type)
 720         <= 0)
 721         goto err;
 722
 723     result = ctx->newCert;
 724  err:
 725     OSSL_CMP_MSG_free(req);
 726     OSSL_CMP_MSG_free(rep);
 727     return result;
 728 }
 729
 730 X509 *OSSL_CMP_exec_RR_ses(OSSL_CMP_CTX *ctx)
 731 {
 732     OSSL_CMP_MSG *rr = NULL;
 733     OSSL_CMP_MSG *rp = NULL;
 734     const int num_RevDetails = 1;
 735     const int rsid = OSSL_CMP_REVREQSID;
 736     OSSL_CMP_REVREPCONTENT *rrep = NULL;
 737     OSSL_CMP_PKISI *si = NULL;
 738     char buf[OSSL_CMP_PKISI_BUFLEN];
 739     X509 *result = NULL;
 740
 741     if (ctx == NULL) {
 742         CMPerr(0, CMP_R_INVALID_ARGS);
 743         return 0;
 744     }
 745     if (ctx->oldCert == NULL) {
 746         CMPerr(0, CMP_R_MISSING_REFERENCE_CERT);
 747         return 0;
 748     }
 749     ctx->status = -1;
 750
 751     /* OSSL_CMP_rr_new() also checks if all necessary options are set */
 752     if ((rr = ossl_cmp_rr_new(ctx)) == NULL)
 753         goto end;
 754
 755     if (!send_receive_check(ctx, rr, &rp, OSSL_CMP_PKIBODY_RP))
 756         goto end;
 757
 758     rrep = rp->body->value.rp;
 759 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 760     if (sk_OSSL_CMP_PKISI_num(rrep->status) != num_RevDetails) {
 761         CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
 762         goto end;
 763     }
 764 #else
 765     if (sk_OSSL_CMP_PKISI_num(rrep->status) < 1) {
 766         CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
 767         goto end;
 768     }
 769 #endif
 770
 771     /* evaluate PKIStatus field */
 772     si = ossl_cmp_revrepcontent_get_pkisi(rrep, rsid);
 773     if (!save_statusInfo(ctx, si))
 774         goto err;
 775     switch (ossl_cmp_pkisi_get_status(si)) {
 776     case OSSL_CMP_PKISTATUS_accepted:
 777         ossl_cmp_info(ctx, "revocation accepted (PKIStatus=accepted)");
 778         result = ctx->oldCert;
 779         break;
 780     case OSSL_CMP_PKISTATUS_grantedWithMods:
 781         ossl_cmp_info(ctx, "revocation accepted (PKIStatus=grantedWithMods)");
 782         result = ctx->oldCert;
 783         break;
 784     case OSSL_CMP_PKISTATUS_rejection:
 785         CMPerr(0, CMP_R_REQUEST_REJECTED_BY_SERVER);
 786         goto err;
 787     case OSSL_CMP_PKISTATUS_revocationWarning:
 788         ossl_cmp_info(ctx, "revocation accepted (PKIStatus=revocationWarning)");
 789         result = ctx->oldCert;
 790         break;
 791     case OSSL_CMP_PKISTATUS_revocationNotification:
 792         /* interpretation as warning or error depends on CA */
 793         ossl_cmp_warn(ctx,
 794                       "revocation accepted (PKIStatus=revocationNotification)");
 795         result = ctx->oldCert;
 796         break;
 797     case OSSL_CMP_PKISTATUS_waiting:
 798     case OSSL_CMP_PKISTATUS_keyUpdateWarning:
 799         CMPerr(0, CMP_R_UNEXPECTED_PKISTATUS);
 800         goto err;
 801     default:
 802         CMPerr(0, CMP_R_UNKNOWN_PKISTATUS);
 803         goto err;
 804     }
 805
 806     /* check any present CertId in optional revCerts field */
 807     if (rrep->revCerts != NULL) {
 808         OSSL_CRMF_CERTID *cid;
 809         OSSL_CRMF_CERTTEMPLATE *tmpl =
 810             sk_OSSL_CMP_REVDETAILS_value(rr->body->value.rr, rsid)->certDetails;
 811         const X509_NAME *issuer = OSSL_CRMF_CERTTEMPLATE_get0_issuer(tmpl);
 812         ASN1_INTEGER *serial = OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(tmpl);
 813
 814         if (sk_OSSL_CRMF_CERTID_num(rrep->revCerts) != num_RevDetails) {
 815             CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
 816             result = NULL;
 817             goto err;
 818         }
 819         if ((cid = ossl_cmp_revrepcontent_get_CertId(rrep, rsid)) == NULL) {
 820             result = NULL;
 821             goto err;
 822         }
 823         if (X509_NAME_cmp(issuer, OSSL_CRMF_CERTID_get0_issuer(cid)) != 0) {
 824 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 825             CMPerr(0, CMP_R_WRONG_CERTID_IN_RP);
 826             result = NULL;
 827             goto err;
 828 #endif
 829         }
 830         if (ASN1_INTEGER_cmp(serial,
 831                              OSSL_CRMF_CERTID_get0_serialNumber(cid)) != 0) {
 832 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 833             CMPerr(0, CMP_R_WRONG_SERIAL_IN_RP);
 834             result = NULL;
 835             goto err;
 836 #endif
 837         }
 838     }
 839
 840     /* check number of any optionally present crls */
 841     if (rrep->crls != NULL && sk_X509_CRL_num(rrep->crls) != num_RevDetails) {
 842         CMPerr(0, CMP_R_WRONG_RP_COMPONENT_COUNT);
 843         result = NULL;
 844         goto err;
 845     }
 846
 847  err:
 848     if (result == NULL
 849             && OSSL_CMP_CTX_snprint_PKIStatus(ctx, buf, sizeof(buf)) != NULL)
 850         ERR_add_error_data(1, buf);
 851
 852  end:
 853     OSSL_CMP_MSG_free(rr);
 854     OSSL_CMP_MSG_free(rp);
 855     return result;
 856 }
 857
 858 STACK_OF(OSSL_CMP_ITAV) *OSSL_CMP_exec_GENM_ses(OSSL_CMP_CTX *ctx)
 859 {
 860     OSSL_CMP_MSG *genm;
 861     OSSL_CMP_MSG *genp = NULL;
 862     STACK_OF(OSSL_CMP_ITAV) *rcvd_itavs = NULL;
 863
 864     if (ctx == NULL) {
 865         CMPerr(0, CMP_R_INVALID_ARGS);
 866         return 0;
 867     }
 868
 869     if ((genm = ossl_cmp_genm_new(ctx)) == NULL)
 870         goto err;
 871
 872     if (!send_receive_check(ctx, genm, &genp, OSSL_CMP_PKIBODY_GENP))
 873         goto err;
 874
 875     /* received stack of itavs not to be freed with the genp */
 876     rcvd_itavs = genp->body->value.genp;
 877     genp->body->value.genp = NULL;
 878
 879  err:
 880     OSSL_CMP_MSG_free(genm);
 881     OSSL_CMP_MSG_free(genp);
 882
 883     return rcvd_itavs; /* recv_itavs == NULL indicates an error */
 884 }