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 /* Represents the cause for a connection's termination. */
   9 typedef struct quic_terminate_cause_st {
  10     /*
  11      * If we are in a TERMINATING or TERMINATED state, this is the error code
  12      * associated with the error. This field is valid iff we are in the
  13      * TERMINATING or TERMINATED states.
  14      */
  15     uint64_t                        error_code;
  16
  17     /*
  18      * If terminate_app is set and this is nonzero, this is the frame type which
  19      * caused the connection to be terminated.
  20      */
  21     uint64_t                        frame_type;
  22
  23     /* Is this error code in the transport (0) or application (1) space? */
  24     unsigned int                    app : 1;
  25
  26     /*
  27      * If set, the cause of the termination is a received CONNECTION_CLOSE
  28      * frame. Otherwise, we decided to terminate ourselves and sent a
  29      * CONNECTION_CLOSE frame (regardless of whether the peer later also sends
  30      * one).
  31      */
  32     unsigned int                    remote : 1;
  33 } QUIC_TERMINATE_CAUSE;
  34
  35 /*
  36  * QUIC Channel Structure
  37  * ======================
  38  *
  39  * QUIC channel internals. It is intended that only the QUIC_CHANNEL
  40  * implementation and the RX depacketiser be allowed to access this structure
  41  * directly. As the RX depacketiser has no state of its own and computes over a
  42  * QUIC_CHANNEL structure, it can be viewed as an extention of the QUIC_CHANNEL
  43  * implementation. While the RX depacketiser could be provided with adequate
  44  * accessors to do what it needs, this would weaken the abstraction provided by
  45  * the QUIC_CHANNEL to other components; moreover the coupling of the RX
  46  * depacketiser to QUIC_CHANNEL internals is too deep and bespoke to make this
  47  * desirable.
  48  *
  49  * Other components should not include this header.
  50  */
  51 struct quic_channel_st {
  52     OSSL_LIB_CTX                    *libctx;
  53     const char                      *propq;
  54
  55     /*
  56      * The associated TLS 1.3 connection data. Used to provide the handshake
  57      * layer; its 'network' side is plugged into the crypto stream for each EL
  58      * (other than the 0-RTT EL).
  59      */
  60     QUIC_TLS                        *qtls;
  61     SSL                             *tls;
  62
  63     /*
  64      * The transport parameter block we will send or have sent.
  65      * Freed after sending or when connection is freed.
  66      */
  67     unsigned char                   *local_transport_params;
  68
  69     /* Asynchronous I/O reactor. */
  70     QUIC_REACTOR                    rtor;
  71
  72     /* Our current L4 peer address, if any. */
  73     BIO_ADDR                        cur_peer_addr;
  74
  75     /* Network-side read and write BIOs. */
  76     BIO                             *net_rbio, *net_wbio;
  77
  78     /*
  79      * Subcomponents of the connection. All of these components are instantiated
  80      * and owned by us.
  81      */
  82     OSSL_QUIC_TX_PACKETISER         *txp;
  83     QUIC_TXPIM                      *txpim;
  84     QUIC_CFQ                        *cfq;
  85     /* Connection level FC. */
  86     QUIC_TXFC                       conn_txfc;
  87     QUIC_RXFC                       conn_rxfc;
  88     QUIC_STREAM_MAP                 qsm;
  89     OSSL_STATM                      statm;
  90     OSSL_CC_DATA                    *cc_data;
  91     const OSSL_CC_METHOD            *cc_method;
  92     OSSL_ACKM                       *ackm;
  93
  94     /*
  95      * RX demuxer. We register incoming DCIDs with this. Since we currently only
  96      * support client operation and use one L4 port per connection, we own the
  97      * demuxer and register a single zero-length DCID with it.
  98      */
  99     QUIC_DEMUX                      *demux;
 100
 101     /* Record layers in the TX and RX directions, plus the RX demuxer. */
 102     OSSL_QTX                        *qtx;
 103     OSSL_QRX                        *qrx;
 104
 105     /*
 106      * Send and receive parts of the crypto streams.
 107      * crypto_send[QUIC_PN_SPACE_APP] is the 1-RTT crypto stream. There is no
 108      * 0-RTT crypto stream.
 109      */
 110     QUIC_SSTREAM                    *crypto_send[QUIC_PN_SPACE_NUM];
 111     QUIC_RSTREAM                    *crypto_recv[QUIC_PN_SPACE_NUM];
 112
 113     /*
 114      * Our (currently only) application data stream. This is a bidirectional
 115      * client-initiated stream and thus (in QUICv1) always has a stream ID of 0.
 116      */
 117     QUIC_STREAM                     *stream0;
 118
 119     /* Internal state. */
 120     /*
 121      * Client: The DCID used in the first Initial packet we transmit as a client.
 122      * Server: The DCID used in the first Initial packet the client transmitted.
 123      * Randomly generated and required by RFC to be at least 8 bytes.
 124      */
 125     QUIC_CONN_ID                    init_dcid;
 126
 127     /*
 128      * Client: The SCID found in the first Initial packet from the server.
 129      * Not valid for servers.
 130      * Valid if have_received_enc_pkt is set.
 131      */
 132     QUIC_CONN_ID                    init_scid;
 133
 134     /*
 135      * Client only: The SCID found in an incoming Retry packet we handled.
 136      * Not valid for servers.
 137      */
 138     QUIC_CONN_ID                    retry_scid;
 139
 140     /* Server only: The DCID we currently use to talk to the peer. */
 141     QUIC_CONN_ID                    cur_remote_dcid;
 142     /* Server only: The DCID we currently expect the peer to use to talk to us. */
 143     QUIC_CONN_ID                    cur_local_dcid;
 144
 145     /* Transport parameter values received from server. */
 146     uint64_t                        init_max_stream_data_bidi_local;
 147     uint64_t                        init_max_stream_data_bidi_remote;
 148     uint64_t                        init_max_stream_data_uni_remote;
 149     uint64_t                        rx_max_ack_delay; /* ms */
 150     unsigned char                   rx_ack_delay_exp;
 151
 152     /*
 153      * Temporary staging area to store information about the incoming packet we
 154      * are currently processing.
 155      */
 156     OSSL_QRX_PKT                    *qrx_pkt;
 157
 158     /*
 159      * Current limit on number of streams we may create. Set by transport
 160      * parameters initially and then by MAX_STREAMS frames.
 161      */
 162     uint64_t                        max_local_streams_bidi;
 163     uint64_t                        max_local_streams_uni;
 164
 165     /* The negotiated maximum idle timeout in milliseconds. */
 166     uint64_t                        max_idle_timeout;
 167
 168     /*
 169      * Maximum payload size in bytes for datagrams sent to our peer, as
 170      * negotiated by transport parameters.
 171      */
 172     uint64_t                        rx_max_udp_payload_size;
 173     /* Maximum active CID limit, as negotiated by transport parameters. */
 174     uint64_t                        rx_active_conn_id_limit;
 175
 176     /* Valid if we are in the TERMINATING or TERMINATED states. */
 177     QUIC_TERMINATE_CAUSE            terminate_cause;
 178
 179     /*
 180      * Deadline at which we move to TERMINATING state. Valid if in the
 181      * TERMINATING state.
 182      */
 183     OSSL_TIME                       terminate_deadline;
 184
 185     /*
 186      * Deadline at which connection dies due to idle timeout if no further
 187      * events occur.
 188      */
 189     OSSL_TIME                       idle_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 # endif
 289
 290 #endif