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 quic_unlock(ctx.qc); /* tsan doesn't like freeing locked mutexes */
448 #if defined(OPENSSL_THREADS)
449 ossl_crypto_mutex_free(&ctx.qc->mutex);
453 /* SSL method init */
454 int ossl_quic_init(SSL *s)
456 /* Same op as SSL_clear, forward the call. */
457 return ossl_quic_clear(s);
460 /* SSL method deinit */
461 void ossl_quic_deinit(SSL *s)
467 int ossl_quic_reset(SSL *s)
471 if (!expect_quic(s, &ctx))
474 /* TODO(QUIC); Currently a no-op. */
479 int ossl_quic_clear(SSL *s)
483 if (!expect_quic(s, &ctx))
486 /* TODO(QUIC): Currently a no-op. */
490 void ossl_quic_conn_set_override_now_cb(SSL *s,
491 OSSL_TIME (*now_cb)(void *arg),
496 if (!expect_quic(s, &ctx))
499 ctx.qc->override_now_cb = now_cb;
500 ctx.qc->override_now_cb_arg = now_cb_arg;
503 void ossl_quic_conn_force_assist_thread_wake(SSL *s)
507 if (!expect_quic(s, &ctx))
510 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
511 if (ctx.qc->is_thread_assisted && ctx.qc->started)
512 ossl_quic_thread_assist_notify_deadline_changed(&ctx.qc->thread_assist);
517 static void qc_touch_default_xso(QUIC_CONNECTION *qc)
519 qc->default_xso_created = 1;
520 qc_update_reject_policy(qc);
524 * Changes default XSO. Allows caller to keep reference to the old default XSO
525 * (if any). Reference to new XSO is transferred from caller.
528 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION *qc, QUIC_XSO *xso,
536 if (qc->default_xso != xso) {
537 *old_xso = qc->default_xso; /* transfer old XSO ref to caller */
539 qc->default_xso = xso;
543 * Changing to not having a default XSO. XSO becomes standalone and
544 * now has a ref to the QC.
546 if (!ossl_assert(SSL_up_ref(&qc->ssl)))
550 * Changing from not having a default XSO to having one. The new XSO
551 * will have had a reference to the QC we need to drop to avoid a
552 * circular reference.
554 * Currently we never change directly from one default XSO to
555 * another, though this function would also still be correct if this
558 assert(*old_xso == NULL);
560 CRYPTO_DOWN_REF(&qc->ssl.references, &refs, &qc->ssl.lock);
566 qc_touch_default_xso(qc);
570 * Changes default XSO, releasing the reference to any previous default XSO.
571 * Reference to new XSO is transferred from caller.
574 static void qc_set_default_xso(QUIC_CONNECTION *qc, QUIC_XSO *xso, int touch)
576 QUIC_XSO *old_xso = NULL;
578 qc_set_default_xso_keep_ref(qc, xso, touch, &old_xso);
581 SSL_free(&old_xso->ssl);
585 * QUIC Front-End I/O API: Network BIO Configuration
586 * =================================================
588 * Handling the different BIOs is difficult:
590 * - It is more or less a requirement that we use non-blocking network I/O;
591 * we need to be able to have timeouts on recv() calls, and make best effort
592 * (non blocking) send() and recv() calls.
594 * The only sensible way to do this is to configure the socket into
595 * non-blocking mode. We could try to do select() before calling send() or
596 * recv() to get a guarantee that the call will not block, but this will
597 * probably run into issues with buggy OSes which generate spurious socket
598 * readiness events. In any case, relying on this to work reliably does not
601 * Timeouts could be handled via setsockopt() socket timeout options, but
602 * this depends on OS support and adds another syscall to every network I/O
603 * operation. It also has obvious thread safety concerns if we want to move
604 * to concurrent use of a single socket at some later date.
606 * Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
607 * be made non-blocking. However some OSes (e.g. Windows) do not support
608 * this, so we cannot rely on this.
610 * As such, we need to configure any FD in non-blocking mode. This may
611 * confound users who pass a blocking socket to libssl. However, in practice
612 * it would be extremely strange for a user of QUIC to pass an FD to us,
613 * then also try and send receive traffic on the same socket(!). Thus the
614 * impact of this should be limited, and can be documented.
616 * - We support both blocking and non-blocking operation in terms of the API
617 * presented to the user. One prospect is to set the blocking mode based on
618 * whether the socket passed to us was already in blocking mode. However,
619 * Windows has no API for determining if a socket is in blocking mode (!),
620 * therefore this cannot be done portably. Currently therefore we expose an
621 * explicit API call to set this, and default to blocking mode.
623 * - We need to determine our initial destination UDP address. The "natural"
624 * way for a user to do this is to set the peer variable on a BIO_dgram.
625 * However, this has problems because BIO_dgram's peer variable is used for
626 * both transmission and reception. This means it can be constantly being
627 * changed to a malicious value (e.g. if some random unrelated entity on the
628 * network starts sending traffic to us) on every read call. This is not a
629 * direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
630 * calls only, which do not use this variable. However, we do need to let
631 * the user specify the peer in a 'normal' manner. The compromise here is
632 * that we grab the current peer value set at the time the write BIO is set
633 * and do not read the value again.
635 * - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
636 * Currently we do this by only supporting non-blocking mode.
641 * Determines what initial destination UDP address we should use, if possible.
642 * If this fails the client must set the destination address manually, or use a
643 * BIO which does not need a destination address.
645 static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
647 if (BIO_dgram_get_peer(net_wbio, peer) <= 0)
653 void ossl_quic_conn_set0_net_rbio(SSL *s, BIO *net_rbio)
657 if (!expect_quic(s, &ctx))
660 if (ctx.qc->net_rbio == net_rbio)
663 if (!ossl_quic_channel_set_net_rbio(ctx.qc->ch, net_rbio))
666 BIO_free(ctx.qc->net_rbio);
667 ctx.qc->net_rbio = net_rbio;
670 * If what we have is not pollable (e.g. a BIO_dgram_pair) disable blocking
671 * mode as we do not support it for non-pollable BIOs.
673 if (net_rbio != NULL) {
674 BIO_POLL_DESCRIPTOR d = {0};
676 if (!BIO_get_rpoll_descriptor(net_rbio, &d)
677 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
678 ctx.qc->blocking = 0;
679 ctx.qc->default_blocking = 0;
680 ctx.qc->can_poll_net_rbio = 0;
682 ctx.qc->can_poll_net_rbio = 1;
687 void ossl_quic_conn_set0_net_wbio(SSL *s, BIO *net_wbio)
691 if (!expect_quic(s, &ctx))
694 if (ctx.qc->net_wbio == net_wbio)
697 if (!ossl_quic_channel_set_net_wbio(ctx.qc->ch, net_wbio))
700 BIO_free(ctx.qc->net_wbio);
701 ctx.qc->net_wbio = net_wbio;
703 if (net_wbio != NULL) {
704 BIO_POLL_DESCRIPTOR d = {0};
706 if (!BIO_get_wpoll_descriptor(net_wbio, &d)
707 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
708 ctx.qc->blocking = 0;
709 ctx.qc->default_blocking = 0;
710 ctx.qc->can_poll_net_wbio = 0;
712 ctx.qc->can_poll_net_wbio = 1;
716 * If we do not have a peer address yet, and we have not started trying
717 * to connect yet, try to autodetect one.
719 if (BIO_ADDR_family(&ctx.qc->init_peer_addr) == AF_UNSPEC
720 && !ctx.qc->started) {
721 if (!csm_analyse_init_peer_addr(net_wbio, &ctx.qc->init_peer_addr))
723 BIO_ADDR_clear(&ctx.qc->init_peer_addr);
725 ossl_quic_channel_set_peer_addr(ctx.qc->ch,
726 &ctx.qc->init_peer_addr);
731 BIO *ossl_quic_conn_get_net_rbio(const SSL *s)
735 if (!expect_quic(s, &ctx))
738 return ctx.qc->net_rbio;
741 BIO *ossl_quic_conn_get_net_wbio(const SSL *s)
745 if (!expect_quic(s, &ctx))
748 return ctx.qc->net_wbio;
751 int ossl_quic_conn_get_blocking_mode(const SSL *s)
755 if (!expect_quic(s, &ctx))
759 return ctx.xso->blocking;
761 return ctx.qc->blocking;
764 int ossl_quic_conn_set_blocking_mode(SSL *s, int blocking)
768 if (!expect_quic(s, &ctx))
771 /* Cannot enable blocking mode if we do not have pollable FDs. */
773 (!ctx.qc->can_poll_net_rbio || !ctx.qc->can_poll_net_wbio))
774 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_UNSUPPORTED, NULL);
776 if (!ctx.is_stream) {
778 * If called on a QCSO, update default and connection-level blocking
781 ctx.qc->blocking = (blocking != 0);
782 ctx.qc->default_blocking = ctx.qc->blocking;
787 * If called on a QSSO or QCSO with a default XSO, update blocking
790 ctx.xso->blocking = (blocking != 0);
795 int ossl_quic_conn_set_initial_peer_addr(SSL *s,
796 const BIO_ADDR *peer_addr)
800 if (!expect_quic(s, &ctx))
804 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
807 if (peer_addr == NULL) {
808 BIO_ADDR_clear(&ctx.qc->init_peer_addr);
812 ctx.qc->init_peer_addr = *peer_addr;
817 * QUIC Front-End I/O API: Asynchronous I/O Management
818 * ===================================================
820 * (BIO/)SSL_tick => ossl_quic_tick
821 * (BIO/)SSL_get_tick_timeout => ossl_quic_get_tick_timeout
822 * (BIO/)SSL_get_poll_fd => ossl_quic_get_poll_fd
826 /* Returns 1 if the connection is being used in blocking mode. */
827 static int qc_blocking_mode(const QUIC_CONNECTION *qc)
832 static int xso_blocking_mode(const QUIC_XSO *xso)
835 && xso->conn->can_poll_net_rbio
836 && xso->conn->can_poll_net_wbio;
839 /* SSL_tick; ticks the reactor. */
841 int ossl_quic_tick(SSL *s)
845 if (!expect_quic(s, &ctx))
849 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
855 * SSL_get_tick_timeout. Get the time in milliseconds until the SSL object
856 * should be ticked by the application by calling SSL_tick(). tv is set to 0 if
857 * the object should be ticked immediately and tv->tv_sec is set to -1 if no
858 * timeout is currently active.
861 int ossl_quic_get_tick_timeout(SSL *s, struct timeval *tv)
864 OSSL_TIME deadline = ossl_time_infinite();
866 if (!expect_quic(s, &ctx))
872 = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(ctx.qc->ch));
874 if (ossl_time_is_infinite(deadline)) {
881 *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, ossl_time_now()));
886 /* SSL_get_rpoll_descriptor */
887 int ossl_quic_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
891 if (!expect_quic(s, &ctx))
894 if (desc == NULL || ctx.qc->net_rbio == NULL)
897 return BIO_get_rpoll_descriptor(ctx.qc->net_rbio, desc);
900 /* SSL_get_wpoll_descriptor */
901 int ossl_quic_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
905 if (!expect_quic(s, &ctx))
908 if (desc == NULL || ctx.qc->net_wbio == NULL)
911 return BIO_get_wpoll_descriptor(ctx.qc->net_wbio, desc);
914 /* SSL_net_read_desired */
916 int ossl_quic_get_net_read_desired(SSL *s)
921 if (!expect_quic(s, &ctx))
925 ret = ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
930 /* SSL_net_write_desired */
932 int ossl_quic_get_net_write_desired(SSL *s)
937 if (!expect_quic(s, &ctx))
941 ret = ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(ctx.qc->ch));
947 * QUIC Front-End I/O API: Connection Lifecycle Operations
948 * =======================================================
950 * SSL_do_handshake => ossl_quic_do_handshake
951 * SSL_set_connect_state => ossl_quic_set_connect_state
952 * SSL_set_accept_state => ossl_quic_set_accept_state
953 * SSL_shutdown => ossl_quic_shutdown
954 * SSL_ctrl => ossl_quic_ctrl
955 * (BIO/)SSL_connect => ossl_quic_connect
956 * (BIO/)SSL_accept => ossl_quic_accept
961 static int quic_shutdown_wait(void *arg)
963 QUIC_CONNECTION *qc = arg;
965 return ossl_quic_channel_is_terminated(qc->ch);
969 int ossl_quic_conn_shutdown(SSL *s, uint64_t flags,
970 const SSL_SHUTDOWN_EX_ARGS *args,
976 if (!expect_quic(s, &ctx))
980 /* TODO(QUIC): Semantics currently undefined for QSSOs */
985 ossl_quic_channel_local_close(ctx.qc->ch,
986 args != NULL ? args->quic_error_code : 0);
988 /* TODO(QUIC): !SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH */
990 if (ossl_quic_channel_is_terminated(ctx.qc->ch)) {
995 if (qc_blocking_mode(ctx.qc) && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0)
996 block_until_pred(ctx.qc, quic_shutdown_wait, ctx.qc, 0);
998 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1000 ret = ossl_quic_channel_is_terminated(ctx.qc->ch);
1001 quic_unlock(ctx.qc);
1006 long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
1010 if (!expect_quic(s, &ctx))
1015 /* If called on a QCSO, update the default mode. */
1017 ctx.qc->default_ssl_mode |= (uint32_t)larg;
1020 * If we were called on a QSSO or have a default stream, we also update
1023 if (ctx.xso != NULL) {
1024 /* Cannot enable EPW while AON write in progress. */
1025 if (ctx.xso->aon_write_in_progress)
1026 larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
1028 ctx.xso->ssl_mode |= (uint32_t)larg;
1029 return ctx.xso->ssl_mode;
1032 return ctx.qc->default_ssl_mode;
1033 case SSL_CTRL_CLEAR_MODE:
1035 ctx.qc->default_ssl_mode &= ~(uint32_t)larg;
1037 if (ctx.xso != NULL) {
1038 ctx.xso->ssl_mode &= ~(uint32_t)larg;
1039 return ctx.xso->ssl_mode;
1042 return ctx.qc->default_ssl_mode;
1044 /* Probably a TLS related ctrl. Defer to our internal SSL object */
1045 return SSL_ctrl(ctx.qc->tls, cmd, larg, parg);
1049 /* SSL_set_connect_state */
1050 void ossl_quic_set_connect_state(SSL *s)
1054 if (!expect_quic(s, &ctx))
1057 /* Cannot be changed after handshake started */
1058 if (ctx.qc->started || ctx.is_stream)
1061 ctx.qc->as_server_state = 0;
1064 /* SSL_set_accept_state */
1065 void ossl_quic_set_accept_state(SSL *s)
1069 if (!expect_quic(s, &ctx))
1072 /* Cannot be changed after handshake started */
1073 if (ctx.qc->started || ctx.is_stream)
1076 ctx.qc->as_server_state = 1;
1079 /* SSL_do_handshake */
1080 struct quic_handshake_wait_args {
1081 QUIC_CONNECTION *qc;
1084 static int quic_handshake_wait(void *arg)
1086 struct quic_handshake_wait_args *args = arg;
1088 if (!ossl_quic_channel_is_active(args->qc->ch))
1091 if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
1097 static int configure_channel(QUIC_CONNECTION *qc)
1099 assert(qc->ch != NULL);
1101 if (!ossl_quic_channel_set_net_rbio(qc->ch, qc->net_rbio)
1102 || !ossl_quic_channel_set_net_wbio(qc->ch, qc->net_wbio)
1103 || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
1110 static int create_channel(QUIC_CONNECTION *qc)
1112 QUIC_CHANNEL_ARGS args = {0};
1114 args.libctx = qc->ssl.ctx->libctx;
1115 args.propq = qc->ssl.ctx->propq;
1116 args.is_server = qc->as_server;
1118 args.mutex = qc->mutex;
1119 args.now_cb = qc->override_now_cb;
1120 args.now_cb_arg = qc->override_now_cb_arg;
1122 qc->ch = ossl_quic_channel_new(&args);
1130 * Creates a channel and configures it with the information we have accumulated
1131 * via calls made to us from the application prior to starting a handshake
1135 static int ensure_channel_started(QUIC_CONNECTION *qc)
1138 if (!configure_channel(qc)
1139 || !ossl_quic_channel_start(qc->ch))
1142 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1143 if (qc->is_thread_assisted)
1144 if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch))
1153 ossl_quic_channel_free(qc->ch);
1159 static int quic_do_handshake(QCTX *ctx)
1162 QUIC_CONNECTION *qc = ctx->qc;
1164 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1165 /* Handshake already completed. */
1168 if (ossl_quic_channel_is_term_any(qc->ch))
1169 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1171 if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
1172 /* Peer address must have been set. */
1173 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
1174 return -1; /* Non-protocol error */
1177 if (qc->as_server != qc->as_server_state) {
1178 /* TODO(QUIC): Must match the method used to create the QCSO */
1179 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
1180 return -1; /* Non-protocol error */
1183 if (qc->net_rbio == NULL || qc->net_wbio == NULL) {
1184 /* Need read and write BIOs. */
1185 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BIO_NOT_SET, NULL);
1186 return -1; /* Non-protocol error */
1190 * Start connection process. Note we may come here multiple times in
1191 * non-blocking mode, which is fine.
1193 if (!ensure_channel_started(qc)) {
1194 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1195 return -1; /* Non-protocol error */
1198 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1199 /* The handshake is now done. */
1202 if (qc_blocking_mode(qc)) {
1203 /* In blocking mode, wait for the handshake to complete. */
1204 struct quic_handshake_wait_args args;
1208 ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
1209 if (!ossl_quic_channel_is_active(qc->ch)) {
1210 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1211 return 0; /* Shutdown before completion */
1212 } else if (ret <= 0) {
1213 QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1214 return -1; /* Non-protocol error */
1217 assert(ossl_quic_channel_is_handshake_complete(qc->ch));
1220 /* Try to advance the reactor. */
1221 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1223 if (ossl_quic_channel_is_handshake_complete(qc->ch))
1224 /* The handshake is now done. */
1227 /* Otherwise, indicate that the handshake isn't done yet. */
1228 QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1229 return -1; /* Non-protocol error */
1234 int ossl_quic_do_handshake(SSL *s)
1239 if (!expect_quic(s, &ctx))
1244 ret = quic_do_handshake(&ctx);
1245 quic_unlock(ctx.qc);
1250 int ossl_quic_connect(SSL *s)
1252 /* Ensure we are in connect state (no-op if non-idle). */
1253 ossl_quic_set_connect_state(s);
1255 /* Begin or continue the handshake */
1256 return ossl_quic_do_handshake(s);
1260 int ossl_quic_accept(SSL *s)
1262 /* Ensure we are in accept state (no-op if non-idle). */
1263 ossl_quic_set_accept_state(s);
1265 /* Begin or continue the handshake */
1266 return ossl_quic_do_handshake(s);
1270 * QUIC Front-End I/O API: Stream Lifecycle Operations
1271 * ===================================================
1273 * SSL_stream_new => ossl_quic_conn_stream_new
1278 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
1279 * default XSO was created. Returns 0 if it was not (e.g. because it already
1280 * exists). Note that this is NOT an error condition.
1283 static int qc_try_create_default_xso_for_write(QCTX *ctx)
1286 QUIC_CONNECTION *qc = ctx->qc;
1288 if (qc->default_xso_created
1289 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1291 * We only do this once. If the user detaches a previously created
1292 * default XSO we don't auto-create another one.
1294 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1296 /* Create a locally-initiated stream. */
1297 if (qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_AUTO_UNI)
1298 flags |= SSL_STREAM_FLAG_UNI;
1300 qc_set_default_xso(qc, (QUIC_XSO *)quic_conn_stream_new(ctx, flags,
1303 if (qc->default_xso == NULL)
1304 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1306 qc_touch_default_xso(qc);
1310 struct quic_wait_for_stream_args {
1311 QUIC_CONNECTION *qc;
1318 static int quic_wait_for_stream(void *arg)
1320 struct quic_wait_for_stream_args *args = arg;
1322 if (!ossl_quic_channel_is_active(args->qc->ch)) {
1323 /* If connection is torn down due to an error while blocking, stop. */
1324 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1328 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1329 args->expect_id | QUIC_STREAM_DIR_BIDI);
1330 if (args->qs == NULL)
1331 args->qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args->qc->ch),
1332 args->expect_id | QUIC_STREAM_DIR_UNI);
1334 if (args->qs != NULL)
1335 return 1; /* stream now exists */
1337 return 0; /* did not get a stream, keep trying */
1341 static int qc_wait_for_default_xso_for_read(QCTX *ctx)
1343 /* Called on a QCSO and we don't currently have a default stream. */
1345 QUIC_CONNECTION *qc = ctx->qc;
1348 struct quic_wait_for_stream_args wargs;
1351 * If default stream functionality is disabled or we already detached
1352 * one, don't make another default stream and just fail.
1354 if (qc->default_xso_created
1355 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
1356 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_NO_STREAM, NULL);
1359 * The peer may have opened a stream since we last ticked. So tick and
1360 * see if the stream with ordinal 0 (remote, bidi/uni based on stream
1361 * mode) exists yet. QUIC stream IDs must be allocated in order, so the
1362 * first stream created by a peer must have an ordinal of 0.
1364 expect_id = qc->as_server
1365 ? QUIC_STREAM_INITIATOR_CLIENT
1366 : QUIC_STREAM_INITIATOR_SERVER;
1368 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1369 expect_id | QUIC_STREAM_DIR_BIDI);
1371 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1372 expect_id | QUIC_STREAM_DIR_UNI);
1375 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1377 qs = ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc->ch),
1382 if (!qc_blocking_mode(qc))
1383 /* Non-blocking mode, so just bail immediately. */
1384 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_READ);
1386 /* Block until we have a stream. */
1390 wargs.expect_id = expect_id;
1392 res = block_until_pred(qc, quic_wait_for_stream, &wargs, 0);
1394 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1395 else if (res < 0 || wargs.qs == NULL)
1396 /* quic_wait_for_stream raised error here */
1403 * We now have qs != NULL. Make it the default stream, creating the
1406 qc_set_default_xso(qc, create_xso_from_stream(qc, qs), /*touch=*/0);
1407 if (qc->default_xso == NULL)
1408 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1410 qc_touch_default_xso(qc); /* inhibits default XSO */
1415 static QUIC_XSO *create_xso_from_stream(QUIC_CONNECTION *qc, QUIC_STREAM *qs)
1417 QUIC_XSO *xso = NULL;
1419 if ((xso = OPENSSL_zalloc(sizeof(*xso))) == NULL)
1422 if (!ossl_ssl_init(&xso->ssl, qc->ssl.ctx, qc->ssl.method, SSL_TYPE_QUIC_XSO))
1426 if (!SSL_up_ref(&qc->ssl))
1430 xso->blocking = qc->default_blocking;
1431 xso->ssl_mode = qc->default_ssl_mode;
1432 xso->last_error = SSL_ERROR_NONE;
1444 /* locking depends on need_lock */
1445 static SSL *quic_conn_stream_new(QCTX *ctx, uint64_t flags, int need_lock)
1447 QUIC_CONNECTION *qc = ctx->qc;
1448 QUIC_XSO *xso = NULL;
1449 QUIC_STREAM *qs = NULL;
1450 int is_uni = ((flags & SSL_STREAM_FLAG_UNI) != 0);
1455 if (ossl_quic_channel_is_term_any(qc->ch)) {
1456 QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1460 qs = ossl_quic_channel_new_stream_local(qc->ch, is_uni);
1464 xso = create_xso_from_stream(qc, qs);
1468 qc_touch_default_xso(qc); /* inhibits default XSO */
1476 ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc->ch), qs);
1485 SSL *ossl_quic_conn_stream_new(SSL *s, uint64_t flags)
1489 if (!expect_quic_conn_only(s, &ctx))
1492 return quic_conn_stream_new(&ctx, flags, /*need_lock=*/1);
1496 * QUIC Front-End I/O API: Steady-State Operations
1497 * ===============================================
1499 * Here we dispatch calls to the steady-state front-end I/O API functions; that
1500 * is, the functions used during the established phase of a QUIC connection
1501 * (e.g. SSL_read, SSL_write).
1503 * Each function must handle both blocking and non-blocking modes. As discussed
1504 * above, all QUIC I/O is implemented using non-blocking mode internally.
1506 * SSL_get_error => partially implemented by ossl_quic_get_error
1507 * (BIO/)SSL_read => ossl_quic_read
1508 * (BIO/)SSL_write => ossl_quic_write
1509 * SSL_pending => ossl_quic_pending
1510 * SSL_stream_conclude => ossl_quic_conn_stream_conclude
1514 int ossl_quic_get_error(const SSL *s, int i)
1518 if (!expect_quic(s, &ctx))
1521 return ctx.is_stream ? ctx.xso->last_error : ctx.qc->last_error;
1528 * The set of functions below provide the implementation of the public SSL_write
1529 * function. We must handle:
1531 * - both blocking and non-blocking operation at the application level,
1532 * depending on how we are configured;
1534 * - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
1536 * - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
1540 static void quic_post_write(QUIC_XSO *xso, int did_append, int do_tick)
1543 * We have appended at least one byte to the stream.
1544 * Potentially mark stream as active, depending on FC.
1547 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso->conn->ch),
1553 * TODO(QUIC): It is probably inefficient to try and do this immediately,
1554 * plus we should eventually consider Nagle's algorithm.
1557 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso->conn->ch), 0);
1560 struct quic_write_again_args {
1562 const unsigned char *buf;
1564 size_t total_written;
1568 static int quic_write_again(void *arg)
1570 struct quic_write_again_args *args = arg;
1571 size_t actual_written = 0;
1573 if (!ossl_quic_channel_is_active(args->xso->conn->ch))
1574 /* If connection is torn down due to an error while blocking, stop. */
1577 if (!ossl_quic_sstream_append(args->xso->stream->sstream,
1578 args->buf, args->len, &actual_written))
1581 quic_post_write(args->xso, actual_written > 0, 0);
1583 args->buf += actual_written;
1584 args->len -= actual_written;
1585 args->total_written += actual_written;
1588 /* Written everything, done. */
1591 /* Not written everything yet, keep trying. */
1596 static int quic_write_blocking(QCTX *ctx, const void *buf, size_t len,
1600 QUIC_XSO *xso = ctx->xso;
1601 struct quic_write_again_args args;
1602 size_t actual_written = 0;
1604 /* First make a best effort to append as much of the data as possible. */
1605 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len,
1607 /* Stream already finished or allocation error. */
1609 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1612 quic_post_write(xso, actual_written > 0, 1);
1614 if (actual_written == len) {
1615 /* Managed to append everything on the first try. */
1616 *written = actual_written;
1621 * We did not manage to append all of the data immediately, so the stream
1622 * buffer has probably filled up. This means we need to block until some of
1626 args.buf = (const unsigned char *)buf + actual_written;
1627 args.len = len - actual_written;
1628 args.total_written = 0;
1630 res = block_until_pred(xso->conn, quic_write_again, &args, 0);
1632 if (!ossl_quic_channel_is_active(xso->conn->ch))
1633 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1635 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1638 *written = args.total_written;
1643 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
1646 static void aon_write_begin(QUIC_XSO *xso, const unsigned char *buf,
1647 size_t buf_len, size_t already_sent)
1649 assert(!xso->aon_write_in_progress);
1651 xso->aon_write_in_progress = 1;
1652 xso->aon_buf_base = buf;
1653 xso->aon_buf_pos = already_sent;
1654 xso->aon_buf_len = buf_len;
1657 static void aon_write_finish(QUIC_XSO *xso)
1659 xso->aon_write_in_progress = 0;
1660 xso->aon_buf_base = NULL;
1661 xso->aon_buf_pos = 0;
1662 xso->aon_buf_len = 0;
1666 static int quic_write_nonblocking_aon(QCTX *ctx, const void *buf,
1667 size_t len, size_t *written)
1669 QUIC_XSO *xso = ctx->xso;
1670 const void *actual_buf;
1671 size_t actual_len, actual_written = 0;
1672 int accept_moving_buffer
1673 = ((xso->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
1675 if (xso->aon_write_in_progress) {
1677 * We are in the middle of an AON write (i.e., a previous write did not
1678 * manage to append all data to the SSTREAM and we have Enable Partial
1679 * Write (EPW) mode disabled.)
1681 if ((!accept_moving_buffer && xso->aon_buf_base != buf)
1682 || len != xso->aon_buf_len)
1684 * Pointer must not have changed if we are not in accept moving
1685 * buffer mode. Length must never change.
1687 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, SSL_R_BAD_WRITE_RETRY, NULL);
1689 actual_buf = (unsigned char *)buf + xso->aon_buf_pos;
1690 actual_len = len - xso->aon_buf_pos;
1691 assert(actual_len > 0);
1697 /* First make a best effort to append as much of the data as possible. */
1698 if (!ossl_quic_sstream_append(xso->stream->sstream, actual_buf, actual_len,
1700 /* Stream already finished or allocation error. */
1702 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1705 quic_post_write(xso, actual_written > 0, 1);
1707 if (actual_written == actual_len) {
1708 /* We have sent everything. */
1709 if (xso->aon_write_in_progress) {
1711 * We have sent everything, and we were in the middle of an AON
1712 * write. The output write length is the total length of the AON
1713 * buffer, not however many bytes we managed to write to the stream
1716 *written = xso->aon_buf_len;
1717 aon_write_finish(xso);
1719 *written = actual_written;
1725 if (xso->aon_write_in_progress) {
1727 * AON write is in progress but we have not written everything yet. We
1728 * may have managed to send zero bytes, or some number of bytes less
1729 * than the total remaining which need to be appended during this
1732 xso->aon_buf_pos += actual_written;
1733 assert(xso->aon_buf_pos < xso->aon_buf_len);
1734 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
1738 * Not in an existing AON operation but partial write is not enabled, so we
1739 * need to begin a new AON operation. However we needn't bother if we didn't
1740 * actually append anything.
1742 if (actual_written > 0)
1743 aon_write_begin(xso, buf, len, actual_written);
1746 * AON - We do not publicly admit to having appended anything until AON
1750 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_WANT_WRITE);
1754 static int quic_write_nonblocking_epw(QCTX *ctx, const void *buf, size_t len,
1757 QUIC_XSO *xso = ctx->xso;
1759 /* Simple best effort operation. */
1760 if (!ossl_quic_sstream_append(xso->stream->sstream, buf, len, written)) {
1761 /* Stream already finished or allocation error. */
1763 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1766 quic_post_write(xso, *written > 0, 1);
1771 int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
1782 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, &ctx))
1785 partial_write = ((ctx.xso->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0);
1787 if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1788 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1793 * If we haven't finished the handshake, try to advance it.
1794 * We don't accept writes until the handshake is completed.
1796 if (quic_do_handshake(&ctx) < 1) {
1801 if (ctx.xso->stream == NULL || ctx.xso->stream->sstream == NULL) {
1802 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1806 if (xso_blocking_mode(ctx.xso))
1807 ret = quic_write_blocking(&ctx, buf, len, written);
1808 else if (partial_write)
1809 ret = quic_write_nonblocking_epw(&ctx, buf, len, written);
1811 ret = quic_write_nonblocking_aon(&ctx, buf, len, written);
1814 quic_unlock(ctx.qc);
1822 struct quic_read_again_args {
1824 QUIC_STREAM *stream;
1832 static int quic_read_actual(QCTX *ctx,
1833 QUIC_STREAM *stream,
1834 void *buf, size_t buf_len,
1839 QUIC_CONNECTION *qc = ctx->qc;
1841 /* If the receive part of the stream is over, issue EOF. */
1842 if (stream->recv_fin_retired)
1843 return QUIC_RAISE_NORMAL_ERROR(ctx, SSL_ERROR_ZERO_RETURN);
1845 if (stream->rstream == NULL)
1846 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1849 if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
1850 bytes_read, &is_fin))
1851 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1854 if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
1855 bytes_read, &is_fin))
1856 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1860 if (*bytes_read > 0) {
1862 * We have read at least one byte from the stream. Inform stream-level
1863 * RXFC of the retirement of controlled bytes. Update the active stream
1864 * status (the RXFC may now want to emit a frame granting more credit to
1867 OSSL_RTT_INFO rtt_info;
1869 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
1871 if (!ossl_quic_rxfc_on_retire(&stream->rxfc, *bytes_read,
1872 rtt_info.smoothed_rtt))
1873 return QUIC_RAISE_NON_NORMAL_ERROR(ctx, ERR_R_INTERNAL_ERROR, NULL);
1877 stream->recv_fin_retired = 1;
1879 if (*bytes_read > 0)
1880 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
1888 static int quic_read_again(void *arg)
1890 struct quic_read_again_args *args = arg;
1892 if (!ossl_quic_channel_is_active(args->ctx->qc->ch)) {
1893 /* If connection is torn down due to an error while blocking, stop. */
1894 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1898 if (!quic_read_actual(args->ctx, args->stream,
1899 args->buf, args->len, args->bytes_read,
1903 if (*args->bytes_read > 0)
1904 /* got at least one byte, the SSL_read op can finish now */
1907 return 0; /* did not read anything, keep trying */
1911 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
1915 struct quic_read_again_args args;
1919 if (!expect_quic(s, &ctx))
1924 if (ossl_quic_channel_is_term_any(ctx.qc->ch)) {
1925 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1929 /* If we haven't finished the handshake, try to advance it. */
1930 if (quic_do_handshake(&ctx) < 1) {
1931 ret = 0; /* ossl_quic_do_handshake raised error here */
1935 if (ctx.xso == NULL) {
1937 * Called on a QCSO and we don't currently have a default stream.
1939 * Wait until we get a stream initiated by the peer (blocking mode) or
1940 * fail if we don't have one yet (non-blocking mode).
1942 if (!qc_wait_for_default_xso_for_read(&ctx)) {
1943 ret = 0; /* error already raised here */
1947 ctx.xso = ctx.qc->default_xso;
1950 if (ctx.xso->stream == NULL) {
1951 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1955 if (!quic_read_actual(&ctx, ctx.xso->stream, buf, len, bytes_read, peek)) {
1956 ret = 0; /* quic_read_actual raised error here */
1960 if (*bytes_read > 0) {
1962 * Even though we succeeded, tick the reactor here to ensure we are
1963 * handling other aspects of the QUIC connection.
1965 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx.qc->ch), 0);
1967 } else if (xso_blocking_mode(ctx.xso)) {
1969 * We were not able to read anything immediately, so our stream
1970 * buffer is empty. This means we need to block until we get
1971 * at least one byte.
1974 args.stream = ctx.xso->stream;
1977 args.bytes_read = bytes_read;
1980 res = block_until_pred(ctx.qc, quic_read_again, &args, 0);
1982 ret = QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
1984 } else if (res < 0) {
1985 ret = 0; /* quic_read_again raised error here */
1991 /* We did not get any bytes and are not in blocking mode. */
1992 ret = QUIC_RAISE_NORMAL_ERROR(&ctx, SSL_ERROR_WANT_READ);
1996 quic_unlock(ctx.qc);
2000 int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
2002 return quic_read(s, buf, len, bytes_read, 0);
2005 int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
2007 return quic_read(s, buf, len, bytes_read, 1);
2015 static size_t ossl_quic_pending_int(const SSL *s)
2021 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, &ctx))
2024 if (ctx.xso->stream == NULL || ctx.xso->stream->rstream == NULL)
2025 /* Cannot raise errors here because we are const, just fail. */
2028 if (!ossl_quic_rstream_available(ctx.xso->stream->rstream, &avail, &fin))
2032 quic_unlock(ctx.qc);
2036 size_t ossl_quic_pending(const SSL *s)
2038 return ossl_quic_pending_int(s);
2041 int ossl_quic_has_pending(const SSL *s)
2043 return ossl_quic_pending_int(s) > 0;
2047 * SSL_stream_conclude
2048 * -------------------
2051 int ossl_quic_conn_stream_conclude(SSL *s)
2056 if (!expect_quic_with_stream_lock(s, /*remote_init=*/0, &ctx))
2059 qs = ctx.xso->stream;
2061 if (qs == NULL || qs->sstream == NULL) {
2062 quic_unlock(ctx.qc);
2066 if (!ossl_quic_channel_is_active(ctx.qc->ch)
2067 || ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
2068 quic_unlock(ctx.qc);
2072 ossl_quic_sstream_fin(qs->sstream);
2073 quic_post_write(ctx.xso, 1, 1);
2074 quic_unlock(ctx.qc);
2079 * SSL_inject_net_dgram
2080 * --------------------
2083 int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
2085 const BIO_ADDR *peer,
2086 const BIO_ADDR *local)
2092 if (!expect_quic(s, &ctx))
2097 demux = ossl_quic_channel_get0_demux(ctx.qc->ch);
2098 ret = ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
2100 quic_unlock(ctx.qc);
2105 * SSL_get0_connection
2106 * -------------------
2108 SSL *ossl_quic_get0_connection(SSL *s)
2112 if (!expect_quic(s, &ctx))
2115 return &ctx.qc->ssl;
2119 * SSL_get_stream_type
2120 * -------------------
2122 int ossl_quic_get_stream_type(SSL *s)
2126 if (!expect_quic(s, &ctx))
2127 return SSL_STREAM_TYPE_BIDI;
2129 if (ctx.xso == NULL) {
2131 * If deferred XSO creation has yet to occur, proceed according to the
2132 * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
2133 * what kind of stream will be created yet, so return BIDI on the basis
2134 * that at this time, the client still has the option of calling
2135 * SSL_read() or SSL_write() first.
2137 if (ctx.qc->default_xso_created
2138 || ctx.qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2139 return SSL_STREAM_TYPE_NONE;
2141 return SSL_STREAM_TYPE_BIDI;
2144 if (ossl_quic_stream_is_bidi(ctx.xso->stream))
2145 return SSL_STREAM_TYPE_BIDI;
2147 if (ossl_quic_stream_is_server_init(ctx.xso->stream) != ctx.qc->as_server)
2148 return SSL_STREAM_TYPE_READ;
2150 return SSL_STREAM_TYPE_WRITE;
2158 uint64_t ossl_quic_get_stream_id(SSL *s)
2163 if (!expect_quic_with_stream_lock(s, /*remote_init=*/-1, &ctx))
2166 id = ctx.xso->stream->id;
2167 quic_unlock(ctx.qc);
2173 * SSL_set_default_stream_mode
2174 * ---------------------------
2177 int ossl_quic_set_default_stream_mode(SSL *s, uint32_t mode)
2181 if (!expect_quic_conn_only(s, &ctx))
2186 if (ctx.qc->default_xso_created)
2187 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
2188 "too late to change default stream mode");
2191 case SSL_DEFAULT_STREAM_MODE_NONE:
2192 case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI:
2193 case SSL_DEFAULT_STREAM_MODE_AUTO_UNI:
2194 ctx.qc->default_stream_mode = mode;
2197 quic_unlock(ctx.qc);
2198 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
2199 "bad default stream type");
2202 quic_unlock(ctx.qc);
2211 SSL *ossl_quic_detach_stream(SSL *s)
2214 QUIC_XSO *xso = NULL;
2216 if (!expect_quic_conn_only(s, &ctx))
2221 /* Calling this function inhibits default XSO autocreation. */
2222 /* QC ref to any default XSO is transferred to us and to caller. */
2223 qc_set_default_xso_keep_ref(ctx.qc, NULL, /*touch=*/1, &xso);
2225 quic_unlock(ctx.qc);
2227 return xso != NULL ? &xso->ssl : NULL;
2235 int ossl_quic_attach_stream(SSL *conn, SSL *stream)
2241 if (!expect_quic_conn_only(conn, &ctx))
2244 if (stream == NULL || stream->type != SSL_TYPE_QUIC_XSO)
2245 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_NULL_PARAMETER,
2246 "stream to attach must be a valid QUIC stream");
2248 xso = (QUIC_XSO *)stream;
2252 if (ctx.qc->default_xso != NULL) {
2253 quic_unlock(ctx.qc);
2254 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
2255 "connection already has a default stream");
2259 * It is a caller error for the XSO being attached as a default XSO to have
2260 * more than one ref.
2262 if (!CRYPTO_GET_REF(&xso->ssl.references, &nref, &xso->ssl.lock)) {
2263 quic_unlock(ctx.qc);
2264 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR,
2269 quic_unlock(ctx.qc);
2270 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_PASSED_INVALID_ARGUMENT,
2271 "stream being attached must have "
2272 "only 1 reference");
2275 /* Caller's reference to the XSO is transferred to us. */
2276 /* Calling this function inhibits default XSO autocreation. */
2277 qc_set_default_xso(ctx.qc, xso, /*touch=*/1);
2279 quic_unlock(ctx.qc);
2284 * SSL_set_incoming_stream_policy
2285 * ------------------------------
2288 static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION *qc)
2290 switch (qc->incoming_stream_policy) {
2291 case SSL_INCOMING_STREAM_POLICY_AUTO:
2292 if ((qc->default_xso == NULL && !qc->default_xso_created)
2293 || qc->default_stream_mode == SSL_DEFAULT_STREAM_MODE_NONE)
2294 return SSL_INCOMING_STREAM_POLICY_ACCEPT;
2296 return SSL_INCOMING_STREAM_POLICY_REJECT;
2299 return qc->incoming_stream_policy;
2304 static void qc_update_reject_policy(QUIC_CONNECTION *qc)
2306 int policy = qc_get_effective_incoming_stream_policy(qc);
2307 int enable_reject = (policy == SSL_INCOMING_STREAM_POLICY_REJECT);
2309 ossl_quic_channel_set_incoming_stream_auto_reject(qc->ch,
2311 qc->incoming_stream_aec);
2315 int ossl_quic_set_incoming_stream_policy(SSL *s, int policy,
2321 if (!expect_quic_conn_only(s, &ctx))
2327 case SSL_INCOMING_STREAM_POLICY_AUTO:
2328 case SSL_INCOMING_STREAM_POLICY_ACCEPT:
2329 case SSL_INCOMING_STREAM_POLICY_REJECT:
2330 ctx.qc->incoming_stream_policy = policy;
2331 ctx.qc->incoming_stream_aec = aec;
2339 qc_update_reject_policy(ctx.qc);
2340 quic_unlock(ctx.qc);
2348 struct wait_for_incoming_stream_args {
2354 static int wait_for_incoming_stream(void *arg)
2356 struct wait_for_incoming_stream_args *args = arg;
2357 QUIC_CONNECTION *qc = args->ctx->qc;
2358 QUIC_STREAM_MAP *qsm = ossl_quic_channel_get_qsm(qc->ch);
2360 if (!ossl_quic_channel_is_active(qc->ch)) {
2361 /* If connection is torn down due to an error while blocking, stop. */
2362 QUIC_RAISE_NON_NORMAL_ERROR(args->ctx, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
2366 args->qs = ossl_quic_stream_map_peek_accept_queue(qsm);
2367 if (args->qs != NULL)
2368 return 1; /* got a stream */
2370 return 0; /* did not get a stream, keep trying */
2374 SSL *ossl_quic_accept_stream(SSL *s, uint64_t flags)
2379 QUIC_STREAM_MAP *qsm;
2382 OSSL_RTT_INFO rtt_info;
2384 if (!expect_quic_conn_only(s, &ctx))
2389 if (qc_get_effective_incoming_stream_policy(ctx.qc)
2390 == SSL_INCOMING_STREAM_POLICY_REJECT)
2393 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
2395 qs = ossl_quic_stream_map_peek_accept_queue(qsm);
2397 if (qc_blocking_mode(ctx.qc)
2398 && (flags & SSL_ACCEPT_STREAM_NO_BLOCK) == 0) {
2399 struct wait_for_incoming_stream_args args;
2404 ret = block_until_pred(ctx.qc, wait_for_incoming_stream, &args, 0);
2406 QUIC_RAISE_NON_NORMAL_ERROR(&ctx, ERR_R_INTERNAL_ERROR, NULL);
2408 } else if (ret < 0 || args.qs == NULL) {
2418 xso = create_xso_from_stream(ctx.qc, qs);
2422 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx.qc->ch), &rtt_info);
2423 ossl_quic_stream_map_remove_from_accept_queue(qsm, qs,
2424 rtt_info.smoothed_rtt);
2427 /* Calling this function inhibits default XSO autocreation. */
2428 qc_touch_default_xso(ctx.qc); /* inhibits default XSO */
2431 quic_unlock(ctx.qc);
2436 * SSL_get_accept_stream_queue_len
2437 * -------------------------------
2440 size_t ossl_quic_get_accept_stream_queue_len(SSL *s)
2445 if (!expect_quic_conn_only(s, &ctx))
2450 v = ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(ctx.qc->ch));
2452 quic_unlock(ctx.qc);
2460 int ossl_quic_stream_reset(SSL *ssl,
2461 const SSL_STREAM_RESET_ARGS *args,
2465 QUIC_STREAM_MAP *qsm;
2467 uint64_t error_code;
2469 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/0, &ctx))
2472 qsm = ossl_quic_channel_get_qsm(ctx.qc->ch);
2473 qs = ctx.xso->stream;
2474 error_code = (args != NULL ? args->quic_error_code : 0);
2476 ossl_quic_stream_map_reset_stream_send_part(qsm, qs, error_code);
2478 quic_unlock(ctx.qc);
2483 * SSL_get_stream_read_state
2484 * -------------------------
2486 static void quic_classify_stream(QUIC_CONNECTION *qc,
2490 uint64_t *app_error_code)
2493 uint64_t final_size;
2495 local_init = (ossl_quic_stream_is_server_init(qs) == qc->as_server);
2497 if (app_error_code != NULL)
2498 *app_error_code = UINT64_MAX;
2500 app_error_code = &final_size; /* throw away value */
2502 if (!ossl_quic_stream_is_bidi(qs) && local_init != is_write) {
2504 * Unidirectional stream and this direction of transmission doesn't
2507 *state = SSL_STREAM_STATE_WRONG_DIR;
2508 } else if (ossl_quic_channel_is_term_any(qc->ch)) {
2509 /* Connection already closed. */
2510 *state = SSL_STREAM_STATE_CONN_CLOSED;
2511 } else if (!is_write && qs->recv_fin_retired) {
2512 /* Application has read a FIN. */
2513 *state = SSL_STREAM_STATE_FINISHED;
2514 } else if ((!is_write && qs->stop_sending)
2515 || (is_write && qs->reset_stream)) {
2517 * Stream has been reset locally. FIN takes precedence over this for the
2518 * read case as the application need not care if the stream is reset
2519 * after a FIN has been successfully processed.
2521 *state = SSL_STREAM_STATE_RESET_LOCAL;
2522 *app_error_code = !is_write
2523 ? qs->stop_sending_aec
2524 : qs->reset_stream_aec;
2525 } else if ((!is_write && qs->peer_reset_stream)
2526 || (is_write && qs->peer_stop_sending)) {
2528 * Stream has been reset remotely. */
2529 *state = SSL_STREAM_STATE_RESET_REMOTE;
2530 *app_error_code = !is_write
2531 ? qs->peer_reset_stream_aec
2532 : qs->peer_stop_sending_aec;
2533 } else if (is_write && ossl_quic_sstream_get_final_size(qs->sstream,
2536 * Stream has been finished. Stream reset takes precedence over this for
2537 * the write case as peer may not have received all data.
2539 *state = SSL_STREAM_STATE_FINISHED;
2541 /* Stream still healthy. */
2542 *state = SSL_STREAM_STATE_OK;
2546 static int quic_get_stream_state(SSL *ssl, int is_write)
2551 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, &ctx))
2552 return SSL_STREAM_STATE_NONE;
2554 quic_classify_stream(ctx.qc, ctx.xso->stream, is_write, &state, NULL);
2555 quic_unlock(ctx.qc);
2559 int ossl_quic_get_stream_read_state(SSL *ssl)
2561 return quic_get_stream_state(ssl, /*is_write=*/0);
2565 * SSL_get_stream_write_state
2566 * --------------------------
2568 int ossl_quic_get_stream_write_state(SSL *ssl)
2570 return quic_get_stream_state(ssl, /*is_write=*/1);
2574 * SSL_get_stream_read_error_code
2575 * ------------------------------
2577 static int quic_get_stream_error_code(SSL *ssl, int is_write,
2578 uint64_t *app_error_code)
2583 if (!expect_quic_with_stream_lock(ssl, /*remote_init=*/-1, &ctx))
2586 quic_classify_stream(ctx.qc, ctx.xso->stream, /*is_write=*/0,
2587 &state, app_error_code);
2589 quic_unlock(ctx.qc);
2591 case SSL_STREAM_STATE_FINISHED:
2593 case SSL_STREAM_STATE_RESET_LOCAL:
2594 case SSL_STREAM_STATE_RESET_REMOTE:
2601 int ossl_quic_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code)
2603 return quic_get_stream_error_code(ssl, /*is_write=*/0, app_error_code);
2607 * SSL_get_stream_write_error_code
2608 * -------------------------------
2610 int ossl_quic_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code)
2612 return quic_get_stream_error_code(ssl, /*is_write=*/1, app_error_code);
2616 * SSL_get_conn_close_info
2617 * -----------------------
2619 int ossl_quic_get_conn_close_info(SSL *ssl,
2620 SSL_CONN_CLOSE_INFO *info,
2624 const QUIC_TERMINATE_CAUSE *tc;
2626 if (!expect_quic_conn_only(ssl, &ctx))
2629 tc = ossl_quic_channel_get_terminate_cause(ctx.qc->ch);
2633 info->error_code = tc->error_code;
2634 info->reason = NULL; /* TODO(QUIC): Wire reason */
2635 info->reason_len = 0;
2636 info->is_local = !tc->remote;
2637 info->is_transport = !tc->app;
2642 * QUIC Front-End I/O API: SSL_CTX Management
2643 * ==========================================
2646 long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2650 return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
2654 long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2656 return ssl3_callback_ctrl(s, cmd, fp);
2659 long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2661 return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
2664 int ossl_quic_renegotiate_check(SSL *ssl, int initok)
2666 /* We never do renegotiation. */
2671 * These functions define the TLSv1.2 (and below) ciphers that are supported by
2672 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
2675 int ossl_quic_num_ciphers(void)
2680 const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)