Skip to main content
Case StudiesEcosystemAuthenticationPluginsCommunityVulnerabilities

如何使用 API 网关 Apache APISIX 的 CSRF 安全插件拦截跨站点伪造攻击

· 阅读需约 7 分钟
暴渊
曾奕霖

本文介绍了 Apache APISIX 的 CSRF 安全插件 csrf，并详细说明如何在 Apache APISIX 中借助 csrf 插件来保护您的 API 信息安全。

Apache APISIX 是一个动态、实时、高性能的 API 网关，提供负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。作为 API 网关，Apache APISIX 拥有多种类型的实用插件，本文介绍了 CSRF 安全插件 csrf，并详细说明如何在 Apache APISIX 中借助 csrf 插件来保护您的 API 信息安全。

CSRF（Cross-Site Request Forgery），即跨站点请求伪造。发起跨站点请求伪造攻击的关键点在于让目标服务器无法分辨众多请求的来源是真实用户还是攻击者。攻击的一般流程为：首先攻击者会诱导用户导航至攻击者提供的网页上。该网页包含一个自动发送到目标服务器的请求。然后该网页正常加载，这个请求就会自动发送至服务器。在服务器看来，这个请求和用户正常发送的请求一模一样，殊不知这是由攻击者发起，而用户却毫不知情。由于该请求携带了用户的一些凭据，攻击者通过解析这些凭据，就可以获取用户信息，进而产生安全风险。

插件介绍

csrf 插件基于 Double Submit Cookie 方案实现。根据 RFC 7231#section-4.2.1 的定义，我们把 GET、HEAD 和 OPTIONS 这三种方法称为安全方法。按照这一约定，csrf 插件会直接放行这三种方法，但会对其他的方法做检查并拦截其中的不安全请求。

为了抵御 CSRF 攻击，我们需要制造一个无法伪造的令牌或标识符，并且保证这个不会与攻击者的请求一起发送。用户需要将 csrf 插件依赖的 token 携带在请求头，token 使用密钥进行签名计算。这样就保证了 token 无法被他人伪造，从而保证了 API 的安全。

插件工作流程
Click to Preview

在路由中开启 csrf 插件后，访问该路由的所有请求响应中都会包含携带了 csrf token 的 Cookie。

用户需要在对该路由的不安全请求中携带这一 Cookie，并在请求头添加额外的字段用来携带 Cookie 的内容。字段为插件配置中的 name 值，这样的请求才能通过 CSRF 插件的校验。

用户在插件的配置中提供一个随机密钥，插件使用该密钥对 token 信息进行 sha256 哈希加密，然后生成 CSRF token，从而保证该 token 不可伪造。

如何使用

配置开启 CSRF 插件的路由

在 APISIX 中使用 Admin API 创建一条路由并启用 csrf 插件：

curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
  "uri": "/hello",
  "plugins": {
    "csrf": {
      "key": "edd1c9f034335f136f87ad84b625c8f1"
    }
  },
  "upstream": {
    "type": "roundrobin",
    "nodes": {
      "127.0.0.1:9001": 1
    }
  }
}'

其中对于插件有三个配置项：

  • key：必填项，随机秘钥的值。用户需要提供一个随机密钥。
  • expires：选填项，随机秘钥的过期时间，默认值为 7200 秒。由于 CSRF token 使用 Cookie 下发至客户端，该配置会被放置在 Cookie 的配置中，从而控制 Cookie 的过期时间。另外在插件内部也会计算时间来判断 token 是否过期。
  • name：选填项， CSRF token 的名称，默认值为 apisix-csrf-token。

发送请求测试

首先使用 POST 请求访问该路由：

curl -i http://127.0.0.1:9080/hello -X POST

Apache APISIX 会拦截该请求并返回 401 错误。在返回的头部中会发现设置了一个 Cookie，如果没有配置插件的 name 字段的话，Cookie 内部应该为默认值 apisix-csrf-token=.... 。这就是 CSRF 插件生成的 CSRF token。在请求中，需要确保请求携带该 Cookie 并且在请求头写入该 token。

HTTP/1.1 401 Unauthorized
Set-Cookie: apisix-csrf-token= ${apisix-csrf-token};path=/;Expires=Mon, 13-Dec-21 09:33:55 GMT
{"error_msg":"no csrf token in headers"}

客户端使用 JavaScript 示例：使用 js-cookie 读取 Cookie 并使用 axios 发送请求。

const token = Cookie.get('apisix-csrf-token');

const instance = axios.create({
  headers: {'apisix-csrf-token': token}
});

如果 Cookie 中的 token 和请求头中的 token 不一致，请求会被 csrf 插件拦截，示例如下：

curl -i http://127.0.0.1:9080/hello -X POST -H 'apisix-csrf-token: ${apisix-csrf-token}' -b 'apisix-csrf-token= ${apisix-csrf-token}'
HTTP/1.1 401 Unauthorized
Set-Cookie: apisix-csrf-token= ${apisix-csrf-token};path=/;Expires=Mon, 13-Dec-21 09:33:55 GMT
{"error_msg":"csrf token mismatch"}

最后使用 curl 验证正常的访问：

curl -i http://127.0.0.1:9080/hello -X POST -H 'apisix-csrf-token: ${apisix-csrf-token}' -b 'apisix-csrf-token= ${apisix-csrf-token}'
HTTP/1.1 200 OK

插件在内部需要校验 Cookie 中的 token 与 请求头中携带 token 的是否一致，并对其进行重新计算签名来验证该 token 是否有效。

禁用插件

移除 csrf 插件的相关配置信息，然后发送一个更新路由的请求，即可停用该插件。

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
  "uri": "/hello",
  "upstream": {
    "type": "roundrobin",
    "nodes": {
      "127.0.0.1:1980": 1
    }
  }
}'

总结

本文详细描述了 csrf 插件的工作方式以及使用方法，希望通过本文可以让大家对在 Apache APISIX 中使用插件拦截 CSRF 攻击有更清晰的认识，方便在实际场景中应用。

Apache APISIX 项目目前正在开发其他插件以支持集成更多服务，如果您对此有兴趣，您可以通过 GitHub Discussions 发起讨论，或通过邮件列表进行交流.

Table of Contents