HOWTO · PHP
PHP でユーザーIP アドレスを取得する
このチュートリアルでは、PHP でユーザーの IP アドレスを取得する方法を示します
このページの内容
PHP リクエストに関連付けられたネットワークアドレスを取得するには、$_SERVER['REMOTE_ADDR'] を使います。これは Web サーバーに接続した相手側のアドレスです。アプリケーションの前段にリバースプロキシがある場合、接続相手は訪問者ではなくプロキシの可能性があります。プロキシ関連のリクエストヘッダーを使用できるのは、それらを送信して検証するプロキシをアプリケーションが明示的に信頼する設定になっている場合に限られます。
$_SERVER['REMOTE_ADDR'] で接続相手のアドレスを取得する
$_SERVER は、サーバーとリクエストに関する情報を含む PHP のスーパーグローバルです。その REMOTE_ADDR 要素には、リクエストを処理するサーバーに接続した相手側のアドレスが格納されます。サーバーに直接接続している場合、通常は接続元クライアントのアドレスです。ロードバランサーやリバースプロキシを経由する場合は、多くの場合、プロキシのアドレスになります。PHP が受け取る値は Web サーバーとプロキシの設定によって決まるため、必ずエンドユーザーのアドレスになるとは限りません。
ローカル環境からのリクエストでは、接続相手のアドレスが IPv6 のループバックアドレス ::1 になることがあります。ループバックアドレスはローカルマシンを指します。::1 は IPv6 のループバックアドレスで、IPv4 の 127.0.0.1 に相当します。実際の値はローカルサーバーと接続方法によって異なります。ループバックアドレスの説明も参照してください。
次の実行可能な例では、取得処理だけで完結するよう、代表的なサーバー値を設定しています。display_output は false のままなので、値を取得しますが画面には出力しません。アプリケーションでは、用途に応じてレスポンスやログにこの値を使用してください。
このセクションのコードと表示されるラベルや出力は英語のままです。
<?php
$_SERVER['REMOTE_ADDR'] = '::1';
$peerAddress = $_SERVER['REMOTE_ADDR'];
$display_output = false;
if ($display_output) {
echo "The connected peer is: " . $peerAddress . PHP_EOL;
}
?>
実際のリクエストでは、サンプル値を代入せず、サーバーが提供する $_SERVER['REMOTE_ADDR'] の値を使用してください。PHP マニュアルのサーバー変数リファレンスでは、利用可能な $_SERVER の要素が説明されています。
プロキシを信頼できる場合に限りプロキシヘッダーを解釈する
PHP では、HTTP_X_FORWARDED_FOR や HTTP_CLIENT_IP などのリクエストヘッダーが $_SERVER の要素として公開されることがあります。値が存在しても、それが訪問者のアドレスだとは限りません。クライアント自身がヘッダー値を送信できますし、プロキシが値をそのまま渡したり、追加したり、置き換えたりすることもあります。特に HTTP_X_FORWARDED_FOR には、単一のアドレスではなく、カンマ区切りのアドレス列が入る場合があります。インフラの文書化された信頼ルールを適用せずに先頭の値を選び、それを実際のクライアントアドレスとみなしてはいけません。
転送された値を使うのは、接続相手がアプリケーションで明示的に信頼しているプロキシと一致し、かつ、そのプロキシがクライアントから送られた転送ヘッダーを削除または検証する設定になっている場合に限ってください。信頼するプロキシの一覧は実際のデプロイ環境に合わせます。サンプルのアドレスをそのまま本番設定に使わないでください。接続相手を信頼できない場合は REMOTE_ADDR を使用します。HTTP_CLIENT_IP にも同じ信頼上の問題があるため、共有インターネット接続からのアクセスを判定する特別な値として使うべきではありません。
次の実行可能な例は、信頼するプロキシが X-Forwarded-For を検証済みの単一アドレスで上書きする環境を想定しています。サンプルのプロキシアドレスと検証方針は、実際のインフラで定めた値に置き換えてください。この例では、代表値に対して選択された転送先アドレスを出力します。複数プロキシのアドレス列を解析する処理は含まれていません。
このセクションのコードと表示されるラベルや出力は英語のままです。
<?php
$_SERVER['REMOTE_ADDR'] = '192.0.2.10';
$_SERVER['HTTP_X_FORWARDED_FOR'] = '198.51.100.24';
$trustedProxies = ['192.0.2.10'];
$peerAddress = $_SERVER['REMOTE_ADDR'];
if (in_array($peerAddress, $trustedProxies, true)
&& isset($_SERVER['HTTP_X_FORWARDED_FOR'])
&& filter_var($_SERVER['HTTP_X_FORWARDED_FOR'], FILTER_VALIDATE_IP) !== false) {
$clientAddress = $_SERVER['HTTP_X_FORWARDED_FOR'];
} else {
$clientAddress = $peerAddress;
}
echo "Selected address: " . $clientAddress . PHP_EOL;
?>
Selected address: 198.51.100.24
filter_var() のドキュメントでは、ここで使う検証関数が説明されています。文字列が IP アドレスとして有効かを検証しても、信頼できる送信元から届いたことまでは確認できません。その信頼性は、接続相手の確認とプロキシ設定によって判断します。プロキシがアドレス列を転送する場合は、実際のデプロイ環境で定めた信頼ルールに従って列をたどるフレームワーク、または慎重にレビューされたコードを使用してください。
条件式で簡潔なフォールバックを記述する
読みやすい if/elseif/else ブロックは、特にプロキシの信頼確認を含む場合、通常は監査しやすい書き方です。条件式を使うと同じ選択を簡潔に表現できますが、信頼できないヘッダーが安全になるわけではありません。次の実行可能な例は、信頼するプロキシの確認を行い、上で説明した単一アドレスへの上書き方針を使います。サーバー値は代表例で、選択された転送先アドレスを出力します。
このセクションのコードと表示されるラベルや出力は英語のままです。
<?php
$_SERVER['REMOTE_ADDR'] = '192.0.2.10';
$_SERVER['HTTP_X_FORWARDED_FOR'] = '198.51.100.24';
$trustedProxies = ['192.0.2.10'];
$peerAddress = $_SERVER['REMOTE_ADDR'];
$forwardedAddress = $_SERVER['HTTP_X_FORWARDED_FOR'] ?? '';
$clientAddress = in_array($peerAddress, $trustedProxies, true)
&& filter_var($forwardedAddress, FILTER_VALIDATE_IP) !== false
? $forwardedAddress
: $peerAddress;
echo "Selected address: " . $clientAddress . PHP_EOL;
?>
Selected address: 198.51.100.24
フォールバックの順序には意味があります。接続相手が信頼するプロキシの一覧にある場合に限り、検証済みの転送先アドレスを採用します。それ以外の場合は、接続相手のアドレスを使います。括弧を使うと入れ子の条件式が読みやすくなることがありますが、ネストした三項演算子は保守しにくく、信頼確認の代わりにはなりません。クライアントが自分のヘッダーを信頼済み入力として扱わせることのないよう、プロキシのヘッダー処理とアプリケーションの許可リストを一致させてください。