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 ossl_quic_channel_set_msg_callback(qc
->ch
, ctx
->msg_callback
, ssl_base
);
334 ossl_quic_channel_set_msg_callback_arg(qc
->ch
, ctx
->msg_callback_arg
);
336 qc_update_reject_policy(qc
);
339 * We do not create the default XSO yet. The reason for this is that the
340 * stream ID of the default XSO will depend on whether the stream is client
341 * or server-initiated, which depends on who transmits first. Since we do
342 * not know whether the application will be using a client-transmits-first
343 * or server-transmits-first protocol, we defer default XSO creation until
344 * the client calls SSL_read() or SSL_write(). If it calls SSL_read() first,
345 * we take that as a cue that the client is expecting a server-initiated
346 * stream, and vice versa if SSL_write() is called first.
352 #if defined(OPENSSL_THREADS)
353 ossl_crypto_mutex_free(qc
->mutex
);
355 ossl_quic_channel_free(qc
->ch
);
364 void ossl_quic_free(SSL
*s
)
369 /* We should never be called on anything but a QSO. */
370 if (!expect_quic(s
, &ctx
))
377 * When a QSSO is freed, the XSO is freed immediately, because the XSO
378 * itself only contains API personality layer data. However the
379 * underlying QUIC_STREAM is not freed immediately but is instead marked
380 * as deleted for later collection.
383 assert(ctx
.qc
->num_xso
> 0);
386 /* If a stream's send part has not been finished, auto-reset it. */
387 if (ctx
.xso
->stream
->sstream
!= NULL
388 && !ossl_quic_sstream_get_final_size(ctx
.xso
->stream
->sstream
, NULL
))
389 ossl_quic_stream_map_reset_stream_send_part(ossl_quic_channel_get_qsm(ctx
.qc
->ch
),
392 /* Do STOP_SENDING for the receive part, if applicable. */
393 if (ctx
.xso
->stream
->rstream
!= NULL
)
394 ossl_quic_stream_map_stop_sending_recv_part(ossl_quic_channel_get_qsm(ctx
.qc
->ch
),
397 /* Update stream state. */
398 ctx
.xso
->stream
->deleted
= 1;
399 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(ctx
.qc
->ch
),
402 is_default
= (ctx
.xso
== ctx
.qc
->default_xso
);
406 * Unref the connection in most cases; the XSO has a ref to the QC and
407 * not vice versa. But for a default XSO, to avoid circular references,
408 * the QC refs the XSO but the XSO does not ref the QC. If we are the
409 * default XSO, we only get here when the QC is being torn down anyway,
410 * so don't call SSL_free(qc) as we are already in it.
413 SSL_free(&ctx
.qc
->ssl
);
415 /* Note: SSL_free calls OPENSSL_free(xso) for us */
420 * Free the default XSO, if any. The QUIC_STREAM is not deleted at this
421 * stage, but is freed during the channel free when the whole QSM is freed.
423 if (ctx
.qc
->default_xso
!= NULL
) {
424 QUIC_XSO
*xso
= ctx
.qc
->default_xso
;
429 ctx
.qc
->default_xso
= NULL
;
432 /* Ensure we have no remaining XSOs. */
433 assert(ctx
.qc
->num_xso
== 0);
435 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
436 if (ctx
.qc
->is_thread_assisted
&& ctx
.qc
->started
) {
437 ossl_quic_thread_assist_wait_stopped(&ctx
.qc
->thread_assist
);
438 ossl_quic_thread_assist_cleanup(&ctx
.qc
->thread_assist
);
442 ossl_quic_channel_free(ctx
.qc
->ch
);
444 BIO_free(ctx
.qc
->net_rbio
);
445 BIO_free(ctx
.qc
->net_wbio
);
447 /* Note: SSL_free calls OPENSSL_free(qc) for us */
449 SSL_free(ctx
.qc
->tls
);
450 quic_unlock(ctx
.qc
); /* tsan doesn't like freeing locked mutexes */
451 #if defined(OPENSSL_THREADS)
452 ossl_crypto_mutex_free(&ctx
.qc
->mutex
);
456 /* SSL method init */
457 int ossl_quic_init(SSL
*s
)
459 /* Same op as SSL_clear, forward the call. */
460 return ossl_quic_clear(s
);
463 /* SSL method deinit */
464 void ossl_quic_deinit(SSL
*s
)
470 int ossl_quic_reset(SSL
*s
)
474 if (!expect_quic(s
, &ctx
))
477 /* TODO(QUIC); Currently a no-op. */
482 int ossl_quic_clear(SSL
*s
)
486 if (!expect_quic(s
, &ctx
))
489 /* TODO(QUIC): Currently a no-op. */
493 void ossl_quic_conn_set_override_now_cb(SSL
*s
,
494 OSSL_TIME (*now_cb
)(void *arg
),
499 if (!expect_quic(s
, &ctx
))
502 ctx
.qc
->override_now_cb
= now_cb
;
503 ctx
.qc
->override_now_cb_arg
= now_cb_arg
;
506 void ossl_quic_conn_force_assist_thread_wake(SSL
*s
)
510 if (!expect_quic(s
, &ctx
))
513 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
514 if (ctx
.qc
->is_thread_assisted
&& ctx
.qc
->started
)
515 ossl_quic_thread_assist_notify_deadline_changed(&ctx
.qc
->thread_assist
);
520 static void qc_touch_default_xso(QUIC_CONNECTION
*qc
)
522 qc
->default_xso_created
= 1;
523 qc_update_reject_policy(qc
);
527 * Changes default XSO. Allows caller to keep reference to the old default XSO
528 * (if any). Reference to new XSO is transferred from caller.
531 static void qc_set_default_xso_keep_ref(QUIC_CONNECTION
*qc
, QUIC_XSO
*xso
,
539 if (qc
->default_xso
!= xso
) {
540 *old_xso
= qc
->default_xso
; /* transfer old XSO ref to caller */
542 qc
->default_xso
= xso
;
546 * Changing to not having a default XSO. XSO becomes standalone and
547 * now has a ref to the QC.
549 if (!ossl_assert(SSL_up_ref(&qc
->ssl
)))
553 * Changing from not having a default XSO to having one. The new XSO
554 * will have had a reference to the QC we need to drop to avoid a
555 * circular reference.
557 * Currently we never change directly from one default XSO to
558 * another, though this function would also still be correct if this
561 assert(*old_xso
== NULL
);
563 CRYPTO_DOWN_REF(&qc
->ssl
.references
, &refs
, &qc
->ssl
.lock
);
569 qc_touch_default_xso(qc
);
573 * Changes default XSO, releasing the reference to any previous default XSO.
574 * Reference to new XSO is transferred from caller.
577 static void qc_set_default_xso(QUIC_CONNECTION
*qc
, QUIC_XSO
*xso
, int touch
)
579 QUIC_XSO
*old_xso
= NULL
;
581 qc_set_default_xso_keep_ref(qc
, xso
, touch
, &old_xso
);
584 SSL_free(&old_xso
->ssl
);
588 * QUIC Front-End I/O API: Network BIO Configuration
589 * =================================================
591 * Handling the different BIOs is difficult:
593 * - It is more or less a requirement that we use non-blocking network I/O;
594 * we need to be able to have timeouts on recv() calls, and make best effort
595 * (non blocking) send() and recv() calls.
597 * The only sensible way to do this is to configure the socket into
598 * non-blocking mode. We could try to do select() before calling send() or
599 * recv() to get a guarantee that the call will not block, but this will
600 * probably run into issues with buggy OSes which generate spurious socket
601 * readiness events. In any case, relying on this to work reliably does not
604 * Timeouts could be handled via setsockopt() socket timeout options, but
605 * this depends on OS support and adds another syscall to every network I/O
606 * operation. It also has obvious thread safety concerns if we want to move
607 * to concurrent use of a single socket at some later date.
609 * Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
610 * be made non-blocking. However some OSes (e.g. Windows) do not support
611 * this, so we cannot rely on this.
613 * As such, we need to configure any FD in non-blocking mode. This may
614 * confound users who pass a blocking socket to libssl. However, in practice
615 * it would be extremely strange for a user of QUIC to pass an FD to us,
616 * then also try and send receive traffic on the same socket(!). Thus the
617 * impact of this should be limited, and can be documented.
619 * - We support both blocking and non-blocking operation in terms of the API
620 * presented to the user. One prospect is to set the blocking mode based on
621 * whether the socket passed to us was already in blocking mode. However,
622 * Windows has no API for determining if a socket is in blocking mode (!),
623 * therefore this cannot be done portably. Currently therefore we expose an
624 * explicit API call to set this, and default to blocking mode.
626 * - We need to determine our initial destination UDP address. The "natural"
627 * way for a user to do this is to set the peer variable on a BIO_dgram.
628 * However, this has problems because BIO_dgram's peer variable is used for
629 * both transmission and reception. This means it can be constantly being
630 * changed to a malicious value (e.g. if some random unrelated entity on the
631 * network starts sending traffic to us) on every read call. This is not a
632 * direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
633 * calls only, which do not use this variable. However, we do need to let
634 * the user specify the peer in a 'normal' manner. The compromise here is
635 * that we grab the current peer value set at the time the write BIO is set
636 * and do not read the value again.
638 * - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
639 * Currently we do this by only supporting non-blocking mode.
644 * Determines what initial destination UDP address we should use, if possible.
645 * If this fails the client must set the destination address manually, or use a
646 * BIO which does not need a destination address.
648 static int csm_analyse_init_peer_addr(BIO
*net_wbio
, BIO_ADDR
*peer
)
650 if (BIO_dgram_get_peer(net_wbio
, peer
) <= 0)
656 void ossl_quic_conn_set0_net_rbio(SSL
*s
, BIO
*net_rbio
)
660 if (!expect_quic(s
, &ctx
))
663 if (ctx
.qc
->net_rbio
== net_rbio
)
666 if (!ossl_quic_channel_set_net_rbio(ctx
.qc
->ch
, net_rbio
))
669 BIO_free(ctx
.qc
->net_rbio
);
670 ctx
.qc
->net_rbio
= net_rbio
;
673 * If what we have is not pollable (e.g. a BIO_dgram_pair) disable blocking
674 * mode as we do not support it for non-pollable BIOs.
676 if (net_rbio
!= NULL
) {
677 BIO_POLL_DESCRIPTOR d
= {0};
679 if (!BIO_get_rpoll_descriptor(net_rbio
, &d
)
680 || d
.type
!= BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD
) {
681 ctx
.qc
->blocking
= 0;
682 ctx
.qc
->default_blocking
= 0;
683 ctx
.qc
->can_poll_net_rbio
= 0;
685 ctx
.qc
->can_poll_net_rbio
= 1;
690 void ossl_quic_conn_set0_net_wbio(SSL
*s
, BIO
*net_wbio
)
694 if (!expect_quic(s
, &ctx
))
697 if (ctx
.qc
->net_wbio
== net_wbio
)
700 if (!ossl_quic_channel_set_net_wbio(ctx
.qc
->ch
, net_wbio
))
703 BIO_free(ctx
.qc
->net_wbio
);
704 ctx
.qc
->net_wbio
= net_wbio
;
706 if (net_wbio
!= NULL
) {
707 BIO_POLL_DESCRIPTOR d
= {0};
709 if (!BIO_get_wpoll_descriptor(net_wbio
, &d
)
710 || d
.type
!= BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD
) {
711 ctx
.qc
->blocking
= 0;
712 ctx
.qc
->default_blocking
= 0;
713 ctx
.qc
->can_poll_net_wbio
= 0;
715 ctx
.qc
->can_poll_net_wbio
= 1;
719 * If we do not have a peer address yet, and we have not started trying
720 * to connect yet, try to autodetect one.
722 if (BIO_ADDR_family(&ctx
.qc
->init_peer_addr
) == AF_UNSPEC
723 && !ctx
.qc
->started
) {
724 if (!csm_analyse_init_peer_addr(net_wbio
, &ctx
.qc
->init_peer_addr
))
726 BIO_ADDR_clear(&ctx
.qc
->init_peer_addr
);
728 ossl_quic_channel_set_peer_addr(ctx
.qc
->ch
,
729 &ctx
.qc
->init_peer_addr
);
734 BIO
*ossl_quic_conn_get_net_rbio(const SSL
*s
)
738 if (!expect_quic(s
, &ctx
))
741 return ctx
.qc
->net_rbio
;
744 BIO
*ossl_quic_conn_get_net_wbio(const SSL
*s
)
748 if (!expect_quic(s
, &ctx
))
751 return ctx
.qc
->net_wbio
;
754 int ossl_quic_conn_get_blocking_mode(const SSL
*s
)
758 if (!expect_quic(s
, &ctx
))
762 return ctx
.xso
->blocking
;
764 return ctx
.qc
->blocking
;
767 int ossl_quic_conn_set_blocking_mode(SSL
*s
, int blocking
)
771 if (!expect_quic(s
, &ctx
))
774 /* Cannot enable blocking mode if we do not have pollable FDs. */
776 (!ctx
.qc
->can_poll_net_rbio
|| !ctx
.qc
->can_poll_net_wbio
))
777 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_UNSUPPORTED
, NULL
);
779 if (!ctx
.is_stream
) {
781 * If called on a QCSO, update default and connection-level blocking
784 ctx
.qc
->blocking
= (blocking
!= 0);
785 ctx
.qc
->default_blocking
= ctx
.qc
->blocking
;
790 * If called on a QSSO or QCSO with a default XSO, update blocking
793 ctx
.xso
->blocking
= (blocking
!= 0);
798 int ossl_quic_conn_set_initial_peer_addr(SSL
*s
,
799 const BIO_ADDR
*peer_addr
)
803 if (!expect_quic(s
, &ctx
))
807 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
,
810 if (peer_addr
== NULL
) {
811 BIO_ADDR_clear(&ctx
.qc
->init_peer_addr
);
815 ctx
.qc
->init_peer_addr
= *peer_addr
;
820 * QUIC Front-End I/O API: Asynchronous I/O Management
821 * ===================================================
823 * (BIO/)SSL_handle_events => ossl_quic_handle_events
824 * (BIO/)SSL_get_event_timeout => ossl_quic_get_event_timeout
825 * (BIO/)SSL_get_poll_fd => ossl_quic_get_poll_fd
829 /* Returns 1 if the connection is being used in blocking mode. */
830 static int qc_blocking_mode(const QUIC_CONNECTION
*qc
)
835 static int xso_blocking_mode(const QUIC_XSO
*xso
)
838 && xso
->conn
->can_poll_net_rbio
839 && xso
->conn
->can_poll_net_wbio
;
842 /* SSL_handle_events; handles events by ticking the reactor. */
844 int ossl_quic_handle_events(SSL
*s
)
848 if (!expect_quic(s
, &ctx
))
852 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx
.qc
->ch
), 0);
858 * SSL_get_event_timeout. Get the time in milliseconds until the SSL object
859 * should be ticked by the application by calling SSL_handle_events(). tv is set
860 * to 0 if the object should be ticked immediately. If no timeout is currently
861 * active, *is_infinite is set to 1 and the value of *tv is undefined.
864 int ossl_quic_get_event_timeout(SSL
*s
, struct timeval
*tv
, int *is_infinite
)
867 OSSL_TIME deadline
= ossl_time_infinite();
869 if (!expect_quic(s
, &ctx
))
875 = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(ctx
.qc
->ch
));
877 if (ossl_time_is_infinite(deadline
)) {
881 * Robustness against faulty applications that don't check *is_infinite;
882 * harmless long timeout.
884 tv
->tv_sec
= 1000000;
891 *tv
= ossl_time_to_timeval(ossl_time_subtract(deadline
, ossl_time_now()));
897 /* SSL_get_rpoll_descriptor */
898 int ossl_quic_get_rpoll_descriptor(SSL
*s
, BIO_POLL_DESCRIPTOR
*desc
)
902 if (!expect_quic(s
, &ctx
))
905 if (desc
== NULL
|| ctx
.qc
->net_rbio
== NULL
)
908 return BIO_get_rpoll_descriptor(ctx
.qc
->net_rbio
, desc
);
911 /* SSL_get_wpoll_descriptor */
912 int ossl_quic_get_wpoll_descriptor(SSL
*s
, BIO_POLL_DESCRIPTOR
*desc
)
916 if (!expect_quic(s
, &ctx
))
919 if (desc
== NULL
|| ctx
.qc
->net_wbio
== NULL
)
922 return BIO_get_wpoll_descriptor(ctx
.qc
->net_wbio
, desc
);
925 /* SSL_net_read_desired */
927 int ossl_quic_get_net_read_desired(SSL
*s
)
932 if (!expect_quic(s
, &ctx
))
936 ret
= ossl_quic_reactor_net_read_desired(ossl_quic_channel_get_reactor(ctx
.qc
->ch
));
941 /* SSL_net_write_desired */
943 int ossl_quic_get_net_write_desired(SSL
*s
)
948 if (!expect_quic(s
, &ctx
))
952 ret
= ossl_quic_reactor_net_write_desired(ossl_quic_channel_get_reactor(ctx
.qc
->ch
));
958 * QUIC Front-End I/O API: Connection Lifecycle Operations
959 * =======================================================
961 * SSL_do_handshake => ossl_quic_do_handshake
962 * SSL_set_connect_state => ossl_quic_set_connect_state
963 * SSL_set_accept_state => ossl_quic_set_accept_state
964 * SSL_shutdown => ossl_quic_shutdown
965 * SSL_ctrl => ossl_quic_ctrl
966 * (BIO/)SSL_connect => ossl_quic_connect
967 * (BIO/)SSL_accept => ossl_quic_accept
972 static int quic_shutdown_wait(void *arg
)
974 QUIC_CONNECTION
*qc
= arg
;
976 return ossl_quic_channel_is_terminated(qc
->ch
);
980 int ossl_quic_conn_shutdown(SSL
*s
, uint64_t flags
,
981 const SSL_SHUTDOWN_EX_ARGS
*args
,
987 if (!expect_quic(s
, &ctx
))
991 /* TODO(QUIC): Semantics currently undefined for QSSOs */
996 ossl_quic_channel_local_close(ctx
.qc
->ch
,
997 args
!= NULL
? args
->quic_error_code
: 0);
999 /* TODO(QUIC): !SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH */
1001 if (ossl_quic_channel_is_terminated(ctx
.qc
->ch
)) {
1002 quic_unlock(ctx
.qc
);
1006 if (qc_blocking_mode(ctx
.qc
) && (flags
& SSL_SHUTDOWN_FLAG_RAPID
) == 0)
1007 block_until_pred(ctx
.qc
, quic_shutdown_wait
, ctx
.qc
, 0);
1009 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx
.qc
->ch
), 0);
1011 ret
= ossl_quic_channel_is_terminated(ctx
.qc
->ch
);
1012 quic_unlock(ctx
.qc
);
1017 long ossl_quic_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
1021 if (!expect_quic(s
, &ctx
))
1026 /* If called on a QCSO, update the default mode. */
1028 ctx
.qc
->default_ssl_mode
|= (uint32_t)larg
;
1031 * If we were called on a QSSO or have a default stream, we also update
1034 if (ctx
.xso
!= NULL
) {
1035 /* Cannot enable EPW while AON write in progress. */
1036 if (ctx
.xso
->aon_write_in_progress
)
1037 larg
&= ~SSL_MODE_ENABLE_PARTIAL_WRITE
;
1039 ctx
.xso
->ssl_mode
|= (uint32_t)larg
;
1040 return ctx
.xso
->ssl_mode
;
1043 return ctx
.qc
->default_ssl_mode
;
1044 case SSL_CTRL_CLEAR_MODE
:
1046 ctx
.qc
->default_ssl_mode
&= ~(uint32_t)larg
;
1048 if (ctx
.xso
!= NULL
) {
1049 ctx
.xso
->ssl_mode
&= ~(uint32_t)larg
;
1050 return ctx
.xso
->ssl_mode
;
1053 return ctx
.qc
->default_ssl_mode
;
1055 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
1056 ossl_quic_channel_set_msg_callback_arg(ctx
.qc
->ch
, parg
);
1057 /* This ctrl also needs to be passed to the internal SSL object */
1058 return SSL_ctrl(ctx
.qc
->tls
, cmd
, larg
, parg
);
1061 /* Probably a TLS related ctrl. Defer to our internal SSL object */
1062 return SSL_ctrl(ctx
.qc
->tls
, cmd
, larg
, parg
);
1066 /* SSL_set_connect_state */
1067 void ossl_quic_set_connect_state(SSL
*s
)
1071 if (!expect_quic(s
, &ctx
))
1074 /* Cannot be changed after handshake started */
1075 if (ctx
.qc
->started
|| ctx
.is_stream
)
1078 ctx
.qc
->as_server_state
= 0;
1081 /* SSL_set_accept_state */
1082 void ossl_quic_set_accept_state(SSL
*s
)
1086 if (!expect_quic(s
, &ctx
))
1089 /* Cannot be changed after handshake started */
1090 if (ctx
.qc
->started
|| ctx
.is_stream
)
1093 ctx
.qc
->as_server_state
= 1;
1096 /* SSL_do_handshake */
1097 struct quic_handshake_wait_args
{
1098 QUIC_CONNECTION
*qc
;
1101 static int quic_handshake_wait(void *arg
)
1103 struct quic_handshake_wait_args
*args
= arg
;
1105 if (!ossl_quic_channel_is_active(args
->qc
->ch
))
1108 if (ossl_quic_channel_is_handshake_complete(args
->qc
->ch
))
1114 static int configure_channel(QUIC_CONNECTION
*qc
)
1116 assert(qc
->ch
!= NULL
);
1118 if (!ossl_quic_channel_set_net_rbio(qc
->ch
, qc
->net_rbio
)
1119 || !ossl_quic_channel_set_net_wbio(qc
->ch
, qc
->net_wbio
)
1120 || !ossl_quic_channel_set_peer_addr(qc
->ch
, &qc
->init_peer_addr
))
1127 static int create_channel(QUIC_CONNECTION
*qc
)
1129 QUIC_CHANNEL_ARGS args
= {0};
1131 args
.libctx
= qc
->ssl
.ctx
->libctx
;
1132 args
.propq
= qc
->ssl
.ctx
->propq
;
1133 args
.is_server
= qc
->as_server
;
1135 args
.mutex
= qc
->mutex
;
1136 args
.now_cb
= qc
->override_now_cb
;
1137 args
.now_cb_arg
= qc
->override_now_cb_arg
;
1139 qc
->ch
= ossl_quic_channel_new(&args
);
1147 * Creates a channel and configures it with the information we have accumulated
1148 * via calls made to us from the application prior to starting a handshake
1152 static int ensure_channel_started(QUIC_CONNECTION
*qc
)
1155 if (!configure_channel(qc
)
1156 || !ossl_quic_channel_start(qc
->ch
))
1159 #if !defined(OPENSSL_NO_QUIC_THREAD_ASSIST)
1160 if (qc
->is_thread_assisted
)
1161 if (!ossl_quic_thread_assist_init_start(&qc
->thread_assist
, qc
->ch
))
1170 ossl_quic_channel_free(qc
->ch
);
1176 static int quic_do_handshake(QCTX
*ctx
)
1179 QUIC_CONNECTION
*qc
= ctx
->qc
;
1181 if (ossl_quic_channel_is_handshake_complete(qc
->ch
))
1182 /* Handshake already completed. */
1185 if (ossl_quic_channel_is_term_any(qc
->ch
))
1186 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1188 if (BIO_ADDR_family(&qc
->init_peer_addr
) == AF_UNSPEC
) {
1189 /* Peer address must have been set. */
1190 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_REMOTE_PEER_ADDRESS_NOT_SET
, NULL
);
1191 return -1; /* Non-protocol error */
1194 if (qc
->as_server
!= qc
->as_server_state
) {
1195 /* TODO(QUIC): Must match the method used to create the QCSO */
1196 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_PASSED_INVALID_ARGUMENT
, NULL
);
1197 return -1; /* Non-protocol error */
1200 if (qc
->net_rbio
== NULL
|| qc
->net_wbio
== NULL
) {
1201 /* Need read and write BIOs. */
1202 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_BIO_NOT_SET
, NULL
);
1203 return -1; /* Non-protocol error */
1207 * Start connection process. Note we may come here multiple times in
1208 * non-blocking mode, which is fine.
1210 if (!ensure_channel_started(qc
)) {
1211 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1212 return -1; /* Non-protocol error */
1215 if (ossl_quic_channel_is_handshake_complete(qc
->ch
))
1216 /* The handshake is now done. */
1219 if (qc_blocking_mode(qc
)) {
1220 /* In blocking mode, wait for the handshake to complete. */
1221 struct quic_handshake_wait_args args
;
1225 ret
= block_until_pred(qc
, quic_handshake_wait
, &args
, 0);
1226 if (!ossl_quic_channel_is_active(qc
->ch
)) {
1227 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1228 return 0; /* Shutdown before completion */
1229 } else if (ret
<= 0) {
1230 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1231 return -1; /* Non-protocol error */
1234 assert(ossl_quic_channel_is_handshake_complete(qc
->ch
));
1237 /* Try to advance the reactor. */
1238 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc
->ch
), 0);
1240 if (ossl_quic_channel_is_handshake_complete(qc
->ch
))
1241 /* The handshake is now done. */
1244 /* Otherwise, indicate that the handshake isn't done yet. */
1245 QUIC_RAISE_NORMAL_ERROR(ctx
, SSL_ERROR_WANT_READ
);
1246 return -1; /* Non-protocol error */
1251 int ossl_quic_do_handshake(SSL
*s
)
1256 if (!expect_quic(s
, &ctx
))
1261 ret
= quic_do_handshake(&ctx
);
1262 quic_unlock(ctx
.qc
);
1267 int ossl_quic_connect(SSL
*s
)
1269 /* Ensure we are in connect state (no-op if non-idle). */
1270 ossl_quic_set_connect_state(s
);
1272 /* Begin or continue the handshake */
1273 return ossl_quic_do_handshake(s
);
1277 int ossl_quic_accept(SSL
*s
)
1279 /* Ensure we are in accept state (no-op if non-idle). */
1280 ossl_quic_set_accept_state(s
);
1282 /* Begin or continue the handshake */
1283 return ossl_quic_do_handshake(s
);
1287 * QUIC Front-End I/O API: Stream Lifecycle Operations
1288 * ===================================================
1290 * SSL_stream_new => ossl_quic_conn_stream_new
1295 * Try to create the default XSO if it doesn't already exist. Returns 1 if the
1296 * default XSO was created. Returns 0 if it was not (e.g. because it already
1297 * exists). Note that this is NOT an error condition.
1300 static int qc_try_create_default_xso_for_write(QCTX
*ctx
)
1303 QUIC_CONNECTION
*qc
= ctx
->qc
;
1305 if (qc
->default_xso_created
1306 || qc
->default_stream_mode
== SSL_DEFAULT_STREAM_MODE_NONE
)
1308 * We only do this once. If the user detaches a previously created
1309 * default XSO we don't auto-create another one.
1311 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_NO_STREAM
, NULL
);
1313 /* Create a locally-initiated stream. */
1314 if (qc
->default_stream_mode
== SSL_DEFAULT_STREAM_MODE_AUTO_UNI
)
1315 flags
|= SSL_STREAM_FLAG_UNI
;
1317 qc_set_default_xso(qc
, (QUIC_XSO
*)quic_conn_stream_new(ctx
, flags
,
1320 if (qc
->default_xso
== NULL
)
1321 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1323 qc_touch_default_xso(qc
);
1327 struct quic_wait_for_stream_args
{
1328 QUIC_CONNECTION
*qc
;
1335 static int quic_wait_for_stream(void *arg
)
1337 struct quic_wait_for_stream_args
*args
= arg
;
1339 if (!ossl_quic_channel_is_active(args
->qc
->ch
)) {
1340 /* If connection is torn down due to an error while blocking, stop. */
1341 QUIC_RAISE_NON_NORMAL_ERROR(args
->ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1345 args
->qs
= ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args
->qc
->ch
),
1346 args
->expect_id
| QUIC_STREAM_DIR_BIDI
);
1347 if (args
->qs
== NULL
)
1348 args
->qs
= ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(args
->qc
->ch
),
1349 args
->expect_id
| QUIC_STREAM_DIR_UNI
);
1351 if (args
->qs
!= NULL
)
1352 return 1; /* stream now exists */
1354 return 0; /* did not get a stream, keep trying */
1358 static int qc_wait_for_default_xso_for_read(QCTX
*ctx
)
1360 /* Called on a QCSO and we don't currently have a default stream. */
1362 QUIC_CONNECTION
*qc
= ctx
->qc
;
1365 struct quic_wait_for_stream_args wargs
;
1368 * If default stream functionality is disabled or we already detached
1369 * one, don't make another default stream and just fail.
1371 if (qc
->default_xso_created
1372 || qc
->default_stream_mode
== SSL_DEFAULT_STREAM_MODE_NONE
)
1373 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_NO_STREAM
, NULL
);
1376 * The peer may have opened a stream since we last ticked. So tick and
1377 * see if the stream with ordinal 0 (remote, bidi/uni based on stream
1378 * mode) exists yet. QUIC stream IDs must be allocated in order, so the
1379 * first stream created by a peer must have an ordinal of 0.
1381 expect_id
= qc
->as_server
1382 ? QUIC_STREAM_INITIATOR_CLIENT
1383 : QUIC_STREAM_INITIATOR_SERVER
;
1385 qs
= ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc
->ch
),
1386 expect_id
| QUIC_STREAM_DIR_BIDI
);
1388 qs
= ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc
->ch
),
1389 expect_id
| QUIC_STREAM_DIR_UNI
);
1392 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc
->ch
), 0);
1394 qs
= ossl_quic_stream_map_get_by_id(ossl_quic_channel_get_qsm(qc
->ch
),
1399 if (!qc_blocking_mode(qc
))
1400 /* Non-blocking mode, so just bail immediately. */
1401 return QUIC_RAISE_NORMAL_ERROR(ctx
, SSL_ERROR_WANT_READ
);
1403 /* Block until we have a stream. */
1407 wargs
.expect_id
= expect_id
;
1409 res
= block_until_pred(qc
, quic_wait_for_stream
, &wargs
, 0);
1411 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1412 else if (res
< 0 || wargs
.qs
== NULL
)
1413 /* quic_wait_for_stream raised error here */
1420 * We now have qs != NULL. Make it the default stream, creating the
1423 qc_set_default_xso(qc
, create_xso_from_stream(qc
, qs
), /*touch=*/0);
1424 if (qc
->default_xso
== NULL
)
1425 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1427 qc_touch_default_xso(qc
); /* inhibits default XSO */
1432 static QUIC_XSO
*create_xso_from_stream(QUIC_CONNECTION
*qc
, QUIC_STREAM
*qs
)
1434 QUIC_XSO
*xso
= NULL
;
1436 if ((xso
= OPENSSL_zalloc(sizeof(*xso
))) == NULL
)
1439 if (!ossl_ssl_init(&xso
->ssl
, qc
->ssl
.ctx
, qc
->ssl
.method
, SSL_TYPE_QUIC_XSO
))
1443 if (!SSL_up_ref(&qc
->ssl
))
1447 xso
->blocking
= qc
->default_blocking
;
1448 xso
->ssl_mode
= qc
->default_ssl_mode
;
1449 xso
->last_error
= SSL_ERROR_NONE
;
1461 /* locking depends on need_lock */
1462 static SSL
*quic_conn_stream_new(QCTX
*ctx
, uint64_t flags
, int need_lock
)
1464 QUIC_CONNECTION
*qc
= ctx
->qc
;
1465 QUIC_XSO
*xso
= NULL
;
1466 QUIC_STREAM
*qs
= NULL
;
1467 int is_uni
= ((flags
& SSL_STREAM_FLAG_UNI
) != 0);
1472 if (ossl_quic_channel_is_term_any(qc
->ch
)) {
1473 QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1477 qs
= ossl_quic_channel_new_stream_local(qc
->ch
, is_uni
);
1481 xso
= create_xso_from_stream(qc
, qs
);
1485 qc_touch_default_xso(qc
); /* inhibits default XSO */
1493 ossl_quic_stream_map_release(ossl_quic_channel_get_qsm(qc
->ch
), qs
);
1502 SSL
*ossl_quic_conn_stream_new(SSL
*s
, uint64_t flags
)
1506 if (!expect_quic_conn_only(s
, &ctx
))
1509 return quic_conn_stream_new(&ctx
, flags
, /*need_lock=*/1);
1513 * QUIC Front-End I/O API: Steady-State Operations
1514 * ===============================================
1516 * Here we dispatch calls to the steady-state front-end I/O API functions; that
1517 * is, the functions used during the established phase of a QUIC connection
1518 * (e.g. SSL_read, SSL_write).
1520 * Each function must handle both blocking and non-blocking modes. As discussed
1521 * above, all QUIC I/O is implemented using non-blocking mode internally.
1523 * SSL_get_error => partially implemented by ossl_quic_get_error
1524 * (BIO/)SSL_read => ossl_quic_read
1525 * (BIO/)SSL_write => ossl_quic_write
1526 * SSL_pending => ossl_quic_pending
1527 * SSL_stream_conclude => ossl_quic_conn_stream_conclude
1531 int ossl_quic_get_error(const SSL
*s
, int i
)
1535 if (!expect_quic(s
, &ctx
))
1538 return ctx
.is_stream
? ctx
.xso
->last_error
: ctx
.qc
->last_error
;
1545 * The set of functions below provide the implementation of the public SSL_write
1546 * function. We must handle:
1548 * - both blocking and non-blocking operation at the application level,
1549 * depending on how we are configured;
1551 * - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
1553 * - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
1557 static void quic_post_write(QUIC_XSO
*xso
, int did_append
, int do_tick
)
1560 * We have appended at least one byte to the stream.
1561 * Potentially mark stream as active, depending on FC.
1564 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(xso
->conn
->ch
),
1570 * TODO(QUIC): It is probably inefficient to try and do this immediately,
1571 * plus we should eventually consider Nagle's algorithm.
1574 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(xso
->conn
->ch
), 0);
1577 struct quic_write_again_args
{
1579 const unsigned char *buf
;
1581 size_t total_written
;
1585 static int quic_write_again(void *arg
)
1587 struct quic_write_again_args
*args
= arg
;
1588 size_t actual_written
= 0;
1590 if (!ossl_quic_channel_is_active(args
->xso
->conn
->ch
))
1591 /* If connection is torn down due to an error while blocking, stop. */
1594 if (!ossl_quic_sstream_append(args
->xso
->stream
->sstream
,
1595 args
->buf
, args
->len
, &actual_written
))
1598 quic_post_write(args
->xso
, actual_written
> 0, 0);
1600 args
->buf
+= actual_written
;
1601 args
->len
-= actual_written
;
1602 args
->total_written
+= actual_written
;
1605 /* Written everything, done. */
1608 /* Not written everything yet, keep trying. */
1613 static int quic_write_blocking(QCTX
*ctx
, const void *buf
, size_t len
,
1617 QUIC_XSO
*xso
= ctx
->xso
;
1618 struct quic_write_again_args args
;
1619 size_t actual_written
= 0;
1621 /* First make a best effort to append as much of the data as possible. */
1622 if (!ossl_quic_sstream_append(xso
->stream
->sstream
, buf
, len
,
1624 /* Stream already finished or allocation error. */
1626 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1629 quic_post_write(xso
, actual_written
> 0, 1);
1631 if (actual_written
== len
) {
1632 /* Managed to append everything on the first try. */
1633 *written
= actual_written
;
1638 * We did not manage to append all of the data immediately, so the stream
1639 * buffer has probably filled up. This means we need to block until some of
1643 args
.buf
= (const unsigned char *)buf
+ actual_written
;
1644 args
.len
= len
- actual_written
;
1645 args
.total_written
= 0;
1647 res
= block_until_pred(xso
->conn
, quic_write_again
, &args
, 0);
1649 if (!ossl_quic_channel_is_active(xso
->conn
->ch
))
1650 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1652 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1655 *written
= args
.total_written
;
1660 * Functions to manage All-or-Nothing (AON) (that is, non-ENABLE_PARTIAL_WRITE)
1663 static void aon_write_begin(QUIC_XSO
*xso
, const unsigned char *buf
,
1664 size_t buf_len
, size_t already_sent
)
1666 assert(!xso
->aon_write_in_progress
);
1668 xso
->aon_write_in_progress
= 1;
1669 xso
->aon_buf_base
= buf
;
1670 xso
->aon_buf_pos
= already_sent
;
1671 xso
->aon_buf_len
= buf_len
;
1674 static void aon_write_finish(QUIC_XSO
*xso
)
1676 xso
->aon_write_in_progress
= 0;
1677 xso
->aon_buf_base
= NULL
;
1678 xso
->aon_buf_pos
= 0;
1679 xso
->aon_buf_len
= 0;
1683 static int quic_write_nonblocking_aon(QCTX
*ctx
, const void *buf
,
1684 size_t len
, size_t *written
)
1686 QUIC_XSO
*xso
= ctx
->xso
;
1687 const void *actual_buf
;
1688 size_t actual_len
, actual_written
= 0;
1689 int accept_moving_buffer
1690 = ((xso
->ssl_mode
& SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER
) != 0);
1692 if (xso
->aon_write_in_progress
) {
1694 * We are in the middle of an AON write (i.e., a previous write did not
1695 * manage to append all data to the SSTREAM and we have Enable Partial
1696 * Write (EPW) mode disabled.)
1698 if ((!accept_moving_buffer
&& xso
->aon_buf_base
!= buf
)
1699 || len
!= xso
->aon_buf_len
)
1701 * Pointer must not have changed if we are not in accept moving
1702 * buffer mode. Length must never change.
1704 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, SSL_R_BAD_WRITE_RETRY
, NULL
);
1706 actual_buf
= (unsigned char *)buf
+ xso
->aon_buf_pos
;
1707 actual_len
= len
- xso
->aon_buf_pos
;
1708 assert(actual_len
> 0);
1714 /* First make a best effort to append as much of the data as possible. */
1715 if (!ossl_quic_sstream_append(xso
->stream
->sstream
, actual_buf
, actual_len
,
1717 /* Stream already finished or allocation error. */
1719 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1722 quic_post_write(xso
, actual_written
> 0, 1);
1724 if (actual_written
== actual_len
) {
1725 /* We have sent everything. */
1726 if (xso
->aon_write_in_progress
) {
1728 * We have sent everything, and we were in the middle of an AON
1729 * write. The output write length is the total length of the AON
1730 * buffer, not however many bytes we managed to write to the stream
1733 *written
= xso
->aon_buf_len
;
1734 aon_write_finish(xso
);
1736 *written
= actual_written
;
1742 if (xso
->aon_write_in_progress
) {
1744 * AON write is in progress but we have not written everything yet. We
1745 * may have managed to send zero bytes, or some number of bytes less
1746 * than the total remaining which need to be appended during this
1749 xso
->aon_buf_pos
+= actual_written
;
1750 assert(xso
->aon_buf_pos
< xso
->aon_buf_len
);
1751 return QUIC_RAISE_NORMAL_ERROR(ctx
, SSL_ERROR_WANT_WRITE
);
1755 * Not in an existing AON operation but partial write is not enabled, so we
1756 * need to begin a new AON operation. However we needn't bother if we didn't
1757 * actually append anything.
1759 if (actual_written
> 0)
1760 aon_write_begin(xso
, buf
, len
, actual_written
);
1763 * AON - We do not publicly admit to having appended anything until AON
1767 return QUIC_RAISE_NORMAL_ERROR(ctx
, SSL_ERROR_WANT_WRITE
);
1771 static int quic_write_nonblocking_epw(QCTX
*ctx
, const void *buf
, size_t len
,
1774 QUIC_XSO
*xso
= ctx
->xso
;
1776 /* Simple best effort operation. */
1777 if (!ossl_quic_sstream_append(xso
->stream
->sstream
, buf
, len
, written
)) {
1778 /* Stream already finished or allocation error. */
1780 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1783 quic_post_write(xso
, *written
> 0, 1);
1788 int ossl_quic_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
)
1799 if (!expect_quic_with_stream_lock(s
, /*remote_init=*/0, &ctx
))
1802 partial_write
= ((ctx
.xso
->ssl_mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
) != 0);
1804 if (ossl_quic_channel_is_term_any(ctx
.qc
->ch
)) {
1805 ret
= QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1810 * If we haven't finished the handshake, try to advance it.
1811 * We don't accept writes until the handshake is completed.
1813 if (quic_do_handshake(&ctx
) < 1) {
1818 if (ctx
.xso
->stream
== NULL
|| ctx
.xso
->stream
->sstream
== NULL
) {
1819 ret
= QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1823 if (xso_blocking_mode(ctx
.xso
))
1824 ret
= quic_write_blocking(&ctx
, buf
, len
, written
);
1825 else if (partial_write
)
1826 ret
= quic_write_nonblocking_epw(&ctx
, buf
, len
, written
);
1828 ret
= quic_write_nonblocking_aon(&ctx
, buf
, len
, written
);
1831 quic_unlock(ctx
.qc
);
1839 struct quic_read_again_args
{
1841 QUIC_STREAM
*stream
;
1849 static int quic_read_actual(QCTX
*ctx
,
1850 QUIC_STREAM
*stream
,
1851 void *buf
, size_t buf_len
,
1856 QUIC_CONNECTION
*qc
= ctx
->qc
;
1858 /* If the receive part of the stream is over, issue EOF. */
1859 if (stream
->recv_fin_retired
)
1860 return QUIC_RAISE_NORMAL_ERROR(ctx
, SSL_ERROR_ZERO_RETURN
);
1862 if (stream
->rstream
== NULL
)
1863 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1866 if (!ossl_quic_rstream_peek(stream
->rstream
, buf
, buf_len
,
1867 bytes_read
, &is_fin
))
1868 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1871 if (!ossl_quic_rstream_read(stream
->rstream
, buf
, buf_len
,
1872 bytes_read
, &is_fin
))
1873 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1877 if (*bytes_read
> 0) {
1879 * We have read at least one byte from the stream. Inform stream-level
1880 * RXFC of the retirement of controlled bytes. Update the active stream
1881 * status (the RXFC may now want to emit a frame granting more credit to
1884 OSSL_RTT_INFO rtt_info
;
1886 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc
->ch
), &rtt_info
);
1888 if (!ossl_quic_rxfc_on_retire(&stream
->rxfc
, *bytes_read
,
1889 rtt_info
.smoothed_rtt
))
1890 return QUIC_RAISE_NON_NORMAL_ERROR(ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1894 stream
->recv_fin_retired
= 1;
1896 if (*bytes_read
> 0)
1897 ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc
->ch
),
1905 static int quic_read_again(void *arg
)
1907 struct quic_read_again_args
*args
= arg
;
1909 if (!ossl_quic_channel_is_active(args
->ctx
->qc
->ch
)) {
1910 /* If connection is torn down due to an error while blocking, stop. */
1911 QUIC_RAISE_NON_NORMAL_ERROR(args
->ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1915 if (!quic_read_actual(args
->ctx
, args
->stream
,
1916 args
->buf
, args
->len
, args
->bytes_read
,
1920 if (*args
->bytes_read
> 0)
1921 /* got at least one byte, the SSL_read op can finish now */
1924 return 0; /* did not read anything, keep trying */
1928 static int quic_read(SSL
*s
, void *buf
, size_t len
, size_t *bytes_read
, int peek
)
1932 struct quic_read_again_args args
;
1936 if (!expect_quic(s
, &ctx
))
1941 if (ossl_quic_channel_is_term_any(ctx
.qc
->ch
)) {
1942 ret
= QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
1946 /* If we haven't finished the handshake, try to advance it. */
1947 if (quic_do_handshake(&ctx
) < 1) {
1948 ret
= 0; /* ossl_quic_do_handshake raised error here */
1952 if (ctx
.xso
== NULL
) {
1954 * Called on a QCSO and we don't currently have a default stream.
1956 * Wait until we get a stream initiated by the peer (blocking mode) or
1957 * fail if we don't have one yet (non-blocking mode).
1959 if (!qc_wait_for_default_xso_for_read(&ctx
)) {
1960 ret
= 0; /* error already raised here */
1964 ctx
.xso
= ctx
.qc
->default_xso
;
1967 if (ctx
.xso
->stream
== NULL
) {
1968 ret
= QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
1972 if (!quic_read_actual(&ctx
, ctx
.xso
->stream
, buf
, len
, bytes_read
, peek
)) {
1973 ret
= 0; /* quic_read_actual raised error here */
1977 if (*bytes_read
> 0) {
1979 * Even though we succeeded, tick the reactor here to ensure we are
1980 * handling other aspects of the QUIC connection.
1982 ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(ctx
.qc
->ch
), 0);
1984 } else if (xso_blocking_mode(ctx
.xso
)) {
1986 * We were not able to read anything immediately, so our stream
1987 * buffer is empty. This means we need to block until we get
1988 * at least one byte.
1991 args
.stream
= ctx
.xso
->stream
;
1994 args
.bytes_read
= bytes_read
;
1997 res
= block_until_pred(ctx
.qc
, quic_read_again
, &args
, 0);
1999 ret
= QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
2001 } else if (res
< 0) {
2002 ret
= 0; /* quic_read_again raised error here */
2008 /* We did not get any bytes and are not in blocking mode. */
2009 ret
= QUIC_RAISE_NORMAL_ERROR(&ctx
, SSL_ERROR_WANT_READ
);
2013 quic_unlock(ctx
.qc
);
2017 int ossl_quic_read(SSL
*s
, void *buf
, size_t len
, size_t *bytes_read
)
2019 return quic_read(s
, buf
, len
, bytes_read
, 0);
2022 int ossl_quic_peek(SSL
*s
, void *buf
, size_t len
, size_t *bytes_read
)
2024 return quic_read(s
, buf
, len
, bytes_read
, 1);
2032 static size_t ossl_quic_pending_int(const SSL
*s
)
2038 if (!expect_quic_with_stream_lock(s
, /*remote_init=*/-1, &ctx
))
2041 if (ctx
.xso
->stream
== NULL
|| ctx
.xso
->stream
->rstream
== NULL
)
2042 /* Cannot raise errors here because we are const, just fail. */
2045 if (!ossl_quic_rstream_available(ctx
.xso
->stream
->rstream
, &avail
, &fin
))
2049 quic_unlock(ctx
.qc
);
2053 size_t ossl_quic_pending(const SSL
*s
)
2055 return ossl_quic_pending_int(s
);
2058 int ossl_quic_has_pending(const SSL
*s
)
2060 return ossl_quic_pending_int(s
) > 0;
2064 * SSL_stream_conclude
2065 * -------------------
2068 int ossl_quic_conn_stream_conclude(SSL
*s
)
2073 if (!expect_quic_with_stream_lock(s
, /*remote_init=*/0, &ctx
))
2076 qs
= ctx
.xso
->stream
;
2078 if (qs
== NULL
|| qs
->sstream
== NULL
) {
2079 quic_unlock(ctx
.qc
);
2083 if (!ossl_quic_channel_is_active(ctx
.qc
->ch
)
2084 || ossl_quic_sstream_get_final_size(qs
->sstream
, NULL
)) {
2085 quic_unlock(ctx
.qc
);
2089 ossl_quic_sstream_fin(qs
->sstream
);
2090 quic_post_write(ctx
.xso
, 1, 1);
2091 quic_unlock(ctx
.qc
);
2096 * SSL_inject_net_dgram
2097 * --------------------
2100 int SSL_inject_net_dgram(SSL
*s
, const unsigned char *buf
,
2102 const BIO_ADDR
*peer
,
2103 const BIO_ADDR
*local
)
2109 if (!expect_quic(s
, &ctx
))
2114 demux
= ossl_quic_channel_get0_demux(ctx
.qc
->ch
);
2115 ret
= ossl_quic_demux_inject(demux
, buf
, buf_len
, peer
, local
);
2117 quic_unlock(ctx
.qc
);
2122 * SSL_get0_connection
2123 * -------------------
2125 SSL
*ossl_quic_get0_connection(SSL
*s
)
2129 if (!expect_quic(s
, &ctx
))
2132 return &ctx
.qc
->ssl
;
2136 * SSL_get_stream_type
2137 * -------------------
2139 int ossl_quic_get_stream_type(SSL
*s
)
2143 if (!expect_quic(s
, &ctx
))
2144 return SSL_STREAM_TYPE_BIDI
;
2146 if (ctx
.xso
== NULL
) {
2148 * If deferred XSO creation has yet to occur, proceed according to the
2149 * default stream mode. If AUTO_BIDI or AUTO_UNI is set, we cannot know
2150 * what kind of stream will be created yet, so return BIDI on the basis
2151 * that at this time, the client still has the option of calling
2152 * SSL_read() or SSL_write() first.
2154 if (ctx
.qc
->default_xso_created
2155 || ctx
.qc
->default_stream_mode
== SSL_DEFAULT_STREAM_MODE_NONE
)
2156 return SSL_STREAM_TYPE_NONE
;
2158 return SSL_STREAM_TYPE_BIDI
;
2161 if (ossl_quic_stream_is_bidi(ctx
.xso
->stream
))
2162 return SSL_STREAM_TYPE_BIDI
;
2164 if (ossl_quic_stream_is_server_init(ctx
.xso
->stream
) != ctx
.qc
->as_server
)
2165 return SSL_STREAM_TYPE_READ
;
2167 return SSL_STREAM_TYPE_WRITE
;
2175 uint64_t ossl_quic_get_stream_id(SSL
*s
)
2180 if (!expect_quic_with_stream_lock(s
, /*remote_init=*/-1, &ctx
))
2183 id
= ctx
.xso
->stream
->id
;
2184 quic_unlock(ctx
.qc
);
2190 * SSL_set_default_stream_mode
2191 * ---------------------------
2194 int ossl_quic_set_default_stream_mode(SSL
*s
, uint32_t mode
)
2198 if (!expect_quic_conn_only(s
, &ctx
))
2203 if (ctx
.qc
->default_xso_created
)
2204 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
,
2205 "too late to change default stream mode");
2208 case SSL_DEFAULT_STREAM_MODE_NONE
:
2209 case SSL_DEFAULT_STREAM_MODE_AUTO_BIDI
:
2210 case SSL_DEFAULT_STREAM_MODE_AUTO_UNI
:
2211 ctx
.qc
->default_stream_mode
= mode
;
2214 quic_unlock(ctx
.qc
);
2215 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_PASSED_INVALID_ARGUMENT
,
2216 "bad default stream type");
2219 quic_unlock(ctx
.qc
);
2228 SSL
*ossl_quic_detach_stream(SSL
*s
)
2231 QUIC_XSO
*xso
= NULL
;
2233 if (!expect_quic_conn_only(s
, &ctx
))
2238 /* Calling this function inhibits default XSO autocreation. */
2239 /* QC ref to any default XSO is transferred to us and to caller. */
2240 qc_set_default_xso_keep_ref(ctx
.qc
, NULL
, /*touch=*/1, &xso
);
2242 quic_unlock(ctx
.qc
);
2244 return xso
!= NULL
? &xso
->ssl
: NULL
;
2252 int ossl_quic_attach_stream(SSL
*conn
, SSL
*stream
)
2258 if (!expect_quic_conn_only(conn
, &ctx
))
2261 if (stream
== NULL
|| stream
->type
!= SSL_TYPE_QUIC_XSO
)
2262 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_PASSED_NULL_PARAMETER
,
2263 "stream to attach must be a valid QUIC stream");
2265 xso
= (QUIC_XSO
*)stream
;
2269 if (ctx
.qc
->default_xso
!= NULL
) {
2270 quic_unlock(ctx
.qc
);
2271 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
,
2272 "connection already has a default stream");
2276 * It is a caller error for the XSO being attached as a default XSO to have
2277 * more than one ref.
2279 if (!CRYPTO_GET_REF(&xso
->ssl
.references
, &nref
, &xso
->ssl
.lock
)) {
2280 quic_unlock(ctx
.qc
);
2281 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_INTERNAL_ERROR
,
2286 quic_unlock(ctx
.qc
);
2287 return QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_PASSED_INVALID_ARGUMENT
,
2288 "stream being attached must have "
2289 "only 1 reference");
2292 /* Caller's reference to the XSO is transferred to us. */
2293 /* Calling this function inhibits default XSO autocreation. */
2294 qc_set_default_xso(ctx
.qc
, xso
, /*touch=*/1);
2296 quic_unlock(ctx
.qc
);
2301 * SSL_set_incoming_stream_policy
2302 * ------------------------------
2305 static int qc_get_effective_incoming_stream_policy(QUIC_CONNECTION
*qc
)
2307 switch (qc
->incoming_stream_policy
) {
2308 case SSL_INCOMING_STREAM_POLICY_AUTO
:
2309 if ((qc
->default_xso
== NULL
&& !qc
->default_xso_created
)
2310 || qc
->default_stream_mode
== SSL_DEFAULT_STREAM_MODE_NONE
)
2311 return SSL_INCOMING_STREAM_POLICY_ACCEPT
;
2313 return SSL_INCOMING_STREAM_POLICY_REJECT
;
2316 return qc
->incoming_stream_policy
;
2321 static void qc_update_reject_policy(QUIC_CONNECTION
*qc
)
2323 int policy
= qc_get_effective_incoming_stream_policy(qc
);
2324 int enable_reject
= (policy
== SSL_INCOMING_STREAM_POLICY_REJECT
);
2326 ossl_quic_channel_set_incoming_stream_auto_reject(qc
->ch
,
2328 qc
->incoming_stream_aec
);
2332 int ossl_quic_set_incoming_stream_policy(SSL
*s
, int policy
,
2338 if (!expect_quic_conn_only(s
, &ctx
))
2344 case SSL_INCOMING_STREAM_POLICY_AUTO
:
2345 case SSL_INCOMING_STREAM_POLICY_ACCEPT
:
2346 case SSL_INCOMING_STREAM_POLICY_REJECT
:
2347 ctx
.qc
->incoming_stream_policy
= policy
;
2348 ctx
.qc
->incoming_stream_aec
= aec
;
2356 qc_update_reject_policy(ctx
.qc
);
2357 quic_unlock(ctx
.qc
);
2365 struct wait_for_incoming_stream_args
{
2371 static int wait_for_incoming_stream(void *arg
)
2373 struct wait_for_incoming_stream_args
*args
= arg
;
2374 QUIC_CONNECTION
*qc
= args
->ctx
->qc
;
2375 QUIC_STREAM_MAP
*qsm
= ossl_quic_channel_get_qsm(qc
->ch
);
2377 if (!ossl_quic_channel_is_active(qc
->ch
)) {
2378 /* If connection is torn down due to an error while blocking, stop. */
2379 QUIC_RAISE_NON_NORMAL_ERROR(args
->ctx
, SSL_R_PROTOCOL_IS_SHUTDOWN
, NULL
);
2383 args
->qs
= ossl_quic_stream_map_peek_accept_queue(qsm
);
2384 if (args
->qs
!= NULL
)
2385 return 1; /* got a stream */
2387 return 0; /* did not get a stream, keep trying */
2391 SSL
*ossl_quic_accept_stream(SSL
*s
, uint64_t flags
)
2396 QUIC_STREAM_MAP
*qsm
;
2399 OSSL_RTT_INFO rtt_info
;
2401 if (!expect_quic_conn_only(s
, &ctx
))
2406 if (qc_get_effective_incoming_stream_policy(ctx
.qc
)
2407 == SSL_INCOMING_STREAM_POLICY_REJECT
)
2410 qsm
= ossl_quic_channel_get_qsm(ctx
.qc
->ch
);
2412 qs
= ossl_quic_stream_map_peek_accept_queue(qsm
);
2414 if (qc_blocking_mode(ctx
.qc
)
2415 && (flags
& SSL_ACCEPT_STREAM_NO_BLOCK
) == 0) {
2416 struct wait_for_incoming_stream_args args
;
2421 ret
= block_until_pred(ctx
.qc
, wait_for_incoming_stream
, &args
, 0);
2423 QUIC_RAISE_NON_NORMAL_ERROR(&ctx
, ERR_R_INTERNAL_ERROR
, NULL
);
2425 } else if (ret
< 0 || args
.qs
== NULL
) {
2435 xso
= create_xso_from_stream(ctx
.qc
, qs
);
2439 ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(ctx
.qc
->ch
), &rtt_info
);
2440 ossl_quic_stream_map_remove_from_accept_queue(qsm
, qs
,
2441 rtt_info
.smoothed_rtt
);
2444 /* Calling this function inhibits default XSO autocreation. */
2445 qc_touch_default_xso(ctx
.qc
); /* inhibits default XSO */
2448 quic_unlock(ctx
.qc
);
2453 * SSL_get_accept_stream_queue_len
2454 * -------------------------------
2457 size_t ossl_quic_get_accept_stream_queue_len(SSL
*s
)
2462 if (!expect_quic_conn_only(s
, &ctx
))
2467 v
= ossl_quic_stream_map_get_accept_queue_len(ossl_quic_channel_get_qsm(ctx
.qc
->ch
));
2469 quic_unlock(ctx
.qc
);
2477 int ossl_quic_stream_reset(SSL
*ssl
,
2478 const SSL_STREAM_RESET_ARGS
*args
,
2482 QUIC_STREAM_MAP
*qsm
;
2484 uint64_t error_code
;
2486 if (!expect_quic_with_stream_lock(ssl
, /*remote_init=*/0, &ctx
))
2489 qsm
= ossl_quic_channel_get_qsm(ctx
.qc
->ch
);
2490 qs
= ctx
.xso
->stream
;
2491 error_code
= (args
!= NULL
? args
->quic_error_code
: 0);
2493 ossl_quic_stream_map_reset_stream_send_part(qsm
, qs
, error_code
);
2495 quic_unlock(ctx
.qc
);
2500 * SSL_get_stream_read_state
2501 * -------------------------
2503 static void quic_classify_stream(QUIC_CONNECTION
*qc
,
2507 uint64_t *app_error_code
)
2510 uint64_t final_size
;
2512 local_init
= (ossl_quic_stream_is_server_init(qs
) == qc
->as_server
);
2514 if (app_error_code
!= NULL
)
2515 *app_error_code
= UINT64_MAX
;
2517 app_error_code
= &final_size
; /* throw away value */
2519 if (!ossl_quic_stream_is_bidi(qs
) && local_init
!= is_write
) {
2521 * Unidirectional stream and this direction of transmission doesn't
2524 *state
= SSL_STREAM_STATE_WRONG_DIR
;
2525 } else if (ossl_quic_channel_is_term_any(qc
->ch
)) {
2526 /* Connection already closed. */
2527 *state
= SSL_STREAM_STATE_CONN_CLOSED
;
2528 } else if (!is_write
&& qs
->recv_fin_retired
) {
2529 /* Application has read a FIN. */
2530 *state
= SSL_STREAM_STATE_FINISHED
;
2531 } else if ((!is_write
&& qs
->stop_sending
)
2532 || (is_write
&& qs
->reset_stream
)) {
2534 * Stream has been reset locally. FIN takes precedence over this for the
2535 * read case as the application need not care if the stream is reset
2536 * after a FIN has been successfully processed.
2538 *state
= SSL_STREAM_STATE_RESET_LOCAL
;
2539 *app_error_code
= !is_write
2540 ? qs
->stop_sending_aec
2541 : qs
->reset_stream_aec
;
2542 } else if ((!is_write
&& qs
->peer_reset_stream
)
2543 || (is_write
&& qs
->peer_stop_sending
)) {
2545 * Stream has been reset remotely. */
2546 *state
= SSL_STREAM_STATE_RESET_REMOTE
;
2547 *app_error_code
= !is_write
2548 ? qs
->peer_reset_stream_aec
2549 : qs
->peer_stop_sending_aec
;
2550 } else if (is_write
&& ossl_quic_sstream_get_final_size(qs
->sstream
,
2553 * Stream has been finished. Stream reset takes precedence over this for
2554 * the write case as peer may not have received all data.
2556 *state
= SSL_STREAM_STATE_FINISHED
;
2558 /* Stream still healthy. */
2559 *state
= SSL_STREAM_STATE_OK
;
2563 static int quic_get_stream_state(SSL
*ssl
, int is_write
)
2568 if (!expect_quic_with_stream_lock(ssl
, /*remote_init=*/-1, &ctx
))
2569 return SSL_STREAM_STATE_NONE
;
2571 quic_classify_stream(ctx
.qc
, ctx
.xso
->stream
, is_write
, &state
, NULL
);
2572 quic_unlock(ctx
.qc
);
2576 int ossl_quic_get_stream_read_state(SSL
*ssl
)
2578 return quic_get_stream_state(ssl
, /*is_write=*/0);
2582 * SSL_get_stream_write_state
2583 * --------------------------
2585 int ossl_quic_get_stream_write_state(SSL
*ssl
)
2587 return quic_get_stream_state(ssl
, /*is_write=*/1);
2591 * SSL_get_stream_read_error_code
2592 * ------------------------------
2594 static int quic_get_stream_error_code(SSL
*ssl
, int is_write
,
2595 uint64_t *app_error_code
)
2600 if (!expect_quic_with_stream_lock(ssl
, /*remote_init=*/-1, &ctx
))
2603 quic_classify_stream(ctx
.qc
, ctx
.xso
->stream
, /*is_write=*/0,
2604 &state
, app_error_code
);
2606 quic_unlock(ctx
.qc
);
2608 case SSL_STREAM_STATE_FINISHED
:
2610 case SSL_STREAM_STATE_RESET_LOCAL
:
2611 case SSL_STREAM_STATE_RESET_REMOTE
:
2618 int ossl_quic_get_stream_read_error_code(SSL
*ssl
, uint64_t *app_error_code
)
2620 return quic_get_stream_error_code(ssl
, /*is_write=*/0, app_error_code
);
2624 * SSL_get_stream_write_error_code
2625 * -------------------------------
2627 int ossl_quic_get_stream_write_error_code(SSL
*ssl
, uint64_t *app_error_code
)
2629 return quic_get_stream_error_code(ssl
, /*is_write=*/1, app_error_code
);
2633 * SSL_get_conn_close_info
2634 * -----------------------
2636 int ossl_quic_get_conn_close_info(SSL
*ssl
,
2637 SSL_CONN_CLOSE_INFO
*info
,
2641 const QUIC_TERMINATE_CAUSE
*tc
;
2643 if (!expect_quic_conn_only(ssl
, &ctx
))
2646 tc
= ossl_quic_channel_get_terminate_cause(ctx
.qc
->ch
);
2650 info
->error_code
= tc
->error_code
;
2651 info
->reason
= NULL
; /* TODO(QUIC): Wire reason */
2652 info
->reason_len
= 0;
2653 info
->is_local
= !tc
->remote
;
2654 info
->is_transport
= !tc
->app
;
2659 * QUIC Front-End I/O API: SSL_CTX Management
2660 * ==========================================
2663 long ossl_quic_ctx_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
2667 return ssl3_ctx_ctrl(ctx
, cmd
, larg
, parg
);
2671 long ossl_quic_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
2675 if (!expect_quic_conn_only(s
, &ctx
))
2679 case SSL_CTRL_SET_MSG_CALLBACK
:
2680 ossl_quic_channel_set_msg_callback(ctx
.qc
->ch
, (ossl_msg_cb
)fp
,
2682 /* This callback also needs to be set on the internal SSL object */
2683 return ssl3_callback_ctrl(ctx
.qc
->tls
, cmd
, fp
);;
2686 /* Probably a TLS related ctrl. Defer to our internal SSL object */
2687 return ssl3_callback_ctrl(ctx
.qc
->tls
, cmd
, fp
);
2691 long ossl_quic_ctx_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
2693 return ssl3_ctx_callback_ctrl(ctx
, cmd
, fp
);
2696 int ossl_quic_renegotiate_check(SSL
*ssl
, int initok
)
2698 /* We never do renegotiation. */
2703 * These functions define the TLSv1.2 (and below) ciphers that are supported by
2704 * the SSL_METHOD. Since QUIC only supports TLSv1.3 we don't support any.
2707 int ossl_quic_num_ciphers(void)
2712 const SSL_CIPHER
*ossl_quic_get_cipher(unsigned int u
)