One Level Up Top Level

src/http/modules/ngx_http_secure_link_module.c - nginx-1.31.3 nginx/ @ 42f8df65b

Global variables defined

Data types defined

Functions defined

Source code


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


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


  14. ‌typedef struct {
  15.     ngx_http_complex_value_t  *variable;
  16.     ngx_http_complex_value_t  *md5;
  17.     ngx_str_t                  secret;
  18. ‌} ngx_http_secure_link_conf_t;


  21. ‌typedef struct {
  22.     ngx_str_t                  expires;
  23. ‌} ngx_http_secure_link_ctx_t;


  26. static ngx_int_t ngx_http_secure_link_old_variable(ngx_http_request_t *r,
  27.     ngx_http_secure_link_conf_t *conf, ngx_http_variable_value_t *v,
  28.     uintptr_t data);
  29. static ngx_int_t ngx_http_secure_link_expires_variable(ngx_http_request_t *r,
  30.     ngx_http_variable_value_t *v, uintptr_t data);
  31. static void *ngx_http_secure_link_create_conf(ngx_conf_t *cf);
  32. static char *ngx_http_secure_link_merge_conf(ngx_conf_t *cf, void *parent,
  33.     void *child);
  34. static ngx_int_t ngx_http_secure_link_add_variables(ngx_conf_t *cf);


  37. ‌static ngx_command_t  ngx_http_secure_link_commands[] = {

  39.     { ngx_string("secure_link"),
  40.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
  41.       ngx_http_set_complex_value_slot,
  42.       NGX_HTTP_LOC_CONF_OFFSET,
  43.       offsetof(ngx_http_secure_link_conf_t, variable),
  44.       NULL },

  46.     { ngx_string("secure_link_md5"),
  47.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
  48.       ngx_http_set_complex_value_slot,
  49.       NGX_HTTP_LOC_CONF_OFFSET,
  50.       offsetof(ngx_http_secure_link_conf_t, md5),
  51.       NULL },

  53.     { ngx_string("secure_link_secret"),
  54.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
  55.       ngx_conf_set_str_slot,
  56.       NGX_HTTP_LOC_CONF_OFFSET,
  57.       offsetof(ngx_http_secure_link_conf_t, secret),
  58.       NULL },

  60.       ngx_null_command
  61. };


  64. ‌static ngx_http_module_t  ngx_http_secure_link_module_ctx = {
  65.     ngx_http_secure_link_add_variables,    /* preconfiguration */
  66.     NULL,                                  /* postconfiguration */

  68.     NULL,                                  /* create main configuration */
  69.     NULL,                                  /* init main configuration */

  71.     NULL,                                  /* create server configuration */
  72.     NULL,                                  /* merge server configuration */

  74.     ngx_http_secure_link_create_conf,      /* create location configuration */
  75.     ngx_http_secure_link_merge_conf        /* merge location configuration */
  76. };


  79. ‌ngx_module_t  ngx_http_secure_link_module = {
  80.     NGX_MODULE_V1,
  81.     &ngx_http_secure_link_module_ctx,      /* module context */
  82.     ngx_http_secure_link_commands,         /* module directives */
  83.     NGX_HTTP_MODULE,                       /* module type */
  84.     NULL,                                  /* init master */
  85.     NULL,                                  /* init module */
  86.     NULL,                                  /* init process */
  87.     NULL,                                  /* init thread */
  88.     NULL,                                  /* exit thread */
  89.     NULL,                                  /* exit process */
  90.     NULL,                                  /* exit master */
  91.     NGX_MODULE_V1_PADDING
  92. };


  95. ‌static ngx_str_t  ngx_http_secure_link_name = ngx_string("secure_link");
  96. ‌static ngx_str_t  ngx_http_secure_link_expires_name =
  97.     ngx_string("secure_link_expires");


  100. static ngx_int_t
  101. ‌ngx_http_secure_link_variable(ngx_http_request_t *r,
  102.     ngx_http_variable_value_t *v, uintptr_t data)
  103. {
  104.     u_char                       *p, *last, ch;
  105.     time_t                        expires;
  106.     ngx_str_t                     val, hash;
  107.     ngx_md5_t                     md5;
  108.     ngx_uint_t                    i;
  109.     ngx_http_secure_link_ctx_t   *ctx;
  110.     ngx_http_secure_link_conf_t  *conf;
  111.     u_char                        hash_buf[18], md5_buf[16];

  113.     conf = ngx_http_get_module_loc_conf(r, ngx_http_secure_link_module);

  115.     if (conf->secret.data) {
  116.         return ngx_http_secure_link_old_variable(r, conf, v, data);
  117.     }

  119.     if (conf->variable == NULL || conf->md5 == NULL) {
  120.         goto not_found;
  121.     }

  123.     if (ngx_http_complex_value(r, conf->variable, &val) != NGX_OK) {
  124.         return NGX_ERROR;
  125.     }

  127.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  128.                    "secure link: \"%V\"", &val);

  130.     last = val.data + val.len;

  132.     p = ngx_strlchr(val.data, last, ',');
  133.     expires = 0;

  135.     if (p) {
  136.         val.len = p++ - val.data;

  138.         expires = ngx_atotm(p, last - p);
  139.         if (expires <= 0) {
  140.             goto not_found;
  141.         }

  143.         ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_secure_link_ctx_t));
  144.         if (ctx == NULL) {
  145.             return NGX_ERROR;
  146.         }

  148.         ngx_http_set_ctx(r, ctx, ngx_http_secure_link_module);

  150.         ctx->expires.len = last - p;
  151.         ctx->expires.data = p;
  152.     }

  154.     if (val.len > 24) {
  155.         goto not_found;
  156.     }

  158.     hash.data = hash_buf;

  160.     if (ngx_decode_base64url(&hash, &val) != NGX_OK) {
  161.         goto not_found;
  162.     }

  164.     if (hash.len != 16) {
  165.         goto not_found;
  166.     }

  168.     if (ngx_http_complex_value(r, conf->md5, &val) != NGX_OK) {
  169.         return NGX_ERROR;
  170.     }

  172.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  173.                    "secure link md5: \"%V\"", &val);

  175.     ngx_md5_init(&md5);
  176.     ngx_md5_update(&md5, val.data, val.len);
  177.     ngx_md5_final(md5_buf, &md5);

  179.     /* constant time comparison */

  181.     for (ch = 0, i = 0; i < 16; i++) {
  182.         ch |= (hash_buf[i] ^ md5_buf[i]);
  183.     }

  185.     if (ch) {
  186.         goto not_found;
  187.     }

  189.     v->data = (u_char *) ((expires && expires < ngx_time()) ? "0" : "1");
  190.     v->len = 1;
  191.     v->valid = 1;
  192.     v->no_cacheable = 0;
  193.     v->not_found = 0;

  195.     return NGX_OK;

  197. not_found:

  199.     v->not_found = 1;

  201.     return NGX_OK;
  202. }


  205. static ngx_int_t
  206. ‌ngx_http_secure_link_old_variable(ngx_http_request_t *r,
  207.     ngx_http_secure_link_conf_t *conf, ngx_http_variable_value_t *v,
  208.     uintptr_t data)
  209. {
  210.     u_char      *p, *start, *end, *last, ch;
  211.     size_t       len;
  212.     ngx_int_t    n;
  213.     ngx_md5_t    md5;
  214.     ngx_uint_t   i;
  215.     u_char       hash[16];

  217.     p = &r->unparsed_uri.data[1];
  218.     last = r->unparsed_uri.data + r->unparsed_uri.len;

  220.     while (p < last) {
  221.         if (*p++ == '/') {
  222.             start = p;
  223.             goto md5_start;
  224.         }
  225.     }

  227.     goto not_found;

  229. md5_start:

  231.     while (p < last) {
  232.         if (*p++ == '/') {
  233.             end = p - 1;
  234.             goto url_start;
  235.         }
  236.     }

  238.     goto not_found;

  240. url_start:

  242.     len = last - p;

  244.     if (end - start != 32 || len == 0) {
  245.         goto not_found;
  246.     }

  248.     ngx_md5_init(&md5);
  249.     ngx_md5_update(&md5, p, len);
  250.     ngx_md5_update(&md5, conf->secret.data, conf->secret.len);
  251.     ngx_md5_final(hash, &md5);

  253.     for (ch = 0, i = 0; i < 16; i++) {
  254.         n = ngx_hextoi(&start[2 * i], 2);
  255.         if (n == NGX_ERROR) {
  256.             goto not_found;
  257.         }

  259.         /* constant time comparison */

  261.         ch |= (u_char) n ^ hash[i];
  262.     }

  264.     if (ch) {
  265.         goto not_found;
  266.     }

  268.     v->len = len;
  269.     v->valid = 1;
  270.     v->no_cacheable = 0;
  271.     v->not_found = 0;
  272.     v->data = p;

  274.     return NGX_OK;

  276. not_found:

  278.     v->not_found = 1;

  280.     return NGX_OK;
  281. }


  284. static ngx_int_t
  285. ‌ngx_http_secure_link_expires_variable(ngx_http_request_t *r,
  286.     ngx_http_variable_value_t *v, uintptr_t data)
  287. {
  288.     ngx_http_secure_link_ctx_t  *ctx;

  290.     ctx = ngx_http_get_module_ctx(r, ngx_http_secure_link_module);

  292.     if (ctx) {
  293.         v->len = ctx->expires.len;
  294.         v->valid = 1;
  295.         v->no_cacheable = 0;
  296.         v->not_found = 0;
  297.         v->data = ctx->expires.data;

  299.     } else {
  300.         v->not_found = 1;
  301.     }

  303.     return NGX_OK;
  304. }


  307. static void *
  308. ‌ngx_http_secure_link_create_conf(ngx_conf_t *cf)
  309. {
  310.     ngx_http_secure_link_conf_t  *conf;

  312.     conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_secure_link_conf_t));
  313.     if (conf == NULL) {
  314.         return NULL;
  315.     }

  317.     /*
  318.      * set by ngx_pcalloc():
  319.      *
  320.      *     conf->secret = { 0, NULL };
  321.      */

  323.     conf->variable = NGX_CONF_UNSET_PTR;
  324.     conf->md5 = NGX_CONF_UNSET_PTR;

  326.     return conf;
  327. }


  330. static char *
  331. ‌ngx_http_secure_link_merge_conf(ngx_conf_t *cf, void *parent, void *child)
  332. {
  333.     ngx_http_secure_link_conf_t *prev = parent;
  334.     ngx_http_secure_link_conf_t *conf = child;

  336.     if (conf->secret.data) {
  337.         ngx_conf_init_ptr_value(conf->variable, NULL);
  338.         ngx_conf_init_ptr_value(conf->md5, NULL);

  340.         if (conf->variable || conf->md5) {
  341.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  342.                                "\"secure_link_secret\" cannot be mixed with "
  343.                                "\"secure_link\" and \"secure_link_md5\"");
  344.             return NGX_CONF_ERROR;
  345.         }

  347.         return NGX_CONF_OK;
  348.     }

  350.     ngx_conf_merge_ptr_value(conf->variable, prev->variable, NULL);
  351.     ngx_conf_merge_ptr_value(conf->md5, prev->md5, NULL);

  353.     if (conf->variable == NULL && conf->md5 == NULL) {
  354.         conf->secret = prev->secret;
  355.     }

  357.     return NGX_CONF_OK;
  358. }


  361. static ngx_int_t
  362. ‌ngx_http_secure_link_add_variables(ngx_conf_t *cf)
  363. {
  364.     ngx_http_variable_t  *var;

  366.     var = ngx_http_add_variable(cf, &ngx_http_secure_link_name, 0);
  367.     if (var == NULL) {
  368.         return NGX_ERROR;
  369.     }

  371.     var->get_handler = ngx_http_secure_link_variable;

  373.     var = ngx_http_add_variable(cf, &ngx_http_secure_link_expires_name, 0);
  374.     if (var == NULL) {
  375.         return NGX_ERROR;
  376.     }

  378.     var->get_handler = ngx_http_secure_link_expires_variable;

  380.     return NGX_OK;
  381. }

One Level Up Top Level