Coverage Report

Created: 2026-05-20 07:05

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/ssl/quic/quic_impl.c
Line
Count
Source
1
/*
2
 * Copyright 2022-2026 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#include <openssl/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/hashfunc.h"
16
#include "internal/ssl_unwrap.h"
17
#include "internal/quic_tls.h"
18
#include "internal/quic_rx_depack.h"
19
#include "internal/quic_error.h"
20
#include "internal/quic_engine.h"
21
#include "internal/quic_port.h"
22
#include "internal/quic_reactor_wait_ctx.h"
23
#include "internal/time.h"
24
25
typedef struct qctx_st QCTX;
26
27
static void qc_cleanup(QUIC_CONNECTION *qc, int have_lock);
28
static void aon_write_finish(QUIC_XSO *xso);
29
static int create_channel(QUIC_CONNECTION *qc, SSL_CTX *ctx);
30
static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs);
31
static QUIC_CONNECTION *create_qc_from_incoming_conn(QUIC_LISTENER *ql, QUIC_CHANNEL *ch);
32
static int qc_try_create_default_xso_for_write(QCTX *ctx);
33
static int qc_wait_for_default_xso_for_read(QCTX *ctx, int peek);
34
static void qctx_lock(QCTX *qctx);
35
static void qctx_unlock(QCTX *qctx);
36
static void qctx_lock_for_io(QCTX *ctx);
37
static int quic_do_handshake(QCTX *ctx);
38
static void qc_update_reject_policy(QUIC_CONNECTION *qc);
39
static void qc_touch_default_xso(QUIC_CONNECTION *qc);
40
static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch);
41
static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
42
    int touch, QUIC_XSO **old_xso);
43
static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock);
44
static int quic_validate_for_write(QUIC_XSO *xso, int *err);
45
static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active);
46
static void qctx_maybe_autotick(QCTX *ctx);
47
static int qctx_should_autotick(QCTX *ctx);
48
49
/*
50
 * QCTX is a utility structure which provides information we commonly wish to
51
 * unwrap upon an API call being dispatched to us, namely:
52
 *
53
 *   - a pointer to the QUIC_CONNECTION (regardless of whether a QCSO or QSSO
54
 *     was passed);
55
 *   - a pointer to any applicable QUIC_XSO (e.g. if a QSSO was passed, or if
56
 *     a QCSO with a default stream was passed);
57
 *   - whether a QSSO was passed (xso == NULL must not be used to determine this
58
 *     because it may be non-NULL when a QCSO is passed if that QCSO has a
59
 *     default stream);
60
 *   - a pointer to a QUIC_LISTENER object, if one is relevant;
61
 *   - whether we are in "I/O context", meaning that non-normal errors can
62
 *     be reported via SSL_get_error() as well as via ERR. Functions such as
63
 *     SSL_read(), SSL_write() and SSL_do_handshake() are "I/O context"
64
 *     functions which are allowed to change the value returned by
65
 *     SSL_get_error. However, other functions (including functions which call
66
 *     SSL_do_handshake() implicitly) are not allowed to change the return value
67
 *     of SSL_get_error.
68
 */
69
struct qctx_st {
70
    QUIC_OBJ *obj;
71
    QUIC_DOMAIN *qd;
72
    QUIC_LISTENER *ql;
73
    QUIC_CONNECTION *qc;
74
    QUIC_XSO *xso;
75
    int is_stream, is_listener, is_domain, in_io;
76
};
77
78
QUIC_NEEDS_LOCK
79
static void quic_set_last_error(QCTX *ctx, int last_error)
80
0
{
81
0
    if (!ctx->in_io)
82
0
        return;
83
84
0
    if (ctx->is_stream && ctx->xso != NULL)
85
0
        ctx->xso->last_error = last_error;
86
0
    else if (!ctx->is_stream && ctx->qc != NULL)
87
0
        ctx->qc->last_error = last_error;
88
0
}
89
90
/*
91
 * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
92
 * rather than via ERR. Note that normal errors must always be raised while
93
 * holding a lock.
94
 */
95
QUIC_NEEDS_LOCK
96
static int quic_raise_normal_error(QCTX *ctx,
97
    int err)
98
0
{
99
0
    assert(ctx->in_io);
100
0
    quic_set_last_error(ctx, err);
101
102
0
    return 0;
103
0
}
104
105
/*
106
 * Raise a 'non-normal' error, meaning any error that is not reported via
107
 * SSL_get_error() and must be reported via ERR.
108
 *
109
 * qc should be provided if available. In exceptional circumstances when qc is
110
 * not known NULL may be passed. This should generally only happen when an
111
 * expect_...() function defined below fails, which generally indicates a
112
 * dispatch error or caller error.
113
 *
114
 * ctx should be NULL if the connection lock is not held.
115
 */
116
static int quic_raise_non_normal_error(QCTX *ctx,
117
    const char *file,
118
    int line,
119
    const char *func,
120
    int reason,
121
    const char *fmt,
122
    ...)
123
0
{
124
0
    va_list args;
125
126
0
    if (ctx != NULL) {
127
0
        quic_set_last_error(ctx, SSL_ERROR_SSL);
128
129
0
        if (reason == SSL_R_PROTOCOL_IS_SHUTDOWN && ctx->qc != NULL)
130
0
            ossl_quic_channel_restore_err_state(ctx->qc->ch);
131
0
    }
132
133
0
    ERR_new();
134
0
    ERR_set_debug(file, line, func);
135
136
0
    va_start(args, fmt);
137
0
    ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
138
0
    va_end(args);
139
140
0
    return 0;
141
0
}
142
143
#define QUIC_RAISE_NORMAL_ERROR(ctx, err) \
144
0
    quic_raise_normal_error((ctx), (err))
145
146
#define QUIC_RAISE_NON_NORMAL_ERROR(ctx, reason, msg) \
147
0
    quic_raise_non_normal_error((ctx),                \
148
0
        OPENSSL_FILE, OPENSSL_LINE,                   \
149
0
        OPENSSL_FUNC,                                 \
150
0
        (reason),                                     \
151
0
        (msg))
152
/*
153
 * Flags for expect_quic_as:
154
 *
155
 *   QCTX_C
156
 *      The input SSL object may be a QCSO.
157
 *
158
 *   QCTX_S
159
 *      The input SSL object may be a QSSO or a QCSO with a default stream
160
 *      attached.
161
 *
162
 *      (Note this means there is no current way to require an SSL object with a
163
 *      QUIC stream which is not a QCSO; a QCSO with a default stream attached
164
 *      is always considered to satisfy QCTX_S.)
165
 *
166
 *   QCTX_AUTO_S
167
 *      The input SSL object may be a QSSO or a QCSO with a default stream
168
 *      attached. If no default stream is currently attached to a QCSO,
169
 *      one may be auto-created if possible.
170
 *
171
 *      If QCTX_REMOTE_INIT is set, an auto-created default XSO is
172
 *      initiated by the remote party (i.e., local party reads first).
173
 *
174
 *      If it is not set, an auto-created default XSO is
175
 *      initiated by the local party (i.e., local party writes first).
176
 *
177
 *   QCTX_L
178
 *      The input SSL object may be a QLSO.
179
 *
180
 *   QCTX_LOCK
181
 *      If and only if the function returns successfully, the ctx
182
 *      is guaranteed to be locked.
183
 *
184
 *   QCTX_IO
185
 *      Begin an I/O context. If not set, begins a non-I/O context.
186
 *      This determines whether SSL_get_error() is updated; the value it returns
187
 *      is modified only by an I/O call.
188
 *
189
 *   QCTX_NO_ERROR
190
 *      Don't raise an error if the object type is wrong. Should not be used in
191
 *      conjunction with any flags that may raise errors not related to a wrong
192
 *      object type.
193
 */
194
0
#define QCTX_C (1U << 0)
195
0
#define QCTX_S (1U << 1)
196
0
#define QCTX_L (1U << 2)
197
0
#define QCTX_AUTO_S (1U << 3)
198
0
#define QCTX_REMOTE_INIT (1U << 4)
199
0
#define QCTX_LOCK (1U << 5)
200
0
#define QCTX_IO (1U << 6)
201
0
#define QCTX_D (1U << 7)
202
0
#define QCTX_NO_ERROR (1U << 8)
203
204
/*
205
 * Called when expect_quic failed. Used to diagnose why such a call failed and
206
 * raise a reasonable error code based on the configured preconditions in flags.
207
 */
208
static int wrong_type(const SSL *s, uint32_t flags)
209
0
{
210
0
    const uint32_t mask = QCTX_C | QCTX_S | QCTX_L | QCTX_D;
211
0
    int code = ERR_R_UNSUPPORTED;
212
213
0
    if ((flags & QCTX_NO_ERROR) != 0)
214
0
        return 1;
215
0
    else if ((flags & mask) == QCTX_D)
216
0
        code = SSL_R_DOMAIN_USE_ONLY;
217
0
    else if ((flags & mask) == QCTX_L)
218
0
        code = SSL_R_LISTENER_USE_ONLY;
219
0
    else if ((flags & mask) == QCTX_C)
220
0
        code = SSL_R_CONN_USE_ONLY;
221
0
    else if ((flags & mask) == QCTX_S
222
0
        || (flags & mask) == (QCTX_C | QCTX_S))
223
0
        code = SSL_R_NO_STREAM;
224
225
0
    return QUIC_RAISE_NON_NORMAL_ERROR(NULL, code, NULL);
226
0
}
227
228
/*
229
 * Given a QDSO, QCSO, QSSO or QLSO, initialises a QCTX, determining the
230
 * contextually applicable QUIC_LISTENER, QUIC_CONNECTION and QUIC_XSO
231
 * pointers.
232
 *
233
 * After this returns 1, all fields of the passed QCTX are initialised.
234
 * Returns 0 on failure. This function is intended to be used to provide API
235
 * semantics and as such, it invokes QUIC_RAISE_NON_NORMAL_ERROR() on failure
236
 * unless the QCTX_NO_ERROR flag is set.
237
 *
238
 * The flags argument controls the preconditions and postconditions of this
239
 * function. See above for the different flags.
240
 *
241
 * The fields of a QCTX are initialised as follows depending on the identity of
242
 * the SSL object, and assuming the preconditions demanded by the flags field as
243
 * described above are met:
244
 *
245
 *                  QDSO        QLSO        QCSO        QSSO
246
 *   qd             non-NULL    maybe       maybe       maybe
247
 *   ql             NULL        non-NULL    maybe       maybe
248
 *   qc             NULL        NULL        non-NULL    non-NULL
249
 *   xso            NULL        NULL        maybe       non-NULL
250
 *   is_stream      0           0           0           1
251
 *   is_listener    0           1           0           0
252
 *   is_domain      1           0           0           0
253
 *
254
 */
255
static int expect_quic_as(const SSL *s, QCTX *ctx, uint32_t flags)
256
0
{
257
0
    int ok = 0, locked = 0, lock_requested = ((flags & QCTX_LOCK) != 0);
258
0
    QUIC_DOMAIN *qd;
259
0
    QUIC_LISTENER *ql;
260
0
    QUIC_CONNECTION *qc;
261
0
    QUIC_XSO *xso;
262
263
0
    if ((flags & QCTX_AUTO_S) != 0)
264
0
        flags |= QCTX_S;
265
266
0
    ctx->obj = NULL;
267
0
    ctx->qd = NULL;
268
0
    ctx->ql = NULL;
269
0
    ctx->qc = NULL;
270
0
    ctx->xso = NULL;
271
0
    ctx->is_stream = 0;
272
0
    ctx->is_listener = 0;
273
0
    ctx->is_domain = 0;
274
0
    ctx->in_io = ((flags & QCTX_IO) != 0);
275
276
0
    if (s == NULL) {
277
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_PASSED_NULL_PARAMETER, NULL);
278
0
        goto err;
279
0
    }
280
281
0
    switch (s->type) {
282
0
    case SSL_TYPE_QUIC_DOMAIN:
283
0
        if ((flags & QCTX_D) == 0) {
284
0
            wrong_type(s, flags);
285
0
            goto err;
286
0
        }
287
288
0
        qd = (QUIC_DOMAIN *)s;
289
0
        ctx->obj = &qd->obj;
290
0
        ctx->qd = qd;
291
0
        ctx->is_domain = 1;
292
0
        break;
293
294
0
    case SSL_TYPE_QUIC_LISTENER:
295
0
        if ((flags & QCTX_L) == 0) {
296
0
            wrong_type(s, flags);
297
0
            goto err;
298
0
        }
299
300
0
        ql = (QUIC_LISTENER *)s;
301
0
        ctx->obj = &ql->obj;
302
0
        ctx->qd = ql->domain;
303
0
        ctx->ql = ql;
304
0
        ctx->is_listener = 1;
305
0
        break;
306
307
0
    case SSL_TYPE_QUIC_CONNECTION:
308
0
        qc = (QUIC_CONNECTION *)s;
309
0
        ctx->obj = &qc->obj;
310
0
        ctx->qd = qc->domain;
311
0
        ctx->ql = qc->listener; /* never changes, so can be read without lock */
312
0
        ctx->qc = qc;
313
314
0
        if ((flags & QCTX_AUTO_S) != 0) {
315
0
            if ((flags & QCTX_IO) != 0)
316
0
                qctx_lock_for_io(ctx);
317
0
            else
318
0
                qctx_lock(ctx);
319
320
0
            locked = 1;
321
0
        }
322
323
0
        if ((flags & QCTX_AUTO_S) != 0 && qc->default_xso == NULL) {
324
0
            if (!quic_mutation_allowed(qc, /*req_active=*/0)) {
325
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
326
0
                goto err;
327
0
            }
328
329
            /* If we haven't finished the handshake, try to advance it. */
330
0
            if (quic_do_handshake(ctx) < 1)
331
                /* ossl_quic_do_handshake raised error here */
332
0
                goto err;
333
334
0
            if ((flags & QCTX_REMOTE_INIT) != 0) {
335
0
                if (!qc_wait_for_default_xso_for_read(ctx, /*peek=*/0))
336
0
                    goto err;
337
0
            } else {
338
0
                if (!qc_try_create_default_xso_for_write(ctx))
339
0
                    goto err;
340
0
            }
341
0
        }
342
343
0
        if ((flags & QCTX_C) == 0
344
0
            && (qc->default_xso == NULL || (flags & QCTX_S) == 0)) {
345
0
            wrong_type(s, flags);
346
0
            goto err;
347
0
        }
348
349
0
        ctx->xso = qc->default_xso;
350
0
        break;
351
352
0
    case SSL_TYPE_QUIC_XSO:
353
0
        if ((flags & QCTX_S) == 0) {
354
0
            wrong_type(s, flags);
355
0
            goto err;
356
0
        }
357
358
0
        xso = (QUIC_XSO *)s;
359
0
        ctx->obj = &xso->obj;
360
0
        ctx->qd = xso->conn->domain;
361
0
        ctx->ql = xso->conn->listener;
362
0
        ctx->qc = xso->conn;
363
0
        ctx->xso = xso;
364
0
        ctx->is_stream = 1;
365
0
        break;
366
367
0
    default:
368
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
369
0
        goto err;
370
0
    }
371
372
0
    if (lock_requested && !locked) {
373
0
        if ((flags & QCTX_IO) != 0)
374
0
            qctx_lock_for_io(ctx);
375
0
        else
376
0
            qctx_lock(ctx);
377
378
0
        locked = 1;
379
0
    }
380
381
0
    ok = 1;
382
0
err:
383
0
    if (locked && (!ok || !lock_requested))
384
0
        qctx_unlock(ctx);
385
386
0
    return ok;
387
0
}
388
389
static int is_quic_c(const SSL *s, QCTX *ctx, int raiseerrs)
390
0
{
391
0
    uint32_t flags = QCTX_C;
392
393
0
    if (!raiseerrs)
394
0
        flags |= QCTX_NO_ERROR;
395
0
    return expect_quic_as(s, ctx, flags);
396
0
}
397
398
/* Same as expect_quic_cs except that errors are not raised if raiseerrs == 0 */
399
static int is_quic_cs(const SSL *s, QCTX *ctx, int raiseerrs)
400
0
{
401
0
    uint32_t flags = QCTX_C | QCTX_S;
402
403
0
    if (!raiseerrs)
404
0
        flags |= QCTX_NO_ERROR;
405
0
    return expect_quic_as(s, ctx, flags);
406
0
}
407
408
static int expect_quic_cs(const SSL *s, QCTX *ctx)
409
0
{
410
0
    return expect_quic_as(s, ctx, QCTX_C | QCTX_S);
411
0
}
412
413
static int expect_quic_c(const SSL *s, QCTX *ctx)
414
0
{
415
0
    return expect_quic_as(s, ctx, QCTX_C);
416
0
}
417
418
static int expect_quic_cl(const SSL *s, QCTX *ctx)
419
0
{
420
0
    return expect_quic_as(s, ctx, QCTX_C | QCTX_L);
421
0
}
422
423
static int expect_quic_csl(const SSL *s, QCTX *ctx)
424
0
{
425
0
    return expect_quic_as(s, ctx, QCTX_C | QCTX_S | QCTX_L);
426
0
}
427
428
static int expect_quic_csld(const SSL *s, QCTX *ctx)
429
0
{
430
0
    return expect_quic_as(s, ctx, QCTX_C | QCTX_S | QCTX_L | QCTX_D);
431
0
}
432
433
0
#define expect_quic_any expect_quic_csld
434
435
static int expect_quic_listener(const SSL *s, QCTX *ctx)
436
0
{
437
0
    return expect_quic_as(s, ctx, QCTX_L);
438
0
}
439
440
static int expect_quic_domain(const SSL *s, QCTX *ctx)
441
0
{
442
0
    return expect_quic_as(s, ctx, QCTX_D);
443
0
}
444
445
/*
446
 * Like expect_quic_cs(), but requires a QUIC_XSO be contextually available. In
447
 * other words, requires that the passed QSO be a QSSO or a QCSO with a default
448
 * stream.
449
 *
450
 * remote_init determines if we expect the default XSO to be remotely created or
451
 * not. If it is -1, do not instantiate a default XSO if one does not yet exist.
452
 *
453
 * Channel mutex is acquired and retained on success.
454
 */
455
QUIC_ACQUIRES_LOCK
456
static int ossl_unused expect_quic_with_stream_lock(const SSL *s, int remote_init,
457
    int in_io, QCTX *ctx)
458
0
{
459
0
    uint32_t flags = QCTX_S | QCTX_LOCK;
460
461
0
    if (remote_init >= 0)
462
0
        flags |= QCTX_AUTO_S;
463
464
0
    if (remote_init > 0)
465
0
        flags |= QCTX_REMOTE_INIT;
466
467
0
    if (in_io)
468
0
        flags |= QCTX_IO;
469
470
0
    return expect_quic_as(s, ctx, flags);
471
0
}
472
473
/*
474
 * Like expect_quic_cs(), but fails if called on a QUIC_XSO. ctx->xso may still
475
 * be non-NULL if the QCSO has a default stream.
476
 */
477
static int ossl_unused expect_quic_conn_only(const SSL *s, QCTX *ctx)
478
0
{
479
0
    return expect_quic_as(s, ctx, QCTX_C);
480
0
}
481
482
/*
483
 * Ensures that the domain mutex is held for a method which touches channel
484
 * state.
485
 *
486
 * Precondition: Domain mutex is not held (unchecked)
487
 */
488
static void qctx_lock(QCTX *ctx)
489
0
{
490
0
#if defined(OPENSSL_THREADS)
491
0
    assert(ctx->obj != NULL);
492
0
    ossl_crypto_mutex_lock(ossl_quic_obj_get0_mutex(ctx->obj));
493
0
#endif
494
0
}
495
496
/* Precondition: Channel mutex is held (unchecked) */
497
QUIC_NEEDS_LOCK
498
static void qctx_unlock(QCTX *ctx)
499
0
{
500
0
#if defined(OPENSSL_THREADS)
501
0
    assert(ctx->obj != NULL);
502
0
    ossl_crypto_mutex_unlock(ossl_quic_obj_get0_mutex(ctx->obj));
503
0
#endif
504
0
}
505
506
static void qctx_lock_for_io(QCTX *ctx)
507
0
{
508
0
    qctx_lock(ctx);
509
0
    ctx->in_io = 1;
510
511
    /*
512
     * We are entering an I/O function so we must update the values returned by
513
     * SSL_get_error and SSL_want. Set no error. This will be overridden later
514
     * if a call to QUIC_RAISE_NORMAL_ERROR or QUIC_RAISE_NON_NORMAL_ERROR
515
     * occurs during the API call.
516
     */
517
0
    quic_set_last_error(ctx, SSL_ERROR_NONE);
518
0
}
519
520
/*
521
 * This predicate is the criterion which should determine API call rejection for
522
 * *most* mutating API calls, particularly stream-related operations for send
523
 * parts.
524
 *
525
 * A call is rejected (this function returns 0) if shutdown is in progress
526
 * (stream flushing), or we are in a TERMINATING or TERMINATED state. If
527
 * req_active=1, the connection must be active (i.e., the IDLE state is also
528
 * rejected).
529
 */
530
static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active)
531
0
{
532
0
    if (qc->shutting_down || ossl_quic_channel_is_term_any(qc->ch))
533
0
        return 0;
534
535
0
    if (req_active && !ossl_quic_channel_is_active(qc->ch))
536
0
        return 0;
537
538
0
    return 1;
539
0
}
540
541
static int qctx_is_top_level(QCTX *ctx)
542
0
{
543
0
    return ctx->obj->parent_obj == NULL;
544
0
}
545
546
static int qctx_blocking(QCTX *ctx)
547
0
{
548
0
    return ossl_quic_obj_blocking(ctx->obj);
549
0
}
550
551
/*
552
 * Block until a predicate is met.
553
 *
554
 * Precondition: Must have a channel.
555
 * Precondition: Must hold channel lock (unchecked).
556
 */
557
QUIC_NEEDS_LOCK
558
static int block_until_pred(QCTX *ctx,
559
    int (*pred)(void *arg), void *pred_arg,
560
    uint32_t flags)
561
0
{
562
0
    QUIC_ENGINE *qeng;
563
0
    QUIC_REACTOR *rtor;
564
565
0
    qeng = ossl_quic_obj_get0_engine(ctx->obj);
566
0
    assert(qeng != NULL);
567
568
    /*
569
     * Any attempt to block auto-disables tick inhibition as otherwise we will
570
     * hang around forever.
571
     */
572
0
    ossl_quic_engine_set_inhibit_tick(qeng, 0);
573
574
0
    rtor = ossl_quic_engine_get0_reactor(qeng);
575
0
    return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags);
576
0
}
577
578
/*
579
 * QUIC Front-End I/O API: Initialization
580
 * ======================================
581
 *
582
 *         SSL_new                  => ossl_quic_new
583
 *                                     ossl_quic_init
584
 *         SSL_reset                => ossl_quic_reset
585
 *         SSL_clear                => ossl_quic_clear
586
 *                                     ossl_quic_deinit
587
 *         SSL_free                 => ossl_quic_free
588
 *
589
 *         SSL_set_options          => ossl_quic_set_options
590
 *         SSL_get_options          => ossl_quic_get_options
591
 *         SSL_clear_options        => ossl_quic_clear_options
592
 *
593
 */
594
595
/* SSL_new */
596
SSL *ossl_quic_new(SSL_CTX *ctx)
597
0
{
598
0
    QUIC_CONNECTION *qc = NULL;
599
0
    SSL_CONNECTION *sc = NULL;
600
601
    /*
602
     * QUIC_server_method should not be used with SSL_new.
603
     * It should only be used with SSL_new_listener.
604
     */
605
0
    if (ctx->method == OSSL_QUIC_server_method()) {
606
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
607
0
        return NULL;
608
0
    }
609
610
0
    qc = OPENSSL_zalloc(sizeof(*qc));
611
0
    if (qc == NULL) {
612
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
613
0
        return NULL;
614
0
    }
615
616
    /* Create the QUIC domain mutex. */
617
0
#if defined(OPENSSL_THREADS)
618
0
    if ((qc->mutex = ossl_crypto_mutex_new()) == NULL) {
619
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
620
0
        goto err;
621
0
    }
622
0
#endif
623
624
    /* Create the handshake layer. */
625
0
    qc->tls = ossl_ssl_connection_new_int(ctx, &qc->obj.ssl, TLS_method());
626
0
    if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL) {
627
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
628
0
        goto err;
629
0
    }
630
631
    /* override the user_ssl of the inner connection */
632
0
    sc->s3.flags |= TLS1_FLAGS_QUIC | TLS1_FLAGS_QUIC_INTERNAL;
633
634
    /* Restrict options derived from the SSL_CTX. */
635
0
    sc->options &= OSSL_QUIC_PERMITTED_OPTIONS_CONN;
636
0
    sc->pha_enabled = 0;
637
638
    /* Determine mode of operation. */
639
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
640
0
    qc->is_thread_assisted
641
0
        = ((ctx->domain_flags & SSL_DOMAIN_FLAG_THREAD_ASSISTED) != 0);
642
0
#endif
643
644
0
    qc->as_server = 0;
645
0
    qc->as_server_state = qc->as_server;
646
647
0
    if (!create_channel(qc, ctx))
648
0
        goto err;
649
650
0
    ossl_quic_channel_set_msg_callback(qc->ch, ctx->msg_callback, &qc->obj.ssl);
651
0
    ossl_quic_channel_set_msg_callback_arg(qc->ch, ctx->msg_callback_arg);
652
653
    /* Initialise the QUIC_CONNECTION's QUIC_OBJ base. */
654
0
    if (!ossl_quic_obj_init(&qc->obj, ctx, SSL_TYPE_QUIC_CONNECTION, NULL,
655
0
            qc->engine, qc->port)) {
656
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
657
0
        goto err;
658
0
    }
659
660
    /* Initialise libssl APL-related state. */
661
0
    qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
662
0
    qc->default_ssl_mode = qc->obj.ssl.ctx->mode;
663
0
    qc->default_ssl_options = qc->obj.ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
664
0
    qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
665
0
    qc->last_error = SSL_ERROR_NONE;
666
667
0
    qc_update_reject_policy(qc);
668
669
    /*
670
     * We do not create the default XSO yet. The reason for this is that the
671
     * stream ID of the default XSO will depend on whether the stream is client
672
     * or server-initiated, which depends on who transmits first. Since we do
673
     * not know whether the application will be using a client-transmits-first
674
     * or server-transmits-first protocol, we defer default XSO creation until
675
     * the client calls SSL_read() or SSL_write(). If it calls SSL_read() first,
676
     * we take that as a cue that the client is expecting a server-initiated
677
     * stream, and vice versa if SSL_write() is called first.
678
     */
679
0
    return &qc->obj.ssl;
680
681
0
err:
682
0
    if (qc != NULL) {
683
0
        qc_cleanup(qc, /*have_lock=*/0);
684
0
        OPENSSL_free(qc);
685
0
    }
686
0
    return NULL;
687
0
}
688
689
QUIC_NEEDS_LOCK
690
static void quic_unref_port_bios(QUIC_PORT *port)
691
0
{
692
0
    BIO *b;
693
694
0
    if (port == NULL)
695
0
        return;
696
697
0
    b = ossl_quic_port_get_net_rbio(port);
698
0
    BIO_free_all(b);
699
700
0
    b = ossl_quic_port_get_net_wbio(port);
701
0
    BIO_free_all(b);
702
0
}
703
704
QUIC_NEEDS_LOCK
705
static void qc_cleanup(QUIC_CONNECTION *qc, int have_lock)
706
0
{
707
0
    SSL_free(qc->tls);
708
0
    qc->tls = NULL;
709
710
0
    ossl_quic_channel_free(qc->ch);
711
0
    qc->ch = NULL;
712
713
0
    if (qc->port != NULL && qc->listener == NULL && qc->pending == 0) { /* TODO */
714
0
        quic_unref_port_bios(qc->port);
715
0
        ossl_quic_port_free(qc->port);
716
0
        qc->port = NULL;
717
718
0
        ossl_quic_engine_free(qc->engine);
719
0
        qc->engine = NULL;
720
0
    }
721
722
0
#if defined(OPENSSL_THREADS)
723
0
    if (have_lock)
724
        /* tsan doesn't like freeing locked mutexes */
725
0
        ossl_crypto_mutex_unlock(qc->mutex);
726
727
0
    if (qc->listener == NULL && qc->pending == 0)
728
0
        ossl_crypto_mutex_free(&qc->mutex);
729
0
#endif
730
0
}
731
732
/* SSL_free */
733
QUIC_TAKES_LOCK
734
static void quic_free_listener(QCTX *ctx)
735
0
{
736
0
    quic_unref_port_bios(ctx->ql->port);
737
0
    ossl_quic_port_drop_incoming(ctx->ql->port);
738
0
    ossl_quic_port_free(ctx->ql->port);
739
740
0
    if (ctx->ql->domain == NULL) {
741
0
        ossl_quic_engine_free(ctx->ql->engine);
742
0
#if defined(OPENSSL_THREADS)
743
0
        ossl_crypto_mutex_free(&ctx->ql->mutex);
744
0
#endif
745
0
    } else {
746
0
        SSL_free(&ctx->ql->domain->obj.ssl);
747
0
    }
748
0
}
749
750
/* SSL_free */
751
QUIC_TAKES_LOCK
752
static void quic_free_domain(QCTX *ctx)
753
0
{
754
0
    ossl_quic_engine_free(ctx->qd->engine);
755
0
#if defined(OPENSSL_THREADS)
756
0
    ossl_crypto_mutex_free(&ctx->qd->mutex);
757
0
#endif
758
0
}
759
760
QUIC_TAKES_LOCK
761
void ossl_quic_free(SSL *s)
762
0
{
763
0
    QCTX ctx;
764
0
    int is_default;
765
766
    /* We should never be called on anything but a QSO. */
767
0
    if (!expect_quic_any(s, &ctx))
768
0
        return;
769
770
0
    if (ctx.is_domain) {
771
0
        quic_free_domain(&ctx);
772
0
        return;
773
0
    }
774
775
0
    if (ctx.is_listener) {
776
0
        quic_free_listener(&ctx);
777
0
        return;
778
0
    }
779
780
0
    qctx_lock(&ctx);
781
782
0
    if (ctx.is_stream) {
783
        /*
784
         * When a QSSO is freed, the XSO is freed immediately, because the XSO
785
         * itself only contains API personality layer data. However the
786
         * underlying QUIC_STREAM is not freed immediately but is instead marked
787
         * as deleted for later collection.
788
         */
789
790
0
        assert(ctx.qc->num_xso > 0);
791
0
        --ctx.qc->num_xso;
792
793
        /* If a stream's send part has not been finished, auto-reset it. */
794
0
        if ((ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_READY
795
0
                || ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_SEND)
796
0
            && !ossl_quic_sstream_get_final_size(ctx.xso->stream->sstream, NULL))
797
0
            ossl_quic_stream_map_reset_stream_send_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
798
0
                ctx.xso->stream, 0);
799
800
        /* Do STOP_SENDING for the receive part, if applicable. */
801
0
        if (ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_RECV
802
0
            || ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_SIZE_KNOWN)
803
0
            ossl_quic_stream_map_stop_sending_recv_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
804
0
                ctx.xso->stream, 0);
805
806
        /* Update stream state. */
807
0
        ctx.xso->stream->deleted = 1;
808
0
        ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(ctx.qc->ch),
809
0
            ctx.xso->stream);
810
811
0
        is_default = (ctx.xso == ctx.qc->default_xso);
812
0
        qctx_unlock(&ctx);
813
814
        /*
815
         * Unref the connection in most cases; the XSO has a ref to the QC and
816
         * not vice versa. But for a default XSO, to avoid circular references,
817
         * the QC refs the XSO but the XSO does not ref the QC. If we are the
818
         * default XSO, we only get here when the QC is being torn down anyway,
819
         * so don't call SSL_free(qc) as we are already in it.
820
         */
821
0
        if (!is_default)
822
0
            SSL_free(&ctx.qc->obj.ssl);
823
824
        /* Note: SSL_free calls OPENSSL_free(xso) for us */
825
0
        return;
826
0
    }
827
828
    /*
829
     * Free the default XSO, if any. The QUIC_STREAM is not deleted at this
830
     * stage, but is freed during the channel free when the whole QSM is freed.
831
     */
832
0
    if (ctx.qc->default_xso != NULL) {
833
0
        QUIC_XSO *xso = ctx.qc->default_xso;
834
835
0
        qctx_unlock(&ctx);
836
0
        SSL_free(&xso->obj.ssl);
837
0
        qctx_lock(&ctx);
838
0
        ctx.qc->default_xso = NULL;
839
0
    }
840
841
    /* Ensure we have no remaining XSOs. */
842
0
    assert(ctx.qc->num_xso == 0);
843
844
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
845
0
    if (ctx.qc->is_thread_assisted && ctx.qc->started) {
846
0
        ossl_quic_thread_assist_wait_stopped(&ctx.qc->thread_assist);
847
0
        ossl_quic_thread_assist_cleanup(&ctx.qc->thread_assist);
848
0
    }
849
0
#endif
850
851
    /*
852
     * Note: SSL_free (that called this function) calls OPENSSL_free(ctx.qc) for
853
     * us
854
     */
855
0
    qc_cleanup(ctx.qc, /*have_lock=*/1);
856
    /* Note: SSL_free calls OPENSSL_free(qc) for us */
857
858
0
    if (ctx.qc->listener != NULL)
859
0
        SSL_free(&ctx.qc->listener->obj.ssl);
860
0
    if (ctx.qc->domain != NULL)
861
0
        SSL_free(&ctx.qc->domain->obj.ssl);
862
0
}
863
864
/* SSL method init */
865
int ossl_quic_init(SSL *s)
866
0
{
867
    /* Same op as SSL_clear, forward the call. */
868
0
    return ossl_quic_clear(s);
869
0
}
870
871
/* SSL method deinit */
872
void ossl_quic_deinit(SSL *s)
873
0
{
874
    /* No-op. */
875
0
}
876
877
/* SSL_clear (ssl_reset method) */
878
int ossl_quic_reset(SSL *s)
879
0
{
880
0
    QCTX ctx;
881
882
0
    if (!expect_quic_any(s, &ctx))
883
0
        return 0;
884
885
0
    ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
886
0
    return 0;
887
0
}
888
889
/* ssl_clear method (unused) */
890
int ossl_quic_clear(SSL *s)
891
0
{
892
0
    QCTX ctx;
893
894
0
    if (!expect_quic_any(s, &ctx))
895
0
        return 0;
896
897
0
    ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
898
0
    return 0;
899
0
}
900
901
int ossl_quic_set_override_now_cb(SSL *s,
902
    OSSL_TIME (*now_cb)(void *arg),
903
    void *now_cb_arg)
904
0
{
905
0
    QCTX ctx;
906
907
0
    if (!expect_quic_any(s, &ctx))
908
0
        return 0;
909
910
0
    qctx_lock(&ctx);
911
912
0
    ossl_quic_engine_set_time_cb(ctx.obj->engine, now_cb, now_cb_arg);
913
914
0
    qctx_unlock(&ctx);
915
0
    return 1;
916
0
}
917
918
void ossl_quic_conn_force_assist_thread_wake(SSL *s)
919
0
{
920
0
    QCTX ctx;
921
922
0
    if (!expect_quic_conn_only(s, &ctx))
923
0
        return;
924
925
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
926
0
    if (ctx.qc->is_thread_assisted && ctx.qc->started)
927
0
        ossl_quic_thread_assist_notify_deadline_changed(&ctx.qc->thread_assist);
928
0
#endif
929
0
}
930
931
QUIC_NEEDS_LOCK
932
static void qc_touch_default_xso(QUIC_CONNECTION *qc)
933
0
{
934
0
    qc->default_xso_created = 1;
935
0
    qc_update_reject_policy(qc);
936
0
}
937
938
/*
939
 * Changes default XSO. Allows caller to keep reference to the old default XSO
940
 * (if any). Reference to new XSO is transferred from caller.
941
 */
942
QUIC_NEEDS_LOCK
943
static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
944
    int touch,
945
    QUIC_XSO **old_xso)
946
0
{
947
0
    int refs;
948
949
0
    *old_xso = NULL;
950
951
0
    if (qc->default_xso != xso) {
952
0
        *old_xso = qc->default_xso; /* transfer old XSO ref to caller */
953
954
0
        qc->default_xso = xso;
955
956
0
        if (xso == NULL) {
957
            /*
958
             * Changing to not having a default XSO. XSO becomes standalone and
959
             * now has a ref to the QC.
960
             */
961
0
            if (!ossl_assert(SSL_up_ref(&qc->obj.ssl)))
962
0
                return;
963
0
        } else {
964
            /*
965
             * Changing from not having a default XSO to having one. The new XSO
966
             * will have had a reference to the QC we need to drop to avoid a
967
             * circular reference.
968
             *
969
             * Currently we never change directly from one default XSO to
970
             * another, though this function would also still be correct if this
971
             * weren't the case.
972
             */
973
0
            assert(*old_xso == NULL);
974
975
0
            CRYPTO_DOWN_REF(&qc->obj.ssl.references, &refs);
976
0
            assert(refs > 0);
977
0
        }
978
0
    }
979
980
0
    if (touch)
981
0
        qc_touch_default_xso(qc);
982
0
}
983
984
/*
985
 * Changes default XSO, releasing the reference to any previous default XSO.
986
 * Reference to new XSO is transferred from caller.
987
 */
988
QUIC_NEEDS_LOCK
989
static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch)
990
0
{
991
0
    QUIC_XSO *old_xso = NULL;
992
993
0
    qc_set_default_xso_keep_ref(qc, xso, touch, &old_xso);
994
995
0
    if (old_xso != NULL)
996
0
        SSL_free(&old_xso->obj.ssl);
997
0
}
998
999
QUIC_NEEDS_LOCK
1000
static void xso_update_options(QUIC_XSO *xso)
1001
0
{
1002
0
    int cleanse = ((xso->ssl_options & SSL_OP_CLEANSE_PLAINTEXT) != 0);
1003
1004
0
    if (xso->stream->rstream != NULL)
1005
0
        ossl_quic_rstream_set_cleanse(xso->stream->rstream, cleanse);
1006
1007
0
    if (xso->stream->sstream != NULL)
1008
0
        ossl_quic_sstream_set_cleanse(xso->stream->sstream, cleanse);
1009
0
}
1010
1011
/*
1012
 * SSL_set_options
1013
 * ---------------
1014
 *
1015
 * Setting options on a QCSO
1016
 *   - configures the handshake-layer options;
1017
 *   - configures the default data-plane options for new streams;
1018
 *   - configures the data-plane options on the default XSO, if there is one.
1019
 *
1020
 * Setting options on a QSSO
1021
 *   - configures data-plane options for that stream only.
1022
 */
1023
QUIC_TAKES_LOCK
1024
static uint64_t quic_mask_or_options(SSL *ssl, uint64_t mask_value, uint64_t or_value)
1025
0
{
1026
0
    QCTX ctx;
1027
0
    uint64_t hs_mask_value, hs_or_value, ret;
1028
1029
0
    if (!expect_quic_cs(ssl, &ctx))
1030
0
        return 0;
1031
1032
0
    qctx_lock(&ctx);
1033
1034
0
    if (!ctx.is_stream) {
1035
        /*
1036
         * If we were called on the connection, we apply any handshake option
1037
         * changes.
1038
         */
1039
0
        hs_mask_value = (mask_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
1040
0
        hs_or_value = (or_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
1041
1042
0
        SSL_clear_options(ctx.qc->tls, hs_mask_value);
1043
0
        SSL_set_options(ctx.qc->tls, hs_or_value);
1044
1045
        /* Update defaults for new streams. */
1046
0
        ctx.qc->default_ssl_options
1047
0
            = ((ctx.qc->default_ssl_options & ~mask_value) | or_value)
1048
0
            & OSSL_QUIC_PERMITTED_OPTIONS;
1049
0
    }
1050
1051
0
    ret = ctx.qc->default_ssl_options;
1052
0
    if (ctx.xso != NULL) {
1053
0
        ctx.xso->ssl_options
1054
0
            = ((ctx.xso->ssl_options & ~mask_value) | or_value)
1055
0
            & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
1056
1057
0
        xso_update_options(ctx.xso);
1058
1059
0
        if (ctx.is_stream)
1060
0
            ret = ctx.xso->ssl_options;
1061
0
    }
1062
1063
0
    qctx_unlock(&ctx);
1064
0
    return ret;
1065
0
}
1066
1067
uint64_t ossl_quic_set_options(SSL *ssl, uint64_t options)
1068
0
{
1069
0
    return quic_mask_or_options(ssl, 0, options);
1070
0
}
1071
1072
/* SSL_clear_options */
1073
uint64_t ossl_quic_clear_options(SSL *ssl, uint64_t options)
1074
0
{
1075
0
    return quic_mask_or_options(ssl, options, 0);
1076
0
}
1077
1078
/* SSL_get_options */
1079
uint64_t ossl_quic_get_options(const SSL *ssl)
1080
0
{
1081
0
    return quic_mask_or_options((SSL *)ssl, 0, 0);
1082
0
}
1083
1084
/*
1085
 * QUIC Front-End I/O API: Network BIO Configuration
1086
 * =================================================
1087
 *
1088
 * Handling the different BIOs is difficult:
1089
 *
1090
 *   - It is more or less a requirement that we use non-blocking network I/O;
1091
 *     we need to be able to have timeouts on recv() calls, and make best effort
1092
 *     (non blocking) send() and recv() calls.
1093
 *
1094
 *     The only sensible way to do this is to configure the socket into
1095
 *     non-blocking mode. We could try to do select() before calling send() or
1096
 *     recv() to get a guarantee that the call will not block, but this will
1097
 *     probably run into issues with buggy OSes which generate spurious socket
1098
 *     readiness events. In any case, relying on this to work reliably does not
1099
 *     seem sane.
1100
 *
1101
 *     Timeouts could be handled via setsockopt() socket timeout options, but
1102
 *     this depends on OS support and adds another syscall to every network I/O
1103
 *     operation. It also has obvious thread safety concerns if we want to move
1104
 *     to concurrent use of a single socket at some later date.
1105
 *
1106
 *     Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
1107
 *     be made non-blocking. However some OSes (e.g. Windows) do not support
1108
 *     this, so we cannot rely on this.
1109
 *
1110
 *     As such, we need to configure any FD in non-blocking mode. This may
1111
 *     confound users who pass a blocking socket to libssl. However, in practice
1112
 *     it would be extremely strange for a user of QUIC to pass an FD to us,
1113
 *     then also try and send receive traffic on the same socket(!). Thus the
1114
 *     impact of this should be limited, and can be documented.
1115
 *
1116
 *   - We support both blocking and non-blocking operation in terms of the API
1117
 *     presented to the user. One prospect is to set the blocking mode based on
1118
 *     whether the socket passed to us was already in blocking mode. However,
1119
 *     Windows has no API for determining if a socket is in blocking mode (!),
1120
 *     therefore this cannot be done portably. Currently therefore we expose an
1121
 *     explicit API call to set this, and default to blocking mode.
1122
 *
1123
 *   - We need to determine our initial destination UDP address. The "natural"
1124
 *     way for a user to do this is to set the peer variable on a BIO_dgram.
1125
 *     However, this has problems because BIO_dgram's peer variable is used for
1126
 *     both transmission and reception. This means it can be constantly being
1127
 *     changed to a malicious value (e.g. if some random unrelated entity on the
1128
 *     network starts sending traffic to us) on every read call. This is not a
1129
 *     direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
1130
 *     calls only, which do not use this variable. However, we do need to let
1131
 *     the user specify the peer in a 'normal' manner. The compromise here is
1132
 *     that we grab the current peer value set at the time the write BIO is set
1133
 *     and do not read the value again.
1134
 *
1135
 *   - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
1136
 *     Currently we do this by only supporting non-blocking mode.
1137
 *
1138
 */
1139
1140
/*
1141
 * Determines what initial destination UDP address we should use, if possible.
1142
 * If this fails the client must set the destination address manually, or use a
1143
 * BIO which does not need a destination address.
1144
 */
1145
static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
1146
0
{
1147
0
    if (BIO_dgram_detect_peer_addr(net_wbio, peer) <= 0)
1148
0
        return 0;
1149
1150
0
    return 1;
1151
0
}
1152
1153
static int
1154
quic_set0_net_rbio(QUIC_OBJ *obj, BIO *net_rbio)
1155
0
{
1156
0
    QUIC_PORT *port;
1157
0
    BIO *old_rbio = NULL;
1158
1159
0
    port = ossl_quic_obj_get0_port(obj);
1160
0
    old_rbio = ossl_quic_port_get_net_rbio(port);
1161
0
    if (old_rbio == net_rbio)
1162
0
        return 0;
1163
1164
0
    if (!ossl_quic_port_set_net_rbio(port, net_rbio))
1165
0
        return 0;
1166
1167
0
    BIO_free_all(old_rbio);
1168
0
    if (net_rbio != NULL)
1169
0
        BIO_set_nbio(net_rbio, 1); /* best effort autoconfig */
1170
1171
0
    return 1;
1172
0
}
1173
1174
static int
1175
quic_set0_net_wbio(QUIC_OBJ *obj, BIO *net_wbio)
1176
0
{
1177
0
    QUIC_PORT *port;
1178
0
    BIO *old_wbio = NULL;
1179
1180
0
    port = ossl_quic_obj_get0_port(obj);
1181
0
    old_wbio = ossl_quic_port_get_net_wbio(port);
1182
0
    if (old_wbio == net_wbio)
1183
0
        return 0;
1184
1185
0
    if (!ossl_quic_port_set_net_wbio(port, net_wbio))
1186
0
        return 0;
1187
1188
0
    BIO_free_all(old_wbio);
1189
0
    if (net_wbio != NULL)
1190
0
        BIO_set_nbio(net_wbio, 1); /* best effort autoconfig */
1191
1192
0
    return 1;
1193
0
}
1194
1195
void ossl_quic_conn_set0_net_rbio(SSL *s, BIO *net_rbio)
1196
0
{
1197
0
    QCTX ctx;
1198
1199
0
    if (!expect_quic_csl(s, &ctx))
1200
0
        return;
1201
1202
    /* Returns 0 if no change. */
1203
0
    if (!quic_set0_net_rbio(ctx.obj, net_rbio))
1204
0
        return;
1205
0
}
1206
1207
void ossl_quic_conn_set0_net_wbio(SSL *s, BIO *net_wbio)
1208
0
{
1209
0
    QCTX ctx;
1210
1211
0
    if (!expect_quic_csl(s, &ctx))
1212
0
        return;
1213
1214
    /* Returns 0 if no change. */
1215
0
    if (!quic_set0_net_wbio(ctx.obj, net_wbio))
1216
0
        return;
1217
0
}
1218
1219
BIO *ossl_quic_conn_get_net_rbio(const SSL *s)
1220
0
{
1221
0
    QCTX ctx;
1222
0
    QUIC_PORT *port;
1223
1224
0
    if (!expect_quic_csl(s, &ctx))
1225
0
        return NULL;
1226
1227
0
    port = ossl_quic_obj_get0_port(ctx.obj);
1228
0
    assert(port != NULL);
1229
0
    return ossl_quic_port_get_net_rbio(port);
1230
0
}
1231
1232
BIO *ossl_quic_conn_get_net_wbio(const SSL *s)
1233
0
{
1234
0
    QCTX ctx;
1235
0
    QUIC_PORT *port;
1236
1237
0
    if (!expect_quic_csl(s, &ctx))
1238
0
        return NULL;
1239
1240
0
    port = ossl_quic_obj_get0_port(ctx.obj);
1241
0
    assert(port != NULL);
1242
0
    return ossl_quic_port_get_net_wbio(port);
1243
0
}
1244
1245
int ossl_quic_conn_get_blocking_mode(const SSL *s)
1246
0
{
1247
0
    QCTX ctx;
1248
1249
0
    if (!expect_quic_csl(s, &ctx))
1250
0
        return 0;
1251
1252
0
    return qctx_blocking(&ctx);
1253
0
}
1254
1255
QUIC_TAKES_LOCK
1256
int ossl_quic_conn_set_blocking_mode(SSL *s, int blocking)
1257
0
{
1258
0
    int ret = 0;
1259
0
    unsigned int mode;
1260
0
    QCTX ctx;
1261
1262
0
    if (!expect_quic_csl(s, &ctx))
1263
0
        return 0;
1264
1265
0
    qctx_lock(&ctx);
1266
1267
    /* Sanity check - can we support the request given the current network BIO? */
1268
0
    if (blocking) {
1269
        /*
1270
         * If called directly on a top-level object (QCSO or QLSO), update our
1271
         * information on network BIO capabilities.
1272
         */
1273
0
        if (qctx_is_top_level(&ctx))
1274
0
            ossl_quic_engine_update_poll_descriptors(ctx.obj->engine, /*force=*/1);
1275
1276
        /* Cannot enable blocking mode if we do not have pollable FDs. */
1277
0
        if (!ossl_quic_obj_can_support_blocking(ctx.obj)) {
1278
0
            ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
1279
0
            goto out;
1280
0
        }
1281
0
    }
1282
1283
0
    mode = (blocking != 0)
1284
0
        ? QUIC_BLOCKING_MODE_BLOCKING
1285
0
        : QUIC_BLOCKING_MODE_NONBLOCKING;
1286
1287
0
    ossl_quic_obj_set_blocking_mode(ctx.obj, mode);
1288
1289
0
    ret = 1;
1290
0
out:
1291
0
    qctx_unlock(&ctx);
1292
0
    return ret;
1293
0
}
1294
1295
int ossl_quic_conn_set_initial_peer_addr(SSL *s,
1296
    const BIO_ADDR *peer_addr)
1297
0
{
1298
0
    QCTX ctx;
1299
1300
0
    if (!expect_quic_cs(s, &ctx))
1301
0
        return 0;
1302
1303
0
    if (ctx.qc->started)
1304
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
1305
0
            NULL);
1306
1307
0
    if (peer_addr == NULL) {
1308
0
        BIO_ADDR_clear(&ctx.qc->init_peer_addr);
1309
0
        return 1;
1310
0
    }
1311
1312
0
    return BIO_ADDR_copy(&ctx.qc->init_peer_addr, peer_addr);
1313
0
}
1314
1315
/*
1316
 * QUIC Front-End I/O API: Asynchronous I/O Management
1317
 * ===================================================
1318
 *
1319
 *   (BIO/)SSL_handle_events        => ossl_quic_handle_events
1320
 *   (BIO/)SSL_get_event_timeout    => ossl_quic_get_event_timeout
1321
 *   (BIO/)SSL_get_poll_fd          => ossl_quic_get_poll_fd
1322
 *
1323
 */
1324
1325
/* SSL_handle_events; performs QUIC I/O and timeout processing. */
1326
QUIC_TAKES_LOCK
1327
int ossl_quic_handle_events(SSL *s)
1328
0
{
1329
0
    QCTX ctx;
1330
1331
0
    if (!expect_quic_any(s, &ctx))
1332
0
        return 0;
1333
1334
0
    qctx_lock(&ctx);
1335
0
    ossl_quic_reactor_tick(ossl_quic_obj_get0_reactor(ctx.obj), 0);
1336
0
    qctx_unlock(&ctx);
1337
0
    return 1;
1338
0
}
1339
1340
/*
1341
 * SSL_get_event_timeout. Get the time in milliseconds until the SSL object
1342
 * should next have events handled by the application by calling
1343
 * SSL_handle_events(). tv is set to 0 if the object should have events handled
1344
 * immediately. If no timeout is currently active, *is_infinite is set to 1 and
1345
 * the value of *tv is undefined.
1346
 */
1347
QUIC_TAKES_LOCK
1348
int ossl_quic_get_event_timeout(SSL *s, struct timeval *tv, int *is_infinite)
1349
0
{
1350
0
    QCTX ctx;
1351
0
    QUIC_REACTOR *reactor;
1352
0
    OSSL_TIME deadline;
1353
0
    OSSL_TIME basetime;
1354
1355
0
    if (!expect_quic_any(s, &ctx))
1356
0
        return 0;
1357
1358
0
    qctx_lock(&ctx);
1359
1360
0
    reactor = ossl_quic_obj_get0_reactor(ctx.obj);
1361
0
    deadline = ossl_quic_reactor_get_tick_deadline(reactor);
1362
1363
0
    if (ossl_time_is_infinite(deadline)) {
1364
0
        qctx_unlock(&ctx);
1365
0
        *is_infinite = 1;
1366
1367
        /*
1368
         * Robustness against faulty applications that don't check *is_infinite;
1369
         * harmless long timeout.
1370
         */
1371
0
        tv->tv_sec = 1000000;
1372
0
        tv->tv_usec = 0;
1373
0
        return 1;
1374
0
    }
1375
1376
0
    basetime = ossl_quic_engine_get_time(ctx.obj->engine);
1377
1378
0
    qctx_unlock(&ctx);
1379
1380
0
    *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, basetime));
1381
0
    *is_infinite = 0;
1382
1383
0
    return 1;
1384
0
}
1385
1386
/* SSL_get_rpoll_descriptor */
1387
int ossl_quic_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1388
0
{
1389
0
    QCTX ctx;
1390
0
    QUIC_PORT *port = NULL;
1391
0
    BIO *net_rbio;
1392
1393
0
    if (!expect_quic_csl(s, &ctx))
1394
0
        return 0;
1395
1396
0
    port = ossl_quic_obj_get0_port(ctx.obj);
1397
0
    net_rbio = ossl_quic_port_get_net_rbio(port);
1398
0
    if (desc == NULL || net_rbio == NULL)
1399
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1400
0
            NULL);
1401
1402
0
    return BIO_get_rpoll_descriptor(net_rbio, desc);
1403
0
}
1404
1405
/* SSL_get_wpoll_descriptor */
1406
int ossl_quic_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1407
0
{
1408
0
    QCTX ctx;
1409
0
    QUIC_PORT *port = NULL;
1410
0
    BIO *net_wbio;
1411
1412
0
    if (!expect_quic_csl(s, &ctx))
1413
0
        return 0;
1414
1415
0
    port = ossl_quic_obj_get0_port(ctx.obj);
1416
0
    net_wbio = ossl_quic_port_get_net_wbio(port);
1417
0
    if (desc == NULL || net_wbio == NULL)
1418
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1419
0
            NULL);
1420
1421
0
    return BIO_get_wpoll_descriptor(net_wbio, desc);
1422
0
}
1423
1424
/* SSL_net_read_desired */
1425
QUIC_TAKES_LOCK
1426
int ossl_quic_get_net_read_desired(SSL *s)
1427
0
{
1428
0
    QCTX ctx;
1429
0
    int ret;
1430
1431
0
    if (!expect_quic_csl(s, &ctx))
1432
0
        return 0;
1433
1434
0
    qctx_lock(&ctx);
1435
0
    ret = ossl_quic_reactor_net_read_desired(ossl_quic_obj_get0_reactor(ctx.obj));
1436
0
    qctx_unlock(&ctx);
1437
0
    return ret;
1438
0
}
1439
1440
/* SSL_net_write_desired */
1441
QUIC_TAKES_LOCK
1442
int ossl_quic_get_net_write_desired(SSL *s)
1443
0
{
1444
0
    int ret;
1445
0
    QCTX ctx;
1446
1447
0
    if (!expect_quic_csl(s, &ctx))
1448
0
        return 0;
1449
1450
0
    qctx_lock(&ctx);
1451
0
    ret = ossl_quic_reactor_net_write_desired(ossl_quic_obj_get0_reactor(ctx.obj));
1452
0
    qctx_unlock(&ctx);
1453
0
    return ret;
1454
0
}
1455
1456
/*
1457
 * QUIC Front-End I/O API: Connection Lifecycle Operations
1458
 * =======================================================
1459
 *
1460
 *         SSL_do_handshake         => ossl_quic_do_handshake
1461
 *         SSL_set_connect_state    => ossl_quic_set_connect_state
1462
 *         SSL_set_accept_state     => ossl_quic_set_accept_state
1463
 *         SSL_shutdown             => ossl_quic_shutdown
1464
 *         SSL_ctrl                 => ossl_quic_ctrl
1465
 *   (BIO/)SSL_connect              => ossl_quic_connect
1466
 *   (BIO/)SSL_accept               => ossl_quic_accept
1467
 *
1468
 */
1469
1470
QUIC_NEEDS_LOCK
1471
static void qc_shutdown_flush_init(QUIC_CONNECTION *qc)
1472
0
{
1473
0
    QUIC_STREAM_MAP *qsm;
1474
1475
0
    if (qc->shutting_down)
1476
0
        return;
1477
1478
0
    qsm = ossl_quic_channel_get_qsm(qc->ch);
1479
1480
0
    ossl_quic_stream_map_begin_shutdown_flush(qsm);
1481
0
    qc->shutting_down = 1;
1482
0
}
1483
1484
/* Returns 1 if all shutdown-flush streams have been done with. */
1485
QUIC_NEEDS_LOCK
1486
static int qc_shutdown_flush_finished(QUIC_CONNECTION *qc)
1487
0
{
1488
0
    QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
1489
1490
0
    return qc->shutting_down
1491
0
        && ossl_quic_stream_map_is_shutdown_flush_finished(qsm);
1492
0
}
1493
1494
/* SSL_shutdown */
1495
static int quic_shutdown_wait(void *arg)
1496
0
{
1497
0
    QUIC_CONNECTION *qc = arg;
1498
1499
0
    return ossl_quic_channel_is_terminated(qc->ch);
1500
0
}
1501
1502
/* Returns 1 if shutdown flush process has finished or is inapplicable. */
1503
static int quic_shutdown_flush_wait(void *arg)
1504
0
{
1505
0
    QUIC_CONNECTION *qc = arg;
1506
1507
0
    return ossl_quic_channel_is_term_any(qc->ch)
1508
0
        || qc_shutdown_flush_finished(qc);
1509
0
}
1510
1511
static int quic_shutdown_peer_wait(void *arg)
1512
0
{
1513
0
    QUIC_CONNECTION *qc = arg;
1514
0
    return ossl_quic_channel_is_term_any(qc->ch);
1515
0
}
1516
1517
/*
1518
 * This function deals with local shutdown.
1519
 * Function must consider those scenarios:
1520
 *    - blocking mode (1)
1521
 *    - non-blocking mode (2)
1522
 *    - non-blocking mode with assistance from SSL_poll() (3)
1523
 * (1) The function completes shutdown then returns back to caller.
1524
 * To complete shutdown we must do:
1525
 *    - flush all streams, unless we got SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH,
1526
 *      which means the connection is closed without waiting for streams
1527
 *      to deliver data written by application.
1528
 *    - let remote peer know local application is going to close connection,
1529
 *      unless we got SSL_SHUTDOWN_FLAG_WAIT_PEER in which case we await
1530
 *      until remote peer closes the connection
1531
 *    - wait for peer to confirm connection close
1532
 *
1533
 * (2) The function does not block waiting for streams to be flushed
1534
 * nor for peer to close connection (when running with SSL_SHUTDOWN_FLAG_WAIT_PEER)
1535
 * Application is supposed to call SSL_shutdown() repeatedly as long as
1536
 * function returns 0 which indicates the operation is still in progress.
1537
 *
1538
 * (3) In this case application uses SSL_poll() to wait for completion
1539
 * of each step of shutdown process. Application calls SSL_shutdown()
1540
 * to start with connection shutdown. The function does not block.
1541
 * Application then uses SSL_poll() on connection object to monitor
1542
 * progress of shutdown. The SSL_poll() indicates progress by signaling
1543
 * SSL_POLL_EVENT_EC event. Application must check connection object
1544
 * for error. If no error is indicated, then application must call
1545
 * SSL_shutdown() to move to the next stop in shutdown process.
1546
 */
1547
QUIC_TAKES_LOCK
1548
int ossl_quic_conn_shutdown(SSL *s, uint64_t flags,
1549
    const SSL_SHUTDOWN_EX_ARGS *args,
1550
    size_t args_len)
1551
0
{
1552
0
    int ret;
1553
0
    QCTX ctx;
1554
0
    int stream_flush = ((flags & SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH) == 0);
1555
0
    int no_block = ((flags & SSL_SHUTDOWN_FLAG_NO_BLOCK) != 0);
1556
0
    int wait_peer = ((flags & SSL_SHUTDOWN_FLAG_WAIT_PEER) != 0);
1557
1558
0
    if (!expect_quic_cs(s, &ctx))
1559
0
        return -1;
1560
1561
0
    if (ctx.is_stream) {
1562
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_CONN_USE_ONLY, NULL);
1563
0
        return -1;
1564
0
    }
1565
1566
0
    qctx_lock(&ctx);
1567
1568
0
    if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1569
0
        qctx_unlock(&ctx);
1570
0
        return 1;
1571
0
    }
1572
1573
0
    if (!wait_peer) {
1574
        /*
1575
         * Set shutdown reason now when local application wants to do
1576
         * active close (does not waant to wait for peer to close th
1577
         * connection). The reason will be sent to peer with connection
1578
         * close notification as soon as streams will be flushed.
1579
         */
1580
0
        if (args != NULL) {
1581
0
            ossl_quic_channel_set_tcause(ctx.qc->ch, args->quic_error_code,
1582
0
                args->quic_reason);
1583
0
        }
1584
0
    }
1585
1586
    /* Phase 1: Stream Flushing */
1587
0
    if (!wait_peer && stream_flush) {
1588
0
        qc_shutdown_flush_init(ctx.qc);
1589
1590
0
        if (!qc_shutdown_flush_finished(ctx.qc)) {
1591
0
            if (!no_block && qctx_blocking(&ctx)) {
1592
0
                ret = block_until_pred(&ctx, quic_shutdown_flush_wait, ctx.qc, 0);
1593
0
                if (ret < 1) {
1594
0
                    ret = 0;
1595
0
                    goto err;
1596
0
                }
1597
0
            } else {
1598
0
                qctx_maybe_autotick(&ctx);
1599
0
            }
1600
0
        }
1601
1602
0
        if (!qc_shutdown_flush_finished(ctx.qc)) {
1603
0
            qctx_unlock(&ctx);
1604
0
            return 0; /* ongoing */
1605
0
        }
1606
0
    }
1607
1608
    /* Phase 2: Connection Closure */
1609
0
    if (wait_peer && !ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1610
0
        if (!no_block && qctx_blocking(&ctx)) {
1611
0
            ret = block_until_pred(&ctx, quic_shutdown_peer_wait, ctx.qc, 0);
1612
0
            if (ret < 1) {
1613
0
                ret = 0;
1614
0
                goto err;
1615
0
            }
1616
0
        } else {
1617
0
            qctx_maybe_autotick(&ctx);
1618
0
        }
1619
1620
0
        if (!ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1621
0
            ret = 0; /* peer hasn't closed yet - still not done */
1622
0
            goto err;
1623
0
        }
1624
1625
        /*
1626
         * We are at least terminating - go through the normal process of
1627
         * waiting until we are in the TERMINATED state.
1628
         */
1629
0
    }
1630
1631
    /* Block mutation ops regardless of if we did stream flush. */
1632
0
    ctx.qc->shutting_down = 1;
1633
1634
    /*
1635
     * This call is a no-op if we are already terminating, so it doesn't
1636
     * affect the wait_peer case.
1637
     */
1638
0
    ossl_quic_channel_local_close(ctx.qc->ch,
1639
0
        args != NULL ? args->quic_error_code : 0,
1640
0
        args != NULL ? args->quic_reason : NULL);
1641
1642
0
    SSL_set_shutdown(ctx.qc->tls, SSL_SENT_SHUTDOWN);
1643
1644
0
    if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1645
0
        qctx_unlock(&ctx);
1646
0
        return 1;
1647
0
    }
1648
1649
    /* Phase 3: Terminating Wait Time */
1650
0
    if (!no_block && qctx_blocking(&ctx)
1651
0
        && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0) {
1652
0
        ret = block_until_pred(&ctx, quic_shutdown_wait, ctx.qc, 0);
1653
0
        if (ret < 1) {
1654
0
            ret = 0;
1655
0
            goto err;
1656
0
        }
1657
0
    } else {
1658
0
        qctx_maybe_autotick(&ctx);
1659
0
    }
1660
1661
0
    ret = ossl_quic_channel_is_terminated(ctx.qc->ch);
1662
0
err:
1663
0
    qctx_unlock(&ctx);
1664
0
    return ret;
1665
0
}
1666
1667
/* SSL_ctrl */
1668
long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
1669
0
{
1670
0
    QCTX ctx;
1671
1672
0
    if (!expect_quic_csl(s, &ctx))
1673
0
        return 0;
1674
1675
0
    switch (cmd) {
1676
0
    case SSL_CTRL_MODE:
1677
0
        if (ctx.is_listener)
1678
0
            return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
1679
1680
        /* If called on a QCSO, update the default mode. */
1681
0
        if (!ctx.is_stream)
1682
0
            ctx.qc->default_ssl_mode |= (uint32_t)larg;
1683
1684
        /*
1685
         * If we were called on a QSSO or have a default stream, we also update
1686
         * that.
1687
         */
1688
0
        if (ctx.xso != NULL) {
1689
            /* Cannot enable EPW while AON write in progress. */
1690
0
            if (ctx.xso->aon_write_in_progress)
1691
0
                larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
1692
1693
0
            ctx.xso->ssl_mode |= (uint32_t)larg;
1694
0
            return ctx.xso->ssl_mode;
1695
0
        }
1696
1697
0
        return ctx.qc->default_ssl_mode;
1698
0
    case SSL_CTRL_CLEAR_MODE:
1699
0
        if (ctx.is_listener)
1700
0
            return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
1701
1702
0
        if (!ctx.is_stream)
1703
0
            ctx.qc->default_ssl_mode &= ~(uint32_t)larg;
1704
1705
0
        if (ctx.xso != NULL) {
1706
0
            ctx.xso->ssl_mode &= ~(uint32_t)larg;
1707
0
            return ctx.xso->ssl_mode;
1708
0
        }
1709
1710
0
        return ctx.qc->default_ssl_mode;
1711
1712
0
    case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1713
0
        if (ctx.is_listener)
1714
0
            return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
1715
1716
0
        ossl_quic_channel_set_msg_callback_arg(ctx.qc->ch, parg);
1717
        /* This ctrl also needs to be passed to the internal SSL object */
1718
0
        return SSL_ctrl(ctx.qc->tls, cmd, larg, parg);
1719
1720
0
    case DTLS_CTRL_GET_TIMEOUT: /* DTLSv1_get_timeout */
1721
0
    {
1722
0
        int is_infinite;
1723
1724
0
        if (!ossl_quic_get_event_timeout(s, parg, &is_infinite))
1725
0
            return 0;
1726
1727
0
        return !is_infinite;
1728
0
    }
1729
0
    case DTLS_CTRL_HANDLE_TIMEOUT: /* DTLSv1_handle_timeout */
1730
        /* For legacy compatibility with DTLS calls. */
1731
0
        return ossl_quic_handle_events(s) == 1 ? 1 : -1;
1732
1733
        /* Mask ctrls we shouldn't support for QUIC. */
1734
0
    case SSL_CTRL_GET_READ_AHEAD:
1735
0
    case SSL_CTRL_SET_READ_AHEAD:
1736
0
    case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1737
0
    case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1738
0
    case SSL_CTRL_SET_MAX_PIPELINES:
1739
0
        return 0;
1740
1741
0
    default:
1742
        /*
1743
         * Probably a TLS related ctrl. Send back to the frontend SSL_ctrl
1744
         * implementation. Either SSL_ctrl will handle it itself by direct
1745
         * access into handshake layer state, or failing that, it will be passed
1746
         * to the handshake layer via the SSL_METHOD vtable. If the ctrl is not
1747
         * supported by anything, the handshake layer's ctrl method will finally
1748
         * return 0.
1749
         */
1750
0
        if (ctx.is_listener)
1751
0
            return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
1752
1753
0
        return ossl_ctrl_internal(&ctx.qc->obj.ssl, cmd, larg, parg, /*no_quic=*/1);
1754
0
    }
1755
0
}
1756
1757
/* SSL_set_connect_state */
1758
int ossl_quic_set_connect_state(SSL *s, int raiseerrs)
1759
0
{
1760
0
    QCTX ctx;
1761
1762
0
    if (!is_quic_c(s, &ctx, raiseerrs))
1763
0
        return 0;
1764
1765
0
    if (ctx.qc->as_server_state == 0)
1766
0
        return 1;
1767
1768
    /* Cannot be changed after handshake started */
1769
0
    if (ctx.qc->started) {
1770
0
        if (raiseerrs)
1771
0
            QUIC_RAISE_NON_NORMAL_ERROR(NULL, SSL_R_INVALID_COMMAND, NULL);
1772
0
        return 0;
1773
0
    }
1774
1775
0
    ctx.qc->as_server_state = 0;
1776
0
    return 1;
1777
0
}
1778
1779
/* SSL_set_accept_state */
1780
int ossl_quic_set_accept_state(SSL *s, int raiseerrs)
1781
0
{
1782
0
    QCTX ctx;
1783
1784
0
    if (!is_quic_c(s, &ctx, raiseerrs))
1785
0
        return 0;
1786
1787
0
    if (ctx.qc->as_server_state == 1)
1788
0
        return 1;
1789
1790
    /* Cannot be changed after handshake started */
1791
0
    if (ctx.qc->started) {
1792
0
        if (raiseerrs)
1793
0
            QUIC_RAISE_NON_NORMAL_ERROR(NULL, SSL_R_INVALID_COMMAND, NULL);
1794
0
        return 0;
1795
0
    }
1796
1797
0
    ctx.qc->as_server_state = 1;
1798
0
    return 1;
1799
0
}
1800
1801
/* SSL_do_handshake */
1802
struct quic_handshake_wait_args {
1803
    QUIC_CONNECTION *qc;
1804
};
1805
1806
static int tls_wants_non_io_retry(QUIC_CONNECTION *qc)
1807
0
{
1808
0
    int want = SSL_want(qc->tls);
1809
1810
0
    if (want == SSL_X509_LOOKUP
1811
0
        || want == SSL_CLIENT_HELLO_CB
1812
0
        || want == SSL_RETRY_VERIFY)
1813
0
        return 1;
1814
1815
0
    return 0;
1816
0
}
1817
1818
static int quic_handshake_wait(void *arg)
1819
0
{
1820
0
    struct quic_handshake_wait_args *args = arg;
1821
1822
0
    if (!quic_mutation_allowed(args->qc, /*req_active=*/1))
1823
0
        return -1;
1824
1825
0
    if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
1826
0
        return 1;
1827
1828
0
    if (tls_wants_non_io_retry(args->qc))
1829
0
        return 1;
1830
1831
0
    return 0;
1832
0
}
1833
1834
static int configure_channel(QUIC_CONNECTION *qc)
1835
0
{
1836
0
    assert(qc->ch != NULL);
1837
1838
0
    if (!ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
1839
0
        return 0;
1840
1841
0
    return 1;
1842
0
}
1843
1844
static int need_notifier_for_domain_flags(uint64_t domain_flags)
1845
0
{
1846
0
    return (domain_flags & SSL_DOMAIN_FLAG_THREAD_ASSISTED) != 0
1847
0
        || ((domain_flags & SSL_DOMAIN_FLAG_MULTI_THREAD) != 0
1848
0
            && (domain_flags & SSL_DOMAIN_FLAG_BLOCKING) != 0);
1849
0
}
1850
1851
QUIC_NEEDS_LOCK
1852
static int create_channel(QUIC_CONNECTION *qc, SSL_CTX *ctx)
1853
0
{
1854
0
    QUIC_ENGINE_ARGS engine_args = { 0 };
1855
0
    QUIC_PORT_ARGS port_args = { 0 };
1856
1857
0
    engine_args.libctx = ctx->libctx;
1858
0
    engine_args.propq = ctx->propq;
1859
0
#if defined(OPENSSL_THREADS)
1860
0
    engine_args.mutex = qc->mutex;
1861
0
#endif
1862
1863
0
    if (need_notifier_for_domain_flags(ctx->domain_flags))
1864
0
        engine_args.reactor_flags |= QUIC_REACTOR_FLAG_USE_NOTIFIER;
1865
1866
0
    qc->engine = ossl_quic_engine_new(&engine_args);
1867
0
    if (qc->engine == NULL) {
1868
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1869
0
        return 0;
1870
0
    }
1871
1872
0
    port_args.channel_ctx = ctx;
1873
0
    qc->port = ossl_quic_engine_create_port(qc->engine, &port_args);
1874
0
    if (qc->port == NULL) {
1875
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1876
0
        ossl_quic_engine_free(qc->engine);
1877
0
        qc->engine = NULL;
1878
0
        return 0;
1879
0
    }
1880
1881
0
    qc->ch = ossl_quic_port_create_outgoing(qc->port, qc->tls);
1882
0
    if (qc->ch == NULL) {
1883
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1884
0
        ossl_quic_port_free(qc->port);
1885
0
        qc->port = NULL;
1886
0
        ossl_quic_engine_free(qc->engine);
1887
0
        qc->engine = NULL;
1888
0
        return 0;
1889
0
    }
1890
1891
0
    return 1;
1892
0
}
1893
1894
/*
1895
 * Configures a channel with the information we have accumulated via calls made
1896
 * to us from the application prior to starting a handshake attempt.
1897
 */
1898
QUIC_NEEDS_LOCK
1899
static int ensure_channel_started(QCTX *ctx)
1900
0
{
1901
0
    QUIC_CONNECTION *qc = ctx->qc;
1902
1903
0
    if (!qc->started) {
1904
0
        if (!configure_channel(qc)) {
1905
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1906
0
                "failed to configure channel");
1907
0
            return 0;
1908
0
        }
1909
1910
0
        if (!ossl_quic_channel_start(qc->ch)) {
1911
0
            ossl_quic_channel_restore_err_state(qc->ch);
1912
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1913
0
                "failed to start channel");
1914
0
            return 0;
1915
0
        }
1916
1917
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1918
0
        if (qc->is_thread_assisted)
1919
0
            if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch)) {
1920
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1921
0
                    "failed to start assist thread");
1922
0
                return 0;
1923
0
            }
1924
0
#endif
1925
0
    }
1926
1927
0
    qc->started = 1;
1928
0
    return 1;
1929
0
}
1930
1931
QUIC_NEEDS_LOCK
1932
static int quic_do_handshake(QCTX *ctx)
1933
0
{
1934
0
    int ret;
1935
0
    QUIC_CONNECTION *qc = ctx->qc;
1936
0
    QUIC_PORT *port;
1937
0
    BIO *net_rbio, *net_wbio;
1938
1939
0
    if (ossl_quic_channel_is_handshake_complete(qc->ch))
1940
        /* Handshake already completed. */
1941
0
        return 1;
1942
1943
0
    if (!quic_mutation_allowed(qc, /*req_active=*/0))
1944
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1945
1946
0
    if (qc->as_server != qc->as_server_state) {
1947
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
1948
0
        return -1; /* Non-protocol error */
1949
0
    }
1950
1951
0
    port = ossl_quic_obj_get0_port(ctx->obj);
1952
0
    net_rbio = ossl_quic_port_get_net_rbio(port);
1953
0
    net_wbio = ossl_quic_port_get_net_wbio(port);
1954
0
    if (net_rbio == NULL || net_wbio == NULL) {
1955
        /* Need read and write BIOs. */
1956
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BIO_NOT_SET, NULL);
1957
0
        return -1; /* Non-protocol error */
1958
0
    }
1959
1960
0
    if (!qc->started && ossl_quic_port_is_addressed_w(port)
1961
0
        && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1962
        /*
1963
         * We are trying to connect and are using addressed mode, which means we
1964
         * need an initial peer address; if we do not have a peer address yet,
1965
         * we should try to autodetect one.
1966
         *
1967
         * We do this as late as possible because some BIOs (e.g. BIO_s_connect)
1968
         * may not be able to provide us with a peer address until they have
1969
         * finished their own processing. They may not be able to perform this
1970
         * processing until an application has finished configuring that BIO
1971
         * (e.g. with setter calls), which might happen after SSL_set_bio is
1972
         * called.
1973
         */
1974
0
        if (!csm_analyse_init_peer_addr(net_wbio, &qc->init_peer_addr))
1975
            /* best effort */
1976
0
            BIO_ADDR_clear(&qc->init_peer_addr);
1977
0
        else
1978
0
            ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr);
1979
0
    }
1980
1981
0
    if (!qc->started
1982
0
        && ossl_quic_port_is_addressed_w(port)
1983
0
        && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1984
        /*
1985
         * If we still don't have a peer address in addressed mode, we can't do
1986
         * anything.
1987
         */
1988
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
1989
0
        return -1; /* Non-protocol error */
1990
0
    }
1991
1992
    /*
1993
     * Start connection process. Note we may come here multiple times in
1994
     * non-blocking mode, which is fine.
1995
     */
1996
0
    if (!ensure_channel_started(ctx)) /* raises on failure */
1997
0
        return -1; /* Non-protocol error */
1998
1999
0
    if (ossl_quic_channel_is_handshake_complete(qc->ch))
2000
        /* The handshake is now done. */
2001
0
        return 1;
2002
2003
0
    if (!qctx_blocking(ctx)) {
2004
        /* Try to advance the reactor. */
2005
0
        qctx_maybe_autotick(ctx);
2006
2007
0
        if (ossl_quic_channel_is_handshake_complete(qc->ch))
2008
            /* The handshake is now done. */
2009
0
            return 1;
2010
2011
0
        if (ossl_quic_channel_is_term_any(qc->ch)) {
2012
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2013
0
            return 0;
2014
0
        } else if (ossl_quic_obj_desires_blocking(&qc->obj)) {
2015
            /*
2016
             * As a special case when doing a handshake when blocking mode is
2017
             * desired yet not available, see if the network BIOs have become
2018
             * poll descriptor-enabled. This supports BIOs such as BIO_s_connect
2019
             * which do late creation of socket FDs and therefore cannot expose
2020
             * a poll descriptor until after a network BIO is set on the QCSO.
2021
             */
2022
0
            ossl_quic_engine_update_poll_descriptors(qc->obj.engine, /*force=*/1);
2023
0
        }
2024
0
    }
2025
2026
    /*
2027
     * We are either in blocking mode or just entered it due to the code above.
2028
     */
2029
0
    if (qctx_blocking(ctx)) {
2030
        /* In blocking mode, wait for the handshake to complete. */
2031
0
        struct quic_handshake_wait_args args;
2032
2033
0
        args.qc = qc;
2034
2035
0
        ret = block_until_pred(ctx, quic_handshake_wait, &args, 0);
2036
0
        if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
2037
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2038
0
            return 0; /* Shutdown before completion */
2039
0
        } else if (ret <= 0) {
2040
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2041
0
            return -1; /* Non-protocol error */
2042
0
        }
2043
2044
0
        if (tls_wants_non_io_retry(qc)) {
2045
0
            QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
2046
0
            return -1;
2047
0
        }
2048
2049
0
        assert(ossl_quic_channel_is_handshake_complete(qc->ch));
2050
0
        return 1;
2051
0
    }
2052
2053
0
    if (tls_wants_non_io_retry(qc)) {
2054
0
        QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
2055
0
        return -1;
2056
0
    }
2057
2058
    /*
2059
     * Otherwise, indicate that the handshake isn't done yet.
2060
     * We can only get here in non-blocking mode.
2061
     */
2062
0
    QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
2063
0
    return -1; /* Non-protocol error */
2064
0
}
2065
2066
QUIC_TAKES_LOCK
2067
int ossl_quic_do_handshake(SSL *s)
2068
0
{
2069
0
    int ret;
2070
0
    QCTX ctx;
2071
2072
0
    if (!expect_quic_cs(s, &ctx))
2073
0
        return 0;
2074
2075
0
    qctx_lock_for_io(&ctx);
2076
2077
0
    ret = quic_do_handshake(&ctx);
2078
0
    qctx_unlock(&ctx);
2079
0
    return ret;
2080
0
}
2081
2082
/* SSL_connect */
2083
int ossl_quic_connect(SSL *s)
2084
0
{
2085
    /* Ensure we are in connect state (no-op if non-idle). */
2086
0
    if (!ossl_quic_set_connect_state(s, 1))
2087
0
        return -1;
2088
2089
    /* Begin or continue the handshake */
2090
0
    return ossl_quic_do_handshake(s);
2091
0
}
2092
2093
/* SSL_accept */
2094
int ossl_quic_accept(SSL *s)
2095
0
{
2096
    /* Ensure we are in accept state (no-op if non-idle). */
2097
0
    if (!ossl_quic_set_accept_state(s, 1))
2098
0
        return -1;
2099
2100
    /* Begin or continue the handshake */
2101
0
    return ossl_quic_do_handshake(s);
2102
0
}
2103
2104
/*
2105
 * QUIC Front-End I/O API: Stream Lifecycle Operations
2106
 * ===================================================
2107
 *
2108
 *         SSL_stream_new       => ossl_quic_conn_stream_new
2109
 *
2110
 */
2111
2112
/*
2113
 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
2114
 * default XSO was created. Returns 0 if it was not (e.g. because it already
2115
 * exists). Note that this is NOT an error condition.
2116
 */
2117
QUIC_NEEDS_LOCK
2118
static int qc_try_create_default_xso_for_write(QCTX *ctx)
2119
0
{
2120
0
    uint64_t flags = 0;
2121
0
    QUIC_CONNECTION *qc = ctx->qc;
2122
2123
0
    if (qc->default_xso_created
2124
0
        || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2125
        /*
2126
         * We only do this once. If the user detaches a previously created
2127
         * default XSO we don't auto-create another one.
2128
         */
2129
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
2130
2131
    /* Create a locally-initiated stream. */
2132
0
    if (qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_AUTO_UNI)
2133
0
        flags |= SSL_STREAM_FLAG_UNI;
2134
2135
0
    qc_set_default_xso(qc, (QUIC_XSO *)quic_conn_stream_new(ctx, flags,
2136
0
                               /*needs_lock=*/0),
2137
0
        /*touch=*/0);
2138
0
    if (qc->default_xso == NULL)
2139
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2140
2141
0
    qc_touch_default_xso(qc);
2142
0
    return 1;
2143
0
}
2144
2145
struct quic_wait_for_stream_args {
2146
    QUIC_CONNECTION *qc;
2147
    QUIC_STREAM *qs;
2148
    QCTX *ctx;
2149
    uint64_t expect_id;
2150
};
2151
2152
QUIC_NEEDS_LOCK
2153
static int quic_wait_for_stream(void *arg)
2154
0
{
2155
0
    struct quic_wait_for_stream_args *args = arg;
2156
2157
0
    if (!quic_mutation_allowed(args->qc, /*req_active=*/1)) {
2158
        /* If connection is torn down due to an error while blocking, stop. */
2159
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2160
0
        return -1;
2161
0
    }
2162
2163
0
    args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
2164
0
        args->expect_id | QUIC_STREAM_DIR_BIDI);
2165
0
    if (args->qs == NULL)
2166
0
        args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
2167
0
            args->expect_id | QUIC_STREAM_DIR_UNI);
2168
2169
0
    if (args->qs != NULL)
2170
0
        return 1; /* stream now exists */
2171
2172
0
    return 0; /* did not get a stream, keep trying */
2173
0
}
2174
2175
QUIC_NEEDS_LOCK
2176
static int qc_wait_for_default_xso_for_read(QCTX *ctx, int peek)
2177
0
{
2178
    /* Called on a QCSO and we don't currently have a default stream. */
2179
0
    uint64_t expect_id;
2180
0
    QUIC_CONNECTION *qc = ctx->qc;
2181
0
    QUIC_STREAM *qs;
2182
0
    int res;
2183
0
    struct quic_wait_for_stream_args wargs;
2184
0
    OSSL_RTT_INFO rtt_info;
2185
2186
    /*
2187
     * If default stream functionality is disabled or we already detached
2188
     * one, don't make another default stream and just fail.
2189
     */
2190
0
    if (qc->default_xso_created
2191
0
        || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2192
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
2193
2194
    /*
2195
     * The peer may have opened a stream since we last ticked. So tick and
2196
     * see if the stream with ordinal 0 (remote, bidi/uni based on stream
2197
     * mode) exists yet. QUIC stream IDs must be allocated in order, so the
2198
     * first stream created by a peer must have an ordinal of 0.
2199
     */
2200
0
    expect_id = qc->as_server
2201
0
        ? QUIC_STREAM_INITIATOR_CLIENT
2202
0
        : QUIC_STREAM_INITIATOR_SERVER;
2203
2204
0
    qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
2205
0
        expect_id | QUIC_STREAM_DIR_BIDI);
2206
0
    if (qs == NULL)
2207
0
        qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
2208
0
            expect_id | QUIC_STREAM_DIR_UNI);
2209
2210
0
    if (qs == NULL) {
2211
0
        qctx_maybe_autotick(ctx);
2212
2213
0
        qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
2214
0
            expect_id);
2215
0
    }
2216
2217
0
    if (qs == NULL) {
2218
0
        if (peek)
2219
0
            return 0;
2220
2221
0
        if (ossl_quic_channel_is_term_any(qc->ch)) {
2222
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2223
0
        } else if (!qctx_blocking(ctx)) {
2224
            /* Non-blocking mode, so just bail immediately. */
2225
0
            return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
2226
0
        }
2227
2228
        /* Block until we have a stream. */
2229
0
        wargs.qc = qc;
2230
0
        wargs.qs = NULL;
2231
0
        wargs.ctx = ctx;
2232
0
        wargs.expect_id = expect_id;
2233
2234
0
        res = block_until_pred(ctx, quic_wait_for_stream, &wargs, 0);
2235
0
        if (res == 0)
2236
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2237
0
        else if (res < 0 || wargs.qs == NULL)
2238
            /* quic_wait_for_stream raised error here */
2239
0
            return 0;
2240
2241
0
        qs = wargs.qs;
2242
0
    }
2243
2244
    /*
2245
     * We now have qs != NULL. Remove it from the incoming stream queue so that
2246
     * it isn't also returned by any future SSL_accept_stream calls.
2247
     */
2248
0
    ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
2249
0
    ossl_quic_stream_map_remove_from_accept_queue(ossl_quic_channel_get_qsm(qc->ch),
2250
0
        qs, rtt_info.smoothed_rtt);
2251
2252
    /*
2253
     * Now make qs the default stream, creating the necessary XSO.
2254
     */
2255
0
    qc_set_default_xso(qc, create_xso_from_stream(qc, qs), /*touch=*/0);
2256
0
    if (qc->default_xso == NULL)
2257
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2258
2259
0
    qc_touch_default_xso(qc); /* inhibits default XSO */
2260
0
    return 1;
2261
0
}
2262
2263
QUIC_NEEDS_LOCK
2264
static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs)
2265
0
{
2266
0
    QUIC_XSO *xso = NULL;
2267
2268
0
    if ((xso = OPENSSL_zalloc(sizeof(*xso))) == NULL) {
2269
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
2270
0
        goto err;
2271
0
    }
2272
2273
0
    if (!ossl_quic_obj_init(&xso->obj, qc->obj.ssl.ctx, SSL_TYPE_QUIC_XSO,
2274
0
            &qc->obj.ssl, NULL, NULL)) {
2275
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
2276
0
        goto err;
2277
0
    }
2278
2279
    /* XSO refs QC */
2280
0
    if (!SSL_up_ref(&qc->obj.ssl)) {
2281
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SSL_LIB, NULL);
2282
0
        goto err;
2283
0
    }
2284
2285
0
    xso->conn = qc;
2286
0
    xso->ssl_mode = qc->default_ssl_mode;
2287
0
    xso->ssl_options
2288
0
        = qc->default_ssl_options & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
2289
0
    xso->last_error = SSL_ERROR_NONE;
2290
2291
0
    xso->stream = qs;
2292
2293
0
    ++qc->num_xso;
2294
0
    xso_update_options(xso);
2295
0
    return xso;
2296
2297
0
err:
2298
0
    OPENSSL_free(xso);
2299
0
    return NULL;
2300
0
}
2301
2302
struct quic_new_stream_wait_args {
2303
    QUIC_CONNECTION *qc;
2304
    int is_uni;
2305
};
2306
2307
static int quic_new_stream_wait(void *arg)
2308
0
{
2309
0
    struct quic_new_stream_wait_args *args = arg;
2310
0
    QUIC_CONNECTION *qc = args->qc;
2311
2312
0
    if (!quic_mutation_allowed(qc, /*req_active=*/1))
2313
0
        return -1;
2314
2315
0
    if (ossl_quic_channel_is_new_local_stream_admissible(qc->ch, args->is_uni))
2316
0
        return 1;
2317
2318
0
    return 0;
2319
0
}
2320
2321
/* locking depends on need_lock */
2322
static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock)
2323
0
{
2324
0
    int ret;
2325
0
    QUIC_CONNECTION *qc = ctx->qc;
2326
0
    QUIC_XSO *xso = NULL;
2327
0
    QUIC_STREAM *qs = NULL;
2328
0
    int is_uni = ((flags & SSL_STREAM_FLAG_UNI) != 0);
2329
0
    int no_blocking = ((flags & SSL_STREAM_FLAG_NO_BLOCK) != 0);
2330
0
    int advance = ((flags & SSL_STREAM_FLAG_ADVANCE) != 0);
2331
2332
0
    if (need_lock)
2333
0
        qctx_lock(ctx);
2334
2335
0
    if (!quic_mutation_allowed(qc, /*req_active=*/0)) {
2336
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2337
0
        goto err;
2338
0
    }
2339
2340
0
    if (!advance
2341
0
        && !ossl_quic_channel_is_new_local_stream_admissible(qc->ch, is_uni)) {
2342
0
        struct quic_new_stream_wait_args args;
2343
2344
        /*
2345
         * Stream count flow control currently doesn't permit this stream to be
2346
         * opened.
2347
         */
2348
0
        if (no_blocking || !qctx_blocking(ctx)) {
2349
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_STREAM_COUNT_LIMITED, NULL);
2350
0
            goto err;
2351
0
        }
2352
2353
0
        args.qc = qc;
2354
0
        args.is_uni = is_uni;
2355
2356
        /* Blocking mode - wait until we can get a stream. */
2357
0
        ret = block_until_pred(ctx, quic_new_stream_wait, &args, 0);
2358
0
        if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
2359
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2360
0
            goto err; /* Shutdown before completion */
2361
0
        } else if (ret <= 0) {
2362
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2363
0
            goto err; /* Non-protocol error */
2364
0
        }
2365
0
    }
2366
2367
0
    qs = ossl_quic_channel_new_stream_local(qc->ch, is_uni);
2368
0
    if (qs == NULL) {
2369
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2370
0
        goto err;
2371
0
    }
2372
2373
0
    xso = create_xso_from_stream(qc, qs);
2374
0
    if (xso == NULL)
2375
0
        goto err;
2376
2377
0
    qc_touch_default_xso(qc); /* inhibits default XSO */
2378
0
    if (need_lock)
2379
0
        qctx_unlock(ctx);
2380
2381
0
    return &xso->obj.ssl;
2382
2383
0
err:
2384
0
    OPENSSL_free(xso);
2385
0
    ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc->ch), qs);
2386
0
    if (need_lock)
2387
0
        qctx_unlock(ctx);
2388
2389
0
    return NULL;
2390
0
}
2391
2392
QUIC_TAKES_LOCK
2393
SSL *ossl_quic_conn_stream_new(SSL *s, uint64_t flags)
2394
0
{
2395
0
    QCTX ctx;
2396
2397
0
    if (!expect_quic_conn_only(s, &ctx))
2398
0
        return NULL;
2399
2400
0
    return quic_conn_stream_new(&ctx, flags, /*need_lock=*/1);
2401
0
}
2402
2403
/*
2404
 * QUIC Front-End I/O API: Steady-State Operations
2405
 * ===============================================
2406
 *
2407
 * Here we dispatch calls to the steady-state front-end I/O API functions; that
2408
 * is, the functions used during the established phase of a QUIC connection
2409
 * (e.g. SSL_read, SSL_write).
2410
 *
2411
 * Each function must handle both blocking and non-blocking modes. As discussed
2412
 * above, all QUIC I/O is implemented using non-blocking mode internally.
2413
 *
2414
 *         SSL_get_error        => partially implemented by ossl_quic_get_error
2415
 *         SSL_want             => ossl_quic_want
2416
 *   (BIO/)SSL_read             => ossl_quic_read
2417
 *   (BIO/)SSL_write            => ossl_quic_write
2418
 *         SSL_pending          => ossl_quic_pending
2419
 *         SSL_stream_conclude  => ossl_quic_conn_stream_conclude
2420
 *         SSL_key_update       => ossl_quic_key_update
2421
 */
2422
2423
/* SSL_get_error */
2424
int ossl_quic_get_error(const SSL *s, int i)
2425
0
{
2426
0
    QCTX ctx;
2427
0
    int net_error, last_error;
2428
2429
    /* SSL_get_errors() should not raise new errors */
2430
0
    if (!is_quic_cs(s, &ctx, 0 /* suppress errors */))
2431
0
        return SSL_ERROR_SSL;
2432
2433
0
    qctx_lock(&ctx);
2434
0
    net_error = ossl_quic_channel_net_error(ctx.qc->ch);
2435
0
    last_error = ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error;
2436
0
    qctx_unlock(&ctx);
2437
2438
0
    if (net_error)
2439
0
        return SSL_ERROR_SYSCALL;
2440
2441
0
    return last_error;
2442
0
}
2443
2444
/* Converts a code returned by SSL_get_error to a code returned by SSL_want. */
2445
static int error_to_want(int error)
2446
0
{
2447
0
    switch (error) {
2448
0
    case SSL_ERROR_WANT_CONNECT: /* never used - UDP is connectionless */
2449
0
    case SSL_ERROR_WANT_ACCEPT: /* never used - UDP is connectionless */
2450
0
    case SSL_ERROR_ZERO_RETURN:
2451
0
    default:
2452
0
        return SSL_NOTHING;
2453
2454
0
    case SSL_ERROR_WANT_READ:
2455
0
        return SSL_READING;
2456
2457
0
    case SSL_ERROR_WANT_WRITE:
2458
0
        return SSL_WRITING;
2459
2460
0
    case SSL_ERROR_WANT_RETRY_VERIFY:
2461
0
        return SSL_RETRY_VERIFY;
2462
2463
0
    case SSL_ERROR_WANT_CLIENT_HELLO_CB:
2464
0
        return SSL_CLIENT_HELLO_CB;
2465
2466
0
    case SSL_ERROR_WANT_X509_LOOKUP:
2467
0
        return SSL_X509_LOOKUP;
2468
0
    }
2469
0
}
2470
2471
/* SSL_want */
2472
int ossl_quic_want(const SSL *s)
2473
0
{
2474
0
    QCTX ctx;
2475
0
    int w;
2476
2477
0
    if (!expect_quic_cs(s, &ctx))
2478
0
        return SSL_NOTHING;
2479
2480
0
    qctx_lock(&ctx);
2481
2482
0
    w = error_to_want(ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error);
2483
2484
0
    qctx_unlock(&ctx);
2485
0
    return w;
2486
0
}
2487
2488
/*
2489
 * SSL_write
2490
 * ---------
2491
 *
2492
 * The set of functions below provide the implementation of the public SSL_write
2493
 * function. We must handle:
2494
 *
2495
 *   - both blocking and non-blocking operation at the application level,
2496
 *     depending on how we are configured;
2497
 *
2498
 *   - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
2499
 *
2500
 *   - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
2501
 *
2502
 */
2503
QUIC_NEEDS_LOCK
2504
static void quic_post_write(QUIC_XSO *xso, int did_append,
2505
    int did_append_all, uint64_t flags,
2506
    int do_tick)
2507
0
{
2508
    /*
2509
     * We have appended at least one byte to the stream.
2510
     * Potentially mark stream as active, depending on FC.
2511
     */
2512
0
    if (did_append)
2513
0
        ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso->conn->ch),
2514
0
            xso->stream);
2515
2516
0
    if (did_append_all && (flags & SSL_WRITE_FLAG_CONCLUDE) != 0)
2517
0
        ossl_quic_sstream_fin(xso->stream->sstream);
2518
2519
    /*
2520
     * Try and send.
2521
     *
2522
     * TODO(QUIC FUTURE): It is probably inefficient to try and do this
2523
     * immediately, plus we should eventually consider Nagle's algorithm.
2524
     */
2525
0
    if (do_tick)
2526
0
        ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso->conn->ch), 0);
2527
0
}
2528
2529
struct quic_write_again_args {
2530
    QUIC_XSO *xso;
2531
    const unsigned char *buf;
2532
    size_t len;
2533
    size_t total_written;
2534
    int err;
2535
    uint64_t flags;
2536
};
2537
2538
/*
2539
 * Absolute maximum write buffer size, enforced to prevent a rogue peer from
2540
 * deliberately inducing DoS. This has been chosen based on the optimal buffer
2541
 * size for an RTT of 500ms and a bandwidth of 100 Mb/s.
2542
 */
2543
0
#define MAX_WRITE_BUF_SIZE (6 * 1024 * 1024)
2544
2545
/*
2546
 * Ensure spare buffer space available (up until a limit, at least).
2547
 */
2548
QUIC_NEEDS_LOCK
2549
static int sstream_ensure_spare(QUIC_SSTREAM *sstream, uint64_t spare)
2550
0
{
2551
0
    size_t cur_sz = ossl_quic_sstream_get_buffer_size(sstream);
2552
0
    size_t avail = ossl_quic_sstream_get_buffer_avail(sstream);
2553
0
    size_t spare_ = (spare > SIZE_MAX) ? SIZE_MAX : (size_t)spare;
2554
0
    size_t new_sz, growth;
2555
2556
0
    if (spare_ <= avail || cur_sz == MAX_WRITE_BUF_SIZE)
2557
0
        return 1;
2558
2559
0
    growth = spare_ - avail;
2560
0
    if (cur_sz + growth > MAX_WRITE_BUF_SIZE)
2561
0
        new_sz = MAX_WRITE_BUF_SIZE;
2562
0
    else
2563
0
        new_sz = cur_sz + growth;
2564
2565
0
    return ossl_quic_sstream_set_buffer_size(sstream, new_sz);
2566
0
}
2567
2568
/*
2569
 * Append to a QUIC_STREAM's QUIC_SSTREAM, ensuring buffer space is expanded
2570
 * as needed according to flow control.
2571
 */
2572
QUIC_NEEDS_LOCK
2573
static int xso_sstream_append(QUIC_XSO *xso, const unsigned char *buf,
2574
    size_t len, size_t *actual_written)
2575
0
{
2576
0
    QUIC_SSTREAM *sstream = xso->stream->sstream;
2577
0
    uint64_t cur = ossl_quic_sstream_get_cur_size(sstream);
2578
0
    uint64_t cwm = ossl_quic_txfc_get_cwm(&xso->stream->txfc);
2579
0
    uint64_t permitted = (cwm >= cur ? cwm - cur : 0);
2580
2581
0
    if (len > permitted)
2582
0
        len = (size_t)permitted;
2583
2584
0
    if (!sstream_ensure_spare(sstream, len))
2585
0
        return 0;
2586
2587
0
    return ossl_quic_sstream_append(sstream, buf, len, actual_written);
2588
0
}
2589
2590
QUIC_NEEDS_LOCK
2591
static int quic_write_again(void *arg)
2592
0
{
2593
0
    struct quic_write_again_args *args = arg;
2594
0
    size_t actual_written = 0;
2595
2596
0
    if (!quic_mutation_allowed(args->xso->conn, /*req_active=*/1))
2597
        /* If connection is torn down due to an error while blocking, stop. */
2598
0
        return -2;
2599
2600
0
    if (!quic_validate_for_write(args->xso, &args->err))
2601
        /*
2602
         * Stream may have become invalid for write due to connection events
2603
         * while we blocked.
2604
         */
2605
0
        return -2;
2606
2607
0
    args->err = ERR_R_INTERNAL_ERROR;
2608
0
    if (!xso_sstream_append(args->xso, args->buf, args->len, &actual_written))
2609
0
        return -2;
2610
2611
0
    quic_post_write(args->xso, actual_written > 0,
2612
0
        args->len == actual_written, args->flags, 0);
2613
2614
0
    args->buf += actual_written;
2615
0
    args->len -= actual_written;
2616
0
    args->total_written += actual_written;
2617
2618
0
    if (args->len == 0)
2619
        /* Written everything, done. */
2620
0
        return 1;
2621
2622
    /* Not written everything yet, keep trying. */
2623
0
    return 0;
2624
0
}
2625
2626
QUIC_NEEDS_LOCK
2627
static int quic_write_blocking(QCTX *ctx, const void *buf, size_t len,
2628
    uint64_t flags, size_t *written)
2629
0
{
2630
0
    int res;
2631
0
    QUIC_XSO *xso = ctx->xso;
2632
0
    struct quic_write_again_args args;
2633
0
    size_t actual_written = 0;
2634
2635
    /* First make a best effort to append as much of the data as possible. */
2636
0
    if (!xso_sstream_append(xso, buf, len, &actual_written)) {
2637
        /* Stream already finished or allocation error. */
2638
0
        *written = 0;
2639
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2640
0
    }
2641
2642
0
    quic_post_write(xso, actual_written > 0, actual_written == len, flags, 1);
2643
2644
    /*
2645
     * Record however much data we wrote
2646
     */
2647
0
    *written = actual_written;
2648
2649
0
    if (actual_written == len) {
2650
        /* Managed to append everything on the first try. */
2651
0
        return 1;
2652
0
    }
2653
2654
    /*
2655
     * We did not manage to append all of the data immediately, so the stream
2656
     * buffer has probably filled up. This means we need to block until some of
2657
     * it is freed up.
2658
     */
2659
0
    args.xso = xso;
2660
0
    args.buf = (const unsigned char *)buf + actual_written;
2661
0
    args.len = len - actual_written;
2662
0
    args.total_written = 0;
2663
0
    args.err = ERR_R_INTERNAL_ERROR;
2664
0
    args.flags = flags;
2665
2666
0
    res = block_until_pred(ctx, quic_write_again, &args, 0);
2667
0
    if (res <= 0) {
2668
0
        if (!quic_mutation_allowed(xso->conn, /*req_active=*/1))
2669
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2670
0
        else
2671
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, args.err, NULL);
2672
0
    }
2673
2674
    /*
2675
     * When waiting on extra buffer space to be available, args.total_written
2676
     * holds the amount of remaining data we requested to write, which will be
2677
     * something less than the len parameter passed in, however much we wrote
2678
     * here, add it to the value that we wrote when we initially called
2679
     * xso_sstream_append
2680
     */
2681
0
    *written += args.total_written;
2682
0
    return 1;
2683
0
}
2684
2685
/*
2686
 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
2687
 * write semantics.
2688
 */
2689
static void aon_write_begin(QUIC_XSO *xso, const unsigned char *buf,
2690
    size_t buf_len, size_t already_sent)
2691
0
{
2692
0
    assert(!xso->aon_write_in_progress);
2693
2694
0
    xso->aon_write_in_progress = 1;
2695
0
    xso->aon_buf_base = buf;
2696
0
    xso->aon_buf_pos = already_sent;
2697
0
    xso->aon_buf_len = buf_len;
2698
0
}
2699
2700
static void aon_write_finish(QUIC_XSO *xso)
2701
0
{
2702
0
    xso->aon_write_in_progress = 0;
2703
0
    xso->aon_buf_base = NULL;
2704
0
    xso->aon_buf_pos = 0;
2705
0
    xso->aon_buf_len = 0;
2706
0
}
2707
2708
QUIC_NEEDS_LOCK
2709
static int quic_write_nonblocking_aon(QCTX *ctx, const void *buf,
2710
    size_t len, uint64_t flags,
2711
    size_t *written)
2712
0
{
2713
0
    QUIC_XSO *xso = ctx->xso;
2714
0
    const void *actual_buf;
2715
0
    size_t actual_len, actual_written = 0;
2716
0
    int accept_moving_buffer
2717
0
        = ((xso->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
2718
2719
0
    if (xso->aon_write_in_progress) {
2720
        /*
2721
         * We are in the middle of an AON write (i.e., a previous write did not
2722
         * manage to append all data to the SSTREAM and we have Enable Partial
2723
         * Write (EPW) mode disabled.)
2724
         */
2725
0
        if ((!accept_moving_buffer && xso->aon_buf_base != buf)
2726
0
            || len != xso->aon_buf_len)
2727
            /*
2728
             * Pointer must not have changed if we are not in accept moving
2729
             * buffer mode. Length must never change.
2730
             */
2731
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BAD_WRITE_RETRY, NULL);
2732
2733
0
        actual_buf = (unsigned char *)buf + xso->aon_buf_pos;
2734
0
        actual_len = len - xso->aon_buf_pos;
2735
0
        assert(actual_len > 0);
2736
0
    } else {
2737
0
        actual_buf = buf;
2738
0
        actual_len = len;
2739
0
    }
2740
2741
    /* First make a best effort to append as much of the data as possible. */
2742
0
    if (!xso_sstream_append(xso, actual_buf, actual_len, &actual_written)) {
2743
        /* Stream already finished or allocation error. */
2744
0
        *written = 0;
2745
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2746
0
    }
2747
2748
0
    quic_post_write(xso, actual_written > 0, actual_written == actual_len,
2749
0
        flags, qctx_should_autotick(ctx));
2750
2751
0
    if (actual_written == actual_len) {
2752
        /* We have sent everything. */
2753
0
        if (xso->aon_write_in_progress) {
2754
            /*
2755
             * We have sent everything, and we were in the middle of an AON
2756
             * write. The output write length is the total length of the AON
2757
             * buffer, not however many bytes we managed to write to the stream
2758
             * in this call.
2759
             */
2760
0
            *written = xso->aon_buf_len;
2761
0
            aon_write_finish(xso);
2762
0
        } else {
2763
0
            *written = actual_written;
2764
0
        }
2765
2766
0
        return 1;
2767
0
    }
2768
2769
0
    if (xso->aon_write_in_progress) {
2770
        /*
2771
         * AON write is in progress but we have not written everything yet. We
2772
         * may have managed to send zero bytes, or some number of bytes less
2773
         * than the total remaining which need to be appended during this
2774
         * AON operation.
2775
         */
2776
0
        xso->aon_buf_pos += actual_written;
2777
0
        assert(xso->aon_buf_pos < xso->aon_buf_len);
2778
0
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2779
0
    }
2780
2781
    /*
2782
     * Not in an existing AON operation but partial write is not enabled, so we
2783
     * need to begin a new AON operation. However we needn't bother if we didn't
2784
     * actually append anything.
2785
     */
2786
0
    if (actual_written > 0)
2787
0
        aon_write_begin(xso, buf, len, actual_written);
2788
2789
    /*
2790
     * AON - We do not publicly admit to having appended anything until AON
2791
     * completes.
2792
     */
2793
0
    *written = 0;
2794
0
    return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2795
0
}
2796
2797
QUIC_NEEDS_LOCK
2798
static int quic_write_nonblocking_epw(QCTX *ctx, const void *buf, size_t len,
2799
    uint64_t flags, size_t *written)
2800
0
{
2801
0
    QUIC_XSO *xso = ctx->xso;
2802
2803
    /* Simple best effort operation. */
2804
0
    if (!xso_sstream_append(xso, buf, len, written)) {
2805
        /* Stream already finished or allocation error. */
2806
0
        *written = 0;
2807
0
        return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2808
0
    }
2809
2810
0
    quic_post_write(xso, *written > 0, *written == len, flags,
2811
0
        qctx_should_autotick(ctx));
2812
2813
0
    if (*written == 0)
2814
        /* SSL_write_ex returns 0 if it didn't write anything. */
2815
0
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2816
2817
0
    return 1;
2818
0
}
2819
2820
QUIC_NEEDS_LOCK
2821
static int quic_validate_for_write(QUIC_XSO *xso, int *err)
2822
0
{
2823
0
    QUIC_STREAM_MAP *qsm;
2824
2825
0
    if (xso == NULL || xso->stream == NULL) {
2826
0
        *err = ERR_R_INTERNAL_ERROR;
2827
0
        return 0;
2828
0
    }
2829
2830
0
    switch (xso->stream->send_state) {
2831
0
    default:
2832
0
    case QUIC_SSTREAM_STATE_NONE:
2833
0
        *err = SSL_R_STREAM_RECV_ONLY;
2834
0
        return 0;
2835
2836
0
    case QUIC_SSTREAM_STATE_READY:
2837
0
        qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2838
2839
0
        if (!ossl_quic_stream_map_ensure_send_part_id(qsm, xso->stream)) {
2840
0
            *err = ERR_R_INTERNAL_ERROR;
2841
0
            return 0;
2842
0
        }
2843
2844
        /* FALLTHROUGH */
2845
0
    case QUIC_SSTREAM_STATE_SEND:
2846
0
    case QUIC_SSTREAM_STATE_DATA_SENT:
2847
0
        if (ossl_quic_sstream_get_final_size(xso->stream->sstream, NULL)) {
2848
0
            *err = SSL_R_STREAM_FINISHED;
2849
0
            return 0;
2850
0
        }
2851
0
        return 1;
2852
2853
0
    case QUIC_SSTREAM_STATE_DATA_RECVD:
2854
0
        *err = SSL_R_STREAM_FINISHED;
2855
0
        return 0;
2856
2857
0
    case QUIC_SSTREAM_STATE_RESET_SENT:
2858
0
    case QUIC_SSTREAM_STATE_RESET_RECVD:
2859
0
        *err = SSL_R_STREAM_RESET;
2860
0
        return 0;
2861
0
    }
2862
0
}
2863
2864
QUIC_TAKES_LOCK
2865
int ossl_quic_write_flags(SSL *s, const void *buf, size_t len,
2866
    uint64_t flags, size_t *written)
2867
0
{
2868
0
    int ret;
2869
0
    QCTX ctx;
2870
0
    int partial_write, err;
2871
2872
0
    *written = 0;
2873
2874
0
    if (len == 0) {
2875
        /* Do not autocreate default XSO for zero-length writes. */
2876
0
        if (!expect_quic_cs(s, &ctx))
2877
0
            return 0;
2878
2879
0
        qctx_lock_for_io(&ctx);
2880
0
    } else {
2881
0
        if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/1, &ctx))
2882
0
            return 0;
2883
0
    }
2884
2885
0
    partial_write = ((ctx.xso != NULL)
2886
0
            ? ((ctx.xso->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0)
2887
0
            : 0);
2888
2889
0
    if ((flags & ~SSL_WRITE_FLAG_CONCLUDE) != 0) {
2890
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_UNSUPPORTED_WRITE_FLAG, NULL);
2891
0
        goto out;
2892
0
    }
2893
2894
0
    if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
2895
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2896
0
        goto out;
2897
0
    }
2898
2899
    /*
2900
     * If we haven't finished the handshake, try to advance it.
2901
     * We don't accept writes until the handshake is completed.
2902
     */
2903
0
    if (quic_do_handshake(&ctx) < 1) {
2904
0
        ret = 0;
2905
0
        goto out;
2906
0
    }
2907
2908
    /* Ensure correct stream state, stream send part not concluded, etc. */
2909
0
    if (len > 0 && !quic_validate_for_write(ctx.xso, &err)) {
2910
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
2911
0
        goto out;
2912
0
    }
2913
2914
0
    if (len == 0) {
2915
0
        if ((flags & SSL_WRITE_FLAG_CONCLUDE) != 0)
2916
0
            quic_post_write(ctx.xso, 0, 1, flags,
2917
0
                qctx_should_autotick(&ctx));
2918
2919
0
        ret = 1;
2920
0
        goto out;
2921
0
    }
2922
2923
0
    if (qctx_blocking(&ctx))
2924
0
        ret = quic_write_blocking(&ctx, buf, len, flags, written);
2925
0
    else if (partial_write)
2926
0
        ret = quic_write_nonblocking_epw(&ctx, buf, len, flags, written);
2927
0
    else
2928
0
        ret = quic_write_nonblocking_aon(&ctx, buf, len, flags, written);
2929
2930
0
out:
2931
0
    qctx_unlock(&ctx);
2932
0
    return ret;
2933
0
}
2934
2935
QUIC_TAKES_LOCK
2936
int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
2937
0
{
2938
0
    return ossl_quic_write_flags(s, buf, len, 0, written);
2939
0
}
2940
2941
/*
2942
 * SSL_read
2943
 * --------
2944
 */
2945
struct quic_read_again_args {
2946
    QCTX *ctx;
2947
    QUIC_STREAM *stream;
2948
    void *buf;
2949
    size_t len;
2950
    size_t *bytes_read;
2951
    int peek;
2952
};
2953
2954
QUIC_NEEDS_LOCK
2955
static int quic_validate_for_read(QUIC_XSO *xso, int *err, int *eos)
2956
0
{
2957
0
    QUIC_STREAM_MAP *qsm;
2958
2959
0
    *eos = 0;
2960
2961
0
    if (xso == NULL || xso->stream == NULL) {
2962
0
        *err = ERR_R_INTERNAL_ERROR;
2963
0
        return 0;
2964
0
    }
2965
2966
0
    switch (xso->stream->recv_state) {
2967
0
    default:
2968
0
    case QUIC_RSTREAM_STATE_NONE:
2969
0
        *err = SSL_R_STREAM_SEND_ONLY;
2970
0
        return 0;
2971
2972
0
    case QUIC_RSTREAM_STATE_RECV:
2973
0
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
2974
0
    case QUIC_RSTREAM_STATE_DATA_RECVD:
2975
0
        return 1;
2976
2977
0
    case QUIC_RSTREAM_STATE_DATA_READ:
2978
0
        *eos = 1;
2979
0
        return 0;
2980
2981
0
    case QUIC_RSTREAM_STATE_RESET_RECVD:
2982
0
        qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2983
0
        ossl_quic_stream_map_notify_app_read_reset_recv_part(qsm, xso->stream);
2984
2985
        /* FALLTHROUGH */
2986
0
    case QUIC_RSTREAM_STATE_RESET_READ:
2987
0
        *err = SSL_R_STREAM_RESET;
2988
0
        return 0;
2989
0
    }
2990
0
}
2991
2992
QUIC_NEEDS_LOCK
2993
static int quic_read_actual(QCTX *ctx,
2994
    QUIC_STREAM *stream,
2995
    void *buf, size_t buf_len,
2996
    size_t *bytes_read,
2997
    int peek)
2998
0
{
2999
0
    int is_fin = 0, err, eos;
3000
0
    QUIC_CONNECTION *qc = ctx->qc;
3001
3002
0
    if (!quic_validate_for_read(ctx->xso, &err, &eos)) {
3003
0
        if (eos) {
3004
0
            ctx->xso->retired_fin = 1;
3005
0
            return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
3006
0
        } else {
3007
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, err, NULL);
3008
0
        }
3009
0
    }
3010
3011
0
    if (peek) {
3012
0
        if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
3013
0
                bytes_read, &is_fin))
3014
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
3015
3016
0
    } else {
3017
0
        if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
3018
0
                bytes_read, &is_fin))
3019
0
            return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
3020
0
    }
3021
3022
0
    if (!peek) {
3023
0
        if (*bytes_read > 0) {
3024
            /*
3025
             * We have read at least one byte from the stream. Inform stream-level
3026
             * RXFC of the retirement of controlled bytes. Update the active stream
3027
             * status (the RXFC may now want to emit a frame granting more credit to
3028
             * the peer).
3029
             */
3030
0
            OSSL_RTT_INFO rtt_info;
3031
3032
0
            ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
3033
3034
0
            if (!ossl_quic_rxfc_on_retire(&stream->rxfc, *bytes_read,
3035
0
                    rtt_info.smoothed_rtt))
3036
0
                return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
3037
0
        }
3038
3039
0
        if (is_fin && !peek) {
3040
0
            QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(ctx->qc->ch);
3041
3042
0
            ossl_quic_stream_map_notify_totally_read(qsm, ctx->xso->stream);
3043
0
        }
3044
3045
0
        if (*bytes_read > 0)
3046
0
            ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
3047
0
                stream);
3048
0
    }
3049
3050
0
    if (*bytes_read == 0 && is_fin) {
3051
0
        ctx->xso->retired_fin = 1;
3052
0
        return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
3053
0
    }
3054
3055
0
    return 1;
3056
0
}
3057
3058
QUIC_NEEDS_LOCK
3059
static int quic_read_again(void *arg)
3060
0
{
3061
0
    struct quic_read_again_args *args = arg;
3062
3063
0
    if (!quic_mutation_allowed(args->ctx->qc, /*req_active=*/1)) {
3064
        /* If connection is torn down due to an error while blocking, stop. */
3065
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
3066
0
        return -1;
3067
0
    }
3068
3069
0
    if (!quic_read_actual(args->ctx, args->stream,
3070
0
            args->buf, args->len, args->bytes_read,
3071
0
            args->peek))
3072
0
        return -1;
3073
3074
0
    if (*args->bytes_read > 0)
3075
        /* got at least one byte, the SSL_read op can finish now */
3076
0
        return 1;
3077
3078
0
    return 0; /* did not read anything, keep trying */
3079
0
}
3080
3081
QUIC_TAKES_LOCK
3082
static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
3083
0
{
3084
0
    int ret, res;
3085
0
    QCTX ctx;
3086
0
    struct quic_read_again_args args;
3087
3088
0
    *bytes_read = 0;
3089
3090
0
    if (!expect_quic_cs(s, &ctx))
3091
0
        return 0;
3092
3093
0
    qctx_lock_for_io(&ctx);
3094
3095
    /* If we haven't finished the handshake, try to advance it. */
3096
0
    if (quic_do_handshake(&ctx) < 1) {
3097
0
        ret = 0; /* ossl_quic_do_handshake raised error here */
3098
0
        goto out;
3099
0
    }
3100
3101
0
    if (ctx.xso == NULL) {
3102
        /*
3103
         * Called on a QCSO and we don't currently have a default stream.
3104
         *
3105
         * Wait until we get a stream initiated by the peer (blocking mode) or
3106
         * fail if we don't have one yet (non-blocking mode).
3107
         */
3108
0
        if (!qc_wait_for_default_xso_for_read(&ctx, /*peek=*/0)) {
3109
0
            ret = 0; /* error already raised here */
3110
0
            goto out;
3111
0
        }
3112
3113
0
        ctx.xso = ctx.qc->default_xso;
3114
0
    }
3115
3116
0
    if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
3117
0
        ret = 0; /* quic_read_actual raised error here */
3118
0
        goto out;
3119
0
    }
3120
3121
0
    if (*bytes_read > 0) {
3122
        /*
3123
         * Even though we succeeded, tick the reactor here to ensure we are
3124
         * handling other aspects of the QUIC connection.
3125
         */
3126
0
        if (quic_mutation_allowed(ctx.qc, /*req_active=*/0))
3127
0
            qctx_maybe_autotick(&ctx);
3128
3129
0
        ret = 1;
3130
0
    } else if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
3131
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
3132
0
        goto out;
3133
0
    } else if (qctx_blocking(&ctx)) {
3134
        /*
3135
         * We were not able to read anything immediately, so our stream
3136
         * buffer is empty. This means we need to block until we get
3137
         * at least one byte.
3138
         */
3139
0
        args.ctx = &ctx;
3140
0
        args.stream = ctx.xso->stream;
3141
0
        args.buf = buf;
3142
0
        args.len = len;
3143
0
        args.bytes_read = bytes_read;
3144
0
        args.peek = peek;
3145
3146
0
        res = block_until_pred(&ctx, quic_read_again, &args, 0);
3147
0
        if (res == 0) {
3148
0
            ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3149
0
            goto out;
3150
0
        } else if (res < 0) {
3151
0
            ret = 0; /* quic_read_again raised error here */
3152
0
            goto out;
3153
0
        }
3154
3155
0
        ret = 1;
3156
0
    } else {
3157
        /*
3158
         * We did not get any bytes and are not in blocking mode.
3159
         * Tick to see if this delivers any more.
3160
         */
3161
0
        qctx_maybe_autotick(&ctx);
3162
3163
        /* Try the read again. */
3164
0
        if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
3165
0
            ret = 0; /* quic_read_actual raised error here */
3166
0
            goto out;
3167
0
        }
3168
3169
0
        if (*bytes_read > 0)
3170
0
            ret = 1; /* Succeeded this time. */
3171
0
        else
3172
0
            ret = QUIC_RAISE_NORMAL_ERROR(&ctx, SSL_ERROR_WANT_READ);
3173
0
    }
3174
3175
0
out:
3176
0
    qctx_unlock(&ctx);
3177
0
    return ret;
3178
0
}
3179
3180
int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
3181
0
{
3182
0
    return quic_read(s, buf, len, bytes_read, 0);
3183
0
}
3184
3185
int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
3186
0
{
3187
0
    return quic_read(s, buf, len, bytes_read, 1);
3188
0
}
3189
3190
/*
3191
 * SSL_pending
3192
 * -----------
3193
 */
3194
3195
QUIC_TAKES_LOCK
3196
static size_t ossl_quic_pending_int(const SSL *s, int check_channel)
3197
0
{
3198
0
    QCTX ctx;
3199
0
    size_t avail = 0;
3200
3201
0
    if (!expect_quic_cs(s, &ctx))
3202
0
        return 0;
3203
3204
0
    qctx_lock(&ctx);
3205
3206
0
    if (!ctx.qc->started)
3207
0
        goto out;
3208
3209
0
    if (ctx.xso == NULL) {
3210
        /* No XSO yet, but there might be a default XSO eligible to be created. */
3211
0
        if (qc_wait_for_default_xso_for_read(&ctx, /*peek=*/1)) {
3212
0
            ctx.xso = ctx.qc->default_xso;
3213
0
        } else {
3214
0
            QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_NO_STREAM, NULL);
3215
0
            goto out;
3216
0
        }
3217
0
    }
3218
3219
0
    if (ctx.xso->stream == NULL) {
3220
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3221
0
        goto out;
3222
0
    }
3223
3224
0
    if (check_channel)
3225
        /* We care about boolean result here only */
3226
0
        avail = ossl_quic_stream_recv_pending(ctx.xso->stream,
3227
0
                    /*include_fin=*/1)
3228
0
                > 0
3229
0
            || ossl_quic_channel_has_pending(ctx.qc->ch)
3230
0
            || ossl_quic_channel_is_term_any(ctx.qc->ch);
3231
0
    else
3232
0
        avail = ossl_quic_stream_recv_pending(ctx.xso->stream,
3233
0
            /*include_fin=*/0);
3234
3235
0
out:
3236
0
    qctx_unlock(&ctx);
3237
0
    return avail;
3238
0
}
3239
3240
size_t ossl_quic_pending(const SSL *s)
3241
0
{
3242
0
    return ossl_quic_pending_int(s, /*check_channel=*/0);
3243
0
}
3244
3245
int ossl_quic_has_pending(const SSL *s)
3246
0
{
3247
    /* Do we have app-side pending data or pending URXEs or RXEs? */
3248
0
    return ossl_quic_pending_int(s, /*check_channel=*/1) > 0;
3249
0
}
3250
3251
/*
3252
 * SSL_stream_conclude
3253
 * -------------------
3254
 */
3255
QUIC_TAKES_LOCK
3256
int ossl_quic_conn_stream_conclude(SSL *s)
3257
0
{
3258
0
    QCTX ctx;
3259
0
    QUIC_STREAM *qs;
3260
0
    int err;
3261
0
    int ret;
3262
3263
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/0, &ctx))
3264
0
        return 0;
3265
3266
0
    qs = ctx.xso->stream;
3267
3268
0
    if (!quic_mutation_allowed(ctx.qc, /*req_active=*/1)) {
3269
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
3270
0
        qctx_unlock(&ctx);
3271
0
        return ret;
3272
0
    }
3273
3274
0
    if (!quic_validate_for_write(ctx.xso, &err)) {
3275
0
        ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
3276
0
        qctx_unlock(&ctx);
3277
0
        return ret;
3278
0
    }
3279
3280
0
    if (ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
3281
0
        qctx_unlock(&ctx);
3282
0
        return 1;
3283
0
    }
3284
3285
0
    ossl_quic_sstream_fin(qs->sstream);
3286
0
    quic_post_write(ctx.xso, 1, 0, 0, qctx_should_autotick(&ctx));
3287
0
    qctx_unlock(&ctx);
3288
0
    return 1;
3289
0
}
3290
3291
/*
3292
 * SSL_inject_net_dgram
3293
 * --------------------
3294
 */
3295
QUIC_TAKES_LOCK
3296
int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
3297
    size_t buf_len,
3298
    const BIO_ADDR *peer,
3299
    const BIO_ADDR *local)
3300
0
{
3301
0
    int ret = 0;
3302
0
    QCTX ctx;
3303
0
    QUIC_DEMUX *demux;
3304
0
    QUIC_PORT *port;
3305
3306
0
    if (!expect_quic_csl(s, &ctx))
3307
0
        return 0;
3308
3309
0
    qctx_lock(&ctx);
3310
3311
0
    port = ossl_quic_obj_get0_port(ctx.obj);
3312
0
    if (port == NULL) {
3313
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
3314
0
        goto err;
3315
0
    }
3316
3317
0
    demux = ossl_quic_port_get0_demux(port);
3318
0
    ret = ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
3319
3320
0
err:
3321
0
    qctx_unlock(&ctx);
3322
0
    return ret;
3323
0
}
3324
3325
/*
3326
 * SSL_get0_connection
3327
 * -------------------
3328
 */
3329
SSL *ossl_quic_get0_connection(SSL *s)
3330
0
{
3331
0
    QCTX ctx;
3332
3333
0
    if (!expect_quic_cs(s, &ctx))
3334
0
        return NULL;
3335
3336
0
    return &ctx.qc->obj.ssl;
3337
0
}
3338
3339
/*
3340
 * SSL_get0_listener
3341
 * -----------------
3342
 */
3343
SSL *ossl_quic_get0_listener(SSL *s)
3344
0
{
3345
0
    QCTX ctx;
3346
3347
0
    if (!expect_quic_csl(s, &ctx))
3348
0
        return NULL;
3349
3350
0
    return ctx.ql != NULL ? &ctx.ql->obj.ssl : NULL;
3351
0
}
3352
3353
/*
3354
 * SSL_get0_domain
3355
 * ---------------
3356
 */
3357
SSL *ossl_quic_get0_domain(SSL *s)
3358
0
{
3359
0
    QCTX ctx;
3360
3361
0
    if (!expect_quic_any(s, &ctx))
3362
0
        return NULL;
3363
3364
0
    return ctx.qd != NULL ? &ctx.qd->obj.ssl : NULL;
3365
0
}
3366
3367
/*
3368
 * SSL_get_domain_flags
3369
 * --------------------
3370
 */
3371
int ossl_quic_get_domain_flags(const SSL *ssl, uint64_t *domain_flags)
3372
0
{
3373
0
    QCTX ctx;
3374
3375
0
    if (!expect_quic_any(ssl, &ctx))
3376
0
        return 0;
3377
3378
0
    if (domain_flags != NULL)
3379
0
        *domain_flags = ctx.obj->domain_flags;
3380
3381
0
    return 1;
3382
0
}
3383
3384
/*
3385
 * SSL_get_stream_type
3386
 * -------------------
3387
 */
3388
int ossl_quic_get_stream_type(SSL *s)
3389
0
{
3390
0
    QCTX ctx;
3391
3392
0
    if (!expect_quic_cs(s, &ctx))
3393
0
        return SSL_STREAM_TYPE_BIDI;
3394
3395
0
    if (ctx.xso == NULL) {
3396
        /*
3397
         * If deferred XSO creation has yet to occur, proceed according to the
3398
         * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
3399
         * what kind of stream will be created yet, so return BIDI on the basis
3400
         * that at this time, the client still has the option of calling
3401
         * SSL_read() or SSL_write() first.
3402
         */
3403
0
        if (ctx.qc->default_xso_created
3404
0
            || ctx.qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
3405
0
            return SSL_STREAM_TYPE_NONE;
3406
0
        else
3407
0
            return SSL_STREAM_TYPE_BIDI;
3408
0
    }
3409
3410
0
    if (ossl_quic_stream_is_bidi(ctx.xso->stream))
3411
0
        return SSL_STREAM_TYPE_BIDI;
3412
3413
0
    if (ossl_quic_stream_is_server_init(ctx.xso->stream) != ctx.qc->as_server)
3414
0
        return SSL_STREAM_TYPE_READ;
3415
0
    else
3416
0
        return SSL_STREAM_TYPE_WRITE;
3417
0
}
3418
3419
/*
3420
 * SSL_get_stream_id
3421
 * -----------------
3422
 */
3423
QUIC_TAKES_LOCK
3424
uint64_t ossl_quic_get_stream_id(SSL *s)
3425
0
{
3426
0
    QCTX ctx;
3427
0
    uint64_t id;
3428
3429
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
3430
0
        return UINT64_MAX;
3431
3432
0
    id = ctx.xso->stream->id;
3433
0
    qctx_unlock(&ctx);
3434
3435
0
    return id;
3436
0
}
3437
3438
/*
3439
 * SSL_is_stream_local
3440
 * -------------------
3441
 */
3442
QUIC_TAKES_LOCK
3443
int ossl_quic_is_stream_local(SSL *s)
3444
0
{
3445
0
    QCTX ctx;
3446
0
    int is_local;
3447
3448
0
    if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
3449
0
        return -1;
3450
3451
0
    is_local = ossl_quic_stream_is_local_init(ctx.xso->stream);
3452
0
    qctx_unlock(&ctx);
3453
3454
0
    return is_local;
3455
0
}
3456
3457
/*
3458
 * SSL_set_default_stream_mode
3459
 * ---------------------------
3460
 */
3461
QUIC_TAKES_LOCK
3462
int ossl_quic_set_default_stream_mode(SSL *s, uint32_t mode)
3463
0
{
3464
0
    QCTX ctx;
3465
3466
0
    if (!expect_quic_conn_only(s, &ctx))
3467
0
        return 0;
3468
3469
0
    qctx_lock(&ctx);
3470
3471
0
    if (ctx.qc->default_xso_created) {
3472
0
        qctx_unlock(&ctx);
3473
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
3474
0
            "too late to change default stream mode");
3475
0
    }
3476
3477
0
    switch (mode) {
3478
0
    case SSL_DEFAULT_STREAM_MODE_NONE:
3479
0
    case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI:
3480
0
    case SSL_DEFAULT_STREAM_MODE_AUTO_UNI:
3481
0
        ctx.qc->default_stream_mode = mode;
3482
0
        break;
3483
0
    default:
3484
0
        qctx_unlock(&ctx);
3485
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3486
0
            "bad default stream type");
3487
0
    }
3488
3489
0
    qctx_unlock(&ctx);
3490
0
    return 1;
3491
0
}
3492
3493
/*
3494
 * SSL_set_incoming_stream_policy
3495
 * ------------------------------
3496
 */
3497
QUIC_NEEDS_LOCK
3498
static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION *qc)
3499
0
{
3500
0
    switch (qc->incoming_stream_policy) {
3501
0
    case SSL_INCOMING_STREAM_POLICY_AUTO:
3502
0
        if ((qc->default_xso == NULL && !qc->default_xso_created)
3503
0
            || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
3504
0
            return SSL_INCOMING_STREAM_POLICY_ACCEPT;
3505
0
        else
3506
0
            return SSL_INCOMING_STREAM_POLICY_REJECT;
3507
3508
0
    default:
3509
0
        return qc->incoming_stream_policy;
3510
0
    }
3511
0
}
3512
3513
QUIC_NEEDS_LOCK
3514
static void qc_update_reject_policy(QUIC_CONNECTION *qc)
3515
0
{
3516
0
    int policy = qc_get_effective_incoming_stream_policy(qc);
3517
0
    int enable_reject = (policy == SSL_INCOMING_STREAM_POLICY_REJECT);
3518
3519
0
    ossl_quic_channel_set_incoming_stream_auto_reject(qc->ch,
3520
0
        enable_reject,
3521
0
        qc->incoming_stream_aec);
3522
0
}
3523
3524
QUIC_TAKES_LOCK
3525
int ossl_quic_set_incoming_stream_policy(SSL *s, int policy,
3526
    uint64_t aec)
3527
0
{
3528
0
    int ret = 1;
3529
0
    QCTX ctx;
3530
3531
0
    if (!expect_quic_conn_only(s, &ctx))
3532
0
        return 0;
3533
3534
0
    qctx_lock(&ctx);
3535
3536
0
    switch (policy) {
3537
0
    case SSL_INCOMING_STREAM_POLICY_AUTO:
3538
0
    case SSL_INCOMING_STREAM_POLICY_ACCEPT:
3539
0
    case SSL_INCOMING_STREAM_POLICY_REJECT:
3540
0
        ctx.qc->incoming_stream_policy = policy;
3541
0
        ctx.qc->incoming_stream_aec = aec;
3542
0
        break;
3543
3544
0
    default:
3545
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3546
0
        ret = 0;
3547
0
        break;
3548
0
    }
3549
3550
0
    qc_update_reject_policy(ctx.qc);
3551
0
    qctx_unlock(&ctx);
3552
0
    return ret;
3553
0
}
3554
3555
/*
3556
 * SSL_get_value, SSL_set_value
3557
 * ----------------------------
3558
 */
3559
QUIC_TAKES_LOCK
3560
static int qc_getset_idle_timeout(QCTX *ctx, uint32_t class_,
3561
    uint64_t *p_value_out, uint64_t *p_value_in)
3562
0
{
3563
0
    int ret = 0;
3564
0
    uint64_t value_out = 0, value_in;
3565
3566
0
    qctx_lock(ctx);
3567
3568
0
    switch (class_) {
3569
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3570
0
        value_out = ctx->is_listener
3571
0
            ? ossl_quic_port_get_max_idle_timeout(ctx->ql->port)
3572
0
            : ossl_quic_channel_get_max_idle_timeout_request(ctx->qc->ch);
3573
3574
0
        if (p_value_in != NULL) {
3575
0
            value_in = *p_value_in;
3576
0
            if (value_in > OSSL_QUIC_VLINT_MAX) {
3577
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3578
0
                    NULL);
3579
0
                goto err;
3580
0
            }
3581
3582
0
            if (ctx->is_listener) {
3583
0
                ossl_quic_port_set_max_idle_timeout(ctx->ql->port, value_in);
3584
0
            } else {
3585
0
                if (!ossl_quic_channel_set_max_idle_timeout_request(ctx->qc->ch, value_in)) {
3586
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3587
0
                        NULL);
3588
0
                    goto err;
3589
0
                }
3590
0
            }
3591
0
        }
3592
0
        break;
3593
3594
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3595
0
    case SSL_VALUE_CLASS_FEATURE_NEGOTIATED:
3596
0
        if (p_value_in != NULL) {
3597
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3598
0
                NULL);
3599
0
            goto err;
3600
0
        }
3601
3602
0
        if (ctx->is_listener) {
3603
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3604
0
                NULL);
3605
0
            goto err;
3606
0
        }
3607
3608
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3609
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3610
0
                NULL);
3611
0
            goto err;
3612
0
        }
3613
3614
0
        value_out = (class_ == SSL_VALUE_CLASS_FEATURE_NEGOTIATED)
3615
0
            ? ossl_quic_channel_get_max_idle_timeout_actual(ctx->qc->ch)
3616
0
            : ossl_quic_channel_get_max_idle_timeout_peer_request(ctx->qc->ch);
3617
0
        break;
3618
3619
0
    default:
3620
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3621
0
            NULL);
3622
0
        goto err;
3623
0
    }
3624
3625
0
    ret = 1;
3626
0
err:
3627
0
    qctx_unlock(ctx);
3628
0
    if (ret && p_value_out != NULL)
3629
0
        *p_value_out = value_out;
3630
3631
0
    return ret;
3632
0
}
3633
3634
QUIC_TAKES_LOCK
3635
static int qc_getset_max_udp_payload_size(QCTX *ctx, uint32_t class_,
3636
    uint64_t *p_value_out, uint64_t *p_value_in)
3637
0
{
3638
0
    int ret = 0;
3639
0
    uint64_t value_out = 0, value_in;
3640
3641
0
    qctx_lock(ctx);
3642
3643
0
    switch (class_) {
3644
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3645
0
        value_out = ctx->is_listener
3646
0
            ? ossl_quic_port_get_max_udp_payload_size(ctx->ql->port)
3647
0
            : ossl_quic_channel_get_max_udp_payload_size_request(ctx->qc->ch);
3648
3649
0
        if (p_value_in != NULL) {
3650
0
            value_in = *p_value_in;
3651
0
            if (value_in > QUIC_DEFAULT_MAX_UDP_PAYLOAD_SIZE || value_in < QUIC_MIN_INITIAL_DGRAM_LEN) {
3652
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3653
0
                    NULL);
3654
0
                goto err;
3655
0
            }
3656
3657
0
            if (ctx->is_listener) {
3658
0
                ossl_quic_port_set_max_udp_payload_size(ctx->ql->port, value_in);
3659
0
            } else {
3660
0
                if (!ossl_quic_channel_set_max_udp_payload_size_request(ctx->qc->ch, value_in)) {
3661
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3662
0
                        NULL);
3663
0
                    goto err;
3664
0
                }
3665
0
            }
3666
0
        }
3667
0
        break;
3668
3669
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3670
0
        if (p_value_in != NULL) {
3671
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3672
0
                NULL);
3673
0
            goto err;
3674
0
        }
3675
3676
0
        if (ctx->is_listener) {
3677
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3678
0
                NULL);
3679
0
            goto err;
3680
0
        }
3681
3682
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3683
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3684
0
                NULL);
3685
0
            goto err;
3686
0
        }
3687
3688
0
        value_out = ossl_quic_channel_get_max_udp_payload_size_peer_request(ctx->qc->ch);
3689
0
        break;
3690
3691
0
    default:
3692
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3693
0
            NULL);
3694
0
        goto err;
3695
0
    }
3696
3697
0
    ret = 1;
3698
0
err:
3699
0
    qctx_unlock(ctx);
3700
0
    if (ret && p_value_out != NULL)
3701
0
        *p_value_out = value_out;
3702
3703
0
    return ret;
3704
0
}
3705
3706
QUIC_TAKES_LOCK
3707
static int qc_getset_max_data(QCTX *ctx, uint32_t class_,
3708
    uint64_t *p_value_out, uint64_t *p_value_in)
3709
0
{
3710
0
    int ret = 0;
3711
0
    uint64_t value_out = 0, value_in;
3712
3713
0
    qctx_lock(ctx);
3714
3715
0
    switch (class_) {
3716
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3717
0
        value_out = ctx->is_listener
3718
0
            ? ossl_quic_port_get_init_max_data(ctx->ql->port)
3719
0
            : ossl_quic_channel_get_max_data_request(ctx->qc->ch);
3720
3721
0
        if (p_value_in != NULL) {
3722
0
            value_in = *p_value_in;
3723
0
            if (value_in > OSSL_QUIC_VLINT_MAX) {
3724
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3725
0
                    NULL);
3726
0
                goto err;
3727
0
            }
3728
3729
0
            if (ctx->is_listener) {
3730
0
                ossl_quic_port_set_init_max_data(ctx->ql->port, value_in);
3731
0
            } else {
3732
0
                if (!ossl_quic_channel_set_max_data_request(ctx->qc->ch, value_in)) {
3733
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3734
0
                        NULL);
3735
0
                    goto err;
3736
0
                }
3737
0
            }
3738
0
        }
3739
0
        break;
3740
3741
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3742
0
        if (p_value_in != NULL) {
3743
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3744
0
                NULL);
3745
0
            goto err;
3746
0
        }
3747
3748
0
        if (ctx->is_listener) {
3749
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3750
0
                NULL);
3751
0
            goto err;
3752
0
        }
3753
3754
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3755
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3756
0
                NULL);
3757
0
            goto err;
3758
0
        }
3759
3760
0
        value_out = ossl_quic_channel_get_max_data_peer_request(ctx->qc->ch);
3761
0
        break;
3762
3763
0
    default:
3764
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3765
0
            NULL);
3766
0
        goto err;
3767
0
    }
3768
3769
0
    ret = 1;
3770
0
err:
3771
0
    qctx_unlock(ctx);
3772
0
    if (ret && p_value_out != NULL)
3773
0
        *p_value_out = value_out;
3774
3775
0
    return ret;
3776
0
}
3777
3778
QUIC_TAKES_LOCK
3779
static int qc_getset_max_stream_data(QCTX *ctx, uint32_t class_,
3780
    uint64_t *p_value_out, int is_uni, int is_remote, uint64_t *p_value_in)
3781
0
{
3782
0
    int ret = 0;
3783
0
    uint64_t value_out = 0, value_in;
3784
3785
0
    qctx_lock(ctx);
3786
3787
0
    switch (class_) {
3788
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3789
0
        value_out = ctx->is_listener
3790
0
            ? ossl_quic_port_get_init_max_stream_data(ctx->ql->port, is_uni, is_remote)
3791
0
            : ossl_quic_channel_get_max_stream_data_request(ctx->qc->ch, is_uni, is_remote);
3792
3793
0
        if (p_value_in != NULL) {
3794
0
            value_in = *p_value_in;
3795
0
            if (value_in > OSSL_QUIC_VLINT_MAX) {
3796
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3797
0
                    NULL);
3798
0
                goto err;
3799
0
            }
3800
3801
0
            if (ctx->is_listener) {
3802
0
                ossl_quic_port_set_init_max_stream_data(ctx->ql->port, value_in, is_uni, is_remote);
3803
0
            } else {
3804
0
                if (!ossl_quic_channel_set_max_stream_data_request(ctx->qc->ch, value_in, is_uni, is_remote)) {
3805
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3806
0
                        NULL);
3807
0
                    goto err;
3808
0
                }
3809
0
            }
3810
0
        }
3811
0
        break;
3812
3813
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3814
0
        if (p_value_in != NULL) {
3815
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3816
0
                NULL);
3817
0
            goto err;
3818
0
        }
3819
3820
0
        if (ctx->is_listener) {
3821
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3822
0
                NULL);
3823
0
            goto err;
3824
0
        }
3825
3826
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3827
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3828
0
                NULL);
3829
0
            goto err;
3830
0
        }
3831
3832
0
        value_out = ossl_quic_channel_get_max_stream_data_peer_request(ctx->qc->ch, is_uni, is_remote);
3833
0
        break;
3834
3835
0
    default:
3836
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3837
0
            NULL);
3838
0
        goto err;
3839
0
    }
3840
3841
0
    ret = 1;
3842
0
err:
3843
0
    qctx_unlock(ctx);
3844
0
    if (ret && p_value_out != NULL)
3845
0
        *p_value_out = value_out;
3846
3847
0
    return ret;
3848
0
}
3849
3850
QUIC_TAKES_LOCK
3851
static int qc_getset_ack_delay_exponent(QCTX *ctx, uint32_t class_,
3852
    uint64_t *p_value_out, uint64_t *p_value_in)
3853
0
{
3854
0
    int ret = 0;
3855
0
    uint64_t value_out = 0, value_in;
3856
3857
0
    qctx_lock(ctx);
3858
3859
0
    switch (class_) {
3860
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3861
0
        value_out = ctx->is_listener
3862
0
            ? ossl_quic_port_get_ack_delay_exponent(ctx->ql->port)
3863
0
            : ossl_quic_channel_get_ack_delay_exponent_request(ctx->qc->ch);
3864
3865
0
        if (p_value_in != NULL) {
3866
0
            value_in = *p_value_in;
3867
0
            if (value_in > QUIC_MAX_ACK_DELAY_EXP) {
3868
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3869
0
                    NULL);
3870
0
                goto err;
3871
0
            }
3872
3873
0
            if (ctx->is_listener) {
3874
0
                ossl_quic_port_set_ack_delay_exponent(ctx->ql->port, value_in);
3875
0
            } else {
3876
0
                if (!ossl_quic_channel_set_ack_delay_exponent_request(ctx->qc->ch, value_in)) {
3877
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3878
0
                        NULL);
3879
0
                    goto err;
3880
0
                }
3881
0
            }
3882
0
        }
3883
0
        break;
3884
3885
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3886
0
        if (p_value_in != NULL) {
3887
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3888
0
                NULL);
3889
0
            goto err;
3890
0
        }
3891
3892
0
        if (ctx->is_listener) {
3893
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3894
0
                NULL);
3895
0
            goto err;
3896
0
        }
3897
3898
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3899
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3900
0
                NULL);
3901
0
            goto err;
3902
0
        }
3903
3904
0
        value_out = ossl_quic_channel_get_ack_delay_exponent_peer_request(ctx->qc->ch);
3905
0
        break;
3906
3907
0
    default:
3908
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3909
0
            NULL);
3910
0
        goto err;
3911
0
    }
3912
3913
0
    ret = 1;
3914
0
err:
3915
0
    qctx_unlock(ctx);
3916
0
    if (ret && p_value_out != NULL)
3917
0
        *p_value_out = value_out;
3918
3919
0
    return ret;
3920
0
}
3921
3922
QUIC_TAKES_LOCK
3923
static int qc_getset_max_ack_delay(QCTX *ctx, uint32_t class_,
3924
    uint64_t *p_value_out, uint64_t *p_value_in)
3925
0
{
3926
0
    int ret = 0;
3927
0
    uint64_t value_out = 0, value_in;
3928
3929
0
    qctx_lock(ctx);
3930
3931
0
    switch (class_) {
3932
0
    case SSL_VALUE_CLASS_FEATURE_REQUEST:
3933
0
        value_out = ctx->is_listener
3934
0
            ? ossl_quic_port_get_max_ack_delay(ctx->ql->port)
3935
0
            : ossl_quic_channel_get_max_ack_delay_request(ctx->qc->ch);
3936
3937
0
        if (p_value_in != NULL) {
3938
0
            value_in = *p_value_in;
3939
0
            if (value_in > QUIC_MAX_MAX_ACK_DELAY) {
3940
0
                QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3941
0
                    NULL);
3942
0
                goto err;
3943
0
            }
3944
3945
0
            if (ctx->is_listener) {
3946
0
                ossl_quic_port_set_max_ack_delay(ctx->ql->port, value_in);
3947
0
            } else {
3948
0
                if (!ossl_quic_channel_set_max_ack_delay_request(ctx->qc->ch, value_in)) {
3949
0
                    QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NOT_RENEGOTIABLE,
3950
0
                        NULL);
3951
0
                    goto err;
3952
0
                }
3953
0
            }
3954
0
        }
3955
0
        break;
3956
3957
0
    case SSL_VALUE_CLASS_FEATURE_PEER_REQUEST:
3958
0
        if (p_value_in != NULL) {
3959
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3960
0
                NULL);
3961
0
            goto err;
3962
0
        }
3963
3964
0
        if (ctx->is_listener) {
3965
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_OP,
3966
0
                NULL);
3967
0
            goto err;
3968
0
        }
3969
3970
0
        if (!ossl_quic_channel_is_handshake_complete(ctx->qc->ch)) {
3971
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_FEATURE_NEGOTIATION_NOT_COMPLETE,
3972
0
                NULL);
3973
0
            goto err;
3974
0
        }
3975
3976
0
        value_out = ossl_quic_channel_get_max_ack_delay_peer_request(ctx->qc->ch);
3977
0
        break;
3978
3979
0
    default:
3980
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
3981
0
            NULL);
3982
0
        goto err;
3983
0
    }
3984
3985
0
    ret = 1;
3986
0
err:
3987
0
    qctx_unlock(ctx);
3988
0
    if (ret && p_value_out != NULL)
3989
0
        *p_value_out = value_out;
3990
3991
0
    return ret;
3992
0
}
3993
3994
QUIC_TAKES_LOCK
3995
static int qc_get_stream_avail(QCTX *ctx, uint32_t class_,
3996
    int is_uni, int is_remote,
3997
    uint64_t *value)
3998
0
{
3999
0
    int ret = 0;
4000
4001
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
4002
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
4003
0
            NULL);
4004
0
        return 0;
4005
0
    }
4006
4007
0
    qctx_lock(ctx);
4008
4009
0
    *value = is_remote
4010
0
        ? ossl_quic_channel_get_remote_stream_count_avail(ctx->qc->ch, is_uni)
4011
0
        : ossl_quic_channel_get_local_stream_count_avail(ctx->qc->ch, is_uni);
4012
4013
0
    ret = 1;
4014
0
    qctx_unlock(ctx);
4015
0
    return ret;
4016
0
}
4017
4018
QUIC_NEEDS_LOCK
4019
static int qctx_should_autotick(QCTX *ctx)
4020
0
{
4021
0
    int event_handling_mode;
4022
0
    QUIC_OBJ *obj = ctx->obj;
4023
4024
0
    for (; (event_handling_mode = obj->event_handling_mode) == SSL_VALUE_EVENT_HANDLING_MODE_INHERIT
4025
0
        && obj->parent_obj != NULL;
4026
0
        obj = obj->parent_obj)
4027
0
        ;
4028
4029
0
    return event_handling_mode != SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT;
4030
0
}
4031
4032
QUIC_NEEDS_LOCK
4033
static void qctx_maybe_autotick(QCTX *ctx)
4034
0
{
4035
0
    if (!qctx_should_autotick(ctx))
4036
0
        return;
4037
4038
0
    ossl_quic_reactor_tick(ossl_quic_obj_get0_reactor(ctx->obj), 0);
4039
0
}
4040
4041
QUIC_TAKES_LOCK
4042
static int qc_getset_event_handling(QCTX *ctx, uint32_t class_,
4043
    uint64_t *p_value_out,
4044
    uint64_t *p_value_in)
4045
0
{
4046
0
    int ret = 0;
4047
0
    uint64_t value_out = 0;
4048
4049
0
    qctx_lock(ctx);
4050
4051
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
4052
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
4053
0
            NULL);
4054
0
        goto err;
4055
0
    }
4056
4057
0
    if (p_value_in != NULL) {
4058
0
        switch (*p_value_in) {
4059
0
        case SSL_VALUE_EVENT_HANDLING_MODE_INHERIT:
4060
0
        case SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT:
4061
0
        case SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT:
4062
0
            break;
4063
0
        default:
4064
0
            QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT,
4065
0
                NULL);
4066
0
            goto err;
4067
0
        }
4068
4069
0
        value_out = *p_value_in;
4070
0
        ctx->obj->event_handling_mode = (int)value_out;
4071
0
    } else {
4072
0
        value_out = ctx->obj->event_handling_mode;
4073
0
    }
4074
4075
0
    ret = 1;
4076
0
err:
4077
0
    qctx_unlock(ctx);
4078
0
    if (ret && p_value_out != NULL)
4079
0
        *p_value_out = value_out;
4080
4081
0
    return ret;
4082
0
}
4083
4084
QUIC_TAKES_LOCK
4085
static int qc_get_stream_write_buf_stat(QCTX *ctx, uint32_t class_,
4086
    uint64_t *p_value_out,
4087
    size_t (*getter)(QUIC_SSTREAM *sstream))
4088
0
{
4089
0
    int ret = 0;
4090
0
    size_t value = 0;
4091
4092
0
    qctx_lock(ctx);
4093
4094
0
    if (class_ != SSL_VALUE_CLASS_GENERIC) {
4095
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_UNSUPPORTED_CONFIG_VALUE_CLASS,
4096
0
            NULL);
4097
0
        goto err;
4098
0
    }
4099
4100
0
    if (ctx->xso == NULL) {
4101
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
4102
0
        goto err;
4103
0
    }
4104
4105
0
    if (!ossl_quic_stream_has_send(ctx->xso->stream)) {
4106
0
        QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_STREAM_RECV_ONLY, NULL);
4107
0
        goto err;
4108
0
    }
4109
4110
0
    if (ossl_quic_stream_has_send_buffer(ctx->xso->stream))
4111
0
        value = getter(ctx->xso->stream->sstream);
4112
4113
0
    ret = 1;
4114
0
err:
4115
0
    qctx_unlock(ctx);
4116
0
    *p_value_out = (uint64_t)value;
4117
0
    return ret;
4118
0
}
4119
4120
QUIC_NEEDS_LOCK
4121
static int expect_quic_for_value(SSL *s, QCTX *ctx, uint32_t id)
4122
0
{
4123
0
    switch (id) {
4124
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
4125
0
    case SSL_VALUE_STREAM_WRITE_BUF_SIZE:
4126
0
    case SSL_VALUE_STREAM_WRITE_BUF_USED:
4127
0
    case SSL_VALUE_STREAM_WRITE_BUF_AVAIL:
4128
0
        return expect_quic_cs(s, ctx);
4129
0
    case SSL_VALUE_QUIC_IDLE_TIMEOUT:
4130
0
    case SSL_VALUE_QUIC_UDP_PAYLOAD_SIZE_MAX:
4131
0
    case SSL_VALUE_QUIC_WINDOWCON:
4132
0
    case SSL_VALUE_QUIC_WINDOWBSTR:
4133
0
    case SSL_VALUE_QUIC_WINDOWUSTR:
4134
0
    case SSL_VALUE_QUIC_ACK_DELAY_EXPONENT:
4135
0
    case SSL_VALUE_QUIC_ACK_DELAY_MAX:
4136
0
        return expect_quic_cl(s, ctx);
4137
0
    default:
4138
0
        return expect_quic_conn_only(s, ctx);
4139
0
    }
4140
0
}
4141
4142
QUIC_TAKES_LOCK
4143
int ossl_quic_get_value_uint(SSL *s, uint32_t class_, uint32_t id,
4144
    uint64_t *value)
4145
0
{
4146
0
    QCTX ctx;
4147
4148
0
    if (!expect_quic_for_value(s, &ctx, id))
4149
0
        return 0;
4150
4151
0
    if (value == NULL)
4152
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
4153
0
            ERR_R_PASSED_INVALID_ARGUMENT, NULL);
4154
4155
0
    switch (id) {
4156
0
    case SSL_VALUE_QUIC_IDLE_TIMEOUT:
4157
0
        return qc_getset_idle_timeout(&ctx, class_, value, NULL);
4158
0
    case SSL_VALUE_QUIC_UDP_PAYLOAD_SIZE_MAX:
4159
0
        return qc_getset_max_udp_payload_size(&ctx, class_, value, NULL);
4160
0
    case SSL_VALUE_QUIC_WINDOWCON:
4161
0
        return qc_getset_max_data(&ctx, class_, value, NULL);
4162
0
    case SSL_VALUE_QUIC_WINDOWBSTR:
4163
0
        return qc_getset_max_stream_data(&ctx, class_, value, /*uni=*/0, /*remote=*/0, NULL);
4164
0
    case SSL_VALUE_QUIC_WINDOWUSTR:
4165
0
        return qc_getset_max_stream_data(&ctx, class_, value, /*uni=*/1, /*remote=*/1, NULL);
4166
0
    case SSL_VALUE_QUIC_ACK_DELAY_EXPONENT:
4167
0
        return qc_getset_ack_delay_exponent(&ctx, class_, value, NULL);
4168
0
    case SSL_VALUE_QUIC_ACK_DELAY_MAX:
4169
0
        return qc_getset_max_ack_delay(&ctx, class_, value, NULL);
4170
4171
0
    case SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL:
4172
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/0, /*remote=*/0, value);
4173
0
    case SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL:
4174
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/0, /*remote=*/1, value);
4175
0
    case SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL:
4176
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/1, /*remote=*/0, value);
4177
0
    case SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL:
4178
0
        return qc_get_stream_avail(&ctx, class_, /*uni=*/1, /*remote=*/1, value);
4179
4180
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
4181
0
        return qc_getset_event_handling(&ctx, class_, value, NULL);
4182
4183
0
    case SSL_VALUE_STREAM_WRITE_BUF_SIZE:
4184
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
4185
0
            ossl_quic_sstream_get_buffer_size);
4186
0
    case SSL_VALUE_STREAM_WRITE_BUF_USED:
4187
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
4188
0
            ossl_quic_sstream_get_buffer_used);
4189
0
    case SSL_VALUE_STREAM_WRITE_BUF_AVAIL:
4190
0
        return qc_get_stream_write_buf_stat(&ctx, class_, value,
4191
0
            ossl_quic_sstream_get_buffer_avail);
4192
4193
0
    default:
4194
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
4195
0
            SSL_R_UNSUPPORTED_CONFIG_VALUE, NULL);
4196
0
    }
4197
4198
0
    return 1;
4199
0
}
4200
4201
QUIC_TAKES_LOCK
4202
int ossl_quic_set_value_uint(SSL *s, uint32_t class_, uint32_t id,
4203
    uint64_t value)
4204
0
{
4205
0
    QCTX ctx;
4206
4207
0
    if (!expect_quic_for_value(s, &ctx, id))
4208
0
        return 0;
4209
4210
0
    switch (id) {
4211
0
    case SSL_VALUE_EVENT_HANDLING_MODE:
4212
0
        return qc_getset_event_handling(&ctx, class_, NULL, &value);
4213
4214
0
    case SSL_VALUE_QUIC_IDLE_TIMEOUT:
4215
0
        return qc_getset_idle_timeout(&ctx, class_, NULL, &value);
4216
0
    case SSL_VALUE_QUIC_UDP_PAYLOAD_SIZE_MAX:
4217
0
        return qc_getset_max_udp_payload_size(&ctx, class_, NULL, &value);
4218
0
    case SSL_VALUE_QUIC_WINDOWCON:
4219
0
        return qc_getset_max_data(&ctx, class_, NULL, &value);
4220
0
    case SSL_VALUE_QUIC_WINDOWBSTR:
4221
0
        return qc_getset_max_stream_data(&ctx, class_, NULL, /*uni=*/0, /*remote=*/0, &value);
4222
0
    case SSL_VALUE_QUIC_WINDOWUSTR:
4223
0
        return qc_getset_max_stream_data(&ctx, class_, NULL, /*uni=*/1, /*remote=*/1, &value);
4224
0
    case SSL_VALUE_QUIC_ACK_DELAY_EXPONENT:
4225
0
        return qc_getset_ack_delay_exponent(&ctx, class_, NULL, &value);
4226
0
    case SSL_VALUE_QUIC_ACK_DELAY_MAX:
4227
0
        return qc_getset_max_ack_delay(&ctx, class_, NULL, &value);
4228
4229
0
    default:
4230
0
        return QUIC_RAISE_NON_NORMAL_ERROR(&ctx,
4231
0
            SSL_R_UNSUPPORTED_CONFIG_VALUE, NULL);
4232
0
    }
4233
4234
0
    return 1;
4235
0
}
4236
4237
/*
4238
 * SSL_accept_stream
4239
 * -----------------
4240
 */
4241
struct wait_for_incoming_stream_args {
4242
    QCTX *ctx;
4243
    QUIC_STREAM *qs;
4244
};
4245
4246
QUIC_NEEDS_LOCK
4247
static int wait_for_incoming_stream(void *arg)
4248
0
{
4249
0
    struct wait_for_incoming_stream_args *args = arg;
4250
0
    QUIC_CONNECTION *qc = args->ctx->qc;
4251
0
    QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
4252
4253
0
    if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
4254
        /* If connection is torn down due to an error while blocking, stop. */
4255
0
        QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
4256
0
        return -1;
4257
0
    }
4258
4259
0
    args->qs = ossl_quic_stream_map_peek_accept_queue(qsm);
4260
0
    if (args->qs != NULL)
4261
0
        return 1; /* got a stream */
4262
4263
0
    return 0; /* did not get a stream, keep trying */
4264
0
}
4265
4266
QUIC_TAKES_LOCK
4267
SSL *ossl_quic_accept_stream(SSL *s, uint64_t flags)
4268
0
{
4269
0
    QCTX ctx;
4270
0
    int ret;
4271
0
    SSL *new_s = NULL;
4272
0
    QUIC_STREAM_MAP *qsm;
4273
0
    QUIC_STREAM *qs;
4274
0
    QUIC_XSO *xso;
4275
0
    OSSL_RTT_INFO rtt_info;
4276
4277
0
    if (!expect_quic_conn_only(s, &ctx))
4278
0
        return NULL;
4279
4280
0
    qctx_lock(&ctx);
4281
4282
0
    if (qc_get_effective_incoming_stream_policy(ctx.qc)
4283
0
        == SSL_INCOMING_STREAM_POLICY_REJECT) {
4284
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
4285
0
        goto out;
4286
0
    }
4287
4288
0
    qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
4289
4290
0
    if ((flags & SSL_ACCEPT_STREAM_UNI) && !(flags & SSL_ACCEPT_STREAM_BIDI)) {
4291
0
        qs = ossl_quic_stream_map_find_in_accept_queue(qsm, 1);
4292
0
    } else if ((flags & SSL_ACCEPT_STREAM_BIDI)
4293
0
        && !(flags & SSL_ACCEPT_STREAM_UNI)) {
4294
0
        qs = ossl_quic_stream_map_find_in_accept_queue(qsm, 0);
4295
0
    } else {
4296
0
        qs = ossl_quic_stream_map_peek_accept_queue(qsm);
4297
0
    }
4298
4299
0
    if (qs == NULL) {
4300
0
        if (qctx_blocking(&ctx)
4301
0
            && (flags & SSL_ACCEPT_STREAM_NO_BLOCK) == 0) {
4302
0
            struct wait_for_incoming_stream_args args;
4303
4304
0
            args.ctx = &ctx;
4305
0
            args.qs = NULL;
4306
4307
0
            ret = block_until_pred(&ctx, wait_for_incoming_stream, &args, 0);
4308
0
            if (ret == 0) {
4309
0
                QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
4310
0
                goto out;
4311
0
            } else if (ret < 0 || args.qs == NULL) {
4312
0
                goto out;
4313
0
            }
4314
4315
0
            qs = args.qs;
4316
0
        } else {
4317
0
            goto out;
4318
0
        }
4319
0
    }
4320
4321
0
    xso = create_xso_from_stream(ctx.qc, qs);
4322
0
    if (xso == NULL)
4323
0
        goto out;
4324
4325
0
    ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx.qc->ch), &rtt_info);
4326
0
    ossl_quic_stream_map_remove_from_accept_queue(qsm, qs,
4327
0
        rtt_info.smoothed_rtt);
4328
0
    new_s = &xso->obj.ssl;
4329
4330
    /* Calling this function inhibits default XSO autocreation. */
4331
0
    qc_touch_default_xso(ctx.qc); /* inhibits default XSO */
4332
4333
0
out:
4334
0
    qctx_unlock(&ctx);
4335
0
    return new_s;
4336
0
}
4337
4338
/*
4339
 * SSL_get_accept_stream_queue_len
4340
 * -------------------------------
4341
 */
4342
QUIC_TAKES_LOCK
4343
size_t ossl_quic_get_accept_stream_queue_len(SSL *s)
4344
0
{
4345
0
    QCTX ctx;
4346
0
    size_t v;
4347
4348
0
    if (!expect_quic_conn_only(s, &ctx))
4349
0
        return 0;
4350
4351
0
    qctx_lock(&ctx);
4352
4353
0
    v = ossl_quic_stream_map_get_total_accept_queue_len(ossl_quic_channel_get_qsm(ctx.qc->ch));
4354
4355
0
    qctx_unlock(&ctx);
4356
0
    return v;
4357
0
}
4358
4359
/*
4360
 * SSL_stream_reset
4361
 * ----------------
4362
 */
4363
int ossl_quic_stream_reset(SSL *ssl,
4364
    const SSL_STREAM_RESET_ARGS *args,
4365
    size_t args_len)
4366
0
{
4367
0
    QCTX ctx;
4368
0
    QUIC_STREAM_MAP *qsm;
4369
0
    QUIC_STREAM *qs;
4370
0
    uint64_t error_code;
4371
0
    int ok, err;
4372
4373
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/0, /*io=*/0, &ctx))
4374
0
        return 0;
4375
4376
0
    qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
4377
0
    qs = ctx.xso->stream;
4378
0
    error_code = (args != NULL ? args->quic_error_code : 0);
4379
4380
0
    if (!quic_validate_for_write(ctx.xso, &err)) {
4381
0
        ok = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
4382
0
        goto err;
4383
0
    }
4384
4385
0
    ok = ossl_quic_stream_map_reset_stream_send_part(qsm, qs, error_code);
4386
0
    if (ok)
4387
0
        ctx.xso->requested_reset = 1;
4388
4389
0
err:
4390
0
    qctx_unlock(&ctx);
4391
0
    return ok;
4392
0
}
4393
4394
/*
4395
 * SSL_get_stream_read_state
4396
 * -------------------------
4397
 */
4398
static void quic_classify_stream(QUIC_CONNECTION *qc,
4399
    QUIC_STREAM *qs,
4400
    int is_write,
4401
    int *state,
4402
    uint64_t *app_error_code)
4403
0
{
4404
0
    int local_init;
4405
0
    uint64_t scratch_pad; /* throw away value */
4406
4407
0
    local_init = (ossl_quic_stream_is_server_init(qs) == qc->as_server);
4408
4409
0
    if (app_error_code != NULL)
4410
0
        *app_error_code = UINT64_MAX;
4411
0
    else
4412
0
        app_error_code = &scratch_pad;
4413
4414
0
    if (!ossl_quic_stream_is_bidi(qs) && local_init != is_write) {
4415
        /*
4416
         * Unidirectional stream and this direction of transmission doesn't
4417
         * exist.
4418
         */
4419
0
        *state = SSL_STREAM_STATE_WRONG_DIR;
4420
0
    } else if (ossl_quic_channel_is_term_any(qc->ch)) {
4421
        /* Connection already closed. */
4422
0
        *state = SSL_STREAM_STATE_CONN_CLOSED;
4423
0
    } else if (!is_write && qs->recv_state == QUIC_RSTREAM_STATE_DATA_READ) {
4424
        /* Application has read a FIN. */
4425
0
        *state = SSL_STREAM_STATE_FINISHED;
4426
0
    } else if ((!is_write && qs->stop_sending)
4427
0
        || (is_write && ossl_quic_stream_send_is_reset(qs))) {
4428
        /*
4429
         * Stream has been reset locally. FIN takes precedence over this for the
4430
         * read case as the application need not care if the stream is reset
4431
         * after a FIN has been successfully processed.
4432
         */
4433
0
        *state = SSL_STREAM_STATE_RESET_LOCAL;
4434
0
        *app_error_code = !is_write
4435
0
            ? qs->stop_sending_aec
4436
0
            : qs->reset_stream_aec;
4437
0
    } else if ((!is_write && ossl_quic_stream_recv_is_reset(qs))
4438
0
        || (is_write && qs->peer_stop_sending)) {
4439
        /*
4440
         * Stream has been reset remotely. */
4441
0
        *state = SSL_STREAM_STATE_RESET_REMOTE;
4442
0
        *app_error_code = !is_write
4443
0
            ? qs->peer_reset_stream_aec
4444
0
            : qs->peer_stop_sending_aec;
4445
0
    } else if (is_write && qs->have_final_size) {
4446
        /*
4447
         * Stream has been finished. Stream reset takes precedence over this for
4448
         * the write case as peer may not have received all data.
4449
         */
4450
0
        *state = SSL_STREAM_STATE_FINISHED;
4451
0
    } else {
4452
        /* Stream still healthy. */
4453
0
        *state = SSL_STREAM_STATE_OK;
4454
0
    }
4455
0
}
4456
4457
static int quic_get_stream_state(SSL *ssl, int is_write)
4458
0
{
4459
0
    QCTX ctx;
4460
0
    int state;
4461
4462
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
4463
0
        return SSL_STREAM_STATE_NONE;
4464
4465
0
    quic_classify_stream(ctx.qc, ctx.xso->stream, is_write, &state, NULL);
4466
0
    qctx_unlock(&ctx);
4467
0
    return state;
4468
0
}
4469
4470
int ossl_quic_get_stream_read_state(SSL *ssl)
4471
0
{
4472
0
    return quic_get_stream_state(ssl, /*is_write=*/0);
4473
0
}
4474
4475
/*
4476
 * SSL_get_stream_write_state
4477
 * --------------------------
4478
 */
4479
int ossl_quic_get_stream_write_state(SSL *ssl)
4480
0
{
4481
0
    return quic_get_stream_state(ssl, /*is_write=*/1);
4482
0
}
4483
4484
/*
4485
 * SSL_get_stream_read_error_code
4486
 * ------------------------------
4487
 */
4488
static int quic_get_stream_error_code(SSL *ssl, int is_write,
4489
    uint64_t *app_error_code)
4490
0
{
4491
0
    QCTX ctx;
4492
0
    int state;
4493
4494
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
4495
0
        return -1;
4496
4497
0
    quic_classify_stream(ctx.qc, ctx.xso->stream, is_write,
4498
0
        &state, app_error_code);
4499
4500
0
    qctx_unlock(&ctx);
4501
0
    switch (state) {
4502
0
    case SSL_STREAM_STATE_FINISHED:
4503
0
        return 0;
4504
0
    case SSL_STREAM_STATE_RESET_LOCAL:
4505
0
    case SSL_STREAM_STATE_RESET_REMOTE:
4506
0
        return 1;
4507
0
    default:
4508
0
        return -1;
4509
0
    }
4510
0
}
4511
4512
int ossl_quic_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code)
4513
0
{
4514
0
    return quic_get_stream_error_code(ssl, /*is_write=*/0, app_error_code);
4515
0
}
4516
4517
/*
4518
 * SSL_get_stream_write_error_code
4519
 * -------------------------------
4520
 */
4521
int ossl_quic_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code)
4522
0
{
4523
0
    return quic_get_stream_error_code(ssl, /*is_write=*/1, app_error_code);
4524
0
}
4525
4526
/*
4527
 * Write buffer size mutation
4528
 * --------------------------
4529
 */
4530
int ossl_quic_set_write_buffer_size(SSL *ssl, size_t size)
4531
0
{
4532
0
    int ret = 0;
4533
0
    QCTX ctx;
4534
4535
0
    if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
4536
0
        return 0;
4537
4538
0
    if (!ossl_quic_stream_has_send(ctx.xso->stream)) {
4539
        /* Called on a unidirectional receive-only stream - error. */
4540
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
4541
0
        goto out;
4542
0
    }
4543
4544
0
    if (!ossl_quic_stream_has_send_buffer(ctx.xso->stream)) {
4545
        /*
4546
         * If the stream has a send part but we have disposed of it because we
4547
         * no longer need it, this is a no-op.
4548
         */
4549
0
        ret = 1;
4550
0
        goto out;
4551
0
    }
4552
4553
0
    if (!ossl_quic_sstream_set_buffer_size(ctx.xso->stream->sstream, size)) {
4554
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
4555
0
        goto out;
4556
0
    }
4557
4558
0
    ret = 1;
4559
4560
0
out:
4561
0
    qctx_unlock(&ctx);
4562
0
    return ret;
4563
0
}
4564
4565
/*
4566
 * SSL_get_conn_close_info
4567
 * -----------------------
4568
 */
4569
int ossl_quic_get_conn_close_info(SSL *ssl,
4570
    SSL_CONN_CLOSE_INFO *info,
4571
    size_t info_len)
4572
0
{
4573
0
    QCTX ctx;
4574
0
    const QUIC_TERMINATE_CAUSE *tc;
4575
4576
0
    if (!expect_quic_conn_only(ssl, &ctx))
4577
0
        return -1;
4578
4579
0
    tc = ossl_quic_channel_get_terminate_cause(ctx.qc->ch);
4580
0
    if (tc == NULL)
4581
0
        return 0;
4582
4583
0
    info->error_code = tc->error_code;
4584
0
    info->frame_type = tc->frame_type;
4585
0
    info->reason = tc->reason;
4586
0
    info->reason_len = tc->reason_len;
4587
0
    info->flags = 0;
4588
0
    if (!tc->remote)
4589
0
        info->flags |= SSL_CONN_CLOSE_FLAG_LOCAL;
4590
0
    if (!tc->app)
4591
0
        info->flags |= SSL_CONN_CLOSE_FLAG_TRANSPORT;
4592
0
    return 1;
4593
0
}
4594
4595
/*
4596
 * SSL_key_update
4597
 * --------------
4598
 */
4599
int ossl_quic_key_update(SSL *ssl, int update_type)
4600
0
{
4601
0
    QCTX ctx;
4602
4603
0
    if (!expect_quic_conn_only(ssl, &ctx))
4604
0
        return 0;
4605
4606
0
    switch (update_type) {
4607
0
    case SSL_KEY_UPDATE_NOT_REQUESTED:
4608
        /*
4609
         * QUIC signals peer key update implicily by triggering a local
4610
         * spontaneous TXKU. Silently upgrade this to SSL_KEY_UPDATE_REQUESTED.
4611
         */
4612
0
    case SSL_KEY_UPDATE_REQUESTED:
4613
0
        break;
4614
4615
0
    default:
4616
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
4617
0
        return 0;
4618
0
    }
4619
4620
0
    qctx_lock(&ctx);
4621
4622
    /* Attempt to perform a TXKU. */
4623
0
    if (!ossl_quic_channel_trigger_txku(ctx.qc->ch)) {
4624
0
        QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_TOO_MANY_KEY_UPDATES, NULL);
4625
0
        qctx_unlock(&ctx);
4626
0
        return 0;
4627
0
    }
4628
4629
0
    qctx_unlock(&ctx);
4630
0
    return 1;
4631
0
}
4632
4633
/*
4634
 * SSL_get_key_update_type
4635
 * -----------------------
4636
 */
4637
int ossl_quic_get_key_update_type(const SSL *s)
4638
0
{
4639
    /*
4640
     * We always handle key updates immediately so a key update is never
4641
     * pending.
4642
     */
4643
0
    return SSL_KEY_UPDATE_NONE;
4644
0
}
4645
4646
/**
4647
 * @brief Allocates an SSL object for a user from a QUIC channel.
4648
 *
4649
 * This function creates a new QUIC_CONNECTION object based on an incoming
4650
 * connection associated with the provided QUIC_LISTENER. If the connection
4651
 * creation fails, the function returns NULL. Otherwise, it returns a pointer
4652
 * to the SSL object associated with the newly created connection.
4653
 *
4654
 * Note: This function is a registered port callback made from
4655
 * ossl_quic_new_listener and ossl_quic_new_listener_from, and allows for
4656
 * pre-allocation of the user_ssl object when a channel is created, rather than
4657
 * when it is accepted
4658
 *
4659
 * @param ch  Pointer to the QUIC_CHANNEL representing the incoming connection.
4660
 * @param arg Pointer to a QUIC_LISTENER used to create the connection.
4661
 *
4662
 * @return Pointer to the SSL object on success, or NULL on failure.
4663
 */
4664
static SSL *alloc_port_user_ssl(QUIC_CHANNEL *ch, QUIC_LISTENER *ql)
4665
0
{
4666
0
    QUIC_CONNECTION *qc = create_qc_from_incoming_conn(ql, ch);
4667
4668
0
    return (qc == NULL) ? NULL : &qc->obj.ssl;
4669
0
}
4670
4671
/*
4672
 * QUIC Front-End I/O API: Listeners
4673
 * =================================
4674
 */
4675
4676
/*
4677
 * SSL_new_listener
4678
 * ----------------
4679
 */
4680
SSL *ossl_quic_new_listener(SSL_CTX *ctx, uint64_t flags)
4681
0
{
4682
0
    QUIC_LISTENER *ql = NULL;
4683
0
    QUIC_ENGINE_ARGS engine_args = { 0 };
4684
0
    QUIC_PORT_ARGS port_args = { 0 };
4685
4686
0
    if ((ql = OPENSSL_zalloc(sizeof(*ql))) == NULL) {
4687
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
4688
0
        goto err;
4689
0
    }
4690
4691
0
#if defined(OPENSSL_THREADS)
4692
0
    if ((ql->mutex = ossl_crypto_mutex_new()) == NULL) {
4693
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
4694
0
        goto err;
4695
0
    }
4696
0
#endif
4697
4698
0
    engine_args.libctx = ctx->libctx;
4699
0
    engine_args.propq = ctx->propq;
4700
0
#if defined(OPENSSL_THREADS)
4701
0
    engine_args.mutex = ql->mutex;
4702
0
#endif
4703
4704
0
    if (need_notifier_for_domain_flags(ctx->domain_flags))
4705
0
        engine_args.reactor_flags |= QUIC_REACTOR_FLAG_USE_NOTIFIER;
4706
4707
0
    if ((ql->engine = ossl_quic_engine_new(&engine_args)) == NULL) {
4708
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4709
0
        goto err;
4710
0
    }
4711
4712
0
    port_args.channel_ctx = ctx;
4713
0
    port_args.is_multi_conn = 1;
4714
0
    port_args.get_conn_user_ssl = alloc_port_user_ssl;
4715
0
    port_args.ql = ql;
4716
0
    if ((flags & SSL_LISTENER_FLAG_NO_VALIDATE) == 0)
4717
0
        port_args.do_addr_validation = 1;
4718
0
    ql->port = ossl_quic_engine_create_port(ql->engine, &port_args);
4719
0
    if (ql->port == NULL) {
4720
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4721
0
        goto err;
4722
0
    }
4723
4724
    /* TODO(QUIC FUTURE): Implement SSL_LISTENER_FLAG_NO_ACCEPT */
4725
4726
0
    ossl_quic_port_set_allow_incoming(ql->port, 1);
4727
4728
    /* Initialise the QUIC_LISTENER's object header. */
4729
0
    if (!ossl_quic_obj_init(&ql->obj, ctx, SSL_TYPE_QUIC_LISTENER, NULL,
4730
0
            ql->engine, ql->port))
4731
0
        goto err;
4732
4733
0
    return &ql->obj.ssl;
4734
4735
0
err:
4736
0
    if (ql != NULL)
4737
0
        ossl_quic_engine_free(ql->engine);
4738
4739
0
#if defined(OPENSSL_THREADS)
4740
0
    ossl_crypto_mutex_free(&ql->mutex);
4741
0
#endif
4742
0
    OPENSSL_free(ql);
4743
0
    return NULL;
4744
0
}
4745
4746
/*
4747
 * SSL_new_listener_from
4748
 * ---------------------
4749
 */
4750
SSL *ossl_quic_new_listener_from(SSL *ssl, uint64_t flags)
4751
0
{
4752
0
    QCTX ctx;
4753
0
    QUIC_LISTENER *ql = NULL;
4754
0
    QUIC_PORT_ARGS port_args = { 0 };
4755
4756
0
    if (!expect_quic_domain(ssl, &ctx))
4757
0
        return NULL;
4758
4759
0
    if (!SSL_up_ref(&ctx.qd->obj.ssl))
4760
0
        return NULL;
4761
4762
0
    qctx_lock(&ctx);
4763
4764
0
    if ((ql = OPENSSL_zalloc(sizeof(*ql))) == NULL) {
4765
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
4766
0
        goto err;
4767
0
    }
4768
4769
0
    port_args.channel_ctx = ssl->ctx;
4770
0
    port_args.is_multi_conn = 1;
4771
0
    port_args.get_conn_user_ssl = alloc_port_user_ssl;
4772
0
    port_args.ql = ql;
4773
0
    if ((flags & SSL_LISTENER_FLAG_NO_VALIDATE) == 0)
4774
0
        port_args.do_addr_validation = 1;
4775
0
    ql->port = ossl_quic_engine_create_port(ctx.qd->engine, &port_args);
4776
0
    if (ql->port == NULL) {
4777
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4778
0
        goto err;
4779
0
    }
4780
4781
0
    ql->domain = ctx.qd;
4782
0
    ql->engine = ctx.qd->engine;
4783
0
#if defined(OPENSSL_THREADS)
4784
0
    ql->mutex = ctx.qd->mutex;
4785
0
#endif
4786
4787
    /*
4788
     * TODO(QUIC FUTURE): Implement SSL_LISTENER_FLAG_NO_ACCEPT
4789
     * Given that we have apis to create client SSL objects from
4790
     * server SSL objects (see SSL_new_from_listener), we have aspirations
4791
     * to enable a flag that allows for the creation of the latter, but not
4792
     * be used to do accept any connections.  This is a placeholder for the
4793
     * implementation of that flag
4794
     */
4795
4796
0
    ossl_quic_port_set_allow_incoming(ql->port, 1);
4797
4798
    /* Initialise the QUIC_LISTENER's object header. */
4799
0
    if (!ossl_quic_obj_init(&ql->obj, ssl->ctx, SSL_TYPE_QUIC_LISTENER,
4800
0
            &ctx.qd->obj.ssl, NULL, ql->port))
4801
0
        goto err;
4802
4803
0
    qctx_unlock(&ctx);
4804
0
    return &ql->obj.ssl;
4805
4806
0
err:
4807
0
    if (ql != NULL)
4808
0
        ossl_quic_port_free(ql->port);
4809
4810
0
    OPENSSL_free(ql);
4811
0
    qctx_unlock(&ctx);
4812
0
    SSL_free(&ctx.qd->obj.ssl);
4813
4814
0
    return NULL;
4815
0
}
4816
4817
/*
4818
 * SSL_new_from_listener
4819
 * ---------------------
4820
 * code here is derived from ossl_quic_new(). The `ssl` argument is
4821
 * a listener object which already comes with QUIC port/engine. The newly
4822
 * created QUIC connection object (QCSO) is going to share the port/engine
4823
 * with listener (`ssl`).  The `ssl` also becomes a parent of QCSO created
4824
 * by this function. The caller uses QCSO instance to connect to
4825
 * remote QUIC server.
4826
 *
4827
 * The QCSO created here requires us to also create a channel so we
4828
 * can connect to remote server.
4829
 */
4830
SSL *ossl_quic_new_from_listener(SSL *ssl, uint64_t flags)
4831
0
{
4832
0
    QCTX ctx;
4833
0
    QUIC_CONNECTION *qc = NULL;
4834
0
    QUIC_LISTENER *ql;
4835
0
    SSL_CONNECTION *sc = NULL;
4836
4837
0
    if (flags != 0)
4838
0
        return NULL;
4839
4840
0
    if (!expect_quic_listener(ssl, &ctx))
4841
0
        return NULL;
4842
4843
0
    if (!SSL_up_ref(&ctx.ql->obj.ssl))
4844
0
        return NULL;
4845
4846
0
    qctx_lock(&ctx);
4847
4848
0
    ql = ctx.ql;
4849
4850
    /*
4851
     * listeners (server) contexts don't typically
4852
     * allocate a token cache because they don't need
4853
     * to store them, but here we are using a server side
4854
     * ctx as a client, so we should allocate one now
4855
     */
4856
0
    if (ssl->ctx->tokencache == NULL)
4857
0
        if ((ssl->ctx->tokencache = ossl_quic_new_token_store()) == NULL)
4858
0
            goto err;
4859
4860
0
    if ((qc = OPENSSL_zalloc(sizeof(*qc))) == NULL) {
4861
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
4862
0
        goto err;
4863
0
    }
4864
4865
    /*
4866
     * NOTE: setting a listener here is needed so `qc_cleanup()` does the right
4867
     * thing. Setting listener to ql avoids premature destruction of port in
4868
     * qc_cleanup()
4869
     */
4870
0
    qc->listener = ql;
4871
0
    qc->engine = ql->engine;
4872
0
    qc->port = ql->port;
4873
/* create channel */
4874
0
#if defined(OPENSSL_THREADS)
4875
    /* this is the engine mutex */
4876
0
    qc->mutex = ql->mutex;
4877
0
#endif
4878
0
#if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
4879
0
    qc->is_thread_assisted
4880
0
        = ((ql->obj.domain_flags & SSL_DOMAIN_FLAG_THREAD_ASSISTED) != 0);
4881
0
#endif
4882
4883
    /* Create the handshake layer. */
4884
0
    qc->tls = ossl_ssl_connection_new_int(ql->obj.ssl.ctx, NULL, TLS_method());
4885
0
    if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL) {
4886
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4887
0
        goto err;
4888
0
    }
4889
0
    sc->s3.flags |= TLS1_FLAGS_QUIC | TLS1_FLAGS_QUIC_INTERNAL;
4890
4891
0
    qc->default_ssl_options = OSSL_QUIC_PERMITTED_OPTIONS;
4892
0
    qc->last_error = SSL_ERROR_NONE;
4893
4894
    /*
4895
     * This is QCSO, we don't expect to accept connections
4896
     * on success the channel assumes ownership of tls, we need
4897
     * to grab reference for qc.
4898
     */
4899
0
    qc->ch = ossl_quic_port_create_outgoing(qc->port, qc->tls);
4900
0
    if (qc->ch == NULL) {
4901
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4902
0
        goto err;
4903
0
    }
4904
4905
0
    ossl_quic_channel_set_msg_callback(qc->ch, ql->obj.ssl.ctx->msg_callback, &qc->obj.ssl);
4906
0
    ossl_quic_channel_set_msg_callback_arg(qc->ch, ql->obj.ssl.ctx->msg_callback_arg);
4907
4908
    /*
4909
     * We deliberately pass NULL for engine and port, because we don't want to
4910
     * to turn QCSO we create here into an event leader, nor port leader.
4911
     * Both those roles are occupied already by listener (`ssl`) we use
4912
     * to create a new QCSO here.
4913
     */
4914
0
    if (!ossl_quic_obj_init(&qc->obj, ql->obj.ssl.ctx,
4915
0
            SSL_TYPE_QUIC_CONNECTION,
4916
0
            &ql->obj.ssl, NULL, NULL)) {
4917
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
4918
0
        goto err;
4919
0
    }
4920
4921
    /* Initialise libssl APL-related state. */
4922
0
    qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
4923
0
    qc->default_ssl_mode = qc->obj.ssl.ctx->mode;
4924
0
    qc->default_ssl_options = qc->obj.ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
4925
0
    qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
4926
0
    qc->last_error = SSL_ERROR_NONE;
4927
4928
0
    qc_update_reject_policy(qc);
4929
4930
0
    qctx_unlock(&ctx);
4931
4932
0
    return &qc->obj.ssl;
4933
4934
0
err:
4935
0
    if (qc != NULL) {
4936
0
        qc_cleanup(qc, /* have_lock= */ 0);
4937
0
        OPENSSL_free(qc);
4938
0
    }
4939
0
    qctx_unlock(&ctx);
4940
0
    SSL_free(&ctx.ql->obj.ssl);
4941
4942
0
    return NULL;
4943
0
}
4944
4945
/*
4946
 * SSL_listen
4947
 * ----------
4948
 */
4949
QUIC_NEEDS_LOCK
4950
static int ql_listen(QUIC_LISTENER *ql)
4951
0
{
4952
0
    if (ql->listening)
4953
0
        return 1;
4954
4955
0
    ossl_quic_port_set_allow_incoming(ql->port, 1);
4956
0
    ql->listening = 1;
4957
0
    return 1;
4958
0
}
4959
4960
QUIC_TAKES_LOCK
4961
int ossl_quic_listen(SSL *ssl)
4962
0
{
4963
0
    QCTX ctx;
4964
0
    int ret;
4965
4966
0
    if (!expect_quic_listener(ssl, &ctx))
4967
0
        return 0;
4968
4969
0
    qctx_lock_for_io(&ctx);
4970
4971
0
    ret = ql_listen(ctx.ql);
4972
4973
0
    qctx_unlock(&ctx);
4974
0
    return ret;
4975
0
}
4976
4977
QUIC_TAKES_LOCK
4978
int ossl_quic_peeloff_conn(SSL *listener, SSL *new_conn)
4979
0
{
4980
0
    QCTX lctx;
4981
0
    QCTX cctx;
4982
0
    QUIC_CHANNEL *new_ch;
4983
0
    QUIC_CONNECTION *qc = NULL;
4984
0
    QUIC_LISTENER *ql = NULL;
4985
0
    SSL *tls = NULL;
4986
0
    int ret = 0;
4987
4988
0
    if (!expect_quic_listener(listener, &lctx))
4989
0
        return -1;
4990
4991
0
    if (!expect_quic_c(new_conn, &cctx))
4992
0
        return -1;
4993
4994
0
    qctx_lock_for_io(&lctx);
4995
4996
0
    if (!ossl_quic_port_test_and_set_peeloff(lctx.ql->port, PEELOFF_LISTEN)) {
4997
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
4998
0
            "This listener is using SSL_accept_connection");
4999
0
        ret = -1;
5000
0
        goto out;
5001
0
    }
5002
5003
0
    new_ch = ossl_quic_port_pop_incoming(lctx.ql->port);
5004
0
    if (new_ch != NULL) {
5005
0
        tls = ossl_ssl_connection_new_int(ossl_quic_port_get_channel_ctx(lctx.ql->port),
5006
0
            new_conn, TLS_method());
5007
0
        if (tls == NULL)
5008
0
            goto out;
5009
5010
0
        qc = cctx.qc;
5011
0
        ql = lctx.ql;
5012
        /*
5013
         * Need to ensure that we take a reference on our new listener
5014
         * so that we don't free it before this connection
5015
         */
5016
0
        if (!SSL_up_ref(&ql->obj.ssl))
5017
0
            goto out;
5018
5019
0
        ossl_quic_channel_free(qc->ch);
5020
0
        ossl_quic_port_free(qc->port);
5021
0
        ossl_quic_engine_free(qc->engine);
5022
        /*
5023
         * Ensure that we point to our listener so we can drop
5024
         * the above refcount when this SSL object is freed
5025
         */
5026
0
        qc->listener = ql;
5027
0
        qc->obj.engine = ql->engine;
5028
0
        qc->engine = ql->engine;
5029
0
        qc->port = ql->port;
5030
0
        qc->pending = 1;
5031
0
#if defined(OPENSSL_THREADS)
5032
0
        ossl_crypto_mutex_free(&qc->mutex);
5033
0
        qc->mutex = ql->mutex;
5034
0
#endif
5035
0
        qc->ch = new_ch;
5036
0
        SSL_free(qc->tls);
5037
0
        ossl_quic_channel_set0_tls(new_ch, tls);
5038
0
        qc->tls = tls;
5039
0
        ossl_quic_channel_get_peer_addr(new_ch, &qc->init_peer_addr); /* best effort */
5040
0
        qc->started = 1;
5041
0
        qc->as_server = 1;
5042
0
        qc->as_server_state = 1;
5043
0
        qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
5044
0
        qc->default_ssl_options = ql->obj.ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
5045
0
        qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
5046
0
        qc->last_error = SSL_ERROR_NONE;
5047
0
        qc_update_reject_policy(qc);
5048
0
        ret = 1;
5049
0
    }
5050
0
out:
5051
0
    qctx_unlock(&lctx);
5052
0
    return ret;
5053
0
}
5054
5055
/*
5056
 * SSL_accept_connection
5057
 * ---------------------
5058
 */
5059
static int quic_accept_connection_wait(void *arg)
5060
0
{
5061
0
    QUIC_PORT *port = arg;
5062
5063
0
    if (!ossl_quic_port_is_running(port))
5064
0
        return -1;
5065
5066
0
    if (ossl_quic_port_have_incoming(port))
5067
0
        return 1;
5068
5069
0
    return 0;
5070
0
}
5071
5072
QUIC_TAKES_LOCK
5073
SSL *ossl_quic_accept_connection(SSL *ssl, uint64_t flags)
5074
0
{
5075
0
    int ret;
5076
0
    QCTX ctx;
5077
0
    SSL *conn_ssl = NULL;
5078
0
    SSL *conn_ssl_tmp = NULL;
5079
0
    SSL_CONNECTION *conn = NULL;
5080
0
    QUIC_CHANNEL *new_ch = NULL;
5081
0
    QUIC_CONNECTION *qc = NULL;
5082
0
    int no_block = ((flags & SSL_ACCEPT_CONNECTION_NO_BLOCK) != 0);
5083
5084
0
    if (!expect_quic_listener(ssl, &ctx))
5085
0
        return NULL;
5086
5087
0
    qctx_lock_for_io(&ctx);
5088
5089
0
    if (!ql_listen(ctx.ql))
5090
0
        goto out;
5091
5092
0
    if (!ossl_quic_port_test_and_set_peeloff(ctx.ql->port, PEELOFF_ACCEPT)) {
5093
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
5094
0
            "This listener is using SSL_listen_ex");
5095
0
        goto out;
5096
0
    }
5097
5098
    /* Wait for an incoming connection if needed. */
5099
0
    new_ch = ossl_quic_port_pop_incoming(ctx.ql->port);
5100
0
    if (new_ch == NULL && ossl_quic_port_is_running(ctx.ql->port)) {
5101
0
        if (!no_block && qctx_blocking(&ctx)) {
5102
0
            ret = block_until_pred(&ctx, quic_accept_connection_wait,
5103
0
                ctx.ql->port, 0);
5104
0
            if (ret < 1)
5105
0
                goto out;
5106
0
        } else {
5107
0
            qctx_maybe_autotick(&ctx);
5108
0
        }
5109
5110
0
        if (!ossl_quic_port_is_running(ctx.ql->port))
5111
0
            goto out;
5112
5113
0
        new_ch = ossl_quic_port_pop_incoming(ctx.ql->port);
5114
0
    }
5115
5116
0
    if (new_ch == NULL && ossl_quic_port_is_running(ctx.ql->port)) {
5117
        /* No connections already queued. */
5118
0
        ossl_quic_reactor_tick(ossl_quic_engine_get0_reactor(ctx.ql->engine), 0);
5119
5120
0
        new_ch = ossl_quic_port_pop_incoming(ctx.ql->port);
5121
0
    }
5122
5123
    /*
5124
     * port_make_channel pre-allocates our user_ssl for us for each newly
5125
     * created channel, so once we pop the new channel from the port above
5126
     * we just need to extract it
5127
     */
5128
0
    if (new_ch == NULL)
5129
0
        goto out;
5130
5131
    /*
5132
     * All objects below must exist, because new_ch != NULL. The objects are
5133
     * bound to new_ch. If channel constructor fails to create any item here
5134
     * it just fails to create channel.
5135
     */
5136
0
    if (!ossl_assert((conn_ssl_tmp = ossl_quic_channel_get0_tls(new_ch)) != NULL)
5137
0
        || !ossl_assert((conn = SSL_CONNECTION_FROM_SSL(conn_ssl_tmp)) != NULL)
5138
0
        || !ossl_assert((conn_ssl_tmp = SSL_CONNECTION_GET_USER_SSL(conn)) != NULL))
5139
0
        goto out;
5140
5141
0
    qc = (QUIC_CONNECTION *)conn_ssl_tmp;
5142
0
    if (SSL_up_ref(&ctx.ql->obj.ssl)) {
5143
0
        qc->listener = ctx.ql;
5144
0
        conn_ssl = conn_ssl_tmp;
5145
0
        conn_ssl_tmp = NULL;
5146
0
        qc->pending = 0;
5147
0
    }
5148
5149
0
out:
5150
5151
0
    qctx_unlock(&ctx);
5152
    /*
5153
     * You might expect ossl_quic_channel_free() to be called here. Be
5154
     * assured it happens, The process goes as follows:
5155
     *    - The SSL_free() here is being handled by ossl_quic_free().
5156
     *    - The very last step of ossl_quic_free() is call to qc_cleanup()
5157
     *      where channel gets freed.
5158
     * NOTE: We defer this SSL_free until after the call to qctx_unlock above
5159
     * to avoid the deadlock that would occur when ossl_quic_free attempts to
5160
     * re-acquire this mutex.  We also do the gymnastics with conn_ssl and
5161
     * conn_ssl_tmp above so that we only actually do the free on the SSL
5162
     * object if the up-ref above fails, in such a way that we don't unbalance
5163
     * the listener refcount (i.e. if the up-ref fails above, we don't set the
5164
     * listener pointer so that we don't then drop the ref-count erroneously
5165
     * during the free operation.
5166
     */
5167
0
    SSL_free(conn_ssl_tmp);
5168
0
    return conn_ssl;
5169
0
}
5170
5171
static QUIC_CONNECTION *create_qc_from_incoming_conn(QUIC_LISTENER *ql, QUIC_CHANNEL *ch)
5172
0
{
5173
0
    QUIC_CONNECTION *qc = NULL;
5174
5175
0
    if ((qc = OPENSSL_zalloc(sizeof(*qc))) == NULL) {
5176
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
5177
0
        goto err;
5178
0
    }
5179
5180
0
    if (!ossl_quic_obj_init(&qc->obj, ql->obj.ssl.ctx,
5181
0
            SSL_TYPE_QUIC_CONNECTION,
5182
0
            &ql->obj.ssl, NULL, NULL)) {
5183
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
5184
0
        goto err;
5185
0
    }
5186
5187
0
    qc->pending = 1;
5188
0
    qc->engine = ql->engine;
5189
0
    qc->port = ql->port;
5190
0
    qc->ch = ch;
5191
0
#if defined(OPENSSL_THREADS)
5192
0
    qc->mutex = ql->mutex;
5193
0
#endif
5194
0
    qc->started = 1;
5195
0
    qc->as_server = 1;
5196
0
    qc->as_server_state = 1;
5197
0
    qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
5198
0
    qc->default_ssl_options = ql->obj.ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
5199
0
    qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
5200
0
    qc->last_error = SSL_ERROR_NONE;
5201
0
    qc_update_reject_policy(qc);
5202
5203
    /*
5204
     * Detach the channel from the freshly-built qc before handing it back.
5205
     *
5206
     * qc->ch was set to @p ch above so the in-function initialisers
5207
     * (e.g. qc_update_reject_policy()) can reach the channel during setup.
5208
     * Once setup is done we clear it again because, at this point, the qc
5209
     * does NOT yet own the channel: @p ch is still owned by the caller of
5210
     * port_new_handshake_layer(), which only commits ownership (by setting
5211
     * qc->ch = ch on the success path) after the rest of channel
5212
     * construction has succeeded.
5213
     *
5214
     * Leaving qc->ch set here would mean any error path that does
5215
     * SSL_free(user_ssl) before the commit point cascades into
5216
     * qc_cleanup() -> ossl_quic_channel_free(qc->ch) and frees a channel
5217
     * the caller is still using -- the use-after-free / double-free class
5218
     * of bug we hit before. Resetting to NULL makes SSL_free(user_ssl)
5219
     * safe at any point until the caller explicitly hands ch over.
5220
     */
5221
0
    qc->ch = NULL;
5222
5223
0
    return qc;
5224
5225
0
err:
5226
0
    OPENSSL_free(qc);
5227
0
    return NULL;
5228
0
}
5229
5230
DEFINE_LHASH_OF_EX(QUIC_TOKEN);
5231
5232
struct ssl_token_store_st {
5233
    LHASH_OF(QUIC_TOKEN) *cache;
5234
    CRYPTO_REF_COUNT references;
5235
    CRYPTO_MUTEX *mutex;
5236
};
5237
5238
static unsigned long quic_token_hash(const QUIC_TOKEN *item)
5239
0
{
5240
0
    return (unsigned long)ossl_fnv1a_hash(item->hashkey, item->hashkey_len);
5241
0
}
5242
5243
static int quic_token_cmp(const QUIC_TOKEN *a, const QUIC_TOKEN *b)
5244
0
{
5245
0
    if (a->hashkey_len != b->hashkey_len)
5246
0
        return 1;
5247
0
    return memcmp(a->hashkey, b->hashkey, a->hashkey_len);
5248
0
}
5249
5250
SSL_TOKEN_STORE *ossl_quic_new_token_store(void)
5251
0
{
5252
0
    int ok = 0;
5253
0
    SSL_TOKEN_STORE *newcache = OPENSSL_zalloc(sizeof(SSL_TOKEN_STORE));
5254
5255
0
    if (newcache == NULL)
5256
0
        goto out;
5257
5258
0
    newcache->cache = lh_QUIC_TOKEN_new(quic_token_hash, quic_token_cmp);
5259
0
    if (newcache->cache == NULL)
5260
0
        goto out;
5261
5262
0
#if defined(OPENSSL_THREADS)
5263
0
    if ((newcache->mutex = ossl_crypto_mutex_new()) == NULL)
5264
0
        goto out;
5265
0
#endif
5266
5267
0
    if (!CRYPTO_NEW_REF(&newcache->references, 1))
5268
0
        goto out;
5269
5270
0
    ok = 1;
5271
0
out:
5272
0
    if (!ok) {
5273
0
        ossl_quic_free_token_store(newcache);
5274
0
        newcache = NULL;
5275
0
    }
5276
0
    return newcache;
5277
0
}
5278
5279
static void free_this_token(QUIC_TOKEN *tok)
5280
0
{
5281
0
    ossl_quic_free_peer_token(tok);
5282
0
}
5283
5284
void ossl_quic_free_token_store(SSL_TOKEN_STORE *hdl)
5285
0
{
5286
0
    int refs;
5287
5288
0
    if (hdl == NULL)
5289
0
        return;
5290
5291
0
    if (!CRYPTO_DOWN_REF(&hdl->references, &refs))
5292
0
        return;
5293
5294
0
    if (refs > 0)
5295
0
        return;
5296
5297
    /* last reference, we can clean up */
5298
0
    ossl_crypto_mutex_free(&hdl->mutex);
5299
0
    lh_QUIC_TOKEN_doall(hdl->cache, free_this_token);
5300
0
    lh_QUIC_TOKEN_free(hdl->cache);
5301
0
    CRYPTO_FREE_REF(&hdl->references);
5302
0
    OPENSSL_free(hdl);
5303
0
    return;
5304
0
}
5305
5306
/**
5307
 * @brief build a new QUIC_TOKEN
5308
 *
5309
 * This function creates a new token storage structure for saving in our
5310
 * tokencache
5311
 *
5312
 * In an effort to make allocation and freeing of these tokens a bit faster
5313
 * We do them in a single allocation in this format
5314
 * +---------------+        --\
5315
 * |   hashkey *   |---|      |
5316
 * |   hashkey_len |   |      | QUIC_TOKEN
5317
 * |   token *     |---|--|   |
5318
 * |   token_len   |   |  |   |
5319
 * +---------------+<--|  | --/
5320
 * |  hashkey buf  |      |
5321
 * |               |      |
5322
 * |---------------|<-----|
5323
 * |  token buf    |
5324
 * |               |
5325
 * +---------------+
5326
 *
5327
 * @param peer - the peer address that sent the token
5328
 * @param token - the buffer holding the token
5329
 * @param token_len - the size of token
5330
 *
5331
 * @returns a QUIC_TOKEN pointer or NULL on error
5332
 */
5333
static QUIC_TOKEN *ossl_quic_build_new_token(BIO_ADDR *peer, uint8_t *token,
5334
    size_t token_len)
5335
0
{
5336
0
    QUIC_TOKEN *new_token;
5337
0
    size_t hashkey_len = 0;
5338
0
    size_t addr_len = 0;
5339
0
    int family;
5340
0
    unsigned short port;
5341
0
    int *famptr;
5342
0
    unsigned short *portptr;
5343
0
    uint8_t *addrptr;
5344
5345
0
    if ((token != NULL && token_len == 0) || (token == NULL && token_len != 0))
5346
0
        return NULL;
5347
5348
0
    if (!BIO_ADDR_rawaddress(peer, NULL, &addr_len))
5349
0
        return NULL;
5350
0
    family = BIO_ADDR_family(peer);
5351
0
    port = BIO_ADDR_rawport(peer);
5352
5353
0
    hashkey_len += sizeof(int); /* hashkey(family) */
5354
0
    hashkey_len += sizeof(unsigned short); /* hashkey(port) */
5355
0
    hashkey_len += addr_len; /* hashkey(address) */
5356
5357
0
    new_token = OPENSSL_zalloc(sizeof(QUIC_TOKEN) + hashkey_len + token_len);
5358
0
    if (new_token == NULL)
5359
0
        return NULL;
5360
5361
0
    if (!CRYPTO_NEW_REF(&new_token->references, 1)) {
5362
0
        OPENSSL_free(new_token);
5363
0
        return NULL;
5364
0
    }
5365
5366
0
    new_token->hashkey_len = hashkey_len;
5367
    /* hashkey is allocated inline, immediately after the QUIC_TOKEN struct */
5368
0
    new_token->hashkey = (uint8_t *)(new_token + 1);
5369
    /* token buffer follows the hashkey in the inline allocation */
5370
0
    new_token->token = new_token->hashkey + hashkey_len;
5371
0
    new_token->token_len = token_len;
5372
0
    famptr = (int *)new_token->hashkey;
5373
0
    portptr = (unsigned short *)(famptr + 1);
5374
0
    addrptr = (uint8_t *)(portptr + 1);
5375
0
    *famptr = family;
5376
0
    *portptr = port;
5377
0
    if (!BIO_ADDR_rawaddress(peer, addrptr, NULL)) {
5378
0
        ossl_quic_free_peer_token(new_token);
5379
0
        return NULL;
5380
0
    }
5381
0
    if (token != NULL)
5382
0
        memcpy(new_token->token, token, token_len);
5383
0
    return new_token;
5384
0
}
5385
5386
int ossl_quic_set_peer_token(SSL_CTX *ctx, BIO_ADDR *peer,
5387
    const uint8_t *token, size_t token_len)
5388
0
{
5389
0
    SSL_TOKEN_STORE *c = ctx->tokencache;
5390
0
    QUIC_TOKEN *tok, *old = NULL;
5391
5392
0
    if (ctx->tokencache == NULL)
5393
0
        return 0;
5394
5395
0
    tok = ossl_quic_build_new_token(peer, (uint8_t *)token, token_len);
5396
0
    if (tok == NULL)
5397
0
        return 0;
5398
5399
    /* we might be sharing this cache, lock it */
5400
0
    ossl_crypto_mutex_lock(c->mutex);
5401
5402
0
    old = lh_QUIC_TOKEN_retrieve(c->cache, tok);
5403
0
    if (old != NULL) {
5404
0
        lh_QUIC_TOKEN_delete(c->cache, old);
5405
0
        ossl_quic_free_peer_token(old);
5406
0
    }
5407
0
    lh_QUIC_TOKEN_insert(c->cache, tok);
5408
5409
0
    ossl_crypto_mutex_unlock(c->mutex);
5410
0
    return 1;
5411
0
}
5412
5413
int ossl_quic_get_peer_token(SSL_CTX *ctx, BIO_ADDR *peer,
5414
    QUIC_TOKEN **token)
5415
0
{
5416
0
    SSL_TOKEN_STORE *c = ctx->tokencache;
5417
0
    QUIC_TOKEN *key = NULL;
5418
0
    QUIC_TOKEN *tok = NULL;
5419
0
    int ret;
5420
0
    int rc = 0;
5421
5422
0
    if (c == NULL)
5423
0
        return 0;
5424
5425
0
    key = ossl_quic_build_new_token(peer, NULL, 0);
5426
0
    if (key == NULL)
5427
0
        return 0;
5428
5429
0
    ossl_crypto_mutex_lock(c->mutex);
5430
0
    tok = lh_QUIC_TOKEN_retrieve(c->cache, key);
5431
0
    if (tok != NULL) {
5432
0
        *token = tok;
5433
0
        CRYPTO_UP_REF(&tok->references, &ret);
5434
0
        rc = 1;
5435
0
    }
5436
5437
0
    ossl_crypto_mutex_unlock(c->mutex);
5438
0
    ossl_quic_free_peer_token(key);
5439
0
    return rc;
5440
0
}
5441
5442
void ossl_quic_free_peer_token(QUIC_TOKEN *token)
5443
0
{
5444
0
    int refs = 0;
5445
5446
0
    if (!CRYPTO_DOWN_REF(&token->references, &refs))
5447
0
        return;
5448
5449
0
    if (refs > 0)
5450
0
        return;
5451
5452
0
    CRYPTO_FREE_REF(&token->references);
5453
0
    OPENSSL_free(token);
5454
0
}
5455
5456
/*
5457
 * SSL_get_accept_connection_queue_len
5458
 * -----------------------------------
5459
 */
5460
QUIC_TAKES_LOCK
5461
size_t ossl_quic_get_accept_connection_queue_len(SSL *ssl)
5462
0
{
5463
0
    QCTX ctx;
5464
0
    int ret;
5465
5466
0
    if (!expect_quic_listener(ssl, &ctx))
5467
0
        return 0;
5468
5469
0
    qctx_lock(&ctx);
5470
5471
0
    ret = (int)ossl_quic_port_get_num_incoming_channels(ctx.ql->port);
5472
5473
0
    qctx_unlock(&ctx);
5474
0
    return ret;
5475
0
}
5476
5477
QUIC_TAKES_LOCK
5478
int ossl_quic_get_peer_addr(SSL *ssl, BIO_ADDR *peer_addr)
5479
0
{
5480
0
    QCTX ctx;
5481
0
    int ret;
5482
5483
0
    if (!expect_quic_cs(ssl, &ctx))
5484
0
        return 0;
5485
5486
0
    qctx_lock(&ctx);
5487
0
    ret = ossl_quic_channel_get_peer_addr(ctx.qc->ch, peer_addr);
5488
0
    qctx_unlock(&ctx);
5489
5490
0
    return ret;
5491
0
}
5492
5493
/*
5494
 * QUIC Front-End I/O API: Domains
5495
 * ===============================
5496
 */
5497
5498
/*
5499
 * SSL_new_domain
5500
 * --------------
5501
 */
5502
SSL *ossl_quic_new_domain(SSL_CTX *ctx, uint64_t flags)
5503
0
{
5504
0
    QUIC_DOMAIN *qd = NULL;
5505
0
    QUIC_ENGINE_ARGS engine_args = { 0 };
5506
0
    uint64_t domain_flags;
5507
5508
0
    domain_flags = ctx->domain_flags;
5509
0
    if ((flags & (SSL_DOMAIN_FLAG_SINGLE_THREAD | SSL_DOMAIN_FLAG_MULTI_THREAD | SSL_DOMAIN_FLAG_THREAD_ASSISTED)) != 0)
5510
0
        domain_flags = flags;
5511
0
    else
5512
0
        domain_flags = ctx->domain_flags | flags;
5513
5514
0
    if (!ossl_adjust_domain_flags(domain_flags, &domain_flags))
5515
0
        return NULL;
5516
5517
0
    if ((qd = OPENSSL_zalloc(sizeof(*qd))) == NULL) {
5518
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
5519
0
        return NULL;
5520
0
    }
5521
5522
0
#if defined(OPENSSL_THREADS)
5523
0
    if ((qd->mutex = ossl_crypto_mutex_new()) == NULL) {
5524
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
5525
0
        goto err;
5526
0
    }
5527
0
#endif
5528
5529
0
    engine_args.libctx = ctx->libctx;
5530
0
    engine_args.propq = ctx->propq;
5531
0
#if defined(OPENSSL_THREADS)
5532
0
    engine_args.mutex = qd->mutex;
5533
0
#endif
5534
5535
0
    if (need_notifier_for_domain_flags(domain_flags))
5536
0
        engine_args.reactor_flags |= QUIC_REACTOR_FLAG_USE_NOTIFIER;
5537
5538
0
    if ((qd->engine = ossl_quic_engine_new(&engine_args)) == NULL) {
5539
0
        QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
5540
0
        goto err;
5541
0
    }
5542
5543
    /* Initialise the QUIC_DOMAIN's object header. */
5544
0
    if (!ossl_quic_obj_init(&qd->obj, ctx, SSL_TYPE_QUIC_DOMAIN, NULL,
5545
0
            qd->engine, NULL))
5546
0
        goto err;
5547
5548
0
    ossl_quic_obj_set_domain_flags(&qd->obj, domain_flags);
5549
0
    return &qd->obj.ssl;
5550
5551
0
err:
5552
0
    ossl_quic_engine_free(qd->engine);
5553
0
#if defined(OPENSSL_THREADS)
5554
0
    ossl_crypto_mutex_free(&qd->mutex);
5555
0
#endif
5556
0
    OPENSSL_free(qd);
5557
0
    return NULL;
5558
0
}
5559
5560
/*
5561
 * QUIC Front-End I/O API: SSL_CTX Management
5562
 * ==========================================
5563
 */
5564
5565
long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
5566
0
{
5567
0
    switch (cmd) {
5568
0
    default:
5569
0
        return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
5570
0
    }
5571
0
}
5572
5573
long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp)(void))
5574
0
{
5575
0
    QCTX ctx;
5576
5577
0
    if (!expect_quic_conn_only(s, &ctx))
5578
0
        return 0;
5579
5580
0
    switch (cmd) {
5581
0
    case SSL_CTRL_SET_MSG_CALLBACK:
5582
0
        ossl_quic_channel_set_msg_callback(ctx.qc->ch, (ossl_msg_cb)fp,
5583
0
            &ctx.qc->obj.ssl);
5584
        /* This callback also needs to be set on the internal SSL object */
5585
0
        return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);
5586
0
        ;
5587
5588
0
    default:
5589
        /* Probably a TLS related ctrl. Defer to our internal SSL object */
5590
0
        return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);
5591
0
    }
5592
0
}
5593
5594
long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp)(void))
5595
0
{
5596
0
    return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
5597
0
}
5598
5599
int ossl_quic_renegotiate_check(SSL *ssl, int initok)
5600
0
{
5601
    /* We never do renegotiation. */
5602
0
    return 0;
5603
0
}
5604
5605
const SSL_CIPHER *ossl_quic_get_cipher_by_char(const unsigned char *p)
5606
0
{
5607
0
    const SSL_CIPHER *ciph = ssl3_get_cipher_by_char(p);
5608
5609
0
    if (ciph == NULL)
5610
0
        return NULL;
5611
0
    if ((ciph->algorithm2 & SSL_QUIC) == 0)
5612
0
        return NULL;
5613
5614
0
    return ciph;
5615
0
}
5616
5617
/*
5618
 * These functions define the TLSv1.2 (and below) ciphers that are supported by
5619
 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
5620
 */
5621
5622
int ossl_quic_num_ciphers(void)
5623
0
{
5624
0
    return 0;
5625
0
}
5626
5627
const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)
5628
0
{
5629
0
    return NULL;
5630
0
}
5631
5632
/*
5633
 * SSL_get_shutdown()
5634
 * ------------------
5635
 */
5636
int ossl_quic_get_shutdown(const SSL *s)
5637
0
{
5638
0
    QCTX ctx;
5639
0
    int shut = 0;
5640
5641
0
    if (!expect_quic_conn_only(s, &ctx))
5642
0
        return 0;
5643
5644
0
    if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
5645
0
        shut |= SSL_SENT_SHUTDOWN;
5646
0
        if (!ossl_quic_channel_is_closing(ctx.qc->ch))
5647
0
            shut |= SSL_RECEIVED_SHUTDOWN;
5648
0
    }
5649
5650
0
    return shut;
5651
0
}
5652
5653
/*
5654
 * QUIC Polling Support APIs
5655
 * =========================
5656
 */
5657
5658
/* Do we have the R (read) condition? */
5659
QUIC_NEEDS_LOCK
5660
static int test_poll_event_r(QUIC_XSO *xso)
5661
0
{
5662
0
    int fin = 0;
5663
0
    size_t avail = 0;
5664
5665
    /*
5666
     * If a stream has had the fin bit set on the last packet
5667
     * received, then we need to return a 1 here to raise
5668
     * SSL_POLL_EVENT_R, so that the stream can have its completion
5669
     * detected and closed gracefully by an application.
5670
     * However, if the client reads the data via SSL_read[_ex], that api
5671
     * provides no stream status, and as a result the stream state moves to
5672
     * QUIC_RSTREAM_STATE_DATA_READ, and the receive buffer is freed, which
5673
     * stored the fin state, so its not directly know-able here.  Instead
5674
     * check for the stream state being QUIC_RSTREAM_STATE_DATA_READ, which
5675
     * is only set if the last stream frame received had the fin bit set, and
5676
     * the client read the data.  This catches our poll/read/poll case
5677
     */
5678
0
    if (xso->stream->recv_state == QUIC_RSTREAM_STATE_DATA_READ)
5679
0
        return 1;
5680
5681
0
    return ossl_quic_stream_has_recv_buffer(xso->stream)
5682
0
        && ossl_quic_rstream_available(xso->stream->rstream, &avail, &fin)
5683
0
        && (avail > 0 || (fin && !xso->retired_fin));
5684
0
}
5685
5686
/* Do we have the ER (exception: read) condition? */
5687
QUIC_NEEDS_LOCK
5688
static int test_poll_event_er(QUIC_XSO *xso)
5689
0
{
5690
0
    return ossl_quic_stream_has_recv(xso->stream)
5691
0
        && ossl_quic_stream_recv_is_reset(xso->stream)
5692
0
        && !xso->retired_fin;
5693
0
}
5694
5695
/* Do we have the W (write) condition? */
5696
QUIC_NEEDS_LOCK
5697
static int test_poll_event_w(QUIC_XSO *xso)
5698
0
{
5699
0
    return !xso->conn->shutting_down
5700
0
        && ossl_quic_stream_has_send_buffer(xso->stream)
5701
0
        && ossl_quic_sstream_get_buffer_avail(xso->stream->sstream)
5702
0
        && !ossl_quic_sstream_get_final_size(xso->stream->sstream, NULL)
5703
0
        && ossl_quic_txfc_get_cwm(&xso->stream->txfc)
5704
0
        > ossl_quic_sstream_get_cur_size(xso->stream->sstream)
5705
0
        && quic_mutation_allowed(xso->conn, /*req_active=*/1);
5706
0
}
5707
5708
/* Do we have the EW (exception: write) condition? */
5709
QUIC_NEEDS_LOCK
5710
static int test_poll_event_ew(QUIC_XSO *xso)
5711
0
{
5712
0
    return ossl_quic_stream_has_send(xso->stream)
5713
0
        && xso->stream->peer_stop_sending
5714
0
        && !xso->requested_reset
5715
0
        && !xso->conn->shutting_down;
5716
0
}
5717
5718
/* Do we have the EC (exception: connection) condition? */
5719
QUIC_NEEDS_LOCK
5720
static int test_poll_event_ec(QUIC_CONNECTION *qc)
5721
0
{
5722
0
    return ossl_quic_channel_is_term_any(qc->ch);
5723
0
}
5724
5725
/* Do we have the ECD (exception: connection drained) condition? */
5726
QUIC_NEEDS_LOCK
5727
static int test_poll_event_ecd(QUIC_CONNECTION *qc)
5728
0
{
5729
0
    return ossl_quic_channel_is_terminated(qc->ch);
5730
0
}
5731
5732
/* Do we have the IS (incoming: stream) condition? */
5733
QUIC_NEEDS_LOCK
5734
static int test_poll_event_is(QUIC_CONNECTION *qc, int is_uni)
5735
0
{
5736
0
    return ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(qc->ch),
5737
0
               is_uni)
5738
0
        > 0;
5739
0
}
5740
5741
/* Do we have the OS (outgoing: stream) condition? */
5742
QUIC_NEEDS_LOCK
5743
static int test_poll_event_os(QUIC_CONNECTION *qc, int is_uni)
5744
0
{
5745
    /* Is it currently possible for us to make an outgoing stream? */
5746
0
    return quic_mutation_allowed(qc, /*req_active=*/1)
5747
0
        && ossl_quic_channel_get_local_stream_count_avail(qc->ch, is_uni) > 0;
5748
0
}
5749
5750
/* Do we have the EL (exception: listener) condition? */
5751
QUIC_NEEDS_LOCK
5752
static int test_poll_event_el(QUIC_LISTENER *ql)
5753
0
{
5754
0
    return !ossl_quic_port_is_running(ql->port);
5755
0
}
5756
5757
/* Do we have the IC (incoming: connection) condition? */
5758
QUIC_NEEDS_LOCK
5759
static int test_poll_event_ic(QUIC_LISTENER *ql)
5760
0
{
5761
0
    return ossl_quic_port_get_num_incoming_channels(ql->port) > 0;
5762
0
}
5763
5764
QUIC_TAKES_LOCK
5765
int ossl_quic_conn_poll_events(SSL *ssl, uint64_t events, int do_tick,
5766
    uint64_t *p_revents)
5767
0
{
5768
0
    QCTX ctx;
5769
0
    uint64_t revents = 0;
5770
5771
0
    if (!expect_quic_csl(ssl, &ctx))
5772
0
        return 0;
5773
5774
0
    qctx_lock(&ctx);
5775
5776
0
    if (ctx.qc != NULL && !ctx.qc->started) {
5777
        /* We can only try to write on non-started connection. */
5778
0
        if ((events & SSL_POLL_EVENT_W) != 0)
5779
0
            revents |= SSL_POLL_EVENT_W;
5780
0
        goto end;
5781
0
    }
5782
5783
0
    if (do_tick)
5784
0
        ossl_quic_reactor_tick(ossl_quic_obj_get0_reactor(ctx.obj), 0);
5785
5786
0
    if (ctx.xso != NULL) {
5787
        /* SSL object has a stream component. */
5788
5789
0
        if ((events & SSL_POLL_EVENT_R) != 0
5790
0
            && test_poll_event_r(ctx.xso))
5791
0
            revents |= SSL_POLL_EVENT_R;
5792
5793
0
        if ((events & SSL_POLL_EVENT_ER) != 0
5794
0
            && test_poll_event_er(ctx.xso))
5795
0
            revents |= SSL_POLL_EVENT_ER;
5796
5797
0
        if ((events & SSL_POLL_EVENT_W) != 0
5798
0
            && test_poll_event_w(ctx.xso))
5799
0
            revents |= SSL_POLL_EVENT_W;
5800
5801
0
        if ((events & SSL_POLL_EVENT_EW) != 0
5802
0
            && test_poll_event_ew(ctx.xso))
5803
0
            revents |= SSL_POLL_EVENT_EW;
5804
0
    }
5805
5806
0
    if (ctx.qc != NULL && !ctx.is_stream) {
5807
0
        if ((events & SSL_POLL_EVENT_EC) != 0
5808
0
            && test_poll_event_ec(ctx.qc))
5809
0
            revents |= SSL_POLL_EVENT_EC;
5810
5811
0
        if ((events & SSL_POLL_EVENT_ECD) != 0
5812
0
            && test_poll_event_ecd(ctx.qc))
5813
0
            revents |= SSL_POLL_EVENT_ECD;
5814
5815
0
        if ((events & SSL_POLL_EVENT_ISB) != 0
5816
0
            && test_poll_event_is(ctx.qc, /*uni=*/0))
5817
0
            revents |= SSL_POLL_EVENT_ISB;
5818
5819
0
        if ((events & SSL_POLL_EVENT_ISU) != 0
5820
0
            && test_poll_event_is(ctx.qc, /*uni=*/1))
5821
0
            revents |= SSL_POLL_EVENT_ISU;
5822
5823
0
        if ((events & SSL_POLL_EVENT_OSB) != 0
5824
0
            && test_poll_event_os(ctx.qc, /*uni=*/0))
5825
0
            revents |= SSL_POLL_EVENT_OSB;
5826
5827
0
        if ((events & SSL_POLL_EVENT_OSU) != 0
5828
0
            && test_poll_event_os(ctx.qc, /*uni=*/1))
5829
0
            revents |= SSL_POLL_EVENT_OSU;
5830
0
    }
5831
5832
0
    if (ctx.is_listener) {
5833
0
        if ((events & SSL_POLL_EVENT_EL) != 0
5834
0
            && test_poll_event_el(ctx.ql))
5835
0
            revents |= SSL_POLL_EVENT_EL;
5836
5837
0
        if ((events & SSL_POLL_EVENT_IC) != 0
5838
0
            && test_poll_event_ic(ctx.ql))
5839
0
            revents |= SSL_POLL_EVENT_IC;
5840
0
    }
5841
5842
0
end:
5843
0
    qctx_unlock(&ctx);
5844
0
    *p_revents = revents;
5845
0
    return 1;
5846
0
}
5847
5848
QUIC_TAKES_LOCK
5849
int ossl_quic_get_notifier_fd(SSL *ssl)
5850
0
{
5851
0
    QCTX ctx;
5852
0
    QUIC_REACTOR *rtor;
5853
0
    RIO_NOTIFIER *nfy;
5854
0
    int nfd = -1;
5855
5856
0
    if (!expect_quic_any(ssl, &ctx))
5857
0
        return -1;
5858
5859
0
    qctx_lock(&ctx);
5860
0
    rtor = ossl_quic_obj_get0_reactor(ctx.obj);
5861
0
    nfy = ossl_quic_reactor_get0_notifier(rtor);
5862
0
    if (nfy == NULL)
5863
0
        goto end;
5864
0
    nfd = ossl_rio_notifier_as_fd(nfy);
5865
5866
0
end:
5867
0
    qctx_unlock(&ctx);
5868
0
    return nfd;
5869
0
}
5870
5871
QUIC_TAKES_LOCK
5872
void ossl_quic_enter_blocking_section(SSL *ssl, QUIC_REACTOR_WAIT_CTX *wctx)
5873
0
{
5874
0
    QCTX ctx;
5875
0
    QUIC_REACTOR *rtor;
5876
5877
0
    if (!expect_quic_any(ssl, &ctx))
5878
0
        return;
5879
5880
0
    qctx_lock(&ctx);
5881
0
    rtor = ossl_quic_obj_get0_reactor(ctx.obj);
5882
0
    ossl_quic_reactor_wait_ctx_enter(wctx, rtor);
5883
0
    qctx_unlock(&ctx);
5884
0
}
5885
5886
QUIC_TAKES_LOCK
5887
void ossl_quic_leave_blocking_section(SSL *ssl, QUIC_REACTOR_WAIT_CTX *wctx)
5888
0
{
5889
0
    QCTX ctx;
5890
0
    QUIC_REACTOR *rtor;
5891
5892
0
    if (!expect_quic_any(ssl, &ctx))
5893
0
        return;
5894
5895
0
    qctx_lock(&ctx);
5896
0
    rtor = ossl_quic_obj_get0_reactor(ctx.obj);
5897
0
    ossl_quic_reactor_wait_ctx_leave(wctx, rtor);
5898
0
    qctx_unlock(&ctx);
5899
0
}
5900
5901
/*
5902
 * Internal Testing APIs
5903
 * =====================
5904
 */
5905
5906
QUIC_CHANNEL *ossl_quic_conn_get_channel(SSL *s)
5907
0
{
5908
0
    QCTX ctx;
5909
5910
0
    if (!expect_quic_conn_only(s, &ctx))
5911
0
        return NULL;
5912
5913
0
    return ctx.qc->ch;
5914
0
}
5915
5916
int ossl_quic_set_diag_title(SSL_CTX *ctx, const char *title)
5917
0
{
5918
0
#ifndef OPENSSL_NO_QLOG
5919
0
    OPENSSL_free(ctx->qlog_title);
5920
0
    ctx->qlog_title = NULL;
5921
5922
0
    if (title == NULL)
5923
0
        return 1;
5924
5925
0
    if ((ctx->qlog_title = OPENSSL_strdup(title)) == NULL)
5926
0
        return 0;
5927
0
#endif
5928
5929
0
    return 1;
5930
0
}