Coverage Report

Created: 2025-10-10 07:01

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