Coverage Report

Created: 2025-08-03 07:12

/src/openssl/ssl/quic/quic_channel.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2022-2025 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#include <openssl/rand.h>
11
#include <openssl/err.h>
12
#include "internal/ssl_unwrap.h"
13
#include "internal/quic_channel.h"
14
#include "internal/quic_error.h"
15
#include "internal/quic_rx_depack.h"
16
#include "internal/quic_lcidm.h"
17
#include "internal/quic_srtm.h"
18
#include "internal/qlog_event_helpers.h"
19
#include "internal/quic_txp.h"
20
#include "internal/quic_tls.h"
21
#include "internal/quic_ssl.h"
22
#include "../ssl_local.h"
23
#include "quic_channel_local.h"
24
#include "quic_port_local.h"
25
#include "quic_engine_local.h"
26
27
0
#define INIT_CRYPTO_RECV_BUF_LEN    16384
28
0
#define INIT_CRYPTO_SEND_BUF_LEN    16384
29
0
#define INIT_APP_BUF_LEN             8192
30
31
/*
32
 * Interval before we force a PING to ensure NATs don't timeout. This is based
33
 * on the lowest commonly seen value of 30 seconds as cited in RFC 9000 s.
34
 * 10.1.2.
35
 */
36
0
#define MAX_NAT_INTERVAL (ossl_ms2time(25000))
37
38
/*
39
 * Our maximum ACK delay on the TX side. This is up to us to choose. Note that
40
 * this could differ from QUIC_DEFAULT_MAX_DELAY in future as that is a protocol
41
 * value which determines the value of the maximum ACK delay if the
42
 * max_ack_delay transport parameter is not set.
43
 */
44
0
#define DEFAULT_MAX_ACK_DELAY   QUIC_DEFAULT_MAX_ACK_DELAY
45
46
DEFINE_LIST_OF_IMPL(ch, QUIC_CHANNEL);
47
48
static void ch_save_err_state(QUIC_CHANNEL *ch);
49
static int ch_rx(QUIC_CHANNEL *ch, int channel_only, int *notify_other_threads);
50
static int ch_tx(QUIC_CHANNEL *ch, int *notify_other_threads);
51
static int ch_tick_tls(QUIC_CHANNEL *ch, int channel_only, int *notify_other_threads);
52
static void ch_rx_handle_packet(QUIC_CHANNEL *ch, int channel_only);
53
static OSSL_TIME ch_determine_next_tick_deadline(QUIC_CHANNEL *ch);
54
static int ch_retry(QUIC_CHANNEL *ch,
55
                    const unsigned char *retry_token,
56
                    size_t retry_token_len,
57
                    const QUIC_CONN_ID *retry_scid,
58
                    int drop_later_pn);
59
static int ch_restart(QUIC_CHANNEL *ch);
60
61
static void ch_cleanup(QUIC_CHANNEL *ch);
62
static int ch_generate_transport_params(QUIC_CHANNEL *ch);
63
static int ch_on_transport_params(const unsigned char *params,
64
                                  size_t params_len,
65
                                  void *arg);
66
static int ch_on_handshake_alert(void *arg, unsigned char alert_code);
67
static int ch_on_handshake_complete(void *arg);
68
static int ch_on_handshake_yield_secret(uint32_t prot_level, int direction,
69
                                        uint32_t suite_id, EVP_MD *md,
70
                                        const unsigned char *secret,
71
                                        size_t secret_len,
72
                                        void *arg);
73
static int ch_on_crypto_recv_record(const unsigned char **buf,
74
                                    size_t *bytes_read, void *arg);
75
static int ch_on_crypto_release_record(size_t bytes_read, void *arg);
76
static int crypto_ensure_empty(QUIC_RSTREAM *rstream);
77
static int ch_on_crypto_send(const unsigned char *buf, size_t buf_len,
78
                             size_t *consumed, void *arg);
79
static OSSL_TIME get_time(void *arg);
80
static uint64_t get_stream_limit(int uni, void *arg);
81
static int rx_late_validate(QUIC_PN pn, int pn_space, void *arg);
82
static void rxku_detected(QUIC_PN pn, void *arg);
83
static int ch_retry(QUIC_CHANNEL *ch,
84
                    const unsigned char *retry_token,
85
                    size_t retry_token_len,
86
                    const QUIC_CONN_ID *retry_scid,
87
                    int drop_later_pn);
88
static void ch_update_idle(QUIC_CHANNEL *ch);
89
static int ch_discard_el(QUIC_CHANNEL *ch,
90
                         uint32_t enc_level);
91
static void ch_on_idle_timeout(QUIC_CHANNEL *ch);
92
static void ch_update_idle(QUIC_CHANNEL *ch);
93
static void ch_update_ping_deadline(QUIC_CHANNEL *ch);
94
static void ch_on_terminating_timeout(QUIC_CHANNEL *ch);
95
static void ch_start_terminating(QUIC_CHANNEL *ch,
96
                                 const QUIC_TERMINATE_CAUSE *tcause,
97
                                 int force_immediate);
98
static void ch_on_txp_ack_tx(const OSSL_QUIC_FRAME_ACK *ack, uint32_t pn_space,
99
                             void *arg);
100
static void ch_rx_handle_version_neg(QUIC_CHANNEL *ch, OSSL_QRX_PKT *pkt);
101
static void ch_raise_version_neg_failure(QUIC_CHANNEL *ch);
102
static void ch_record_state_transition(QUIC_CHANNEL *ch, uint32_t new_state);
103
104
DEFINE_LHASH_OF_EX(QUIC_SRT_ELEM);
105
106
QUIC_NEEDS_LOCK
107
static QLOG *ch_get_qlog(QUIC_CHANNEL *ch)
108
0
{
109
0
#ifndef OPENSSL_NO_QLOG
110
0
    QLOG_TRACE_INFO qti = {0};
111
112
0
    if (ch->qlog != NULL)
113
0
        return ch->qlog;
114
115
0
    if (!ch->use_qlog)
116
0
        return NULL;
117
118
0
    if (ch->is_server && ch->init_dcid.id_len == 0)
119
0
        return NULL;
120
121
0
    qti.odcid       = ch->init_dcid;
122
0
    qti.title       = ch->qlog_title;
123
0
    qti.description = NULL;
124
0
    qti.group_id    = NULL;
125
0
    qti.is_server   = ch->is_server;
126
0
    qti.now_cb      = get_time;
127
0
    qti.now_cb_arg  = ch;
128
0
    if ((ch->qlog = ossl_qlog_new_from_env(&qti)) == NULL) {
129
0
        ch->use_qlog = 0; /* don't try again */
130
0
        return NULL;
131
0
    }
132
133
0
    return ch->qlog;
134
#else
135
    return NULL;
136
#endif
137
0
}
138
139
QUIC_NEEDS_LOCK
140
static QLOG *ch_get_qlog_cb(void *arg)
141
0
{
142
0
    QUIC_CHANNEL *ch = arg;
143
144
0
    return ch_get_qlog(ch);
145
0
}
146
147
/*
148
 * QUIC Channel Initialization and Teardown
149
 * ========================================
150
 */
151
0
#define DEFAULT_INIT_CONN_RXFC_WND      (768 * 1024)
152
0
#define DEFAULT_CONN_RXFC_MAX_WND_MUL   20
153
154
0
#define DEFAULT_INIT_STREAM_RXFC_WND    (512 * 1024)
155
0
#define DEFAULT_STREAM_RXFC_MAX_WND_MUL 12
156
157
0
#define DEFAULT_INIT_CONN_MAX_STREAMS           100
158
159
static int ch_init(QUIC_CHANNEL *ch)
160
0
{
161
0
    OSSL_QUIC_TX_PACKETISER_ARGS txp_args = {0};
162
0
    OSSL_QTX_ARGS qtx_args = {0};
163
0
    OSSL_QRX_ARGS qrx_args = {0};
164
0
    QUIC_TLS_ARGS tls_args = {0};
165
0
    uint32_t pn_space;
166
0
    size_t rx_short_dcid_len;
167
0
    size_t tx_init_dcid_len;
168
169
0
    if (ch->port == NULL || ch->lcidm == NULL || ch->srtm == NULL)
170
0
        goto err;
171
172
0
    rx_short_dcid_len = ossl_quic_port_get_rx_short_dcid_len(ch->port);
173
0
    tx_init_dcid_len = ossl_quic_port_get_tx_init_dcid_len(ch->port);
174
175
    /* For clients, generate our initial DCID. */
176
0
    if (!ch->is_server
177
0
        && !ossl_quic_gen_rand_conn_id(ch->port->engine->libctx, tx_init_dcid_len,
178
0
                                       &ch->init_dcid))
179
0
        goto err;
180
181
    /* We plug in a network write BIO to the QTX later when we get one. */
182
0
    qtx_args.libctx             = ch->port->engine->libctx;
183
0
    qtx_args.get_qlog_cb        = ch_get_qlog_cb;
184
0
    qtx_args.get_qlog_cb_arg    = ch;
185
0
    qtx_args.mdpl               = QUIC_MIN_INITIAL_DGRAM_LEN;
186
0
    ch->rx_max_udp_payload_size = qtx_args.mdpl;
187
188
0
    ch->ping_deadline = ossl_time_infinite();
189
190
0
    ch->qtx = ossl_qtx_new(&qtx_args);
191
0
    if (ch->qtx == NULL)
192
0
        goto err;
193
194
0
    ch->txpim = ossl_quic_txpim_new();
195
0
    if (ch->txpim == NULL)
196
0
        goto err;
197
198
0
    ch->cfq = ossl_quic_cfq_new();
199
0
    if (ch->cfq == NULL)
200
0
        goto err;
201
202
0
    if (!ossl_quic_txfc_init(&ch->conn_txfc, NULL))
203
0
        goto err;
204
205
    /*
206
     * Note: The TP we transmit governs what the peer can transmit and thus
207
     * applies to the RXFC.
208
     */
209
0
    ch->tx_init_max_stream_data_bidi_local  = DEFAULT_INIT_STREAM_RXFC_WND;
210
0
    ch->tx_init_max_stream_data_bidi_remote = DEFAULT_INIT_STREAM_RXFC_WND;
211
0
    ch->tx_init_max_stream_data_uni         = DEFAULT_INIT_STREAM_RXFC_WND;
212
213
0
    if (!ossl_quic_rxfc_init(&ch->conn_rxfc, NULL,
214
0
                             DEFAULT_INIT_CONN_RXFC_WND,
215
0
                             DEFAULT_CONN_RXFC_MAX_WND_MUL *
216
0
                             DEFAULT_INIT_CONN_RXFC_WND,
217
0
                             get_time, ch))
218
0
        goto err;
219
220
0
    for (pn_space = QUIC_PN_SPACE_INITIAL; pn_space < QUIC_PN_SPACE_NUM; ++pn_space)
221
0
        if (!ossl_quic_rxfc_init_standalone(&ch->crypto_rxfc[pn_space],
222
0
                                            INIT_CRYPTO_RECV_BUF_LEN,
223
0
                                            get_time, ch))
224
0
            goto err;
225
226
0
    if (!ossl_quic_rxfc_init_standalone(&ch->max_streams_bidi_rxfc,
227
0
                                        DEFAULT_INIT_CONN_MAX_STREAMS,
228
0
                                        get_time, ch))
229
0
        goto err;
230
231
0
    if (!ossl_quic_rxfc_init_standalone(&ch->max_streams_uni_rxfc,
232
0
                                        DEFAULT_INIT_CONN_MAX_STREAMS,
233
0
                                        get_time, ch))
234
0
        goto err;
235
236
0
    if (!ossl_statm_init(&ch->statm))
237
0
        goto err;
238
239
0
    ch->have_statm = 1;
240
0
    ch->cc_method = &ossl_cc_newreno_method;
241
0
    if ((ch->cc_data = ch->cc_method->new(get_time, ch)) == NULL)
242
0
        goto err;
243
244
0
    if ((ch->ackm = ossl_ackm_new(get_time, ch, &ch->statm,
245
0
                                  ch->cc_method, ch->cc_data,
246
0
                                  ch->is_server)) == NULL)
247
0
        goto err;
248
249
0
    if (!ossl_quic_stream_map_init(&ch->qsm, get_stream_limit, ch,
250
0
                                   &ch->max_streams_bidi_rxfc,
251
0
                                   &ch->max_streams_uni_rxfc,
252
0
                                   ch->is_server))
253
0
        goto err;
254
255
0
    ch->have_qsm = 1;
256
257
0
    if (!ch->is_server
258
0
        && !ossl_quic_lcidm_generate_initial(ch->lcidm, ch, &ch->init_scid))
259
0
        goto err;
260
261
0
    txp_args.cur_scid               = ch->init_scid;
262
0
    txp_args.cur_dcid               = ch->init_dcid;
263
0
    txp_args.ack_delay_exponent     = 3;
264
0
    txp_args.qtx                    = ch->qtx;
265
0
    txp_args.txpim                  = ch->txpim;
266
0
    txp_args.cfq                    = ch->cfq;
267
0
    txp_args.ackm                   = ch->ackm;
268
0
    txp_args.qsm                    = &ch->qsm;
269
0
    txp_args.conn_txfc              = &ch->conn_txfc;
270
0
    txp_args.conn_rxfc              = &ch->conn_rxfc;
271
0
    txp_args.max_streams_bidi_rxfc  = &ch->max_streams_bidi_rxfc;
272
0
    txp_args.max_streams_uni_rxfc   = &ch->max_streams_uni_rxfc;
273
0
    txp_args.cc_method              = ch->cc_method;
274
0
    txp_args.cc_data                = ch->cc_data;
275
0
    txp_args.now                    = get_time;
276
0
    txp_args.now_arg                = ch;
277
0
    txp_args.get_qlog_cb            = ch_get_qlog_cb;
278
0
    txp_args.get_qlog_cb_arg        = ch;
279
0
    txp_args.protocol_version       = QUIC_VERSION_1;
280
281
0
    for (pn_space = QUIC_PN_SPACE_INITIAL; pn_space < QUIC_PN_SPACE_NUM; ++pn_space) {
282
0
        ch->crypto_send[pn_space] = ossl_quic_sstream_new(INIT_CRYPTO_SEND_BUF_LEN);
283
0
        if (ch->crypto_send[pn_space] == NULL)
284
0
            goto err;
285
286
0
        txp_args.crypto[pn_space] = ch->crypto_send[pn_space];
287
0
    }
288
289
0
    ch->txp = ossl_quic_tx_packetiser_new(&txp_args);
290
0
    if (ch->txp == NULL)
291
0
        goto err;
292
293
    /* clients have no amplification limit, so are considered always valid */
294
0
    if (!ch->is_server)
295
0
        ossl_quic_tx_packetiser_set_validated(ch->txp);
296
297
0
    ossl_quic_tx_packetiser_set_ack_tx_cb(ch->txp, ch_on_txp_ack_tx, ch);
298
299
    /*
300
     * qrx does not exist yet, then we must be dealing with client channel
301
     * (QUIC connection initiator).
302
     * If qrx exists already, then we are dealing with server channel which
303
     * qrx gets created by port_default_packet_handler() before
304
     * port_default_packet_handler() accepts connection and creates channel
305
     * for it.
306
     * The exception here is tserver which always creates channel,
307
     * before the first packet is ever seen.
308
     */
309
0
    if (ch->qrx == NULL && ch->is_tserver_ch == 0) {
310
        /* we are regular client, create channel */
311
0
        qrx_args.libctx             = ch->port->engine->libctx;
312
0
        qrx_args.demux              = ch->port->demux;
313
0
        qrx_args.short_conn_id_len  = rx_short_dcid_len;
314
0
        qrx_args.max_deferred       = 32;
315
316
0
        if ((ch->qrx = ossl_qrx_new(&qrx_args)) == NULL)
317
0
            goto err;
318
0
    }
319
320
0
    if (ch->qrx != NULL) {
321
        /*
322
         * callbacks for channels associated with tserver's port
323
         * are set up later when we call ossl_quic_channel_bind_qrx()
324
         * in port_default_packet_handler()
325
         */
326
0
        if (!ossl_qrx_set_late_validation_cb(ch->qrx,
327
0
                                             rx_late_validate,
328
0
                                             ch))
329
0
            goto err;
330
331
0
        if (!ossl_qrx_set_key_update_cb(ch->qrx,
332
0
                                        rxku_detected,
333
0
                                        ch))
334
0
            goto err;
335
0
    }
336
337
338
0
    for (pn_space = QUIC_PN_SPACE_INITIAL; pn_space < QUIC_PN_SPACE_NUM; ++pn_space) {
339
0
        ch->crypto_recv[pn_space] = ossl_quic_rstream_new(NULL, NULL, 0);
340
0
        if (ch->crypto_recv[pn_space] == NULL)
341
0
            goto err;
342
0
    }
343
344
    /* Plug in the TLS handshake layer. */
345
0
    tls_args.s                          = ch->tls;
346
0
    tls_args.crypto_send_cb             = ch_on_crypto_send;
347
0
    tls_args.crypto_send_cb_arg         = ch;
348
0
    tls_args.crypto_recv_rcd_cb         = ch_on_crypto_recv_record;
349
0
    tls_args.crypto_recv_rcd_cb_arg     = ch;
350
0
    tls_args.crypto_release_rcd_cb      = ch_on_crypto_release_record;
351
0
    tls_args.crypto_release_rcd_cb_arg  = ch;
352
0
    tls_args.yield_secret_cb            = ch_on_handshake_yield_secret;
353
0
    tls_args.yield_secret_cb_arg        = ch;
354
0
    tls_args.got_transport_params_cb    = ch_on_transport_params;
355
0
    tls_args.got_transport_params_cb_arg= ch;
356
0
    tls_args.handshake_complete_cb      = ch_on_handshake_complete;
357
0
    tls_args.handshake_complete_cb_arg  = ch;
358
0
    tls_args.alert_cb                   = ch_on_handshake_alert;
359
0
    tls_args.alert_cb_arg               = ch;
360
0
    tls_args.is_server                  = ch->is_server;
361
0
    tls_args.ossl_quic                  = 1;
362
363
0
    if ((ch->qtls = ossl_quic_tls_new(&tls_args)) == NULL)
364
0
        goto err;
365
366
0
    ch->tx_max_ack_delay        = DEFAULT_MAX_ACK_DELAY;
367
0
    ch->rx_max_ack_delay        = QUIC_DEFAULT_MAX_ACK_DELAY;
368
0
    ch->rx_ack_delay_exp        = QUIC_DEFAULT_ACK_DELAY_EXP;
369
0
    ch->rx_active_conn_id_limit = QUIC_MIN_ACTIVE_CONN_ID_LIMIT;
370
0
    ch->tx_enc_level            = QUIC_ENC_LEVEL_INITIAL;
371
0
    ch->rx_enc_level            = QUIC_ENC_LEVEL_INITIAL;
372
0
    ch->txku_threshold_override = UINT64_MAX;
373
374
0
    ch->max_idle_timeout_local_req  = QUIC_DEFAULT_IDLE_TIMEOUT;
375
0
    ch->max_idle_timeout_remote_req = 0;
376
0
    ch->max_idle_timeout            = ch->max_idle_timeout_local_req;
377
378
0
    ossl_ackm_set_tx_max_ack_delay(ch->ackm, ossl_ms2time(ch->tx_max_ack_delay));
379
0
    ossl_ackm_set_rx_max_ack_delay(ch->ackm, ossl_ms2time(ch->rx_max_ack_delay));
380
381
0
    ch_update_idle(ch);
382
0
    ossl_list_ch_insert_tail(&ch->port->channel_list, ch);
383
0
    ch->on_port_list = 1;
384
0
    return 1;
385
386
0
err:
387
0
    ch_cleanup(ch);
388
0
    return 0;
389
0
}
390
391
static void ch_cleanup(QUIC_CHANNEL *ch)
392
0
{
393
0
    uint32_t pn_space;
394
395
0
    if (ch->ackm != NULL)
396
0
        for (pn_space = QUIC_PN_SPACE_INITIAL;
397
0
             pn_space < QUIC_PN_SPACE_NUM;
398
0
             ++pn_space)
399
0
            ossl_ackm_on_pkt_space_discarded(ch->ackm, pn_space);
400
401
0
    ossl_quic_lcidm_cull(ch->lcidm, ch);
402
0
    ossl_quic_srtm_cull(ch->srtm, ch);
403
0
    ossl_quic_tx_packetiser_free(ch->txp);
404
0
    ossl_quic_txpim_free(ch->txpim);
405
0
    ossl_quic_cfq_free(ch->cfq);
406
0
    ossl_qtx_free(ch->qtx);
407
0
    if (ch->cc_data != NULL)
408
0
        ch->cc_method->free(ch->cc_data);
409
0
    if (ch->have_statm)
410
0
        ossl_statm_destroy(&ch->statm);
411
0
    ossl_ackm_free(ch->ackm);
412
413
0
    if (ch->have_qsm)
414
0
        ossl_quic_stream_map_cleanup(&ch->qsm);
415
416
0
    for (pn_space = QUIC_PN_SPACE_INITIAL; pn_space < QUIC_PN_SPACE_NUM; ++pn_space) {
417
0
        ossl_quic_sstream_free(ch->crypto_send[pn_space]);
418
0
        ossl_quic_rstream_free(ch->crypto_recv[pn_space]);
419
0
    }
420
421
0
    ossl_qrx_pkt_release(ch->qrx_pkt);
422
0
    ch->qrx_pkt = NULL;
423
424
0
    ossl_quic_tls_free(ch->qtls);
425
0
    ossl_qrx_free(ch->qrx);
426
0
    OPENSSL_free(ch->local_transport_params);
427
0
    OPENSSL_free((char *)ch->terminate_cause.reason);
428
0
    OSSL_ERR_STATE_free(ch->err_state);
429
0
    OPENSSL_free(ch->ack_range_scratch);
430
0
    OPENSSL_free(ch->pending_new_token);
431
432
0
    if (ch->on_port_list) {
433
0
        ossl_list_ch_remove(&ch->port->channel_list, ch);
434
0
        ch->on_port_list = 0;
435
0
    }
436
437
0
#ifndef OPENSSL_NO_QLOG
438
0
    if (ch->qlog != NULL)
439
0
        ossl_qlog_flush(ch->qlog); /* best effort */
440
441
0
    OPENSSL_free(ch->qlog_title);
442
0
    ossl_qlog_free(ch->qlog);
443
0
#endif
444
0
}
445
446
int ossl_quic_channel_init(QUIC_CHANNEL *ch)
447
0
{
448
0
    return ch_init(ch);
449
0
}
450
451
void ossl_quic_channel_bind_qrx(QUIC_CHANNEL *tserver_ch, OSSL_QRX *qrx)
452
0
{
453
0
    if (tserver_ch->qrx == NULL && tserver_ch->is_tserver_ch == 1) {
454
0
        tserver_ch->qrx = qrx;
455
0
        ossl_qrx_set_late_validation_cb(tserver_ch->qrx, rx_late_validate,
456
0
                                        tserver_ch);
457
0
        ossl_qrx_set_key_update_cb(tserver_ch->qrx, rxku_detected,
458
0
                                   tserver_ch);
459
0
    }
460
0
}
461
462
QUIC_CHANNEL *ossl_quic_channel_alloc(const QUIC_CHANNEL_ARGS *args)
463
0
{
464
0
    QUIC_CHANNEL *ch = NULL;
465
466
0
    if ((ch = OPENSSL_zalloc(sizeof(*ch))) == NULL)
467
0
        return NULL;
468
469
0
    ch->port           = args->port;
470
0
    ch->is_server      = args->is_server;
471
0
    ch->tls            = args->tls;
472
0
    ch->lcidm          = args->lcidm;
473
0
    ch->srtm           = args->srtm;
474
0
    ch->qrx            = args->qrx;
475
0
    ch->is_tserver_ch  = args->is_tserver_ch;
476
0
#ifndef OPENSSL_NO_QLOG
477
0
    ch->use_qlog    = args->use_qlog;
478
479
0
    if (ch->use_qlog && args->qlog_title != NULL) {
480
0
        if ((ch->qlog_title = OPENSSL_strdup(args->qlog_title)) == NULL) {
481
0
            OPENSSL_free(ch);
482
0
            return NULL;
483
0
        }
484
0
    }
485
0
#endif
486
487
0
    return ch;
488
0
}
489
490
void ossl_quic_channel_free(QUIC_CHANNEL *ch)
491
0
{
492
0
    if (ch == NULL)
493
0
        return;
494
495
0
    ch_cleanup(ch);
496
0
    OPENSSL_free(ch);
497
0
}
498
499
/* Set mutator callbacks for test framework support */
500
int ossl_quic_channel_set_mutator(QUIC_CHANNEL *ch,
501
                                  ossl_mutate_packet_cb mutatecb,
502
                                  ossl_finish_mutate_cb finishmutatecb,
503
                                  void *mutatearg)
504
0
{
505
0
    if (ch->qtx == NULL)
506
0
        return 0;
507
508
0
    ossl_qtx_set_mutator(ch->qtx, mutatecb, finishmutatecb, mutatearg);
509
0
    return 1;
510
0
}
511
512
int ossl_quic_channel_get_peer_addr(QUIC_CHANNEL *ch, BIO_ADDR *peer_addr)
513
0
{
514
0
    if (!ch->addressed_mode)
515
0
        return 0;
516
517
0
    return BIO_ADDR_copy(peer_addr, &ch->cur_peer_addr);
518
0
}
519
520
int ossl_quic_channel_set_peer_addr(QUIC_CHANNEL *ch, const BIO_ADDR *peer_addr)
521
0
{
522
0
    if (ch->state != QUIC_CHANNEL_STATE_IDLE)
523
0
        return 0;
524
525
0
    if (peer_addr == NULL || BIO_ADDR_family(peer_addr) == AF_UNSPEC) {
526
0
        BIO_ADDR_clear(&ch->cur_peer_addr);
527
0
        ch->addressed_mode = 0;
528
0
        return 1;
529
0
    }
530
531
0
    if (!BIO_ADDR_copy(&ch->cur_peer_addr, peer_addr)) {
532
0
        ch->addressed_mode = 0;
533
0
        return 0;
534
0
    }
535
0
    ch->addressed_mode = 1;
536
537
0
    return 1;
538
0
}
539
540
QUIC_REACTOR *ossl_quic_channel_get_reactor(QUIC_CHANNEL *ch)
541
0
{
542
0
    return ossl_quic_port_get0_reactor(ch->port);
543
0
}
544
545
QUIC_STREAM_MAP *ossl_quic_channel_get_qsm(QUIC_CHANNEL *ch)
546
0
{
547
0
    return &ch->qsm;
548
0
}
549
550
OSSL_STATM *ossl_quic_channel_get_statm(QUIC_CHANNEL *ch)
551
0
{
552
0
    return &ch->statm;
553
0
}
554
555
SSL *ossl_quic_channel_get0_tls(QUIC_CHANNEL *ch)
556
0
{
557
0
    return ch->tls;
558
0
}
559
560
static void free_buf_mem(unsigned char *buf, size_t buf_len, void *arg)
561
0
{
562
0
    BUF_MEM_free((BUF_MEM *)arg);
563
0
}
564
565
int ossl_quic_channel_schedule_new_token(QUIC_CHANNEL *ch,
566
                                         const unsigned char *token,
567
                                         size_t token_len)
568
0
{
569
0
    int rc = 0;
570
0
    QUIC_CFQ_ITEM *cfq_item;
571
0
    WPACKET wpkt;
572
0
    BUF_MEM *buf_mem = NULL;
573
0
    size_t l = 0;
574
575
0
    buf_mem = BUF_MEM_new();
576
0
    if (buf_mem == NULL)
577
0
        goto err;
578
579
0
    if (!WPACKET_init(&wpkt, buf_mem))
580
0
        goto err;
581
582
0
    if (!ossl_quic_wire_encode_frame_new_token(&wpkt, token,
583
0
                                               token_len)) {
584
0
        WPACKET_cleanup(&wpkt);
585
0
        goto err;
586
0
    }
587
588
0
    WPACKET_finish(&wpkt);
589
590
0
    if (!WPACKET_get_total_written(&wpkt, &l))
591
0
        goto err;
592
593
0
    cfq_item = ossl_quic_cfq_add_frame(ch->cfq, 1,
594
0
                                       QUIC_PN_SPACE_APP,
595
0
                                       OSSL_QUIC_FRAME_TYPE_NEW_TOKEN, 0,
596
0
                                       (unsigned char *)buf_mem->data, l,
597
0
                                       free_buf_mem,
598
0
                                       buf_mem);
599
0
    if (cfq_item == NULL)
600
0
        goto err;
601
602
0
    rc = 1;
603
0
err:
604
0
    if (!rc)
605
0
        BUF_MEM_free(buf_mem);
606
0
    return rc;
607
0
}
608
609
size_t ossl_quic_channel_get_short_header_conn_id_len(QUIC_CHANNEL *ch)
610
0
{
611
0
    return ossl_quic_port_get_rx_short_dcid_len(ch->port);
612
0
}
613
614
QUIC_STREAM *ossl_quic_channel_get_stream_by_id(QUIC_CHANNEL *ch,
615
                                                uint64_t stream_id)
616
0
{
617
0
    return ossl_quic_stream_map_get_by_id(&ch->qsm, stream_id);
618
0
}
619
620
int ossl_quic_channel_is_active(const QUIC_CHANNEL *ch)
621
0
{
622
0
    return ch != NULL && ch->state == QUIC_CHANNEL_STATE_ACTIVE;
623
0
}
624
625
int ossl_quic_channel_is_closing(const QUIC_CHANNEL *ch)
626
0
{
627
0
    return ch->state == QUIC_CHANNEL_STATE_TERMINATING_CLOSING;
628
0
}
629
630
static int ossl_quic_channel_is_draining(const QUIC_CHANNEL *ch)
631
0
{
632
0
    return ch->state == QUIC_CHANNEL_STATE_TERMINATING_DRAINING;
633
0
}
634
635
static int ossl_quic_channel_is_terminating(const QUIC_CHANNEL *ch)
636
0
{
637
0
    return ossl_quic_channel_is_closing(ch)
638
0
        || ossl_quic_channel_is_draining(ch);
639
0
}
640
641
int ossl_quic_channel_is_terminated(const QUIC_CHANNEL *ch)
642
0
{
643
0
    return ch->state == QUIC_CHANNEL_STATE_TERMINATED;
644
0
}
645
646
int ossl_quic_channel_is_term_any(const QUIC_CHANNEL *ch)
647
0
{
648
0
    return ossl_quic_channel_is_terminating(ch)
649
0
        || ossl_quic_channel_is_terminated(ch);
650
0
}
651
652
const QUIC_TERMINATE_CAUSE *
653
ossl_quic_channel_get_terminate_cause(const QUIC_CHANNEL *ch)
654
0
{
655
0
    return ossl_quic_channel_is_term_any(ch) ? &ch->terminate_cause : NULL;
656
0
}
657
658
int ossl_quic_channel_is_handshake_complete(const QUIC_CHANNEL *ch)
659
0
{
660
0
    return ch->handshake_complete;
661
0
}
662
663
int ossl_quic_channel_is_handshake_confirmed(const QUIC_CHANNEL *ch)
664
0
{
665
0
    return ch->handshake_confirmed;
666
0
}
667
668
QUIC_DEMUX *ossl_quic_channel_get0_demux(QUIC_CHANNEL *ch)
669
0
{
670
0
    return ch->port->demux;
671
0
}
672
673
QUIC_PORT *ossl_quic_channel_get0_port(QUIC_CHANNEL *ch)
674
0
{
675
0
    return ch->port;
676
0
}
677
678
QUIC_ENGINE *ossl_quic_channel_get0_engine(QUIC_CHANNEL *ch)
679
0
{
680
0
    return ossl_quic_port_get0_engine(ch->port);
681
0
}
682
683
CRYPTO_MUTEX *ossl_quic_channel_get_mutex(QUIC_CHANNEL *ch)
684
0
{
685
0
    return ossl_quic_port_get0_mutex(ch->port);
686
0
}
687
688
int ossl_quic_channel_has_pending(const QUIC_CHANNEL *ch)
689
0
{
690
0
    return ossl_quic_demux_has_pending(ch->port->demux)
691
0
        || ossl_qrx_processed_read_pending(ch->qrx);
692
0
}
693
694
/*
695
 * QUIC Channel: Callbacks from Miscellaneous Subsidiary Components
696
 * ================================================================
697
 */
698
699
/* Used by various components. */
700
static OSSL_TIME get_time(void *arg)
701
0
{
702
0
    QUIC_CHANNEL *ch = arg;
703
704
0
    return ossl_quic_port_get_time(ch->port);
705
0
}
706
707
/* Used by QSM. */
708
static uint64_t get_stream_limit(int uni, void *arg)
709
0
{
710
0
    QUIC_CHANNEL *ch = arg;
711
712
0
    return uni ? ch->max_local_streams_uni : ch->max_local_streams_bidi;
713
0
}
714
715
/*
716
 * Called by QRX to determine if a packet is potentially invalid before trying
717
 * to decrypt it.
718
 */
719
static int rx_late_validate(QUIC_PN pn, int pn_space, void *arg)
720
0
{
721
0
    QUIC_CHANNEL *ch = arg;
722
723
    /* Potential duplicates should not be processed. */
724
0
    if (!ossl_ackm_is_rx_pn_processable(ch->ackm, pn, pn_space))
725
0
        return 0;
726
727
0
    return 1;
728
0
}
729
730
/*
731
 * Triggers a TXKU (whether spontaneous or solicited). Does not check whether
732
 * spontaneous TXKU is currently allowed.
733
 */
734
QUIC_NEEDS_LOCK
735
static void ch_trigger_txku(QUIC_CHANNEL *ch)
736
0
{
737
0
    uint64_t next_pn
738
0
        = ossl_quic_tx_packetiser_get_next_pn(ch->txp, QUIC_PN_SPACE_APP);
739
740
0
    if (!ossl_quic_pn_valid(next_pn)
741
0
        || !ossl_qtx_trigger_key_update(ch->qtx)) {
742
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR, 0,
743
0
                                               "key update");
744
0
        return;
745
0
    }
746
747
0
    ch->txku_in_progress    = 1;
748
0
    ch->txku_pn             = next_pn;
749
0
    ch->rxku_expected       = ch->ku_locally_initiated;
750
0
}
751
752
QUIC_NEEDS_LOCK
753
static int txku_in_progress(QUIC_CHANNEL *ch)
754
0
{
755
0
    if (ch->txku_in_progress
756
0
        && ossl_ackm_get_largest_acked(ch->ackm, QUIC_PN_SPACE_APP) >= ch->txku_pn) {
757
0
        OSSL_TIME pto = ossl_ackm_get_pto_duration(ch->ackm);
758
759
        /*
760
         * RFC 9001 s. 6.5: Endpoints SHOULD wait three times the PTO before
761
         * initiating a key update after receiving an acknowledgment that
762
         * confirms that the previous key update was received.
763
         *
764
         * Note that by the above wording, this period starts from when we get
765
         * the ack for a TXKU-triggering packet, not when the TXKU is initiated.
766
         * So we defer TXKU cooldown deadline calculation to this point.
767
         */
768
0
        ch->txku_in_progress        = 0;
769
0
        ch->txku_cooldown_deadline  = ossl_time_add(get_time(ch),
770
0
                                                    ossl_time_multiply(pto, 3));
771
0
    }
772
773
0
    return ch->txku_in_progress;
774
0
}
775
776
QUIC_NEEDS_LOCK
777
static int txku_allowed(QUIC_CHANNEL *ch)
778
0
{
779
0
    return ch->tx_enc_level == QUIC_ENC_LEVEL_1RTT /* Sanity check. */
780
        /* Strict RFC 9001 criterion for TXKU. */
781
0
        && ch->handshake_confirmed
782
0
        && !txku_in_progress(ch);
783
0
}
784
785
QUIC_NEEDS_LOCK
786
static int txku_recommendable(QUIC_CHANNEL *ch)
787
0
{
788
0
    if (!txku_allowed(ch))
789
0
        return 0;
790
791
0
    return
792
        /* Recommended RFC 9001 criterion for TXKU. */
793
0
        ossl_time_compare(get_time(ch), ch->txku_cooldown_deadline) >= 0
794
        /* Some additional sensible criteria. */
795
0
        && !ch->rxku_in_progress
796
0
        && !ch->rxku_pending_confirm;
797
0
}
798
799
QUIC_NEEDS_LOCK
800
static int txku_desirable(QUIC_CHANNEL *ch)
801
0
{
802
0
    uint64_t cur_pkt_count, max_pkt_count, thresh_pkt_count;
803
0
    const uint32_t enc_level = QUIC_ENC_LEVEL_1RTT;
804
805
    /* Check AEAD limit to determine if we should perform a spontaneous TXKU. */
806
0
    cur_pkt_count = ossl_qtx_get_cur_epoch_pkt_count(ch->qtx, enc_level);
807
0
    max_pkt_count = ossl_qtx_get_max_epoch_pkt_count(ch->qtx, enc_level);
808
809
0
    thresh_pkt_count = max_pkt_count / 2;
810
0
    if (ch->txku_threshold_override != UINT64_MAX)
811
0
        thresh_pkt_count = ch->txku_threshold_override;
812
813
0
    return cur_pkt_count >= thresh_pkt_count;
814
0
}
815
816
QUIC_NEEDS_LOCK
817
static void ch_maybe_trigger_spontaneous_txku(QUIC_CHANNEL *ch)
818
0
{
819
0
    if (!txku_recommendable(ch) || !txku_desirable(ch))
820
0
        return;
821
822
0
    ch->ku_locally_initiated = 1;
823
0
    ch_trigger_txku(ch);
824
0
}
825
826
QUIC_NEEDS_LOCK
827
static int rxku_allowed(QUIC_CHANNEL *ch)
828
0
{
829
    /*
830
     * RFC 9001 s. 6.1: An endpoint MUST NOT initiate a key update prior to
831
     * having confirmed the handshake (Section 4.1.2).
832
     *
833
     * RFC 9001 s. 6.1: An endpoint MUST NOT initiate a subsequent key update
834
     * unless it has received an acknowledgment for a packet that was sent
835
     * protected with keys from the current key phase.
836
     *
837
     * RFC 9001 s. 6.2: If an endpoint detects a second update before it has
838
     * sent any packets with updated keys containing an acknowledgment for the
839
     * packet that initiated the key update, it indicates that its peer has
840
     * updated keys twice without awaiting confirmation. An endpoint MAY treat
841
     * such consecutive key updates as a connection error of type
842
     * KEY_UPDATE_ERROR.
843
     */
844
0
    return ch->handshake_confirmed && !ch->rxku_pending_confirm;
845
0
}
846
847
/*
848
 * Called when the QRX detects a new RX key update event.
849
 */
850
enum rxku_decision {
851
    DECISION_RXKU_ONLY,
852
    DECISION_PROTOCOL_VIOLATION,
853
    DECISION_SOLICITED_TXKU
854
};
855
856
/* Called when the QRX detects a key update has occurred. */
857
QUIC_NEEDS_LOCK
858
static void rxku_detected(QUIC_PN pn, void *arg)
859
0
{
860
0
    QUIC_CHANNEL *ch = arg;
861
0
    enum rxku_decision decision;
862
0
    OSSL_TIME pto;
863
864
    /*
865
     * Note: rxku_in_progress is always 0 here as an RXKU cannot be detected
866
     * when we are still in UPDATING or COOLDOWN (see quic_record_rx.h).
867
     */
868
0
    assert(!ch->rxku_in_progress);
869
870
0
    if (!rxku_allowed(ch))
871
        /* Is RXKU even allowed at this time? */
872
0
        decision = DECISION_PROTOCOL_VIOLATION;
873
874
0
    else if (ch->ku_locally_initiated)
875
        /*
876
         * If this key update was locally initiated (meaning that this detected
877
         * RXKU event is a result of our own spontaneous TXKU), we do not
878
         * trigger another TXKU; after all, to do so would result in an infinite
879
         * ping-pong of key updates. We still process it as an RXKU.
880
         */
881
0
        decision = DECISION_RXKU_ONLY;
882
883
0
    else
884
        /*
885
         * Otherwise, a peer triggering a KU means we have to trigger a KU also.
886
         */
887
0
        decision = DECISION_SOLICITED_TXKU;
888
889
0
    if (decision == DECISION_PROTOCOL_VIOLATION) {
890
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_KEY_UPDATE_ERROR,
891
0
                                               0, "RX key update again too soon");
892
0
        return;
893
0
    }
894
895
0
    pto = ossl_ackm_get_pto_duration(ch->ackm);
896
897
0
    ch->ku_locally_initiated        = 0;
898
0
    ch->rxku_in_progress            = 1;
899
0
    ch->rxku_pending_confirm        = 1;
900
0
    ch->rxku_trigger_pn             = pn;
901
0
    ch->rxku_update_end_deadline    = ossl_time_add(get_time(ch), pto);
902
0
    ch->rxku_expected               = 0;
903
904
0
    if (decision == DECISION_SOLICITED_TXKU)
905
        /* NOT gated by usual txku_allowed() */
906
0
        ch_trigger_txku(ch);
907
908
    /*
909
     * Ordinarily, we only generate ACK when some ACK-eliciting frame has been
910
     * received. In some cases, this may not occur for a long time, for example
911
     * if transmission of application data is going in only one direction and
912
     * nothing else is happening with the connection. However, since the peer
913
     * cannot initiate a subsequent (spontaneous) TXKU until its prior
914
     * (spontaneous or solicited) TXKU has completed - meaning that prior
915
     * TXKU's trigger packet (or subsequent packet) has been acknowledged, this
916
     * can lead to very long times before a TXKU is considered 'completed'.
917
     * Optimise this by forcing ACK generation after triggering TXKU.
918
     * (Basically, we consider a RXKU event something that is 'ACK-eliciting',
919
     * which it more or less should be; it is necessarily separate from ordinary
920
     * processing of ACK-eliciting frames as key update is not indicated via a
921
     * frame.)
922
     */
923
0
    ossl_quic_tx_packetiser_schedule_ack(ch->txp, QUIC_PN_SPACE_APP);
924
0
}
925
926
/* Called per tick to handle RXKU timer events. */
927
QUIC_NEEDS_LOCK
928
static void ch_rxku_tick(QUIC_CHANNEL *ch)
929
0
{
930
0
    if (!ch->rxku_in_progress
931
0
        || ossl_time_compare(get_time(ch), ch->rxku_update_end_deadline) < 0)
932
0
        return;
933
934
0
    ch->rxku_update_end_deadline    = ossl_time_infinite();
935
0
    ch->rxku_in_progress            = 0;
936
937
0
    if (!ossl_qrx_key_update_timeout(ch->qrx, /*normal=*/1))
938
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR, 0,
939
0
                                               "RXKU cooldown internal error");
940
0
}
941
942
QUIC_NEEDS_LOCK
943
static void ch_on_txp_ack_tx(const OSSL_QUIC_FRAME_ACK *ack, uint32_t pn_space,
944
                             void *arg)
945
0
{
946
0
    QUIC_CHANNEL *ch = arg;
947
948
0
    if (pn_space != QUIC_PN_SPACE_APP || !ch->rxku_pending_confirm
949
0
        || !ossl_quic_frame_ack_contains_pn(ack, ch->rxku_trigger_pn))
950
0
        return;
951
952
    /*
953
     * Defer clearing rxku_pending_confirm until TXP generate call returns
954
     * successfully.
955
     */
956
0
    ch->rxku_pending_confirm_done = 1;
957
0
}
958
959
/*
960
 * QUIC Channel: Handshake Layer Event Handling
961
 * ============================================
962
 */
963
static int ch_on_crypto_send(const unsigned char *buf, size_t buf_len,
964
                             size_t *consumed, void *arg)
965
0
{
966
0
    int ret;
967
0
    QUIC_CHANNEL *ch = arg;
968
0
    uint32_t enc_level = ch->tx_enc_level;
969
0
    uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level);
970
0
    QUIC_SSTREAM *sstream = ch->crypto_send[pn_space];
971
972
0
    if (!ossl_assert(sstream != NULL))
973
0
        return 0;
974
975
0
    ret = ossl_quic_sstream_append(sstream, buf, buf_len, consumed);
976
0
    return ret;
977
0
}
978
979
static int crypto_ensure_empty(QUIC_RSTREAM *rstream)
980
0
{
981
0
    size_t avail = 0;
982
0
    int is_fin = 0;
983
984
0
    if (rstream == NULL)
985
0
        return 1;
986
987
0
    if (!ossl_quic_rstream_available(rstream, &avail, &is_fin))
988
0
        return 0;
989
990
0
    return avail == 0;
991
0
}
992
993
static int ch_on_crypto_recv_record(const unsigned char **buf,
994
                                    size_t *bytes_read, void *arg)
995
0
{
996
0
    QUIC_CHANNEL *ch = arg;
997
0
    QUIC_RSTREAM *rstream;
998
0
    int is_fin = 0; /* crypto stream is never finished, so we don't use this */
999
0
    uint32_t i;
1000
1001
    /*
1002
     * After we move to a later EL we must not allow our peer to send any new
1003
     * bytes in the crypto stream on a previous EL. Retransmissions of old bytes
1004
     * are allowed.
1005
     *
1006
     * In practice we will only move to a new EL when we have consumed all bytes
1007
     * which should be sent on the crypto stream at a previous EL. For example,
1008
     * the Handshake EL should not be provisioned until we have completely
1009
     * consumed a TLS 1.3 ServerHello. Thus when we provision an EL the output
1010
     * of ossl_quic_rstream_available() should be 0 for all lower ELs. Thus if a
1011
     * given EL is available we simply ensure we have not received any further
1012
     * bytes at a lower EL.
1013
     */
1014
0
    for (i = QUIC_ENC_LEVEL_INITIAL; i < ch->rx_enc_level; ++i)
1015
0
        if (i != QUIC_ENC_LEVEL_0RTT &&
1016
0
            !crypto_ensure_empty(ch->crypto_recv[ossl_quic_enc_level_to_pn_space(i)])) {
1017
            /* Protocol violation (RFC 9001 s. 4.1.3) */
1018
0
            ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
1019
0
                                                   OSSL_QUIC_FRAME_TYPE_CRYPTO,
1020
0
                                                   "crypto stream data in wrong EL");
1021
0
            return 0;
1022
0
        }
1023
1024
0
    rstream = ch->crypto_recv[ossl_quic_enc_level_to_pn_space(ch->rx_enc_level)];
1025
0
    if (rstream == NULL)
1026
0
        return 0;
1027
1028
0
    return ossl_quic_rstream_get_record(rstream, buf, bytes_read,
1029
0
                                        &is_fin);
1030
0
}
1031
1032
static int ch_on_crypto_release_record(size_t bytes_read, void *arg)
1033
0
{
1034
0
    QUIC_CHANNEL *ch = arg;
1035
0
    QUIC_RSTREAM *rstream;
1036
0
    OSSL_RTT_INFO rtt_info;
1037
0
    uint32_t rx_pn_space = ossl_quic_enc_level_to_pn_space(ch->rx_enc_level);
1038
1039
0
    rstream = ch->crypto_recv[rx_pn_space];
1040
0
    if (rstream == NULL)
1041
0
        return 0;
1042
1043
0
    ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ch), &rtt_info);
1044
0
    if (!ossl_quic_rxfc_on_retire(&ch->crypto_rxfc[rx_pn_space], bytes_read,
1045
0
                                  rtt_info.smoothed_rtt))
1046
0
        return 0;
1047
1048
0
    return ossl_quic_rstream_release_record(rstream, bytes_read);
1049
0
}
1050
1051
static int ch_on_handshake_yield_secret(uint32_t prot_level, int direction,
1052
                                        uint32_t suite_id, EVP_MD *md,
1053
                                        const unsigned char *secret,
1054
                                        size_t secret_len,
1055
                                        void *arg)
1056
0
{
1057
0
    QUIC_CHANNEL *ch = arg;
1058
0
    uint32_t i;
1059
0
    uint32_t enc_level;
1060
1061
    /* Convert TLS protection level to QUIC encryption level */
1062
0
    switch (prot_level) {
1063
0
    case OSSL_RECORD_PROTECTION_LEVEL_EARLY:
1064
0
        enc_level = QUIC_ENC_LEVEL_0RTT;
1065
0
        break;
1066
1067
0
    case OSSL_RECORD_PROTECTION_LEVEL_HANDSHAKE:
1068
0
        enc_level = QUIC_ENC_LEVEL_HANDSHAKE;
1069
0
        break;
1070
1071
0
    case OSSL_RECORD_PROTECTION_LEVEL_APPLICATION:
1072
0
        enc_level = QUIC_ENC_LEVEL_1RTT;
1073
0
        break;
1074
1075
0
    default:
1076
0
        return 0;
1077
0
    }
1078
1079
0
    if (enc_level < QUIC_ENC_LEVEL_HANDSHAKE || enc_level >= QUIC_ENC_LEVEL_NUM)
1080
        /* Invalid EL. */
1081
0
        return 0;
1082
1083
1084
0
    if (direction) {
1085
        /* TX */
1086
0
        if (enc_level <= ch->tx_enc_level)
1087
            /*
1088
             * Does not make sense for us to try and provision an EL we have already
1089
             * attained.
1090
             */
1091
0
            return 0;
1092
1093
0
        if (!ossl_qtx_provide_secret(ch->qtx, enc_level,
1094
0
                                     suite_id, md,
1095
0
                                     secret, secret_len))
1096
0
            return 0;
1097
1098
0
        ch->tx_enc_level = enc_level;
1099
0
    } else {
1100
        /* RX */
1101
0
        if (enc_level <= ch->rx_enc_level)
1102
            /*
1103
             * Does not make sense for us to try and provision an EL we have already
1104
             * attained.
1105
             */
1106
0
            return 0;
1107
1108
        /*
1109
         * Ensure all crypto streams for previous ELs are now empty of available
1110
         * data.
1111
         */
1112
0
        for (i = QUIC_ENC_LEVEL_INITIAL; i < enc_level; ++i)
1113
0
            if (!crypto_ensure_empty(ch->crypto_recv[ossl_quic_enc_level_to_pn_space(i)])) {
1114
                /* Protocol violation (RFC 9001 s. 4.1.3) */
1115
0
                ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
1116
0
                                                    OSSL_QUIC_FRAME_TYPE_CRYPTO,
1117
0
                                                    "crypto stream data in wrong EL");
1118
0
                return 0;
1119
0
            }
1120
1121
0
        if (!ossl_qrx_provide_secret(ch->qrx, enc_level,
1122
0
                                     suite_id, md,
1123
0
                                     secret, secret_len))
1124
0
            return 0;
1125
1126
0
        ch->have_new_rx_secret = 1;
1127
0
        ch->rx_enc_level = enc_level;
1128
0
    }
1129
1130
0
    return 1;
1131
0
}
1132
1133
static int ch_on_handshake_complete(void *arg)
1134
0
{
1135
0
    QUIC_CHANNEL *ch = arg;
1136
1137
0
    if (!ossl_assert(!ch->handshake_complete))
1138
0
        return 0; /* this should not happen twice */
1139
1140
0
    if (!ossl_assert(ch->tx_enc_level == QUIC_ENC_LEVEL_1RTT))
1141
0
        return 0;
1142
1143
    /*
1144
     * When handshake is complete, we no longer need to abide by the
1145
     * 3x amplification limit, though we should be validated as soon
1146
     * as we see a handshake key encrypted packet (see ossl_quic_handle_packet)
1147
     */
1148
0
    ossl_quic_tx_packetiser_set_validated(ch->txp);
1149
1150
0
    if (!ch->got_remote_transport_params) {
1151
        /*
1152
         * Was not a valid QUIC handshake if we did not get valid transport
1153
         * params.
1154
         */
1155
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_CRYPTO_MISSING_EXT,
1156
0
                                               OSSL_QUIC_FRAME_TYPE_CRYPTO,
1157
0
                                               "no transport parameters received");
1158
0
        return 0;
1159
0
    }
1160
1161
    /* Don't need transport parameters anymore. */
1162
0
    OPENSSL_free(ch->local_transport_params);
1163
0
    ch->local_transport_params = NULL;
1164
1165
    /* Tell the QRX it can now process 1-RTT packets. */
1166
0
    ossl_qrx_allow_1rtt_processing(ch->qrx);
1167
1168
    /* Tell TXP the handshake is complete. */
1169
0
    ossl_quic_tx_packetiser_notify_handshake_complete(ch->txp);
1170
1171
0
    ch->handshake_complete = 1;
1172
1173
0
    if (ch->pending_new_token != NULL) {
1174
        /*
1175
         * Note this is a best effort operation here
1176
         * If scheduling a new token fails, the worst outcome is that
1177
         * a client, not having received it, will just have to go through
1178
         * an extra roundtrip on a subsequent connection via the retry frame
1179
         * path, at which point we get another opportunity to schedule another
1180
         * new token.  As a result, we don't need to handle any errors here
1181
         */
1182
0
        ossl_quic_channel_schedule_new_token(ch,
1183
0
                                             ch->pending_new_token,
1184
0
                                             ch->pending_new_token_len);
1185
0
        OPENSSL_free(ch->pending_new_token);
1186
0
        ch->pending_new_token = NULL;
1187
0
        ch->pending_new_token_len = 0;
1188
0
    }
1189
1190
0
    if (ch->is_server) {
1191
        /*
1192
         * On the server, the handshake is confirmed as soon as it is complete.
1193
         */
1194
0
        ossl_quic_channel_on_handshake_confirmed(ch);
1195
1196
0
        ossl_quic_tx_packetiser_schedule_handshake_done(ch->txp);
1197
0
    }
1198
1199
0
    ch_record_state_transition(ch, ch->state);
1200
0
    return 1;
1201
0
}
1202
1203
static int ch_on_handshake_alert(void *arg, unsigned char alert_code)
1204
0
{
1205
0
    QUIC_CHANNEL *ch = arg;
1206
1207
    /*
1208
     * RFC 9001 s. 4.4: More specifically, servers MUST NOT send post-handshake
1209
     * TLS CertificateRequest messages, and clients MUST treat receipt of such
1210
     * messages as a connection error of type PROTOCOL_VIOLATION.
1211
     */
1212
0
    if (alert_code == SSL_AD_UNEXPECTED_MESSAGE
1213
0
            && ch->handshake_complete
1214
0
            && ossl_quic_tls_is_cert_request(ch->qtls))
1215
0
        ossl_quic_channel_raise_protocol_error(ch,
1216
0
                                               OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
1217
0
                                               0,
1218
0
                                               "Post-handshake TLS "
1219
0
                                               "CertificateRequest received");
1220
    /*
1221
     * RFC 9001 s. 4.6.1: Servers MUST NOT send the early_data extension with a
1222
     * max_early_data_size field set to any value other than 0xffffffff. A
1223
     * client MUST treat receipt of a NewSessionTicket that contains an
1224
     * early_data extension with any other value as a connection error of type
1225
     * PROTOCOL_VIOLATION.
1226
     */
1227
0
    else if (alert_code == SSL_AD_ILLEGAL_PARAMETER
1228
0
             && ch->handshake_complete
1229
0
             && ossl_quic_tls_has_bad_max_early_data(ch->qtls))
1230
0
        ossl_quic_channel_raise_protocol_error(ch,
1231
0
                                               OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
1232
0
                                               0,
1233
0
                                               "Bad max_early_data received");
1234
0
    else
1235
0
        ossl_quic_channel_raise_protocol_error(ch,
1236
0
                                               OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN
1237
0
                                               + alert_code,
1238
0
                                               0, "handshake alert");
1239
1240
0
    return 1;
1241
0
}
1242
1243
/*
1244
 * QUIC Channel: Transport Parameter Handling
1245
 * ==========================================
1246
 */
1247
1248
/*
1249
 * Called by handshake layer when we receive QUIC Transport Parameters from the
1250
 * peer. Note that these are not authenticated until the handshake is marked
1251
 * as complete.
1252
 */
1253
#define TP_REASON_SERVER_ONLY(x) \
1254
0
    x " may not be sent by a client"
1255
#define TP_REASON_DUP(x) \
1256
0
    x " appears multiple times"
1257
#define TP_REASON_MALFORMED(x) \
1258
0
    x " is malformed"
1259
#define TP_REASON_EXPECTED_VALUE(x) \
1260
0
    x " does not match expected value"
1261
#define TP_REASON_NOT_RETRY(x) \
1262
0
    x " sent when not performing a retry"
1263
#define TP_REASON_REQUIRED(x) \
1264
0
    x " was not sent but is required"
1265
#define TP_REASON_INTERNAL_ERROR(x) \
1266
0
    x " encountered internal error"
1267
1268
static void txfc_bump_cwm_bidi(QUIC_STREAM *s, void *arg)
1269
0
{
1270
0
    if (!ossl_quic_stream_is_bidi(s)
1271
0
        || ossl_quic_stream_is_server_init(s))
1272
0
        return;
1273
1274
0
    ossl_quic_txfc_bump_cwm(&s->txfc, *(uint64_t *)arg);
1275
0
}
1276
1277
static void txfc_bump_cwm_uni(QUIC_STREAM *s, void *arg)
1278
0
{
1279
0
    if (ossl_quic_stream_is_bidi(s)
1280
0
        || ossl_quic_stream_is_server_init(s))
1281
0
        return;
1282
1283
0
    ossl_quic_txfc_bump_cwm(&s->txfc, *(uint64_t *)arg);
1284
0
}
1285
1286
static void do_update(QUIC_STREAM *s, void *arg)
1287
0
{
1288
0
    QUIC_CHANNEL *ch = arg;
1289
1290
0
    ossl_quic_stream_map_update_state(&ch->qsm, s);
1291
0
}
1292
1293
static uint64_t min_u64_ignore_0(uint64_t a, uint64_t b)
1294
0
{
1295
0
    if (a == 0)
1296
0
        return b;
1297
0
    if (b == 0)
1298
0
        return a;
1299
1300
0
    return a < b ? a : b;
1301
0
}
1302
1303
static int ch_on_transport_params(const unsigned char *params,
1304
                                  size_t params_len,
1305
                                  void *arg)
1306
0
{
1307
0
    QUIC_CHANNEL *ch = arg;
1308
0
    PACKET pkt;
1309
0
    uint64_t id, v;
1310
0
    size_t len;
1311
0
    const unsigned char *body;
1312
0
    int got_orig_dcid = 0;
1313
0
    int got_initial_scid = 0;
1314
0
    int got_retry_scid = 0;
1315
0
    int got_initial_max_data = 0;
1316
0
    int got_initial_max_stream_data_bidi_local = 0;
1317
0
    int got_initial_max_stream_data_bidi_remote = 0;
1318
0
    int got_initial_max_stream_data_uni = 0;
1319
0
    int got_initial_max_streams_bidi = 0;
1320
0
    int got_initial_max_streams_uni = 0;
1321
0
    int got_stateless_reset_token = 0;
1322
0
    int got_preferred_addr = 0;
1323
0
    int got_ack_delay_exp = 0;
1324
0
    int got_max_ack_delay = 0;
1325
0
    int got_max_udp_payload_size = 0;
1326
0
    int got_max_idle_timeout = 0;
1327
0
    int got_active_conn_id_limit = 0;
1328
0
    int got_disable_active_migration = 0;
1329
0
    QUIC_CONN_ID cid;
1330
0
    const char *reason = "bad transport parameter";
1331
0
    ossl_unused uint64_t rx_max_idle_timeout = 0;
1332
0
    ossl_unused const void *stateless_reset_token_p = NULL;
1333
0
    QUIC_PREFERRED_ADDR pfa;
1334
1335
0
    if (ch->got_remote_transport_params) {
1336
0
        reason = "multiple transport parameter extensions";
1337
0
        goto malformed;
1338
0
    }
1339
1340
0
    if (!PACKET_buf_init(&pkt, params, params_len)) {
1341
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR, 0,
1342
0
                                               "internal error (packet buf init)");
1343
0
        return 0;
1344
0
    }
1345
1346
0
    while (PACKET_remaining(&pkt) > 0) {
1347
0
        if (!ossl_quic_wire_peek_transport_param(&pkt, &id))
1348
0
            goto malformed;
1349
1350
0
        switch (id) {
1351
0
        case QUIC_TPARAM_ORIG_DCID:
1352
0
            if (got_orig_dcid) {
1353
0
                reason = TP_REASON_DUP("ORIG_DCID");
1354
0
                goto malformed;
1355
0
            }
1356
1357
0
            if (ch->is_server) {
1358
0
                reason = TP_REASON_SERVER_ONLY("ORIG_DCID");
1359
0
                goto malformed;
1360
0
            }
1361
1362
0
            if (!ossl_quic_wire_decode_transport_param_cid(&pkt, NULL, &cid)) {
1363
0
                reason = TP_REASON_MALFORMED("ORIG_DCID");
1364
0
                goto malformed;
1365
0
            }
1366
1367
#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
1368
            /* Must match our initial DCID. */
1369
            if (!ossl_quic_conn_id_eq(&ch->init_dcid, &cid)) {
1370
                reason = TP_REASON_EXPECTED_VALUE("ORIG_DCID");
1371
                goto malformed;
1372
            }
1373
#endif
1374
1375
0
            got_orig_dcid = 1;
1376
0
            break;
1377
1378
0
        case QUIC_TPARAM_RETRY_SCID:
1379
0
            if (ch->is_server) {
1380
0
                reason = TP_REASON_SERVER_ONLY("RETRY_SCID");
1381
0
                goto malformed;
1382
0
            }
1383
1384
0
            if (got_retry_scid) {
1385
0
                reason = TP_REASON_DUP("RETRY_SCID");
1386
0
                goto malformed;
1387
0
            }
1388
1389
0
            if (!ch->doing_retry) {
1390
0
                reason = TP_REASON_NOT_RETRY("RETRY_SCID");
1391
0
                goto malformed;
1392
0
            }
1393
1394
0
            if (!ossl_quic_wire_decode_transport_param_cid(&pkt, NULL, &cid)) {
1395
0
                reason = TP_REASON_MALFORMED("RETRY_SCID");
1396
0
                goto malformed;
1397
0
            }
1398
1399
            /* Must match Retry packet SCID. */
1400
0
            if (!ossl_quic_conn_id_eq(&ch->retry_scid, &cid)) {
1401
0
                reason = TP_REASON_EXPECTED_VALUE("RETRY_SCID");
1402
0
                goto malformed;
1403
0
            }
1404
1405
0
            got_retry_scid = 1;
1406
0
            break;
1407
1408
0
        case QUIC_TPARAM_INITIAL_SCID:
1409
0
            if (got_initial_scid) {
1410
                /* must not appear more than once */
1411
0
                reason = TP_REASON_DUP("INITIAL_SCID");
1412
0
                goto malformed;
1413
0
            }
1414
1415
0
            if (!ossl_quic_wire_decode_transport_param_cid(&pkt, NULL, &cid)) {
1416
0
                reason = TP_REASON_MALFORMED("INITIAL_SCID");
1417
0
                goto malformed;
1418
0
            }
1419
1420
0
            if (!ossl_quic_conn_id_eq(&ch->init_scid, &cid)) {
1421
0
                reason = TP_REASON_EXPECTED_VALUE("INITIAL_SCID");
1422
0
                goto malformed;
1423
0
            }
1424
1425
0
            got_initial_scid = 1;
1426
0
            break;
1427
1428
0
        case QUIC_TPARAM_INITIAL_MAX_DATA:
1429
0
            if (got_initial_max_data) {
1430
                /* must not appear more than once */
1431
0
                reason = TP_REASON_DUP("INITIAL_MAX_DATA");
1432
0
                goto malformed;
1433
0
            }
1434
1435
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)) {
1436
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_DATA");
1437
0
                goto malformed;
1438
0
            }
1439
1440
0
            ossl_quic_txfc_bump_cwm(&ch->conn_txfc, v);
1441
0
            got_initial_max_data = 1;
1442
0
            break;
1443
1444
0
        case QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL:
1445
0
            if (got_initial_max_stream_data_bidi_local) {
1446
                /* must not appear more than once */
1447
0
                reason = TP_REASON_DUP("INITIAL_MAX_STREAM_DATA_BIDI_LOCAL");
1448
0
                goto malformed;
1449
0
            }
1450
1451
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)) {
1452
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_STREAM_DATA_BIDI_LOCAL");
1453
0
                goto malformed;
1454
0
            }
1455
1456
            /*
1457
             * This is correct; the BIDI_LOCAL TP governs streams created by
1458
             * the endpoint which sends the TP, i.e., our peer.
1459
             */
1460
0
            ch->rx_init_max_stream_data_bidi_remote = v;
1461
0
            got_initial_max_stream_data_bidi_local = 1;
1462
0
            break;
1463
1464
0
        case QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE:
1465
0
            if (got_initial_max_stream_data_bidi_remote) {
1466
                /* must not appear more than once */
1467
0
                reason = TP_REASON_DUP("INITIAL_MAX_STREAM_DATA_BIDI_REMOTE");
1468
0
                goto malformed;
1469
0
            }
1470
1471
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)) {
1472
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_STREAM_DATA_BIDI_REMOTE");
1473
0
                goto malformed;
1474
0
            }
1475
1476
            /*
1477
             * This is correct; the BIDI_REMOTE TP governs streams created
1478
             * by the endpoint which receives the TP, i.e., us.
1479
             */
1480
0
            ch->rx_init_max_stream_data_bidi_local = v;
1481
1482
            /* Apply to all existing streams. */
1483
0
            ossl_quic_stream_map_visit(&ch->qsm, txfc_bump_cwm_bidi, &v);
1484
0
            got_initial_max_stream_data_bidi_remote = 1;
1485
0
            break;
1486
1487
0
        case QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_UNI:
1488
0
            if (got_initial_max_stream_data_uni) {
1489
                /* must not appear more than once */
1490
0
                reason = TP_REASON_DUP("INITIAL_MAX_STREAM_DATA_UNI");
1491
0
                goto malformed;
1492
0
            }
1493
1494
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)) {
1495
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_STREAM_DATA_UNI");
1496
0
                goto malformed;
1497
0
            }
1498
1499
0
            ch->rx_init_max_stream_data_uni = v;
1500
1501
            /* Apply to all existing streams. */
1502
0
            ossl_quic_stream_map_visit(&ch->qsm, txfc_bump_cwm_uni, &v);
1503
0
            got_initial_max_stream_data_uni = 1;
1504
0
            break;
1505
1506
0
        case QUIC_TPARAM_ACK_DELAY_EXP:
1507
0
            if (got_ack_delay_exp) {
1508
                /* must not appear more than once */
1509
0
                reason = TP_REASON_DUP("ACK_DELAY_EXP");
1510
0
                goto malformed;
1511
0
            }
1512
1513
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1514
0
                || v > QUIC_MAX_ACK_DELAY_EXP) {
1515
0
                reason = TP_REASON_MALFORMED("ACK_DELAY_EXP");
1516
0
                goto malformed;
1517
0
            }
1518
1519
0
            ch->rx_ack_delay_exp = (unsigned char)v;
1520
0
            got_ack_delay_exp = 1;
1521
0
            break;
1522
1523
0
        case QUIC_TPARAM_MAX_ACK_DELAY:
1524
0
            if (got_max_ack_delay) {
1525
                /* must not appear more than once */
1526
0
                reason = TP_REASON_DUP("MAX_ACK_DELAY");
1527
0
                goto malformed;
1528
0
            }
1529
1530
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1531
0
                || v >= (((uint64_t)1) << 14)) {
1532
0
                reason = TP_REASON_MALFORMED("MAX_ACK_DELAY");
1533
0
                goto malformed;
1534
0
            }
1535
1536
0
            ch->rx_max_ack_delay = v;
1537
0
            ossl_ackm_set_rx_max_ack_delay(ch->ackm,
1538
0
                                           ossl_ms2time(ch->rx_max_ack_delay));
1539
1540
0
            got_max_ack_delay = 1;
1541
0
            break;
1542
1543
0
        case QUIC_TPARAM_INITIAL_MAX_STREAMS_BIDI:
1544
0
            if (got_initial_max_streams_bidi) {
1545
                /* must not appear more than once */
1546
0
                reason = TP_REASON_DUP("INITIAL_MAX_STREAMS_BIDI");
1547
0
                goto malformed;
1548
0
            }
1549
1550
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1551
0
                || v > (((uint64_t)1) << 60)) {
1552
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_STREAMS_BIDI");
1553
0
                goto malformed;
1554
0
            }
1555
1556
0
            assert(ch->max_local_streams_bidi == 0);
1557
0
            ch->max_local_streams_bidi = v;
1558
0
            got_initial_max_streams_bidi = 1;
1559
0
            break;
1560
1561
0
        case QUIC_TPARAM_INITIAL_MAX_STREAMS_UNI:
1562
0
            if (got_initial_max_streams_uni) {
1563
                /* must not appear more than once */
1564
0
                reason = TP_REASON_DUP("INITIAL_MAX_STREAMS_UNI");
1565
0
                goto malformed;
1566
0
            }
1567
1568
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1569
0
                || v > (((uint64_t)1) << 60)) {
1570
0
                reason = TP_REASON_MALFORMED("INITIAL_MAX_STREAMS_UNI");
1571
0
                goto malformed;
1572
0
            }
1573
1574
0
            assert(ch->max_local_streams_uni == 0);
1575
0
            ch->max_local_streams_uni = v;
1576
0
            got_initial_max_streams_uni = 1;
1577
0
            break;
1578
1579
0
        case QUIC_TPARAM_MAX_IDLE_TIMEOUT:
1580
0
            if (got_max_idle_timeout) {
1581
                /* must not appear more than once */
1582
0
                reason = TP_REASON_DUP("MAX_IDLE_TIMEOUT");
1583
0
                goto malformed;
1584
0
            }
1585
1586
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)) {
1587
0
                reason = TP_REASON_MALFORMED("MAX_IDLE_TIMEOUT");
1588
0
                goto malformed;
1589
0
            }
1590
1591
0
            ch->max_idle_timeout_remote_req = v;
1592
1593
0
            ch->max_idle_timeout = min_u64_ignore_0(ch->max_idle_timeout_local_req,
1594
0
                                                    ch->max_idle_timeout_remote_req);
1595
1596
1597
0
            ch_update_idle(ch);
1598
0
            got_max_idle_timeout = 1;
1599
0
            rx_max_idle_timeout = v;
1600
0
            break;
1601
1602
0
        case QUIC_TPARAM_MAX_UDP_PAYLOAD_SIZE:
1603
0
            if (got_max_udp_payload_size) {
1604
                /* must not appear more than once */
1605
0
                reason = TP_REASON_DUP("MAX_UDP_PAYLOAD_SIZE");
1606
0
                goto malformed;
1607
0
            }
1608
1609
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1610
0
                || v < QUIC_MIN_INITIAL_DGRAM_LEN) {
1611
0
                reason = TP_REASON_MALFORMED("MAX_UDP_PAYLOAD_SIZE");
1612
0
                goto malformed;
1613
0
            }
1614
1615
0
            ch->rx_max_udp_payload_size = v;
1616
0
            got_max_udp_payload_size    = 1;
1617
0
            break;
1618
1619
0
        case QUIC_TPARAM_ACTIVE_CONN_ID_LIMIT:
1620
0
            if (got_active_conn_id_limit) {
1621
                /* must not appear more than once */
1622
0
                reason = TP_REASON_DUP("ACTIVE_CONN_ID_LIMIT");
1623
0
                goto malformed;
1624
0
            }
1625
1626
0
            if (!ossl_quic_wire_decode_transport_param_int(&pkt, &id, &v)
1627
0
                || v < QUIC_MIN_ACTIVE_CONN_ID_LIMIT) {
1628
0
                reason = TP_REASON_MALFORMED("ACTIVE_CONN_ID_LIMIT");
1629
0
                goto malformed;
1630
0
            }
1631
1632
0
            ch->rx_active_conn_id_limit = v;
1633
0
            got_active_conn_id_limit = 1;
1634
0
            break;
1635
1636
0
        case QUIC_TPARAM_STATELESS_RESET_TOKEN:
1637
0
            if (got_stateless_reset_token) {
1638
0
                reason = TP_REASON_DUP("STATELESS_RESET_TOKEN");
1639
0
                goto malformed;
1640
0
            }
1641
1642
            /*
1643
             * RFC 9000 s. 18.2: This transport parameter MUST NOT be sent
1644
             * by a client but MAY be sent by a server.
1645
             */
1646
0
            if (ch->is_server) {
1647
0
                reason = TP_REASON_SERVER_ONLY("STATELESS_RESET_TOKEN");
1648
0
                goto malformed;
1649
0
            }
1650
1651
0
            body = ossl_quic_wire_decode_transport_param_bytes(&pkt, &id, &len);
1652
0
            if (body == NULL || len != QUIC_STATELESS_RESET_TOKEN_LEN) {
1653
0
                reason = TP_REASON_MALFORMED("STATELESS_RESET_TOKEN");
1654
0
                goto malformed;
1655
0
            }
1656
0
            if (!ossl_quic_srtm_add(ch->srtm, ch, ch->cur_remote_seq_num,
1657
0
                                    (const QUIC_STATELESS_RESET_TOKEN *)body)) {
1658
0
                reason = TP_REASON_INTERNAL_ERROR("STATELESS_RESET_TOKEN");
1659
0
                goto malformed;
1660
0
            }
1661
1662
0
            stateless_reset_token_p     = body;
1663
0
            got_stateless_reset_token   = 1;
1664
0
            break;
1665
1666
0
        case QUIC_TPARAM_PREFERRED_ADDR:
1667
            /* TODO(QUIC FUTURE): Handle preferred address. */
1668
0
            if (got_preferred_addr) {
1669
0
                reason = TP_REASON_DUP("PREFERRED_ADDR");
1670
0
                goto malformed;
1671
0
            }
1672
1673
            /*
1674
             * RFC 9000 s. 18.2: "A server that chooses a zero-length
1675
             * connection ID MUST NOT provide a preferred address.
1676
             * Similarly, a server MUST NOT include a zero-length connection
1677
             * ID in this transport parameter. A client MUST treat a
1678
             * violation of these requirements as a connection error of type
1679
             * TRANSPORT_PARAMETER_ERROR."
1680
             */
1681
0
            if (ch->is_server) {
1682
0
                reason = TP_REASON_SERVER_ONLY("PREFERRED_ADDR");
1683
0
                goto malformed;
1684
0
            }
1685
1686
0
            if (ch->cur_remote_dcid.id_len == 0) {
1687
0
                reason = "PREFERRED_ADDR provided for zero-length CID";
1688
0
                goto malformed;
1689
0
            }
1690
1691
0
            if (!ossl_quic_wire_decode_transport_param_preferred_addr(&pkt, &pfa)) {
1692
0
                reason = TP_REASON_MALFORMED("PREFERRED_ADDR");
1693
0
                goto malformed;
1694
0
            }
1695
1696
0
            if (pfa.cid.id_len == 0) {
1697
0
                reason = "zero-length CID in PREFERRED_ADDR";
1698
0
                goto malformed;
1699
0
            }
1700
1701
0
            got_preferred_addr = 1;
1702
0
            break;
1703
1704
0
        case QUIC_TPARAM_DISABLE_ACTIVE_MIGRATION:
1705
            /* We do not currently handle migration, so nothing to do. */
1706
0
            if (got_disable_active_migration) {
1707
                /* must not appear more than once */
1708
0
                reason = TP_REASON_DUP("DISABLE_ACTIVE_MIGRATION");
1709
0
                goto malformed;
1710
0
            }
1711
1712
0
            body = ossl_quic_wire_decode_transport_param_bytes(&pkt, &id, &len);
1713
0
            if (body == NULL || len > 0) {
1714
0
                reason = TP_REASON_MALFORMED("DISABLE_ACTIVE_MIGRATION");
1715
0
                goto malformed;
1716
0
            }
1717
1718
0
            got_disable_active_migration = 1;
1719
0
            break;
1720
1721
0
        default:
1722
            /*
1723
             * Skip over and ignore.
1724
             *
1725
             * RFC 9000 s. 7.4: We SHOULD treat duplicated transport parameters
1726
             * as a connection error, but we are not required to. Currently,
1727
             * handle this programmatically by checking for duplicates in the
1728
             * parameters that we recognise, as above, but don't bother
1729
             * maintaining a list of duplicates for anything we don't recognise.
1730
             */
1731
0
            body = ossl_quic_wire_decode_transport_param_bytes(&pkt, &id,
1732
0
                                                               &len);
1733
0
            if (body == NULL)
1734
0
                goto malformed;
1735
1736
0
            break;
1737
0
        }
1738
0
    }
1739
1740
0
    if (!got_initial_scid) {
1741
0
        reason = TP_REASON_REQUIRED("INITIAL_SCID");
1742
0
        goto malformed;
1743
0
    }
1744
1745
0
    if (!ch->is_server) {
1746
0
        if (!got_orig_dcid) {
1747
0
            reason = TP_REASON_REQUIRED("ORIG_DCID");
1748
0
            goto malformed;
1749
0
        }
1750
1751
0
        if (ch->doing_retry && !got_retry_scid) {
1752
0
            reason = TP_REASON_REQUIRED("RETRY_SCID");
1753
0
            goto malformed;
1754
0
        }
1755
0
    }
1756
1757
0
    ch->got_remote_transport_params = 1;
1758
1759
0
#ifndef OPENSSL_NO_QLOG
1760
0
    QLOG_EVENT_BEGIN(ch_get_qlog(ch), transport, parameters_set)
1761
0
        QLOG_STR("owner", "remote");
1762
1763
0
        if (got_orig_dcid)
1764
0
            QLOG_CID("original_destination_connection_id",
1765
0
                     &ch->init_dcid);
1766
0
        if (got_initial_scid)
1767
0
            QLOG_CID("original_source_connection_id",
1768
0
                     &ch->init_dcid);
1769
0
        if (got_retry_scid)
1770
0
            QLOG_CID("retry_source_connection_id",
1771
0
                     &ch->retry_scid);
1772
0
        if (got_initial_max_data)
1773
0
            QLOG_U64("initial_max_data",
1774
0
                     ossl_quic_txfc_get_cwm(&ch->conn_txfc));
1775
0
        if (got_initial_max_stream_data_bidi_local)
1776
0
            QLOG_U64("initial_max_stream_data_bidi_local",
1777
0
                     ch->rx_init_max_stream_data_bidi_local);
1778
0
        if (got_initial_max_stream_data_bidi_remote)
1779
0
            QLOG_U64("initial_max_stream_data_bidi_remote",
1780
0
                     ch->rx_init_max_stream_data_bidi_remote);
1781
0
        if (got_initial_max_stream_data_uni)
1782
0
            QLOG_U64("initial_max_stream_data_uni",
1783
0
                     ch->rx_init_max_stream_data_uni);
1784
0
        if (got_initial_max_streams_bidi)
1785
0
            QLOG_U64("initial_max_streams_bidi",
1786
0
                     ch->max_local_streams_bidi);
1787
0
        if (got_initial_max_streams_uni)
1788
0
            QLOG_U64("initial_max_streams_uni",
1789
0
                     ch->max_local_streams_uni);
1790
0
        if (got_ack_delay_exp)
1791
0
            QLOG_U64("ack_delay_exponent", ch->rx_ack_delay_exp);
1792
0
        if (got_max_ack_delay)
1793
0
            QLOG_U64("max_ack_delay", ch->rx_max_ack_delay);
1794
0
        if (got_max_udp_payload_size)
1795
0
            QLOG_U64("max_udp_payload_size", ch->rx_max_udp_payload_size);
1796
0
        if (got_max_idle_timeout)
1797
0
            QLOG_U64("max_idle_timeout", rx_max_idle_timeout);
1798
0
        if (got_active_conn_id_limit)
1799
0
            QLOG_U64("active_connection_id_limit", ch->rx_active_conn_id_limit);
1800
0
        if (got_stateless_reset_token)
1801
0
            QLOG_BIN("stateless_reset_token", stateless_reset_token_p,
1802
0
                     QUIC_STATELESS_RESET_TOKEN_LEN);
1803
0
        if (got_preferred_addr) {
1804
0
            QLOG_BEGIN("preferred_addr")
1805
0
                QLOG_U64("port_v4", pfa.ipv4_port);
1806
0
                QLOG_U64("port_v6", pfa.ipv6_port);
1807
0
                QLOG_BIN("ip_v4", pfa.ipv4, sizeof(pfa.ipv4));
1808
0
                QLOG_BIN("ip_v6", pfa.ipv6, sizeof(pfa.ipv6));
1809
0
                QLOG_BIN("stateless_reset_token", pfa.stateless_reset.token,
1810
0
                         sizeof(pfa.stateless_reset.token));
1811
0
                QLOG_CID("connection_id", &pfa.cid);
1812
0
            QLOG_END()
1813
0
        }
1814
0
        QLOG_BOOL("disable_active_migration", got_disable_active_migration);
1815
0
    QLOG_EVENT_END()
1816
0
#endif
1817
1818
0
    if (got_initial_max_data || got_initial_max_stream_data_bidi_remote
1819
0
        || got_initial_max_streams_bidi || got_initial_max_streams_uni)
1820
        /*
1821
         * If FC credit was bumped, we may now be able to send. Update all
1822
         * streams.
1823
         */
1824
0
        ossl_quic_stream_map_visit(&ch->qsm, do_update, ch);
1825
1826
    /* If we are a server, we now generate our own transport parameters. */
1827
0
    if (ch->is_server && !ch_generate_transport_params(ch)) {
1828
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR, 0,
1829
0
                                               "internal error");
1830
0
        return 0;
1831
0
    }
1832
1833
0
    return 1;
1834
1835
0
malformed:
1836
0
    ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR,
1837
0
                                           0, reason);
1838
0
    return 0;
1839
0
}
1840
1841
/*
1842
 * Called when we want to generate transport parameters. This is called
1843
 * immediately at instantiation time for a client and after we receive the
1844
 * client's transport parameters for a server.
1845
 */
1846
static int ch_generate_transport_params(QUIC_CHANNEL *ch)
1847
0
{
1848
0
    int ok = 0;
1849
0
    BUF_MEM *buf_mem = NULL;
1850
0
    WPACKET wpkt;
1851
0
    int wpkt_valid = 0;
1852
0
    size_t buf_len = 0;
1853
0
    QUIC_CONN_ID *id_to_use = NULL;
1854
1855
    /*
1856
     * We need to select which connection id to encode in the
1857
     * QUIC_TPARAM_ORIG_DCID transport parameter
1858
     * If we have an odcid, then this connection was established
1859
     * in response to a retry request, and we need to use the connection
1860
     * id sent in the first initial packet.
1861
     * If we don't have an odcid, then this connection was established
1862
     * without a retry and the init_dcid is the connection we should use
1863
     */
1864
0
    if (ch->odcid.id_len == 0)
1865
0
        id_to_use = &ch->init_dcid;
1866
0
    else
1867
0
        id_to_use = &ch->odcid;
1868
1869
0
    if (ch->local_transport_params != NULL || ch->got_local_transport_params)
1870
0
        goto err;
1871
1872
0
    if ((buf_mem = BUF_MEM_new()) == NULL)
1873
0
        goto err;
1874
1875
0
    if (!WPACKET_init(&wpkt, buf_mem))
1876
0
        goto err;
1877
1878
0
    wpkt_valid = 1;
1879
1880
0
    if (ossl_quic_wire_encode_transport_param_bytes(&wpkt, QUIC_TPARAM_DISABLE_ACTIVE_MIGRATION,
1881
0
                                                    NULL, 0) == NULL)
1882
0
        goto err;
1883
1884
0
    if (ch->is_server) {
1885
0
        if (!ossl_quic_wire_encode_transport_param_cid(&wpkt, QUIC_TPARAM_ORIG_DCID,
1886
0
                                                       id_to_use))
1887
0
            goto err;
1888
1889
0
        if (!ossl_quic_wire_encode_transport_param_cid(&wpkt, QUIC_TPARAM_INITIAL_SCID,
1890
0
                                                       &ch->cur_local_cid))
1891
0
            goto err;
1892
0
        if (ch->odcid.id_len != 0)
1893
0
            if (!ossl_quic_wire_encode_transport_param_cid(&wpkt,
1894
0
                                                           QUIC_TPARAM_RETRY_SCID,
1895
0
                                                           &ch->init_dcid))
1896
0
                goto err;
1897
0
    } else {
1898
0
        if (!ossl_quic_wire_encode_transport_param_cid(&wpkt, QUIC_TPARAM_INITIAL_SCID,
1899
0
                                                       &ch->init_scid))
1900
0
            goto err;
1901
0
    }
1902
1903
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_MAX_IDLE_TIMEOUT,
1904
0
                                                   ch->max_idle_timeout_local_req))
1905
0
        goto err;
1906
1907
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_MAX_UDP_PAYLOAD_SIZE,
1908
0
                                                   QUIC_MIN_INITIAL_DGRAM_LEN))
1909
0
        goto err;
1910
1911
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_ACTIVE_CONN_ID_LIMIT,
1912
0
                                                   QUIC_MIN_ACTIVE_CONN_ID_LIMIT))
1913
0
        goto err;
1914
1915
0
    if (ch->tx_max_ack_delay != QUIC_DEFAULT_MAX_ACK_DELAY
1916
0
        && !ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_MAX_ACK_DELAY,
1917
0
                                                      ch->tx_max_ack_delay))
1918
0
        goto err;
1919
1920
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_DATA,
1921
0
                                                   ossl_quic_rxfc_get_cwm(&ch->conn_rxfc)))
1922
0
        goto err;
1923
1924
    /* Send the default CWM for a new RXFC. */
1925
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL,
1926
0
                                                   ch->tx_init_max_stream_data_bidi_local))
1927
0
        goto err;
1928
1929
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE,
1930
0
                                                   ch->tx_init_max_stream_data_bidi_remote))
1931
0
        goto err;
1932
1933
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_STREAM_DATA_UNI,
1934
0
                                                   ch->tx_init_max_stream_data_uni))
1935
0
        goto err;
1936
1937
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_STREAMS_BIDI,
1938
0
                                                   ossl_quic_rxfc_get_cwm(&ch->max_streams_bidi_rxfc)))
1939
0
        goto err;
1940
1941
0
    if (!ossl_quic_wire_encode_transport_param_int(&wpkt, QUIC_TPARAM_INITIAL_MAX_STREAMS_UNI,
1942
0
                                                   ossl_quic_rxfc_get_cwm(&ch->max_streams_uni_rxfc)))
1943
0
        goto err;
1944
1945
0
    if (!WPACKET_finish(&wpkt))
1946
0
        goto err;
1947
1948
0
    wpkt_valid = 0;
1949
1950
0
    if (!WPACKET_get_total_written(&wpkt, &buf_len))
1951
0
        goto err;
1952
1953
0
    ch->local_transport_params = (unsigned char *)buf_mem->data;
1954
0
    buf_mem->data = NULL;
1955
1956
0
    if (!ossl_quic_tls_set_transport_params(ch->qtls, ch->local_transport_params,
1957
0
                                            buf_len))
1958
0
        goto err;
1959
1960
0
#ifndef OPENSSL_NO_QLOG
1961
0
    QLOG_EVENT_BEGIN(ch_get_qlog(ch), transport, parameters_set)
1962
0
        QLOG_STR("owner", "local");
1963
0
        QLOG_BOOL("disable_active_migration", 1);
1964
0
        if (ch->is_server) {
1965
0
            QLOG_CID("original_destination_connection_id", &ch->init_dcid);
1966
0
            QLOG_CID("initial_source_connection_id", &ch->cur_local_cid);
1967
0
        } else {
1968
0
            QLOG_STR("initial_source_connection_id", "");
1969
0
        }
1970
0
        QLOG_U64("max_idle_timeout", ch->max_idle_timeout);
1971
0
        QLOG_U64("max_udp_payload_size", QUIC_MIN_INITIAL_DGRAM_LEN);
1972
0
        QLOG_U64("active_connection_id_limit", QUIC_MIN_ACTIVE_CONN_ID_LIMIT);
1973
0
        QLOG_U64("max_ack_delay", ch->tx_max_ack_delay);
1974
0
        QLOG_U64("initial_max_data", ossl_quic_rxfc_get_cwm(&ch->conn_rxfc));
1975
0
        QLOG_U64("initial_max_stream_data_bidi_local",
1976
0
                 ch->tx_init_max_stream_data_bidi_local);
1977
0
        QLOG_U64("initial_max_stream_data_bidi_remote",
1978
0
                 ch->tx_init_max_stream_data_bidi_remote);
1979
0
        QLOG_U64("initial_max_stream_data_uni",
1980
0
                 ch->tx_init_max_stream_data_uni);
1981
0
        QLOG_U64("initial_max_streams_bidi",
1982
0
                 ossl_quic_rxfc_get_cwm(&ch->max_streams_bidi_rxfc));
1983
0
        QLOG_U64("initial_max_streams_uni",
1984
0
                 ossl_quic_rxfc_get_cwm(&ch->max_streams_uni_rxfc));
1985
0
    QLOG_EVENT_END()
1986
0
#endif
1987
1988
0
    ch->got_local_transport_params = 1;
1989
1990
0
    ok = 1;
1991
0
err:
1992
0
    if (wpkt_valid)
1993
0
        WPACKET_cleanup(&wpkt);
1994
0
    BUF_MEM_free(buf_mem);
1995
0
    return ok;
1996
0
}
1997
1998
/*
1999
 * QUIC Channel: Ticker-Mutator
2000
 * ============================
2001
 */
2002
2003
/*
2004
 * The central ticker function called by the reactor. This does everything, or
2005
 * at least everything network I/O related. Best effort - not allowed to fail
2006
 * "loudly".
2007
 */
2008
void ossl_quic_channel_subtick(QUIC_CHANNEL *ch, QUIC_TICK_RESULT *res,
2009
                               uint32_t flags)
2010
0
{
2011
0
    OSSL_TIME now, deadline;
2012
0
    int channel_only = (flags & QUIC_REACTOR_TICK_FLAG_CHANNEL_ONLY) != 0;
2013
0
    int notify_other_threads = 0;
2014
2015
    /*
2016
     * When we tick the QUIC connection, we do everything we need to do
2017
     * periodically. Network I/O handling will already have been performed
2018
     * as necessary by the QUIC port. Thus, in order, we:
2019
     *
2020
     *   - handle any packets the DEMUX has queued up for us;
2021
     *   - handle any timer events which are due to fire (ACKM, etc.);
2022
     *   - generate any packets which need to be sent;
2023
     *   - determine the time at which we should next be ticked.
2024
     */
2025
2026
    /*
2027
     * If the connection has not yet started, or we are in the TERMINATED state,
2028
     * there is nothing to do.
2029
     */
2030
0
    if (ch->state == QUIC_CHANNEL_STATE_IDLE
2031
0
            || ossl_quic_channel_is_terminated(ch)) {
2032
0
        res->net_read_desired       = 0;
2033
0
        res->net_write_desired      = 0;
2034
0
        res->notify_other_threads   = 0;
2035
0
        res->tick_deadline          = ossl_time_infinite();
2036
0
        return;
2037
0
    }
2038
2039
    /*
2040
     * If we are in the TERMINATING state, check if the terminating timer has
2041
     * expired.
2042
     */
2043
0
    if (ossl_quic_channel_is_terminating(ch)) {
2044
0
        now = get_time(ch);
2045
2046
0
        if (ossl_time_compare(now, ch->terminate_deadline) >= 0) {
2047
0
            ch_on_terminating_timeout(ch);
2048
0
            res->net_read_desired       = 0;
2049
0
            res->net_write_desired      = 0;
2050
0
            res->notify_other_threads   = 1;
2051
0
            res->tick_deadline          = ossl_time_infinite();
2052
0
            return; /* abort normal processing, nothing to do */
2053
0
        }
2054
0
    }
2055
2056
0
    if (!ch->port->engine->inhibit_tick) {
2057
        /* Handle RXKU timeouts. */
2058
0
        ch_rxku_tick(ch);
2059
2060
0
        do {
2061
            /* Process queued incoming packets. */
2062
0
            ch->did_tls_tick        = 0;
2063
0
            ch->have_new_rx_secret  = 0;
2064
0
            ch_rx(ch, channel_only, &notify_other_threads);
2065
2066
            /*
2067
             * Allow the handshake layer to check for any new incoming data and
2068
             * generate new outgoing data.
2069
             */
2070
0
            if (!ch->did_tls_tick)
2071
0
                ch_tick_tls(ch, channel_only, &notify_other_threads);
2072
2073
            /*
2074
             * If the handshake layer gave us a new secret, we need to do RX
2075
             * again because packets that were not previously processable and
2076
             * were deferred might now be processable.
2077
             *
2078
             * TODO(QUIC FUTURE): Consider handling this in the yield_secret callback.
2079
             */
2080
0
        } while (ch->have_new_rx_secret);
2081
0
    }
2082
2083
    /*
2084
     * Handle any timer events which are due to fire; namely, the loss
2085
     * detection deadline and the idle timeout.
2086
     *
2087
     * ACKM ACK generation deadline is polled by TXP, so we don't need to
2088
     * handle it here.
2089
     */
2090
0
    now = get_time(ch);
2091
0
    if (ossl_time_compare(now, ch->idle_deadline) >= 0) {
2092
        /*
2093
         * Idle timeout differs from normal protocol violation because we do
2094
         * not send a CONN_CLOSE frame; go straight to TERMINATED.
2095
         */
2096
0
        if (!ch->port->engine->inhibit_tick)
2097
0
            ch_on_idle_timeout(ch);
2098
2099
0
        res->net_read_desired       = 0;
2100
0
        res->net_write_desired      = 0;
2101
0
        res->notify_other_threads   = 1;
2102
0
        res->tick_deadline          = ossl_time_infinite();
2103
0
        return;
2104
0
    }
2105
2106
0
    if (!ch->port->engine->inhibit_tick) {
2107
0
        deadline = ossl_ackm_get_loss_detection_deadline(ch->ackm);
2108
0
        if (!ossl_time_is_zero(deadline)
2109
0
            && ossl_time_compare(now, deadline) >= 0)
2110
0
            ossl_ackm_on_timeout(ch->ackm);
2111
2112
        /* If a ping is due, inform TXP. */
2113
0
        if (ossl_time_compare(now, ch->ping_deadline) >= 0) {
2114
0
            int pn_space = ossl_quic_enc_level_to_pn_space(ch->tx_enc_level);
2115
2116
0
            ossl_quic_tx_packetiser_schedule_ack_eliciting(ch->txp, pn_space);
2117
2118
            /*
2119
             * If we have no CC budget at this time we cannot process the above
2120
             * PING request immediately. In any case we have scheduled the
2121
             * request so bump the ping deadline. If we don't do this we will
2122
             * busy-loop endlessly as the above deadline comparison condition
2123
             * will still be met.
2124
             */
2125
0
            ch_update_ping_deadline(ch);
2126
0
        }
2127
2128
        /* Queue any data to be sent for transmission. */
2129
0
        ch_tx(ch, &notify_other_threads);
2130
2131
        /* Do stream GC. */
2132
0
        ossl_quic_stream_map_gc(&ch->qsm);
2133
0
    }
2134
2135
    /* Determine the time at which we should next be ticked. */
2136
0
    res->tick_deadline = ch_determine_next_tick_deadline(ch);
2137
2138
    /*
2139
     * Always process network input unless we are now terminated. Although we
2140
     * had not terminated at the beginning of this tick, network errors in
2141
     * ch_tx() may have caused us to transition to the Terminated state.
2142
     */
2143
0
    res->net_read_desired = !ossl_quic_channel_is_terminated(ch);
2144
2145
    /* We want to write to the network if we have any data in our TX queue. */
2146
0
    res->net_write_desired
2147
0
        = (!ossl_quic_channel_is_terminated(ch)
2148
0
           && ossl_qtx_get_queue_len_datagrams(ch->qtx) > 0);
2149
2150
0
    res->notify_other_threads = notify_other_threads;
2151
0
}
2152
2153
static int ch_tick_tls(QUIC_CHANNEL *ch, int channel_only, int *notify_other_threads)
2154
0
{
2155
0
    uint64_t error_code;
2156
0
    const char *error_msg;
2157
0
    ERR_STATE *error_state = NULL;
2158
2159
0
    if (channel_only)
2160
0
        return 1;
2161
2162
0
    ch->did_tls_tick = 1;
2163
0
    ossl_quic_tls_tick(ch->qtls);
2164
2165
0
    if (ossl_quic_tls_get_error(ch->qtls, &error_code, &error_msg,
2166
0
                                &error_state)) {
2167
0
        ossl_quic_channel_raise_protocol_error_state(ch, error_code, 0,
2168
0
                                                     error_msg, error_state);
2169
0
        if (notify_other_threads != NULL)
2170
0
            *notify_other_threads = 1;
2171
2172
0
        return 0;
2173
0
    }
2174
2175
0
    return 1;
2176
0
}
2177
2178
/* Check incoming forged packet limit and terminate connection if needed. */
2179
static void ch_rx_check_forged_pkt_limit(QUIC_CHANNEL *ch)
2180
0
{
2181
0
    uint32_t enc_level;
2182
0
    uint64_t limit = UINT64_MAX, l;
2183
2184
0
    for (enc_level = QUIC_ENC_LEVEL_INITIAL;
2185
0
         enc_level < QUIC_ENC_LEVEL_NUM;
2186
0
         ++enc_level)
2187
0
    {
2188
        /*
2189
         * Different ELs can have different AEADs which can in turn impose
2190
         * different limits, so use the lowest value of any currently valid EL.
2191
         */
2192
0
        if ((ch->el_discarded & (1U << enc_level)) != 0)
2193
0
            continue;
2194
2195
0
        if (enc_level > ch->rx_enc_level)
2196
0
            break;
2197
2198
0
        l = ossl_qrx_get_max_forged_pkt_count(ch->qrx, enc_level);
2199
0
        if (l < limit)
2200
0
            limit = l;
2201
0
    }
2202
2203
0
    if (ossl_qrx_get_cur_forged_pkt_count(ch->qrx) < limit)
2204
0
        return;
2205
2206
0
    ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_AEAD_LIMIT_REACHED, 0,
2207
0
                                           "forgery limit");
2208
0
}
2209
2210
/* Process queued incoming packets and handle frames, if any. */
2211
static int ch_rx(QUIC_CHANNEL *ch, int channel_only, int *notify_other_threads)
2212
0
{
2213
0
    int handled_any = 0;
2214
0
    const int closing = ossl_quic_channel_is_closing(ch);
2215
2216
0
    if (!ch->is_server && !ch->have_sent_any_pkt)
2217
        /*
2218
         * We have not sent anything yet, therefore there is no need to check
2219
         * for incoming data.
2220
         */
2221
0
        return 1;
2222
2223
0
    for (;;) {
2224
0
        assert(ch->qrx_pkt == NULL);
2225
2226
0
        if (!ossl_qrx_read_pkt(ch->qrx, &ch->qrx_pkt))
2227
0
            break;
2228
2229
        /* Track the amount of data received while in the closing state */
2230
0
        if (closing)
2231
0
            ossl_quic_tx_packetiser_record_received_closing_bytes(
2232
0
                    ch->txp, ch->qrx_pkt->hdr->len);
2233
2234
0
        if (!handled_any) {
2235
0
            ch_update_idle(ch);
2236
0
            ch_update_ping_deadline(ch);
2237
0
        }
2238
2239
0
        ch_rx_handle_packet(ch, channel_only); /* best effort */
2240
2241
        /*
2242
         * Regardless of the outcome of frame handling, unref the packet.
2243
         * This will free the packet unless something added another
2244
         * reference to it during frame processing.
2245
         */
2246
0
        ossl_qrx_pkt_release(ch->qrx_pkt);
2247
0
        ch->qrx_pkt = NULL;
2248
2249
0
        ch->have_sent_ack_eliciting_since_rx = 0;
2250
0
        handled_any = 1;
2251
0
    }
2252
2253
0
    ch_rx_check_forged_pkt_limit(ch);
2254
2255
0
    if (handled_any && notify_other_threads != NULL)
2256
0
        *notify_other_threads = 1;
2257
2258
    /*
2259
     * When in TERMINATING - CLOSING, generate a CONN_CLOSE frame whenever we
2260
     * process one or more incoming packets.
2261
     */
2262
0
    if (handled_any && closing)
2263
0
        ch->conn_close_queued = 1;
2264
2265
0
    return 1;
2266
0
}
2267
2268
static int bio_addr_eq(const BIO_ADDR *a, const BIO_ADDR *b)
2269
0
{
2270
0
    if (BIO_ADDR_family(a) != BIO_ADDR_family(b))
2271
0
        return 0;
2272
2273
0
    switch (BIO_ADDR_family(a)) {
2274
0
        case AF_INET:
2275
0
            return !memcmp(&a->s_in.sin_addr,
2276
0
                           &b->s_in.sin_addr,
2277
0
                           sizeof(a->s_in.sin_addr))
2278
0
                && a->s_in.sin_port == b->s_in.sin_port;
2279
0
#if OPENSSL_USE_IPV6
2280
0
        case AF_INET6:
2281
0
            return !memcmp(&a->s_in6.sin6_addr,
2282
0
                           &b->s_in6.sin6_addr,
2283
0
                           sizeof(a->s_in6.sin6_addr))
2284
0
                && a->s_in6.sin6_port == b->s_in6.sin6_port;
2285
0
#endif
2286
0
        default:
2287
0
            return 0; /* not supported */
2288
0
    }
2289
2290
0
    return 1;
2291
0
}
2292
2293
/* Handles the packet currently in ch->qrx_pkt->hdr. */
2294
static void ch_rx_handle_packet(QUIC_CHANNEL *ch, int channel_only)
2295
0
{
2296
0
    uint32_t enc_level;
2297
0
    int old_have_processed_any_pkt = ch->have_processed_any_pkt;
2298
0
    OSSL_QTX_IOVEC iovec;
2299
0
    PACKET vpkt;
2300
0
    unsigned long supported_ver;
2301
2302
0
    assert(ch->qrx_pkt != NULL);
2303
2304
    /*
2305
     * RFC 9000 s. 10.2.1 Closing Connection State:
2306
     *      An endpoint that is closing is not required to process any
2307
     *      received frame.
2308
     */
2309
0
    if (!ossl_quic_channel_is_active(ch))
2310
0
        return;
2311
2312
0
    if (ossl_quic_pkt_type_is_encrypted(ch->qrx_pkt->hdr->type)) {
2313
0
        if (!ch->have_received_enc_pkt) {
2314
0
            ch->cur_remote_dcid = ch->init_scid = ch->qrx_pkt->hdr->src_conn_id;
2315
0
            ch->have_received_enc_pkt = 1;
2316
2317
            /*
2318
             * We change to using the SCID in the first Initial packet as the
2319
             * DCID.
2320
             */
2321
0
            ossl_quic_tx_packetiser_set_cur_dcid(ch->txp, &ch->init_scid);
2322
0
        }
2323
2324
0
        enc_level = ossl_quic_pkt_type_to_enc_level(ch->qrx_pkt->hdr->type);
2325
0
        if ((ch->el_discarded & (1U << enc_level)) != 0)
2326
            /* Do not process packets from ELs we have already discarded. */
2327
0
            return;
2328
0
    }
2329
2330
    /*
2331
     * RFC 9000 s. 9.6: "If a client receives packets from a new server address
2332
     * when the client has not initiated a migration to that address, the client
2333
     * SHOULD discard these packets."
2334
     *
2335
     * We need to be a bit careful here as due to the BIO abstraction layer an
2336
     * application is liable to be weird and lie to us about peer addresses.
2337
     * Only apply this check if we actually are using a real AF_INET or AF_INET6
2338
     * address.
2339
     */
2340
0
    if (!ch->is_server
2341
0
        && ch->qrx_pkt->peer != NULL
2342
0
        && (
2343
0
               BIO_ADDR_family(&ch->cur_peer_addr) == AF_INET
2344
0
#if OPENSSL_USE_IPV6
2345
0
            || BIO_ADDR_family(&ch->cur_peer_addr) == AF_INET6
2346
0
#endif
2347
0
        )
2348
0
        && !bio_addr_eq(ch->qrx_pkt->peer, &ch->cur_peer_addr))
2349
0
        return;
2350
2351
0
    if (!ch->is_server
2352
0
        && ch->have_received_enc_pkt
2353
0
        && ossl_quic_pkt_type_has_scid(ch->qrx_pkt->hdr->type)) {
2354
        /*
2355
         * RFC 9000 s. 7.2: "Once a client has received a valid Initial packet
2356
         * from the server, it MUST discard any subsequent packet it receives on
2357
         * that connection with a different SCID."
2358
         */
2359
0
        if (!ossl_quic_conn_id_eq(&ch->qrx_pkt->hdr->src_conn_id,
2360
0
                                  &ch->init_scid))
2361
0
            return;
2362
0
    }
2363
2364
0
    if (ossl_quic_pkt_type_has_version(ch->qrx_pkt->hdr->type)
2365
0
        && ch->qrx_pkt->hdr->version != QUIC_VERSION_1)
2366
        /*
2367
         * RFC 9000 s. 5.2.1: If a client receives a packet that uses a
2368
         * different version than it initially selected, it MUST discard the
2369
         * packet. We only ever use v1, so require it.
2370
         */
2371
0
        return;
2372
2373
0
    if (ch->qrx_pkt->hdr->type == QUIC_PKT_TYPE_VERSION_NEG) {
2374
2375
        /*
2376
         * Sanity check.  Version negotiation packet MUST have a version
2377
         * value of 0 according to the RFC.  We must discard such packets
2378
         */
2379
0
        if (ch->qrx_pkt->hdr->version != 0)
2380
0
            return;
2381
2382
        /*
2383
         * RFC 9000 s. 6.2: If a client receives a version negotiation
2384
         * packet, we need to do the following:
2385
         * a) If the negotiation packet lists the version we initially sent
2386
         *    then we must abandon this connection attempt
2387
         * b) We have to select a version from the list provided in the
2388
         *    version negotiation packet, and retry the connection attempt
2389
         *    in much the same way that ch_retry does, but we can reuse the
2390
         *    connection id values
2391
         */
2392
2393
0
        if (old_have_processed_any_pkt == 1) {
2394
            /*
2395
             * We've gotten previous packets, need to discard this.
2396
             */
2397
0
            return;
2398
0
        }
2399
2400
        /*
2401
         * Indicate that we have processed a packet, as any subsequently
2402
         * received version negotiation packet must be discarded above
2403
         */
2404
0
        ch->have_processed_any_pkt = 1;
2405
2406
        /*
2407
         * Following the header, version negotiation packets
2408
         * contain an array of 32 bit integers representing
2409
         * the supported versions that the server honors
2410
         * this array, bounded by the hdr->len field
2411
         * needs to be traversed so that we can find a matching
2412
         * version
2413
         */
2414
0
        if (!PACKET_buf_init(&vpkt, ch->qrx_pkt->hdr->data,
2415
0
                             ch->qrx_pkt->hdr->len))
2416
0
            return;
2417
2418
0
        while (PACKET_remaining(&vpkt) > 0) {
2419
            /*
2420
             * We only support quic version 1 at the moment, so
2421
             * look to see if thats offered
2422
             */
2423
0
            if (!PACKET_get_net_4(&vpkt, &supported_ver))
2424
0
                return;
2425
2426
0
            supported_ver = ntohl(supported_ver);
2427
0
            if (supported_ver == QUIC_VERSION_1) {
2428
                /*
2429
                 * If the server supports version 1, set it as
2430
                 * the packetisers version
2431
                 */
2432
0
                ossl_quic_tx_packetiser_set_protocol_version(ch->txp, QUIC_VERSION_1);
2433
2434
                /*
2435
                 * And then request a restart of the QUIC connection 
2436
                 */
2437
0
                if (!ch_restart(ch))
2438
0
                    ossl_quic_channel_raise_protocol_error(ch,
2439
0
                                                           OSSL_QUIC_ERR_INTERNAL_ERROR,
2440
0
                                                           0, "handling ver negotiation packet");
2441
0
                return;
2442
0
            }
2443
0
        }
2444
2445
        /*
2446
         * If we get here, then the server doesn't support a version of the
2447
         * protocol that we can handle, abandon the connection
2448
         */
2449
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_CONNECTION_REFUSED,
2450
0
                                               0, "unsupported protocol version");
2451
0
        return;
2452
0
    }
2453
2454
0
    ch->have_processed_any_pkt = 1;
2455
2456
    /*
2457
     * RFC 9000 s. 17.2: "An endpoint MUST treat receipt of a packet that has a
2458
     * non-zero value for [the reserved bits] after removing both packet and
2459
     * header protection as a connection error of type PROTOCOL_VIOLATION."
2460
     */
2461
0
    if (ossl_quic_pkt_type_is_encrypted(ch->qrx_pkt->hdr->type)
2462
0
        && ch->qrx_pkt->hdr->reserved != 0) {
2463
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
2464
0
                                               0, "packet header reserved bits");
2465
0
        return;
2466
0
    }
2467
2468
0
    iovec.buf       = ch->qrx_pkt->hdr->data;
2469
0
    iovec.buf_len   = ch->qrx_pkt->hdr->len;
2470
0
    ossl_qlog_event_transport_packet_received(ch_get_qlog(ch), ch->qrx_pkt->hdr,
2471
0
                                              ch->qrx_pkt->pn, &iovec, 1,
2472
0
                                              ch->qrx_pkt->datagram_id);
2473
2474
    /* Handle incoming packet. */
2475
0
    switch (ch->qrx_pkt->hdr->type) {
2476
0
    case QUIC_PKT_TYPE_RETRY:
2477
0
        if (ch->doing_retry || ch->is_server)
2478
            /*
2479
             * It is not allowed to ask a client to do a retry more than
2480
             * once. Clients may not send retries.
2481
             */
2482
0
            return;
2483
2484
        /*
2485
         * RFC 9000 s 17.2.5.2: After the client has received and processed an
2486
         * Initial or Retry packet from the server, it MUST discard any
2487
         * subsequent Retry packets that it receives.
2488
         */
2489
0
        if (ch->have_received_enc_pkt)
2490
0
            return;
2491
2492
0
        if (ch->qrx_pkt->hdr->len <= QUIC_RETRY_INTEGRITY_TAG_LEN)
2493
            /* Packets with zero-length Retry Tokens are invalid. */
2494
0
            return;
2495
2496
        /*
2497
         * TODO(QUIC FUTURE): Theoretically this should probably be in the QRX.
2498
         * However because validation is dependent on context (namely the
2499
         * client's initial DCID) we can't do this cleanly. In the future we
2500
         * should probably add a callback to the QRX to let it call us (via
2501
         * the DEMUX) and ask us about the correct original DCID, rather
2502
         * than allow the QRX to emit a potentially malformed packet to the
2503
         * upper layers. However, special casing this will do for now.
2504
         */
2505
0
        if (!ossl_quic_validate_retry_integrity_tag(ch->port->engine->libctx,
2506
0
                                                    ch->port->engine->propq,
2507
0
                                                    ch->qrx_pkt->hdr,
2508
0
                                                    &ch->init_dcid))
2509
            /* Malformed retry packet, ignore. */
2510
0
            return;
2511
2512
0
        if (!ch_retry(ch, ch->qrx_pkt->hdr->data,
2513
0
                      ch->qrx_pkt->hdr->len - QUIC_RETRY_INTEGRITY_TAG_LEN,
2514
0
                      &ch->qrx_pkt->hdr->src_conn_id, old_have_processed_any_pkt))
2515
0
            ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR,
2516
0
                                                   0, "handling retry packet");
2517
0
        break;
2518
2519
0
    case QUIC_PKT_TYPE_0RTT:
2520
0
        if (!ch->is_server)
2521
            /* Clients should never receive 0-RTT packets. */
2522
0
            return;
2523
2524
        /*
2525
         * TODO(QUIC 0RTT): Implement 0-RTT on the server side. We currently
2526
         * do not need to implement this as a client can only do 0-RTT if we
2527
         * have given it permission to in a previous session.
2528
         */
2529
0
        break;
2530
2531
0
    case QUIC_PKT_TYPE_INITIAL:
2532
0
    case QUIC_PKT_TYPE_HANDSHAKE:
2533
0
    case QUIC_PKT_TYPE_1RTT:
2534
0
        if (ch->is_server && ch->qrx_pkt->hdr->type == QUIC_PKT_TYPE_HANDSHAKE)
2535
            /*
2536
             * We automatically drop INITIAL EL keys when first successfully
2537
             * decrypting a HANDSHAKE packet, as per the RFC.
2538
             */
2539
0
            ch_discard_el(ch, QUIC_ENC_LEVEL_INITIAL);
2540
2541
0
        if (ch->rxku_in_progress
2542
0
            && ch->qrx_pkt->hdr->type == QUIC_PKT_TYPE_1RTT
2543
0
            && ch->qrx_pkt->pn >= ch->rxku_trigger_pn
2544
0
            && ch->qrx_pkt->key_epoch < ossl_qrx_get_key_epoch(ch->qrx)) {
2545
            /*
2546
             * RFC 9001 s. 6.4: Packets with higher packet numbers MUST be
2547
             * protected with either the same or newer packet protection keys
2548
             * than packets with lower packet numbers. An endpoint that
2549
             * successfully removes protection with old keys when newer keys
2550
             * were used for packets with lower packet numbers MUST treat this
2551
             * as a connection error of type KEY_UPDATE_ERROR.
2552
             */
2553
0
            ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_KEY_UPDATE_ERROR,
2554
0
                                                   0, "new packet with old keys");
2555
0
            break;
2556
0
        }
2557
2558
0
        if (!ch->is_server
2559
0
            && ch->qrx_pkt->hdr->type == QUIC_PKT_TYPE_INITIAL
2560
0
            && ch->qrx_pkt->hdr->token_len > 0) {
2561
            /*
2562
             * RFC 9000 s. 17.2.2: Clients that receive an Initial packet with a
2563
             * non-zero Token Length field MUST either discard the packet or
2564
             * generate a connection error of type PROTOCOL_VIOLATION.
2565
             *
2566
             * TODO(QUIC FUTURE): consider the implications of RFC 9000 s. 10.2.3
2567
             * Immediate Close during the Handshake:
2568
             *      However, at the cost of reducing feedback about
2569
             *      errors for legitimate peers, some forms of denial of
2570
             *      service can be made more difficult for an attacker
2571
             *      if endpoints discard illegal packets rather than
2572
             *      terminating a connection with CONNECTION_CLOSE. For
2573
             *      this reason, endpoints MAY discard packets rather
2574
             *      than immediately close if errors are detected in
2575
             *      packets that lack authentication.
2576
             * I.e. should we drop this packet instead of closing the connection?
2577
             */
2578
0
            ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
2579
0
                                                   0, "client received initial token");
2580
0
            break;
2581
0
        }
2582
2583
        /* This packet contains frames, pass to the RXDP. */
2584
0
        ossl_quic_handle_frames(ch, ch->qrx_pkt); /* best effort */
2585
2586
0
        if (ch->did_crypto_frame)
2587
0
            ch_tick_tls(ch, channel_only, NULL);
2588
2589
0
        break;
2590
2591
0
    case QUIC_PKT_TYPE_VERSION_NEG:
2592
        /*
2593
         * "A client MUST discard any Version Negotiation packet if it has
2594
         * received and successfully processed any other packet."
2595
         */
2596
0
        if (!old_have_processed_any_pkt)
2597
0
            ch_rx_handle_version_neg(ch, ch->qrx_pkt);
2598
2599
0
        break;
2600
2601
0
    default:
2602
0
        assert(0);
2603
0
        break;
2604
0
    }
2605
2606
0
}
2607
2608
static void ch_rx_handle_version_neg(QUIC_CHANNEL *ch, OSSL_QRX_PKT *pkt)
2609
0
{
2610
    /*
2611
     * We do not support version negotiation at this time. As per RFC 9000 s.
2612
     * 6.2., we MUST abandon the connection attempt if we receive a Version
2613
     * Negotiation packet, unless we have already successfully processed another
2614
     * incoming packet, or the packet lists the QUIC version we want to use.
2615
     */
2616
0
    PACKET vpkt;
2617
0
    unsigned long v;
2618
2619
0
    if (!PACKET_buf_init(&vpkt, pkt->hdr->data, pkt->hdr->len))
2620
0
        return;
2621
2622
0
    while (PACKET_remaining(&vpkt) > 0) {
2623
0
        if (!PACKET_get_net_4(&vpkt, &v))
2624
0
            break;
2625
2626
0
        if ((uint32_t)v == QUIC_VERSION_1)
2627
0
            return;
2628
0
    }
2629
2630
    /* No match, this is a failure case. */
2631
0
    ch_raise_version_neg_failure(ch);
2632
0
}
2633
2634
static void ch_raise_version_neg_failure(QUIC_CHANNEL *ch)
2635
0
{
2636
0
    QUIC_TERMINATE_CAUSE tcause = {0};
2637
2638
0
    tcause.error_code = OSSL_QUIC_ERR_CONNECTION_REFUSED;
2639
0
    tcause.reason     = "version negotiation failure";
2640
0
    tcause.reason_len = strlen(tcause.reason);
2641
2642
    /*
2643
     * Skip TERMINATING state; this is not considered a protocol error and we do
2644
     * not send CONNECTION_CLOSE.
2645
     */
2646
0
    ch_start_terminating(ch, &tcause, 1);
2647
0
}
2648
2649
/* Try to generate packets and if possible, flush them to the network. */
2650
static int ch_tx(QUIC_CHANNEL *ch, int *notify_other_threads)
2651
0
{
2652
0
    QUIC_TXP_STATUS status;
2653
0
    int res;
2654
2655
    /*
2656
     * RFC 9000 s. 10.2.2: Draining Connection State:
2657
     *      While otherwise identical to the closing state, an endpoint
2658
     *      in the draining state MUST NOT send any packets.
2659
     * and:
2660
     *      An endpoint MUST NOT send further packets.
2661
     */
2662
0
    if (ossl_quic_channel_is_draining(ch))
2663
0
        return 0;
2664
2665
0
    if (ossl_quic_channel_is_closing(ch)) {
2666
        /*
2667
         * While closing, only send CONN_CLOSE if we've received more traffic
2668
         * from the peer. Once we tell the TXP to generate CONN_CLOSE, all
2669
         * future calls to it generate CONN_CLOSE frames, so otherwise we would
2670
         * just constantly generate CONN_CLOSE frames.
2671
         *
2672
         * Confirming to RFC 9000 s. 10.2.1 Closing Connection State:
2673
         *      An endpoint SHOULD limit the rate at which it generates
2674
         *      packets in the closing state.
2675
         */
2676
0
        if (!ch->conn_close_queued)
2677
0
            return 0;
2678
2679
0
        ch->conn_close_queued = 0;
2680
0
    }
2681
2682
    /* Do TXKU if we need to. */
2683
0
    ch_maybe_trigger_spontaneous_txku(ch);
2684
2685
0
    ch->rxku_pending_confirm_done = 0;
2686
2687
    /* Loop until we stop generating packets to send */
2688
0
    do {
2689
        /*
2690
        * Send packet, if we need to. Best effort. The TXP consults the CC and
2691
        * applies any limitations imposed by it, so we don't need to do it here.
2692
        *
2693
        * Best effort. In particular if TXP fails for some reason we should
2694
        * still flush any queued packets which we already generated.
2695
        */
2696
0
        res = ossl_quic_tx_packetiser_generate(ch->txp, &status);
2697
0
        if (status.sent_pkt > 0) {
2698
0
            ch->have_sent_any_pkt = 1; /* Packet(s) were sent */
2699
0
            ch->port->have_sent_any_pkt = 1;
2700
2701
            /*
2702
            * RFC 9000 s. 10.1. 'An endpoint also restarts its idle timer when
2703
            * sending an ack-eliciting packet if no other ack-eliciting packets
2704
            * have been sent since last receiving and processing a packet.'
2705
            */
2706
0
            if (status.sent_ack_eliciting
2707
0
                    && !ch->have_sent_ack_eliciting_since_rx) {
2708
0
                ch_update_idle(ch);
2709
0
                ch->have_sent_ack_eliciting_since_rx = 1;
2710
0
            }
2711
2712
0
            if (!ch->is_server && status.sent_handshake)
2713
                /*
2714
                * RFC 9001 s. 4.9.1: A client MUST discard Initial keys when it
2715
                * first sends a Handshake packet.
2716
                */
2717
0
                ch_discard_el(ch, QUIC_ENC_LEVEL_INITIAL);
2718
2719
0
            if (ch->rxku_pending_confirm_done)
2720
0
                ch->rxku_pending_confirm = 0;
2721
2722
0
            ch_update_ping_deadline(ch);
2723
0
        }
2724
2725
0
        if (!res) {
2726
            /*
2727
            * One case where TXP can fail is if we reach a TX PN of 2**62 - 1.
2728
            * As per RFC 9000 s. 12.3, if this happens we MUST close the
2729
            * connection without sending a CONNECTION_CLOSE frame. This is
2730
            * actually handled as an emergent consequence of our design, as the
2731
            * TX packetiser will never transmit another packet when the TX PN
2732
            * reaches the limit.
2733
            *
2734
            * Calling the below function terminates the connection; its attempt
2735
            * to schedule a CONNECTION_CLOSE frame will not actually cause a
2736
            * packet to be transmitted for this reason.
2737
            */
2738
0
            ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INTERNAL_ERROR,
2739
0
                                                   0,
2740
0
                                                   "internal error (txp generate)");
2741
0
            break;
2742
0
        }
2743
0
    } while (status.sent_pkt > 0);
2744
2745
    /* Flush packets to network. */
2746
0
    switch (ossl_qtx_flush_net(ch->qtx)) {
2747
0
    case QTX_FLUSH_NET_RES_OK:
2748
0
    case QTX_FLUSH_NET_RES_TRANSIENT_FAIL:
2749
        /* Best effort, done for now. */
2750
0
        break;
2751
2752
0
    case QTX_FLUSH_NET_RES_PERMANENT_FAIL:
2753
0
    default:
2754
        /* Permanent underlying network BIO, start terminating. */
2755
0
        ossl_quic_port_raise_net_error(ch->port, ch);
2756
0
        break;
2757
0
    }
2758
2759
    /*
2760
     * If we have datagrams we have yet to successfully transmit, we need to
2761
     * notify other threads so that they can switch to polling on POLLOUT as
2762
     * well as POLLIN.
2763
     */
2764
0
    if (ossl_qtx_get_queue_len_datagrams(ch->qtx) > 0)
2765
0
        *notify_other_threads = 1;
2766
2767
0
    return 1;
2768
0
}
2769
2770
/* Determine next tick deadline. */
2771
static OSSL_TIME ch_determine_next_tick_deadline(QUIC_CHANNEL *ch)
2772
0
{
2773
0
    OSSL_TIME deadline;
2774
0
    int i;
2775
2776
0
    if (ossl_quic_channel_is_terminated(ch))
2777
0
        return ossl_time_infinite();
2778
2779
0
    deadline = ossl_ackm_get_loss_detection_deadline(ch->ackm);
2780
0
    if (ossl_time_is_zero(deadline))
2781
0
        deadline = ossl_time_infinite();
2782
2783
    /*
2784
     * Check the ack deadline for all enc_levels that are actually provisioned.
2785
     * ACKs aren't restricted by CC.
2786
     */
2787
0
    for (i = 0; i < QUIC_ENC_LEVEL_NUM; i++) {
2788
0
        if (ossl_qtx_is_enc_level_provisioned(ch->qtx, i)) {
2789
0
            deadline = ossl_time_min(deadline,
2790
0
                                     ossl_ackm_get_ack_deadline(ch->ackm,
2791
0
                                                                ossl_quic_enc_level_to_pn_space(i)));
2792
0
        }
2793
0
    }
2794
2795
    /*
2796
     * When do we need to send an ACK-eliciting packet to reset the idle
2797
     * deadline timer for the peer?
2798
     */
2799
0
    if (!ossl_time_is_infinite(ch->ping_deadline))
2800
0
        deadline = ossl_time_min(deadline, ch->ping_deadline);
2801
2802
    /* Apply TXP wakeup deadline. */
2803
0
    deadline = ossl_time_min(deadline,
2804
0
                             ossl_quic_tx_packetiser_get_deadline(ch->txp));
2805
2806
    /* Is the terminating timer armed? */
2807
0
    if (ossl_quic_channel_is_terminating(ch))
2808
0
        deadline = ossl_time_min(deadline,
2809
0
                                 ch->terminate_deadline);
2810
0
    else if (!ossl_time_is_infinite(ch->idle_deadline))
2811
0
        deadline = ossl_time_min(deadline,
2812
0
                                 ch->idle_deadline);
2813
2814
    /* When does the RXKU process complete? */
2815
0
    if (ch->rxku_in_progress)
2816
0
        deadline = ossl_time_min(deadline, ch->rxku_update_end_deadline);
2817
2818
0
    return deadline;
2819
0
}
2820
2821
/*
2822
 * QUIC Channel: Lifecycle Events
2823
 * ==============================
2824
 */
2825
2826
/*
2827
 * Record a state transition. This is not necessarily a change to ch->state but
2828
 * also includes the handshake becoming complete or confirmed, etc.
2829
 */
2830
static void ch_record_state_transition(QUIC_CHANNEL *ch, uint32_t new_state)
2831
0
{
2832
0
    uint32_t old_state = ch->state;
2833
2834
0
    ch->state = new_state;
2835
2836
0
    ossl_qlog_event_connectivity_connection_state_updated(ch_get_qlog(ch),
2837
0
                                                          old_state,
2838
0
                                                          new_state,
2839
0
                                                          ch->handshake_complete,
2840
0
                                                          ch->handshake_confirmed);
2841
0
}
2842
2843
static void free_peer_token(const unsigned char *token,
2844
                            size_t token_len, void *arg)
2845
0
{
2846
0
    ossl_quic_free_peer_token((QUIC_TOKEN *)arg);
2847
0
}
2848
2849
int ossl_quic_channel_start(QUIC_CHANNEL *ch)
2850
0
{
2851
0
    QUIC_TOKEN *token;
2852
2853
0
    if (ch->is_server)
2854
        /*
2855
         * This is not used by the server. The server moves to active
2856
         * automatically on receiving an incoming connection.
2857
         */
2858
0
        return 0;
2859
2860
0
    if (ch->state != QUIC_CHANNEL_STATE_IDLE)
2861
        /* Calls to connect are idempotent */
2862
0
        return 1;
2863
2864
    /* Inform QTX of peer address. */
2865
0
    if (!ossl_quic_tx_packetiser_set_peer(ch->txp, &ch->cur_peer_addr))
2866
0
        return 0;
2867
2868
    /*
2869
     * Look to see if we have a token, and if so, set it on the packetiser
2870
     */
2871
0
    if (!ch->is_server
2872
0
        && ossl_quic_get_peer_token(ch->port->channel_ctx,
2873
0
                                    &ch->cur_peer_addr,
2874
0
                                    &token)
2875
0
        && !ossl_quic_tx_packetiser_set_initial_token(ch->txp, token->token,
2876
0
                                                      token->token_len,
2877
0
                                                      free_peer_token,
2878
0
                                                      token))
2879
0
        free_peer_token(NULL, 0, token);
2880
2881
    /* Plug in secrets for the Initial EL. */
2882
0
    if (!ossl_quic_provide_initial_secret(ch->port->engine->libctx,
2883
0
                                          ch->port->engine->propq,
2884
0
                                          &ch->init_dcid,
2885
0
                                          ch->is_server,
2886
0
                                          ch->qrx, ch->qtx))
2887
0
        return 0;
2888
2889
    /*
2890
     * Determine the QUIC Transport Parameters and serialize the transport
2891
     * parameters block. (For servers, we do this later as we must defer
2892
     * generation until we have received the client's transport parameters.)
2893
     */
2894
0
    if (!ch->is_server && !ch->got_local_transport_params
2895
0
        && !ch_generate_transport_params(ch))
2896
0
        return 0;
2897
2898
    /* Change state. */
2899
0
    ch_record_state_transition(ch, QUIC_CHANNEL_STATE_ACTIVE);
2900
0
    ch->doing_proactive_ver_neg = 0; /* not currently supported */
2901
2902
0
    ossl_qlog_event_connectivity_connection_started(ch_get_qlog(ch),
2903
0
                                                    &ch->init_dcid);
2904
2905
    /* Handshake layer: start (e.g. send CH). */
2906
0
    if (!ch_tick_tls(ch, /*channel_only=*/0, NULL))
2907
0
        return 0;
2908
2909
0
    ossl_quic_reactor_tick(ossl_quic_port_get0_reactor(ch->port), 0); /* best effort */
2910
0
    return 1;
2911
0
}
2912
2913
static void free_token(const unsigned char *token, size_t token_len, void *arg)
2914
0
{
2915
0
    OPENSSL_free((char *)token);
2916
0
}
2917
2918
/* Start a locally initiated connection shutdown. */
2919
void ossl_quic_channel_local_close(QUIC_CHANNEL *ch, uint64_t app_error_code,
2920
                                   const char *app_reason)
2921
0
{
2922
0
    QUIC_TERMINATE_CAUSE tcause = {0};
2923
2924
0
    if (ossl_quic_channel_is_term_any(ch))
2925
0
        return;
2926
2927
0
    tcause.app          = 1;
2928
0
    tcause.error_code   = app_error_code;
2929
0
    tcause.reason       = app_reason;
2930
0
    tcause.reason_len   = app_reason != NULL ? strlen(app_reason) : 0;
2931
0
    ch_start_terminating(ch, &tcause, 0);
2932
0
}
2933
2934
/**
2935
 * ch_restart - Restarts the QUIC channel by simulating loss of the initial
2936
 * packet. This forces the packet to be regenerated with the updated protocol
2937
 * version number.
2938
 *
2939
 * @ch: Pointer to the QUIC_CHANNEL structure.
2940
 *
2941
 * Returns 1 on success, 0 on failure.
2942
 */
2943
static int ch_restart(QUIC_CHANNEL *ch)
2944
0
{
2945
    /*
2946
     * Just pretend we lost our initial packet, so it gets
2947
     * regenerated, with our updated protocol version number
2948
     */
2949
0
   return ossl_ackm_mark_packet_pseudo_lost(ch->ackm, QUIC_PN_SPACE_INITIAL,
2950
0
                                            /* PN= */ 0);
2951
0
}
2952
2953
/* Called when a server asks us to do a retry. */
2954
static int ch_retry(QUIC_CHANNEL *ch,
2955
                    const unsigned char *retry_token,
2956
                    size_t retry_token_len,
2957
                    const QUIC_CONN_ID *retry_scid,
2958
                    int drop_later_pn)
2959
0
{
2960
0
    void *buf;
2961
0
    QUIC_PN pn = 0;
2962
2963
    /*
2964
     * RFC 9000 s. 17.2.5.1: "A client MUST discard a Retry packet that contains
2965
     * a SCID field that is identical to the DCID field of its initial packet."
2966
     */
2967
0
    if (ossl_quic_conn_id_eq(&ch->init_dcid, retry_scid))
2968
0
        return 1;
2969
2970
    /* We change to using the SCID in the Retry packet as the DCID. */
2971
0
    if (!ossl_quic_tx_packetiser_set_cur_dcid(ch->txp, retry_scid))
2972
0
        return 0;
2973
2974
    /*
2975
     * Now we retry. We will release the Retry packet immediately, so copy
2976
     * the token.
2977
     */
2978
0
    if ((buf = OPENSSL_memdup(retry_token, retry_token_len)) == NULL)
2979
0
        return 0;
2980
2981
0
    if (!ossl_quic_tx_packetiser_set_initial_token(ch->txp, buf,
2982
0
                                                   retry_token_len,
2983
0
                                                   free_token, NULL)) {
2984
        /*
2985
         * This may fail if the token we receive is too big for us to ever be
2986
         * able to transmit in an outgoing Initial packet.
2987
         */
2988
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_INVALID_TOKEN, 0,
2989
0
                                               "received oversize token");
2990
0
        OPENSSL_free(buf);
2991
0
        return 0;
2992
0
    }
2993
2994
0
    ch->retry_scid  = *retry_scid;
2995
0
    ch->doing_retry = 1;
2996
2997
    /*
2998
     * If a retry isn't our first response, we need to drop packet number
2999
     * one instead (i.e. the case where we did version negotiation first
3000
     */
3001
0
    if (drop_later_pn == 1)
3002
0
        pn = 1;
3003
3004
    /*
3005
     * We need to stimulate the Initial EL to generate the first CRYPTO frame
3006
     * again. We can do this most cleanly by simply forcing the ACKM to consider
3007
     * the first Initial packet as lost, which it effectively was as the server
3008
     * hasn't processed it. This also maintains the desired behaviour with e.g.
3009
     * PNs not resetting and so on.
3010
     *
3011
     * The PN we used initially is always zero, because QUIC does not allow
3012
     * repeated retries.
3013
     */
3014
0
    if (!ossl_ackm_mark_packet_pseudo_lost(ch->ackm, QUIC_PN_SPACE_INITIAL,
3015
0
                                           pn))
3016
0
        return 0;
3017
3018
    /*
3019
     * Plug in new secrets for the Initial EL. This is the only time we change
3020
     * the secrets for an EL after we already provisioned it.
3021
     */
3022
0
    if (!ossl_quic_provide_initial_secret(ch->port->engine->libctx,
3023
0
                                          ch->port->engine->propq,
3024
0
                                          &ch->retry_scid,
3025
0
                                          /*is_server=*/0,
3026
0
                                          ch->qrx, ch->qtx))
3027
0
        return 0;
3028
3029
0
    return 1;
3030
0
}
3031
3032
/* Called when an EL is to be discarded. */
3033
static int ch_discard_el(QUIC_CHANNEL *ch,
3034
                         uint32_t enc_level)
3035
0
{
3036
0
    if (!ossl_assert(enc_level < QUIC_ENC_LEVEL_1RTT))
3037
0
        return 0;
3038
3039
0
    if ((ch->el_discarded & (1U << enc_level)) != 0)
3040
        /* Already done. */
3041
0
        return 1;
3042
3043
    /* Best effort for all of these. */
3044
0
    ossl_quic_tx_packetiser_discard_enc_level(ch->txp, enc_level);
3045
0
    ossl_qrx_discard_enc_level(ch->qrx, enc_level);
3046
0
    ossl_qtx_discard_enc_level(ch->qtx, enc_level);
3047
3048
0
    if (enc_level != QUIC_ENC_LEVEL_0RTT) {
3049
0
        uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level);
3050
3051
0
        ossl_ackm_on_pkt_space_discarded(ch->ackm, pn_space);
3052
3053
        /* We should still have crypto streams at this point. */
3054
0
        if (!ossl_assert(ch->crypto_send[pn_space] != NULL)
3055
0
            || !ossl_assert(ch->crypto_recv[pn_space] != NULL))
3056
0
            return 0;
3057
3058
        /* Get rid of the crypto stream state for the EL. */
3059
0
        ossl_quic_sstream_free(ch->crypto_send[pn_space]);
3060
0
        ch->crypto_send[pn_space] = NULL;
3061
3062
0
        ossl_quic_rstream_free(ch->crypto_recv[pn_space]);
3063
0
        ch->crypto_recv[pn_space] = NULL;
3064
0
    }
3065
3066
0
    ch->el_discarded |= (1U << enc_level);
3067
0
    return 1;
3068
0
}
3069
3070
/* Intended to be called by the RXDP. */
3071
int ossl_quic_channel_on_handshake_confirmed(QUIC_CHANNEL *ch)
3072
0
{
3073
0
    if (ch->handshake_confirmed)
3074
0
        return 1;
3075
3076
0
    if (!ch->handshake_complete) {
3077
        /*
3078
         * Does not make sense for handshake to be confirmed before it is
3079
         * completed.
3080
         */
3081
0
        ossl_quic_channel_raise_protocol_error(ch, OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
3082
0
                                               OSSL_QUIC_FRAME_TYPE_HANDSHAKE_DONE,
3083
0
                                               "handshake cannot be confirmed "
3084
0
                                               "before it is completed");
3085
0
        return 0;
3086
0
    }
3087
3088
0
    ch_discard_el(ch, QUIC_ENC_LEVEL_HANDSHAKE);
3089
0
    ch->handshake_confirmed = 1;
3090
0
    ch_record_state_transition(ch, ch->state);
3091
0
    ossl_ackm_on_handshake_confirmed(ch->ackm);
3092
0
    return 1;
3093
0
}
3094
3095
/*
3096
 * Master function used when we want to start tearing down a connection:
3097
 *
3098
 *   - If the connection is still IDLE we can go straight to TERMINATED;
3099
 *
3100
 *   - If we are already TERMINATED this is a no-op.
3101
 *
3102
 *   - If we are TERMINATING - CLOSING and we have now got a CONNECTION_CLOSE
3103
 *     from the peer (tcause->remote == 1), we move to TERMINATING - DRAINING.
3104
 *
3105
 *   - If we are TERMINATING - DRAINING, we remain here until the terminating
3106
 *     timer expires.
3107
 *
3108
 *   - Otherwise, we are in ACTIVE and move to TERMINATING - CLOSING.
3109
 *     if we caused the termination (e.g. we have sent a CONNECTION_CLOSE). Note
3110
 *     that we are considered to have caused a termination if we sent the first
3111
 *     CONNECTION_CLOSE frame, even if it is caused by a peer protocol
3112
 *     violation. If the peer sent the first CONNECTION_CLOSE frame, we move to
3113
 *     TERMINATING - DRAINING.
3114
 *
3115
 * We record the termination cause structure passed on the first call only.
3116
 * Any successive calls have their termination cause data discarded;
3117
 * once we start sending a CONNECTION_CLOSE frame, we don't change the details
3118
 * in it.
3119
 *
3120
 * This conforms to RFC 9000 s. 10.2.1: Closing Connection State:
3121
 *      To minimize the state that an endpoint maintains for a closing
3122
 *      connection, endpoints MAY send the exact same packet in response
3123
 *      to any received packet.
3124
 *
3125
 * We don't drop any connection state (specifically packet protection keys)
3126
 * even though we are permitted to.  This conforms to RFC 9000 s. 10.2.1:
3127
 * Closing Connection State:
3128
 *       An endpoint MAY retain packet protection keys for incoming
3129
 *       packets to allow it to read and process a CONNECTION_CLOSE frame.
3130
 *
3131
 * Note that we do not conform to these two from the same section:
3132
 *      An endpoint's selected connection ID and the QUIC version
3133
 *      are sufficient information to identify packets for a closing
3134
 *      connection; the endpoint MAY discard all other connection state.
3135
 * and:
3136
 *      An endpoint MAY drop packet protection keys when entering the
3137
 *      closing state and send a packet containing a CONNECTION_CLOSE
3138
 *      frame in response to any UDP datagram that is received.
3139
 */
3140
static void copy_tcause(QUIC_TERMINATE_CAUSE *dst,
3141
                        const QUIC_TERMINATE_CAUSE *src)
3142
0
{
3143
0
    dst->error_code = src->error_code;
3144
0
    dst->frame_type = src->frame_type;
3145
0
    dst->app        = src->app;
3146
0
    dst->remote     = src->remote;
3147
3148
0
    dst->reason     = NULL;
3149
0
    dst->reason_len = 0;
3150
3151
0
    if (src->reason != NULL && src->reason_len > 0) {
3152
0
        size_t l = src->reason_len;
3153
0
        char *r;
3154
3155
0
        if (l >= SIZE_MAX)
3156
0
            --l;
3157
3158
        /*
3159
         * If this fails, dst->reason becomes NULL and we simply do not use a
3160
         * reason. This ensures termination is infallible.
3161
         */
3162
0
        dst->reason = r = OPENSSL_memdup(src->reason, l + 1);
3163
0
        if (r == NULL)
3164
0
            return;
3165
3166
0
        r[l]  = '\0';
3167
0
        dst->reason_len = l;
3168
0
    }
3169
0
}
3170
3171
static void ch_start_terminating(QUIC_CHANNEL *ch,
3172
                                 const QUIC_TERMINATE_CAUSE *tcause,
3173
                                 int force_immediate)
3174
0
{
3175
    /* No point sending anything if we haven't sent anything yet. */
3176
0
    if (!ch->have_sent_any_pkt)
3177
0
        force_immediate = 1;
3178
3179
0
    switch (ch->state) {
3180
0
    default:
3181
0
    case QUIC_CHANNEL_STATE_IDLE:
3182
0
        copy_tcause(&ch->terminate_cause, tcause);
3183
0
        ch_on_terminating_timeout(ch);
3184
0
        break;
3185
3186
0
    case QUIC_CHANNEL_STATE_ACTIVE:
3187
0
        copy_tcause(&ch->terminate_cause, tcause);
3188
3189
0
        ossl_qlog_event_connectivity_connection_closed(ch_get_qlog(ch), tcause);
3190
3191
0
        if (!force_immediate) {
3192
0
            ch_record_state_transition(ch, tcause->remote
3193
0
                                           ? QUIC_CHANNEL_STATE_TERMINATING_DRAINING
3194
0
                                           : QUIC_CHANNEL_STATE_TERMINATING_CLOSING);
3195
            /*
3196
             * RFC 9000 s. 10.2 Immediate Close
3197
             *  These states SHOULD persist for at least three times
3198
             *  the current PTO interval as defined in [QUIC-RECOVERY].
3199
             */
3200
0
            ch->terminate_deadline
3201
0
                = ossl_time_add(get_time(ch),
3202
0
                                ossl_time_multiply(ossl_ackm_get_pto_duration(ch->ackm),
3203
0
                                                   3));
3204
3205
0
            if (!tcause->remote) {
3206
0
                OSSL_QUIC_FRAME_CONN_CLOSE f = {0};
3207
3208
                /* best effort */
3209
0
                f.error_code = ch->terminate_cause.error_code;
3210
0
                f.frame_type = ch->terminate_cause.frame_type;
3211
0
                f.is_app     = ch->terminate_cause.app;
3212
0
                f.reason     = (char *)ch->terminate_cause.reason;
3213
0
                f.reason_len = ch->terminate_cause.reason_len;
3214
0
                ossl_quic_tx_packetiser_schedule_conn_close(ch->txp, &f);
3215
                /*
3216
                 * RFC 9000 s. 10.2.2 Draining Connection State:
3217
                 *  An endpoint that receives a CONNECTION_CLOSE frame MAY
3218
                 *  send a single packet containing a CONNECTION_CLOSE
3219
                 *  frame before entering the draining state, using a
3220
                 *  NO_ERROR code if appropriate
3221
                 */
3222
0
                ch->conn_close_queued = 1;
3223
0
            }
3224
0
        } else {
3225
0
            ch_on_terminating_timeout(ch);
3226
0
        }
3227
0
        break;
3228
3229
0
    case QUIC_CHANNEL_STATE_TERMINATING_CLOSING:
3230
0
        if (force_immediate)
3231
0
            ch_on_terminating_timeout(ch);
3232
0
        else if (tcause->remote)
3233
            /*
3234
             * RFC 9000 s. 10.2.2 Draining Connection State:
3235
             *  An endpoint MAY enter the draining state from the
3236
             *  closing state if it receives a CONNECTION_CLOSE frame,
3237
             *  which indicates that the peer is also closing or draining.
3238
             */
3239
0
            ch_record_state_transition(ch, QUIC_CHANNEL_STATE_TERMINATING_DRAINING);
3240
3241
0
        break;
3242
3243
0
    case QUIC_CHANNEL_STATE_TERMINATING_DRAINING:
3244
        /*
3245
         * Other than in the force-immediate case, we remain here until the
3246
         * timeout expires.
3247
         */
3248
0
        if (force_immediate)
3249
0
            ch_on_terminating_timeout(ch);
3250
3251
0
        break;
3252
3253
0
    case QUIC_CHANNEL_STATE_TERMINATED:
3254
        /* No-op. */
3255
0
        break;
3256
0
    }
3257
0
}
3258
3259
/* For RXDP use. */
3260
void ossl_quic_channel_on_remote_conn_close(QUIC_CHANNEL *ch,
3261
                                            OSSL_QUIC_FRAME_CONN_CLOSE *f)
3262
0
{
3263
0
    QUIC_TERMINATE_CAUSE tcause = {0};
3264
3265
0
    if (!ossl_quic_channel_is_active(ch))
3266
0
        return;
3267
3268
0
    tcause.remote     = 1;
3269
0
    tcause.app        = f->is_app;
3270
0
    tcause.error_code = f->error_code;
3271
0
    tcause.frame_type = f->frame_type;
3272
0
    tcause.reason     = f->reason;
3273
0
    tcause.reason_len = f->reason_len;
3274
0
    ch_start_terminating(ch, &tcause, 0);
3275
0
}
3276
3277
static void free_frame_data(unsigned char *buf, size_t buf_len, void *arg)
3278
0
{
3279
0
    OPENSSL_free(buf);
3280
0
}
3281
3282
static int ch_enqueue_retire_conn_id(QUIC_CHANNEL *ch, uint64_t seq_num)
3283
0
{
3284
0
    BUF_MEM *buf_mem = NULL;
3285
0
    WPACKET wpkt;
3286
0
    size_t l;
3287
3288
0
    ossl_quic_srtm_remove(ch->srtm, ch, seq_num);
3289
3290
0
    if ((buf_mem = BUF_MEM_new()) == NULL)
3291
0
        goto err;
3292
3293
0
    if (!WPACKET_init(&wpkt, buf_mem))
3294
0
        goto err;
3295
3296
0
    if (!ossl_quic_wire_encode_frame_retire_conn_id(&wpkt, seq_num)) {
3297
0
        WPACKET_cleanup(&wpkt);
3298
0
        goto err;
3299
0
    }
3300
3301
0
    WPACKET_finish(&wpkt);
3302
0
    if (!WPACKET_get_total_written(&wpkt, &l))
3303
0
        goto err;
3304
3305
0
    if (ossl_quic_cfq_add_frame(ch->cfq, 1, QUIC_PN_SPACE_APP,
3306
0
                                OSSL_QUIC_FRAME_TYPE_RETIRE_CONN_ID, 0,
3307
0
                                (unsigned char *)buf_mem->data, l,
3308
0
                                free_frame_data, NULL) == NULL)
3309
0
        goto err;
3310
3311
0
    buf_mem->data = NULL;
3312
0
    BUF_MEM_free(buf_mem);
3313
0
    return 1;
3314
3315
0
err:
3316
0
    ossl_quic_channel_raise_protocol_error(ch,
3317
0
                                           OSSL_QUIC_ERR_INTERNAL_ERROR,
3318
0
                                           OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID,
3319
0
                                           "internal error enqueueing retire conn id");
3320
0
    BUF_MEM_free(buf_mem);
3321
0
    return 0;
3322
0
}
3323
3324
void ossl_quic_channel_on_new_conn_id(QUIC_CHANNEL *ch,
3325
                                      OSSL_QUIC_FRAME_NEW_CONN_ID *f)
3326
0
{
3327
0
    uint64_t new_remote_seq_num = ch->cur_remote_seq_num;
3328
0
    uint64_t new_retire_prior_to = ch->cur_retire_prior_to;
3329
3330
0
    if (!ossl_quic_channel_is_active(ch))
3331
0
        return;
3332
3333
    /* We allow only two active connection ids; first check some constraints */
3334
0
    if (ch->cur_remote_dcid.id_len == 0) {
3335
        /* Changing from 0 length connection id is disallowed */
3336
0
        ossl_quic_channel_raise_protocol_error(ch,
3337
0
                                               OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
3338
0
                                               OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID,
3339
0
                                               "zero length connection id in use");
3340
3341
0
        return;
3342
0
    }
3343
3344
0
    if (f->seq_num > new_remote_seq_num)
3345
0
        new_remote_seq_num = f->seq_num;
3346
0
    if (f->retire_prior_to > new_retire_prior_to)
3347
0
        new_retire_prior_to = f->retire_prior_to;
3348
3349
    /*
3350
     * RFC 9000-5.1.1: An endpoint MUST NOT provide more connection IDs
3351
     * than the peer's limit.
3352
     *
3353
     * After processing a NEW_CONNECTION_ID frame and adding and retiring
3354
     * active connection IDs, if the number of active connection IDs exceeds
3355
     * the value advertised in its active_connection_id_limit transport
3356
     * parameter, an endpoint MUST close the connection with an error of
3357
     * type CONNECTION_ID_LIMIT_ERROR.
3358
     */
3359
0
    if (new_remote_seq_num - new_retire_prior_to > 1) {
3360
0
        ossl_quic_channel_raise_protocol_error(ch,
3361
0
                                               OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR,
3362
0
                                               OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID,
3363
0
                                               "active_connection_id limit violated");
3364
0
        return;
3365
0
    }
3366
3367
    /*
3368
     * RFC 9000-5.1.1: An endpoint MAY send connection IDs that temporarily
3369
     * exceed a peer's limit if the NEW_CONNECTION_ID frame also requires
3370
     * the retirement of any excess, by including a sufficiently large
3371
     * value in the Retire Prior To field.
3372
     *
3373
     * RFC 9000-5.1.2: An endpoint SHOULD allow for sending and tracking
3374
     * a number of RETIRE_CONNECTION_ID frames of at least twice the value
3375
     * of the active_connection_id_limit transport parameter.  An endpoint
3376
     * MUST NOT forget a connection ID without retiring it, though it MAY
3377
     * choose to treat having connection IDs in need of retirement that
3378
     * exceed this limit as a connection error of type CONNECTION_ID_LIMIT_ERROR.
3379
     *
3380
     * We are a little bit more liberal than the minimum mandated.
3381
     */
3382
0
    if (new_retire_prior_to - ch->cur_retire_prior_to > 10) {
3383
0
        ossl_quic_channel_raise_protocol_error(ch,
3384
0
                                               OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR,
3385
0
                                               OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID,
3386
0
                                               "retiring connection id limit violated");
3387
3388
0
        return;
3389
0
    }
3390
3391
0
    if (new_remote_seq_num > ch->cur_remote_seq_num) {
3392
        /* Add new stateless reset token */
3393
0
        if (!ossl_quic_srtm_add(ch->srtm, ch, new_remote_seq_num,
3394
0
                                &f->stateless_reset)) {
3395
0
            ossl_quic_channel_raise_protocol_error(
3396
0
                    ch, OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR,
3397
0
                    OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID,
3398
0
                    "unable to store stateless reset token");
3399
3400
0
            return;
3401
0
        }
3402
0
        ch->cur_remote_seq_num = new_remote_seq_num;
3403
0
        ch->cur_remote_dcid = f->conn_id;
3404
0
        ossl_quic_tx_packetiser_set_cur_dcid(ch->txp, &ch->cur_remote_dcid);
3405
0
    }
3406
3407
    /*
3408
     * RFC 9000-5.1.2: Upon receipt of an increased Retire Prior To
3409
     * field, the peer MUST stop using the corresponding connection IDs
3410
     * and retire them with RETIRE_CONNECTION_ID frames before adding the
3411
     * newly provided connection ID to the set of active connection IDs.
3412
     */
3413
3414
    /*
3415
     * Note: RFC 9000 s. 19.15 says:
3416
     *   "An endpoint that receives a NEW_CONNECTION_ID frame with a sequence
3417
     *    number smaller than the Retire Prior To field of a previously received
3418
     *    NEW_CONNECTION_ID frame MUST send a corresponding
3419
     *    RETIRE_CONNECTION_ID frame that retires the newly received connection
3420
     *    ID, unless it has already done so for that sequence number."
3421
     *
3422
     * Since we currently always queue RETIRE_CONN_ID frames based on the Retire
3423
     * Prior To field of a NEW_CONNECTION_ID frame immediately upon receiving
3424
     * that NEW_CONNECTION_ID frame, by definition this will always be met.
3425
     * This may change in future when we change our CID handling.
3426
     */
3427
0
    while (new_retire_prior_to > ch->cur_retire_prior_to) {
3428
0
        if (!ch_enqueue_retire_conn_id(ch, ch->cur_retire_prior_to))
3429
0
            break;
3430
0
        ++ch->cur_retire_prior_to;
3431
0
    }
3432
0
}
3433
3434
static void ch_save_err_state(QUIC_CHANNEL *ch)
3435
0
{
3436
0
    if (ch->err_state == NULL)
3437
0
        ch->err_state = OSSL_ERR_STATE_new();
3438
3439
0
    if (ch->err_state == NULL)
3440
0
        return;
3441
3442
0
    OSSL_ERR_STATE_save(ch->err_state);
3443
0
}
3444
3445
void ossl_quic_channel_inject(QUIC_CHANNEL *ch, QUIC_URXE *e)
3446
0
{
3447
0
    ossl_qrx_inject_urxe(ch->qrx, e);
3448
0
}
3449
3450
void ossl_quic_channel_inject_pkt(QUIC_CHANNEL *ch, OSSL_QRX_PKT *qpkt)
3451
0
{
3452
0
    ossl_qrx_inject_pkt(ch->qrx, qpkt);
3453
0
}
3454
3455
void ossl_quic_channel_on_stateless_reset(QUIC_CHANNEL *ch)
3456
0
{
3457
0
    QUIC_TERMINATE_CAUSE tcause = {0};
3458
3459
0
    tcause.error_code   = OSSL_QUIC_ERR_NO_ERROR;
3460
0
    tcause.remote       = 1;
3461
0
    ch_start_terminating(ch, &tcause, 0);
3462
0
}
3463
3464
void ossl_quic_channel_raise_net_error(QUIC_CHANNEL *ch)
3465
0
{
3466
0
    QUIC_TERMINATE_CAUSE tcause = {0};
3467
3468
0
    if (ch->net_error)
3469
0
        return;
3470
3471
0
    ch->net_error = 1;
3472
3473
0
    tcause.error_code = OSSL_QUIC_ERR_INTERNAL_ERROR;
3474
0
    tcause.reason     = "network BIO I/O error";
3475
0
    tcause.reason_len = strlen(tcause.reason);
3476
3477
    /*
3478
     * Skip Terminating state and go directly to Terminated, no point trying to
3479
     * send CONNECTION_CLOSE if we cannot communicate.
3480
     */
3481
0
    ch_start_terminating(ch, &tcause, 1);
3482
0
}
3483
3484
int ossl_quic_channel_net_error(QUIC_CHANNEL *ch)
3485
0
{
3486
0
    return ch->net_error;
3487
0
}
3488
3489
void ossl_quic_channel_restore_err_state(QUIC_CHANNEL *ch)
3490
0
{
3491
0
    if (ch == NULL)
3492
0
        return;
3493
3494
0
    if (!ossl_quic_port_is_running(ch->port))
3495
0
        ossl_quic_port_restore_err_state(ch->port);
3496
0
    else
3497
0
        OSSL_ERR_STATE_restore(ch->err_state);
3498
0
}
3499
3500
void ossl_quic_channel_raise_protocol_error_loc(QUIC_CHANNEL *ch,
3501
                                                uint64_t error_code,
3502
                                                uint64_t frame_type,
3503
                                                const char *reason,
3504
                                                ERR_STATE *err_state,
3505
                                                const char *src_file,
3506
                                                int src_line,
3507
                                                const char *src_func)
3508
0
{
3509
0
    QUIC_TERMINATE_CAUSE tcause = {0};
3510
0
    int err_reason = error_code == OSSL_QUIC_ERR_INTERNAL_ERROR
3511
0
                     ? ERR_R_INTERNAL_ERROR : SSL_R_QUIC_PROTOCOL_ERROR;
3512
0
    const char *err_str = ossl_quic_err_to_string(error_code);
3513
0
    const char *err_str_pfx = " (", *err_str_sfx = ")";
3514
0
    const char *ft_str = NULL;
3515
0
    const char *ft_str_pfx = " (", *ft_str_sfx = ")";
3516
3517
0
    if (ch->protocol_error)
3518
        /* Only the first call to this function matters. */
3519
0
        return;
3520
3521
0
    if (err_str == NULL) {
3522
0
        err_str     = "";
3523
0
        err_str_pfx = "";
3524
0
        err_str_sfx = "";
3525
0
    }
3526
3527
    /*
3528
     * If we were provided an underlying error state, restore it and then append
3529
     * our ERR on top as a "cover letter" error.
3530
     */
3531
0
    if (err_state != NULL)
3532
0
        OSSL_ERR_STATE_restore(err_state);
3533
3534
0
    if (frame_type != 0) {
3535
0
        ft_str = ossl_quic_frame_type_to_string(frame_type);
3536
0
        if (ft_str == NULL) {
3537
0
            ft_str      = "";
3538
0
            ft_str_pfx  = "";
3539
0
            ft_str_sfx  = "";
3540
0
        }
3541
3542
0
        ERR_raise_data(ERR_LIB_SSL, err_reason,
3543
0
                       "QUIC error code: 0x%llx%s%s%s "
3544
0
                       "(triggered by frame type: 0x%llx%s%s%s), reason: \"%s\"",
3545
0
                       (unsigned long long) error_code,
3546
0
                       err_str_pfx, err_str, err_str_sfx,
3547
0
                       (unsigned long long) frame_type,
3548
0
                       ft_str_pfx, ft_str, ft_str_sfx,
3549
0
                       reason);
3550
0
    } else {
3551
0
        ERR_raise_data(ERR_LIB_SSL, err_reason,
3552
0
                       "QUIC error code: 0x%llx%s%s%s, reason: \"%s\"",
3553
0
                       (unsigned long long) error_code,
3554
0
                       err_str_pfx, err_str, err_str_sfx,
3555
0
                       reason);
3556
0
    }
3557
3558
0
    if (src_file != NULL)
3559
0
        ERR_set_debug(src_file, src_line, src_func);
3560
3561
0
    ch_save_err_state(ch);
3562
3563
0
    tcause.error_code = error_code;
3564
0
    tcause.frame_type = frame_type;
3565
0
    tcause.reason     = reason;
3566
0
    tcause.reason_len = strlen(reason);
3567
3568
0
    ch->protocol_error = 1;
3569
0
    ch_start_terminating(ch, &tcause, 0);
3570
0
}
3571
3572
/*
3573
 * Called once the terminating timer expires, meaning we move from TERMINATING
3574
 * to TERMINATED.
3575
 */
3576
static void ch_on_terminating_timeout(QUIC_CHANNEL *ch)
3577
0
{
3578
0
    ch_record_state_transition(ch, QUIC_CHANNEL_STATE_TERMINATED);
3579
0
}
3580
3581
/*
3582
 * Determines the effective idle timeout duration. This is based on the idle
3583
 * timeout values that we and our peer signalled in transport parameters
3584
 * but have some limits applied.
3585
 */
3586
static OSSL_TIME ch_get_effective_idle_timeout_duration(QUIC_CHANNEL *ch)
3587
0
{
3588
0
    OSSL_TIME pto;
3589
3590
0
    if (ch->max_idle_timeout == 0)
3591
0
        return ossl_time_infinite();
3592
3593
    /*
3594
     * RFC 9000 s. 10.1: Idle Timeout
3595
     *  To avoid excessively small idle timeout periods, endpoints
3596
     *  MUST increase the idle timeout period to be at least three
3597
     *  times the current Probe Timeout (PTO). This allows for
3598
     *  multiple PTOs to expire, and therefore multiple probes to
3599
     *  be sent and lost, prior to idle timeout.
3600
     */
3601
0
    pto = ossl_ackm_get_pto_duration(ch->ackm);
3602
0
    return ossl_time_max(ossl_ms2time(ch->max_idle_timeout),
3603
0
                                      ossl_time_multiply(pto, 3));
3604
0
}
3605
3606
/*
3607
 * Updates our idle deadline. Called when an event happens which should bump the
3608
 * idle timeout.
3609
 */
3610
static void ch_update_idle(QUIC_CHANNEL *ch)
3611
0
{
3612
0
    ch->idle_deadline = ossl_time_add(get_time(ch),
3613
0
                                      ch_get_effective_idle_timeout_duration(ch));
3614
0
}
3615
3616
/*
3617
 * Updates our ping deadline, which determines when we next generate a ping if
3618
 * we don't have any other ACK-eliciting frames to send.
3619
 */
3620
static void ch_update_ping_deadline(QUIC_CHANNEL *ch)
3621
0
{
3622
0
    OSSL_TIME max_span, idle_duration;
3623
3624
0
    idle_duration = ch_get_effective_idle_timeout_duration(ch);
3625
0
    if (ossl_time_is_infinite(idle_duration)) {
3626
0
        ch->ping_deadline = ossl_time_infinite();
3627
0
        return;
3628
0
    }
3629
3630
    /*
3631
     * Maximum amount of time without traffic before we send a PING to keep
3632
     * the connection open. Usually we use max_idle_timeout/2, but ensure
3633
     * the period never exceeds the assumed NAT interval to ensure NAT
3634
     * devices don't have their state time out (RFC 9000 s. 10.1.2).
3635
     */
3636
0
    max_span = ossl_time_divide(idle_duration, 2);
3637
0
    max_span = ossl_time_min(max_span, MAX_NAT_INTERVAL);
3638
0
    ch->ping_deadline = ossl_time_add(get_time(ch), max_span);
3639
0
}
3640
3641
/* Called when the idle timeout expires. */
3642
static void ch_on_idle_timeout(QUIC_CHANNEL *ch)
3643
0
{
3644
    /*
3645
     * Idle timeout does not have an error code associated with it because a
3646
     * CONN_CLOSE is never sent for it. We shouldn't use this data once we reach
3647
     * TERMINATED anyway.
3648
     */
3649
0
    ch->terminate_cause.app         = 0;
3650
0
    ch->terminate_cause.error_code  = OSSL_QUIC_LOCAL_ERR_IDLE_TIMEOUT;
3651
0
    ch->terminate_cause.frame_type  = 0;
3652
3653
0
    ch_record_state_transition(ch, QUIC_CHANNEL_STATE_TERMINATED);
3654
0
}
3655
3656
/**
3657
 * @brief Common handler for initializing a new QUIC connection.
3658
 *
3659
 * This function configures a QUIC channel (`QUIC_CHANNEL *ch`) for a new
3660
 * connection by setting the peer address, connection IDs, and necessary
3661
 * callbacks. It establishes initial secrets, sets up logging, and performs
3662
 * required transitions for the channel state.
3663
 *
3664
 * @param ch       Pointer to the QUIC channel being initialized.
3665
 * @param peer     Address of the peer to which the channel connects.
3666
 * @param peer_scid Peer-specified source connection ID.
3667
 * @param peer_dcid Peer-specified destination connection ID.
3668
 * @param peer_odcid Peer-specified original destination connection ID
3669
 *                   may be NULL if retry frame not sent to client
3670
 * @return         1 on success, 0 on failure to set required elements.
3671
 */
3672
static int ch_on_new_conn_common(QUIC_CHANNEL *ch, const BIO_ADDR *peer,
3673
                                 const QUIC_CONN_ID *peer_scid,
3674
                                 const QUIC_CONN_ID *peer_dcid,
3675
                                 const QUIC_CONN_ID *peer_odcid)
3676
0
{
3677
    /* Note our newly learnt peer address and CIDs. */
3678
0
    if (!BIO_ADDR_copy(&ch->cur_peer_addr, peer))
3679
0
        return 0;
3680
3681
0
    ch->init_dcid       = *peer_dcid;
3682
0
    ch->cur_remote_dcid = *peer_scid;
3683
0
    ch->odcid.id_len = 0;
3684
3685
0
    if (peer_odcid != NULL)
3686
0
        ch->odcid = *peer_odcid;
3687
3688
    /* Inform QTX of peer address. */
3689
0
    if (!ossl_quic_tx_packetiser_set_peer(ch->txp, &ch->cur_peer_addr))
3690
0
        return 0;
3691
3692
    /* Inform TXP of desired CIDs. */
3693
0
    if (!ossl_quic_tx_packetiser_set_cur_dcid(ch->txp, &ch->cur_remote_dcid))
3694
0
        return 0;
3695
3696
0
    if (!ossl_quic_tx_packetiser_set_cur_scid(ch->txp, &ch->cur_local_cid))
3697
0
        return 0;
3698
3699
    /* Setup QLOG, which did not happen earlier due to lacking an Initial ODCID. */
3700
0
    ossl_qtx_set_qlog_cb(ch->qtx, ch_get_qlog_cb, ch);
3701
0
    ossl_quic_tx_packetiser_set_qlog_cb(ch->txp, ch_get_qlog_cb, ch);
3702
3703
    /*
3704
     * Plug in secrets for the Initial EL. secrets for QRX were created in
3705
     * port_default_packet_handler() already.
3706
     */
3707
0
    if (!ossl_quic_provide_initial_secret(ch->port->engine->libctx,
3708
0
                                          ch->port->engine->propq,
3709
0
                                          &ch->init_dcid,
3710
0
                                          /*is_server=*/1,
3711
0
                                          NULL, ch->qtx))
3712
0
        return 0;
3713
3714
    /* Register the peer ODCID in the LCIDM. */
3715
0
    if (!ossl_quic_lcidm_enrol_odcid(ch->lcidm, ch, peer_odcid == NULL ?
3716
0
                                     &ch->init_dcid :
3717
0
                                     peer_odcid))
3718
0
        return 0;
3719
3720
    /* Change state. */
3721
0
    ch_record_state_transition(ch, QUIC_CHANNEL_STATE_ACTIVE);
3722
0
    ch->doing_proactive_ver_neg = 0; /* not currently supported */
3723
0
    return 1;
3724
0
}
3725
3726
/* Called when we, as a server, get a new incoming connection. */
3727
int ossl_quic_channel_on_new_conn(QUIC_CHANNEL *ch, const BIO_ADDR *peer,
3728
                                  const QUIC_CONN_ID *peer_scid,
3729
                                  const QUIC_CONN_ID *peer_dcid)
3730
0
{
3731
0
    if (!ossl_assert(ch->state == QUIC_CHANNEL_STATE_IDLE && ch->is_server))
3732
0
        return 0;
3733
3734
    /* Generate an Initial LCID we will use for the connection. */
3735
0
    if (!ossl_quic_lcidm_generate_initial(ch->lcidm, ch, &ch->cur_local_cid))
3736
0
        return 0;
3737
3738
0
    return ch_on_new_conn_common(ch, peer, peer_scid, peer_dcid, NULL);
3739
0
}
3740
3741
/**
3742
 * Binds a QUIC channel to a specific peer's address and connection IDs.
3743
 *
3744
 * This function is used to establish a binding between a QUIC channel and a
3745
 * peer's address and connection IDs. The binding is performed only if the
3746
 * channel is idle and is on the server side. The peer's destination connection
3747
 * ID (`peer_dcid`) is mandatory, and the channel's current local connection ID
3748
 * is set to this value.
3749
 *
3750
 * @param ch          Pointer to the QUIC_CHANNEL structure representing the
3751
 *                    channel to be bound.
3752
 * @param peer        Pointer to a BIO_ADDR structure representing the peer's
3753
 *                    address.
3754
 * @param peer_scid   Pointer to the peer's source connection ID (QUIC_CONN_ID).
3755
 * @param peer_dcid   Pointer to the peer's destination connection ID
3756
 *                    (QUIC_CONN_ID). This must not be NULL.
3757
 * @param peer_odcid  Pointer to the original destination connection ID
3758
 *                    (QUIC_CONN_ID) chosen by the peer in its first initial
3759
 *                    packet received without a token.
3760
 *
3761
 * @return 1 on success, or 0 on failure if the conditions for binding are not
3762
 *         met (e.g., channel is not idle or not a server, or binding fails).
3763
 */
3764
int ossl_quic_bind_channel(QUIC_CHANNEL *ch, const BIO_ADDR *peer,
3765
                           const QUIC_CONN_ID *peer_scid,
3766
                           const QUIC_CONN_ID *peer_dcid,
3767
                           const QUIC_CONN_ID *peer_odcid)
3768
0
{
3769
0
    if (peer_dcid == NULL)
3770
0
        return 0;
3771
3772
0
    if (!ossl_assert(ch->state == QUIC_CHANNEL_STATE_IDLE && ch->is_server))
3773
0
        return 0;
3774
3775
0
    ch->cur_local_cid = *peer_dcid;
3776
0
    if (!ossl_quic_lcidm_bind_channel(ch->lcidm, ch, peer_dcid))
3777
0
        return 0;
3778
3779
    /*
3780
     * peer_odcid <=> is initial dst conn id chosen by peer in its
3781
     * first initial packet we received without token.
3782
     */
3783
0
    return ch_on_new_conn_common(ch, peer, peer_scid, peer_dcid, peer_odcid);
3784
0
}
3785
3786
SSL *ossl_quic_channel_get0_ssl(QUIC_CHANNEL *ch)
3787
0
{
3788
0
    return ch->tls;
3789
0
}
3790
3791
static int ch_init_new_stream(QUIC_CHANNEL *ch, QUIC_STREAM *qs,
3792
                              int can_send, int can_recv)
3793
0
{
3794
0
    uint64_t rxfc_wnd;
3795
0
    int server_init = ossl_quic_stream_is_server_init(qs);
3796
0
    int local_init = (ch->is_server == server_init);
3797
0
    int is_uni = !ossl_quic_stream_is_bidi(qs);
3798
3799
0
    if (can_send)
3800
0
        if ((qs->sstream = ossl_quic_sstream_new(INIT_APP_BUF_LEN)) == NULL)
3801
0
            goto err;
3802
3803
0
    if (can_recv)
3804
0
        if ((qs->rstream = ossl_quic_rstream_new(NULL, NULL, 0)) == NULL)
3805
0
            goto err;
3806
3807
    /* TXFC */
3808
0
    if (!ossl_quic_txfc_init(&qs->txfc, &ch->conn_txfc))
3809
0
        goto err;
3810
3811
0
    if (ch->got_remote_transport_params) {
3812
        /*
3813
         * If we already got peer TPs we need to apply the initial CWM credit
3814
         * now. If we didn't already get peer TPs this will be done
3815
         * automatically for all extant streams when we do.
3816
         */
3817
0
        if (can_send) {
3818
0
            uint64_t cwm;
3819
3820
0
            if (is_uni)
3821
0
                cwm = ch->rx_init_max_stream_data_uni;
3822
0
            else if (local_init)
3823
0
                cwm = ch->rx_init_max_stream_data_bidi_local;
3824
0
            else
3825
0
                cwm = ch->rx_init_max_stream_data_bidi_remote;
3826
3827
0
            ossl_quic_txfc_bump_cwm(&qs->txfc, cwm);
3828
0
        }
3829
0
    }
3830
3831
    /* RXFC */
3832
0
    if (!can_recv)
3833
0
        rxfc_wnd = 0;
3834
0
    else if (is_uni)
3835
0
        rxfc_wnd = ch->tx_init_max_stream_data_uni;
3836
0
    else if (local_init)
3837
0
        rxfc_wnd = ch->tx_init_max_stream_data_bidi_local;
3838
0
    else
3839
0
        rxfc_wnd = ch->tx_init_max_stream_data_bidi_remote;
3840
3841
0
    if (!ossl_quic_rxfc_init(&qs->rxfc, &ch->conn_rxfc,
3842
0
                             rxfc_wnd,
3843
0
                             DEFAULT_STREAM_RXFC_MAX_WND_MUL * rxfc_wnd,
3844
0
                             get_time, ch))
3845
0
        goto err;
3846
3847
0
    return 1;
3848
3849
0
err:
3850
0
    ossl_quic_sstream_free(qs->sstream);
3851
0
    qs->sstream = NULL;
3852
0
    ossl_quic_rstream_free(qs->rstream);
3853
0
    qs->rstream = NULL;
3854
0
    return 0;
3855
0
}
3856
3857
static uint64_t *ch_get_local_stream_next_ordinal_ptr(QUIC_CHANNEL *ch,
3858
                                                      int is_uni)
3859
0
{
3860
0
    return is_uni ? &ch->next_local_stream_ordinal_uni
3861
0
                  : &ch->next_local_stream_ordinal_bidi;
3862
0
}
3863
3864
static const uint64_t *ch_get_local_stream_max_ptr(const QUIC_CHANNEL *ch,
3865
                                                   int is_uni)
3866
0
{
3867
0
    return is_uni ? &ch->max_local_streams_uni
3868
0
                  : &ch->max_local_streams_bidi;
3869
0
}
3870
3871
static const QUIC_RXFC *ch_get_remote_stream_count_rxfc(const QUIC_CHANNEL *ch,
3872
                                                        int is_uni)
3873
0
{
3874
0
    return is_uni ? &ch->max_streams_uni_rxfc
3875
0
                  : &ch->max_streams_bidi_rxfc;
3876
0
}
3877
3878
int ossl_quic_channel_is_new_local_stream_admissible(QUIC_CHANNEL *ch,
3879
                                                     int is_uni)
3880
0
{
3881
0
    const uint64_t *p_next_ordinal = ch_get_local_stream_next_ordinal_ptr(ch, is_uni);
3882
3883
0
    return ossl_quic_stream_map_is_local_allowed_by_stream_limit(&ch->qsm,
3884
0
                                                                 *p_next_ordinal,
3885
0
                                                                 is_uni);
3886
0
}
3887
3888
uint64_t ossl_quic_channel_get_local_stream_count_avail(const QUIC_CHANNEL *ch,
3889
                                                        int is_uni)
3890
0
{
3891
0
    const uint64_t *p_next_ordinal, *p_max;
3892
3893
0
    p_next_ordinal  = ch_get_local_stream_next_ordinal_ptr((QUIC_CHANNEL *)ch,
3894
0
                                                           is_uni);
3895
0
    p_max           = ch_get_local_stream_max_ptr(ch, is_uni);
3896
3897
0
    return *p_max - *p_next_ordinal;
3898
0
}
3899
3900
uint64_t ossl_quic_channel_get_remote_stream_count_avail(const QUIC_CHANNEL *ch,
3901
                                                         int is_uni)
3902
0
{
3903
0
    return ossl_quic_rxfc_get_credit(ch_get_remote_stream_count_rxfc(ch, is_uni));
3904
0
}
3905
3906
QUIC_STREAM *ossl_quic_channel_new_stream_local(QUIC_CHANNEL *ch, int is_uni)
3907
0
{
3908
0
    QUIC_STREAM *qs;
3909
0
    int type;
3910
0
    uint64_t stream_id;
3911
0
    uint64_t *p_next_ordinal;
3912
3913
0
    type = ch->is_server ? QUIC_STREAM_INITIATOR_SERVER
3914
0
                         : QUIC_STREAM_INITIATOR_CLIENT;
3915
3916
0
    p_next_ordinal = ch_get_local_stream_next_ordinal_ptr(ch, is_uni);
3917
3918
0
    if (is_uni)
3919
0
        type |= QUIC_STREAM_DIR_UNI;
3920
0
    else
3921
0
        type |= QUIC_STREAM_DIR_BIDI;
3922
3923
0
    if (*p_next_ordinal >= ((uint64_t)1) << 62)
3924
0
        return NULL;
3925
3926
0
    stream_id = ((*p_next_ordinal) << 2) | type;
3927
3928
0
    if ((qs = ossl_quic_stream_map_alloc(&ch->qsm, stream_id, type)) == NULL)
3929
0
        return NULL;
3930
3931
    /* Locally-initiated stream, so we always want a send buffer. */
3932
0
    if (!ch_init_new_stream(ch, qs, /*can_send=*/1, /*can_recv=*/!is_uni))
3933
0
        goto err;
3934
3935
0
    ++*p_next_ordinal;
3936
0
    return qs;
3937
3938
0
err:
3939
0
    ossl_quic_stream_map_release(&ch->qsm, qs);
3940
0
    return NULL;
3941
0
}
3942
3943
QUIC_STREAM *ossl_quic_channel_new_stream_remote(QUIC_CHANNEL *ch,
3944
                                                 uint64_t stream_id)
3945
0
{
3946
0
    uint64_t peer_role;
3947
0
    int is_uni;
3948
0
    QUIC_STREAM *qs;
3949
3950
0
    peer_role = ch->is_server
3951
0
        ? QUIC_STREAM_INITIATOR_CLIENT
3952
0
        : QUIC_STREAM_INITIATOR_SERVER;
3953
3954
0
    if ((stream_id & QUIC_STREAM_INITIATOR_MASK) != peer_role)
3955
0
        return NULL;
3956
3957
0
    is_uni = ((stream_id & QUIC_STREAM_DIR_MASK) == QUIC_STREAM_DIR_UNI);
3958
3959
0
    qs = ossl_quic_stream_map_alloc(&ch->qsm, stream_id,
3960
0
                                    stream_id & (QUIC_STREAM_INITIATOR_MASK
3961
0
                                                 | QUIC_STREAM_DIR_MASK));
3962
0
    if (qs == NULL)
3963
0
        return NULL;
3964
3965
0
    if (!ch_init_new_stream(ch, qs, /*can_send=*/!is_uni, /*can_recv=*/1))
3966
0
        goto err;
3967
3968
0
    if (ch->incoming_stream_auto_reject)
3969
0
        ossl_quic_channel_reject_stream(ch, qs);
3970
0
    else
3971
0
        ossl_quic_stream_map_push_accept_queue(&ch->qsm, qs);
3972
3973
0
    return qs;
3974
3975
0
err:
3976
0
    ossl_quic_stream_map_release(&ch->qsm, qs);
3977
0
    return NULL;
3978
0
}
3979
3980
void ossl_quic_channel_set_incoming_stream_auto_reject(QUIC_CHANNEL *ch,
3981
                                                       int enable,
3982
                                                       uint64_t aec)
3983
0
{
3984
0
    ch->incoming_stream_auto_reject     = (enable != 0);
3985
0
    ch->incoming_stream_auto_reject_aec = aec;
3986
0
}
3987
3988
void ossl_quic_channel_reject_stream(QUIC_CHANNEL *ch, QUIC_STREAM *qs)
3989
0
{
3990
0
    ossl_quic_stream_map_stop_sending_recv_part(&ch->qsm, qs,
3991
0
                                                ch->incoming_stream_auto_reject_aec);
3992
3993
0
    ossl_quic_stream_map_reset_stream_send_part(&ch->qsm, qs,
3994
0
                                                ch->incoming_stream_auto_reject_aec);
3995
0
    qs->deleted = 1;
3996
3997
0
    ossl_quic_stream_map_update_state(&ch->qsm, qs);
3998
0
}
3999
4000
/* Replace local connection ID in TXP and DEMUX for testing purposes. */
4001
int ossl_quic_channel_replace_local_cid(QUIC_CHANNEL *ch,
4002
                                        const QUIC_CONN_ID *conn_id)
4003
0
{
4004
    /* Remove the current LCID from the LCIDM. */
4005
0
    if (!ossl_quic_lcidm_debug_remove(ch->lcidm, &ch->cur_local_cid))
4006
0
        return 0;
4007
0
    ch->cur_local_cid = *conn_id;
4008
    /* Set in the TXP, used only for long header packets. */
4009
0
    if (!ossl_quic_tx_packetiser_set_cur_scid(ch->txp, &ch->cur_local_cid))
4010
0
        return 0;
4011
    /* Add the new LCID to the LCIDM. */
4012
0
    if (!ossl_quic_lcidm_debug_add(ch->lcidm, ch, &ch->cur_local_cid,
4013
0
                                   100))
4014
0
        return 0;
4015
0
    return 1;
4016
0
}
4017
4018
void ossl_quic_channel_set_msg_callback(QUIC_CHANNEL *ch,
4019
                                        ossl_msg_cb msg_callback,
4020
                                        SSL *msg_callback_ssl)
4021
0
{
4022
0
    ch->msg_callback = msg_callback;
4023
0
    ch->msg_callback_ssl = msg_callback_ssl;
4024
0
    ossl_qtx_set_msg_callback(ch->qtx, msg_callback, msg_callback_ssl);
4025
0
    ossl_quic_tx_packetiser_set_msg_callback(ch->txp, msg_callback,
4026
0
                                             msg_callback_ssl);
4027
    /*
4028
     * postpone msg callback setting for tserver until port calls
4029
     * port_bind_channel().
4030
     */
4031
0
    if (ch->is_tserver_ch == 0)
4032
0
        ossl_qrx_set_msg_callback(ch->qrx, msg_callback, msg_callback_ssl);
4033
0
}
4034
4035
void ossl_quic_channel_set_msg_callback_arg(QUIC_CHANNEL *ch,
4036
                                            void *msg_callback_arg)
4037
0
{
4038
0
    ch->msg_callback_arg = msg_callback_arg;
4039
0
    ossl_qtx_set_msg_callback_arg(ch->qtx, msg_callback_arg);
4040
0
    ossl_quic_tx_packetiser_set_msg_callback_arg(ch->txp, msg_callback_arg);
4041
4042
    /*
4043
     * postpone msg callback setting for tserver until port calls
4044
     * port_bind_channel().
4045
     */
4046
0
    if (ch->is_tserver_ch == 0)
4047
0
        ossl_qrx_set_msg_callback_arg(ch->qrx, msg_callback_arg);
4048
0
}
4049
4050
void ossl_quic_channel_set_txku_threshold_override(QUIC_CHANNEL *ch,
4051
                                                   uint64_t tx_pkt_threshold)
4052
0
{
4053
0
    ch->txku_threshold_override = tx_pkt_threshold;
4054
0
}
4055
4056
uint64_t ossl_quic_channel_get_tx_key_epoch(QUIC_CHANNEL *ch)
4057
0
{
4058
0
    return ossl_qtx_get_key_epoch(ch->qtx);
4059
0
}
4060
4061
uint64_t ossl_quic_channel_get_rx_key_epoch(QUIC_CHANNEL *ch)
4062
0
{
4063
0
    return ossl_qrx_get_key_epoch(ch->qrx);
4064
0
}
4065
4066
int ossl_quic_channel_trigger_txku(QUIC_CHANNEL *ch)
4067
0
{
4068
0
    if (!txku_allowed(ch))
4069
0
        return 0;
4070
4071
0
    ch->ku_locally_initiated = 1;
4072
0
    ch_trigger_txku(ch);
4073
0
    return 1;
4074
0
}
4075
4076
int ossl_quic_channel_ping(QUIC_CHANNEL *ch)
4077
0
{
4078
0
    int pn_space = ossl_quic_enc_level_to_pn_space(ch->tx_enc_level);
4079
4080
0
    ossl_quic_tx_packetiser_schedule_ack_eliciting(ch->txp, pn_space);
4081
4082
0
    return 1;
4083
0
}
4084
4085
uint16_t ossl_quic_channel_get_diag_num_rx_ack(QUIC_CHANNEL *ch)
4086
0
{
4087
0
    return ch->diag_num_rx_ack;
4088
0
}
4089
4090
void ossl_quic_channel_get_diag_local_cid(QUIC_CHANNEL *ch, QUIC_CONN_ID *cid)
4091
0
{
4092
0
    *cid = ch->cur_local_cid;
4093
0
}
4094
4095
int ossl_quic_channel_have_generated_transport_params(const QUIC_CHANNEL *ch)
4096
0
{
4097
0
    return ch->got_local_transport_params;
4098
0
}
4099
4100
void ossl_quic_channel_set_max_idle_timeout_request(QUIC_CHANNEL *ch, uint64_t ms)
4101
0
{
4102
0
    ch->max_idle_timeout_local_req = ms;
4103
0
}
4104
uint64_t ossl_quic_channel_get_max_idle_timeout_request(const QUIC_CHANNEL *ch)
4105
0
{
4106
0
    return ch->max_idle_timeout_local_req;
4107
0
}
4108
4109
uint64_t ossl_quic_channel_get_max_idle_timeout_peer_request(const QUIC_CHANNEL *ch)
4110
0
{
4111
0
    return ch->max_idle_timeout_remote_req;
4112
0
}
4113
4114
uint64_t ossl_quic_channel_get_max_idle_timeout_actual(const QUIC_CHANNEL *ch)
4115
0
{
4116
0
    return ch->max_idle_timeout;
4117
0
}