← 戻る

特殊リクエストヘッダーで真のクライアント IP をバックエンドサーバーに渡す方法

章亦春投稿日 Oct 30, 2023 更新日 Nov 11, 2024

読了時間約7分

閲覧数

本日は、OpenResty Edge の別の機能についてご紹介します。特別なリクエストヘッダーを使用して、実際のクライアント IP アドレスをバックエンドサーバーに渡す機能です。通常、バックエンドサーバーまたはオリジンサーバーが見るクライアント IP アドレスは、実際のクライアント IP アドレスではなく、ゲートウェイやプロキシサーバーの IP アドレスです。オリジンサーバーが実際のクライアント IP アドレスを必要とする場合、新しいリクエストヘッダーを作成し、その実際のアドレスをヘッダーに配置する必要があります。これにより、バックエンドサーバーは直接リクエストヘッダーを読み取ることができます。

アプリケーションのページルールを設定する

OpenResty Edge の Admin Web コンソールにアクセスしましょう。これは当社のコンソールのサンプルデプロイメントです。各ユーザーは独自のローカルデプロイメントを持っています。

以前の例で使用した test-edge.com アプリケーションを引き続き使用します。

そのアプリケーションに移動します。

前回のチュートリアルで、すでにアップストリームを作成しています。

この「my backend」アップストリームに対して、バックエンドサーバーを定義しました。

このバックエンドサーバーの IP アドレスが「.100」で終わっています。後ほどこの IP アドレスを使用します。

また、ページルールも既に定義済みです。

このページルールは、先ほど確認したアップストリームへのリバースプロキシを設定しています。

ここで、クライアント IP を「X-Forwarded-For」リクエストヘッダーとして設定する新しいページルールを追加します。

まず、URI「/test-client-ip/」をチェックするルール条件を有効にします。

ここに選択可能なすべての変数が表示されています。

「URI」を選択します。

演算子として「文字列等価」を選択します。

URI「/test-client-ip/」を入力します。

次に、新しいアクションを追加します。

ここで検索機能を使用できます。

「プロキシヘッダーの設定」を検索します。

それを選択します。

ヘッダー名として「X-Forwarded-For」を入力します。このような要件に対しては、よく使用されるリクエストです。「X-Real-IP」など、お好みの他の名前を使用することもできます。

値のタイプを選択します。リクエストに文字列値を指定することができます。

または、OpenResty Edge が提供する組み込み変数を指定することもできます。

これらは現在サポートされている組み込み変数の一部で、将来的にはさらに多くの組み込み変数がサポートされる予定です。

ここでは「クライアントアドレス」を選択します。

ここをクリックして、このルールが既存の通常ルールの前に実行されるようにします。

このページルールを保存します。

いつものように、先ほどの変更をプッシュするために新しいバージョンをリリースする必要があります。

このボタンをクリックします。

リリースします！

新しいバージョンがすべてのゲートウェイサーバーに同期されました。

これで、新しいページルールがすべてのゲートウェイクラスターとサーバーにプッシュされました。

これらの設定変更には、サーバーのリロード、再起動、またはバイナリのアップグレードは必要ありません。そのため、非常に効率的でスケーラブルです。

テスト

それでは、ゲートウェイサーバーにテストリクエストを送信しましょう。そして、バックエンドサーバーが受け取った「X-Forwarded-For」リクエストヘッダーを確認します。

ターミナルを使用して、イギリスのロンドンにあるリモートサーバーにログインします。

このサーバーの IP アドレスが「.240」で終わっています。

サーバーにログインします。

「curl」コマンドラインツールを使用して HTTP リクエストを送信します。

curl http://test-edge.com/test-client-ip/

したがって、このリクエストの実際のクライアント IP も「.240」で終わるはずです。

サーバーからログアウトします。

次に、IP アドレスが「.100」で終わるバックエンドサーバーにログインします。

nginx 設定ファイルで定義されているアクセスログの形式を確認します。

cd /usr/local/openresty/nginx/

nginx 設定ファイルの最初の 30 行を表示します。

「log format」ディレクティブを見つけます。

「X-Forwarded-For」ヘッダーの値がアクセスログ情報の最後のフィールドであることに注意してください。

バックエンドサーバーのアクセスログファイルの最後の行を確認します。

clear
tail -1 logs/access.log

転送されたリクエストの「X-Forwarded-For」ヘッダーが確かに「.240」で終わる IP アドレスであることがわかります。

実際のクライアントの IP アドレスがリクエストヘッダーに含まれています。

次に、アメリカのサンフランシスコにある別のサーバーにログインします。

このサーバーの IP アドレスが「.226」で終わっていることを覚えておいてください。

サーバーにログインします。

テストリクエストを送信します。

curl http://test-edge.com/test-client-ip/

したがって、このリクエストの実際のクライアント IP も「.226」で終わるはずです。

サーバーからログアウトします。

バックエンドサーバーのアクセスログファイルの最後の行を確認します。

予想通り、転送されたリクエストの「X-Forwarded-For」ヘッダーが確かに「226」で終わっています。

実際のクライアントの IP アドレスが再びリクエストヘッダーに含まれています。

場合によっては、OpenResty Edge ゲートウェイサーバー自体が別のプロキシの背後にある可能性があります。このような場合、OpenResty Edge も特別なリクエストヘッダーから実際のクライアント IP アドレスを読み取る必要があります。この話題については、別のチュートリアルで取り上げさせていただきます。

OpenResty Edge について

OpenResty Edge は、マイクロサービスと分散トラフィックアーキテクチャ向けに設計された多機能ゲートウェイソフトウェアで、当社が独自に開発しました。トラフィック管理、プライベート CDN 構築、API ゲートウェイ、セキュリティ保護などの機能を統合し、現代のアプリケーションの構築、管理、保護を容易にします。OpenResty Edge は業界をリードする性能と拡張性を持ち、高並発・高負荷シナリオの厳しい要求を満たすことができます。K8s などのコンテナアプリケーショントラフィックのスケジューリングをサポートし、大量のドメイン名を管理できるため、大規模ウェブサイトや複雑なアプリケーションのニーズを容易に満たすことができます。

OpenResty Edge の試用を申請する

著者について

章亦春（Zhang Yichun）は、オープンソースの OpenResty^® プロジェクトの創始者であり、OpenResty Inc. の CEO および創業者です。

章亦春（GitHub ID: agentzh）は中国江蘇省生まれで、現在は米国ベイエリアに在住しております。彼は中国における初期のオープンソース技術と文化の提唱者およびリーダーの一人であり、Cloudflare、Yahoo!、Alibaba など、国際的に有名なハイテク企業に勤務した経験があります。「エッジコンピューティング」、「動的トレーシング」、「機械プログラミング」の先駆者であり、22 年以上のプログラミング経験と 16 年以上のオープンソース経験を持っております。世界中で 4000 万以上のドメイン名を持つユーザーを抱えるオープンソースプロジェクトのリーダーとして、彼は OpenResty^® オープンソースプロジェクトをベースに、米国シリコンバレーの中心部にハイテク企業 OpenResty Inc. を設立いたしました。同社の主力製品である OpenResty XRay 動的トレーシング技術を利用した非侵襲的な障害分析および排除ツール）と OpenResty Edge（マイクロサービスおよび分散トラフィックに最適化された多機能ゲートウェイソフトウェア）は、世界中の多くの上場企業および大企業から高い評価を得ております。OpenResty 以外にも、章亦春は Linux カーネル、Nginx、LuaJIT、GDB、SystemTap、LLVM、Perl など、複数のオープンソースプロジェクトに累計 100 万行以上のコードを寄与し、60 以上のオープンソースソフトウェアライブラリを執筆しております。