HTTP 头部控制

在 FGW 的配置中，HTTP 头部控制功能允许你微调传入和传出的请求和响应头部。本文档将介绍 FGW 的 HTTP 头部控制功能。

介绍

在日常的网络交互中，HTTP 头部扮演了非常重要的角色。它们可以传递关于请求或响应的各种信息，如身份验证、缓存控制、内容类型等。FGW 提供了 HTTP 头部控制功能，允许用户对传入和传出的请求和响应头部进行精确的控制，以满足各种安全、性能和业务需求。

这里的后端服务，可以使用 Pipy 来模拟，执行下面的命令即可。

pipy -e "pipy().listen(8081).serveHTTP(msg => new Message({ 'status': 200, headers: { 'content-type': 'application/json', 'server': 'Pipy', 'token': 'CONFIDENTIAL'} }, JSON.encode({ headers: msg.head })))"

模拟的服务会返回如下信息，在消息体中返回原始请求的所有头部信息。

curl -i http://localhost:8081/
HTTP/1.1 200 OK
content-type: application/json
server: Pipy
content-length: 200
connection: keep-alive

{"headers":{"protocol":"HTTP/1.1","headers":{"host":"localhost:8080","user-agent":"Apache-HttpClient/x.y.z","accept":"*/*","client-id":"client-1","connection":"keep-alive"},"method":"GET","path":"/"}}

配置说明

FGW 的 HTTP 头部控制功能分为 请求头部控制 RequestHeaderModifier 和响应头部控制 ResponseHeaderModifier，使用二者都可以对 HTTP 头部进行增加、删除、修改三种操作。

  • Set: 设置 HTTP header。此字段用于设定或修改 HTTP 头部的值。如果指定的头部已存在，则其值将被替换为新值；如果不存在，则会添加此头部。它是一个可选字段，其值是一个对象列表，其中每个对象都包含Name和Value两个键。
  • Add: 增加 HTTP header。此字段用于添加新的 HTTP 头部，而不会影响到原有的头部。如果指定的头部已存在，新的头部将被添加，而不会替换已有的头部。它是一个可选字段，其值格式与 Set 字段相同。
  • Remove: 删除 HTTP header。此字段用于从 HTTP 请求或响应中删除指定的头部。这对于确保某些敏感或不必要的头部不被暴露给客户端或后端服务是很有用的。它是一个可选字段，其值是一个字符串列表，代表要删除的头部名称。

示例

{
  "Filters": [
    {
      "Type": "RequestHeaderModifier",
      "RequestHeaderModifier": {
        "Set": [
          {
            "Name": "host",
            "Value": "set-bar"
          }
        ],
        "Add": [
          {
            "Name": "accept",
            "Value": "xxx"
          }
        ],
        "Remove": [
          "user-agent",
          "my-header4"
        ]
      }
    },
    {
      "Type": "ResponseHeaderModifier",
      "ResponseHeaderModifier": {
        "Set": [
          {
            "Name": "dummy1",
            "Value": "set-bar"
          }
        ],
        "Add": [
          {
            "Name": "dummy2",
            "Value": "add,baz"
          }
        ],
        "Remove": [
          "dummy3",
          "my-header8"
        ]
      }
    }
  ]
}

配置

负载均衡配置

我们借助在文档 HTTP 负载均衡 中的负载均衡器配置，修改服务的端点列表为我们的后端服务地址 127.0.0.1:8081；然后根据 HTTP 插件链配置，将 filter/header-modifier.js 插件配置在相应的配置。

{
  "Listeners": [
    {
      "Protocol": "HTTP",
      "Port": 8080
    }
  ],
  "RouteRules": {
    "8080": {
      "*": {
        "RouteType": "HTTP",
        "Matches": [
          {
            "Path": {
              "Type": "Prefix",
              "Path": "/"
            },
            "BackendService": {
              "backendService1": {
                "Weight": 100
              }
            }
          }
        ]
      }
    }
  },
  "Services": {
    "backendService1": {
      "Endpoints": {
        "127.0.0.1:8081": {
          "Weight": 100
        }
      }
    }
  },
  "Chains": {
    "HTTPRoute": [
      "common/consumer.js",
      "http/codec.js",
      "http/route.js",
      "http/service.js",
      "filter/header-modifier.js",
      "http/forward.js",
      "http/default.js"
    ]
  }
}

通过负载均衡访问后端服务。

curl -i http://localhost:8080
HTTP/1.1 200 OK
content-type: application/json
server: Pipy
token: CONFIDENTIAL
content-length: 164
connection: keep-alive

{"headers":{"protocol":"HTTP/1.1","headers":{"host":"localhost:8080","user-agent":"curl/8.1.2","accept":"*/*","connection":"keep-alive"},"method":"GET","path":"/"}}

HTTP 头部控制配置

看到上面的结果后，我们希望对后端服务隐藏客户端的信息，比如将请求中的 user-agent 替换为 Apache-HttpClient/x.y.z；增加 client-id 信息 client-1；同时为了安全期间，避免服务端的 token 泄露，并模拟服务端的 server 信息为 Tomcat Server。

{
  "Matches": [
    {
      "Path": {},
      "BackendService": {},
      "Filters": [
        {
          "Type": "RequestHeaderModifier",
          "RequestHeaderModifier": {
            "Set": [
              {
                "Name": "user-agent",
                "Value": "Apache-HttpClient/x.y.z"
              }
            ],
            "Add": [
              {
                "Name": "client-id",
                "Value": "client-1"
              }
            ]
          }
        },
        {
          "Type": "ResponseHeaderModifier",
          "ResponseHeaderModifier": {
            "Set": [
              {
                "Name": "server",
                "Value": "Tomcat Server"
              }
            ],
            "Remove": [
              "token"
            ]
          }
        }
      ]
    }
  ]
}

再次通过负载均衡访问后端服务，对应的头部信息已经做了修改。

curl -i http://localhost:8080/
HTTP/1.1 200 OK
content-type: application/json
server: Tomcat Server
content-length: 200
connection: keep-alive

{"headers":{"protocol":"HTTP/1.1","headers":{"host":"localhost:8080","user-agent":"Apache-HttpClient/x.y.z","accept":"*/*","client-id":"client-1","connection":"keep-alive"},"method":"GET","path":"/"}}

Feedback

Was this page helpful?


最后修改 November 29, 2023: add docs for fault injection and request mirror, fix typo (b53e400)