既定でエスケープするテンプレート
なぜ大切か HTML を手で貼り合わせることはめったにありません。本物のサイトはテンプレートを使い、良いテンプレートの仕組みはすべての値をエスケープしてくれます。あなたの仕事はほとんど、うっかり それをオフにしない ことと、それをオフにする少しのスイッチに気づくことです。
たとえ:代わりにブレーキをかける車
現代の車は、何かにぶつかりそうになると自動でブレーキをかけます。その機能はオフにでき、ときには十分な理由があります。でもオフになっているたびに、なぜかを問う価値があります。自動エスケープも同じです。良い道具では既定でオンで、それをオフにするはっきり名前の付いた方法が少しあります。
テンプレート:{{ name }} のようなすき間のある HTML のファイルで、サーバーがページごとにそれを埋めます。テンプレートエンジン は、すき間を埋めるコードです。
自動エスケープ:値がすでに安全だと伝えない限り、テンプレートエンジンが、すき間に入れるすべての値をエスケープすることです。
Django
Django のテンプレートは、既定ですべての {{ value }} をエスケープします。<、>、&、"、'、手でエスケープしたのと同じ 5 つです。このサイトのコースのページはそうやって作られています。
{# safe: escaped automatically #}
<p>{{ review.text }}</p>
<input name="q" value="{{ query }}">
{# the dangerous switches: each one turns escaping off #}
{{ review.text|safe }}
{% autoescape off %}{{ review.text }}{% endautoescape %}Python のコードでは、mark_safe(text) が Django に「これはすでに HTML なので、エスケープしないで」と伝えます。自分のコードが書いたテキストにだけ使ってください。Python で小さな HTML のかけらを作る必要があるときは、渡すすべての値をエスケープする format_html を使います:
from django.utils.html import format_html
from django.utils.safestring import mark_safe
bad = mark_safe(f"<b>{user_name}</b>") # user_name is NOT escaped
good = format_html("<b>{}</b>", user_name) # user_name IS escapedページの JavaScript にデータを渡すには、値を <script> のブロックに貼り付ける代わりに、json_script フィルターを使います。それは、スクリプトのタグを早く閉じられない形でデータを JSON として書きます。
Jinja(と Flask)
Jinja はもうひとつの人気のある Python のテンプレートエンジンです。既定が違います。ただの Environment() はエスケープ しません。Flask が .html のテンプレートでするように、それをオンにしてください:
from jinja2 import Environment, select_autoescape
env = Environment(autoescape=select_autoescape(["html", "htm", "xml"]))
# Jinja's dangerous switches: the |safe filter, Markup(text) in Python,
# and {% autoescape false %} blocks.自動エスケープでもできないこと
- 引用符のない属性:
<div title={{ x }}>は空白ひとつで壊れます。常にtitle="{{ x }}"と書いてください。 - リンクのアドレス:
href="{{ url }}"はエスケープされますが、javascript:のアドレスにはエスケープするものがありません。保存したり表示したりする前に、リンクがhttps://かhttp://で始まるかを確かめてください。 <script>のブロックの中: テンプレートのすき間の代わりに、json_scriptかdata-属性を使ってください。
コードレビューの習慣
プロジェクトで |safe、mark_safe、autoescape off、Markup(、そしてフロントエンドのコードでは innerHTML と dangerouslySetInnerHTML を検索してください。見つかったものには、どれも隣に 1 行の理由があるべきです。その値に訪問者のテキストが入りうるなら、それは起こるのを待っているバグです。
よくある誤解
「フレームワークがエスケープするので、XSS は起こりえない」。フレームワークがエスケープするのは すき間 です。安全と印を付けた値、確かめなかったアドレス、innerHTML を使うフロントエンドのコードは守れません。次のモジュールでは、それでもすり抜ける間違いのために、第 2 の層、Content Security Policy を加えます。
もっと深く学びたいですか? PortSwigger の無料の Web Security Academy には、安全に学ぶために作られた練習用のラボ付きの、完全な XSS のコースがあります。
ほかの言語では
ほかの技術での同じ既定と、同じ危険なスイッチ:
// React: text in JSX is escaped for you
<p>{review.text}</p>
// the switch that turns it off (the name is a warning on purpose)
<div dangerouslySetInnerHTML={{ __html: review.text }} />
// Go: html/template escapes for the context (text, attribute, URL, script)
import "html/template" // escapes
// import "text/template" // does NOT escape: never use it for HTML
tmpl := template.Must(template.New("p").Parse(`<p>{{.}}</p>`))
// the switch: template.HTML(text) marks text as already safe
// PHP (Twig) auto-escapes; {{ text|raw }} turns it off
// C# (Razor) auto-escapes @text; @Html.Raw(text) turns it offまとめ
- Django は既定でテンプレートのすべての値をエスケープし、Jinja はオンにしたときだけです。
- 危険なスイッチ:
|safe、mark_safe、autoescape off、Markup、dangerouslySetInnerHTML、Go のtemplate.HTML。 - Python で HTML を作るには
format_htmlを、JavaScript にデータを渡すにはjson_scriptを使います。 - エスケープはリンクのアドレスを確かめず、引用符のない属性も直しません。引用符で囲み、http と https のリンクだけを許しましょう。
この演習はまもなく開きます
その前のレッスンを終えると、このレッスンが解放されます。コース全体が無料でアカウントも不要、このレッスンは今すぐ読めます。
このブラウザは learn.floati.life の Cookie をブロックしているため、ここで修了したレッスンを順番どおりに開けません。このサイトの Cookie を許可して再読み込みしてください。