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