One Level Up Top Level

src/http/v3/ngx_http_v3_module.c - nginx source code

Global variables defined

Functions defined

Source code


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


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_http.h>


  13. static ngx_int_t ngx_http_v3_variable(ngx_http_request_t *r,
  14.     ngx_http_variable_value_t *v, uintptr_t data);
  15. static ngx_int_t ngx_http_v3_add_variables(ngx_conf_t *cf);
  16. static void *ngx_http_v3_create_srv_conf(ngx_conf_t *cf);
  17. static char *ngx_http_v3_merge_srv_conf(ngx_conf_t *cf, void *parent,
  18.     void *child);
  19. static char *ngx_http_quic_host_key(ngx_conf_t *cf, ngx_command_t *cmd,
  20.     void *conf);


  23. ‌static ngx_command_t  ngx_http_v3_commands[] = {

  25.     { ngx_string("http3"),
  26.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
  27.       ngx_conf_set_flag_slot,
  28.       NGX_HTTP_SRV_CONF_OFFSET,
  29.       offsetof(ngx_http_v3_srv_conf_t, enable),
  30.       NULL },

  32.     { ngx_string("http3_hq"),
  33.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
  34.       ngx_conf_set_flag_slot,
  35.       NGX_HTTP_SRV_CONF_OFFSET,
  36.       offsetof(ngx_http_v3_srv_conf_t, enable_hq),
  37.       NULL },

  39.     { ngx_string("http3_max_concurrent_streams"),
  40.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  41.       ngx_conf_set_num_slot,
  42.       NGX_HTTP_SRV_CONF_OFFSET,
  43.       offsetof(ngx_http_v3_srv_conf_t, max_concurrent_streams),
  44.       NULL },

  46.     { ngx_string("http3_stream_buffer_size"),
  47.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  48.       ngx_conf_set_size_slot,
  49.       NGX_HTTP_SRV_CONF_OFFSET,
  50.       offsetof(ngx_http_v3_srv_conf_t, quic.stream_buffer_size),
  51.       NULL },

  53.     { ngx_string("quic_retry"),
  54.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
  55.       ngx_conf_set_flag_slot,
  56.       NGX_HTTP_SRV_CONF_OFFSET,
  57.       offsetof(ngx_http_v3_srv_conf_t, quic.retry),
  58.       NULL },

  60.     { ngx_string("quic_gso"),
  61.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
  62.       ngx_conf_set_flag_slot,
  63.       NGX_HTTP_SRV_CONF_OFFSET,
  64.       offsetof(ngx_http_v3_srv_conf_t, quic.gso_enabled),
  65.       NULL },

  67.     { ngx_string("quic_host_key"),
  68.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  69.       ngx_http_quic_host_key,
  70.       NGX_HTTP_SRV_CONF_OFFSET,
  71.       0,
  72.       NULL },

  74.     { ngx_string("quic_active_connection_id_limit"),
  75.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  76.       ngx_conf_set_num_slot,
  77.       NGX_HTTP_SRV_CONF_OFFSET,
  78.       offsetof(ngx_http_v3_srv_conf_t, quic.active_connection_id_limit),
  79.       NULL },

  81.       ngx_null_command
  82. };


  85. ‌static ngx_http_module_t  ngx_http_v3_module_ctx = {
  86.     ngx_http_v3_add_variables,             /* preconfiguration */
  87.     NULL,                                  /* postconfiguration */

  89.     NULL,                                  /* create main configuration */
  90.     NULL,                                  /* init main configuration */

  92.     ngx_http_v3_create_srv_conf,           /* create server configuration */
  93.     ngx_http_v3_merge_srv_conf,            /* merge server configuration */

  95.     NULL,                                  /* create location configuration */
  96.     NULL                                   /* merge location configuration */
  97. };


  100. ‌ngx_module_t  ngx_http_v3_module = {
  101.     NGX_MODULE_V1,
  102.     &ngx_http_v3_module_ctx,               /* module context */
  103.     ngx_http_v3_commands,                  /* module directives */
  104.     NGX_HTTP_MODULE,                       /* module type */
  105.     NULL,                                  /* init master */
  106.     NULL,                                  /* init module */
  107.     NULL,                                  /* init process */
  108.     NULL,                                  /* init thread */
  109.     NULL,                                  /* exit thread */
  110.     NULL,                                  /* exit process */
  111.     NULL,                                  /* exit master */
  112.     NGX_MODULE_V1_PADDING
  113. };


  116. ‌static ngx_http_variable_t  ngx_http_v3_vars[] = {

  118.     { ngx_string("http3"), NULL, ngx_http_v3_variable, 0, 0, 0 },

  120.       ngx_http_null_variable
  121. };

  123. ‌static ngx_str_t  ngx_http_quic_salt = ngx_string("ngx_quic");


  126. static ngx_int_t
  127. ‌ngx_http_v3_variable(ngx_http_request_t *r,
  128.     ngx_http_variable_value_t *v, uintptr_t data)
  129. {
  130.     ngx_http_v3_session_t  *h3c;

  132.     if (r->connection->quic) {
  133.         h3c = ngx_http_v3_get_session(r->connection);

  135.         if (h3c->hq) {
  136.             v->len = sizeof("hq") - 1;
  137.             v->valid = 1;
  138.             v->no_cacheable = 0;
  139.             v->not_found = 0;
  140.             v->data = (u_char *) "hq";

  142.             return NGX_OK;
  143.         }

  145.         v->len = sizeof("h3") - 1;
  146.         v->valid = 1;
  147.         v->no_cacheable = 0;
  148.         v->not_found = 0;
  149.         v->data = (u_char *) "h3";

  151.         return NGX_OK;
  152.     }

  154.     *v = ngx_http_variable_null_value;

  156.     return NGX_OK;
  157. }


  160. static ngx_int_t
  161. ‌ngx_http_v3_add_variables(ngx_conf_t *cf)
  162. {
  163.     ngx_http_variable_t  *var, *v;

  165.     for (v = ngx_http_v3_vars; v->name.len; v++) {
  166.         var = ngx_http_add_variable(cf, &v->name, v->flags);
  167.         if (var == NULL) {
  168.             return NGX_ERROR;
  169.         }

  171.         var->get_handler = v->get_handler;
  172.         var->data = v->data;
  173.     }

  175.     return NGX_OK;
  176. }


  179. static void *
  180. ‌ngx_http_v3_create_srv_conf(ngx_conf_t *cf)
  181. {
  182.     ngx_http_v3_srv_conf_t  *h3scf;

  184.     h3scf = ngx_pcalloc(cf->pool, sizeof(ngx_http_v3_srv_conf_t));
  185.     if (h3scf == NULL) {
  186.         return NULL;
  187.     }

  189.     /*
  190.      * set by ngx_pcalloc():
  191.      *
  192.      *     h3scf->quic.host_key = { 0, NULL }
  193.      *     h3scf->quic.stream_reject_code_uni = 0;
  194.      *     h3scf->quic.disable_active_migration = 0;
  195.      *     h3scf->quic.idle_timeout = 0;
  196.      *     h3scf->max_blocked_streams = 0;
  197.      */

  199.     h3scf->enable = NGX_CONF_UNSET;
  200.     h3scf->enable_hq = NGX_CONF_UNSET;
  201.     h3scf->max_table_capacity = NGX_HTTP_V3_MAX_TABLE_CAPACITY;
  202.     h3scf->max_concurrent_streams = NGX_CONF_UNSET_UINT;

  204.     h3scf->quic.stream_buffer_size = NGX_CONF_UNSET_SIZE;
  205.     h3scf->quic.max_concurrent_streams_bidi = NGX_CONF_UNSET_UINT;
  206.     h3scf->quic.max_concurrent_streams_uni = NGX_HTTP_V3_MAX_UNI_STREAMS;
  207.     h3scf->quic.retry = NGX_CONF_UNSET;
  208.     h3scf->quic.gso_enabled = NGX_CONF_UNSET;
  209.     h3scf->quic.stream_close_code = NGX_HTTP_V3_ERR_NO_ERROR;
  210.     h3scf->quic.stream_reject_code_bidi = NGX_HTTP_V3_ERR_REQUEST_REJECTED;
  211.     h3scf->quic.active_connection_id_limit = NGX_CONF_UNSET_UINT;

  213.     h3scf->quic.init = ngx_http_v3_init;
  214.     h3scf->quic.shutdown = ngx_http_v3_shutdown;

  216.     return h3scf;
  217. }


  220. static char *
  221. ‌ngx_http_v3_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
  222. {
  223.     ngx_http_v3_srv_conf_t *prev = parent;
  224.     ngx_http_v3_srv_conf_t *conf = child;

  226.     ngx_http_ssl_srv_conf_t   *sscf;
  227.     ngx_http_core_srv_conf_t  *cscf;

  229.     ngx_conf_merge_value(conf->enable, prev->enable, 1);

  231.     ngx_conf_merge_value(conf->enable_hq, prev->enable_hq, 0);

  233.     ngx_conf_merge_uint_value(conf->max_concurrent_streams,
  234.                               prev->max_concurrent_streams, 128);

  236.     conf->max_blocked_streams = conf->max_concurrent_streams;

  238.     ngx_conf_merge_size_value(conf->quic.stream_buffer_size,
  239.                               prev->quic.stream_buffer_size,
  240.                               65536);

  242.     conf->quic.max_concurrent_streams_bidi = conf->max_concurrent_streams;

  244.     ngx_conf_merge_value(conf->quic.retry, prev->quic.retry, 0);
  245.     ngx_conf_merge_value(conf->quic.gso_enabled, prev->quic.gso_enabled, 0);

  247.     ngx_conf_merge_str_value(conf->quic.host_key, prev->quic.host_key, "");

  249.     ngx_conf_merge_uint_value(conf->quic.active_connection_id_limit,
  250.                               prev->quic.active_connection_id_limit,
  251.                               2);

  253.     if (conf->quic.host_key.len == 0) {

  255.         conf->quic.host_key.len = NGX_QUIC_DEFAULT_HOST_KEY_LEN;
  256.         conf->quic.host_key.data = ngx_palloc(cf->pool,
  257.                                               conf->quic.host_key.len);
  258.         if (conf->quic.host_key.data == NULL) {
  259.             return NGX_CONF_ERROR;
  260.         }

  262.         if (RAND_bytes(conf->quic.host_key.data, NGX_QUIC_DEFAULT_HOST_KEY_LEN)
  263.             <= 0)
  264.         {
  265.             return NGX_CONF_ERROR;
  266.         }
  267.     }

  269.     if (ngx_quic_derive_key(cf->log, "av_token_key",
  270.                             &conf->quic.host_key, &ngx_http_quic_salt,
  271.                             conf->quic.av_token_key, NGX_QUIC_AV_KEY_LEN)
  272.         != NGX_OK)
  273.     {
  274.         return NGX_CONF_ERROR;
  275.     }

  277.     if (ngx_quic_derive_key(cf->log, "sr_token_key",
  278.                             &conf->quic.host_key, &ngx_http_quic_salt,
  279.                             conf->quic.sr_token_key, NGX_QUIC_SR_KEY_LEN)
  280.         != NGX_OK)
  281.     {
  282.         return NGX_CONF_ERROR;
  283.     }

  285.     cscf = ngx_http_conf_get_module_srv_conf(cf, ngx_http_core_module);
  286.     conf->quic.handshake_timeout = cscf->client_header_timeout;

  288.     sscf = ngx_http_conf_get_module_srv_conf(cf, ngx_http_ssl_module);
  289.     conf->quic.ssl = &sscf->ssl;

  291.     return NGX_CONF_OK;
  292. }


  295. static char *
  296. ‌ngx_http_quic_host_key(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  297. {
  298.     ngx_http_v3_srv_conf_t  *h3scf = conf;

  300.     u_char           *buf;
  301.     size_t            size;
  302.     ssize_t           n;
  303.     ngx_str_t        *value;
  304.     ngx_file_t        file;
  305.     ngx_file_info_t   fi;
  306.     ngx_quic_conf_t  *qcf;

  308.     qcf = &h3scf->quic;

  310.     if (qcf->host_key.len) {
  311.         return "is duplicate";
  312.     }

  314.     buf = NULL;
  315. #if (NGX_SUPPRESS_WARN)
  316.     size = 0;
  317. #endif

  319.     value = cf->args->elts;

  321.     if (ngx_conf_full_name(cf->cycle, &value[1], 1) != NGX_OK) {
  322.         return NGX_CONF_ERROR;
  323.     }

  325.     ngx_memzero(&file, sizeof(ngx_file_t));
  326.     file.name = value[1];
  327.     file.log = cf->log;

  329.     file.fd = ngx_open_file(file.name.data, NGX_FILE_RDONLY, NGX_FILE_OPEN, 0);

  331.     if (file.fd == NGX_INVALID_FILE) {
  332.         ngx_conf_log_error(NGX_LOG_EMERG, cf, ngx_errno,
  333.                            ngx_open_file_n " \"%V\" failed", &file.name);
  334.         return NGX_CONF_ERROR;
  335.     }

  337.     if (ngx_fd_info(file.fd, &fi) == NGX_FILE_ERROR) {
  338.         ngx_conf_log_error(NGX_LOG_CRIT, cf, ngx_errno,
  339.                            ngx_fd_info_n " \"%V\" failed", &file.name);
  340.         goto failed;
  341.     }

  343.     size = ngx_file_size(&fi);

  345.     if (size == 0) {
  346.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  347.                            "\"%V\" zero key size", &file.name);
  348.         goto failed;
  349.     }

  351.     buf = ngx_pnalloc(cf->pool, size);
  352.     if (buf == NULL) {
  353.         goto failed;
  354.     }

  356.     n = ngx_read_file(&file, buf, size, 0);

  358.     if (n == NGX_ERROR) {
  359.         ngx_conf_log_error(NGX_LOG_CRIT, cf, ngx_errno,
  360.                            ngx_read_file_n " \"%V\" failed", &file.name);
  361.         goto failed;
  362.     }

  364.     if ((size_t) n != size) {
  365.         ngx_conf_log_error(NGX_LOG_CRIT, cf, 0,
  366.                            ngx_read_file_n " \"%V\" returned only "
  367.                            "%z bytes instead of %uz", &file.name, n, size);
  368.         goto failed;
  369.     }

  371.     qcf->host_key.data = buf;
  372.     qcf->host_key.len = n;

  374.     if (ngx_close_file(file.fd) == NGX_FILE_ERROR) {
  375.         ngx_log_error(NGX_LOG_ALERT, cf->log, ngx_errno,
  376.                       ngx_close_file_n " \"%V\" failed", &file.name);
  377.     }

  379.     return NGX_CONF_OK;

  381. failed:

  383.     if (ngx_close_file(file.fd) == NGX_FILE_ERROR) {
  384.         ngx_log_error(NGX_LOG_ALERT, cf->log, ngx_errno,
  385.                       ngx_close_file_n " \"%V\" failed", &file.name);
  386.     }

  388.     if (buf) {
  389.         ngx_explicit_memzero(buf, size);
  390.     }

  392.     return NGX_CONF_ERROR;
  393. }

One Level Up Top Level