ngx_http_auth_jwt_module モジュール

設定例
ディレクティブ
     auth_jwt
     auth_jwt_key_file
組み込み変数

ngx_http_auth_jwt_module モジュール (1.11.3) は指定されたキーを使って提供された JSON Web トークン (JWT) を検証することでクライアント認証を実装します。 JWT の要求は JSON Web Signature (JWS) 構造の中で符号化されていなければなりません。モジュールはOpenID Connect 認証のために使うことができます。

モジュールは、satisfyディレクティブによってngx_http_access_modulengx_http_auth_basic_module および ngx_http_auth_request_moduleのような他のアクセスモジュールと組み合わされるかも知れません。

このモジュールは商用許可の一部として利用可能です。

設定例

location / {
    auth_jwt          "closed site";
    auth_jwt_key_file conf/keys.json;
}

ディレクティブ

構文: auth_jwt string [token=$variable] | off;
デフォルト:
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_key_file file;
デフォルト: -
コンテキスト: http, server, location

JWT署名を検証するためにJSON Web Key Setの中の fileを指定します。パラメータの値には変数に含めることができます。

埋め込み変数

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

JWT claimsを返す変数:

$jwt_claim_aud
audience
$jwt_claim_email
email
$jwt_claim_exp
expiration time
$jwt_claim_iat
issued at
$jwt_claim_iss
issuer
$jwt_claim_jti
JWT ID
$jwt_claim_nbf
not-before
$jwt_claim_sub
subject

JOSE ヘッダのパラメータを返す変数:

$jwt_header_alg
アルゴリズム
$jwt_header_cty
content type
$jwt_header_enc
encryption algorithm
$jwt_header_kid
key ID
$jwt_header_typ
type

TOP
inserted by FC2 system