信頼済みリバースプロキシ認証
概要¶
信頼済みリバースプロキシが付与するHTTPヘッダーからユーザ名を取得し、自動ログインする機能について説明します。
注意事項¶
- 本機能は、クライアントが当該ヘッダーを直接偽装できない構成(リバースプロキシが必ずヘッダーを上書きする構成)でのみ使用してください。
- 公開環境で適切なネットワーク制限なしに有効化すると、なりすましリスクがあります。
パラメータTrustedProxyParametersの設定¶
以下を参考に、設定ファイルAuthentication.jsonのパラメータTrustedProxyParametersを設定してください。
| パラメータ名 | 設定例 | 説明 |
|---|---|---|
| Enabled | true | trueを指定すると機能を有効化します。 環境変数TRUSTED_PROXY_AUTH_ENABLEDが設定されている場合、その値が優先されます。 |
| Header | "X-Forwarded-User" | ユーザ名が格納されているHTTPヘッダー名を指定します。 環境変数TRUSTED_PROXY_AUTH_HEADERが設定されている場合、その値が優先されます。 |
Authentication.jsonの 設定例¶
環境変数による設定と優先順位¶
以下の環境変数が設定されている場合は、Authentication.jsonの値より優先されます。
| 環境変数名 | 対応 パラメータ | 動作 |
|---|---|---|
| TRUSTED_PROXY_AUTH_ENABLED | Enabled | 空文字以外の値 機能が有効になります。true以外の値(例えば1など)でも有効化されます。 |
| TRUSTED_PROXY_AUTH_HEADER | Header | 空でない場合 この環境変数の値を使用します。 空の場合 Authentication.jsonのパラメータHeaderの値を使用します。 |
送信元IPによる制限について¶
特定の送信元からのリクエストのみを自動ログインの対象とするには、必ずSecurity.jsonのパラメータForwardedHeaders.KnownNetworksまたはForwardedHeaders.KnownProxiesを設定してください。詳細はSecurity.jsonを参照してください。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| バージョン 1.5.3.0 以降 | 機能追加 |
