One Level Up Top Level

src/event/quic/ngx_event_quic.h - nginx

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Nginx, Inc.
  4. */


  7. #ifndef _NGX_EVENT_QUIC_H_INCLUDED_
  8. ‌#define _NGX_EVENT_QUIC_H_INCLUDED_


  11. #include <ngx_config.h>
  12. #include <ngx_core.h>


  15. #if (OPENSSL_VERSION_NUMBER >= 0x30500010L)
  16. ‌#define NGX_QUIC_OPENSSL_API                 1

  18. #elif (defined SSL_R_MISSING_QUIC_TRANSPORT_PARAMETERS_EXTENSION)
  19. ‌#define NGX_QUIC_QUICTLS_API                 1

  21. #elif (defined OPENSSL_IS_BORINGSSL || defined OPENSSL_IS_AWSLC               \
  22.        || defined LIBRESSL_VERSION_NUMBER)
  23. ‌#define NGX_QUIC_BORINGSSL_API               1

  25. #else
  26. ‌#define NGX_QUIC_BORINGSSL_API               1
  27. ‌#define NGX_QUIC_OPENSSL_COMPAT              1
  28. #endif


  31. ‌#define NGX_QUIC_MAX_UDP_PAYLOAD_SIZE        65527

  33. ‌#define NGX_QUIC_DEFAULT_ACK_DELAY_EXPONENT  3
  34. ‌#define NGX_QUIC_DEFAULT_MAX_ACK_DELAY       25
  35. ‌#define NGX_QUIC_DEFAULT_HOST_KEY_LEN        32
  36. ‌#define NGX_QUIC_SR_KEY_LEN                  32
  37. ‌#define NGX_QUIC_AV_KEY_LEN                  32

  39. ‌#define NGX_QUIC_SR_TOKEN_LEN                16

  41. ‌#define NGX_QUIC_MIN_INITIAL_SIZE            1200

  43. ‌#define NGX_QUIC_STREAM_SERVER_INITIATED     0x01
  44. ‌#define NGX_QUIC_STREAM_UNIDIRECTIONAL       0x02


  47. ‌typedef ngx_int_t (*ngx_quic_init_pt)(ngx_connection_t *c);
  48. ‌typedef void (*ngx_quic_shutdown_pt)(ngx_connection_t *c);


  51. ‌typedef enum {
  52.     NGX_QUIC_STREAM_SEND_READY = 0,
  53.     NGX_QUIC_STREAM_SEND_SEND,
  54.     NGX_QUIC_STREAM_SEND_DATA_SENT,
  55.     NGX_QUIC_STREAM_SEND_DATA_RECVD,
  56.     NGX_QUIC_STREAM_SEND_RESET_SENT,
  57.     NGX_QUIC_STREAM_SEND_RESET_RECVD
  58. ‌} ngx_quic_stream_send_state_e;


  61. ‌typedef enum {
  62.     NGX_QUIC_STREAM_RECV_RECV = 0,
  63.     NGX_QUIC_STREAM_RECV_SIZE_KNOWN,
  64.     NGX_QUIC_STREAM_RECV_DATA_RECVD,
  65.     NGX_QUIC_STREAM_RECV_DATA_READ,
  66.     NGX_QUIC_STREAM_RECV_RESET_RECVD,
  67.     NGX_QUIC_STREAM_RECV_RESET_READ
  68. ‌} ngx_quic_stream_recv_state_e;


  71. ‌typedef struct {
  72.     uint64_t                       size;
  73.     uint64_t                       offset;
  74.     uint64_t                       last_offset;
  75.     ngx_chain_t                   *chain;
  76.     ngx_chain_t                   *last_chain;
  77. ‌} ngx_quic_buffer_t;


  80. ‌typedef struct {
  81.     ngx_ssl_t                     *ssl;

  83.     ngx_flag_t                     retry;
  84.     ngx_flag_t                     gso_enabled;
  85.     ngx_flag_t                     disable_active_migration;
  86.     ngx_msec_t                     handshake_timeout;
  87.     ngx_msec_t                     idle_timeout;
  88.     ngx_str_t                      host_key;
  89.     size_t                         stream_buffer_size;
  90.     ngx_uint_t                     max_concurrent_streams_bidi;
  91.     ngx_uint_t                     max_concurrent_streams_uni;
  92.     ngx_uint_t                     active_connection_id_limit;
  93.     ngx_int_t                      stream_close_code;
  94.     ngx_int_t                      stream_reject_code_uni;
  95.     ngx_int_t                      stream_reject_code_bidi;

  97.     ngx_quic_init_pt               init;
  98.     ngx_quic_shutdown_pt           shutdown;

  100.     u_char                         av_token_key[NGX_QUIC_AV_KEY_LEN];
  101.     u_char                         sr_token_key[NGX_QUIC_SR_KEY_LEN];
  102. ‌} ngx_quic_conf_t;


  105. ‌struct ngx_quic_stream_s {
  106.     ngx_rbtree_node_t              node;
  107.     ngx_queue_t                    queue;
  108.     ngx_connection_t              *parent;
  109.     ngx_connection_t              *connection;
  110.     uint64_t                       id;
  111.     uint64_t                       sent;
  112.     uint64_t                       acked;
  113.     uint64_t                       send_max_data;
  114.     uint64_t                       send_offset;
  115.     uint64_t                       send_final_size;
  116.     uint64_t                       recv_max_data;
  117.     uint64_t                       recv_offset;
  118.     uint64_t                       recv_window;
  119.     uint64_t                       recv_last;
  120.     uint64_t                       recv_final_size;
  121.     ngx_quic_buffer_t              send;
  122.     ngx_quic_buffer_t              recv;
  123.     ngx_quic_stream_send_state_e   send_state;
  124.     ngx_quic_stream_recv_state_e   recv_state;
  125.     unsigned                       cancelable:1;
  126.     unsigned                       fin_acked:1;
  127. };


  130. void ngx_quic_recvmsg(ngx_event_t *ev);
  131. void ngx_quic_run(ngx_connection_t *c, ngx_quic_conf_t *conf);
  132. ngx_connection_t *ngx_quic_open_stream(ngx_connection_t *c, ngx_uint_t bidi);
  133. void ngx_quic_finalize_connection(ngx_connection_t *c, ngx_uint_t err,
  134.     const char *reason);
  135. void ngx_quic_shutdown_connection(ngx_connection_t *c, ngx_uint_t err,
  136.     const char *reason);
  137. ngx_int_t ngx_quic_reset_stream(ngx_connection_t *c, ngx_uint_t err);
  138. ngx_int_t ngx_quic_shutdown_stream(ngx_connection_t *c, int how);
  139. void ngx_quic_cancelable_stream(ngx_connection_t *c);
  140. ngx_int_t ngx_quic_get_packet_dcid(ngx_log_t *log, u_char *data, size_t len,
  141.     ngx_str_t *dcid);
  142. ngx_int_t ngx_quic_derive_key(ngx_log_t *log, const char *label,
  143.     ngx_str_t *secret, ngx_str_t *salt, u_char *out, size_t len);

  145. #endif /* _NGX_EVENT_QUIC_H_INCLUDED_ */

One Level Up Top Level