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

在日志中脱敏敏感数据

数据脱敏是一种数据保护技术,旨在防止敏感信息在各种环境中暴露,从而在不损害隐私的前提下支持应用程序的安全测试和数据分析。

API7 企业版提供的内置 data-mask 插件可以帮助你删除或替换请求头、请求体和 URL 查询参数中的敏感信息。

本指南介绍如何使用 API7 企业版对 URL 编码请求体中的敏感信息进行脱敏。示例中的 file-logger 插件用于记录日志,以展示信息已成功脱敏。请根据实际用例调整配置。

以下交互式演示介绍了如何在日志中对敏感数据脱敏。

前提条件​

启用 data-mask 和 file-logger 插件​

  1. 从侧边导航栏中选择网关组的 已发布服务,然后点击要修改的服务,例如无版本的 httpbin 服务。

  2. 在已发布服务中,从侧边导航栏中选择 路由。

  3. 选择目标路由,例如 /anything。

  4. 点击 + 添加插件。

  5. 搜索 data-mask 插件。

  6. 点击 添加。

  7. 在对话框中执行以下操作:

    • 在 JSON 编辑器 中添加以下配置:
    {
    "request": [
    {
    "action": "remove",
    "body_format": "urlencoded",
    "name": "password",
    "type": "body"
    },
    {
    "action": "replace",
    "body_format": "urlencoded",
    "name": "token",
    "type": "body",
    "value": "*****"
    },
    {
    "action": "regex",
    "body_format": "urlencoded",
    "name": "card",
    "regex": "(\\d+)\\-\\d+\\-\\d+\\-(\\d+)",
    "type": "body",
    "value": "$1-****-****-$2"
    }
    ]
    }
    • 点击 添加。
  8. 在相同路由下,点击 + 添加插件。

  9. 搜索 file-logger 插件。

  10. 点击 添加。

  11. 在对话框中执行以下操作:

    • 在 JSON 编辑器 中添加以下配置:
    {
    "include_req_body": true,
    "path": "/tmp/mask-urlencoded-body.log"
    }
    • 点击 添加。

验证​

向路由发送请求:

curl -i "http://127.0.0.1:9080/anything" \
--data-urlencode "password=abc" \
--data-urlencode "token=xyz" \
--data-urlencode "card=1234-1234-1234-1234"

应收到 HTTP/1.1 200 OK 响应。

在网关 Docker 容器或 Kubernetes Pod 中查看 /tmp/mask-urlencoded-body.log 的文件内容。应看到类似以下内容的日志条目:

{
"request": {
"uri": "/anything",
"body": "token=*****&card=1234-****-****-1234",
"method": "POST",
"url": "http://127.0.0.1:9080/anything"
}
}

补充资源​