本文實(shí)例講述了Flask框架 CSRF 保護(hù)實(shí)現(xiàn)方法。分享給大家供大家參考，具體如下：

Flask CSRF 保護(hù)

• 為什么需要 CSRF？
• 具體操作步驟
• 實(shí)現(xiàn)
  • 后端書寫
  • 在表單添加保護(hù)
  • 自定義錯誤響應(yīng)和關(guān)閉保護(hù)
  • ajax提交數(shù)據(jù)
• 故障排除

為什么需要 CSRF？

Flask-WTF 表單保護(hù)你免受 CSRF 威脅，你不需要有任何擔(dān)心。盡管如此，如果你有不包含表單的視圖，那么它們?nèi)孕枰Ｗo(hù)。

例如，由 AJAX 發(fā)送的 POST 請求，然而它背后并沒有表單。在 Flask-WTF 0.9.0 以前的版本你無法獲得 CSRF 令牌。這是為什么我們要實(shí)現(xiàn) CSRF。

具體操作步驟

根據(jù) csrf_token 校驗(yàn)原理，具體操作步驟有以下幾步：
1.后端生成 csrf_token 的值，在前端請求登錄或者注冊界面的時候?qū)⒅祩鹘o前端，傳給前端的方式可能有以下兩種：
在模板中的 From 表單中添加隱藏字段
將 csrf_token 使用 cookie 的方式傳給前端
2.在前端發(fā)起請求時，在表單或者在請求頭中帶上指定的 csrf_token
3.后端在接受到請求之后，取到前端發(fā)送過來的 csrf_token，與第1步生成的 csrf_token 的值進(jìn)行校驗(yàn)
4.如果校驗(yàn)對 csrf_token 一致，則代表是正常的請求，否則可能是偽造請求，不予通過

而在 Flask 中，CSRFProtect 這個類專門只對指定 app 進(jìn)行 csrf_token 校驗(yàn)操作，所以開發(fā)者需要做以下幾件事情：
生成 csrf_token 的值
將 csrf_token 的值傳給前端瀏覽器
在前端請求時帶上 csrf_token 值

實(shí)現(xiàn)

后端書寫

為了能夠讓所有的視圖函數(shù)受到 CSRF 保護(hù)，你需要開啟 CsrfProtect 模塊:

from flask_wtf.csrf import CsrfProtect
CsrfProtect(app)

像任何其它的 Flask 擴(kuò)展一樣，你可以惰性加載它:

from flask_wtf.csrf import CsrfProtect
csrf = CsrfProtect()

def create_app():
  app = Flask(__name__)
  csrf.init_app(app)

Note
你需要為 CSRF 保護(hù)設(shè)置一個秘鑰。通常下，同 Flask 應(yīng)用的 SECRET_KEY 是一樣的。

在表單添加保護(hù)

如果模板中存在表單，你不需要做任何事情。與之前一樣:

<form method="post" action="/">
  {{ form.csrf_token }}
</form>

但是如果模板中沒有表單，你需要一個 CSRF 令牌:

<form method="post" action="/">
  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
</form>

自定義錯誤響應(yīng)和關(guān)閉保護(hù)

無論何時未通過 CSRF 驗(yàn)證，都會返回 400 響應(yīng)。你可以自定義這個錯誤響應(yīng):

@csrf.error_handler
def csrf_error(reason):
  return render_template('csrf_error.html', reason=reason), 400

我們強(qiáng)烈建議你對所有視圖啟用 CSRF 保護(hù)。但也提供了某些視圖函數(shù)不需要保護(hù)的裝飾器:

@csrf.exempt
@app.route('/foo', methods=('GET', 'POST'))
def my_handler():
  # ...
  return 'ok'

默認(rèn)情況下你也可以在所有的視圖中禁用 CSRF 保護(hù)，通過設(shè)置 WTF_CSRF_CHECK_DEFAULT 為 False，僅僅當(dāng)你需要的時候選擇調(diào)用 csrf.protect()。這也能夠讓你在檢查 CSRF 令牌前做一些預(yù)先處理:

@app.before_request
def check_csrf():
  if not is_oauth(request):
    csrf.protect()

ajax提交數(shù)據(jù)

不需要表單，通過 AJAX 發(fā)送 POST 請求成為可能。Flask0.9.0 版本后這個功能變成可用的。

• 假設(shè)你已經(jīng)使用了 CsrfProtect(app)，你可以通過 {{ csrf_token() }} 獲取 CSRF
  令牌。這個方法在每個模板中都可以使用，你并不需要擔(dān)心在沒有表單時如何渲染 CSRF 令牌字段。

我們推薦的方式是在 meta 標(biāo)簽中渲染 CSRF 令牌:

<meta name="csrf-token" content="{{ csrf_token() }}">

在 script 標(biāo)簽中渲染同樣可行:

<script type="text/javascript">
  var csrftoken = "{{ csrf_token() }}"
</script>

下面的例子采用了在 meta標(biāo)簽渲染的方式， 在 script 中渲染會更簡單，你無須擔(dān)心沒有相應(yīng)的例子。

無論何時你發(fā)送 AJAX POST 請求，為其添加 X-CSRFToken 頭:

var csrftoken = $(‘meta[name=csrf-token]').attr(‘content')

KaTeX parse error: Expected '}', got 'EOF' at end of input: …|OPTIONS|TRACE)/i.test(settings.type) && !this.crossDomain) {
xhr.setRequestHeader(“X-CSRFToken”, csrftoken)
}
}
})

或者這么寫ajax：
在提交請求時，需要在請求頭中添加 X-CSRFToken 的鍵值對

$.ajax({
  ...
  headers: {
    "X-CSRFToken": getCookie("csrf_token")
  },
  ...
})

故障排除

當(dāng)你定義你的表單的時候，如果犯了這個錯誤 : 從 wtforms 中導(dǎo)入 Form 而不是從 flask.ext.wtf 中導(dǎo)入，CSRF 保護(hù)的大部分功能都能工作(除了 form.validate_on_submit())，但是 CSRF 保護(hù)將會發(fā)生異常。在提交表單的時候，你將會得到 Bad Request/CSRF token missing or incorrect 錯誤。這個錯誤的出現(xiàn)就是因?yàn)槟愕膶?dǎo)入錯誤，而不是你的配置問題。

希望本文所述對大家基于flask框架的Python程序設(shè)計有所幫助。

最新評論