CsrfViewMiddleware
Django 1.9 の場合最初に manage.py startproject
した際に既に settings.py に以下のように CSRF 対策用のミドルウェアが組み込まれた状態となる:
MIDDLEWARE_CLASSES = [
....
'django.middleware.csrf.CsrfViewMiddleware',
....
]
これを使う場合は以下のように form タグの中に CSRF 対策用トークンを埋め込む記述を行う:
<form action="." method="post">{% csrf_token %}
正しい CSRF トークンを付与していなかった場合 403 Forbidden が返却される。
jQuery で CSRF トークンを付与したい
最近よくあるのが POST する際に Ajax 通信にして JSON で結果を受け取りエラーだったらそのまま画面にエラーを表示し成功だったら画面遷移を行うといったものだ。 これを Django で使用しようとすると上記 CSRF トークンが邪魔になる。
不要な場合は CSRF ミドルウェアを除去する
他のライブラリを使用したトークンチェック等行っている場合は組み込みの CSRF チェックは必要ないので settings.py の 'django.middleware.csrf.CsrfViewMiddleware',
の記述を削除する。
XMLHTTPRequest のヘッダに CSRF トークンを付与する
幸いこのあたりは Django 公式ドキュメントに書いてある。
// using jQuery
function getCookie(name) {
var cookieValue = null;
if (document.cookie && document.cookie != '') {
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookie = jQuery.trim(cookies[i]);
// Does this cookie string begin with the name we want?
if (cookie.substring(0, name.length + 1) == (name + '=')) {
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
break;
}
}
}
return cookieValue;
}
var csrftoken = getCookie('csrftoken');
のように CSRF トークンが取得できるので以下のように Ajax 時に付与する:
function csrfSafeMethod(method) {
// these HTTP methods do not require CSRF protection
return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method));
}
$.ajaxSetup({
beforeSend: function(xhr, settings) {
if (!csrfSafeMethod(settings.type) && !this.crossDomain) {
xhr.setRequestHeader("X-CSRFToken", csrftoken);
}
}
});