blob: 69fe8b8c5a47ba484f2aae66a8cca3fdb6eb6e92 [file] [log] [blame]
# Copyright 2010 the Melange authors.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
"""Middleware to protect against cross site request forgeries.
This middleware will automatically add a hidden form input containing the XSRF
token to any <form> sent to the browser, and any (non-AppEngine) POST requests
will be rejected if the provided token is invalid.
import httplib
import itertools
import logging
import os
import re
from django import http
from django.utils.safestring import mark_safe
from soc.logic.helper import xsrfutil
from soc.logic import site
_HTML_TYPES = ('text/html', 'application/xhtml+xml')
_POST_FORM_RE = re.compile(
r'(<form\W[^>]*\bmethod\s*=\s*(\'|"|)POST(\'|"|)\b[^>]*>)', re.IGNORECASE)
def _GetSecretKey(request):
"""Gets the XSRF secret key from the request context.
This function sets the key if it is not present.
request: A django.http.HttpRequest.
The XSRF secret key for the request.
if not hasattr(request, 'site'): = site.singleton()
return site.xsrfSecretKey(
class XsrfMiddleware(object):
"""Middleware for preventing cross-site request forgery attacks.
This class implements the specification defined at
def process_request(self, request):
"""Requires a valid XSRF token on POST requests."""
# we only care about POST
if request.method != 'POST':
return None
# HTTPRequests from AppEngine do not have to have a key
if ('HTTP_X_APPENGINE_CRON' in os.environ
or 'HTTP_X_APPENGINE_QUEUENAME' in os.environ):
return None
post_token = request.POST.get('xsrf_token')
if not post_token:
logging.warn('Missing XSRF token for post data %s', request.POST)
return http.HttpResponse('Missing XSRF token.', status=httplib.FORBIDDEN)
xsrfutil.isTokenValid(_GetSecretKey(request), post_token)
except xsrfutil.InvalidTokenException as e:
logging.warn('Invalid XSRF token for post data %s', request.POST)
return http.HttpResponse(
'Invalid XSRF token, %s' % e.reason, status=httplib.FORBIDDEN)
# token valid, return None and continue processing the request.
return None
def process_response(self, request, response):
"""Alters HTML responses containing <form> tags to embed the XSRF token."""
content_type = response.get('Content-Type', None)
if content_type and content_type.split(';')[0] in _HTML_TYPES:
xsrf_token = xsrfutil.getGeneratedTokenForCurrentUser(
# there may be multiple forms per page, but we only id= one of them
idattributes = itertools.chain(("id='xsrftoken'",), itertools.repeat(''))
# invoked on every matching <form> tag
def add_xsrf_field(match):
"""Returns the matched <form> tag plus the added <input> element"""
return mark_safe( + ("<div style='display:none;'>" +
"<input type='hidden' " + +
" name='xsrf_token' value='" + xsrf_token +
"' /></div>"))
response.content, n = _POST_FORM_RE.subn(add_xsrf_field, response.content)
if n > 0:
# content has changed, so ETag would be invalid
del response['ETag']
return response