ssl/quic/quic_channel_local.h

   1 #ifndef OSSL_QUIC_CHANNEL_LOCAL_H
   2 # define OSSL_QUIC_CHANNEL_LOCAL_H
   3
   4 # include "internal/quic_channel.h"
   5
   6 # ifndef OPENSSL_NO_QUIC
   7
   8 /*
   9  * QUIC Channel Structure
  10  * ======================
  11  *
  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
  20  * desirable.
  21  *
  22  * Other components should not include this header.
  23  */
  24 struct quic_channel_st {
  25     OSSL_LIB_CTX                    *libctx;
  26     const char                      *propq;
  27
  28     /*
  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
  32      * destruction.
  33      */
  34     CRYPTO_MUTEX                    *mutex;
  35
  36     /*
  37      * Callback used to get the current time.
  38      */
  39     OSSL_TIME                       (*now_cb)(void *arg);
  40     void                            *now_cb_arg;
  41
  42     /*
  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).
  46      */
  47     QUIC_TLS                        *qtls;
  48     SSL                             *tls;
  49
  50     /*
  51      * The transport parameter block we will send or have sent.
  52      * Freed after sending or when connection is freed.
  53      */
  54     unsigned char                   *local_transport_params;
  55
  56     /* Asynchronous I/O reactor. */
  57     QUIC_REACTOR                    rtor;
  58
  59     /* Our current L4 peer address, if any. */
  60     BIO_ADDR                        cur_peer_addr;
  61
  62     /* Network-side read and write BIOs. */
  63     BIO                             *net_rbio, *net_wbio;
  64
  65     /*
  66      * Subcomponents of the connection. All of these components are instantiated
  67      * and owned by us.
  68      */
  69     OSSL_QUIC_TX_PACKETISER         *txp;
  70     QUIC_TXPIM                      *txpim;
  71     QUIC_CFQ                        *cfq;
  72     /* Connection level FC. */
  73     QUIC_TXFC                       conn_txfc;
  74     QUIC_RXFC                       conn_rxfc;
  75     QUIC_STREAM_MAP                 qsm;
  76     OSSL_STATM                      statm;
  77     OSSL_CC_DATA                    *cc_data;
  78     const OSSL_CC_METHOD            *cc_method;
  79     OSSL_ACKM                       *ackm;
  80
  81     /*
  82      * RX demuxer. We register incoming DCIDs with this. Since we currently only
  83      * support client operation and use one L4 port per connection, we own the
  84      * demuxer and register a single zero-length DCID with it.
  85      */
  86     QUIC_DEMUX                      *demux;
  87
  88     /* Record layers in the TX and RX directions, plus the RX demuxer. */
  89     OSSL_QTX                        *qtx;
  90     OSSL_QRX                        *qrx;
  91
  92     /*
  93      * Send and receive parts of the crypto streams.
  94      * crypto_send[QUIC_PN_SPACE_APP] is the 1-RTT crypto stream. There is no
  95      * 0-RTT crypto stream.
  96      */
  97     QUIC_SSTREAM                    *crypto_send[QUIC_PN_SPACE_NUM];
  98     QUIC_RSTREAM                    *crypto_recv[QUIC_PN_SPACE_NUM];
  99
 100     /* Internal state. */
 101     /*
 102      * Client: The DCID used in the first Initial packet we transmit as a client.
 103      * Server: The DCID used in the first Initial packet the client transmitted.
 104      * Randomly generated and required by RFC to be at least 8 bytes.
 105      */
 106     QUIC_CONN_ID                    init_dcid;
 107
 108     /*
 109      * Client: The SCID found in the first Initial packet from the server.
 110      * Not valid for servers.
 111      * Valid if have_received_enc_pkt is set.
 112      */
 113     QUIC_CONN_ID                    init_scid;
 114
 115     /*
 116      * Client only: The SCID found in an incoming Retry packet we handled.
 117      * Not valid for servers.
 118      */
 119     QUIC_CONN_ID                    retry_scid;
 120
 121     /* Server only: The DCID we currently use to talk to the peer. */
 122     QUIC_CONN_ID                    cur_remote_dcid;
 123     /* Server only: The DCID we currently expect the peer to use to talk to us. */
 124     QUIC_CONN_ID                    cur_local_dcid;
 125
 126     /* Transport parameter values we send to our peer. */
 127     uint64_t                        tx_init_max_stream_data_bidi_local;
 128     uint64_t                        tx_init_max_stream_data_bidi_remote;
 129     uint64_t                        tx_init_max_stream_data_uni;
 130
 131     /* Transport parameter values received from server. */
 132     uint64_t                        rx_init_max_stream_data_bidi_local;
 133     uint64_t                        rx_init_max_stream_data_bidi_remote;
 134     uint64_t                        rx_init_max_stream_data_uni;
 135     uint64_t                        rx_max_ack_delay; /* ms */
 136     unsigned char                   rx_ack_delay_exp;
 137
 138     /*
 139      * Temporary staging area to store information about the incoming packet we
 140      * are currently processing.
 141      */
 142     OSSL_QRX_PKT                    *qrx_pkt;
 143
 144     /*
 145      * Current limit on number of streams we may create. Set by transport
 146      * parameters initially and then by MAX_STREAMS frames.
 147      */
 148     uint64_t                        max_local_streams_bidi;
 149     uint64_t                        max_local_streams_uni;
 150
 151     /* The negotiated maximum idle timeout in milliseconds. */
 152     uint64_t                        max_idle_timeout;
 153
 154     /*
 155      * Maximum payload size in bytes for datagrams sent to our peer, as
 156      * negotiated by transport parameters.
 157      */
 158     uint64_t                        rx_max_udp_payload_size;
 159     /* Maximum active CID limit, as negotiated by transport parameters. */
 160     uint64_t                        rx_active_conn_id_limit;
 161
 162     /*
 163      * Used to allocate stream IDs. This is a stream ordinal, i.e., a stream ID
 164      * without the low two bits designating type and initiator. Shift and or in
 165      * the type bits to convert to a stream ID.
 166      */
 167     uint64_t                        next_local_stream_ordinal_bidi;
 168     uint64_t                        next_local_stream_ordinal_uni;
 169
 170     /* Valid if we are in the TERMINATING or TERMINATED states. */
 171     QUIC_TERMINATE_CAUSE            terminate_cause;
 172
 173     /*
 174      * Deadline at which we move to TERMINATING state. Valid if in the
 175      * TERMINATING state.
 176      */
 177     OSSL_TIME                       terminate_deadline;
 178
 179     /*
 180      * Deadline at which connection dies due to idle timeout if no further
 181      * events occur.
 182      */
 183     OSSL_TIME                       idle_deadline;
 184
 185     /*
 186      * Deadline at which we should send an ACK-eliciting packet to ensure
 187      * idle timeout does not occur.
 188      */
 189     OSSL_TIME                       ping_deadline;
 190
 191     /*
 192      * State tracking. QUIC connection-level state is best represented based on
 193      * whether various things have happened yet or not, rather than as an
 194      * explicit FSM. We do have a coarse state variable which tracks the basic
 195      * state of the connection's lifecycle, but more fine-grained conditions of
 196      * the Active state are tracked via flags below. For more details, see
 197      * doc/designs/quic-design/connection-state-machine.md. We are in the Open
 198      * state if the state is QUIC_CSM_STATE_ACTIVE and handshake_confirmed is
 199      * set.
 200      */
 201     unsigned int                    state                   : 3;
 202
 203     /*
 204      * Have we received at least one encrypted packet from the peer?
 205      * (If so, Retry and Version Negotiation messages should no longer
 206      *  be received and should be ignored if they do occur.)
 207      */
 208     unsigned int                    have_received_enc_pkt   : 1;
 209
 210     /*
 211      * Have we sent literally any packet yet? If not, there is no point polling
 212      * RX.
 213      */
 214     unsigned int                    have_sent_any_pkt       : 1;
 215
 216     /*
 217      * Are we currently doing proactive version negotiation?
 218      */
 219     unsigned int                    doing_proactive_ver_neg : 1;
 220
 221     /* We have received transport parameters from the peer. */
 222     unsigned int                    got_remote_transport_params    : 1;
 223
 224     /*
 225      * This monotonically transitions to 1 once the TLS state machine is
 226      * 'complete', meaning that it has both sent a Finished and successfully
 227      * verified the peer's Finished (see RFC 9001 s. 4.1.1). Note that it
 228      * does not transition to 1 at both peers simultaneously.
 229      *
 230      * Handshake completion is not the same as handshake confirmation (see
 231      * below).
 232      */
 233     unsigned int                    handshake_complete      : 1;
 234
 235     /*
 236      * This monotonically transitions to 1 once the handshake is confirmed.
 237      * This happens on the client when we receive a HANDSHAKE_DONE frame.
 238      * At our option, we may also take acknowledgement of any 1-RTT packet
 239      * we sent as a handshake confirmation.
 240      */
 241     unsigned int                    handshake_confirmed     : 1;
 242
 243     /*
 244      * We are sending Initial packets based on a Retry. This means we definitely
 245      * should not receive another Retry, and if we do it is an error.
 246      */
 247     unsigned int                    doing_retry             : 1;
 248
 249     /*
 250      * We don't store the current EL here; the TXP asks the QTX which ELs
 251      * are provisioned to determine which ELs to use.
 252      */
 253
 254     /* Have statm, qsm been initialised? Used to track cleanup. */
 255     unsigned int                    have_statm              : 1;
 256     unsigned int                    have_qsm                : 1;
 257
 258     /*
 259      * Preferred ELs for transmission and reception. This is not strictly needed
 260      * as it can be inferred from what keys we have provisioned, but makes
 261      * determining the current EL simpler and faster. A separate EL for
 262      * transmission and reception is not strictly necessary but makes things
 263      * easier for interoperation with the handshake layer, which likes to invoke
 264      * the yield secret callback at different times for TX and RX.
 265      */
 266     unsigned int                    tx_enc_level            : 3;
 267     unsigned int                    rx_enc_level            : 3;
 268
 269     /* If bit n is set, EL n has been discarded. */
 270     unsigned int                    el_discarded            : 4;
 271
 272     /*
 273      * While in TERMINATING - CLOSING, set when we should generate a connection
 274      * close frame.
 275      */
 276     unsigned int                    conn_close_queued       : 1;
 277
 278     /* Are we in server mode? Never changes after instantiation. */
 279     unsigned int                    is_server               : 1;
 280
 281     /*
 282      * Set temporarily when the handshake layer has given us a new RX secret.
 283      * Used to determine if we need to check our RX queues again.
 284      */
 285     unsigned int                    have_new_rx_secret      : 1;
 286
 287     /*
 288      * Have we sent an ack-eliciting packet since the last successful packet
 289      * reception? Used to determine when to bump idle timer (see RFC 9000 s.
 290      * 10.1).
 291      */
 292     unsigned int                    have_sent_ack_eliciting_since_rx    : 1;
 293 };
 294
 295 # endif
 296
 297 #endif