lws-quic.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
enum lws_tls_quic_secret_type {
        LWS_TLS_QUIC_SECRET_CLIENT_EARLY,
        LWS_TLS_QUIC_SECRET_CLIENT_HANDSHAKE,
        LWS_TLS_QUIC_SECRET_SERVER_HANDSHAKE,
        LWS_TLS_QUIC_SECRET_CLIENT_APPLICATION,
        LWS_TLS_QUIC_SECRET_SERVER_APPLICATION,
};
 
/*
 * RFC 9001 4.1 / 5.3 / 5.4: the QUIC packet-protection AEAD and the header-
 * protection cipher are both fixed by the negotiated TLS 1.3 cipher suite, and
 * cannot be inferred from the traffic-secret length alone (TLS_AES_128_GCM_
 * SHA256 and TLS_CHACHA20_POLY1305_SHA256 both use SHA-256 and so produce a
 * 32-byte secret).  The TLS backend reports the negotiated AEAD to the QUIC
 * role via wsi->tls.quic_aead so the correct algorithms are selected.
 */
enum lws_tls_quic_aead {
        LWS_TLS_QUIC_AEAD_UNKNOWN,         
        LWS_TLS_QUIC_AEAD_AES_128_GCM,     
        LWS_TLS_QUIC_AEAD_AES_256_GCM,     
        LWS_TLS_QUIC_AEAD_CHACHA20_POLY1305, 
};
 
enum lws_0rtt_status {
        LWS_0RTT_STATUS_NONE,       
        LWS_0RTT_STATUS_ATTEMPTED,  
        LWS_0RTT_STATUS_ACCEPTED,   
        LWS_0RTT_STATUS_REJECTED,   
};

typedef int (*lws_tls_quic_secret_cb)(struct lws *wsi,
                                      enum lws_tls_quic_secret_type type,
                                      const uint8_t *secret, size_t secret_len);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_init(struct lws *wsi, lws_tls_quic_secret_cb cb);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_advance_handshake(struct lws *wsi, int level,
                               const uint8_t *in, size_t in_len,
                               uint8_t *out, size_t *out_len);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_set_transport_parameters(struct lws *wsi, const uint8_t *tp, size_t tp_len);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_get_transport_parameters(struct lws *wsi, const uint8_t **tp, size_t *tp_len);

LWS_VISIBLE LWS_EXTERN enum lws_0rtt_status
lws_tls_0rtt_status(struct lws *wsi);

LWS_VISIBLE LWS_EXTERN int
lws_rx_is_early_data(struct lws *wsi);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_api_test(void);

LWS_VISIBLE LWS_EXTERN int
lws_tls_quic_migrate_wsi(struct lws *old_wsi, struct lws *new_wsi);

LWS_VISIBLE LWS_EXTERN int
lws_quic_initiate_key_update(struct lws *wsi);

LWS_VISIBLE LWS_EXTERN int
lws_quic_seal_client_initial(uint8_t *pkt, size_t len, size_t pn_offset,
                             uint8_t pn_len, uint64_t pn, const uint8_t *odcid,
                             size_t odcid_len);

LWS_VISIBLE LWS_EXTERN int
lws_quic_seal_packet(uint8_t *pkt, size_t len, size_t pn_offset,
                     uint8_t pn_len, uint64_t pn, enum lws_tls_quic_aead aead,
                     const uint8_t *secret, size_t secret_len,
                     unsigned int key_updates);
 
#if defined(LWS_WITH_FUZZERS)
typedef struct lws_quic_fuzz_taps {
        void (*secret)(struct lws *wsi, const uint8_t *peer_scid,
                       size_t peer_scid_len, enum lws_tls_quic_secret_type type,
                       enum lws_tls_quic_aead aead, const uint8_t *secret,
                       size_t secret_len);
        void (*crypto_tx)(struct lws *wsi, const uint8_t *peer_scid,
                          size_t peer_scid_len, int level, const uint8_t *buf,
                          size_t len);
} lws_quic_fuzz_taps_t;

LWS_VISIBLE LWS_EXTERN void
lws_quic_fuzz_set_taps(struct lws_context *cx,
                       const lws_quic_fuzz_taps_t *taps);
#endif

struct lws_cc_ops {
        void (*init)(struct lws *nwsi);
        void (*on_sent)(struct lws *nwsi, size_t bytes);
        void (*on_ack)(struct lws *nwsi, size_t bytes_acked, lws_usec_t rtt);
        void (*on_loss)(struct lws *nwsi, size_t bytes_lost);
        void (*on_discard)(struct lws *nwsi, size_t bytes_discarded);
        void (*on_persistent_congestion)(struct lws *nwsi);
        int  (*can_send)(struct lws *nwsi, size_t bytes);
        lws_usec_t (*get_pacing_delay)(struct lws *nwsi, size_t bytes_to_send);
};
 
LWS_VISIBLE LWS_EXTERN_FOR_DATA const struct lws_cc_ops lws_cc_ops_newreno;
LWS_VISIBLE LWS_EXTERN_FOR_DATA const struct lws_cc_ops lws_cc_ops_cubic;