HTMLエスケープとは
HTMLでは < や > がタグの開始・終了として解釈されます。これらの文字をそのまま文字として表示したいときは、文字実体参照に置き換える必要があります。この置き換えを HTML エスケープと呼びます。
| 文字 | 実体参照 | 数値参照 |
|---|---|---|
& | & | & |
< | < | < |
> | > | > |
" | " | " |
' | ' | ' |
どんなときに使う?
- ブログや技術記事に HTML / XML のソースコードを掲載するとき
- メールテンプレートや CMS で記号が崩れるとき
- XSS(クロスサイトスクリプティング)対策として、ユーザー入力が正しくエスケープされているか確認するとき
- スクレイピングで取得した
&だらけのテキストを読める形に戻すとき
アンエスケープの対応範囲
アンエスケープは © などの名前付き実体参照、あ のような10進数値参照、あ のような16進数値参照のすべてに対応しています。
各言語でHTMLエスケープする
Webアプリケーションでは、ユーザーの入力をHTMLに出力するたびに必ずエスケープします。ほとんどの言語に標準の関数があります。
| 言語 | エスケープ | アンエスケープ(復元) |
|---|---|---|
| PHP | htmlspecialchars($s, ENT_QUOTES, 'UTF-8') | htmlspecialchars_decode($s, ENT_QUOTES) |
| JavaScript | 標準関数なし。element.textContent = s で代入するか、5文字を replace で置換 | new DOMParser().parseFromString(s, 'text/html').body.textContent |
| Python | html.escape(s) | html.unescape(s) |
| Ruby | CGI.escapeHTML(s) / ERB::Util.html_escape(s) | CGI.unescapeHTML(s) |
| Java | StringEscapeUtils.escapeHtml4(s)(Commons Text)/ HtmlUtils.htmlEscape(s)(Spring) | StringEscapeUtils.unescapeHtml4(s) |
| Go | html.EscapeString(s) | html.UnescapeString(s) |
| C# | WebUtility.HtmlEncode(s) | WebUtility.HtmlDecode(s) |
Twig・Blade・Jinja2・React・Vue などのテンプレートエンジンやフレームワークは、変数の出力を自動でエスケープします。自動エスケープを無効にする構文({!! !!}、|safe、dangerouslySetInnerHTML など)を使うときだけ、XSS に注意してください。
エスケープが必要な文字は5つだけ
HTML として意味を持つのは & < > " ' の5文字で、エスケープが必要なのもこの5文字です。日本語や記号、スペースはそのまま書けます。 (改行されないスペース)や ©(©)のような実体参照は、入力しにくい文字を書くための手段で、エスケープとは目的が違います。<meta charset="UTF-8"> を指定していれば、© や — もそのまま書けます。
二重エスケープに注意
すでにエスケープ済みの文字列をもう一度エスケープすると、< が &lt; になり、画面に < という文字がそのまま表示されてしまいます。「& が表示される」「< がそのまま見える」ときは、保存時と表示時の両方でエスケープしていないか確認してください。原則は保存はそのまま、表示するときに1回だけエスケープです。
実体参照ではなく文字そのものが化けている場合(「縺薙s」や「ã“ã‚“」など)は、文字コードの読み違いが原因です。文字化け復元で戻せます。
よくある質問
日本語はエスケープする必要がありますか?
必要ありません。HTML で特別な意味を持つのは & < > " ' だけで、日本語や絵文字は文字コードを UTF-8 に揃えていればそのまま書けます。あ のような数値参照にするのは、文字コードが指定できない環境などに限られます。
と半角スペースの違いは?
(no-break space)は「そこで改行しない」「連続しても1つにまとめられない」スペースです。通常の半角スペースは HTML では連続しても1つにまとめられ、行の折り返し位置にもなります。レイアウト調整には CSS の padding や white-space を使うほうが安全です。
& のように二重にエスケープされてしまいます
データを保存するときと表示するときの両方でエスケープしている状態です。保存時はエスケープせずそのまま保存し、HTML に出力するときに1回だけエスケープするのが基本です。すでに壊れたデータは、このツールでアンエスケープすると元に戻せます。
シングルクォートはなぜ ' なのですか?
' は HTML4 で定義されておらず、古いブラウザで表示されないことがあるため、互換性の高い数値参照 ' を使っています。
エスケープだけでXSS対策は十分ですか?
HTML本文や属性値の中ではエスケープが基本の対策です。ただし href 属性の javascript: スキームや、<script> 内への出力などは別の対策が必要です。