Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】FILTER_SANITIZE_URL定数の使い方

FILTER_SANITIZE_URL定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

FILTER_SANITIZE_URL定数は、PHPのフィルター機能において、URLとして安全でない文字を取り除き、無害化(サニタイズ)するためのフィルターの種類を表す定数です。ウェブアプリケーション開発では、ユーザーからの入力データが予期せぬ形で悪用されることを防ぐために、データを「サニタイズ」することが非常に重要とされています。特にURLは、悪意のあるスクリプトの埋め込みや、意図しないページへのリダイレクトを引き起こすリスクがあるため、厳格なチェックが求められます。

この定数をfilter_var()関数やfilter_input()関数などの引数として指定すると、入力された文字列から、URLとして不正または危険とみなされる文字が除去されます。具体的には、アルファベット、数字、およびURLの構成要素として一般的な記号(例:-, _, ., /, ?, &, =など)以外の文字が取り除かれたり、URLエンコードされたりすることで、URLとして安全な形式に変換されます。

これにより、アプリケーションが外部から受け取ったURL形式のデータを安全に利用できるようになり、クロスサイトスクリプティング(XSS)などのセキュリティ脆弱性を低減するのに役立ちます。例えば、リダイレクト処理の際にユーザーが指定したURLを使用する場合や、データベースにURLを保存する前などに利用すると効果的です。この定数を使用することで、URLデータに関するセキュリティ対策を簡潔に実装できます。

構文(syntax)

1<?php
2$unsafeUrl = "http://example.com/path with spaces?query=value%";
3$sanitizedUrl = filter_var($unsafeUrl, FILTER_SANITIZE_URL);

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP filter_varによるURLサニタイズ

1<?php
2
3declare(strict_types=1);
4
5/**
6 * URL文字列をPHPのFILTER_SANITIZE_URL定数を使ってサニタイズ(無害化)するデモ関数です。
7 *
8 * FILTER_SANITIZE_URLは、URLとして許可されていない文字(例: スペース、二重引用符、バッククォートなど)を削除します。
9 * 許可される文字は、英数字、および$-_.+!*'(),{}|\^~[]<>#%;/?:@&=です。
10 * このフィルターは、不正な形式のURLや潜在的に危険な文字を取り除くのに役立ちますが、
11 * 'javascript:'のようなURLスキームを検証したり、すべてのXSS攻撃を防ぐものではない点に注意してください。
12 *
13 * @param string $inputUrl サニタイズする元のURL文字列。
14 * @return string サニタイズされたURL文字列。
15 */
16function sanitizeAndDisplayUrl(string $inputUrl): string
17{
18    echo "元のURL:      " . $inputUrl . PHP_EOL;
19
20    // FILTER_SANITIZE_URLフィルターを適用します。
21    // これにより、定義された許可文字セットに含まれない文字が削除されます。
22    $sanitizedUrl = filter_var($inputUrl, FILTER_SANITIZE_URL);
23
24    echo "サニタイズ済みURL: " . $sanitizedUrl . PHP_EOL;
25
26    return $sanitizedUrl;
27}
28
29// 例1: FILTER_SANITIZE_URLで許可されていない文字(スペース、二重引用符、バッククォートなど)を含むURL。
30// これらの文字が削除されることを確認します。
31$urlWithDisallowedChars = "http://example.com/my url with spaces\"and`quotes?name=User Name&value=1";
32sanitizeAndDisplayUrl($urlWithDisallowedChars);
33echo PHP_EOL;
34
35// 例2: 完全に有効なURL。サニタイズによって変更されないことを確認します。
36$validUrl = "https://www.php.net/manual/en/filter.filters.sanitize.php?id=123&name=PHP+Documentation";
37sanitizeAndDisplayUrl($validUrl);
38echo PHP_EOL;
39
40// 例3: FILTER_SANITIZE_URLが"javascript:"のようなスキームを削除しないことを示します。
41// このフィルターは文字レベルのサニタイズであり、スキームの検証やXSS対策を目的としたものではありません。
42$javascriptUrl = "javascript:alert('Hello from JS!');";
43sanitizeAndDisplayUrl($javascriptUrl);
44echo PHP_EOL;
45

このPHPコードは、FILTER_SANITIZE_URL定数を利用してURL文字列を安全な形に「サニタイズ」(無害化)する方法をデモンストレーションしています。FILTER_SANITIZE_URLは、URLとして適切でない文字(例えばスペースや二重引用符、バッククォートなど)を自動的に削除し、英数字と決められた記号のみを含むURL文字列を生成します。

コード内のsanitizeAndDisplayUrl関数は、引数として受け取った$inputUrlに対し、filter_var関数とFILTER_SANITIZE_URLを組み合わせてサニタイズ処理を適用します。その後、元のURLとサニタイズ後のURLの両方を表示し、最終的にサニタイズされたURL文字列を戻り値として返します。

このフィルターは、入力されたURLから不正な文字を取り除く基本的なセキュリティ対策に役立ちます。しかし、「javascript:」のような特定のURLスキームの有効性を検証するものではなく、また、全ての種類のクロスサイトスクリプティング(XSS)攻撃を防ぐものではない点に注意が必要です。より高度な検証には、追加のチェックが必要です。WebアプリケーションでユーザーからのURL入力を処理する際に、この機能はURLの基本的な健全性を保つために非常に有効です。

FILTER_SANITIZE_URLは、URLとして許可されていない特定の文字(スペース、引用符など)を削除し、基本的なURL形式に整えるための定数です。filter_var関数と組み合わせて使用することで、入力されたURL文字列の無害化に役立ちます。

しかし、このフィルターは「javascript:」のような危険なURLスキーム自体を検証したり、除去したりする機能はありません。そのため、FILTER_SANITIZE_URLだけでは、悪意のあるJavaScriptコードを実行させるXSS(クロスサイトスクリプティング)攻撃を完全に防ぐことはできません。

ユーザーからの入力URLをリンクとして表示する際は、このサニタイズ処理に加え、URLのスキームが「http」や「https」などの安全なものであるかを別途バリデーション(検証)し、適切にエスケープするなどの追加対策を必ず実施してください。これにより、より安全にウェブアプリケーションを構築できます。

関連コンテンツ