一、前言
csrf
是django的默认中间件
# settings.python
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
1.使用csrf
的好处
-
csrf
的token
与session
配合使用可以帮助我们省去很多工作。
例如:
def view(request)
user = request.user
return HttpResponse('message')
如果我们不使用csrf
就不能确认request.user
是否可靠。下面会谈这一点。
备注:这里的user
也是使用django
自带的功能,如果你重新实现了session
,user
用户认证,csrf
等等,那就不用往下看了。
- 使用原生的
csrf
可以和django
的第三方框架配合使用
例如在django-rest-framework
(DRF
)这个框架中,就使用了很多关于csrf
与user
的地方,如果你不了解csrf
可能就会造成很多困扰
2.csrf
引起的问题
当然使用csrf
也会有很多麻烦的地方,你可能莫名其妙的遇到403
权限拒绝。
当然,你可以直接将'django.middleware.csrf.CsrfViewMiddleware'
这个中间件注释掉。
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
# 'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
但是当你用的第三方库越来越多,你会发现可能注释掉django
的csrf
中间件并不是万能的。因为这些第三方库可能调用了csrf
的验证功能,这个时候你还是要去查看原因。
3. 结论
了解django
的csrf
的原理及其实现是很有必要的,而不是想着
我直接注释掉这个中间件,不用不就好了吗?
4.django
官网:
-
https://docs.djangoproject.com/zh-hans/3.0/ref/csrf
关于csrf
的全面文档 -
https://docs.djangoproject.com/zh-hans/3.0/ref/csrf/#how-csrf-works
csrf
是如何工作的 -
https://docs.djangoproject.com/zh-hans/3.0/ref/csrf/#using-csrf
如何使用csrf
,包含在表单中使用,以及ajax
中构造参数
一、什么是csrf
攻击,csrf
攻击的实现原理
CSRF
(Cross-site request forgery
)跨站请求伪造,也被称为“One Click Attack”
或者Session Riding
,通常缩写为CSRF
或者XSRF
,是一种对网站的恶意利用。
CSRF
的实现与cookie
有关,很多的网站登陆一次后,会在浏览器保存cookie
,当我们后续访问该网站(比如简书
)的时候,浏览器会根据目标网站
自动添加cookie
信息,简书
的服务端在我们的请求信息中找到cookie
信息后就不会让我们重新登陆验证。
假如某恶意网站上有一个删除简书
文章的链接https://www.jianshu.com/p/3b3264061b26/delete
),当用户被诱导点击该链接后,浏览器就会对该网站发出请求,并附带该网站的cookie
信息。服务端在验证cookie
信息正确后就通过了该删除
请求。导致用户在不知道的情况下删除了自己的文章。
二、如何防止CSRF
攻击
CSRF
攻击之所以能够成功,是因为攻击者可以伪造用户的请求,该请求中所有的用户验证信息都存在于Cookie
中,因此攻击者可以在不知道这些验证信息的情况下直接利用用户自己的Cookie
来通过安全验证。
我们需要做的就是在cookie
之外还要对用户请求进行验证。需要用户携带token
令牌。
三、django
的csrf
是如何工作的
django
在请求返回时,会生成一个token
令牌,该令牌信息会存储到用户的cookie
或者返回的内容中(如果在模版中添加{% csrf-token %}
)。
虽然令牌信息存储在cookie
中,但是当用户发来不安全请求post
、update
、patch
、delete
时(一般认为get
请求为安全请求,django
对get
请求不会验证csrf-token
,除非开发人员强制要求),django
会在请求头
或者请求体 / POST内容
中验证csrf-token
。这就要求用户端必须从cookie
中获取token
信息并设置在请求头
或者POST
内容中,这是csrf
攻击所做不到的。
四、如何在django
中使用csrf
4.1确保你的settings.py
正确设置
# settings.python
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
'django.middleware.csrf.CsrfViewMiddleware'
没有被注释掉才能起作用。
4.2在发起请求前如何获取csrf-token
比较通用的获取方式是通过cookie
,它不仅适用于post
请求,还适用于update
,patch
,delete
请求。
【虽然网上很多人都是使用{% csrf-token %}
标签来生成token
并获取,但是django
官方是推荐从cookie
中获取token
的】
默认的存储token
的cookie
名称为csrftoken
,你也可以在settings.py
中通过CSRF_COOKIE_NAME
来设置
1.)使用纯js
代码来获取token
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 = cookies[i].trim();
// 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');
2.)使用jquery.cookie.js
[ 必须先引入jquery.js
,再引入jquery.cookie.js
],网上有很多CDN
镜像资源
var csrftoken = $.cookie('csrftoken');
4.3如何在请求中携带csrf
验证信息。
1.)当我们发送ajax
请求时,可以在请求头中携带csrftoken
,默认设置的请求头名称为X-CSRFToken
,你也可以在设置中进行修改。
许多JavaScript
框架提供了允许在每个请求上设置标头的钩子。例如在jQuery 1.5.1
及更高版本中
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);
}
}
});
2.)如果我们发送的是一个form
表单
<form method="post" action="/article/**/**/">
{% csrf_token %}
<input type="text" name="username">
<input type="password" name="password">
<input type="submit" value=提交>
</form>
这种非ajax
请求,可以直接在POST
请求内容中携带token
信息。
我们在模版的form
表单中插入{% csrf_token %}
标签。该标签经过模版渲染后,会生成一个input
组件
<input type="hidden" name="csrfmiddlewaretoken" value="aWBlPMzuUNcROaheK6BrlY1XAlPpJATNsUoCyX0pIVA91zJmxLTLaf69JhBJ5k2z">
这样当我们点击提交后,会在POST
请求中携带csrfmiddlewaretoken
信息。
五、装饰器方法
1. csrf_protect
为装饰的视图函数
提供csrf
保护验证,不管是否开启了csrf
中间件。
例如你在大部分的情况下不需要CSRF
保护,而注释了'django.middleware.csrf.CsrfViewMiddleware'
中间件。
但现在有几个重要的视图函数需要对用户进行csrf
验证,以保护安全性,那么可以使用csrf_protect
装饰器。
from django.shortcuts import render
from django.views.decorators.csrf import csrf_protect
@csrf_protect
def my_view(request):
context = {}
# ...
return render(request, "a_template.html", context=context)
2. csrf_exempt
豁免csrf
验证
对于有的视图函数,不需要进行csrf
验证,则可以添加csrf_exempt
装饰器
3.requires_csrf_token
如果你没有启动CsrfViewMiddleware
中间件,又没有对视图函数添加csrf_protect
装饰器,或者添加了csrf_exempt
豁免,那么在模版中添加{% csrf_token %}
是不会生效的。
使用requires_csrf_token
装饰器可以确保{% csrf_token %}
标签一定生效。
4. ensure_csrf_cookie
如果在模版中使用了{% csrf_token %}
标签,那么返回的响应中一定有csrf-token
的cookie
信息,如果页面中没有使用{% csrf_token %}
那么返回的信息中就不一定有csrf-token
的cookie
了。
特别是我们的前端发送的所有非get
请求都是通过ajax
来实现的,那么在视图函数
上使用requires_csrf_token
装饰器可以确保返回的信息中有csrf-token
的cookie
信息。
六、装饰类视图
如果我们使用的是类视图,特别是RESTful
风格的后端api
,那么我们的装饰器直接装饰到get
,post
,update
,patch
,delete
方法上是没有用的。
1. 借助method_decorator
在dispatch()
方法上进行装饰
from django.views import View
from django.views.decorators.csrf import csrf_exempt
from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator
class ProtectedView(View):
@method_decorator(login_required)
@method_decorator(csrf_exempt)
def dispatch(self, *args, **kwargs):
return super().dispatch(*args, **kwargs)
2.用装饰类来代替,并作为关键参数 name
传递要被装饰的方法名
@method_decorator(csrf_exempt, name='dispatch')
@method_decorator(login_required, name='dispatch')
class ProtectedView(View):
pass
可以定义一个装饰器列表或元组,并使用它而不是多次调用 method_decorator()
decorators = [never_cache, login_required]
@method_decorator(decorators, name='dispatch')
class ProtectedView(View):
pass
网友评论