2 * Copyright 2007-2022 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 /* CMP functions for PKIMessage construction */
14 #include "cmp_local.h"
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>
23 OSSL_CMP_MSG *OSSL_CMP_MSG_new(OSSL_LIB_CTX *libctx, const char *propq)
25 OSSL_CMP_MSG *msg = NULL;
27 msg = (OSSL_CMP_MSG *)ASN1_item_new_ex(ASN1_ITEM_rptr(OSSL_CMP_MSG),
29 if (!ossl_cmp_msg_set0_libctx(msg, libctx, propq)) {
30 OSSL_CMP_MSG_free(msg);
36 void OSSL_CMP_MSG_free(OSSL_CMP_MSG *msg)
38 ASN1_item_free((ASN1_VALUE *)msg, ASN1_ITEM_rptr(OSSL_CMP_MSG));
42 * This should only be used if the X509 object was embedded inside another
43 * asn1 object and it needs a libctx to operate.
44 * Use OSSL_CMP_MSG_new() instead if possible.
46 int ossl_cmp_msg_set0_libctx(OSSL_CMP_MSG *msg, OSSL_LIB_CTX *libctx,
51 OPENSSL_free(msg->propq);
54 msg->propq = OPENSSL_strdup(propq);
55 if (msg->propq == NULL)
62 OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg)
65 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
71 const char *ossl_cmp_bodytype_to_string(int type)
73 static const char *type_names[] = {
74 "IR", "IP", "CR", "CP", "P10CR",
75 "POPDECC", "POPDECR", "KUR", "KUP",
76 "KRR", "KRP", "RR", "RP", "CCR", "CCP",
77 "CKUANN", "CANN", "RANN", "CRLANN", "PKICONF", "NESTED",
78 "GENM", "GENP", "ERROR", "CERTCONF", "POLLREQ", "POLLREP",
81 if (type < 0 || type > OSSL_CMP_PKIBODY_TYPE_MAX)
82 return "illegal body type";
83 return type_names[type];
86 int ossl_cmp_msg_set_bodytype(OSSL_CMP_MSG *msg, int type)
88 if (!ossl_assert(msg != NULL && msg->body != NULL))
91 msg->body->type = type;
95 int OSSL_CMP_MSG_get_bodytype(const OSSL_CMP_MSG *msg)
97 if (!ossl_assert(msg != NULL && msg->body != NULL))
100 return msg->body->type;
103 /* Add an extension to the referenced extension stack, which may be NULL */
104 static int add1_extension(X509_EXTENSIONS **pexts, int nid, int crit, void *ex)
109 if (!ossl_assert(pexts != NULL)) /* pointer to var must not be NULL */
112 if ((ext = X509V3_EXT_i2d(nid, crit, ex)) == NULL)
115 res = X509v3_add_ext(pexts, ext, 0) != NULL;
116 X509_EXTENSION_free(ext);
120 /* Add extension list to the referenced extension stack, which may be NULL */
121 static int add_extensions(STACK_OF(X509_EXTENSION) **target,
122 const STACK_OF(X509_EXTENSION) *exts)
129 for (i = 0; i < sk_X509_EXTENSION_num(exts); i++) {
130 X509_EXTENSION *ext = sk_X509_EXTENSION_value(exts, i);
131 ASN1_OBJECT *obj = X509_EXTENSION_get_object(ext);
132 int idx = X509v3_get_ext_by_OBJ(*target, obj, -1);
134 /* Does extension exist in target? */
136 /* Delete all extensions of same type */
138 X509_EXTENSION_free(sk_X509_EXTENSION_delete(*target, idx));
139 idx = X509v3_get_ext_by_OBJ(*target, obj, -1);
142 if (!X509v3_add_ext(target, ext, -1))
148 /* Add a CRL revocation reason code to extension stack, which may be NULL */
149 static int add_crl_reason_extension(X509_EXTENSIONS **pexts, int reason_code)
151 ASN1_ENUMERATED *val = ASN1_ENUMERATED_new();
154 if (val != NULL && ASN1_ENUMERATED_set(val, reason_code))
155 res = add1_extension(pexts, NID_crl_reason, 0 /* non-critical */, val);
156 ASN1_ENUMERATED_free(val);
160 OSSL_CMP_MSG *ossl_cmp_msg_create(OSSL_CMP_CTX *ctx, int bodytype)
162 OSSL_CMP_MSG *msg = NULL;
164 if (!ossl_assert(ctx != NULL))
167 if ((msg = OSSL_CMP_MSG_new(ctx->libctx, ctx->propq)) == NULL)
169 if (!ossl_cmp_hdr_init(ctx, msg->header)
170 || !ossl_cmp_msg_set_bodytype(msg, bodytype))
172 if (ctx->geninfo_ITAVs != NULL
173 && !ossl_cmp_hdr_generalInfo_push1_items(msg->header,
178 case OSSL_CMP_PKIBODY_IR:
179 case OSSL_CMP_PKIBODY_CR:
180 case OSSL_CMP_PKIBODY_KUR:
181 if ((msg->body->value.ir = OSSL_CRMF_MSGS_new()) == NULL)
185 case OSSL_CMP_PKIBODY_P10CR:
186 if (ctx->p10CSR == NULL) {
187 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_P10CSR);
190 if ((msg->body->value.p10cr = X509_REQ_dup(ctx->p10CSR)) == NULL)
194 case OSSL_CMP_PKIBODY_IP:
195 case OSSL_CMP_PKIBODY_CP:
196 case OSSL_CMP_PKIBODY_KUP:
197 if ((msg->body->value.ip = OSSL_CMP_CERTREPMESSAGE_new()) == NULL)
201 case OSSL_CMP_PKIBODY_RR:
202 if ((msg->body->value.rr = sk_OSSL_CMP_REVDETAILS_new_null()) == NULL)
205 case OSSL_CMP_PKIBODY_RP:
206 if ((msg->body->value.rp = OSSL_CMP_REVREPCONTENT_new()) == NULL)
210 case OSSL_CMP_PKIBODY_CERTCONF:
211 if ((msg->body->value.certConf =
212 sk_OSSL_CMP_CERTSTATUS_new_null()) == NULL)
215 case OSSL_CMP_PKIBODY_PKICONF:
216 if ((msg->body->value.pkiconf = ASN1_TYPE_new()) == NULL)
218 ASN1_TYPE_set(msg->body->value.pkiconf, V_ASN1_NULL, NULL);
221 case OSSL_CMP_PKIBODY_POLLREQ:
222 if ((msg->body->value.pollReq = sk_OSSL_CMP_POLLREQ_new_null()) == NULL)
225 case OSSL_CMP_PKIBODY_POLLREP:
226 if ((msg->body->value.pollRep = sk_OSSL_CMP_POLLREP_new_null()) == NULL)
230 case OSSL_CMP_PKIBODY_GENM:
231 case OSSL_CMP_PKIBODY_GENP:
232 if ((msg->body->value.genm = sk_OSSL_CMP_ITAV_new_null()) == NULL)
236 case OSSL_CMP_PKIBODY_ERROR:
237 if ((msg->body->value.error = OSSL_CMP_ERRORMSGCONTENT_new()) == NULL)
242 ERR_raise(ERR_LIB_CMP, CMP_R_UNEXPECTED_PKIBODY);
247 OSSL_CMP_MSG_free(msg);
251 #define HAS_SAN(ctx) \
252 (sk_GENERAL_NAME_num((ctx)->subjectAltNames) > 0 \
253 || OSSL_CMP_CTX_reqExtensions_have_SAN(ctx) == 1)
255 static const X509_NAME *determine_subj(OSSL_CMP_CTX *ctx, int for_KUR,
256 const X509_NAME *ref_subj)
258 if (ctx->subjectName != NULL)
259 return IS_NULL_DN(ctx->subjectName) ? NULL : ctx->subjectName;
260 if (ctx->p10CSR != NULL) /* first default is from any given CSR */
261 return X509_REQ_get_subject_name(ctx->p10CSR);
262 if (for_KUR || !HAS_SAN(ctx))
264 * For KUR, copy subject from any reference cert as fallback.
265 * For IR or CR, do the same only if there is no subjectAltName.
271 OSSL_CRMF_MSG *OSSL_CMP_CTX_setup_CRM(OSSL_CMP_CTX *ctx, int for_KUR, int rid)
273 OSSL_CRMF_MSG *crm = NULL;
274 X509 *refcert = ctx->oldCert != NULL ? ctx->oldCert : ctx->cert;
275 /* refcert defaults to current client cert */
276 EVP_PKEY *rkey = OSSL_CMP_CTX_get0_newPkey(ctx, 0);
277 STACK_OF(GENERAL_NAME) *default_sans = NULL;
278 const X509_NAME *ref_subj =
279 refcert != NULL ? X509_get_subject_name(refcert) : NULL;
280 const X509_NAME *subject = determine_subj(ctx, for_KUR, ref_subj);
281 const X509_NAME *issuer = ctx->issuer != NULL || refcert == NULL
282 ? (IS_NULL_DN(ctx->issuer) ? NULL : ctx->issuer)
283 : X509_get_issuer_name(refcert);
284 int crit = ctx->setSubjectAltNameCritical || subject == NULL;
285 /* RFC5280: subjectAltName MUST be critical if subject is null */
286 X509_EXTENSIONS *exts = NULL;
288 if (rkey == NULL && ctx->p10CSR != NULL)
289 rkey = X509_REQ_get0_pubkey(ctx->p10CSR);
290 if (rkey == NULL && refcert != NULL)
291 rkey = X509_get0_pubkey(refcert);
293 rkey = ctx->pkey; /* default is independent of ctx->oldCert */
295 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
296 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_PUBLIC_KEY);
300 if (for_KUR && refcert == NULL && ctx->p10CSR == NULL) {
301 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_REFERENCE_CERT);
304 if ((crm = OSSL_CRMF_MSG_new()) == NULL)
306 if (!OSSL_CRMF_MSG_set_certReqId(crm, rid)
308 * fill certTemplate, corresponding to CertificationRequestInfo
309 * of PKCS#10. The rkey param cannot be NULL so far -
310 * it could be NULL if centralized key creation was supported
312 || !OSSL_CRMF_CERTTEMPLATE_fill(OSSL_CRMF_MSG_get0_tmpl(crm), rkey,
313 subject, issuer, NULL /* serial */))
315 if (ctx->days != 0) {
316 time_t now = time(NULL);
317 ASN1_TIME *notBefore = ASN1_TIME_adj(NULL, now, 0, 0);
318 ASN1_TIME *notAfter = ASN1_TIME_adj(NULL, now, ctx->days, 0);
320 if (notBefore == NULL
322 || !OSSL_CRMF_MSG_set0_validity(crm, notBefore, notAfter)) {
323 ASN1_TIME_free(notBefore);
324 ASN1_TIME_free(notAfter);
330 if (ctx->p10CSR != NULL
331 && (exts = X509_REQ_get_extensions(ctx->p10CSR)) == NULL)
333 if (!ctx->SubjectAltName_nodefault && !HAS_SAN(ctx) && refcert != NULL
334 && (default_sans = X509V3_get_d2i(X509_get0_extensions(refcert),
335 NID_subject_alt_name, NULL, NULL))
337 && !add1_extension(&exts, NID_subject_alt_name, crit, default_sans))
339 if (ctx->reqExtensions != NULL /* augment/override existing ones */
340 && !add_extensions(&exts, ctx->reqExtensions))
342 if (sk_GENERAL_NAME_num(ctx->subjectAltNames) > 0
343 && !add1_extension(&exts, NID_subject_alt_name,
344 crit, ctx->subjectAltNames))
346 if (ctx->policies != NULL
347 && !add1_extension(&exts, NID_certificate_policies,
348 ctx->setPoliciesCritical, ctx->policies))
350 if (!OSSL_CRMF_MSG_set0_extensions(crm, exts))
353 /* end fill certTemplate, now set any controls */
355 /* for KUR, set OldCertId according to D.6 */
356 if (for_KUR && refcert != NULL) {
357 OSSL_CRMF_CERTID *cid =
358 OSSL_CRMF_CERTID_gen(X509_get_issuer_name(refcert),
359 X509_get0_serialNumber(refcert));
364 ret = OSSL_CRMF_MSG_set1_regCtrl_oldCertID(crm, cid);
365 OSSL_CRMF_CERTID_free(cid);
373 OSSL_CRMF_MSG_free(crm);
377 sk_X509_EXTENSION_pop_free(exts, X509_EXTENSION_free);
378 sk_GENERAL_NAME_pop_free(default_sans, GENERAL_NAME_free);
382 OSSL_CMP_MSG *ossl_cmp_certreq_new(OSSL_CMP_CTX *ctx, int type,
383 const OSSL_CRMF_MSG *crm)
386 OSSL_CRMF_MSG *local_crm = NULL;
388 if (!ossl_assert(ctx != NULL))
391 if (type != OSSL_CMP_PKIBODY_IR && type != OSSL_CMP_PKIBODY_CR
392 && type != OSSL_CMP_PKIBODY_KUR && type != OSSL_CMP_PKIBODY_P10CR) {
393 ERR_raise(ERR_LIB_CMP, CMP_R_INVALID_ARGS);
396 if (type == OSSL_CMP_PKIBODY_P10CR && crm != NULL) {
397 ERR_raise(ERR_LIB_CMP, CMP_R_INVALID_ARGS);
401 if ((msg = ossl_cmp_msg_create(ctx, type)) == NULL)
405 if (ctx->implicitConfirm && !ossl_cmp_hdr_set_implicitConfirm(msg->header))
409 /* For P10CR the content has already been set in OSSL_CMP_MSG_create */
410 if (type != OSSL_CMP_PKIBODY_P10CR) {
411 EVP_PKEY *privkey = OSSL_CMP_CTX_get0_newPkey(ctx, 1);
414 * privkey is NULL in case ctx->newPkey does not include a private key.
415 * We then may try to use ctx->pkey as fallback/default, but only
416 * if ctx-> newPkey does not include a (non-matching) public key:
418 if (privkey == NULL && OSSL_CMP_CTX_get0_newPkey(ctx, 0) == NULL)
419 privkey = ctx->pkey; /* default is independent of ctx->oldCert */
420 if (ctx->popoMethod >= OSSL_CRMF_POPO_SIGNATURE && privkey == NULL) {
421 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_PRIVATE_KEY_FOR_POPO);
425 local_crm = OSSL_CMP_CTX_setup_CRM(ctx,
426 type == OSSL_CMP_PKIBODY_KUR,
428 if (local_crm == NULL
429 || !OSSL_CRMF_MSG_create_popo(ctx->popoMethod, local_crm,
430 privkey, ctx->digest,
431 ctx->libctx, ctx->propq))
434 if ((local_crm = OSSL_CRMF_MSG_dup(crm)) == NULL)
438 /* value.ir is same for cr and kur */
439 if (!sk_OSSL_CRMF_MSG_push(msg->body->value.ir, local_crm))
444 if (!ossl_cmp_msg_protect(ctx, msg))
450 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_CERTREQ);
451 OSSL_CRMF_MSG_free(local_crm);
452 OSSL_CMP_MSG_free(msg);
456 OSSL_CMP_MSG *ossl_cmp_certrep_new(OSSL_CMP_CTX *ctx, int bodytype,
457 int certReqId, const OSSL_CMP_PKISI *si,
458 X509 *cert, const X509 *encryption_recip,
459 STACK_OF(X509) *chain, STACK_OF(X509) *caPubs,
460 int unprotectedErrors)
462 OSSL_CMP_MSG *msg = NULL;
463 OSSL_CMP_CERTREPMESSAGE *repMsg = NULL;
464 OSSL_CMP_CERTRESPONSE *resp = NULL;
465 int status = OSSL_CMP_PKISTATUS_unspecified;
467 if (!ossl_assert(ctx != NULL && si != NULL))
470 if ((msg = ossl_cmp_msg_create(ctx, bodytype)) == NULL)
472 repMsg = msg->body->value.ip; /* value.ip is same for cp and kup */
475 if (ctx->implicitConfirm && !ossl_cmp_hdr_set_implicitConfirm(msg->header))
479 if ((resp = OSSL_CMP_CERTRESPONSE_new()) == NULL)
481 OSSL_CMP_PKISI_free(resp->status);
482 if ((resp->status = OSSL_CMP_PKISI_dup(si)) == NULL
483 || !ASN1_INTEGER_set(resp->certReqId, certReqId))
486 status = ossl_cmp_pkisi_get_status(resp->status);
487 if (status != OSSL_CMP_PKISTATUS_rejection
488 && status != OSSL_CMP_PKISTATUS_waiting && cert != NULL) {
489 if (encryption_recip != NULL) {
490 ERR_raise(ERR_LIB_CMP, ERR_R_UNSUPPORTED);
494 if ((resp->certifiedKeyPair = OSSL_CMP_CERTIFIEDKEYPAIR_new())
497 resp->certifiedKeyPair->certOrEncCert->type =
498 OSSL_CMP_CERTORENCCERT_CERTIFICATE;
499 if (!X509_up_ref(cert))
501 resp->certifiedKeyPair->certOrEncCert->value.certificate = cert;
504 if (!sk_OSSL_CMP_CERTRESPONSE_push(repMsg->response, resp))
508 if (bodytype == OSSL_CMP_PKIBODY_IP && caPubs != NULL
509 && (repMsg->caPubs = X509_chain_up_ref(caPubs)) == NULL)
511 if (sk_X509_num(chain) > 0
512 && !ossl_x509_add_certs_new(&msg->extraCerts, chain,
513 X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP))
516 if (!unprotectedErrors
517 || ossl_cmp_pkisi_get_status(si) != OSSL_CMP_PKISTATUS_rejection)
518 if (!ossl_cmp_msg_protect(ctx, msg))
524 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_CERTREP);
525 OSSL_CMP_CERTRESPONSE_free(resp);
526 OSSL_CMP_MSG_free(msg);
530 OSSL_CMP_MSG *ossl_cmp_rr_new(OSSL_CMP_CTX *ctx)
532 OSSL_CMP_MSG *msg = NULL;
533 OSSL_CMP_REVDETAILS *rd;
536 if (!ossl_assert(ctx != NULL && (ctx->oldCert != NULL
537 || ctx->p10CSR != NULL)))
540 if ((rd = OSSL_CMP_REVDETAILS_new()) == NULL)
543 /* Fill the template from the contents of the certificate to be revoked */
544 ret = ctx->oldCert != NULL
545 ? OSSL_CRMF_CERTTEMPLATE_fill(rd->certDetails,
546 NULL /* pubkey would be redundant */,
547 NULL /* subject would be redundant */,
548 X509_get_issuer_name(ctx->oldCert),
549 X509_get0_serialNumber(ctx->oldCert))
550 : OSSL_CRMF_CERTTEMPLATE_fill(rd->certDetails,
551 X509_REQ_get0_pubkey(ctx->p10CSR),
552 X509_REQ_get_subject_name(ctx->p10CSR),
557 /* revocation reason code is optional */
558 if (ctx->revocationReason != CRL_REASON_NONE
559 && !add_crl_reason_extension(&rd->crlEntryDetails,
560 ctx->revocationReason))
563 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_RR)) == NULL)
566 if (!sk_OSSL_CMP_REVDETAILS_push(msg->body->value.rr, rd))
569 /* Revocation Passphrase according to section 5.3.19.9 could be set here */
571 if (!ossl_cmp_msg_protect(ctx, msg))
577 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_RR);
578 OSSL_CMP_MSG_free(msg);
579 OSSL_CMP_REVDETAILS_free(rd);
583 OSSL_CMP_MSG *ossl_cmp_rp_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si,
584 const OSSL_CRMF_CERTID *cid, int unprotectedErrors)
586 OSSL_CMP_REVREPCONTENT *rep = NULL;
587 OSSL_CMP_PKISI *si1 = NULL;
588 OSSL_CRMF_CERTID *cid_copy = NULL;
589 OSSL_CMP_MSG *msg = NULL;
591 if (!ossl_assert(ctx != NULL && si != NULL))
594 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_RP)) == NULL)
596 rep = msg->body->value.rp;
598 if ((si1 = OSSL_CMP_PKISI_dup(si)) == NULL)
601 if (!sk_OSSL_CMP_PKISI_push(rep->status, si1)) {
602 OSSL_CMP_PKISI_free(si1);
606 if ((rep->revCerts = sk_OSSL_CRMF_CERTID_new_null()) == NULL)
609 if ((cid_copy = OSSL_CRMF_CERTID_dup(cid)) == NULL)
611 if (!sk_OSSL_CRMF_CERTID_push(rep->revCerts, cid_copy)) {
612 OSSL_CRMF_CERTID_free(cid_copy);
617 if (!unprotectedErrors
618 || ossl_cmp_pkisi_get_status(si) != OSSL_CMP_PKISTATUS_rejection)
619 if (!ossl_cmp_msg_protect(ctx, msg))
625 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_RP);
626 OSSL_CMP_MSG_free(msg);
630 OSSL_CMP_MSG *ossl_cmp_pkiconf_new(OSSL_CMP_CTX *ctx)
634 if (!ossl_assert(ctx != NULL))
637 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_PKICONF)) == NULL)
639 if (ossl_cmp_msg_protect(ctx, msg))
643 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_PKICONF);
644 OSSL_CMP_MSG_free(msg);
648 int ossl_cmp_msg_gen_push0_ITAV(OSSL_CMP_MSG *msg, OSSL_CMP_ITAV *itav)
652 if (!ossl_assert(msg != NULL && itav != NULL))
655 bodytype = OSSL_CMP_MSG_get_bodytype(msg);
656 if (bodytype != OSSL_CMP_PKIBODY_GENM
657 && bodytype != OSSL_CMP_PKIBODY_GENP) {
658 ERR_raise(ERR_LIB_CMP, CMP_R_INVALID_ARGS);
662 /* value.genp has the same structure, so this works for genp as well */
663 return OSSL_CMP_ITAV_push0_stack_item(&msg->body->value.genm, itav);
666 int ossl_cmp_msg_gen_push1_ITAVs(OSSL_CMP_MSG *msg,
667 const STACK_OF(OSSL_CMP_ITAV) *itavs)
670 OSSL_CMP_ITAV *itav = NULL;
672 if (!ossl_assert(msg != NULL))
675 for (i = 0; i < sk_OSSL_CMP_ITAV_num(itavs); i++) {
676 itav = OSSL_CMP_ITAV_dup(sk_OSSL_CMP_ITAV_value(itavs, i));
678 || !ossl_cmp_msg_gen_push0_ITAV(msg, itav)) {
679 OSSL_CMP_ITAV_free(itav);
687 * Creates a new General Message/Response with an empty itav stack
688 * returns a pointer to the PKIMessage on success, NULL on error
690 static OSSL_CMP_MSG *gen_new(OSSL_CMP_CTX *ctx,
691 const STACK_OF(OSSL_CMP_ITAV) *itavs,
692 int body_type, int err_code)
694 OSSL_CMP_MSG *msg = NULL;
696 if (!ossl_assert(ctx != NULL))
699 if ((msg = ossl_cmp_msg_create(ctx, body_type)) == NULL)
702 if (itavs != NULL && !ossl_cmp_msg_gen_push1_ITAVs(msg, itavs))
705 if (!ossl_cmp_msg_protect(ctx, msg))
711 ERR_raise(ERR_LIB_CMP, err_code);
712 OSSL_CMP_MSG_free(msg);
716 OSSL_CMP_MSG *ossl_cmp_genm_new(OSSL_CMP_CTX *ctx)
718 return gen_new(ctx, ctx->genm_ITAVs,
719 OSSL_CMP_PKIBODY_GENM, CMP_R_ERROR_CREATING_GENM);
722 OSSL_CMP_MSG *ossl_cmp_genp_new(OSSL_CMP_CTX *ctx,
723 const STACK_OF(OSSL_CMP_ITAV) *itavs)
725 return gen_new(ctx, itavs,
726 OSSL_CMP_PKIBODY_GENP, CMP_R_ERROR_CREATING_GENP);
729 OSSL_CMP_MSG *ossl_cmp_error_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si,
730 int64_t errorCode, const char *details,
733 OSSL_CMP_MSG *msg = NULL;
734 const char *lib = NULL, *reason = NULL;
735 OSSL_CMP_PKIFREETEXT *ft;
737 if (!ossl_assert(ctx != NULL && si != NULL))
740 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_ERROR)) == NULL)
743 OSSL_CMP_PKISI_free(msg->body->value.error->pKIStatusInfo);
744 if ((msg->body->value.error->pKIStatusInfo = OSSL_CMP_PKISI_dup(si))
747 if ((msg->body->value.error->errorCode = ASN1_INTEGER_new()) == NULL)
749 if (!ASN1_INTEGER_set_int64(msg->body->value.error->errorCode, errorCode))
752 && (uint64_t)errorCode < ((uint64_t)ERR_SYSTEM_FLAG << 1)) {
753 lib = ERR_lib_error_string((unsigned long)errorCode);
754 reason = ERR_reason_error_string((unsigned long)errorCode);
756 if (lib != NULL || reason != NULL || details != NULL) {
757 if ((ft = sk_ASN1_UTF8STRING_new_null()) == NULL)
759 msg->body->value.error->errorDetails = ft;
760 if (lib != NULL && *lib != '\0'
761 && !ossl_cmp_sk_ASN1_UTF8STRING_push_str(ft, lib, -1))
763 if (reason != NULL && *reason != '\0'
764 && !ossl_cmp_sk_ASN1_UTF8STRING_push_str(ft, reason, -1))
767 && !ossl_cmp_sk_ASN1_UTF8STRING_push_str(ft, details, -1))
771 if (!unprotected && !ossl_cmp_msg_protect(ctx, msg))
776 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_ERROR);
777 OSSL_CMP_MSG_free(msg);
782 * Set the certHash field of a OSSL_CMP_CERTSTATUS structure.
783 * This is used in the certConf message, for example,
784 * to confirm that the certificate was received successfully.
786 int ossl_cmp_certstatus_set0_certHash(OSSL_CMP_CERTSTATUS *certStatus,
787 ASN1_OCTET_STRING *hash)
789 if (!ossl_assert(certStatus != NULL))
791 ASN1_OCTET_STRING_free(certStatus->certHash);
792 certStatus->certHash = hash;
796 OSSL_CMP_MSG *ossl_cmp_certConf_new(OSSL_CMP_CTX *ctx, int certReqId,
797 int fail_info, const char *text)
799 OSSL_CMP_MSG *msg = NULL;
800 OSSL_CMP_CERTSTATUS *certStatus = NULL;
803 ASN1_OCTET_STRING *certHash = NULL;
804 OSSL_CMP_PKISI *sinfo;
806 if (!ossl_assert(ctx != NULL && ctx->newCert != NULL
807 && (certReqId == OSSL_CMP_CERTREQID
808 || certReqId == OSSL_CMP_CERTREQID_NONE)))
811 if ((unsigned)fail_info > OSSL_CMP_PKIFAILUREINFO_MAX_BIT_PATTERN) {
812 ERR_raise(ERR_LIB_CMP, CMP_R_FAIL_INFO_OUT_OF_RANGE);
816 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_CERTCONF)) == NULL)
819 if ((certStatus = OSSL_CMP_CERTSTATUS_new()) == NULL)
821 /* consume certStatus into msg right away so it gets deallocated with msg */
822 if (sk_OSSL_CMP_CERTSTATUS_push(msg->body->value.certConf, certStatus) < 1) {
823 OSSL_CMP_CERTSTATUS_free(certStatus);
827 /* set the ID of the certReq */
828 if (!ASN1_INTEGER_set(certStatus->certReqId, certReqId))
831 certStatus->hashAlg = NULL;
833 * The hash of the certificate, using the same hash algorithm
834 * as is used to create and verify the certificate signature.
835 * If not available, a fallback hash algorithm is used.
837 if ((certHash = X509_digest_sig(ctx->newCert, &md, &is_fallback)) == NULL)
840 if (!ossl_cmp_hdr_set_pvno(msg->header, OSSL_CMP_PVNO_3))
842 if ((certStatus->hashAlg = X509_ALGOR_new()) == NULL)
844 X509_ALGOR_set_md(certStatus->hashAlg, md);
848 if (!ossl_cmp_certstatus_set0_certHash(certStatus, certHash))
852 * For any particular CertStatus, omission of the statusInfo field
853 * indicates ACCEPTANCE of the specified certificate. Alternatively,
854 * explicit status details (with respect to acceptance or rejection) MAY
855 * be provided in the statusInfo field, perhaps for auditing purposes at
858 sinfo = fail_info != 0 ?
859 OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_rejection, fail_info, text) :
860 OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_accepted, 0, text);
863 certStatus->statusInfo = sinfo;
865 if (!ossl_cmp_msg_protect(ctx, msg))
871 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_CERTCONF);
872 OSSL_CMP_MSG_free(msg);
873 ASN1_OCTET_STRING_free(certHash);
877 OSSL_CMP_MSG *ossl_cmp_pollReq_new(OSSL_CMP_CTX *ctx, int crid)
879 OSSL_CMP_MSG *msg = NULL;
880 OSSL_CMP_POLLREQ *preq = NULL;
882 if (!ossl_assert(ctx != NULL))
885 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_POLLREQ)) == NULL)
888 if ((preq = OSSL_CMP_POLLREQ_new()) == NULL
889 || !ASN1_INTEGER_set(preq->certReqId, crid)
890 || !sk_OSSL_CMP_POLLREQ_push(msg->body->value.pollReq, preq))
894 if (!ossl_cmp_msg_protect(ctx, msg))
900 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_POLLREQ);
901 OSSL_CMP_POLLREQ_free(preq);
902 OSSL_CMP_MSG_free(msg);
906 OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid,
910 OSSL_CMP_POLLREP *prep;
912 if (!ossl_assert(ctx != NULL))
915 if ((msg = ossl_cmp_msg_create(ctx, OSSL_CMP_PKIBODY_POLLREP)) == NULL)
917 if ((prep = OSSL_CMP_POLLREP_new()) == NULL)
919 if (!sk_OSSL_CMP_POLLREP_push(msg->body->value.pollRep, prep))
921 if (!ASN1_INTEGER_set(prep->certReqId, crid))
923 if (!ASN1_INTEGER_set_int64(prep->checkAfter, poll_after))
926 if (!ossl_cmp_msg_protect(ctx, msg))
931 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_CREATING_POLLREP);
932 OSSL_CMP_MSG_free(msg);
937 * returns the status field of the RevRepContent with the given
938 * request/sequence id inside a revocation response.
939 * RevRepContent has the revocation statuses in same order as they were sent in
941 * returns NULL on error
944 ossl_cmp_revrepcontent_get_pkisi(OSSL_CMP_REVREPCONTENT *rrep, int rsid)
946 OSSL_CMP_PKISI *status;
948 if (!ossl_assert(rrep != NULL))
951 if ((status = sk_OSSL_CMP_PKISI_value(rrep->status, rsid)) != NULL)
954 ERR_raise(ERR_LIB_CMP, CMP_R_PKISTATUSINFO_NOT_FOUND);
959 * returns the CertId field in the revCerts part of the RevRepContent
960 * with the given request/sequence id inside a revocation response.
961 * RevRepContent has the CertIds in same order as they were sent in
963 * returns NULL on error
966 ossl_cmp_revrepcontent_get_CertId(OSSL_CMP_REVREPCONTENT *rrep, int rsid)
968 OSSL_CRMF_CERTID *cid = NULL;
970 if (!ossl_assert(rrep != NULL))
973 if ((cid = sk_OSSL_CRMF_CERTID_value(rrep->revCerts, rsid)) != NULL)
976 ERR_raise(ERR_LIB_CMP, CMP_R_CERTID_NOT_FOUND);
980 static int suitable_rid(const ASN1_INTEGER *certReqId, int rid)
984 if (rid == OSSL_CMP_CERTREQID_NONE)
987 trid = ossl_cmp_asn1_get_int(certReqId);
989 if (trid == OSSL_CMP_CERTREQID_NONE) {
990 ERR_raise(ERR_LIB_CMP, CMP_R_BAD_REQUEST_ID);
997 * returns a pointer to the PollResponse with the given CertReqId
998 * (or the first one in case -1) inside a PollRepContent
999 * returns NULL on error or if no suitable PollResponse available
1002 ossl_cmp_pollrepcontent_get0_pollrep(const OSSL_CMP_POLLREPCONTENT *prc,
1005 OSSL_CMP_POLLREP *pollRep = NULL;
1008 if (!ossl_assert(prc != NULL))
1011 for (i = 0; i < sk_OSSL_CMP_POLLREP_num(prc); i++) {
1012 pollRep = sk_OSSL_CMP_POLLREP_value(prc, i);
1013 if (suitable_rid(pollRep->certReqId, rid))
1017 ERR_raise_data(ERR_LIB_CMP, CMP_R_CERTRESPONSE_NOT_FOUND,
1018 "expected certReqId = %d", rid);
1023 * returns a pointer to the CertResponse with the given CertReqId
1024 * (or the first one in case -1) inside a CertRepMessage
1025 * returns NULL on error or if no suitable CertResponse available
1027 OSSL_CMP_CERTRESPONSE *
1028 ossl_cmp_certrepmessage_get0_certresponse(const OSSL_CMP_CERTREPMESSAGE *crm,
1031 OSSL_CMP_CERTRESPONSE *crep = NULL;
1034 if (!ossl_assert(crm != NULL && crm->response != NULL))
1037 for (i = 0; i < sk_OSSL_CMP_CERTRESPONSE_num(crm->response); i++) {
1038 crep = sk_OSSL_CMP_CERTRESPONSE_value(crm->response, i);
1039 if (suitable_rid(crep->certReqId, rid))
1043 ERR_raise_data(ERR_LIB_CMP, CMP_R_CERTRESPONSE_NOT_FOUND,
1044 "expected certReqId = %d", rid);
1049 * Retrieve the newly enrolled certificate from the given certResponse crep.
1050 * In case of indirect POPO uses the libctx and propq from ctx and private key.
1051 * Returns a pointer to a copy of the found certificate, or NULL if not found.
1053 X509 *ossl_cmp_certresponse_get1_cert(const OSSL_CMP_CERTRESPONSE *crep,
1054 const OSSL_CMP_CTX *ctx, EVP_PKEY *pkey)
1056 OSSL_CMP_CERTORENCCERT *coec;
1059 if (!ossl_assert(crep != NULL && ctx != NULL))
1062 if (crep->certifiedKeyPair
1063 && (coec = crep->certifiedKeyPair->certOrEncCert) != NULL) {
1064 switch (coec->type) {
1065 case OSSL_CMP_CERTORENCCERT_CERTIFICATE:
1066 crt = X509_dup(coec->value.certificate);
1068 case OSSL_CMP_CERTORENCCERT_ENCRYPTEDCERT:
1069 /* cert encrypted for indirect PoP; RFC 4210, 5.2.8.2 */
1071 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_PRIVATE_KEY);
1075 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(coec->value.encryptedCert,
1076 ctx->libctx, ctx->propq,
1080 ERR_raise(ERR_LIB_CMP, CMP_R_UNKNOWN_CERT_TYPE);
1085 ERR_raise(ERR_LIB_CMP, CMP_R_CERTIFICATE_NOT_FOUND);
1087 (void)ossl_x509_set0_libctx(crt, ctx->libctx, ctx->propq);
1091 int OSSL_CMP_MSG_update_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg)
1093 if (ctx == NULL || msg == NULL) {
1094 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
1097 if (!ossl_cmp_hdr_set_transactionID(ctx, msg->header))
1099 return msg->header->protectionAlg == NULL
1100 || ossl_cmp_msg_protect(ctx, msg);
1103 int OSSL_CMP_MSG_update_recipNonce(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg)
1105 if (ctx == NULL || msg == NULL || msg->header == NULL) {
1106 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
1109 if (ctx->recipNonce == NULL) /* nothing to do for 1st msg in transaction */
1111 if (!ossl_cmp_asn1_octet_string_set1(&msg->header->recipNonce,
1114 return msg->header->protectionAlg == NULL || ossl_cmp_msg_protect(ctx, msg);
1117 OSSL_CMP_MSG *OSSL_CMP_MSG_read(const char *file, OSSL_LIB_CTX *libctx,
1124 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
1128 msg = OSSL_CMP_MSG_new(libctx, propq);
1130 ERR_raise(ERR_LIB_CMP, ERR_R_CMP_LIB);
1134 if ((bio = BIO_new_file(file, "rb")) == NULL
1135 || d2i_OSSL_CMP_MSG_bio(bio, &msg) == NULL) {
1136 OSSL_CMP_MSG_free(msg);
1143 int OSSL_CMP_MSG_write(const char *file, const OSSL_CMP_MSG *msg)
1148 if (file == NULL || msg == NULL) {
1149 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
1153 bio = BIO_new_file(file, "wb");
1156 res = i2d_OSSL_CMP_MSG_bio(bio, msg);
1161 OSSL_CMP_MSG *d2i_OSSL_CMP_MSG(OSSL_CMP_MSG **msg, const unsigned char **in,
1164 OSSL_LIB_CTX *libctx = NULL;
1165 const char *propq = NULL;
1167 if (msg != NULL && *msg != NULL) {
1168 libctx = (*msg)->libctx;
1169 propq = (*msg)->propq;
1172 return (OSSL_CMP_MSG *)ASN1_item_d2i_ex((ASN1_VALUE **)msg, in, len,
1173 ASN1_ITEM_rptr(OSSL_CMP_MSG),
1177 int i2d_OSSL_CMP_MSG(const OSSL_CMP_MSG *msg, unsigned char **out)
1179 return ASN1_item_i2d((const ASN1_VALUE *)msg, out,
1180 ASN1_ITEM_rptr(OSSL_CMP_MSG));
1183 OSSL_CMP_MSG *d2i_OSSL_CMP_MSG_bio(BIO *bio, OSSL_CMP_MSG **msg)
1185 OSSL_LIB_CTX *libctx = NULL;
1186 const char *propq = NULL;
1188 if (msg != NULL && *msg != NULL) {
1189 libctx = (*msg)->libctx;
1190 propq = (*msg)->propq;
1193 return ASN1_item_d2i_bio_ex(ASN1_ITEM_rptr(OSSL_CMP_MSG), bio, msg, libctx,
1197 int i2d_OSSL_CMP_MSG_bio(BIO *bio, const OSSL_CMP_MSG *msg)
1199 return ASN1_i2d_bio_of(OSSL_CMP_MSG, i2d_OSSL_CMP_MSG, bio, msg);