xref: /freebsd/crypto/openssl/ssl/quic/quic_obj.c (revision e7be843b4a162e68651d3911f0357ed464915629)
1*e7be843bSPierre Pronchery /*
2*e7be843bSPierre Pronchery  * Copyright 2024-2025 The OpenSSL Project Authors. All Rights Reserved.
3*e7be843bSPierre Pronchery  *
4*e7be843bSPierre Pronchery  * Licensed under the Apache License 2.0 (the "License").  You may not use
5*e7be843bSPierre Pronchery  * this file except in compliance with the License.  You can obtain a copy
6*e7be843bSPierre Pronchery  * in the file LICENSE in the source distribution or at
7*e7be843bSPierre Pronchery  * https://www.openssl.org/source/license.html
8*e7be843bSPierre Pronchery  */
9*e7be843bSPierre Pronchery 
10*e7be843bSPierre Pronchery #include "quic_obj_local.h"
11*e7be843bSPierre Pronchery #include "quic_local.h"
12*e7be843bSPierre Pronchery #include "internal/ssl_unwrap.h"
13*e7be843bSPierre Pronchery 
14*e7be843bSPierre Pronchery static int obj_update_cache(QUIC_OBJ *obj);
15*e7be843bSPierre Pronchery 
ossl_quic_obj_init(QUIC_OBJ * obj,SSL_CTX * ctx,int type,SSL * parent_obj,QUIC_ENGINE * engine,QUIC_PORT * port)16*e7be843bSPierre Pronchery int ossl_quic_obj_init(QUIC_OBJ *obj,
17*e7be843bSPierre Pronchery                        SSL_CTX *ctx,
18*e7be843bSPierre Pronchery                        int type,
19*e7be843bSPierre Pronchery                        SSL *parent_obj,
20*e7be843bSPierre Pronchery                        QUIC_ENGINE *engine,
21*e7be843bSPierre Pronchery                        QUIC_PORT *port)
22*e7be843bSPierre Pronchery {
23*e7be843bSPierre Pronchery     int is_event_leader = (engine != NULL);
24*e7be843bSPierre Pronchery     int is_port_leader  = (port != NULL);
25*e7be843bSPierre Pronchery 
26*e7be843bSPierre Pronchery     if (!ossl_assert(obj != NULL && !obj->init_done && SSL_TYPE_IS_QUIC(type)
27*e7be843bSPierre Pronchery                      && (parent_obj == NULL || IS_QUIC(parent_obj))))
28*e7be843bSPierre Pronchery         return 0;
29*e7be843bSPierre Pronchery 
30*e7be843bSPierre Pronchery     /* Event leader is always the root object. */
31*e7be843bSPierre Pronchery     if (!ossl_assert(!is_event_leader || parent_obj == NULL))
32*e7be843bSPierre Pronchery         return 0;
33*e7be843bSPierre Pronchery 
34*e7be843bSPierre Pronchery     if (!ossl_ssl_init(&obj->ssl, ctx, ctx->method, type))
35*e7be843bSPierre Pronchery         goto err;
36*e7be843bSPierre Pronchery 
37*e7be843bSPierre Pronchery     obj->domain_flags       = ctx->domain_flags;
38*e7be843bSPierre Pronchery     obj->parent_obj         = (QUIC_OBJ *)parent_obj;
39*e7be843bSPierre Pronchery     obj->is_event_leader    = is_event_leader;
40*e7be843bSPierre Pronchery     obj->is_port_leader     = is_port_leader;
41*e7be843bSPierre Pronchery     obj->engine             = engine;
42*e7be843bSPierre Pronchery     obj->port               = port;
43*e7be843bSPierre Pronchery     obj->req_blocking_mode  = QUIC_BLOCKING_MODE_INHERIT;
44*e7be843bSPierre Pronchery     if (!obj_update_cache(obj))
45*e7be843bSPierre Pronchery         goto err;
46*e7be843bSPierre Pronchery 
47*e7be843bSPierre Pronchery     obj->init_done          = 1;
48*e7be843bSPierre Pronchery     return 1;
49*e7be843bSPierre Pronchery 
50*e7be843bSPierre Pronchery err:
51*e7be843bSPierre Pronchery     obj->is_event_leader = 0;
52*e7be843bSPierre Pronchery     obj->is_port_leader  = 0;
53*e7be843bSPierre Pronchery     return 0;
54*e7be843bSPierre Pronchery }
55*e7be843bSPierre Pronchery 
obj_update_cache(QUIC_OBJ * obj)56*e7be843bSPierre Pronchery static int obj_update_cache(QUIC_OBJ *obj)
57*e7be843bSPierre Pronchery {
58*e7be843bSPierre Pronchery     QUIC_OBJ *p;
59*e7be843bSPierre Pronchery 
60*e7be843bSPierre Pronchery     for (p = obj; p != NULL && !p->is_event_leader;
61*e7be843bSPierre Pronchery          p = p->parent_obj)
62*e7be843bSPierre Pronchery         if (!ossl_assert(p == obj || p->init_done))
63*e7be843bSPierre Pronchery             return 0;
64*e7be843bSPierre Pronchery 
65*e7be843bSPierre Pronchery     if (!ossl_assert(p != NULL))
66*e7be843bSPierre Pronchery         return 0;
67*e7be843bSPierre Pronchery 
68*e7be843bSPierre Pronchery     /*
69*e7be843bSPierre Pronchery      * Offset of ->ssl is guaranteed to be 0 but the NULL check makes ubsan
70*e7be843bSPierre Pronchery      * happy.
71*e7be843bSPierre Pronchery      */
72*e7be843bSPierre Pronchery     obj->cached_event_leader    = p;
73*e7be843bSPierre Pronchery     obj->engine                 = p->engine;
74*e7be843bSPierre Pronchery 
75*e7be843bSPierre Pronchery     for (p = obj; p != NULL && !p->is_port_leader;
76*e7be843bSPierre Pronchery          p = p->parent_obj);
77*e7be843bSPierre Pronchery 
78*e7be843bSPierre Pronchery     obj->cached_port_leader     = p;
79*e7be843bSPierre Pronchery     obj->port                   = (p != NULL) ? p->port : NULL;
80*e7be843bSPierre Pronchery     return 1;
81*e7be843bSPierre Pronchery }
82*e7be843bSPierre Pronchery 
ossl_quic_obj_get0_handshake_layer(QUIC_OBJ * obj)83*e7be843bSPierre Pronchery SSL_CONNECTION *ossl_quic_obj_get0_handshake_layer(QUIC_OBJ *obj)
84*e7be843bSPierre Pronchery {
85*e7be843bSPierre Pronchery     assert(obj != NULL && obj->init_done);
86*e7be843bSPierre Pronchery 
87*e7be843bSPierre Pronchery     if (obj->ssl.type != SSL_TYPE_QUIC_CONNECTION)
88*e7be843bSPierre Pronchery         return NULL;
89*e7be843bSPierre Pronchery 
90*e7be843bSPierre Pronchery     return SSL_CONNECTION_FROM_SSL_ONLY(((QUIC_CONNECTION *)obj)->tls);
91*e7be843bSPierre Pronchery }
92*e7be843bSPierre Pronchery 
93*e7be843bSPierre Pronchery /* (Returns a cached result.) */
ossl_quic_obj_can_support_blocking(const QUIC_OBJ * obj)94*e7be843bSPierre Pronchery int ossl_quic_obj_can_support_blocking(const QUIC_OBJ *obj)
95*e7be843bSPierre Pronchery {
96*e7be843bSPierre Pronchery     QUIC_REACTOR *rtor;
97*e7be843bSPierre Pronchery 
98*e7be843bSPierre Pronchery     assert(obj != NULL);
99*e7be843bSPierre Pronchery     rtor = ossl_quic_obj_get0_reactor(obj);
100*e7be843bSPierre Pronchery 
101*e7be843bSPierre Pronchery     if ((obj->domain_flags
102*e7be843bSPierre Pronchery             & (SSL_DOMAIN_FLAG_LEGACY_BLOCKING | SSL_DOMAIN_FLAG_BLOCKING)) == 0)
103*e7be843bSPierre Pronchery         return 0;
104*e7be843bSPierre Pronchery 
105*e7be843bSPierre Pronchery     return ossl_quic_reactor_can_poll_r(rtor)
106*e7be843bSPierre Pronchery         || ossl_quic_reactor_can_poll_w(rtor);
107*e7be843bSPierre Pronchery }
108*e7be843bSPierre Pronchery 
ossl_quic_obj_desires_blocking(const QUIC_OBJ * obj)109*e7be843bSPierre Pronchery int ossl_quic_obj_desires_blocking(const QUIC_OBJ *obj)
110*e7be843bSPierre Pronchery {
111*e7be843bSPierre Pronchery     unsigned int req_blocking_mode;
112*e7be843bSPierre Pronchery 
113*e7be843bSPierre Pronchery     assert(obj != NULL);
114*e7be843bSPierre Pronchery     for (; (req_blocking_mode = obj->req_blocking_mode) == QUIC_BLOCKING_MODE_INHERIT
115*e7be843bSPierre Pronchery            && obj->parent_obj != NULL; obj = obj->parent_obj);
116*e7be843bSPierre Pronchery 
117*e7be843bSPierre Pronchery     return req_blocking_mode != QUIC_BLOCKING_MODE_NONBLOCKING;
118*e7be843bSPierre Pronchery }
119*e7be843bSPierre Pronchery 
ossl_quic_obj_blocking(const QUIC_OBJ * obj)120*e7be843bSPierre Pronchery int ossl_quic_obj_blocking(const QUIC_OBJ *obj)
121*e7be843bSPierre Pronchery {
122*e7be843bSPierre Pronchery     assert(obj != NULL);
123*e7be843bSPierre Pronchery 
124*e7be843bSPierre Pronchery     if (!ossl_quic_obj_desires_blocking(obj))
125*e7be843bSPierre Pronchery         return 0;
126*e7be843bSPierre Pronchery 
127*e7be843bSPierre Pronchery     ossl_quic_engine_update_poll_descriptors(ossl_quic_obj_get0_engine(obj),
128*e7be843bSPierre Pronchery                                              /*force=*/0);
129*e7be843bSPierre Pronchery     return ossl_quic_obj_can_support_blocking(obj);
130*e7be843bSPierre Pronchery }
131*e7be843bSPierre Pronchery 
ossl_quic_obj_set_blocking_mode(QUIC_OBJ * obj,unsigned int mode)132*e7be843bSPierre Pronchery void ossl_quic_obj_set_blocking_mode(QUIC_OBJ *obj, unsigned int mode)
133*e7be843bSPierre Pronchery {
134*e7be843bSPierre Pronchery     assert(obj != NULL);
135*e7be843bSPierre Pronchery 
136*e7be843bSPierre Pronchery     obj->req_blocking_mode = mode;
137*e7be843bSPierre Pronchery }
138