ngx_http_auth_jwt_module モジュール
設定例 ディレクティブ auth_jwt auth_jwt_header_set auth_jwt_claim_set auth_jwt_key_file Embedded Variables |
ngx_http_auth_jwt_module
モジュール (1.11.3) は指定されたキーを使って提供された JSON Web トークン (JWT) を検証することでクライアント認証を実装します。 JWT の要求は JSON Web Signature (JWS) 構造の中で符号化されていなければなりません。モジュールはOpenID Connect 認証のために使うことができます。
モジュールは、satisfyディレクティブによってngx_http_access_module、ngx_http_auth_basic_module および ngx_http_auth_request_moduleのような他のアクセスモジュールと組み合わされるかも知れません。
このモジュールは商用許可の一部として利用可能です。
設定例
location / { auth_jwt "closed site"; auth_jwt_key_file conf/keys.json; }
ディレクティブ
構文: |
auth_jwt
|
---|---|
デフォルト: |
auth_jwt off; |
コンテキスト: |
http , server , location |
JSON Webトークンの検証を有効にします。指定された文字列
はrealm
として使われます。パラメータの値には変数に含めることができます。
任意のtoken
パラメータはJSON Webトークンを含む変数を指定します。デフォルトでは、JWTはBearer トークンとして "Authorization" の中に渡されます。JWT はクッキーまたはクエリ文字列の一部としても渡されるかも知れません:
auth_jwt "closed site" token=$cookie_auth_token;
特別な値 off
は上の設定レベルから受け継いだauth_jwt
ディレクティブの影響をキャンセルします。
構文: |
auth_jwt_header_set |
---|---|
デフォルト: | - |
コンテキスト: |
http |
このディレクティブはバージョン1.11.10から導入されました。
変数
を指定されたJOSEヘッダパラメータname
に設定する。
構文: |
auth_jwt_claim_set |
---|---|
デフォルト: | - |
コンテキスト: |
http |
このディレクティブはバージョン1.11.10から導入されました。
変数
を指定されたJWT claimパラメータname
に設定する。
構文: |
auth_jwt_key_file |
---|---|
デフォルト: | - |
コンテキスト: |
http , server , location |
JWT署名を検証するためにJSON Web Key Setの中の file
を指定します。パラメータの値には変数に含めることができます。
埋め込み変数
ngx_http_auth_jwt_module
モジュールは埋め込みの変数をサポートします: