2 * Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/macros.h>
11 #include <openssl/objects.h>
12 #include <openssl/sslerr.h>
13 #include <crypto/rand.h>
14 #include "quic_local.h"
15 #include "internal/quic_tls.h"
16 #include "internal/quic_rx_depack.h"
17 #include "internal/quic_error.h"
18 #include "internal/time.h"
20 typedef struct qctx_st QCTX;
22 static void aon_write_finish(QUIC_XSO *xso);
23 static int create_channel(QUIC_CONNECTION *qc);
24 static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs);
25 static int qc_try_create_default_xso_for_write(QCTX *ctx);
26 static int qc_wait_for_default_xso_for_read(QCTX *ctx);
27 static void quic_lock(QUIC_CONNECTION *qc);
28 static void quic_unlock(QUIC_CONNECTION *qc);
29 static void quic_lock_for_io(QCTX *ctx);
30 static int quic_do_handshake(QCTX *ctx);
31 static void qc_update_reject_policy(QUIC_CONNECTION *qc);
32 static void qc_touch_default_xso(QUIC_CONNECTION *qc);
33 static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch);
34 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
35 int touch, QUIC_XSO **old_xso);
36 static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock);
37 static int quic_validate_for_write(QUIC_XSO *xso, int *err);
38 static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active);
39 static int qc_blocking_mode(const QUIC_CONNECTION *qc);
40 static int xso_blocking_mode(const QUIC_XSO *xso);
43 * QUIC Front-End I/O API: Common Utilities
44 * ========================================
48 * Block until a predicate is met.
50 * Precondition: Must have a channel.
51 * Precondition: Must hold channel lock (unchecked).
54 static int block_until_pred(QUIC_CONNECTION *qc,
55 int (*pred)(void *arg), void *pred_arg,
60 assert(qc->ch != NULL);
63 * Any attempt to block auto-disables tick inhibition as otherwise we will
64 * hang around forever.
66 ossl_quic_channel_set_inhibit_tick(qc->ch, 0);
68 rtor = ossl_quic_channel_get_reactor(qc->ch);
69 return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags,
73 static OSSL_TIME get_time(QUIC_CONNECTION *qc)
75 if (qc->override_now_cb != NULL)
76 return qc->override_now_cb(qc->override_now_cb_arg);
78 return ossl_time_now();
81 static OSSL_TIME get_time_cb(void *arg)
83 QUIC_CONNECTION *qc = arg;
89 * QCTX is a utility structure which provides information we commonly wish to
90 * unwrap upon an API call being dispatched to us, namely:
92 * - a pointer to the QUIC_CONNECTION (regardless of whether a QCSO or QSSO
94 * - a pointer to any applicable QUIC_XSO (e.g. if a QSSO was passed, or if
95 * a QCSO with a default stream was passed);
96 * - whether a QSSO was passed (xso == NULL must not be used to determine this
97 * because it may be non-NULL when a QCSO is passed if that QCSO has a
99 * - whether we are in "I/O context", meaning that non-normal errors can
100 * be reported via SSL_get_error() as well as via ERR. Functions such as
101 * SSL_read(), SSL_write() and SSL_do_handshake() are "I/O context"
102 * functions which are allowed to change the value returned by
103 * SSL_get_error. However, other functions (including functions which call
104 * SSL_do_handshake() implicitly) are not allowed to change the return value
110 int is_stream, in_io;
114 static void quic_set_last_error(QCTX *ctx, int last_error)
119 if (ctx->is_stream && ctx->xso != NULL)
120 ctx->xso->last_error = last_error;
121 else if (!ctx->is_stream && ctx->qc != NULL)
122 ctx->qc->last_error = last_error;
126 * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
127 * rather than via ERR. Note that normal errors must always be raised while
131 static int quic_raise_normal_error(QCTX *ctx,
135 quic_set_last_error(ctx, err);
141 * Raise a 'non-normal' error, meaning any error that is not reported via
142 * SSL_get_error() and must be reported via ERR.
144 * qc should be provided if available. In exceptional circumstances when qc is
145 * not known NULL may be passed. This should generally only happen when an
146 * expect_...() function defined below fails, which generally indicates a
147 * dispatch error or caller error.
149 * ctx should be NULL if the connection lock is not held.
151 static int quic_raise_non_normal_error(QCTX *ctx,
162 quic_set_last_error(ctx, SSL_ERROR_SSL);
164 if (reason == SSL_R_PROTOCOL_IS_SHUTDOWN && ctx->qc != NULL)
165 ossl_quic_channel_restore_err_state(ctx->qc->ch);
169 ERR_set_debug(file, line, func);
172 ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
178 #define QUIC_RAISE_NORMAL_ERROR(ctx, err) \
179 quic_raise_normal_error((ctx), (err))
181 #define QUIC_RAISE_NON_NORMAL_ERROR(ctx, reason, msg) \
182 quic_raise_non_normal_error((ctx), \
183 OPENSSL_FILE, OPENSSL_LINE, \
189 * Given a QCSO or QSSO, initialises a QCTX, determining the contextually
190 * applicable QUIC_CONNECTION pointer and, if applicable, QUIC_XSO pointer.
192 * After this returns 1, all fields of the passed QCTX are initialised.
193 * Returns 0 on failure. This function is intended to be used to provide API
194 * semantics and as such, it invokes QUIC_RAISE_NON_NORMAL_ERROR() on failure.
196 static int expect_quic(const SSL *s, QCTX *ctx)
206 return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_PASSED_NULL_PARAMETER, NULL);
209 case SSL_TYPE_QUIC_CONNECTION:
210 qc = (QUIC_CONNECTION *)s;
212 ctx->xso = qc->default_xso;
217 case SSL_TYPE_QUIC_XSO:
226 return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
231 * Like expect_quic(), but requires a QUIC_XSO be contextually available. In
232 * other words, requires that the passed QSO be a QSSO or a QCSO with a default
235 * remote_init determines if we expect the default XSO to be remotely created or
236 * not. If it is -1, do not instantiate a default XSO if one does not yet exist.
238 * Channel mutex is acquired and retained on success.
241 static int ossl_unused expect_quic_with_stream_lock(const SSL *s, int remote_init,
242 int in_io, QCTX *ctx)
244 if (!expect_quic(s, ctx))
248 quic_lock_for_io(ctx);
252 if (ctx->xso == NULL && remote_init >= 0) {
253 if (!quic_mutation_allowed(ctx->qc, /*req_active=*/0)) {
254 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
258 /* If we haven't finished the handshake, try to advance it. */
259 if (quic_do_handshake(ctx) < 1)
260 /* ossl_quic_do_handshake raised error here */
263 if (remote_init == 0) {
264 if (!qc_try_create_default_xso_for_write(ctx))
267 if (!qc_wait_for_default_xso_for_read(ctx))
271 ctx->xso = ctx->qc->default_xso;
274 if (ctx->xso == NULL) {
275 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
279 return 1; /* coverity[missing_unlock]: lock held */
282 quic_unlock(ctx->qc);
287 * Like expect_quic(), but fails if called on a QUIC_XSO. ctx->xso may still
288 * be non-NULL if the QCSO has a default stream.
290 static int ossl_unused expect_quic_conn_only(const SSL *s, QCTX *ctx)
292 if (!expect_quic(s, ctx))
296 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_CONN_USE_ONLY, NULL);
302 * Ensures that the channel mutex is held for a method which touches channel
305 * Precondition: Channel mutex is not held (unchecked)
307 static void quic_lock(QUIC_CONNECTION *qc)
309 #if defined(OPENSSL_THREADS)
310 ossl_crypto_mutex_lock(qc->mutex);
314 static void quic_lock_for_io(QCTX *ctx)
320 * We are entering an I/O function so we must update the values returned by
321 * SSL_get_error and SSL_want. Set no error. This will be overridden later
322 * if a call to QUIC_RAISE_NORMAL_ERROR or QUIC_RAISE_NON_NORMAL_ERROR
323 * occurs during the API call.
325 quic_set_last_error(ctx, SSL_ERROR_NONE);
328 /* Precondition: Channel mutex is held (unchecked) */
330 static void quic_unlock(QUIC_CONNECTION *qc)
332 #if defined(OPENSSL_THREADS)
333 ossl_crypto_mutex_unlock(qc->mutex);
338 * This predicate is the criterion which should determine API call rejection for
339 * *most* mutating API calls, particularly stream-related operations for send
342 * A call is rejected (this function returns 0) if shutdown is in progress
343 * (stream flushing), or we are in a TERMINATING or TERMINATED state. If
344 * req_active=1, the connection must be active (i.e., the IDLE state is also
347 static int quic_mutation_allowed(QUIC_CONNECTION *qc, int req_active)
349 if (qc->shutting_down || ossl_quic_channel_is_term_any(qc->ch))
352 if (req_active && !ossl_quic_channel_is_active(qc->ch))
359 * QUIC Front-End I/O API: Initialization
360 * ======================================
362 * SSL_new => ossl_quic_new
364 * SSL_reset => ossl_quic_reset
365 * SSL_clear => ossl_quic_clear
367 * SSL_free => ossl_quic_free
369 * SSL_set_options => ossl_quic_set_options
370 * SSL_get_options => ossl_quic_get_options
371 * SSL_clear_options => ossl_quic_clear_options
376 SSL *ossl_quic_new(SSL_CTX *ctx)
378 QUIC_CONNECTION *qc = NULL;
379 SSL *ssl_base = NULL;
380 SSL_CONNECTION *sc = NULL;
382 qc = OPENSSL_zalloc(sizeof(*qc));
384 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
388 /* Initialise the QUIC_CONNECTION's stub header. */
390 if (!ossl_ssl_init(ssl_base, ctx, ctx->method, SSL_TYPE_QUIC_CONNECTION)) {
392 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
396 qc->tls = ossl_ssl_connection_new_int(ctx, TLS_method());
397 if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL) {
398 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
402 /* override the user_ssl of the inner connection */
403 sc->s3.flags |= TLS1_FLAGS_QUIC;
405 /* Restrict options derived from the SSL_CTX. */
406 sc->options &= OSSL_QUIC_PERMITTED_OPTIONS_CONN;
409 #if defined(OPENSSL_THREADS)
410 if ((qc->mutex = ossl_crypto_mutex_new()) == NULL) {
411 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
416 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
417 qc->is_thread_assisted
418 = (ssl_base->method == OSSL_QUIC_client_thread_method());
421 qc->as_server = 0; /* TODO(QUIC SERVER): add server support */
422 qc->as_server_state = qc->as_server;
424 qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
425 qc->default_ssl_mode = qc->ssl.ctx->mode;
426 qc->default_ssl_options = qc->ssl.ctx->options & OSSL_QUIC_PERMITTED_OPTIONS;
427 qc->desires_blocking = 1;
429 qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
430 qc->last_error = SSL_ERROR_NONE;
432 if (!create_channel(qc))
435 ossl_quic_channel_set_msg_callback(qc->ch, ctx->msg_callback, ssl_base);
436 ossl_quic_channel_set_msg_callback_arg(qc->ch, ctx->msg_callback_arg);
438 qc_update_reject_policy(qc);
441 * We do not create the default XSO yet. The reason for this is that the
442 * stream ID of the default XSO will depend on whether the stream is client
443 * or server-initiated, which depends on who transmits first. Since we do
444 * not know whether the application will be using a client-transmits-first
445 * or server-transmits-first protocol, we defer default XSO creation until
446 * the client calls SSL_read() or SSL_write(). If it calls SSL_read() first,
447 * we take that as a cue that the client is expecting a server-initiated
448 * stream, and vice versa if SSL_write() is called first.
454 #if defined(OPENSSL_THREADS)
455 ossl_crypto_mutex_free(qc->mutex);
457 ossl_quic_channel_free(qc->ch);
466 void ossl_quic_free(SSL *s)
471 /* We should never be called on anything but a QSO. */
472 if (!expect_quic(s, &ctx))
479 * When a QSSO is freed, the XSO is freed immediately, because the XSO
480 * itself only contains API personality layer data. However the
481 * underlying QUIC_STREAM is not freed immediately but is instead marked
482 * as deleted for later collection.
485 assert(ctx.qc->num_xso > 0);
488 /* If a stream's send part has not been finished, auto-reset it. */
489 if (( ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_READY
490 || ctx.xso->stream->send_state == QUIC_SSTREAM_STATE_SEND)
491 && !ossl_quic_sstream_get_final_size(ctx.xso->stream->sstream, NULL))
492 ossl_quic_stream_map_reset_stream_send_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
495 /* Do STOP_SENDING for the receive part, if applicable. */
496 if ( ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_RECV
497 || ctx.xso->stream->recv_state == QUIC_RSTREAM_STATE_SIZE_KNOWN)
498 ossl_quic_stream_map_stop_sending_recv_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
501 /* Update stream state. */
502 ctx.xso->stream->deleted = 1;
503 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(ctx.qc->ch),
506 is_default = (ctx.xso == ctx.qc->default_xso);
510 * Unref the connection in most cases; the XSO has a ref to the QC and
511 * not vice versa. But for a default XSO, to avoid circular references,
512 * the QC refs the XSO but the XSO does not ref the QC. If we are the
513 * default XSO, we only get here when the QC is being torn down anyway,
514 * so don't call SSL_free(qc) as we are already in it.
517 SSL_free(&ctx.qc->ssl);
519 /* Note: SSL_free calls OPENSSL_free(xso) for us */
524 * Free the default XSO, if any. The QUIC_STREAM is not deleted at this
525 * stage, but is freed during the channel free when the whole QSM is freed.
527 if (ctx.qc->default_xso != NULL) {
528 QUIC_XSO *xso = ctx.qc->default_xso;
533 ctx.qc->default_xso = NULL;
536 /* Ensure we have no remaining XSOs. */
537 assert(ctx.qc->num_xso == 0);
539 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
540 if (ctx.qc->is_thread_assisted && ctx.qc->started) {
541 ossl_quic_thread_assist_wait_stopped(&ctx.qc->thread_assist);
542 ossl_quic_thread_assist_cleanup(&ctx.qc->thread_assist);
546 ossl_quic_channel_free(ctx.qc->ch);
548 BIO_free(ctx.qc->net_rbio);
549 BIO_free(ctx.qc->net_wbio);
551 /* Note: SSL_free calls OPENSSL_free(qc) for us */
553 SSL_free(ctx.qc->tls);
554 quic_unlock(ctx.qc); /* tsan doesn't like freeing locked mutexes */
555 #if defined(OPENSSL_THREADS)
556 ossl_crypto_mutex_free(&ctx.qc->mutex);
560 /* SSL method init */
561 int ossl_quic_init(SSL *s)
563 /* Same op as SSL_clear, forward the call. */
564 return ossl_quic_clear(s);
567 /* SSL method deinit */
568 void ossl_quic_deinit(SSL *s)
573 /* SSL_clear (ssl_reset method) */
574 int ossl_quic_reset(SSL *s)
578 if (!expect_quic(s, &ctx))
581 ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
585 /* ssl_clear method (unused) */
586 int ossl_quic_clear(SSL *s)
590 if (!expect_quic(s, &ctx))
593 ERR_raise(ERR_LIB_SSL, ERR_R_UNSUPPORTED);
597 int ossl_quic_conn_set_override_now_cb(SSL *s,
598 OSSL_TIME (*now_cb)(void *arg),
603 if (!expect_quic(s, &ctx))
608 ctx.qc->override_now_cb = now_cb;
609 ctx.qc->override_now_cb_arg = now_cb_arg;
615 void ossl_quic_conn_force_assist_thread_wake(SSL *s)
619 if (!expect_quic(s, &ctx))
622 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
623 if (ctx.qc->is_thread_assisted && ctx.qc->started)
624 ossl_quic_thread_assist_notify_deadline_changed(&ctx.qc->thread_assist);
629 static void qc_touch_default_xso(QUIC_CONNECTION *qc)
631 qc->default_xso_created = 1;
632 qc_update_reject_policy(qc);
636 * Changes default XSO. Allows caller to keep reference to the old default XSO
637 * (if any). Reference to new XSO is transferred from caller.
640 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
648 if (qc->default_xso != xso) {
649 *old_xso = qc->default_xso; /* transfer old XSO ref to caller */
651 qc->default_xso = xso;
655 * Changing to not having a default XSO. XSO becomes standalone and
656 * now has a ref to the QC.
658 if (!ossl_assert(SSL_up_ref(&qc->ssl)))
662 * Changing from not having a default XSO to having one. The new XSO
663 * will have had a reference to the QC we need to drop to avoid a
664 * circular reference.
666 * Currently we never change directly from one default XSO to
667 * another, though this function would also still be correct if this
670 assert(*old_xso == NULL);
672 CRYPTO_DOWN_REF(&qc->ssl.references, &refs);
678 qc_touch_default_xso(qc);
682 * Changes default XSO, releasing the reference to any previous default XSO.
683 * Reference to new XSO is transferred from caller.
686 static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch)
688 QUIC_XSO *old_xso = NULL;
690 qc_set_default_xso_keep_ref(qc, xso, touch, &old_xso);
693 SSL_free(&old_xso->ssl);
697 static void xso_update_options(QUIC_XSO *xso)
699 int cleanse = ((xso->ssl_options & SSL_OP_CLEANSE_PLAINTEXT) != 0);
701 if (xso->stream->rstream != NULL)
702 ossl_quic_rstream_set_cleanse(xso->stream->rstream, cleanse);
704 if (xso->stream->sstream != NULL)
705 ossl_quic_sstream_set_cleanse(xso->stream->sstream, cleanse);
712 * Setting options on a QCSO
713 * - configures the handshake-layer options;
714 * - configures the default data-plane options for new streams;
715 * - configures the data-plane options on the default XSO, if there is one.
717 * Setting options on a QSSO
718 * - configures data-plane options for that stream only.
721 static uint64_t quic_mask_or_options(SSL *ssl, uint64_t mask_value, uint64_t or_value)
724 uint64_t hs_mask_value, hs_or_value, ret;
726 if (!expect_quic(ssl, &ctx))
731 if (!ctx.is_stream) {
733 * If we were called on the connection, we apply any handshake option
736 hs_mask_value = (mask_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
737 hs_or_value = (or_value & OSSL_QUIC_PERMITTED_OPTIONS_CONN);
739 SSL_clear_options(ctx.qc->tls, hs_mask_value);
740 SSL_set_options(ctx.qc->tls, hs_or_value);
742 /* Update defaults for new streams. */
743 ctx.qc->default_ssl_options
744 = ((ctx.qc->default_ssl_options & ~mask_value) | or_value)
745 & OSSL_QUIC_PERMITTED_OPTIONS;
748 if (ctx.xso != NULL) {
750 = ((ctx.xso->ssl_options & ~mask_value) | or_value)
751 & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
753 xso_update_options(ctx.xso);
756 ret = ctx.is_stream ? ctx.xso->ssl_options : ctx.qc->default_ssl_options;
762 uint64_t ossl_quic_set_options(SSL *ssl, uint64_t options)
764 return quic_mask_or_options(ssl, 0, options);
767 /* SSL_clear_options */
768 uint64_t ossl_quic_clear_options(SSL *ssl, uint64_t options)
770 return quic_mask_or_options(ssl, options, 0);
773 /* SSL_get_options */
774 uint64_t ossl_quic_get_options(const SSL *ssl)
776 return quic_mask_or_options((SSL *)ssl, 0, 0);
780 * QUIC Front-End I/O API: Network BIO Configuration
781 * =================================================
783 * Handling the different BIOs is difficult:
785 * - It is more or less a requirement that we use non-blocking network I/O;
786 * we need to be able to have timeouts on recv() calls, and make best effort
787 * (non blocking) send() and recv() calls.
789 * The only sensible way to do this is to configure the socket into
790 * non-blocking mode. We could try to do select() before calling send() or
791 * recv() to get a guarantee that the call will not block, but this will
792 * probably run into issues with buggy OSes which generate spurious socket
793 * readiness events. In any case, relying on this to work reliably does not
796 * Timeouts could be handled via setsockopt() socket timeout options, but
797 * this depends on OS support and adds another syscall to every network I/O
798 * operation. It also has obvious thread safety concerns if we want to move
799 * to concurrent use of a single socket at some later date.
801 * Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
802 * be made non-blocking. However some OSes (e.g. Windows) do not support
803 * this, so we cannot rely on this.
805 * As such, we need to configure any FD in non-blocking mode. This may
806 * confound users who pass a blocking socket to libssl. However, in practice
807 * it would be extremely strange for a user of QUIC to pass an FD to us,
808 * then also try and send receive traffic on the same socket(!). Thus the
809 * impact of this should be limited, and can be documented.
811 * - We support both blocking and non-blocking operation in terms of the API
812 * presented to the user. One prospect is to set the blocking mode based on
813 * whether the socket passed to us was already in blocking mode. However,
814 * Windows has no API for determining if a socket is in blocking mode (!),
815 * therefore this cannot be done portably. Currently therefore we expose an
816 * explicit API call to set this, and default to blocking mode.
818 * - We need to determine our initial destination UDP address. The "natural"
819 * way for a user to do this is to set the peer variable on a BIO_dgram.
820 * However, this has problems because BIO_dgram's peer variable is used for
821 * both transmission and reception. This means it can be constantly being
822 * changed to a malicious value (e.g. if some random unrelated entity on the
823 * network starts sending traffic to us) on every read call. This is not a
824 * direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
825 * calls only, which do not use this variable. However, we do need to let
826 * the user specify the peer in a 'normal' manner. The compromise here is
827 * that we grab the current peer value set at the time the write BIO is set
828 * and do not read the value again.
830 * - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
831 * Currently we do this by only supporting non-blocking mode.
836 * Determines what initial destination UDP address we should use, if possible.
837 * If this fails the client must set the destination address manually, or use a
838 * BIO which does not need a destination address.
840 static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
842 if (BIO_dgram_detect_peer_addr(net_wbio, peer) <= 0)
848 static int qc_can_support_blocking_cached(QUIC_CONNECTION *qc)
850 QUIC_REACTOR *rtor = ossl_quic_channel_get_reactor(qc->ch);
852 return ossl_quic_reactor_can_poll_r(rtor)
853 && ossl_quic_reactor_can_poll_w(rtor);
856 static void qc_update_can_support_blocking(QUIC_CONNECTION *qc)
858 ossl_quic_channel_update_poll_descriptors(qc->ch); /* best effort */
861 static void qc_update_blocking_mode(QUIC_CONNECTION *qc)
863 qc->blocking = qc->desires_blocking && qc_can_support_blocking_cached(qc);
866 void ossl_quic_conn_set0_net_rbio(SSL *s, BIO *net_rbio)
870 if (!expect_quic(s, &ctx))
873 if (ctx.qc->net_rbio == net_rbio)
876 if (!ossl_quic_channel_set_net_rbio(ctx.qc->ch, net_rbio))
879 BIO_free(ctx.qc->net_rbio);
880 ctx.qc->net_rbio = net_rbio;
882 if (net_rbio != NULL)
883 BIO_set_nbio(net_rbio, 1); /* best effort autoconfig */
886 * Determine if the current pair of read/write BIOs now set allows blocking
887 * mode to be supported.
889 qc_update_can_support_blocking(ctx.qc);
890 qc_update_blocking_mode(ctx.qc);
893 void ossl_quic_conn_set0_net_wbio(SSL *s, BIO *net_wbio)
897 if (!expect_quic(s, &ctx))
900 if (ctx.qc->net_wbio == net_wbio)
903 if (!ossl_quic_channel_set_net_wbio(ctx.qc->ch, net_wbio))
906 BIO_free(ctx.qc->net_wbio);
907 ctx.qc->net_wbio = net_wbio;
909 if (net_wbio != NULL)
910 BIO_set_nbio(net_wbio, 1); /* best effort autoconfig */
913 * Determine if the current pair of read/write BIOs now set allows blocking
914 * mode to be supported.
916 qc_update_can_support_blocking(ctx.qc);
917 qc_update_blocking_mode(ctx.qc);
920 BIO *ossl_quic_conn_get_net_rbio(const SSL *s)
924 if (!expect_quic(s, &ctx))
927 return ctx.qc->net_rbio;
930 BIO *ossl_quic_conn_get_net_wbio(const SSL *s)
934 if (!expect_quic(s, &ctx))
937 return ctx.qc->net_wbio;
940 int ossl_quic_conn_get_blocking_mode(const SSL *s)
944 if (!expect_quic(s, &ctx))
948 return xso_blocking_mode(ctx.xso);
950 return qc_blocking_mode(ctx.qc);
954 int ossl_quic_conn_set_blocking_mode(SSL *s, int blocking)
959 if (!expect_quic(s, &ctx))
964 /* Sanity check - can we support the request given the current network BIO? */
967 * If called directly on a QCSO, update our information on network BIO
971 qc_update_can_support_blocking(ctx.qc);
973 /* Cannot enable blocking mode if we do not have pollable FDs. */
974 if (!qc_can_support_blocking_cached(ctx.qc)) {
975 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
982 * If called directly on a QCSO, update default and connection-level
985 ctx.qc->desires_blocking = (blocking != 0);
987 if (ctx.xso != NULL) {
989 * If called on a QSSO or a QCSO with a default XSO, update the blocking
992 ctx.xso->desires_blocking = (blocking != 0);
993 ctx.xso->desires_blocking_set = 1;
998 qc_update_blocking_mode(ctx.qc);
1003 int ossl_quic_conn_set_initial_peer_addr(SSL *s,
1004 const BIO_ADDR *peer_addr)
1008 if (!expect_quic(s, &ctx))
1011 if (ctx.qc->started)
1012 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
1015 if (peer_addr == NULL) {
1016 BIO_ADDR_clear(&ctx.qc->init_peer_addr);
1020 ctx.qc->init_peer_addr = *peer_addr;
1025 * QUIC Front-End I/O API: Asynchronous I/O Management
1026 * ===================================================
1028 * (BIO/)SSL_handle_events => ossl_quic_handle_events
1029 * (BIO/)SSL_get_event_timeout => ossl_quic_get_event_timeout
1030 * (BIO/)SSL_get_poll_fd => ossl_quic_get_poll_fd
1034 /* Returns 1 if the connection is being used in blocking mode. */
1035 static int qc_blocking_mode(const QUIC_CONNECTION *qc)
1037 return qc->blocking;
1040 static int xso_blocking_mode(const QUIC_XSO *xso)
1042 if (xso->desires_blocking_set)
1043 return xso->desires_blocking && qc_can_support_blocking_cached(xso->conn);
1045 /* Only ever set if we can support blocking. */
1046 return xso->conn->blocking;
1049 /* SSL_handle_events; performs QUIC I/O and timeout processing. */
1051 int ossl_quic_handle_events(SSL *s)
1055 if (!expect_quic(s, &ctx))
1059 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1060 quic_unlock(ctx.qc);
1065 * SSL_get_event_timeout. Get the time in milliseconds until the SSL object
1066 * should next have events handled by the application by calling
1067 * SSL_handle_events(). tv is set to 0 if the object should have events handled
1068 * immediately. If no timeout is currently active, *is_infinite is set to 1 and
1069 * the value of *tv is undefined.
1072 int ossl_quic_get_event_timeout(SSL *s, struct timeval *tv, int *is_infinite)
1075 OSSL_TIME deadline = ossl_time_infinite();
1077 if (!expect_quic(s, &ctx))
1083 = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(ctx.qc->ch));
1085 if (ossl_time_is_infinite(deadline)) {
1089 * Robustness against faulty applications that don't check *is_infinite;
1090 * harmless long timeout.
1092 tv->tv_sec = 1000000;
1095 quic_unlock(ctx.qc);
1099 *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, get_time(ctx.qc)));
1101 quic_unlock(ctx.qc);
1105 /* SSL_get_rpoll_descriptor */
1106 int ossl_quic_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1110 if (!expect_quic(s, &ctx))
1113 if (desc == NULL || ctx.qc->net_rbio == NULL)
1114 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1117 return BIO_get_rpoll_descriptor(ctx.qc->net_rbio, desc);
1120 /* SSL_get_wpoll_descriptor */
1121 int ossl_quic_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
1125 if (!expect_quic(s, &ctx))
1128 if (desc == NULL || ctx.qc->net_wbio == NULL)
1129 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
1132 return BIO_get_wpoll_descriptor(ctx.qc->net_wbio, desc);
1135 /* SSL_net_read_desired */
1137 int ossl_quic_get_net_read_desired(SSL *s)
1142 if (!expect_quic(s, &ctx))
1146 ret = ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
1147 quic_unlock(ctx.qc);
1151 /* SSL_net_write_desired */
1153 int ossl_quic_get_net_write_desired(SSL *s)
1158 if (!expect_quic(s, &ctx))
1162 ret = ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
1163 quic_unlock(ctx.qc);
1168 * QUIC Front-End I/O API: Connection Lifecycle Operations
1169 * =======================================================
1171 * SSL_do_handshake => ossl_quic_do_handshake
1172 * SSL_set_connect_state => ossl_quic_set_connect_state
1173 * SSL_set_accept_state => ossl_quic_set_accept_state
1174 * SSL_shutdown => ossl_quic_shutdown
1175 * SSL_ctrl => ossl_quic_ctrl
1176 * (BIO/)SSL_connect => ossl_quic_connect
1177 * (BIO/)SSL_accept => ossl_quic_accept
1182 static void qc_shutdown_flush_init(QUIC_CONNECTION *qc)
1184 QUIC_STREAM_MAP *qsm;
1186 if (qc->shutting_down)
1189 qsm = ossl_quic_channel_get_qsm(qc->ch);
1191 ossl_quic_stream_map_begin_shutdown_flush(qsm);
1192 qc->shutting_down = 1;
1195 /* Returns 1 if all shutdown-flush streams have been done with. */
1197 static int qc_shutdown_flush_finished(QUIC_CONNECTION *qc)
1199 QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
1201 return qc->shutting_down
1202 && ossl_quic_stream_map_is_shutdown_flush_finished(qsm);
1206 static int quic_shutdown_wait(void *arg)
1208 QUIC_CONNECTION *qc = arg;
1210 return ossl_quic_channel_is_terminated(qc->ch);
1213 /* Returns 1 if shutdown flush process has finished or is inapplicable. */
1214 static int quic_shutdown_flush_wait(void *arg)
1216 QUIC_CONNECTION *qc = arg;
1218 return ossl_quic_channel_is_term_any(qc->ch)
1219 || qc_shutdown_flush_finished(qc);
1222 static int quic_shutdown_peer_wait(void *arg)
1224 QUIC_CONNECTION *qc = arg;
1225 return ossl_quic_channel_is_term_any(qc->ch);
1229 int ossl_quic_conn_shutdown(SSL *s, uint64_t flags,
1230 const SSL_SHUTDOWN_EX_ARGS *args,
1235 int stream_flush = ((flags & SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH) == 0);
1236 int no_block = ((flags & SSL_SHUTDOWN_FLAG_NO_BLOCK) != 0);
1237 int wait_peer = ((flags & SSL_SHUTDOWN_FLAG_WAIT_PEER) != 0);
1239 if (!expect_quic(s, &ctx))
1242 if (ctx.is_stream) {
1243 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_CONN_USE_ONLY, NULL);
1249 if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1250 quic_unlock(ctx.qc);
1254 /* Phase 1: Stream Flushing */
1255 if (!wait_peer && stream_flush) {
1256 qc_shutdown_flush_init(ctx.qc);
1258 if (!qc_shutdown_flush_finished(ctx.qc)) {
1259 if (!no_block && qc_blocking_mode(ctx.qc)) {
1260 ret = block_until_pred(ctx.qc, quic_shutdown_flush_wait, ctx.qc, 0);
1266 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1270 if (!qc_shutdown_flush_finished(ctx.qc)) {
1271 quic_unlock(ctx.qc);
1272 return 0; /* ongoing */
1276 /* Phase 2: Connection Closure */
1277 if (wait_peer && !ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1278 if (!no_block && qc_blocking_mode(ctx.qc)) {
1279 ret = block_until_pred(ctx.qc, quic_shutdown_peer_wait, ctx.qc, 0);
1285 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1288 if (!ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1289 ret = 0; /* peer hasn't closed yet - still not done */
1294 * We are at least terminating - go through the normal process of
1295 * waiting until we are in the TERMINATED state.
1299 /* Block mutation ops regardless of if we did stream flush. */
1300 ctx.qc->shutting_down = 1;
1303 * This call is a no-op if we are already terminating, so it doesn't
1304 * affect the wait_peer case.
1306 ossl_quic_channel_local_close(ctx.qc->ch,
1307 args != NULL ? args->quic_error_code : 0,
1308 args != NULL ? args->quic_reason : NULL);
1310 SSL_set_shutdown(ctx.qc->tls, SSL_SENT_SHUTDOWN);
1312 if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
1313 quic_unlock(ctx.qc);
1317 /* Phase 3: Terminating Wait Time */
1318 if (!no_block && qc_blocking_mode(ctx.qc)
1319 && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0) {
1320 ret = block_until_pred(ctx.qc, quic_shutdown_wait, ctx.qc, 0);
1326 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1329 ret = ossl_quic_channel_is_terminated(ctx.qc->ch);
1331 quic_unlock(ctx.qc);
1336 long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
1340 if (!expect_quic(s, &ctx))
1345 /* If called on a QCSO, update the default mode. */
1347 ctx.qc->default_ssl_mode |= (uint32_t)larg;
1350 * If we were called on a QSSO or have a default stream, we also update
1353 if (ctx.xso != NULL) {
1354 /* Cannot enable EPW while AON write in progress. */
1355 if (ctx.xso->aon_write_in_progress)
1356 larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
1358 ctx.xso->ssl_mode |= (uint32_t)larg;
1359 return ctx.xso->ssl_mode;
1362 return ctx.qc->default_ssl_mode;
1363 case SSL_CTRL_CLEAR_MODE:
1365 ctx.qc->default_ssl_mode &= ~(uint32_t)larg;
1367 if (ctx.xso != NULL) {
1368 ctx.xso->ssl_mode &= ~(uint32_t)larg;
1369 return ctx.xso->ssl_mode;
1372 return ctx.qc->default_ssl_mode;
1374 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1375 ossl_quic_channel_set_msg_callback_arg(ctx.qc->ch, parg);
1376 /* This ctrl also needs to be passed to the internal SSL object */
1377 return SSL_ctrl(ctx.qc->tls, cmd, larg, parg);
1379 case DTLS_CTRL_GET_TIMEOUT: /* DTLSv1_get_timeout */
1383 if (!ossl_quic_get_event_timeout(s, parg, &is_infinite))
1386 return !is_infinite;
1388 case DTLS_CTRL_HANDLE_TIMEOUT: /* DTLSv1_handle_timeout */
1389 /* For legacy compatibility with DTLS calls. */
1390 return ossl_quic_handle_events(s) == 1 ? 1 : -1;
1392 /* Mask ctrls we shouldn't support for QUIC. */
1393 case SSL_CTRL_GET_READ_AHEAD:
1394 case SSL_CTRL_SET_READ_AHEAD:
1395 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1396 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1397 case SSL_CTRL_SET_MAX_PIPELINES:
1402 * Probably a TLS related ctrl. Send back to the frontend SSL_ctrl
1403 * implementation. Either SSL_ctrl will handle it itself by direct
1404 * access into handshake layer state, or failing that, it will be passed
1405 * to the handshake layer via the SSL_METHOD vtable. If the ctrl is not
1406 * supported by anything, the handshake layer's ctrl method will finally
1409 return ossl_ctrl_internal(&ctx.qc->ssl, cmd, larg, parg, /*no_quic=*/1);
1413 /* SSL_set_connect_state */
1414 void ossl_quic_set_connect_state(SSL *s)
1418 if (!expect_quic(s, &ctx))
1421 /* Cannot be changed after handshake started */
1422 if (ctx.qc->started || ctx.is_stream)
1425 ctx.qc->as_server_state = 0;
1428 /* SSL_set_accept_state */
1429 void ossl_quic_set_accept_state(SSL *s)
1433 if (!expect_quic(s, &ctx))
1436 /* Cannot be changed after handshake started */
1437 if (ctx.qc->started || ctx.is_stream)
1440 ctx.qc->as_server_state = 1;
1443 /* SSL_do_handshake */
1444 struct quic_handshake_wait_args {
1445 QUIC_CONNECTION *qc;
1448 static int tls_wants_non_io_retry(QUIC_CONNECTION *qc)
1450 int want = SSL_want(qc->tls);
1452 if (want == SSL_X509_LOOKUP
1453 || want == SSL_CLIENT_HELLO_CB
1454 || want == SSL_RETRY_VERIFY)
1460 static int quic_handshake_wait(void *arg)
1462 struct quic_handshake_wait_args *args = arg;
1464 if (!quic_mutation_allowed(args->qc, /*req_active=*/1))
1467 if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
1470 if (tls_wants_non_io_retry(args->qc))
1476 static int configure_channel(QUIC_CONNECTION *qc)
1478 assert(qc->ch != NULL);
1480 if (!ossl_quic_channel_set_net_rbio(qc->ch, qc->net_rbio)
1481 || !ossl_quic_channel_set_net_wbio(qc->ch, qc->net_wbio)
1482 || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
1489 static int create_channel(QUIC_CONNECTION *qc)
1491 QUIC_CHANNEL_ARGS args = {0};
1493 args.libctx = qc->ssl.ctx->libctx;
1494 args.propq = qc->ssl.ctx->propq;
1495 args.is_server = qc->as_server;
1497 args.mutex = qc->mutex;
1498 args.now_cb = get_time_cb;
1499 args.now_cb_arg = qc;
1501 qc->ch = ossl_quic_channel_new(&args);
1502 if (qc->ch == NULL) {
1503 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1511 * Configures a channel with the information we have accumulated via calls made
1512 * to us from the application prior to starting a handshake attempt.
1515 static int ensure_channel_started(QCTX *ctx)
1517 QUIC_CONNECTION *qc = ctx->qc;
1520 if (!configure_channel(qc)) {
1521 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1522 "failed to configure channel");
1526 if (!ossl_quic_channel_start(qc->ch)) {
1527 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1528 "failed to start channel");
1532 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1533 if (qc->is_thread_assisted)
1534 if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch)) {
1535 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR,
1536 "failed to start assist thread");
1547 static int quic_do_handshake(QCTX *ctx)
1550 QUIC_CONNECTION *qc = ctx->qc;
1552 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1553 /* Handshake already completed. */
1556 if (!quic_mutation_allowed(qc, /*req_active=*/0))
1557 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1559 if (qc->as_server != qc->as_server_state) {
1560 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
1561 return -1; /* Non-protocol error */
1564 if (qc->net_rbio == NULL || qc->net_wbio == NULL) {
1565 /* Need read and write BIOs. */
1566 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BIO_NOT_SET, NULL);
1567 return -1; /* Non-protocol error */
1571 * We need to determine our addressing mode. There are basically two
1572 * ways we can use L4 addresses:
1574 * - Addressed mode, in which our BIO_sendmmsg calls have destination
1575 * addresses attached to them which we expect the underlying network BIO
1578 * - Unaddressed mode, in which the BIO provided to us on the
1579 * network side neither provides us with L4 addresses nor is capable of
1580 * honouring ones we provide. We don't know where the QUIC traffic we
1581 * send ends up exactly and trust the application to know what it is
1584 * Addressed mode is preferred because it enables support for connection
1585 * migration, multipath, etc. in the future. Addressed mode is automatically
1586 * enabled if we are using e.g. BIO_s_datagram, with or without
1589 * If we are passed a BIO_s_dgram_pair (or some custom BIO) we may have to
1590 * use unaddressed mode unless that BIO supports capability flags indicating
1591 * it can provide and honour L4 addresses.
1593 * Our strategy for determining address mode is simple: we probe the
1594 * underlying network BIOs for their capabilities. If the network BIOs
1595 * support what we need, we use addressed mode. Otherwise, we use
1598 * If addressed mode is chosen, we require an initial peer address to be
1599 * set. If this is not set, we fail. If unaddressed mode is used, we do not
1600 * require this, as such an address is superfluous, though it can be set if
1603 if (!qc->started && !qc->addressing_probe_done) {
1604 long rcaps = BIO_dgram_get_effective_caps(qc->net_rbio);
1605 long wcaps = BIO_dgram_get_effective_caps(qc->net_wbio);
1607 qc->addressed_mode_r = ((rcaps & BIO_DGRAM_CAP_PROVIDES_SRC_ADDR) != 0);
1608 qc->addressed_mode_w = ((wcaps & BIO_DGRAM_CAP_HANDLES_DST_ADDR) != 0);
1609 qc->addressing_probe_done = 1;
1612 if (!qc->started && qc->addressed_mode_w
1613 && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1615 * We are trying to connect and are using addressed mode, which means we
1616 * need an initial peer address; if we do not have a peer address yet,
1617 * we should try to autodetect one.
1619 * We do this as late as possible because some BIOs (e.g. BIO_s_connect)
1620 * may not be able to provide us with a peer address until they have
1621 * finished their own processing. They may not be able to perform this
1622 * processing until an application has finished configuring that BIO
1623 * (e.g. with setter calls), which might happen after SSL_set_bio is
1626 if (!csm_analyse_init_peer_addr(qc->net_wbio, &qc->init_peer_addr))
1628 BIO_ADDR_clear(&qc->init_peer_addr);
1630 ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr);
1634 && qc->addressed_mode_w
1635 && BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1637 * If we still don't have a peer address in addressed mode, we can't do
1640 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
1641 return -1; /* Non-protocol error */
1645 * Start connection process. Note we may come here multiple times in
1646 * non-blocking mode, which is fine.
1648 if (!ensure_channel_started(ctx)) /* raises on failure */
1649 return -1; /* Non-protocol error */
1651 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1652 /* The handshake is now done. */
1655 if (!qc_blocking_mode(qc)) {
1656 /* Try to advance the reactor. */
1657 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1659 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1660 /* The handshake is now done. */
1663 if (ossl_quic_channel_is_term_any(qc->ch)) {
1664 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1666 } else if (qc->desires_blocking) {
1668 * As a special case when doing a handshake when blocking mode is
1669 * desired yet not available, see if the network BIOs have become
1670 * poll descriptor-enabled. This supports BIOs such as BIO_s_connect
1671 * which do late creation of socket FDs and therefore cannot expose
1672 * a poll descriptor until after a network BIO is set on the QCSO.
1674 assert(!qc->blocking);
1675 qc_update_can_support_blocking(qc);
1676 qc_update_blocking_mode(qc);
1681 * We are either in blocking mode or just entered it due to the code above.
1683 if (qc_blocking_mode(qc)) {
1684 /* In blocking mode, wait for the handshake to complete. */
1685 struct quic_handshake_wait_args args;
1689 ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
1690 if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
1691 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1692 return 0; /* Shutdown before completion */
1693 } else if (ret <= 0) {
1694 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1695 return -1; /* Non-protocol error */
1698 if (tls_wants_non_io_retry(qc)) {
1699 QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
1703 assert(ossl_quic_channel_is_handshake_complete(qc->ch));
1707 if (tls_wants_non_io_retry(qc)) {
1708 QUIC_RAISE_NORMAL_ERROR(ctx, SSL_get_error(qc->tls, 0));
1713 * Otherwise, indicate that the handshake isn't done yet.
1714 * We can only get here in non-blocking mode.
1716 QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1717 return -1; /* Non-protocol error */
1721 int ossl_quic_do_handshake(SSL *s)
1726 if (!expect_quic(s, &ctx))
1729 quic_lock_for_io(&ctx);
1731 ret = quic_do_handshake(&ctx);
1732 quic_unlock(ctx.qc);
1737 int ossl_quic_connect(SSL *s)
1739 /* Ensure we are in connect state (no-op if non-idle). */
1740 ossl_quic_set_connect_state(s);
1742 /* Begin or continue the handshake */
1743 return ossl_quic_do_handshake(s);
1747 int ossl_quic_accept(SSL *s)
1749 /* Ensure we are in accept state (no-op if non-idle). */
1750 ossl_quic_set_accept_state(s);
1752 /* Begin or continue the handshake */
1753 return ossl_quic_do_handshake(s);
1757 * QUIC Front-End I/O API: Stream Lifecycle Operations
1758 * ===================================================
1760 * SSL_stream_new => ossl_quic_conn_stream_new
1765 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
1766 * default XSO was created. Returns 0 if it was not (e.g. because it already
1767 * exists). Note that this is NOT an error condition.
1770 static int qc_try_create_default_xso_for_write(QCTX *ctx)
1773 QUIC_CONNECTION *qc = ctx->qc;
1775 if (qc->default_xso_created
1776 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1778 * We only do this once. If the user detaches a previously created
1779 * default XSO we don't auto-create another one.
1781 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1783 /* Create a locally-initiated stream. */
1784 if (qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_AUTO_UNI)
1785 flags |= SSL_STREAM_FLAG_UNI;
1787 qc_set_default_xso(qc, (QUIC_XSO *)quic_conn_stream_new(ctx, flags,
1790 if (qc->default_xso == NULL)
1791 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1793 qc_touch_default_xso(qc);
1797 struct quic_wait_for_stream_args {
1798 QUIC_CONNECTION *qc;
1805 static int quic_wait_for_stream(void *arg)
1807 struct quic_wait_for_stream_args *args = arg;
1809 if (!quic_mutation_allowed(args->qc, /*req_active=*/1)) {
1810 /* If connection is torn down due to an error while blocking, stop. */
1811 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1815 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1816 args->expect_id | QUIC_STREAM_DIR_BIDI);
1817 if (args->qs == NULL)
1818 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1819 args->expect_id | QUIC_STREAM_DIR_UNI);
1821 if (args->qs != NULL)
1822 return 1; /* stream now exists */
1824 return 0; /* did not get a stream, keep trying */
1828 static int qc_wait_for_default_xso_for_read(QCTX *ctx)
1830 /* Called on a QCSO and we don't currently have a default stream. */
1832 QUIC_CONNECTION *qc = ctx->qc;
1835 struct quic_wait_for_stream_args wargs;
1838 * If default stream functionality is disabled or we already detached
1839 * one, don't make another default stream and just fail.
1841 if (qc->default_xso_created
1842 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1843 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1846 * The peer may have opened a stream since we last ticked. So tick and
1847 * see if the stream with ordinal 0 (remote, bidi/uni based on stream
1848 * mode) exists yet. QUIC stream IDs must be allocated in order, so the
1849 * first stream created by a peer must have an ordinal of 0.
1851 expect_id = qc->as_server
1852 ? QUIC_STREAM_INITIATOR_CLIENT
1853 : QUIC_STREAM_INITIATOR_SERVER;
1855 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1856 expect_id | QUIC_STREAM_DIR_BIDI);
1858 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1859 expect_id | QUIC_STREAM_DIR_UNI);
1862 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1864 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1869 if (!qc_blocking_mode(qc))
1870 /* Non-blocking mode, so just bail immediately. */
1871 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1873 /* Block until we have a stream. */
1877 wargs.expect_id = expect_id;
1879 res = block_until_pred(qc, quic_wait_for_stream, &wargs, 0);
1881 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1882 else if (res < 0 || wargs.qs == NULL)
1883 /* quic_wait_for_stream raised error here */
1890 * We now have qs != NULL. Make it the default stream, creating the
1893 qc_set_default_xso(qc, create_xso_from_stream(qc, qs), /*touch=*/0);
1894 if (qc->default_xso == NULL)
1895 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1897 qc_touch_default_xso(qc); /* inhibits default XSO */
1902 static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs)
1904 QUIC_XSO *xso = NULL;
1906 if ((xso = OPENSSL_zalloc(sizeof(*xso))) == NULL) {
1907 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_CRYPTO_LIB, NULL);
1911 if (!ossl_ssl_init(&xso->ssl, qc->ssl.ctx, qc->ssl.method, SSL_TYPE_QUIC_XSO)) {
1912 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
1917 if (!SSL_up_ref(&qc->ssl)) {
1918 QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_SSL_LIB, NULL);
1923 xso->ssl_mode = qc->default_ssl_mode;
1925 = qc->default_ssl_options & OSSL_QUIC_PERMITTED_OPTIONS_STREAM;
1926 xso->last_error = SSL_ERROR_NONE;
1931 xso_update_options(xso);
1939 struct quic_new_stream_wait_args {
1940 QUIC_CONNECTION *qc;
1944 static int quic_new_stream_wait(void *arg)
1946 struct quic_new_stream_wait_args *args = arg;
1947 QUIC_CONNECTION *qc = args->qc;
1949 if (!quic_mutation_allowed(qc, /*req_active=*/1))
1952 if (ossl_quic_channel_is_new_local_stream_admissible(qc->ch, args->is_uni))
1958 /* locking depends on need_lock */
1959 static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock)
1962 QUIC_CONNECTION *qc = ctx->qc;
1963 QUIC_XSO *xso = NULL;
1964 QUIC_STREAM *qs = NULL;
1965 int is_uni = ((flags & SSL_STREAM_FLAG_UNI) != 0);
1966 int no_blocking = ((flags & SSL_STREAM_FLAG_NO_BLOCK) != 0);
1967 int advance = ((flags & SSL_STREAM_FLAG_ADVANCE) != 0);
1972 if (!quic_mutation_allowed(qc, /*req_active=*/0)) {
1973 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1978 && !ossl_quic_channel_is_new_local_stream_admissible(qc->ch, is_uni)) {
1979 struct quic_new_stream_wait_args args;
1982 * Stream count flow control currently doesn't permit this stream to be
1985 if (no_blocking || !qc_blocking_mode(qc)) {
1986 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_STREAM_COUNT_LIMITED, NULL);
1991 args.is_uni = is_uni;
1993 /* Blocking mode - wait until we can get a stream. */
1994 ret = block_until_pred(ctx->qc, quic_new_stream_wait, &args, 0);
1995 if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
1996 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1997 goto err; /* Shutdown before completion */
1998 } else if (ret <= 0) {
1999 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2000 goto err; /* Non-protocol error */
2004 qs = ossl_quic_channel_new_stream_local(qc->ch, is_uni);
2006 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2010 xso = create_xso_from_stream(qc, qs);
2014 qc_touch_default_xso(qc); /* inhibits default XSO */
2022 ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc->ch), qs);
2031 SSL *ossl_quic_conn_stream_new(SSL *s, uint64_t flags)
2035 if (!expect_quic_conn_only(s, &ctx))
2038 return quic_conn_stream_new(&ctx, flags, /*need_lock=*/1);
2042 * QUIC Front-End I/O API: Steady-State Operations
2043 * ===============================================
2045 * Here we dispatch calls to the steady-state front-end I/O API functions; that
2046 * is, the functions used during the established phase of a QUIC connection
2047 * (e.g. SSL_read, SSL_write).
2049 * Each function must handle both blocking and non-blocking modes. As discussed
2050 * above, all QUIC I/O is implemented using non-blocking mode internally.
2052 * SSL_get_error => partially implemented by ossl_quic_get_error
2053 * SSL_want => ossl_quic_want
2054 * (BIO/)SSL_read => ossl_quic_read
2055 * (BIO/)SSL_write => ossl_quic_write
2056 * SSL_pending => ossl_quic_pending
2057 * SSL_stream_conclude => ossl_quic_conn_stream_conclude
2058 * SSL_key_update => ossl_quic_key_update
2062 int ossl_quic_get_error(const SSL *s, int i)
2065 int net_error, last_error;
2067 if (!expect_quic(s, &ctx))
2071 net_error = ossl_quic_channel_net_error(ctx.qc->ch);
2072 last_error = ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error;
2073 quic_unlock(ctx.qc);
2076 return SSL_ERROR_SYSCALL;
2081 /* Converts a code returned by SSL_get_error to a code returned by SSL_want. */
2082 static int error_to_want(int error)
2085 case SSL_ERROR_WANT_CONNECT: /* never used - UDP is connectionless */
2086 case SSL_ERROR_WANT_ACCEPT: /* never used - UDP is connectionless */
2087 case SSL_ERROR_ZERO_RETURN:
2091 case SSL_ERROR_WANT_READ:
2094 case SSL_ERROR_WANT_WRITE:
2097 case SSL_ERROR_WANT_RETRY_VERIFY:
2098 return SSL_RETRY_VERIFY;
2100 case SSL_ERROR_WANT_CLIENT_HELLO_CB:
2101 return SSL_CLIENT_HELLO_CB;
2103 case SSL_ERROR_WANT_X509_LOOKUP:
2104 return SSL_X509_LOOKUP;
2109 int ossl_quic_want(const SSL *s)
2114 if (!expect_quic(s, &ctx))
2119 w = error_to_want(ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error);
2121 quic_unlock(ctx.qc);
2129 * The set of functions below provide the implementation of the public SSL_write
2130 * function. We must handle:
2132 * - both blocking and non-blocking operation at the application level,
2133 * depending on how we are configured;
2135 * - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
2137 * - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
2141 static void quic_post_write(QUIC_XSO *xso, int did_append, int do_tick)
2144 * We have appended at least one byte to the stream.
2145 * Potentially mark stream as active, depending on FC.
2148 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso->conn->ch),
2154 * TODO(QUIC FUTURE): It is probably inefficient to try and do this
2155 * immediately, plus we should eventually consider Nagle's algorithm.
2158 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso->conn->ch), 0);
2161 struct quic_write_again_args {
2163 const unsigned char *buf;
2165 size_t total_written;
2170 static int quic_write_again(void *arg)
2172 struct quic_write_again_args *args = arg;
2173 size_t actual_written = 0;
2175 if (!quic_mutation_allowed(args->xso->conn, /*req_active=*/1))
2176 /* If connection is torn down due to an error while blocking, stop. */
2179 if (!quic_validate_for_write(args->xso, &args->err))
2181 * Stream may have become invalid for write due to connection events
2186 args->err = ERR_R_INTERNAL_ERROR;
2187 if (!ossl_quic_sstream_append(args->xso->stream->sstream,
2188 args->buf, args->len, &actual_written))
2191 quic_post_write(args->xso, actual_written > 0, 0);
2193 args->buf += actual_written;
2194 args->len -= actual_written;
2195 args->total_written += actual_written;
2198 /* Written everything, done. */
2201 /* Not written everything yet, keep trying. */
2206 static int quic_write_blocking(QCTX *ctx, const void *buf, size_t len,
2210 QUIC_XSO *xso = ctx->xso;
2211 struct quic_write_again_args args;
2212 size_t actual_written = 0;
2214 /* First make a best effort to append as much of the data as possible. */
2215 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len,
2217 /* Stream already finished or allocation error. */
2219 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2222 quic_post_write(xso, actual_written > 0, 1);
2224 if (actual_written == len) {
2225 /* Managed to append everything on the first try. */
2226 *written = actual_written;
2231 * We did not manage to append all of the data immediately, so the stream
2232 * buffer has probably filled up. This means we need to block until some of
2236 args.buf = (const unsigned char *)buf + actual_written;
2237 args.len = len - actual_written;
2238 args.total_written = 0;
2239 args.err = ERR_R_INTERNAL_ERROR;
2241 res = block_until_pred(xso->conn, quic_write_again, &args, 0);
2243 if (!quic_mutation_allowed(xso->conn, /*req_active=*/1))
2244 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2246 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, args.err, NULL);
2249 *written = args.total_written;
2254 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
2257 static void aon_write_begin(QUIC_XSO *xso, const unsigned char *buf,
2258 size_t buf_len, size_t already_sent)
2260 assert(!xso->aon_write_in_progress);
2262 xso->aon_write_in_progress = 1;
2263 xso->aon_buf_base = buf;
2264 xso->aon_buf_pos = already_sent;
2265 xso->aon_buf_len = buf_len;
2268 static void aon_write_finish(QUIC_XSO *xso)
2270 xso->aon_write_in_progress = 0;
2271 xso->aon_buf_base = NULL;
2272 xso->aon_buf_pos = 0;
2273 xso->aon_buf_len = 0;
2277 static int quic_write_nonblocking_aon(QCTX *ctx, const void *buf,
2278 size_t len, size_t *written)
2280 QUIC_XSO *xso = ctx->xso;
2281 const void *actual_buf;
2282 size_t actual_len, actual_written = 0;
2283 int accept_moving_buffer
2284 = ((xso->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
2286 if (xso->aon_write_in_progress) {
2288 * We are in the middle of an AON write (i.e., a previous write did not
2289 * manage to append all data to the SSTREAM and we have Enable Partial
2290 * Write (EPW) mode disabled.)
2292 if ((!accept_moving_buffer && xso->aon_buf_base != buf)
2293 || len != xso->aon_buf_len)
2295 * Pointer must not have changed if we are not in accept moving
2296 * buffer mode. Length must never change.
2298 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BAD_WRITE_RETRY, NULL);
2300 actual_buf = (unsigned char *)buf + xso->aon_buf_pos;
2301 actual_len = len - xso->aon_buf_pos;
2302 assert(actual_len > 0);
2308 /* First make a best effort to append as much of the data as possible. */
2309 if (!ossl_quic_sstream_append(xso->stream->sstream, actual_buf, actual_len,
2311 /* Stream already finished or allocation error. */
2313 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2316 quic_post_write(xso, actual_written > 0, 1);
2318 if (actual_written == actual_len) {
2319 /* We have sent everything. */
2320 if (xso->aon_write_in_progress) {
2322 * We have sent everything, and we were in the middle of an AON
2323 * write. The output write length is the total length of the AON
2324 * buffer, not however many bytes we managed to write to the stream
2327 *written = xso->aon_buf_len;
2328 aon_write_finish(xso);
2330 *written = actual_written;
2336 if (xso->aon_write_in_progress) {
2338 * AON write is in progress but we have not written everything yet. We
2339 * may have managed to send zero bytes, or some number of bytes less
2340 * than the total remaining which need to be appended during this
2343 xso->aon_buf_pos += actual_written;
2344 assert(xso->aon_buf_pos < xso->aon_buf_len);
2345 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2349 * Not in an existing AON operation but partial write is not enabled, so we
2350 * need to begin a new AON operation. However we needn't bother if we didn't
2351 * actually append anything.
2353 if (actual_written > 0)
2354 aon_write_begin(xso, buf, len, actual_written);
2357 * AON - We do not publicly admit to having appended anything until AON
2361 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
2365 static int quic_write_nonblocking_epw(QCTX *ctx, const void *buf, size_t len,
2368 QUIC_XSO *xso = ctx->xso;
2370 /* Simple best effort operation. */
2371 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len, written)) {
2372 /* Stream already finished or allocation error. */
2374 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2377 quic_post_write(xso, *written > 0, 1);
2382 static int quic_validate_for_write(QUIC_XSO *xso, int *err)
2384 QUIC_STREAM_MAP *qsm;
2386 if (xso == NULL || xso->stream == NULL) {
2387 *err = ERR_R_INTERNAL_ERROR;
2391 switch (xso->stream->send_state) {
2393 case QUIC_SSTREAM_STATE_NONE:
2394 *err = SSL_R_STREAM_RECV_ONLY;
2397 case QUIC_SSTREAM_STATE_READY:
2398 qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2400 if (!ossl_quic_stream_map_ensure_send_part_id(qsm, xso->stream)) {
2401 *err = ERR_R_INTERNAL_ERROR;
2406 case QUIC_SSTREAM_STATE_SEND:
2407 case QUIC_SSTREAM_STATE_DATA_SENT:
2408 case QUIC_SSTREAM_STATE_DATA_RECVD:
2409 if (ossl_quic_sstream_get_final_size(xso->stream->sstream, NULL)) {
2410 *err = SSL_R_STREAM_FINISHED;
2416 case QUIC_SSTREAM_STATE_RESET_SENT:
2417 case QUIC_SSTREAM_STATE_RESET_RECVD:
2418 *err = SSL_R_STREAM_RESET;
2424 int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
2428 int partial_write, err;
2432 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/1, &ctx))
2435 partial_write = ((ctx.xso->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0);
2437 if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
2438 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2443 * If we haven't finished the handshake, try to advance it.
2444 * We don't accept writes until the handshake is completed.
2446 if (quic_do_handshake(&ctx) < 1) {
2451 /* Ensure correct stream state, stream send part not concluded, etc. */
2452 if (!quic_validate_for_write(ctx.xso, &err)) {
2453 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
2462 if (xso_blocking_mode(ctx.xso))
2463 ret = quic_write_blocking(&ctx, buf, len, written);
2464 else if (partial_write)
2465 ret = quic_write_nonblocking_epw(&ctx, buf, len, written);
2467 ret = quic_write_nonblocking_aon(&ctx, buf, len, written);
2470 quic_unlock(ctx.qc);
2478 struct quic_read_again_args {
2480 QUIC_STREAM *stream;
2488 static int quic_validate_for_read(QUIC_XSO *xso, int *err, int *eos)
2490 QUIC_STREAM_MAP *qsm;
2494 if (xso == NULL || xso->stream == NULL) {
2495 *err = ERR_R_INTERNAL_ERROR;
2499 switch (xso->stream->recv_state) {
2501 case QUIC_RSTREAM_STATE_NONE:
2502 *err = SSL_R_STREAM_SEND_ONLY;
2505 case QUIC_RSTREAM_STATE_RECV:
2506 case QUIC_RSTREAM_STATE_SIZE_KNOWN:
2507 case QUIC_RSTREAM_STATE_DATA_RECVD:
2510 case QUIC_RSTREAM_STATE_DATA_READ:
2514 case QUIC_RSTREAM_STATE_RESET_RECVD:
2515 qsm = ossl_quic_channel_get_qsm(xso->conn->ch);
2516 ossl_quic_stream_map_notify_app_read_reset_recv_part(qsm, xso->stream);
2519 case QUIC_RSTREAM_STATE_RESET_READ:
2520 *err = SSL_R_STREAM_RESET;
2526 static int quic_read_actual(QCTX *ctx,
2527 QUIC_STREAM *stream,
2528 void *buf, size_t buf_len,
2532 int is_fin = 0, err, eos;
2533 QUIC_CONNECTION *qc = ctx->qc;
2535 if (!quic_validate_for_read(ctx->xso, &err, &eos)) {
2537 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
2539 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, err, NULL);
2543 if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
2544 bytes_read, &is_fin))
2545 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2548 if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
2549 bytes_read, &is_fin))
2550 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2554 if (*bytes_read > 0) {
2556 * We have read at least one byte from the stream. Inform stream-level
2557 * RXFC of the retirement of controlled bytes. Update the active stream
2558 * status (the RXFC may now want to emit a frame granting more credit to
2561 OSSL_RTT_INFO rtt_info;
2563 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
2565 if (!ossl_quic_rxfc_on_retire(&stream->rxfc, *bytes_read,
2566 rtt_info.smoothed_rtt))
2567 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
2570 if (is_fin && !peek) {
2571 QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(ctx->qc->ch);
2573 ossl_quic_stream_map_notify_totally_read(qsm, ctx->xso->stream);
2576 if (*bytes_read > 0)
2577 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
2581 if (*bytes_read == 0 && is_fin)
2582 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
2588 static int quic_read_again(void *arg)
2590 struct quic_read_again_args *args = arg;
2592 if (!quic_mutation_allowed(args->ctx->qc, /*req_active=*/1)) {
2593 /* If connection is torn down due to an error while blocking, stop. */
2594 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2598 if (!quic_read_actual(args->ctx, args->stream,
2599 args->buf, args->len, args->bytes_read,
2603 if (*args->bytes_read > 0)
2604 /* got at least one byte, the SSL_read op can finish now */
2607 return 0; /* did not read anything, keep trying */
2611 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
2615 struct quic_read_again_args args;
2619 if (!expect_quic(s, &ctx))
2622 quic_lock_for_io(&ctx);
2624 if (!quic_mutation_allowed(ctx.qc, /*req_active=*/0)) {
2625 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2629 /* If we haven't finished the handshake, try to advance it. */
2630 if (quic_do_handshake(&ctx) < 1) {
2631 ret = 0; /* ossl_quic_do_handshake raised error here */
2635 if (ctx.xso == NULL) {
2637 * Called on a QCSO and we don't currently have a default stream.
2639 * Wait until we get a stream initiated by the peer (blocking mode) or
2640 * fail if we don't have one yet (non-blocking mode).
2642 if (!qc_wait_for_default_xso_for_read(&ctx)) {
2643 ret = 0; /* error already raised here */
2647 ctx.xso = ctx.qc->default_xso;
2650 if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
2651 ret = 0; /* quic_read_actual raised error here */
2655 if (*bytes_read > 0) {
2657 * Even though we succeeded, tick the reactor here to ensure we are
2658 * handling other aspects of the QUIC connection.
2660 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
2662 } else if (xso_blocking_mode(ctx.xso)) {
2664 * We were not able to read anything immediately, so our stream
2665 * buffer is empty. This means we need to block until we get
2666 * at least one byte.
2669 args.stream = ctx.xso->stream;
2672 args.bytes_read = bytes_read;
2675 res = block_until_pred(ctx.qc, quic_read_again, &args, 0);
2677 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2679 } else if (res < 0) {
2680 ret = 0; /* quic_read_again raised error here */
2687 * We did not get any bytes and are not in blocking mode.
2688 * Tick to see if this delivers any more.
2690 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
2692 /* Try the read again. */
2693 if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
2694 ret = 0; /* quic_read_actual raised error here */
2698 if (*bytes_read > 0)
2699 ret = 1; /* Succeeded this time. */
2701 ret = QUIC_RAISE_NORMAL_ERROR(&ctx, SSL_ERROR_WANT_READ);
2705 quic_unlock(ctx.qc);
2709 int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
2711 return quic_read(s, buf, len, bytes_read, 0);
2714 int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
2716 return quic_read(s, buf, len, bytes_read, 1);
2725 static size_t ossl_quic_pending_int(const SSL *s, int check_channel)
2732 if (!expect_quic(s, &ctx))
2737 if (ctx.xso == NULL) {
2738 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_NO_STREAM, NULL);
2742 if (ctx.xso->stream == NULL
2743 || !ossl_quic_stream_has_recv_buffer(ctx.xso->stream)) {
2744 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2748 if (!ossl_quic_rstream_available(ctx.xso->stream->rstream, &avail, &fin))
2751 if (avail == 0 && check_channel && ossl_quic_channel_has_pending(ctx.qc->ch))
2755 quic_unlock(ctx.qc);
2759 size_t ossl_quic_pending(const SSL *s)
2761 return ossl_quic_pending_int(s, /*check_channel=*/0);
2764 int ossl_quic_has_pending(const SSL *s)
2766 /* Do we have app-side pending data or pending URXEs or RXEs? */
2767 return ossl_quic_pending_int(s, /*check_channel=*/1) > 0;
2771 * SSL_stream_conclude
2772 * -------------------
2775 int ossl_quic_conn_stream_conclude(SSL *s)
2781 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, /*io=*/0, &ctx))
2784 qs = ctx.xso->stream;
2786 if (!quic_mutation_allowed(ctx.qc, /*req_active=*/1)) {
2787 quic_unlock(ctx.qc);
2788 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2791 if (!quic_validate_for_write(ctx.xso, &err)) {
2792 quic_unlock(ctx.qc);
2793 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
2796 if (ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
2797 quic_unlock(ctx.qc);
2801 ossl_quic_sstream_fin(qs->sstream);
2802 quic_post_write(ctx.xso, 1, 1);
2803 quic_unlock(ctx.qc);
2808 * SSL_inject_net_dgram
2809 * --------------------
2812 int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
2814 const BIO_ADDR *peer,
2815 const BIO_ADDR *local)
2821 if (!expect_quic(s, &ctx))
2826 demux = ossl_quic_channel_get0_demux(ctx.qc->ch);
2827 ret = ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
2829 quic_unlock(ctx.qc);
2834 * SSL_get0_connection
2835 * -------------------
2837 SSL *ossl_quic_get0_connection(SSL *s)
2841 if (!expect_quic(s, &ctx))
2844 return &ctx.qc->ssl;
2848 * SSL_get_stream_type
2849 * -------------------
2851 int ossl_quic_get_stream_type(SSL *s)
2855 if (!expect_quic(s, &ctx))
2856 return SSL_STREAM_TYPE_BIDI;
2858 if (ctx.xso == NULL) {
2860 * If deferred XSO creation has yet to occur, proceed according to the
2861 * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
2862 * what kind of stream will be created yet, so return BIDI on the basis
2863 * that at this time, the client still has the option of calling
2864 * SSL_read() or SSL_write() first.
2866 if (ctx.qc->default_xso_created
2867 || ctx.qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2868 return SSL_STREAM_TYPE_NONE;
2870 return SSL_STREAM_TYPE_BIDI;
2873 if (ossl_quic_stream_is_bidi(ctx.xso->stream))
2874 return SSL_STREAM_TYPE_BIDI;
2876 if (ossl_quic_stream_is_server_init(ctx.xso->stream) != ctx.qc->as_server)
2877 return SSL_STREAM_TYPE_READ;
2879 return SSL_STREAM_TYPE_WRITE;
2887 uint64_t ossl_quic_get_stream_id(SSL *s)
2892 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
2895 id = ctx.xso->stream->id;
2896 quic_unlock(ctx.qc);
2902 * SSL_is_stream_local
2903 * -------------------
2906 int ossl_quic_is_stream_local(SSL *s)
2911 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, /*io=*/0, &ctx))
2914 is_local = ossl_quic_stream_is_local_init(ctx.xso->stream);
2915 quic_unlock(ctx.qc);
2921 * SSL_set_default_stream_mode
2922 * ---------------------------
2925 int ossl_quic_set_default_stream_mode(SSL *s, uint32_t mode)
2929 if (!expect_quic_conn_only(s, &ctx))
2934 if (ctx.qc->default_xso_created) {
2935 quic_unlock(ctx.qc);
2936 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
2937 "too late to change default stream mode");
2941 case SSL_DEFAULT_STREAM_MODE_NONE:
2942 case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI:
2943 case SSL_DEFAULT_STREAM_MODE_AUTO_UNI:
2944 ctx.qc->default_stream_mode = mode;
2947 quic_unlock(ctx.qc);
2948 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
2949 "bad default stream type");
2952 quic_unlock(ctx.qc);
2961 SSL *ossl_quic_detach_stream(SSL *s)
2964 QUIC_XSO *xso = NULL;
2966 if (!expect_quic_conn_only(s, &ctx))
2971 /* Calling this function inhibits default XSO autocreation. */
2972 /* QC ref to any default XSO is transferred to us and to caller. */
2973 qc_set_default_xso_keep_ref(ctx.qc, NULL, /*touch=*/1, &xso);
2975 quic_unlock(ctx.qc);
2977 return xso != NULL ? &xso->ssl : NULL;
2985 int ossl_quic_attach_stream(SSL *conn, SSL *stream)
2991 if (!expect_quic_conn_only(conn, &ctx))
2994 if (stream == NULL || stream->type != SSL_TYPE_QUIC_XSO)
2995 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_NULL_PARAMETER,
2996 "stream to attach must be a valid QUIC stream");
2998 xso = (QUIC_XSO *)stream;
3002 if (ctx.qc->default_xso != NULL) {
3003 quic_unlock(ctx.qc);
3004 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
3005 "connection already has a default stream");
3009 * It is a caller error for the XSO being attached as a default XSO to have
3010 * more than one ref.
3012 if (!CRYPTO_GET_REF(&xso->ssl.references, &nref)) {
3013 quic_unlock(ctx.qc);
3014 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR,
3019 quic_unlock(ctx.qc);
3020 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
3021 "stream being attached must have "
3022 "only 1 reference");
3025 /* Caller's reference to the XSO is transferred to us. */
3026 /* Calling this function inhibits default XSO autocreation. */
3027 qc_set_default_xso(ctx.qc, xso, /*touch=*/1);
3029 quic_unlock(ctx.qc);
3034 * SSL_set_incoming_stream_policy
3035 * ------------------------------
3038 static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION *qc)
3040 switch (qc->incoming_stream_policy) {
3041 case SSL_INCOMING_STREAM_POLICY_AUTO:
3042 if ((qc->default_xso == NULL && !qc->default_xso_created)
3043 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
3044 return SSL_INCOMING_STREAM_POLICY_ACCEPT;
3046 return SSL_INCOMING_STREAM_POLICY_REJECT;
3049 return qc->incoming_stream_policy;
3054 static void qc_update_reject_policy(QUIC_CONNECTION *qc)
3056 int policy = qc_get_effective_incoming_stream_policy(qc);
3057 int enable_reject = (policy == SSL_INCOMING_STREAM_POLICY_REJECT);
3059 ossl_quic_channel_set_incoming_stream_auto_reject(qc->ch,
3061 qc->incoming_stream_aec);
3065 int ossl_quic_set_incoming_stream_policy(SSL *s, int policy,
3071 if (!expect_quic_conn_only(s, &ctx))
3077 case SSL_INCOMING_STREAM_POLICY_AUTO:
3078 case SSL_INCOMING_STREAM_POLICY_ACCEPT:
3079 case SSL_INCOMING_STREAM_POLICY_REJECT:
3080 ctx.qc->incoming_stream_policy = policy;
3081 ctx.qc->incoming_stream_aec = aec;
3085 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3090 qc_update_reject_policy(ctx.qc);
3091 quic_unlock(ctx.qc);
3099 struct wait_for_incoming_stream_args {
3105 static int wait_for_incoming_stream(void *arg)
3107 struct wait_for_incoming_stream_args *args = arg;
3108 QUIC_CONNECTION *qc = args->ctx->qc;
3109 QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
3111 if (!quic_mutation_allowed(qc, /*req_active=*/1)) {
3112 /* If connection is torn down due to an error while blocking, stop. */
3113 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
3117 args->qs = ossl_quic_stream_map_peek_accept_queue(qsm);
3118 if (args->qs != NULL)
3119 return 1; /* got a stream */
3121 return 0; /* did not get a stream, keep trying */
3125 SSL *ossl_quic_accept_stream(SSL *s, uint64_t flags)
3130 QUIC_STREAM_MAP *qsm;
3133 OSSL_RTT_INFO rtt_info;
3135 if (!expect_quic_conn_only(s, &ctx))
3140 if (qc_get_effective_incoming_stream_policy(ctx.qc)
3141 == SSL_INCOMING_STREAM_POLICY_REJECT) {
3142 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
3146 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
3148 qs = ossl_quic_stream_map_peek_accept_queue(qsm);
3150 if (qc_blocking_mode(ctx.qc)
3151 && (flags & SSL_ACCEPT_STREAM_NO_BLOCK) == 0) {
3152 struct wait_for_incoming_stream_args args;
3157 ret = block_until_pred(ctx.qc, wait_for_incoming_stream, &args, 0);
3159 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3161 } else if (ret < 0 || args.qs == NULL) {
3171 xso = create_xso_from_stream(ctx.qc, qs);
3175 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx.qc->ch), &rtt_info);
3176 ossl_quic_stream_map_remove_from_accept_queue(qsm, qs,
3177 rtt_info.smoothed_rtt);
3180 /* Calling this function inhibits default XSO autocreation. */
3181 qc_touch_default_xso(ctx.qc); /* inhibits default XSO */
3184 quic_unlock(ctx.qc);
3189 * SSL_get_accept_stream_queue_len
3190 * -------------------------------
3193 size_t ossl_quic_get_accept_stream_queue_len(SSL *s)
3198 if (!expect_quic_conn_only(s, &ctx))
3203 v = ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(ctx.qc->ch));
3205 quic_unlock(ctx.qc);
3213 int ossl_quic_stream_reset(SSL *ssl,
3214 const SSL_STREAM_RESET_ARGS *args,
3218 QUIC_STREAM_MAP *qsm;
3220 uint64_t error_code;
3223 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/0, /*io=*/0, &ctx))
3226 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
3227 qs = ctx.xso->stream;
3228 error_code = (args != NULL ? args->quic_error_code : 0);
3230 if (!quic_validate_for_write(ctx.xso, &err)) {
3231 ok = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, err, NULL);
3235 ok = ossl_quic_stream_map_reset_stream_send_part(qsm, qs, error_code);
3238 quic_unlock(ctx.qc);
3243 * SSL_get_stream_read_state
3244 * -------------------------
3246 static void quic_classify_stream(QUIC_CONNECTION *qc,
3250 uint64_t *app_error_code)
3253 uint64_t final_size;
3255 local_init = (ossl_quic_stream_is_server_init(qs) == qc->as_server);
3257 if (app_error_code != NULL)
3258 *app_error_code = UINT64_MAX;
3260 app_error_code = &final_size; /* throw away value */
3262 if (!ossl_quic_stream_is_bidi(qs) && local_init != is_write) {
3264 * Unidirectional stream and this direction of transmission doesn't
3267 *state = SSL_STREAM_STATE_WRONG_DIR;
3268 } else if (ossl_quic_channel_is_term_any(qc->ch)) {
3269 /* Connection already closed. */
3270 *state = SSL_STREAM_STATE_CONN_CLOSED;
3271 } else if (!is_write && qs->recv_state == QUIC_RSTREAM_STATE_DATA_READ) {
3272 /* Application has read a FIN. */
3273 *state = SSL_STREAM_STATE_FINISHED;
3274 } else if ((!is_write && qs->stop_sending)
3275 || (is_write && ossl_quic_stream_send_is_reset(qs))) {
3277 * Stream has been reset locally. FIN takes precedence over this for the
3278 * read case as the application need not care if the stream is reset
3279 * after a FIN has been successfully processed.
3281 *state = SSL_STREAM_STATE_RESET_LOCAL;
3282 *app_error_code = !is_write
3283 ? qs->stop_sending_aec
3284 : qs->reset_stream_aec;
3285 } else if ((!is_write && ossl_quic_stream_recv_is_reset(qs))
3286 || (is_write && qs->peer_stop_sending)) {
3288 * Stream has been reset remotely. */
3289 *state = SSL_STREAM_STATE_RESET_REMOTE;
3290 *app_error_code = !is_write
3291 ? qs->peer_reset_stream_aec
3292 : qs->peer_stop_sending_aec;
3293 } else if (is_write && ossl_quic_sstream_get_final_size(qs->sstream,
3296 * Stream has been finished. Stream reset takes precedence over this for
3297 * the write case as peer may not have received all data.
3299 *state = SSL_STREAM_STATE_FINISHED;
3301 /* Stream still healthy. */
3302 *state = SSL_STREAM_STATE_OK;
3306 static int quic_get_stream_state(SSL *ssl, int is_write)
3311 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3312 return SSL_STREAM_STATE_NONE;
3314 quic_classify_stream(ctx.qc, ctx.xso->stream, is_write, &state, NULL);
3315 quic_unlock(ctx.qc);
3319 int ossl_quic_get_stream_read_state(SSL *ssl)
3321 return quic_get_stream_state(ssl, /*is_write=*/0);
3325 * SSL_get_stream_write_state
3326 * --------------------------
3328 int ossl_quic_get_stream_write_state(SSL *ssl)
3330 return quic_get_stream_state(ssl, /*is_write=*/1);
3334 * SSL_get_stream_read_error_code
3335 * ------------------------------
3337 static int quic_get_stream_error_code(SSL *ssl, int is_write,
3338 uint64_t *app_error_code)
3343 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3346 quic_classify_stream(ctx.qc, ctx.xso->stream, /*is_write=*/0,
3347 &state, app_error_code);
3349 quic_unlock(ctx.qc);
3351 case SSL_STREAM_STATE_FINISHED:
3353 case SSL_STREAM_STATE_RESET_LOCAL:
3354 case SSL_STREAM_STATE_RESET_REMOTE:
3361 int ossl_quic_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code)
3363 return quic_get_stream_error_code(ssl, /*is_write=*/0, app_error_code);
3367 * SSL_get_stream_write_error_code
3368 * -------------------------------
3370 int ossl_quic_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code)
3372 return quic_get_stream_error_code(ssl, /*is_write=*/1, app_error_code);
3376 * Write buffer size mutation
3377 * --------------------------
3379 int ossl_quic_set_write_buffer_size(SSL *ssl, size_t size)
3384 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, /*io=*/0, &ctx))
3387 if (!ossl_quic_stream_has_send(ctx.xso->stream)) {
3388 /* Called on a unidirectional receive-only stream - error. */
3389 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, NULL);
3393 if (!ossl_quic_stream_has_send_buffer(ctx.xso->stream)) {
3395 * If the stream has a send part but we have disposed of it because we
3396 * no longer need it, this is a no-op.
3402 if (!ossl_quic_sstream_set_buffer_size(ctx.xso->stream->sstream, size)) {
3403 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
3410 quic_unlock(ctx.qc);
3415 * SSL_get_conn_close_info
3416 * -----------------------
3418 int ossl_quic_get_conn_close_info(SSL *ssl,
3419 SSL_CONN_CLOSE_INFO *info,
3423 const QUIC_TERMINATE_CAUSE *tc;
3425 if (!expect_quic_conn_only(ssl, &ctx))
3428 tc = ossl_quic_channel_get_terminate_cause(ctx.qc->ch);
3432 info->error_code = tc->error_code;
3433 info->reason = tc->reason;
3434 info->reason_len = tc->reason_len;
3437 info->flags |= SSL_CONN_CLOSE_FLAG_LOCAL;
3439 info->flags |= SSL_CONN_CLOSE_FLAG_TRANSPORT;
3447 int ossl_quic_key_update(SSL *ssl, int update_type)
3451 if (!expect_quic_conn_only(ssl, &ctx))
3454 switch (update_type) {
3455 case SSL_KEY_UPDATE_NOT_REQUESTED:
3457 * QUIC signals peer key update implicily by triggering a local
3458 * spontaneous TXKU. Silently upgrade this to SSL_KEY_UPDATE_REQUESTED.
3460 case SSL_KEY_UPDATE_REQUESTED:
3464 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
3470 /* Attempt to perform a TXKU. */
3471 if (!ossl_quic_channel_trigger_txku(ctx.qc->ch)) {
3472 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_TOO_MANY_KEY_UPDATES, NULL);
3473 quic_unlock(ctx.qc);
3477 quic_unlock(ctx.qc);
3482 * SSL_get_key_update_type
3483 * -----------------------
3485 int ossl_quic_get_key_update_type(const SSL *s)
3488 * We always handle key updates immediately so a key update is never
3491 return SSL_KEY_UPDATE_NONE;
3495 * QUIC Front-End I/O API: SSL_CTX Management
3496 * ==========================================
3499 long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
3503 return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
3507 long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
3511 if (!expect_quic_conn_only(s, &ctx))
3515 case SSL_CTRL_SET_MSG_CALLBACK:
3516 ossl_quic_channel_set_msg_callback(ctx.qc->ch, (ossl_msg_cb)fp,
3518 /* This callback also needs to be set on the internal SSL object */
3519 return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);;
3522 /* Probably a TLS related ctrl. Defer to our internal SSL object */
3523 return ssl3_callback_ctrl(ctx.qc->tls, cmd, fp);
3527 long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
3529 return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
3532 int ossl_quic_renegotiate_check(SSL *ssl, int initok)
3534 /* We never do renegotiation. */
3538 const SSL_CIPHER *ossl_quic_get_cipher_by_char(const unsigned char *p)
3540 const SSL_CIPHER *ciph = ssl3_get_cipher_by_char(p);
3542 if ((ciph->algorithm2 & SSL_QUIC) == 0)
3549 * These functions define the TLSv1.2 (and below) ciphers that are supported by
3550 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
3553 int ossl_quic_num_ciphers(void)
3558 const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)
3564 * Internal Testing APIs
3565 * =====================
3568 QUIC_CHANNEL *ossl_quic_conn_get_channel(SSL *s)
3572 if (!expect_quic_conn_only(s, &ctx))