Mercurial > hg > nginx
view src/http/modules/ngx_http_userid_filter_module.c @ 503:b1648294f693 release-0.1.26
nginx-0.1.26-RELEASE import
*) Change: the invalid client header lines are now ignored and logged
at the info level.
*) Change: the server name is also logged in error log.
*) Feature: the ngx_http_auth_basic_module module and the auth_basic
and auth_basic_user_file directives.
author | Igor Sysoev <igor@sysoev.ru> |
---|---|
date | Tue, 22 Mar 2005 16:02:46 +0000 |
parents | d4ea69372b94 |
children | 9b8c906f6e63 |
line wrap: on
line source
/* * Copyright (C) Igor Sysoev */ #include <ngx_config.h> #include <ngx_core.h> #include <ngx_http.h> #define NGX_HTTP_USERID_OFF 0 #define NGX_HTTP_USERID_LOG 1 #define NGX_HTTP_USERID_V1 2 #define NGX_HTTP_USERID_ON 3 /* 31 Dec 2037 23:55:55 GMT */ #define NGX_HTTP_USERID_MAX_EXPIRES 2145916555 typedef struct { ngx_flag_t enable; ngx_int_t service; ngx_str_t name; ngx_str_t domain; ngx_str_t path; time_t expires; ngx_str_t p3p; } ngx_http_userid_conf_t; typedef struct { uint32_t uid_got[4]; uint32_t uid_set[4]; } ngx_http_userid_ctx_t; static ngx_int_t ngx_http_userid_get_uid(ngx_http_request_t *r, ngx_http_userid_ctx_t *ctx, ngx_http_userid_conf_t *conf); static ngx_int_t ngx_http_userid_set_uid(ngx_http_request_t *r, ngx_http_userid_ctx_t *ctx, ngx_http_userid_conf_t *conf); static size_t ngx_http_userid_log_uid_got_getlen(ngx_http_request_t *r, uintptr_t data); static u_char *ngx_http_userid_log_uid_got(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op); static size_t ngx_http_userid_log_uid_set_getlen(ngx_http_request_t *r, uintptr_t data); static u_char *ngx_http_userid_log_uid_set(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op); static ngx_int_t ngx_http_userid_add_log_formats(ngx_conf_t *cf); static ngx_int_t ngx_http_userid_init(ngx_cycle_t *cycle); static void *ngx_http_userid_create_conf(ngx_conf_t *cf); static char *ngx_http_userid_merge_conf(ngx_conf_t *cf, void *parent, void *child); static char *ngx_http_userid_domain(ngx_conf_t *cf, void *post, void *data); static char *ngx_http_userid_path(ngx_conf_t *cf, void *post, void *data); static char *ngx_http_userid_expires(ngx_conf_t *cf, ngx_command_t *cmd, void *conf); static char *ngx_http_userid_p3p(ngx_conf_t *cf, void *post, void *data); static uint32_t sequencer_v1 = 1; static uint32_t sequencer_v2 = 0x03030302; static u_char expires[] = "; expires=Thu, 31-Dec-37 23:55:55 GMT"; static ngx_http_output_header_filter_pt ngx_http_next_header_filter; static ngx_conf_enum_t ngx_http_userid_state[] = { { ngx_string("off"), NGX_HTTP_USERID_OFF }, { ngx_string("log"), NGX_HTTP_USERID_LOG }, { ngx_string("v1"), NGX_HTTP_USERID_V1 }, { ngx_string("on"), NGX_HTTP_USERID_ON }, { ngx_null_string, 0 } }; static ngx_conf_post_handler_pt ngx_http_userid_domain_p = ngx_http_userid_domain; static ngx_conf_post_handler_pt ngx_http_userid_path_p = ngx_http_userid_path; static ngx_conf_post_handler_pt ngx_http_userid_p3p_p = ngx_http_userid_p3p; static ngx_command_t ngx_http_userid_commands[] = { { ngx_string("userid"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, ngx_conf_set_enum_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, enable), ngx_http_userid_state }, { ngx_string("userid_service"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG, ngx_conf_set_num_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, service), NULL }, { ngx_string("userid_name"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG, ngx_conf_set_str_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, name), NULL }, { ngx_string("userid_domain"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG, ngx_conf_set_str_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, domain), &ngx_http_userid_domain_p }, { ngx_string("userid_path"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG, ngx_conf_set_str_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, path), &ngx_http_userid_path_p }, { ngx_string("userid_expires"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, ngx_http_userid_expires, NGX_HTTP_LOC_CONF_OFFSET, 0, NULL }, { ngx_string("userid_p3p"), NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, ngx_conf_set_str_slot, NGX_HTTP_LOC_CONF_OFFSET, offsetof(ngx_http_userid_conf_t, p3p), &ngx_http_userid_p3p_p }, ngx_null_command }; ngx_http_module_t ngx_http_userid_filter_module_ctx = { ngx_http_userid_add_log_formats, /* pre conf */ NULL, /* create main configuration */ NULL, /* init main configuration */ NULL, /* create server configuration */ NULL, /* merge server configuration */ ngx_http_userid_create_conf, /* create location configration */ ngx_http_userid_merge_conf /* merge location configration */ }; ngx_module_t ngx_http_userid_filter_module = { NGX_MODULE, &ngx_http_userid_filter_module_ctx, /* module context */ ngx_http_userid_commands, /* module directives */ NGX_HTTP_MODULE, /* module type */ ngx_http_userid_init, /* init module */ NULL /* init process */ }; static ngx_http_log_op_name_t ngx_http_userid_log_fmt_ops[] = { { ngx_string("uid_got"), 0, NULL, ngx_http_userid_log_uid_got_getlen, ngx_http_userid_log_uid_got }, { ngx_string("uid_set"), 0, NULL, ngx_http_userid_log_uid_set_getlen, ngx_http_userid_log_uid_set }, { ngx_null_string, 0, NULL, NULL, NULL } }; static ngx_int_t ngx_http_userid_filter(ngx_http_request_t *r) { ngx_int_t rc; ngx_http_userid_ctx_t *ctx; ngx_http_userid_conf_t *conf; conf = ngx_http_get_module_loc_conf(r, ngx_http_userid_filter_module); if (conf->enable == NGX_HTTP_USERID_OFF) { return ngx_http_next_header_filter(r); } ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_userid_ctx_t)); if (ctx == NULL) { return NGX_ERROR; } ngx_http_set_ctx(r, ctx, ngx_http_userid_filter_module); rc = ngx_http_userid_get_uid(r, ctx, conf); if (rc != NGX_OK) { return rc; } if (conf->enable == NGX_HTTP_USERID_LOG || ctx->uid_got[3] != 0) { return ngx_http_next_header_filter(r); } rc = ngx_http_userid_set_uid(r, ctx, conf); if (rc != NGX_OK) { return rc; } return ngx_http_next_header_filter(r); } static ngx_int_t ngx_http_userid_get_uid(ngx_http_request_t *r, ngx_http_userid_ctx_t *ctx, ngx_http_userid_conf_t *conf) { u_char *start, *last, *end; ngx_uint_t i; ngx_str_t src, dst; ngx_table_elt_t **cookies; cookies = r->headers_in.cookies.elts; for (i = 0; i < r->headers_in.cookies.nelts; i++) { ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, "cookie: \"%V\"", &cookies[i]->value); if (conf->name.len >= cookies[i]->value.len) { continue; } start = cookies[i]->value.data; end = cookies[i]->value.data + cookies[i]->value.len; while (start < end) { if (ngx_strncmp(start, conf->name.data, conf->name.len) != 0) { while (start < end && *start++ != ';') { /* void */ } while (start < end && *start == ' ') { start++; } continue; } start += conf->name.len; while (start < end && *start == ' ') { start++; } if (start == end || *start++ != '=') { /* the invalid "Cookie" header */ break; } while (start < end && *start == ' ') { start++; } last = start; while (last < end && *last++ != ';') { /* void */ } if (last - start < 22) { ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "client sent too short userid cookie \"%V\"", &cookies[i]->value); break; } /* * we have to limit encoded string to 22 characters * because there are already the millions cookies with a garbage * instead of the correct base64 trail "==" */ src.len = 22; src.data = start; dst.data = (u_char *) ctx->uid_got; if (ngx_decode_base64(&dst, &src) == NGX_ERROR) { ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "client sent invalid userid cookie \"%V\"", &cookies[i]->value); break; } ngx_log_debug4(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, "uid: %08XD%08XD%08XD%08XD", ctx->uid_got[0], ctx->uid_got[1], ctx->uid_got[2], ctx->uid_got[3]); return NGX_OK; } } return NGX_OK; } static ngx_int_t ngx_http_userid_set_uid(ngx_http_request_t *r, ngx_http_userid_ctx_t *ctx, ngx_http_userid_conf_t *conf) { u_char *cookie, *p; size_t len; socklen_t slen; struct sockaddr_in sin; ngx_str_t src, dst; ngx_table_elt_t *set_cookie, *p3p; /* TODO: mutex for sequencers */ if (conf->enable == NGX_HTTP_USERID_V1) { if (conf->service == NGX_CONF_UNSET) { ctx->uid_set[0] = 0; } else { ctx->uid_set[0] = htonl(conf->service); } ctx->uid_set[1] = ngx_time(); ctx->uid_set[2] = ngx_pid; ctx->uid_set[3] = sequencer_v1; sequencer_v1 += 0x100; } else { if (conf->service == NGX_CONF_UNSET) { if (r->in_addr == 0) { slen = sizeof(struct sockaddr_in); if (getsockname(r->connection->fd, (struct sockaddr *) &sin, &slen) == -1) { ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_socket_errno, "getsockname() failed"); } r->in_addr = sin.sin_addr.s_addr; } ctx->uid_set[0] = htonl(r->in_addr); } else { ctx->uid_set[0] = htonl(conf->service); } ctx->uid_set[1] = htonl(ngx_time()); ctx->uid_set[2] = htonl(ngx_pid); ctx->uid_set[3] = htonl(sequencer_v2); sequencer_v2 += 0x100; if (sequencer_v2 < 0x03030302) { sequencer_v2 = 0x03030302; } } len = conf->name.len + 1 + ngx_base64_encoded_length(16) + conf->path.len; if (conf->expires) { len += sizeof(expires) - 1 + 2; } if (conf->domain.len) { len += conf->domain.len; } cookie = ngx_palloc(r->pool, len); if (cookie == NULL) { return NGX_ERROR; } p = ngx_cpymem(cookie, conf->name.data, conf->name.len); *p++ = '='; src.len = 16; src.data = (u_char *) ctx->uid_set; dst.data = p; ngx_encode_base64(&dst, &src); p += dst.len; if (conf->expires == NGX_HTTP_USERID_MAX_EXPIRES) { p = ngx_cpymem(p, expires, sizeof(expires) - 1); } else if (conf->expires) { p = ngx_cpymem(p, expires, sizeof("; expires=") - 1); p = ngx_http_cookie_time(p, ngx_time() + conf->expires); } if (conf->domain.len) { p = ngx_cpymem(p, conf->domain.data, conf->domain.len); } p = ngx_cpymem(p, conf->path.data, conf->path.len); set_cookie = ngx_list_push(&r->headers_out.headers); if (set_cookie == NULL) { return NGX_ERROR; } set_cookie->key.len = sizeof("Set-Cookie") - 1; set_cookie->key.data = (u_char *) "Set-Cookie"; set_cookie->value.len = p - cookie; set_cookie->value.data = cookie; ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, "uid cookie: \"%V\"", &set_cookie->value); if (conf->p3p.len == 0) { return NGX_OK; } p3p = ngx_list_push(&r->headers_out.headers); if (p3p == NULL) { return NGX_ERROR; } p3p->key.len = sizeof("P3P") - 1; p3p->key.data = (u_char *) "P3P"; p3p->value = conf->p3p; return NGX_OK; } static size_t ngx_http_userid_log_uid_got_getlen(ngx_http_request_t *r, uintptr_t data) { ngx_http_userid_ctx_t *ctx; ngx_http_userid_conf_t *conf; ctx = ngx_http_get_module_ctx(r, ngx_http_userid_filter_module); if (ctx == NULL || ctx->uid_got[3] == 0) { return 1; } conf = ngx_http_get_module_loc_conf(r, ngx_http_userid_filter_module); return conf->name.len + 1 + 32; } static u_char * ngx_http_userid_log_uid_got(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op) { ngx_http_userid_ctx_t *ctx; ngx_http_userid_conf_t *conf; ctx = ngx_http_get_module_ctx(r, ngx_http_userid_filter_module); if (ctx == NULL || ctx->uid_got[3] == 0) { *buf = '-'; return buf + 1; } conf = ngx_http_get_module_loc_conf(r, ngx_http_userid_filter_module); buf = ngx_cpymem(buf, conf->name.data, conf->name.len); *buf++ = '='; return ngx_sprintf(buf, "%08XD%08XD%08XD%08XD", ctx->uid_got[0], ctx->uid_got[1], ctx->uid_got[2], ctx->uid_got[3]); } static size_t ngx_http_userid_log_uid_set_getlen(ngx_http_request_t *r, uintptr_t data) { ngx_http_userid_ctx_t *ctx; ngx_http_userid_conf_t *conf; ctx = ngx_http_get_module_ctx(r, ngx_http_userid_filter_module); if (ctx == NULL || ctx->uid_set[3] == 0) { return 1; } conf = ngx_http_get_module_loc_conf(r, ngx_http_userid_filter_module); return conf->name.len + 1 + 32; } static u_char * ngx_http_userid_log_uid_set(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op) { ngx_http_userid_ctx_t *ctx; ngx_http_userid_conf_t *conf; ctx = ngx_http_get_module_ctx(r, ngx_http_userid_filter_module); if (ctx == NULL || ctx->uid_set[3] == 0) { *buf = '-'; return buf + 1; } conf = ngx_http_get_module_loc_conf(r, ngx_http_userid_filter_module); buf = ngx_cpymem(buf, conf->name.data, conf->name.len); *buf++ = '='; return ngx_sprintf(buf, "%08XD%08XD%08XD%08XD", ctx->uid_set[0], ctx->uid_set[1], ctx->uid_set[2], ctx->uid_set[3]); } static ngx_int_t ngx_http_userid_add_log_formats(ngx_conf_t *cf) { ngx_http_log_op_name_t *op; for (op = ngx_http_userid_log_fmt_ops; op->name.len; op++) { /* void */ } op->run = NULL; for (op = ngx_http_log_fmt_ops; op->run; op++) { if (op->name.len == 0) { op = (ngx_http_log_op_name_t *) op->run; } } op->run = (ngx_http_log_op_run_pt) ngx_http_userid_log_fmt_ops; return NGX_OK; } static ngx_int_t ngx_http_userid_init(ngx_cycle_t *cycle) { ngx_http_next_header_filter = ngx_http_top_header_filter; ngx_http_top_header_filter = ngx_http_userid_filter; return NGX_OK; } static void * ngx_http_userid_create_conf(ngx_conf_t *cf) { ngx_http_userid_conf_t *conf; conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_userid_conf_t)); if (conf == NULL) { return NGX_CONF_ERROR; } /* * set by ngx_pcalloc(): * * conf->name.len = 0; * conf->name.date = NULL; * conf->domain.len = 0; * conf->domain.date = NULL; * conf->path.len = 0; * conf->path.date = NULL; * conf->p3p.len = 0; * conf->p3p.date = NULL; */ conf->enable = NGX_CONF_UNSET; conf->service = NGX_CONF_UNSET; conf->expires = NGX_CONF_UNSET; return conf; } static char * ngx_http_userid_merge_conf(ngx_conf_t *cf, void *parent, void *child) { ngx_http_userid_conf_t *prev = parent; ngx_http_userid_conf_t *conf = child; ngx_conf_merge_value(conf->enable, prev->enable, NGX_HTTP_USERID_OFF); ngx_conf_merge_str_value(conf->name, prev->name, "uid"); ngx_conf_merge_str_value(conf->domain, prev->domain, ""); ngx_conf_merge_str_value(conf->path, prev->path, "; path=/"); ngx_conf_merge_str_value(conf->p3p, prev->p3p, ""); ngx_conf_merge_value(conf->service, prev->service, NGX_CONF_UNSET); ngx_conf_merge_sec_value(conf->expires, prev->expires, 0); return NGX_CONF_OK; } static char * ngx_http_userid_domain(ngx_conf_t *cf, void *post, void *data) { ngx_str_t *domain = data; u_char *p, *new; if (ngx_strcmp(domain->data, "none") == 0) { domain->len = 0; domain->data = (u_char *) ""; return NGX_CONF_OK; } new = ngx_palloc(cf->pool, sizeof("; domain=") - 1 + domain->len); if (new == NULL) { return NGX_CONF_ERROR; } p = ngx_cpymem(new, "; domain=", sizeof("; domain=") - 1); ngx_memcpy(p, domain->data, domain->len); domain->len += sizeof("; domain=") - 1; domain->data = new; return NGX_CONF_OK; } static char * ngx_http_userid_path(ngx_conf_t *cf, void *post, void *data) { ngx_str_t *path = data; u_char *p, *new; new = ngx_palloc(cf->pool, sizeof("; path=") - 1 + path->len); if (new == NULL) { return NGX_CONF_ERROR; } p = ngx_cpymem(new, "; path=", sizeof("; path=") - 1); ngx_memcpy(p, path->data, path->len); path->len += sizeof("; path=") - 1; path->data = new; return NGX_CONF_OK; } static char * ngx_http_userid_expires(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) { ngx_http_userid_conf_t *ucf = conf; ngx_str_t *value; if (ucf->expires != NGX_CONF_UNSET) { return "is duplicate"; } value = cf->args->elts; if (ngx_strcmp(value[1].data, "max") == 0) { ucf->expires = NGX_HTTP_USERID_MAX_EXPIRES; return NGX_CONF_OK; } if (ngx_strcmp(value[1].data, "off") == 0) { ucf->expires = 0; return NGX_CONF_OK; } ucf->expires = ngx_parse_time(&value[1], 1); if (ucf->expires == NGX_ERROR) { return "invalid value"; } if (ucf->expires == NGX_PARSE_LARGE_TIME) { return "value must be less than 68 years"; } return NGX_CONF_OK; } static char * ngx_http_userid_p3p(ngx_conf_t *cf, void *post, void *data) { ngx_str_t *p3p = data; if (ngx_strcmp(p3p->data, "none") == 0) { p3p->len = 0; p3p->data = (u_char *) ""; } return NGX_CONF_OK; }