2 * Copyright 2022 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 int quic_do_handshake(QCTX *ctx);
30 static void qc_update_reject_policy(QUIC_CONNECTION *qc);
31 static void qc_touch_default_xso(QUIC_CONNECTION *qc);
32 static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch);
33 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
34 int touch, QUIC_XSO **old_xso);
35 static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock);
38 * QUIC Front-End I/O API: Common Utilities
39 * ========================================
43 * Block until a predicate is met.
45 * Precondition: Must have a channel.
46 * Precondition: Must hold channel lock (unchecked).
49 static int block_until_pred(QUIC_CONNECTION *qc,
50 int (*pred)(void *arg), void *pred_arg,
55 assert(qc->ch != NULL);
57 rtor = ossl_quic_channel_get_reactor(qc->ch);
58 return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags,
63 * QCTX is a utility structure which provides information we commonly wish to
64 * unwrap upon an API call being dispatched to us, namely:
66 * - a pointer to the QUIC_CONNECTION (regardless of whether a QCSO or QSSO
68 * - a pointer to any applicable QUIC_XSO (e.g. if a QSSO was passed, or if
69 * a QCSO with a default stream was passed);
70 * - whether a QSSO was passed (xso == NULL must not be used to determine this
71 * because it may be non-NULL when a QCSO is passed if that QCSO has a
81 * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
82 * rather than via ERR. Note that normal errors must always be raised while
86 static int quic_raise_normal_error(QCTX *ctx,
90 ctx->xso->last_error = err;
92 ctx->qc->last_error = err;
98 * Raise a 'non-normal' error, meaning any error that is not reported via
99 * SSL_get_error() and must be reported via ERR.
101 * qc should be provided if available. In exceptional circumstances when qc is
102 * not known NULL may be passed. This should generally only happen when an
103 * expect_...() function defined below fails, which generally indicates a
104 * dispatch error or caller error.
106 * ctx should be NULL if the connection lock is not held.
108 static int quic_raise_non_normal_error(QCTX *ctx,
119 ERR_set_debug(file, line, func);
122 ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
126 if (ctx->is_stream && ctx->xso != NULL)
127 ctx->xso->last_error = SSL_ERROR_SSL;
128 else if (!ctx->is_stream && ctx->qc != NULL)
129 ctx->qc->last_error = SSL_ERROR_SSL;
135 #define QUIC_RAISE_NORMAL_ERROR(ctx, err) \
136 quic_raise_normal_error((ctx), (err))
138 #define QUIC_RAISE_NON_NORMAL_ERROR(ctx, reason, msg) \
139 quic_raise_non_normal_error((ctx), \
140 OPENSSL_FILE, OPENSSL_LINE, \
146 * Given a QCSO or QSSO, initialises a QCTX, determining the contextually
147 * applicable QUIC_CONNECTION pointer and, if applicable, QUIC_XSO pointer.
149 * After this returns 1, all fields of the passed QCTX are initialised.
150 * Returns 0 on failure. This function is intended to be used to provide API
151 * semantics and as such, it invokes QUIC_RAISE_NON_NORMAL_ERROR() on failure.
153 static int expect_quic(const SSL *s, QCTX *ctx)
163 return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_PASSED_NULL_PARAMETER, NULL);
166 case SSL_TYPE_QUIC_CONNECTION:
167 qc = (QUIC_CONNECTION *)s;
169 ctx->xso = qc->default_xso;
173 case SSL_TYPE_QUIC_XSO:
181 return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
186 * Like expect_quic(), but requires a QUIC_XSO be contextually available. In
187 * other words, requires that the passed QSO be a QSSO or a QCSO with a default
190 * remote_init determines if we expect the default XSO to be remotely created or
191 * not. If it is -1, do not instantiate a default XSO if one does not yet exist.
193 * Channel mutex is acquired and retained on success.
196 static int ossl_unused expect_quic_with_stream_lock(const SSL *s, int remote_init,
199 if (!expect_quic(s, ctx))
204 if (ctx->xso == NULL && remote_init >= 0) {
205 if (ossl_quic_channel_is_term_any(ctx->qc->ch)) {
206 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
210 /* If we haven't finished the handshake, try to advance it. */
211 if (quic_do_handshake(ctx) < 1)
212 /* ossl_quic_do_handshake raised error here */
215 if (remote_init == 0) {
216 if (!qc_try_create_default_xso_for_write(ctx))
219 if (!qc_wait_for_default_xso_for_read(ctx))
223 ctx->xso = ctx->qc->default_xso;
226 if (ctx->xso == NULL) {
227 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
231 return 1; /* lock held */
234 quic_unlock(ctx->qc);
239 * Like expect_quic(), but fails if called on a QUIC_XSO. ctx->xso may still
240 * be non-NULL if the QCSO has a default stream.
242 static int ossl_unused expect_quic_conn_only(const SSL *s, QCTX *ctx)
244 if (!expect_quic(s, ctx))
248 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_CONN_USE_ONLY, NULL);
254 * Ensures that the channel mutex is held for a method which touches channel
257 * Precondition: Channel mutex is not held (unchecked)
259 static void quic_lock(QUIC_CONNECTION *qc)
261 #if defined(OPENSSL_THREADS)
262 ossl_crypto_mutex_lock(qc->mutex);
266 /* Precondition: Channel mutex is held (unchecked) */
268 static void quic_unlock(QUIC_CONNECTION *qc)
270 #if defined(OPENSSL_THREADS)
271 ossl_crypto_mutex_unlock(qc->mutex);
277 * QUIC Front-End I/O API: Initialization
278 * ======================================
280 * SSL_new => ossl_quic_new
282 * SSL_reset => ossl_quic_reset
283 * SSL_clear => ossl_quic_clear
285 * SSL_free => ossl_quic_free
290 SSL *ossl_quic_new(SSL_CTX *ctx)
292 QUIC_CONNECTION *qc = NULL;
293 SSL *ssl_base = NULL;
294 SSL_CONNECTION *sc = NULL;
296 qc = OPENSSL_zalloc(sizeof(*qc));
300 /* Initialise the QUIC_CONNECTION's stub header. */
302 if (!ossl_ssl_init(ssl_base, ctx, ctx->method, SSL_TYPE_QUIC_CONNECTION)) {
307 qc->tls = ossl_ssl_connection_new_int(ctx, TLS_method());
308 if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL)
311 #if defined(OPENSSL_THREADS)
312 if ((qc->mutex = ossl_crypto_mutex_new()) == NULL)
316 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
317 qc->is_thread_assisted
318 = (ssl_base->method == OSSL_QUIC_client_thread_method());
321 qc->as_server = 0; /* TODO(QUIC): server support */
322 qc->as_server_state = qc->as_server;
324 qc->default_stream_mode = SSL_DEFAULT_STREAM_MODE_AUTO_BIDI;
325 qc->default_ssl_mode = qc->ssl.ctx->mode;
326 qc->default_blocking = 1;
327 qc->incoming_stream_policy = SSL_INCOMING_STREAM_POLICY_AUTO;
328 qc->last_error = SSL_ERROR_NONE;
330 if (!create_channel(qc))
333 qc_update_reject_policy(qc);
336 * We do not create the default XSO yet. The reason for this is that the
337 * stream ID of the default XSO will depend on whether the stream is client
338 * or server-initiated, which depends on who transmits first. Since we do
339 * not know whether the application will be using a client-transmits-first
340 * or server-transmits-first protocol, we defer default XSO creation until
341 * the client calls SSL_read() or SSL_write(). If it calls SSL_read() first,
342 * we take that as a cue that the client is expecting a server-initiated
343 * stream, and vice versa if SSL_write() is called first.
349 #if defined(OPENSSL_THREADS)
350 ossl_crypto_mutex_free(qc->mutex);
352 ossl_quic_channel_free(qc->ch);
361 void ossl_quic_free(SSL *s)
366 /* We should never be called on anything but a QSO. */
367 if (!expect_quic(s, &ctx))
374 * When a QSSO is freed, the XSO is freed immediately, because the XSO
375 * itself only contains API personality layer data. However the
376 * underlying QUIC_STREAM is not freed immediately but is instead marked
377 * as deleted for later collection.
380 assert(ctx.qc->num_xso > 0);
383 /* If a stream's send part has not been finished, auto-reset it. */
384 if (ctx.xso->stream->sstream != NULL
385 && !ossl_quic_sstream_get_final_size(ctx.xso->stream->sstream, NULL))
386 ossl_quic_stream_map_reset_stream_send_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
389 /* Do STOP_SENDING for the receive part, if applicable. */
390 if (ctx.xso->stream->rstream != NULL)
391 ossl_quic_stream_map_stop_sending_recv_part(ossl_quic_channel_get_qsm(ctx.qc->ch),
394 /* Update stream state. */
395 ctx.xso->stream->deleted = 1;
396 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(ctx.qc->ch),
399 is_default = (ctx.xso == ctx.qc->default_xso);
403 * Unref the connection in most cases; the XSO has a ref to the QC and
404 * not vice versa. But for a default XSO, to avoid circular references,
405 * the QC refs the XSO but the XSO does not ref the QC. If we are the
406 * default XSO, we only get here when the QC is being torn down anyway,
407 * so don't call SSL_free(qc) as we are already in it.
410 SSL_free(&ctx.qc->ssl);
412 /* Note: SSL_free calls OPENSSL_free(xso) for us */
417 * Free the default XSO, if any. The QUIC_STREAM is not deleted at this
418 * stage, but is freed during the channel free when the whole QSM is freed.
420 if (ctx.qc->default_xso != NULL) {
421 QUIC_XSO *xso = ctx.qc->default_xso;
426 ctx.qc->default_xso = NULL;
429 /* Ensure we have no remaining XSOs. */
430 assert(ctx.qc->num_xso == 0);
432 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
433 if (ctx.qc->is_thread_assisted && ctx.qc->started) {
434 ossl_quic_thread_assist_wait_stopped(&ctx.qc->thread_assist);
435 ossl_quic_thread_assist_cleanup(&ctx.qc->thread_assist);
439 ossl_quic_channel_free(ctx.qc->ch);
441 BIO_free(ctx.qc->net_rbio);
442 BIO_free(ctx.qc->net_wbio);
444 /* Note: SSL_free calls OPENSSL_free(qc) for us */
446 SSL_free(ctx.qc->tls);
447 #if defined(OPENSSL_THREADS)
448 ossl_crypto_mutex_free(&ctx.qc->mutex); /* freed while still locked */
452 /* SSL method init */
453 int ossl_quic_init(SSL *s)
455 /* Same op as SSL_clear, forward the call. */
456 return ossl_quic_clear(s);
459 /* SSL method deinit */
460 void ossl_quic_deinit(SSL *s)
466 int ossl_quic_reset(SSL *s)
470 if (!expect_quic(s, &ctx))
473 /* TODO(QUIC); Currently a no-op. */
478 int ossl_quic_clear(SSL *s)
482 if (!expect_quic(s, &ctx))
485 /* TODO(QUIC): Currently a no-op. */
489 void ossl_quic_conn_set_override_now_cb(SSL *s,
490 OSSL_TIME (*now_cb)(void *arg),
495 if (!expect_quic(s, &ctx))
498 ctx.qc->override_now_cb = now_cb;
499 ctx.qc->override_now_cb_arg = now_cb_arg;
502 void ossl_quic_conn_force_assist_thread_wake(SSL *s)
506 if (!expect_quic(s, &ctx))
509 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
510 if (ctx.qc->is_thread_assisted && ctx.qc->started)
511 ossl_quic_thread_assist_notify_deadline_changed(&ctx.qc->thread_assist);
516 static void qc_touch_default_xso(QUIC_CONNECTION *qc)
518 qc->default_xso_created = 1;
519 qc_update_reject_policy(qc);
523 * Changes default XSO. Allows caller to keep reference to the old default XSO
524 * (if any). Reference to new XSO is transferred from caller.
527 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
535 if (qc->default_xso != xso) {
536 *old_xso = qc->default_xso; /* transfer old XSO ref to caller */
538 qc->default_xso = xso;
542 * Changing to not having a default XSO. XSO becomes standalone and
543 * now has a ref to the QC.
545 if (!ossl_assert(SSL_up_ref(&qc->ssl)))
549 * Changing from not having a default XSO to having one. The new XSO
550 * will have had a reference to the QC we need to drop to avoid a
551 * circular reference.
553 * Currently we never change directly from one default XSO to
554 * another, though this function would also still be correct if this
557 assert(*old_xso == NULL);
559 CRYPTO_DOWN_REF(&qc->ssl.references, &refs, &qc->ssl.lock);
565 qc_touch_default_xso(qc);
569 * Changes default XSO, releasing the reference to any previous default XSO.
570 * Reference to new XSO is transferred from caller.
573 static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch)
575 QUIC_XSO *old_xso = NULL;
577 qc_set_default_xso_keep_ref(qc, xso, touch, &old_xso);
580 SSL_free(&old_xso->ssl);
584 * QUIC Front-End I/O API: Network BIO Configuration
585 * =================================================
587 * Handling the different BIOs is difficult:
589 * - It is more or less a requirement that we use non-blocking network I/O;
590 * we need to be able to have timeouts on recv() calls, and make best effort
591 * (non blocking) send() and recv() calls.
593 * The only sensible way to do this is to configure the socket into
594 * non-blocking mode. We could try to do select() before calling send() or
595 * recv() to get a guarantee that the call will not block, but this will
596 * probably run into issues with buggy OSes which generate spurious socket
597 * readiness events. In any case, relying on this to work reliably does not
600 * Timeouts could be handled via setsockopt() socket timeout options, but
601 * this depends on OS support and adds another syscall to every network I/O
602 * operation. It also has obvious thread safety concerns if we want to move
603 * to concurrent use of a single socket at some later date.
605 * Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
606 * be made non-blocking. However some OSes (e.g. Windows) do not support
607 * this, so we cannot rely on this.
609 * As such, we need to configure any FD in non-blocking mode. This may
610 * confound users who pass a blocking socket to libssl. However, in practice
611 * it would be extremely strange for a user of QUIC to pass an FD to us,
612 * then also try and send receive traffic on the same socket(!). Thus the
613 * impact of this should be limited, and can be documented.
615 * - We support both blocking and non-blocking operation in terms of the API
616 * presented to the user. One prospect is to set the blocking mode based on
617 * whether the socket passed to us was already in blocking mode. However,
618 * Windows has no API for determining if a socket is in blocking mode (!),
619 * therefore this cannot be done portably. Currently therefore we expose an
620 * explicit API call to set this, and default to blocking mode.
622 * - We need to determine our initial destination UDP address. The "natural"
623 * way for a user to do this is to set the peer variable on a BIO_dgram.
624 * However, this has problems because BIO_dgram's peer variable is used for
625 * both transmission and reception. This means it can be constantly being
626 * changed to a malicious value (e.g. if some random unrelated entity on the
627 * network starts sending traffic to us) on every read call. This is not a
628 * direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
629 * calls only, which do not use this variable. However, we do need to let
630 * the user specify the peer in a 'normal' manner. The compromise here is
631 * that we grab the current peer value set at the time the write BIO is set
632 * and do not read the value again.
634 * - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
635 * Currently we do this by only supporting non-blocking mode.
640 * Determines what initial destination UDP address we should use, if possible.
641 * If this fails the client must set the destination address manually, or use a
642 * BIO which does not need a destination address.
644 static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
646 if (BIO_dgram_get_peer(net_wbio, peer) <= 0)
652 void ossl_quic_conn_set0_net_rbio(SSL *s, BIO *net_rbio)
656 if (!expect_quic(s, &ctx))
659 if (ctx.qc->net_rbio == net_rbio)
662 if (!ossl_quic_channel_set_net_rbio(ctx.qc->ch, net_rbio))
665 BIO_free(ctx.qc->net_rbio);
666 ctx.qc->net_rbio = net_rbio;
669 * If what we have is not pollable (e.g. a BIO_dgram_pair) disable blocking
670 * mode as we do not support it for non-pollable BIOs.
672 if (net_rbio != NULL) {
673 BIO_POLL_DESCRIPTOR d = {0};
675 if (!BIO_get_rpoll_descriptor(net_rbio, &d)
676 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
677 ctx.qc->blocking = 0;
678 ctx.qc->default_blocking = 0;
679 ctx.qc->can_poll_net_rbio = 0;
681 ctx.qc->can_poll_net_rbio = 1;
686 void ossl_quic_conn_set0_net_wbio(SSL *s, BIO *net_wbio)
690 if (!expect_quic(s, &ctx))
693 if (ctx.qc->net_wbio == net_wbio)
696 if (!ossl_quic_channel_set_net_wbio(ctx.qc->ch, net_wbio))
699 BIO_free(ctx.qc->net_wbio);
700 ctx.qc->net_wbio = net_wbio;
702 if (net_wbio != NULL) {
703 BIO_POLL_DESCRIPTOR d = {0};
705 if (!BIO_get_wpoll_descriptor(net_wbio, &d)
706 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
707 ctx.qc->blocking = 0;
708 ctx.qc->default_blocking = 0;
709 ctx.qc->can_poll_net_wbio = 0;
711 ctx.qc->can_poll_net_wbio = 1;
715 * If we do not have a peer address yet, and we have not started trying
716 * to connect yet, try to autodetect one.
718 if (BIO_ADDR_family(&ctx.qc->init_peer_addr) == AF_UNSPEC
719 && !ctx.qc->started) {
720 if (!csm_analyse_init_peer_addr(net_wbio, &ctx.qc->init_peer_addr))
722 BIO_ADDR_clear(&ctx.qc->init_peer_addr);
724 ossl_quic_channel_set_peer_addr(ctx.qc->ch,
725 &ctx.qc->init_peer_addr);
730 BIO *ossl_quic_conn_get_net_rbio(const SSL *s)
734 if (!expect_quic(s, &ctx))
737 return ctx.qc->net_rbio;
740 BIO *ossl_quic_conn_get_net_wbio(const SSL *s)
744 if (!expect_quic(s, &ctx))
747 return ctx.qc->net_wbio;
750 int ossl_quic_conn_get_blocking_mode(const SSL *s)
754 if (!expect_quic(s, &ctx))
758 return ctx.xso->blocking;
760 return ctx.qc->blocking;
763 int ossl_quic_conn_set_blocking_mode(SSL *s, int blocking)
767 if (!expect_quic(s, &ctx))
770 /* Cannot enable blocking mode if we do not have pollable FDs. */
772 (!ctx.qc->can_poll_net_rbio || !ctx.qc->can_poll_net_wbio))
773 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
775 if (!ctx.is_stream) {
777 * If called on a QCSO, update default and connection-level blocking
780 ctx.qc->blocking = (blocking != 0);
781 ctx.qc->default_blocking = ctx.qc->blocking;
786 * If called on a QSSO or QCSO with a default XSO, update blocking
789 ctx.xso->blocking = (blocking != 0);
794 int ossl_quic_conn_set_initial_peer_addr(SSL *s,
795 const BIO_ADDR *peer_addr)
799 if (!expect_quic(s, &ctx))
803 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
806 if (peer_addr == NULL) {
807 BIO_ADDR_clear(&ctx.qc->init_peer_addr);
811 ctx.qc->init_peer_addr = *peer_addr;
816 * QUIC Front-End I/O API: Asynchronous I/O Management
817 * ===================================================
819 * (BIO/)SSL_tick => ossl_quic_tick
820 * (BIO/)SSL_get_tick_timeout => ossl_quic_get_tick_timeout
821 * (BIO/)SSL_get_poll_fd => ossl_quic_get_poll_fd
825 /* Returns 1 if the connection is being used in blocking mode. */
826 static int qc_blocking_mode(const QUIC_CONNECTION *qc)
831 static int xso_blocking_mode(const QUIC_XSO *xso)
834 && xso->conn->can_poll_net_rbio
835 && xso->conn->can_poll_net_wbio;
838 /* SSL_tick; ticks the reactor. */
840 int ossl_quic_tick(SSL *s)
844 if (!expect_quic(s, &ctx))
848 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
854 * SSL_get_tick_timeout. Get the time in milliseconds until the SSL object
855 * should be ticked by the application by calling SSL_tick(). tv is set to 0 if
856 * the object should be ticked immediately and tv->tv_sec is set to -1 if no
857 * timeout is currently active.
860 int ossl_quic_get_tick_timeout(SSL *s, struct timeval *tv)
863 OSSL_TIME deadline = ossl_time_infinite();
865 if (!expect_quic(s, &ctx))
871 = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(ctx.qc->ch));
873 if (ossl_time_is_infinite(deadline)) {
880 *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, ossl_time_now()));
885 /* SSL_get_rpoll_descriptor */
886 int ossl_quic_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
890 if (!expect_quic(s, &ctx))
893 if (desc == NULL || ctx.qc->net_rbio == NULL)
896 return BIO_get_rpoll_descriptor(ctx.qc->net_rbio, desc);
899 /* SSL_get_wpoll_descriptor */
900 int ossl_quic_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
904 if (!expect_quic(s, &ctx))
907 if (desc == NULL || ctx.qc->net_wbio == NULL)
910 return BIO_get_wpoll_descriptor(ctx.qc->net_wbio, desc);
913 /* SSL_net_read_desired */
915 int ossl_quic_get_net_read_desired(SSL *s)
920 if (!expect_quic(s, &ctx))
924 ret = ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
929 /* SSL_net_write_desired */
931 int ossl_quic_get_net_write_desired(SSL *s)
936 if (!expect_quic(s, &ctx))
940 ret = ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
946 * QUIC Front-End I/O API: Connection Lifecycle Operations
947 * =======================================================
949 * SSL_do_handshake => ossl_quic_do_handshake
950 * SSL_set_connect_state => ossl_quic_set_connect_state
951 * SSL_set_accept_state => ossl_quic_set_accept_state
952 * SSL_shutdown => ossl_quic_shutdown
953 * SSL_ctrl => ossl_quic_ctrl
954 * (BIO/)SSL_connect => ossl_quic_connect
955 * (BIO/)SSL_accept => ossl_quic_accept
960 static int quic_shutdown_wait(void *arg)
962 QUIC_CONNECTION *qc = arg;
964 return ossl_quic_channel_is_terminated(qc->ch);
968 int ossl_quic_conn_shutdown(SSL *s, uint64_t flags,
969 const SSL_SHUTDOWN_EX_ARGS *args,
975 if (!expect_quic(s, &ctx))
979 /* TODO(QUIC): Semantics currently undefined for QSSOs */
984 ossl_quic_channel_local_close(ctx.qc->ch,
985 args != NULL ? args->quic_error_code : 0);
987 /* TODO(QUIC): !SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH */
989 if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
994 if (qc_blocking_mode(ctx.qc) && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0)
995 block_until_pred(ctx.qc, quic_shutdown_wait, ctx.qc, 0);
997 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
999 ret = ossl_quic_channel_is_terminated(ctx.qc->ch);
1000 quic_unlock(ctx.qc);
1005 long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
1009 if (!expect_quic(s, &ctx))
1014 /* If called on a QCSO, update the default mode. */
1016 ctx.qc->default_ssl_mode |= (uint32_t)larg;
1019 * If we were called on a QSSO or have a default stream, we also update
1022 if (ctx.xso != NULL) {
1023 /* Cannot enable EPW while AON write in progress. */
1024 if (ctx.xso->aon_write_in_progress)
1025 larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
1027 ctx.xso->ssl_mode |= (uint32_t)larg;
1028 return ctx.xso->ssl_mode;
1031 return ctx.qc->default_ssl_mode;
1032 case SSL_CTRL_CLEAR_MODE:
1034 ctx.qc->default_ssl_mode &= ~(uint32_t)larg;
1036 if (ctx.xso != NULL) {
1037 ctx.xso->ssl_mode &= ~(uint32_t)larg;
1038 return ctx.xso->ssl_mode;
1041 return ctx.qc->default_ssl_mode;
1043 /* Probably a TLS related ctrl. Defer to our internal SSL object */
1044 return SSL_ctrl(ctx.qc->tls, cmd, larg, parg);
1048 /* SSL_set_connect_state */
1049 void ossl_quic_set_connect_state(SSL *s)
1053 if (!expect_quic(s, &ctx))
1056 /* Cannot be changed after handshake started */
1057 if (ctx.qc->started || ctx.is_stream)
1060 ctx.qc->as_server_state = 0;
1063 /* SSL_set_accept_state */
1064 void ossl_quic_set_accept_state(SSL *s)
1068 if (!expect_quic(s, &ctx))
1071 /* Cannot be changed after handshake started */
1072 if (ctx.qc->started || ctx.is_stream)
1075 ctx.qc->as_server_state = 1;
1078 /* SSL_do_handshake */
1079 struct quic_handshake_wait_args {
1080 QUIC_CONNECTION *qc;
1083 static int quic_handshake_wait(void *arg)
1085 struct quic_handshake_wait_args *args = arg;
1087 if (!ossl_quic_channel_is_active(args->qc->ch))
1090 if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
1096 static int configure_channel(QUIC_CONNECTION *qc)
1098 assert(qc->ch != NULL);
1100 if (!ossl_quic_channel_set_net_rbio(qc->ch, qc->net_rbio)
1101 || !ossl_quic_channel_set_net_wbio(qc->ch, qc->net_wbio)
1102 || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
1109 static int create_channel(QUIC_CONNECTION *qc)
1111 QUIC_CHANNEL_ARGS args = {0};
1113 args.libctx = qc->ssl.ctx->libctx;
1114 args.propq = qc->ssl.ctx->propq;
1115 args.is_server = qc->as_server;
1117 args.mutex = qc->mutex;
1118 args.now_cb = qc->override_now_cb;
1119 args.now_cb_arg = qc->override_now_cb_arg;
1121 qc->ch = ossl_quic_channel_new(&args);
1129 * Creates a channel and configures it with the information we have accumulated
1130 * via calls made to us from the application prior to starting a handshake
1134 static int ensure_channel_started(QUIC_CONNECTION *qc)
1137 if (!configure_channel(qc)
1138 || !ossl_quic_channel_start(qc->ch))
1141 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1142 if (qc->is_thread_assisted)
1143 if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch))
1152 ossl_quic_channel_free(qc->ch);
1158 static int quic_do_handshake(QCTX *ctx)
1161 QUIC_CONNECTION *qc = ctx->qc;
1163 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1164 /* Handshake already completed. */
1167 if (ossl_quic_channel_is_term_any(qc->ch))
1168 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1170 if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1171 /* Peer address must have been set. */
1172 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
1173 return -1; /* Non-protocol error */
1176 if (qc->as_server != qc->as_server_state) {
1177 /* TODO(QUIC): Must match the method used to create the QCSO */
1178 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
1179 return -1; /* Non-protocol error */
1182 if (qc->net_rbio == NULL || qc->net_wbio == NULL) {
1183 /* Need read and write BIOs. */
1184 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BIO_NOT_SET, NULL);
1185 return -1; /* Non-protocol error */
1189 * Start connection process. Note we may come here multiple times in
1190 * non-blocking mode, which is fine.
1192 if (!ensure_channel_started(qc)) {
1193 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1194 return -1; /* Non-protocol error */
1197 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1198 /* The handshake is now done. */
1201 if (qc_blocking_mode(qc)) {
1202 /* In blocking mode, wait for the handshake to complete. */
1203 struct quic_handshake_wait_args args;
1207 ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
1208 if (!ossl_quic_channel_is_active(qc->ch)) {
1209 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1210 return 0; /* Shutdown before completion */
1211 } else if (ret <= 0) {
1212 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1213 return -1; /* Non-protocol error */
1216 assert(ossl_quic_channel_is_handshake_complete(qc->ch));
1219 /* Try to advance the reactor. */
1220 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1222 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1223 /* The handshake is now done. */
1226 /* Otherwise, indicate that the handshake isn't done yet. */
1227 QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1228 return -1; /* Non-protocol error */
1233 int ossl_quic_do_handshake(SSL *s)
1238 if (!expect_quic(s, &ctx))
1243 ret = quic_do_handshake(&ctx);
1244 quic_unlock(ctx.qc);
1249 int ossl_quic_connect(SSL *s)
1251 /* Ensure we are in connect state (no-op if non-idle). */
1252 ossl_quic_set_connect_state(s);
1254 /* Begin or continue the handshake */
1255 return ossl_quic_do_handshake(s);
1259 int ossl_quic_accept(SSL *s)
1261 /* Ensure we are in accept state (no-op if non-idle). */
1262 ossl_quic_set_accept_state(s);
1264 /* Begin or continue the handshake */
1265 return ossl_quic_do_handshake(s);
1269 * QUIC Front-End I/O API: Stream Lifecycle Operations
1270 * ===================================================
1272 * SSL_stream_new => ossl_quic_conn_stream_new
1277 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
1278 * default XSO was created. Returns 0 if it was not (e.g. because it already
1279 * exists). Note that this is NOT an error condition.
1282 static int qc_try_create_default_xso_for_write(QCTX *ctx)
1285 QUIC_CONNECTION *qc = ctx->qc;
1287 if (qc->default_xso_created
1288 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1290 * We only do this once. If the user detaches a previously created
1291 * default XSO we don't auto-create another one.
1293 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1295 /* Create a locally-initiated stream. */
1296 if (qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_AUTO_UNI)
1297 flags |= SSL_STREAM_FLAG_UNI;
1299 qc_set_default_xso(qc, (QUIC_XSO *)quic_conn_stream_new(ctx, flags,
1302 if (qc->default_xso == NULL)
1303 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1305 qc_touch_default_xso(qc);
1309 struct quic_wait_for_stream_args {
1310 QUIC_CONNECTION *qc;
1317 static int quic_wait_for_stream(void *arg)
1319 struct quic_wait_for_stream_args *args = arg;
1321 if (!ossl_quic_channel_is_active(args->qc->ch)) {
1322 /* If connection is torn down due to an error while blocking, stop. */
1323 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1327 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1328 args->expect_id | QUIC_STREAM_DIR_BIDI);
1329 if (args->qs == NULL)
1330 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1331 args->expect_id | QUIC_STREAM_DIR_UNI);
1333 if (args->qs != NULL)
1334 return 1; /* stream now exists */
1336 return 0; /* did not get a stream, keep trying */
1340 static int qc_wait_for_default_xso_for_read(QCTX *ctx)
1342 /* Called on a QCSO and we don't currently have a default stream. */
1344 QUIC_CONNECTION *qc = ctx->qc;
1347 struct quic_wait_for_stream_args wargs;
1350 * If default stream functionality is disabled or we already detached
1351 * one, don't make another default stream and just fail.
1353 if (qc->default_xso_created
1354 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1355 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1358 * The peer may have opened a stream since we last ticked. So tick and
1359 * see if the stream with ordinal 0 (remote, bidi/uni based on stream
1360 * mode) exists yet. QUIC stream IDs must be allocated in order, so the
1361 * first stream created by a peer must have an ordinal of 0.
1363 expect_id = qc->as_server
1364 ? QUIC_STREAM_INITIATOR_CLIENT
1365 : QUIC_STREAM_INITIATOR_SERVER;
1367 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1368 expect_id | QUIC_STREAM_DIR_BIDI);
1370 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1371 expect_id | QUIC_STREAM_DIR_UNI);
1374 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1376 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1381 if (!qc_blocking_mode(qc))
1382 /* Non-blocking mode, so just bail immediately. */
1383 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1385 /* Block until we have a stream. */
1389 wargs.expect_id = expect_id;
1391 res = block_until_pred(qc, quic_wait_for_stream, &wargs, 0);
1393 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1394 else if (res < 0 || wargs.qs == NULL)
1395 /* quic_wait_for_stream raised error here */
1402 * We now have qs != NULL. Make it the default stream, creating the
1405 qc_set_default_xso(qc, create_xso_from_stream(qc, qs), /*touch=*/0);
1406 if (qc->default_xso == NULL)
1407 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1409 qc_touch_default_xso(qc); /* inhibits default XSO */
1414 static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs)
1416 QUIC_XSO *xso = NULL;
1418 if ((xso = OPENSSL_zalloc(sizeof(*xso))) == NULL)
1421 if (!ossl_ssl_init(&xso->ssl, qc->ssl.ctx, qc->ssl.method, SSL_TYPE_QUIC_XSO))
1425 if (!SSL_up_ref(&qc->ssl))
1429 xso->blocking = qc->default_blocking;
1430 xso->ssl_mode = qc->default_ssl_mode;
1431 xso->last_error = SSL_ERROR_NONE;
1443 /* locking depends on need_lock */
1444 static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock)
1446 QUIC_CONNECTION *qc = ctx->qc;
1447 QUIC_XSO *xso = NULL;
1448 QUIC_STREAM *qs = NULL;
1449 int is_uni = ((flags & SSL_STREAM_FLAG_UNI) != 0);
1454 if (ossl_quic_channel_is_term_any(qc->ch)) {
1455 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1459 qs = ossl_quic_channel_new_stream_local(qc->ch, is_uni);
1463 xso = create_xso_from_stream(qc, qs);
1467 qc_touch_default_xso(qc); /* inhibits default XSO */
1475 ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc->ch), qs);
1484 SSL *ossl_quic_conn_stream_new(SSL *s, uint64_t flags)
1488 if (!expect_quic_conn_only(s, &ctx))
1491 return quic_conn_stream_new(&ctx, flags, /*need_lock=*/1);
1495 * QUIC Front-End I/O API: Steady-State Operations
1496 * ===============================================
1498 * Here we dispatch calls to the steady-state front-end I/O API functions; that
1499 * is, the functions used during the established phase of a QUIC connection
1500 * (e.g. SSL_read, SSL_write).
1502 * Each function must handle both blocking and non-blocking modes. As discussed
1503 * above, all QUIC I/O is implemented using non-blocking mode internally.
1505 * SSL_get_error => partially implemented by ossl_quic_get_error
1506 * (BIO/)SSL_read => ossl_quic_read
1507 * (BIO/)SSL_write => ossl_quic_write
1508 * SSL_pending => ossl_quic_pending
1509 * SSL_stream_conclude => ossl_quic_conn_stream_conclude
1513 int ossl_quic_get_error(const SSL *s, int i)
1517 if (!expect_quic(s, &ctx))
1520 return ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error;
1527 * The set of functions below provide the implementation of the public SSL_write
1528 * function. We must handle:
1530 * - both blocking and non-blocking operation at the application level,
1531 * depending on how we are configured;
1533 * - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
1535 * - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
1539 static void quic_post_write(QUIC_XSO *xso, int did_append, int do_tick)
1542 * We have appended at least one byte to the stream.
1543 * Potentially mark stream as active, depending on FC.
1546 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso->conn->ch),
1552 * TODO(QUIC): It is probably inefficient to try and do this immediately,
1553 * plus we should eventually consider Nagle's algorithm.
1556 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso->conn->ch), 0);
1559 struct quic_write_again_args {
1561 const unsigned char *buf;
1563 size_t total_written;
1567 static int quic_write_again(void *arg)
1569 struct quic_write_again_args *args = arg;
1570 size_t actual_written = 0;
1572 if (!ossl_quic_channel_is_active(args->xso->conn->ch))
1573 /* If connection is torn down due to an error while blocking, stop. */
1576 if (!ossl_quic_sstream_append(args->xso->stream->sstream,
1577 args->buf, args->len, &actual_written))
1580 quic_post_write(args->xso, actual_written > 0, 0);
1582 args->buf += actual_written;
1583 args->len -= actual_written;
1584 args->total_written += actual_written;
1587 /* Written everything, done. */
1590 /* Not written everything yet, keep trying. */
1595 static int quic_write_blocking(QCTX *ctx, const void *buf, size_t len,
1599 QUIC_XSO *xso = ctx->xso;
1600 struct quic_write_again_args args;
1601 size_t actual_written = 0;
1603 /* First make a best effort to append as much of the data as possible. */
1604 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len,
1606 /* Stream already finished or allocation error. */
1608 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1611 quic_post_write(xso, actual_written > 0, 1);
1613 if (actual_written == len) {
1614 /* Managed to append everything on the first try. */
1615 *written = actual_written;
1620 * We did not manage to append all of the data immediately, so the stream
1621 * buffer has probably filled up. This means we need to block until some of
1625 args.buf = (const unsigned char *)buf + actual_written;
1626 args.len = len - actual_written;
1627 args.total_written = 0;
1629 res = block_until_pred(xso->conn, quic_write_again, &args, 0);
1631 if (!ossl_quic_channel_is_active(xso->conn->ch))
1632 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1634 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1637 *written = args.total_written;
1642 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
1645 static void aon_write_begin(QUIC_XSO *xso, const unsigned char *buf,
1646 size_t buf_len, size_t already_sent)
1648 assert(!xso->aon_write_in_progress);
1650 xso->aon_write_in_progress = 1;
1651 xso->aon_buf_base = buf;
1652 xso->aon_buf_pos = already_sent;
1653 xso->aon_buf_len = buf_len;
1656 static void aon_write_finish(QUIC_XSO *xso)
1658 xso->aon_write_in_progress = 0;
1659 xso->aon_buf_base = NULL;
1660 xso->aon_buf_pos = 0;
1661 xso->aon_buf_len = 0;
1665 static int quic_write_nonblocking_aon(QCTX *ctx, const void *buf,
1666 size_t len, size_t *written)
1668 QUIC_XSO *xso = ctx->xso;
1669 const void *actual_buf;
1670 size_t actual_len, actual_written = 0;
1671 int accept_moving_buffer
1672 = ((xso->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
1674 if (xso->aon_write_in_progress) {
1676 * We are in the middle of an AON write (i.e., a previous write did not
1677 * manage to append all data to the SSTREAM and we have Enable Partial
1678 * Write (EPW) mode disabled.)
1680 if ((!accept_moving_buffer && xso->aon_buf_base != buf)
1681 || len != xso->aon_buf_len)
1683 * Pointer must not have changed if we are not in accept moving
1684 * buffer mode. Length must never change.
1686 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BAD_WRITE_RETRY, NULL);
1688 actual_buf = (unsigned char *)buf + xso->aon_buf_pos;
1689 actual_len = len - xso->aon_buf_pos;
1690 assert(actual_len > 0);
1696 /* First make a best effort to append as much of the data as possible. */
1697 if (!ossl_quic_sstream_append(xso->stream->sstream, actual_buf, actual_len,
1699 /* Stream already finished or allocation error. */
1701 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1704 quic_post_write(xso, actual_written > 0, 1);
1706 if (actual_written == actual_len) {
1707 /* We have sent everything. */
1708 if (xso->aon_write_in_progress) {
1710 * We have sent everything, and we were in the middle of an AON
1711 * write. The output write length is the total length of the AON
1712 * buffer, not however many bytes we managed to write to the stream
1715 *written = xso->aon_buf_len;
1716 aon_write_finish(xso);
1718 *written = actual_written;
1724 if (xso->aon_write_in_progress) {
1726 * AON write is in progress but we have not written everything yet. We
1727 * may have managed to send zero bytes, or some number of bytes less
1728 * than the total remaining which need to be appended during this
1731 xso->aon_buf_pos += actual_written;
1732 assert(xso->aon_buf_pos < xso->aon_buf_len);
1733 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
1737 * Not in an existing AON operation but partial write is not enabled, so we
1738 * need to begin a new AON operation. However we needn't bother if we didn't
1739 * actually append anything.
1741 if (actual_written > 0)
1742 aon_write_begin(xso, buf, len, actual_written);
1745 * AON - We do not publicly admit to having appended anything until AON
1749 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
1753 static int quic_write_nonblocking_epw(QCTX *ctx, const void *buf, size_t len,
1756 QUIC_XSO *xso = ctx->xso;
1758 /* Simple best effort operation. */
1759 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len, written)) {
1760 /* Stream already finished or allocation error. */
1762 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1765 quic_post_write(xso, *written > 0, 1);
1770 int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
1781 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, &ctx))
1784 partial_write = ((ctx.xso->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0);
1786 if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1787 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1792 * If we haven't finished the handshake, try to advance it.
1793 * We don't accept writes until the handshake is completed.
1795 if (quic_do_handshake(&ctx) < 1) {
1800 if (ctx.xso->stream == NULL || ctx.xso->stream->sstream == NULL) {
1801 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1805 if (xso_blocking_mode(ctx.xso))
1806 ret = quic_write_blocking(&ctx, buf, len, written);
1807 else if (partial_write)
1808 ret = quic_write_nonblocking_epw(&ctx, buf, len, written);
1810 ret = quic_write_nonblocking_aon(&ctx, buf, len, written);
1813 quic_unlock(ctx.qc);
1821 struct quic_read_again_args {
1823 QUIC_STREAM *stream;
1831 static int quic_read_actual(QCTX *ctx,
1832 QUIC_STREAM *stream,
1833 void *buf, size_t buf_len,
1838 QUIC_CONNECTION *qc = ctx->qc;
1840 /* If the receive part of the stream is over, issue EOF. */
1841 if (stream->recv_fin_retired)
1842 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
1844 if (stream->rstream == NULL)
1845 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1848 if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
1849 bytes_read, &is_fin))
1850 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1853 if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
1854 bytes_read, &is_fin))
1855 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1859 if (*bytes_read > 0) {
1861 * We have read at least one byte from the stream. Inform stream-level
1862 * RXFC of the retirement of controlled bytes. Update the active stream
1863 * status (the RXFC may now want to emit a frame granting more credit to
1866 OSSL_RTT_INFO rtt_info;
1868 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
1870 if (!ossl_quic_rxfc_on_retire(&stream->rxfc, *bytes_read,
1871 rtt_info.smoothed_rtt))
1872 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1876 stream->recv_fin_retired = 1;
1878 if (*bytes_read > 0)
1879 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
1887 static int quic_read_again(void *arg)
1889 struct quic_read_again_args *args = arg;
1891 if (!ossl_quic_channel_is_active(args->ctx->qc->ch)) {
1892 /* If connection is torn down due to an error while blocking, stop. */
1893 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1897 if (!quic_read_actual(args->ctx, args->stream,
1898 args->buf, args->len, args->bytes_read,
1902 if (*args->bytes_read > 0)
1903 /* got at least one byte, the SSL_read op can finish now */
1906 return 0; /* did not read anything, keep trying */
1910 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
1914 struct quic_read_again_args args;
1918 if (!expect_quic(s, &ctx))
1923 if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1924 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1928 /* If we haven't finished the handshake, try to advance it. */
1929 if (quic_do_handshake(&ctx) < 1) {
1930 ret = 0; /* ossl_quic_do_handshake raised error here */
1934 if (ctx.xso == NULL) {
1936 * Called on a QCSO and we don't currently have a default stream.
1938 * Wait until we get a stream initiated by the peer (blocking mode) or
1939 * fail if we don't have one yet (non-blocking mode).
1941 if (!qc_wait_for_default_xso_for_read(&ctx)) {
1942 ret = 0; /* error already raised here */
1946 ctx.xso = ctx.qc->default_xso;
1949 if (ctx.xso->stream == NULL) {
1950 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1954 if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
1955 ret = 0; /* quic_read_actual raised error here */
1959 if (*bytes_read > 0) {
1961 * Even though we succeeded, tick the reactor here to ensure we are
1962 * handling other aspects of the QUIC connection.
1964 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1966 } else if (xso_blocking_mode(ctx.xso)) {
1968 * We were not able to read anything immediately, so our stream
1969 * buffer is empty. This means we need to block until we get
1970 * at least one byte.
1973 args.stream = ctx.xso->stream;
1976 args.bytes_read = bytes_read;
1979 res = block_until_pred(ctx.qc, quic_read_again, &args, 0);
1981 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1983 } else if (res < 0) {
1984 ret = 0; /* quic_read_again raised error here */
1990 /* We did not get any bytes and are not in blocking mode. */
1991 ret = QUIC_RAISE_NORMAL_ERROR(&ctx, SSL_ERROR_WANT_READ);
1995 quic_unlock(ctx.qc);
1999 int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
2001 return quic_read(s, buf, len, bytes_read, 0);
2004 int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
2006 return quic_read(s, buf, len, bytes_read, 1);
2014 static size_t ossl_quic_pending_int(const SSL *s)
2020 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, &ctx))
2023 if (ctx.xso->stream == NULL || ctx.xso->stream->rstream == NULL)
2024 /* Cannot raise errors here because we are const, just fail. */
2027 if (!ossl_quic_rstream_available(ctx.xso->stream->rstream, &avail, &fin))
2031 quic_unlock(ctx.qc);
2035 size_t ossl_quic_pending(const SSL *s)
2037 return ossl_quic_pending_int(s);
2040 int ossl_quic_has_pending(const SSL *s)
2042 return ossl_quic_pending_int(s) > 0;
2046 * SSL_stream_conclude
2047 * -------------------
2050 int ossl_quic_conn_stream_conclude(SSL *s)
2055 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, &ctx))
2058 qs = ctx.xso->stream;
2060 if (qs == NULL || qs->sstream == NULL) {
2061 quic_unlock(ctx.qc);
2065 if (!ossl_quic_channel_is_active(ctx.qc->ch)
2066 || ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
2067 quic_unlock(ctx.qc);
2071 ossl_quic_sstream_fin(qs->sstream);
2072 quic_post_write(ctx.xso, 1, 1);
2073 quic_unlock(ctx.qc);
2078 * SSL_inject_net_dgram
2079 * --------------------
2082 int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
2084 const BIO_ADDR *peer,
2085 const BIO_ADDR *local)
2091 if (!expect_quic(s, &ctx))
2096 demux = ossl_quic_channel_get0_demux(ctx.qc->ch);
2097 ret = ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
2099 quic_unlock(ctx.qc);
2104 * SSL_get0_connection
2105 * -------------------
2107 SSL *ossl_quic_get0_connection(SSL *s)
2111 if (!expect_quic(s, &ctx))
2114 return &ctx.qc->ssl;
2118 * SSL_get_stream_type
2119 * -------------------
2121 int ossl_quic_get_stream_type(SSL *s)
2125 if (!expect_quic(s, &ctx))
2126 return SSL_STREAM_TYPE_BIDI;
2128 if (ctx.xso == NULL) {
2130 * If deferred XSO creation has yet to occur, proceed according to the
2131 * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
2132 * what kind of stream will be created yet, so return BIDI on the basis
2133 * that at this time, the client still has the option of calling
2134 * SSL_read() or SSL_write() first.
2136 if (ctx.qc->default_xso_created
2137 || ctx.qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2138 return SSL_STREAM_TYPE_NONE;
2140 return SSL_STREAM_TYPE_BIDI;
2143 if (ossl_quic_stream_is_bidi(ctx.xso->stream))
2144 return SSL_STREAM_TYPE_BIDI;
2146 if (ossl_quic_stream_is_server_init(ctx.xso->stream) != ctx.qc->as_server)
2147 return SSL_STREAM_TYPE_READ;
2149 return SSL_STREAM_TYPE_WRITE;
2157 uint64_t ossl_quic_get_stream_id(SSL *s)
2162 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, &ctx))
2165 id = ctx.xso->stream->id;
2166 quic_unlock(ctx.qc);
2172 * SSL_set_default_stream_mode
2173 * ---------------------------
2176 int ossl_quic_set_default_stream_mode(SSL *s, uint32_t mode)
2180 if (!expect_quic_conn_only(s, &ctx))
2185 if (ctx.qc->default_xso_created)
2186 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
2187 "too late to change default stream mode");
2190 case SSL_DEFAULT_STREAM_MODE_NONE:
2191 case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI:
2192 case SSL_DEFAULT_STREAM_MODE_AUTO_UNI:
2193 ctx.qc->default_stream_mode = mode;
2196 quic_unlock(ctx.qc);
2197 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
2198 "bad default stream type");
2201 quic_unlock(ctx.qc);
2210 SSL *ossl_quic_detach_stream(SSL *s)
2213 QUIC_XSO *xso = NULL;
2215 if (!expect_quic_conn_only(s, &ctx))
2220 /* Calling this function inhibits default XSO autocreation. */
2221 /* QC ref to any default XSO is transferred to us and to caller. */
2222 qc_set_default_xso_keep_ref(ctx.qc, NULL, /*touch=*/1, &xso);
2224 quic_unlock(ctx.qc);
2226 return xso != NULL ? &xso->ssl : NULL;
2234 int ossl_quic_attach_stream(SSL *conn, SSL *stream)
2240 if (!expect_quic_conn_only(conn, &ctx))
2243 if (stream == NULL || stream->type != SSL_TYPE_QUIC_XSO)
2244 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_NULL_PARAMETER,
2245 "stream to attach must be a valid QUIC stream");
2247 xso = (QUIC_XSO *)stream;
2251 if (ctx.qc->default_xso != NULL) {
2252 quic_unlock(ctx.qc);
2253 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
2254 "connection already has a default stream");
2258 * It is a caller error for the XSO being attached as a default XSO to have
2259 * more than one ref.
2261 if (!CRYPTO_GET_REF(&xso->ssl.references, &nref, &xso->ssl.lock)) {
2262 quic_unlock(ctx.qc);
2263 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR,
2268 quic_unlock(ctx.qc);
2269 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
2270 "stream being attached must have "
2271 "only 1 reference");
2274 /* Caller's reference to the XSO is transferred to us. */
2275 /* Calling this function inhibits default XSO autocreation. */
2276 qc_set_default_xso(ctx.qc, xso, /*touch=*/1);
2278 quic_unlock(ctx.qc);
2283 * SSL_set_incoming_stream_policy
2284 * ------------------------------
2287 static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION *qc)
2289 switch (qc->incoming_stream_policy) {
2290 case SSL_INCOMING_STREAM_POLICY_AUTO:
2291 if ((qc->default_xso == NULL && !qc->default_xso_created)
2292 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2293 return SSL_INCOMING_STREAM_POLICY_ACCEPT;
2295 return SSL_INCOMING_STREAM_POLICY_REJECT;
2298 return qc->incoming_stream_policy;
2303 static void qc_update_reject_policy(QUIC_CONNECTION *qc)
2305 int policy = qc_get_effective_incoming_stream_policy(qc);
2306 int enable_reject = (policy == SSL_INCOMING_STREAM_POLICY_REJECT);
2308 ossl_quic_channel_set_incoming_stream_auto_reject(qc->ch,
2310 qc->incoming_stream_aec);
2314 int ossl_quic_set_incoming_stream_policy(SSL *s, int policy,
2320 if (!expect_quic_conn_only(s, &ctx))
2326 case SSL_INCOMING_STREAM_POLICY_AUTO:
2327 case SSL_INCOMING_STREAM_POLICY_ACCEPT:
2328 case SSL_INCOMING_STREAM_POLICY_REJECT:
2329 ctx.qc->incoming_stream_policy = policy;
2330 ctx.qc->incoming_stream_aec = aec;
2338 qc_update_reject_policy(ctx.qc);
2339 quic_unlock(ctx.qc);
2347 struct wait_for_incoming_stream_args {
2353 static int wait_for_incoming_stream(void *arg)
2355 struct wait_for_incoming_stream_args *args = arg;
2356 QUIC_CONNECTION *qc = args->ctx->qc;
2357 QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
2359 if (!ossl_quic_channel_is_active(qc->ch)) {
2360 /* If connection is torn down due to an error while blocking, stop. */
2361 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2365 args->qs = ossl_quic_stream_map_peek_accept_queue(qsm);
2366 if (args->qs != NULL)
2367 return 1; /* got a stream */
2369 return 0; /* did not get a stream, keep trying */
2373 SSL *ossl_quic_accept_stream(SSL *s, uint64_t flags)
2378 QUIC_STREAM_MAP *qsm;
2381 OSSL_RTT_INFO rtt_info;
2383 if (!expect_quic_conn_only(s, &ctx))
2388 if (qc_get_effective_incoming_stream_policy(ctx.qc)
2389 == SSL_INCOMING_STREAM_POLICY_REJECT)
2392 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
2394 qs = ossl_quic_stream_map_peek_accept_queue(qsm);
2396 if (qc_blocking_mode(ctx.qc)
2397 && (flags & SSL_ACCEPT_STREAM_NO_BLOCK) == 0) {
2398 struct wait_for_incoming_stream_args args;
2403 ret = block_until_pred(ctx.qc, wait_for_incoming_stream, &args, 0);
2405 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2407 } else if (ret < 0 || args.qs == NULL) {
2417 xso = create_xso_from_stream(ctx.qc, qs);
2421 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx.qc->ch), &rtt_info);
2422 ossl_quic_stream_map_remove_from_accept_queue(qsm, qs,
2423 rtt_info.smoothed_rtt);
2426 /* Calling this function inhibits default XSO autocreation. */
2427 qc_touch_default_xso(ctx.qc); /* inhibits default XSO */
2430 quic_unlock(ctx.qc);
2435 * SSL_get_accept_stream_queue_len
2436 * -------------------------------
2439 size_t ossl_quic_get_accept_stream_queue_len(SSL *s)
2444 if (!expect_quic_conn_only(s, &ctx))
2449 v = ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(ctx.qc->ch));
2451 quic_unlock(ctx.qc);
2459 int ossl_quic_stream_reset(SSL *ssl,
2460 const SSL_STREAM_RESET_ARGS *args,
2464 QUIC_STREAM_MAP *qsm;
2466 uint64_t error_code;
2468 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/0, &ctx))
2471 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
2472 qs = ctx.xso->stream;
2473 error_code = (args != NULL ? args->quic_error_code : 0);
2475 ossl_quic_stream_map_reset_stream_send_part(qsm, qs, error_code);
2477 quic_unlock(ctx.qc);
2482 * SSL_get_stream_read_state
2483 * -------------------------
2485 static void quic_classify_stream(QUIC_CONNECTION *qc,
2489 uint64_t *app_error_code)
2492 uint64_t final_size;
2494 local_init = (ossl_quic_stream_is_server_init(qs) == qc->as_server);
2496 if (app_error_code != NULL)
2497 *app_error_code = UINT64_MAX;
2499 app_error_code = &final_size; /* throw away value */
2501 if (!ossl_quic_stream_is_bidi(qs) && local_init != is_write) {
2503 * Unidirectional stream and this direction of transmission doesn't
2506 *state = SSL_STREAM_STATE_WRONG_DIR;
2507 } else if (ossl_quic_channel_is_term_any(qc->ch)) {
2508 /* Connection already closed. */
2509 *state = SSL_STREAM_STATE_CONN_CLOSED;
2510 } else if (!is_write && qs->recv_fin_retired) {
2511 /* Application has read a FIN. */
2512 *state = SSL_STREAM_STATE_FINISHED;
2513 } else if ((!is_write && qs->stop_sending)
2514 || (is_write && qs->reset_stream)) {
2516 * Stream has been reset locally. FIN takes precedence over this for the
2517 * read case as the application need not care if the stream is reset
2518 * after a FIN has been successfully processed.
2520 *state = SSL_STREAM_STATE_RESET_LOCAL;
2521 *app_error_code = !is_write
2522 ? qs->stop_sending_aec
2523 : qs->reset_stream_aec;
2524 } else if ((!is_write && qs->peer_reset_stream)
2525 || (is_write && qs->peer_stop_sending)) {
2527 * Stream has been reset remotely. */
2528 *state = SSL_STREAM_STATE_RESET_REMOTE;
2529 *app_error_code = !is_write
2530 ? qs->peer_reset_stream_aec
2531 : qs->peer_stop_sending_aec;
2532 } else if (is_write && ossl_quic_sstream_get_final_size(qs->sstream,
2535 * Stream has been finished. Stream reset takes precedence over this for
2536 * the write case as peer may not have received all data.
2538 *state = SSL_STREAM_STATE_FINISHED;
2540 /* Stream still healthy. */
2541 *state = SSL_STREAM_STATE_OK;
2545 static int quic_get_stream_state(SSL *ssl, int is_write)
2550 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, &ctx))
2551 return SSL_STREAM_STATE_NONE;
2553 quic_classify_stream(ctx.qc, ctx.xso->stream, is_write, &state, NULL);
2554 quic_unlock(ctx.qc);
2558 int ossl_quic_get_stream_read_state(SSL *ssl)
2560 return quic_get_stream_state(ssl, /*is_write=*/0);
2564 * SSL_get_stream_write_state
2565 * --------------------------
2567 int ossl_quic_get_stream_write_state(SSL *ssl)
2569 return quic_get_stream_state(ssl, /*is_write=*/1);
2573 * SSL_get_stream_read_error_code
2574 * ------------------------------
2576 static int quic_get_stream_error_code(SSL *ssl, int is_write,
2577 uint64_t *app_error_code)
2582 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, &ctx))
2585 quic_classify_stream(ctx.qc, ctx.xso->stream, /*is_write=*/0,
2586 &state, app_error_code);
2588 quic_unlock(ctx.qc);
2590 case SSL_STREAM_STATE_FINISHED:
2592 case SSL_STREAM_STATE_RESET_LOCAL:
2593 case SSL_STREAM_STATE_RESET_REMOTE:
2600 int ossl_quic_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code)
2602 return quic_get_stream_error_code(ssl, /*is_write=*/0, app_error_code);
2606 * SSL_get_stream_write_error_code
2607 * -------------------------------
2609 int ossl_quic_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code)
2611 return quic_get_stream_error_code(ssl, /*is_write=*/1, app_error_code);
2615 * SSL_get_conn_close_info
2616 * -----------------------
2618 int ossl_quic_get_conn_close_info(SSL *ssl,
2619 SSL_CONN_CLOSE_INFO *info,
2623 const QUIC_TERMINATE_CAUSE *tc;
2625 if (!expect_quic_conn_only(ssl, &ctx))
2628 tc = ossl_quic_channel_get_terminate_cause(ctx.qc->ch);
2632 info->error_code = tc->error_code;
2633 info->reason = NULL; /* TODO(QUIC): Wire reason */
2634 info->reason_len = 0;
2635 info->is_local = !tc->remote;
2636 info->is_transport = !tc->app;
2641 * QUIC Front-End I/O API: SSL_CTX Management
2642 * ==========================================
2645 long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2649 return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
2653 long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2655 return ssl3_callback_ctrl(s, cmd, fp);
2658 long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2660 return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
2663 int ossl_quic_renegotiate_check(SSL *ssl, int initok)
2665 /* We never do renegotiation. */
2670 * These functions define the TLSv1.2 (and below) ciphers that are supported by
2671 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
2674 int ossl_quic_num_ciphers(void)
2679 const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)