One Level Up Top Level

src/event/quic/ngx_event_quic_transport.h - nginx source code

Data types defined

Macros defined

Source code


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


  7. #ifndef _NGX_EVENT_QUIC_TRANSPORT_H_INCLUDED_
  8. ‌#define _NGX_EVENT_QUIC_TRANSPORT_H_INCLUDED_


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


  15. /*
  16. * RFC 9000, 17.2.  Long Header Packets
  17. *           17.3.  Short Header Packets
  18. *
  19. * QUIC flags in first byte
  20. */
  21. ‌#define NGX_QUIC_PKT_LONG       0x80  /* header form */
  22. ‌#define NGX_QUIC_PKT_FIXED_BIT  0x40
  23. ‌#define NGX_QUIC_PKT_TYPE       0x30  /* in long packet */
  24. ‌#define NGX_QUIC_PKT_KPHASE     0x04  /* in short packet */

  26. ‌#define ngx_quic_long_pkt(flags)  ((flags) & NGX_QUIC_PKT_LONG)
  27. ‌#define ngx_quic_short_pkt(flags)  (((flags) & NGX_QUIC_PKT_LONG) == 0)

  29. /* Long packet types */
  30. ‌#define NGX_QUIC_PKT_INITIAL    0x00
  31. ‌#define NGX_QUIC_PKT_ZRTT       0x10
  32. ‌#define NGX_QUIC_PKT_HANDSHAKE  0x20
  33. ‌#define NGX_QUIC_PKT_RETRY      0x30

  35. ‌#define ngx_quic_pkt_in(flags)                                                \
  36.     (((flags) & NGX_QUIC_PKT_TYPE) == NGX_QUIC_PKT_INITIAL)
  37. ‌#define ngx_quic_pkt_zrtt(flags)                                              \
  38.     (((flags) & NGX_QUIC_PKT_TYPE) == NGX_QUIC_PKT_ZRTT)
  39. ‌#define ngx_quic_pkt_hs(flags)                                                \
  40.     (((flags) & NGX_QUIC_PKT_TYPE) == NGX_QUIC_PKT_HANDSHAKE)
  41. ‌#define ngx_quic_pkt_retry(flags)                                             \
  42.     (((flags) & NGX_QUIC_PKT_TYPE) == NGX_QUIC_PKT_RETRY)

  44. ‌#define ngx_quic_pkt_rb_mask(flags)                                           \
  45.     (ngx_quic_long_pkt(flags) ? 0x0C : 0x18)
  46. ‌#define ngx_quic_pkt_hp_mask(flags)                                           \
  47.     (ngx_quic_long_pkt(flags) ? 0x0F : 0x1F)

  49. ‌#define ngx_quic_level_name(lvl)                                              \
  50.     (lvl == ssl_encryption_application) ? "app"                               \
  51.         : (lvl == ssl_encryption_initial) ? "init"                            \
  52.             : (lvl == ssl_encryption_handshake) ? "hs" : "early"

  54. ‌#define NGX_QUIC_MAX_CID_LEN                             20
  55. ‌#define NGX_QUIC_SERVER_CID_LEN                          NGX_QUIC_MAX_CID_LEN

  57. /* 12.4.  Frames and Frame Types */
  58. ‌#define NGX_QUIC_FT_PADDING                              0x00
  59. ‌#define NGX_QUIC_FT_PING                                 0x01
  60. ‌#define NGX_QUIC_FT_ACK                                  0x02
  61. ‌#define NGX_QUIC_FT_ACK_ECN                              0x03
  62. ‌#define NGX_QUIC_FT_RESET_STREAM                         0x04
  63. ‌#define NGX_QUIC_FT_STOP_SENDING                         0x05
  64. ‌#define NGX_QUIC_FT_CRYPTO                               0x06
  65. ‌#define NGX_QUIC_FT_NEW_TOKEN                            0x07
  66. ‌#define NGX_QUIC_FT_STREAM                               0x08
  67. ‌#define NGX_QUIC_FT_STREAM1                              0x09
  68. ‌#define NGX_QUIC_FT_STREAM2                              0x0A
  69. ‌#define NGX_QUIC_FT_STREAM3                              0x0B
  70. ‌#define NGX_QUIC_FT_STREAM4                              0x0C
  71. ‌#define NGX_QUIC_FT_STREAM5                              0x0D
  72. ‌#define NGX_QUIC_FT_STREAM6                              0x0E
  73. ‌#define NGX_QUIC_FT_STREAM7                              0x0F
  74. ‌#define NGX_QUIC_FT_MAX_DATA                             0x10
  75. ‌#define NGX_QUIC_FT_MAX_STREAM_DATA                      0x11
  76. ‌#define NGX_QUIC_FT_MAX_STREAMS                          0x12
  77. ‌#define NGX_QUIC_FT_MAX_STREAMS2                         0x13
  78. ‌#define NGX_QUIC_FT_DATA_BLOCKED                         0x14
  79. ‌#define NGX_QUIC_FT_STREAM_DATA_BLOCKED                  0x15
  80. ‌#define NGX_QUIC_FT_STREAMS_BLOCKED                      0x16
  81. ‌#define NGX_QUIC_FT_STREAMS_BLOCKED2                     0x17
  82. ‌#define NGX_QUIC_FT_NEW_CONNECTION_ID                    0x18
  83. ‌#define NGX_QUIC_FT_RETIRE_CONNECTION_ID                 0x19
  84. ‌#define NGX_QUIC_FT_PATH_CHALLENGE                       0x1A
  85. ‌#define NGX_QUIC_FT_PATH_RESPONSE                        0x1B
  86. ‌#define NGX_QUIC_FT_CONNECTION_CLOSE                     0x1C
  87. ‌#define NGX_QUIC_FT_CONNECTION_CLOSE_APP                 0x1D
  88. ‌#define NGX_QUIC_FT_HANDSHAKE_DONE                       0x1E

  90. ‌#define NGX_QUIC_FT_LAST  NGX_QUIC_FT_HANDSHAKE_DONE

  92. /* 22.5.  QUIC Transport Error Codes Registry */
  93. ‌#define NGX_QUIC_ERR_NO_ERROR                            0x00
  94. ‌#define NGX_QUIC_ERR_INTERNAL_ERROR                      0x01
  95. ‌#define NGX_QUIC_ERR_CONNECTION_REFUSED                  0x02
  96. ‌#define NGX_QUIC_ERR_FLOW_CONTROL_ERROR                  0x03
  97. ‌#define NGX_QUIC_ERR_STREAM_LIMIT_ERROR                  0x04
  98. ‌#define NGX_QUIC_ERR_STREAM_STATE_ERROR                  0x05
  99. ‌#define NGX_QUIC_ERR_FINAL_SIZE_ERROR                    0x06
  100. ‌#define NGX_QUIC_ERR_FRAME_ENCODING_ERROR                0x07
  101. ‌#define NGX_QUIC_ERR_TRANSPORT_PARAMETER_ERROR           0x08
  102. ‌#define NGX_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR           0x09
  103. ‌#define NGX_QUIC_ERR_PROTOCOL_VIOLATION                  0x0A
  104. ‌#define NGX_QUIC_ERR_INVALID_TOKEN                       0x0B
  105. ‌#define NGX_QUIC_ERR_APPLICATION_ERROR                   0x0C
  106. ‌#define NGX_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED              0x0D
  107. ‌#define NGX_QUIC_ERR_KEY_UPDATE_ERROR                    0x0E
  108. ‌#define NGX_QUIC_ERR_AEAD_LIMIT_REACHED                  0x0F
  109. ‌#define NGX_QUIC_ERR_NO_VIABLE_PATH                      0x10

  111. ‌#define NGX_QUIC_ERR_CRYPTO_ERROR                       0x100

  113. ‌#define NGX_QUIC_ERR_CRYPTO(e)  (NGX_QUIC_ERR_CRYPTO_ERROR + (e))


  116. /* 22.3.  QUIC Transport Parameters Registry */
  117. ‌#define NGX_QUIC_TP_ORIGINAL_DCID                        0x00
  118. ‌#define NGX_QUIC_TP_MAX_IDLE_TIMEOUT                     0x01
  119. ‌#define NGX_QUIC_TP_SR_TOKEN                             0x02
  120. ‌#define NGX_QUIC_TP_MAX_UDP_PAYLOAD_SIZE                 0x03
  121. ‌#define NGX_QUIC_TP_INITIAL_MAX_DATA                     0x04
  122. ‌#define NGX_QUIC_TP_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL   0x05
  123. ‌#define NGX_QUIC_TP_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE  0x06
  124. ‌#define NGX_QUIC_TP_INITIAL_MAX_STREAM_DATA_UNI          0x07
  125. ‌#define NGX_QUIC_TP_INITIAL_MAX_STREAMS_BIDI             0x08
  126. ‌#define NGX_QUIC_TP_INITIAL_MAX_STREAMS_UNI              0x09
  127. ‌#define NGX_QUIC_TP_ACK_DELAY_EXPONENT                   0x0A
  128. ‌#define NGX_QUIC_TP_MAX_ACK_DELAY                        0x0B
  129. ‌#define NGX_QUIC_TP_DISABLE_ACTIVE_MIGRATION             0x0C
  130. ‌#define NGX_QUIC_TP_PREFERRED_ADDRESS                    0x0D
  131. ‌#define NGX_QUIC_TP_ACTIVE_CONNECTION_ID_LIMIT           0x0E
  132. ‌#define NGX_QUIC_TP_INITIAL_SCID                         0x0F
  133. ‌#define NGX_QUIC_TP_RETRY_SCID                           0x10

  135. ‌#define NGX_QUIC_CID_LEN_MIN                                8
  136. ‌#define NGX_QUIC_CID_LEN_MAX                               20

  138. ‌#define NGX_QUIC_MAX_RANGES                                10


  141. ‌typedef struct {
  142.     uint64_t                                    gap;
  143.     uint64_t                                    range;
  144. ‌} ngx_quic_ack_range_t;


  147. ‌typedef struct {
  148.     uint64_t                                    largest;
  149.     uint64_t                                    delay;
  150.     uint64_t                                    range_count;
  151.     uint64_t                                    first_range;
  152.     uint64_t                                    ect0;
  153.     uint64_t                                    ect1;
  154.     uint64_t                                    ce;
  155.     uint64_t                                    ranges_length;
  156. ‌} ngx_quic_ack_frame_t;


  159. ‌typedef struct {
  160.     uint64_t                                    seqnum;
  161.     uint64_t                                    retire;
  162.     uint8_t                                     len;
  163.     u_char                                      cid[NGX_QUIC_CID_LEN_MAX];
  164.     u_char                                      srt[NGX_QUIC_SR_TOKEN_LEN];
  165. ‌} ngx_quic_new_conn_id_frame_t;


  168. ‌typedef struct {
  169.     uint64_t                                    length;
  170. ‌} ngx_quic_new_token_frame_t;

  172. /*
  173. * common layout for CRYPTO and STREAM frames;
  174. * conceptually, CRYPTO frame is also a stream
  175. * frame lacking some properties
  176. */
  177. ‌typedef struct {
  178.     uint64_t                                    offset;
  179.     uint64_t                                    length;
  180. ‌} ngx_quic_ordered_frame_t;

  182. ‌typedef ngx_quic_ordered_frame_t  ngx_quic_crypto_frame_t;


  185. ‌typedef struct {
  186.     /* initial fields same as in ngx_quic_ordered_frame_t */
  187.     uint64_t                                    offset;
  188.     uint64_t                                    length;

  190.     uint64_t                                    stream_id;
  191.     unsigned                                    off:1;
  192.     unsigned                                    len:1;
  193.     unsigned                                    fin:1;
  194. ‌} ngx_quic_stream_frame_t;


  197. ‌typedef struct {
  198.     uint64_t                                    max_data;
  199. ‌} ngx_quic_max_data_frame_t;


  202. ‌typedef struct {
  203.     uint64_t                                    error_code;
  204.     uint64_t                                    frame_type;
  205.     ngx_str_t                                   reason;
  206. ‌} ngx_quic_close_frame_t;


  209. ‌typedef struct {
  210.     uint64_t                                    id;
  211.     uint64_t                                    error_code;
  212.     uint64_t                                    final_size;
  213. ‌} ngx_quic_reset_stream_frame_t;


  216. ‌typedef struct {
  217.     uint64_t                                    id;
  218.     uint64_t                                    error_code;
  219. ‌} ngx_quic_stop_sending_frame_t;


  222. ‌typedef struct {
  223.     uint64_t                                    limit;
  224.     ngx_uint_t                                  bidi;  /* unsigned: bidi:1 */
  225. ‌} ngx_quic_streams_blocked_frame_t;


  228. ‌typedef struct {
  229.     uint64_t                                    limit;
  230.     ngx_uint_t                                  bidi;  /* unsigned: bidi:1 */
  231. ‌} ngx_quic_max_streams_frame_t;


  234. ‌typedef struct {
  235.     uint64_t                                    id;
  236.     uint64_t                                    limit;
  237. ‌} ngx_quic_max_stream_data_frame_t;


  240. ‌typedef struct {
  241.     uint64_t                                    limit;
  242. ‌} ngx_quic_data_blocked_frame_t;


  245. ‌typedef struct {
  246.     uint64_t                                    id;
  247.     uint64_t                                    limit;
  248. ‌} ngx_quic_stream_data_blocked_frame_t;


  251. ‌typedef struct {
  252.     uint64_t                                    sequence_number;
  253. ‌} ngx_quic_retire_cid_frame_t;


  256. ‌typedef struct {
  257.     u_char                                      data[8];
  258. ‌} ngx_quic_path_challenge_frame_t;


  261. ‌typedef struct ngx_quic_frame_s                 ngx_quic_frame_t;

  263. ‌struct ngx_quic_frame_s {
  264.     ngx_uint_t                                  type;
  265.     enum ssl_encryption_level_t                 level;
  266.     ngx_queue_t                                 queue;
  267.     uint64_t                                    pnum;
  268.     size_t                                      plen;
  269.     ngx_msec_t                                  send_time;
  270.     ssize_t                                     len;
  271.     unsigned                                    need_ack:1;
  272.     unsigned                                    pkt_need_ack:1;
  273.     unsigned                                    ignore_congestion:1;

  275.     ngx_chain_t                                *data;
  276. ‌    union {
  277.         ngx_quic_ack_frame_t                    ack;
  278.         ngx_quic_crypto_frame_t                 crypto;
  279.         ngx_quic_ordered_frame_t                ord;
  280.         ngx_quic_new_conn_id_frame_t            ncid;
  281.         ngx_quic_new_token_frame_t              token;
  282.         ngx_quic_stream_frame_t                 stream;
  283.         ngx_quic_max_data_frame_t               max_data;
  284.         ngx_quic_close_frame_t                  close;
  285.         ngx_quic_reset_stream_frame_t           reset_stream;
  286.         ngx_quic_stop_sending_frame_t           stop_sending;
  287.         ngx_quic_streams_blocked_frame_t        streams_blocked;
  288.         ngx_quic_max_streams_frame_t            max_streams;
  289.         ngx_quic_max_stream_data_frame_t        max_stream_data;
  290.         ngx_quic_data_blocked_frame_t           data_blocked;
  291.         ngx_quic_stream_data_blocked_frame_t    stream_data_blocked;
  292.         ngx_quic_retire_cid_frame_t             retire_cid;
  293.         ngx_quic_path_challenge_frame_t         path_challenge;
  294.         ngx_quic_path_challenge_frame_t         path_response;
  295.     } u;
  296. };


  299. ‌typedef struct {
  300.     ngx_log_t                                  *log;
  301.     ngx_quic_path_t                            *path;

  303.     ngx_quic_keys_t                            *keys;

  305.     ngx_msec_t                                  received;
  306.     uint64_t                                    number;
  307.     uint8_t                                     num_len;
  308.     uint32_t                                    trunc;
  309.     uint8_t                                     flags;
  310.     uint32_t                                    version;
  311.     ngx_str_t                                   token;
  312.     enum ssl_encryption_level_t                 level;
  313.     ngx_uint_t                                  error;

  315.     /* filled in by parser */
  316.     ngx_buf_t                                  *raw;   /* udp datagram */

  318.     u_char                                     *data;  /* quic packet */
  319.     size_t                                      len;

  321.     /* cleartext fields */
  322.     ngx_str_t                                   odcid; /* retry packet tag */
  323.     u_char                                      odcid_buf[NGX_QUIC_MAX_CID_LEN];
  324.     ngx_str_t                                   dcid;
  325.     ngx_str_t                                   scid;
  326.     uint64_t                                    pn;
  327.     u_char                                     *plaintext;
  328.     ngx_str_t                                   payload; /* decrypted data */

  330.     unsigned                                    need_ack:1;
  331.     unsigned                                    key_phase:1;
  332.     unsigned                                    key_update:1;
  333.     unsigned                                    parsed:1;
  334.     unsigned                                    decrypted:1;
  335.     unsigned                                    validated:1;
  336.     unsigned                                    retried:1;
  337.     unsigned                                    first:1;
  338.     unsigned                                    rebound:1;
  339.     unsigned                                    path_challenged:1;
  340. ‌} ngx_quic_header_t;


  343. ‌typedef struct {
  344.     ngx_msec_t                 max_idle_timeout;
  345.     ngx_msec_t                 max_ack_delay;

  347.     size_t                     max_udp_payload_size;
  348.     size_t                     initial_max_data;
  349.     size_t                     initial_max_stream_data_bidi_local;
  350.     size_t                     initial_max_stream_data_bidi_remote;
  351.     size_t                     initial_max_stream_data_uni;
  352.     ngx_uint_t                 initial_max_streams_bidi;
  353.     ngx_uint_t                 initial_max_streams_uni;
  354.     ngx_uint_t                 ack_delay_exponent;
  355.     ngx_uint_t                 active_connection_id_limit;
  356.     ngx_flag_t                 disable_active_migration;

  358.     ngx_str_t                  original_dcid;
  359.     ngx_str_t                  initial_scid;
  360.     ngx_str_t                  retry_scid;
  361.     u_char                     sr_token[NGX_QUIC_SR_TOKEN_LEN];

  363.     /* TODO */
  364.     void                      *preferred_address;
  365. ‌} ngx_quic_tp_t;


  368. ngx_int_t ngx_quic_parse_packet(ngx_quic_header_t *pkt);

  370. size_t ngx_quic_create_version_negotiation(ngx_quic_header_t *pkt, u_char *out);

  372. size_t ngx_quic_payload_size(ngx_quic_header_t *pkt, size_t pkt_len);

  374. size_t ngx_quic_create_header(ngx_quic_header_t *pkt, u_char *out,
  375.     u_char **pnp);

  377. size_t ngx_quic_create_retry_itag(ngx_quic_header_t *pkt, u_char *out,
  378.     u_char **start);

  380. ssize_t ngx_quic_parse_frame(ngx_quic_header_t *pkt, u_char *start, u_char *end,
  381.     ngx_quic_frame_t *frame);
  382. ssize_t ngx_quic_create_frame(u_char *p, ngx_quic_frame_t *f);

  384. ssize_t ngx_quic_parse_ack_range(ngx_log_t *log, u_char *start,
  385.     u_char *end, uint64_t *gap, uint64_t *range);
  386. size_t ngx_quic_create_ack_range(u_char *p, uint64_t gap, uint64_t range);

  388. ngx_int_t ngx_quic_init_transport_params(ngx_quic_tp_t *tp,
  389.     ngx_quic_conf_t *qcf);
  390. ngx_int_t ngx_quic_parse_transport_params(u_char *p, u_char *end,
  391.     ngx_quic_tp_t *tp, ngx_log_t *log);
  392. ssize_t ngx_quic_create_transport_params(u_char *p, u_char *end,
  393.     ngx_quic_tp_t *tp, size_t *clen);

  395. void ngx_quic_dcid_encode_key(u_char *dcid, uint64_t key);

  397. #endif /* _NGX_EVENT_QUIC_TRANSPORT_H_INCLUDED_ */

One Level Up Top Level