Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl33/ssl/quic/quic_impl.c
Line
Count
Source
1
/*
2
 * Copyright 2022-2025 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#include <openssl/macros.h>
11
#include <openssl/objects.h>
12
#include <openssl/sslerr.h>
13
#include <crypto/rand.h>
14
#include "quic_local.h"
15
#include "internal/quic_tls.h"
16
#include "internal/quic_rx_depack.h"
17
#include "internal/quic_error.h"
18
#include "internal/quic_engine.h"
19
#include "internal/quic_port.h"
20
#include "internal/time.h"
21
22
typedef struct qctx_st QCTX;
23
24
static void aon_write_finish(QUIC_XSO *xso);
25
static int create_channel(QUIC_CONNECTION *qc);
26
static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs);
27
static int qc_try_create_default_xso_for_write(QCTX *ctx);
28
static int qc_wait_for_default_xso_for_read(QCTX *ctx, int peek);
29
static void quic_lock(QUIC_CONNECTION *qc);
30
static void quic_unlock(QUIC_CONNECTION *qc);
31
static void quic_lock_for_io(QCTX *ctx);
32
static int quic_do_handshake(QCTX *ctx);
33
static void qc_update_reject_policy(QUIC_CONNECTION *qc);
34
static void qc_touch_default_xso(QUIC_CONNECTION *qc);
35
static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch);
36
static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
37
    int touch, QUIC_XSO **old_xso);
38
static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock);
39
static int quic_validate_for_write(QUIC_XSO *xso, int *err);
40
static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active);
41
static int qc_blocking_mode(const QUIC_CONNECTION *qc);
42
static int xso_blocking_mode(const QUIC_XSO *xso);
43
static void qctx_maybe_autotick(QCTX *ctx);
44
static int qctx_should_autotick(QCTX *ctx);
45
46
/*
47
 * QUIC Front-End I/O API: Common Utilities
48
 * ========================================
49
 */
50
51
/*
52
 * Block until a predicate is met.
53
 *
54
 * Precondition: Must have a channel.
55
 * Precondition: Must hold channel lock (unchecked).
56
 */
57
QUIC_NEEDS_LOCK
58
static int block_until_pred(QUIC_CONNECTION *qc,
59
    int (*pred)(void *arg), void *pred_arg,
60
    uint32_t flags)
61
0
{
62
0
    QUIC_REACTOR *rtor;
63
64
0
    assert(qc->ch != NULL);
65
66
    /*
67
     * Any attempt to block auto-disables tick inhibition as otherwise we will
68
     * hang around forever.
69
     */
70
0
    ossl_quic_engine_set_inhibit_tick(qc->engine, 0);
71
72
0
    rtor = ossl_quic_channel_get_reactor(qc->ch);
73
0
    return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags,
74
0
        qc->mutex);
75
0
}
76
77
static OSSL_TIME get_time(QUIC_CONNECTION *qc)
78
123M
{
79
123M
    if (qc->override_now_cb != NULL)
80
123M
        return qc->override_now_cb(qc->override_now_cb_arg);
81
20.9k
    else
82
20.9k
        return ossl_time_now();
83
123M
}
84
85
static OSSL_TIME get_time_cb(void *arg)
86
88.9M
{
87
88.9M
    QUIC_CONNECTION *qc = arg;
88
89
88.9M
    return get_time(qc);
90
88.9M
}
91
92
/*
93
 * QCTX is a utility structure which provides information we commonly wish to
94
 * unwrap upon an API call being dispatched to us, namely:
95
 *
96
 *   - a pointer to the QUIC_CONNECTION (regardless of whether a QCSO or QSSO
97
 *     was passed);
98
 *   - a pointer to any applicable QUIC_XSO (e.g. if a QSSO was passed, or if
99
 *     a QCSO with a default stream was passed);
100
 *   - whether a QSSO was passed (xso == NULL must not be used to determine this
101
 *     because it may be non-NULL when a QCSO is passed if that QCSO has a
102
 *     default stream);
103
 *   - whether we are in "I/O context", meaning that non-normal errors can
104
 *     be reported via SSL_get_error() as well as via ERR. Functions such as
105
 *     SSL_read(), SSL_write() and SSL_do_handshake() are "I/O context"
106
 *     functions which are allowed to change the value returned by
107
 *     SSL_get_error. However, other functions (including functions which call
108
 *     SSL_do_handshake() implicitly) are not allowed to change the return value
109
 *     of SSL_get_error.
110
 */
111
struct qctx_st {
112
    QUIC_CONNECTION *qc;
113
    QUIC_XSO *xso;
114
    int is_stream, in_io;
115
};
116
117
QUIC_NEEDS_LOCK
118
static void quic_set_last_error(QCTX *ctx, int last_error)
119
141M
{
120
141M
    if (!ctx->in_io)
121
6.86k
        return;
122
123
141M
    if (ctx->is_stream && ctx->xso != NULL)
124
14.0M
        ctx->xso->last_error = last_error;
125
127M
    else if (!ctx->is_stream && ctx->qc != NULL)
126
127M
        ctx->qc->last_error = last_error;
127
141M
}
128
129
/*
130
 * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
131
 * rather than via ERR. Note that normal errors must always be raised while
132
 * holding a lock.
133
 */
134
QUIC_NEEDS_LOCK
135
static int quic_raise_normal_error(QCTX *ctx,
136
    int err)
137
70.5M
{
138
70.5M
    assert(ctx->in_io);
139
70.5M
    quic_set_last_error(ctx, err);
140
141
70.5M
    return 0;
142
70.5M
}
143
144
/*
145
 * Raise a 'non-normal' error, meaning any error that is not reported via
146
 * SSL_get_error() and must be reported via ERR.
147
 *
148
 * qc should be provided if available. In exceptional circumstances when qc is
149
 * not known NULL may be passed. This should generally only happen when an
150
 * expect_...() function defined below fails, which generally indicates a
151
 * dispatch error or caller error.
152
 *
153
 * ctx should be NULL if the connection lock is not held.
154
 */
155
static int quic_raise_non_normal_error(QCTX *ctx,
156
    const char *file,
157
    int line,
158
    const char *func,
159
    int reason,
160
    const char *fmt,
161
    ...)
162
46.1k
{
163
46.1k
    va_list args;
164
165
46.1k
    if (ctx != NULL) {
166
46.1k
        quic_set_last_error(ctx, SSL_ERROR_SSL);
167
168
46.1k
        if (reason == SSL_R_PROTOCOL_IS_SHUTDOWN && ctx->qc != NULL)
169
42.5k
            ossl_quic_channel_restore_err_state(ctx->qc->ch);
170
46.1k
    }
171
172
46.1k
    ERR_new();
173
46.1k
    ERR_set_debug(file, line, func);
174
175
46.1k
    va_start(args, fmt);
176
46.1k
    ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
177
46.1k
    va_end(args);
178
179
46.1k
    return 0;
180
46.1k
}
181
182
#define QUIC_RAISE_NORMAL_ERROR(ctx, err) \
183
31.8M
    quic_raise_normal_error((ctx), (err))
184
185
#define QUIC_RAISE_NON_NORMAL_ERROR(ctx, reason, msg) \
186
23.4k
    quic_raise_non_normal_error((ctx),                \
187
23.4k
        OPENSSL_FILE, OPENSSL_LINE,                   \
188
23.4k
        OPENSSL_FUNC,                                 \
189
23.4k
        (reason),                                     \
190
23.4k
        (msg))
191
192
/*
193
 * Given a QCSO or QSSO, initialises a QCTX, determining the contextually
194
 * applicable QUIC_CONNECTION pointer and, if applicable, QUIC_XSO pointer.
195
 *
196
 * After this returns 1, all fields of the passed QCTX are initialised.
197
 * Returns 0 on failure. This function is intended to be used to provide API
198
 * semantics and as such, it invokes QUIC_RAISE_NON_NORMAL_ERROR() on failure.
199
 */
200
static int expect_quic(const SSL *s, QCTX *ctx)
201
98.7M
{
202
98.7M
    QUIC_CONNECTION *qc;
203
98.7M
    QUIC_XSO *xso;
204
205
98.7M
    ctx->qc = NULL;
206
98.7M
    ctx->xso = NULL;
207
98.7M
    ctx->is_stream = 0;
208
209
98.7M
    if (s == NULL)
210
0
        return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_PASSED_NULL_PARAMETER, NULL);
211
212
98.7M
    switch (s->type) {
213
91.9M
    case SSL_TYPE_QUIC_CONNECTION:
214
91.9M
        qc = (QUIC_CONNECTION *)s;
215
91.9M
        ctx->qc = qc;
216
91.9M
        ctx->xso = qc->default_xso;
217
91.9M
        ctx->is_stream = 0;
218
91.9M
        ctx->in_io = 0;
219
91.9M
        return 1;
220
221
6.81M
    case SSL_TYPE_QUIC_XSO:
222
6.81M
        xso = (QUIC_XSO *)s;
223
6.81M
        ctx->qc = xso->conn;
224
6.81M
        ctx->xso = xso;
225
6.81M
        ctx->is_stream = 1;
226
6.81M
        ctx->in_io = 0;
227
6.81M
        return 1;
228
229
0
    default:
230
0
        return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
231
98.7M
    }
232
98.7M
}
233
234
/*
235
 * Like expect_quic(), but requires a QUIC_XSO be contextually available. In
236
 * other words, requires that the passed QSO be a QSSO or a QCSO with a default
237
 * stream.
238
 *
239
 * remote_init determines if we expect the default XSO to be remotely created or
240
 * not. If it is -1, do not instantiate a default XSO if one does not yet exist.
241
 *
242
 * Channel mutex is acquired and retained on success.
243
 */
244
QUIC_ACQUIRES_LOCK
245
static int ossl_unused expect_quic_with_stream_lock(const SSL *s, int remote_init,
246
    int in_io, QCTX *ctx)
247
75.2k
{
248
75.2k
    if (!expect_quic(s, ctx))
249
0
        return 0;
250
251
75.2k
    if (in_io)
252
75.2k
        quic_lock_for_io(ctx);
253
0
    else
254
0
        quic_lock(ctx->qc);
255
256
75.2k
    if (ctx->xso == NULL && remote_init >= 0) {
257
0
        if (!quic_mutation_allowed(ctx->qc, /*req_active=*/0)) {
258
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
259
0
            goto err;
260
0
        }
261
262
        /* If we haven't finished the handshake, try to advance it. */
263
0
        if (quic_do_handshake(ctx) < 1)
264
            /* ossl_quic_do_handshake raised error here */
265
0
            goto err;
266
267
0
        if (remote_init == 0) {
268
0
            if (!qc_try_create_default_xso_for_write(ctx))
269
0
                goto err;
270
0
        } else {
271
0
            if (!qc_wait_for_default_xso_for_read(ctx, /*peek=*/0))
272
0
                goto err;
273
0
        }
274
275
0
        ctx->xso = ctx->qc->default_xso;
276
0
    }
277
278
75.2k
    if (ctx->xso == NULL) {
279
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
280
0
        goto err;
281
0
    }
282
283
75.2k
    return 1; /* coverity[missing_unlock]: lock held */
284
285
0
err:
286
0
    quic_unlock(ctx->qc);
287
0
    return 0;
288
75.2k
}
289
290
/*
291
 * Like expect_quic(), but fails if called on a QUIC_XSO. ctx->xso may still
292
 * be non-NULL if the QCSO has a default stream.
293
 */
294
static int ossl_unused expect_quic_conn_only(const SSL *s, QCTX *ctx)
295
31.5k
{
296
31.5k
    if (!expect_quic(s, ctx))
297
0
        return 0;
298
299
31.5k
    if (ctx->is_stream)
300
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_CONN_USE_ONLY, NULL);
301
302
31.5k
    return 1;
303
31.5k
}
304
305
/*
306
 * Ensures that the channel mutex is held for a method which touches channel
307
 * state.
308
 *
309
 * Precondition: Channel mutex is not held (unchecked)
310
 */
311
static void quic_lock(QUIC_CONNECTION *qc)
312
98.5M
{
313
98.5M
#if defined(OPENSSL_THREADS)
314
98.5M
    ossl_crypto_mutex_lock(qc->mutex);
315
98.5M
#endif
316
98.5M
}
317
318
static void quic_lock_for_io(QCTX *ctx)
319
31.8M
{
320
31.8M
    quic_lock(ctx->qc);
321
31.8M
    ctx->in_io = 1;
322
323
    /*
324
     * We are entering an I/O function so we must update the values returned by
325
     * SSL_get_error and SSL_want. Set no error. This will be overridden later
326
     * if a call to QUIC_RAISE_NORMAL_ERROR or QUIC_RAISE_NON_NORMAL_ERROR
327
     * occurs during the API call.
328
     */
329
31.8M
    quic_set_last_error(ctx, SSL_ERROR_NONE);
330
31.8M
}
331
332
/* Precondition: Channel mutex is held (unchecked) */
333
QUIC_NEEDS_LOCK
334
static void quic_unlock(QUIC_CONNECTION *qc)
335
98.5M
{
336
98.5M
#if defined(OPENSSL_THREADS)
337
98.5M
    ossl_crypto_mutex_unlock(qc->mutex);
338
98.5M
#endif
339
98.5M
}
340
341
/*
342
 * This predicate is the criterion which should determine API call rejection for
343
 * *most* mutating API calls, particularly stream-related operations for send
344
 * parts.
345
 *
346
 * A call is rejected (this function returns 0) if shutdown is in progress
347
 * (stream flushing), or we are in a TERMINATING or TERMINATED state. If
348
 * req_active=1, the connection must be active (i.e., the IDLE state is also
349
 * rejected).
350
 */
351
static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active)
352
68.2M
{
353
68.2M
    if (qc->shutting_down || ossl_quic_channel_is_term_any(qc->ch))
354
7.65k
        return 0;
355
356
68.2M
    if (req_active && !ossl_quic_channel_is_active(qc->ch))
357
0
        return 0;
358
359
68.2M
    return 1;
360
68.2M
}
361
362
/*
363
 * QUIC Front-End I/O API: Initialization
364
 * ======================================
365
 *
366
 *         SSL_new                  => ossl_quic_new
367
 *                                     ossl_quic_init
368
 *         SSL_reset                => ossl_quic_reset
369
 *         SSL_clear                => ossl_quic_clear
370
 *                                     ossl_quic_deinit
371
 *         SSL_free                 => ossl_quic_free
372
 *
373
 *         SSL_set_options          => ossl_quic_set_options
374
 *         SSL_get_options          => ossl_quic_get_options
375
 *         SSL_clear_options        => ossl_quic_clear_options
376
 *
377
 */
378
379
/* SSL_new */
380
SSL *ossl_quic_new(SSL_CTX *ctx)
381
20.9k
{
382
20.9k
    QUIC_CONNECTION *qc = NULL;
383
20.9k
    SSL *ssl_base = NULL;
384
20.9k
    SSL_CONNECTION *sc = NULL;
385
386
20.9k
    qc = OPENSSL_zalloc(sizeof(*qc));
387
20.9k
    if (qc == NULL) {
388
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
389
0
        return NULL;
390
0
    }
391
20.9k
#if defined(OPENSSL_THREADS)
392
20.9k
    if ((qc->mutex = ossl_crypto_mutex_new()) == NULL) {
393
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
394
0
        goto err;
395
0
    }
396
20.9k
#endif
397
398
    /* Initialise the QUIC_CONNECTION's stub header. */
399
20.9k
    ssl_base = &qc->ssl;
400
20.9k
    if (!ossl_ssl_init(ssl_base, ctx, ctx->method, SSL_TYPE_QUIC_CONNECTION)) {
401
0
        ssl_base = NULL;
402
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
403
0
        goto err;
404
0
    }
405
406
20.9k
    qc->tls = ossl_ssl_connection_new_int(ctx, ssl_base, TLS_method());
407
20.9k
    if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL) {
408
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
409
0
        goto err;
410
0
    }
411
412
    /* override the user_ssl of the inner connection */
413
20.9k
    sc->s3.flags |= TLS1_FLAGS_QUIC;
414
415
    /* Restrict options derived from the SSL_CTX. */
416
20.9k
    sc->options &= OSSL_QUIC_PERMITTED_OPTIONS_CONN;
417
20.9k
    sc->pha_enabled = 0;
418
419
20.9k
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
420
20.9k
    qc->is_thread_assisted
421
20.9k
        = (ssl_base->method == OSSL_QUIC_client_thread_method());
422
20.9k
#endif
423
424
20.9k
    qc->as_server = 0; /* TODO(QUIC SERVER): add server support */
425
20.9k
    qc->as_server_state = qc->as_server;
426
427
20.9k
    qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
428
20.9k
    qc->default_ssl_mode = qc->ssl.ctx->mode;
429
20.9k
    qc->default_ssl_options = qc->ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
430
20.9k
    qc->desires_blocking = 1;
431
20.9k
    qc->blocking = 0;
432
20.9k
    qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
433
20.9k
    qc->last_error = SSL_ERROR_NONE;
434
435
20.9k
    if (!create_channel(qc))
436
0
        goto err;
437
438
20.9k
    ossl_quic_channel_set_msg_callback(qc->ch, ctx->msg_callback, ssl_base);
439
20.9k
    ossl_quic_channel_set_msg_callback_arg(qc->ch, ctx->msg_callback_arg);
440
441
20.9k
    qc_update_reject_policy(qc);
442
443
    /*
444
     * We do not create the default XSO yet. The reason for this is that the
445
     * stream ID of the default XSO will depend on whether the stream is client
446
     * or server-initiated, which depends on who transmits first. Since we do
447
     * not know whether the application will be using a client-transmits-first
448
     * or server-transmits-first protocol, we defer default XSO creation until
449
     * the client calls SSL_read() or SSL_write(). If it calls SSL_read() first,
450
     * we take that as a cue that the client is expecting a server-initiated
451
     * stream, and vice versa if SSL_write() is called first.
452
     */
453
20.9k
    return ssl_base;
454
455
0
err:
456
0
    if (ssl_base == NULL) {
457
0
#if defined(OPENSSL_THREADS)
458
0
        ossl_crypto_mutex_free(&qc->mutex);
459
0
#endif
460
0
        OPENSSL_free(qc);
461
0
    } else {
462
0
        SSL_free(ssl_base);
463
0
    }
464
0
    return NULL;
465
20.9k
}
466
467
/* SSL_free */
468
QUIC_TAKES_LOCK
469
void ossl_quic_free(SSL *s)
470
26.2k
{
471
26.2k
    QCTX ctx;
472
26.2k
    int is_default;
473
474
    /* We should never be called on anything but a QSO. */
475
26.2k
    if (!expect_quic(s, &ctx))
476
0
        return;
477
478
26.2k
    quic_lock(ctx.qc);
479
480
26.2k
    if (ctx.is_stream) {
481
        /*
482
         * When a QSSO is freed, the XSO is freed immediately, because the XSO
483
         * itself only contains API personality layer data. However the
484
         * underlying QUIC_STREAM is not freed immediately but is instead marked
485
         * as deleted for later collection.
486
         */
487
488
5.35k
        assert(ctx.qc->num_xso > 0);
489
5.35k
        --ctx.qc->num_xso;
490
491
        /* If a stream's send part has not been finished, auto-reset it. */
492
5.35k
        if ((ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_READY
493
2.00k
                || ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_SEND)
494
4.87k
            && !ossl_quic_sstream_get_final_size(ctx.xso->stream->sstream, NULL))
495
4.87k
            ossl_quic_stream_map_reset_stream_send_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
496
4.87k
                ctx.xso->stream, 0);
497
498
        /* Do STOP_SENDING for the receive part, if applicable. */
499
5.35k
        if (ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_RECV
500
993
            || ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_SIZE_KNOWN)
501
4.95k
            ossl_quic_stream_map_stop_sending_recv_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
502
4.95k
                ctx.xso->stream, 0);
503
504
        /* Update stream state. */
505
5.35k
        ctx.xso->stream->deleted = 1;
506
5.35k
        ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(ctx.qc->ch),
507
5.35k
            ctx.xso->stream);
508
509
5.35k
        is_default = (ctx.xso == ctx.qc->default_xso);
510
5.35k
        quic_unlock(ctx.qc);
511
512
        /*
513
         * Unref the connection in most cases; the XSO has a ref to the QC and
514
         * not vice versa. But for a default XSO, to avoid circular references,
515
         * the QC refs the XSO but the XSO does not ref the QC. If we are the
516
         * default XSO, we only get here when the QC is being torn down anyway,
517
         * so don't call SSL_free(qc) as we are already in it.
518
         */
519
5.35k
        if (!is_default)
520
2.77k
            SSL_free(&ctx.qc->ssl);
521
522
        /* Note: SSL_free calls OPENSSL_free(xso) for us */
523
5.35k
        return;
524
5.35k
    }
525
526
    /*
527
     * Free the default XSO, if any. The QUIC_STREAM is not deleted at this
528
     * stage, but is freed during the channel free when the whole QSM is freed.
529
     */
530
20.9k
    if (ctx.qc->default_xso != NULL) {
531
2.58k
        QUIC_XSO *xso = ctx.qc->default_xso;
532
533
2.58k
        quic_unlock(ctx.qc);
534
2.58k
        SSL_free(&xso->ssl);
535
2.58k
        quic_lock(ctx.qc);
536
2.58k
        ctx.qc->default_xso = NULL;
537
2.58k
    }
538
539
    /* Ensure we have no remaining XSOs. */
540
20.9k
    assert(ctx.qc->num_xso == 0);
541
542
20.9k
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
543
20.9k
    if (ctx.qc->is_thread_assisted && ctx.qc->started) {
544
0
        ossl_quic_thread_assist_wait_stopped(&ctx.qc->thread_assist);
545
0
        ossl_quic_thread_assist_cleanup(&ctx.qc->thread_assist);
546
0
    }
547
20.9k
#endif
548
549
20.9k
    SSL_free(ctx.qc->tls);
550
551
20.9k
    ossl_quic_channel_free(ctx.qc->ch);
552
20.9k
    ossl_quic_port_free(ctx.qc->port);
553
20.9k
    ossl_quic_engine_free(ctx.qc->engine);
554
555
20.9k
    BIO_free_all(ctx.qc->net_rbio);
556
20.9k
    BIO_free_all(ctx.qc->net_wbio);
557
558
20.9k
    quic_unlock(ctx.qc); /* tsan doesn't like freeing locked mutexes */
559
20.9k
#if defined(OPENSSL_THREADS)
560
20.9k
    ossl_crypto_mutex_free(&ctx.qc->mutex);
561
20.9k
#endif
562
563
    /*
564
     * Note: SSL_free (that called this function) calls OPENSSL_free(ctx.qc) for
565
     * us
566
     */
567
20.9k
}
568
569
/* SSL method init */
570
int ossl_quic_init(SSL *s)
571
0
{
572
    /* Same op as SSL_clear, forward the call. */
573
0
    return ossl_quic_clear(s);
574
0
}
575
576
/* SSL method deinit */
577
void ossl_quic_deinit(SSL *s)
578
0
{
579
    /* No-op. */
580
0
}
581
582
/* SSL_clear (ssl_reset method) */
583
int ossl_quic_reset(SSL *s)
584
0
{
585
0
    QCTX ctx;
586
587
0
    if (!expect_quic(s, &ctx))
588
0
        return 0;
589
590
0
    ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
591
0
    return 0;
592
0
}
593
594
/* ssl_clear method (unused) */
595
int ossl_quic_clear(SSL *s)
596
0
{
597
0
    QCTX ctx;
598
599
0
    if (!expect_quic(s, &ctx))
600
0
        return 0;
601
602
0
    ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
603
0
    return 0;
604
0
}
605
606
int ossl_quic_conn_set_override_now_cb(SSL *s,
607
    OSSL_TIME (*now_cb)(void *arg),
608
    void *now_cb_arg)
609
20.9k
{
610
20.9k
    QCTX ctx;
611
612
20.9k
    if (!expect_quic(s, &ctx))
613
0
        return 0;
614
615
20.9k
    quic_lock(ctx.qc);
616
617
20.9k
    ctx.qc->override_now_cb = now_cb;
618
20.9k
    ctx.qc->override_now_cb_arg = now_cb_arg;
619
620
20.9k
    quic_unlock(ctx.qc);
621
20.9k
    return 1;
622
20.9k
}
623
624
void ossl_quic_conn_force_assist_thread_wake(SSL *s)
625
0
{
626
0
    QCTX ctx;
627
628
0
    if (!expect_quic(s, &ctx))
629
0
        return;
630
631
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
632
0
    if (ctx.qc->is_thread_assisted && ctx.qc->started)
633
0
        ossl_quic_thread_assist_notify_deadline_changed(&ctx.qc->thread_assist);
634
0
#endif
635
0
}
636
637
QUIC_NEEDS_LOCK
638
static void qc_touch_default_xso(QUIC_CONNECTION *qc)
639
12.4k
{
640
12.4k
    qc->default_xso_created = 1;
641
12.4k
    qc_update_reject_policy(qc);
642
12.4k
}
643
644
/*
645
 * Changes default XSO. Allows caller to keep reference to the old default XSO
646
 * (if any). Reference to new XSO is transferred from caller.
647
 */
648
QUIC_NEEDS_LOCK
649
static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
650
    int touch,
651
    QUIC_XSO **old_xso)
652
6.67k
{
653
6.67k
    int refs;
654
655
6.67k
    *old_xso = NULL;
656
657
6.67k
    if (qc->default_xso != xso) {
658
6.67k
        *old_xso = qc->default_xso; /* transfer old XSO ref to caller */
659
660
6.67k
        qc->default_xso = xso;
661
662
6.67k
        if (xso == NULL) {
663
            /*
664
             * Changing to not having a default XSO. XSO becomes standalone and
665
             * now has a ref to the QC.
666
             */
667
0
            if (!ossl_assert(SSL_up_ref(&qc->ssl)))
668
0
                return;
669
6.67k
        } else {
670
            /*
671
             * Changing from not having a default XSO to having one. The new XSO
672
             * will have had a reference to the QC we need to drop to avoid a
673
             * circular reference.
674
             *
675
             * Currently we never change directly from one default XSO to
676
             * another, though this function would also still be correct if this
677
             * weren't the case.
678
             */
679
6.67k
            assert(*old_xso == NULL);
680
681
6.67k
            CRYPTO_DOWN_REF(&qc->ssl.references, &refs);
682
6.67k
            assert(refs > 0);
683
6.67k
        }
684
6.67k
    }
685
686
6.67k
    if (touch)
687
0
        qc_touch_default_xso(qc);
688
6.67k
}
689
690
/*
691
 * Changes default XSO, releasing the reference to any previous default XSO.
692
 * Reference to new XSO is transferred from caller.
693
 */
694
QUIC_NEEDS_LOCK
695
static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch)
696
6.67k
{
697
6.67k
    QUIC_XSO *old_xso = NULL;
698
699
6.67k
    qc_set_default_xso_keep_ref(qc, xso, touch, &old_xso);
700
701
6.67k
    if (old_xso != NULL)
702
0
        SSL_free(&old_xso->ssl);
703
6.67k
}
704
705
QUIC_NEEDS_LOCK
706
static void xso_update_options(QUIC_XSO *xso)
707
12.4k
{
708
12.4k
    int cleanse = ((xso->ssl_options & SSL_OP_CLEANSE_PLAINTEXT) != 0);
709
710
12.4k
    if (xso->stream->rstream != NULL)
711
12.3k
        ossl_quic_rstream_set_cleanse(xso->stream->rstream, cleanse);
712
713
12.4k
    if (xso->stream->sstream != NULL)
714
11.4k
        ossl_quic_sstream_set_cleanse(xso->stream->sstream, cleanse);
715
12.4k
}
716
717
/*
718
 * SSL_set_options
719
 * ---------------
720
 *
721
 * Setting options on a QCSO
722
 *   - configures the handshake-layer options;
723
 *   - configures the default data-plane options for new streams;
724
 *   - configures the data-plane options on the default XSO, if there is one.
725
 *
726
 * Setting options on a QSSO
727
 *   - configures data-plane options for that stream only.
728
 */
729
QUIC_TAKES_LOCK
730
static uint64_t quic_mask_or_options(SSL *ssl, uint64_t mask_value, uint64_t or_value)
731
0
{
732
0
    QCTX ctx;
733
0
    uint64_t hs_mask_value, hs_or_value, ret;
734
735
0
    if (!expect_quic(ssl, &ctx))
736
0
        return 0;
737
738
0
    quic_lock(ctx.qc);
739
740
0
    if (!ctx.is_stream) {
741
        /*
742
         * If we were called on the connection, we apply any handshake option
743
         * changes.
744
         */
745
0
        hs_mask_value = (mask_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
746
0
        hs_or_value = (or_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
747
748
0
        SSL_clear_options(ctx.qc->tls, hs_mask_value);
749
0
        SSL_set_options(ctx.qc->tls, hs_or_value);
750
751
        /* Update defaults for new streams. */
752
0
        ctx.qc->default_ssl_options
753
0
            = ((ctx.qc->default_ssl_options & ~mask_value) | or_value)
754
0
            & OSSL_QUIC_PERMITTED_OPTIONS;
755
0
    }
756
757
0
    if (ctx.xso != NULL) {
758
0
        ctx.xso->ssl_options
759
0
            = ((ctx.xso->ssl_options & ~mask_value) | or_value)
760
0
            & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
761
762
0
        xso_update_options(ctx.xso);
763
0
    }
764
765
0
    ret = ctx.is_stream ? ctx.xso->ssl_options : ctx.qc->default_ssl_options;
766
767
0
    quic_unlock(ctx.qc);
768
0
    return ret;
769
0
}
770
771
uint64_t ossl_quic_set_options(SSL *ssl, uint64_t options)
772
0
{
773
0
    return quic_mask_or_options(ssl, 0, options);
774
0
}
775
776
/* SSL_clear_options */
777
uint64_t ossl_quic_clear_options(SSL *ssl, uint64_t options)
778
0
{
779
0
    return quic_mask_or_options(ssl, options, 0);
780
0
}
781
782
/* SSL_get_options */
783
uint64_t ossl_quic_get_options(const SSL *ssl)
784
0
{
785
0
    return quic_mask_or_options((SSL *)ssl, 0, 0);
786
0
}
787
788
/*
789
 * QUIC Front-End I/O API: Network BIO Configuration
790
 * =================================================
791
 *
792
 * Handling the different BIOs is difficult:
793
 *
794
 *   - It is more or less a requirement that we use non-blocking network I/O;
795
 *     we need to be able to have timeouts on recv() calls, and make best effort
796
 *     (non blocking) send() and recv() calls.
797
 *
798
 *     The only sensible way to do this is to configure the socket into
799
 *     non-blocking mode. We could try to do select() before calling send() or
800
 *     recv() to get a guarantee that the call will not block, but this will
801
 *     probably run into issues with buggy OSes which generate spurious socket
802
 *     readiness events. In any case, relying on this to work reliably does not
803
 *     seem sane.
804
 *
805
 *     Timeouts could be handled via setsockopt() socket timeout options, but
806
 *     this depends on OS support and adds another syscall to every network I/O
807
 *     operation. It also has obvious thread safety concerns if we want to move
808
 *     to concurrent use of a single socket at some later date.
809
 *
810
 *     Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
811
 *     be made non-blocking. However some OSes (e.g. Windows) do not support
812
 *     this, so we cannot rely on this.
813
 *
814
 *     As such, we need to configure any FD in non-blocking mode. This may
815
 *     confound users who pass a blocking socket to libssl. However, in practice
816
 *     it would be extremely strange for a user of QUIC to pass an FD to us,
817
 *     then also try and send receive traffic on the same socket(!). Thus the
818
 *     impact of this should be limited, and can be documented.
819
 *
820
 *   - We support both blocking and non-blocking operation in terms of the API
821
 *     presented to the user. One prospect is to set the blocking mode based on
822
 *     whether the socket passed to us was already in blocking mode. However,
823
 *     Windows has no API for determining if a socket is in blocking mode (!),
824
 *     therefore this cannot be done portably. Currently therefore we expose an
825
 *     explicit API call to set this, and default to blocking mode.
826
 *
827
 *   - We need to determine our initial destination UDP address. The "natural"
828
 *     way for a user to do this is to set the peer variable on a BIO_dgram.
829
 *     However, this has problems because BIO_dgram's peer variable is used for
830
 *     both transmission and reception. This means it can be constantly being
831
 *     changed to a malicious value (e.g. if some random unrelated entity on the
832
 *     network starts sending traffic to us) on every read call. This is not a
833
 *     direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
834
 *     calls only, which do not use this variable. However, we do need to let
835
 *     the user specify the peer in a 'normal' manner. The compromise here is
836
 *     that we grab the current peer value set at the time the write BIO is set
837
 *     and do not read the value again.
838
 *
839
 *   - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
840
 *     Currently we do this by only supporting non-blocking mode.
841
 *
842
 */
843
844
/*
845
 * Determines what initial destination UDP address we should use, if possible.
846
 * If this fails the client must set the destination address manually, or use a
847
 * BIO which does not need a destination address.
848
 */
849
static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
850
0
{
851
0
    if (BIO_dgram_detect_peer_addr(net_wbio, peer) <= 0)
852
0
        return 0;
853
854
0
    return 1;
855
0
}
856
857
static int qc_can_support_blocking_cached(QUIC_CONNECTION *qc)
858
21.7M
{
859
21.7M
    QUIC_REACTOR *rtor = ossl_quic_channel_get_reactor(qc->ch);
860
861
21.7M
    return ossl_quic_reactor_can_poll_r(rtor)
862
0
        && ossl_quic_reactor_can_poll_w(rtor);
863
21.7M
}
864
865
static void qc_update_can_support_blocking(QUIC_CONNECTION *qc)
866
21.7M
{
867
21.7M
    ossl_quic_port_update_poll_descriptors(qc->port); /* best effort */
868
21.7M
}
869
870
static void qc_update_blocking_mode(QUIC_CONNECTION *qc)
871
21.7M
{
872
21.7M
    qc->blocking = qc->desires_blocking && qc_can_support_blocking_cached(qc);
873
21.7M
}
874
875
void ossl_quic_conn_set0_net_rbio(SSL *s, BIO *net_rbio)
876
20.9k
{
877
20.9k
    QCTX ctx;
878
879
20.9k
    if (!expect_quic(s, &ctx))
880
0
        return;
881
882
20.9k
    if (ctx.qc->net_rbio == net_rbio)
883
0
        return;
884
885
20.9k
    if (!ossl_quic_port_set_net_rbio(ctx.qc->port, net_rbio))
886
0
        return;
887
888
20.9k
    BIO_free_all(ctx.qc->net_rbio);
889
20.9k
    ctx.qc->net_rbio = net_rbio;
890
891
20.9k
    if (net_rbio != NULL)
892
20.9k
        BIO_set_nbio(net_rbio, 1); /* best effort autoconfig */
893
894
    /*
895
     * Determine if the current pair of read/write BIOs now set allows blocking
896
     * mode to be supported.
897
     */
898
20.9k
    qc_update_can_support_blocking(ctx.qc);
899
20.9k
    qc_update_blocking_mode(ctx.qc);
900
20.9k
}
901
902
void ossl_quic_conn_set0_net_wbio(SSL *s, BIO *net_wbio)
903
20.9k
{
904
20.9k
    QCTX ctx;
905
906
20.9k
    if (!expect_quic(s, &ctx))
907
0
        return;
908
909
20.9k
    if (ctx.qc->net_wbio == net_wbio)
910
0
        return;
911
912
20.9k
    if (!ossl_quic_port_set_net_wbio(ctx.qc->port, net_wbio))
913
0
        return;
914
915
20.9k
    BIO_free_all(ctx.qc->net_wbio);
916
20.9k
    ctx.qc->net_wbio = net_wbio;
917
918
20.9k
    if (net_wbio != NULL)
919
20.9k
        BIO_set_nbio(net_wbio, 1); /* best effort autoconfig */
920
921
    /*
922
     * Determine if the current pair of read/write BIOs now set allows blocking
923
     * mode to be supported.
924
     */
925
20.9k
    qc_update_can_support_blocking(ctx.qc);
926
20.9k
    qc_update_blocking_mode(ctx.qc);
927
20.9k
}
928
929
BIO *ossl_quic_conn_get_net_rbio(const SSL *s)
930
41.8k
{
931
41.8k
    QCTX ctx;
932
933
41.8k
    if (!expect_quic(s, &ctx))
934
0
        return NULL;
935
936
41.8k
    return ctx.qc->net_rbio;
937
41.8k
}
938
939
BIO *ossl_quic_conn_get_net_wbio(const SSL *s)
940
20.9k
{
941
20.9k
    QCTX ctx;
942
943
20.9k
    if (!expect_quic(s, &ctx))
944
0
        return NULL;
945
946
20.9k
    return ctx.qc->net_wbio;
947
20.9k
}
948
949
int ossl_quic_conn_get_blocking_mode(const SSL *s)
950
0
{
951
0
    QCTX ctx;
952
953
0
    if (!expect_quic(s, &ctx))
954
0
        return 0;
955
956
0
    if (ctx.is_stream)
957
0
        return xso_blocking_mode(ctx.xso);
958
959
0
    return qc_blocking_mode(ctx.qc);
960
0
}
961
962
QUIC_TAKES_LOCK
963
int ossl_quic_conn_set_blocking_mode(SSL *s, int blocking)
964
0
{
965
0
    int ret = 0;
966
0
    QCTX ctx;
967
968
0
    if (!expect_quic(s, &ctx))
969
0
        return 0;
970
971
0
    quic_lock(ctx.qc);
972
973
    /* Sanity check - can we support the request given the current network BIO? */
974
0
    if (blocking) {
975
        /*
976
         * If called directly on a QCSO, update our information on network BIO
977
         * capabilities.
978
         */
979
0
        if (!ctx.is_stream)
980
0
            qc_update_can_support_blocking(ctx.qc);
981
982
        /* Cannot enable blocking mode if we do not have pollable FDs. */
983
0
        if (!qc_can_support_blocking_cached(ctx.qc)) {
984
0
            ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
985
0
            goto out;
986
0
        }
987
0
    }
988
989
0
    if (!ctx.is_stream)
990
        /*
991
         * If called directly on a QCSO, update default and connection-level
992
         * blocking modes.
993
         */
994
0
        ctx.qc->desires_blocking = (blocking != 0);
995
996
0
    if (ctx.xso != NULL) {
997
        /*
998
         * If called on a QSSO or a QCSO with a default XSO, update the blocking
999
         * mode.
1000
         */
1001
0
        ctx.xso->desires_blocking = (blocking != 0);
1002
0
        ctx.xso->desires_blocking_set = 1;
1003
0
    }
1004
1005
0
    ret = 1;
1006
0
out:
1007
0
    qc_update_blocking_mode(ctx.qc);
1008
0
    quic_unlock(ctx.qc);
1009
0
    return ret;
1010
0
}
1011
1012
int ossl_quic_conn_set_initial_peer_addr(SSL *s,
1013
    const BIO_ADDR *peer_addr)
1014
50.4k
{
1015
50.4k
    QCTX ctx;
1016
1017
50.4k
    if (!expect_quic(s, &ctx))
1018
0
        return 0;
1019
1020
50.4k
    if (ctx.qc->started)
1021
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
1022
50.4k
            NULL);
1023
1024
50.4k
    if (peer_addr == NULL) {
1025
0
        BIO_ADDR_clear(&ctx.qc->init_peer_addr);
1026
0
        return 1;
1027
0
    }
1028
1029
50.4k
    ctx.qc->init_peer_addr = *peer_addr;
1030
50.4k
    return 1;
1031
50.4k
}
1032
1033
/*
1034
 * QUIC Front-End I/O API: Asynchronous I/O Management
1035
 * ===================================================
1036
 *
1037
 *   (BIO/)SSL_handle_events        => ossl_quic_handle_events
1038
 *   (BIO/)SSL_get_event_timeout    => ossl_quic_get_event_timeout
1039
 *   (BIO/)SSL_get_poll_fd          => ossl_quic_get_poll_fd
1040
 *
1041
 */
1042
1043
/* Returns 1 if the connection is being used in blocking mode. */
1044
static int qc_blocking_mode(const QUIC_CONNECTION *qc)
1045
47.1M
{
1046
47.1M
    return qc->blocking;
1047
47.1M
}
1048
1049
static int xso_blocking_mode(const QUIC_XSO *xso)
1050
6.46M
{
1051
6.46M
    if (xso->desires_blocking_set)
1052
0
        return xso->desires_blocking && qc_can_support_blocking_cached(xso->conn);
1053
6.46M
    else
1054
        /* Only ever set if we can support blocking. */
1055
6.46M
        return xso->conn->blocking;
1056
6.46M
}
1057
1058
/* SSL_handle_events; performs QUIC I/O and timeout processing. */
1059
QUIC_TAKES_LOCK
1060
int ossl_quic_handle_events(SSL *s)
1061
0
{
1062
0
    QCTX ctx;
1063
1064
0
    if (!expect_quic(s, &ctx))
1065
0
        return 0;
1066
1067
0
    quic_lock(ctx.qc);
1068
0
    if (ctx.qc->started)
1069
0
        ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1070
0
    quic_unlock(ctx.qc);
1071
0
    return 1;
1072
0
}
1073
1074
/*
1075
 * SSL_get_event_timeout. Get the time in milliseconds until the SSL object
1076
 * should next have events handled by the application by calling
1077
 * SSL_handle_events(). tv is set to 0 if the object should have events handled
1078
 * immediately. If no timeout is currently active, *is_infinite is set to 1 and
1079
 * the value of *tv is undefined.
1080
 */
1081
QUIC_TAKES_LOCK
1082
int ossl_quic_get_event_timeout(SSL *s, struct timeval *tv, int *is_infinite)
1083
34.8M
{
1084
34.8M
    QCTX ctx;
1085
34.8M
    OSSL_TIME deadline = ossl_time_infinite();
1086
1087
34.8M
    if (!expect_quic(s, &ctx))
1088
0
        return 0;
1089
1090
34.8M
    quic_lock(ctx.qc);
1091
1092
34.8M
    if (ctx.qc->started)
1093
34.8M
        deadline
1094
34.8M
            = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(ctx.qc->ch));
1095
1096
34.8M
    if (ossl_time_is_infinite(deadline)) {
1097
134k
        *is_infinite = 1;
1098
1099
        /*
1100
         * Robustness against faulty applications that don't check *is_infinite;
1101
         * harmless long timeout.
1102
         */
1103
134k
        tv->tv_sec = 1000000;
1104
134k
        tv->tv_usec = 0;
1105
1106
134k
        quic_unlock(ctx.qc);
1107
134k
        return 1;
1108
134k
    }
1109
1110
34.7M
    *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, get_time(ctx.qc)));
1111
34.7M
    *is_infinite = 0;
1112
34.7M
    quic_unlock(ctx.qc);
1113
34.7M
    return 1;
1114
34.8M
}
1115
1116
/* SSL_get_rpoll_descriptor */
1117
int ossl_quic_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1118
0
{
1119
0
    QCTX ctx;
1120
1121
0
    if (!expect_quic(s, &ctx))
1122
0
        return 0;
1123
1124
0
    if (desc == NULL || ctx.qc->net_rbio == NULL)
1125
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1126
0
            NULL);
1127
1128
0
    return BIO_get_rpoll_descriptor(ctx.qc->net_rbio, desc);
1129
0
}
1130
1131
/* SSL_get_wpoll_descriptor */
1132
int ossl_quic_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1133
0
{
1134
0
    QCTX ctx;
1135
1136
0
    if (!expect_quic(s, &ctx))
1137
0
        return 0;
1138
1139
0
    if (desc == NULL || ctx.qc->net_wbio == NULL)
1140
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1141
0
            NULL);
1142
1143
0
    return BIO_get_wpoll_descriptor(ctx.qc->net_wbio, desc);
1144
0
}
1145
1146
/* SSL_net_read_desired */
1147
QUIC_TAKES_LOCK
1148
int ossl_quic_get_net_read_desired(SSL *s)
1149
0
{
1150
0
    QCTX ctx;
1151
0
    int ret;
1152
1153
0
    if (!expect_quic(s, &ctx))
1154
0
        return 0;
1155
1156
0
    quic_lock(ctx.qc);
1157
0
    ret = ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
1158
0
    quic_unlock(ctx.qc);
1159
0
    return ret;
1160
0
}
1161
1162
/* SSL_net_write_desired */
1163
QUIC_TAKES_LOCK
1164
int ossl_quic_get_net_write_desired(SSL *s)
1165
0
{
1166
0
    int ret;
1167
0
    QCTX ctx;
1168
1169
0
    if (!expect_quic(s, &ctx))
1170
0
        return 0;
1171
1172
0
    quic_lock(ctx.qc);
1173
0
    ret = ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
1174
0
    quic_unlock(ctx.qc);
1175
0
    return ret;
1176
0
}
1177
1178
/*
1179
 * QUIC Front-End I/O API: Connection Lifecycle Operations
1180
 * =======================================================
1181
 *
1182
 *         SSL_do_handshake         => ossl_quic_do_handshake
1183
 *         SSL_set_connect_state    => ossl_quic_set_connect_state
1184
 *         SSL_set_accept_state     => ossl_quic_set_accept_state
1185
 *         SSL_shutdown             => ossl_quic_shutdown
1186
 *         SSL_ctrl                 => ossl_quic_ctrl
1187
 *   (BIO/)SSL_connect              => ossl_quic_connect
1188
 *   (BIO/)SSL_accept               => ossl_quic_accept
1189
 *
1190
 */
1191
1192
QUIC_NEEDS_LOCK
1193
static void qc_shutdown_flush_init(QUIC_CONNECTION *qc)
1194
0
{
1195
0
    QUIC_STREAM_MAP *qsm;
1196
1197
0
    if (qc->shutting_down)
1198
0
        return;
1199
1200
0
    qsm = ossl_quic_channel_get_qsm(qc->ch);
1201
1202
0
    ossl_quic_stream_map_begin_shutdown_flush(qsm);
1203
0
    qc->shutting_down = 1;
1204
0
}
1205
1206
/* Returns 1 if all shutdown-flush streams have been done with. */
1207
QUIC_NEEDS_LOCK
1208
static int qc_shutdown_flush_finished(QUIC_CONNECTION *qc)
1209
0
{
1210
0
    QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
1211
1212
0
    return qc->shutting_down
1213
0
        && ossl_quic_stream_map_is_shutdown_flush_finished(qsm);
1214
0
}
1215
1216
/* SSL_shutdown */
1217
static int quic_shutdown_wait(void *arg)
1218
0
{
1219
0
    QUIC_CONNECTION *qc = arg;
1220
1221
0
    return ossl_quic_channel_is_terminated(qc->ch);
1222
0
}
1223
1224
/* Returns 1 if shutdown flush process has finished or is inapplicable. */
1225
static int quic_shutdown_flush_wait(void *arg)
1226
0
{
1227
0
    QUIC_CONNECTION *qc = arg;
1228
1229
0
    return ossl_quic_channel_is_term_any(qc->ch)
1230
0
        || qc_shutdown_flush_finished(qc);
1231
0
}
1232
1233
static int quic_shutdown_peer_wait(void *arg)
1234
0
{
1235
0
    QUIC_CONNECTION *qc = arg;
1236
0
    return ossl_quic_channel_is_term_any(qc->ch);
1237
0
}
1238
1239
QUIC_TAKES_LOCK
1240
int ossl_quic_conn_shutdown(SSL *s, uint64_t flags,
1241
    const SSL_SHUTDOWN_EX_ARGS *args,
1242
    size_t args_len)
1243
0
{
1244
0
    int ret;
1245
0
    QCTX ctx;
1246
0
    int stream_flush = ((flags & SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH) == 0);
1247
0
    int no_block = ((flags & SSL_SHUTDOWN_FLAG_NO_BLOCK) != 0);
1248
0
    int wait_peer = ((flags & SSL_SHUTDOWN_FLAG_WAIT_PEER) != 0);
1249
1250
0
    if (!expect_quic(s, &ctx))
1251
0
        return -1;
1252
1253
0
    if (ctx.is_stream) {
1254
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_CONN_USE_ONLY, NULL);
1255
0
        return -1;
1256
0
    }
1257
1258
0
    quic_lock(ctx.qc);
1259
1260
0
    if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1261
0
        quic_unlock(ctx.qc);
1262
0
        return 1;
1263
0
    }
1264
1265
    /* Phase 1: Stream Flushing */
1266
0
    if (!wait_peer && stream_flush) {
1267
0
        qc_shutdown_flush_init(ctx.qc);
1268
1269
0
        if (!qc_shutdown_flush_finished(ctx.qc)) {
1270
0
            if (!no_block && qc_blocking_mode(ctx.qc)) {
1271
0
                ret = block_until_pred(ctx.qc, quic_shutdown_flush_wait, ctx.qc, 0);
1272
0
                if (ret < 1) {
1273
0
                    ret = 0;
1274
0
                    goto err;
1275
0
                }
1276
0
            } else {
1277
0
                qctx_maybe_autotick(&ctx);
1278
0
            }
1279
0
        }
1280
1281
0
        if (!qc_shutdown_flush_finished(ctx.qc)) {
1282
0
            quic_unlock(ctx.qc);
1283
0
            return 0; /* ongoing */
1284
0
        }
1285
0
    }
1286
1287
    /* Phase 2: Connection Closure */
1288
0
    if (wait_peer && !ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1289
0
        if (!no_block && qc_blocking_mode(ctx.qc)) {
1290
0
            ret = block_until_pred(ctx.qc, quic_shutdown_peer_wait, ctx.qc, 0);
1291
0
            if (ret < 1) {
1292
0
                ret = 0;
1293
0
                goto err;
1294
0
            }
1295
0
        } else {
1296
0
            qctx_maybe_autotick(&ctx);
1297
0
        }
1298
1299
0
        if (!ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1300
0
            ret = 0; /* peer hasn't closed yet - still not done */
1301
0
            goto err;
1302
0
        }
1303
1304
        /*
1305
         * We are at least terminating - go through the normal process of
1306
         * waiting until we are in the TERMINATED state.
1307
         */
1308
0
    }
1309
1310
    /* Block mutation ops regardless of if we did stream flush. */
1311
0
    ctx.qc->shutting_down = 1;
1312
1313
    /*
1314
     * This call is a no-op if we are already terminating, so it doesn't
1315
     * affect the wait_peer case.
1316
     */
1317
0
    ossl_quic_channel_local_close(ctx.qc->ch,
1318
0
        args != NULL ? args->quic_error_code : 0,
1319
0
        args != NULL ? args->quic_reason : NULL);
1320
1321
0
    SSL_set_shutdown(ctx.qc->tls, SSL_SENT_SHUTDOWN);
1322
1323
0
    if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1324
0
        quic_unlock(ctx.qc);
1325
0
        return 1;
1326
0
    }
1327
1328
    /* Phase 3: Terminating Wait Time */
1329
0
    if (!no_block && qc_blocking_mode(ctx.qc)
1330
0
        && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0) {
1331
0
        ret = block_until_pred(ctx.qc, quic_shutdown_wait, ctx.qc, 0);
1332
0
        if (ret < 1) {
1333
0
            ret = 0;
1334
0
            goto err;
1335
0
        }
1336
0
    } else {
1337
0
        qctx_maybe_autotick(&ctx);
1338
0
    }
1339
1340
0
    ret = ossl_quic_channel_is_terminated(ctx.qc->ch);
1341
0
err:
1342
0
    quic_unlock(ctx.qc);
1343
0
    return ret;
1344
0
}
1345
1346
/* SSL_ctrl */
1347
long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
1348
20.9k
{
1349
20.9k
    QCTX ctx;
1350
1351
20.9k
    if (!expect_quic(s, &ctx))
1352
0
        return 0;
1353
1354
20.9k
    switch (cmd) {
1355
0
    case SSL_CTRL_MODE:
1356
        /* If called on a QCSO, update the default mode. */
1357
0
        if (!ctx.is_stream)
1358
0
            ctx.qc->default_ssl_mode |= (uint32_t)larg;
1359
1360
        /*
1361
         * If we were called on a QSSO or have a default stream, we also update
1362
         * that.
1363
         */
1364
0
        if (ctx.xso != NULL) {
1365
            /* Cannot enable EPW while AON write in progress. */
1366
0
            if (ctx.xso->aon_write_in_progress)
1367
0
                larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
1368
1369
0
            ctx.xso->ssl_mode |= (uint32_t)larg;
1370
0
            return ctx.xso->ssl_mode;
1371
0
        }
1372
1373
0
        return ctx.qc->default_ssl_mode;
1374
0
    case SSL_CTRL_CLEAR_MODE:
1375
0
        if (!ctx.is_stream)
1376
0
            ctx.qc->default_ssl_mode &= ~(uint32_t)larg;
1377
1378
0
        if (ctx.xso != NULL) {
1379
0
            ctx.xso->ssl_mode &= ~(uint32_t)larg;
1380
0
            return ctx.xso->ssl_mode;
1381
0
        }
1382
1383
0
        return ctx.qc->default_ssl_mode;
1384
1385
0
    case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1386
0
        ossl_quic_channel_set_msg_callback_arg(ctx.qc->ch, parg);
1387
        /* This ctrl also needs to be passed to the internal SSL object */
1388
0
        return SSL_ctrl(ctx.qc->tls, cmd, larg, parg);
1389
1390
0
    case DTLS_CTRL_GET_TIMEOUT: /* DTLSv1_get_timeout */
1391
0
    {
1392
0
        int is_infinite;
1393
1394
0
        if (!ossl_quic_get_event_timeout(s, parg, &is_infinite))
1395
0
            return 0;
1396
1397
0
        return !is_infinite;
1398
0
    }
1399
0
    case DTLS_CTRL_HANDLE_TIMEOUT: /* DTLSv1_handle_timeout */
1400
        /* For legacy compatibility with DTLS calls. */
1401
0
        return ossl_quic_handle_events(s) == 1 ? 1 : -1;
1402
1403
        /* Mask ctrls we shouldn't support for QUIC. */
1404
0
    case SSL_CTRL_GET_READ_AHEAD:
1405
0
    case SSL_CTRL_SET_READ_AHEAD:
1406
0
    case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1407
0
    case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1408
0
    case SSL_CTRL_SET_MAX_PIPELINES:
1409
0
        return 0;
1410
1411
20.9k
    default:
1412
        /*
1413
         * Probably a TLS related ctrl. Send back to the frontend SSL_ctrl
1414
         * implementation. Either SSL_ctrl will handle it itself by direct
1415
         * access into handshake layer state, or failing that, it will be passed
1416
         * to the handshake layer via the SSL_METHOD vtable. If the ctrl is not
1417
         * supported by anything, the handshake layer's ctrl method will finally
1418
         * return 0.
1419
         */
1420
20.9k
        return ossl_ctrl_internal(&ctx.qc->ssl, cmd, larg, parg, /*no_quic=*/1);
1421
20.9k
    }
1422
20.9k
}
1423
1424
/* SSL_set_connect_state */
1425
void ossl_quic_set_connect_state(SSL *s)
1426
20.9k
{
1427
20.9k
    QCTX ctx;
1428
1429
20.9k
    if (!expect_quic(s, &ctx))
1430
0
        return;
1431
1432
    /* Cannot be changed after handshake started */
1433
20.9k
    if (ctx.qc->started || ctx.is_stream)
1434
0
        return;
1435
1436
20.9k
    ctx.qc->as_server_state = 0;
1437
20.9k
}
1438
1439
/* SSL_set_accept_state */
1440
void ossl_quic_set_accept_state(SSL *s)
1441
{
1442
    QCTX ctx;
1443
1444
    if (!expect_quic(s, &ctx))
1445
        return;
1446
1447
    /* Cannot be changed after handshake started */
1448
    if (ctx.qc->started || ctx.is_stream)
1449
        return;
1450
1451
    ctx.qc->as_server_state = 1;
1452
}
1453
1454
/* SSL_do_handshake */
1455
struct quic_handshake_wait_args {
1456
    QUIC_CONNECTION *qc;
1457
};
1458
1459
static int tls_wants_non_io_retry(QUIC_CONNECTION *qc)
1460
47.9M
{
1461
47.9M
    int want = SSL_want(qc->tls);
1462
1463
47.9M
    if (want == SSL_X509_LOOKUP
1464
47.9M
        || want == SSL_CLIENT_HELLO_CB
1465
47.9M
        || want == SSL_RETRY_VERIFY)
1466
0
        return 1;
1467
1468
47.9M
    return 0;
1469
47.9M
}
1470
1471
static int quic_handshake_wait(void *arg)
1472
0
{
1473
0
    struct quic_handshake_wait_args *args = arg;
1474
1475
0
    if (!quic_mutation_allowed(args->qc, /*req_active=*/1))
1476
0
        return -1;
1477
1478
0
    if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
1479
0
        return 1;
1480
1481
0
    if (tls_wants_non_io_retry(args->qc))
1482
0
        return 1;
1483
1484
0
    return 0;
1485
0
}
1486
1487
static int configure_channel(QUIC_CONNECTION *qc)
1488
20.9k
{
1489
20.9k
    assert(qc->ch != NULL);
1490
1491
20.9k
    if (!ossl_quic_port_set_net_rbio(qc->port, qc->net_rbio)
1492
20.9k
        || !ossl_quic_port_set_net_wbio(qc->port, qc->net_wbio)
1493
20.9k
        || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
1494
0
        return 0;
1495
1496
20.9k
    return 1;
1497
20.9k
}
1498
1499
QUIC_NEEDS_LOCK
1500
static int create_channel(QUIC_CONNECTION *qc)
1501
20.9k
{
1502
20.9k
    QUIC_ENGINE_ARGS engine_args = { 0 };
1503
20.9k
    QUIC_PORT_ARGS port_args = { 0 };
1504
1505
20.9k
    engine_args.libctx = qc->ssl.ctx->libctx;
1506
20.9k
    engine_args.propq = qc->ssl.ctx->propq;
1507
20.9k
    engine_args.mutex = qc->mutex;
1508
20.9k
    engine_args.now_cb = get_time_cb;
1509
20.9k
    engine_args.now_cb_arg = qc;
1510
20.9k
    qc->engine = ossl_quic_engine_new(&engine_args);
1511
20.9k
    if (qc->engine == NULL) {
1512
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1513
0
        return 0;
1514
0
    }
1515
1516
20.9k
    port_args.channel_ctx = qc->ssl.ctx;
1517
20.9k
    qc->port = ossl_quic_engine_create_port(qc->engine, &port_args);
1518
20.9k
    if (qc->port == NULL) {
1519
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1520
0
        ossl_quic_engine_free(qc->engine);
1521
0
        return 0;
1522
0
    }
1523
1524
20.9k
    qc->ch = ossl_quic_port_create_outgoing(qc->port, qc->tls);
1525
20.9k
    if (qc->ch == NULL) {
1526
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1527
0
        ossl_quic_port_free(qc->port);
1528
0
        ossl_quic_engine_free(qc->engine);
1529
0
        return 0;
1530
0
    }
1531
1532
20.9k
    return 1;
1533
20.9k
}
1534
1535
/*
1536
 * Configures a channel with the information we have accumulated via calls made
1537
 * to us from the application prior to starting a handshake attempt.
1538
 */
1539
QUIC_NEEDS_LOCK
1540
static int ensure_channel_started(QCTX *ctx)
1541
48.0M
{
1542
48.0M
    QUIC_CONNECTION *qc = ctx->qc;
1543
1544
48.0M
    if (!qc->started) {
1545
50.4k
        if (!configure_channel(qc)) {
1546
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1547
0
                "failed to configure channel");
1548
0
            return 0;
1549
0
        }
1550
1551
50.4k
        if (!ossl_quic_channel_start(qc->ch)) {
1552
0
            ossl_quic_channel_restore_err_state(qc->ch);
1553
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1554
0
                "failed to start channel");
1555
0
            return 0;
1556
0
        }
1557
1558
50.4k
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1559
50.4k
        if (qc->is_thread_assisted)
1560
0
            if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch,
1561
0
                    qc->override_now_cb,
1562
0
                    qc->override_now_cb_arg)) {
1563
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1564
0
                    "failed to start assist thread");
1565
0
                return 0;
1566
0
            }
1567
50.4k
#endif
1568
50.4k
    }
1569
1570
48.0M
    qc->started = 1;
1571
48.0M
    return 1;
1572
48.0M
}
1573
1574
QUIC_NEEDS_LOCK
1575
static int quic_do_handshake(QCTX *ctx)
1576
31.8M
{
1577
31.8M
    int ret;
1578
31.8M
    QUIC_CONNECTION *qc = ctx->qc;
1579
1580
31.8M
    if (ossl_quic_channel_is_handshake_complete(qc->ch))
1581
        /* Handshake already completed. */
1582
10.0M
        return 1;
1583
1584
21.7M
    if (!quic_mutation_allowed(qc, /*req_active=*/0))
1585
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1586
1587
21.7M
    if (qc->as_server != qc->as_server_state) {
1588
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
1589
0
        return -1; /* Non-protocol error */
1590
0
    }
1591
1592
21.7M
    if (qc->net_rbio == NULL || qc->net_wbio == NULL) {
1593
        /* Need read and write BIOs. */
1594
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BIO_NOT_SET, NULL);
1595
0
        return -1; /* Non-protocol error */
1596
0
    }
1597
1598
    /*
1599
     * We need to determine our addressing mode. There are basically two
1600
     * ways we can use L4 addresses:
1601
     *
1602
     *   - Addressed mode, in which our BIO_sendmmsg calls have destination
1603
     *     addresses attached to them which we expect the underlying network BIO
1604
     *     to handle;
1605
     *
1606
     *   - Unaddressed mode, in which the BIO provided to us on the
1607
     *     network side neither provides us with L4 addresses nor is capable of
1608
     *     honouring ones we provide. We don't know where the QUIC traffic we
1609
     *     send ends up exactly and trust the application to know what it is
1610
     *     doing.
1611
     *
1612
     * Addressed mode is preferred because it enables support for connection
1613
     * migration, multipath, etc. in the future. Addressed mode is automatically
1614
     * enabled if we are using e.g. BIO_s_datagram, with or without
1615
     * BIO_s_connect.
1616
     *
1617
     * If we are passed a BIO_s_dgram_pair (or some custom BIO) we may have to
1618
     * use unaddressed mode unless that BIO supports capability flags indicating
1619
     * it can provide and honour L4 addresses.
1620
     *
1621
     * Our strategy for determining address mode is simple: we probe the
1622
     * underlying network BIOs for their capabilities. If the network BIOs
1623
     * support what we need, we use addressed mode. Otherwise, we use
1624
     * unaddressed mode.
1625
     *
1626
     * If addressed mode is chosen, we require an initial peer address to be
1627
     * set. If this is not set, we fail. If unaddressed mode is used, we do not
1628
     * require this, as such an address is superfluous, though it can be set if
1629
     * desired.
1630
     */
1631
21.7M
    if (!qc->started && !qc->addressing_probe_done) {
1632
20.9k
        long rcaps = BIO_dgram_get_effective_caps(qc->net_rbio);
1633
20.9k
        long wcaps = BIO_dgram_get_effective_caps(qc->net_wbio);
1634
1635
20.9k
        qc->addressed_mode_r = ((rcaps & BIO_DGRAM_CAP_PROVIDES_SRC_ADDR) != 0);
1636
20.9k
        qc->addressed_mode_w = ((wcaps & BIO_DGRAM_CAP_HANDLES_DST_ADDR) != 0);
1637
20.9k
        qc->addressing_probe_done = 1;
1638
20.9k
    }
1639
1640
21.7M
    if (!qc->started && qc->addressed_mode_w
1641
20.9k
        && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1642
        /*
1643
         * We are trying to connect and are using addressed mode, which means we
1644
         * need an initial peer address; if we do not have a peer address yet,
1645
         * we should try to autodetect one.
1646
         *
1647
         * We do this as late as possible because some BIOs (e.g. BIO_s_connect)
1648
         * may not be able to provide us with a peer address until they have
1649
         * finished their own processing. They may not be able to perform this
1650
         * processing until an application has finished configuring that BIO
1651
         * (e.g. with setter calls), which might happen after SSL_set_bio is
1652
         * called.
1653
         */
1654
0
        if (!csm_analyse_init_peer_addr(qc->net_wbio, &qc->init_peer_addr))
1655
            /* best effort */
1656
0
            BIO_ADDR_clear(&qc->init_peer_addr);
1657
0
        else
1658
0
            ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr);
1659
0
    }
1660
1661
21.7M
    if (!qc->started
1662
20.9k
        && qc->addressed_mode_w
1663
20.9k
        && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1664
        /*
1665
         * If we still don't have a peer address in addressed mode, we can't do
1666
         * anything.
1667
         */
1668
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
1669
0
        return -1; /* Non-protocol error */
1670
0
    }
1671
1672
    /*
1673
     * Start connection process. Note we may come here multiple times in
1674
     * non-blocking mode, which is fine.
1675
     */
1676
21.7M
    if (!ensure_channel_started(ctx)) /* raises on failure */
1677
0
        return -1; /* Non-protocol error */
1678
1679
21.7M
    if (ossl_quic_channel_is_handshake_complete(qc->ch))
1680
        /* The handshake is now done. */
1681
0
        return 1;
1682
1683
21.7M
    if (!qc_blocking_mode(qc)) {
1684
        /* Try to advance the reactor. */
1685
21.7M
        qctx_maybe_autotick(ctx);
1686
1687
21.7M
        if (ossl_quic_channel_is_handshake_complete(qc->ch))
1688
            /* The handshake is now done. */
1689
5.14k
            return 1;
1690
1691
21.7M
        if (ossl_quic_channel_is_term_any(qc->ch)) {
1692
13.8k
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1693
13.8k
            return 0;
1694
21.7M
        } else if (qc->desires_blocking) {
1695
            /*
1696
             * As a special case when doing a handshake when blocking mode is
1697
             * desired yet not available, see if the network BIOs have become
1698
             * poll descriptor-enabled. This supports BIOs such as BIO_s_connect
1699
             * which do late creation of socket FDs and therefore cannot expose
1700
             * a poll descriptor until after a network BIO is set on the QCSO.
1701
             */
1702
21.7M
            assert(!qc->blocking);
1703
21.7M
            qc_update_can_support_blocking(qc);
1704
21.7M
            qc_update_blocking_mode(qc);
1705
21.7M
        }
1706
21.7M
    }
1707
1708
    /*
1709
     * We are either in blocking mode or just entered it due to the code above.
1710
     */
1711
21.7M
    if (qc_blocking_mode(qc)) {
1712
        /* In blocking mode, wait for the handshake to complete. */
1713
0
        struct quic_handshake_wait_args args;
1714
1715
0
        args.qc = qc;
1716
1717
0
        ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
1718
0
        if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
1719
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1720
0
            return 0; /* Shutdown before completion */
1721
0
        } else if (ret <= 0) {
1722
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1723
0
            return -1; /* Non-protocol error */
1724
0
        }
1725
1726
0
        if (tls_wants_non_io_retry(qc)) {
1727
0
            QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
1728
0
            return -1;
1729
0
        }
1730
1731
0
        assert(ossl_quic_channel_is_handshake_complete(qc->ch));
1732
0
        return 1;
1733
0
    }
1734
1735
21.7M
    if (tls_wants_non_io_retry(qc)) {
1736
0
        QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
1737
0
        return -1;
1738
0
    }
1739
1740
    /*
1741
     * Otherwise, indicate that the handshake isn't done yet.
1742
     * We can only get here in non-blocking mode.
1743
     */
1744
21.7M
    QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1745
21.7M
    return -1; /* Non-protocol error */
1746
21.7M
}
1747
1748
QUIC_TAKES_LOCK
1749
int ossl_quic_do_handshake(SSL *s)
1750
48.0M
{
1751
48.0M
    int ret;
1752
48.0M
    QCTX ctx;
1753
1754
48.0M
    if (!expect_quic(s, &ctx))
1755
0
        return 0;
1756
1757
48.0M
    quic_lock_for_io(&ctx);
1758
1759
48.0M
    ret = quic_do_handshake(&ctx);
1760
48.0M
    quic_unlock(ctx.qc);
1761
48.0M
    return ret;
1762
48.0M
}
1763
1764
/* SSL_connect */
1765
int ossl_quic_connect(SSL *s)
1766
0
{
1767
    /* Ensure we are in connect state (no-op if non-idle). */
1768
0
    ossl_quic_set_connect_state(s);
1769
1770
    /* Begin or continue the handshake */
1771
0
    return ossl_quic_do_handshake(s);
1772
0
}
1773
1774
/* SSL_accept */
1775
int ossl_quic_accept(SSL *s)
1776
0
{
1777
    /* Ensure we are in accept state (no-op if non-idle). */
1778
0
    ossl_quic_set_accept_state(s);
1779
1780
    /* Begin or continue the handshake */
1781
0
    return ossl_quic_do_handshake(s);
1782
0
}
1783
1784
/*
1785
 * QUIC Front-End I/O API: Stream Lifecycle Operations
1786
 * ===================================================
1787
 *
1788
 *         SSL_stream_new       => ossl_quic_conn_stream_new
1789
 *
1790
 */
1791
1792
/*
1793
 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
1794
 * default XSO was created. Returns 0 if it was not (e.g. because it already
1795
 * exists). Note that this is NOT an error condition.
1796
 */
1797
QUIC_NEEDS_LOCK
1798
static int qc_try_create_default_xso_for_write(QCTX *ctx)
1799
0
{
1800
0
    uint64_t flags = 0;
1801
0
    QUIC_CONNECTION *qc = ctx->qc;
1802
1803
0
    if (qc->default_xso_created
1804
0
        || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1805
        /*
1806
         * We only do this once. If the user detaches a previously created
1807
         * default XSO we don't auto-create another one.
1808
         */
1809
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1810
1811
    /* Create a locally-initiated stream. */
1812
0
    if (qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_AUTO_UNI)
1813
0
        flags |= SSL_STREAM_FLAG_UNI;
1814
1815
0
    qc_set_default_xso(qc, (QUIC_XSO *)quic_conn_stream_new(ctx, flags,
1816
0
                               /*needs_lock=*/0),
1817
0
        /*touch=*/0);
1818
0
    if (qc->default_xso == NULL)
1819
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1820
1821
0
    qc_touch_default_xso(qc);
1822
0
    return 1;
1823
0
}
1824
1825
struct quic_wait_for_stream_args {
1826
    QUIC_CONNECTION *qc;
1827
    QUIC_STREAM *qs;
1828
    QCTX *ctx;
1829
    uint64_t expect_id;
1830
};
1831
1832
QUIC_NEEDS_LOCK
1833
static int quic_wait_for_stream(void *arg)
1834
0
{
1835
0
    struct quic_wait_for_stream_args *args = arg;
1836
1837
0
    if (!quic_mutation_allowed(args->qc, /*req_active=*/1)) {
1838
        /* If connection is torn down due to an error while blocking, stop. */
1839
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1840
0
        return -1;
1841
0
    }
1842
1843
0
    args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1844
0
        args->expect_id | QUIC_STREAM_DIR_BIDI);
1845
0
    if (args->qs == NULL)
1846
0
        args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1847
0
            args->expect_id | QUIC_STREAM_DIR_UNI);
1848
1849
0
    if (args->qs != NULL)
1850
0
        return 1; /* stream now exists */
1851
1852
0
    return 0; /* did not get a stream, keep trying */
1853
0
}
1854
1855
QUIC_NEEDS_LOCK
1856
static int qc_wait_for_default_xso_for_read(QCTX *ctx, int peek)
1857
3.59M
{
1858
    /* Called on a QCSO and we don't currently have a default stream. */
1859
3.59M
    uint64_t expect_id;
1860
3.59M
    QUIC_CONNECTION *qc = ctx->qc;
1861
3.59M
    QUIC_STREAM *qs;
1862
3.59M
    int res;
1863
3.59M
    struct quic_wait_for_stream_args wargs;
1864
3.59M
    OSSL_RTT_INFO rtt_info;
1865
1866
    /*
1867
     * If default stream functionality is disabled or we already detached
1868
     * one, don't make another default stream and just fail.
1869
     */
1870
3.59M
    if (qc->default_xso_created
1871
3.59M
        || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1872
2
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1873
1874
    /*
1875
     * The peer may have opened a stream since we last ticked. So tick and
1876
     * see if the stream with ordinal 0 (remote, bidi/uni based on stream
1877
     * mode) exists yet. QUIC stream IDs must be allocated in order, so the
1878
     * first stream created by a peer must have an ordinal of 0.
1879
     */
1880
3.59M
    expect_id = qc->as_server
1881
3.59M
        ? QUIC_STREAM_INITIATOR_CLIENT
1882
3.59M
        : QUIC_STREAM_INITIATOR_SERVER;
1883
1884
3.59M
    qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1885
3.59M
        expect_id | QUIC_STREAM_DIR_BIDI);
1886
3.59M
    if (qs == NULL)
1887
3.59M
        qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1888
3.59M
            expect_id | QUIC_STREAM_DIR_UNI);
1889
1890
3.59M
    if (qs == NULL) {
1891
3.59M
        qctx_maybe_autotick(ctx);
1892
1893
3.59M
        qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1894
3.59M
            expect_id);
1895
3.59M
    }
1896
1897
3.59M
    if (qs == NULL) {
1898
3.59M
        if (peek)
1899
0
            return 0;
1900
1901
3.59M
        if (!qc_blocking_mode(qc))
1902
            /* Non-blocking mode, so just bail immediately. */
1903
3.59M
            return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1904
1905
        /* Block until we have a stream. */
1906
0
        wargs.qc = qc;
1907
0
        wargs.qs = NULL;
1908
0
        wargs.ctx = ctx;
1909
0
        wargs.expect_id = expect_id;
1910
1911
0
        res = block_until_pred(qc, quic_wait_for_stream, &wargs, 0);
1912
0
        if (res == 0)
1913
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1914
0
        else if (res < 0 || wargs.qs == NULL)
1915
            /* quic_wait_for_stream raised error here */
1916
0
            return 0;
1917
1918
0
        qs = wargs.qs;
1919
0
    }
1920
1921
    /*
1922
     * We now have qs != NULL. Remove it from the incoming stream queue so that
1923
     * it isn't also returned by any future SSL_accept_stream calls.
1924
     */
1925
2.58k
    ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
1926
2.58k
    ossl_quic_stream_map_remove_from_accept_queue(ossl_quic_channel_get_qsm(qc->ch),
1927
2.58k
        qs, rtt_info.smoothed_rtt);
1928
1929
    /*
1930
     * Now make qs the default stream, creating the necessary XSO.
1931
     */
1932
2.58k
    qc_set_default_xso(qc, create_xso_from_stream(qc, qs), /*touch=*/0);
1933
2.58k
    if (qc->default_xso == NULL)
1934
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1935
1936
2.58k
    qc_touch_default_xso(qc); /* inhibits default XSO */
1937
2.58k
    return 1;
1938
2.58k
}
1939
1940
QUIC_NEEDS_LOCK
1941
static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs)
1942
12.4k
{
1943
12.4k
    QUIC_XSO *xso = NULL;
1944
1945
12.4k
    if ((xso = OPENSSL_zalloc(sizeof(*xso))) == NULL) {
1946
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
1947
0
        goto err;
1948
0
    }
1949
1950
12.4k
    if (!ossl_ssl_init(&xso->ssl, qc->ssl.ctx, qc->ssl.method, SSL_TYPE_QUIC_XSO)) {
1951
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1952
0
        goto err;
1953
0
    }
1954
1955
    /* XSO refs QC */
1956
12.4k
    if (!SSL_up_ref(&qc->ssl)) {
1957
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SSL_LIB, NULL);
1958
0
        goto err;
1959
0
    }
1960
1961
12.4k
    xso->conn = qc;
1962
12.4k
    xso->ssl_mode = qc->default_ssl_mode;
1963
12.4k
    xso->ssl_options
1964
12.4k
        = qc->default_ssl_options & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
1965
12.4k
    xso->last_error = SSL_ERROR_NONE;
1966
1967
12.4k
    xso->stream = qs;
1968
1969
12.4k
    ++qc->num_xso;
1970
12.4k
    xso_update_options(xso);
1971
12.4k
    return xso;
1972
1973
0
err:
1974
0
    OPENSSL_free(xso);
1975
0
    return NULL;
1976
12.4k
}
1977
1978
struct quic_new_stream_wait_args {
1979
    QUIC_CONNECTION *qc;
1980
    int is_uni;
1981
};
1982
1983
static int quic_new_stream_wait(void *arg)
1984
0
{
1985
0
    struct quic_new_stream_wait_args *args = arg;
1986
0
    QUIC_CONNECTION *qc = args->qc;
1987
1988
0
    if (!quic_mutation_allowed(qc, /*req_active=*/1))
1989
0
        return -1;
1990
1991
0
    if (ossl_quic_channel_is_new_local_stream_admissible(qc->ch, args->is_uni))
1992
0
        return 1;
1993
1994
0
    return 0;
1995
0
}
1996
1997
/* locking depends on need_lock */
1998
static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock)
1999
12.1k
{
2000
12.1k
    int ret;
2001
12.1k
    QUIC_CONNECTION *qc = ctx->qc;
2002
12.1k
    QUIC_XSO *xso = NULL;
2003
12.1k
    QUIC_STREAM *qs = NULL;
2004
12.1k
    int is_uni = ((flags & SSL_STREAM_FLAG_UNI) != 0);
2005
12.1k
    int no_blocking = ((flags & SSL_STREAM_FLAG_NO_BLOCK) != 0);
2006
12.1k
    int advance = ((flags & SSL_STREAM_FLAG_ADVANCE) != 0);
2007
2008
12.1k
    if (need_lock)
2009
12.1k
        quic_lock(qc);
2010
2011
12.1k
    if (!quic_mutation_allowed(qc, /*req_active=*/0)) {
2012
3.40k
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2013
3.40k
        goto err;
2014
3.40k
    }
2015
2016
8.77k
    if (!advance
2017
8.77k
        && !ossl_quic_channel_is_new_local_stream_admissible(qc->ch, is_uni)) {
2018
3.46k
        struct quic_new_stream_wait_args args;
2019
2020
        /*
2021
         * Stream count flow control currently doesn't permit this stream to be
2022
         * opened.
2023
         */
2024
3.46k
        if (no_blocking || !qc_blocking_mode(qc)) {
2025
3.46k
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_STREAM_COUNT_LIMITED, NULL);
2026
3.46k
            goto err;
2027
3.46k
        }
2028
2029
0
        args.qc = qc;
2030
0
        args.is_uni = is_uni;
2031
2032
        /* Blocking mode - wait until we can get a stream. */
2033
0
        ret = block_until_pred(ctx->qc, quic_new_stream_wait, &args, 0);
2034
0
        if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
2035
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2036
0
            goto err; /* Shutdown before completion */
2037
0
        } else if (ret <= 0) {
2038
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2039
0
            goto err; /* Non-protocol error */
2040
0
        }
2041
0
    }
2042
2043
5.31k
    qs = ossl_quic_channel_new_stream_local(qc->ch, is_uni);
2044
5.31k
    if (qs == NULL) {
2045
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2046
0
        goto err;
2047
0
    }
2048
2049
5.31k
    xso = create_xso_from_stream(qc, qs);
2050
5.31k
    if (xso == NULL)
2051
0
        goto err;
2052
2053
5.31k
    qc_touch_default_xso(qc); /* inhibits default XSO */
2054
5.31k
    if (need_lock)
2055
5.31k
        quic_unlock(qc);
2056
2057
5.31k
    return &xso->ssl;
2058
2059
6.86k
err:
2060
6.86k
    OPENSSL_free(xso);
2061
6.86k
    ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc->ch), qs);
2062
6.86k
    if (need_lock)
2063
6.86k
        quic_unlock(qc);
2064
2065
6.86k
    return NULL;
2066
5.31k
}
2067
2068
QUIC_TAKES_LOCK
2069
SSL *ossl_quic_conn_stream_new(SSL *s, uint64_t flags)
2070
12.1k
{
2071
12.1k
    QCTX ctx;
2072
2073
12.1k
    if (!expect_quic_conn_only(s, &ctx))
2074
0
        return NULL;
2075
2076
12.1k
    return quic_conn_stream_new(&ctx, flags, /*need_lock=*/1);
2077
12.1k
}
2078
2079
/*
2080
 * QUIC Front-End I/O API: Steady-State Operations
2081
 * ===============================================
2082
 *
2083
 * Here we dispatch calls to the steady-state front-end I/O API functions; that
2084
 * is, the functions used during the established phase of a QUIC connection
2085
 * (e.g. SSL_read, SSL_write).
2086
 *
2087
 * Each function must handle both blocking and non-blocking modes. As discussed
2088
 * above, all QUIC I/O is implemented using non-blocking mode internally.
2089
 *
2090
 *         SSL_get_error        => partially implemented by ossl_quic_get_error
2091
 *         SSL_want             => ossl_quic_want
2092
 *   (BIO/)SSL_read             => ossl_quic_read
2093
 *   (BIO/)SSL_write            => ossl_quic_write
2094
 *         SSL_pending          => ossl_quic_pending
2095
 *         SSL_stream_conclude  => ossl_quic_conn_stream_conclude
2096
 *         SSL_key_update       => ossl_quic_key_update
2097
 */
2098
2099
/* SSL_get_error */
2100
int ossl_quic_get_error(const SSL *s, int i)
2101
70.5M
{
2102
70.5M
    QCTX ctx;
2103
70.5M
    int net_error, last_error;
2104
2105
70.5M
    if (!expect_quic(s, &ctx))
2106
245
        return 0;
2107
2108
70.5M
    quic_lock(ctx.qc);
2109
70.5M
    net_error = ossl_quic_channel_net_error(ctx.qc->ch);
2110
70.5M
    last_error = ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error;
2111
70.5M
    quic_unlock(ctx.qc);
2112
2113
70.5M
    if (net_error)
2114
0
        return SSL_ERROR_SYSCALL;
2115
2116
70.5M
    return last_error;
2117
70.5M
}
2118
2119
/* Converts a code returned by SSL_get_error to a code returned by SSL_want. */
2120
static int error_to_want(int error)
2121
0
{
2122
0
    switch (error) {
2123
0
    case SSL_ERROR_WANT_CONNECT: /* never used - UDP is connectionless */
2124
0
    case SSL_ERROR_WANT_ACCEPT: /* never used - UDP is connectionless */
2125
0
    case SSL_ERROR_ZERO_RETURN:
2126
0
    default:
2127
0
        return SSL_NOTHING;
2128
2129
0
    case SSL_ERROR_WANT_READ:
2130
0
        return SSL_READING;
2131
2132
0
    case SSL_ERROR_WANT_WRITE:
2133
0
        return SSL_WRITING;
2134
2135
0
    case SSL_ERROR_WANT_RETRY_VERIFY:
2136
0
        return SSL_RETRY_VERIFY;
2137
2138
0
    case SSL_ERROR_WANT_CLIENT_HELLO_CB:
2139
0
        return SSL_CLIENT_HELLO_CB;
2140
2141
0
    case SSL_ERROR_WANT_X509_LOOKUP:
2142
0
        return SSL_X509_LOOKUP;
2143
0
    }
2144
0
}
2145
2146
/* SSL_want */
2147
int ossl_quic_want(const SSL *s)
2148
0
{
2149
0
    QCTX ctx;
2150
0
    int w;
2151
2152
0
    if (!expect_quic(s, &ctx))
2153
0
        return SSL_NOTHING;
2154
2155
0
    quic_lock(ctx.qc);
2156
2157
0
    w = error_to_want(ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error);
2158
2159
0
    quic_unlock(ctx.qc);
2160
0
    return w;
2161
0
}
2162
2163
/*
2164
 * SSL_write
2165
 * ---------
2166
 *
2167
 * The set of functions below provide the implementation of the public SSL_write
2168
 * function. We must handle:
2169
 *
2170
 *   - both blocking and non-blocking operation at the application level,
2171
 *     depending on how we are configured;
2172
 *
2173
 *   - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
2174
 *
2175
 *   - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
2176
 *
2177
 */
2178
QUIC_NEEDS_LOCK
2179
static void quic_post_write(QUIC_XSO *xso, int did_append,
2180
    int did_append_all, uint64_t flags,
2181
    int do_tick)
2182
124k
{
2183
    /*
2184
     * We have appended at least one byte to the stream.
2185
     * Potentially mark stream as active, depending on FC.
2186
     */
2187
124k
    if (did_append)
2188
5.61k
        ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso->conn->ch),
2189
5.61k
            xso->stream);
2190
2191
124k
    if (did_append_all && (flags & SSL_WRITE_FLAG_CONCLUDE) != 0)
2192
0
        ossl_quic_sstream_fin(xso->stream->sstream);
2193
2194
    /*
2195
     * Try and send.
2196
     *
2197
     * TODO(QUIC FUTURE): It is probably inefficient to try and do this
2198
     * immediately, plus we should eventually consider Nagle's algorithm.
2199
     */
2200
124k
    if (do_tick)
2201
124k
        ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso->conn->ch), 0);
2202
124k
}
2203
2204
struct quic_write_again_args {
2205
    QUIC_XSO *xso;
2206
    const unsigned char *buf;
2207
    size_t len;
2208
    size_t total_written;
2209
    int err;
2210
    uint64_t flags;
2211
};
2212
2213
/*
2214
 * Absolute maximum write buffer size, enforced to prevent a rogue peer from
2215
 * deliberately inducing DoS. This has been chosen based on the optimal buffer
2216
 * size for an RTT of 500ms and a bandwidth of 100 Mb/s.
2217
 */
2218
0
#define MAX_WRITE_BUF_SIZE (6 * 1024 * 1024)
2219
2220
/*
2221
 * Ensure spare buffer space available (up until a limit, at least).
2222
 */
2223
QUIC_NEEDS_LOCK
2224
static int sstream_ensure_spare(QUIC_SSTREAM *sstream, uint64_t spare)
2225
124k
{
2226
124k
    size_t cur_sz = ossl_quic_sstream_get_buffer_size(sstream);
2227
124k
    size_t avail = ossl_quic_sstream_get_buffer_avail(sstream);
2228
124k
    size_t spare_ = (spare > SIZE_MAX) ? SIZE_MAX : (size_t)spare;
2229
124k
    size_t new_sz, growth;
2230
2231
124k
    if (spare_ <= avail || cur_sz == MAX_WRITE_BUF_SIZE)
2232
124k
        return 1;
2233
2234
0
    growth = spare_ - avail;
2235
0
    if (cur_sz + growth > MAX_WRITE_BUF_SIZE)
2236
0
        new_sz = MAX_WRITE_BUF_SIZE;
2237
0
    else
2238
0
        new_sz = cur_sz + growth;
2239
2240
0
    return ossl_quic_sstream_set_buffer_size(sstream, new_sz);
2241
124k
}
2242
2243
/*
2244
 * Append to a QUIC_STREAM's QUIC_SSTREAM, ensuring buffer space is expanded
2245
 * as needed according to flow control.
2246
 */
2247
QUIC_NEEDS_LOCK
2248
static int xso_sstream_append(QUIC_XSO *xso, const unsigned char *buf,
2249
    size_t len, size_t *actual_written)
2250
124k
{
2251
124k
    QUIC_SSTREAM *sstream = xso->stream->sstream;
2252
124k
    uint64_t cur = ossl_quic_sstream_get_cur_size(sstream);
2253
124k
    uint64_t cwm = ossl_quic_txfc_get_cwm(&xso->stream->txfc);
2254
124k
    uint64_t permitted = (cwm >= cur ? cwm - cur : 0);
2255
2256
124k
    if (len > permitted)
2257
119k
        len = (size_t)permitted;
2258
2259
124k
    if (!sstream_ensure_spare(sstream, len))
2260
0
        return 0;
2261
2262
124k
    return ossl_quic_sstream_append(sstream, buf, len, actual_written);
2263
124k
}
2264
2265
QUIC_NEEDS_LOCK
2266
static int quic_write_again(void *arg)
2267
0
{
2268
0
    struct quic_write_again_args *args = arg;
2269
0
    size_t actual_written = 0;
2270
2271
0
    if (!quic_mutation_allowed(args->xso->conn, /*req_active=*/1))
2272
        /* If connection is torn down due to an error while blocking, stop. */
2273
0
        return -2;
2274
2275
0
    if (!quic_validate_for_write(args->xso, &args->err))
2276
        /*
2277
         * Stream may have become invalid for write due to connection events
2278
         * while we blocked.
2279
         */
2280
0
        return -2;
2281
2282
0
    args->err = ERR_R_INTERNAL_ERROR;
2283
0
    if (!xso_sstream_append(args->xso, args->buf, args->len, &actual_written))
2284
0
        return -2;
2285
2286
0
    quic_post_write(args->xso, actual_written > 0,
2287
0
        args->len == actual_written, args->flags, 0);
2288
2289
0
    args->buf += actual_written;
2290
0
    args->len -= actual_written;
2291
0
    args->total_written += actual_written;
2292
2293
0
    if (args->len == 0)
2294
        /* Written everything, done. */
2295
0
        return 1;
2296
2297
    /* Not written everything yet, keep trying. */
2298
0
    return 0;
2299
0
}
2300
2301
QUIC_NEEDS_LOCK
2302
static int quic_write_blocking(QCTX *ctx, const void *buf, size_t len,
2303
    uint64_t flags, size_t *written)
2304
0
{
2305
0
    int res;
2306
0
    QUIC_XSO *xso = ctx->xso;
2307
0
    struct quic_write_again_args args;
2308
0
    size_t actual_written = 0;
2309
2310
    /* First make a best effort to append as much of the data as possible. */
2311
0
    if (!xso_sstream_append(xso, buf, len, &actual_written)) {
2312
        /* Stream already finished or allocation error. */
2313
0
        *written = 0;
2314
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2315
0
    }
2316
2317
0
    quic_post_write(xso, actual_written > 0, actual_written == len, flags, 1);
2318
2319
    /*
2320
     * Record however much data we wrote
2321
     */
2322
0
    *written = actual_written;
2323
2324
0
    if (actual_written == len) {
2325
        /* Managed to append everything on the first try. */
2326
0
        return 1;
2327
0
    }
2328
2329
    /*
2330
     * We did not manage to append all of the data immediately, so the stream
2331
     * buffer has probably filled up. This means we need to block until some of
2332
     * it is freed up.
2333
     */
2334
0
    args.xso = xso;
2335
0
    args.buf = (const unsigned char *)buf + actual_written;
2336
0
    args.len = len - actual_written;
2337
0
    args.total_written = 0;
2338
0
    args.err = ERR_R_INTERNAL_ERROR;
2339
0
    args.flags = flags;
2340
2341
0
    res = block_until_pred(xso->conn, quic_write_again, &args, 0);
2342
0
    if (res <= 0) {
2343
0
        if (!quic_mutation_allowed(xso->conn, /*req_active=*/1))
2344
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2345
0
        else
2346
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, args.err, NULL);
2347
0
    }
2348
2349
    /*
2350
     * When waiting on extra buffer space to be available, args.total_written
2351
     * holds the amount of remaining data we requested to write, which will be
2352
     * something less than the len parameter passed in, however much we wrote
2353
     * here, add it to the value that we wrote when we initially called
2354
     * xso_sstream_append
2355
     */
2356
0
    *written += args.total_written;
2357
0
    return 1;
2358
0
}
2359
2360
/*
2361
 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
2362
 * write semantics.
2363
 */
2364
static void aon_write_begin(QUIC_XSO *xso, const unsigned char *buf,
2365
    size_t buf_len, size_t already_sent)
2366
629
{
2367
629
    assert(!xso->aon_write_in_progress);
2368
2369
629
    xso->aon_write_in_progress = 1;
2370
629
    xso->aon_buf_base = buf;
2371
629
    xso->aon_buf_pos = already_sent;
2372
629
    xso->aon_buf_len = buf_len;
2373
629
}
2374
2375
static void aon_write_finish(QUIC_XSO *xso)
2376
131
{
2377
131
    xso->aon_write_in_progress = 0;
2378
131
    xso->aon_buf_base = NULL;
2379
131
    xso->aon_buf_pos = 0;
2380
131
    xso->aon_buf_len = 0;
2381
131
}
2382
2383
QUIC_NEEDS_LOCK
2384
static int quic_write_nonblocking_aon(QCTX *ctx, const void *buf,
2385
    size_t len, uint64_t flags,
2386
    size_t *written)
2387
124k
{
2388
124k
    QUIC_XSO *xso = ctx->xso;
2389
124k
    const void *actual_buf;
2390
124k
    size_t actual_len, actual_written = 0;
2391
124k
    int accept_moving_buffer
2392
124k
        = ((xso->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
2393
2394
124k
    if (xso->aon_write_in_progress) {
2395
        /*
2396
         * We are in the middle of an AON write (i.e., a previous write did not
2397
         * manage to append all data to the SSTREAM and we have Enable Partial
2398
         * Write (EPW) mode disabled.)
2399
         */
2400
115k
        if ((!accept_moving_buffer && xso->aon_buf_base != buf)
2401
115k
            || len != xso->aon_buf_len)
2402
            /*
2403
             * Pointer must not have changed if we are not in accept moving
2404
             * buffer mode. Length must never change.
2405
             */
2406
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BAD_WRITE_RETRY, NULL);
2407
2408
115k
        actual_buf = (unsigned char *)buf + xso->aon_buf_pos;
2409
115k
        actual_len = len - xso->aon_buf_pos;
2410
115k
        assert(actual_len > 0);
2411
115k
    } else {
2412
9.63k
        actual_buf = buf;
2413
9.63k
        actual_len = len;
2414
9.63k
    }
2415
2416
    /* First make a best effort to append as much of the data as possible. */
2417
124k
    if (!xso_sstream_append(xso, actual_buf, actual_len, &actual_written)) {
2418
        /* Stream already finished or allocation error. */
2419
0
        *written = 0;
2420
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2421
0
    }
2422
2423
124k
    quic_post_write(xso, actual_written > 0, actual_written == actual_len,
2424
124k
        flags, qctx_should_autotick(ctx));
2425
2426
124k
    if (actual_written == actual_len) {
2427
        /* We have sent everything. */
2428
4.97k
        if (xso->aon_write_in_progress) {
2429
            /*
2430
             * We have sent everything, and we were in the middle of an AON
2431
             * write. The output write length is the total length of the AON
2432
             * buffer, not however many bytes we managed to write to the stream
2433
             * in this call.
2434
             */
2435
131
            *written = xso->aon_buf_len;
2436
131
            aon_write_finish(xso);
2437
4.84k
        } else {
2438
4.84k
            *written = actual_written;
2439
4.84k
        }
2440
2441
4.97k
        return 1;
2442
4.97k
    }
2443
2444
119k
    if (xso->aon_write_in_progress) {
2445
        /*
2446
         * AON write is in progress but we have not written everything yet. We
2447
         * may have managed to send zero bytes, or some number of bytes less
2448
         * than the total remaining which need to be appended during this
2449
         * AON operation.
2450
         */
2451
115k
        xso->aon_buf_pos += actual_written;
2452
115k
        assert(xso->aon_buf_pos < xso->aon_buf_len);
2453
115k
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2454
115k
    }
2455
2456
    /*
2457
     * Not in an existing AON operation but partial write is not enabled, so we
2458
     * need to begin a new AON operation. However we needn't bother if we didn't
2459
     * actually append anything.
2460
     */
2461
4.79k
    if (actual_written > 0)
2462
629
        aon_write_begin(xso, buf, len, actual_written);
2463
2464
    /*
2465
     * AON - We do not publicly admit to having appended anything until AON
2466
     * completes.
2467
     */
2468
4.79k
    *written = 0;
2469
4.79k
    return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2470
119k
}
2471
2472
QUIC_NEEDS_LOCK
2473
static int quic_write_nonblocking_epw(QCTX *ctx, const void *buf, size_t len,
2474
    uint64_t flags, size_t *written)
2475
0
{
2476
0
    QUIC_XSO *xso = ctx->xso;
2477
2478
    /* Simple best effort operation. */
2479
0
    if (!xso_sstream_append(xso, buf, len, written)) {
2480
        /* Stream already finished or allocation error. */
2481
0
        *written = 0;
2482
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2483
0
    }
2484
2485
0
    quic_post_write(xso, *written > 0, *written == len, flags,
2486
0
        qctx_should_autotick(ctx));
2487
2488
0
    if (*written == 0)
2489
        /* SSL_write_ex returns 0 if it didn't read anything. */
2490
0
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
2491
2492
0
    return 1;
2493
0
}
2494
2495
QUIC_NEEDS_LOCK
2496
static int quic_validate_for_write(QUIC_XSO *xso, int *err)
2497
124k
{
2498
124k
    QUIC_STREAM_MAP *qsm;
2499
2500
124k
    if (xso == NULL || xso->stream == NULL) {
2501
0
        *err = ERR_R_INTERNAL_ERROR;
2502
0
        return 0;
2503
0
    }
2504
2505
124k
    switch (xso->stream->send_state) {
2506
0
    default:
2507
10
    case QUIC_SSTREAM_STATE_NONE:
2508
10
        *err = SSL_R_STREAM_RECV_ONLY;
2509
10
        return 0;
2510
2511
3.60k
    case QUIC_SSTREAM_STATE_READY:
2512
3.60k
        qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2513
2514
3.60k
        if (!ossl_quic_stream_map_ensure_send_part_id(qsm, xso->stream)) {
2515
0
            *err = ERR_R_INTERNAL_ERROR;
2516
0
            return 0;
2517
0
        }
2518
2519
        /* FALLTHROUGH */
2520
124k
    case QUIC_SSTREAM_STATE_SEND:
2521
124k
    case QUIC_SSTREAM_STATE_DATA_SENT:
2522
124k
        if (ossl_quic_sstream_get_final_size(xso->stream->sstream, NULL)) {
2523
0
            *err = SSL_R_STREAM_FINISHED;
2524
0
            return 0;
2525
0
        }
2526
124k
        return 1;
2527
2528
0
    case QUIC_SSTREAM_STATE_DATA_RECVD:
2529
0
        *err = SSL_R_STREAM_FINISHED;
2530
0
        return 0;
2531
2532
21
    case QUIC_SSTREAM_STATE_RESET_SENT:
2533
21
    case QUIC_SSTREAM_STATE_RESET_RECVD:
2534
21
        *err = SSL_R_STREAM_RESET;
2535
21
        return 0;
2536
124k
    }
2537
124k
}
2538
2539
QUIC_TAKES_LOCK
2540
int ossl_quic_write_flags(SSL *s, const void *buf, size_t len,
2541
    uint64_t flags, size_t *written)
2542
125k
{
2543
125k
    int ret;
2544
125k
    QCTX ctx;
2545
125k
    int partial_write, err;
2546
2547
125k
    *written = 0;
2548
2549
125k
    if (len == 0) {
2550
        /* Do not autocreate default XSO for zero-length writes. */
2551
0
        if (!expect_quic(s, &ctx))
2552
0
            return 0;
2553
2554
0
        quic_lock_for_io(&ctx);
2555
125k
    } else {
2556
125k
        if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/1, &ctx))
2557
0
            return 0;
2558
125k
    }
2559
2560
125k
    partial_write = ((ctx.xso != NULL)
2561
125k
            ? ((ctx.xso->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0)
2562
125k
            : 0);
2563
2564
125k
    if ((flags & ~SSL_WRITE_FLAG_CONCLUDE) != 0) {
2565
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_UNSUPPORTED_WRITE_FLAG, NULL);
2566
0
        goto out;
2567
0
    }
2568
2569
125k
    if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
2570
534
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2571
534
        goto out;
2572
534
    }
2573
2574
    /*
2575
     * If we haven't finished the handshake, try to advance it.
2576
     * We don't accept writes until the handshake is completed.
2577
     */
2578
124k
    if (quic_do_handshake(&ctx) < 1) {
2579
0
        ret = 0;
2580
0
        goto out;
2581
0
    }
2582
2583
    /* Ensure correct stream state, stream send part not concluded, etc. */
2584
124k
    if (len > 0 && !quic_validate_for_write(ctx.xso, &err)) {
2585
31
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
2586
31
        goto out;
2587
31
    }
2588
2589
124k
    if (len == 0) {
2590
0
        if ((flags & SSL_WRITE_FLAG_CONCLUDE) != 0)
2591
0
            quic_post_write(ctx.xso, 0, 1, flags,
2592
0
                qctx_should_autotick(&ctx));
2593
2594
0
        ret = 1;
2595
0
        goto out;
2596
0
    }
2597
2598
124k
    if (xso_blocking_mode(ctx.xso))
2599
0
        ret = quic_write_blocking(&ctx, buf, len, flags, written);
2600
124k
    else if (partial_write)
2601
0
        ret = quic_write_nonblocking_epw(&ctx, buf, len, flags, written);
2602
124k
    else
2603
124k
        ret = quic_write_nonblocking_aon(&ctx, buf, len, flags, written);
2604
2605
125k
out:
2606
125k
    quic_unlock(ctx.qc);
2607
125k
    return ret;
2608
124k
}
2609
2610
QUIC_TAKES_LOCK
2611
int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
2612
0
{
2613
0
    return ossl_quic_write_flags(s, buf, len, 0, written);
2614
0
}
2615
2616
/*
2617
 * SSL_read
2618
 * --------
2619
 */
2620
struct quic_read_again_args {
2621
    QCTX *ctx;
2622
    QUIC_STREAM *stream;
2623
    void *buf;
2624
    size_t len;
2625
    size_t *bytes_read;
2626
    int peek;
2627
};
2628
2629
QUIC_NEEDS_LOCK
2630
static int quic_validate_for_read(QUIC_XSO *xso, int *err, int *eos)
2631
33.0M
{
2632
33.0M
    QUIC_STREAM_MAP *qsm;
2633
2634
33.0M
    *eos = 0;
2635
2636
33.0M
    if (xso == NULL || xso->stream == NULL) {
2637
0
        *err = ERR_R_INTERNAL_ERROR;
2638
0
        return 0;
2639
0
    }
2640
2641
33.0M
    switch (xso->stream->recv_state) {
2642
0
    default:
2643
0
    case QUIC_RSTREAM_STATE_NONE:
2644
0
        *err = SSL_R_STREAM_SEND_ONLY;
2645
0
        return 0;
2646
2647
17.8M
    case QUIC_RSTREAM_STATE_RECV:
2648
33.0M
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
2649
33.0M
    case QUIC_RSTREAM_STATE_DATA_RECVD:
2650
33.0M
        return 1;
2651
2652
156
    case QUIC_RSTREAM_STATE_DATA_READ:
2653
156
        *eos = 1;
2654
156
        return 0;
2655
2656
146
    case QUIC_RSTREAM_STATE_RESET_RECVD:
2657
146
        qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2658
146
        ossl_quic_stream_map_notify_app_read_reset_recv_part(qsm, xso->stream);
2659
2660
        /* FALLTHROUGH */
2661
146
    case QUIC_RSTREAM_STATE_RESET_READ:
2662
146
        *err = SSL_R_STREAM_RESET;
2663
146
        return 0;
2664
33.0M
    }
2665
33.0M
}
2666
2667
QUIC_NEEDS_LOCK
2668
static int quic_read_actual(QCTX *ctx,
2669
    QUIC_STREAM *stream,
2670
    void *buf, size_t buf_len,
2671
    size_t *bytes_read,
2672
    int peek)
2673
33.0M
{
2674
33.0M
    int is_fin = 0, err, eos;
2675
33.0M
    QUIC_CONNECTION *qc = ctx->qc;
2676
2677
33.0M
    if (!quic_validate_for_read(ctx->xso, &err, &eos)) {
2678
302
        if (eos) {
2679
156
            ctx->xso->retired_fin = 1;
2680
156
            return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
2681
156
        } else {
2682
146
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, err, NULL);
2683
146
        }
2684
302
    }
2685
2686
33.0M
    if (peek) {
2687
0
        if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
2688
0
                bytes_read, &is_fin))
2689
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2690
2691
33.0M
    } else {
2692
33.0M
        if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
2693
33.0M
                bytes_read, &is_fin))
2694
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2695
33.0M
    }
2696
2697
33.0M
    if (!peek) {
2698
33.0M
        if (*bytes_read > 0) {
2699
            /*
2700
             * We have read at least one byte from the stream. Inform stream-level
2701
             * RXFC of the retirement of controlled bytes. Update the active stream
2702
             * status (the RXFC may now want to emit a frame granting more credit to
2703
             * the peer).
2704
             */
2705
5.98k
            OSSL_RTT_INFO rtt_info;
2706
2707
5.98k
            ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
2708
2709
5.98k
            if (!ossl_quic_rxfc_on_retire(&stream->rxfc, *bytes_read,
2710
5.98k
                    rtt_info.smoothed_rtt))
2711
0
                return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2712
5.98k
        }
2713
2714
33.0M
        if (is_fin && !peek) {
2715
732
            QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(ctx->qc->ch);
2716
2717
732
            ossl_quic_stream_map_notify_totally_read(qsm, ctx->xso->stream);
2718
732
        }
2719
2720
33.0M
        if (*bytes_read > 0)
2721
5.98k
            ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
2722
5.98k
                stream);
2723
33.0M
    }
2724
2725
33.0M
    if (*bytes_read == 0 && is_fin) {
2726
141
        ctx->xso->retired_fin = 1;
2727
141
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
2728
141
    }
2729
2730
33.0M
    return 1;
2731
33.0M
}
2732
2733
QUIC_NEEDS_LOCK
2734
static int quic_read_again(void *arg)
2735
0
{
2736
0
    struct quic_read_again_args *args = arg;
2737
2738
0
    if (!quic_mutation_allowed(args->ctx->qc, /*req_active=*/1)) {
2739
        /* If connection is torn down due to an error while blocking, stop. */
2740
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2741
0
        return -1;
2742
0
    }
2743
2744
0
    if (!quic_read_actual(args->ctx, args->stream,
2745
0
            args->buf, args->len, args->bytes_read,
2746
0
            args->peek))
2747
0
        return -1;
2748
2749
0
    if (*args->bytes_read > 0)
2750
        /* got at least one byte, the SSL_read op can finish now */
2751
0
        return 1;
2752
2753
0
    return 0; /* did not read anything, keep trying */
2754
0
}
2755
2756
QUIC_TAKES_LOCK
2757
static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
2758
9.99M
{
2759
9.99M
    int ret, res;
2760
9.99M
    QCTX ctx;
2761
9.99M
    struct quic_read_again_args args;
2762
2763
9.99M
    *bytes_read = 0;
2764
2765
9.99M
    if (!expect_quic(s, &ctx))
2766
0
        return 0;
2767
2768
9.99M
    quic_lock_for_io(&ctx);
2769
2770
9.99M
    if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
2771
2.03k
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2772
2.03k
        goto out;
2773
2.03k
    }
2774
2775
    /* If we haven't finished the handshake, try to advance it. */
2776
9.98M
    if (quic_do_handshake(&ctx) < 1) {
2777
0
        ret = 0; /* ossl_quic_do_handshake raised error here */
2778
0
        goto out;
2779
0
    }
2780
2781
9.98M
    if (ctx.xso == NULL) {
2782
        /*
2783
         * Called on a QCSO and we don't currently have a default stream.
2784
         *
2785
         * Wait until we get a stream initiated by the peer (blocking mode) or
2786
         * fail if we don't have one yet (non-blocking mode).
2787
         */
2788
3.59M
        if (!qc_wait_for_default_xso_for_read(&ctx, /*peek=*/0)) {
2789
3.59M
            ret = 0; /* error already raised here */
2790
3.59M
            goto out;
2791
3.59M
        }
2792
2793
2.58k
        ctx.xso = ctx.qc->default_xso;
2794
2.58k
    }
2795
2796
6.39M
    if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
2797
137
        ret = 0; /* quic_read_actual raised error here */
2798
137
        goto out;
2799
137
    }
2800
2801
6.39M
    if (*bytes_read > 0) {
2802
        /*
2803
         * Even though we succeeded, tick the reactor here to ensure we are
2804
         * handling other aspects of the QUIC connection.
2805
         */
2806
1.88k
        qctx_maybe_autotick(&ctx);
2807
1.88k
        ret = 1;
2808
6.39M
    } else if (xso_blocking_mode(ctx.xso)) {
2809
        /*
2810
         * We were not able to read anything immediately, so our stream
2811
         * buffer is empty. This means we need to block until we get
2812
         * at least one byte.
2813
         */
2814
0
        args.ctx = &ctx;
2815
0
        args.stream = ctx.xso->stream;
2816
0
        args.buf = buf;
2817
0
        args.len = len;
2818
0
        args.bytes_read = bytes_read;
2819
0
        args.peek = peek;
2820
2821
0
        res = block_until_pred(ctx.qc, quic_read_again, &args, 0);
2822
0
        if (res == 0) {
2823
0
            ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2824
0
            goto out;
2825
0
        } else if (res < 0) {
2826
0
            ret = 0; /* quic_read_again raised error here */
2827
0
            goto out;
2828
0
        }
2829
2830
0
        ret = 1;
2831
6.39M
    } else {
2832
        /*
2833
         * We did not get any bytes and are not in blocking mode.
2834
         * Tick to see if this delivers any more.
2835
         */
2836
6.39M
        qctx_maybe_autotick(&ctx);
2837
2838
        /* Try the read again. */
2839
6.39M
        if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
2840
26
            ret = 0; /* quic_read_actual raised error here */
2841
26
            goto out;
2842
26
        }
2843
2844
6.39M
        if (*bytes_read > 0)
2845
673
            ret = 1; /* Succeeded this time. */
2846
6.39M
        else
2847
6.39M
            ret = QUIC_RAISE_NORMAL_ERROR(&ctx, SSL_ERROR_WANT_READ);
2848
6.39M
    }
2849
2850
9.99M
out:
2851
9.99M
    quic_unlock(ctx.qc);
2852
9.99M
    return ret;
2853
6.39M
}
2854
2855
int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
2856
22.4M
{
2857
22.4M
    return quic_read(s, buf, len, bytes_read, 0);
2858
22.4M
}
2859
2860
int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
2861
0
{
2862
0
    return quic_read(s, buf, len, bytes_read, 1);
2863
0
}
2864
2865
/*
2866
 * SSL_pending
2867
 * -----------
2868
 */
2869
2870
QUIC_TAKES_LOCK
2871
static size_t ossl_quic_pending_int(const SSL *s, int check_channel)
2872
0
{
2873
0
    QCTX ctx;
2874
0
    size_t avail = 0;
2875
2876
0
    if (!expect_quic(s, &ctx))
2877
0
        return 0;
2878
2879
0
    quic_lock(ctx.qc);
2880
2881
0
    if (!ctx.qc->started)
2882
0
        goto out;
2883
2884
0
    if (ctx.xso == NULL) {
2885
        /* No XSO yet, but there might be a default XSO eligible to be created. */
2886
0
        if (qc_wait_for_default_xso_for_read(&ctx, /*peek=*/1)) {
2887
0
            ctx.xso = ctx.qc->default_xso;
2888
0
        } else {
2889
0
            QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_NO_STREAM, NULL);
2890
0
            goto out;
2891
0
        }
2892
0
    }
2893
2894
0
    if (ctx.xso->stream == NULL) {
2895
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2896
0
        goto out;
2897
0
    }
2898
2899
0
    if (check_channel)
2900
0
        avail = ossl_quic_stream_recv_pending(ctx.xso->stream,
2901
0
                    /*include_fin=*/1)
2902
0
            || ossl_quic_channel_has_pending(ctx.qc->ch)
2903
0
            || ossl_quic_channel_is_term_any(ctx.qc->ch);
2904
0
    else
2905
0
        avail = ossl_quic_stream_recv_pending(ctx.xso->stream,
2906
0
            /*include_fin=*/0);
2907
2908
0
out:
2909
0
    quic_unlock(ctx.qc);
2910
0
    return avail;
2911
0
}
2912
2913
size_t ossl_quic_pending(const SSL *s)
2914
0
{
2915
0
    return ossl_quic_pending_int(s, /*check_channel=*/0);
2916
0
}
2917
2918
int ossl_quic_has_pending(const SSL *s)
2919
0
{
2920
    /* Do we have app-side pending data or pending URXEs or RXEs? */
2921
0
    return ossl_quic_pending_int(s, /*check_channel=*/1) > 0;
2922
0
}
2923
2924
/*
2925
 * SSL_stream_conclude
2926
 * -------------------
2927
 */
2928
QUIC_TAKES_LOCK
2929
int ossl_quic_conn_stream_conclude(SSL *s)
2930
0
{
2931
0
    QCTX ctx;
2932
0
    QUIC_STREAM *qs;
2933
0
    int err;
2934
0
    int ret;
2935
2936
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/0, &ctx))
2937
0
        return 0;
2938
2939
0
    qs = ctx.xso->stream;
2940
2941
0
    if (!quic_mutation_allowed(ctx.qc, /*req_active=*/1)) {
2942
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2943
0
        quic_unlock(ctx.qc);
2944
0
        return ret;
2945
0
    }
2946
2947
0
    if (!quic_validate_for_write(ctx.xso, &err)) {
2948
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
2949
0
        quic_unlock(ctx.qc);
2950
0
        return ret;
2951
0
    }
2952
2953
0
    if (ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
2954
0
        quic_unlock(ctx.qc);
2955
0
        return 1;
2956
0
    }
2957
2958
0
    ossl_quic_sstream_fin(qs->sstream);
2959
0
    quic_post_write(ctx.xso, 1, 0, 0, qctx_should_autotick(&ctx));
2960
0
    quic_unlock(ctx.qc);
2961
0
    return 1;
2962
0
}
2963
2964
/*
2965
 * SSL_inject_net_dgram
2966
 * --------------------
2967
 */
2968
QUIC_TAKES_LOCK
2969
int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
2970
    size_t buf_len,
2971
    const BIO_ADDR *peer,
2972
    const BIO_ADDR *local)
2973
0
{
2974
0
    int ret;
2975
0
    QCTX ctx;
2976
0
    QUIC_DEMUX *demux;
2977
2978
0
    if (!expect_quic(s, &ctx))
2979
0
        return 0;
2980
2981
0
    quic_lock(ctx.qc);
2982
2983
0
    demux = ossl_quic_channel_get0_demux(ctx.qc->ch);
2984
0
    ret = ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
2985
2986
0
    quic_unlock(ctx.qc);
2987
0
    return ret;
2988
0
}
2989
2990
/*
2991
 * SSL_get0_connection
2992
 * -------------------
2993
 */
2994
SSL *ossl_quic_get0_connection(SSL *s)
2995
0
{
2996
0
    QCTX ctx;
2997
2998
0
    if (!expect_quic(s, &ctx))
2999
0
        return NULL;
3000
3001
0
    return &ctx.qc->ssl;
3002
0
}
3003
3004
/*
3005
 * SSL_get_stream_type
3006
 * -------------------
3007
 */
3008
int ossl_quic_get_stream_type(SSL *s)
3009
0
{
3010
0
    QCTX ctx;
3011
3012
0
    if (!expect_quic(s, &ctx))
3013
0
        return SSL_STREAM_TYPE_BIDI;
3014
3015
0
    if (ctx.xso == NULL) {
3016
        /*
3017
         * If deferred XSO creation has yet to occur, proceed according to the
3018
         * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
3019
         * what kind of stream will be created yet, so return BIDI on the basis
3020
         * that at this time, the client still has the option of calling
3021
         * SSL_read() or SSL_write() first.
3022
         */
3023
0
        if (ctx.qc->default_xso_created
3024
0
            || ctx.qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
3025
0
            return SSL_STREAM_TYPE_NONE;
3026
0
        else
3027
0
            return SSL_STREAM_TYPE_BIDI;
3028
0
    }
3029
3030
0
    if (ossl_quic_stream_is_bidi(ctx.xso->stream))
3031
0
        return SSL_STREAM_TYPE_BIDI;
3032
3033
0
    if (ossl_quic_stream_is_server_init(ctx.xso->stream) != ctx.qc->as_server)
3034
0
        return SSL_STREAM_TYPE_READ;
3035
0
    else
3036
0
        return SSL_STREAM_TYPE_WRITE;
3037
0
}
3038
3039
/*
3040
 * SSL_get_stream_id
3041
 * -----------------
3042
 */
3043
QUIC_TAKES_LOCK
3044
uint64_t ossl_quic_get_stream_id(SSL *s)
3045
0
{
3046
0
    QCTX ctx;
3047
0
    uint64_t id;
3048
3049
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
3050
0
        return UINT64_MAX;
3051
3052
0
    id = ctx.xso->stream->id;
3053
0
    quic_unlock(ctx.qc);
3054
3055
0
    return id;
3056
0
}
3057
3058
/*
3059
 * SSL_is_stream_local
3060
 * -------------------
3061
 */
3062
QUIC_TAKES_LOCK
3063
int ossl_quic_is_stream_local(SSL *s)
3064
0
{
3065
0
    QCTX ctx;
3066
0
    int is_local;
3067
3068
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
3069
0
        return -1;
3070
3071
0
    is_local = ossl_quic_stream_is_local_init(ctx.xso->stream);
3072
0
    quic_unlock(ctx.qc);
3073
3074
0
    return is_local;
3075
0
}
3076
3077
/*
3078
 * SSL_set_default_stream_mode
3079
 * ---------------------------
3080
 */
3081
QUIC_TAKES_LOCK
3082
int ossl_quic_set_default_stream_mode(SSL *s, uint32_t mode)
3083
0
{
3084
0
    QCTX ctx;
3085
3086
0
    if (!expect_quic_conn_only(s, &ctx))
3087
0
        return 0;
3088
3089
0
    quic_lock(ctx.qc);
3090
3091
0
    if (ctx.qc->default_xso_created) {
3092
0
        quic_unlock(ctx.qc);
3093
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
3094
0
            "too late to change default stream mode");
3095
0
    }
3096
3097
0
    switch (mode) {
3098
0
    case SSL_DEFAULT_STREAM_MODE_NONE:
3099
0
    case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI:
3100
0
    case SSL_DEFAULT_STREAM_MODE_AUTO_UNI:
3101
0
        ctx.qc->default_stream_mode = mode;
3102
0
        break;
3103
0
    default:
3104
0
        quic_unlock(ctx.qc);
3105
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3106
0
            "bad default stream type");
3107
0
    }
3108
3109
0
    quic_unlock(ctx.qc);
3110
0
    return 1;
3111
0
}
3112
3113
/*
3114
 * SSL_detach_stream
3115
 * -----------------
3116
 */
3117
QUIC_TAKES_LOCK
3118
SSL *ossl_quic_detach_stream(SSL *s)
3119
0
{
3120
0
    QCTX ctx;
3121
0
    QUIC_XSO *xso = NULL;
3122
3123
0
    if (!expect_quic_conn_only(s, &ctx))
3124
0
        return NULL;
3125
3126
0
    quic_lock(ctx.qc);
3127
3128
    /* Calling this function inhibits default XSO autocreation. */
3129
    /* QC ref to any default XSO is transferred to us and to caller. */
3130
0
    qc_set_default_xso_keep_ref(ctx.qc, NULL, /*touch=*/1, &xso);
3131
3132
0
    quic_unlock(ctx.qc);
3133
3134
0
    return xso != NULL ? &xso->ssl : NULL;
3135
0
}
3136
3137
/*
3138
 * SSL_attach_stream
3139
 * -----------------
3140
 */
3141
QUIC_TAKES_LOCK
3142
int ossl_quic_attach_stream(SSL *conn, SSL *stream)
3143
0
{
3144
0
    QCTX ctx;
3145
0
    QUIC_XSO *xso;
3146
0
    int nref;
3147
3148
0
    if (!expect_quic_conn_only(conn, &ctx))
3149
0
        return 0;
3150
3151
0
    if (stream == NULL || stream->type != SSL_TYPE_QUIC_XSO)
3152
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_NULL_PARAMETER,
3153
0
            "stream to attach must be a valid QUIC stream");
3154
3155
0
    xso = (QUIC_XSO *)stream;
3156
3157
0
    quic_lock(ctx.qc);
3158
3159
0
    if (ctx.qc->default_xso != NULL) {
3160
0
        quic_unlock(ctx.qc);
3161
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
3162
0
            "connection already has a default stream");
3163
0
    }
3164
3165
    /*
3166
     * It is a caller error for the XSO being attached as a default XSO to have
3167
     * more than one ref.
3168
     */
3169
0
    if (!CRYPTO_GET_REF(&xso->ssl.references, &nref)) {
3170
0
        quic_unlock(ctx.qc);
3171
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR,
3172
0
            "ref");
3173
0
    }
3174
3175
0
    if (nref != 1) {
3176
0
        quic_unlock(ctx.qc);
3177
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3178
0
            "stream being attached must have "
3179
0
            "only 1 reference");
3180
0
    }
3181
3182
    /* Caller's reference to the XSO is transferred to us. */
3183
    /* Calling this function inhibits default XSO autocreation. */
3184
0
    qc_set_default_xso(ctx.qc, xso, /*touch=*/1);
3185
3186
0
    quic_unlock(ctx.qc);
3187
0
    return 1;
3188
0
}
3189
3190
/*
3191
 * SSL_set_incoming_stream_policy
3192
 * ------------------------------
3193
 */
3194
QUIC_NEEDS_LOCK
3195
static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION *qc)
3196
113k
{
3197
113k
    switch (qc->incoming_stream_policy) {
3198
50.4k
    case SSL_INCOMING_STREAM_POLICY_AUTO:
3199
50.4k
        if ((qc->default_xso == NULL && !qc->default_xso_created)
3200
0
            || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
3201
50.4k
            return SSL_INCOMING_STREAM_POLICY_ACCEPT;
3202
0
        else
3203
0
            return SSL_INCOMING_STREAM_POLICY_REJECT;
3204
3205
63.3k
    default:
3206
63.3k
        return qc->incoming_stream_policy;
3207
113k
    }
3208
113k
}
3209
3210
QUIC_NEEDS_LOCK
3211
static void qc_update_reject_policy(QUIC_CONNECTION *qc)
3212
113k
{
3213
113k
    int policy = qc_get_effective_incoming_stream_policy(qc);
3214
113k
    int enable_reject = (policy == SSL_INCOMING_STREAM_POLICY_REJECT);
3215
3216
113k
    ossl_quic_channel_set_incoming_stream_auto_reject(qc->ch,
3217
113k
        enable_reject,
3218
113k
        qc->incoming_stream_aec);
3219
113k
}
3220
3221
QUIC_TAKES_LOCK
3222
int ossl_quic_set_incoming_stream_policy(SSL *s, int policy,
3223
    uint64_t aec)
3224
50.4k
{
3225
50.4k
    int ret = 1;
3226
50.4k
    QCTX ctx;
3227
3228
50.4k
    if (!expect_quic_conn_only(s, &ctx))
3229
0
        return 0;
3230
3231
50.4k
    quic_lock(ctx.qc);
3232
3233
50.4k
    switch (policy) {
3234
0
    case SSL_INCOMING_STREAM_POLICY_AUTO:
3235
50.4k
    case SSL_INCOMING_STREAM_POLICY_ACCEPT:
3236
50.4k
    case SSL_INCOMING_STREAM_POLICY_REJECT:
3237
50.4k
        ctx.qc->incoming_stream_policy = policy;
3238
50.4k
        ctx.qc->incoming_stream_aec = aec;
3239
50.4k
        break;
3240
3241
0
    default:
3242
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3243
0
        ret = 0;
3244
0
        break;
3245
50.4k
    }
3246
3247
50.4k
    qc_update_reject_policy(ctx.qc);
3248
50.4k
    quic_unlock(ctx.qc);
3249
50.4k
    return ret;
3250
50.4k
}
3251
3252
/*
3253
 * SSL_get_value, SSL_set_value
3254
 * ----------------------------
3255
 */
3256
QUIC_TAKES_LOCK
3257
static int qc_getset_idle_timeout(QCTX *ctx, uint32_t class_,
3258
    uint64_t *p_value_out, uint64_t *p_value_in)
3259
0
{
3260
0
    int ret = 0;
3261
0
    uint64_t value_out = 0, value_in;
3262
3263
0
    quic_lock(ctx->qc);
3264
3265
0
    switch (class_) {
3266
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3267
0
        value_out = ossl_quic_channel_get_max_idle_timeout_request(ctx->qc->ch);
3268
3269
0
        if (p_value_in != NULL) {
3270
0
            value_in = *p_value_in;
3271
0
            if (value_in > OSSL_QUIC_VLINT_MAX) {
3272
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3273
0
                    NULL);
3274
0
                goto err;
3275
0
            }
3276
3277
0
            if (ossl_quic_channel_have_generated_transport_params(ctx->qc->ch)) {
3278
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3279
0
                    NULL);
3280
0
                goto err;
3281
0
            }
3282
3283
0
            ossl_quic_channel_set_max_idle_timeout_request(ctx->qc->ch, value_in);
3284
0
        }
3285
0
        break;
3286
3287
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3288
0
    case SSL_VALUE_CLASS_FEATURE_NEGOTIATED:
3289
0
        if (p_value_in != NULL) {
3290
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3291
0
                NULL);
3292
0
            goto err;
3293
0
        }
3294
3295
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3296
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3297
0
                NULL);
3298
0
            goto err;
3299
0
        }
3300
3301
0
        value_out = (class_ == SSL_VALUE_CLASS_FEATURE_NEGOTIATED)
3302
0
            ? ossl_quic_channel_get_max_idle_timeout_actual(ctx->qc->ch)
3303
0
            : ossl_quic_channel_get_max_idle_timeout_peer_request(ctx->qc->ch);
3304
0
        break;
3305
3306
0
    default:
3307
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3308
0
            NULL);
3309
0
        goto err;
3310
0
    }
3311
3312
0
    ret = 1;
3313
0
err:
3314
0
    quic_unlock(ctx->qc);
3315
0
    if (ret && p_value_out != NULL)
3316
0
        *p_value_out = value_out;
3317
3318
0
    return ret;
3319
0
}
3320
3321
QUIC_TAKES_LOCK
3322
static int qc_get_stream_avail(QCTX *ctx, uint32_t class_,
3323
    int is_uni, int is_remote,
3324
    uint64_t *value)
3325
0
{
3326
0
    int ret = 0;
3327
3328
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
3329
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3330
0
            NULL);
3331
0
        return 0;
3332
0
    }
3333
3334
0
    quic_lock(ctx->qc);
3335
3336
0
    *value = is_remote
3337
0
        ? ossl_quic_channel_get_remote_stream_count_avail(ctx->qc->ch, is_uni)
3338
0
        : ossl_quic_channel_get_local_stream_count_avail(ctx->qc->ch, is_uni);
3339
3340
0
    ret = 1;
3341
0
    quic_unlock(ctx->qc);
3342
0
    return ret;
3343
0
}
3344
3345
QUIC_NEEDS_LOCK
3346
static int qctx_should_autotick(QCTX *ctx)
3347
31.8M
{
3348
31.8M
    int event_handling_mode;
3349
3350
31.8M
    if (ctx->is_stream) {
3351
3.40M
        event_handling_mode = ctx->xso->event_handling_mode;
3352
3.40M
        if (event_handling_mode != SSL_VALUE_EVENT_HANDLING_MODE_INHERIT)
3353
0
            return event_handling_mode != SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT;
3354
3.40M
    }
3355
3356
31.8M
    event_handling_mode = ctx->qc->event_handling_mode;
3357
31.8M
    return event_handling_mode != SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT;
3358
31.8M
}
3359
3360
QUIC_NEEDS_LOCK
3361
static void qctx_maybe_autotick(QCTX *ctx)
3362
70.4M
{
3363
70.4M
    if (!qctx_should_autotick(ctx))
3364
0
        return;
3365
3366
70.4M
    ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx->qc->ch), 0);
3367
70.4M
}
3368
3369
QUIC_TAKES_LOCK
3370
static int qc_getset_event_handling(QCTX *ctx, uint32_t class_,
3371
    uint64_t *p_value_out,
3372
    uint64_t *p_value_in)
3373
0
{
3374
0
    int ret = 0;
3375
0
    uint64_t value_out = 0;
3376
3377
0
    quic_lock(ctx->qc);
3378
3379
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
3380
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3381
0
            NULL);
3382
0
        goto err;
3383
0
    }
3384
3385
0
    if (p_value_in != NULL) {
3386
0
        switch (*p_value_in) {
3387
0
        case SSL_VALUE_EVENT_HANDLING_MODE_INHERIT:
3388
0
        case SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT:
3389
0
        case SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT:
3390
0
            break;
3391
0
        default:
3392
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3393
0
                NULL);
3394
0
            goto err;
3395
0
        }
3396
3397
0
        value_out = *p_value_in;
3398
0
        if (ctx->is_stream)
3399
0
            ctx->xso->event_handling_mode = (int)value_out;
3400
0
        else
3401
0
            ctx->qc->event_handling_mode = (int)value_out;
3402
0
    } else {
3403
0
        value_out = ctx->is_stream
3404
0
            ? ctx->xso->event_handling_mode
3405
0
            : ctx->qc->event_handling_mode;
3406
0
    }
3407
3408
0
    ret = 1;
3409
0
err:
3410
0
    quic_unlock(ctx->qc);
3411
0
    if (ret && p_value_out != NULL)
3412
0
        *p_value_out = value_out;
3413
3414
0
    return ret;
3415
0
}
3416
3417
QUIC_TAKES_LOCK
3418
static int qc_get_stream_write_buf_stat(QCTX *ctx, uint32_t class_,
3419
    uint64_t *p_value_out,
3420
    size_t (*getter)(QUIC_SSTREAM *sstream))
3421
0
{
3422
0
    int ret = 0;
3423
0
    size_t value = 0;
3424
3425
0
    quic_lock(ctx->qc);
3426
3427
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
3428
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3429
0
            NULL);
3430
0
        goto err;
3431
0
    }
3432
3433
0
    if (ctx->xso == NULL) {
3434
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
3435
0
        goto err;
3436
0
    }
3437
3438
0
    if (!ossl_quic_stream_has_send(ctx->xso->stream)) {
3439
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_STREAM_RECV_ONLY, NULL);
3440
0
        goto err;
3441
0
    }
3442
3443
0
    if (ossl_quic_stream_has_send_buffer(ctx->xso->stream))
3444
0
        value = getter(ctx->xso->stream->sstream);
3445
3446
0
    ret = 1;
3447
0
err:
3448
0
    quic_unlock(ctx->qc);
3449
0
    *p_value_out = (uint64_t)value;
3450
0
    return ret;
3451
0
}
3452
3453
QUIC_NEEDS_LOCK
3454
static int expect_quic_for_value(SSL *s, QCTX *ctx, uint32_t id)
3455
0
{
3456
0
    switch (id) {
3457
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
3458
0
    case SSL_VALUE_STREAM_WRITE_BUF_SIZE:
3459
0
    case SSL_VALUE_STREAM_WRITE_BUF_USED:
3460
0
    case SSL_VALUE_STREAM_WRITE_BUF_AVAIL:
3461
0
        return expect_quic(s, ctx);
3462
0
    default:
3463
0
        return expect_quic_conn_only(s, ctx);
3464
0
    }
3465
0
}
3466
3467
QUIC_TAKES_LOCK
3468
int ossl_quic_get_value_uint(SSL *s, uint32_t class_, uint32_t id,
3469
    uint64_t *value)
3470
0
{
3471
0
    QCTX ctx;
3472
3473
0
    if (!expect_quic_for_value(s, &ctx, id))
3474
0
        return 0;
3475
3476
0
    if (value == NULL)
3477
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
3478
0
            ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3479
3480
0
    switch (id) {
3481
0
    case SSL_VALUE_QUIC_IDLE_TIMEOUT:
3482
0
        return qc_getset_idle_timeout(&ctx, class_, value, NULL);
3483
3484
0
    case SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL:
3485
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/0, /*remote=*/0, value);
3486
0
    case SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL:
3487
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/0, /*remote=*/1, value);
3488
0
    case SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL:
3489
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/1, /*remote=*/0, value);
3490
0
    case SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL:
3491
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/1, /*remote=*/1, value);
3492
3493
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
3494
0
        return qc_getset_event_handling(&ctx, class_, value, NULL);
3495
3496
0
    case SSL_VALUE_STREAM_WRITE_BUF_SIZE:
3497
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
3498
0
            ossl_quic_sstream_get_buffer_size);
3499
0
    case SSL_VALUE_STREAM_WRITE_BUF_USED:
3500
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
3501
0
            ossl_quic_sstream_get_buffer_used);
3502
0
    case SSL_VALUE_STREAM_WRITE_BUF_AVAIL:
3503
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
3504
0
            ossl_quic_sstream_get_buffer_avail);
3505
3506
0
    default:
3507
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
3508
0
            SSL_R_UNSUPPORTED_CONFIG_VALUE, NULL);
3509
0
    }
3510
3511
0
    return 1;
3512
0
}
3513
3514
QUIC_TAKES_LOCK
3515
int ossl_quic_set_value_uint(SSL *s, uint32_t class_, uint32_t id,
3516
    uint64_t value)
3517
0
{
3518
0
    QCTX ctx;
3519
3520
0
    if (!expect_quic_for_value(s, &ctx, id))
3521
0
        return 0;
3522
3523
0
    switch (id) {
3524
0
    case SSL_VALUE_QUIC_IDLE_TIMEOUT:
3525
0
        return qc_getset_idle_timeout(&ctx, class_, NULL, &value);
3526
3527
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
3528
0
        return qc_getset_event_handling(&ctx, class_, NULL, &value);
3529
3530
0
    default:
3531
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
3532
0
            SSL_R_UNSUPPORTED_CONFIG_VALUE, NULL);
3533
0
    }
3534
3535
0
    return 1;
3536
0
}
3537
3538
/*
3539
 * SSL_accept_stream
3540
 * -----------------
3541
 */
3542
struct wait_for_incoming_stream_args {
3543
    QCTX *ctx;
3544
    QUIC_STREAM *qs;
3545
};
3546
3547
QUIC_NEEDS_LOCK
3548
static int wait_for_incoming_stream(void *arg)
3549
0
{
3550
0
    struct wait_for_incoming_stream_args *args = arg;
3551
0
    QUIC_CONNECTION *qc = args->ctx->qc;
3552
0
    QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
3553
3554
0
    if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
3555
        /* If connection is torn down due to an error while blocking, stop. */
3556
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
3557
0
        return -1;
3558
0
    }
3559
3560
0
    args->qs = ossl_quic_stream_map_peek_accept_queue(qsm);
3561
0
    if (args->qs != NULL)
3562
0
        return 1; /* got a stream */
3563
3564
0
    return 0; /* did not get a stream, keep trying */
3565
0
}
3566
3567
QUIC_TAKES_LOCK
3568
SSL *ossl_quic_accept_stream(SSL *s, uint64_t flags)
3569
213
{
3570
213
    QCTX ctx;
3571
213
    int ret;
3572
213
    SSL *new_s = NULL;
3573
213
    QUIC_STREAM_MAP *qsm;
3574
213
    QUIC_STREAM *qs;
3575
213
    QUIC_XSO *xso;
3576
213
    OSSL_RTT_INFO rtt_info;
3577
3578
213
    if (!expect_quic_conn_only(s, &ctx))
3579
0
        return NULL;
3580
3581
213
    quic_lock(ctx.qc);
3582
3583
213
    if (qc_get_effective_incoming_stream_policy(ctx.qc)
3584
213
        == SSL_INCOMING_STREAM_POLICY_REJECT) {
3585
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
3586
0
        goto out;
3587
0
    }
3588
3589
213
    qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
3590
3591
213
    qs = ossl_quic_stream_map_peek_accept_queue(qsm);
3592
213
    if (qs == NULL) {
3593
0
        if (qc_blocking_mode(ctx.qc)
3594
0
            && (flags & SSL_ACCEPT_STREAM_NO_BLOCK) == 0) {
3595
0
            struct wait_for_incoming_stream_args args;
3596
3597
0
            args.ctx = &ctx;
3598
0
            args.qs = NULL;
3599
3600
0
            ret = block_until_pred(ctx.qc, wait_for_incoming_stream, &args, 0);
3601
0
            if (ret == 0) {
3602
0
                QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3603
0
                goto out;
3604
0
            } else if (ret < 0 || args.qs == NULL) {
3605
0
                goto out;
3606
0
            }
3607
3608
0
            qs = args.qs;
3609
0
        } else {
3610
0
            goto out;
3611
0
        }
3612
0
    }
3613
3614
213
    xso = create_xso_from_stream(ctx.qc, qs);
3615
213
    if (xso == NULL)
3616
0
        goto out;
3617
3618
213
    ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx.qc->ch), &rtt_info);
3619
213
    ossl_quic_stream_map_remove_from_accept_queue(qsm, qs,
3620
213
        rtt_info.smoothed_rtt);
3621
213
    new_s = &xso->ssl;
3622
3623
    /* Calling this function inhibits default XSO autocreation. */
3624
213
    qc_touch_default_xso(ctx.qc); /* inhibits default XSO */
3625
3626
213
out:
3627
213
    quic_unlock(ctx.qc);
3628
213
    return new_s;
3629
213
}
3630
3631
/*
3632
 * SSL_get_accept_stream_queue_len
3633
 * -------------------------------
3634
 */
3635
QUIC_TAKES_LOCK
3636
size_t ossl_quic_get_accept_stream_queue_len(SSL *s)
3637
11.6k
{
3638
11.6k
    QCTX ctx;
3639
11.6k
    size_t v;
3640
3641
11.6k
    if (!expect_quic_conn_only(s, &ctx))
3642
0
        return 0;
3643
3644
11.6k
    quic_lock(ctx.qc);
3645
3646
11.6k
    v = ossl_quic_stream_map_get_total_accept_queue_len(ossl_quic_channel_get_qsm(ctx.qc->ch));
3647
3648
11.6k
    quic_unlock(ctx.qc);
3649
11.6k
    return v;
3650
11.6k
}
3651
3652
/*
3653
 * SSL_stream_reset
3654
 * ----------------
3655
 */
3656
int ossl_quic_stream_reset(SSL *ssl,
3657
    const SSL_STREAM_RESET_ARGS *args,
3658
    size_t args_len)
3659
0
{
3660
0
    QCTX ctx;
3661
0
    QUIC_STREAM_MAP *qsm;
3662
0
    QUIC_STREAM *qs;
3663
0
    uint64_t error_code;
3664
0
    int ok, err;
3665
3666
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/0, /*io=*/0, &ctx))
3667
0
        return 0;
3668
3669
0
    qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
3670
0
    qs = ctx.xso->stream;
3671
0
    error_code = (args != NULL ? args->quic_error_code : 0);
3672
3673
0
    if (!quic_validate_for_write(ctx.xso, &err)) {
3674
0
        ok = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
3675
0
        goto err;
3676
0
    }
3677
3678
0
    ok = ossl_quic_stream_map_reset_stream_send_part(qsm, qs, error_code);
3679
0
    if (ok)
3680
0
        ctx.xso->requested_reset = 1;
3681
3682
0
err:
3683
0
    quic_unlock(ctx.qc);
3684
0
    return ok;
3685
0
}
3686
3687
/*
3688
 * SSL_get_stream_read_state
3689
 * -------------------------
3690
 */
3691
static void quic_classify_stream(QUIC_CONNECTION *qc,
3692
    QUIC_STREAM *qs,
3693
    int is_write,
3694
    int *state,
3695
    uint64_t *app_error_code)
3696
0
{
3697
0
    int local_init;
3698
0
    uint64_t final_size;
3699
3700
0
    local_init = (ossl_quic_stream_is_server_init(qs) == qc->as_server);
3701
3702
0
    if (app_error_code != NULL)
3703
0
        *app_error_code = UINT64_MAX;
3704
0
    else
3705
0
        app_error_code = &final_size; /* throw away value */
3706
3707
0
    if (!ossl_quic_stream_is_bidi(qs) && local_init != is_write) {
3708
        /*
3709
         * Unidirectional stream and this direction of transmission doesn't
3710
         * exist.
3711
         */
3712
0
        *state = SSL_STREAM_STATE_WRONG_DIR;
3713
0
    } else if (ossl_quic_channel_is_term_any(qc->ch)) {
3714
        /* Connection already closed. */
3715
0
        *state = SSL_STREAM_STATE_CONN_CLOSED;
3716
0
    } else if (!is_write && qs->recv_state == QUIC_RSTREAM_STATE_DATA_READ) {
3717
        /* Application has read a FIN. */
3718
0
        *state = SSL_STREAM_STATE_FINISHED;
3719
0
    } else if ((!is_write && qs->stop_sending)
3720
0
        || (is_write && ossl_quic_stream_send_is_reset(qs))) {
3721
        /*
3722
         * Stream has been reset locally. FIN takes precedence over this for the
3723
         * read case as the application need not care if the stream is reset
3724
         * after a FIN has been successfully processed.
3725
         */
3726
0
        *state = SSL_STREAM_STATE_RESET_LOCAL;
3727
0
        *app_error_code = !is_write
3728
0
            ? qs->stop_sending_aec
3729
0
            : qs->reset_stream_aec;
3730
0
    } else if ((!is_write && ossl_quic_stream_recv_is_reset(qs))
3731
0
        || (is_write && qs->peer_stop_sending)) {
3732
        /*
3733
         * Stream has been reset remotely. */
3734
0
        *state = SSL_STREAM_STATE_RESET_REMOTE;
3735
0
        *app_error_code = !is_write
3736
0
            ? qs->peer_reset_stream_aec
3737
0
            : qs->peer_stop_sending_aec;
3738
0
    } else if (is_write && ossl_quic_sstream_get_final_size(qs->sstream, &final_size)) {
3739
        /*
3740
         * Stream has been finished. Stream reset takes precedence over this for
3741
         * the write case as peer may not have received all data.
3742
         */
3743
0
        *state = SSL_STREAM_STATE_FINISHED;
3744
0
    } else {
3745
        /* Stream still healthy. */
3746
0
        *state = SSL_STREAM_STATE_OK;
3747
0
    }
3748
0
}
3749
3750
static int quic_get_stream_state(SSL *ssl, int is_write)
3751
0
{
3752
0
    QCTX ctx;
3753
0
    int state;
3754
3755
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3756
0
        return SSL_STREAM_STATE_NONE;
3757
3758
0
    quic_classify_stream(ctx.qc, ctx.xso->stream, is_write, &state, NULL);
3759
0
    quic_unlock(ctx.qc);
3760
0
    return state;
3761
0
}
3762
3763
int ossl_quic_get_stream_read_state(SSL *ssl)
3764
0
{
3765
0
    return quic_get_stream_state(ssl, /*is_write=*/0);
3766
0
}
3767
3768
/*
3769
 * SSL_get_stream_write_state
3770
 * --------------------------
3771
 */
3772
int ossl_quic_get_stream_write_state(SSL *ssl)
3773
0
{
3774
0
    return quic_get_stream_state(ssl, /*is_write=*/1);
3775
0
}
3776
3777
/*
3778
 * SSL_get_stream_read_error_code
3779
 * ------------------------------
3780
 */
3781
static int quic_get_stream_error_code(SSL *ssl, int is_write,
3782
    uint64_t *app_error_code)
3783
0
{
3784
0
    QCTX ctx;
3785
0
    int state;
3786
3787
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3788
0
        return -1;
3789
3790
0
    quic_classify_stream(ctx.qc, ctx.xso->stream, is_write,
3791
0
        &state, app_error_code);
3792
3793
0
    quic_unlock(ctx.qc);
3794
0
    switch (state) {
3795
0
    case SSL_STREAM_STATE_FINISHED:
3796
0
        return 0;
3797
0
    case SSL_STREAM_STATE_RESET_LOCAL:
3798
0
    case SSL_STREAM_STATE_RESET_REMOTE:
3799
0
        return 1;
3800
0
    default:
3801
0
        return -1;
3802
0
    }
3803
0
}
3804
3805
int ossl_quic_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code)
3806
0
{
3807
0
    return quic_get_stream_error_code(ssl, /*is_write=*/0, app_error_code);
3808
0
}
3809
3810
/*
3811
 * SSL_get_stream_write_error_code
3812
 * -------------------------------
3813
 */
3814
int ossl_quic_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code)
3815
0
{
3816
0
    return quic_get_stream_error_code(ssl, /*is_write=*/1, app_error_code);
3817
0
}
3818
3819
/*
3820
 * Write buffer size mutation
3821
 * --------------------------
3822
 */
3823
int ossl_quic_set_write_buffer_size(SSL *ssl, size_t size)
3824
0
{
3825
0
    int ret = 0;
3826
0
    QCTX ctx;
3827
3828
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3829
0
        return 0;
3830
3831
0
    if (!ossl_quic_stream_has_send(ctx.xso->stream)) {
3832
        /* Called on a unidirectional receive-only stream - error. */
3833
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
3834
0
        goto out;
3835
0
    }
3836
3837
0
    if (!ossl_quic_stream_has_send_buffer(ctx.xso->stream)) {
3838
        /*
3839
         * If the stream has a send part but we have disposed of it because we
3840
         * no longer need it, this is a no-op.
3841
         */
3842
0
        ret = 1;
3843
0
        goto out;
3844
0
    }
3845
3846
0
    if (!ossl_quic_sstream_set_buffer_size(ctx.xso->stream->sstream, size)) {
3847
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3848
0
        goto out;
3849
0
    }
3850
3851
0
    ret = 1;
3852
3853
0
out:
3854
0
    quic_unlock(ctx.qc);
3855
0
    return ret;
3856
0
}
3857
3858
/*
3859
 * SSL_get_conn_close_info
3860
 * -----------------------
3861
 */
3862
int ossl_quic_get_conn_close_info(SSL *ssl,
3863
    SSL_CONN_CLOSE_INFO *info,
3864
    size_t info_len)
3865
0
{
3866
0
    QCTX ctx;
3867
0
    const QUIC_TERMINATE_CAUSE *tc;
3868
3869
0
    if (!expect_quic_conn_only(ssl, &ctx))
3870
0
        return -1;
3871
3872
0
    tc = ossl_quic_channel_get_terminate_cause(ctx.qc->ch);
3873
0
    if (tc == NULL)
3874
0
        return 0;
3875
3876
0
    info->error_code = tc->error_code;
3877
0
    info->frame_type = tc->frame_type;
3878
0
    info->reason = tc->reason;
3879
0
    info->reason_len = tc->reason_len;
3880
0
    info->flags = 0;
3881
0
    if (!tc->remote)
3882
0
        info->flags |= SSL_CONN_CLOSE_FLAG_LOCAL;
3883
0
    if (!tc->app)
3884
0
        info->flags |= SSL_CONN_CLOSE_FLAG_TRANSPORT;
3885
0
    return 1;
3886
0
}
3887
3888
/*
3889
 * SSL_key_update
3890
 * --------------
3891
 */
3892
int ossl_quic_key_update(SSL *ssl, int update_type)
3893
0
{
3894
0
    QCTX ctx;
3895
3896
0
    if (!expect_quic_conn_only(ssl, &ctx))
3897
0
        return 0;
3898
3899
0
    switch (update_type) {
3900
0
    case SSL_KEY_UPDATE_NOT_REQUESTED:
3901
        /*
3902
         * QUIC signals peer key update implicily by triggering a local
3903
         * spontaneous TXKU. Silently upgrade this to SSL_KEY_UPDATE_REQUESTED.
3904
         */
3905
0
    case SSL_KEY_UPDATE_REQUESTED:
3906
0
        break;
3907
3908
0
    default:
3909
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3910
0
        return 0;
3911
0
    }
3912
3913
0
    quic_lock(ctx.qc);
3914
3915
    /* Attempt to perform a TXKU. */
3916
0
    if (!ossl_quic_channel_trigger_txku(ctx.qc->ch)) {
3917
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_TOO_MANY_KEY_UPDATES, NULL);
3918
0
        quic_unlock(ctx.qc);
3919
0
        return 0;
3920
0
    }
3921
3922
0
    quic_unlock(ctx.qc);
3923
0
    return 1;
3924
0
}
3925
3926
/*
3927
 * SSL_get_key_update_type
3928
 * -----------------------
3929
 */
3930
int ossl_quic_get_key_update_type(const SSL *s)
3931
0
{
3932
    /*
3933
     * We always handle key updates immediately so a key update is never
3934
     * pending.
3935
     */
3936
0
    return SSL_KEY_UPDATE_NONE;
3937
0
}
3938
3939
/*
3940
 * QUIC Front-End I/O API: SSL_CTX Management
3941
 * ==========================================
3942
 */
3943
3944
long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
3945
29.7k
{
3946
29.7k
    switch (cmd) {
3947
29.7k
    default:
3948
29.7k
        return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
3949
29.7k
    }
3950
29.7k
}
3951
3952
long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp)(void))
3953
0
{
3954
0
    QCTX ctx;
3955
3956
0
    if (!expect_quic_conn_only(s, &ctx))
3957
0
        return 0;
3958
3959
0
    switch (cmd) {
3960
0
    case SSL_CTRL_SET_MSG_CALLBACK:
3961
0
        ossl_quic_channel_set_msg_callback(ctx.qc->ch, (ossl_msg_cb)fp,
3962
0
            &ctx.qc->ssl);
3963
        /* This callback also needs to be set on the internal SSL object */
3964
0
        return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);
3965
0
        ;
3966
3967
0
    default:
3968
        /* Probably a TLS related ctrl. Defer to our internal SSL object */
3969
0
        return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);
3970
0
    }
3971
0
}
3972
3973
long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp)(void))
3974
0
{
3975
0
    return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
3976
0
}
3977
3978
int ossl_quic_renegotiate_check(SSL *ssl, int initok)
3979
0
{
3980
    /* We never do renegotiation. */
3981
0
    return 0;
3982
0
}
3983
3984
const SSL_CIPHER *ossl_quic_get_cipher_by_char(const unsigned char *p)
3985
0
{
3986
0
    const SSL_CIPHER *ciph = ssl3_get_cipher_by_char(p);
3987
3988
0
    if ((ciph->algorithm2 & SSL_QUIC) == 0)
3989
0
        return NULL;
3990
3991
0
    return ciph;
3992
0
}
3993
3994
/*
3995
 * These functions define the TLSv1.2 (and below) ciphers that are supported by
3996
 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
3997
 */
3998
3999
int ossl_quic_num_ciphers(void)
4000
50.6k
{
4001
50.6k
    return 0;
4002
50.6k
}
4003
4004
const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)
4005
0
{
4006
0
    return NULL;
4007
0
}
4008
4009
/*
4010
 * SSL_get_shutdown()
4011
 * ------------------
4012
 */
4013
int ossl_quic_get_shutdown(const SSL *s)
4014
0
{
4015
0
    QCTX ctx;
4016
0
    int shut = 0;
4017
4018
0
    if (!expect_quic_conn_only(s, &ctx))
4019
0
        return 0;
4020
4021
0
    if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
4022
0
        shut |= SSL_SENT_SHUTDOWN;
4023
0
        if (!ossl_quic_channel_is_closing(ctx.qc->ch))
4024
0
            shut |= SSL_RECEIVED_SHUTDOWN;
4025
0
    }
4026
4027
0
    return shut;
4028
0
}
4029
4030
/*
4031
 * QUIC Polling Support APIs
4032
 * =========================
4033
 */
4034
4035
/* Do we have the R (read) condition? */
4036
QUIC_NEEDS_LOCK
4037
static int test_poll_event_r(QUIC_XSO *xso)
4038
0
{
4039
0
    int fin = 0;
4040
0
    size_t avail = 0;
4041
4042
0
    return ossl_quic_stream_has_recv_buffer(xso->stream)
4043
0
        && ossl_quic_rstream_available(xso->stream->rstream, &avail, &fin)
4044
0
        && (avail > 0 || (fin && !xso->retired_fin));
4045
0
}
4046
4047
/* Do we have the ER (exception: read) condition? */
4048
QUIC_NEEDS_LOCK
4049
static int test_poll_event_er(QUIC_XSO *xso)
4050
0
{
4051
0
    return ossl_quic_stream_has_recv(xso->stream)
4052
0
        && ossl_quic_stream_recv_is_reset(xso->stream)
4053
0
        && !xso->retired_fin;
4054
0
}
4055
4056
/* Do we have the W (write) condition? */
4057
QUIC_NEEDS_LOCK
4058
static int test_poll_event_w(QUIC_XSO *xso)
4059
0
{
4060
0
    return !xso->conn->shutting_down
4061
0
        && ossl_quic_stream_has_send_buffer(xso->stream)
4062
0
        && ossl_quic_sstream_get_buffer_avail(xso->stream->sstream)
4063
0
        && !ossl_quic_sstream_get_final_size(xso->stream->sstream, NULL)
4064
0
        && quic_mutation_allowed(xso->conn, /*req_active=*/1);
4065
0
}
4066
4067
/* Do we have the EW (exception: write) condition? */
4068
QUIC_NEEDS_LOCK
4069
static int test_poll_event_ew(QUIC_XSO *xso)
4070
0
{
4071
0
    return ossl_quic_stream_has_send(xso->stream)
4072
0
        && xso->stream->peer_stop_sending
4073
0
        && !xso->requested_reset
4074
0
        && !xso->conn->shutting_down;
4075
0
}
4076
4077
/* Do we have the EC (exception: connection) condition? */
4078
QUIC_NEEDS_LOCK
4079
static int test_poll_event_ec(QUIC_CONNECTION *qc)
4080
0
{
4081
0
    return ossl_quic_channel_is_term_any(qc->ch);
4082
0
}
4083
4084
/* Do we have the ECD (exception: connection drained) condition? */
4085
QUIC_NEEDS_LOCK
4086
static int test_poll_event_ecd(QUIC_CONNECTION *qc)
4087
0
{
4088
0
    return ossl_quic_channel_is_terminated(qc->ch);
4089
0
}
4090
4091
/* Do we have the IS (incoming: stream) condition? */
4092
QUIC_NEEDS_LOCK
4093
static int test_poll_event_is(QUIC_CONNECTION *qc, int is_uni)
4094
0
{
4095
0
    return ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(qc->ch),
4096
0
        is_uni);
4097
0
}
4098
4099
/* Do we have the OS (outgoing: stream) condition? */
4100
QUIC_NEEDS_LOCK
4101
static int test_poll_event_os(QUIC_CONNECTION *qc, int is_uni)
4102
0
{
4103
    /* Is it currently possible for us to make an outgoing stream? */
4104
0
    return quic_mutation_allowed(qc, /*req_active=*/1)
4105
0
        && ossl_quic_channel_get_local_stream_count_avail(qc->ch, is_uni) > 0;
4106
0
}
4107
4108
QUIC_TAKES_LOCK
4109
int ossl_quic_conn_poll_events(SSL *ssl, uint64_t events, int do_tick,
4110
    uint64_t *p_revents)
4111
0
{
4112
0
    QCTX ctx;
4113
0
    uint64_t revents = 0;
4114
4115
0
    if (!expect_quic(ssl, &ctx))
4116
0
        return 0;
4117
4118
0
    quic_lock(ctx.qc);
4119
4120
0
    if (!ctx.qc->started) {
4121
        /* We can only try to write on non-started connection. */
4122
0
        if ((events & SSL_POLL_EVENT_W) != 0)
4123
0
            revents |= SSL_POLL_EVENT_W;
4124
0
        goto end;
4125
0
    }
4126
4127
0
    if (do_tick)
4128
0
        ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
4129
4130
0
    if (ctx.xso != NULL) {
4131
        /* SSL object has a stream component. */
4132
4133
0
        if ((events & SSL_POLL_EVENT_R) != 0
4134
0
            && test_poll_event_r(ctx.xso))
4135
0
            revents |= SSL_POLL_EVENT_R;
4136
4137
0
        if ((events & SSL_POLL_EVENT_ER) != 0
4138
0
            && test_poll_event_er(ctx.xso))
4139
0
            revents |= SSL_POLL_EVENT_ER;
4140
4141
0
        if ((events & SSL_POLL_EVENT_W) != 0
4142
0
            && test_poll_event_w(ctx.xso))
4143
0
            revents |= SSL_POLL_EVENT_W;
4144
4145
0
        if ((events & SSL_POLL_EVENT_EW) != 0
4146
0
            && test_poll_event_ew(ctx.xso))
4147
0
            revents |= SSL_POLL_EVENT_EW;
4148
0
    }
4149
4150
0
    if (!ctx.is_stream) {
4151
0
        if ((events & SSL_POLL_EVENT_EC) != 0
4152
0
            && test_poll_event_ec(ctx.qc))
4153
0
            revents |= SSL_POLL_EVENT_EC;
4154
4155
0
        if ((events & SSL_POLL_EVENT_ECD) != 0
4156
0
            && test_poll_event_ecd(ctx.qc))
4157
0
            revents |= SSL_POLL_EVENT_ECD;
4158
4159
0
        if ((events & SSL_POLL_EVENT_ISB) != 0
4160
0
            && test_poll_event_is(ctx.qc, /*uni=*/0))
4161
0
            revents |= SSL_POLL_EVENT_ISB;
4162
4163
0
        if ((events & SSL_POLL_EVENT_ISU) != 0
4164
0
            && test_poll_event_is(ctx.qc, /*uni=*/1))
4165
0
            revents |= SSL_POLL_EVENT_ISU;
4166
4167
0
        if ((events & SSL_POLL_EVENT_OSB) != 0
4168
0
            && test_poll_event_os(ctx.qc, /*uni=*/0))
4169
0
            revents |= SSL_POLL_EVENT_OSB;
4170
4171
0
        if ((events & SSL_POLL_EVENT_OSU) != 0
4172
0
            && test_poll_event_os(ctx.qc, /*uni=*/1))
4173
0
            revents |= SSL_POLL_EVENT_OSU;
4174
0
    }
4175
4176
0
end:
4177
0
    quic_unlock(ctx.qc);
4178
0
    *p_revents = revents;
4179
0
    return 1;
4180
0
}
4181
4182
/*
4183
 * Internal Testing APIs
4184
 * =====================
4185
 */
4186
4187
QUIC_CHANNEL *ossl_quic_conn_get_channel(SSL *s)
4188
0
{
4189
0
    QCTX ctx;
4190
4191
0
    if (!expect_quic_conn_only(s, &ctx))
4192
0
        return NULL;
4193
4194
0
    return ctx.qc->ch;
4195
0
}
4196
4197
int ossl_quic_set_diag_title(SSL_CTX *ctx, const char *title)
4198
0
{
4199
0
#ifndef OPENSSL_NO_QLOG
4200
0
    OPENSSL_free(ctx->qlog_title);
4201
0
    ctx->qlog_title = NULL;
4202
4203
0
    if (title == NULL)
4204
0
        return 1;
4205
4206
0
    if ((ctx->qlog_title = OPENSSL_strdup(title)) == NULL)
4207
0
        return 0;
4208
0
#endif
4209
4210
0
    return 1;
4211
0
}