lua-resty-cookie
该库解析 Nginx 的 HTTP Cookie 头,并返回 cookie 中的每个字段。
$ opm get valdemaras-pipiras/lua-resty-cookie
名称
lua-resty-cookie - 该库解析 Nginx 的 HTTP Cookie 头,并返回 cookie 中的每个字段。
状态
该库已准备好投入生产。
概要
lua_package_path "/path/to/lua-resty-cookie/lib/?.lua;;";
server {
location /test {
content_by_lua '
local ck = require "resty.cookie"
local cookie, err = ck:new()
if not cookie then
ngx.log(ngx.ERR, err)
return
end
-- get single cookie
local field, err = cookie:get("lang")
if not field then
ngx.log(ngx.ERR, err)
return
end
ngx.say("lang", " => ", field)
-- get all cookies
local fields, err = cookie:get_all()
if not fields then
ngx.log(ngx.ERR, err)
return
end
for k, v in pairs(fields) do
ngx.say(k, " => ", v)
end
-- set one cookie
local ok, err = cookie:set({
key = "Name", value = "Bob", path = "/",
domain = "example.com", secure = true, httponly = true,
expires = "Wed, 09 Jun 2021 10:18:14 GMT", max_age = 50,
samesite = "Strict", extension = "a4334aebaec"
})
if not ok then
ngx.log(ngx.ERR, err)
return
end
-- set another cookie, both cookies will appear in HTTP response
local ok, err = cookie:set({
key = "Age", value = "20",
})
if not ok then
ngx.log(ngx.ERR, err)
return
end
';
}
}
方法
new
语法: cookie_obj = cookie()
为当前请求创建一个新的 cookie 对象。您可以使用此对象获取从客户端解析的 cookie,或者稍后将 cookie 设置到客户端。
get
语法: cookie_val, err = cookie_obj:get(cookie_name)
获取单个客户端 cookie 值。如果出错,返回 `nil` 和错误消息。
get_all
语法: fields, err = cookie_obj:get_all()
以 lua 表格形式获取所有客户端 cookie 键/值对。如果出错,返回 `nil` 和错误消息。
get_cookie_size
语法: size = cookie_obj:get_cookie_size()
获取 cookie 大小,即 cookie 头值字符串的长度。
set
syntax: ok, err = cookie_obj:set({
key = "Name",
value = "Bob",
path = "/",
domain = "example.com",
secure = true, httponly = true,
expires = "Wed, 09 Jun 2021 10:18:14 GMT",
max_age = 50,
samesite = "Strict",
extension = "a4334aebaec"
})
将 cookie 设置到客户端。这将添加一个新的 'Set-Cookie' 响应头。`key` 和 `value` 是必需的,所有其他字段都是可选的。如果相同的 cookie(整个 cookie 字符串,例如“Name=Bob; Expires=Wed, 09 Jun 2021 10:18:14 GMT; Max-Age=50; Domain=example.com; Path=/; Secure; HttpOnly;”)已经设置,则新 cookie 将被忽略。
get_cookie_string
syntax: cookie_string, err = cookie.get_cookie_string({ --[[ see "set" method ]] })
返回表示传入表格的 cookie 字符串。有关详细信息,请参见 `set` 方法,但与 `set` 不同,此函数不会更改当前请求响应,而只会返回生成的字符串。如果出错,返回 `nil` 和错误消息。
这是一个静态函数,而不是 `cookie` 对象的方法。
安装
您需要使用您的 Nginx 编译 ngx_lua。
您需要配置 lua_package_path 指令,将您的 `lua-resty-cookie` 源代码树的路径添加到 ngx_lua 的 Lua 模块搜索路径中,如
# nginx.conf
http {
lua_package_path "/path/to/lua-resty-cookie/lib/?.lua;;";
...
}
然后在 Lua 中加载库
local ck = require "resty.cookie"
作者
Jiale Zhi <vipcalio@gmail.com>,CloudFlare Inc.
Yichun Zhang (agentzh) <agentzh@gmail.com>,CloudFlare Inc.
版权和许可
此模块根据 BSD 许可证授权。
版权所有 (C) 2013,Jiale Zhi <vipcalio@gmail.com>,CloudFlare Inc.
版权所有 (C) 2013,Yichun Zhang <agentzh@gmail.com>,CloudFlare Inc.
保留所有权利。
允许以源代码和二进制形式重新分发和使用本软件,无论是否修改,只要满足以下条件
源代码的重新分发必须保留上述版权声明、此条件列表和以下免责声明。
二进制形式的重新分发必须在随发行提供的文档和/或其他材料中复制上述版权声明、此条件列表和以下免责声明。
本软件由版权持有人和贡献者“按现状”提供,任何明示或暗示的担保,包括但不限于适销性和特定用途适用性的暗示担保均被排除在外。在任何情况下,版权持有人或贡献者均不对任何直接的、间接的、附带的、特殊的、惩罚性的或后果性的损害(包括但不限于替代商品或服务的采购;使用、数据或利润损失;或业务中断)负责,无论其是基于何种责任理论,无论是合同、严格责任还是侵权行为(包括疏忽或其他原因)引起的,即使已告知可能发生此类损害。
作者
Jiale Zhi,Yichun Zhang (agentzh)
许可证
2bsd
版本
-
该库解析 Nginx 的 HTTP Cookie 头,并返回 cookie 中的每个字段。 2023-06-20 07:37:10