Модуль ngx_http_userid_module
- Пример конфигурации
- Директивы
- userid
- userid_domain
- userid_expires
- userid_flags
- userid_mark
- userid_name
- userid_p3p
- userid_path
- userid_service
- Встроенные переменные
Модуль ngx_http_userid_module устанавливает куки, подходящие для идентификации клиента. Полученные и установленные куки можно регистрировать, используя встроенные переменные $uid_got и $uid_set. Этот модуль совместим с модулем mod_uid для Apache.
Пример конфигурации
userid on; userid_name uid; userid_domain example.com; userid_path /; userid_expires 365d; userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
Директивы
| Синтаксис: | userid
on |
v1 |
log |
off; |
|---|---|
| По умолчанию: | userid off; |
| Контекст: | http, server, location |
Включает или отключает установку куки и регистрирование полученных куки:
on- включает установку куки версии 2 и регистрирование полученных куки;
v1- включает установку куки версии 1 и регистрирование полученных куки;
log- отключает установку куки, но включает регистрирование полученных куки;
off- отключает установку куки и регистрирование полученных куки.
| Синтаксис: | userid_domain name | none; |
|---|---|
| По умолчанию: | userid_domain none; |
| Контекст: | http, server, location |
Определяет домен, для которого устанавливается куки. Параметр none отключает установку домена для куки.
| Синтаксис: | userid_expires time | max |
off; |
|---|---|
| По умолчанию: | userid_expires off; |
| Контекст: | http, server, location |
Устанавливает время, в течение которого браузер должен хранить куки. Параметр max приведет к истечению срока действия куки в “31 Dec 2037 23:55:55 GMT”. Параметр off приведет к истечению срока действия куки в конце сессии браузера.
| Синтаксис: | userid_flags
off |
flag ...; |
|---|---|
| По умолчанию: | userid_flags off; |
| Контекст: | http, server, location |
Эта директива появилась в версии 1.19.3.
Если параметр не off, определяет один или несколько дополнительных флагов для куки: secure, httponly, samesite=strict, samesite=lax, samesite=none.
| Синтаксис: | userid_mark
letter | digit |
= |
off; |
|---|---|
| По умолчанию: | userid_mark off; |
| Контекст: | http, server, location |
Если параметр не off, включает механизм маркировки куки и устанавливает символ, используемый в качестве метки. Этот механизм используется для добавления или изменения userid_p3p и/или времени истечения срока действия куки, сохраняя при этом идентификатор клиента. Метка может быть любой буквой английского алфавита (регистрозависимая), цифрой или символом “=”.
Если метка установлена, она сравнивается с первым символом заполнения в base64 представлении идентификатора клиента, переданного в куки. Если они не совпадают, куки пересылается заново с указанной меткой, временем истечения срока действия и заголовком “P3P”.
| Синтаксис: | userid_name name; |
|---|---|
| По умолчанию: | userid_name uid; |
| Контекст: | http, server, location |
Устанавливает имя куки.
| Синтаксис: | userid_p3p string | none; |
|---|---|
| По умолчанию: | userid_p3p none; |
| Контекст: | http, server, location |
Устанавливает значение для поля заголовка “P3P”, которое будет отправлено вместе с куки. Если директива установлена на специальное значение none, заголовок “P3P” не будет отправлен в ответе.
| Синтаксис: | userid_path path; |
|---|---|
| По умолчанию: | userid_path /; |
| Контекст: | http, server, location |
Определяет путь, для которого устанавливается куки.
| Синтаксис: | userid_service number; |
|---|---|
| По умолчанию: | userid_service IP address of the server; |
| Контекст: | http, server, location |
Если идентификаторы выдаются несколькими серверами (сервисами), каждый сервис должен получить свой собственный number, чтобы обеспечить уникальность идентификаторов клиентов. Для куки версии 1 значение по умолчанию равно нулю. Для куки версии 2 значение по умолчанию равно числу, составленному из последних четырех октетов IP-адреса сервера.
Встроенные переменные
Модуль ngx_http_userid_module поддерживает следующие встроенные переменные:
$uid_got- Имя куки и полученный идентификатор клиента.
$uid_reset- Если переменная установлена на непустую строку, отличную от “
0”, идентификаторы клиентов сбрасываются. Специальное значение “log” дополнительно приводит к выводу сообщений о сброшенных идентификаторах в error_log. $uid_set- Имя куки и отправленный идентификатор клиента.
© 2002-2021 Igor Sysoev
© 2011-2024 Nginx, Inc.
Licensed under the BSD License.
https://nginx.org/en/docs/http/ngx_http_userid_module.html
