エスケープが必要な理由
データには、書き込む先で特別な意味を持つ文字が混ざることがあります。たとえば HTML の < はタグの始まり、SQL の ' は文字列の終わり、URL の & はクエリの区切りです。こうした文字を、ただの文字として扱わせる処理がエスケープです。
エスケープをし忘れると、入力した値が「データ」ではなく「命令」として実行されます。これが、XSS(スクリプトの埋め込み)や SQL インジェクションの原因です。
出力先ごとの方法
| 出力先 | 特別な文字 | 方法 | 例 |
|---|---|---|---|
| HTML の本文 | < > & | HTML実体参照 | < → < |
| HTML の属性値 | " ' と < & | 実体参照(属性値は必ず引用符で囲む) | " → " |
| URL のクエリの値 | & = # ? +、日本語など | パーセントエンコード | & → %26 |
| JavaScript の文字列 | " ' \ と改行、</script> | バックスラッシュ(\)で始まる表記 | " → \" |
| JSON | " \ と制御文字 | JSON の規則でエスケープ(自作せず、ライブラリで作る) | 改行 → \n |
| SQL | ' など | エスケープより、プレースホルダ(後述) | — |
| 正規表現 | . * + ? ( ) [ ] { } ^ $ | \ | バックスラッシュを前に付ける | . → \. |
HTML 用のエスケープは、HTML の中に書くときだけ有効です。URL に入れるなら URL 用、JSON を作るなら JSON 用の方法が必要です。「何でも安全にするエスケープ」はありません。
XSS を防ぐ:HTML に出力するとき
ユーザーが入力した <script>alert(1)</script> を、そのまま HTML に書くと、画面でスクリプトとして動いてしまいます。HTML エスケープを通すと、<script>... となり、ただの文字として表示されます。
- エスケープは「入力するとき」ではなく「出力するとき」に行う。同じデータでも、HTML に出すか、CSV に出すかで、必要な処理が違うため
- 引用符で囲んでいない属性値に、ユーザーの入力を入れない。スペースだけで属性を増やせてしまう
- リンクの URL(
href)は、javascript:で始まるものを許可しない。HTML エスケープでは防げない
実際の変換はHTMLエスケープで試せます。
SQL インジェクションを防ぐ:プレースホルダを使う
SQL に文字列を連結して組み立てると、入力の ' で文字列を閉じて、別の命令を書かれてしまいます。対策は、文字をエスケープすることより、プレースホルダ(バインド変数)を使うことです。
| 悪い例(文字列の連結) | よい例(プレースホルダ) |
|---|---|
"SELECT * FROM users WHERE name = '" + name + "'" | SELECT * FROM users WHERE name = ?(値は別に渡す) |
プレースホルダでは、SQL の文と値が別々にデータベースへ届くため、値が命令として読まれることがありません。ORM やクエリビルダーも、内部でこの方法を使っています。
フレームワークの自動エスケープ
多くのテンプレートエンジンやフレームワークは、画面に出す値を自動で HTML エスケープします。React の {value}、Twig の {{ value }}、Laravel Blade の {{ $value }} などです。
ところが、これを無効にする書き方があります。React の dangerouslySetInnerHTML、Twig の |raw、Blade の {!! $value !!} などです。ユーザーの入力をこれらで出力すると、XSS の原因になります。どうしても必要なときは、許可するタグを絞った専用のライブラリで消毒してから使います。
二重エスケープと、エスケープし忘れ
- 二重エスケープ:すでにエスケープされた値を、もう一度エスケープすると、
&lt;のような表示になり、画面に<がそのまま見える。URL でも同じで、%25E3...のような二重エンコードになる(URLの構造と読み方)。 - エスケープし忘れ:自動エスケープがない場所(メール本文のHTML、JavaScript の文字列、PDF生成など)で、同じつもりでそのまま出力して漏れる。
- 文字コードの混同:エスケープは文字の意味を変える処理で、文字コードの変換(文字コード入門)とは別の話。
JSON の中の「\uXXXX」
JSON では、日本語が あ のような形で書かれていることがあります。これは文字のエスケープの一種で、読み込めば元の文字(あ)に戻ります。日本語に戻したいときはUnicodeエスケープで変換できます。
正規表現でエスケープが必要な場面
ユーザーの入力を正規表現に使うときは、そのまま入れると、. が「任意の1文字」、( が「グループの始まり」などと解釈され、思わぬ結果になったり、エラーになったりします。入力を「ただの文字」として検索したいときは、特別な文字の前に \ を付けます。正規表現テスターで、エスケープの有無による違いを試せます。
覚えておく3つのこと
- エスケープは出力先で決まる。HTML、URL、JSON、SQL で方法がちがう。
- エスケープは出力するときに行う。
- SQL は文字をエスケープせず、プレースホルダで値を渡す。