Nginx 中 proxy_cookie_path 的用法

zzhongcy

已于 2024-05-14 16:25:27 修改

阅读量48

点赞数

分类专栏： Nginx 文章标签： nginx 运维

于 2024-05-14 16:22:08 首次发布

原文链接：http://blog.duhbb.com/

版权

Nginx 专栏收录该内容

85 篇文章 32 订阅

订阅专栏

昨天调试 nginx 的时候, 转发都配置好了, 结果登录之后又跳到了登录页面, 顿时一脸懵逼;然后在别的地方看了下配置, 拷贝过来之后就可以正常登录的. 而拷贝过来的配置的一个关键的指令就是 proxy_cookie_path, 这不禁引起了我的好奇, 遂撰此文记录, 避免下次踩坑.

下面的这个介绍部分参考了这个博客:

https://cloud.tencent.com/developer/article/1858199

proxy_cookie_path 语法

proxy_cookie_path source target;

source 源路径
target 目标路径

使用原因

cookie 的 path 与地址栏上的 path 不一致, 浏览器就不会接受这个 cookie, 无法传入 JSESSIONID 的 cookie, 导致登录验证失败.

使用场景

当 nginx 配置的反向代理的路径和源地址路径不一致时使用.

# elastic-job 代理配置
location /etc-job/api/ {
    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_pass http://10.55.3.139:8088/api/;
    proxy_cookie_path / /etc-job/api/;
    proxy_set_header   Cookie $http_cookie;
}

感觉说的不是很清楚, 笔者还是看下 nginx 的官方文档吧!

nginx 官方文档

官方介绍的地址如下: http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_path

语法:
    proxy_cookie_path off;
    proxy_cookie_path path replacement;
    # 二者选其一或者同时存在, 同时存在就是 off 了
默认:
    proxy_cookie_path off;
上下文:
    http, server, location

这个指令是从 1.1.15 版本开始引入的.

可以设置被代理服务器响应中的 Set-Cookie 这个路径属性. 假被设代理服务器返回的 Set-Cookie 头的 path 字段的属性是 path=/two/some/uri/.

那么这个指令 proxy_cookie_path /two/ /; 会将这个属性重写为 path=/some/uri/.

我感觉这个就是一种替换, 将 /two/ 替换为 / 了

path 和 replacement 可以包含变量: proxy_cookie_path $uri /some$uri;

The directive can also be specified using regular expressions. In this case, path should either start from the ~ symbol for a case-sensitive matching, or from the ~* symbols for case-insensitive matching. The regular expression can contain named and positional captures, and replacement can reference them:

proxy_cookie_path ~*^/user/([^/]+) /u/$1;

同一级可以指定多个 proxy_cookie_path 指令:

proxy_cookie_path /one/ /;
proxy_cookie_path / /two/;

如果有多个指令都可以匹配上 cookie 的路径,nginx 会选择第一个匹配的指令.

off 参数会将所有继承的 proxy_cookie_path 都取消掉.

1.为什么cookie会丢失？

一个没有经过代理的地址如：http://127.0.0.1/project，它cookie的path为：/project；

但如果做了代理的处理，如地址：http://127.0.0.1/proxy_path，那cookie的path就变为了代理地址：/proxy_path。

如果cookie的path与地址栏上的path不相符游览器就不会接受这个cookie，那每次请求都会重新生成cookie，cookie中存放这sessionId,自然session也就跟着失效了。

2.nginx中proxy_cookie_path 的用法

proxy_cookie_path 的作用是用来改变cookie的路径语法：proxy_cookie_path path replacement;

path是你要替换的路径 replacement 就是要替换为的值。详情可以去nginx 官网看看传送门。

3.下面分别分三种情况处理

1.host、端口转换，cookie不会丢失：

    location /project {
        proxy_pass   http://127.0.0.1:8080/project;
    }

2.路径也变化，则需要设置cookie的路径转换：

    location /proxy_path {
        proxy_pass   http://127.0.0.1:8080/project;
        proxy_cookie_path  /project /proxy_path;
    }

3.直接代理本地端口：

    location /proxy_path {
        proxy_pass   http://127.0.0.1:8080/;
        proxy_cookie_path  /project /proxy_path; # project 为你的项目名 也可用变量代替
    }