Version: 2.11

real-ip

目录

简介

real-ip 插件用于动态改变传递到 APISIX 的客户端的 IP 和端口。

它工作方式和 Nginxngx_http_realip_module 模块一样,并且更为灵活。

该插件要求 APISIX 运行在 APISIX-OpenResty 上。

属性

名称类型必选项默认值有效值描述
sourcestring必填任何 Nginx 变量,如 arg_realiphttp_x_forwarded_for根据变量的值 APISIX 动态设置客户端的 IP 和端口。如果该值不包含端口,则不会更改客户端的端口。
trusted_addressesarray[string]可选IPCIDR 范围列表动态设置 set_real_ip_from 指令

如果 source 设置的远程地址缺失或无效,该插件则直接放行,不会更改客户端地址。

如何启用

下面是一个示例,在指定的 route 上开启了 real-ip 插件:

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "plugins": {
  5. "real-ip": {
  6. "source": "arg_realip",
  7. "trusted_addresses": ["127.0.0.0/24"]
  8. },
  9. "response-rewrite": {
  10. "headers": {
  11. "remote_addr": "$remote_addr",
  12. "remote_port": "$remote_port"
  13. }
  14. }
  15. },
  16. "upstream": {
  17. "type": "roundrobin",
  18. "nodes": {
  19. "127.0.0.1:1980": 1
  20. }
  21. }
  22. }'

测试插件

使用 curl 访问:

  1. curl 'http://127.0.0.1:9080/index.html?realip=1.2.3.4:9080' -I
  2. ...
  3. remote-addr: 1.2.3.4
  4. remote-port: 9080

禁用插件

想要禁用该插件时很简单,在路由 plugins 配置块中删除对应 JSON 配置,不需要重启服务,即可立即生效禁用该插件。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. }
  10. }'