1 #ifndef OSSL_QUIC_CHANNEL_LOCAL_H
2 # define OSSL_QUIC_CHANNEL_LOCAL_H
4 # include "internal/quic_channel.h"
6 # ifndef OPENSSL_NO_QUIC
9 * QUIC Channel Structure
10 * ======================
12 * QUIC channel internals. It is intended that only the QUIC_CHANNEL
13 * implementation and the RX depacketiser be allowed to access this structure
14 * directly. As the RX depacketiser has no state of its own and computes over a
15 * QUIC_CHANNEL structure, it can be viewed as an extention of the QUIC_CHANNEL
16 * implementation. While the RX depacketiser could be provided with adequate
17 * accessors to do what it needs, this would weaken the abstraction provided by
18 * the QUIC_CHANNEL to other components; moreover the coupling of the RX
19 * depacketiser to QUIC_CHANNEL internals is too deep and bespoke to make this
22 * Other components should not include this header.
24 struct quic_channel_st {
29 * Master synchronisation mutex used for thread assisted mode
30 * synchronisation. We don't own this; the instantiator of the channel
31 * passes it to us and is responsible for freeing it after channel
37 * Callback used to get the current time.
39 OSSL_TIME (*now_cb)(void *arg);
43 * The associated TLS 1.3 connection data. Used to provide the handshake
44 * layer; its 'network' side is plugged into the crypto stream for each EL
45 * (other than the 0-RTT EL).
51 * The transport parameter block we will send or have sent.
52 * Freed after sending or when connection is freed.
54 unsigned char *local_transport_params;
56 /* Asynchronous I/O reactor. */
59 /* Our current L4 peer address, if any. */
60 BIO_ADDR cur_peer_addr;
62 /* Network-side read and write BIOs. */
63 BIO *net_rbio, *net_wbio;
66 * Subcomponents of the connection. All of these components are instantiated
69 OSSL_QUIC_TX_PACKETISER *txp;
73 * Connection level FC. The stream_count RXFCs is used to manage
74 * MAX_STREAMS signalling.
78 QUIC_RXFC max_streams_bidi_rxfc, max_streams_uni_rxfc;
81 OSSL_CC_DATA *cc_data;
82 const OSSL_CC_METHOD *cc_method;
86 * RX demuxer. We register incoming DCIDs with this. Since we currently only
87 * support client operation and use one L4 port per connection, we own the
88 * demuxer and register a single zero-length DCID with it.
92 /* Record layers in the TX and RX directions, plus the RX demuxer. */
96 /* Message callback related arguments */
97 ossl_msg_cb msg_callback;
98 void *msg_callback_arg;
99 SSL *msg_callback_ssl;
102 * Send and receive parts of the crypto streams.
103 * crypto_send[QUIC_PN_SPACE_APP] is the 1-RTT crypto stream. There is no
104 * 0-RTT crypto stream.
106 QUIC_SSTREAM *crypto_send[QUIC_PN_SPACE_NUM];
107 QUIC_RSTREAM *crypto_recv[QUIC_PN_SPACE_NUM];
109 /* Internal state. */
111 * Client: The DCID used in the first Initial packet we transmit as a client.
112 * Server: The DCID used in the first Initial packet the client transmitted.
113 * Randomly generated and required by RFC to be at least 8 bytes.
115 QUIC_CONN_ID init_dcid;
118 * Client: The SCID found in the first Initial packet from the server.
119 * Not valid for servers.
120 * Valid if have_received_enc_pkt is set.
122 QUIC_CONN_ID init_scid;
125 * Client only: The SCID found in an incoming Retry packet we handled.
126 * Not valid for servers.
128 QUIC_CONN_ID retry_scid;
130 /* The DCID we currently use to talk to the peer and its sequence num. */
131 QUIC_CONN_ID cur_remote_dcid;
132 uint64_t cur_remote_seq_num;
133 uint64_t cur_retire_prior_to;
134 /* Server only: The DCID we currently expect the peer to use to talk to us. */
135 QUIC_CONN_ID cur_local_cid;
137 /* Transport parameter values we send to our peer. */
138 uint64_t tx_init_max_stream_data_bidi_local;
139 uint64_t tx_init_max_stream_data_bidi_remote;
140 uint64_t tx_init_max_stream_data_uni;
142 /* Transport parameter values received from server. */
143 uint64_t rx_init_max_stream_data_bidi_local;
144 uint64_t rx_init_max_stream_data_bidi_remote;
145 uint64_t rx_init_max_stream_data_uni;
146 uint64_t rx_max_ack_delay; /* ms */
147 unsigned char rx_ack_delay_exp;
150 * Temporary staging area to store information about the incoming packet we
151 * are currently processing.
153 OSSL_QRX_PKT *qrx_pkt;
156 * Current limit on number of streams we may create. Set by transport
157 * parameters initially and then by MAX_STREAMS frames.
159 uint64_t max_local_streams_bidi;
160 uint64_t max_local_streams_uni;
162 /* The negotiated maximum idle timeout in milliseconds. */
163 uint64_t max_idle_timeout;
166 * Maximum payload size in bytes for datagrams sent to our peer, as
167 * negotiated by transport parameters.
169 uint64_t rx_max_udp_payload_size;
170 /* Maximum active CID limit, as negotiated by transport parameters. */
171 uint64_t rx_active_conn_id_limit;
174 * Used to allocate stream IDs. This is a stream ordinal, i.e., a stream ID
175 * without the low two bits designating type and initiator. Shift and or in
176 * the type bits to convert to a stream ID.
178 uint64_t next_local_stream_ordinal_bidi;
179 uint64_t next_local_stream_ordinal_uni;
182 * Used to track which stream ordinals within a given stream type have been
183 * used by the remote peer. This is an optimisation used to determine
184 * which streams should be implicitly created due to usage of a higher
187 uint64_t next_remote_stream_ordinal_bidi;
188 uint64_t next_remote_stream_ordinal_uni;
191 * Application error code to be used for STOP_SENDING/RESET_STREAM frames
192 * used to autoreject incoming streams.
194 uint64_t incoming_stream_auto_reject_aec;
196 /* Valid if we are in the TERMINATING or TERMINATED states. */
197 QUIC_TERMINATE_CAUSE terminate_cause;
200 * Deadline at which we move to TERMINATING state. Valid if in the
203 OSSL_TIME terminate_deadline;
206 * Deadline at which connection dies due to idle timeout if no further
209 OSSL_TIME idle_deadline;
212 * Deadline at which we should send an ACK-eliciting packet to ensure
213 * idle timeout does not occur.
215 OSSL_TIME ping_deadline;
218 * State tracking. QUIC connection-level state is best represented based on
219 * whether various things have happened yet or not, rather than as an
220 * explicit FSM. We do have a coarse state variable which tracks the basic
221 * state of the connection's lifecycle, but more fine-grained conditions of
222 * the Active state are tracked via flags below. For more details, see
223 * doc/designs/quic-design/connection-state-machine.md. We are in the Open
224 * state if the state is QUIC_CSM_STATE_ACTIVE and handshake_confirmed is
227 unsigned int state : 3;
230 * Have we received at least one encrypted packet from the peer?
231 * (If so, Retry and Version Negotiation messages should no longer
232 * be received and should be ignored if they do occur.)
234 unsigned int have_received_enc_pkt : 1;
237 * Have we sent literally any packet yet? If not, there is no point polling
240 unsigned int have_sent_any_pkt : 1;
243 * Are we currently doing proactive version negotiation?
245 unsigned int doing_proactive_ver_neg : 1;
247 /* We have received transport parameters from the peer. */
248 unsigned int got_remote_transport_params : 1;
251 * This monotonically transitions to 1 once the TLS state machine is
252 * 'complete', meaning that it has both sent a Finished and successfully
253 * verified the peer's Finished (see RFC 9001 s. 4.1.1). Note that it
254 * does not transition to 1 at both peers simultaneously.
256 * Handshake completion is not the same as handshake confirmation (see
259 unsigned int handshake_complete : 1;
262 * This monotonically transitions to 1 once the handshake is confirmed.
263 * This happens on the client when we receive a HANDSHAKE_DONE frame.
264 * At our option, we may also take acknowledgement of any 1-RTT packet
265 * we sent as a handshake confirmation.
267 unsigned int handshake_confirmed : 1;
270 * We are sending Initial packets based on a Retry. This means we definitely
271 * should not receive another Retry, and if we do it is an error.
273 unsigned int doing_retry : 1;
276 * We don't store the current EL here; the TXP asks the QTX which ELs
277 * are provisioned to determine which ELs to use.
280 /* Have statm, qsm been initialised? Used to track cleanup. */
281 unsigned int have_statm : 1;
282 unsigned int have_qsm : 1;
285 * Preferred ELs for transmission and reception. This is not strictly needed
286 * as it can be inferred from what keys we have provisioned, but makes
287 * determining the current EL simpler and faster. A separate EL for
288 * transmission and reception is not strictly necessary but makes things
289 * easier for interoperation with the handshake layer, which likes to invoke
290 * the yield secret callback at different times for TX and RX.
292 unsigned int tx_enc_level : 3;
293 unsigned int rx_enc_level : 3;
295 /* If bit n is set, EL n has been discarded. */
296 unsigned int el_discarded : 4;
299 * While in TERMINATING - CLOSING, set when we should generate a connection
302 unsigned int conn_close_queued : 1;
304 /* Are we in server mode? Never changes after instantiation. */
305 unsigned int is_server : 1;
308 * Set temporarily when the handshake layer has given us a new RX secret.
309 * Used to determine if we need to check our RX queues again.
311 unsigned int have_new_rx_secret : 1;
314 * Have we sent an ack-eliciting packet since the last successful packet
315 * reception? Used to determine when to bump idle timer (see RFC 9000 s.
318 unsigned int have_sent_ack_eliciting_since_rx : 1;
320 /* Should incoming streams automatically be rejected? */
321 unsigned int incoming_stream_auto_reject : 1;