跨站请求伪造(英语: Cross-Site Request Forgery),也被称为one-click attack或者session riding,通常缩写为CSRF 或者XSRF, 是一种挟制用户在当前已登录的Web应用程序上执行非本意的操作的攻击方法。跟跨网站脚本( XSS)相比, XSS 利用的是用户对指定网站的信任, CSRF 利用的是网站对用户网页浏览器的信任。

如何防御

这里我们选择通过 token 的方式对请求进行校验,通过中间件的方式实现, CSRF 跨站点防御插件由社区包提供。

开发者可以通过对接口添加中间件的方式,增加 token 校验功能。

感兴趣的朋友可以阅读插件源码 https://github.com/gogf/csrf

使用方式

引入插件包

  1. import "github.com/gogf/csrf"

配置接口中间件

csrf 插件支持自定义 csrf.Config 配置, Config 中的 Cookie.Name 是中间件设置到请求返回 Cookie token 的名称, ExpireTimetoken 超时时间, TokenLengthtoken 长度, TokenRequestKey 是后续请求需求带上的参数名。

  1. s := g.Server()
  2. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  3. group.Middleware(csrf.NewWithCfg(csrf.Config{
  4. Cookie: &http.Cookie{
  5. Name: "_csrf",// token name in cookie
  6. },
  7. ExpireTime: time.Hour * 24,
  8. TokenLength: 32,
  9. TokenRequestKey: "X-Token",// use this key to read token in request param
  10. }))
  11. group.ALL("/csrf", func(r *ghttp.Request) {
  12. r.Response.Writeln(r.Method + ": " + r.RequestURI)
  13. })
  14. })

前端对接

通过配置后,前端在POST请求前从 Cookie 中读取 _csrf 的值(即 token),然后请求发出时将 tokenX-TokenTokenRequestKey 所设置)参数名置入请求中(可以是 Header 或者 Form)即可通过 token 校验。

代码示例

使用默认配置

  1. package main
  2. import (
  3. "net/http"
  4. "time"
  5. "github.com/gogf/csrf"
  6. "github.com/gogf/gf/v2/frame/g"
  7. "github.com/gogf/gf/v2/net/ghttp"
  8. )
  9. // default cfg
  10. func main() {
  11. s := g.Server()
  12. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  13. group.Middleware(csrf.New())
  14. group.ALL("/csrf", func(r *ghttp.Request) {
  15. r.Response.Writeln(r.Method + ": " + r.RequestURI)
  16. })
  17. })
  18. s.SetPort(8199)
  19. s.Run()
  20. }

使用自定义配置

  1. package main
  2. import (
  3. "net/http"
  4. "time"
  5. "github.com/gogf/csrf"
  6. "github.com/gogf/gf/v2/frame/g"
  7. "github.com/gogf/gf/v2/net/ghttp"
  8. )
  9. // set cfg
  10. func main() {
  11. s := g.Server()
  12. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  13. group.Middleware(csrf.NewWithCfg(csrf.Config{
  14. Cookie: &http.Cookie{
  15. Name: "_csrf",// token name in cookie
  16. Secure: true,
  17. SameSite: http.SameSiteNoneMode,// 自定义samesite
  18. },
  19. ExpireTime: time.Hour * 24,
  20. TokenLength: 32,
  21. TokenRequestKey: "X-Token",// use this key to read token in request param
  22. }))
  23. group.ALL("/csrf", func(r *ghttp.Request) {
  24. r.Response.Writeln(r.Method + ": " + r.RequestURI)
  25. })
  26. })
  27. s.SetPort(8199)
  28. s.Run()
  29. }

通过请求体验效果

http://localhost:8199/api.v2/csrf