IP 限制
IP 限制是一种常用的访问控制技术。通过将资源限制为特定的 IP 地址,组织可以遵守最小权限原则,防止未经授权的访问,并保持符合安全要求。
APISIX 通过以下方式支持 IP 限制:
- 通过 IP 限制对上游资源的访问
- 通过 IP 限制对 Admin API 的访问
本指南将向你展示如何为这些实践配置 APISIX。
通过 IP 限制对上游资源的访问
在本节中,你将了解如何使用 ip-restriction 插件通过 IP 控制客户端对上游资源的访问。你还将了解当 APISIX 位于反向代理之后时,如何将真实客户端 IP 暴露给 APISIX,以便 ip-restriction 插件可以基于真实客户端 IP 评估访问。
按原始远程地址限制
创建一个带有 ip-restriction 插件的路由并配置 IP 白名单:
curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-d '{
"id": "ip-restriction-route",
"uri": "/anything",
"plugins": {
"ip-restriction": {
"whitelist": [
"192.168.0.1/24"
]
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'
❶ 配置允许访问上游资源的 IP 地址列表。该配置支持 IPv4 和 IPv6 格式。
向路由发送请求:
curl -i "http://127.0.0.1:9080/anything"
如果你的 IP 被允许,你应该收到 HTTP/1.1 200 OK 响应。如果没有,你应该收到 HTTP/1.1 403 Forbidden 响应和以下错误消息:
{"message":"Your IP address is not allowed"}
你还可以配置 ip-restriction 插件的 IP 地址列表以 列入黑名单。但是,请注意,白名单和黑名单不能同时配置。有关更多信息,请参阅 插件文档。
在可信反向代理后限制访问
APISIX 位于反向代理后方时,连接地址是代理地址,而非原始客户端地址。请使用 real-ip 插件仅从已知代理地址接收客户端地址,再使用 ip-restriction 检查得到的地址。代理必须覆盖转发请求头,并禁止客户端绕过代理直接访问网关监听端口。
以下示例假设可信代理地址为 192.0.2.10,且该代理会把 X-Forwarded-For 覆盖为原始客户端地址。请按实际代理和允许访问的客户端地址替换文档示例地址:
curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-d '{
"id": "ip-restriction-route",
"uri": "/anything",
"plugins": {
"ip-restriction": {
"whitelist": [
"198.51.100.20"
]
},
"real-ip": {
"source": "http_x_forwarded_for",
"trusted_addresses": ["192.0.2.10"]
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'
❶ 允许指定的原始客户端地址访问上游资源。
❷ 从代理覆盖的 X-Forwarded-For 请求头读取原始客户端地址。
❸ 仅当与 APISIX 建立连接的是已配置的代理地址时,才信任转发地址。
分别让允许和不允许的客户端通过代理发送请求。前者应收到 HTTP/1.1 200 OK,后者应收到 HTTP/1.1 403 Forbidden。
如果验证期间仍可直接访问网关监听端口,还要确认不可信客户端无法通过伪造转发请求头获得访问权限:
APISIX_DIRECT_ADDRESS="<gateway-direct-address>"
curl -i "http://${APISIX_DIRECT_ADDRESS}:9080/anything" \
-H "X-Forwarded-For: 198.51.100.20"
由于该连接地址不在 trusted_addresses 中,请求应收到 HTTP/1.1 403 Forbidden。生产环境还应通过网络策略或防火墙阻止客户端直接连接网关。
通过 IP 限制 Admin API 访问
通过限制授权人员对 Admin API 的访问,组织可以最大限度地减少攻击面,并确保只有具有必要专业知识和职责的个人才能进行关键更改。这有助于在整个基础设施中保持更高水平的控制和整体安全性。
若要仅允许指定 IP 地址通过 APISIX Admin API 查看和写入资源,请使用以下内容更新配置文件 config.yaml:
deployment:
admin:
admin_key_required: true
allow_admin:
- 127.0.0.0/24
# - "::/64"
❶ 配置允许访问 Admin API 的 IP 地址列表。该配置支持 IPv4 和 IPv6 格式。
如果未配置 allow_admin,APISIX 会使用默认白名单 127.0.0.0/24,并拒绝来自其他地址的请求。当可信管理员从其他网络连接时,请配置明确的白名单;生产环境中不要使用 0.0.0.0/0。
重新加载 APISIX 以使配置文件更改生效。