Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudflare/lua-resty-cookie
Lua library for HTTP cookie manipulations for OpenResty/ngx_lua
https://github.com/cloudflare/lua-resty-cookie
Last synced: 4 days ago
JSON representation
Lua library for HTTP cookie manipulations for OpenResty/ngx_lua
- Host: GitHub
- URL: https://github.com/cloudflare/lua-resty-cookie
- Owner: cloudflare
- Archived: true
- Created: 2013-10-27T01:42:39.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T12:59:08.000Z (about 1 year ago)
- Last Synced: 2024-04-14T22:17:10.634Z (7 months ago)
- Language: Perl
- Size: 23.4 KB
- Stars: 341
- Watchers: 38
- Forks: 160
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-resty - lua-resty-cookie
- awesome-nginx - lua-resty-cookie - Lua library for HTTP cookie manipulations for OpenResty/ngx_lua. (Rust Modules / Lua Modules)
README
Name
====
lua-resty-cookie - This library parses HTTP Cookie header for Nginx and returns each field in the cookie.
Table of Contents
=================
* [Name](#name)
* [Status](#status)
* [Synopsis](#synopsis)
* [Methods](#methods)
* [new](#new)
* [get](#get)
* [get_all](#get_all)
* [get_cookie_size](#get_cookie_size)
* [set](#set)
* [get_cookie_string](#get_cookie_string)
* [Installation](#installation)
* [Authors](#authors)
* [Copyright and License](#copyright-and-license)
Status
======
This library is production ready.
Synopsis
========
```lua
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
';
}
}
```
Methods
=======
[Back to TOC](#table-of-contents)
new
---
`syntax: cookie_obj = cookie()`
Create a new cookie object for current request. You can get parsed cookie from client or set cookie to client later using this object.
[Back to TOC](#table-of-contents)
get
---
`syntax: cookie_val, err = cookie_obj:get(cookie_name)`
Get a single client cookie value. On error, returns `nil` and an error message.
[Back to TOC](#table-of-contents)
get_all
-------
`syntax: fields, err = cookie_obj:get_all()`
Get all client cookie key/value pairs in a lua table. On error, returns `nil` and an error message.
[Back to TOC](#table-of-contents)
get_cookie_size
-------
`syntax: size = cookie_obj:get_cookie_size()`
Get the cookie size, i.e the string length of the cookie header value.
[Back to TOC](#table-of-contents)
set
---
```lua
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"
})
```
Set a cookie to client. This will add a new 'Set-Cookie' response header. `key` and `value` are required, all other fields are optional.
If the same cookie (whole cookie string, e.g. "Name=Bob; Expires=Wed, 09 Jun 2021 10:18:14 GMT; Max-Age=50; Domain=example.com; Path=/; Secure; HttpOnly;") has already been setted, new cookie will be ignored.
[Back to TOC](#table-of-contents)
get_cookie_string
---
```lua
syntax: cookie_string, err = cookie.get_cookie_string({ --[[ see "set" method ]] })
```
Returns a cookie string representing the table passed. See the `set` method for details, but unlike `set`, this function doesn't change the
current request response, but just return the generated string. On error, returns `nil` and an error message.
This is a static function, not a method of the `cookie` object.
[Back to TOC](#table-of-contents)
Installation
============
You need to compile [ngx_lua](https://github.com/chaoslawful/lua-nginx-module/tags) with your Nginx.
You need to configure
the [lua_package_path](https://github.com/chaoslawful/lua-nginx-module#lua_package_path) directive to
add the path of your `lua-resty-cookie` source tree to ngx_lua's Lua module search path, as in
# nginx.conf
http {
lua_package_path "/path/to/lua-resty-cookie/lib/?.lua;;";
...
}
and then load the library in Lua:
local ck = require "resty.cookie"
[Back to TOC](#table-of-contents)
Authors
=======
Jiale Zhi , CloudFlare Inc.
Yichun Zhang (agentzh) , CloudFlare Inc.
[Back to TOC](#table-of-contents)
Copyright and License
=====================
This module is licensed under the BSD license.
Copyright (C) 2013, by Jiale Zhi , CloudFlare Inc.
Copyright (C) 2013, by Yichun Zhang , CloudFlare Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[Back to TOC](#table-of-contents)