Coverage Report

Created: 2026-09-12 06:55

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