Coverage Report

Created: 2023-06-08 06:41

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