mod_lua.xml revision 890b9ed4c432913c66d39ef44823c2ec5f63fbe8
fb51a6b789d85113d0976148685b0063c294220drbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
77a0265761f1bec2aaa0b4116c644f8066e349e3rbowen<!-- $LastChangedRevision$ -->
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Licensed to the Apache Software Foundation (ASF) under one or more
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen contributor license agreements. See the NOTICE file distributed with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen this work for additional information regarding copyright ownership.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen The ASF licenses this file to You under the Apache License, Version 2.0
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen (the "License"); you may not use this file except in compliance with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen the License. You may obtain a copy of the License at
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Unless required by applicable law or agreed to in writing, software
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen distributed under the License is distributed on an "AS IS" BASIS,
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen See the License for the specific language governing permissions and
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen limitations under the License.
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<description>Provides Lua hooks into various portions of the httpd
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenrequest processing</description>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>This module allows the server to be extended with scripts written in the
889dc1728817c1c56d0c8d894c768614e346d86ecovenerLua programming language. The extension points (hooks) available with
889dc1728817c1c56d0c8d894c768614e346d86ecovener<module>mod_lua</module> include many of the hooks available to
889dc1728817c1c56d0c8d894c768614e346d86ecovenernatively compiled Apache HTTP Server modules, such as mapping requests to
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimfiles, generating dynamic responses, access control, authentication, and
889dc1728817c1c56d0c8d894c768614e346d86ecovenerauthorization</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>More information on the Lua programming language can be found at the
889dc1728817c1c56d0c8d894c768614e346d86ecovener<a href="http://www.lua.org/">the Lua website</a>.</p>
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirier<note><code>mod_lua</code> is still in experimental state.
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierUntil it is declared stable, usage and behavior may change
8ad875ad9725307fd052e36abc2938f89f56902csfat any time, even between stable releases of the 2.4.x series.
8ad875ad9725307fd052e36abc2938f89f56902csfBe sure to check the CHANGES file before upgrading.</note>
e19685ea3d8a2a0754a532b464a3d194c9f9a429humbedooh<p>This module holds a great deal of power over httpd, which is both a
ededb790277bba8f7ae292b5385aecc7ac433105humbedoohstrength and a potential security risk. It is <strong>not</strong> recommended
09a561bcc5c1159de86edf7e644cc9777636211ahumbedoohthat you use this module on a server that is shared with users you do not
e19685ea3d8a2a0754a532b464a3d194c9f9a429humbedoohtrust, as it can be abused to change the internal workings of httpd.</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<section id="basicconf"><title>Basic Configuration</title>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenwhich can be used with an <code>AddHandler</code> directive:</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenAddHandler lua-script .lua
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierThis will cause <code>mod_lua</code> to handle requests for files
92e5d4326ae44f79da5cb049470daba604506846poirier<p>For more flexibility, see <directive>LuaMapHandler</directive>.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghandlers"><title>Writing Handlers</title>
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p> In the Apache HTTP Server API, the handler is a specific kind of hook
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimresponsible for generating the response. Examples of modules that include a
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
92e5d4326ae44f79da5cb049470daba604506846poirier-- example handler
92e5d4326ae44f79da5cb049470daba604506846poirierrequire "string"
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim This is the default method name for Lua handlers, see the optional
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim function-name in the LuaMapHandler directive to choose a different
cf7d90693f7579700c4f7e663adb83196f903df1covener entry point.
cf7d90693f7579700c4f7e663adb83196f903df1covenerfunction handle(r)
92e5d4326ae44f79da5cb049470daba604506846poirier r:puts("Hello Lua World!\n")
92e5d4326ae44f79da5cb049470daba604506846poirier if r.method == 'GET' then
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parseargs() ) do
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh r:puts( string.format("%s: %s\n", k, v) )
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.method == 'POST' then
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parsebody() ) do
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh r:puts( string.format("%s: %s\n", k, v) )
e1fcc3befbb69aab09018a6b8fe15d8816a16076humbedooh r:puts("Unsupported HTTP method " .. r.method)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis handler function just prints out the uri or form encoded
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis means (and in fact encourages) that you can have multiple
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandlers (or hooks, or filters) in the same script.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p><module>mod_authz_core</module> provides a high-level interface to
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfauthorization that is much easier to use than using into the relevant
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfhooks directly. The first argument to the
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directive module="mod_authz_core">Require</directive> directive gives
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfthe name of the responsible authorization provider. For any
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directive module="mod_authz_core">Require</directive> line,
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<module>mod_authz_core</module> will call the authorization provider
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfof the given name, passing the rest of the line as parameters. The
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfprovider will then check authorization and pass the result as return
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The authz provider is normally called before authentication. If it needs to
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfknow the authenticated user name (or if the user will be authenticated at
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfall), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfThis will cause authentication to proceed and the authz provider to be
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfcalled a second time.</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The following authz provider function takes two arguments, one ip
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfaddress and one user name. It will allow access from the given ip address
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfwithout authentication, or if the authenticated user matches the second
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfargument:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfrequire 'apache2'
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sffunction authz_check_foo(r, ip, user)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf if r.useragent_ip == ip then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf elseif r.user == nil then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf elseif r.user == user then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The following configuration registers this function as provider
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<code>foo</code> and configures it for URL <code>/</code>:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfLuaAuthzProvider foo authz_provider.lua authz_check_foo
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<Location />
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf Require foo 10.1.2.3 john_doe
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</Location>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier<section id="writinghooks"><title>Writing Hooks</title>
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p>Hook functions are how modules (and Lua scripts) participate in the
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimprocessing of requests. Each type of hook exposed by the server exists for
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jima specific purposes such as mapping requests to the filesystem,
889dc1728817c1c56d0c8d894c768614e346d86ecovenerperforming access control, or setting mimetypes. General purpose hooks
889dc1728817c1c56d0c8d894c768614e346d86ecovenerthat simply run at handy times in the request lifecycle exist as well.</p>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>Hook functions are passed the request object as their only argument.
92e5d4326ae44f79da5cb049470daba604506846poirierThey can return any value, depending on the hook, but most commonly
92e5d4326ae44f79da5cb049470daba604506846poirierthey'll return OK, DONE, or DECLINED, which you can write in lua as
92e5d4326ae44f79da5cb049470daba604506846poirier<code>apache2.OK</code>, <code>apache2.DONE</code>, or
92e5d4326ae44f79da5cb049470daba604506846poirier<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
bb57315f942d09c744543fe41e453bd0181fd93ecovener-- example hook that rewrites the URI to a filesystem path.
bb57315f942d09c744543fe41e453bd0181fd93ecovenerrequire 'apache2'
bb57315f942d09c744543fe41e453bd0181fd93ecovenerfunction translate_name(r)
bb57315f942d09c744543fe41e453bd0181fd93ecovener if r.uri == "/translate-name" then
bb57315f942d09c744543fe41e453bd0181fd93ecovener -- we don't care about this URL, give another module a chance
bb57315f942d09c744543fe41e453bd0181fd93ecovener--[[ example hook that rewrites one URI to another URI. It returns a
bb57315f942d09c744543fe41e453bd0181fd93ecovener apache2.DECLINED to give other URL mappers a chance to work on the
bb57315f942d09c744543fe41e453bd0181fd93ecovener substitution, including the core translate_name hook which maps based
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim on the DocumentRoot.
bb57315f942d09c744543fe41e453bd0181fd93ecovener Note: It is currently undefined as to whether this runs before or after
92e5d4326ae44f79da5cb049470daba604506846poirierrequire 'apache2'
92e5d4326ae44f79da5cb049470daba604506846poirierfunction translate_name(r)
92e5d4326ae44f79da5cb049470daba604506846poirier if r.uri == "/translate-name" then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="datastructures"><title>Data Structures</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <p>The request_rec is mapped in as a userdata. It has a metatable
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen which lets you do useful things with it. For the most part it
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim has the same fields as the request_rec struct (see httpd.h
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen until we get better docs here) many of which are writeable as
92e5d4326ae44f79da5cb049470daba604506846poirier well as readable. (The table fields' content can be changed, but the
92e5d4326ae44f79da5cb049470daba604506846poirier fields themselves cannot be set to different tables.)</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <p>The request_rec has (at least) the following methods:</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:addoutputfilter(name|function) -- add an output filter
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </highlight>
65305d236fe992253daa6ee6b3176a8e0e2d87e1humbedooh r:parseargs() -- returns a Lua table containing the request's query string arguments
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </highlight>
65305d236fe992253daa6ee6b3176a8e0e2d87e1humbedooh r:parsebody() -- parse any POST data in the request and return it as a Lua table
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("hello", " world", "!") -- print to response body
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:write("a single string") -- print to response body
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="logging"><title>Logging Functions</title>
92e5d4326ae44f79da5cb049470daba604506846poirier -- examples of logging messages<br />
b60ba9fb00026d3dbca744c6c19afe63cba3a3d1covener r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:debug("This is a debug log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:info("This is an info log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:notice("This is an notice log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:warn("This is an warn log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:err("This is an err log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:alert("This is an alert log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:crit("This is an crit log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:emerg("This is an emerg log message")<br />
92e5d4326ae44f79da5cb049470daba604506846poirier<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant OK. Handlers should return this if they've
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handled the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant DECLINED. Handlers should return this if
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier they are not going to handle the request.</dd>
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <dd>internal constants used by <module>mod_proxy</module></dd>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>(Other HTTP status codes are not yet implemented.)</p>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Specify the base path for resolving relative paths for mod_lua directives</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the base path which will be used to evaluate all
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier relative paths within mod_lua. If not specified they
fb51a6b789d85113d0976148685b0063c294220drbowen will be resolved relative to the current working directory,
fb51a6b789d85113d0976148685b0063c294220drbowen which may not always work well for a server.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
7b65675e5144193ad34c8ea7fc68e27c51f8ef1bhumbedooh<description>One of once, request, conn -- default is once</description>
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh<syntax>LuaScope once|request|conn|thread [max|min max]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the lifecycle scope of the Lua interpreter which will
c994f52ac80f9664d2940e5ccd9e77466572013frbowen be used by handlers in this "Directory." The default is "once"</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <dt>request:</dt> <dd>use the interpreter to handle anything based on
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim the same file within this request, which is also
c994f52ac80f9664d2940e5ccd9e77466572013frbowen request scoped.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh handling the request.</dd>
7b65675e5144193ad34c8ea7fc68e27c51f8ef1bhumbedooh<!-- not implemented
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>server:</dt> <dd>This one is different than others because the
fb51a6b789d85113d0976148685b0063c294220drbowen server scope is quite long lived, and multiple threads
fb51a6b789d85113d0976148685b0063c294220drbowen will have the same server_rec. To accommodate this
fb51a6b789d85113d0976148685b0063c294220drbowen server scoped interpreter are stored in an apr
fb51a6b789d85113d0976148685b0063c294220drbowen resource list. The min and max arguments are intended
c994f52ac80f9664d2940e5ccd9e77466572013frbowen to specify the pool size, but are unused at this time.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Map a path to a lua handler</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This directive matches a uri pattern to invoke a specific
fb51a6b789d85113d0976148685b0063c294220drbowen handler function in a specific file. It uses PCRE regular
fb51a6b789d85113d0976148685b0063c294220drbowen expressions to match the uri, and supports interpolating
fb51a6b789d85113d0976148685b0063c294220drbowen match groups into both the file path and the function name
fb51a6b789d85113d0976148685b0063c294220drbowen be careful writing your regular expressions to avoid security
fb51a6b789d85113d0976148685b0063c294220drbowen issues.</p>
fb926c8c319705c9fe42d55a6ad13d9b0972cb72humbedooh LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen handler function handle_show on the lua vm after
fb51a6b789d85113d0976148685b0063c294220drbowen loading that file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would invoke the "handle" function, which
fb51a6b789d85113d0976148685b0063c294220drbowen is the default if no specific function name is
fb51a6b789d85113d0976148685b0063c294220drbowen provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.path</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Add a path to lua's module search path. Follows the same
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim conventions as lua. This just munges the package.path in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.cpath</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Add a path to lua's shared library search path. Follows the same
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim conventions as lua. This just munges the package.cpath in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Configure the compiled code cache.</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen Specify the behavior of the in-memory code cache. The default
fb51a6b789d85113d0976148685b0063c294220drbowen is stat, which stats the top level script (not any included
fb51a6b789d85113d0976148685b0063c294220drbowen ones) each time that file is needed, and reloads it if the
fb51a6b789d85113d0976148685b0063c294220drbowen modified time indicates it is newer than the one it has
fb51a6b789d85113d0976148685b0063c294220drbowen already loaded. The other values cause it to keep the file
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim cached forever (don't stat and replace) or to never cache the
92e5d4326ae44f79da5cb049470daba604506846poirier <p>In general stat or forever is good for production, and stat or never
3a602d0ba8536a79a780655bb92133b571e38378poirier for development.</p>
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache stat
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache forever
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache never
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the translate name phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
fb51a6b789d85113d0976148685b0063c294220drbowen Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
fb51a6b789d85113d0976148685b0063c294220drbowen request processing. The hook function receives a single
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim argument, the request_rec, and should return a status code,
fb51a6b789d85113d0976148685b0063c294220drbowen which is either an HTTP error code, or the constants defined
fb51a6b789d85113d0976148685b0063c294220drbowen in the apache2 module: apache2.OK, apache2.DECLINED, or
fb51a6b789d85113d0976148685b0063c294220drbowen <p>For those new to hooks, basically each hook will be invoked
fb51a6b789d85113d0976148685b0063c294220drbowen until one of them returns apache2.OK. If your hook doesn't
fb51a6b789d85113d0976148685b0063c294220drbowen want to do the translation it should just return
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DECLINED. If the request should stop processing, then
92e5d4326ae44f79da5cb049470daba604506846poirierLuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
92e5d4326ae44f79da5cb049470daba604506846poirierrequire "apache2"
92e5d4326ae44f79da5cb049470daba604506846poirierfunction silly_mapper(r)
92e5d4326ae44f79da5cb049470daba604506846poirier if r.uri == "/" then
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Context</title><p>This directive is not valid in <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Directory</directive>, <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Files</directive>, or htaccess
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh<description>Provide a hook for the fixups phase of a request
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenprocessing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the map_to_storage phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh <p>Like <directive>LuaHookTranslateName</directive> but executed at the
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh map-to-storage phase of a request. Modules like mod_cache run at this phase,
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh which makes for an interesting example on what to do here:
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh LuaHookMapToStorage /path/to/lua/script.lua check_cache
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh </highlight>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohrequire"apache2"
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohcached_files = {}
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction read_file(filename)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local input = io.open(filename, "r")
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if input then
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local data = input:read("*a")
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh cached_files[filename] = data
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh file = cached_files[filename]
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh input:close()
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return cached_files[filename]
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction check_cache(r)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if r.filename:match("%.png$") then -- Only match PNG files
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local file = cached_files[r.filename] -- Check cache entries
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if not file then
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh file = read_file(r.filename) -- Read file into cache
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if file then -- If file exists, write it out
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh r:write(file)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh r:info(("Sent %s to client from cache"):format(r.filename))
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return apache2.DONE -- skip default handler for PNG files
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return apache2.DECLINED -- If we had nothing to do, let others serve this.
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the check_user_id phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the type_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the auth_checker phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<p>Invoke a lua function in the auth_checker phase of processing
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poiriera request. This can be used to implement arbitrary authentication
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierand authorization checking. A very simple example:
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierrequire 'apache2'
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- fake authcheck hook
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- If request has no auth info, set the response header and
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- return a 401 to ask the browser for basic auth info.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- If request has auth info, don't actually look at it, just
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- pretend we got userid 'foo' and validated it.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- Then check if the userid is 'foo' and accept the request.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierfunction authcheck_hook(r)
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier -- look for auth info
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier auth = r.headers_in['Authorization']
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier if auth ~= nil then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier -- fake the user
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier if r.user == nil then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug("authcheck: user is nil, returning 401")
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier elseif r.user == "foo" then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug('user foo: OK')
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug("authcheck: user='" .. r.user .. "'")
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the access_checker phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>Add your hook to the access_checker phase. An access checker
92e5d4326ae44f79da5cb049470daba604506846poirierhook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the insert_filter phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<description>Controls how parent configuration sections are merged into children</description>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<syntax>LuaInherit none|parent-first|parent-last</syntax>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<contextlist><context>server config</context><context>virtual host</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<context>directory</context><context>.htaccess</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</contextlist>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener <usage><p>By default, if LuaHook* directives are used in overlapping
ae600ca541efc686b34f8b1f21bd3d0741d37674covener Directory or Location configuration sections, the scripts defined in the
ae600ca541efc686b34f8b1f21bd3d0741d37674covener more specific section are run <em>after</em> those defined in the more
ae600ca541efc686b34f8b1f21bd3d0741d37674covener generic section (LuaInherit parent-first). You can reverse this order, or
ae600ca541efc686b34f8b1f21bd3d0741d37674covener make the parent context not apply at all.</p>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener <p> In previous 2.3.x releases, the default was effectively to ignore LuaHook*
ae600ca541efc686b34f8b1f21bd3d0741d37674covener directives from parent configuration sections.</p></usage>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the quick handler of request processing</description>
35b6187510aac978a1e2a242560ef5fff9f09e8ehumbedooh<syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
448a4db8228c5b9f6c1d3693e7a6b07b8b2b0c5erjung<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Context</title><p>This directive is not valid in <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Directory</directive>, <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Files</directive>, or htaccess
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</directivesynopsis>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directivesynopsis>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<description>Plug an authorization provider function into <module>mod_authz_core</module>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</description>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<contextlist><context>server config</context> </contextlist>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>After a lua function has been registered as authorization provider, it can be used
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfwith the <directive module="mod_authz_core">Require</directive> directive:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfLuaAuthzProvider foo authz.lua authz_check_foo
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<Location />
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh Require foo johndoe
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</Location>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohrequire "apache2"
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction authz_check_foo(r, who)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen</modulesynopsis>