chunk 6 of CMP contribution to OpenSSL
[openssl.git] / crypto / crmf / crmf_lib.c
1 /*-
2  * Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright Nokia 2007-2018
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  * CRMF implementation by Martin Peylo, Miikka Viljanen, and David von Oheimb.
12  */
13
14 /*
15  * This file contains the functions that handle the individual items inside
16  * the CRMF structures
17  */
18
19 /*
20  * NAMING
21  *
22  * The 0 functions use the supplied structure pointer directly in the parent and
23  * it will be freed up when the parent is freed.
24  *
25  * The 1 functions use a copy of the supplied structure pointer (or in some
26  * cases increases its link count) in the parent and so both should be freed up.
27  */
28
29 #include <openssl/asn1t.h>
30
31 #include "crmf_local.h"
32 #include "internal/constant_time.h"
33
34 /* explicit #includes not strictly needed since implied by the above: */
35 #include <openssl/crmf.h>
36 #include <openssl/err.h>
37 #include <openssl/evp.h>
38
39 /*-
40  * atyp = Attribute Type
41  * valt = Value Type
42  * ctrlinf = "regCtrl" or "regInfo"
43  */
44 #define IMPLEMENT_CRMF_CTRL_FUNC(atyp, valt, ctrlinf)                     \
45 int OSSL_CRMF_MSG_set1_##ctrlinf##_##atyp(OSSL_CRMF_MSG *msg,             \
46                                           const valt *in)                 \
47 {                                                                         \
48     OSSL_CRMF_ATTRIBUTETYPEANDVALUE *atav = NULL;                         \
49                                                                           \
50     if (msg == NULL || in  == NULL)                                       \
51         goto err;                                                         \
52     if ((atav = OSSL_CRMF_ATTRIBUTETYPEANDVALUE_new()) == NULL)           \
53         goto err;                                                         \
54     if ((atav->type = OBJ_nid2obj(NID_id_##ctrlinf##_##atyp)) == NULL)    \
55         goto err;                                                         \
56     if ((atav->value.atyp = valt##_dup(in)) == NULL)                      \
57         goto err;                                                         \
58     if (!OSSL_CRMF_MSG_push0_##ctrlinf(msg, atav))                        \
59         goto err;                                                         \
60     return 1;                                                             \
61  err:                                                                     \
62     OSSL_CRMF_ATTRIBUTETYPEANDVALUE_free(atav);                           \
63     return 0;                                                             \
64 }
65
66
67 /*-
68  * Pushes the given control attribute into the controls stack of a CertRequest
69  * (section 6)
70  * returns 1 on success, 0 on error
71  */
72 static int OSSL_CRMF_MSG_push0_regCtrl(OSSL_CRMF_MSG *crm,
73                                        OSSL_CRMF_ATTRIBUTETYPEANDVALUE *ctrl)
74 {
75     int new = 0;
76
77     if (crm == NULL || crm->certReq == NULL || ctrl == NULL) {
78         CRMFerr(CRMF_F_OSSL_CRMF_MSG_PUSH0_REGCTRL, CRMF_R_NULL_ARGUMENT);
79         return 0;
80     }
81
82     if (crm->certReq->controls == NULL) {
83         crm->certReq->controls = sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_new_null();
84         if (crm->certReq->controls == NULL)
85             goto err;
86         new = 1;
87     }
88     if (!sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_push(crm->certReq->controls, ctrl))
89         goto err;
90
91     return 1;
92  err:
93     if (new != 0) {
94         sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_free(crm->certReq->controls);
95         crm->certReq->controls = NULL;
96     }
97     return 0;
98 }
99
100 /* id-regCtrl-regToken Control (section 6.1) */
101 IMPLEMENT_CRMF_CTRL_FUNC(regToken, ASN1_STRING, regCtrl)
102
103 /* id-regCtrl-authenticator Control (section 6.2) */
104 #define ASN1_UTF8STRING_dup ASN1_STRING_dup
105 IMPLEMENT_CRMF_CTRL_FUNC(authenticator, ASN1_UTF8STRING, regCtrl)
106
107 int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
108                                      int method, GENERAL_NAME *nm)
109 {
110     if (spi == NULL
111             || method < OSSL_CRMF_PUB_METHOD_DONTCARE
112             || method > OSSL_CRMF_PUB_METHOD_LDAP) {
113         CRMFerr(CRMF_F_OSSL_CRMF_MSG_SET0_SINGLEPUBINFO,
114                 ERR_R_PASSED_INVALID_ARGUMENT);
115         return 0;
116     }
117
118     if (!ASN1_INTEGER_set(spi->pubMethod, method))
119         return 0;
120     GENERAL_NAME_free(spi->pubLocation);
121     spi->pubLocation = nm;
122     return 1;
123 }
124
125 int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
126                                  OSSL_CRMF_PKIPUBLICATIONINFO *pi,
127                                  OSSL_CRMF_SINGLEPUBINFO *spi)
128 {
129     if (pi == NULL || spi == NULL) {
130         CRMFerr(CRMF_F_OSSL_CRMF_MSG_PKIPUBLICATIONINFO_PUSH0_SINGLEPUBINFO,
131                 CRMF_R_NULL_ARGUMENT);
132         return 0;
133     }
134     if (pi->pubInfos == NULL)
135         pi->pubInfos = sk_OSSL_CRMF_SINGLEPUBINFO_new_null();
136     if (pi->pubInfos == NULL)
137         return 0;
138
139     return sk_OSSL_CRMF_SINGLEPUBINFO_push(pi->pubInfos, spi);
140 }
141
142 int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
143                                  OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action)
144 {
145     if (pi == NULL
146             || action < OSSL_CRMF_PUB_ACTION_DONTPUBLISH
147             || action > OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH) {
148         CRMFerr(CRMF_F_OSSL_CRMF_MSG_SET_PKIPUBLICATIONINFO_ACTION,
149                 ERR_R_PASSED_INVALID_ARGUMENT);
150         return 0;
151     }
152
153     return ASN1_INTEGER_set(pi->action, action);
154 }
155
156 /* id-regCtrl-pkiPublicationInfo Control (section 6.3) */
157 IMPLEMENT_CRMF_CTRL_FUNC(pkiPublicationInfo, OSSL_CRMF_PKIPUBLICATIONINFO,
158                          regCtrl)
159
160 /* id-regCtrl-oldCertID Control (section 6.5) from the given */
161 IMPLEMENT_CRMF_CTRL_FUNC(oldCertID, OSSL_CRMF_CERTID, regCtrl)
162
163 OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
164                                        const ASN1_INTEGER *serial)
165 {
166     OSSL_CRMF_CERTID *cid = NULL;
167
168     if (issuer == NULL || serial == NULL) {
169         CRMFerr(CRMF_F_OSSL_CRMF_CERTID_GEN, CRMF_R_NULL_ARGUMENT);
170         return NULL;
171     }
172
173     if ((cid = OSSL_CRMF_CERTID_new()) == NULL)
174         goto err;
175
176     if (!X509_NAME_set(&cid->issuer->d.directoryName, issuer))
177         goto err;
178     cid->issuer->type = GEN_DIRNAME;
179
180     ASN1_INTEGER_free(cid->serialNumber);
181     if ((cid->serialNumber = ASN1_INTEGER_dup(serial)) == NULL)
182         goto err;
183
184     return cid;
185
186  err:
187     OSSL_CRMF_CERTID_free(cid);
188     return NULL;
189 }
190
191 /*
192  * id-regCtrl-protocolEncrKey Control (section 6.6)
193  */
194 IMPLEMENT_CRMF_CTRL_FUNC(protocolEncrKey, X509_PUBKEY, regCtrl)
195
196 /*-
197  * Pushes the attribute given in regInfo in to the CertReqMsg->regInfo stack.
198  * (section 7)
199  * returns 1 on success, 0 on error
200  */
201 static int OSSL_CRMF_MSG_push0_regInfo(OSSL_CRMF_MSG *crm,
202                                        OSSL_CRMF_ATTRIBUTETYPEANDVALUE *ri)
203 {
204     STACK_OF(OSSL_CRMF_ATTRIBUTETYPEANDVALUE) *info = NULL;
205
206     if (crm == NULL || ri == NULL) {
207         CRMFerr(CRMF_F_OSSL_CRMF_MSG_PUSH0_REGINFO, CRMF_R_NULL_ARGUMENT);
208         return 0;
209     }
210
211     if (crm->regInfo == NULL)
212         crm->regInfo = info = sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_new_null();
213     if (crm->regInfo == NULL)
214         goto err;
215     if (!sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_push(crm->regInfo, ri))
216         goto err;
217     return 1;
218
219  err:
220     if (info != NULL)
221         crm->regInfo = NULL;
222     sk_OSSL_CRMF_ATTRIBUTETYPEANDVALUE_free(info);
223     return 0;
224 }
225
226 /* id-regInfo-utf8Pairs to regInfo (section 7.1) */
227 IMPLEMENT_CRMF_CTRL_FUNC(utf8Pairs, ASN1_UTF8STRING, regInfo)
228
229 /* id-regInfo-certReq to regInfo (section 7.2) */
230 IMPLEMENT_CRMF_CTRL_FUNC(certReq, OSSL_CRMF_CERTREQUEST, regInfo)
231
232
233 /* retrieves the certificate template of crm */
234 OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm)
235 {
236     if (crm == NULL || crm->certReq == NULL) {
237         CRMFerr(CRMF_F_OSSL_CRMF_MSG_GET0_TMPL, CRMF_R_NULL_ARGUMENT);
238         return NULL;
239     }
240     return crm->certReq->certTemplate;
241 }
242
243
244 int OSSL_CRMF_MSG_set_validity(OSSL_CRMF_MSG *crm, time_t from, time_t to)
245 {
246     OSSL_CRMF_OPTIONALVALIDITY *vld = NULL;
247     ASN1_TIME *from_asn = NULL;
248     ASN1_TIME *to_asn = NULL;
249     OSSL_CRMF_CERTTEMPLATE *tmpl = OSSL_CRMF_MSG_get0_tmpl(crm);
250
251     if (tmpl == NULL) { /* also crm == NULL implies this */
252         CRMFerr(CRMF_F_OSSL_CRMF_MSG_SET_VALIDITY, CRMF_R_NULL_ARGUMENT);
253         return 0;
254     }
255
256     if (from != 0 && ((from_asn = ASN1_TIME_set(NULL, from)) == NULL))
257         goto err;
258     if (to != 0 && ((to_asn = ASN1_TIME_set(NULL, to)) == NULL))
259         goto err;
260     if ((vld = OSSL_CRMF_OPTIONALVALIDITY_new()) == NULL)
261         goto err;
262
263     vld->notBefore = from_asn;
264     vld->notAfter = to_asn;
265
266     tmpl->validity = vld;
267
268     return 1;
269  err:
270     ASN1_TIME_free(from_asn);
271     ASN1_TIME_free(to_asn);
272     return 0;
273 }
274
275
276 int OSSL_CRMF_MSG_set_certReqId(OSSL_CRMF_MSG *crm, int rid)
277 {
278     if (crm == NULL || crm->certReq == NULL || crm->certReq->certReqId == NULL) {
279         CRMFerr(CRMF_F_OSSL_CRMF_MSG_SET_CERTREQID, CRMF_R_NULL_ARGUMENT);
280         return 0;
281     }
282
283     return ASN1_INTEGER_set(crm->certReq->certReqId, rid);
284 }
285
286 /* get ASN.1 encoded integer, return -1 on error */
287 static int crmf_asn1_get_int(const ASN1_INTEGER *a)
288 {
289     int64_t res;
290
291     if (!ASN1_INTEGER_get_int64(&res, a)) {
292         CRMFerr(0, ASN1_R_INVALID_NUMBER);
293         return -1;
294     }
295     if (res < INT_MIN) {
296         CRMFerr(0, ASN1_R_TOO_SMALL);
297         return -1;
298     }
299     if (res > INT_MAX) {
300         CRMFerr(0, ASN1_R_TOO_LARGE);
301         return -1;
302     }
303     return (int)res;
304 }
305
306 int OSSL_CRMF_MSG_get_certReqId(OSSL_CRMF_MSG *crm)
307 {
308     if (crm == NULL || /* not really needed: */ crm->certReq == NULL) {
309         CRMFerr(CRMF_F_OSSL_CRMF_MSG_GET_CERTREQID, CRMF_R_NULL_ARGUMENT);
310         return -1;
311     }
312     return crmf_asn1_get_int(crm->certReq->certReqId);
313 }
314
315
316 int OSSL_CRMF_MSG_set0_extensions(OSSL_CRMF_MSG *crm,
317                                   X509_EXTENSIONS *exts)
318 {
319     OSSL_CRMF_CERTTEMPLATE *tmpl = OSSL_CRMF_MSG_get0_tmpl(crm);
320
321     if (tmpl == NULL) { /* also crm == NULL implies this */
322         CRMFerr(CRMF_F_OSSL_CRMF_MSG_SET0_EXTENSIONS, CRMF_R_NULL_ARGUMENT);
323         return 0;
324     }
325
326     if (sk_X509_EXTENSION_num(exts) == 0) {
327         sk_X509_EXTENSION_free(exts);
328         exts = NULL; /* do not include empty extensions list */
329     }
330
331     sk_X509_EXTENSION_pop_free(tmpl->extensions, X509_EXTENSION_free);
332     tmpl->extensions = exts;
333     return 1;
334 }
335
336
337 int OSSL_CRMF_MSG_push0_extension(OSSL_CRMF_MSG *crm,
338                                   X509_EXTENSION *ext)
339 {
340     int new = 0;
341     OSSL_CRMF_CERTTEMPLATE *tmpl = OSSL_CRMF_MSG_get0_tmpl(crm);
342
343     if (tmpl == NULL || ext == NULL) { /* also crm == NULL implies this */
344         CRMFerr(CRMF_F_OSSL_CRMF_MSG_PUSH0_EXTENSION, CRMF_R_NULL_ARGUMENT);
345         return 0;
346     }
347
348     if (tmpl->extensions == NULL) {
349         if ((tmpl->extensions = sk_X509_EXTENSION_new_null()) == NULL)
350             goto err;
351         new = 1;
352     }
353
354     if (!sk_X509_EXTENSION_push(tmpl->extensions, ext))
355         goto err;
356     return 1;
357  err:
358     if (new != 0) {
359         sk_X509_EXTENSION_free(tmpl->extensions);
360         tmpl->extensions = NULL;
361     }
362     return 0;
363 }
364
365 /* TODO: support cases 1+2 (besides case 3) defined in RFC 4211, section 4.1. */
366 static int CRMF_poposigningkey_init(OSSL_CRMF_POPOSIGNINGKEY *ps,
367                                     OSSL_CRMF_CERTREQUEST *cr,
368                                     EVP_PKEY *pkey, int dgst)
369 {
370     int len;
371     size_t crlen;
372     size_t siglen;
373     unsigned char *crder = NULL, *sig = NULL;
374     int alg_nid = 0;
375     int md_nid = 0;
376     const EVP_MD *alg = NULL;
377     EVP_MD_CTX *ctx = NULL;
378     int ret = 0;
379
380     if (ps == NULL || cr == NULL || pkey == NULL) {
381         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT, CRMF_R_NULL_ARGUMENT);
382         return 0;
383     }
384
385     /* OpenSSL defaults all bit strings to be encoded as ASN.1 NamedBitList */
386     ps->signature->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
387     ps->signature->flags |= ASN1_STRING_FLAG_BITS_LEFT;
388
389     len = i2d_OSSL_CRMF_CERTREQUEST(cr, &crder);
390     if (len < 0 || crder == NULL) {
391         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT, CRMF_R_ERROR);
392         goto err;
393     }
394     crlen = (size_t)len;
395
396     if (!OBJ_find_sigid_by_algs(&alg_nid, dgst, EVP_PKEY_id(pkey))) {
397         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT,
398                 CRMF_R_UNSUPPORTED_ALG_FOR_POPSIGNINGKEY);
399         goto err;
400     }
401     if (!OBJ_find_sigid_algs(alg_nid, &md_nid, NULL)
402             || (alg = EVP_get_digestbynid(md_nid)) == NULL) {
403         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT,
404                 CRMF_R_UNSUPPORTED_ALG_FOR_POPSIGNINGKEY);
405         goto err;
406     }
407     if (!X509_ALGOR_set0(ps->algorithmIdentifier, OBJ_nid2obj(alg_nid),
408                          V_ASN1_NULL, NULL)
409             || (ctx = EVP_MD_CTX_new()) == NULL
410             || EVP_DigestSignInit(ctx, NULL, alg, NULL, pkey) <= 0
411             || EVP_DigestSignUpdate(ctx, crder, crlen) <= 0
412             || EVP_DigestSignFinal(ctx, NULL, &siglen) <= 0) {
413         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT, CRMF_R_ERROR);
414         goto err;
415     }
416     if ((sig = OPENSSL_malloc(siglen)) == NULL)
417         goto err;
418     if (EVP_DigestSignFinal(ctx, sig, &siglen) <= 0
419             || !ASN1_BIT_STRING_set(ps->signature, sig, siglen)) {
420         CRMFerr(CRMF_F_CRMF_POPOSIGNINGKEY_INIT, CRMF_R_ERROR);
421         goto err;
422     }
423     ret = 1;
424
425  err:
426     OPENSSL_free(crder);
427     EVP_MD_CTX_free(ctx);
428     OPENSSL_free(sig);
429     return ret;
430 }
431
432
433 int OSSL_CRMF_MSG_create_popo(OSSL_CRMF_MSG *crm, EVP_PKEY *pkey,
434                               int dgst, int ppmtd)
435 {
436     OSSL_CRMF_POPO *pp = NULL;
437     ASN1_INTEGER *tag = NULL;
438
439     if (crm == NULL || (ppmtd == OSSL_CRMF_POPO_SIGNATURE && pkey == NULL)) {
440         CRMFerr(CRMF_F_OSSL_CRMF_MSG_CREATE_POPO, CRMF_R_NULL_ARGUMENT);
441         return 0;
442     }
443
444     if (ppmtd == OSSL_CRMF_POPO_NONE)
445         goto end;
446     if ((pp = OSSL_CRMF_POPO_new()) == NULL)
447         goto err;
448     pp->type = ppmtd;
449
450     switch (ppmtd) {
451     case OSSL_CRMF_POPO_RAVERIFIED:
452         if ((pp->value.raVerified = ASN1_NULL_new()) == NULL)
453             goto err;
454         break;
455
456     case OSSL_CRMF_POPO_SIGNATURE:
457         {
458             OSSL_CRMF_POPOSIGNINGKEY *ps = OSSL_CRMF_POPOSIGNINGKEY_new();
459             if (ps == NULL
460                     || !CRMF_poposigningkey_init(ps, crm->certReq, pkey, dgst)){
461                 OSSL_CRMF_POPOSIGNINGKEY_free(ps);
462                 goto err;
463             }
464             pp->value.signature = ps;
465         }
466         break;
467
468     case OSSL_CRMF_POPO_KEYENC:
469         if ((pp->value.keyEncipherment = OSSL_CRMF_POPOPRIVKEY_new()) == NULL)
470             goto err;
471         tag = ASN1_INTEGER_new();
472         pp->value.keyEncipherment->type =
473             OSSL_CRMF_POPOPRIVKEY_SUBSEQUENTMESSAGE;
474         pp->value.keyEncipherment->value.subsequentMessage = tag;
475         if (tag == NULL
476                 || !ASN1_INTEGER_set(tag, OSSL_CRMF_SUBSEQUENTMESSAGE_ENCRCERT))
477             goto err;
478         break;
479
480     default:
481         CRMFerr(CRMF_F_OSSL_CRMF_MSG_CREATE_POPO,
482                 CRMF_R_UNSUPPORTED_METHOD_FOR_CREATING_POPO);
483         goto err;
484     }
485
486  end:
487     OSSL_CRMF_POPO_free(crm->popo);
488     crm->popo = pp;
489
490     return 1;
491  err:
492     OSSL_CRMF_POPO_free(pp);
493     return 0;
494 }
495
496 /* returns 0 for equal, -1 for a < b or error on a, 1 for a > b or error on b */
497 static int X509_PUBKEY_cmp(X509_PUBKEY *a, X509_PUBKEY *b)
498 {
499     X509_ALGOR *algA = NULL, *algB = NULL;
500     int res = 0;
501
502     if (a == b)
503         return 0;
504     if (a == NULL || !X509_PUBKEY_get0_param(NULL, NULL, NULL, &algA, a)
505             || algA == NULL)
506         return -1;
507     if (b == NULL || !X509_PUBKEY_get0_param(NULL, NULL, NULL, &algB, b)
508             || algB == NULL)
509         return 1;
510     if ((res = X509_ALGOR_cmp(algA, algB)) != 0)
511         return res;
512     return EVP_PKEY_cmp(X509_PUBKEY_get0(a), X509_PUBKEY_get0(b));
513 }
514
515 /* verifies the Proof-of-Possession of the request with the given rid in reqs */
516 int OSSL_CRMF_MSGS_verify_popo(const OSSL_CRMF_MSGS *reqs,
517                                int rid, int acceptRAVerified)
518 {
519     OSSL_CRMF_MSG *req = NULL;
520     X509_PUBKEY *pubkey = NULL;
521     OSSL_CRMF_POPOSIGNINGKEY *sig = NULL;
522
523     if (reqs == NULL
524             || (req = sk_OSSL_CRMF_MSG_value(reqs, rid)) == NULL
525             || req->popo == NULL) {
526         CRMFerr(CRMF_F_OSSL_CRMF_MSGS_VERIFY_POPO,
527                 CRMF_R_NULL_ARGUMENT);
528         return 0;
529     }
530
531     switch (req->popo->type) {
532     case OSSL_CRMF_POPO_RAVERIFIED:
533         if (acceptRAVerified)
534             return 1;
535         break;
536     case OSSL_CRMF_POPO_SIGNATURE:
537         pubkey = req->certReq->certTemplate->publicKey;
538         sig = req->popo->value.signature;
539         if (sig->poposkInput != NULL) {
540             /*
541              * According to RFC 4211: publicKey contains a copy of
542              * the public key from the certificate template. This MUST be
543              * exactly the same value as contained in the certificate template.
544              */
545             if (pubkey == NULL
546                     || sig->poposkInput->publicKey == NULL
547                     || X509_PUBKEY_cmp(pubkey, sig->poposkInput->publicKey)
548                     || ASN1_item_verify(
549                            ASN1_ITEM_rptr(OSSL_CRMF_POPOSIGNINGKEYINPUT),
550                            sig->algorithmIdentifier, sig->signature,
551                            sig->poposkInput, X509_PUBKEY_get0(pubkey)) < 1)
552                 break;
553         } else {
554             if (pubkey == NULL
555                     || req->certReq->certTemplate->subject == NULL
556                     || ASN1_item_verify(ASN1_ITEM_rptr(OSSL_CRMF_CERTREQUEST),
557                                     sig->algorithmIdentifier, sig->signature,
558                                     req->certReq,
559                                     X509_PUBKEY_get0(pubkey)) < 1)
560                 break;
561         }
562         return 1;
563     case OSSL_CRMF_POPO_KEYENC:
564         /*
565          * TODO: when OSSL_CMP_certrep_new() supports encrypted certs,
566          * return 1 if the type of req->popo->value.keyEncipherment
567          * is OSSL_CRMF_POPOPRIVKEY_SUBSEQUENTMESSAGE and
568          * its value.subsequentMessage == OSSL_CRMF_SUBSEQUENTMESSAGE_ENCRCERT
569          */
570     case OSSL_CRMF_POPO_KEYAGREE:
571     default:
572         CRMFerr(CRMF_F_OSSL_CRMF_MSGS_VERIFY_POPO,
573                 CRMF_R_UNSUPPORTED_POPO_METHOD);
574         return 0;
575     }
576     CRMFerr(CRMF_F_OSSL_CRMF_MSGS_VERIFY_POPO,
577             CRMF_R_UNSUPPORTED_POPO_NOT_ACCEPTED);
578     return 0;
579 }
580
581 /* retrieves the serialNumber of the given cert template or NULL on error */
582 ASN1_INTEGER *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(OSSL_CRMF_CERTTEMPLATE *tmpl)
583 {
584     return tmpl != NULL ? tmpl->serialNumber : NULL;
585 }
586
587 /* retrieves the issuer name of the given cert template or NULL on error */
588 X509_NAME *OSSL_CRMF_CERTTEMPLATE_get0_issuer(OSSL_CRMF_CERTTEMPLATE *tmpl)
589 {
590     return tmpl != NULL ? tmpl->issuer : NULL;
591 }
592
593 /* retrieves the issuer name of the given CertId or NULL on error */
594 X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid)
595 {
596     return cid != NULL && cid->issuer->type == GEN_DIRNAME ?
597         cid->issuer->d.directoryName : NULL;
598 }
599
600 /* retrieves the serialNumber of the given CertId or NULL on error */
601 ASN1_INTEGER *OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid)
602 {
603     return cid != NULL ? cid->serialNumber : NULL;
604 }
605
606 /*-
607  * fill in certificate template.
608  * Any value argument that is NULL will leave the respective field unchanged.
609  */
610 int OSSL_CRMF_CERTTEMPLATE_fill(OSSL_CRMF_CERTTEMPLATE *tmpl,
611                                 EVP_PKEY *pubkey,
612                                 const X509_NAME *subject,
613                                 const X509_NAME *issuer,
614                                 const ASN1_INTEGER *serial)
615 {
616     if (tmpl == NULL) {
617         CRMFerr(CRMF_F_OSSL_CRMF_CERTTEMPLATE_FILL, CRMF_R_NULL_ARGUMENT);
618         return 0;
619     }
620     if (subject != NULL && !X509_NAME_set(&tmpl->subject, subject))
621         return 0;
622     if (issuer != NULL && !X509_NAME_set(&tmpl->issuer, issuer))
623         return 0;
624     if (serial != NULL) {
625         ASN1_INTEGER_free(tmpl->serialNumber);
626         if ((tmpl->serialNumber = ASN1_INTEGER_dup(serial)) == NULL)
627             return 0;
628     }
629     if (pubkey != NULL && !X509_PUBKEY_set(&tmpl->publicKey, pubkey))
630         return 0;
631     return 1;
632 }
633
634
635 /*-
636  * Decrypts the certificate in the given encryptedValue using private key pkey.
637  * This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
638  *
639  * returns a pointer to the decrypted certificate
640  * returns NULL on error or if no certificate available
641  */
642 X509 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(OSSL_CRMF_ENCRYPTEDVALUE *ecert,
643                                             EVP_PKEY *pkey)
644 {
645     X509 *cert = NULL; /* decrypted certificate */
646     EVP_CIPHER_CTX *evp_ctx = NULL; /* context for symmetric encryption */
647     unsigned char *ek = NULL; /* decrypted symmetric encryption key */
648     size_t eksize = 0; /* size of decrypted symmetric encryption key */
649     const EVP_CIPHER *cipher = NULL; /* used cipher */
650     int cikeysize = 0; /* key size from cipher */
651     unsigned char *iv = NULL; /* initial vector for symmetric encryption */
652     unsigned char *outbuf = NULL; /* decryption output buffer */
653     const unsigned char *p = NULL; /* needed for decoding ASN1 */
654     int symmAlg = 0; /* NIDs for symmetric algorithm */
655     int n, outlen = 0;
656     EVP_PKEY_CTX *pkctx = NULL; /* private key context */
657
658     if (ecert == NULL || ecert->symmAlg == NULL || ecert->encSymmKey == NULL
659             || ecert->encValue == NULL || pkey == NULL) {
660         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
661                 CRMF_R_NULL_ARGUMENT);
662         return NULL;
663     }
664     if ((symmAlg = OBJ_obj2nid(ecert->symmAlg->algorithm)) == 0) {
665         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
666                 CRMF_R_UNSUPPORTED_CIPHER);
667         return NULL;
668     }
669     /* select symmetric cipher based on algorithm given in message */
670     if ((cipher = EVP_get_cipherbynid(symmAlg)) == NULL) {
671         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
672                 CRMF_R_UNSUPPORTED_CIPHER);
673         goto end;
674     }
675     cikeysize = EVP_CIPHER_key_length(cipher);
676     /* first the symmetric key needs to be decrypted */
677     pkctx = EVP_PKEY_CTX_new(pkey, NULL);
678     if (pkctx != NULL && EVP_PKEY_decrypt_init(pkctx)) {
679         ASN1_BIT_STRING *encKey = ecert->encSymmKey;
680         size_t failure;
681         int retval;
682
683         if (EVP_PKEY_decrypt(pkctx, NULL, &eksize,
684                              encKey->data, encKey->length) <= 0
685                 || (ek = OPENSSL_malloc(eksize)) == NULL)
686             goto end;
687         retval = EVP_PKEY_decrypt(pkctx, ek, &eksize,
688                                   encKey->data, encKey->length);
689         ERR_clear_error(); /* error state may have sensitive information */
690         failure = ~constant_time_is_zero_s(constant_time_msb(retval)
691                                            | constant_time_is_zero(retval));
692         failure |= ~constant_time_eq_s(eksize, (size_t)cikeysize);
693         if (failure) {
694             CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
695                     CRMF_R_ERROR_DECRYPTING_SYMMETRIC_KEY);
696             goto end;
697         }
698     } else {
699         goto end;
700     }
701     if ((iv = OPENSSL_malloc(EVP_CIPHER_iv_length(cipher))) == NULL)
702         goto end;
703     if (ASN1_TYPE_get_octetstring(ecert->symmAlg->parameter, iv,
704                                   EVP_CIPHER_iv_length(cipher))
705         != EVP_CIPHER_iv_length(cipher)) {
706         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
707                 CRMF_R_MALFORMED_IV);
708         goto end;
709     }
710
711     /*
712      * d2i_X509 changes the given pointer, so use p for decoding the message and
713      * keep the original pointer in outbuf so the memory can be freed later
714      */
715     if ((p = outbuf = OPENSSL_malloc(ecert->encValue->length +
716                                      EVP_CIPHER_block_size(cipher))) == NULL
717             || (evp_ctx = EVP_CIPHER_CTX_new()) == NULL)
718         goto end;
719     EVP_CIPHER_CTX_set_padding(evp_ctx, 0);
720
721     if (!EVP_DecryptInit(evp_ctx, cipher, ek, iv)
722             || !EVP_DecryptUpdate(evp_ctx, outbuf, &outlen,
723                                   ecert->encValue->data,
724                                   ecert->encValue->length)
725             || !EVP_DecryptFinal(evp_ctx, outbuf + outlen, &n)) {
726         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
727                 CRMF_R_ERROR_DECRYPTING_CERTIFICATE);
728         goto end;
729     }
730     outlen += n;
731
732     /* convert decrypted certificate from DER to internal ASN.1 structure */
733     if ((cert = d2i_X509(NULL, &p, outlen)) == NULL) {
734         CRMFerr(CRMF_F_OSSL_CRMF_ENCRYPTEDVALUE_GET1_ENCCERT,
735                 CRMF_R_ERROR_DECODING_CERTIFICATE);
736     }
737  end:
738     EVP_PKEY_CTX_free(pkctx);
739     OPENSSL_free(outbuf);
740     EVP_CIPHER_CTX_free(evp_ctx);
741     OPENSSL_clear_free(ek, eksize);
742     OPENSSL_free(iv);
743     return cert;
744 }