lua-nginx-module

已于 2022-05-18 18:44:28 修改
阅读量1.3k 收藏
点赞数
分类专栏： Openresty 文章标签： lua nginx 运维
于 2022-01-04 11:08:52 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/songfeihu0810232/article/details/122298787
版权
本文深入介绍了ngx_http_lua_module，一个让Nginx支持Lua脚本的强大组件，属于OpenResty核心部分。文档覆盖了模块状态、版本信息、安装教程及配置、典型应用场景、兼容性问题、已知问题等，并提供了丰富的社区资源链接和YouTube教学视频。重点讨论了如何在Nginx中使用Lua进行功能扩展，包括请求处理、响应头操作、内部请求识别等高级特性。
摘要由CSDN通过智能技术生成

Name

ngx_http_lua_module - Embed the power of Lua into Nginx HTTP Servers.

This module is a core component of OpenResty. If you are using this module,
then you are essentially using OpenResty.

This module is not distributed with the Nginx source. See
the installation instructions.

Table of Contents

Status

Production ready.

Version

This document describes ngx_lua
v0.10.19, which was released
on 3 Nov, 2020.

Videos

You are welcome to subscribe to our official YouTube channel, OpenResty.

Back to TOC

Synopsis


 # set search paths for pure Lua external libraries (';;' is the default path):
 lua_package_path '/foo/bar/?.lua;/blah/?.lua;;';

 # set search paths for Lua external libraries written in C (can also use ';;'):
 lua_package_cpath '/bar/baz/?.so;/blah/blah/?.so;;';

 server {
     location /lua_content {
         # MIME type determined by default_type:
         default_type 'text/plain';

         content_by_lua_block {
             ngx.say('Hello,world!')
         }
     }

     location /nginx_var {
         # MIME type determined by default_type:
         default_type 'text/plain';

         # try access /nginx_var?a=hello,world
         content_by_lua_block {
             ngx.say(ngx.var.arg_a)
         }
     }

     location = /request_body {
         client_max_body_size 50k;
         client_body_buffer_size 50k;

         content_by_lua_block {
             ngx.req.read_body()  -- explicitly read the req body
             local data = ngx.req.get_body_data()
             if data then
                 ngx.say("body data:")
                 ngx.print(data)
                 return
             end

             -- body may get buffered in a temp file:
             local file = ngx.req.get_body_file()
             if file then
                 ngx.say("body is in file ", file)
             else
                 ngx.say("no body found")
             end
         }
     }

     # transparent non-blocking I/O in Lua via subrequests
     # (well, a better way is to use cosockets)
     location = /lua {
         # MIME type determined by default_type:
         default_type 'text/plain';

         content_by_lua_block {
             local res = ngx.location.capture("/some_other_location")
             if res then
                 ngx.say("status: ", res.status)
                 ngx.say("body:")
                 ngx.print(res.body)
             end
         }
     }

     location = /foo {
         rewrite_by_lua_block {
             res = ngx.location.capture("/memc",
                 { args = { cmd = "incr", key = ngx.var.uri } }
             )
         }

         proxy_pass http://blah.blah.com;
     }

     location = /mixed {
         rewrite_by_lua_file /path/to/rewrite.lua;
         access_by_lua_file /path/to/access.lua;
         content_by_lua_file /path/to/content.lua;
     }

     # use nginx var in code path
     # CAUTION: contents in nginx var must be carefully filtered,
     # otherwise there'll be great security risk!
     location ~ ^/app/([-_a-zA-Z0-9/]+) {
         set $path $1;
         content_by_lua_file /path/to/lua/app/root/$path.lua;
     }

     location / {
        client_max_body_size 100k;
        client_body_buffer_size 100k;

        access_by_lua_block {
            -- check the client IP address is in our black list
            if ngx.var.remote_addr == "132.5.72.3" then
                ngx.exit(ngx.HTTP_FORBIDDEN)
            end

            -- check if the URI contains bad words
            if ngx.var.uri and
                   string.match(ngx.var.request_body, "evil")
            then
                return ngx.redirect("/terms_of_use.html")
            end

            -- tests passed
        }

        # proxy_pass/fastcgi_pass/etc settings
     }
 }

Back to TOC

Description

This module embeds LuaJIT 2.0/2.1 into Nginx.
It is a core component of OpenResty. If you are using
this module, then you are essentially using OpenResty.

Since version v0.10.16 of this module, the standard Lua
interpreter (also known as “PUC-Rio Lua”) is not supported anymore. This
document interchangeably uses the terms “Lua” and “LuaJIT” to refer to the
LuaJIT interpreter.

By leveraging Nginx’s subrequests, this module allows the integration of the
powerful Lua threads (known as Lua “coroutines”) into the Nginx event model.

Unlike Apache’s mod_lua
and Lighttpd’s mod_magnet,
Lua code executed using this module can be 100% non-blocking on network
traffic as long as the Nginx API for Lua provided by
this module is used to handle requests to upstream services such as MySQL,
PostgreSQL, Memcached, Redis, or upstream HTTP web services.

At least the following Lua libraries and Nginx modules can be used with this
module:

Almost any Nginx modules can be used with this ngx_lua module by means of
ngx.location.capture or
ngx.location.capture_multi but it is
recommended to use those lua-resty-* libraries instead of creating
subrequests to access the Nginx upstream modules because the former is usually
much more flexible and memory-efficient.

The Lua interpreter (also known as “Lua State” or “LuaJIT VM instance”) is
shared across all the requests in a single Nginx worker process to minimize
memory use. Request contexts are segregated using lightweight Lua coroutines.

Loaded Lua modules persist in the Nginx worker process level resulting in a
small memory footprint in Lua even when under heavy loads.

This module is plugged into Nginx’s “http” subsystem so it can only speaks
downstream communication protocols in the HTTP family (HTTP 0.9/1.0/1.1/2.0,
WebSockets, etc…). If you want to do generic TCP communications with the
downstream clients, then you should use the
ngx_stream_lua
module instead, which offers a compatible Lua API.

Back to TOC

Typical Uses

Just to name a few:

  • Mashup’ing and processing outputs of various Nginx upstream outputs (proxy, drizzle, postgres, redis, memcached, and etc) in Lua,
  • doing arbitrarily complex access control and security checks in Lua before requests actually reach the upstream backends,
  • manipulating response headers in an arbitrary way (by Lua)
  • fetching backend information from external storage backends (like redis, memcached, mysql, postgresql) and use that information to choose which upstream backend to access on-the-fly,
  • coding up arbitrarily complex web applications in a content handler using synchronous but still non-blocking access to the database backends and other storage,
  • doing very complex URL dispatch in Lua at rewrite phase,
  • using Lua to implement advanced caching mechanism for Nginx’s subrequests and arbitrary locations.

The possibilities are unlimited as the module allows bringing together various
elements within Nginx as well as exposing the power of the Lua language to the
user. The module provides the full flexibility of scripting while offering
performance levels comparable with native C language programs both in terms of
CPU time as well as memory footprint thanks to LuaJIT 2.x.

Other scripting language implementations typically struggle to match this
performance level.

Back to TOC

Nginx Compatibility

The latest version of this module is compatible with the following versions of Nginx:

  • 1.19.x (last tested: 1.19.3)
  • 1.17.x (last tested: 1.17.8)
  • 1.15.x (last tested: 1.15.8)
  • 1.14.x
  • 1.13.x (last tested: 1.13.6)
  • 1.12.x
  • 1.11.x (last tested: 1.11.2)
  • 1.10.x
  • 1.9.x (last tested: 1.9.15)
  • 1.8.x
  • 1.7.x (last tested: 1.7.10)
  • 1.6.x

Nginx cores older than 1.6.0 (exclusive) are not supported.

Back to TOC

Installation

It is highly recommended to use OpenResty releases
which bundle Nginx, ngx_lua (this module), LuaJIT, as well as other powerful
companion Nginx modules and Lua libraries.

It is discouraged to build this module with Nginx yourself since it is tricky
to set up exactly right.

Note that Nginx, LuaJIT, and OpenSSL official releases have various limitations
and long standing bugs that can cause some of this module’s features to be
disabled, not work properly, or run slower. Official OpenResty releases are
recommended because they bundle OpenResty’s optimized LuaJIT 2.1 fork and
Nginx/OpenSSL
patches.

Alternatively, ngx_lua can be manually compiled into Nginx:

  1. LuaJIT can be downloaded from the latest release of OpenResty’s LuaJIT fork. The official LuaJIT 2.x releases are also supported, although performance will be significantly lower for reasons elaborated above
  2. Download the latest version of the ngx_devel_kit (NDK) module HERE
  3. Download the latest version of ngx_lua HERE
  4. Download the latest supported version of Nginx HERE (See Nginx Compatibility)
  5. Download the latest version of the lua-resty-core HERE
  6. Download the latest version of the lua-resty-lrucache HERE

Build the source with this module:


 wget 'https://openresty.org/download/nginx-1.19.3.tar.gz'
 tar -xzvf nginx-1.19.3.tar.gz
 cd nginx-1.19.3/

 # tell nginx's build system where to find LuaJIT 2.0:
 export LUAJIT_LIB=/path/to/luajit/lib
 export LUAJIT_INC=/path/to/luajit/include/luajit-2.0

 # tell nginx's build system where to find LuaJIT 2.1:
 export LUAJIT_LIB=/path/to/luajit/lib
 export LUAJIT_INC=/path/to/luajit/include/luajit-2.1

 # Here we assume Nginx is to be installed under /opt/nginx/.
 ./configure --prefix=/opt/nginx \
         --with-ld-opt="-Wl,-rpath,/path/to/luajit/lib" \
         --add-module=/path/to/ngx_devel_kit \
         --add-module=/path/to/lua-nginx-module

 # Note that you may also want to add `./configure` options which are used in your
 # current nginx build.
 # You can get usually those options using command nginx -V

 # you can change the parallelism number 2 below to fit the number of spare CPU cores in your
 # machine.
 make -j2
 make install

 # Note that this version of lug-nginx-module not allow to set `lua_load_resty_core off;` any more.
 # So, you have to install `lua-resty-core` and `lua-resty-lrucache` manually as below.

 cd lua-resty-core
 make install PREFIX=/opt/nginx
 cd lua-resty-lrucache
 make install PREFIX=/opt/nginx

 # add necessary `lua_package_path` directive to `nginx.conf`, in the http context

 lua_package_path "/opt/nginx/lib/lua/?.lua;;";

Back to TOC

Building as a dynamic module

Starting from NGINX 1.9.11, you can also compile this module as a dynamic module, by using the --add-dynamic-module=PATH option instead of --add-module=PATH on the
./configure command line above. And then you can explicitly load the module in your nginx.conf via the load_module
directive, for example,


 load_module /path/to/modules/ndk_http_module.so;  # assuming NDK is built as a dynamic module too
 load_module /path/to/modules/ngx_http_lua_module.so;

Back to TOC

C Macro Configurations

While building this module either via OpenResty or with the Nginx core, you can define the following C macros via the C compiler options:

  • NGX_LUA_USE_ASSERT
    When defined, will enable assertions in the ngx_lua C code base. Recommended for debugging or testing builds. It can introduce some (small) runtime overhead when enabled. This macro was first introduced in the v0.9.10 release.
  • NGX_LUA_ABORT_AT_PANIC
    When the LuaJIT VM panics, ngx_lua will instruct the current nginx worker process to quit gracefully by default. By specifying this C macro, ngx_lua will abort the current nginx worker process (which usually result in a core dump file) immediately. This option is useful for debugging VM panics. This option was first introduced in the v0.9.8 release.

To enable one or more of these macros, just pass extra C compiler options to the ./configure script of either Nginx or OpenResty. For instance,

./configure --with-cc-opt="-DNGX_LUA_USE_ASSERT -DNGX_LUA_ABORT_AT_PANIC"

Back to TOC

Community

Back to TOC

English Mailing List

The openresty-en mailing list is for English speakers.

Back to TOC

Chinese Mailing List

The openresty mailing list is for Chinese speakers.

Back to TOC

Code Repository

The code repository of this project is hosted on GitHub at
openresty/lua-nginx-module.

Back to TOC

Bugs and Patches

Please submit bug reports, wishlists, or patches by

  1. creating a ticket on the GitHub Issue Tracker,
  2. or posting to the OpenResty community.

Back to TOC

LuaJIT bytecode support

Watch YouTube video “Measure Execution Time of Lua Code Correctly in OpenResty”

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UINpT6ry-1641265614498)(https://img.youtube.com/vi/EP7c0BM2yNo/0.jpg)]

As from the v0.5.0rc32 release, all *_by_lua_file configure directives (such as content_by_lua_file) support loading LuaJIT 2.0/2.1 raw bytecode files directly:


 /path/to/luajit/bin/luajit -b /path/to/input_file.lua /path/to/output_file.ljbc

The -bg option can be used to include debug information in the LuaJIT bytecode file:


 /path/to/luajit/bin/luajit -bg /path/to/input_file.lua /path/to/output_file.ljbc

Please refer to the official LuaJIT documentation on the -b option for more details:

https://luajit.org/running.html#opt_b

Note that the bytecode files generated by LuaJIT 2.1 is not compatible with
LuaJIT 2.0, and vice versa. The support for LuaJIT 2.1 bytecode was first added
in ngx_lua v0.9.3.

Attempts to load standard Lua 5.1 bytecode files into ngx_lua instances linked
to LuaJIT 2.0/2.1 (or vice versa) will result in an Nginx error message such as
the one below:

[error] 13909#0: *1 failed to load Lua inlined code: bad byte-code header in /path/to/test_file.luac

Loading bytecode files via the Lua primitives like require and
dofile should always work as expected.

Back to TOC

System Environment Variable Support

If you want to access the system environment variable, say, foo, in Lua via the standard Lua API os.getenv, then you should also list this environment variable name in your nginx.conf file via the env directive. For example,


 env foo;

Back to TOC

HTTP 1.0 support

The HTTP 1.0 protocol does not support chunked output and requires an explicit Content-Length header when the response body is not empty in order to support the HTTP 1.0 keep-alive.
So when a HTTP 1.0 request is made and the lua_http10_buffering directive is turned on, ngx_lua will buffer the
output of ngx.say and ngx.print calls and also postpone sending response headers until all the response body output is received.
At that time ngx_lua can calculate the total length of the body and construct a proper Content-Length header to return to the HTTP 1.0 client.
If the Content-Length response header is set in the running Lua code, however, this buffering will be disabled even if the lua_http10_buffering directive is turned on.

For large streaming output responses, it is important to disable the lua_http10_buffering directive to minimise memory usage.

Note that common HTTP benchmark tools such as ab and http_load issue HTTP 1.0 requests by default.
To force curl to send HTTP 1.0 requests, use the -0 option.

Back to TOC

Statically Linking Pure Lua Modules

With LuaJIT 2.x, it is possible to statically link the bytecode of pure Lua
modules into the Nginx executable.

You can use the luajit executable to compile .lua Lua
module files to .o object files containing the exported bytecode
data, and then link the .o files directly in your Nginx build.

Below is a trivial example to demonstrate this. Consider that we have the following .lua file named foo.lua:


 -- foo.lua
 local _M = {}

 function _M.go()
     print("Hello from foo")
 end

 return _M

And then we compile this .lua file to foo.o file:


 /path/to/luajit/bin/luajit -bg foo.lua foo.o

What matters here is the name of the .lua file, which determines how you use this module later on the Lua land. The file name foo.o does not matter at all except the .o file extension (which tells luajit what output format is used). If you want to strip the Lua debug information from the resulting bytecode, you can just specify the -b option above instead of -bg.

Then when building Nginx or OpenResty, pass the --with-ld-opt="foo.o" option to the ./configure script:


 ./configure --with-ld-opt="/path/to/foo.o" ...

Finally, you can just do the following in any Lua code run by ngx_lua:


 local foo = require "foo"
 foo.go()

And this piece of code no longer depends on the external foo.lua file any more because it has already been compiled into the nginx executable.

If you want to use dot in the Lua module name when calling require, as in


 local foo = require "resty.foo"

then you need to rename the foo.lua file to resty_foo.lua before compiling it down to a .o file with the luajit command-line utility.

It is important to use exactly the same version of LuaJIT when compiling .lua files to .o files as building nginx + ngx_lua. This is because the LuaJIT bytecode format may be incompatible between different LuaJIT versions. When the bytecode format is incompatible, you will see a Lua runtime error saying that the Lua module is not found.

When you have multiple .lua files to compile and link, then just specify their .o files at the same time in the value of the --with-ld-opt option. For instance,


 ./configure --with-ld-opt="/path/to/foo.o /path/to/bar.o" ...

If you have too many .o files, then it might not be feasible to name them all in a single command. In this case, you can build a static library (or archive) for your .o files, as in


 ar rcus libmyluafiles.a *.o

then you can link the myluafiles archive as a whole to your nginx executable:


 ./configure \
     --with-ld-opt="-L/path/to/lib -Wl,--whole-archive -lmyluafiles -Wl,--no-whole-archive"

where /path/to/lib is the path of the directory containing the libmyluafiles.a file. It should be noted that the linker option --whole-archive is required here because otherwise our archive will be skipped because no symbols in our archive are mentioned in the main parts of the nginx executable.

Back to TOC

Data Sharing within an Nginx Worker

To globally share data among all the requests handled by the same Nginx worker
process, encapsulate the shared data into a Lua module, use the Lua
require builtin to import the module, and then manipulate the
shared data in Lua. This works because required Lua modules are loaded only
once and all coroutines will share the same copy of the module (both its code
and data).

Note that the use of global Lua variables is strongly discouraged, as it may
lead to unexpected race conditions between concurrent requests.

Here is a small example on sharing data within an Nginx worker via a Lua module:


 -- mydata.lua
 local _M = {}

 local data = {
     dog = 3,
     cat = 4,
     pig = 5,
 }

 function _M.get_age(name)
     return data[name]
 end

 return _M

and then accessing it from nginx.conf:


 location /lua {
     content_by_lua_block {
         local mydata = require "mydata"
         ngx.say(mydata.get_age("dog"))
     }
 }

The mydata module in this example will only be loaded and run on the first request to the location /lua,
and all subsequent requests to the same Nginx worker process will use the reloaded instance of the
module as well as the same copy of the data in it, until a HUP signal is sent to the Nginx master process to force a reload.
This data sharing technique is essential for high performance Lua applications based on this module.

Note that this data sharing is on a per-worker basis and not on a per-server basis. That is, when there are multiple Nginx worker processes under an Nginx master, data sharing cannot cross the process boundary between these workers.

It is usually recommended to share read-only data this way. You can also share changeable data among all the concurrent requests of each Nginx worker process as
long as there is no nonblocking I/O operations (including ngx.sleep)
in the middle of your calculations. As long as you do not give the
control back to the Nginx event loop and ngx_lua’s light thread
scheduler (even implicitly), there can never be any race conditions in
between. For this reason, always be very careful when you want to share changeable data on the
worker level. Buggy optimizations can easily lead to hard-to-debug
race conditions under load.

If server-wide data sharing is required, then use one or more of the following approaches:

  1. Use the ngx.shared.DICT API provided by this module.
  2. Use only a single Nginx worker and a single server (this is however not recommended when there is a multi core CPU or multiple CPUs in a single machine).
  3. Use data storage mechanisms such as memcached, redis, MySQL or PostgreSQL. The OpenResty official releases come with a set of companion Nginx modules and Lua libraries that provide interfaces with these data storage mechanisms.

Back to TOC

Known Issues

Back to TOC

TCP socket connect operation issues

The tcpsock:connect method may indicate success despite connection failures such as with Connection Refused errors.

However, later attempts to manipulate the cosocket object will fail and return the actual error status message generated by the failed connect operation.

This issue is due to limitations in the Nginx event model and only appears to affect Mac OS X.

Back to TOC

Lua Coroutine Yielding/Resuming

  • Because Lua’s dofile and require builtins are currently implemented as C functions in LuaJIT 2.0/2.1, if the Lua file being loaded by dofile or require invokes ngx.location.capture*, ngx.exec, ngx.exit, or other API functions requiring yielding in the top-level scope of the Lua file, then the Lua error “attempt to yield across C-call boundary” will be raised. To avoid this, put these calls requiring yielding into your own Lua functions in the Lua file instead of the top-level scope of the file.

Back to TOC

Lua Variable Scope

Care must be taken when importing modules, and this form should be used:


 local xxx = require('xxx')

instead of the old deprecated form:


 require('xxx')

Here is the reason: by design, the global environment has exactly the same lifetime as the Nginx request handler associated with it. Each request handler has its own set of Lua global variables and that is the idea of request isolation. The Lua module is actually loaded by the first Nginx request handler and is cached by the require() built-in in the package.loaded table for later reference, and the module() builtin used by some Lua modules has the side effect of setting a global variable to the loaded module table. But this global variable will be cleared at the end of the request handler, and every subsequent request handler all has its own (clean) global environment. So one will get Lua exception for accessing the nil value.

The use of Lua global variables is a generally inadvisable in the ngx_lua context as:

  1. the misuse of Lua globals has detrimental side effects on concurrent requests when such variables should instead be local in scope,
  2. Lua global variables require Lua table look-ups in the global environment which is computationally expensive, and
  3. some Lua global variable references may include typing errors which make such difficult to debug.

It is therefore highly recommended to always declare such within an appropriate local scope instead.


 -- Avoid
 foo = 123
 -- Recommended
 local foo = 123

 -- Avoid
 function foo() return 123 end
 -- Recommended
 local function foo() return 123 end

To find all instances of Lua global variables in your Lua code, run the lua-releng tool across all .lua source files:

$ lua-releng
Checking use of Lua global variables in file lib/foo/bar.lua ...
        1       [1489]  SETGLOBAL       7 -1    ; contains
        55      [1506]  GETGLOBAL       7 -3    ; setvar
        3       [1545]  GETGLOBAL       3 -4    ; varexpand

The output says that the line 1489 of file lib/foo/bar.lua writes to a global variable named contains, the line 1506 reads from the global variable setvar, and line 1545 reads the global varexpand.

This tool will guarantee that local variables in the Lua module functions are all declared with the local keyword, otherwise a runtime exception will be thrown. It prevents undesirable race conditions while accessing such variables. See Data Sharing within an Nginx Worker for the reasons behind this.

Back to TOC

Locations Configured by Subrequest Directives of Other Modules

The ngx.location.capture and ngx.location.capture_multi directives cannot capture locations that include the add_before_body, add_after_body, auth_request, echo_location, echo_location_async, echo_subrequest, or echo_subrequest_async directives.


 location /foo {
     content_by_lua_block {
         res = ngx.location.capture("/bar")
     }
 }
 location /bar {
     echo_location /blah;
 }
 location /blah {
     echo "Success!";
 }


 $ curl -i http://example.com/foo

will not work as expected.

Back to TOC

Cosockets Not Available Everywhere

Due to internal limitations in the Nginx core, the cosocket API is disabled in the following contexts: set_by_lua*, log_by_lua*, header_filter_by_lua*, and body_filter_by_lua.

The cosockets are currently also disabled in the init_by_lua* and init_worker_by_lua* directive contexts but we may add support for these contexts in the future because there is no limitation in the Nginx core (or the limitation might be worked around).

There exists a workaround, however, when the original context does not need to wait for the cosocket results. That is, creating a zero-delay timer via the ngx.timer.at API and do the cosocket results in the timer handler, which runs asynchronously as to the original context creating the timer.

Back to TOC

Special Escaping Sequences

NOTE Following the v0.9.17 release, this pitfall can be avoided by using the *_by_lua_block {} configuration directives.

PCRE sequences such as \d, \s, or \w, require special attention because in string literals, the backslash character, \, is stripped out by both the Lua language parser and by the Nginx config file parser before processing if not within a *_by_lua_block {} directive. So the following snippet will not work as expected:


 # nginx.conf
 ? location /test {
 ?     content_by_lua '
 ?         local regex = "\d+"  -- THIS IS WRONG OUTSIDE OF A *_by_lua_block DIRECTIVE
 ?         local m = ngx.re.match("hello, 1234", regex)
 ?         if m then ngx.say(m[0]) else ngx.say("not matched!") end
 ?     ';
 ? }
 # evaluates to "not matched!"

To avoid this, double escape the backslash:


 # nginx.conf
 location /test {
     content_by_lua '
         local regex = "\\\\d+"
         local m = ngx.re.match("hello, 1234", regex)
         if m then ngx.say(m[0]) else ngx.say("not matched!") end
     ';
 }
 # evaluates to "1234"

Here, \\\\d+ is stripped down to \\d+ by the Nginx config file parser and this is further stripped down to \d+ by the Lua language parser before running.

Alternatively, the regex pattern can be presented as a long-bracketed Lua string literal by encasing it in “long brackets”, [[...]], in which case backslashes have to only be escaped once for the Nginx config file parser.


 # nginx.conf
 location /test {
     content_by_lua '
         local regex = [[\\d+]]
         local m = ngx.re.match("hello, 1234", regex)
         if m then ngx.say(m[0]) else ngx.say("not matched!") end
     ';
 }
 # evaluates to "1234"

Here, [[\\d+]] is stripped down to [[\d+]] by the Nginx config file parser and this is processed correctly.

Note that a longer from of the long bracket, [=[...]=], may be required if the regex pattern contains [...] sequences.
The [=[...]=] form may be used as the default form if desired.


 # nginx.conf
 location /test {
     content_by_lua '
         local regex = [=[[0-9]+]=]
         local m = ngx.re.match("hello, 1234", regex)
         if m then ngx.say(m[0]) else ngx.say("not matched!") end
     ';
 }
 # evaluates to "1234"

An alternative approach to escaping PCRE sequences is to ensure that Lua code is placed in external script files and executed using the various *_by_lua_file directives.
With this approach, the backslashes are only stripped by the Lua language parser and therefore only need to be escaped once each.


 -- test.lua
 local regex = "\\d+"
 local m = ngx.re.match("hello, 1234", regex)
 if m then ngx.say(m[0]) else ngx.say("not matched!") end
 -- evaluates to "1234"

Within external script files, PCRE sequences presented as long-bracketed Lua string literals do not require modification.


 -- test.lua
 local regex = [[\d+]]
 local m = ngx.re.match("hello, 1234", regex)
 if m then ngx.say(m[0]) else ngx.say("not matched!") end
 -- evaluates to "1234"

As noted earlier, PCRE sequences presented within *_by_lua_block {} directives (available following the v0.9.17 release) do not require modification.


 # nginx.conf
 location /test {
     content_by_lua_block {
         local regex = [[\d+]]
         local m = ngx.re.match("hello, 1234", regex)
         if m then ngx.say(m[0]) else ngx.say("not matched!") end
     }
 }
 # evaluates to "1234"

NOTE You are recommended to use by_lua_file when the Lua code is very long.

Back to TOC

Mixing with SSI Not Supported

Mixing SSI with ngx_lua in the same Nginx request is not supported at all. Just use ngx_lua exclusively. Everything you can do with SSI can be done atop ngx_lua anyway and it can be more efficient when using ngx_lua.

Back to TOC

SPDY Mode Not Fully Supported

Certain Lua APIs provided by ngx_lua do not work in Nginx’s SPDY mode yet: ngx.location.capture, ngx.location.capture_multi, and ngx.req.socket.

Back to TOC

Missing data on short circuited requests

Nginx may terminate a request early with (at least):

  • 400 (Bad Request)
  • 405 (Not Allowed)
  • 408 (Request Timeout)
  • 413 (Request Entity Too Large)
  • 414 (Request URI Too Large)
  • 494 (Request Headers Too Large)
  • 499 (Client Closed Request)
  • 500 (Internal Server Error)
  • 501 (Not Implemented)

This means that phases that normally run are skipped, such as the rewrite or
access phase. This also means that later phases that are run regardless, e.g.
log_by_lua, will not have access to information that is normally set in those
phases.

Back to TOC

TODO

  • cosocket: implement LuaSocket’s unconnected UDP API.
  • cosocket: add support in the context of init_by_lua*.
  • cosocket: implement the bind() method for stream-typed cosockets.
  • cosocket: review and merge aviramc’s patch for adding the bsdrecv method.
  • cosocket: add configure options for different strategies of handling the cosocket connection exceeding in the pools.
  • review and apply vadim-pavlov’s patch for ngx.location.capture’s extra_headers option
  • use ngx_hash_t to optimize the built-in header look-up process for ngx.req.set_header, ngx.header.HEADER, and etc.
  • add directives to run Lua codes when Nginx stops.
  • add ignore_resp_headers, ignore_resp_body, and ignore_resp options to ngx.location.capture and ngx.location.capture_multi methods, to allow micro performance tuning on the user side.
  • add automatic Lua code time slicing support by yielding and resuming the Lua VM actively via Lua’s debug hooks.
  • add stat mode similar to mod_lua.
  • cosocket: add client SSL certificate support.

Back to TOC

Changes

The changes made in every release of this module are listed in the change logs of the OpenResty bundle:

https://openresty.org/#Changes

Back to TOC

Test Suite

The following dependencies are required to run the test suite:

The order in which these modules are added during configuration is important because the position of any filter module in the
filtering chain determines the final output, for example. The correct adding order is shown above.

  • 3rd-party Lua libraries:

  • Applications:

    • mysql: create database ‘ngx_test’, grant all privileges to user ‘ngx_test’, password is ‘ngx_test’
    • memcached: listening on the default port, 11211.
    • redis: listening on the default port, 6379.

See also the developer build script for more details on setting up the testing environment.

To run the whole test suite in the default testing mode:

cd /path/to/lua-nginx-module
export PATH=/path/to/your/nginx/sbin:$PATH
prove -I/path/to/test-nginx/lib -r t

To run specific test files:

cd /path/to/lua-nginx-module
export PATH=/path/to/your/nginx/sbin:$PATH
prove -I/path/to/test-nginx/lib t/002-content.t t/003-errors.t

To run a specific test block in a particular test file, add the line --- ONLY to the test block you want to run, and then use the prove utility to run that .t file.

There are also various testing modes based on mockeagain, valgrind, and etc. Refer to the Test::Nginx documentation for more details for various advanced testing modes. See also the test reports for the Nginx test cluster running on Amazon EC2: https://qa.openresty.org.

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright © 2009-2017, by Xiaozhe Wang (chaoslawful) chaoslawful@gmail.com.

Copyright © 2009-2019, by Yichun “agentzh” Zhang (章亦春) agentzh@gmail.com, OpenResty 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

See Also

Blog posts:

Other related modules and libraries:

Back to TOC

Directives

The basic building blocks of scripting Nginx with Lua are directives. Directives are used to specify when the user Lua code is run and
how the result will be used. Below is a diagram showing the order in which directives are executed.

Lua Nginx Modules Directives

Back to TOC

lua_load_resty_core

syntax: lua_load_resty_core on|off

default: lua_load_resty_core on

context: http

This directive is deprecated since the v0.10.16 release of this
module. The resty.core module from
lua-resty-core is now mandatorily
loaded during the Lua VM initialization. Specifying this directive will have no
effect.

This directive was first introduced in the v0.10.15 release and
used to optionally load the resty.core module.

Back to TOC

lua_capture_error_log

syntax: lua_capture_error_log size

default: none

context: http

Enables a buffer of the specified size for capturing all the Nginx error log message data (not just those produced
by this module or the Nginx http subsystem, but everything) without touching files or disks.

You can use units like k and m in the size value, as in


 lua_capture_error_log 100k;

As a rule of thumb, a 4KB buffer can usually hold about 20 typical error log messages. So do the maths!

This buffer never grows. If it is full, new error log messages will replace the oldest ones in the buffer.

The size of the buffer must be bigger than the maximum length of a single error log message (which is 4K in OpenResty and 2K in stock NGINX).

You can read the messages in the buffer on the Lua land via the
get_logs()
function of the
ngx.errlog
module of the lua-resty-core
library. This Lua API function will return the captured error log messages and
also remove these already read from the global capturing buffer, making room
for any new error log data. For this reason, the user should not configure this
buffer to be too big if the user read the buffered error log data fast enough.

Note that the log level specified in the standard error_log directive
does have effect on this capturing facility. It only captures log
messages of a level no lower than the specified log level in the error_log directive.
The user can still choose to set an even higher filtering log level on the fly via the Lua API function
errlog.set_filter_level.
So it is more flexible than the static error_log directive.

It is worth noting that there is no way to capture the debugging logs
without building OpenResty or Nginx with the ./configure
option --with-debug. And enabling debugging logs is
strongly discouraged in production builds due to high overhead.

This directive was first introduced in the v0.10.9 release.

Back to TOC

lua_use_default_type

syntax: lua_use_default_type on | off

default: lua_use_default_type on

context: http, server, location, location if

Specifies whether to use the MIME type specified by the default_type directive for the default value of the Content-Type response header. Deactivate this directive if a default Content-Type response header for Lua request handlers is not desired.

This directive is turned on by default.

This directive was first introduced in the v0.9.1 release.

Back to TOC

lua_malloc_trim

syntax: lua_malloc_trim <request-count>

default: lua_malloc_trim 1000

context: http

Asks the underlying libc runtime library to release its cached free memory back to the operating system every
N requests processed by the Nginx core. By default, N is 1000. You can configure the request count
by using your own numbers. Smaller numbers mean more frequent releases, which may introduce higher CPU time consumption and
smaller memory footprint while larger numbers usually lead to less CPU time overhead and relatively larger memory footprint.
Just tune the number for your own use cases.

Configuring the argument to 0 essentially turns off the periodical memory trimming altogether.


 lua_malloc_trim 0;  # turn off trimming completely

The current implementation uses an Nginx log phase handler to do the request counting. So the appearance of the
log_subrequest on directives in nginx.conf
may make the counting faster when subrequests are involved. By default, only “main requests” count.

Note that this directive does not affect the memory allocated by LuaJIT’s own allocator based on the mmap
system call.

This directive was first introduced in the v0.10.7 release.

Back to TOC

lua_code_cache

syntax: lua_code_cache on | off

default: lua_code_cache on

context: http, server, location, location if

Enables or disables the Lua code cache for Lua code in *_by_lua_file directives (like set_by_lua_file and
content_by_lua_file) and Lua modules.

When turning off, every request served by ngx_lua will run in a separate Lua VM instance, starting from the 0.9.3 release. So the Lua files referenced in set_by_lua_file,
content_by_lua_file, access_by_lua_file,
and etc will not be cached
and all Lua modules used will be loaded from scratch. With this in place, developers can adopt an edit-and-refresh approach.

Please note however, that Lua code written inlined within nginx.conf
such as those specified by set_by_lua, content_by_lua,
access_by_lua, and rewrite_by_lua will not be updated when you edit the inlined Lua code in your nginx.conf file because only the Nginx config file parser can correctly parse the nginx.conf
file and the only way is to reload the config file
by sending a HUP signal or just to restart Nginx.

Even when the code cache is enabled, Lua files which are loaded by dofile or loadfile
in *_by_lua_file cannot be cached (unless you cache the results yourself). Usually you can either use the init_by_lua
or init_by_lua_file directives to load all such files or just make these Lua files true Lua modules
and load them via require.

The ngx_lua module does not support the stat mode available with the
Apache mod_lua module (yet).

Disabling the Lua code cache is strongly
discouraged for production use and should only be used during
development as it has a significant negative impact on overall performance. For example, the performance of a “hello world” Lua example can drop by an order of magnitude after disabling the Lua code cache.

Back to TOC

lua_thread_cache_max_entries

syntax: lua_thread_cache_max_entries <num>

default: lua_thread_cache_max_entries 1024

context: http

Specifies the maximum number of entries allowed in the worker process level lua thread object cache.

This cache recycles the lua thread GC objects among all our “light threads”.

A zero value of <num> disables the cache.

Note that this feature requires OpenResty’s LuaJIT with the new C API lua_resetthread.

This feature was first introduced in verson v0.10.9.

Back to TOC

lua_regex_cache_max_entries

syntax: lua_regex_cache_max_entries <num>

default: lua_regex_cache_max_entries 1024

context: http

Specifies the maximum number of entries allowed in the worker process level compiled regex cache.

The regular expressions used in ngx.re.match, ngx.re.gmatch, ngx.re.sub, and ngx.re.gsub will be cached within this cache if the regex option o (i.e., compile-once flag) is specified.

The default number of entries allowed is 1024 and when this limit is reached, new regular expressions will not be cached (as if the o option was not specified) and there will be one, and only one, warning in the error.log file:

2011/08/27 23:18:26 [warn] 31997#0: *1 lua exceeding regex cache max entries (1024), ...

If you are using the ngx.re.* implementation of lua-resty-core by loading the resty.core.regex module (or just the resty.core module), then an LRU cache is used for the regex cache being used here.

Do not activate the o option for regular expressions (and/or replace string arguments for ngx.re.sub and ngx.re.gsub) that are generated on the fly and give rise to infinite variations to avoid hitting the specified limit.

Back to TOC

lua_regex_match_limit

syntax: lua_regex_match_limit <num>

default: lua_regex_match_limit 0

context: http

Specifies the “match limit” used by the PCRE library when executing the ngx.re API. To quote the PCRE manpage, “the limit … has the effect of limiting the amount of backtracking that can take place.”

When the limit is hit, the error string “pcre_exec() failed: -8” will be returned by the ngx.re API functions on the Lua land.

When setting the limit to 0, the default “match limit” when compiling the PCRE library is used. And this is the default value of this directive.

This directive was first introduced in the v0.8.5 release.

Back to TOC

lua_package_path

syntax: lua_package_path <lua-style-path-str>

default: The content of LUA_PATH environment variable or Lua’s compiled-in defaults.

context: http

Sets the Lua module search path used by scripts specified by set_by_lua,
content_by_lua and others. The path string is in standard Lua path form, and ;;
can be used to stand for the original search paths.

As from the v0.5.0rc29 release, the special notation $prefix or ${prefix} can be used in the search path string to indicate the path of the server prefix usually determined by the -p PATH command-line option while starting the Nginx server.

Back to TOC

lua_package_cpath

syntax: lua_package_cpath <lua-style-cpath-str>

default: The content of LUA_CPATH environment variable or Lua’s compiled-in defaults.

context: http

Sets the Lua C-module search path used by scripts specified by set_by_lua,
content_by_lua and others. The cpath string is in standard Lua cpath form, and ;;
can be used to stand for the original cpath.

As from the v0.5.0rc29 release, the special notation $prefix or ${prefix} can be used in the search path string to indicate the path of the server prefix usually determined by the -p PATH command-line option while starting the Nginx server.

Back to TOC

init_by_lua

syntax: init_by_lua <lua-script-str>

context: http

phase: loading-config

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the init_by_lua_block directive instead.

Runs the Lua code specified by the argument <lua-script-str> on the global Lua VM level when the Nginx master process (if any) is loading the Nginx config file.

When Nginx receives the HUP signal and starts reloading the config file, the Lua VM will also be re-created and init_by_lua will run again on the new Lua VM. In case that the lua_code_cache directive is turned off (default on), the init_by_lua handler will run upon every request because in this special mode a standalone Lua VM is always created for each request.

Usually you can pre-load Lua modules at server start-up by means of this hook and take advantage of modern operating systems’ copy-on-write (COW) optimization. Here is an example for pre-loading Lua modules:


 # this runs before forking out nginx worker processes:
 init_by_lua_block { require "cjson" }

 server {
     location = /api {
         content_by_lua_block {
             -- the following require() will just  return
             -- the already loaded module from package.loaded:
             ngx.say(require "cjson".encode{dog = 5, cat = 6})
         }
     }
 }

You can also initialize the lua_shared_dict shm storage at this phase. Here is an example for this:


 lua_shared_dict dogs 1m;

 init_by_lua_block {
     local dogs = ngx.shared.dogs
     dogs:set("Tom", 56)
 }

 server {
     location = /api {
         content_by_lua_block {
             local dogs = ngx.shared.dogs
             ngx.say(dogs:get("Tom"))
         }
     }
 }

But note that, the lua_shared_dict’s shm storage will not be cleared through a config reload (via the HUP signal, for example). So if you do not want to re-initialize the shm storage in your init_by_lua code in this case, then you just need to set a custom flag in the shm storage and always check the flag in your init_by_lua code.

Because the Lua code in this context runs before Nginx forks its worker processes (if any), data or code loaded here will enjoy the Copy-on-write (COW) feature provided by many operating systems among all the worker processes, thus saving a lot of memory.

Do not initialize your own Lua global variables in this context because use of Lua global variables have performance penalties and can lead to global namespace pollution (see the Lua Variable Scope section for more details). The recommended way is to use proper Lua module files (but do not use the standard Lua function module() to define Lua modules because it pollutes the global namespace as well) and call require() to load your own module files in init_by_lua or other contexts (require() does cache the loaded Lua modules in the global package.loaded table in the Lua registry so your modules will only loaded once for the whole Lua VM instance).

Only a small set of the Nginx API for Lua is supported in this context:

More Nginx APIs for Lua may be supported in this context upon future user requests.

Basically you can safely use Lua libraries that do blocking I/O in this very context because blocking the master process during server start-up is completely okay. Even the Nginx core does blocking I/O (at least on resolving upstream’s host names) at the configure-loading phase.

You should be very careful about potential security vulnerabilities in your Lua code registered in this context because the Nginx master process is often run under the root account.

This directive was first introduced in the v0.5.5 release.

See also the following blog posts for more details on OpenResty and Nginx’s shared memory zones:

Back to TOC

init_by_lua_block

syntax: init_by_lua_block { lua-script }

context: http

phase: loading-config

Similar to the init_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 init_by_lua_block {
     print("I need no extra escaping here, for example: \r\nblah")
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

init_by_lua_file

syntax: init_by_lua_file <path-to-lua-script-file>

context: http

phase: loading-config

Equivalent to init_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code or LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.5.5 release.

Back to TOC

init_worker_by_lua

syntax: init_worker_by_lua <lua-script-str>

context: http

phase: starting-worker

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the init_worker_by_lua_block directive instead.

Runs the specified Lua code upon every Nginx worker process’s startup when the master process is enabled. When the master process is disabled, this hook will just run after init_by_lua*.

This hook is often used to create per-worker reoccurring timers (via the ngx.timer.at Lua API), either for backend health-check or other timed routine work. Below is an example,


 init_worker_by_lua '
     local delay = 3  -- in seconds
     local new_timer = ngx.timer.at
     local log = ngx.log
     local ERR = ngx.ERR
     local check

     check = function(premature)
         if not premature then
             -- do the health check or other routine work
             local ok, err = new_timer(delay, check)
             if not ok then
                 log(ERR, "failed to create timer: ", err)
                 return
             end
         end

         -- do something in timer
     end

     local hdl, err = new_timer(delay, check)
     if not hdl then
         log(ERR, "failed to create timer: ", err)
         return
     end

     -- other job in init_worker_by_lua
 ';

This directive was first introduced in the v0.9.5 release.

This hook no longer runs in the cache manager and cache loader processes since the v0.10.12 release.

Back to TOC

init_worker_by_lua_block

syntax: init_worker_by_lua_block { lua-script }

context: http

phase: starting-worker

Similar to the init_worker_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 init_worker_by_lua_block {
     print("I need no extra escaping here, for example: \r\nblah")
 }

This directive was first introduced in the v0.9.17 release.

This hook no longer runs in the cache manager and cache loader processes since the v0.10.12 release.

Back to TOC

init_worker_by_lua_file

syntax: init_worker_by_lua_file <lua-file-path>

context: http

phase: starting-worker

Similar to init_worker_by_lua, but accepts the file path to a Lua source file or Lua bytecode file.

This directive was first introduced in the v0.9.5 release.

This hook no longer runs in the cache manager and cache loader processes since the v0.10.12 release.

Back to TOC

exit_worker_by_lua_block

syntax: exit_worker_by_lua_block { lua-script }

context: http

phase: exiting-worker

Runs the specified Lua code upon every Nginx worker process’s exit when the master process is enabled. When the master process is disabled, this hook will run before the Nginx process exits.

This hook is often used to release resources allocated by each worker (e.g. resources allocated by init_worker_by_lua*), or to prevent workers from exiting abnormally.

For example,


 exit_worker_by_lua_block {
     print("log from exit_worker_by_lua_block")
 }

It’s not allowed to create a timer (even a 0-delay timer) here since it runs after all timers have been processed.

This directive was first introduced in the v0.10.18 release.

Back to TOC

exit_worker_by_lua_file

syntax: exit_worker_by_lua_file <path-to-lua-script-file>

context: http

phase: exiting-worker

Similar to exit_worker_by_lua_block, but accepts the file path to a Lua source file or Lua bytecode file.

This directive was first introduced in the v0.10.18 release.

Back to TOC

set_by_lua

syntax: set_by_lua KaTeX parse error: Expected 'EOF', got '&' at position 5: res &̲lt;lua-script-s…arg1 $arg2 …]

context: server, server if, location, location if

phase: rewrite

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the set_by_lua_block directive instead.

Executes code specified in <lua-script-str> with optional input arguments $arg1 $arg2 ..., and returns string output to $res.
The code in <lua-script-str> can make API calls and can retrieve input arguments from the ngx.arg table (index starts from 1 and increases sequentially).

This directive is designed to execute short, fast running code blocks as the Nginx event loop is blocked during code execution. Time consuming code sequences should therefore be avoided.

This directive is implemented by injecting custom commands into the standard ngx_http_rewrite_module’s command list. Because ngx_http_rewrite_module does not support nonblocking I/O in its commands, Lua APIs requiring yielding the current Lua “light thread” cannot work in this directive.

At least the following API functions are currently disabled within the context of set_by_lua:

In addition, note that this directive can only write out a value to a single Nginx variable at
a time. However, a workaround is possible using the ngx.var.VARIABLE interface.


 location /foo {
     set $diff ''; # we have to predefine the $diff variable here

     set_by_lua $sum '
         local a = 32
         local b = 56

         ngx.var.diff = a - b  -- write to $diff directly
         return a + b          -- return the $sum value normally
     ';

     echo "sum = $sum, diff = $diff";
 }

This directive can be freely mixed with all directives of the ngx_http_rewrite_module, set-misc-nginx-module, and array-var-nginx-module modules. All of these directives will run in the same order as they appear in the config file.


 set $foo 32;
 set_by_lua $bar 'return tonumber(ngx.var.foo) + 1';
 set $baz "bar: $bar";  # $baz == "bar: 33"

As from the v0.5.0rc29 release, Nginx variable interpolation is disabled in the <lua-script-str> argument of this directive and therefore, the dollar sign character ($) can be used directly.

This directive requires the ngx_devel_kit module.

Back to TOC

set_by_lua_block

syntax: set_by_lua_block $res { lua-script }

context: server, server if, location, location if

phase: rewrite

Similar to the set_by_lua directive except that

  1. this directive inlines the Lua source directly
    inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
    special character escaping), and
  2. this directive does not support extra arguments after the Lua script as in set_by_lua.

For example,


 set_by_lua_block $res { return 32 + math.cos(32) }
 # $res now has the value "32.834223360507" or alike.

No special escaping is required in the Lua code block.

This directive was first introduced in the v0.9.17 release.

Back to TOC

set_by_lua_file

syntax: set_by_lua_file KaTeX parse error: Expected 'EOF', got '&' at position 5: res &̲lt;path-to-lua-…arg1 $arg2 …]

context: server, server if, location, location if

phase: rewrite

Equivalent to set_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

Nginx variable interpolation is supported in the <path-to-lua-script-file> argument string of this directive. But special care must be taken for injection attacks.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

When the Lua code cache is turned on (by default), the user code is loaded once at the first request and cached
and the Nginx config must be reloaded each time the Lua source file is modified.
The Lua code cache can be temporarily disabled during development by
switching lua_code_cache off in nginx.conf to avoid reloading Nginx.

This directive requires the ngx_devel_kit module.

Back to TOC

content_by_lua

syntax: content_by_lua <lua-script-str>

context: location, location if

phase: content

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the content_by_lua_block directive instead.

Acts as a “content handler” and executes Lua code string specified in <lua-script-str> for every request.
The Lua code may make API calls and is executed as a new spawned coroutine in an independent global environment (i.e. a sandbox).

Do not use this directive and other content handler directives in the same location. For example, this directive and the proxy_pass directive should not be used in the same location.

Back to TOC

content_by_lua_block

syntax: content_by_lua_block { lua-script }

context: location, location if

phase: content

Similar to the content_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 content_by_lua_block {
     ngx.say("I need no extra escaping here, for example: \r\nblah")
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

content_by_lua_file

syntax: content_by_lua_file <path-to-lua-script-file>

context: location, location if

phase: content

Equivalent to content_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

Nginx variables can be used in the <path-to-lua-script-file> string to provide flexibility. This however carries some risks and is not ordinarily recommended.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

When the Lua code cache is turned on (by default), the user code is loaded once at the first request and cached
and the Nginx config must be reloaded each time the Lua source file is modified.
The Lua code cache can be temporarily disabled during development by
switching lua_code_cache off in nginx.conf to avoid reloading Nginx.

Nginx variables are supported in the file path for dynamic dispatch, for example:


 # CAUTION: contents in nginx var must be carefully filtered,
 # otherwise there'll be great security risk!
 location ~ ^/app/([-_a-zA-Z0-9/]+) {
     set $path $1;
     content_by_lua_file /path/to/lua/app/root/$path.lua;
 }

But be very careful about malicious user inputs and always carefully validate or filter out the user-supplied path components.

Back to TOC

rewrite_by_lua

syntax: rewrite_by_lua <lua-script-str>

context: http, server, location, location if

phase: rewrite tail

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the rewrite_by_lua_block directive instead.

Acts as a rewrite phase handler and executes Lua code string specified in <lua-script-str> for every request.
The Lua code may make API calls and is executed as a new spawned coroutine in an independent global environment (i.e. a sandbox).

Note that this handler always runs after the standard ngx_http_rewrite_module. So the following will work as expected:


 location /foo {
     set $a 12; # create and initialize $a
     set $b ""; # create and initialize $b
     rewrite_by_lua 'ngx.var.b = tonumber(ngx.var.a) + 1';
     echo "res = $b";
 }

because set $a 12 and set $b "" run before rewrite_by_lua.

On the other hand, the following will not work as expected:


 ?  location /foo {
 ?      set $a 12; # create and initialize $a
 ?      set $b ''; # create and initialize $b
 ?      rewrite_by_lua 'ngx.var.b = tonumber(ngx.var.a) + 1';
 ?      if ($b = '13') {
 ?         rewrite ^ /bar redirect;
 ?         break;
 ?      }
 ?
 ?      echo "res = $b";
 ?  }

because if runs before rewrite_by_lua even if it is placed after rewrite_by_lua in the config.

The right way of doing this is as follows:


 location /foo {
     set $a 12; # create and initialize $a
     set $b ''; # create and initialize $b
     rewrite_by_lua '
         ngx.var.b = tonumber(ngx.var.a) + 1
         if tonumber(ngx.var.b) == 13 then
             return ngx.redirect("/bar")
         end
     ';

     echo "res = $b";
 }

Note that the ngx_eval module can be approximated by using rewrite_by_lua. For example,


 location / {
     eval $res {
         proxy_pass http://foo.com/check-spam;
     }

     if ($res = 'spam') {
         rewrite ^ /terms-of-use.html redirect;
     }

     fastcgi_pass ...;
 }

can be implemented in ngx_lua as:


 location = /check-spam {
     internal;
     proxy_pass http://foo.com/check-spam;
 }

 location / {
     rewrite_by_lua '
         local res = ngx.location.capture("/check-spam")
         if res.body == "spam" then
             return ngx.redirect("/terms-of-use.html")
         end
     ';

     fastcgi_pass ...;
 }

Just as any other rewrite phase handlers, rewrite_by_lua also runs in subrequests.

Note that when calling ngx.exit(ngx.OK) within a rewrite_by_lua handler, the Nginx request processing control flow will still continue to the content handler. To terminate the current request from within a rewrite_by_lua handler, call ngx.exit with status >= 200 (ngx.HTTP_OK) and status < 300 (ngx.HTTP_SPECIAL_RESPONSE) for successful quits and ngx.exit(ngx.HTTP_INTERNAL_SERVER_ERROR) (or its friends) for failures.

If the ngx_http_rewrite_module’s rewrite directive is used to change the URI and initiate location re-lookups (internal redirections), then any rewrite_by_lua or rewrite_by_lua_file code sequences within the current location will not be executed. For example,


 location /foo {
     rewrite ^ /bar;
     rewrite_by_lua 'ngx.exit(503)';
 }
 location /bar {
     ...
 }

Here the Lua code ngx.exit(503) will never run. This will be the case if rewrite ^ /bar last is used as this will similarly initiate an internal redirection. If the break modifier is used instead, there will be no internal redirection and the rewrite_by_lua code will be executed.

The rewrite_by_lua code will always run at the end of the rewrite request-processing phase unless rewrite_by_lua_no_postpone is turned on.

Back to TOC

rewrite_by_lua_block

syntax: rewrite_by_lua_block { lua-script }

context: http, server, location, location if

phase: rewrite tail

Similar to the rewrite_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 rewrite_by_lua_block {
     do_something("hello, world!\nhiya\n")
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

rewrite_by_lua_file

syntax: rewrite_by_lua_file <path-to-lua-script-file>

context: http, server, location, location if

phase: rewrite tail

Equivalent to rewrite_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

Nginx variables can be used in the <path-to-lua-script-file> string to provide flexibility. This however carries some risks and is not ordinarily recommended.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

When the Lua code cache is turned on (by default), the user code is loaded once at the first request and cached and the Nginx config must be reloaded each time the Lua source file is modified. The Lua code cache can be temporarily disabled during development by switching lua_code_cache off in nginx.conf to avoid reloading Nginx.

The rewrite_by_lua_file code will always run at the end of the rewrite request-processing phase unless rewrite_by_lua_no_postpone is turned on.

Nginx variables are supported in the file path for dynamic dispatch just as in content_by_lua_file.

Back to TOC

access_by_lua

syntax: access_by_lua <lua-script-str>

context: http, server, location, location if

phase: access tail

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the access_by_lua_block directive instead.

Acts as an access phase handler and executes Lua code string specified in <lua-script-str> for every request.
The Lua code may make API calls and is executed as a new spawned coroutine in an independent global environment (i.e. a sandbox).

Note that this handler always runs after the standard ngx_http_access_module. So the following will work as expected:


 location / {
     deny    192.168.1.1;
     allow   192.168.1.0/24;
     allow   10.1.1.0/16;
     deny    all;

     access_by_lua '
         local res = ngx.location.capture("/mysql", { ... })
         ...
     ';

     # proxy_pass/fastcgi_pass/...
 }

That is, if a client IP address is in the blacklist, it will be denied before the MySQL query for more complex authentication is executed by access_by_lua.

Note that the ngx_auth_request module can be approximated by using access_by_lua:


 location / {
     auth_request /auth;

     # proxy_pass/fastcgi_pass/postgres_pass/...
 }

can be implemented in ngx_lua as:


 location / {
     access_by_lua '
         local res = ngx.location.capture("/auth")

         if res.status == ngx.HTTP_OK then
             return
         end

         if res.status == ngx.HTTP_FORBIDDEN then
             ngx.exit(res.status)
         end

         ngx.exit(ngx.HTTP_INTERNAL_SERVER_ERROR)
     ';

     # proxy_pass/fastcgi_pass/postgres_pass/...
 }

As with other access phase handlers, access_by_lua will not run in subrequests.

Note that when calling ngx.exit(ngx.OK) within a access_by_lua handler, the Nginx request processing control flow will still continue to the content handler. To terminate the current request from within a access_by_lua handler, call ngx.exit with status >= 200 (ngx.HTTP_OK) and status < 300 (ngx.HTTP_SPECIAL_RESPONSE) for successful quits and ngx.exit(ngx.HTTP_INTERNAL_SERVER_ERROR) (or its friends) for failures.

Starting from the v0.9.20 release, you can use the access_by_lua_no_postpone
directive to control when to run this handler inside the “access” request-processing phase
of Nginx.

Back to TOC

access_by_lua_block

syntax: access_by_lua_block { lua-script }

context: http, server, location, location if

phase: access tail

Similar to the access_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 access_by_lua_block {
     do_something("hello, world!\nhiya\n")
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

access_by_lua_file

syntax: access_by_lua_file <path-to-lua-script-file>

context: http, server, location, location if

phase: access tail

Equivalent to access_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

Nginx variables can be used in the <path-to-lua-script-file> string to provide flexibility. This however carries some risks and is not ordinarily recommended.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

When the Lua code cache is turned on (by default), the user code is loaded once at the first request and cached
and the Nginx config must be reloaded each time the Lua source file is modified.
The Lua code cache can be temporarily disabled during development by switching lua_code_cache off in nginx.conf to avoid repeatedly reloading Nginx.

Nginx variables are supported in the file path for dynamic dispatch just as in content_by_lua_file.

Back to TOC

header_filter_by_lua

syntax: header_filter_by_lua <lua-script-str>

context: http, server, location, location if

phase: output-header-filter

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the header_filter_by_lua_block directive instead.

Uses Lua code specified in <lua-script-str> to define an output header filter.

Note that the following API functions are currently disabled within this context:

Here is an example of overriding a response header (or adding one if absent) in our Lua header filter:


 location / {
     proxy_pass http://mybackend;
     header_filter_by_lua 'ngx.header.Foo = "blah"';
 }

This directive was first introduced in the v0.2.1rc20 release.

Back to TOC

header_filter_by_lua_block

syntax: header_filter_by_lua_block { lua-script }

context: http, server, location, location if

phase: output-header-filter

Similar to the header_filter_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 header_filter_by_lua_block {
     ngx.header["content-length"] = nil
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

header_filter_by_lua_file

syntax: header_filter_by_lua_file <path-to-lua-script-file>

context: http, server, location, location if

phase: output-header-filter

Equivalent to header_filter_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.2.1rc20 release.

Back to TOC

body_filter_by_lua

syntax: body_filter_by_lua <lua-script-str>

context: http, server, location, location if

phase: output-body-filter

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the body_filter_by_lua_block directive instead.

Uses Lua code specified in <lua-script-str> to define an output body filter.

The input data chunk is passed via ngx.arg[1] (as a Lua string value) and the “eof” flag indicating the end of the response body data stream is passed via ngx.arg[2] (as a Lua boolean value).

Behind the scene, the “eof” flag is just the last_buf (for main requests) or last_in_chain (for subrequests) flag of the Nginx chain link buffers. (Before the v0.7.14 release, the “eof” flag does not work at all in subrequests.)

The output data stream can be aborted immediately by running the following Lua statement:


 return ngx.ERROR

This will truncate the response body and usually result in incomplete and also invalid responses.

The Lua code can pass its own modified version of the input data chunk to the downstream Nginx output body filters by overriding ngx.arg[1] with a Lua string or a Lua table of strings. For example, to transform all the lowercase letters in the response body, we can just write:


 location / {
     proxy_pass http://mybackend;
     body_filter_by_lua 'ngx.arg[1] = string.upper(ngx.arg[1])';
 }

When setting nil or an empty Lua string value to ngx.arg[1], no data chunk will be passed to the downstream Nginx output filters at all.

Likewise, new “eof” flag can also be specified by setting a boolean value to ngx.arg[2]. For example,


 location /t {
     echo hello world;
     echo hiya globe;

     body_filter_by_lua '
         local chunk = ngx.arg[1]
         if string.match(chunk, "hello") then
             ngx.arg[2] = true  -- new eof
             return
         end

         -- just throw away any remaining chunk data
         ngx.arg[1] = nil
     ';
 }

Then GET /t will just return the output

hello world

That is, when the body filter sees a chunk containing the word “hello”, then it will set the “eof” flag to true immediately, resulting in truncated but still valid responses.

When the Lua code may change the length of the response body, then it is required to always clear out the Content-Length response header (if any) in a header filter to enforce streaming output, as in


 location /foo {
     # fastcgi_pass/proxy_pass/...

     header_filter_by_lua_block { ngx.header.content_length = nil }
     body_filter_by_lua 'ngx.arg[1] = string.len(ngx.arg[1]) .. "\\n"';
 }

Note that the following API functions are currently disabled within this context due to the limitations in Nginx output filter’s current implementation:

Nginx output filters may be called multiple times for a single request because response body may be delivered in chunks. Thus, the Lua code specified by in this directive may also run multiple times in the lifetime of a single HTTP request.

This directive was first introduced in the v0.5.0rc32 release.

Back to TOC

body_filter_by_lua_block

syntax: body_filter_by_lua_block { lua-script-str }

context: http, server, location, location if

phase: output-body-filter

Similar to the body_filter_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 body_filter_by_lua_block {
     local data, eof = ngx.arg[1], ngx.arg[2]
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

body_filter_by_lua_file

syntax: body_filter_by_lua_file <path-to-lua-script-file>

context: http, server, location, location if

phase: output-body-filter

Equivalent to body_filter_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.5.0rc32 release.

Back to TOC

log_by_lua

syntax: log_by_lua <lua-script-str>

context: http, server, location, location if

phase: log

NOTE Use of this directive is discouraged following the v0.9.17 release. Use the log_by_lua_block directive instead.

Runs the Lua source code inlined as the <lua-script-str> at the log request processing phase. This does not replace the current access logs, but runs before.

Note that the following API functions are currently disabled within this context:

Here is an example of gathering average data for $upstream_response_time:


 lua_shared_dict log_dict 5M;

 server {
     location / {
         proxy_pass http://mybackend;

         log_by_lua '
             local log_dict = ngx.shared.log_dict
             local upstream_time = tonumber(ngx.var.upstream_response_time)

             local sum = log_dict:get("upstream_time-sum") or 0
             sum = sum + upstream_time
             log_dict:set("upstream_time-sum", sum)

             local newval, err = log_dict:incr("upstream_time-nb", 1)
             if not newval and err == "not found" then
                 log_dict:add("upstream_time-nb", 0)
                 log_dict:incr("upstream_time-nb", 1)
             end
         ';
     }

     location = /status {
         content_by_lua_block {
             local log_dict = ngx.shared.log_dict
             local sum = log_dict:get("upstream_time-sum")
             local nb = log_dict:get("upstream_time-nb")

             if nb and sum then
                 ngx.say("average upstream response time: ", sum / nb,
                         " (", nb, " reqs)")
             else
                 ngx.say("no data yet")
             end
         }
     }
 }

This directive was first introduced in the v0.5.0rc31 release.

Back to TOC

log_by_lua_block

syntax: log_by_lua_block { lua-script }

context: http, server, location, location if

phase: log

Similar to the log_by_lua directive except that this directive inlines
the Lua source directly
inside a pair of curly braces ({}) instead of in an Nginx string literal (which requires
special character escaping).

For instance,


 log_by_lua_block {
     print("I need no extra escaping here, for example: \r\nblah")
 }

This directive was first introduced in the v0.9.17 release.

Back to TOC

log_by_lua_file

syntax: log_by_lua_file <path-to-lua-script-file>

context: http, server, location, location if

phase: log

Equivalent to log_by_lua, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.5.0rc31 release.

Back to TOC

balancer_by_lua_block

syntax: balancer_by_lua_block { lua-script }

context: upstream

phase: content

This directive runs Lua code as an upstream balancer for any upstream entities defined
by the upstream {} configuration block.

For instance,


 upstream foo {
     server 127.0.0.1;
     balancer_by_lua_block {
         -- use Lua to do something interesting here
         -- as a dynamic balancer
     }
 }

 server {
     location / {
         proxy_pass http://foo;
     }
 }

The resulting Lua load balancer can work with any existing Nginx upstream modules
like ngx_proxy and
ngx_fastcgi.

Also, the Lua load balancer can work with the standard upstream connection pool mechanism,
i.e., the standard keepalive directive.
Just ensure that the keepalive directive
is used after this balancer_by_lua_block directive in a single upstream {} configuration block.

The Lua load balancer can totally ignore the list of servers defined in the upstream {} block
and select peer from a completely dynamic server list (even changing per request) via the
ngx.balancer module
from the lua-resty-core library.

The Lua code handler registered by this directive might get called more than once in a single
downstream request when the Nginx upstream mechanism retries the request on conditions
specified by directives like the proxy_next_upstream
directive.

This Lua code execution context does not support yielding, so Lua APIs that may yield
(like cosockets and “light threads”) are disabled in this context. One can usually work
around this limitation by doing such operations in an earlier phase handler (like
access_by_lua*) and passing along the result into this context
via the ngx.ctx table.

This directive was first introduced in the v0.10.0 release.

Back to TOC

balancer_by_lua_file

syntax: balancer_by_lua_file <path-to-lua-script-file>

context: upstream

phase: content

Equivalent to balancer_by_lua_block, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.10.0 release.

Back to TOC

lua_need_request_body

syntax: lua_need_request_body <on|off>

default: off

context: http, server, location, location if

phase: depends on usage

Determines whether to force the request body data to be read before running rewrite/access/content_by_lua* or not. The Nginx core does not read the client request body by default and if request body data is required, then this directive should be turned on or the ngx.req.read_body function should be called within the Lua code.

To read the request body data within the KaTeX parse error: Expected 'EOF', got '#' at position 70: …ore_module.html#̲var_request_bod…request_body variable.

If the current location includes rewrite_by_lua* directives,
then the request body will be read just before the rewrite_by_lua* code is run (and also at the
rewrite phase). Similarly, if only content_by_lua is specified,
the request body will not be read until the content handler’s Lua code is
about to run (i.e., the request body will be read during the content phase).

It is recommended however, to use the ngx.req.read_body and ngx.req.discard_body functions for finer control over the request body reading process instead.

This also applies to access_by_lua*.

Back to TOC

ssl_client_hello_by_lua_block

syntax: ssl_client_hello_by_lua_block { lua-script }

context: http, server

phase: right-after-client-hello-message-was-processed

This directive runs user Lua code when Nginx is about to post-process the SSL client hello message for the downstream
SSL (https) connections.

It is particularly useful for dynamically setting the SSL protocols according to the SNI.

It is also useful to do some custom operations according to the per-connection information in the client hello message.

For example, one can parse custom client hello extension and do the corresponding handling in pure Lua.

This Lua handler will always run whether the SSL session is resumed (via SSL session IDs or TLS session tickets) or not.
While the ssl_certificate_by_lua* Lua handler will only runs when initiating a full SSL handshake.

The ngx.ssl.clienthello Lua modules
provided by the lua-resty-core
library are particularly useful in this context.

Note that this handler runs in extremely early stage of SSL handshake, before the SSL client hello extensions are parsed.
So you can not use some Lua API like ssl.server_name() which is dependent on the later stage’s processing.

Also note that only the directive in default server is valid for several virtual servers with the same IP address and port.

Below is a trivial example using the
ngx.ssl.clienthello module
at the same time:


 server {
     listen 443 ssl;
     server_name   test.com;
     ssl_certificate /path/to/cert.crt;
     ssl_certificate_key /path/to/key.key;
     ssl_client_hello_by_lua_block {
         local ssl_clt = require "ngx.ssl.clienthello"
         local host, err = ssl_clt.get_client_hello_server_name()
         if host == "test.com" then
             ssl_clt.set_protocols({"TLSv1", "TLSv1.1"})
         elseif host == "test2.com" then
             ssl_clt.set_protocols({"TLSv1.2", "TLSv1.3"})
         elseif not host then
             ngx.log(ngx.ERR, "failed to get the SNI name: ", err)
             ngx.exit(ngx.ERROR)
         else
             ngx.log(ngx.ERR, "unknown SNI name: ", host)
             ngx.exit(ngx.ERROR)
         end
     }
     ...
 }
 server {
     listen 443 ssl;
     server_name   test2.com;
     ssl_certificate /path/to/cert.crt;
     ssl_certificate_key /path/to/key.key;
     ...
 }

See more information in the ngx.ssl.clienthello
Lua modules’ official documentation.

Uncaught Lua exceptions in the user Lua code immediately abort the current SSL session, so does the
ngx.exit call with an error code like ngx.ERROR.

This Lua code execution context does support yielding, so Lua APIs that may yield
(like cosockets, sleeping, and “light threads”)
are enabled in this context

Note, you need to configure the ssl_certificate
and ssl_certificate_key
to avoid the following error while starting NGINX:

nginx: [emerg] no ssl configured for the server

This directive requires OpenSSL 1.1.1 or greater.

If you are using the official pre-built
packages for
OpenResty 1.19.9.2 or later, then everything should
work out of the box.

If you are not using one of the OpenSSL
packages provided by
OpenResty, you will need to apply patches to OpenSSL
in order to use this directive:

https://openresty.org/en/openssl-patches.html

Similarly, if you are not using the Nginx core shipped with
OpenResty 1.19.9.2 or later, you will need to apply
patches to the standard Nginx core:

https://openresty.org/en/nginx-ssl-patches.html

This directive was first introduced in the v0.10.21 release.

Back to TOC

ssl_client_hello_by_lua_file

syntax: ssl_client_hello_by_lua_file <path-to-lua-script-file>

context: http, server

phase: right-after-client-hello-message-was-processed

Equivalent to ssl_client_hello_by_lua_block, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.10.21 release.

Back to TOC

ssl_certificate_by_lua_block

syntax: ssl_certificate_by_lua_block { lua-script }

context: server

phase: right-before-SSL-handshake

This directive runs user Lua code when Nginx is about to start the SSL handshake for the downstream
SSL (https) connections.

It is particularly useful for setting the SSL certificate chain and the corresponding private key on a per-request
basis. It is also useful to load such handshake configurations nonblockingly from the remote (for example,
with the cosocket API). And one can also do per-request OCSP stapling handling in pure
Lua here as well.

Another typical use case is to do SSL handshake traffic control nonblockingly in this context,
with the help of the lua-resty-limit-traffic#readme
library, for example.

One can also do interesting things with the SSL handshake requests from the client side, like
rejecting old SSL clients using the SSLv3 protocol or even below selectively.

The ngx.ssl
and ngx.ocsp Lua modules
provided by the lua-resty-core
library are particularly useful in this context. You can use the Lua API offered by these two Lua modules
to manipulate the SSL certificate chain and private key for the current SSL connection
being initiated.

This Lua handler does not run at all, however, when Nginx/OpenSSL successfully resumes
the SSL session via SSL session IDs or TLS session tickets for the current SSL connection. In
other words, this Lua handler only runs when Nginx has to initiate a full SSL handshake.

Below is a trivial example using the
ngx.ssl module
at the same time:


 server {
     listen 443 ssl;
     server_name   test.com;

     ssl_certificate_by_lua_block {
         print("About to initiate a new SSL handshake!")
     }

     location / {
         root html;
     }
 }

See more complicated examples in the ngx.ssl
and ngx.ocsp
Lua modules’ official documentation.

Uncaught Lua exceptions in the user Lua code immediately abort the current SSL session, so does the
ngx.exit call with an error code like ngx.ERROR.

This Lua code execution context does support yielding, so Lua APIs that may yield
(like cosockets, sleeping, and “light threads”)
are enabled in this context.

Note, however, you still need to configure the ssl_certificate and
ssl_certificate_key
directives even though you will not use this static certificate and private key at all. This is
because the NGINX core requires their appearance otherwise you are seeing the following error
while starting NGINX:

nginx: [emerg] no ssl configured for the server

This directive requires OpenSSL 1.0.2e or greater.

If you are using the official pre-built
packages for
OpenResty 1.9.7.2 or later, then everything should
work out of the box.

If you are not using one of the OpenSSL
packages provided by
OpenResty, you will need to apply patches to OpenSSL
in order to use this directive:

https://openresty.org/en/openssl-patches.html

Similarly, if you are not using the Nginx core shipped with
OpenResty 1.9.7.2 or later, you will need to apply
patches to the standard Nginx core:

https://openresty.org/en/nginx-ssl-patches.html

This directive was first introduced in the v0.10.0 release.

Back to TOC

ssl_certificate_by_lua_file

syntax: ssl_certificate_by_lua_file <path-to-lua-script-file>

context: server

phase: right-before-SSL-handshake

Equivalent to ssl_certificate_by_lua_block, except that the file specified by <path-to-lua-script-file> contains the Lua code, or, as from the v0.5.0rc32 release, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.10.0 release.

Back to TOC

ssl_session_fetch_by_lua_block

syntax: ssl_session_fetch_by_lua_block { lua-script }

context: http

phase: right-before-SSL-handshake

This directive runs Lua code to look up and load the SSL session (if any) according to the session ID
provided by the current SSL handshake request for the downstream.

The Lua API for obtaining the current session ID and loading a cached SSL session data
is provided in the ngx.ssl.session
Lua module shipped with the lua-resty-core
library.

Lua APIs that may yield, like ngx.sleep and cosockets,
are enabled in this context.

This hook, together with the ssl_session_store_by_lua* hook,
can be used to implement distributed caching mechanisms in pure Lua (based
on the cosocket API, for example). If a cached SSL session is found
and loaded into the current SSL connection context,
SSL session resumption can then get immediately initiated and bypass the full SSL handshake process which is very expensive in terms of CPU time.

Please note that TLS session tickets are very different and it is the clients’ responsibility
to cache the SSL session state when session tickets are used. SSL session resumptions based on
TLS session tickets would happen automatically without going through this hook (nor the
ssl_session_store_by_lua* hook). This hook is mainly
for older or less capable SSL clients that can only do SSL sessions by session IDs.

When ssl_certificate_by_lua* is specified at the same time,
this hook usually runs before ssl_certificate_by_lua*.
When the SSL session is found and successfully loaded for the current SSL connection,
SSL session resumption will happen and thus bypass the ssl_certificate_by_lua*
hook completely. In this case, Nginx also bypasses the ssl_session_store_by_lua*
hook, for obvious reasons.

To easily test this hook locally with a modern web browser, you can temporarily put the following line
in your https server block to disable the TLS session ticket support:

ssl_session_tickets off;

But do not forget to comment this line out before publishing your site to the world.

If you are using the official pre-built packages for OpenResty
1.11.2.1 or later, then everything should work out of the box.

If you are not using one of the OpenSSL
packages provided by
OpenResty, you will need to apply patches to OpenSSL
in order to use this directive:

https://openresty.org/en/openssl-patches.html

Similarly, if you are not using the Nginx core shipped with
OpenResty 1.11.2.1 or later, you will need to apply
patches to the standard Nginx core:

https://openresty.org/en/nginx-ssl-patches.html

This directive was first introduced in the v0.10.6 release.

Note that this directive can only be used in the http context starting
with the v0.10.7 release since SSL session resumption happens
before server name dispatch.

Back to TOC

ssl_session_fetch_by_lua_file

syntax: ssl_session_fetch_by_lua_file <path-to-lua-script-file>

context: http

phase: right-before-SSL-handshake

Equivalent to ssl_session_fetch_by_lua_block, except that the file specified by <path-to-lua-script-file> contains the Lua code, or rather, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.10.6 release.

Note that: this directive is only allowed to used in http context from the v0.10.7 release
(because SSL session resumption happens before server name dispatch).

Back to TOC

ssl_session_store_by_lua_block

syntax: ssl_session_store_by_lua_block { lua-script }

context: http

phase: right-after-SSL-handshake

This directive runs Lua code to fetch and save the SSL session (if any) according to the session ID
provided by the current SSL handshake request for the downstream. The saved or cached SSL
session data can be used for future SSL connections to resume SSL sessions without going
through the full SSL handshake process (which is very expensive in terms of CPU time).

Lua APIs that may yield, like ngx.sleep and cosockets,
are disabled in this context. You can still, however, use the ngx.timer.at API
to create 0-delay timers to save the SSL session data asynchronously to external services (like redis or memcached).

The Lua API for obtaining the current session ID and the associated session state data
is provided in the ngx.ssl.session
Lua module shipped with the lua-resty-core
library.

To easily test this hook locally with a modern web browser, you can temporarily put the following line
in your https server block to disable the TLS session ticket support:

ssl_session_tickets off;

But do not forget to comment this line out before publishing your site to the world.

This directive was first introduced in the v0.10.6 release.

Note that: this directive is only allowed to used in http context from the v0.10.7 release
(because SSL session resumption happens before server name dispatch).

Back to TOC

ssl_session_store_by_lua_file

syntax: ssl_session_store_by_lua_file <path-to-lua-script-file>

context: http

phase: right-after-SSL-handshake

Equivalent to ssl_session_store_by_lua_block, except that the file specified by <path-to-lua-script-file> contains the Lua code, or rather, the LuaJIT bytecode to be executed.

When a relative path like foo/bar.lua is given, they will be turned into the absolute path relative to the server prefix path determined by the -p PATH command-line option while starting the Nginx server.

This directive was first introduced in the v0.10.6 release.

Note that: this directive is only allowed to used in http context from the v0.10.7 release
(because SSL session resumption happens before server name dispatch).

Back to TOC

lua_shared_dict

syntax: lua_shared_dict <name> <size>

default: no

context: http

phase: depends on usage

Declares a shared memory zone, <name>, to serve as storage for the shm based Lua dictionary ngx.shared.<name>.

Shared memory zones are always shared by all the Nginx worker processes in the current Nginx server instance.

The <size> argument accepts size units such as k and m:


 http {
     lua_shared_dict dogs 10m;
     ...
 }

The hard-coded minimum size is 8KB while the practical minimum size depends
on actual user data set (some people start with 12KB).

See ngx.shared.DICT for details.

This directive was first introduced in the v0.3.1rc22 release.

Back to TOC

lua_socket_connect_timeout

syntax: lua_socket_connect_timeout <time>

default: lua_socket_connect_timeout 60s

context: http, server, location

This directive controls the default timeout value used in TCP/unix-domain socket object’s connect method and can be overridden by the settimeout or settimeouts methods.

The <time> argument can be an integer, with an optional time unit, like s (second), ms (millisecond), m (minute). The default time unit is s, i.e., “second”. The default setting is 60s.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_send_timeout

syntax: lua_socket_send_timeout <time>

default: lua_socket_send_timeout 60s

context: http, server, location

Controls the default timeout value used in TCP/unix-domain socket object’s send method and can be overridden by the settimeout or settimeouts methods.

The <time> argument can be an integer, with an optional time unit, like s (second), ms (millisecond), m (minute). The default time unit is s, i.e., “second”. The default setting is 60s.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_send_lowat

syntax: lua_socket_send_lowat <size>

default: lua_socket_send_lowat 0

context: http, server, location

Controls the lowat (low water) value for the cosocket send buffer.

Back to TOC

lua_socket_read_timeout

syntax: lua_socket_read_timeout <time>

default: lua_socket_read_timeout 60s

context: http, server, location

phase: depends on usage

This directive controls the default timeout value used in TCP/unix-domain socket object’s receive method and iterator functions returned by the receiveuntil method. This setting can be overridden by the settimeout or settimeouts methods.

The <time> argument can be an integer, with an optional time unit, like s (second), ms (millisecond), m (minute). The default time unit is s, i.e., “second”. The default setting is 60s.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_buffer_size

syntax: lua_socket_buffer_size <size>

default: lua_socket_buffer_size 4k/8k

context: http, server, location

Specifies the buffer size used by cosocket reading operations.

This buffer does not have to be that big to hold everything at the same time because cosocket supports 100% non-buffered reading and parsing. So even 1 byte buffer size should still work everywhere but the performance could be terrible.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_pool_size

syntax: lua_socket_pool_size <size>

default: lua_socket_pool_size 30

context: http, server, location

Specifies the size limit (in terms of connection count) for every cosocket connection pool associated with every remote server (i.e., identified by either the host-port pair or the unix domain socket file path).

Default to 30 connections for every pool.

When the connection pool exceeds the available size limit, the least recently used (idle) connection already in the pool will be closed to make room for the current connection.

Note that the cosocket connection pool is per Nginx worker process rather than per Nginx server instance, so size limit specified here also applies to every single Nginx worker process.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_keepalive_timeout

syntax: lua_socket_keepalive_timeout <time>

default: lua_socket_keepalive_timeout 60s

context: http, server, location

This directive controls the default maximal idle time of the connections in the cosocket built-in connection pool. When this timeout reaches, idle connections will be closed and removed from the pool. This setting can be overridden by cosocket objects’ setkeepalive method.

The <time> argument can be an integer, with an optional time unit, like s (second), ms (millisecond), m (minute). The default time unit is s, i.e., “second”. The default setting is 60s.

This directive was first introduced in the v0.5.0rc1 release.

Back to TOC

lua_socket_log_errors

syntax: lua_socket_log_errors on|off

default: lua_socket_log_errors on

context: http, server, location

This directive can be used to toggle error logging when a failure occurs for the TCP or UDP cosockets. If you are already doing proper error handling and logging in your Lua code, then it is recommended to turn this directive off to prevent data flushing in your Nginx error log files (which is usually rather expensive).

This directive was first introduced in the v0.5.13 release.

Back to TOC

lua_ssl_ciphers

syntax: lua_ssl_ciphers <ciphers>

default: lua_ssl_ciphers DEFAULT

context: http, server, location

Specifies the enabled ciphers for requests to a SSL/TLS server in the tcpsock:sslhandshake method. The ciphers are specified in the format understood by the OpenSSL library.

The full list can be viewed using the “openssl ciphers” command.

This directive was first introduced in the v0.9.11 release.

Back to TOC

lua_ssl_crl

syntax: lua_ssl_crl <file>

default: no

context: http, server, location

Specifies a file with revoked certificates (CRL) in the PEM format used to verify the certificate of the SSL/TLS server in the tcpsock:sslhandshake method.

This directive was first introduced in the v0.9.11 release.

Back to TOC

lua_ssl_protocols

syntax: lua_ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3]

default: lua_ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2

context: http, server, location

Enables the specified protocols for requests to a SSL/TLS server in the tcpsock:sslhandshake method.

The support for the TLSv1.3 parameter requires version v0.10.12 and OpenSSL 1.1.1.

This directive was first introduced in the v0.9.11 release.

Back to TOC

lua_ssl_trusted_certificate

syntax: lua_ssl_trusted_certificate <file>

default: no

context: http, server, location

Specifies a file path with trusted CA certificates in the PEM format used to verify the certificate of the SSL/TLS server in the tcpsock:sslhandshake method.

This directive was first introduced in the v0.9.11 release.

See also lua_ssl_verify_depth.

Back to TOC

lua_ssl_verify_depth

syntax: lua_ssl_verify_depth <number>

default: lua_ssl_verify_depth 1

context: http, server, location

Sets the verification depth in the server certificates chain.

This directive was first introduced in the v0.9.11 release.

See also lua_ssl_trusted_certificate.

Back to TOC

lua_ssl_conf_command

syntax: lua_ssl_conf_command <command>

default: no

context: http, server, location

Sets arbitrary OpenSSL configuration commands.

The directive is supported when using OpenSSL 1.0.2 or higher and nginx 1.19.4 or higher. According to the specify command, higher OpenSSL version may be needed.

Several lua_ssl_conf_command directives can be specified on the same level:


 lua_ssl_conf_command Options PrioritizeChaCha;
 lua_ssl_conf_command Ciphersuites TLS_CHACHA20_POLY1305_SHA256;

Configuration commands are applied after OpenResty own configuration for SSL, so they can be used to override anything set by OpenResty.

Note though that configuring OpenSSL directly with lua_ssl_conf_command might result in a behaviour OpenResty does not expect, and should be done with care.

This directive was first introduced in the v0.10.21 release.

Back to TOC

lua_http10_buffering

syntax: lua_http10_buffering on|off

default: lua_http10_buffering on

context: http, server, location, location-if

Enables or disables automatic response buffering for HTTP 1.0 (or older) requests. This buffering mechanism is mainly used for HTTP 1.0 keep-alive which relies on a proper Content-Length response header.

If the Lua code explicitly sets a Content-Length response header before sending the headers (either explicitly via ngx.send_headers or implicitly via the first ngx.say or ngx.print call), then the HTTP 1.0 response buffering will be disabled even when this directive is turned on.

To output very large response data in a streaming fashion (via the ngx.flush call, for example), this directive MUST be turned off to minimize memory usage.

This directive is turned on by default.

This directive was first introduced in the v0.5.0rc19 release.

Back to TOC

rewrite_by_lua_no_postpone

syntax: rewrite_by_lua_no_postpone on|off

default: rewrite_by_lua_no_postpone off

context: http

Controls whether or not to disable postponing rewrite_by_lua* directives to run at the end of the rewrite request-processing phase. By default, this directive is turned off and the Lua code is postponed to run at the end of the rewrite phase.

This directive was first introduced in the v0.5.0rc29 release.

Back to TOC

access_by_lua_no_postpone

syntax: access_by_lua_no_postpone on|off

default: access_by_lua_no_postpone off

context: http

Controls whether or not to disable postponing access_by_lua* directives to run at the end of the access request-processing phase. By default, this directive is turned off and the Lua code is postponed to run at the end of the access phase.

This directive was first introduced in the v0.9.20 release.

Back to TOC

lua_transform_underscores_in_response_headers

syntax: lua_transform_underscores_in_response_headers on|off

default: lua_transform_underscores_in_response_headers on

context: http, server, location, location-if

Controls whether to transform underscores (_) in the response header names specified in the ngx.header.HEADER API to hyphens (-).

This directive was first introduced in the v0.5.0rc32 release.

Back to TOC

lua_check_client_abort

syntax: lua_check_client_abort on|off

default: lua_check_client_abort off

context: http, server, location, location-if

This directive controls whether to check for premature client connection abortion.

When this directive is on, the ngx_lua module will monitor the premature connection close event on the downstream connections and when there is such an event, it will call the user Lua function callback (registered by ngx.on_abort) or just stop and clean up all the Lua “light threads” running in the current request’s request handler when there is no user callback function registered.

According to the current implementation, however, if the client closes the connection before the Lua code finishes reading the request body data via ngx.req.socket, then ngx_lua will neither stop all the running “light threads” nor call the user callback (if ngx.on_abort has been called). Instead, the reading operation on ngx.req.socket will just return the error message “client aborted” as the second return value (the first return value is surely nil).

When TCP keepalive is disabled, it is relying on the client side to close the socket gracefully (by sending a FIN packet or something like that). For (soft) real-time web applications, it is highly recommended to configure the TCP keepalive support in your system’s TCP stack implementation in order to detect “half-open” TCP connections in time.

For example, on Linux, you can configure the standard listen directive in your nginx.conf file like this:


 listen 80 so_keepalive=2s:2s:8;

On FreeBSD, you can only tune the system-wide configuration for TCP keepalive, for example:

# sysctl net.inet.tcp.keepintvl=2000
# sysctl net.inet.tcp.keepidle=2000

This directive was first introduced in the v0.7.4 release.

See also ngx.on_abort.

Back to TOC

lua_max_pending_timers

syntax: lua_max_pending_timers <count>

default: lua_max_pending_timers 1024

context: http

Controls the maximum number of pending timers allowed.

Pending timers are those timers that have not expired yet.

When exceeding this limit, the ngx.timer.at call will immediately return nil and the error string “too many pending timers”.

This directive was first introduced in the v0.8.0 release.

Back to TOC

lua_max_running_timers

syntax: lua_max_running_timers <count>

default: lua_max_running_timers 256

context: http

Controls the maximum number of “running timers” allowed.

Running timers are those timers whose user callback functions are still running.

When exceeding this limit, Nginx will stop running the callbacks of newly expired timers and log an error message “N lua_max_running_timers are not enough” where “N” is the current value of this directive.

This directive was first introduced in the v0.8.0 release.

Back to TOC

lua_sa_restart

syntax: lua_sa_restart on|off

default: lua_sa_restart on

context: http

When enabled, this module will set the SA_RESTART flag on Nginx workers signal dispositions.

This allows Lua I/O primitives to not be interrupted by Nginx’s handling of various signals.

This directive was first introduced in the v0.10.14 release.

Back to TOC

lua_worker_thread_vm_pool_size

syntax: lua_worker_thread_vm_pool_size <size>

default: lua_worker_thread_vm_pool_size 100

context: http

Specifies the size limit of the Lua VM pool (default 100) that will be used in the ngx.run_worker_thread API.

Also, it is not allowed to create Lua VMs that exceeds the pool size limit.

The Lua VM in the VM pool is used to execute Lua code in separate thread.

The pool is global at Nginx worker level. And it is used to reuse Lua VMs between requests.

Back to TOC

Nginx API for Lua

Back to TOC

Introduction

The various *_by_lua, *_by_lua_block and *_by_lua_file configuration directives serve as gateways to the Lua API within the nginx.conf file. The Nginx Lua API described below can only be called within the user Lua code run in the context of these configuration directives.

The API is exposed to Lua in the form of two standard packages ngx and ndk. These packages are in the default global scope within ngx_lua and are always available within ngx_lua directives.

The packages can be introduced into external Lua modules like this:


 local say = ngx.say

 local _M = {}

 function _M.foo(a)
     say(a)
 end

 return _M

Use of the package.seeall flag is strongly discouraged due to its various bad side-effects.

It is also possible to directly require the packages in external Lua modules:


 local ngx = require "ngx"
 local ndk = require "ndk"

The ability to require these packages was introduced in the v0.2.1rc19 release.

Network I/O operations in user code should only be done through the Nginx Lua API calls as the Nginx event loop may be blocked and performance drop off dramatically otherwise. Disk operations with relatively small amount of data can be done using the standard Lua io library but huge file reading and writing should be avoided wherever possible as they may block the Nginx process significantly. Delegating all network and disk I/O operations to Nginx’s subrequests (via the ngx.location.capture method and similar) is strongly recommended for maximum performance.

Back to TOC

ngx.arg

syntax: val = ngx.arg[index]

context: set_by_lua*, body_filter_by_lua*

When this is used in the context of the set_by_lua* directives, this table is read-only and holds the input arguments to the config directives:


 value = ngx.arg[n]

Here is an example


 location /foo {
     set $a 32;
     set $b 56;

     set_by_lua $sum
         'return tonumber(ngx.arg[1]) + tonumber(ngx.arg[2])'
         $a $b;

     echo $sum;
 }

that writes out 88, the sum of 32 and 56.

When this table is used in the context of body_filter_by_lua*, the first element holds the input data chunk to the output filter code and the second element holds the boolean flag for the “eof” flag indicating the end of the whole output data stream.

The data chunk and “eof” flag passed to the downstream Nginx output filters can also be overridden by assigning values directly to the corresponding table elements. When setting nil or an empty Lua string value to ngx.arg[1], no data chunk will be passed to the downstream Nginx output filters at all.

Back to TOC

ngx.var.VARIABLE

syntax: ngx.var.VAR_NAME

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, balancer_by_lua*

Read and write Nginx variable values.


 value = ngx.var.some_nginx_variable_name
 ngx.var.some_nginx_variable_name = value

Note that only already defined Nginx variables can be written to.
For example:


 location /foo {
     set $my_var ''; # this line is required to create $my_var at config time
     content_by_lua_block {
         ngx.var.my_var = 123
         ...
     }
 }

That is, Nginx variables cannot be created on-the-fly.

Some special Nginx variables like $args and $limit_rate can be assigned a value,
many others are not, like $query_string, $arg_PARAMETER, and $http_NAME.

Nginx regex group capturing variables $1, $2, $3, and etc, can be read by this
interface as well, by writing ngx.var[1], ngx.var[2], ngx.var[3], and etc.

Setting ngx.var.Foo to a nil value will unset the $Foo Nginx variable.


 ngx.var.args = nil

CAUTION When reading from an Nginx variable, Nginx will allocate memory in the per-request memory pool which is freed only at request termination. So when you need to read from an Nginx variable repeatedly in your Lua code, cache the Nginx variable value to your own Lua variable, for example,


 local val = ngx.var.some_var
 --- use the val repeatedly later

to prevent (temporary) memory leaking within the current request’s lifetime. Another way of caching the result is to use the ngx.ctx table.

Undefined Nginx variables are evaluated to nil while uninitialized (but defined) Nginx variables are evaluated to an empty Lua string.

This API requires a relatively expensive metamethod call and it is recommended to avoid using it on hot code paths.

Back to TOC

Core constants

context: init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, *log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*


   ngx.OK (0)
   ngx.ERROR (-1)
   ngx.AGAIN (-2)
   ngx.DONE (-4)
   ngx.DECLINED (-5)

Note that only three of these constants are utilized by the Nginx API for Lua (i.e., ngx.exit accepts ngx.OK, ngx.ERROR, and ngx.DECLINED as input).


   ngx.null

The ngx.null constant is a NULL light userdata usually used to represent nil values in Lua tables etc and is similar to the lua-cjson library’s cjson.null constant. This constant was first introduced in the v0.5.0rc5 release.

The ngx.DECLINED constant was first introduced in the v0.5.0rc19 release.

Back to TOC

HTTP method constants

context: init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

  ngx.HTTP_GET
  ngx.HTTP_HEAD
  ngx.HTTP_PUT
  ngx.HTTP_POST
  ngx.HTTP_DELETE
  ngx.HTTP_OPTIONS   (added in the v0.5.0rc24 release)
  ngx.HTTP_MKCOL     (added in the v0.8.2 release)
  ngx.HTTP_COPY      (added in the v0.8.2 release)
  ngx.HTTP_MOVE      (added in the v0.8.2 release)
  ngx.HTTP_PROPFIND  (added in the v0.8.2 release)
  ngx.HTTP_PROPPATCH (added in the v0.8.2 release)
  ngx.HTTP_LOCK      (added in the v0.8.2 release)
  ngx.HTTP_UNLOCK    (added in the v0.8.2 release)
  ngx.HTTP_PATCH     (added in the v0.8.2 release)
  ngx.HTTP_TRACE     (added in the v0.8.2 release)

These constants are usually used in ngx.location.capture and ngx.location.capture_multi method calls.

Back to TOC

HTTP status constants

context: init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*


   value = ngx.HTTP_CONTINUE (100) (first added in the v0.9.20 release)
   value = ngx.HTTP_SWITCHING_PROTOCOLS (101) (first added in the v0.9.20 release)
   value = ngx.HTTP_OK (200)
   value = ngx.HTTP_CREATED (201)
   value = ngx.HTTP_ACCEPTED (202) (first added in the v0.9.20 release)
   value = ngx.HTTP_NO_CONTENT (204) (first added in the v0.9.20 release)
   value = ngx.HTTP_PARTIAL_CONTENT (206) (first added in the v0.9.20 release)
   value = ngx.HTTP_SPECIAL_RESPONSE (300)
   value = ngx.HTTP_MOVED_PERMANENTLY (301)
   value = ngx.HTTP_MOVED_TEMPORARILY (302)
   value = ngx.HTTP_SEE_OTHER (303)
   value = ngx.HTTP_NOT_MODIFIED (304)
   value = ngx.HTTP_TEMPORARY_REDIRECT (307) (first added in the v0.9.20 release)
   value = ngx.HTTP_PERMANENT_REDIRECT (308)
   value = ngx.HTTP_BAD_REQUEST (400)
   value = ngx.HTTP_UNAUTHORIZED (401)
   value = ngx.HTTP_PAYMENT_REQUIRED (402) (first added in the v0.9.20 release)
   value = ngx.HTTP_FORBIDDEN (403)
   value = ngx.HTTP_NOT_FOUND (404)
   value = ngx.HTTP_NOT_ALLOWED (405)
   value = ngx.HTTP_NOT_ACCEPTABLE (406) (first added in the v0.9.20 release)
   value = ngx.HTTP_REQUEST_TIMEOUT (408) (first added in the v0.9.20 release)
   value = ngx.HTTP_CONFLICT (409) (first added in the v0.9.20 release)
   value = ngx.HTTP_GONE (410)
   value = ngx.HTTP_UPGRADE_REQUIRED (426) (first added in the v0.9.20 release)
   value = ngx.HTTP_TOO_MANY_REQUESTS (429) (first added in the v0.9.20 release)
   value = ngx.HTTP_CLOSE (444) (first added in the v0.9.20 release)
   value = ngx.HTTP_ILLEGAL (451) (first added in the v0.9.20 release)
   value = ngx.HTTP_INTERNAL_SERVER_ERROR (500)
   value = ngx.HTTP_NOT_IMPLEMENTED (501)
   value = ngx.HTTP_METHOD_NOT_IMPLEMENTED (501) (kept for compatibility)
   value = ngx.HTTP_BAD_GATEWAY (502) (first added in the v0.9.20 release)
   value = ngx.HTTP_SERVICE_UNAVAILABLE (503)
   value = ngx.HTTP_GATEWAY_TIMEOUT (504) (first added in the v0.3.1rc38 release)
   value = ngx.HTTP_VERSION_NOT_SUPPORTED (505) (first added in the v0.9.20 release)
   value = ngx.HTTP_INSUFFICIENT_STORAGE (507) (first added in the v0.9.20 release)

Back to TOC

Nginx log level constants

context: init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*


   ngx.STDERR
   ngx.EMERG
   ngx.ALERT
   ngx.CRIT
   ngx.ERR
   ngx.WARN
   ngx.NOTICE
   ngx.INFO
   ngx.DEBUG

These constants are usually used by the ngx.log method.

Back to TOC

print

syntax: print(…)

context: init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Writes argument values into the Nginx error.log file with the ngx.NOTICE log level.

It is equivalent to


 ngx.log(ngx.NOTICE, ...)

Lua nil arguments are accepted and result in literal "nil" strings while Lua booleans result in literal "true" or "false" strings. And the ngx.null constant will yield the "null" string output.

There is a hard coded 2048 byte limitation on error message lengths in the Nginx core. This limit includes trailing newlines and leading time stamps. If the message size exceeds this limit, Nginx will truncate the message text accordingly. This limit can be manually modified by editing the NGX_MAX_ERROR_STR macro definition in the src/core/ngx_log.h file in the Nginx source tree.

Back to TOC

ngx.ctx

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, exit_worker_by_lua*

This table can be used to store per-request Lua context data and has a life time identical to the current request (as with the Nginx variables).

Consider the following example,


 location /test {
     rewrite_by_lua_block {
         ngx.ctx.foo = 76
     }
     access_by_lua_block {
         ngx.ctx.foo = ngx.ctx.foo + 3
     }
     content_by_lua_block {
         ngx.say(ngx.ctx.foo)
     }
 }

Then GET /test will yield the output


 79

That is, the ngx.ctx.foo entry persists across the rewrite, access, and content phases of a request.

Every request, including subrequests, has its own copy of the table. For example:


 location /sub {
     content_by_lua_block {
         ngx.say("sub pre: ", ngx.ctx.blah)
         ngx.ctx.blah = 32
         ngx.say("sub post: ", ngx.ctx.blah)
     }
 }

 location /main {
     content_by_lua_block {
         ngx.ctx.blah = 73
         ngx.say("main pre: ", ngx.ctx.blah)
         local res = ngx.location.capture("/sub")
         ngx.print(res.body)
         ngx.say("main post: ", ngx.ctx.blah)
     }
 }

Then GET /main will give the output


 main pre: 73
 sub pre: nil
 sub post: 32
 main post: 73

Here, modification of the ngx.ctx.blah entry in the subrequest does not affect the one in the parent request. This is because they have two separate versions of ngx.ctx.blah.

Internal redirects (triggered by nginx configuration directives like error_page, try_files, index and etc) will destroy the original request ngx.ctx data (if any) and the new request will have an empty ngx.ctx table. For instance,


 location /new {
     content_by_lua_block {
         ngx.say(ngx.ctx.foo)
     }
 }

 location /orig {
     content_by_lua_block {
         ngx.ctx.foo = "hello"
         ngx.exec("/new")
     }
 }

Then GET /orig will give


 nil

rather than the original "hello" value.

Because HTTP request is created after SSL handshake, the ngx.ctx created
in ssl_certificate_by_lua*, ssl_session_store_by_lua*, ssl_session_fetch_by_lua* and ssl_client_hello_by_lua*
is not available in the following phases like rewrite_by_lua*.

Since dev, the ngx.ctx created during a SSL handshake
will be inherited by the requests which share the same TCP connection established by the handshake.
Note that overwrite values in ngx.ctx in the http request phases (like rewrite_by_lua*) will only take affect in the current http request.

Arbitrary data values, including Lua closures and nested tables, can be inserted into this “magic” table. It also allows the registration of custom meta methods.

Overriding ngx.ctx with a new Lua table is also supported, for example,


 ngx.ctx = { foo = 32, bar = 54 }

When being used in the context of init_worker_by_lua*, this table just has the same lifetime of the current Lua handler.

The ngx.ctx lookup requires relatively expensive metamethod calls and it is much slower than explicitly passing per-request data along by your own function arguments. So do not abuse this API for saving your own function arguments because it usually has quite some performance impact.

Because of the metamethod magic, never “local” the ngx.ctx table outside your Lua function scope on the Lua module level due to worker-level data sharing. For example, the following is bad:


 -- mymodule.lua
 local _M = {}

 -- the following line is bad since ngx.ctx is a per-request
 -- data while this <code>ctx</code> variable is on the Lua module level
 -- and thus is per-nginx-worker.
 local ctx = ngx.ctx

 function _M.main()
     ctx.foo = "bar"
 end

 return _M

Use the following instead:


 -- mymodule.lua
 local _M = {}

 function _M.main(ctx)
     ctx.foo = "bar"
 end

 return _M

That is, let the caller pass the ctx table explicitly via a function argument.

Back to TOC

ngx.location.capture

syntax: res = ngx.location.capture(uri, options?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Issues a synchronous but still non-blocking Nginx Subrequest using uri.

Nginx’s subrequests provide a powerful way to make non-blocking internal requests to other locations configured with disk file directory or any other Nginx C modules like ngx_proxy, ngx_fastcgi, ngx_memc,
ngx_postgres, ngx_drizzle, and even ngx_lua itself and etc etc etc.

Also note that subrequests just mimic the HTTP interface but there is no extra HTTP/TCP traffic nor IPC involved. Everything works internally, efficiently, on the C level.

Subrequests are completely different from HTTP 301/302 redirection (via ngx.redirect) and internal redirection (via ngx.exec).

You should always read the request body (by either calling ngx.req.read_body or configuring lua_need_request_body on) before initiating a subrequest.

This API function (as well as ngx.location.capture_multi) always buffers the whole response body of the subrequest in memory. Thus, you should use cosockets
and streaming processing instead if you have to handle large subrequest responses.

Here is a basic example:


 res = ngx.location.capture(uri)

Returns a Lua table with 4 slots: res.status, res.header, res.body, and res.truncated.

res.status holds the response status code for the subrequest response.

res.header holds all the response headers of the
subrequest and it is a normal Lua table. For multi-value response headers,
the value is a Lua (array) table that holds all the values in the order that
they appear. For instance, if the subrequest response headers contain the following
lines:


 Set-Cookie: a=3
 Set-Cookie: foo=bar
 Set-Cookie: baz=blah

Then res.header["Set-Cookie"] will be evaluated to the table value
{"a=3", "foo=bar", "baz=blah"}.

res.body holds the subrequest’s response body data, which might be truncated. You always need to check the res.truncated boolean flag to see if res.body contains truncated data. The data truncation here can only be caused by those unrecoverable errors in your subrequests like the cases that the remote end aborts the connection prematurely in the middle of the response body data stream or a read timeout happens when your subrequest is receiving the response body data from the remote.

URI query strings can be concatenated to URI itself, for instance,


 res = ngx.location.capture('/foo/bar?a=3&b=4')

Named locations like @foo are not allowed due to a limitation in
the Nginx core. Use normal locations combined with the internal directive to
prepare internal-only locations.

An optional option table can be fed as the second
argument, which supports the options:

  • method
    specify the subrequest’s request method, which only accepts constants like ngx.HTTP_POST.
  • body
    specify the subrequest’s request body (string value only).
  • args
    specify the subrequest’s URI query arguments (both string value and Lua tables are accepted)
  • ctx
    specify a Lua table to be the ngx.ctx table for the subrequest. It can be the current request’s ngx.ctx table, which effectively makes the parent and its subrequest to share exactly the same context table. This option was first introduced in the v0.3.1rc25 release.
  • vars
    take a Lua table which holds the values to set the specified Nginx variables in the subrequest as this option’s value. This option was first introduced in the v0.3.1rc31 release.
  • copy_all_vars
    specify whether to copy over all the Nginx variable values of the current request to the subrequest in question. modifications of the Nginx variables in the subrequest will not affect the current (parent) request. This option was first introduced in the v0.3.1rc31 release.
  • share_all_vars
    specify whether to share all the Nginx variables of the subrequest with the current (parent) request. modifications of the Nginx variables in the subrequest will affect the current (parent) request. Enabling this option may lead to hard-to-debug issues due to bad side-effects and is considered bad and harmful. Only enable this option when you completely know what you are doing.
  • always_forward_body
    when set to true, the current (parent) request’s request body will always be forwarded to the subrequest being created if the body option is not specified. The request body read by either ngx.req.read_body() or lua_need_request_body on will be directly forwarded to the subrequest without copying the whole request body data when creating the subrequest (no matter the request body data is buffered in memory buffers or temporary files). By default, this option is false and when the body option is not specified, the request body of the current (parent) request is only forwarded when the subrequest takes the PUT or POST request method.

Issuing a POST subrequest, for example, can be done as follows


 res = ngx.location.capture(
     '/foo/bar',
     { method = ngx.HTTP_POST, body = 'hello, world' }
 )

See HTTP method constants methods other than POST.
The method option is ngx.HTTP_GET by default.

The args option can specify extra URI arguments, for instance,


 ngx.location.capture('/foo?a=1',
     { args = { b = 3, c = ':' } }
 )

is equivalent to


 ngx.location.capture('/foo?a=1&b=3&c=%3a')

that is, this method will escape argument keys and values according to URI rules and
concatenate them together into a complete query string. The format for the Lua table passed as the args argument is identical to the format used in the ngx.encode_args method.

The args option can also take plain query strings:


 ngx.location.capture('/foo?a=1',
     { args = 'b=3&c=%3a' }
 )

This is functionally identical to the previous examples.

The share_all_vars option controls whether to share Nginx variables among the current request and its subrequests.
If this option is set to true, then the current request and associated subrequests will share the same Nginx variable scope. Hence, changes to Nginx variables made by a subrequest will affect the current request.

Care should be taken in using this option as variable scope sharing can have unexpected side effects. The args, vars, or copy_all_vars options are generally preferable instead.

This option is set to false by default


 location /other {
     set $dog "$dog world";
     echo "$uri dog: $dog";
 }

 location /lua {
     set $dog 'hello';
     content_by_lua_block {
         res = ngx.location.capture("/other",
             { share_all_vars = true })

         ngx.print(res.body)
         ngx.say(ngx.var.uri, ": ", ngx.var.dog)
     }
 }

Accessing location /lua gives

/other dog: hello world
/lua: hello world

The copy_all_vars option provides a copy of the parent request’s Nginx variables to subrequests when such subrequests are issued. Changes made to these variables by such subrequests will not affect the parent request or any other subrequests sharing the parent request’s variables.


 location /other {
     set $dog "$dog world";
     echo "$uri dog: $dog";
 }

 location /lua {
     set $dog 'hello';
     content_by_lua_block {
         res = ngx.location.capture("/other",
             { copy_all_vars = true })

         ngx.print(res.body)
         ngx.say(ngx.var.uri, ": ", ngx.var.dog)
     }
 }

Request GET /lua will give the output

/other dog: hello world
/lua: hello

Note that if both share_all_vars and copy_all_vars are set to true, then share_all_vars takes precedence.

In addition to the two settings above, it is possible to specify
values for variables in the subrequest using the vars option. These
variables are set after the sharing or copying of variables has been
evaluated, and provides a more efficient method of passing specific
values to a subrequest over encoding them as URL arguments and
unescaping them in the Nginx config file.


 location /other {
     content_by_lua_block {
         ngx.say("dog = ", ngx.var.dog)
         ngx.say("cat = ", ngx.var.cat)
     }
 }

 location /lua {
     set $dog '';
     set $cat '';
     content_by_lua_block {
         res = ngx.location.capture("/other",
             { vars = { dog = "hello", cat = 32 }})

         ngx.print(res.body)
     }
 }

Accessing /lua will yield the output

dog = hello
cat = 32

The ctx option can be used to specify a custom Lua table to serve as the ngx.ctx table for the subrequest.


 location /sub {
     content_by_lua_block {
         ngx.ctx.foo = "bar";
     }
 }
 location /lua {
     content_by_lua_block {
         local ctx = {}
         res = ngx.location.capture("/sub", { ctx = ctx })

         ngx.say(ctx.foo)
         ngx.say(ngx.ctx.foo)
     }
 }

Then request GET /lua gives

bar
nil

It is also possible to use this ctx option to share the same ngx.ctx table between the current (parent) request and the subrequest:


 location /sub {
     content_by_lua_block {
         ngx.ctx.foo = "bar"
     }
 }
 location /lua {
     content_by_lua_block {
         res = ngx.location.capture("/sub", { ctx = ngx.ctx })
         ngx.say(ngx.ctx.foo)
     }
 }

Request GET /lua yields the output

bar

Note that subrequests issued by ngx.location.capture inherit all the
request headers of the current request by default and that this may have unexpected side effects on the
subrequest responses. For example, when using the standard ngx_proxy module to serve
subrequests, an “Accept-Encoding: gzip” header in the main request may result
in gzipped responses that cannot be handled properly in Lua code. Original request headers should be ignored by setting
proxy_pass_request_headers to off in subrequest locations.

When the body option is not specified and the always_forward_body option is false (the default value), the POST and PUT subrequests will inherit the request bodies of the parent request (if any).

There is a hard-coded upper limit on the number of subrequests possible for every main request. In older versions of Nginx, the limit was 50 concurrent subrequests and in more recent versions, Nginx 1.9.5 onwards, the same limit is changed to limit the depth of recursive subrequests. When this limit is exceeded, the following error message is added to the error.log file:

[error] 13983#0: *1 subrequests cycle while processing "/uri"

The limit can be manually modified if required by editing the definition of the NGX_HTTP_MAX_SUBREQUESTS macro in the nginx/src/http/ngx_http_request.h file in the Nginx source tree.

Please also refer to restrictions on capturing locations configured by subrequest directives of other modules.

Back to TOC

ngx.location.capture_multi

syntax: res1, res2, … = ngx.location.capture_multi({ {uri, options?}, {uri, options?}, … })

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Just like ngx.location.capture, but supports multiple subrequests running in parallel.

This function issues several parallel subrequests specified by the input table and returns their results in the same order. For example,


 res1, res2, res3 = ngx.location.capture_multi{
     { "/foo", { args = "a=3&b=4" } },
     { "/bar" },
     { "/baz", { method = ngx.HTTP_POST, body = "hello" } },
 }

 if res1.status == ngx.HTTP_OK then
     ...
 end

 if res2.body == "BLAH" then
     ...
 end

This function will not return until all the subrequests terminate.
The total latency is the longest latency of the individual subrequests rather than the sum.

Lua tables can be used for both requests and responses when the number of subrequests to be issued is not known in advance:


 -- construct the requests table
 local reqs = {}
 table.insert(reqs, { "/mysql" })
 table.insert(reqs, { "/postgres" })
 table.insert(reqs, { "/redis" })
 table.insert(reqs, { "/memcached" })

 -- issue all the requests at once and wait until they all return
 local resps = { ngx.location.capture_multi(reqs) }

 -- loop over the responses table
 for i, resp in ipairs(resps) do
     -- process the response table "resp"
 end

The ngx.location.capture function is just a special form
of this function. Logically speaking, the ngx.location.capture can be implemented like this


 ngx.location.capture =
     function (uri, args)
         return ngx.location.capture_multi({ {uri, args} })
     end

Please also refer to restrictions on capturing locations configured by subrequest directives of other modules.

Back to TOC

ngx.status

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Read and write the current request’s response status. This should be called
before sending out the response headers.


 ngx.status = ngx.HTTP_CREATED
 status = ngx.status

Setting ngx.status after the response header is sent out has no effect but leaving an error message in your Nginx’s error log file:

attempt to set ngx.status after sending out response headers

Back to TOC

ngx.header.HEADER

syntax: ngx.header.HEADER = VALUE

syntax: value = ngx.header.HEADER

context: rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Set, add to, or clear the current request’s HEADER response header that is to be sent.

Underscores (_) in the header names will be replaced by hyphens (-) by default. This transformation can be turned off via the lua_transform_underscores_in_response_headers directive.

The header names are matched case-insensitively.


 -- equivalent to ngx.header["Content-Type"] = 'text/plain'
 ngx.header.content_type = 'text/plain'

 ngx.header["X-My-Header"] = 'blah blah'

Multi-value headers can be set this way:


 ngx.header['Set-Cookie'] = {'a=32; path=/', 'b=4; path=/'}

will yield


 Set-Cookie: a=32; path=/
 Set-Cookie: b=4; path=/

in the response headers.

Only Lua tables are accepted (Only the last element in the table will take effect for standard headers such as Content-Type that only accept a single value).


 ngx.header.content_type = {'a', 'b'}

is equivalent to


 ngx.header.content_type = 'b'

Setting a slot to nil effectively removes it from the response headers:


 ngx.header["X-My-Header"] = nil

The same applies to assigning an empty table:


 ngx.header["X-My-Header"] = {}

Setting ngx.header.HEADER after sending out response headers (either explicitly with ngx.send_headers or implicitly with ngx.print and similar) will log an error message.

Reading ngx.header.HEADER will return the value of the response header named HEADER.

Underscores (_) in the header names will also be replaced by dashes (-) and the header names will be matched case-insensitively. If the response header is not present at all, nil will be returned.

This is particularly useful in the context of header_filter_by_lua*, for example,


 location /test {
     set $footer '';

     proxy_pass http://some-backend;

     header_filter_by_lua_block {
         if ngx.header["X-My-Header"] == "blah" then
             ngx.var.footer = "some value"
         end
     }

     echo_after_body $footer;
 }

For multi-value headers, all of the values of header will be collected in order and returned as a Lua table. For example, response headers

Foo: bar
Foo: baz

will result in


 {"bar", "baz"}

to be returned when reading ngx.header.Foo.

Note that ngx.header is not a normal Lua table and as such, it is not possible to iterate through it using the Lua ipairs function.

Note: this function throws a Lua error if HEADER or
VALUE contain unsafe characters (control characters).

For reading request headers, use the ngx.req.get_headers function instead.

Back to TOC

ngx.resp.get_headers

syntax: headers, err = ngx.resp.get_headers(max_headers?, raw?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, balancer_by_lua*

Returns a Lua table holding all the current response headers for the current request.


 local h, err = ngx.resp.get_headers()

 if err == "truncated" then
     -- one can choose to ignore or reject the current response here
 end

 for k, v in pairs(h) do
     ...
 end

This function has the same signature as ngx.req.get_headers except getting response headers instead of request headers.

Note that a maximum of 100 response headers are parsed by default (including those with the same name) and that additional response headers are silently discarded to guard against potential denial of service attacks. Since v0.10.13, when the limit is exceeded, it will return a second value which is the string "truncated".

This API was first introduced in the v0.9.5 release.

Back to TOC

ngx.req.is_internal

syntax: is_internal = ngx.req.is_internal()

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Returns a boolean indicating whether the current request is an “internal request”, i.e.,
a request initiated from inside the current Nginx server instead of from the client side.

Subrequests are all internal requests and so are requests after internal redirects.

This API was first introduced in the v0.9.20 release.

Back to TOC

ngx.req.start_time

syntax: secs = ngx.req.start_time()

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Returns a floating-point number representing the timestamp (including milliseconds as the decimal part) when the current request was created.

The following example emulates the $request_time variable value (provided by ngx_http_log_module) in pure Lua:


 local request_time = ngx.now() - ngx.req.start_time()

This function was first introduced in the v0.7.7 release.

See also ngx.now and ngx.update_time.

Back to TOC

ngx.req.http_version

syntax: num = ngx.req.http_version()

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*

Returns the HTTP version number for the current request as a Lua number.

Current possible values are 2.0, 1.0, 1.1, and 0.9. Returns nil for unrecognized values.

This method was first introduced in the v0.7.17 release.

Back to TOC

ngx.req.raw_header

syntax: str = ngx.req.raw_header(no_request_line?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*

Returns the original raw HTTP protocol header received by the Nginx server.

By default, the request line and trailing CR LF terminator will also be included. For example,


 ngx.print(ngx.req.raw_header())

gives something like this:

GET /t HTTP/1.1
Host: localhost
Connection: close
Foo: bar

You can specify the optional
no_request_line argument as a true value to exclude the request line from the result. For example,


 ngx.print(ngx.req.raw_header(true))

outputs something like this:

Host: localhost
Connection: close
Foo: bar

This method was first introduced in the v0.7.17 release.

This method does not work in HTTP/2 requests yet.

Back to TOC

ngx.req.get_method

syntax: method_name = ngx.req.get_method()

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, balancer_by_lua*, log_by_lua*

Retrieves the current request’s request method name. Strings like "GET" and "POST" are returned instead of numerical method constants.

If the current request is an Nginx subrequest, then the subrequest’s method name will be returned.

This method was first introduced in the v0.5.6 release.

See also ngx.req.set_method.

Back to TOC

ngx.req.set_method

syntax: ngx.req.set_method(method_id)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*

Overrides the current request’s request method with the method_id argument. Currently only numerical method constants are supported, like ngx.HTTP_POST and ngx.HTTP_GET.

If the current request is an Nginx subrequest, then the subrequest’s method will be overridden.

This method was first introduced in the v0.5.6 release.

See also ngx.req.get_method.

Back to TOC

ngx.req.set_uri

syntax: ngx.req.set_uri(uri, jump?, binary?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*

Rewrite the current request’s (parsed) URI by the uri argument. The uri argument must be a Lua string and cannot be of zero length, or a Lua exception will be thrown.

The optional boolean jump argument can trigger location rematch (or location jump) as ngx_http_rewrite_module’s rewrite directive, that is, when jump is true (default to false), this function will never return and it will tell Nginx to try re-searching locations with the new URI value at the later post-rewrite phase and jumping to the new location.

Location jump will not be triggered otherwise, and only the current request’s URI will be modified, which is also the default behavior. This function will return but with no returned values when the jump argument is false or absent altogether.

For example, the following Nginx config snippet


 rewrite ^ /foo last;

can be coded in Lua like this:


 ngx.req.set_uri("/foo", true)

Similarly, Nginx config


 rewrite ^ /foo break;

can be coded in Lua as


 ngx.req.set_uri("/foo", false)

or equivalently,


 ngx.req.set_uri("/foo")

The jump argument can only be set to true in rewrite_by_lua*. Use of jump in other contexts is prohibited and will throw out a Lua exception.

A more sophisticated example involving regex substitutions is as follows


 location /test {
     rewrite_by_lua_block {
         local uri = ngx.re.sub(ngx.var.uri, "^/test/(.*)", "/$1", "o")
         ngx.req.set_uri(uri)
     }
     proxy_pass http://my_backend;
 }

which is functionally equivalent to


 location /test {
     rewrite ^/test/(.*) /$1 break;
     proxy_pass http://my_backend;
 }

Note: this function throws a Lua error if the uri argument
contains unsafe characters (control characters).

Note that it is not possible to use this interface to rewrite URI arguments and that ngx.req.set_uri_args should be used for this instead. For instance, Nginx config


 rewrite ^ /foo?a=3? last;

can be coded as


 ngx.req.set_uri_args("a=3")
 ngx.req.set_uri("/foo", true)

or


 ngx.req.set_uri_args({a = 3})
 ngx.req.set_uri("/foo", true)

Starting from 0.10.16 of this module, this function accepts an
optional boolean binary argument to allow arbitrary binary URI
data. By default, this binary argument is false and this function
will throw out a Lua error such as the one below when the uri
argument contains any control characters (ASCII Code 0 ~ 0x08, 0x0A ~ 0x1F and 0x7F).

[error] 23430#23430: *1 lua entry thread aborted: runtime error:
content_by_lua(nginx.conf:44):3: ngx.req.set_uri unsafe byte "0x00"
in "\x00foo" (maybe you want to set the 'binary' argument?)

This interface was first introduced in the v0.3.1rc14 release.

Back to TOC

ngx.req.set_uri_args

syntax: ngx.req.set_uri_args(args)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*

Rewrite the current request’s URI query arguments by the args argument. The args argument can be either a Lua string, as in


 ngx.req.set_uri_args("a=3&b=hello%20world")

or a Lua table holding the query arguments’ key-value pairs, as in


 ngx.req.set_uri_args({ a = 3, b = "hello world" })

In the former case, i.e., when the whole query-string is provided directly,
the input Lua string should already be well-formed with the URI encoding.
For security considerations, this method will automatically escape any control and
whitespace characters (ASCII code 0x00 ~ 0x20 and 0x7F) in the Lua string.

In the latter case, this method will escape argument keys and values according to the URI escaping rule.

Multi-value arguments are also supported:


 ngx.req.set_uri_args({ a = 3, b = {5, 6} })

which will result in a query string like a=3&b=5&b=6.

This interface was first introduced in the v0.3.1rc13 release.

See also ngx.req.set_uri.

Back to TOC

ngx.req.get_uri_args

syntax: args, err = ngx.req.get_uri_args(max_args?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, balancer_by_lua*

Returns a Lua table holding all the current request URL query arguments.


 location = /test {
     content_by_lua_block {
         local args, err = ngx.req.get_uri_args()

         if err == "truncated" then
             -- one can choose to ignore or reject the current request here
         end

         for key, val in pairs(args) do
             if type(val) == "table" then
                 ngx.say(key, ": ", table.concat(val, ", "))
             else
                 ngx.say(key, ": ", val)
             end
         end
     }
 }

Then GET /test?foo=bar&bar=baz&bar=blah will yield the response body


 foo: bar
 bar: baz, blah

Multiple occurrences of an argument key will result in a table value holding all the values for that key in order.

Keys and values are unescaped according to URI escaping rules. In the settings above, GET /test?a%20b=1%61+2 will yield:


 a b: 1a 2

Arguments without the =<value> parts are treated as boolean arguments. GET /test?foo&bar will yield:


 foo: true
 bar: true

That is, they will take Lua boolean values true. However, they are different from arguments taking empty string values. GET /test?foo=&bar= will give something like


 foo:
 bar:

Empty key arguments are discarded. GET /test?=hello&=world will yield an empty output for instance.

Updating query arguments via the Nginx variable $args (or ngx.var.args in Lua) at runtime is also supported:


 ngx.var.args = "a=3&b=42"
 local args, err = ngx.req.get_uri_args()

Here the args table will always look like


 {a = 3, b = 42}

regardless of the actual request query string.

Note that a maximum of 100 request arguments are parsed by default (including those with the same name) and that additional request arguments are silently discarded to guard against potential denial of service attacks. Since v0.10.13, when the limit is exceeded, it will return a second value which is the string "truncated".

However, the optional max_args function argument can be used to override this limit:


 local args, err = ngx.req.get_uri_args(10)
 if err == "truncated" then
     -- one can choose to ignore or reject the current request here
 end

This argument can be set to zero to remove the limit and to process all request arguments received:


 local args, err = ngx.req.get_uri_args(0)

Removing the max_args cap is strongly discouraged.

Back to TOC

ngx.req.get_post_args

syntax: args, err = ngx.req.get_post_args(max_args?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Returns a Lua table holding all the current request POST query arguments (of the MIME type application/x-www-form-urlencoded). Call ngx.req.read_body to read the request body first or turn on the lua_need_request_body directive to avoid errors.


 location = /test {
     content_by_lua_block {
         ngx.req.read_body()
         local args, err = ngx.req.get_post_args()

         if err == "truncated" then
             -- one can choose to ignore or reject the current request here
         end

         if not args then
             ngx.say("failed to get post args: ", err)
             return
         end
         for key, val in pairs(args) do
             if type(val) == "table" then
                 ngx.say(key, ": ", table.concat(val, ", "))
             else
                 ngx.say(key, ": ", val)
             end
         end
     }
 }

Then


 # Post request with the body 'foo=bar&bar=baz&bar=blah'
 $ curl --data 'foo=bar&bar=baz&bar=blah' localhost/test

will yield the response body like


 foo: bar
 bar: baz, blah

Multiple occurrences of an argument key will result in a table value holding all of the values for that key in order.

Keys and values will be unescaped according to URI escaping rules.

With the settings above,


 # POST request with body 'a%20b=1%61+2'
 $ curl -d 'a%20b=1%61+2' localhost/test

will yield:


 a b: 1a 2

Arguments without the =<value> parts are treated as boolean arguments. POST /test with the request body foo&bar will yield:


 foo: true
 bar: true

That is, they will take Lua boolean values true. However, they are different from arguments taking empty string values. POST /test with request body foo=&bar= will return something like


 foo:
 bar:

Empty key arguments are discarded. POST /test with body =hello&=world will yield empty outputs for instance.

Note that a maximum of 100 request arguments are parsed by default (including those with the same name) and that additional request arguments are silently discarded to guard against potential denial of service attacks. Since v0.10.13, when the limit is exceeded, it will return a second value which is the string "truncated".

However, the optional max_args function argument can be used to override this limit:


 local args, err = ngx.req.get_post_args(10)
 if err == "truncated" then
     -- one can choose to ignore or reject the current request here
 end

This argument can be set to zero to remove the limit and to process all request arguments received:


 local args, err = ngx.req.get_post_args(0)

Removing the max_args cap is strongly discouraged.

Back to TOC

ngx.req.get_headers

syntax: headers, err = ngx.req.get_headers(max_headers?, raw?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Returns a Lua table holding all the current request headers.


 local h, err = ngx.req.get_headers()

 if err == "truncated" then
     -- one can choose to ignore or reject the current request here
 end

 for k, v in pairs(h) do
     ...
 end

To read an individual header:


 ngx.say("Host: ", ngx.req.get_headers()["Host"])

Note that the ngx.var.HEADER API call, which uses core $http_HEADER variables, may be more preferable for reading individual request headers.

For multiple instances of request headers such as:


 Foo: foo
 Foo: bar
 Foo: baz

the value of ngx.req.get_headers()["Foo"] will be a Lua (array) table such as:


 {"foo", "bar", "baz"}

Note that a maximum of 100 request headers are parsed by default (including those with the same name) and that additional request headers are silently discarded to guard against potential denial of service attacks. Since v0.10.13, when the limit is exceeded, it will return a second value which is the string "truncated".

However, the optional max_headers function argument can be used to override this limit:


 local headers, err = ngx.req.get_headers(10)

 if err == "truncated" then
     -- one can choose to ignore or reject the current request here
 end

This argument can be set to zero to remove the limit and to process all request headers received:


 local headers, err = ngx.req.get_headers(0)

Removing the max_headers cap is strongly discouraged.

Since the 0.6.9 release, all the header names in the Lua table returned are converted to the pure lower-case form by default, unless the raw argument is set to true (default to false).

Also, by default, an __index metamethod is added to the resulting Lua table and will normalize the keys to a pure lowercase form with all underscores converted to dashes in case of a lookup miss. For example, if a request header My-Foo-Header is present, then the following invocations will all pick up the value of this header correctly:


 ngx.say(headers.my_foo_header)
 ngx.say(headers["My-Foo-Header"])
 ngx.say(headers["my-foo-header"])

The __index metamethod will not be added when the raw argument is set to true.

Back to TOC

ngx.req.set_header

syntax: ngx.req.set_header(header_name, header_value)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*

Set the current request’s request header named header_name to value header_value, overriding any existing ones.

The input Lua string header_name and header_value should already be well-formed with the URI encoding.
For security considerations, this method will automatically escape " “, “””, “(”, “)”, “,”, “/”, “:”, “;”, “?”,
“<”, “=”, “>”, “?”, “@”, “[”, “]”, “”, “{”, “}”, 0x00-0x1F, 0x7F-0xFF in header_name and automatically escape
"0x00-0x08, 0x0A-0x0F, 0x7F in header_value.

By default, all the subrequests subsequently initiated by ngx.location.capture and ngx.location.capture_multi will inherit the new header.

It is not a Lua’s equivalent of nginx proxy_set_header directive (same is true about ngx.req.clear_header). proxy_set_header only affects the upstream request while ngx.req.set_header change the incoming request. Record the http headers in the access log file will show the difference. But you still can use it as an alternative of nginx proxy_set_header directive as long as you know the difference.

Here is an example of setting the Content-Type header:


 ngx.req.set_header("Content-Type", "text/css")

The header_value can take an array list of values,
for example,


 ngx.req.set_header("Foo", {"a", "abc"})

will produce two new request headers:


 Foo: a
 Foo: abc

and old Foo headers will be overridden if there is any.

When the header_value argument is nil, the request header will be removed. So


 ngx.req.set_header("X-Foo", nil)

is equivalent to


 ngx.req.clear_header("X-Foo")

Note: this function throws a Lua error if header_name or
header_value contain unsafe characters (control characters).

Back to TOC

ngx.req.clear_header

syntax: ngx.req.clear_header(header_name)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*

Clears the current request’s request header named header_name. None of the current request’s existing subrequests will be affected but subsequently initiated subrequests will inherit the change by default.

Back to TOC

ngx.req.read_body

syntax: ngx.req.read_body()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Reads the client request body synchronously without blocking the Nginx event loop.


 ngx.req.read_body()
 local args = ngx.req.get_post_args()

If the request body is already read previously by turning on lua_need_request_body or by using other modules, then this function does not run and returns immediately.

If the request body has already been explicitly discarded, either by the ngx.req.discard_body function or other modules, this function does not run and returns immediately.

In case of errors, such as connection errors while reading the data, this method will throw out a Lua exception or terminate the current request with a 500 status code immediately.

The request body data read using this function can be retrieved later via ngx.req.get_body_data or, alternatively, the temporary file name for the body data cached to disk using ngx.req.get_body_file. This depends on

  1. whether the current request body is already larger than the client_body_buffer_size,
  2. and whether client_body_in_file_only has been switched on.

In cases where current request may have a request body and the request body data is not required, The ngx.req.discard_body function must be used to explicitly discard the request body to avoid breaking things under HTTP 1.1 keepalive or HTTP 1.1 pipelining.

This function was first introduced in the v0.3.1rc17 release.

Back to TOC

ngx.req.discard_body

syntax: ngx.req.discard_body()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Explicitly discard the request body, i.e., read the data on the connection and throw it away immediately (without using the request body by any means).

This function is an asynchronous call and returns immediately.

If the request body has already been read, this function does nothing and returns immediately.

This function was first introduced in the v0.3.1rc17 release.

See also ngx.req.read_body.

Back to TOC

ngx.req.get_body_data

syntax: data = ngx.req.get_body_data()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*, log_by_lua*

Retrieves in-memory request body data. It returns a Lua string rather than a Lua table holding all the parsed query arguments. Use the ngx.req.get_post_args function instead if a Lua table is required.

This function returns nil if

  1. the request body has not been read,
  2. the request body has been read into disk temporary files,
  3. or the request body has zero size.

If the request body has not been read yet, call ngx.req.read_body first (or turn on lua_need_request_body to force this module to read the request body. This is not recommended however).

If the request body has been read into disk files, try calling the ngx.req.get_body_file function instead.

To force in-memory request bodies, try setting client_body_buffer_size to the same size value in client_max_body_size.

Note that calling this function instead of using ngx.var.request_body or ngx.var.echo_request_body is more efficient because it can save one dynamic memory allocation and one data copy.

This function was first introduced in the v0.3.1rc17 release.

See also ngx.req.get_body_file.

Back to TOC

ngx.req.get_body_file

syntax: file_name = ngx.req.get_body_file()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Retrieves the file name for the in-file request body data. Returns nil if the request body has not been read or has been read into memory.

The returned file is read only and is usually cleaned up by Nginx’s memory pool. It should not be manually modified, renamed, or removed in Lua code.

If the request body has not been read yet, call ngx.req.read_body first (or turn on lua_need_request_body to force this module to read the request body. This is not recommended however).

If the request body has been read into memory, try calling the ngx.req.get_body_data function instead.

To force in-file request bodies, try turning on client_body_in_file_only.

This function was first introduced in the v0.3.1rc17 release.

See also ngx.req.get_body_data.

Back to TOC

ngx.req.set_body_data

syntax: ngx.req.set_body_data(data)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Set the current request’s request body using the in-memory data specified by the data argument.

If the request body has not been read yet, call ngx.req.read_body first (or turn on lua_need_request_body to force this module to read the request body. This is not recommended however). Additionally, the request body must not have been previously discarded by ngx.req.discard_body.

Whether the previous request body has been read into memory or buffered into a disk file, it will be freed or the disk file will be cleaned up immediately, respectively.

This function was first introduced in the v0.3.1rc18 release.

See also ngx.req.set_body_file.

Back to TOC

ngx.req.set_body_file

syntax: ngx.req.set_body_file(file_name, auto_clean?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Set the current request’s request body using the in-file data specified by the file_name argument.

If the request body has not been read yet, call ngx.req.read_body first (or turn on lua_need_request_body to force this module to read the request body. This is not recommended however). Additionally, the request body must not have been previously discarded by ngx.req.discard_body.

If the optional auto_clean argument is given a true value, then this file will be removed at request completion or the next time this function or ngx.req.set_body_data are called in the same request. The auto_clean is default to false.

Please ensure that the file specified by the file_name argument exists and is readable by an Nginx worker process by setting its permission properly to avoid Lua exception errors.

Whether the previous request body has been read into memory or buffered into a disk file, it will be freed or the disk file will be cleaned up immediately, respectively.

This function was first introduced in the v0.3.1rc18 release.

See also ngx.req.set_body_data.

Back to TOC

ngx.req.init_body

syntax: ngx.req.init_body(buffer_size?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*

Creates a new blank request body for the current request and initializes the buffer for later request body data writing via the ngx.req.append_body and ngx.req.finish_body APIs.

If the buffer_size argument is specified, then its value will be used for the size of the memory buffer for body writing with ngx.req.append_body. If the argument is omitted, then the value specified by the standard client_body_buffer_size directive will be used instead.

When the data can no longer be hold in the memory buffer for the request body, then the data will be flushed onto a temporary file just like the standard request body reader in the Nginx core.

It is important to always call the ngx.req.finish_body after all the data has been appended onto the current request body. Also, when this function is used together with ngx.req.socket, it is required to call ngx.req.socket before this function, or you will get the “request body already exists” error message.

The usage of this function is often like this:


 ngx.req.init_body(128 * 1024)  -- buffer is 128KB
 for chunk in next_data_chunk() do
     ngx.req.append_body(chunk) -- each chunk can be 4KB
 end
 ngx.req.finish_body()

This function can be used with ngx.req.append_body, ngx.req.finish_body, and ngx.req.socket to implement efficient input filters in pure Lua (in the context of rewrite_by_lua* or access_by_lua*), which can be used with other Nginx content handler or upstream modules like ngx_http_proxy_module and ngx_http_fastcgi_module.

This function was first introduced in the v0.5.11 release.

Back to TOC

ngx.req.append_body

syntax: ngx.req.append_body(data_chunk)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*

Append new data chunk specified by the data_chunk argument onto the existing request body created by the ngx.req.init_body call.

When the data can no longer be hold in the memory buffer for the request body, then the data will be flushed onto a temporary file just like the standard request body reader in the Nginx core.

It is important to always call the ngx.req.finish_body after all the data has been appended onto the current request body.

This function can be used with ngx.req.init_body, ngx.req.finish_body, and ngx.req.socket to implement efficient input filters in pure Lua (in the context of rewrite_by_lua* or access_by_lua*), which can be used with other Nginx content handler or upstream modules like ngx_http_proxy_module and ngx_http_fastcgi_module.

This function was first introduced in the v0.5.11 release.

See also ngx.req.init_body.

Back to TOC

ngx.req.finish_body

syntax: ngx.req.finish_body()

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*

Completes the construction process of the new request body created by the ngx.req.init_body and ngx.req.append_body calls.

This function can be used with ngx.req.init_body, ngx.req.append_body, and ngx.req.socket to implement efficient input filters in pure Lua (in the context of rewrite_by_lua* or access_by_lua*), which can be used with other Nginx content handler or upstream modules like ngx_http_proxy_module and ngx_http_fastcgi_module.

This function was first introduced in the v0.5.11 release.

See also ngx.req.init_body.

Back to TOC

ngx.req.socket

syntax: tcpsock, err = ngx.req.socket()

syntax: tcpsock, err = ngx.req.socket(raw)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Returns a read-only cosocket object that wraps the downstream connection. Only receive, receiveany and receiveuntil methods are supported on this object.

In case of error, nil will be returned as well as a string describing the error.

The socket object returned by this method is usually used to read the current request’s body in a streaming fashion. Do not turn on the lua_need_request_body directive, and do not mix this call with ngx.req.read_body and ngx.req.discard_body.

If any request body data has been pre-read into the Nginx core request header buffer, the resulting cosocket object will take care of this to avoid potential data loss resulting from such pre-reading.
Chunked request bodies are not yet supported in this API.

Since the v0.9.0 release, this function accepts an optional boolean raw argument. When this argument is true, this function returns a full-duplex cosocket object wrapping around the raw downstream connection socket, upon which you can call the receive, receiveany, receiveuntil, and send methods.

When the raw argument is true, it is required that no pending data from any previous ngx.say, ngx.print, or ngx.send_headers calls exists. So if you have these downstream output calls previously, you should call ngx.flush(true) before calling ngx.req.socket(true) to ensure that there is no pending output data. If the request body has not been read yet, then this “raw socket” can also be used to read the request body.

You can use the “raw request socket” returned by ngx.req.socket(true) to implement fancy protocols like WebSocket, or just emit your own raw HTTP response header or body data. You can refer to the lua-resty-websocket library for a real world example.

This function was first introduced in the v0.5.0rc1 release.

Back to TOC

ngx.exec

syntax: ngx.exec(uri, args?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Does an internal redirect to uri with args and is similar to the echo_exec directive of the echo-nginx-module.


 ngx.exec('/some-location')
 ngx.exec('/some-location', 'a=3&b=5&c=6')
 ngx.exec('/some-location?a=3&b=5', 'c=6')

The optional second args can be used to specify extra URI query arguments, for example:


 ngx.exec("/foo", "a=3&b=hello%20world")

Alternatively, a Lua table can be passed for the args argument for ngx_lua to carry out URI escaping and string concatenation.


 ngx.exec("/foo", { a = 3, b = "hello world" })

The result is exactly the same as the previous example.

The format for the Lua table passed as the args argument is identical to the format used in the ngx.encode_args method.

Named locations are also supported but the second args argument will be ignored if present and the querystring for the new target is inherited from the referring location (if any).

GET /foo/file.php?a=hello will return “hello” and not “goodbye” in the example below


 location /foo {
     content_by_lua_block {
         ngx.exec("@bar", "a=goodbye")
     }
 }

 location @bar {
     content_by_lua_block {
         local args = ngx.req.get_uri_args()
         for key, val in pairs(args) do
             if key == "a" then
                 ngx.say(val)
             end
         end
     }
 }

Note that the ngx.exec method is different from ngx.redirect in that
it is purely an internal redirect and that no new external HTTP traffic is involved.

Also note that this method call terminates the processing of the current request and that it must be called before ngx.send_headers or explicit response body
outputs by either ngx.print or ngx.say.

It is recommended that a coding style that combines this method call with the return statement, i.e., return ngx.exec(...) be adopted when this method call is used in contexts other than header_filter_by_lua* to reinforce the fact that the request processing is being terminated.

Back to TOC

ngx.redirect

syntax: ngx.redirect(uri, status?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Issue an HTTP 301 or 302 redirection to uri.

Note: this function throws a Lua error if the uri argument
contains unsafe characters (control characters).

The optional status parameter specifies the HTTP status code to be used. The following status codes are supported right now:

  • 301
  • 302 (default)
  • 303
  • 307
  • 308

It is 302 (ngx.HTTP_MOVED_TEMPORARILY) by default.

Here is an example assuming the current server name is localhost and that it is listening on port 1984:


 return ngx.redirect("/foo")

which is equivalent to


 return ngx.redirect("/foo", ngx.HTTP_MOVED_TEMPORARILY)

Redirecting arbitrary external URLs is also supported, for example:


 return ngx.redirect("http://www.google.com")

We can also use the numerical code directly as the second status argument:


 return ngx.redirect("/foo", 301)

This method is similar to the rewrite directive with the redirect modifier in the standard
ngx_http_rewrite_module, for example, this nginx.conf snippet


 rewrite ^ /foo? redirect;  # nginx config

is equivalent to the following Lua code


 return ngx.redirect('/foo')  -- Lua code

while


 rewrite ^ /foo? permanent;  # nginx config

is equivalent to


 return ngx.redirect('/foo', ngx.HTTP_MOVED_PERMANENTLY)  -- Lua code

URI arguments can be specified as well, for example:


 return ngx.redirect('/foo?a=3&b=4')

Note that this method call terminates the processing of the current request and that it must be called before ngx.send_headers or explicit response body
outputs by either ngx.print or ngx.say.

It is recommended that a coding style that combines this method call with the return statement, i.e., return ngx.redirect(...) be adopted when this method call is used in contexts other than header_filter_by_lua* to reinforce the fact that the request processing is being terminated.

Back to TOC

ngx.send_headers

syntax: ok, err = ngx.send_headers()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Explicitly send out the response headers.

Since v0.8.3 this function returns 1 on success, or returns nil and a string describing the error otherwise.

Note that there is normally no need to manually send out response headers as ngx_lua will automatically send headers out
before content is output with ngx.say or ngx.print or when content_by_lua* exits normally.

Back to TOC

ngx.headers_sent

syntax: value = ngx.headers_sent

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*

Returns true if the response headers have been sent (by ngx_lua), and false otherwise.

This API was first introduced in ngx_lua v0.3.1rc6.

Back to TOC

ngx.print

syntax: ok, err = ngx.print(…)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Emits arguments concatenated to the HTTP client (as response body). If response headers have not been sent, this function will send headers out first and then output body data.

Since v0.8.3 this function returns 1 on success, or returns nil and a string describing the error otherwise.

Lua nil values will output "nil" strings and Lua boolean values will output "true" and "false" literal strings respectively.

Nested arrays of strings are permitted and the elements in the arrays will be sent one by one:


 local table = {
     "hello, ",
     {"world: ", true, " or ", false,
         {": ", nil}}
 }
 ngx.print(table)

will yield the output


 hello, world: true or false: nil

Non-array table arguments will cause a Lua exception to be thrown.

The ngx.null constant will yield the "null" string output.

This is an asynchronous call and will return immediately without waiting for all the data to be written into the system send buffer. To run in synchronous mode, call ngx.flush(true) after calling ngx.print. This can be particularly useful for streaming output. See ngx.flush for more details.

Please note that both ngx.print and ngx.say will always invoke the whole Nginx output body filter chain, which is an expensive operation. So be careful when calling either of these two in a tight loop; buffer the data yourself in Lua and save the calls.

Back to TOC

ngx.say

syntax: ok, err = ngx.say(…)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Just as ngx.print but also emit a trailing newline.

Back to TOC

ngx.log

syntax: ngx.log(log_level, …)

context: init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Log arguments concatenated to error.log with the given logging level.

Lua nil arguments are accepted and result in literal "nil" string while Lua booleans result in literal "true" or "false" string outputs. And the ngx.null constant will yield the "null" string output.

The log_level argument can take constants like ngx.ERR and ngx.WARN. Check out Nginx log level constants for details.

There is a hard coded 2048 byte limitation on error message lengths in the Nginx core. This limit includes trailing newlines and leading time stamps. If the message size exceeds this limit, Nginx will truncate the message text accordingly. This limit can be manually modified by editing the NGX_MAX_ERROR_STR macro definition in the src/core/ngx_log.h file in the Nginx source tree.

Back to TOC

ngx.flush

syntax: ok, err = ngx.flush(wait?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Flushes response output to the client.

ngx.flush accepts an optional boolean wait argument (Default: false) first introduced in the v0.3.1rc34 release. When called with the default argument, it issues an asynchronous call (Returns immediately without waiting for output data to be written into the system send buffer). Calling the function with the wait argument set to true switches to synchronous mode.

In synchronous mode, the function will not return until all output data has been written into the system send buffer or until the send_timeout setting has expired. Note that using the Lua coroutine mechanism means that this function does not block the Nginx event loop even in the synchronous mode.

When ngx.flush(true) is called immediately after ngx.print or ngx.say, it causes the latter functions to run in synchronous mode. This can be particularly useful for streaming output.

Note that ngx.flush is not functional when in the HTTP 1.0 output buffering mode. See HTTP 1.0 support.

Since v0.8.3 this function returns 1 on success, or returns nil and a string describing the error otherwise.

Back to TOC

ngx.exit

syntax: ngx.exit(status)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

When status >= 200 (i.e., ngx.HTTP_OK and above), it will interrupt the execution of the current request and return status code to Nginx.

When status == 0 (i.e., ngx.OK), it will only quit the current phase handler (or the content handler if the content_by_lua* directive is used) and continue to run later phases (if any) for the current request.

The status argument can be ngx.OK, ngx.ERROR, ngx.HTTP_NOT_FOUND,
ngx.HTTP_MOVED_TEMPORARILY, or other HTTP status constants.

To return an error page with custom contents, use code snippets like this:


 ngx.status = ngx.HTTP_GONE
 ngx.say("This is our own content")
 -- to cause quit the whole request rather than the current phase handler
 ngx.exit(ngx.HTTP_OK)

The effect in action:


 $ curl -i http://localhost/test
 HTTP/1.1 410 Gone
 Server: nginx/1.0.6
 Date: Thu, 15 Sep 2011 00:51:48 GMT
 Content-Type: text/plain
 Transfer-Encoding: chunked
 Connection: keep-alive

 This is our own content

Number literals can be used directly as the argument, for instance,


 ngx.exit(501)

Note that while this method accepts all HTTP status constants as input, it only accepts ngx.OK and ngx.ERROR of the core constants.

Also note that this method call terminates the processing of the current request and that it is recommended that a coding style that combines this method call with the return statement, i.e., return ngx.exit(...) be used to reinforce the fact that the request processing is being terminated.

When being used in the contexts of header_filter_by_lua*, balancer_by_lua*, and
ssl_session_store_by_lua*, ngx.exit() is
an asynchronous operation and will return immediately. This behavior may change in future and it is recommended that users always use return in combination as suggested above.

Back to TOC

ngx.eof

syntax: ok, err = ngx.eof()

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Explicitly specify the end of the response output stream. In the case of HTTP 1.1 chunked encoded output, it will just trigger the Nginx core to send out the “last chunk”.

When you disable the HTTP 1.1 keep-alive feature for your downstream connections, you can rely on well written HTTP clients to close the connection actively for you when you call this method. This trick can be used do back-ground jobs without letting the HTTP clients to wait on the connection, as in the following example:


 location = /async {
     keepalive_timeout 0;
     content_by_lua_block {
         ngx.say("got the task!")
         ngx.eof()  -- well written HTTP clients will close the connection at this point
         -- access MySQL, PostgreSQL, Redis, Memcached, and etc here...
     }
 }

But if you create subrequests to access other locations configured by Nginx upstream modules, then you should configure those upstream modules to ignore client connection abortions if they are not by default. For example, by default the standard ngx_http_proxy_module will terminate both the subrequest and the main request as soon as the client closes the connection, so it is important to turn on the proxy_ignore_client_abort directive in your location block configured by ngx_http_proxy_module:


 proxy_ignore_client_abort on;

A better way to do background jobs is to use the ngx.timer.at API.

Since v0.8.3 this function returns 1 on success, or returns nil and a string describing the error otherwise.

Back to TOC

ngx.sleep

syntax: ngx.sleep(seconds)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_client_hello_by_lua*

Sleeps for the specified seconds without blocking. One can specify time resolution up to 0.001 seconds (i.e., one millisecond).

Behind the scene, this method makes use of the Nginx timers.

Since the 0.7.20 release, The 0 time argument can also be specified.

This method was introduced in the 0.5.0rc30 release.

Back to TOC

ngx.escape_uri

syntax: newstr = ngx.escape_uri(str, type?)

context: init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Since v0.10.16, this function accepts an optional type argument.
It accepts the following values (defaults to 2):

  • 0: escapes str as a full URI. And the characters
    (space), #, %,
    ?, 0x00 ~ 0x1F, 0x7F ~ 0xFF will be escaped.
  • 2: escape str as a URI component. All characters except
    alphabetic characters, digits, -, ., _,
    ~ will be encoded as %XX.

Back to TOC

ngx.unescape_uri

syntax: newstr = ngx.unescape_uri(str)

context: init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Unescape str as an escaped URI component.

For example,


 ngx.say(ngx.unescape_uri("b%20r56+7"))

gives the output

b r56 7

Invalid escaping sequences are handled in a conventional way: %s are left unchanged. Also, characters that should not appear in escaped string are simply left unchanged.

For example,


 ngx.say(ngx.unescape_uri("try %search%%20%again%"))

gives the output

try %search% %again%

(Note that %20 following % got unescaped, even it can be considered a part of invalid sequence.)

Back to TOC

ngx.encode_args

syntax: str = ngx.encode_args(table)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_client_hello_by_lua*

Encode the Lua table to a query args string according to the URI encoded rules.

For example,


 ngx.encode_args({foo = 3, ["b r"] = "hello world"})

yields

foo=3&b%20r=hello%20world

The table keys must be Lua strings.

Multi-value query args are also supported. Just use a Lua table for the argument’s value, for example:


 ngx.encode_args({baz = {32, "hello"}})

gives

baz=32&baz=hello

If the value table is empty and the effect is equivalent to the nil value.

Boolean argument values are also supported, for instance,


 ngx.encode_args({a = true, b = 1})

yields

a&b=1

If the argument value is false, then the effect is equivalent to the nil value.

This method was first introduced in the v0.3.1rc27 release.

Back to TOC

ngx.decode_args

syntax: table, err = ngx.decode_args(str, max_args?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Decodes a URI encoded query-string into a Lua table. This is the inverse function of ngx.encode_args.

The optional max_args argument can be used to specify the maximum number of arguments parsed from the str argument. By default, a maximum of 100 request arguments are parsed (including those with the same name) and that additional URI arguments are silently discarded to guard against potential denial of service attacks. Since v0.10.13, when the limit is exceeded, it will return a second value which is the string "truncated".

This argument can be set to zero to remove the limit and to process all request arguments received:


 local args = ngx.decode_args(str, 0)

Removing the max_args cap is strongly discouraged.

This method was introduced in the v0.5.0rc29.

Back to TOC

ngx.encode_base64

syntax: newstr = ngx.encode_base64(str, no_padding?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Encodes str to a base64 digest.

Since the 0.9.16 release, an optional boolean-typed no_padding argument can be specified to control whether the base64 padding should be appended to the resulting digest (default to false, i.e., with padding enabled).

Back to TOC

ngx.decode_base64

syntax: newstr = ngx.decode_base64(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Decodes the str argument as a base64 digest to the raw form. Returns nil if str is not well formed.

Back to TOC

ngx.crc32_short

syntax: intval = ngx.crc32_short(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Calculates the CRC-32 (Cyclic Redundancy Code) digest for the str argument.

This method performs better on relatively short str inputs (i.e., less than 30 ~ 60 bytes), as compared to ngx.crc32_long. The result is exactly the same as ngx.crc32_long.

Behind the scene, it is just a thin wrapper around the ngx_crc32_short function defined in the Nginx core.

This API was first introduced in the v0.3.1rc8 release.

Back to TOC

ngx.crc32_long

syntax: intval = ngx.crc32_long(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Calculates the CRC-32 (Cyclic Redundancy Code) digest for the str argument.

This method performs better on relatively long str inputs (i.e., longer than 30 ~ 60 bytes), as compared to ngx.crc32_short. The result is exactly the same as ngx.crc32_short.

Behind the scene, it is just a thin wrapper around the ngx_crc32_long function defined in the Nginx core.

This API was first introduced in the v0.3.1rc8 release.

Back to TOC

ngx.hmac_sha1

syntax: digest = ngx.hmac_sha1(secret_key, str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Computes the HMAC-SHA1 digest of the argument str and turns the result using the secret key <secret_key>.

The raw binary form of the HMAC-SHA1 digest will be generated, use ngx.encode_base64, for example, to encode the result to a textual representation if desired.

For example,


 local key = "thisisverysecretstuff"
 local src = "some string we want to sign"
 local digest = ngx.hmac_sha1(key, src)
 ngx.say(ngx.encode_base64(digest))

yields the output

R/pvxzHC4NLtj7S+kXFg/NePTmk=

This API requires the OpenSSL library enabled in the Nginx build (usually by passing the --with-http_ssl_module option to the ./configure script).

This function was first introduced in the v0.3.1rc29 release.

Back to TOC

ngx.md5

syntax: digest = ngx.md5(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Returns the hexadecimal representation of the MD5 digest of the str argument.

For example,


 location = /md5 {
     content_by_lua_block { ngx.say(ngx.md5("hello")) }
 }

yields the output

5d41402abc4b2a76b9719d911017c592

See ngx.md5_bin if the raw binary MD5 digest is required.

Back to TOC

ngx.md5_bin

syntax: digest = ngx.md5_bin(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Returns the binary form of the MD5 digest of the str argument.

See ngx.md5 if the hexadecimal form of the MD5 digest is required.

Back to TOC

ngx.sha1_bin

syntax: digest = ngx.sha1_bin(str)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Returns the binary form of the SHA-1 digest of the str argument.

This function requires SHA-1 support in the Nginx build. (This usually just means OpenSSL should be installed while building Nginx).

This function was first introduced in the v0.5.0rc6.

Back to TOC

ngx.quote_sql_str

syntax: quoted_value = ngx.quote_sql_str(raw_value)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, ssl_client_hello_by_lua*

Returns a quoted SQL string literal according to the MySQL quoting rules.

Back to TOC

ngx.today

syntax: str = ngx.today()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns current date (in the format yyyy-mm-dd) from the Nginx cached time (no syscall involved unlike Lua’s date library).

This is the local time.

Back to TOC

ngx.time

syntax: secs = ngx.time()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns the elapsed seconds from the epoch for the current time stamp from the Nginx cached time (no syscall involved unlike Lua’s date library).

Updates of the Nginx time cache can be forced by calling ngx.update_time first.

Back to TOC

ngx.now

syntax: secs = ngx.now()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns a floating-point number for the elapsed time in seconds (including milliseconds as the decimal part) from the epoch for the current time stamp from the Nginx cached time (no syscall involved unlike Lua’s date library).

You can forcibly update the Nginx time cache by calling ngx.update_time first.

This API was first introduced in v0.3.1rc32.

Back to TOC

ngx.update_time

syntax: ngx.update_time()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Forcibly updates the Nginx current time cache. This call involves a syscall and thus has some overhead, so do not abuse it.

This API was first introduced in v0.3.1rc32.

Back to TOC

ngx.localtime

syntax: str = ngx.localtime()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns the current time stamp (in the format yyyy-mm-dd hh:mm:ss) of the Nginx cached time (no syscall involved unlike Lua’s os.date function).

This is the local time.

Back to TOC

ngx.utctime

syntax: str = ngx.utctime()

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns the current time stamp (in the format yyyy-mm-dd hh:mm:ss) of the Nginx cached time (no syscall involved unlike Lua’s os.date function).

This is the UTC time.

Back to TOC

ngx.cookie_time

syntax: str = ngx.cookie_time(sec)

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns a formatted string can be used as the cookie expiration time. The parameter sec is the time stamp in seconds (like those returned from ngx.time).


 ngx.say(ngx.cookie_time(1290079655))
     -- yields "Thu, 18-Nov-10 11:27:35 GMT"

Back to TOC

ngx.http_time

syntax: str = ngx.http_time(sec)

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Returns a formated string can be used as the http header time (for example, being used in Last-Modified header). The parameter sec is the time stamp in seconds (like those returned from ngx.time).


 ngx.say(ngx.http_time(1290079655))
     -- yields "Thu, 18 Nov 2010 11:27:35 GMT"

Back to TOC

ngx.parse_http_time

syntax: sec = ngx.parse_http_time(str)

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Parse the http time string (as returned by ngx.http_time) into seconds. Returns the seconds or nil if the input string is in bad forms.


 local time = ngx.parse_http_time("Thu, 18 Nov 2010 11:27:35 GMT")
 if time == nil then
     ...
 end

Back to TOC

ngx.is_subrequest

syntax: value = ngx.is_subrequest

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*

Returns true if the current request is an Nginx subrequest, or false otherwise.

Back to TOC

ngx.re.match

syntax: captures, err = ngx.re.match(subject, regex, options?, ctx?, res_table?)

context: init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*, exit_worker_by_lua*, ssl_client_hello_by_lua*

Matches the subject string using the Perl compatible regular expression `

lua-upstream-nginx-module, Nginx C 模块将Lua向ngx_lua公开，用于 Nginx upstreams.zip
10-10
lua-upstream-nginx-module, Nginx C 模块将Lua向ngx_lua公开，用于 Nginx upstreams 电子邮件名称ngx_http_lua_upstream - Nginx MODULE，用于向 Nginx upstreams公开Lua到 ngx_lua目录NAME状态概要说明函数get_upstreamsget_ser
nginx 安装nginx_lua模块出现ngx_http_lua_module requires the Lua library
zmjmvp的专栏
08-02 4857
***今天安装nginx模块时一直出现 ngx_http_lua_module requires the Lua library 问题*** 但是我已经安装了lua， 并且在profile 文件中加入了：```shell export LUAJIT_LIB=/usr/local/lib export LUAJIT_INC=/usr/local/include/luajit-2.1 ``` 网上看...
ngx lua模块源码简单解析
囧囧有神的专栏
07-11 1万+
对nginx lua模块的整个流程，原理简单解析。由于nginx lua模块相关配置，指令，API非常多，所以本文档只以content_by_lua指令举例说明。 读本文档最好配合读源码. 不适合对nginx和lua一点都不了解的人看。 1.相关配置 详细配置见 https://github.com/openresty/lua-nginx-module#installation 2
Nginx实战：LUA脚本_环境配置安装
龙叔运维的博客
06-01 3798
Nginx Lua 脚本是 Nginx 与 Lua 语言集成的结果，它允许你使用 Lua 语言编写Nginx 模块，以执行复杂的逻辑、访问后端服务、处理请求和响应等。
nginx_lua_module 模块配置
太#阳%鸟的博客
07-30 1498
想在nginx 做一个拦截转发的事情，刚刚开始想到的是负载均衡，发现负载均衡没有办法获取到请求，根据请求头进行进行转发数据，然后又开始找资料，刚刚好看到一个lua脚本语言配置的nginx的环境。 做为一名躺平程序员竟然要我学习新的知识，我的天啦！！！ 过程实在可怕，于是乎我变成一个拿来主义。通过各种百度 C + V 工程师终于配置好了nginx_lua 模块 查看自己nginx 的编译配置 nginx -V 我的配置是相当简单就一个ssl的配置。后面一系列操作到现在的lua满配操作。 TLS SNI.
lua-nginx-module-0.10.13
07-18
Lua-Nginx-Module，简称lua-nginx-module，是Nginx服务器的一个重要扩展模块，它将强大的Lua脚本语言集成到Nginx中，允许用户在Nginx配置文件中直接编写Lua代码，极大地增强了Nginx的功能性和灵活性。版本0.10.13是...
lua-nginx-module-master.zip
05-12
这个"lua-nginx-module-master.zip"压缩包包含了该模块的源代码，是安装和自定义Nginx与Lua集成的关键组件。 在深入讲解之前，先来了解一下Nginx。Nginx是一款高性能的HTTP和反向代理服务器，以其轻量级、高并发...
lua-nginx-module-0.10.9rc7
01-04
1. **获取源码**：从官方仓库或镜像站点下载lua-nginx-module-0.10.9rc7的压缩包，并解压到工作目录。 2. **编译Nginx**：在编译Nginx时，需要将lua-nginx-module源码路径作为参数传递给`--add-module`选项。同时，...
Nginx安装lua-nginx-module模块的方法步骤
09-19
ngx_lua_module，也被称为lua-nginx-module，是一个强大的Nginx HTTP模块，它将Lua解析器集成到了Nginx服务器中，使得用户可以利用Lua语言编写高性能的Web应用和服务。这个模块提供了丰富的API，用于处理HTTP请求、...
安装nginx+lua时提示：./configure: error: ngx_http_lua_module requires the Lua library.
热门推荐
阳光梦的专栏
08-11 2万+
    上回在安装nginx+lua时过程中，在执行./configure命令时提示错误： error: ngx_http_lua_module requires the Lua library，而我确实已经安装luajit(LuaJIT：LuaJIT is a Just-In-Time Compiler (JIT) for the  Lua programming language. lua的高...
ng_lua环境搭建
qinyushuang的专栏
02-03 3583
前言： ngx_lua_module 是一个nginx http模块，它把 lua 解析器内嵌到 nginx，用来解析并执行lua 语言编写的网页后台脚本。 特性： 支持Windows和Linux平台。 支持高并发高性能。 HTML网页中内嵌LUA脚本代码，类似于PHP。 支持非阻塞的数据库操作，目前只支持MYSQL。 支持异步的文件IO操作。 支持非阻塞的SOCKET IO操作。
OpenResty 介绍与实战讲解（nginx&lua）
匠人精神，持之以恒！
02-18 3322
OpenResty是一个基于 Nginx与Lua的高性能Web平台，其内部集成了大量精良的Lua库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态Web应用、Web服务和动态网关。简单地说OpenResty的目标是让你的Web服务直接跑在 Nginx 服务内部，充分利用 Nginx 的非阻塞 I/O 模型，不仅仅对 HTTP 客户端请求,甚至于对远程后端诸如 MySQL、PostgreSQL、Memcached 以及 Redis 等都进行一致的高性能响应。Nginx。
科普文：软件架构Nginx系列之【nginx + lua 应用场景】
最新发布
为无为，事无事，味无味。
08-25 2150
ngx_lua是Nginx的一个模块，将Lua嵌入到Nginx中，从而可以使用Lua来编写脚本，这样就可以使用Lua编写应用脚本，部署到Nginx中运行，即Nginx变成了一个Web容器。注：Tengine也包含ngx_lua模块。至于二者的区别：OpenResty是Nginx的Bundle；而Tengine则是Nginx的Fork。ngx_lua模块的原理：1、每个worker（工作进程）创建一个Lua VM，worker内所有协程共享VM；
nginx上安装lua并执行lua脚本
janthinasnail的博客
12-12 3982
（写在前面：以下是在centos7系统进行安装） 一、安装lua # 安装依赖 yum -y install gcc+ gcc-c++ readline-devel # 下载LuaJIT wget http://luajit.org/download/LuaJIT-2.0.4.tar.gz # 解压 tar -xf LuaJIT-2.0.4.tar.gz # 进入目录 cd LuaJIT-2.0.4 # 安装 make install PREFIX=/usr/local/LuaJIT ..
nginx + lua
xu_ya_fei的专栏
02-10 7297
--nignx lua 终于要考虑在nginx下使用lua啊啦，这里首先不得不提的就是lua-nginx-module了，nginx_lua_module是由淘宝的工程师清无（王晓哲）和春来（章亦春）所开发的nginx第三方模块,它能将lua语言嵌入到nginx配置中,从而使用lua就极大增强了nginx的能力，ngx_lua_module 是一个nginx http模块，它把 lua 解析器内
tengine安装ngx_http_lua_module
weixin_33971977的博客
04-17 732
从http://luajit.org/download.html下载的luajit来安装tengine上，启动时报错如下 nginx: [alert] detected a LuaJIT version which is not OpenResty's; many optimizations will be disabled and performance will be compromis...
nginx中添加lua模块
m0_38130105的博客
03-11 8608
nginx 中添加 lua 模块，支持lua脚本一...
Nginx模块Lua-Nginx-Module学习笔记（一）Nginx Lua API 接口详解
Tinywan
03-12 1126
源码地址：https://github.com/Tinywan/Lua-Nginx-Redis 一、介绍 　　各种* _by_lua，* _by_lua_block和* _by_lua_file配置指令用作nginx.conf文件中Lua API的网关。 下面描述的Nginx Lua API只能在这些配置指令的上下文中运行的用户Lua代码中调用。API以两个标准软件包ngx和ndk的形式...
nginx编译lua模块必需文件：lua-nginx-module解析
从给定的文件信息中，可以得知该压缩包名为“lua-nginx-module-master.zip”，其内容是关于Lua模块与Nginx集成的必需文件集合。这个模块的作用是在Nginx中嵌入Lua脚本，从而使得Nginx能够执行Lua语言编写的脚本代码...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值