crypto/cmp/cmp_msg.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 /* CMP functions for PKIMessage construction */
  13
  14 #include "cmp_local.h"
  15
  16 /* explicit #includes not strictly needed since implied by the above: */
  17 #include <openssl/asn1t.h>
  18 #include <openssl/cmp.h>
  19 #include <openssl/crmf.h>
  20 #include <openssl/err.h>
  21 #include <openssl/x509.h>
  22
  23 DEFINE_STACK_OF(OSSL_CMP_CERTSTATUS)
  24 DEFINE_STACK_OF(OSSL_CMP_ITAV)
  25 DEFINE_STACK_OF(GENERAL_NAME)
  26 DEFINE_STACK_OF(X509)
  27 DEFINE_STACK_OF(X509_EXTENSION)
  28 DEFINE_STACK_OF(OSSL_CMP_PKISI)
  29 DEFINE_STACK_OF(OSSL_CRMF_MSG)
  30 DEFINE_STACK_OF(OSSL_CMP_CERTRESPONSE)
  31 DEFINE_STACK_OF(OSSL_CRMF_CERTID)
  32 DEFINE_STACK_OF(ASN1_UTF8STRING)
  33
  34 OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg)
  35 {
  36     if (msg == NULL) {
  37         CMPerr(0, CMP_R_NULL_ARGUMENT);
  38         return NULL;
  39     }
  40     return msg->header;
  41 }
  42
  43 const char *ossl_cmp_bodytype_to_string(int type)
  44 {
  45     static const char *type_names[] = {
  46         "IR", "IP", "CR", "CP", "P10CR",
  47         "POPDECC", "POPDECR", "KUR", "KUP",
  48         "KRR", "KRP", "RR", "RP", "CCR", "CCP",
  49         "CKUANN", "CANN", "RANN", "CRLANN", "PKICONF", "NESTED",
  50         "GENM", "GENP", "ERROR", "CERTCONF", "POLLREQ", "POLLREP",
  51     };
  52
  53     if (type < 0 || type > OSSL_CMP_PKIBODY_TYPE_MAX)
  54         return "illegal body type";
  55     return type_names[type];
  56 }
  57
  58 int ossl_cmp_msg_set_bodytype(OSSL_CMP_MSG *msg, int type)
  59 {
  60     if (!ossl_assert(msg != NULL && msg->body != NULL))
  61         return 0;
  62
  63     msg->body->type = type;
  64     return 1;
  65 }
  66
  67 int ossl_cmp_msg_get_bodytype(const OSSL_CMP_MSG *msg)
  68 {
  69     if (!ossl_assert(msg != NULL && msg->body != NULL))
  70         return -1;
  71
  72     return msg->body->type;
  73 }
  74
  75 /* Add an extension to the referenced extension stack, which may be NULL */
  76 static int add1_extension(X509_EXTENSIONS **pexts, int nid, int crit, void *ex)
  77 {
  78     X509_EXTENSION *ext;
  79     int res;
  80
  81     if (!ossl_assert(pexts != NULL)) /* pointer to var must not be NULL */
  82         return 0;
  83
  84     if ((ext = X509V3_EXT_i2d(nid, crit, ex)) == NULL)
  85         return 0;
  86
  87     res = X509v3_add_ext(pexts, ext, 0) != NULL;
  88     X509_EXTENSION_free(ext);
  89     return res;
  90 }
  91
  92 /* Add a CRL revocation reason code to extension stack, which may be NULL */
  93 static int add_crl_reason_extension(X509_EXTENSIONS **pexts, int reason_code)
  94 {
  95     ASN1_ENUMERATED *val = ASN1_ENUMERATED_new();
  96     int res = 0;
  97
  98     if (val != NULL && ASN1_ENUMERATED_set(val, reason_code))
  99         res = add1_extension(pexts, NID_crl_reason, 0 /* non-critical */, val);
 100     ASN1_ENUMERATED_free(val);
 101     return res;
 102 }
 103
 104 OSSL_CMP_MSG *ossl_cmp_msg_create(OSSL_CMP_CTX *ctx, int bodytype)
 105 {
 106     OSSL_CMP_MSG *msg = NULL;
 107
 108     if (!ossl_assert(ctx != NULL))
 109         return NULL;
 110
 111     if ((msg = OSSL_CMP_MSG_new()) == NULL)
 112         return NULL;
 113     if (!ossl_cmp_hdr_init(ctx, msg->header)
 114             || !ossl_cmp_msg_set_bodytype(msg, bodytype))
 115         goto err;
 116     if (ctx->geninfo_ITAVs != NULL
 117             && !ossl_cmp_hdr_generalInfo_push1_items(msg->header,
 118                                                      ctx->geninfo_ITAVs))
 119         goto err;
 120
 121     switch (bodytype) {
 122     case OSSL_CMP_PKIBODY_IR:
 123     case OSSL_CMP_PKIBODY_CR:
 124     case OSSL_CMP_PKIBODY_KUR:
 125         if ((msg->body->value.ir = OSSL_CRMF_MSGS_new()) == NULL)
 126             goto err;
 127         return msg;
 128
 129     case OSSL_CMP_PKIBODY_P10CR:
 130         if (ctx->p10CSR == NULL) {
 131             CMPerr(0, CMP_R_MISSING_P10CSR);
 132             goto err;
 133         }
 134         if ((msg->body->value.p10cr = X509_REQ_dup(ctx->p10CSR)) == NULL)
 135             goto err;
 136         return msg;
 137
 138     case OSSL_CMP_PKIBODY_IP:
 139     case OSSL_CMP_PKIBODY_CP:
 140     case OSSL_CMP_PKIBODY_KUP:
 141         if ((msg->body->value.ip = OSSL_CMP_CERTREPMESSAGE_new()) == NULL)
 142             goto err;
 143         return msg;
 144
 145     case OSSL_CMP_PKIBODY_RR:
 146         if ((msg->body->value.rr = sk_OSSL_CMP_REVDETAILS_new_null()) == NULL)
 147             goto err;
 148         return msg;
 149     case OSSL_CMP_PKIBODY_RP:
 150         if ((msg->body->value.rp = OSSL_CMP_REVREPCONTENT_new()) == NULL)
 151             goto err;
 152         return msg;
 153
 154     case OSSL_CMP_PKIBODY_CERTCONF:
 155         if ((msg->body->value.certConf =
 156              sk_OSSL_CMP_CERTSTATUS_new_null()) == NULL)
 157             goto err;
 158         return msg;
 159     case OSSL_CMP_PKIBODY_PKICONF:
 160         if ((msg->body->value.pkiconf = ASN1_TYPE_new()) == NULL)
 161             goto err;
 162         ASN1_TYPE_set(msg->body->value.pkiconf, V_ASN1_NULL, NULL);
 163         return msg;
 164
 165     case OSSL_CMP_PKIBODY_POLLREQ:
 166         if ((msg->body->value.pollReq = sk_OSSL_CMP_POLLREQ_new_null()) == NULL)
 167             goto err;
 168         return msg;
 169     case OSSL_CMP_PKIBODY_POLLREP:
 170         if ((msg->body->value.pollRep = sk_OSSL_CMP_POLLREP_new_null()) == NULL)
 171             goto err;
 172         return msg;
 173
 174     case OSSL_CMP_PKIBODY_GENM:
 175     case OSSL_CMP_PKIBODY_GENP:
 176         if ((msg->body->value.genm = sk_OSSL_CMP_ITAV_new_null()) == NULL)
 177             goto err;
 178         return msg;
 179
 180     case OSSL_CMP_PKIBODY_ERROR:
 181         if ((msg->body->value.error = OSSL_CMP_ERRORMSGCONTENT_new()) == NULL)
 182             goto err;
 183         return msg;
 184
 185     default:
 186         CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
 187         goto err;
 188     }
 189
 190  err:
 191     OSSL_CMP_MSG_free(msg);
 192     return NULL;
 193 }
 194
 195 #define HAS_SAN(ctx) \
 196     (sk_GENERAL_NAME_num((ctx)->subjectAltNames) > 0 \
 197          || OSSL_CMP_CTX_reqExtensions_have_SAN(ctx) == 1)
 198
 199 static const X509_NAME *determine_subj(OSSL_CMP_CTX *ctx, X509 *refcert,
 200                                        int for_KUR)
 201 {
 202     if (ctx->subjectName != NULL)
 203         return ctx->subjectName;
 204
 205     if (refcert != NULL && (for_KUR || !HAS_SAN(ctx)))
 206         /*
 207          * For KUR, copy subjectName from reference certificate.
 208          * For IR or CR, do the same only if there is no subjectAltName.
 209          */
 210         return X509_get_subject_name(refcert);
 211     return NULL;
 212 }
 213
 214 OSSL_CRMF_MSG *OSSL_CMP_CTX_setup_CRM(OSSL_CMP_CTX *ctx, int for_KUR, int rid)
 215 {
 216     OSSL_CRMF_MSG *crm = NULL;
 217     X509 *refcert = ctx->oldCert != NULL ? ctx->oldCert : ctx->cert;
 218     /* refcert defaults to current client cert */
 219     EVP_PKEY *rkey = OSSL_CMP_CTX_get0_newPkey(ctx, 0);
 220     STACK_OF(GENERAL_NAME) *default_sans = NULL;
 221     const X509_NAME *subject = determine_subj(ctx, refcert, for_KUR);
 222     int crit = ctx->setSubjectAltNameCritical || subject == NULL;
 223     /* RFC5280: subjectAltName MUST be critical if subject is null */
 224     X509_EXTENSIONS *exts = NULL;
 225
 226     if (rkey == NULL)
 227         rkey = ctx->pkey; /* default is independent of ctx->oldCert */
 228     if (rkey == NULL) {
 229 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 230         CMPerr(0, CMP_R_NULL_ARGUMENT);
 231         return NULL;
 232 #endif
 233     }
 234     if (for_KUR && refcert == NULL) {
 235         CMPerr(0, CMP_R_MISSING_REFERENCE_CERT);
 236         return NULL;
 237     }
 238     if ((crm = OSSL_CRMF_MSG_new()) == NULL)
 239         return NULL;
 240     if (!OSSL_CRMF_MSG_set_certReqId(crm, rid)
 241             /*
 242              * fill certTemplate, corresponding to CertificationRequestInfo
 243              * of PKCS#10. The rkey param cannot be NULL so far -
 244              * it could be NULL if centralized key creation was supported
 245              */
 246             || !OSSL_CRMF_CERTTEMPLATE_fill(OSSL_CRMF_MSG_get0_tmpl(crm), rkey,
 247                                             subject, ctx->issuer,
 248                                             NULL /* serial */))
 249         goto err;
 250     if (ctx->days != 0) {
 251         time_t now = time(NULL);
 252         ASN1_TIME *notBefore = ASN1_TIME_adj(NULL, now, 0, 0);
 253         ASN1_TIME *notAfter = ASN1_TIME_adj(NULL, now, ctx->days, 0);
 254
 255         if (notBefore == NULL
 256                 || notAfter == NULL
 257                 || !OSSL_CRMF_MSG_set0_validity(crm, notBefore, notAfter)) {
 258             ASN1_TIME_free(notBefore);
 259             ASN1_TIME_free(notAfter);
 260             goto err;
 261         }
 262     }
 263
 264     /* extensions */
 265     if (refcert != NULL && !ctx->SubjectAltName_nodefault)
 266         default_sans = X509V3_get_d2i(X509_get0_extensions(refcert),
 267                                       NID_subject_alt_name, NULL, NULL);
 268     /* exts are copied from ctx to allow reuse */
 269     if (ctx->reqExtensions != NULL) {
 270         exts = sk_X509_EXTENSION_deep_copy(ctx->reqExtensions,
 271                                            X509_EXTENSION_dup,
 272                                            X509_EXTENSION_free);
 273         if (exts == NULL)
 274             goto err;
 275     }
 276     if (sk_GENERAL_NAME_num(ctx->subjectAltNames) > 0
 277             && !add1_extension(&exts, NID_subject_alt_name,
 278                                crit, ctx->subjectAltNames))
 279         goto err;
 280     if (!HAS_SAN(ctx) && default_sans != NULL
 281             && !add1_extension(&exts, NID_subject_alt_name, crit, default_sans))
 282         goto err;
 283     if (ctx->policies != NULL
 284             && !add1_extension(&exts, NID_certificate_policies,
 285                                ctx->setPoliciesCritical, ctx->policies))
 286         goto err;
 287     if (!OSSL_CRMF_MSG_set0_extensions(crm, exts))
 288         goto err;
 289     exts = NULL;
 290     /* end fill certTemplate, now set any controls */
 291
 292     /* for KUR, set OldCertId according to D.6 */
 293     if (for_KUR) {
 294         OSSL_CRMF_CERTID *cid =
 295             OSSL_CRMF_CERTID_gen(X509_get_issuer_name(refcert),
 296                                  X509_get0_serialNumber(refcert));
 297         int ret;
 298
 299         if (cid == NULL)
 300             goto err;
 301         ret = OSSL_CRMF_MSG_set1_regCtrl_oldCertID(crm, cid);
 302         OSSL_CRMF_CERTID_free(cid);
 303         if (ret == 0)
 304             goto err;
 305     }
 306
 307     goto end;
 308
 309  err:
 310     OSSL_CRMF_MSG_free(crm);
 311     crm = NULL;
 312
 313  end:
 314     sk_X509_EXTENSION_pop_free(exts, X509_EXTENSION_free);
 315     sk_GENERAL_NAME_pop_free(default_sans, GENERAL_NAME_free);
 316     return crm;
 317 }
 318
 319 OSSL_CMP_MSG *ossl_cmp_certreq_new(OSSL_CMP_CTX *ctx, int type,
 320                                    const OSSL_CRMF_MSG *crm)
 321 {
 322     OSSL_CMP_MSG *msg;
 323     OSSL_CRMF_MSG *local_crm = NULL;
 324
 325     if (!ossl_assert(ctx != NULL))
 326         return NULL;
 327
 328     if (type != OSSL_CMP_PKIBODY_IR && type != OSSL_CMP_PKIBODY_CR
 329             && type != OSSL_CMP_PKIBODY_KUR && type != OSSL_CMP_PKIBODY_P10CR) {
 330         CMPerr(0, CMP_R_INVALID_ARGS);
 331         return NULL;
 332     }
 333
 334     if ((msg = ossl_cmp_msg_create(ctx, type)) == NULL)
 335         goto err;
 336
 337     /* header */
 338     if (ctx->implicitConfirm && !ossl_cmp_hdr_set_implicitConfirm(msg->header))
 339         goto err;
 340
 341     /* body */
 342     /* For P10CR the content has already been set in OSSL_CMP_MSG_create */
 343     if (type != OSSL_CMP_PKIBODY_P10CR) {
 344         EVP_PKEY *privkey = OSSL_CMP_CTX_get0_newPkey(ctx, 1);
 345
 346         if (privkey == NULL)
 347             privkey = ctx->pkey; /* default is independent of ctx->oldCert */
 348         if (ctx->popoMethod == OSSL_CRMF_POPO_SIGNATURE && privkey == NULL) {
 349             CMPerr(0, CMP_R_MISSING_PRIVATE_KEY);
 350             goto err;
 351         }
 352         if (crm == NULL) {
 353             local_crm = OSSL_CMP_CTX_setup_CRM(ctx,
 354                                                type == OSSL_CMP_PKIBODY_KUR,
 355                                                OSSL_CMP_CERTREQID);
 356             if (local_crm == NULL
 357                 || !OSSL_CRMF_MSG_create_popo(local_crm, privkey, ctx->digest,
 358                                               ctx->popoMethod))
 359                 goto err;
 360         } else {
 361             if ((local_crm = OSSL_CRMF_MSG_dup(crm)) == NULL)
 362                 goto err;
 363         }
 364
 365         /* value.ir is same for cr and kur */
 366         if (!sk_OSSL_CRMF_MSG_push(msg->body->value.ir, local_crm))
 367             goto err;
 368         local_crm = NULL;
 369         /* TODO: here optional 2nd certreqmsg could be pushed to the stack */
 370     }
 371
 372     if (!ossl_cmp_msg_protect(ctx, msg))
 373         goto err;
 374
 375     return msg;
 376
 377  err:
 378     CMPerr(0, CMP_R_ERROR_CREATING_CERTREQ);
 379     OSSL_CRMF_MSG_free(local_crm);
 380     OSSL_CMP_MSG_free(msg);
 381     return NULL;
 382 }
 383
 384 OSSL_CMP_MSG *ossl_cmp_certrep_new(OSSL_CMP_CTX *ctx, int bodytype,
 385                                    int certReqId, OSSL_CMP_PKISI *si,
 386                                    X509 *cert, STACK_OF(X509) *chain,
 387                                    STACK_OF(X509) *caPubs, int encrypted,
 388                                    int unprotectedErrors)
 389 {
 390     OSSL_CMP_MSG *msg = NULL;
 391     OSSL_CMP_CERTREPMESSAGE *repMsg = NULL;
 392     OSSL_CMP_CERTRESPONSE *resp = NULL;
 393     int status = -1;
 394
 395     if (!ossl_assert(ctx != NULL && si != NULL))
 396         return NULL;
 397
 398     if ((msg = ossl_cmp_msg_create(ctx, bodytype)) == NULL)
 399         goto err;
 400     repMsg = msg->body->value.ip; /* value.ip is same for cp and kup */
 401
 402     /* header */
 403     if (ctx->implicitConfirm && !ossl_cmp_hdr_set_implicitConfirm(msg->header))
 404         goto err;
 405
 406     /* body */
 407     if ((resp = OSSL_CMP_CERTRESPONSE_new()) == NULL)
 408         goto err;
 409     OSSL_CMP_PKISI_free(resp->status);
 410     if ((resp->status = OSSL_CMP_PKISI_dup(si)) == NULL
 411             || !ASN1_INTEGER_set(resp->certReqId, certReqId))
 412         goto err;
 413
 414     status = ossl_cmp_pkisi_get_status(resp->status);
 415     if (status != OSSL_CMP_PKISTATUS_rejection
 416             && status != OSSL_CMP_PKISTATUS_waiting && cert != NULL) {
 417         if (encrypted) {
 418             CMPerr(0, CMP_R_INVALID_ARGS);
 419             goto err;
 420         }
 421
 422         if ((resp->certifiedKeyPair = OSSL_CMP_CERTIFIEDKEYPAIR_new())
 423             == NULL)
 424             goto err;
 425         resp->certifiedKeyPair->certOrEncCert->type =
 426             OSSL_CMP_CERTORENCCERT_CERTIFICATE;
 427         if (!X509_up_ref(cert))
 428             goto err;
 429         resp->certifiedKeyPair->certOrEncCert->value.certificate = cert;
 430     }
 431
 432     if (!sk_OSSL_CMP_CERTRESPONSE_push(repMsg->response, resp))
 433         goto err;
 434     resp = NULL;
 435     /* TODO: here optional 2nd certrep could be pushed to the stack */
 436
 437     if (bodytype == OSSL_CMP_PKIBODY_IP && caPubs != NULL
 438             && (repMsg->caPubs = X509_chain_up_ref(caPubs)) == NULL)
 439         goto err;
 440     if (sk_X509_num(chain) > 0) {
 441         msg->extraCerts = sk_X509_new_reserve(NULL, sk_X509_num(chain));
 442         if (msg->extraCerts == NULL
 443                 || !X509_add_certs(msg->extraCerts, chain,
 444                                    X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP))
 445         goto err;
 446     }
 447
 448     if (!unprotectedErrors
 449             || ossl_cmp_pkisi_get_status(si) != OSSL_CMP_PKISTATUS_rejection)
 450         if (!ossl_cmp_msg_protect(ctx, msg))
 451             goto err;
 452
 453     return msg;
 454
 455  err:
 456     CMPerr(0, CMP_R_ERROR_CREATING_CERTREP);
 457     OSSL_CMP_CERTRESPONSE_free(resp);
 458     OSSL_CMP_MSG_free(msg);
 459     return NULL;
 460 }
 461
 462 OSSL_CMP_MSG *ossl_cmp_rr_new(OSSL_CMP_CTX *ctx)
 463 {
 464     OSSL_CMP_MSG *msg = NULL;
 465     OSSL_CMP_REVDETAILS *rd;
 466
 467     if (!ossl_assert(ctx != NULL && ctx->oldCert != NULL))
 468         return NULL;
 469
 470     if ((rd = OSSL_CMP_REVDETAILS_new()) == NULL)
 471         goto err;
 472
 473     /* Fill the template from the contents of the certificate to be revoked */
 474     if (!OSSL_CRMF_CERTTEMPLATE_fill(rd->certDetails,
 475                                      NULL /* pubkey would be redundant */,
 476                                      NULL /* subject would be redundant */,
 477                                      X509_get_issuer_name(ctx->oldCert),
 478                                      X509_get0_serialNumber(ctx->oldCert)))
 479         goto err;
 480
 481     /* revocation reason code is optional */
 482     if (ctx->revocationReason != CRL_REASON_NONE
 483             && !add_crl_reason_extension(&rd->crlEntryDetails,
 484                                          ctx->revocationReason))
 485         goto err;
 486
 487     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_RR)) == NULL)
 488         goto err;
 489
 490     if (!sk_OSSL_CMP_REVDETAILS_push(msg->body->value.rr, rd))
 491         goto err;
 492     rd = NULL;
 493
 494     /*
 495      * TODO: the Revocation Passphrase according to section 5.3.19.9 could be
 496      *       set here if set in ctx
 497      */
 498
 499     if (!ossl_cmp_msg_protect(ctx, msg))
 500         goto err;
 501
 502     return msg;
 503
 504  err:
 505     CMPerr(0, CMP_R_ERROR_CREATING_RR);
 506     OSSL_CMP_MSG_free(msg);
 507     OSSL_CMP_REVDETAILS_free(rd);
 508     return NULL;
 509 }
 510
 511 OSSL_CMP_MSG *ossl_cmp_rp_new(OSSL_CMP_CTX *ctx, OSSL_CMP_PKISI *si,
 512                               OSSL_CRMF_CERTID *cid, int unprot_err)
 513 {
 514     OSSL_CMP_REVREPCONTENT *rep = NULL;
 515     OSSL_CMP_PKISI *si1 = NULL;
 516     OSSL_CRMF_CERTID *cid_copy = NULL;
 517     OSSL_CMP_MSG *msg = NULL;
 518
 519     if (!ossl_assert(ctx != NULL && si != NULL && cid != NULL))
 520         return NULL;
 521
 522     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_RP)) == NULL)
 523         goto err;
 524     rep = msg->body->value.rp;
 525
 526     if ((si1 = OSSL_CMP_PKISI_dup(si)) == NULL)
 527         goto err;
 528
 529     if (!sk_OSSL_CMP_PKISI_push(rep->status, si1)) {
 530         OSSL_CMP_PKISI_free(si1);
 531         goto err;
 532     }
 533
 534     if ((rep->revCerts = sk_OSSL_CRMF_CERTID_new_null()) == NULL)
 535         goto err;
 536     if ((cid_copy = OSSL_CRMF_CERTID_dup(cid)) == NULL)
 537         goto err;
 538     if (!sk_OSSL_CRMF_CERTID_push(rep->revCerts, cid_copy)) {
 539         OSSL_CRMF_CERTID_free(cid_copy);
 540         goto err;
 541     }
 542
 543     if (!unprot_err
 544             || ossl_cmp_pkisi_get_status(si) != OSSL_CMP_PKISTATUS_rejection)
 545         if (!ossl_cmp_msg_protect(ctx, msg))
 546             goto err;
 547
 548     return msg;
 549
 550  err:
 551     CMPerr(0, CMP_R_ERROR_CREATING_RP);
 552     OSSL_CMP_MSG_free(msg);
 553     return NULL;
 554 }
 555
 556 OSSL_CMP_MSG *ossl_cmp_pkiconf_new(OSSL_CMP_CTX *ctx)
 557 {
 558     OSSL_CMP_MSG *msg;
 559
 560     if (!ossl_assert(ctx != NULL))
 561         return NULL;
 562
 563     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_PKICONF)) == NULL)
 564         goto err;
 565     if (ossl_cmp_msg_protect(ctx, msg))
 566         return msg;
 567
 568  err:
 569     CMPerr(0, CMP_R_ERROR_CREATING_PKICONF);
 570     OSSL_CMP_MSG_free(msg);
 571     return NULL;
 572 }
 573
 574 int ossl_cmp_msg_gen_push0_ITAV(OSSL_CMP_MSG *msg, OSSL_CMP_ITAV *itav)
 575 {
 576     int bodytype;
 577
 578     if (!ossl_assert(msg != NULL && itav != NULL))
 579         return 0;
 580
 581     bodytype = ossl_cmp_msg_get_bodytype(msg);
 582     if (bodytype != OSSL_CMP_PKIBODY_GENM
 583             && bodytype != OSSL_CMP_PKIBODY_GENP) {
 584         CMPerr(0, CMP_R_INVALID_ARGS);
 585         return 0;
 586     }
 587
 588     /* value.genp has the same structure, so this works for genp as well */
 589     return OSSL_CMP_ITAV_push0_stack_item(&msg->body->value.genm, itav);
 590 }
 591
 592 int ossl_cmp_msg_gen_push1_ITAVs(OSSL_CMP_MSG *msg,
 593                                  const STACK_OF(OSSL_CMP_ITAV) *itavs)
 594 {
 595     int i;
 596     OSSL_CMP_ITAV *itav = NULL;
 597
 598     if (!ossl_assert(msg != NULL))
 599         return 0;
 600
 601     for (i = 0; i < sk_OSSL_CMP_ITAV_num(itavs); i++) {
 602         itav = OSSL_CMP_ITAV_dup(sk_OSSL_CMP_ITAV_value(itavs, i));
 603         if (itav == NULL
 604                 || !ossl_cmp_msg_gen_push0_ITAV(msg, itav)) {
 605             OSSL_CMP_ITAV_free(itav);
 606             return 0;
 607         }
 608     }
 609     return 1;
 610 }
 611
 612 /*
 613  * Creates a new General Message/Response with an empty itav stack
 614  * returns a pointer to the PKIMessage on success, NULL on error
 615  */
 616 static OSSL_CMP_MSG *gen_new(OSSL_CMP_CTX *ctx,
 617                              const STACK_OF(OSSL_CMP_ITAV) *itavs,
 618                              int body_type, int err_code)
 619 {
 620     OSSL_CMP_MSG *msg = NULL;
 621
 622     if (!ossl_assert(ctx != NULL))
 623         return NULL;
 624
 625     if ((msg = ossl_cmp_msg_create(ctx, body_type)) == NULL)
 626         return NULL;
 627
 628     if (ctx->genm_ITAVs != NULL
 629             && !ossl_cmp_msg_gen_push1_ITAVs(msg, itavs))
 630         goto err;
 631
 632     if (!ossl_cmp_msg_protect(ctx, msg))
 633         goto err;
 634
 635     return msg;
 636
 637  err:
 638     CMPerr(0, err_code);
 639     OSSL_CMP_MSG_free(msg);
 640     return NULL;
 641 }
 642
 643 OSSL_CMP_MSG *ossl_cmp_genm_new(OSSL_CMP_CTX *ctx)
 644 {
 645     return gen_new(ctx, ctx->genm_ITAVs,
 646                    OSSL_CMP_PKIBODY_GENM, CMP_R_ERROR_CREATING_GENM);
 647 }
 648
 649 OSSL_CMP_MSG *ossl_cmp_genp_new(OSSL_CMP_CTX *ctx,
 650                                 const STACK_OF(OSSL_CMP_ITAV) *itavs)
 651 {
 652     return gen_new(ctx, itavs,
 653                    OSSL_CMP_PKIBODY_GENP, CMP_R_ERROR_CREATING_GENP);
 654 }
 655
 656 OSSL_CMP_MSG *ossl_cmp_error_new(OSSL_CMP_CTX *ctx, OSSL_CMP_PKISI *si,
 657                                  int errorCode,
 658                                  const char *details, int unprotected)
 659 {
 660     OSSL_CMP_MSG *msg = NULL;
 661     OSSL_CMP_PKIFREETEXT *ft;
 662
 663     if (!ossl_assert(ctx != NULL && si != NULL))
 664         return NULL;
 665
 666     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_ERROR)) == NULL)
 667         goto err;
 668
 669     OSSL_CMP_PKISI_free(msg->body->value.error->pKIStatusInfo);
 670     if ((msg->body->value.error->pKIStatusInfo = OSSL_CMP_PKISI_dup(si))
 671         == NULL)
 672         goto err;
 673     if (errorCode >= 0) {
 674         if ((msg->body->value.error->errorCode = ASN1_INTEGER_new()) == NULL)
 675             goto err;
 676         if (!ASN1_INTEGER_set(msg->body->value.error->errorCode, errorCode))
 677             goto err;
 678     }
 679     if (details != NULL) {
 680         if ((ft = sk_ASN1_UTF8STRING_new_null()) == NULL)
 681             goto err;
 682         msg->body->value.error->errorDetails = ft;
 683         if (!ossl_cmp_sk_ASN1_UTF8STRING_push_str(ft, details))
 684             goto err;
 685     }
 686
 687     if (!unprotected && !ossl_cmp_msg_protect(ctx, msg))
 688         goto err;
 689     return msg;
 690
 691  err:
 692     CMPerr(0, CMP_R_ERROR_CREATING_ERROR);
 693     OSSL_CMP_MSG_free(msg);
 694     return NULL;
 695 }
 696
 697 /*
 698  * Set the certHash field of a OSSL_CMP_CERTSTATUS structure.
 699  * This is used in the certConf message, for example,
 700  * to confirm that the certificate was received successfully.
 701  */
 702 int ossl_cmp_certstatus_set0_certHash(OSSL_CMP_CERTSTATUS *certStatus,
 703                                       ASN1_OCTET_STRING *hash)
 704 {
 705     if (!ossl_assert(certStatus != NULL))
 706         return 0;
 707     ASN1_OCTET_STRING_free(certStatus->certHash);
 708     certStatus->certHash = hash;
 709     return 1;
 710 }
 711
 712 /*
 713  * TODO: handle potential 2nd certificate when signing and encrypting
 714  * certificates have been requested/received
 715  */
 716 OSSL_CMP_MSG *ossl_cmp_certConf_new(OSSL_CMP_CTX *ctx, int fail_info,
 717                                     const char *text)
 718 {
 719     OSSL_CMP_MSG *msg = NULL;
 720     OSSL_CMP_CERTSTATUS *certStatus = NULL;
 721     ASN1_OCTET_STRING *certHash = NULL;
 722     OSSL_CMP_PKISI *sinfo;
 723
 724     if (!ossl_assert(ctx != NULL && ctx->newCert != NULL))
 725         return NULL;
 726
 727     if ((unsigned)fail_info > OSSL_CMP_PKIFAILUREINFO_MAX_BIT_PATTERN) {
 728         CMPerr(0, CMP_R_FAIL_INFO_OUT_OF_RANGE);
 729         return NULL;
 730     }
 731
 732     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_CERTCONF)) == NULL)
 733         goto err;
 734
 735     if ((certStatus = OSSL_CMP_CERTSTATUS_new()) == NULL)
 736         goto err;
 737     /* consume certStatus into msg right away so it gets deallocated with msg */
 738     if (!sk_OSSL_CMP_CERTSTATUS_push(msg->body->value.certConf, certStatus))
 739         goto err;
 740     /* set the ID of the certReq */
 741     if (!ASN1_INTEGER_set(certStatus->certReqId, OSSL_CMP_CERTREQID))
 742         goto err;
 743     /*
 744      * the hash of the certificate, using the same hash algorithm
 745      * as is used to create and verify the certificate signature
 746      */
 747     if ((certHash = X509_digest_sig(ctx->newCert)) == NULL)
 748         goto err;
 749
 750     if (!ossl_cmp_certstatus_set0_certHash(certStatus, certHash))
 751         goto err;
 752     certHash = NULL;
 753     /*
 754      * For any particular CertStatus, omission of the statusInfo field
 755      * indicates ACCEPTANCE of the specified certificate.  Alternatively,
 756      * explicit status details (with respect to acceptance or rejection) MAY
 757      * be provided in the statusInfo field, perhaps for auditing purposes at
 758      * the CA/RA.
 759      */
 760     sinfo = fail_info != 0 ?
 761         OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_rejection, fail_info, text) :
 762         OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_accepted, 0, text);
 763     if (sinfo == NULL)
 764         goto err;
 765     certStatus->statusInfo = sinfo;
 766
 767     if (!ossl_cmp_msg_protect(ctx, msg))
 768         goto err;
 769
 770     return msg;
 771
 772  err:
 773     CMPerr(0, CMP_R_ERROR_CREATING_CERTCONF);
 774     OSSL_CMP_MSG_free(msg);
 775     ASN1_OCTET_STRING_free(certHash);
 776     return NULL;
 777 }
 778
 779 OSSL_CMP_MSG *ossl_cmp_pollReq_new(OSSL_CMP_CTX *ctx, int crid)
 780 {
 781     OSSL_CMP_MSG *msg = NULL;
 782     OSSL_CMP_POLLREQ *preq = NULL;
 783
 784     if (!ossl_assert(ctx != NULL))
 785         return NULL;
 786
 787     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_POLLREQ)) == NULL)
 788         goto err;
 789
 790     /* TODO: support multiple cert request IDs to poll */
 791     if ((preq = OSSL_CMP_POLLREQ_new()) == NULL
 792             || !ASN1_INTEGER_set(preq->certReqId, crid)
 793             || !sk_OSSL_CMP_POLLREQ_push(msg->body->value.pollReq, preq))
 794         goto err;
 795
 796     preq = NULL;
 797     if (!ossl_cmp_msg_protect(ctx, msg))
 798         goto err;
 799
 800     return msg;
 801
 802  err:
 803     CMPerr(0, CMP_R_ERROR_CREATING_POLLREQ);
 804     OSSL_CMP_POLLREQ_free(preq);
 805     OSSL_CMP_MSG_free(msg);
 806     return NULL;
 807 }
 808
 809 OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid,
 810                                    int64_t poll_after)
 811 {
 812     OSSL_CMP_MSG *msg;
 813     OSSL_CMP_POLLREP *prep;
 814
 815     if (!ossl_assert(ctx != NULL))
 816         return NULL;
 817
 818     if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_POLLREP)) == NULL)
 819         goto err;
 820     if ((prep = OSSL_CMP_POLLREP_new()) == NULL)
 821         goto err;
 822     if (!sk_OSSL_CMP_POLLREP_push(msg->body->value.pollRep, prep))
 823         goto err;
 824     if (!ASN1_INTEGER_set(prep->certReqId, crid))
 825         goto err;
 826     if (!ASN1_INTEGER_set_int64(prep->checkAfter, poll_after))
 827         goto err;
 828
 829     if (!ossl_cmp_msg_protect(ctx, msg))
 830         goto err;
 831     return msg;
 832
 833  err:
 834     CMPerr(0, CMP_R_ERROR_CREATING_POLLREP);
 835     OSSL_CMP_MSG_free(msg);
 836     return NULL;
 837 }
 838
 839 /*-
 840  * returns the status field of the RevRepContent with the given
 841  * request/sequence id inside a revocation response.
 842  * RevRepContent has the revocation statuses in same order as they were sent in
 843  * RevReqContent.
 844  * returns NULL on error
 845  */
 846 OSSL_CMP_PKISI *
 847 ossl_cmp_revrepcontent_get_pkisi(OSSL_CMP_REVREPCONTENT *rrep, int rsid)
 848 {
 849     OSSL_CMP_PKISI *status;
 850
 851     if (!ossl_assert(rrep != NULL))
 852         return NULL;
 853
 854     if ((status = sk_OSSL_CMP_PKISI_value(rrep->status, rsid)) != NULL)
 855         return status;
 856
 857     CMPerr(0, CMP_R_PKISTATUSINFO_NOT_FOUND);
 858     return NULL;
 859 }
 860
 861 /*
 862  * returns the CertId field in the revCerts part of the RevRepContent
 863  * with the given request/sequence id inside a revocation response.
 864  * RevRepContent has the CertIds in same order as they were sent in
 865  * RevReqContent.
 866  * returns NULL on error
 867  */
 868 OSSL_CRMF_CERTID *
 869 ossl_cmp_revrepcontent_get_CertId(OSSL_CMP_REVREPCONTENT *rrep, int rsid)
 870 {
 871     OSSL_CRMF_CERTID *cid = NULL;
 872
 873     if (!ossl_assert(rrep != NULL))
 874         return NULL;
 875
 876     if ((cid = sk_OSSL_CRMF_CERTID_value(rrep->revCerts, rsid)) != NULL)
 877         return cid;
 878
 879     CMPerr(0, CMP_R_CERTID_NOT_FOUND);
 880     return NULL;
 881 }
 882
 883 static int suitable_rid(const ASN1_INTEGER *certReqId, int rid)
 884 {
 885     int trid;
 886
 887     if (rid == -1)
 888         return 1;
 889
 890     trid = ossl_cmp_asn1_get_int(certReqId);
 891
 892     if (trid == -1) {
 893         CMPerr(0, CMP_R_BAD_REQUEST_ID);
 894         return 0;
 895     }
 896     return rid == trid;
 897 }
 898
 899 static void add_expected_rid(int rid)
 900 {
 901     char str[DECIMAL_SIZE(rid) + 1];
 902
 903     BIO_snprintf(str, sizeof(str), "%d", rid);
 904     ERR_add_error_data(2, "expected certReqId = ", str);
 905 }
 906
 907 /*
 908  * returns a pointer to the PollResponse with the given CertReqId
 909  * (or the first one in case -1) inside a PollRepContent
 910  * returns NULL on error or if no suitable PollResponse available
 911  */
 912 OSSL_CMP_POLLREP *
 913 ossl_cmp_pollrepcontent_get0_pollrep(const OSSL_CMP_POLLREPCONTENT *prc,
 914                                      int rid)
 915 {
 916     OSSL_CMP_POLLREP *pollRep = NULL;
 917     int i;
 918
 919     if (!ossl_assert(prc != NULL))
 920         return NULL;
 921
 922     for (i = 0; i < sk_OSSL_CMP_POLLREP_num(prc); i++) {
 923         pollRep = sk_OSSL_CMP_POLLREP_value(prc, i);
 924         if (suitable_rid(pollRep->certReqId, rid))
 925             return pollRep;
 926     }
 927
 928     CMPerr(0, CMP_R_CERTRESPONSE_NOT_FOUND);
 929     add_expected_rid(rid);
 930     return NULL;
 931 }
 932
 933 /*
 934  * returns a pointer to the CertResponse with the given CertReqId
 935  * (or the first one in case -1) inside a CertRepMessage
 936  * returns NULL on error or if no suitable CertResponse available
 937  */
 938 OSSL_CMP_CERTRESPONSE *
 939 ossl_cmp_certrepmessage_get0_certresponse(const OSSL_CMP_CERTREPMESSAGE *crm,
 940                                           int rid)
 941 {
 942     OSSL_CMP_CERTRESPONSE *crep = NULL;
 943     int i;
 944
 945     if (!ossl_assert(crm != NULL && crm->response != NULL))
 946         return NULL;
 947
 948     for (i = 0; i < sk_OSSL_CMP_CERTRESPONSE_num(crm->response); i++) {
 949         crep = sk_OSSL_CMP_CERTRESPONSE_value(crm->response, i);
 950         if (suitable_rid(crep->certReqId, rid))
 951             return crep;
 952     }
 953
 954     CMPerr(0, CMP_R_CERTRESPONSE_NOT_FOUND);
 955     add_expected_rid(rid);
 956     return NULL;
 957 }
 958
 959 /*
 960  * CMP_CERTRESPONSE_get1_certificate() attempts to retrieve the returned
 961  * certificate from the given certResponse B<crep>.
 962  * Uses the privkey in case of indirect POP from B<ctx>.
 963  * Returns a pointer to a copy of the found certificate, or NULL if not found.
 964  */
 965 X509 *ossl_cmp_certresponse_get1_certificate(EVP_PKEY *privkey,
 966                                              const OSSL_CMP_CERTRESPONSE *crep)
 967 {
 968     OSSL_CMP_CERTORENCCERT *coec;
 969     X509 *crt = NULL;
 970
 971     if (!ossl_assert(crep != NULL))
 972         return NULL;
 973
 974     if (crep->certifiedKeyPair
 975             && (coec = crep->certifiedKeyPair->certOrEncCert) != NULL) {
 976         switch (coec->type) {
 977         case OSSL_CMP_CERTORENCCERT_CERTIFICATE:
 978             crt = X509_dup(coec->value.certificate);
 979             break;
 980         case OSSL_CMP_CERTORENCCERT_ENCRYPTEDCERT:
 981             /* cert encrypted for indirect PoP; RFC 4210, 5.2.8.2 */
 982             if (privkey == NULL) {
 983                 CMPerr(0, CMP_R_MISSING_PRIVATE_KEY);
 984                 return NULL;
 985             }
 986             crt =
 987                 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(coec->value.encryptedCert,
 988                                                       privkey);
 989             break;
 990         default:
 991             CMPerr(0, CMP_R_UNKNOWN_CERT_TYPE);
 992             return NULL;
 993         }
 994     }
 995     if (crt == NULL)
 996         CMPerr(0, CMP_R_CERTIFICATE_NOT_FOUND);
 997     return crt;
 998 }
 999
1000 int OSSL_CMP_MSG_update_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg)
1001 {
1002     if (ctx == NULL || msg == NULL) {
1003         CMPerr(0, CMP_R_NULL_ARGUMENT);
1004         return 0;
1005     }
1006     if (!ossl_cmp_hdr_set_transactionID(ctx, msg->header))
1007         return 0;
1008     return msg->header->protectionAlg == NULL
1009             || ossl_cmp_msg_protect(ctx, msg);
1010 }
1011
1012 OSSL_CMP_MSG *OSSL_CMP_MSG_read(const char *file)
1013 {
1014     OSSL_CMP_MSG *msg = NULL;
1015     BIO *bio = NULL;
1016
1017     if (file == NULL) {
1018         CMPerr(0, CMP_R_NULL_ARGUMENT);
1019         return NULL;
1020     }
1021
1022     if ((bio = BIO_new_file(file, "rb")) == NULL)
1023         return NULL;
1024     msg = d2i_OSSL_CMP_MSG_bio(bio, NULL);
1025     BIO_free(bio);
1026     return msg;
1027 }
1028
1029 int OSSL_CMP_MSG_write(const char *file, const OSSL_CMP_MSG *msg)
1030 {
1031     BIO *bio;
1032     int res;
1033
1034     if (file == NULL || msg == NULL) {
1035         CMPerr(0, CMP_R_NULL_ARGUMENT);
1036         return -1;
1037     }
1038
1039     bio = BIO_new_file(file, "wb");
1040     if (bio == NULL)
1041         return -2;
1042     res = i2d_OSSL_CMP_MSG_bio(bio, msg);
1043     BIO_free(bio);
1044     return res;
1045 }
1046
1047 OSSL_CMP_MSG *d2i_OSSL_CMP_MSG_bio(BIO *bio, OSSL_CMP_MSG **msg)
1048 {
1049     return ASN1_d2i_bio_of(OSSL_CMP_MSG, OSSL_CMP_MSG_new,
1050                            d2i_OSSL_CMP_MSG, bio, msg);
1051 }
1052
1053 int i2d_OSSL_CMP_MSG_bio(BIO *bio, const OSSL_CMP_MSG *msg)
1054 {
1055     return ASN1_i2d_bio_of(OSSL_CMP_MSG, i2d_OSSL_CMP_MSG, bio, msg);
1056 }