nginx中的proxy_set_header参数详解

在使用 Nginx 作为反向代理服务器时，proxy_set_header 指令扮演着至关重要的角色。它允许我们自定义请求头信息，将客户端请求传递给上游服务器时，添加或修改特定的信息，从而实现更灵活的代理功能。本文将深入探讨 proxy_set_header 指令的用法，并结合实际场景，分析其在不同应用场景下的作用。

1、proxy_set_header 的指令概述

proxy_set_header 是 Nginx 配置中用于设置代理请求 HTTP 头部的指令。当 Nginx 作为反向代理时，它允许自定义从客户端接收到的请求或添加新的请求头，然后将其转发到后端服务器。这对于维护 HTTP 协议的连贯性、安全性和功能性至关重要。

2、proxy_set_header指令的语法

proxy_set_header 指令的语法如下：

proxy_set_header <header-name><value>;

• ：要设置或修改的 HTTP 请求头的名称。
• ：请求头的新值，可以是静态字符串、变量或表达式。
• value 可以是字符串、变量或它们的组合。Nginx 提供了丰富的内置变量，可以方便地获取请求信息，例如：

host: Host头部是 HTTP 请求中用于指定请求资源的服务器地址。在代理设置中，proxy_set_header Host $host; 确保了请求头中的 Host 字段被正确传递，避免了请求中的 Host 头被 Nginx 默认值覆盖。
X-Forwarded-For：用于记录经过的代理服务器的 IP 地址链。
X-Forwarded-Proto：指示原始请求使用的协议（HTTP 或 HTTPS）。
$http_user_agent: 客户端的 User-Agent 信息。
$request_uri: 客户端请求的 URI。
X-Real-IP: X-Real-IP头部用于记录客户端的真实 IP 地址。在代理设置中，proxy_set_header X-Real-IP $remote_addr; 可以防止 Nginx 重写原始请求中的 IP 地址，使得后端服务能够识别客户端的真实来源。
Origin：用于 CORS（跨域资源共享）请求，指示请求的来源。

3、proxy_set_header 指令的应用场景

假设您有一个运行在内网的 Web 应用服务器，您希望通过 Nginx 反向代理将该应用暴露给外网用户。以下是一些可能的配置场景：

1. 传递客户端 IP 地址:

在代理环境中，上游服务器无法直接获取客户端的真实 IP 地址。为了让上游服务器能够识别客户端的真实 IP 地址，可以使用 proxy_set_header 指令传递客户端 IP 地址。

proxy_set_header X-Real-IP $remote_addr;

• X-Real-IP 是一个自定义的请求头字段，用于存储客户端的真实 IP 地址。
• 上游服务器可以通过读取 X-Real-IP 字段获取客户端的 IP 地址。

2. 传递代理信息:

在多级代理环境中，上游服务器可能需要了解请求经过了哪些代理服务器。可以使用 proxy_set_header 指令传递代理信息。

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

• X-Forwarded-For 是一个标准的请求头字段，用于存储客户端 IP 地址和所有代理服务器的 IP 地址，以逗号分隔。
• 上游服务器可以通过读取 X-Forwarded-For 字段获取所有代理服务器的 IP 地址。

3. 支持 WebSocket 协议:

WebSocket 协议是一种双向通信协议，需要在请求头中设置 Upgrade 和 Connection 字段。可以使用 proxy_set_header 指令传递 WebSocket 协议信息。

proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

• $http_upgrade 变量获取客户端请求的 Upgrade 字段的值。
• 将 Connection 字段设置为 upgrade，表示请求升级为 WebSocket 协议。

4. 自定义请求头信息:

除了传递客户端 IP 地址和代理信息，还可以使用 proxy_set_header 指令添加其他自定义的请求头信息，例如：

proxy_set_header X-My-Header "My Value";

• X-My-Header 是一个自定义的请求头字段，用于存储自定义信息。
• 上游服务器可以通过读取 X-My-Header 字段获取自定义信息。

5. 移除请求头信息:

可以使用 proxy_set_header 指令将请求头字段的值设置为 “”，从而移除该请求头字段。

proxy_set_header User-Agent "";

• 这将移除请求头中的 User-Agent 字段。

6、跨域资源共享 (CORS)

在处理跨域请求时，后端服务器需要知道请求的来源。通过设置 Origin 请求头，后端可以根据需要决定是否允许该请求。例如：

proxy_set_header Origin $http_origin;

这将确保后端服务器能够接收到正确的来源信息，从而做出相应的 CORS 响应。

配置示例

server {
    listen 8080;
    server_name your_domain.com;

    location /{
        proxy_pass http://backend_server:80;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Origin $http_origin;
        proxy_read_timeout 6000s;
        proxy_set_header X-NginX-Proxy true;
        proxy_http_version 1.1;
        chunked_transfer_encoding off;}}

在这个配置中，Nginx将请求转发到backend_server，并通过各种proxy_set_header指令传递客户端的相关信息。

proxy_set_header 指令的注意事项

• 确保设置的请求头字段名称和值符合规范，避免与其他请求头字段冲突。
• 确保 proxy_set_header 指令在正确的 location 块内，以便它们只应用于特定的请求。
• 谨慎使用 proxy_set_header 指令，避免传递敏感信息，例如用户密码等。
• 在使用 proxy_set_header 指令时，需要根据实际情况选择合适的变量和值，以确保上游服务器能够正确识别和处理请求信息。

总结

proxy_set_header 指令是 Nginx 反向代理服务器中一个非常重要的指令，为反向代理配置提供了强大的灵活性。它允许我们自定义请求头信息，传递客户端 IP 地址、代理信息、WebSocket 协议信息等，从而实现更灵活的代理功能。在使用 proxy_set_header 指令时，需要根据实际情况选择合适的变量和值，以确保上游服务器能够正确识别和处理请求信息。