モジュール ngx_http_userid_module

ngx_http_userid_moduleモジュールは、クライアントの識別に適したクッキーを設定します。受信および設定されたクッキーは、組み込み変数$uid_gotと$uid_setを使用してログに記録できます。このモジュールは、Apacheのmod_uidモジュールと互換性があります。

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 off;

クッキーの設定と受信したクッキーのログ記録を有効または無効にします

on

バージョン2のクッキーの設定と受信したクッキーのログ記録を有効にします。

v1

バージョン1のクッキーの設定と受信したクッキーのログ記録を有効にします。

log

クッキーの設定を無効にし、受信したクッキーのログ記録を有効にします。

off

クッキーの設定と受信したクッキーのログ記録を無効にします。

userid_domain none;

クッキーが設定されるドメインを定義します。noneパラメータは、クッキーのドメインの設定を無効にします。

userid_expires off;

ブラウザがクッキーを保持する時間を設定します。パラメータmaxは、クッキーが「31 Dec 2037 23:55:55 GMT」に期限切れになるようにします。パラメータoffは、ブラウザセッションの終了時にクッキーが期限切れになるようにします。

userid_flags off;

パラメータがoffでない場合、クッキーに追加のフラグを1つ以上定義します：secure、httponly、samesite=strict、samesite=lax、samesite=none。

userid_mark off;

パラメータがoffでない場合、クッキーのマーク機構を有効にし、マークとして使用する文字を設定します。この機構は、クライアント識別子を保持したままuserid_p3pおよび/またはクッキーの有効期限を追加または変更するために使用されます。マークには、英字（大文字と小文字を区別）、数字、または「=」文字を使用できます。

マークが設定されている場合、クッキーで渡されたクライアント識別子のbase64表現の最初のパディングシンボルと比較されます。一致しない場合、クッキーは指定されたマーク、有効期限、および「P3P」ヘッダーとともに再送信されます。

userid_name uid;

クッキーの名前を設定します。

userid_p3p none;

クッキーとともに送信される「P3P」ヘッダーフィールドの値を設定します。ディレクティブが特別な値noneに設定されている場合、「P3P」ヘッダーは応答で送信されません。

userid_path /;

クッキーが設定されるパスを定義します。

userid_service IP address of the server;

識別子が複数のサーバー（サービス）によって発行される場合、クライアント識別子が確実に一意になるように、各サービスに独自のnumberを割り当てる必要があります。バージョン1のクッキーの場合、デフォルト値はゼロです。バージョン2のクッキーの場合、デフォルト値はサーバーのIPアドレスの最後の4オクテットから構成される数値です。

ngx_http_userid_moduleモジュールは、以下の組み込み変数をサポートしています

$uid_got

クッキー名と受信したクライアント識別子。

$uid_reset

変数が空でない文字列「0」以外に設定されている場合、クライアント識別子がリセットされます。特別な値「log」は、さらにリセットされた識別子に関するメッセージをerror_logに出力します。

$uid_set

クッキー名と送信されたクライアント識別子。