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 static void aon_write_finish(QUIC_CONNECTION *qc);
21 static int ensure_channel(QUIC_CONNECTION *qc);
24 * QUIC Front-End I/O API: Common Utilities
25 * ========================================
29 * Block until a predicate is met.
31 * Precondition: Must have a channel.
32 * Precondition: Must hold channel lock (unchecked).
35 static int block_until_pred(QUIC_CONNECTION *qc,
36 int (*pred)(void *arg), void *pred_arg,
41 assert(qc->ch != NULL);
43 rtor = ossl_quic_channel_get_reactor(qc->ch);
44 return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags,
49 * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
50 * rather than via ERR.
52 static int quic_raise_normal_error(QUIC_CONNECTION *qc,
60 * Raise a 'non-normal' error, meaning any error that is not reported via
61 * SSL_get_error() and must be reported via ERR.
63 static int quic_raise_non_normal_error(QUIC_CONNECTION *qc,
74 ERR_set_debug(file, line, func);
77 ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
80 qc->last_error = SSL_ERROR_SSL;
84 #define QUIC_RAISE_NORMAL_ERROR(qc, err) \
85 quic_raise_normal_error((qc), (err))
87 #define QUIC_RAISE_NON_NORMAL_ERROR(qc, reason, msg) \
88 quic_raise_non_normal_error((qc), \
89 OPENSSL_FILE, OPENSSL_LINE, \
95 * Should be called at entry of every public function to confirm we have a valid
98 static ossl_inline int expect_quic_conn(const QUIC_CONNECTION *qc)
100 if (!ossl_assert(qc != NULL))
101 return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
108 * Ensures that the channel mutex is held for a method which touches channel
111 * Precondition: Channel mutex is not held (unchecked)
113 static void quic_lock(QUIC_CONNECTION *qc)
115 ossl_crypto_mutex_lock(qc->mutex);
118 /* Precondition: Channel mutex is held (unchecked) */
120 static void quic_unlock(QUIC_CONNECTION *qc)
122 ossl_crypto_mutex_unlock(qc->mutex);
127 * QUIC Front-End I/O API: Initialization
128 * ======================================
130 * SSL_new => ossl_quic_new
132 * SSL_reset => ossl_quic_reset
133 * SSL_clear => ossl_quic_clear
135 * SSL_free => ossl_quic_free
140 SSL *ossl_quic_new(SSL_CTX *ctx)
142 QUIC_CONNECTION *qc = NULL;
143 SSL *ssl_base = NULL;
144 SSL_CONNECTION *sc = NULL;
146 qc = OPENSSL_zalloc(sizeof(*qc));
150 /* Initialise the QUIC_CONNECTION's stub header. */
152 if (!ossl_ssl_init(ssl_base, ctx, ctx->method, SSL_TYPE_QUIC_CONNECTION)) {
157 qc->tls = ossl_ssl_connection_new_int(ctx, TLS_method());
158 if (qc->tls == NULL || (sc = SSL_CONNECTION_FROM_SSL(qc->tls)) == NULL)
161 if ((qc->mutex = ossl_crypto_mutex_new()) == NULL)
164 qc->is_thread_assisted
165 = (ssl_base->method == OSSL_QUIC_client_thread_method());
167 /* Channel is not created yet. */
168 qc->ssl_mode = qc->ssl.ctx->mode;
169 qc->last_error = SSL_ERROR_NONE;
182 void ossl_quic_free(SSL *s)
184 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
186 /* We should never be called on anything but a QUIC_CONNECTION. */
187 if (!expect_quic_conn(qc))
192 if (qc->is_thread_assisted && qc->started) {
193 ossl_quic_thread_assist_wait_stopped(&qc->thread_assist);
194 ossl_quic_thread_assist_cleanup(&qc->thread_assist);
197 ossl_quic_channel_free(qc->ch);
199 BIO_free(qc->net_rbio);
200 BIO_free(qc->net_wbio);
202 /* Note: SSL_free calls OPENSSL_free(qc) for us */
205 ossl_crypto_mutex_free(&qc->mutex);
208 /* SSL method init */
209 int ossl_quic_init(SSL *s)
211 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
213 if (!expect_quic_conn(qc))
216 /* Same op as SSL_clear, forward the call. */
217 return ossl_quic_clear(s);
220 /* SSL method deinit */
221 void ossl_quic_deinit(SSL *s)
227 int ossl_quic_reset(SSL *s)
229 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
231 if (!expect_quic_conn(qc))
234 /* TODO(QUIC); Currently a no-op. */
239 int ossl_quic_clear(SSL *s)
241 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
243 if (!expect_quic_conn(qc))
246 /* TODO(QUIC): Currently a no-op. */
250 void ossl_quic_conn_set_override_now_cb(SSL *s,
251 OSSL_TIME (*now_cb)(void *arg),
254 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
256 qc->override_now_cb = now_cb;
257 qc->override_now_cb_arg = now_cb_arg;
260 void ossl_quic_conn_force_assist_thread_wake(SSL *s)
262 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
264 if (qc->is_thread_assisted && qc->started)
265 ossl_quic_thread_assist_notify_deadline_changed(&qc->thread_assist);
269 * QUIC Front-End I/O API: Network BIO Configuration
270 * =================================================
272 * Handling the different BIOs is difficult:
274 * - It is more or less a requirement that we use non-blocking network I/O;
275 * we need to be able to have timeouts on recv() calls, and make best effort
276 * (non blocking) send() and recv() calls.
278 * The only sensible way to do this is to configure the socket into
279 * non-blocking mode. We could try to do select() before calling send() or
280 * recv() to get a guarantee that the call will not block, but this will
281 * probably run into issues with buggy OSes which generate spurious socket
282 * readiness events. In any case, relying on this to work reliably does not
285 * Timeouts could be handled via setsockopt() socket timeout options, but
286 * this depends on OS support and adds another syscall to every network I/O
287 * operation. It also has obvious thread safety concerns if we want to move
288 * to concurrent use of a single socket at some later date.
290 * Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
291 * be made non-blocking. However some OSes (e.g. Windows) do not support
292 * this, so we cannot rely on this.
294 * As such, we need to configure any FD in non-blocking mode. This may
295 * confound users who pass a blocking socket to libssl. However, in practice
296 * it would be extremely strange for a user of QUIC to pass an FD to us,
297 * then also try and send receive traffic on the same socket(!). Thus the
298 * impact of this should be limited, and can be documented.
300 * - We support both blocking and non-blocking operation in terms of the API
301 * presented to the user. One prospect is to set the blocking mode based on
302 * whether the socket passed to us was already in blocking mode. However,
303 * Windows has no API for determining if a socket is in blocking mode (!),
304 * therefore this cannot be done portably. Currently therefore we expose an
305 * explicit API call to set this, and default to blocking mode.
307 * - We need to determine our initial destination UDP address. The "natural"
308 * way for a user to do this is to set the peer variable on a BIO_dgram.
309 * However, this has problems because BIO_dgram's peer variable is used for
310 * both transmission and reception. This means it can be constantly being
311 * changed to a malicious value (e.g. if some random unrelated entity on the
312 * network starts sending traffic to us) on every read call. This is not a
313 * direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
314 * calls only, which do not use this variable. However, we do need to let
315 * the user specify the peer in a 'normal' manner. The compromise here is
316 * that we grab the current peer value set at the time the write BIO is set
317 * and do not read the value again.
319 * - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
320 * Currently we do this by only supporting non-blocking mode.
325 * Determines what initial destination UDP address we should use, if possible.
326 * If this fails the client must set the destination address manually, or use a
327 * BIO which does not need a destination address.
329 static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
331 if (BIO_dgram_get_peer(net_wbio, peer) <= 0)
337 void ossl_quic_conn_set0_net_rbio(QUIC_CONNECTION *qc, BIO *net_rbio)
339 if (qc->net_rbio == net_rbio)
342 if (qc->ch != NULL && !ossl_quic_channel_set_net_rbio(qc->ch, net_rbio))
345 BIO_free(qc->net_rbio);
346 qc->net_rbio = net_rbio;
349 * If what we have is not pollable (e.g. a BIO_dgram_pair) disable blocking
350 * mode as we do not support it for non-pollable BIOs.
352 if (net_rbio != NULL) {
353 BIO_POLL_DESCRIPTOR d = {0};
355 if (!BIO_get_rpoll_descriptor(net_rbio, &d)
356 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
358 qc->can_poll_net_rbio = 0;
360 qc->can_poll_net_rbio = 1;
365 void ossl_quic_conn_set0_net_wbio(QUIC_CONNECTION *qc, BIO *net_wbio)
367 if (qc->net_wbio == net_wbio)
370 if (qc->ch != NULL && !ossl_quic_channel_set_net_wbio(qc->ch, net_wbio))
373 BIO_free(qc->net_wbio);
374 qc->net_wbio = net_wbio;
376 if (net_wbio != NULL) {
377 BIO_POLL_DESCRIPTOR d = {0};
379 if (!BIO_get_wpoll_descriptor(net_wbio, &d)
380 || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
382 qc->can_poll_net_wbio = 0;
384 qc->can_poll_net_wbio = 1;
388 * If we do not have a peer address yet, and we have not started trying
389 * to connect yet, try to autodetect one.
391 if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC
393 if (!csm_analyse_init_peer_addr(net_wbio, &qc->init_peer_addr))
395 BIO_ADDR_clear(&qc->init_peer_addr);
398 ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr);
403 BIO *ossl_quic_conn_get_net_rbio(const QUIC_CONNECTION *qc)
408 BIO *ossl_quic_conn_get_net_wbio(const QUIC_CONNECTION *qc)
413 int ossl_quic_conn_get_blocking_mode(const QUIC_CONNECTION *qc)
418 int ossl_quic_conn_set_blocking_mode(QUIC_CONNECTION *qc, int blocking)
420 /* Cannot enable blocking mode if we do not have pollable FDs. */
422 (!qc->can_poll_net_rbio || !qc->can_poll_net_wbio))
423 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_UNSUPPORTED, NULL);
425 qc->blocking = (blocking != 0);
429 int ossl_quic_conn_set_initial_peer_addr(QUIC_CONNECTION *qc,
430 const BIO_ADDR *peer_addr)
433 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
436 if (peer_addr == NULL) {
437 BIO_ADDR_clear(&qc->init_peer_addr);
441 qc->init_peer_addr = *peer_addr;
446 * QUIC Front-End I/O API: Asynchronous I/O Management
447 * ===================================================
449 * (BIO/)SSL_tick => ossl_quic_tick
450 * (BIO/)SSL_get_tick_timeout => ossl_quic_get_tick_timeout
451 * (BIO/)SSL_get_poll_fd => ossl_quic_get_poll_fd
455 /* Returns 1 if the connection is being used in blocking mode. */
456 static int blocking_mode(const QUIC_CONNECTION *qc)
461 /* SSL_tick; ticks the reactor. */
463 int ossl_quic_tick(QUIC_CONNECTION *qc)
467 if (qc->ch == NULL) {
472 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
478 * SSL_get_tick_timeout. Get the time in milliseconds until the SSL object
479 * should be ticked by the application by calling SSL_tick(). tv is set to 0 if
480 * the object should be ticked immediately and tv->tv_sec is set to -1 if no
481 * timeout is currently active.
484 int ossl_quic_get_tick_timeout(QUIC_CONNECTION *qc, struct timeval *tv)
486 OSSL_TIME deadline = ossl_time_infinite();
492 = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(qc->ch));
494 if (ossl_time_is_infinite(deadline)) {
501 *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, ossl_time_now()));
506 /* SSL_get_rpoll_descriptor */
507 int ossl_quic_get_rpoll_descriptor(QUIC_CONNECTION *qc, BIO_POLL_DESCRIPTOR *desc)
509 if (desc == NULL || qc->net_rbio == NULL)
512 return BIO_get_rpoll_descriptor(qc->net_rbio, desc);
515 /* SSL_get_wpoll_descriptor */
516 int ossl_quic_get_wpoll_descriptor(QUIC_CONNECTION *qc, BIO_POLL_DESCRIPTOR *desc)
518 if (desc == NULL || qc->net_wbio == NULL)
521 return BIO_get_wpoll_descriptor(qc->net_wbio, desc);
524 /* SSL_net_read_desired */
526 int ossl_quic_get_net_read_desired(QUIC_CONNECTION *qc)
535 ret = ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(qc->ch));
540 /* SSL_net_write_desired */
542 int ossl_quic_get_net_write_desired(QUIC_CONNECTION *qc)
551 ret = ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(qc->ch));
557 * QUIC Front-End I/O API: Connection Lifecycle Operations
558 * =======================================================
560 * SSL_do_handshake => ossl_quic_do_handshake
561 * SSL_set_connect_state => ossl_quic_set_connect_state
562 * SSL_set_accept_state => ossl_quic_set_accept_state
563 * SSL_shutdown => ossl_quic_shutdown
564 * SSL_ctrl => ossl_quic_ctrl
565 * (BIO/)SSL_connect => ossl_quic_connect
566 * (BIO/)SSL_accept => ossl_quic_accept
571 static int quic_shutdown_wait(void *arg)
573 QUIC_CONNECTION *qc = arg;
575 return qc->ch == NULL || ossl_quic_channel_is_terminated(qc->ch);
579 int ossl_quic_conn_shutdown(QUIC_CONNECTION *qc, uint64_t flags,
580 const SSL_SHUTDOWN_EX_ARGS *args,
587 if (!ensure_channel(qc)) {
592 ossl_quic_channel_local_close(qc->ch,
593 args != NULL ? args->quic_error_code : 0);
595 /* TODO(QUIC): !SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH */
597 if (ossl_quic_channel_is_terminated(qc->ch)) {
602 if (blocking_mode(qc) && (flags & SSL_SHUTDOWN_FLAG_RAPID) == 0)
603 block_until_pred(qc, quic_shutdown_wait, qc, 0);
605 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
607 ret = ossl_quic_channel_is_terminated(qc->ch);
613 long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
615 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
617 if (!expect_quic_conn(qc))
622 /* Cannot enable EPW while AON write in progress. */
623 if (qc->aon_write_in_progress)
624 larg &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
626 qc->ssl_mode |= (uint32_t)larg;
628 case SSL_CTRL_CLEAR_MODE:
629 qc->ssl_mode &= ~(uint32_t)larg;
632 /* Probably a TLS related ctrl. Defer to our internal SSL object */
633 return SSL_ctrl(qc->tls, cmd, larg, parg);
637 /* SSL_set_connect_state */
638 void ossl_quic_set_connect_state(QUIC_CONNECTION *qc)
640 /* Cannot be changed after handshake started */
647 /* SSL_set_accept_state */
648 void ossl_quic_set_accept_state(QUIC_CONNECTION *qc)
650 /* Cannot be changed after handshake started */
657 /* SSL_do_handshake */
658 struct quic_handshake_wait_args {
662 static int quic_handshake_wait(void *arg)
664 struct quic_handshake_wait_args *args = arg;
666 if (!ossl_quic_channel_is_active(args->qc->ch))
669 if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
675 static int configure_channel(QUIC_CONNECTION *qc)
677 assert(qc->ch != NULL);
679 if (!ossl_quic_channel_set_net_rbio(qc->ch, qc->net_rbio)
680 || !ossl_quic_channel_set_net_wbio(qc->ch, qc->net_wbio)
681 || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
688 static int ensure_channel(QUIC_CONNECTION *qc)
690 QUIC_CHANNEL_ARGS args = {0};
695 args.libctx = qc->ssl.ctx->libctx;
696 args.propq = qc->ssl.ctx->propq;
699 args.mutex = qc->mutex;
700 args.now_cb = qc->override_now_cb;
701 args.now_cb_arg = qc->override_now_cb_arg;
703 qc->ch = ossl_quic_channel_new(&args);
711 * Creates a channel and configures it with the information we have accumulated
712 * via calls made to us from the application prior to starting a handshake
716 static int ensure_channel_and_start(QUIC_CONNECTION *qc)
719 if (!ensure_channel(qc))
722 if (!configure_channel(qc)
723 || !ossl_quic_channel_start(qc->ch))
726 qc->stream0 = ossl_quic_channel_get_stream_by_id(qc->ch, 0);
727 if (qc->stream0 == NULL)
730 if (qc->is_thread_assisted)
731 if (!ossl_quic_thread_assist_init_start(&qc->thread_assist, qc->ch))
739 ossl_quic_channel_free(qc->ch);
745 static int quic_do_handshake(QUIC_CONNECTION *qc)
749 if (qc->ch != NULL && ossl_quic_channel_is_handshake_complete(qc->ch))
750 /* Handshake already completed. */
753 if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch))
754 return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
756 if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC) {
757 /* Peer address must have been set. */
758 QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET, NULL);
759 return -1; /* Non-protocol error */
763 /* TODO(QUIC): Server mode not currently supported */
764 QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
765 return -1; /* Non-protocol error */
768 if (qc->net_rbio == NULL || qc->net_wbio == NULL) {
769 /* Need read and write BIOs. */
770 QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_BIO_NOT_SET, NULL);
771 return -1; /* Non-protocol error */
775 * Start connection process. Note we may come here multiple times in
776 * non-blocking mode, which is fine.
778 if (!ensure_channel_and_start(qc)) {
779 QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
780 return -1; /* Non-protocol error */
783 if (ossl_quic_channel_is_handshake_complete(qc->ch))
784 /* The handshake is now done. */
787 if (blocking_mode(qc)) {
788 /* In blocking mode, wait for the handshake to complete. */
789 struct quic_handshake_wait_args args;
793 ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
794 if (!ossl_quic_channel_is_active(qc->ch)) {
795 QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
796 return 0; /* Shutdown before completion */
797 } else if (ret <= 0) {
798 QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
799 return -1; /* Non-protocol error */
802 assert(ossl_quic_channel_is_handshake_complete(qc->ch));
805 /* Try to advance the reactor. */
806 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
808 if (ossl_quic_channel_is_handshake_complete(qc->ch))
809 /* The handshake is now done. */
812 /* Otherwise, indicate that the handshake isn't done yet. */
813 QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_READ);
814 return -1; /* Non-protocol error */
819 int ossl_quic_do_handshake(QUIC_CONNECTION *qc)
825 ret = quic_do_handshake(qc);
831 int ossl_quic_connect(SSL *s)
833 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
835 if (!expect_quic_conn(qc))
838 /* Ensure we are in connect state (no-op if non-idle). */
839 ossl_quic_set_connect_state(qc);
841 /* Begin or continue the handshake */
842 return ossl_quic_do_handshake(qc);
846 int ossl_quic_accept(SSL *s)
848 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
850 if (!expect_quic_conn(qc))
853 /* Ensure we are in accept state (no-op if non-idle). */
854 ossl_quic_set_accept_state(qc);
856 /* Begin or continue the handshake */
857 return ossl_quic_do_handshake(qc);
861 * QUIC Front-End I/O API: Steady-State Operations
862 * ===============================================
864 * Here we dispatch calls to the steady-state front-end I/O API functions; that
865 * is, the functions used during the established phase of a QUIC connection
866 * (e.g. SSL_read, SSL_write).
868 * Each function must handle both blocking and non-blocking modes. As discussed
869 * above, all QUIC I/O is implemented using non-blocking mode internally.
871 * SSL_get_error => partially implemented by ossl_quic_get_error
872 * (BIO/)SSL_read => ossl_quic_read
873 * (BIO/)SSL_write => ossl_quic_write
874 * SSL_pending => ossl_quic_pending
875 * SSL_stream_conclude => ossl_quic_conn_stream_conclude
879 int ossl_quic_get_error(const QUIC_CONNECTION *qc, int i)
881 return qc->last_error;
888 * The set of functions below provide the implementation of the public SSL_write
889 * function. We must handle:
891 * - both blocking and non-blocking operation at the application level,
892 * depending on how we are configured;
894 * - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
896 * - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
900 static void quic_post_write(QUIC_CONNECTION *qc, int did_append, int do_tick)
903 * We have appended at least one byte to the stream.
904 * Potentially mark stream as active, depending on FC.
907 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
913 * TODO(QUIC): It is probably inefficient to try and do this immediately,
914 * plus we should eventually consider Nagle's algorithm.
917 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
920 struct quic_write_again_args {
922 const unsigned char *buf;
924 size_t total_written;
928 static int quic_write_again(void *arg)
930 struct quic_write_again_args *args = arg;
931 size_t actual_written = 0;
933 if (!ossl_quic_channel_is_active(args->qc->ch))
934 /* If connection is torn down due to an error while blocking, stop. */
937 if (!ossl_quic_sstream_append(args->qc->stream0->sstream,
938 args->buf, args->len, &actual_written))
941 quic_post_write(args->qc, actual_written > 0, 0);
943 args->buf += actual_written;
944 args->len -= actual_written;
945 args->total_written += actual_written;
948 /* Written everything, done. */
951 /* Not written everything yet, keep trying. */
956 static int quic_write_blocking(QUIC_CONNECTION *qc, const void *buf, size_t len,
960 struct quic_write_again_args args;
961 size_t actual_written = 0;
963 /* First make a best effort to append as much of the data as possible. */
964 if (!ossl_quic_sstream_append(qc->stream0->sstream, buf, len,
966 /* Stream already finished or allocation error. */
968 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
971 quic_post_write(qc, actual_written > 0, 1);
973 if (actual_written == len) {
974 /* Managed to append everything on the first try. */
975 *written = actual_written;
980 * We did not manage to append all of the data immediately, so the stream
981 * buffer has probably filled up. This means we need to block until some of
985 args.buf = (const unsigned char *)buf + actual_written;
986 args.len = len - actual_written;
987 args.total_written = 0;
989 res = block_until_pred(qc, quic_write_again, &args, 0);
991 if (!ossl_quic_channel_is_active(qc->ch))
992 return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
994 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
997 *written = args.total_written;
1002 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
1005 static void aon_write_begin(QUIC_CONNECTION *qc, const unsigned char *buf,
1006 size_t buf_len, size_t already_sent)
1008 assert(!qc->aon_write_in_progress);
1010 qc->aon_write_in_progress = 1;
1011 qc->aon_buf_base = buf;
1012 qc->aon_buf_pos = already_sent;
1013 qc->aon_buf_len = buf_len;
1016 static void aon_write_finish(QUIC_CONNECTION *qc)
1018 qc->aon_write_in_progress = 0;
1019 qc->aon_buf_base = NULL;
1020 qc->aon_buf_pos = 0;
1021 qc->aon_buf_len = 0;
1025 static int quic_write_nonblocking_aon(QUIC_CONNECTION *qc, const void *buf,
1026 size_t len, size_t *written)
1028 const void *actual_buf;
1029 size_t actual_len, actual_written = 0;
1030 int accept_moving_buffer
1031 = ((qc->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
1033 if (qc->aon_write_in_progress) {
1035 * We are in the middle of an AON write (i.e., a previous write did not
1036 * manage to append all data to the SSTREAM and we have Enable Partial
1037 * Write (EPW) mode disabled.)
1039 if ((!accept_moving_buffer && qc->aon_buf_base != buf)
1040 || len != qc->aon_buf_len)
1042 * Pointer must not have changed if we are not in accept moving
1043 * buffer mode. Length must never change.
1045 return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_BAD_WRITE_RETRY, NULL);
1047 actual_buf = (unsigned char *)buf + qc->aon_buf_pos;
1048 actual_len = len - qc->aon_buf_pos;
1049 assert(actual_len > 0);
1055 /* First make a best effort to append as much of the data as possible. */
1056 if (!ossl_quic_sstream_append(qc->stream0->sstream, actual_buf, actual_len,
1058 /* Stream already finished or allocation error. */
1060 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1063 quic_post_write(qc, actual_written > 0, 1);
1065 if (actual_written == actual_len) {
1066 /* We have sent everything. */
1067 if (qc->aon_write_in_progress) {
1069 * We have sent everything, and we were in the middle of an AON
1070 * write. The output write length is the total length of the AON
1071 * buffer, not however many bytes we managed to write to the stream
1074 *written = qc->aon_buf_len;
1075 aon_write_finish(qc);
1077 *written = actual_written;
1083 if (qc->aon_write_in_progress) {
1085 * AON write is in progress but we have not written everything yet. We
1086 * may have managed to send zero bytes, or some number of bytes less
1087 * than the total remaining which need to be appended during this
1090 qc->aon_buf_pos += actual_written;
1091 assert(qc->aon_buf_pos < qc->aon_buf_len);
1092 return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_WRITE);
1096 * Not in an existing AON operation but partial write is not enabled, so we
1097 * need to begin a new AON operation. However we needn't bother if we didn't
1098 * actually append anything.
1100 if (actual_written > 0)
1101 aon_write_begin(qc, buf, len, actual_written);
1104 * AON - We do not publicly admit to having appended anything until AON
1108 return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_WRITE);
1112 static int quic_write_nonblocking_epw(QUIC_CONNECTION *qc, const void *buf, size_t len,
1115 /* Simple best effort operation. */
1116 if (!ossl_quic_sstream_append(qc->stream0->sstream, buf, len, written)) {
1117 /* Stream already finished or allocation error. */
1119 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1122 quic_post_write(qc, *written > 0, 1);
1127 int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
1130 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
1131 int partial_write = ((qc->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0);
1135 if (!expect_quic_conn(qc))
1140 if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch)) {
1141 ret = QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1146 * If we haven't finished the handshake, try to advance it.
1147 * We don't accept writes until the handshake is completed.
1149 if (quic_do_handshake(qc) < 1) {
1154 if (qc->stream0 == NULL || qc->stream0->sstream == NULL) {
1155 ret = QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1159 if (blocking_mode(qc))
1160 ret = quic_write_blocking(qc, buf, len, written);
1161 else if (partial_write)
1162 ret = quic_write_nonblocking_epw(qc, buf, len, written);
1164 ret = quic_write_nonblocking_aon(qc, buf, len, written);
1175 struct quic_read_again_args {
1176 QUIC_CONNECTION *qc;
1177 QUIC_STREAM *stream;
1185 static int quic_read_actual(QUIC_CONNECTION *qc,
1186 QUIC_STREAM *stream,
1187 void *buf, size_t buf_len,
1193 /* If the receive part of the stream is over, issue EOF. */
1194 if (stream->recv_fin_retired)
1195 return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_ZERO_RETURN);
1197 if (stream->rstream == NULL)
1198 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1201 if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
1202 bytes_read, &is_fin))
1203 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1206 if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
1207 bytes_read, &is_fin))
1208 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1212 if (*bytes_read > 0) {
1214 * We have read at least one byte from the stream. Inform stream-level
1215 * RXFC of the retirement of controlled bytes. Update the active stream
1216 * status (the RXFC may now want to emit a frame granting more credit to
1219 OSSL_RTT_INFO rtt_info;
1221 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
1223 if (!ossl_quic_rxfc_on_retire(&qc->stream0->rxfc, *bytes_read,
1224 rtt_info.smoothed_rtt))
1225 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1229 stream->recv_fin_retired = 1;
1231 if (*bytes_read > 0)
1232 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
1240 static int quic_read_again(void *arg)
1242 struct quic_read_again_args *args = arg;
1244 if (!ossl_quic_channel_is_active(args->qc->ch)) {
1245 /* If connection is torn down due to an error while blocking, stop. */
1246 QUIC_RAISE_NON_NORMAL_ERROR(args->qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1250 if (!quic_read_actual(args->qc, args->stream,
1251 args->buf, args->len, args->bytes_read,
1255 if (*args->bytes_read > 0)
1256 /* got at least one byte, the SSL_read op can finish now */
1259 return 0; /* did not read anything, keep trying */
1263 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
1266 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
1267 struct quic_read_again_args args;
1271 if (!expect_quic_conn(qc))
1276 if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch)) {
1277 ret = QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1281 /* If we haven't finished the handshake, try to advance it. */
1282 if (quic_do_handshake(qc) < 1) {
1283 ret = 0; /* ossl_quic_do_handshake raised error here */
1287 if (qc->stream0 == NULL) {
1288 ret = QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1292 if (!quic_read_actual(qc, qc->stream0, buf, len, bytes_read, peek)) {
1293 ret = 0; /* quic_read_actual raised error here */
1297 if (*bytes_read > 0) {
1299 * Even though we succeeded, tick the reactor here to ensure we are
1300 * handling other aspects of the QUIC connection.
1302 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch), 0);
1304 } else if (blocking_mode(qc)) {
1306 * We were not able to read anything immediately, so our stream
1307 * buffer is empty. This means we need to block until we get
1308 * at least one byte.
1311 args.stream = qc->stream0;
1314 args.bytes_read = bytes_read;
1317 res = block_until_pred(qc, quic_read_again, &args, 0);
1319 ret = QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1321 } else if (res < 0) {
1322 ret = 0; /* quic_read_again raised error here */
1328 /* We did not get any bytes and are not in blocking mode. */
1329 ret = QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_READ);
1337 int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
1339 return quic_read(s, buf, len, bytes_read, 0);
1342 int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
1344 return quic_read(s, buf, len, bytes_read, 1);
1352 static size_t ossl_quic_pending_int(const QUIC_CONNECTION *qc)
1357 if (!expect_quic_conn(qc))
1360 quic_lock((QUIC_CONNECTION *)qc);
1362 if (qc->stream0 == NULL || qc->stream0->rstream == NULL)
1363 /* Cannot raise errors here because we are const, just fail. */
1366 if (!ossl_quic_rstream_available(qc->stream0->rstream, &avail, &fin))
1370 quic_unlock((QUIC_CONNECTION *)qc);
1374 size_t ossl_quic_pending(const SSL *s)
1376 const QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_CONST_SSL(s);
1378 return ossl_quic_pending_int(qc);
1381 int ossl_quic_has_pending(const QUIC_CONNECTION *qc)
1383 return ossl_quic_pending_int(qc) > 0;
1387 * SSL_stream_conclude
1388 * -------------------
1391 int ossl_quic_conn_stream_conclude(QUIC_CONNECTION *qc)
1393 QUIC_STREAM *qs = qc->stream0;
1397 if (qs == NULL || qs->sstream == NULL) {
1402 if (!ossl_quic_channel_is_active(qc->ch)
1403 || ossl_quic_sstream_get_final_size(qs->sstream, NULL)) {
1408 ossl_quic_sstream_fin(qs->sstream);
1409 quic_post_write(qc, 1, 1);
1415 * SSL_inject_net_dgram
1416 * --------------------
1418 int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
1420 const BIO_ADDR *peer,
1421 const BIO_ADDR *local)
1423 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
1426 if (!expect_quic_conn(qc))
1430 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
1433 demux = ossl_quic_channel_get0_demux(qc->ch);
1434 return ossl_quic_demux_inject(demux, buf, buf_len, peer, local);
1438 * QUIC Front-End I/O API: SSL_CTX Management
1439 * ==========================================
1442 long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1446 return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
1450 long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1452 return ssl3_callback_ctrl(s, cmd, fp);
1455 long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1457 return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
1460 int ossl_quic_renegotiate_check(SSL *ssl, int initok)
1462 /* We never do renegotiation. */
1467 * These functions define the TLSv1.2 (and below) ciphers that are supported by
1468 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
1471 int ossl_quic_num_ciphers(void)
1476 const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)