xref: /freebsd/crypto/openssl/crypto/cmp/cmp_vfy.c (revision 78e936b2d0b5e6554425009199be31e76bc67c10)
1 /*
2  * Copyright 2007-2026 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright Nokia 2007-2020
4  * Copyright Siemens AG 2015-2020
5  *
6  * Licensed under the Apache License 2.0 (the "License").  You may not use
7  * this file except in compliance with the License.  You can obtain a copy
8  * in the file LICENSE in the source distribution or at
9  * https://www.openssl.org/source/license.html
10  */
11 
12 /* CMP functions for PKIMessage checking */
13 
14 #include "cmp_local.h"
15 #include <openssl/cmp_util.h>
16 
17 /* explicit #includes not strictly needed since implied by the above: */
18 #include <openssl/asn1t.h>
19 #include <openssl/cmp.h>
20 #include <openssl/crmf.h>
21 #include <openssl/err.h>
22 #include <openssl/x509.h>
23 
24 /* Verify a message protected by signature according to RFC section 5.1.3.3 */
verify_signature(const OSSL_CMP_CTX * cmp_ctx,const OSSL_CMP_MSG * msg,X509 * cert)25 static int verify_signature(const OSSL_CMP_CTX *cmp_ctx,
26     const OSSL_CMP_MSG *msg, X509 *cert)
27 {
28     OSSL_CMP_PROTECTEDPART prot_part;
29     EVP_PKEY *pubkey = NULL;
30     BIO *bio;
31     int res = 0;
32 
33     if (!ossl_assert(cmp_ctx != NULL && msg != NULL && cert != NULL))
34         return 0;
35 
36     bio = BIO_new(BIO_s_mem()); /* may be NULL */
37     if (bio == NULL)
38         return 0;
39     /* verify that keyUsage, if present, contains digitalSignature */
40     if (!cmp_ctx->ignore_keyusage
41         && (X509_get_key_usage(cert) & X509v3_KU_DIGITAL_SIGNATURE) == 0) {
42         ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_KEY_USAGE_DIGITALSIGNATURE);
43         goto sig_err;
44     }
45 
46     pubkey = X509_get_pubkey(cert);
47     if (pubkey == NULL) {
48         ERR_raise(ERR_LIB_CMP, CMP_R_FAILED_EXTRACTING_PUBKEY);
49         goto sig_err;
50     }
51 
52     prot_part.header = msg->header;
53     prot_part.body = msg->body;
54 
55     if (ASN1_item_verify_ex(ASN1_ITEM_rptr(OSSL_CMP_PROTECTEDPART),
56             msg->header->protectionAlg, msg->protection,
57             &prot_part, NULL, pubkey, cmp_ctx->libctx,
58             cmp_ctx->propq)
59         > 0) {
60         res = 1;
61         goto end;
62     }
63 
64 sig_err:
65     res = ossl_x509_print_ex_brief(bio, cert, X509_FLAG_NO_EXTENSIONS);
66     ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_VALIDATING_SIGNATURE);
67     if (res) {
68         ERR_add_error_txt(NULL, "\n");
69         ERR_add_error_mem_bio(NULL, bio);
70     }
71     res = 0;
72 
73 end:
74     EVP_PKEY_free(pubkey);
75     BIO_free(bio);
76 
77     return res;
78 }
79 
80 /* Verify a message protected with PBMAC */
verify_PBMAC(OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg)81 static int verify_PBMAC(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg)
82 {
83     ASN1_BIT_STRING *protection = NULL;
84     int valid = 0;
85 
86     /* generate expected protection for the message */
87     if ((protection = ossl_cmp_calc_protection(ctx, msg)) == NULL)
88         return 0; /* failed to generate protection string! */
89 
90     valid = msg->protection != NULL && msg->protection->length >= 0
91         && msg->protection->type == protection->type
92         && msg->protection->length == protection->length
93         && CRYPTO_memcmp(msg->protection->data, protection->data,
94                protection->length)
95             == 0;
96     ASN1_BIT_STRING_free(protection);
97     if (!valid)
98         ERR_raise(ERR_LIB_CMP, CMP_R_WRONG_PBM_VALUE);
99 
100     return valid;
101 }
102 
103 /*-
104  * Attempt to validate certificate and path using any given store with trusted
105  * certs (possibly including CRLs and a cert verification callback function)
106  * and non-trusted intermediate certs from the given ctx.
107  *
108  * Returns 1 on successful validation and 0 otherwise.
109  */
OSSL_CMP_validate_cert_path(const OSSL_CMP_CTX * ctx,X509_STORE * trusted_store,X509 * cert)110 int OSSL_CMP_validate_cert_path(const OSSL_CMP_CTX *ctx,
111     X509_STORE *trusted_store, X509 *cert)
112 {
113     int valid = 0;
114     X509_STORE_CTX *csc = NULL;
115     int err;
116 
117     if (ctx == NULL || cert == NULL) {
118         ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
119         return 0;
120     }
121 
122     if (trusted_store == NULL) {
123         ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_TRUST_STORE);
124         return 0;
125     }
126 
127     if ((csc = X509_STORE_CTX_new_ex(ctx->libctx, ctx->propq)) == NULL
128         || !X509_STORE_CTX_init(csc, trusted_store,
129             cert, ctx->untrusted))
130         goto err;
131 
132     valid = X509_verify_cert(csc) > 0;
133 
134     /* make sure suitable error is queued even if callback did not do */
135     err = ERR_peek_last_error();
136     if (!valid && ERR_GET_REASON(err) != CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
137         ERR_raise(ERR_LIB_CMP, CMP_R_POTENTIALLY_INVALID_CERTIFICATE);
138 
139 err:
140     /* directly output any fresh errors, needed for check_msg_find_cert() */
141     OSSL_CMP_CTX_print_errors(ctx);
142     X509_STORE_CTX_free(csc);
143     return valid;
144 }
145 
verify_cb_cert(X509_STORE * ts,X509 * cert,int err)146 static int verify_cb_cert(X509_STORE *ts, X509 *cert, int err)
147 {
148     X509_STORE_CTX_verify_cb verify_cb;
149     X509_STORE_CTX *csc;
150     int ok = 0;
151 
152     if (ts == NULL || (verify_cb = X509_STORE_get_verify_cb(ts)) == NULL)
153         return ok;
154     if ((csc = X509_STORE_CTX_new()) != NULL
155         && X509_STORE_CTX_init(csc, ts, cert, NULL)) {
156         X509_STORE_CTX_set_error(csc, err);
157         X509_STORE_CTX_set_current_cert(csc, cert);
158         ok = (*verify_cb)(0, csc);
159     }
160     X509_STORE_CTX_free(csc);
161     return ok;
162 }
163 
164 /* Return 0 if expect_name != NULL and there is no matching actual_name */
check_name(const OSSL_CMP_CTX * ctx,int log_success,const char * actual_desc,const X509_NAME * actual_name,const char * expect_desc,const X509_NAME * expect_name)165 static int check_name(const OSSL_CMP_CTX *ctx, int log_success,
166     const char *actual_desc, const X509_NAME *actual_name,
167     const char *expect_desc, const X509_NAME *expect_name)
168 {
169     char *str;
170 
171     if (expect_name == NULL)
172         return 1; /* no expectation, thus trivially fulfilled */
173 
174     /* make sure that a matching name is there */
175     if (actual_name == NULL) {
176         ossl_cmp_log1(WARN, ctx, "missing %s", actual_desc);
177         return 0;
178     }
179     str = X509_NAME_oneline(actual_name, NULL, 0);
180     if (X509_NAME_cmp(actual_name, expect_name) == 0) {
181         if (log_success && str != NULL)
182             ossl_cmp_log3(INFO, ctx, " %s matches %s: %s",
183                 actual_desc, expect_desc, str);
184         OPENSSL_free(str);
185         return 1;
186     }
187 
188     if (str != NULL)
189         ossl_cmp_log2(INFO, ctx, " actual name in %s = %s", actual_desc, str);
190     OPENSSL_free(str);
191     if ((str = X509_NAME_oneline(expect_name, NULL, 0)) != NULL)
192         ossl_cmp_log2(INFO, ctx, " does not match %s = %s", expect_desc, str);
193     OPENSSL_free(str);
194     return 0;
195 }
196 
197 /* Return 0 if skid != NULL and there is no matching subject key ID in cert */
check_kid(const OSSL_CMP_CTX * ctx,const ASN1_OCTET_STRING * ckid,const ASN1_OCTET_STRING * skid)198 static int check_kid(const OSSL_CMP_CTX *ctx,
199     const ASN1_OCTET_STRING *ckid,
200     const ASN1_OCTET_STRING *skid)
201 {
202     char *str;
203 
204     if (skid == NULL)
205         return 1; /* no expectation, thus trivially fulfilled */
206 
207     /* make sure that the expected subject key identifier is there */
208     if (ckid == NULL) {
209         ossl_cmp_warn(ctx, "missing Subject Key Identifier in certificate");
210         return 0;
211     }
212     str = i2s_ASN1_OCTET_STRING(NULL, ckid);
213     if (ASN1_OCTET_STRING_cmp(ckid, skid) == 0) {
214         if (str != NULL)
215             ossl_cmp_log1(INFO, ctx, " subjectKID matches senderKID: %s", str);
216         OPENSSL_free(str);
217         return 1;
218     }
219 
220     if (str != NULL)
221         ossl_cmp_log1(INFO, ctx, " cert Subject Key Identifier = %s", str);
222     OPENSSL_free(str);
223     if ((str = i2s_ASN1_OCTET_STRING(NULL, skid)) != NULL)
224         ossl_cmp_log1(INFO, ctx, " does not match senderKID    = %s", str);
225     OPENSSL_free(str);
226     return 0;
227 }
228 
already_checked(const X509 * cert,const STACK_OF (X509)* already_checked)229 static int already_checked(const X509 *cert,
230     const STACK_OF(X509) *already_checked)
231 {
232     int i;
233 
234     for (i = sk_X509_num(already_checked /* may be NULL */); i > 0; i--)
235         if (X509_cmp(sk_X509_value(already_checked, i - 1), cert) == 0)
236             return 1;
237     return 0;
238 }
239 
240 /*-
241  * Check if the given cert is acceptable as sender cert of the given message.
242  * The subject DN must match, the subject key ID as well if present in the msg,
243  * and the cert must be current (checked if ctx->trusted is not NULL).
244  * Note that cert revocation etc. is checked by OSSL_CMP_validate_cert_path().
245  *
246  * Returns 0 on error or not acceptable, else 1.
247  */
cert_acceptable(const OSSL_CMP_CTX * ctx,const char * desc1,const char * desc2,X509 * cert,const STACK_OF (X509)* already_checked1,const STACK_OF (X509)* already_checked2,const OSSL_CMP_MSG * msg)248 static int cert_acceptable(const OSSL_CMP_CTX *ctx,
249     const char *desc1, const char *desc2, X509 *cert,
250     const STACK_OF(X509) *already_checked1,
251     const STACK_OF(X509) *already_checked2,
252     const OSSL_CMP_MSG *msg)
253 {
254     X509_STORE *ts = ctx->trusted;
255     int self_issued = X509_check_issued(cert, cert) == X509_V_OK;
256     char *str;
257     X509_VERIFY_PARAM *vpm = ts != NULL ? X509_STORE_get0_param(ts) : NULL;
258     int time_cmp;
259 
260     ossl_cmp_log3(INFO, ctx, " considering %s%s %s with..",
261         self_issued ? "self-issued " : "", desc1, desc2);
262     if ((str = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0)) != NULL)
263         ossl_cmp_log1(INFO, ctx, "  subject = %s", str);
264     OPENSSL_free(str);
265     if (!self_issued) {
266         str = X509_NAME_oneline(X509_get_issuer_name(cert), NULL, 0);
267         if (str != NULL)
268             ossl_cmp_log1(INFO, ctx, "  issuer  = %s", str);
269         OPENSSL_free(str);
270     }
271 
272     if (already_checked(cert, already_checked1)
273         || already_checked(cert, already_checked2)) {
274         ossl_cmp_info(ctx, " cert has already been checked");
275         return 0;
276     }
277 
278     time_cmp = X509_cmp_timeframe(vpm, X509_get0_notBefore(cert),
279         X509_get0_notAfter(cert));
280     if (time_cmp != 0) {
281         int err = time_cmp > 0 ? X509_V_ERR_CERT_HAS_EXPIRED
282                                : X509_V_ERR_CERT_NOT_YET_VALID;
283 
284         ossl_cmp_warn(ctx, time_cmp > 0 ? "cert has expired" : "cert is not yet valid");
285         if (ctx->log_cb != NULL /* logging not temporarily disabled */
286             && verify_cb_cert(ts, cert, err) <= 0)
287             return 0;
288     }
289 
290     if (!check_name(ctx, 1,
291             "cert subject", X509_get_subject_name(cert),
292             "sender field", msg->header->sender->d.directoryName))
293         return 0;
294 
295     if (!check_kid(ctx, X509_get0_subject_key_id(cert), msg->header->senderKID))
296         return 0;
297     /* prevent misleading error later in case x509v3_cache_extensions() fails */
298     if (!ossl_x509v3_cache_extensions(cert)) {
299         ossl_cmp_warn(ctx, "cert appears to be invalid");
300         return 0;
301     }
302     if (!verify_signature(ctx, msg, cert)) {
303         ossl_cmp_warn(ctx, "msg signature verification failed");
304         return 0;
305     }
306     /* acceptable also if there is no senderKID in msg header */
307     ossl_cmp_info(ctx, " cert seems acceptable");
308     return 1;
309 }
310 
check_cert_path(const OSSL_CMP_CTX * ctx,X509_STORE * store,X509 * scrt)311 static int check_cert_path(const OSSL_CMP_CTX *ctx, X509_STORE *store,
312     X509 *scrt)
313 {
314     if (OSSL_CMP_validate_cert_path(ctx, store, scrt))
315         return 1;
316 
317     ossl_cmp_warn(ctx,
318         "msg signature validates but cert path validation failed");
319     return 0;
320 }
321 
322 /*
323  * Exceptional handling for 3GPP TS 33.310 [3G/LTE Network Domain Security
324  * (NDS); Authentication Framework (AF)], only to use for IP messages
325  * and if the ctx option is explicitly set: use self-issued certificates
326  * from extraCerts as trust anchor to validate sender cert -
327  * provided it also can validate the newly enrolled certificate
328  */
check_cert_path_3gpp(const OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg,X509 * scrt)329 static int check_cert_path_3gpp(const OSSL_CMP_CTX *ctx,
330     const OSSL_CMP_MSG *msg, X509 *scrt)
331 {
332     int valid = 0;
333     X509_STORE *store;
334 
335     if (!ctx->permitTAInExtraCertsForIR)
336         return 0;
337 
338     if ((store = X509_STORE_new()) == NULL
339         || !ossl_cmp_X509_STORE_add1_certs(store, msg->extraCerts,
340             1 /* self-issued only */))
341         goto err;
342 
343     /* store does not include CRLs */
344     valid = OSSL_CMP_validate_cert_path(ctx, store, scrt);
345     if (!valid) {
346         ossl_cmp_warn(ctx,
347             "also exceptional 3GPP mode cert path validation failed");
348     } else if (OSSL_CMP_MSG_get_bodytype(msg) == OSSL_CMP_PKIBODY_IP) {
349         /*
350          * verify that the newly enrolled certificate (which assumed rid ==
351          * OSSL_CMP_CERTREQID) can also be validated with the same trusted store
352          */
353         OSSL_CMP_CERTRESPONSE *crep = ossl_cmp_certrepmessage_get0_certresponse(msg->body->value.ip,
354             OSSL_CMP_CERTREQID);
355         X509 *newcrt = NULL;
356 
357         valid = crep != NULL
358             && (newcrt = ossl_cmp_certresponse_get1_cert(ctx, crep)) != NULL
359             && OSSL_CMP_validate_cert_path(ctx, store, newcrt);
360         X509_free(newcrt);
361     }
362 
363 err:
364     X509_STORE_free(store);
365     return valid;
366 }
367 
368 /* checks protection of msg but not cert revocation nor cert chain */
check_msg_given_cert(const OSSL_CMP_CTX * ctx,X509 * cert,const OSSL_CMP_MSG * msg)369 static int check_msg_given_cert(const OSSL_CMP_CTX *ctx, X509 *cert,
370     const OSSL_CMP_MSG *msg)
371 {
372     return cert_acceptable(ctx, "previously validated", "sender cert",
373         cert, NULL, NULL, msg);
374 }
375 
376 /*-
377  * Try all certs in given list for verifying msg, normally or in 3GPP mode.
378  * If already_checked1 == NULL then certs are assumed to be the msg->extraCerts.
379  * On success cache the found cert using ossl_cmp_ctx_set1_validatedSrvCert().
380  */
check_msg_with_certs(OSSL_CMP_CTX * ctx,const STACK_OF (X509)* certs,const char * desc,const STACK_OF (X509)* already_checked1,const STACK_OF (X509)* already_checked2,const OSSL_CMP_MSG * msg,int mode_3gpp)381 static int check_msg_with_certs(OSSL_CMP_CTX *ctx, const STACK_OF(X509) *certs,
382     const char *desc,
383     const STACK_OF(X509) *already_checked1,
384     const STACK_OF(X509) *already_checked2,
385     const OSSL_CMP_MSG *msg, int mode_3gpp)
386 {
387     int in_extraCerts = already_checked1 == NULL;
388     int n_acceptable_certs = 0;
389     int i;
390 
391     if (sk_X509_num(certs) <= 0) {
392         ossl_cmp_log1(INFO, ctx, "no %s", desc);
393         return 0;
394     }
395 
396     for (i = 0; i < sk_X509_num(certs); i++) { /* certs may be NULL */
397         X509 *cert = sk_X509_value(certs, i);
398 
399         if (!ossl_assert(cert != NULL))
400             return 0;
401         if (!cert_acceptable(ctx, "cert from", desc, cert,
402                 already_checked1, already_checked2, msg))
403             continue;
404         n_acceptable_certs++;
405         if (mode_3gpp ? check_cert_path_3gpp(ctx, msg, cert)
406                       : check_cert_path(ctx, ctx->trusted, cert)) {
407             /* store successful sender cert for further msgs in transaction */
408             return ossl_cmp_ctx_set1_validatedSrvCert(ctx, cert);
409         }
410     }
411     if (in_extraCerts && n_acceptable_certs == 0)
412         ossl_cmp_log1(WARN, ctx, "no acceptable %s", desc);
413     return 0;
414 }
415 
416 /*-
417  * Verify msg trying first ctx->untrusted, which should include extraCerts
418  * at its front, then trying the trusted certs in truststore (if any) of ctx.
419  * On success cache the found cert using ossl_cmp_ctx_set1_validatedSrvCert().
420  */
check_msg_all_certs(OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg,int mode_3gpp)421 static int check_msg_all_certs(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg,
422     int mode_3gpp)
423 {
424     int ret = 0;
425 
426     if (ctx->permitTAInExtraCertsForIR
427         && OSSL_CMP_MSG_get_bodytype(msg) == OSSL_CMP_PKIBODY_IP)
428         ossl_cmp_info(ctx, mode_3gpp ? "normal mode failed; trying now 3GPP mode trusting extraCerts" : "trying first normal mode using trust store");
429     else if (mode_3gpp)
430         return 0;
431 
432     if (check_msg_with_certs(ctx, msg->extraCerts, "extraCerts",
433             NULL, NULL, msg, mode_3gpp))
434         return 1;
435     if (check_msg_with_certs(ctx, ctx->untrusted, "untrusted certs",
436             msg->extraCerts, NULL, msg, mode_3gpp))
437         return 1;
438 
439     if (ctx->trusted == NULL) {
440         ossl_cmp_warn(ctx, mode_3gpp ? "no self-issued extraCerts" : "no trusted store");
441     } else {
442         STACK_OF(X509) *trusted = X509_STORE_get1_all_certs(ctx->trusted);
443 
444         ret = check_msg_with_certs(ctx, trusted,
445             mode_3gpp ? "self-issued extraCerts"
446                       : "certs in trusted store",
447             msg->extraCerts, ctx->untrusted,
448             msg, mode_3gpp);
449         OSSL_STACK_OF_X509_free(trusted);
450     }
451     return ret;
452 }
453 
454 /*-
455  * Verify message signature with any acceptable and valid candidate cert.
456  * On success cache the found cert using ossl_cmp_ctx_set1_validatedSrvCert().
457  */
check_msg_find_cert(OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg)458 static int check_msg_find_cert(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg)
459 {
460     X509 *scrt = ctx->validatedSrvCert; /* previous successful sender cert */
461     GENERAL_NAME *sender = msg->header->sender;
462     char *sname = NULL;
463     char *skid_str = NULL;
464     const ASN1_OCTET_STRING *skid = msg->header->senderKID;
465     OSSL_CMP_log_cb_t backup_log_cb = ctx->log_cb;
466     int res = 0;
467 
468     if (sender == NULL || msg->body == NULL)
469         return 0; /* other NULL cases already have been checked */
470     if (sender->type != GEN_DIRNAME) {
471         /* So far, only X509_NAME is supported */
472         ERR_raise(ERR_LIB_CMP, CMP_R_SENDER_GENERALNAME_TYPE_NOT_SUPPORTED);
473         return 0;
474     }
475 
476     /* dump any hitherto errors to avoid confusion when printing further ones */
477     OSSL_CMP_CTX_print_errors(ctx);
478 
479     /* enable clearing irrelevant errors in attempts to validate sender certs */
480     (void)ERR_set_mark();
481     ctx->log_cb = NULL; /* temporarily disable logging */
482 
483     if (scrt != NULL) {
484         /*-
485          * try first using cached message sender cert (in 'scrt' variable),
486          * which was used successfully earlier in the same transaction
487          * (assuming that the certificate itself was not revoked meanwhile and
488          *  is a good guess for use in validating also the current message)
489          */
490         if (check_msg_given_cert(ctx, scrt, msg)) {
491             ctx->log_cb = backup_log_cb;
492             (void)ERR_pop_to_mark();
493             return 1;
494         }
495         /* cached sender cert has shown to be no more successfully usable */
496         /* re-do the above check (just) for adding diagnostic information */
497         ossl_cmp_info(ctx,
498             "trying to verify msg signature with previously validated cert");
499         ctx->log_cb = backup_log_cb;
500         (void)check_msg_given_cert(ctx, scrt, msg);
501         ctx->log_cb = NULL;
502         (void)ossl_cmp_ctx_set1_validatedSrvCert(ctx, NULL); /* this invalidates scrt */
503     }
504 
505     res = check_msg_all_certs(ctx, msg, 0 /* using ctx->trusted */)
506         || check_msg_all_certs(ctx, msg, 1 /* 3gpp */);
507 
508     ctx->log_cb = backup_log_cb; /* re-enable logging */
509     /* discard any previous diagnostic information on trying to use certs */
510     (void)ERR_pop_to_mark();
511 
512     if (res)
513         goto end;
514     /* failed finding a sender cert that verifies the message signature */
515 
516     sname = X509_NAME_oneline(sender->d.directoryName, NULL, 0);
517     skid_str = skid == NULL ? NULL : i2s_ASN1_OCTET_STRING(NULL, skid);
518     if (ctx->log_cb != NULL) {
519         ossl_cmp_info(ctx, "trying to verify msg signature with a valid cert that..");
520         if (sname != NULL)
521             ossl_cmp_log1(INFO, ctx, "matches msg sender    = %s", sname);
522         if (skid_str != NULL)
523             ossl_cmp_log1(INFO, ctx, "matches msg senderKID = %s", skid_str);
524         else
525             ossl_cmp_info(ctx, "while msg header does not contain senderKID");
526         /* re-do the above checks (just) for adding diagnostic information */
527         (void)check_msg_all_certs(ctx, msg, 0 /* using ctx->trusted */);
528         (void)check_msg_all_certs(ctx, msg, 1 /* 3gpp */);
529     }
530 
531     ERR_raise(ERR_LIB_CMP, CMP_R_NO_SUITABLE_SENDER_CERT);
532     if (sname != NULL) {
533         ERR_add_error_txt(NULL, "for msg sender name = ");
534         ERR_add_error_txt(NULL, sname);
535     }
536     if (skid_str != NULL) {
537         ERR_add_error_txt(" and ", "for msg senderKID = ");
538         ERR_add_error_txt(NULL, skid_str);
539     }
540 
541 end:
542     OPENSSL_free(sname);
543     OPENSSL_free(skid_str);
544     return res;
545 }
546 
547 /*-
548  * Validate the protection of the given PKIMessage using either password-
549  * based mac (PBM) or a signature algorithm. In the case of signature algorithm,
550  * the sender certificate can have been pinned by providing it in ctx->srvCert,
551  * else it is searched in msg->extraCerts, ctx->untrusted, in ctx->trusted
552  * (in this order) and is path is validated against ctx->trusted.
553  * On success cache the found cert using ossl_cmp_ctx_set1_validatedSrvCert().
554  *
555  * If ctx->permitTAInExtraCertsForIR is true and when validating a CMP IP msg,
556  * the trust anchor for validating the IP msg may be taken from msg->extraCerts
557  * if a self-issued certificate is found there that can be used to
558  * validate the enrolled certificate returned in the IP.
559  * This is according to the need given in 3GPP TS 33.310.
560  *
561  * Returns 1 on success, 0 on error or validation failed.
562  */
OSSL_CMP_validate_msg(OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg)563 int OSSL_CMP_validate_msg(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg)
564 {
565     X509 *scrt;
566 
567     ossl_cmp_debug(ctx, "validating CMP message");
568     if (ctx == NULL || msg == NULL
569         || msg->header == NULL || msg->body == NULL) {
570         ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
571         return 0;
572     }
573 
574     if (msg->header->protectionAlg == NULL /* unprotected message */
575         || msg->protection == NULL || msg->protection->data == NULL) {
576         ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_PROTECTION);
577         return 0;
578     }
579 
580     switch (ossl_cmp_hdr_get_protection_nid(msg->header)) {
581         /* 5.1.3.1.  Shared Secret Information */
582     case NID_id_PasswordBasedMAC:
583         if (ctx->secretValue == NULL) {
584             ossl_cmp_info(ctx, "no secret available for verifying PBM-based CMP message protection");
585             ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_SECRET);
586             return 0;
587         }
588         if (verify_PBMAC(ctx, msg)) {
589             /*
590              * RFC 9810, 5.3.2: 'Note that if the PKI message protection is
591              * "shared secret information", then any certificate transported in
592              * the caPubs field may be directly trusted as a root CA
593              * certificate by the initiator.'
594              */
595             switch (OSSL_CMP_MSG_get_bodytype(msg)) {
596             case -1:
597                 return 0;
598             case OSSL_CMP_PKIBODY_IP:
599             case OSSL_CMP_PKIBODY_CP:
600             case OSSL_CMP_PKIBODY_KUP:
601             case OSSL_CMP_PKIBODY_CCP:
602                 if (ctx->trusted != NULL) {
603                     STACK_OF(X509) *certs = msg->body->value.ip->caPubs;
604                     /* value.ip is same for cp, kup, and ccp */
605 
606                     if (!ossl_cmp_X509_STORE_add1_certs(ctx->trusted, certs, 0))
607                         /* adds both self-issued and not self-issued certs */
608                         return 0;
609                 }
610                 break;
611             default:
612                 break;
613             }
614             ossl_cmp_debug(ctx,
615                 "successfully validated PBM-based CMP message protection");
616             return 1;
617         }
618         ossl_cmp_warn(ctx, "verifying PBM-based CMP message protection failed");
619         break;
620 
621         /*
622          * 5.1.3.2 DH Key Pairs
623          * Not yet supported
624          */
625     case NID_id_DHBasedMac:
626         ERR_raise(ERR_LIB_CMP, CMP_R_UNSUPPORTED_PROTECTION_ALG_DHBASEDMAC);
627         break;
628 
629         /*
630          * 5.1.3.3.  Signature
631          */
632     default:
633         scrt = ctx->srvCert;
634         if (scrt == NULL) {
635             if (ctx->trusted == NULL && ctx->secretValue != NULL) {
636                 ossl_cmp_info(ctx, "no trust store nor pinned sender cert available for verifying signature-based CMP message protection");
637                 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_TRUST_ANCHOR);
638                 return 0;
639             }
640             if (check_msg_find_cert(ctx, msg)) {
641                 ossl_cmp_log1(DEBUG, ctx,
642                     "successfully validated signature-based CMP message protection using trust store%s",
643                     ctx->permitTAInExtraCertsForIR ? " or 3GPP mode" : "");
644                 return 1;
645             }
646         } else { /* use pinned sender cert */
647             /* use ctx->srvCert for signature check even if not acceptable */
648             if (verify_signature(ctx, msg, scrt)) {
649                 ossl_cmp_debug(ctx,
650                     "successfully validated signature-based CMP message protection using pinned sender cert");
651                 return ossl_cmp_ctx_set1_validatedSrvCert(ctx, scrt);
652             }
653             ossl_cmp_warn(ctx, "CMP message signature verification failed");
654             ERR_raise(ERR_LIB_CMP, CMP_R_SRVCERT_DOES_NOT_VALIDATE_MSG);
655         }
656         break;
657     }
658     return 0;
659 }
660 
check_transactionID_or_nonce(ASN1_OCTET_STRING * expected,ASN1_OCTET_STRING * actual,int reason)661 static int check_transactionID_or_nonce(ASN1_OCTET_STRING *expected,
662     ASN1_OCTET_STRING *actual, int reason)
663 {
664     if (expected != NULL
665         && (actual == NULL || ASN1_OCTET_STRING_cmp(expected, actual) != 0)) {
666 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
667         char *expected_str, *actual_str;
668 
669         expected_str = i2s_ASN1_OCTET_STRING(NULL, expected);
670         actual_str = actual == NULL ? NULL : i2s_ASN1_OCTET_STRING(NULL, actual);
671         ERR_raise_data(ERR_LIB_CMP, reason,
672             "expected = %s, actual = %s",
673             expected_str == NULL ? "?" : expected_str,
674             actual == NULL ? "(none)" : actual_str == NULL ? "?"
675                                                            : actual_str);
676         OPENSSL_free(expected_str);
677         OPENSSL_free(actual_str);
678         return 0;
679 #endif
680     }
681     return 1;
682 }
683 
684 /*-
685  * Check received message (i.e., response by server or request from client)
686  * Any msg->extraCerts are prepended to ctx->untrusted.
687  *
688  * Ensures that:
689  * its sender is of appropriate type (currently only X509_NAME) and
690  *     matches any expected sender or srvCert subject given in the ctx
691  * it has a valid body type
692  * its protection is valid (or invalid/absent, but only if a callback function
693  *     is present and yields a positive result using also the supplied argument)
694  * its transaction ID matches the previous transaction ID stored in ctx (if any)
695  * its recipNonce matches the previous senderNonce stored in the ctx (if any)
696  *
697  * If everything is fine:
698  * learns the senderNonce from the received message,
699  * learns the transaction ID if it is not yet in ctx,
700  * and makes any certs in caPubs directly trusted.
701  *
702  * Returns 1 on success, 0 on error.
703  */
ossl_cmp_msg_check_update(OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg,ossl_cmp_allow_unprotected_cb_t cb,int cb_arg)704 int ossl_cmp_msg_check_update(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg,
705     ossl_cmp_allow_unprotected_cb_t cb, int cb_arg)
706 {
707     OSSL_CMP_PKIHEADER *hdr;
708     const X509_NAME *expected_sender;
709     int num_untrusted, num_added, res;
710 
711     if (!ossl_assert(ctx != NULL && msg != NULL && msg->header != NULL))
712         return 0;
713     hdr = OSSL_CMP_MSG_get0_header(msg);
714 
715     /* If expected_sender is given, validate sender name of received msg */
716     expected_sender = ctx->expected_sender;
717     if (expected_sender == NULL && ctx->srvCert != NULL)
718         expected_sender = X509_get_subject_name(ctx->srvCert);
719     if (expected_sender != NULL) {
720         const X509_NAME *actual_sender;
721         char *str;
722 
723         if (hdr->sender->type != GEN_DIRNAME) {
724             ERR_raise(ERR_LIB_CMP, CMP_R_SENDER_GENERALNAME_TYPE_NOT_SUPPORTED);
725             return 0;
726         }
727         actual_sender = hdr->sender->d.directoryName;
728         /*
729          * Compare actual sender name of response with expected sender name.
730          * Mitigates risk of accepting misused PBM secret or
731          * misused certificate of an unauthorized entity of a trusted hierarchy.
732          */
733         if (!check_name(ctx, 0, "sender DN field", actual_sender,
734                 "expected sender", expected_sender)) {
735             str = X509_NAME_oneline(actual_sender, NULL, 0);
736             ERR_raise_data(ERR_LIB_CMP, CMP_R_UNEXPECTED_SENDER,
737                 "%s", str != NULL ? str : "<unknown>");
738             OPENSSL_free(str);
739             return 0;
740         }
741     }
742     /* Note: if recipient was NULL-DN it could be learned here if needed */
743 
744     num_added = sk_X509_num(msg->extraCerts);
745     if (num_added > 10)
746         ossl_cmp_log1(WARN, ctx, "received CMP message contains %d extraCerts",
747             num_added);
748     /*
749      * Store any provided extraCerts in ctx for use in OSSL_CMP_validate_msg()
750      * and for future use, such that they are available to ctx->certConf_cb and
751      * the peer does not need to send them again in the same transaction.
752      * Note that it does not help validating the message before storing the
753      * extraCerts because they do not belong to the protected msg part anyway.
754      * The extraCerts are prepended. Allows simple removal if they shall not be
755      * cached. Also they get used first, which is likely good for efficiency.
756      */
757     num_untrusted = ctx->untrusted == NULL ? 0 : sk_X509_num(ctx->untrusted);
758     res = ossl_x509_add_certs_new(&ctx->untrusted, msg->extraCerts,
759         /* this allows self-signed certs */
760         X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP
761             | X509_ADD_FLAG_PREPEND);
762     num_added = (ctx->untrusted == NULL ? 0 : sk_X509_num(ctx->untrusted))
763         - num_untrusted;
764     if (!res) {
765         while (num_added-- > 0)
766             X509_free(sk_X509_shift(ctx->untrusted));
767         return 0;
768     }
769 
770     if (hdr->protectionAlg != NULL)
771         res = OSSL_CMP_validate_msg(ctx, msg)
772             /* explicitly permitted exceptions for invalid protection: */
773             || (cb != NULL && (*cb)(ctx, msg, 1, cb_arg) > 0);
774     else
775         /* explicitly permitted exceptions for missing protection: */
776         res = cb != NULL && (*cb)(ctx, msg, 0, cb_arg) > 0;
777 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
778     res = 1; /* support more aggressive fuzzing by letting invalid msg pass */
779 #endif
780 
781     /*
782      * remove extraCerts again if not caching
783      * or if we failed validation above, lest a remote user
784      * starts sending us lots of certificates in invalid messages
785      * leading to a DOS from unbounded certificate stack growth
786      */
787     if (ctx->noCacheExtraCerts || res != 1)
788         while (num_added-- > 0)
789             X509_free(sk_X509_shift(ctx->untrusted));
790 
791     if (!res) {
792         if (hdr->protectionAlg != NULL)
793             ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_VALIDATING_PROTECTION);
794         else
795             ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_PROTECTION);
796         return 0;
797     }
798 
799     /* check CMP version number in header */
800     if (ossl_cmp_hdr_get_pvno(hdr) != OSSL_CMP_PVNO_2
801         && ossl_cmp_hdr_get_pvno(hdr) != OSSL_CMP_PVNO_3) {
802 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
803         ERR_raise(ERR_LIB_CMP, CMP_R_UNEXPECTED_PVNO);
804         return 0;
805 #endif
806     }
807 
808     if (OSSL_CMP_MSG_get_bodytype(msg) < 0) {
809 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
810         ERR_raise(ERR_LIB_CMP, CMP_R_PKIBODY_ERROR);
811         return 0;
812 #endif
813     }
814 
815     /* compare received transactionID with the expected one in previous msg */
816     if (!check_transactionID_or_nonce(ctx->transactionID, hdr->transactionID,
817             CMP_R_TRANSACTIONID_UNMATCHED))
818         return 0;
819 
820     /*
821      * enable clearing irrelevant errors
822      * in attempts to validate recipient nonce in case of delayed delivery.
823      */
824     (void)ERR_set_mark();
825     /* compare received nonce with the one we sent */
826     if (!check_transactionID_or_nonce(ctx->senderNonce, hdr->recipNonce,
827             CMP_R_RECIPNONCE_UNMATCHED)) {
828         /* check if we are polling and received final response */
829         if (ctx->first_senderNonce == NULL
830             || OSSL_CMP_MSG_get_bodytype(msg) == OSSL_CMP_PKIBODY_POLLREP
831             /* compare received nonce with our sender nonce at poll start */
832             || !check_transactionID_or_nonce(ctx->first_senderNonce,
833                 hdr->recipNonce,
834                 CMP_R_RECIPNONCE_UNMATCHED)) {
835             (void)ERR_clear_last_mark();
836             return 0;
837         }
838     }
839     (void)ERR_pop_to_mark();
840 
841     /* if not yet present, learn transactionID */
842     if (ctx->transactionID == NULL
843         && !OSSL_CMP_CTX_set1_transactionID(ctx, hdr->transactionID))
844         return 0;
845 
846     /*
847      * RFC 9810 section 5.1.1 states: the recipNonce is copied from
848      * the senderNonce of the previous message in the transaction.
849      * --> Store for setting in next message
850      */
851     if (!ossl_cmp_ctx_set1_recipNonce(ctx, hdr->senderNonce))
852         return 0;
853 
854     if (ossl_cmp_hdr_get_protection_nid(hdr) == NID_id_PasswordBasedMAC) {
855         /*
856          * RFC 9810, 5.3.2: 'Note that if the PKI message protection is
857          * "shared secret information", then any certificate transported in
858          * the caPubs field may be directly trusted as a root CA
859          * certificate by the initiator.'
860          */
861         switch (OSSL_CMP_MSG_get_bodytype(msg)) {
862         case OSSL_CMP_PKIBODY_IP:
863         case OSSL_CMP_PKIBODY_CP:
864         case OSSL_CMP_PKIBODY_KUP:
865         case OSSL_CMP_PKIBODY_CCP:
866             if (ctx->trusted != NULL) {
867                 STACK_OF(X509) *certs = msg->body->value.ip->caPubs;
868                 /* value.ip is same for cp, kup, and ccp */
869 
870                 if (!ossl_cmp_X509_STORE_add1_certs(ctx->trusted, certs, 0))
871                     /* adds both self-issued and not self-issued certs */
872                     return 0;
873             }
874             break;
875         default:
876             break;
877         }
878     }
879     return 1;
880 }
881 
ossl_cmp_verify_popo(const OSSL_CMP_CTX * ctx,const OSSL_CMP_MSG * msg,int acceptRAVerified)882 int ossl_cmp_verify_popo(const OSSL_CMP_CTX *ctx,
883     const OSSL_CMP_MSG *msg, int acceptRAVerified)
884 {
885     if (!ossl_assert(msg != NULL && msg->body != NULL))
886         return 0;
887     switch (msg->body->type) {
888     case OSSL_CMP_PKIBODY_P10CR: {
889         X509_REQ *req = msg->body->value.p10cr;
890 
891         if (X509_REQ_verify_ex(req, X509_REQ_get0_pubkey(req), ctx->libctx,
892                 ctx->propq)
893             <= 0) {
894 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
895             ERR_raise(ERR_LIB_CMP, CMP_R_REQUEST_NOT_ACCEPTED);
896             return 0;
897 #endif
898         }
899     } break;
900     case OSSL_CMP_PKIBODY_IR:
901     case OSSL_CMP_PKIBODY_CR:
902     case OSSL_CMP_PKIBODY_KUR:
903         if (!OSSL_CRMF_MSGS_verify_popo(msg->body->value.ir, OSSL_CMP_CERTREQID,
904                 acceptRAVerified,
905                 ctx->libctx, ctx->propq)) {
906 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
907             return 0;
908 #endif
909         }
910         break;
911     default:
912         ERR_raise(ERR_LIB_CMP, CMP_R_PKIBODY_ERROR);
913         return 0;
914     }
915     return 1;
916 }
917