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アドレス;

複数のサーバ(サービス)で識別子を発行する場合、それぞれのサービスはクライアントの識別子がユニークになるように独自のnumberが割り当てられる必要があります。バージョン1のクッキーでは、デフォルト値はゼロです。バージョン2のクッキーでは、デフォルトの値はサーバのIPアドレスの最後の4オクテットから作られた数値です。

ngx_http_userid_moduleモジュールは次の埋め込み変数をサポートします:

$uid_got

クッキー名と受け取ったクライアントの識別子

$uid_reset

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

$uid_set

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