src/event/quic/ngx_event_quic_protection.c - nginx

Functions defined

Macros defined

Source code


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


  4. #include <ngx_config.h>
  5. #include <ngx_core.h>
  6. #include <ngx_event.h>
  7. #include <ngx_event_quic_connection.h>
  8. #if (NGX_QUIC_BORINGSSL_EVP_API)
  9. #include <openssl/hkdf.h>
  10. #include <openssl/chacha.h>
  11. #else
  12. #include <openssl/kdf.h>
  13. #endif


  14. /* RFC 9001, 5.4.1.  Header Protection Application: 5-byte mask */
  15. #define NGX_QUIC_HP_LEN               5

  16. #define NGX_QUIC_AES_128_KEY_LEN      16

  17. #define NGX_QUIC_INITIAL_CIPHER       TLS1_3_CK_AES_128_GCM_SHA256


  18. #define ngx_quic_md(str)     { sizeof(str) - 1, str }


  19. static ngx_int_t ngx_hkdf_expand(u_char *out_key, size_t out_len,
  20.     const EVP_MD *digest, const u_char *prk, size_t prk_len,
  21.     const u_char *info, size_t info_len);
  22. static ngx_int_t ngx_hkdf_extract(u_char *out_key, size_t *out_len,
  23.     const EVP_MD *digest, const u_char *secret, size_t secret_len,
  24.     const u_char *salt, size_t salt_len);

  25. static uint64_t ngx_quic_parse_pn(u_char **pos, ngx_int_t len, u_char *mask,
  26.     uint64_t *largest_pn);

  27. static ngx_int_t ngx_quic_crypto_open(ngx_quic_secret_t *s, ngx_str_t *out,
  28.     const u_char *nonce, ngx_str_t *in, ngx_str_t *ad, ngx_log_t *log);
  29. #if !(NGX_QUIC_BORINGSSL_EVP_API)
  30. static ngx_int_t ngx_quic_crypto_common(ngx_quic_secret_t *s, ngx_str_t *out,
  31.     const u_char *nonce, ngx_str_t *in, ngx_str_t *ad, ngx_log_t *log);
  32. #endif

  33. static ngx_int_t ngx_quic_crypto_hp_init(const EVP_CIPHER *cipher,
  34.     ngx_quic_secret_t *s, ngx_log_t *log);
  35. static ngx_int_t ngx_quic_crypto_hp(ngx_quic_secret_t *s,
  36.     u_char *out, u_char *in, ngx_log_t *log);
  37. static void ngx_quic_crypto_hp_cleanup(ngx_quic_secret_t *s);

  38. static ngx_int_t ngx_quic_create_packet(ngx_quic_header_t *pkt,
  39.     ngx_str_t *res);
  40. static ngx_int_t ngx_quic_create_retry_packet(ngx_quic_header_t *pkt,
  41.     ngx_str_t *res);


  42. ngx_int_t
  43. ngx_quic_ciphers(ngx_uint_t id, ngx_quic_ciphers_t *ciphers)
  44. {
  45.     ngx_int_t  len;

  46.     switch (id) {

  47.     case TLS1_3_CK_AES_128_GCM_SHA256:
  48. #if (NGX_QUIC_BORINGSSL_EVP_API)
  49.         ciphers->c = EVP_aead_aes_128_gcm();
  50. #else
  51.         ciphers->c = EVP_aes_128_gcm();
  52. #endif
  53.         ciphers->hp = EVP_aes_128_ctr();
  54.         ciphers->d = EVP_sha256();
  55.         len = 16;
  56.         break;

  57.     case TLS1_3_CK_AES_256_GCM_SHA384:
  58. #if (NGX_QUIC_BORINGSSL_EVP_API)
  59.         ciphers->c = EVP_aead_aes_256_gcm();
  60. #else
  61.         ciphers->c = EVP_aes_256_gcm();
  62. #endif
  63.         ciphers->hp = EVP_aes_256_ctr();
  64.         ciphers->d = EVP_sha384();
  65.         len = 32;
  66.         break;

  67.     case TLS1_3_CK_CHACHA20_POLY1305_SHA256:
  68. #if (NGX_QUIC_BORINGSSL_EVP_API)
  69.         ciphers->c = EVP_aead_chacha20_poly1305();
  70. #else
  71.         ciphers->c = EVP_chacha20_poly1305();
  72. #endif
  73. #if (NGX_QUIC_BORINGSSL_EVP_API)
  74.         ciphers->hp = (const EVP_CIPHER *) EVP_aead_chacha20_poly1305();
  75. #else
  76.         ciphers->hp = EVP_chacha20();
  77. #endif
  78.         ciphers->d = EVP_sha256();
  79.         len = 32;
  80.         break;

  81. #if !(NGX_QUIC_BORINGSSL_EVP_API)
  82.     case TLS1_3_CK_AES_128_CCM_SHA256:
  83.         ciphers->c = EVP_aes_128_ccm();
  84.         ciphers->hp = EVP_aes_128_ctr();
  85.         ciphers->d = EVP_sha256();
  86.         len = 16;
  87.         break;
  88. #endif

  89.     default:
  90.         return NGX_ERROR;
  91.     }

  92.     return len;
  93. }


  94. ngx_int_t
  95. ngx_quic_keys_set_initial_secret(ngx_quic_keys_t *keys, ngx_str_t *secret,
  96.     ngx_log_t *log)
  97. {
  98.     size_t               is_len;
  99.     uint8_t              is[SHA256_DIGEST_LENGTH];
  100.     ngx_str_t            iss;
  101.     ngx_uint_t           i;
  102.     const EVP_MD        *digest;
  103.     ngx_quic_md_t        client_key, server_key;
  104.     ngx_quic_hkdf_t      seq[8];
  105.     ngx_quic_secret_t   *client, *server;
  106.     ngx_quic_ciphers_t   ciphers;

  107.     static const uint8_t salt[20] = {
  108.         0x38, 0x76, 0x2c, 0xf7, 0xf5, 0x59, 0x34, 0xb3, 0x4d, 0x17,
  109.         0x9a, 0xe6, 0xa4, 0xc8, 0x0c, 0xad, 0xcc, 0xbb, 0x7f, 0x0a
  110.     };

  111.     client = &keys->secrets[NGX_QUIC_ENCRYPTION_INITIAL].client;
  112.     server = &keys->secrets[NGX_QUIC_ENCRYPTION_INITIAL].server;

  113.     /*
  114.      * RFC 9001, section 5.  Packet Protection
  115.      *
  116.      * Initial packets use AEAD_AES_128_GCM.  The hash function
  117.      * for HKDF when deriving initial secrets and keys is SHA-256.
  118.      */

  119.     digest = EVP_sha256();
  120.     is_len = SHA256_DIGEST_LENGTH;

  121.     if (ngx_hkdf_extract(is, &is_len, digest, secret->data, secret->len,
  122.                          salt, sizeof(salt))
  123.         != NGX_OK)
  124.     {
  125.         return NGX_ERROR;
  126.     }

  127.     iss.len = is_len;
  128.     iss.data = is;

  129.     ngx_log_debug0(NGX_LOG_DEBUG_EVENT, log, 0,
  130.                    "quic ngx_quic_set_initial_secret");
  131. #ifdef NGX_QUIC_DEBUG_CRYPTO
  132.     ngx_log_debug3(NGX_LOG_DEBUG_EVENT, log, 0,
  133.                    "quic salt len:%uz %*xs", sizeof(salt), sizeof(salt), salt);
  134.     ngx_log_debug3(NGX_LOG_DEBUG_EVENT, log, 0,
  135.                    "quic initial secret len:%uz %*xs", is_len, is_len, is);
  136. #endif

  137.     client->secret.len = SHA256_DIGEST_LENGTH;
  138.     server->secret.len = SHA256_DIGEST_LENGTH;

  139.     client_key.len = NGX_QUIC_AES_128_KEY_LEN;
  140.     server_key.len = NGX_QUIC_AES_128_KEY_LEN;

  141.     client->hp.len = NGX_QUIC_AES_128_KEY_LEN;
  142.     server->hp.len = NGX_QUIC_AES_128_KEY_LEN;

  143.     client->iv.len = NGX_QUIC_IV_LEN;
  144.     server->iv.len = NGX_QUIC_IV_LEN;

  145.     /* labels per RFC 9001, 5.1. Packet Protection Keys */
  146.     ngx_quic_hkdf_set(&seq[0], "tls13 client in", &client->secret, &iss);
  147.     ngx_quic_hkdf_set(&seq[1], "tls13 quic key", &client_key, &client->secret);
  148.     ngx_quic_hkdf_set(&seq[2], "tls13 quic iv", &client->iv, &client->secret);
  149.     ngx_quic_hkdf_set(&seq[3], "tls13 quic hp", &client->hp, &client->secret);
  150.     ngx_quic_hkdf_set(&seq[4], "tls13 server in", &server->secret, &iss);
  151.     ngx_quic_hkdf_set(&seq[5], "tls13 quic key", &server_key, &server->secret);
  152.     ngx_quic_hkdf_set(&seq[6], "tls13 quic iv", &server->iv, &server->secret);
  153.     ngx_quic_hkdf_set(&seq[7], "tls13 quic hp", &server->hp, &server->secret);

  154.     for (i = 0; i < (sizeof(seq) / sizeof(seq[0])); i++) {
  155.         if (ngx_quic_hkdf_expand(&seq[i], digest, log) != NGX_OK) {
  156.             return NGX_ERROR;
  157.         }
  158.     }

  159.     if (ngx_quic_ciphers(NGX_QUIC_INITIAL_CIPHER, &ciphers) == NGX_ERROR) {
  160.         return NGX_ERROR;
  161.     }

  162.     if (ngx_quic_crypto_init(ciphers.c, client, &client_key, 0, log)
  163.         == NGX_ERROR)
  164.     {
  165.         return NGX_ERROR;
  166.     }

  167.     if (ngx_quic_crypto_init(ciphers.c, server, &server_key, 1, log)
  168.         == NGX_ERROR)
  169.     {
  170.         goto failed;
  171.     }

  172.     if (ngx_quic_crypto_hp_init(ciphers.hp, client, log) == NGX_ERROR) {
  173.         goto failed;
  174.     }

  175.     if (ngx_quic_crypto_hp_init(ciphers.hp, server, log) == NGX_ERROR) {
  176.         goto failed;
  177.     }

  178.     return NGX_OK;

  179. failed:

  180.     ngx_quic_keys_cleanup(keys);

  181.     return NGX_ERROR;
  182. }


  183. ngx_int_t
  184. ngx_quic_hkdf_expand(ngx_quic_hkdf_t *h, const EVP_MD *digest, ngx_log_t *log)
  185. {
  186.     size_t    info_len;
  187.     uint8_t  *p;
  188.     uint8_t   info[20];

  189.     info_len = 2 + 1 + h->label_len + 1;

  190.     info[0] = 0;
  191.     info[1] = h->out_len;
  192.     info[2] = h->label_len;

  193.     p = ngx_cpymem(&info[3], h->label, h->label_len);
  194.     *p = '\0';

  195.     if (ngx_hkdf_expand(h->out, h->out_len, digest,
  196.                         h->prk, h->prk_len, info, info_len)
  197.         != NGX_OK)
  198.     {
  199.         ngx_ssl_error(NGX_LOG_INFO, log, 0,
  200.                       "ngx_hkdf_expand(%*s) failed", h->label_len, h->label);
  201.         return NGX_ERROR;
  202.     }

  203. #ifdef NGX_QUIC_DEBUG_CRYPTO
  204.     ngx_log_debug5(NGX_LOG_DEBUG_EVENT, log, 0,
  205.                    "quic expand \"%*s\" len:%uz %*xs",
  206.                    h->label_len, h->label, h->out_len, h->out_len, h->out);
  207. #endif

  208.     return NGX_OK;
  209. }


  210. static ngx_int_t
  211. ngx_hkdf_expand(u_char *out_key, size_t out_len, const EVP_MD *digest,
  212.     const uint8_t *prk, size_t prk_len, const u_char *info, size_t info_len)
  213. {
  214. #if (NGX_QUIC_BORINGSSL_EVP_API)

  215.     if (HKDF_expand(out_key, out_len, digest, prk, prk_len, info, info_len)
  216.         == 0)
  217.     {
  218.         return NGX_ERROR;
  219.     }

  220.     return NGX_OK;

  221. #else

  222.     EVP_PKEY_CTX  *pctx;

  223.     pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL);
  224.     if (pctx == NULL) {
  225.         return NGX_ERROR;
  226.     }

  227.     if (EVP_PKEY_derive_init(pctx) <= 0) {
  228.         goto failed;
  229.     }

  230.     if (EVP_PKEY_CTX_hkdf_mode(pctx, EVP_PKEY_HKDEF_MODE_EXPAND_ONLY) <= 0) {
  231.         goto failed;
  232.     }

  233.     if (EVP_PKEY_CTX_set_hkdf_md(pctx, digest) <= 0) {
  234.         goto failed;
  235.     }

  236.     if (EVP_PKEY_CTX_set1_hkdf_key(pctx, prk, prk_len) <= 0) {
  237.         goto failed;
  238.     }

  239.     if (EVP_PKEY_CTX_add1_hkdf_info(pctx, info, info_len) <= 0) {
  240.         goto failed;
  241.     }

  242.     if (EVP_PKEY_derive(pctx, out_key, &out_len) <= 0) {
  243.         goto failed;
  244.     }

  245.     EVP_PKEY_CTX_free(pctx);

  246.     return NGX_OK;

  247. failed:

  248.     EVP_PKEY_CTX_free(pctx);

  249.     return NGX_ERROR;

  250. #endif
  251. }


  252. static ngx_int_t
  253. ngx_hkdf_extract(u_char *out_key, size_t *out_len, const EVP_MD *digest,
  254.     const u_char *secret, size_t secret_len, const u_char *salt,
  255.     size_t salt_len)
  256. {
  257. #if (NGX_QUIC_BORINGSSL_EVP_API)

  258.     if (HKDF_extract(out_key, out_len, digest, secret, secret_len, salt,
  259.                      salt_len)
  260.         == 0)
  261.     {
  262.         return NGX_ERROR;
  263.     }

  264.     return NGX_OK;

  265. #else

  266.     EVP_PKEY_CTX  *pctx;

  267.     pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL);
  268.     if (pctx == NULL) {
  269.         return NGX_ERROR;
  270.     }

  271.     if (EVP_PKEY_derive_init(pctx) <= 0) {
  272.         goto failed;
  273.     }

  274.     if (EVP_PKEY_CTX_hkdf_mode(pctx, EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY) <= 0) {
  275.         goto failed;
  276.     }

  277.     if (EVP_PKEY_CTX_set_hkdf_md(pctx, digest) <= 0) {
  278.         goto failed;
  279.     }

  280.     if (EVP_PKEY_CTX_set1_hkdf_key(pctx, secret, secret_len) <= 0) {
  281.         goto failed;
  282.     }

  283.     if (EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, salt_len) <= 0) {
  284.         goto failed;
  285.     }

  286.     if (EVP_PKEY_derive(pctx, out_key, out_len) <= 0) {
  287.         goto failed;
  288.     }

  289.     EVP_PKEY_CTX_free(pctx);

  290.     return NGX_OK;

  291. failed:

  292.     EVP_PKEY_CTX_free(pctx);

  293.     return NGX_ERROR;

  294. #endif
  295. }


  296. ngx_int_t
  297. ngx_quic_crypto_init(const ngx_quic_cipher_t *cipher, ngx_quic_secret_t *s,
  298.     ngx_quic_md_t *key, ngx_int_t enc, ngx_log_t *log)
  299. {

  300. #if (NGX_QUIC_BORINGSSL_EVP_API)
  301.     EVP_AEAD_CTX  *ctx;

  302.     ctx = EVP_AEAD_CTX_new(cipher, key->data, key->len,
  303.                            EVP_AEAD_DEFAULT_TAG_LENGTH);
  304.     if (ctx == NULL) {
  305.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_AEAD_CTX_new() failed");
  306.         return NGX_ERROR;
  307.     }
  308. #else
  309.     EVP_CIPHER_CTX  *ctx;

  310.     ctx = EVP_CIPHER_CTX_new();
  311.     if (ctx == NULL) {
  312.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CIPHER_CTX_new() failed");
  313.         return NGX_ERROR;
  314.     }

  315.     if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, enc) != 1) {
  316.         EVP_CIPHER_CTX_free(ctx);
  317.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherInit_ex() failed");
  318.         return NGX_ERROR;
  319.     }

  320.     if (EVP_CIPHER_mode(cipher) == EVP_CIPH_CCM_MODE
  321.         && EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, NGX_QUIC_TAG_LEN,
  322.                                NULL)
  323.            == 0)
  324.     {
  325.         EVP_CIPHER_CTX_free(ctx);
  326.         ngx_ssl_error(NGX_LOG_INFO, log, 0,
  327.                       "EVP_CIPHER_CTX_ctrl(EVP_CTRL_AEAD_SET_TAG) failed");
  328.         return NGX_ERROR;
  329.     }

  330.     if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, s->iv.len, NULL)
  331.         == 0)
  332.     {
  333.         EVP_CIPHER_CTX_free(ctx);
  334.         ngx_ssl_error(NGX_LOG_INFO, log, 0,
  335.                       "EVP_CIPHER_CTX_ctrl(EVP_CTRL_AEAD_SET_IVLEN) failed");
  336.         return NGX_ERROR;
  337.     }

  338.     if (EVP_CipherInit_ex(ctx, NULL, NULL, key->data, NULL, enc) != 1) {
  339.         EVP_CIPHER_CTX_free(ctx);
  340.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherInit_ex() failed");
  341.         return NGX_ERROR;
  342.     }
  343. #endif

  344.     s->ctx = ctx;
  345.     return NGX_OK;
  346. }


  347. static ngx_int_t
  348. ngx_quic_crypto_open(ngx_quic_secret_t *s, ngx_str_t *out, const u_char *nonce,
  349.     ngx_str_t *in, ngx_str_t *ad, ngx_log_t *log)
  350. {
  351. #if (NGX_QUIC_BORINGSSL_EVP_API)
  352.     if (EVP_AEAD_CTX_open(s->ctx, out->data, &out->len, out->len, nonce,
  353.                           s->iv.len, in->data, in->len, ad->data, ad->len)
  354.         != 1)
  355.     {
  356.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_AEAD_CTX_open() failed");
  357.         return NGX_ERROR;
  358.     }

  359.     return NGX_OK;
  360. #else
  361.     return ngx_quic_crypto_common(s, out, nonce, in, ad, log);
  362. #endif
  363. }


  364. ngx_int_t
  365. ngx_quic_crypto_seal(ngx_quic_secret_t *s, ngx_str_t *out, const u_char *nonce,
  366.     ngx_str_t *in, ngx_str_t *ad, ngx_log_t *log)
  367. {
  368. #if (NGX_QUIC_BORINGSSL_EVP_API)
  369.     if (EVP_AEAD_CTX_seal(s->ctx, out->data, &out->len, out->len, nonce,
  370.                           s->iv.len, in->data, in->len, ad->data, ad->len)
  371.         != 1)
  372.     {
  373.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_AEAD_CTX_seal() failed");
  374.         return NGX_ERROR;
  375.     }

  376.     return NGX_OK;
  377. #else
  378.     return ngx_quic_crypto_common(s, out, nonce, in, ad, log);
  379. #endif
  380. }


  381. #if !(NGX_QUIC_BORINGSSL_EVP_API)

  382. static ngx_int_t
  383. ngx_quic_crypto_common(ngx_quic_secret_t *s, ngx_str_t *out,
  384.     const u_char *nonce, ngx_str_t *in, ngx_str_t *ad, ngx_log_t *log)
  385. {
  386.     int                     len, enc;
  387.     ngx_quic_crypto_ctx_t  *ctx;

  388.     ctx = s->ctx;
  389.     enc = EVP_CIPHER_CTX_encrypting(ctx);

  390.     if (EVP_CipherInit_ex(ctx, NULL, NULL, NULL, nonce, enc) != 1) {
  391.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherInit_ex() failed");
  392.         return NGX_ERROR;
  393.     }

  394.     if (enc == 0) {
  395.         in->len -= NGX_QUIC_TAG_LEN;

  396.         if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, NGX_QUIC_TAG_LEN,
  397.                                 in->data + in->len)
  398.             == 0)
  399.         {
  400.             ngx_ssl_error(NGX_LOG_INFO, log, 0,
  401.                           "EVP_CIPHER_CTX_ctrl(EVP_CTRL_AEAD_SET_TAG) failed");
  402.             return NGX_ERROR;
  403.         }
  404.     }

  405.     if (EVP_CIPHER_mode(EVP_CIPHER_CTX_cipher(ctx)) == EVP_CIPH_CCM_MODE
  406.         && EVP_CipherUpdate(ctx, NULL, &len, NULL, in->len) != 1)
  407.     {
  408.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherUpdate() failed");
  409.         return NGX_ERROR;
  410.     }

  411.     if (EVP_CipherUpdate(ctx, NULL, &len, ad->data, ad->len) != 1) {
  412.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherUpdate() failed");
  413.         return NGX_ERROR;
  414.     }

  415.     if (EVP_CipherUpdate(ctx, out->data, &len, in->data, in->len) != 1) {
  416.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherUpdate() failed");
  417.         return NGX_ERROR;
  418.     }

  419.     out->len = len;

  420.     if (EVP_CipherFinal_ex(ctx, out->data + out->len, &len) <= 0) {
  421.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CipherFinal_ex failed");
  422.         return NGX_ERROR;
  423.     }

  424.     out->len += len;

  425.     if (enc == 1) {
  426.         if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, NGX_QUIC_TAG_LEN,
  427.                                 out->data + out->len)
  428.             == 0)
  429.         {
  430.             ngx_ssl_error(NGX_LOG_INFO, log, 0,
  431.                           "EVP_CIPHER_CTX_ctrl(EVP_CTRL_AEAD_GET_TAG) failed");
  432.             return NGX_ERROR;
  433.         }

  434.         out->len += NGX_QUIC_TAG_LEN;
  435.     }

  436.     return NGX_OK;
  437. }

  438. #endif


  439. void
  440. ngx_quic_crypto_cleanup(ngx_quic_secret_t *s)
  441. {
  442.     if (s->ctx) {
  443. #if (NGX_QUIC_BORINGSSL_EVP_API)
  444.         EVP_AEAD_CTX_free(s->ctx);
  445. #else
  446.         EVP_CIPHER_CTX_free(s->ctx);
  447. #endif
  448.         s->ctx = NULL;
  449.     }
  450. }


  451. static ngx_int_t
  452. ngx_quic_crypto_hp_init(const EVP_CIPHER *cipher, ngx_quic_secret_t *s,
  453.     ngx_log_t *log)
  454. {
  455.     EVP_CIPHER_CTX  *ctx;

  456. #if (NGX_QUIC_BORINGSSL_EVP_API)
  457.     if (cipher == (EVP_CIPHER *) EVP_aead_chacha20_poly1305()) {
  458.         /* no EVP interface */
  459.         s->hp_ctx = NULL;
  460.         return NGX_OK;
  461.     }
  462. #endif

  463.     ctx = EVP_CIPHER_CTX_new();
  464.     if (ctx == NULL) {
  465.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_CIPHER_CTX_new() failed");
  466.         return NGX_ERROR;
  467.     }

  468.     if (EVP_EncryptInit_ex(ctx, cipher, NULL, s->hp.data, NULL) != 1) {
  469.         EVP_CIPHER_CTX_free(ctx);
  470.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_EncryptInit_ex() failed");
  471.         return NGX_ERROR;
  472.     }

  473.     s->hp_ctx = ctx;
  474.     return NGX_OK;
  475. }


  476. static ngx_int_t
  477. ngx_quic_crypto_hp(ngx_quic_secret_t *s, u_char *out, u_char *in,
  478.     ngx_log_t *log)
  479. {
  480.     int              outlen;
  481.     EVP_CIPHER_CTX  *ctx;

  482.     static const u_char zero[NGX_QUIC_HP_LEN];

  483.     ctx = s->hp_ctx;

  484. #if (NGX_QUIC_BORINGSSL_EVP_API)
  485.     uint32_t         cnt;

  486.     if (ctx == NULL) {
  487.         ngx_memcpy(&cnt, in, sizeof(uint32_t));
  488.         CRYPTO_chacha_20(out, zero, NGX_QUIC_HP_LEN, s->hp.data, &in[4], cnt);
  489.         return NGX_OK;
  490.     }
  491. #endif

  492.     if (EVP_EncryptInit_ex(ctx, NULL, NULL, NULL, in) != 1) {
  493.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_EncryptInit_ex() failed");
  494.         return NGX_ERROR;
  495.     }

  496.     if (!EVP_EncryptUpdate(ctx, out, &outlen, zero, NGX_QUIC_HP_LEN)) {
  497.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_EncryptUpdate() failed");
  498.         return NGX_ERROR;
  499.     }

  500.     if (!EVP_EncryptFinal_ex(ctx, out + NGX_QUIC_HP_LEN, &outlen)) {
  501.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "EVP_EncryptFinal_Ex() failed");
  502.         return NGX_ERROR;
  503.     }

  504.     return NGX_OK;
  505. }


  506. static void
  507. ngx_quic_crypto_hp_cleanup(ngx_quic_secret_t *s)
  508. {
  509.     if (s->hp_ctx) {
  510.         EVP_CIPHER_CTX_free(s->hp_ctx);
  511.         s->hp_ctx = NULL;
  512.     }
  513. }


  514. ngx_int_t
  515. ngx_quic_keys_set_encryption_secret(ngx_log_t *log, ngx_uint_t is_write,
  516.     ngx_quic_keys_t *keys, ngx_uint_t level, const SSL_CIPHER *cipher,
  517.     const uint8_t *secret, size_t secret_len)
  518. {
  519.     ngx_int_t            key_len;
  520.     ngx_str_t            secret_str;
  521.     ngx_uint_t           i;
  522.     ngx_quic_md_t        key;
  523.     ngx_quic_hkdf_t      seq[3];
  524.     ngx_quic_secret_t   *peer_secret;
  525.     ngx_quic_ciphers_t   ciphers;

  526.     peer_secret = is_write ? &keys->secrets[level].server
  527.                            : &keys->secrets[level].client;

  528.     keys->cipher = SSL_CIPHER_get_id(cipher);

  529.     key_len = ngx_quic_ciphers(keys->cipher, &ciphers);

  530.     if (key_len == NGX_ERROR) {
  531.         ngx_ssl_error(NGX_LOG_INFO, log, 0, "unexpected cipher");
  532.         return NGX_ERROR;
  533.     }

  534.     if (sizeof(peer_secret->secret.data) < secret_len) {
  535.         ngx_log_error(NGX_LOG_ALERT, log, 0,
  536.                       "unexpected secret len: %uz", secret_len);
  537.         return NGX_ERROR;
  538.     }

  539.     peer_secret->secret.len = secret_len;
  540.     ngx_memcpy(peer_secret->secret.data, secret, secret_len);

  541.     key.len = key_len;
  542.     peer_secret->iv.len = NGX_QUIC_IV_LEN;
  543.     peer_secret->hp.len = key_len;

  544.     secret_str.len = secret_len;
  545.     secret_str.data = (u_char *) secret;

  546.     ngx_quic_hkdf_set(&seq[0], "tls13 quic key", &key, &secret_str);
  547.     ngx_quic_hkdf_set(&seq[1], "tls13 quic iv", &peer_secret->iv, &secret_str);
  548.     ngx_quic_hkdf_set(&seq[2], "tls13 quic hp", &peer_secret->hp, &secret_str);

  549.     for (i = 0; i < (sizeof(seq) / sizeof(seq[0])); i++) {
  550.         if (ngx_quic_hkdf_expand(&seq[i], ciphers.d, log) != NGX_OK) {
  551.             return NGX_ERROR;
  552.         }
  553.     }

  554.     if (ngx_quic_crypto_init(ciphers.c, peer_secret, &key, is_write, log)
  555.         == NGX_ERROR)
  556.     {
  557.         return NGX_ERROR;
  558.     }

  559.     if (ngx_quic_crypto_hp_init(ciphers.hp, peer_secret, log) == NGX_ERROR) {
  560.         return NGX_ERROR;
  561.     }

  562.     ngx_explicit_memzero(key.data, key.len);

  563.     return NGX_OK;
  564. }


  565. ngx_uint_t
  566. ngx_quic_keys_available(ngx_quic_keys_t *keys, ngx_uint_t level,
  567.     ngx_uint_t is_write)
  568. {
  569.     if (is_write == 0) {
  570.         return keys->secrets[level].client.ctx != NULL;
  571.     }

  572.     return keys->secrets[level].server.ctx != NULL;
  573. }


  574. void
  575. ngx_quic_keys_discard(ngx_quic_keys_t *keys, ngx_uint_t level)
  576. {
  577.     ngx_quic_secret_t  *client, *server;

  578.     client = &keys->secrets[level].client;
  579.     server = &keys->secrets[level].server;

  580.     ngx_quic_crypto_cleanup(client);
  581.     ngx_quic_crypto_cleanup(server);

  582.     ngx_quic_crypto_hp_cleanup(client);
  583.     ngx_quic_crypto_hp_cleanup(server);

  584.     if (client->secret.len) {
  585.         ngx_explicit_memzero(client->secret.data, client->secret.len);
  586.         client->secret.len = 0;
  587.     }

  588.     if (server->secret.len) {
  589.         ngx_explicit_memzero(server->secret.data, server->secret.len);
  590.         server->secret.len = 0;
  591.     }
  592. }


  593. void
  594. ngx_quic_keys_switch(ngx_connection_t *c, ngx_quic_keys_t *keys)
  595. {
  596.     ngx_quic_secrets_t  *current, *next, tmp;

  597.     current = &keys->secrets[NGX_QUIC_ENCRYPTION_APPLICATION];
  598.     next = &keys->next_key;

  599.     ngx_quic_crypto_cleanup(&current->client);
  600.     ngx_quic_crypto_cleanup(&current->server);

  601.     tmp = *current;
  602.     *current = *next;
  603.     *next = tmp;
  604. }


  605. void
  606. ngx_quic_keys_update(ngx_event_t *ev)
  607. {
  608.     ngx_int_t               key_len;
  609.     ngx_uint_t              i;
  610.     ngx_quic_md_t           client_key, server_key;
  611.     ngx_quic_hkdf_t         seq[6];
  612.     ngx_quic_keys_t        *keys;
  613.     ngx_connection_t       *c;
  614.     ngx_quic_ciphers_t      ciphers;
  615.     ngx_quic_secrets_t     *current, *next;
  616.     ngx_quic_connection_t  *qc;

  617.     c = ev->data;
  618.     qc = ngx_quic_get_connection(c);
  619.     keys = qc->keys;

  620.     current = &keys->secrets[NGX_QUIC_ENCRYPTION_APPLICATION];
  621.     next = &keys->next_key;

  622.     ngx_log_debug0(NGX_LOG_DEBUG_EVENT, c->log, 0, "quic key update");

  623.     c->log->action = "updating keys";

  624.     key_len = ngx_quic_ciphers(keys->cipher, &ciphers);

  625.     if (key_len == NGX_ERROR) {
  626.         goto failed;
  627.     }

  628.     client_key.len = key_len;
  629.     server_key.len = key_len;

  630.     next->client.secret.len = current->client.secret.len;
  631.     next->client.iv.len = NGX_QUIC_IV_LEN;
  632.     next->client.hp = current->client.hp;
  633.     next->client.hp_ctx = current->client.hp_ctx;

  634.     next->server.secret.len = current->server.secret.len;
  635.     next->server.iv.len = NGX_QUIC_IV_LEN;
  636.     next->server.hp = current->server.hp;
  637.     next->server.hp_ctx = current->server.hp_ctx;

  638.     ngx_quic_hkdf_set(&seq[0], "tls13 quic ku",
  639.                       &next->client.secret, &current->client.secret);
  640.     ngx_quic_hkdf_set(&seq[1], "tls13 quic key",
  641.                       &client_key, &next->client.secret);
  642.     ngx_quic_hkdf_set(&seq[2], "tls13 quic iv",
  643.                       &next->client.iv, &next->client.secret);
  644.     ngx_quic_hkdf_set(&seq[3], "tls13 quic ku",
  645.                       &next->server.secret, &current->server.secret);
  646.     ngx_quic_hkdf_set(&seq[4], "tls13 quic key",
  647.                       &server_key, &next->server.secret);
  648.     ngx_quic_hkdf_set(&seq[5], "tls13 quic iv",
  649.                       &next->server.iv, &next->server.secret);

  650.     for (i = 0; i < (sizeof(seq) / sizeof(seq[0])); i++) {
  651.         if (ngx_quic_hkdf_expand(&seq[i], ciphers.d, c->log) != NGX_OK) {
  652.             goto failed;
  653.         }
  654.     }

  655.     if (ngx_quic_crypto_init(ciphers.c, &next->client, &client_key, 0, c->log)
  656.         == NGX_ERROR)
  657.     {
  658.         goto failed;
  659.     }

  660.     if (ngx_quic_crypto_init(ciphers.c, &next->server, &server_key, 1, c->log)
  661.         == NGX_ERROR)
  662.     {
  663.         goto failed;
  664.     }

  665.     ngx_explicit_memzero(current->client.secret.data,
  666.                          current->client.secret.len);
  667.     ngx_explicit_memzero(current->server.secret.data,
  668.                          current->server.secret.len);

  669.     current->client.secret.len = 0;
  670.     current->server.secret.len = 0;

  671.     ngx_explicit_memzero(client_key.data, client_key.len);
  672.     ngx_explicit_memzero(server_key.data, server_key.len);

  673.     return;

  674. failed:

  675.     ngx_quic_close_connection(c, NGX_ERROR);
  676. }


  677. void
  678. ngx_quic_keys_cleanup(ngx_quic_keys_t *keys)
  679. {
  680.     ngx_uint_t           i;
  681.     ngx_quic_secrets_t  *next;

  682.     for (i = 0; i < NGX_QUIC_ENCRYPTION_LAST; i++) {
  683.         ngx_quic_keys_discard(keys, i);
  684.     }

  685.     next = &keys->next_key;

  686.     ngx_quic_crypto_cleanup(&next->client);
  687.     ngx_quic_crypto_cleanup(&next->server);

  688.     if (next->client.secret.len) {
  689.         ngx_explicit_memzero(next->client.secret.data,
  690.                              next->client.secret.len);
  691.         next->client.secret.len = 0;
  692.     }

  693.     if (next->server.secret.len) {
  694.         ngx_explicit_memzero(next->server.secret.data,
  695.                              next->server.secret.len);
  696.         next->server.secret.len = 0;
  697.     }
  698. }


  699. static ngx_int_t
  700. ngx_quic_create_packet(ngx_quic_header_t *pkt, ngx_str_t *res)
  701. {
  702.     u_char             *pnp, *sample;
  703.     ngx_str_t           ad, out;
  704.     ngx_uint_t          i;
  705.     ngx_quic_secret_t  *secret;
  706.     u_char              nonce[NGX_QUIC_IV_LEN], mask[NGX_QUIC_HP_LEN];

  707.     ad.data = res->data;
  708.     ad.len = ngx_quic_create_header(pkt, ad.data, &pnp);

  709.     out.len = pkt->payload.len + NGX_QUIC_TAG_LEN;
  710.     out.data = res->data + ad.len;

  711. #ifdef NGX_QUIC_DEBUG_CRYPTO
  712.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  713.                    "quic ad len:%uz %xV", ad.len, &ad);
  714. #endif

  715.     secret = &pkt->keys->secrets[pkt->level].server;

  716.     ngx_memcpy(nonce, secret->iv.data, secret->iv.len);
  717.     ngx_quic_compute_nonce(nonce, sizeof(nonce), pkt->number);

  718.     if (ngx_quic_crypto_seal(secret, &out, nonce, &pkt->payload, &ad, pkt->log)
  719.         != NGX_OK)
  720.     {
  721.         return NGX_ERROR;
  722.     }

  723.     sample = &out.data[4 - pkt->num_len];
  724.     if (ngx_quic_crypto_hp(secret, mask, sample, pkt->log) != NGX_OK) {
  725.         return NGX_ERROR;
  726.     }

  727.     /* RFC 9001, 5.4.1.  Header Protection Application */
  728.     ad.data[0] ^= mask[0] & ngx_quic_pkt_hp_mask(pkt->flags);

  729.     for (i = 0; i < pkt->num_len; i++) {
  730.         pnp[i] ^= mask[i + 1];
  731.     }

  732.     res->len = ad.len + out.len;

  733.     return NGX_OK;
  734. }


  735. static ngx_int_t
  736. ngx_quic_create_retry_packet(ngx_quic_header_t *pkt, ngx_str_t *res)
  737. {
  738.     u_char              *start;
  739.     ngx_str_t            ad, itag;
  740.     ngx_quic_secret_t    secret;
  741.     ngx_quic_ciphers_t   ciphers;

  742.     /* 5.8.  Retry Packet Integrity */
  743.     static ngx_quic_md_t  key = ngx_quic_md(
  744.         "\xbe\x0c\x69\x0b\x9f\x66\x57\x5a\x1d\x76\x6b\x54\xe3\x68\xc8\x4e");
  745.     static const u_char   nonce[NGX_QUIC_IV_LEN] = {
  746.         0x46, 0x15, 0x99, 0xd3, 0x5d, 0x63, 0x2b, 0xf2, 0x23, 0x98, 0x25, 0xbb
  747.     };
  748.     static ngx_str_t      in = ngx_string("");

  749.     ad.data = res->data;
  750.     ad.len = ngx_quic_create_retry_itag(pkt, ad.data, &start);

  751.     itag.data = ad.data + ad.len;
  752.     itag.len = NGX_QUIC_TAG_LEN;

  753. #ifdef NGX_QUIC_DEBUG_CRYPTO
  754.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  755.                    "quic retry itag len:%uz %xV", ad.len, &ad);
  756. #endif

  757.     if (ngx_quic_ciphers(NGX_QUIC_INITIAL_CIPHER, &ciphers) == NGX_ERROR) {
  758.         return NGX_ERROR;
  759.     }

  760.     secret.iv.len = NGX_QUIC_IV_LEN;

  761.     if (ngx_quic_crypto_init(ciphers.c, &secret, &key, 1, pkt->log)
  762.         == NGX_ERROR)
  763.     {
  764.         return NGX_ERROR;
  765.     }

  766.     if (ngx_quic_crypto_seal(&secret, &itag, nonce, &in, &ad, pkt->log)
  767.         != NGX_OK)
  768.     {
  769.         ngx_quic_crypto_cleanup(&secret);
  770.         return NGX_ERROR;
  771.     }

  772.     ngx_quic_crypto_cleanup(&secret);

  773.     res->len = itag.data + itag.len - start;
  774.     res->data = start;

  775.     return NGX_OK;
  776. }


  777. ngx_int_t
  778. ngx_quic_derive_key(ngx_log_t *log, const char *label, ngx_str_t *secret,
  779.     ngx_str_t *salt, u_char *out, size_t len)
  780. {
  781.     size_t         is_len, info_len;
  782.     uint8_t       *p;
  783.     const EVP_MD  *digest;

  784.     uint8_t        is[SHA256_DIGEST_LENGTH];
  785.     uint8_t        info[20];

  786.     digest = EVP_sha256();
  787.     is_len = SHA256_DIGEST_LENGTH;

  788.     if (ngx_hkdf_extract(is, &is_len, digest, secret->data, secret->len,
  789.                          salt->data, salt->len)
  790.         != NGX_OK)
  791.     {
  792.         ngx_ssl_error(NGX_LOG_INFO, log, 0,
  793.                       "ngx_hkdf_extract(%s) failed", label);
  794.         return NGX_ERROR;
  795.     }

  796.     info[0] = 0;
  797.     info[1] = len;
  798.     info[2] = ngx_strlen(label);

  799.     info_len = 2 + 1 + info[2] + 1;

  800.     if (info_len >= 20) {
  801.         ngx_log_error(NGX_LOG_INFO, log, 0,
  802.                       "ngx_quic_create_key label \"%s\" too long", label);
  803.         return NGX_ERROR;
  804.     }

  805.     p = ngx_cpymem(&info[3], label, info[2]);
  806.     *p = '\0';

  807.     if (ngx_hkdf_expand(out, len, digest, is, is_len, info, info_len) != NGX_OK)
  808.     {
  809.         ngx_ssl_error(NGX_LOG_INFO, log, 0,
  810.                       "ngx_hkdf_expand(%s) failed", label);
  811.         return NGX_ERROR;
  812.     }

  813.     return NGX_OK;
  814. }


  815. static uint64_t
  816. ngx_quic_parse_pn(u_char **pos, ngx_int_t len, u_char *mask,
  817.     uint64_t *largest_pn)
  818. {
  819.     u_char    *p;
  820.     uint64_t   truncated_pn, expected_pn, candidate_pn;
  821.     uint64_t   pn_nbits, pn_win, pn_hwin, pn_mask;

  822.     pn_nbits = ngx_min(len * 8, 62);

  823.     p = *pos;
  824.     truncated_pn = *p++ ^ *mask++;

  825.     while (--len) {
  826.         truncated_pn = (truncated_pn << 8) + (*p++ ^ *mask++);
  827.     }

  828.     *pos = p;

  829.     expected_pn = *largest_pn + 1;
  830.     pn_win = 1ULL << pn_nbits;
  831.     pn_hwin = pn_win / 2;
  832.     pn_mask = pn_win - 1;

  833.     candidate_pn = (expected_pn & ~pn_mask) | truncated_pn;

  834.     if ((int64_t) candidate_pn <= (int64_t) (expected_pn - pn_hwin)
  835.         && candidate_pn < (1ULL << 62) - pn_win)
  836.     {
  837.         candidate_pn += pn_win;

  838.     } else if (candidate_pn > expected_pn + pn_hwin
  839.                && candidate_pn >= pn_win)
  840.     {
  841.         candidate_pn -= pn_win;
  842.     }

  843.     *largest_pn = ngx_max((int64_t) *largest_pn, (int64_t) candidate_pn);

  844.     return candidate_pn;
  845. }


  846. void
  847. ngx_quic_compute_nonce(u_char *nonce, size_t len, uint64_t pn)
  848. {
  849.     nonce[len - 8] ^= (pn >> 56) & 0x3f;
  850.     nonce[len - 7] ^= (pn >> 48) & 0xff;
  851.     nonce[len - 6] ^= (pn >> 40) & 0xff;
  852.     nonce[len - 5] ^= (pn >> 32) & 0xff;
  853.     nonce[len - 4] ^= (pn >> 24) & 0xff;
  854.     nonce[len - 3] ^= (pn >> 16) & 0xff;
  855.     nonce[len - 2] ^= (pn >> 8) & 0xff;
  856.     nonce[len - 1] ^= pn & 0xff;
  857. }


  858. ngx_int_t
  859. ngx_quic_encrypt(ngx_quic_header_t *pkt, ngx_str_t *res)
  860. {
  861.     if (ngx_quic_pkt_retry(pkt->flags)) {
  862.         return ngx_quic_create_retry_packet(pkt, res);
  863.     }

  864.     return ngx_quic_create_packet(pkt, res);
  865. }


  866. ngx_int_t
  867. ngx_quic_decrypt(ngx_quic_header_t *pkt, uint64_t *largest_pn)
  868. {
  869.     u_char             *p, *sample;
  870.     size_t              len;
  871.     uint64_t            pn, lpn;
  872.     ngx_int_t           pnl;
  873.     ngx_str_t           in, ad;
  874.     ngx_uint_t          key_phase;
  875.     ngx_quic_secret_t  *secret;
  876.     uint8_t             nonce[NGX_QUIC_IV_LEN], mask[NGX_QUIC_HP_LEN];

  877.     secret = &pkt->keys->secrets[pkt->level].client;

  878.     p = pkt->raw->pos;
  879.     len = pkt->data + pkt->len - p;

  880.     /*
  881.      * RFC 9001, 5.4.2. Header Protection Sample
  882.      *           5.4.3. AES-Based Header Protection
  883.      *           5.4.4. ChaCha20-Based Header Protection
  884.      *
  885.      * the Packet Number field is assumed to be 4 bytes long
  886.      * AES and ChaCha20 algorithms sample 16 bytes
  887.      */

  888.     if (len < NGX_QUIC_TAG_LEN + 4) {
  889.         return NGX_DECLINED;
  890.     }

  891.     sample = p + 4;

  892.     /* header protection */

  893.     if (ngx_quic_crypto_hp(secret, mask, sample, pkt->log) != NGX_OK) {
  894.         return NGX_DECLINED;
  895.     }

  896.     pkt->flags ^= mask[0] & ngx_quic_pkt_hp_mask(pkt->flags);

  897.     if (ngx_quic_short_pkt(pkt->flags)) {
  898.         key_phase = (pkt->flags & NGX_QUIC_PKT_KPHASE) != 0;

  899.         if (key_phase != pkt->key_phase) {
  900.             if (pkt->keys->next_key.client.ctx != NULL) {
  901.                 secret = &pkt->keys->next_key.client;
  902.                 pkt->key_update = 1;

  903.             } else {
  904.                 /*
  905.                  * RFC 9001,  6.3. Timing of Receive Key Generation.
  906.                  *
  907.                  * Trial decryption to avoid timing side-channel.
  908.                  */
  909.                 ngx_log_debug0(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  910.                                "quic next key missing");
  911.             }
  912.         }
  913.     }

  914.     lpn = *largest_pn;

  915.     pnl = (pkt->flags & 0x03) + 1;
  916.     pn = ngx_quic_parse_pn(&p, pnl, &mask[1], &lpn);

  917.     pkt->pn = pn;

  918.     ngx_log_debug1(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  919.                    "quic packet rx clearflags:%xd", pkt->flags);
  920.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  921.                    "quic packet rx number:%uL len:%xi", pn, pnl);

  922.     /* packet protection */

  923.     in.data = p;
  924.     in.len = len - pnl;

  925.     ad.len = p - pkt->data;
  926.     ad.data = pkt->plaintext;

  927.     ngx_memcpy(ad.data, pkt->data, ad.len);
  928.     ad.data[0] = pkt->flags;

  929.     do {
  930.         ad.data[ad.len - pnl] = pn >> (8 * (pnl - 1)) % 256;
  931.     } while (--pnl);

  932.     ngx_memcpy(nonce, secret->iv.data, secret->iv.len);
  933.     ngx_quic_compute_nonce(nonce, sizeof(nonce), pn);

  934. #ifdef NGX_QUIC_DEBUG_CRYPTO
  935.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  936.                    "quic ad len:%uz %xV", ad.len, &ad);
  937. #endif

  938.     pkt->payload.len = in.len - NGX_QUIC_TAG_LEN;
  939.     pkt->payload.data = pkt->plaintext + ad.len;

  940.     if (ngx_quic_crypto_open(secret, &pkt->payload, nonce, &in, &ad, pkt->log)
  941.         != NGX_OK)
  942.     {
  943.         return NGX_DECLINED;
  944.     }

  945.     if (pkt->payload.len == 0) {
  946.         /*
  947.          * RFC 9000, 12.4.  Frames and Frame Types
  948.          *
  949.          * An endpoint MUST treat receipt of a packet containing no
  950.          * frames as a connection error of type PROTOCOL_VIOLATION.
  951.          */
  952.         ngx_log_error(NGX_LOG_INFO, pkt->log, 0, "quic zero-length packet");
  953.         pkt->error = NGX_QUIC_ERR_PROTOCOL_VIOLATION;
  954.         return NGX_ERROR;
  955.     }

  956.     if (pkt->flags & ngx_quic_pkt_rb_mask(pkt->flags)) {
  957.         /*
  958.          * RFC 9000, Reserved Bits
  959.          *
  960.          * An endpoint MUST treat receipt of a packet that has
  961.          * a non-zero value for these bits, after removing both
  962.          * packet and header protection, as a connection error
  963.          * of type PROTOCOL_VIOLATION.
  964.          */
  965.         ngx_log_error(NGX_LOG_INFO, pkt->log, 0,
  966.                       "quic reserved bit set in packet");
  967.         pkt->error = NGX_QUIC_ERR_PROTOCOL_VIOLATION;
  968.         return NGX_ERROR;
  969.     }

  970. #if defined(NGX_QUIC_DEBUG_CRYPTO) && defined(NGX_QUIC_DEBUG_PACKETS)
  971.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, pkt->log, 0,
  972.                    "quic packet payload len:%uz %xV",
  973.                    pkt->payload.len, &pkt->payload);
  974. #endif

  975.     *largest_pn = lpn;

  976.     return NGX_OK;
  977. }