原文地址: Nginx 中 proxy_cookie_path 的用法

歡迎訪問我的博客: http://blog.duhbb.com/

昨天調試 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 都取消掉.

如何查看 Set-Cookie

其實很簡單, chrome F12 打開調試, 然後登錄之後, 就可以看到接口 set-cookie 的響應了, 如下圖

如果這個 path 和瀏覽器地址欄的不一致, 瀏覽器會拒絕寫入這個 cookie, 相當於登陸了個寂寞.

原文地址: Nginx 中 proxy_cookie_path 的用法

歡迎訪問我的博客: http://blog.duhbb.com/