跳到主要内容
版本:3.5.x

对访问日志中的敏感数据脱敏

在 Kubernetes 等容器化环境中部署 API 网关时,访问日志通常会直接写入容器的标准输出。容器运行时或日志收集工具会捕获这些日志,并可将其转发到集中式日志系统。

但是,这些日志可能包含电子邮件地址或访问令牌等敏感信息。如果未经适当处理就存储或传输,可能带来隐私和安全风险。为降低此类风险,需要在记录日志时对敏感数据进行脱敏。

本指南介绍如何使用 NGINX 的 map 模块定义一个新的日志变量,并将其用于 access_log_format,以便对网关访问日志中的一个电子邮件地址脱敏。

前置要求​

  1. 安装 API7 企业版。
  2. 网关组中至少有一个网关实例。

更新网关配置​

本节将把 request_uri 中的电子邮件地址替换为 xxxxxx,同时保留 URI 的其余部分,以保护日志中的敏感信息。

在网关配置文件的 nginx_config 配置中添加以下 http_configuration_snippet。该配置会检查 request_uri,并根据 map 块中的模式匹配结果将其映射到新变量 masked_uri:

config.yaml
nginx_config:
http_configuration_snippet: |
map $request_uri $masked_uri {
~^(.*?email=)[^&\s]+(.*)$ $1xxxxxx$2;
default $request_uri;
}

更新网关配置文件中 nginx_config 下的 access_log_format,并使用新变量 masked_uri 记录请求 URI:

config.yaml
nginx_config:
http:
access_log_format: '$masked_uri $remote_addr - $remote_user [$time_local] $status $body_bytes_sent $request_time "$http_referer" "$http_user_agent" $upstream_addr $upstream_status $upstream_response_time "$upstream_scheme://$upstream_host$upstream_uri"'

重新加载 API7 网关,使配置更改生效。

验证​

可以使用任何现有路由进行验证。如果网关还没有路由,请先创建路由。

向该路由发送在查询参数中包含电子邮件地址的请求:

curl -i "http://127.0.0.1:9080/get?email=test@gmail.com&user=123"

查看 API7 网关的访问日志,应看到类似以下的日志条目,其中电子邮件地址已脱敏:

2025-02-19 11:48:21 /get?email=xxxxxx&user=123 172.17.0.1 - - [19/Feb/2025:03:48:18 +0000] 200 562 0.004 "-" "curl/8.7.1" 192.168.10.101:3030

其他资源​

如果还需对请求头、请求体和 URL 查询参数中的敏感数据脱敏,请参阅 data-mask 插件。