如何使用header_filter_by_lua添加COOKIE

level077_0b9b · 2012-11-22T14:28:24+00:00

Hello, folks! I am happy to announce the new development version of ngx_openresty, 1.2.4.9: http://openresty.org/#Download Special thanks go to all ou...

如何使用header_filter_by_lua添加COOKIE

level077_0b9b

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

lhmwzy

gx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

在 2012年11月22日下午2:28，level077 <lev...@gmail.com>写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

lhmwzy

我是这样添加的
ngx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

另外，header_filter_by_lua能设置cookies？

在 2012年11月22日下午2:34，lhmwzy <lh...@gmail.com>写道：

gx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

在 2012年11月22日下午2:28，level077 <lev...@gmail.com>写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

lhmwzy

找到以前的例子了：
agentzh写的

Now with the latest ngx_lua v0.3.1rc3, we can implement this with a
little inlined Lua in nginx.conf:

server_name external.domain.com;

location / {
proxy_pass http://backend.int/;

header_filter_by_lua '
local cookies = ngx.header.set_cookie
if not cookies then return end
local newcookies = {}
for i, val in ipairs(cookies) do
local newval = string.gsub(val, "([dD]omain)=[%w_-\\\\.]+",
"%1=external.domain.com")
table.insert(newcookies, newval)
end
ngx.header.set_cookie = newcookies
';
}

We can surely make this more portable by avoiding hard-coding the
"external.domain.com" literal in our Lua code and reference
ngx.var.server_name (i.e., the nginx variable $server_name) instead ;)

Sorry, one line of Lua should be inserted right here for the case of a
single Set-Cookie response header:

if type(cookies) ~= "table" then cookies = {cookies} end

that is, ngx.header.set_cookie will just return a single Lua string
instead of a Lua table if there's only one Set-Cookie header.

在 2012年11月22日下午2:37，lhmwzy <lh...@gmail.com>写道：

我是这样添加的
ngx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

另外，header_filter_by_lua能设置cookies？

在 2012年11月22日下午2:34，lhmwzy <lh...@gmail.com>写道：

gx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

在 2012年11月22日下午2:28，level077 <lev...@gmail.com>写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

level077_0b9b

正解，3Q

在 2012年11月22日星期四UTC+8下午2时44分13秒，lhmwzy写道：

找到以前的例子了：
agentzh写的
Now with the latest ngx_lua v0.3.1rc3, we can implement this with a
little inlined Lua in nginx.conf:
server_name external.domain.com;

location / {
proxy_pass http://backend.int/;
header_filter_by_lua '
local cookies = ngx.header.set_cookie
if not cookies then return end
local newcookies = {}
for i, val in ipairs(cookies) do
local newval = string.gsub(val, "([dD]omain)=[%w_-\\\\.]+",
"%1=external.domain.com")
table.insert(newcookies, newval)
end
ngx.header.set_cookie = newcookies
';
}
We can surely make this more portable by avoiding hard-coding the
"external.domain.com" literal in our Lua code and reference
ngx.var.server_name (i.e., the nginx variable $server_name) instead ;)

Sorry, one line of Lua should be inserted right here for the case of a
single Set-Cookie response header:
if type(cookies) ~= "table" then cookies = {cookies} end

that is, ngx.header.set_cookie will just return a single Lua string
instead of a Lua table if there's only one Set-Cookie header.

在 2012年11月22日下午2:37，lhmwzy <lhm...@gmail.com>写道：

我是这样添加的
ngx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

另外，header_filter_by_lua能设置cookies？

在 2012年11月22日下午2:34，lhmwzy <lhm...@gmail.com>写道：

gx.header["Set-Cookie"] = {"name=" .. session_name .. "; expires=" .. expiretime ..";path=/" }

在 2012年11月22日下午2:28，level077 <leve...@gmail.com>写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

level077_0b9b

接着个问题，我现在把这个问题解决了，第一次进来的请求，我会设置个COOKIE，然后需要把这个设置的cookie值也记录到log中，目前第一次请求的日志里肯定没这cookie值，需要怎么做？应该涉及到phase问题了吧

在 2012年11月22日星期四UTC+8下午2时28分24秒，level077写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

wd

或许你对于第一次进来的设置一个变量，在 log 阶段判断这个变量和cookie，如果没有 cookie 就用这个变量，都没有就空。

2012/11/22 level077 <lev...@gmail.com>

接着个问题，我现在把这个问题解决了，第一次进来的请求，我会设置个COOKIE，然后需要把这个设置的cookie值也记录到log中，目前第一次请求的日志里肯定没这cookie值，需要怎么做？应该涉及到phase问题了吧

在 2012年11月22日星期四UTC+8下午2时28分24秒，level077写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

level077_0b9b

使用log_by_lua?还是可以直接加在access_log里呢？

在 2012年11月23日星期五UTC+8下午12时34分01秒，wd写道：

或许你对于第一次进来的设置一个变量，在 log 阶段判断这个变量和cookie，如果没有 cookie 就用这个变量，都没有就空。

2012/11/22 level077 <leve...@gmail.com>

接着个问题，我现在把这个问题解决了，第一次进来的请求，我会设置个COOKIE，然后需要把这个设置的cookie值也记录到log中，目前第一次请求的日志里肯定没这cookie值，需要怎么做？应该涉及到phase问题了吧

在 2012年11月22日星期四UTC+8下午2时28分24秒，level077写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

level077_0b9b

我想使用ngx.req.set_header,其他的header都可以，但就是cookie在日志里没抓到....

在 2012年11月23日星期五UTC+8下午12时34分01秒，wd写道：

或许你对于第一次进来的设置一个变量，在 log 阶段判断这个变量和cookie，如果没有 cookie 就用这个变量，都没有就空。

2012/11/22 level077 <leve...@gmail.com>

接着个问题，我现在把这个问题解决了，第一次进来的请求，我会设置个COOKIE，然后需要把这个设置的cookie值也记录到log中，目前第一次请求的日志里肯定没这cookie值，需要怎么做？应该涉及到phase问题了吧

在 2012年11月22日星期四UTC+8下午2时28分24秒，level077写道：

使用ngx.header.Set-Cookie = "xxx" 这样是不行的，是不是COOKIE添加需要其他的做法？

agentzh

Hello!

2012/11/23 level077 <lev...@gmail.com>:
> 我想使用ngx.req.set_header,其他的header都可以，但就是cookie在日志里没抓到....
>

你能提供一个最小化的例子么？我不太清楚你究竟想在这里达到什么需求，究竟是处理 Set-Cookie 响应头还是处理 Cookie
请求头。我也不知道你的 log_format 配置指令的日志模版是如何写的。

Regards,
-agentzh

wd

2012/11/24 agentzh <age...@gmail.com>

Hello!

2012/11/23 level077 <lev...@gmail.com>:
> 我想使用ngx.req.set_header,其他的header都可以，但就是cookie在日志里没抓到....
>

你能提供一个最小化的例子么？我不太清楚你究竟想在这里达到什么需求，究竟是处理 Set-Cookie 响应头还是处理 Cookie
请求头。我也不知道你的 log_format 配置指令的日志模版是如何写的。

他的需求应该是想在日志里面记录 cookie，包括第一次用户访问给用户产生的 cookie（这个还没有在用户本次请求的 header 里面）。

我之前想到的方法是通过环境变量，通过 lua 写一个环境变量，在 log_format 里面记录他。。。

Regards,
-agentzh

agentzh

Hello!

2012/11/23 wd:
>
> 他的需求应该是想在日志里面记录 cookie，包括第一次用户访问给用户产生的 cookie（这个还没有在用户本次请求的 header 里面）。
>

第一次用户访问为用户产生的 cookie 在 Set-Cookie 响应头里，可以在 log_format 模版里面通过
$sent_http_set_cookie 变量来记录，细节在这里：

    http://wiki.nginx.org/HttpCoreModule#.24sent_http_HEADER

后续从客户端带回来的 cookie 则可以通过 $cookie_XXX 或者 $http_cookie 予以记录：

    http://wiki.nginx.org/HttpCoreModule#.24cookie_COOKIE
    http://wiki.nginx.org/HttpCoreModule#.24http_HEADER

> 我之前想到的方法是通过环境变量，通过 lua 写一个环境变量，在 log_format 里面记录他。。。
>

嗯，也可以使用自定义的 nginx 变量进行归一化处理。可以在 header_filter_by_lua 之类的地方通过 Lua 把
Cookie 请求头或者 Set-Cookie 响应头的值存入自定义的Nginx 变量中，例如：

    set $my_cookie '';
    header_filter_by_lua '
        ngx.var.my_cookie = ngx.var.sent_http_cookie or ngx.var.sent
    ';

然后在 log_format 模版中直接引用 $my_cookie 即可 :)

Best regards,
-agentzh

agentzh

Hello!

2012/11/23 agentzh <age...@gmail.com>:
> 嗯，也可以使用自定义的 nginx 变量进行归一化处理。可以在 header_filter_by_lua 之类的地方通过 Lua 把
> Cookie 请求头或者 Set-Cookie 响应头的值存入自定义的Nginx 变量中，例如：
>
>     set $my_cookie '';
>     header_filter_by_lua '
>         ngx.var.my_cookie = ngx.var.sent_http_cookie or ngx.var.sent
>     ';

笔误，这里当是

       ngx.var.my_cookie = ngx.var.sent_http_set_cookie or ngx.var.http_cookie

>
> 然后在 log_format 模版中直接引用 $my_cookie 即可 :)
>
> Best regards,
> -agentzh

level077_0b9b

假设：log_format main "$cookie_1 $cookie_2 $cookie_3"

发送cookie：ngx.header['Set-Cookie'] = {'1=cookie_1; path=/', '2=cookie_2; path=/'，'3=cookie_3;path=/'}

$sent_http_set_cookie 的值只是1=cookie_1; path=/

可不可以使用ngx.req.set_header重新设置，然后使用日志记录下来？

在 2012年11月24日星期六UTC+8上午9时30分46秒，agentzh写道：

Hello!
2012/11/23 wd:
>
> 他的需求应该是想在日志里面记录 cookie，包括第一次用户访问给用户产生的 cookie（这个还没有在用户本次请求的 header 里面）。
>
第一次用户访问为用户产生的 cookie 在 Set-Cookie 响应头里，可以在 log_format 模版里面通过
$sent_http_set_cookie 变量来记录，细节在这里：
http://wiki.nginx.org/HttpCoreModule#.24sent_http_HEADER
后续从客户端带回来的 cookie 则可以通过 $cookie_XXX 或者 $http_cookie 予以记录：
http://wiki.nginx.org/HttpCoreModule#.24cookie_COOKIE
http://wiki.nginx.org/HttpCoreModule#.24http_HEADER
> 我之前想到的方法是通过环境变量，通过 lua 写一个环境变量，在 log_format 里面记录他。。。
>
嗯，也可以使用自定义的 nginx 变量进行归一化处理。可以在 header_filter_by_lua 之类的地方通过 Lua 把
Cookie 请求头或者 Set-Cookie 响应头的值存入自定义的Nginx 变量中，例如：
set $my_cookie '';
header_filter_by_lua '
ngx.var.my_cookie = ngx.var.sent_http_cookie or ngx.var.sent
';
然后在 log_format 模版中直接引用 $my_cookie 即可 :)
Best regards,
-agentzh

agentzh

Hello!

2012/11/25 level077:
> 假设：log_format main  "$cookie_1   $cookie_2    $cookie_3"
>
> 发送cookie：ngx.header['Set-Cookie'] = {'1=cookie_1; path=/', '2=cookie_2;
> path=/'，'3=cookie_3;path=/'}
>
> $sent_http_set_cookie 的值只是1=cookie_1; path=/
>
> 可不可以使用ngx.req.set_header重新设置，然后使用日志记录下来？
>

是的，$sent_http_set_cookie 只会返回第一个 Set-Cookie 头（因为 $sent_http_XXX
变量的值总是第一个 XXX 响应头的值）。

所以如果你有用到多个 Set-Cookie 头，最好在 Lua 中通过读取

    ngx.header["Set-Cookie"]

将所有的 Set-Cookie 响应头的值都序列化到一个 nginx 变量中。下面是一个完整的例子：

    log_format test '[$time_local] "$request" set-cookie: $my_cookie';
    access_log logs/access2.log test;

    server {
        # entry point
        location = /t {
            set $my_cookie '';

            proxy_pass http://127.0.0.1:$server_port/remote;

            header_filter_by_lua '
                local vals = ngx.header["Set-Cookie"]
                if type(vals) == "table" then
                    vals = table.concat(vals, " ")
                end
                ngx.var.my_cookie = vals
            ';
        }

        # dummy location to emulate a remote service
        location = /remote {
            access_log off;
            content_by_lua "
                ngx.header['Set-Cookie'] = {
                    '1=cookie_1; path=/',
                    '2=cookie_2; path=/',
                    '3=cookie_3;path=/'
                }
            ";
        }
    }

这里我们用 location = /remote 摸拟了一个生成 Set-Cookie 响应头的后端服务，然后在我们的主 location
中通过 proxy_pass 访问它。

请求 /t 接口可以在 logs/access2.log 中得到下面这一行记录：

    [25/Nov/2012:20:14:34 -0800] "GET /t HTTP/1.1" set-cookie:
1=cookie_1; path=/ 2=cookie_2; path=/ 3=cookie_3;path=/

我们看到，三个 cookie 都被记录下来了。上面这个例子同样可以处理只有一个 cookie 的情形。

如果你的应用直接是使用 content_by_lua 来生成 cookie 的话，则无需再引入 header_filter_by_lua
了，直接在 content_by_lua 中把所有 cookie 的值序列化进 $my_cookie 变量中去即可，例如：

    log_format test '[$time_local] "$request" set-cookie: $my_cookie';
    access_log logs/access2.log test;

    server {
        location = /t {
            set $my_cookie '';

            content_by_lua "
                local vals = {
                    '1=cookie_1; path=/',
                    '2=cookie_2; path=/',
                    '3=cookie_3;path=/'
                }

                ngx.header['Set-Cookie'] = vals
                ngx.var.my_cookie = table.concat(vals, ' ')
            ";
        }
    }

效果是完全一样的。上面这两个例子都在我本机测试通过 :)

Best regards,
-agentzh

level077_0b9b

我现在就是这么做。

设置多个变量，然后在lua中赋值。

感谢，还有lhmwzy wd :)

在 2012年11月26日星期一UTC+8下午12时23分09秒，agentzh写道：

Hello!
2012/11/25 level077:
> 假设：log_format main "$cookie_1 $cookie_2 $cookie_3"
>
> 发送cookie：ngx.header['Set-Cookie'] = {'1=cookie_1; path=/', '2=cookie_2;
> path=/'，'3=cookie_3;path=/'}
>
> $sent_http_set_cookie 的值只是1=cookie_1; path=/
>
> 可不可以使用ngx.req.set_header重新设置，然后使用日志记录下来？
>
是的，$sent_http_set_cookie 只会返回第一个 Set-Cookie 头（因为 $sent_http_XXX
变量的值总是第一个 XXX 响应头的值）。
所以如果你有用到多个 Set-Cookie 头，最好在 Lua 中通过读取
ngx.header["Set-Cookie"]
将所有的 Set-Cookie 响应头的值都序列化到一个 nginx 变量中。下面是一个完整的例子：
log_format test '[$time_local] "$request" set-cookie: $my_cookie';
access_log logs/access2.log test;
server {
# entry point
location = /t {
set $my_cookie '';
proxy_pass http://127.0.0.1:$server_port/remote;
header_filter_by_lua '
local vals = ngx.header["Set-Cookie"]
if type(vals) == "table" then
vals = table.concat(vals, " ")
end
ngx.var.my_cookie = vals
';
}
# dummy location to emulate a remote service
location = /remote {
access_log off;
content_by_lua "
ngx.header['Set-Cookie'] = {
'1=cookie_1; path=/',
'2=cookie_2; path=/',
'3=cookie_3;path=/'
}
";
}
}
这里我们用 location = /remote 摸拟了一个生成 Set-Cookie 响应头的后端服务，然后在我们的主 location
中通过 proxy_pass 访问它。
请求 /t 接口可以在 logs/access2.log 中得到下面这一行记录：
[25/Nov/2012:20:14:34 -0800] "GET /t HTTP/1.1" set-cookie:
1=cookie_1; path=/ 2=cookie_2; path=/ 3=cookie_3;path=/
我们看到，三个 cookie 都被记录下来了。上面这个例子同样可以处理只有一个 cookie 的情形。
如果你的应用直接是使用 content_by_lua 来生成 cookie 的话，则无需再引入 header_filter_by_lua
了，直接在 content_by_lua 中把所有 cookie 的值序列化进 $my_cookie 变量中去即可，例如：
log_format test '[$time_local] "$request" set-cookie: $my_cookie';
access_log logs/access2.log test;
server {
location = /t {
set $my_cookie '';
content_by_lua "
local vals = {
'1=cookie_1; path=/',
'2=cookie_2; path=/',
'3=cookie_3;path=/'
}
ngx.header['Set-Cookie'] = vals
ngx.var.my_cookie = table.concat(vals, ' ')
";
}
}
效果是完全一样的。上面这两个例子都在我本机测试通过 :)
Best regards,
-agentzh