]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_lua.xml.fr
Updates.
[apache] / docs / manual / mod / mod_lua.xml.fr
1 <?xml version="1.0"?>
2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision : 1375917 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
7
8 <!--
9  Licensed to the Apache Software Foundation (ASF) under one or more
10  contributor license agreements.  See the NOTICE file distributed with
11  this work for additional information regarding copyright ownership.
12  The ASF licenses this file to You under the Apache License, Version 2.0
13  (the "License"); you may not use this file except in compliance with
14  the License.  You may obtain a copy of the License at
15
16      http://www.apache.org/licenses/LICENSE-2.0
17
18  Unless required by applicable law or agreed to in writing, software
19  distributed under the License is distributed on an "AS IS" BASIS,
20  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  See the License for the specific language governing permissions and
22  limitations under the License.
23 -->
24
25 <modulesynopsis metafile="mod_lua.xml.meta">
26
27 <name>mod_lua</name>
28
29 <description>Fournit des points d'entr&eacute;e Lua dans diff&eacute;rentes parties du
30 traitement des requ&ecirc;tes httpd</description>
31 <status>Experimental</status>
32 <sourcefile>mod_lua.c</sourcefile>
33 <identifier>lua_module</identifier>
34 <compatibility>versions 2.3 et sup&eacute;rieures</compatibility>
35
36 <summary>
37 <p>Ce module permet d'ajouter au serveur des extensions sous forme de
38 scripts &eacute;crits dans le langage de programmation Lua.
39 <module>mod_lua</module> fournit de nombreuses extensions
40 (hooks) disponibles avec les modules natifs du serveur HTTP Apache,
41 comme les associations de requ&ecirc;tes &agrave; des fichiers, la g&eacute;n&eacute;ration de
42 r&eacute;ponses dynamiques, le contr&ocirc;le d'acc&egrave;s, l'authentification et
43 l'autorisation.</p>
44
45 <p>Vous trouverez davantage d'informations &agrave; propos du langage de
46 programmation Lua sur <a href="http://www.lua.org/">le site web de
47 Lua</a>.</p>
48
49 <note><code>mod_lua</code> est encore au stade exp&eacute;rimental. Son mode
50 d'utilisation et son comportement pourront changer &agrave; tout moment jusqu'&agrave;
51 ce qu'il passe au stade stable, et ce m&ecirc;me entre deux versions stables
52 2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise &agrave;
53 jour.</note>
54
55 <note type="warning"><title>Avertissement</title>
56 <p>Ce module poss&egrave;de une grande capacit&eacute; d'action sur le fonctrionnement
57 de httpd, ce qui lui conf&egrave;re une grande puissance, mais peut aussi
58 induire un risque de s&eacute;curit&eacute;. Il est d&eacute;conseill&eacute; d'utiliser ce module
59 sur un serveur partag&eacute; avec des utilisateurs auxquels vous ne pouvez pas
60 accorder une confiance absolue, car il peut permettre de modifier le
61 fonctionnement interne de httpd.</p>
62 </note>
63
64 </summary>
65
66 <section id="basicconf"><title>Configuration de base</title>
67
68 <p>La directive de base pour le chargement du module est</p>
69
70 <highlight language="config">
71     LoadModule lua_module modules/mod_lua.so
72 </highlight>
73
74 <p>
75 <code>mod_lua</code> fournit un gestionnaire nomm&eacute;
76 <code>lua-script</code> qui peut &ecirc;tre utilis&eacute; avec une directive
77 <code>AddHandler</code> :</p>
78
79 <highlight language="config">
80 AddHandler lua-script .lua
81 </highlight>
82
83 <p>
84 Ceci aura pour effet de faire traiter les requ&ecirc;tes pour les fichiers
85 dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
86 invoquant cette fonction de <code>gestion</code> de fichier.
87 </p>
88
89 <p>Pour plus de d&eacute;tails, voir la directive
90 <directive>LuaMapHandler</directive>.
91  </p>
92 </section>
93
94 <section id="writinghandlers"><title>Ecrire des gestionnaires</title>
95 <p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
96 point d'accroche (hook) sp&eacute;cifique responsable de la g&eacute;n&eacute;ration de la
97 r&eacute;ponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
98 <module>mod_status</module> sont des exemples de modules comportant un
99 gestionnaire.</p>
100
101 <p><code>mod_lua</code> cherche toujours &agrave; invoquer une fonction Lua pour le
102 gestionnaire, plut&ocirc;t que de simplement &eacute;valuer le corps d'un script dans
103 le style de CGI. Une fonction de gestionnaire se pr&eacute;sente comme suit :</p>
104
105
106 <highlight language="lua">
107 <strong>example.lua</strong><br/>
108 -- exemple de gestionnaire
109
110 require "string"
111
112 --[[
113      Il s'agit du nom de m&eacute;thode par d&eacute;faut pour les gestionnaires Lua ;
114      voir les noms de fonctions optionnels dans la directive
115      LuaMapHandler pour choisir un point d'entr&eacute;e diff&eacute;rent.
116 --]]
117 function handle(r)
118     r.content_type = "text/plain"
119     r:puts("Hello Lua World!\n")
120
121     if r.method == 'GET' then
122         for k, v in pairs( r:parseargs() ) do
123             r:puts( string.format("%s: %s\n", k, v) )
124         end
125     elseif r.method == 'POST' then
126         for k, v in pairs( r:parsebody() ) do
127             r:puts( string.format("%s: %s\n", k, v) )
128         end
129     else
130         r:puts("Unsupported HTTP method " .. r.method)
131     end
132 end
133 </highlight>
134
135 <p>
136 Ce gestionnaire se contente d'afficher les arguments cod&eacute;s d'un uri ou
137 d'un formulaire dans un page au format texte.
138 </p>
139
140 <p>
141 Cela signifie que vous pouvez (et &ecirc;tes encourag&eacute; &agrave;) avoir plusieurs
142 gestionnaires (ou points d'entr&eacute;e, ou filtres) dans le m&ecirc;me script.
143 </p>
144
145 </section>
146 <section id="writingauthzproviders">
147 <title>Ecriture de fournisseurs d'autorisation</title>
148
149 <p><module>mod_authz_core</module> fournit une interface d'autorisation
150 de haut niveau bien plus facile &agrave; utiliser que dans les hooks
151 correspondants. Le premier argument de la directive <directive
152 module="mod_authz_core">Require</directive> permet de sp&eacute;cifier le
153 fournisseur d'autorisation &agrave; utiliser. Pour chaque directive <directive
154 module="mod_authz_core">Require</directive>,
155 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
156 sp&eacute;cifi&eacute;, le reste de la ligne constituant les param&egrave;tres. Le
157 fournisseur consid&eacute;r&eacute; va alors v&eacute;rifier les autorisations et fournir le
158 r&eacute;sultat dans une valeur de retour.</p>
159
160 <p>En g&eacute;n&eacute;ral, le fournisseur authz est appel&eacute; avant l'authentification.
161 S'il doit conna&icirc;tre le nom d'utilisateur authentifi&eacute; (ou si
162 l'utilisateur est appel&eacute; &agrave; &ecirc;tre authentifi&eacute;), le fournisseur doit
163 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
164 d&eacute;clancher le processus d'authentification et un deuxi&egrave;me appel du
165 fournisseur authz.</p>
166
167 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
168 une adresse IP et un nom d'utilisateur. Elle autorise l'acc&egrave;s dans le
169 cas o&ugrave; la requ&ecirc;te provient de l'adresse IP sp&eacute;cifi&eacute;e, ou si
170 l'utilisateur authentifi&eacute; correspond au second argument :</p>
171
172 <highlight language="lua">
173 <strong>authz_provider.lua</strong><br/>
174
175 require 'apache2'
176
177 function authz_check_foo(r, ip, user)
178     if r.useragent_ip == ip then
179         return apache2.AUTHZ_GRANTED
180     elseif r.user == nil then
181         return apache2.AUTHZ_DENIED_NO_USER
182     elseif r.user == user then
183         return apache2.AUTHZ_GRANTED
184     else
185         return apache2.AUTHZ_DENIED
186     end
187 end
188 </highlight>
189
190 <p>La configuration suivante enregistre cette fonction en tant que
191 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
192 <highlight language="config">
193 LuaAuthzProvider foo authz_provider.lua authz_check_foo
194 &lt;Location /&gt;
195   Require foo 10.1.2.3 john_doe
196 &lt;/Location&gt;
197 </highlight>
198
199 </section>
200
201 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
202 (hooks)</title>
203
204 <p>Les fonctions d'accroche d&eacute;terminent la mani&egrave;re dont les modules (et
205 les scripts Lua) participent au traitement des requ&ecirc;tes. Chaque type
206 d'accroche propos&eacute; par le serveur a un r&ocirc;le sp&eacute;cifique, comme
207 l'association de requ&ecirc;tes au syst&egrave;me de fichiers, le contr&ocirc;le d'acc&egrave;s,
208 ou la d&eacute;finition de types MIME : </p>
209
210 <table border="1" style="zebra">
211     <tr>
212         <th>Phase d'accroche</th>
213         <th>Directive mod_lua</th>
214         <th>Description</th>
215     </tr>
216     <tr>
217         <td>Gestionnaire rapide</td>
218         <td><directive module="mod_lua">LuaQuickHandler</directive></td>
219         <td>Il s'agit de la premi&egrave;re accroche appel&eacute;e lorsqu'une requ&ecirc;te
220         a &eacute;t&eacute; associ&eacute;e &agrave; un serveur ou un serveur virtuel.</td>
221     </tr>
222     <tr>
223         <td>Phase de traduction</td>
224         <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
225         <td>Cette phase traduit l'URI de la requ&ecirc;te en nom de fichier
226         sur le syst&egrave;me. Ce sont des modules comme
227         <module>mod_alias</module> et <module>mod_rewrite</module> qui
228         interviennent au cours de cette phase.</td>
229     </tr>
230     <tr>
231         <td>Choix du lieu de stockage de la ressource</td>
232         <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
233         <td>Cette phase d&eacute;finit le lieu de stockage de la ressource :
234         physique, en cache ou externe/mandat&eacute;. Elle est assur&eacute;e par les
235         modules de mandat ou de mise en cache.</td>
236     </tr>
237     <tr>
238         <td>Autorisation d'acc&egrave;s</td>
239         <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
240         <td>Cette phase v&eacute;rifie si un client a l'autorisation d'acc&egrave;s &agrave;
241         la ressource. Elle s'ex&eacute;cute avant l'authentification de
242         l'utisateur ; il faut donc &ecirc;tre prudent.
243         </td>
244     </tr>
245     <tr>
246         <td>V&eacute;rification de l'identifiant utilisateur</td>
247         <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
248         <td>Cette phase v&eacute;rifie l'identifiant de l'utilisateur ayant
249         fait l'objet d'une n&eacute;gociation.</td>
250     </tr>
251     <tr>
252         <td>V&eacute;rification de l'autorisation d'acc&egrave;s</td>
253         <td><directive module="mod_lua">LuaHookAuthChecker</directive>
254         ou
255             <directive module="mod_lua">LuaAuthzProvider</directive></td>
256         <td>Cette phase v&eacute;rifie l'autorisation d'acc&egrave;s d'un utilisateur
257         en fonction des ses param&egrave;tres de connexion, comme
258         l'identifiant, le certificat, etc...
259         </td>
260     </tr>
261     <tr>
262         <td>V&eacute;rification du type de la ressource</td>
263         <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
264         <td>Cette phase assigne un type de contenu et un gestionnaire &agrave;
265         la ressource.</td>
266     </tr>
267     <tr>
268         <td>Derniers r&eacute;glages</td>
269         <td><directive module="mod_lua">LuaHookFixups</directive></td>
270         <td>C'est la derni&egrave;re phase avant l'activation des gestionnaires
271         de contenu. Toute modification de derni&egrave;re minute &agrave; la requ&ecirc;te
272         doit &ecirc;tre effectu&eacute;e ici.</td>
273     </tr>
274     <tr>
275         <td>Gestionnaire de contenu</td>
276         <td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
277         <td>C'est durant cette phase que le contenu est trait&eacute;. Les
278         fichiers sont lus, interpr&eacute;t&eacute;s, certains sont ex&eacute;cut&eacute;s, et le
279         r&eacute;sultat obtenu est envoy&eacute; au client.</td>
280     </tr>
281     <tr>
282         <td>Journalisation</td>
283         <td>aucune</td>
284         <td>Lorsqu'une requ&ecirc;te a &eacute;t&eacute; trait&eacute;e, plusieurs phases de
285         journalisation interviennent, et enregistrent leurs r&eacute;sultats
286         dans les fichiers d'erreur ou d'acc&egrave;s.</td>
287     </tr>
288
289 </table>
290
291 <p>Les fonctions d'accroche re&ccedil;oivent l'objet de la requ&ecirc;te comme seul
292 argument (sauf LuaAuthzProvider qui re&ccedil;oit aussi des arguments en
293 provenance de la directive Require). Elles peuvent renvoyer une valeur,
294 selon la fonction, mais il s'agit en g&eacute;n&eacute;ral d'un
295 code d'&eacute;tat HTTP ou des valeurs OK, DONE, ou DECLINED,
296 que vous pouvez &eacute;crire dans lua sous la forme <code>apache2.OK</code>,
297 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
298
299
300 <highlight language="lua">
301 <strong>translate_name.lua</strong><br/>
302 -- exemple d'accroche qui r&eacute;&eacute;crit un URI en chemin du syst&egrave;me de
303 fichiers.
304
305 require 'apache2'
306
307 function translate_name(r)
308     if r.uri == "/translate-name" then
309         r.filename = r.document_root .. "/find_me.txt"
310         return apache2.OK
311     end
312     -- on ne g&egrave;re pas cette URL et on donne sa chance &agrave; un autre module
313     return apache2.DECLINED
314 end
315 </highlight>
316
317
318 <highlight language="lua">
319 <strong>translate_name2.lua</strong><br/>
320 --[[ exemple d'accroche qui r&eacute;&eacute;crit un URI vers un autre URI. Il renvoie
321         un apache2.DECLINED pour permettre &agrave; un autre interpr&eacute;teur d'URL de
322         travailler sur la substitution, y compris l'accroche translate_name
323         de base dont les tables de correspondances se basent sur DocumentRoot.
324
325      Note: utilisez le drapeau early/late de la directive pour
326      l'ex&eacute;cuter avant ou apr&egrave;s mod_alias.
327 --]]
328
329 require 'apache2'
330
331 function translate_name(r)
332     if r.uri == "/translate-name" then
333         r.uri = "/find_me.txt"
334         return apache2.DECLINED
335     end
336     return apache2.DECLINED
337 end
338 </highlight>
339 </section>
340
341 <section id="datastructures"><title>Structures de donn&eacute;es</title>
342
343 <dl>
344 <dt>request_rec</dt>
345         <dd>
346         <p>request_rec est consid&eacute;r&eacute;e en tant que donn&eacute;e utilisateur.
347         Elle poss&egrave;de une m&eacute;tatable qui vous permet d'accomplir des
348         choses int&eacute;ressantes. Pour la plus grande partie, elle poss&egrave;de
349         les m&ecirc;mes champs que la structure request_rec, la
350         plupart d'entre eux &eacute;tant accessibles en lecture et &eacute;criture (le
351         contenu des champs de la table peut &ecirc;tre modifi&eacute;, mais les
352         champs eux-m&ecirc;mes ne peuvent pas &ecirc;tre &eacute;tablis en tant que tables
353         distinctes).</p>
354
355         <table border="1" style="zebra">
356
357         <tr>
358           <th><strong>Nom</strong></th>
359           <th><strong>Type Lua</strong></th>
360           <th><strong>Modifiable</strong></th>
361           <th><strong>Description</strong></th>
362         </tr>
363         <tr>
364           <td><code>allowoverrides</code></td>
365           <td>string</td>
366           <td>non</td>
367           <td>L'option AllowOverride s'applique &agrave; la requ&ecirc;te courante.</td>
368         </tr>
369         <tr>
370           <td><code>ap_auth_type</code></td>
371           <td>string</td>
372           <td>non</td>
373           <td>Ce champ contient le type d'authentification effectu&eacute;e
374           (par exemple <code>basic</code>)</td>
375         </tr>
376         <tr>
377           <td><code>args</code></td>
378           <td>string</td>
379           <td>oui</td>
380           <td>La cha&icirc;ne de param&egrave;tres de la requ&ecirc;te (par exemple
381           <code>foo=bar&amp;name=johnsmith</code>)</td>
382         </tr>
383         <tr>
384           <td><code>assbackwards</code></td>
385           <td>boolean</td>
386           <td>non</td>
387           <td>contient true s'il s'agit d'une requ&ecirc;te de style HTTP/0.9
388           (par exemple <code>GET /foo</code> (sans champs d'en-t&ecirc;te) )</td>
389         </tr>
390         <tr>
391           <td><code>auth_name</code></td>
392           <td>string</td>
393           <td>non</td>
394           <td>La cha&icirc;ne d'identification utilis&eacute;e pour la v&eacute;rification
395           de l'autorisation d'acc&egrave;s (si elle est disponible).</td>
396         </tr>
397         <tr>
398           <td><code>banner</code></td>
399           <td>string</td>
400           <td>non</td>
401           <td>La banni&egrave;re du serveur, par exemple <code>Apache HTTP
402           Server/2.4.3 openssl/0.9.8c</code></td>
403         </tr>
404         <tr>
405           <td><code>basic_auth_pw</code></td>
406           <td>string</td>
407           <td>non</td>
408           <td>Le mot de passe pour l'authentification de base envoy&eacute;
409           avec la requ&ecirc;te, s'il existe</td>
410         </tr>
411         <tr>
412           <td><code>canonical_filename</code></td>
413           <td>string</td>
414           <td>non</td>
415           <td>Le nom de fichier canonique de la requ&ecirc;te</td>
416         </tr>
417         <tr>
418           <td><code>content_encoding</code></td>
419           <td>string</td>
420           <td>non</td>
421           <td>Le type de codage du contenu de la requ&ecirc;te courante</td>
422         </tr>
423         <tr>
424           <td><code>content_type</code></td>
425           <td>string</td>
426           <td>oui</td>
427           <td>Le type de contenu de la requ&ecirc;te courante, tel qu'il a &eacute;t&eacute;
428           d&eacute;termin&eacute; au cours de la phase type_check (par exemple
429           <code>image/gif</code> ou <code>text/html</code>)</td>
430         </tr>
431
432         <tr>
433           <td><code>context_prefix</code></td>
434           <td>string</td>
435           <td>non</td>
436           <td></td>
437         </tr>
438         <tr>
439           <td><code>context_document_root</code></td>
440           <td>string</td>
441           <td>non</td>
442           <td></td>
443         </tr>
444
445         <tr>
446           <td><code>document_root</code></td>
447           <td>string</td>
448           <td>non</td>
449           <td>La racine des documents du serveur</td>
450         </tr>
451         <tr>
452           <td><code>err_headers_out</code></td>
453           <td>table</td>
454           <td>non</td>
455           <td>L'en-t&ecirc;te MIME de l'environnement pour la r&eacute;ponse, &eacute;crit
456           m&ecirc;me en cas d'erreur et conserv&eacute; pendant les redirections
457           internes</td>
458         </tr>
459         <tr>
460           <td><code>filename</code></td>
461           <td>string</td>
462           <td>oui</td>
463           <td>Le nom de fichier correspondant &agrave; la requ&ecirc;te, par exemple
464           /www/example.com/foo.txt. Il peut &ecirc;tre modifi&eacute; au cours des
465           phases translate-name ou map-to-storage du traitement de la
466           requ&ecirc;te pour permettre au gestionnaire par d&eacute;faut (ou aux
467           gestionnaires de script) de servir une version du fichier
468           autre que celle demand&eacute;e.</td>
469         </tr>
470         <tr>
471           <td><code>handler</code></td>
472           <td>string</td>
473           <td>oui</td>
474           <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
475           doit traiter la requ&ecirc;te, par exemple <code>lua-script</code>
476           si elle doit &ecirc;tre trait&eacute;e par mod_lua. Cette valeur est en
477           g&eacute;n&eacute;ral d&eacute;finie via les directives <directive
478           module="mod_mime">AddHandler</directive> ou <directive
479           module="core">SetHandler</directive>, mais peut aussi l'&ecirc;tre
480           via mod_lua pour permettre &agrave; un autre gestionnaire de traiter
481           une requ&ecirc;te sp&eacute;cifique qui ne serait pas trait&eacute;e par d&eacute;faut
482           par ce dernier.
483             </td>
484         </tr>
485         <tr>
486           <td><code>headers_in</code></td>
487           <td>table</td>
488           <td>oui</td>
489           <td>Les en-t&ecirc;tes MIME de l'environnement de la requ&ecirc;te. Il
490           s'agit des en-t&ecirc;tes comme <code>Host, User-Agent,
491           Referer</code>, etc...</td>
492         </tr>
493         <tr>
494           <td><code>headers_out</code></td>
495           <td>table</td>
496           <td>oui</td>
497           <td>Les en-t&ecirc;tes MIME de l'environnement de la r&eacute;ponse.</td>
498         </tr>
499         <tr>
500           <td><code>hostname</code></td>
501           <td>string</td>
502           <td>non</td>
503           <td>Le nom d'h&ocirc;te, tel que d&eacute;fini par l'en-t&ecirc;te
504           <code>Host:</code> ou par un URI complet.</td>
505         </tr>
506         <tr>
507           <td><code>is_https</code></td>
508           <td>boolean</td>
509           <td>non</td>
510           <td>Indique si la requ&ecirc;te &agrave; &eacute;t&eacute; faite via HTTPS</td>
511         </tr>
512         <tr>
513           <td><code>is_initial_req</code></td>
514           <td>boolean</td>
515           <td>non</td>
516           <td>Indique si la requ&ecirc;te courante est la requ&ecirc;te initiale ou
517           une sous-requ&ecirc;te.</td>
518         </tr>
519         <tr>
520           <td><code>limit_req_body</code></td>
521           <td>number</td>
522           <td>non</td>
523           <td>La taille maximale du corps de la requ&ecirc;te, ou 0 si aucune
524           limite.</td>
525         </tr>
526         <tr>
527         <td><code>log_id</code></td>
528           <td>string</td>
529           <td>non</td>
530           <td>L'identifiant de la requ&ecirc;te dans les journaux d'acc&egrave;s ou
531           d'erreur.</td>
532         </tr>
533         <tr>
534           <td><code>method</code></td>
535           <td>string</td>
536           <td>non</td>
537           <td>La m&eacute;thode de la requ&ecirc;te, par exemple <code>GET</code> ou
538           <code>POST</code>.</td>
539         </tr>
540         <tr>
541           <td><code>notes</code></td>
542           <td>table</td>
543           <td>oui</td>
544           <td>Une liste de notes qui peuvent &ecirc;tre transmises d'un module
545           &agrave; l'autre.</td>
546         </tr>
547         <tr>
548           <td><code>options</code></td>
549           <td>string</td>
550           <td>non</td>
551           <td>La valeur de la directive Options pour la requ&ecirc;te
552           courante.</td>
553         </tr>
554         <tr>
555           <td><code>path_info</code></td>
556           <td>string</td>
557           <td>non</td>
558           <td>La valeur de PATH_INFO extraite de la requ&ecirc;te.</td>
559         </tr>
560         <tr>
561           <td><code>port</code></td>
562           <td>number</td>
563           <td>non</td>
564           <td>Le port du serveur utilis&eacute; par la requ&ecirc;te.</td>
565         </tr>
566         <tr>
567           <td><code>protocol</code></td>
568           <td>string</td>
569           <td>non</td>
570           <td>Le protocole utilis&eacute;, par exemple <code>HTTP/1.1</code></td>
571         </tr>
572         <tr>
573           <td><code>proxyreq</code></td>
574           <td>string</td>
575           <td>oui</td>
576           <td>Indique s'il s'agit d'une requ&ecirc;te mandat&eacute;e ou non. Cette
577           valeur est en g&eacute;n&eacute;ral d&eacute;finie au cours de la phase
578           post_read_request/translate_name du traitement de la requ&ecirc;te.</td>
579         </tr>
580         <tr>
581           <td><code>range</code></td>
582           <td>string</td>
583           <td>non</td>
584           <td>Le contenu de l'en-t&ecirc;te <code>Range:</code>.</td>
585         </tr>
586         <tr>
587           <td><code>remaining</code></td>
588           <td>number</td>
589           <td>non</td>
590           <td>Le nombre d'octets du corps de la requ&ecirc;te restant &agrave; lire.</td>
591         </tr>
592         <tr>
593           <td><code>server_built</code></td>
594           <td>string</td>
595           <td>non</td>
596           <td>La date de compilation du serveur.</td>
597         </tr>
598         <tr>
599           <td><code>server_name</code></td>
600           <td>string</td>
601           <td>non</td>
602           <td>Le nom du serveur pour cette requ&ecirc;te.</td>
603         </tr>
604         <tr>
605           <td><code>some_auth_required</code></td>
606           <td>boolean</td>
607           <td>non</td>
608           <td>Indique si une autorisation est/&eacute;tait requise pour cette
609           requ&ecirc;te.</td>
610         </tr>
611         <tr>
612           <td><code>subprocess_env</code></td>
613           <td>table</td>
614           <td>oui</td>
615           <td>Le jeu de variables d'environnement pour cette requ&ecirc;te.</td>
616         </tr>
617         <tr>
618           <td><code>started</code></td>
619           <td>number</td>
620           <td>non</td>
621           <td>Le moment o&ugrave; le serveur a &eacute;t&eacute; (re)d&eacute;marr&eacute;, en secondes
622           depuis epoch (1er janvier 1970)</td>
623         </tr>
624         <tr>
625           <td><code>status</code></td>
626           <td>number</td>
627           <td>oui</td>
628           <td>Le code de retour (courant) pour cette requ&ecirc;te, par
629           exemple <code>200</code> ou <code>404</code>.</td>
630         </tr>
631         <tr>
632           <td><code>the_request</code></td>
633           <td>string</td>
634           <td>non</td>
635           <td>La cha&icirc;ne de la requ&ecirc;te telle qu'elle a &eacute;t&eacute; envoy&eacute;e par le
636           client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
637         </tr>
638         <tr>
639           <td><code>unparsed_uri</code></td>
640           <td>string</td>
641           <td>non</td>
642           <td>La partie URI non interpr&eacute;t&eacute;e de la requ&ecirc;te</td>
643         </tr>
644         <tr>
645           <td><code>uri</code></td>
646           <td>string</td>
647           <td>oui</td>
648           <td>L'URI apr&egrave;s interpr&eacute;tation par httpd</td>
649         </tr>
650         <tr>
651           <td><code>user</code></td>
652           <td>string</td>
653           <td>oui</td>
654           <td>Si une authentification a &eacute;t&eacute; effectu&eacute;e, nom de
655           l'utilisateur authentifi&eacute;.</td>
656         </tr>
657         <tr>
658           <td><code>useragent_ip</code></td>
659           <td>string</td>
660           <td>non</td>
661           <td>L'adresse IP de l'agent qui a envoy&eacute; la requ&ecirc;te</td>
662         </tr>
663         </table>
664
665         <p>La structure request_rec poss&egrave;de (au minimum) les m&eacute;thodes
666         suivantes :</p>
667
668         <highlight language="lua">
669         r:flush() -- vide le tampon de sortie
670         </highlight>
671
672         <highlight language="lua">
673         r:addoutputfilter(name|function) -- ajoute un filtre en sortie
674         </highlight>
675
676         <highlight language="lua">
677         r:sendfile(filename) -- envoie un fichier entier au client en
678         utilisant sendfile s'il est support&eacute; par la plateforme
679         </highlight>
680
681         <highlight language="lua">
682         r:parseargs() -- renvoie une table Lua contenant la cha&icirc;ne
683         d'arguments de la requ&ecirc;te
684         </highlight>
685
686
687         <highlight language="lua">
688         r:parsebody()([sizeLimit]) -- interpr&egrave;te le corps de la requ&ecirc;te
689         en tant que POST et renvoie une table lua. Un nombre optionnel
690         peut &ecirc;tre fourni pour sp&eacute;cifier le nombre maximal d'octets &agrave;
691         interpr&eacute;ter. La valeur par d&eacute;faut est 8192.
692         </highlight>
693
694
695         <highlight language="lua">
696         r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la r&eacute;ponse
697         </highlight>
698
699         <highlight language="lua">
700         r:write("une simple cha&icirc;ne") -- affichage dans le
701         corps de la r&eacute;ponse
702         </highlight>
703
704         <highlight language="lua">
705         r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Echappe le
706         code HTML et renvoie le r&eacute;sultat
707         </highlight>
708         </dd>
709     </dl>
710
711 </section>
712
713 <section id="logging"><title>Fonctions de journalisation</title>
714
715 <highlight language="lua">
716         -- exemples de messages de journalisation
717         r:trace1("Ceci est un message de journalisation de niveau
718         trace") -- les niveaux valides vont de trace1 &agrave; trace8 <br />
719         r:debug("Ceci est un message de journalisation de niveau debug")<br />
720         r:info("Ceci est un message de journalisation de niveau info")<br />
721         r:notice("Ceci est un message de journalisation de niveau notice")<br />
722         r:warn("Ceci est un message de journalisation de niveau warn")<br />
723         r:err("Ceci est un message de journalisation de niveau err")<br />
724         r:alert("Ceci est un message de journalisation de niveau alert")<br />
725         r:crit("Ceci est un message de journalisation de niveau crit")<br />
726         r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
727 </highlight>
728
729 </section>
730
731 <section id="apache2"><title>Paquet apache2</title>
732 <p>Le paquet nomm&eacute; <code>apache2</code> est fourni avec (au minimum) le
733 contenu suivant :</p>
734 <dl>
735   <dt>apache2.OK</dt>
736   <dd>Constante interne OK. Les gestionnaires renverront cette valeur
737   s'ils ont trait&eacute; la requ&ecirc;te.</dd>
738   <dt>apache2.DECLINED</dt>
739   <dd>Constante interne DECLINED. Les gestionnaires renverront cette
740   valeur s'ils n'ont pas l'intention de traiter la requ&ecirc;te.</dd>
741   <dt>apache2.DONE</dt>
742   <dd>Constante interne DONE.</dd>
743   <dt>apache2.version</dt>
744   <dd>Cha&icirc;ne contenant la version du serveur HTTP Apache</dd>
745   <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
746   <dd>Code d'&eacute;tat HTTP</dd>
747   <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
748   <dd>Constantes internes utilis&eacute;es par <module>mod_proxy</module></dd>
749   <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
750   <dd>constantes internes utilis&eacute;es par <module>mod_authz_core</module></dd>
751
752 </dl>
753 <p>Les autres codes d'&eacute;tat HTTP ne sont pas encore impl&eacute;ment&eacute;s.</p>
754 </section>
755
756
757
758 <directivesynopsis>
759 <name>LuaRoot</name>
760 <description>Sp&eacute;cifie le chemin de base pour la r&eacute;solution des chemins
761 relatifs dans les directives de mod_lua</description>
762 <syntax>LuaRoot /chemin/vers/un/r&eacute;pertoire</syntax>
763 <contextlist><context>server config</context><context>virtual host</context>
764 <context>directory</context><context>.htaccess</context>
765 </contextlist>
766 <override>All</override>
767
768 <usage>
769     <p>Cette directive permet de sp&eacute;cifier le chemin de base qui sera
770     utilis&eacute; pour &eacute;valuer tous les chemins relatifs dans mod_lua. En
771     l'absence de cette directive, les chemins relatifs sont r&eacute;solus par
772     rapport au r&eacute;pertoire de travail courant, ce qui ne sera pas
773     toujours appropri&eacute; pour un serveur.</p>
774 </usage>
775 </directivesynopsis>
776
777 <directivesynopsis>
778 <name>LuaScope</name>
779 <description>Une valeur parmi once, request, conn, thread -- la valeur
780 par d&eacute;faut est once</description>
781 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
782 <default>LuaScope once</default>
783 <contextlist><context>server config</context><context>virtual host</context>
784 <context>directory</context><context>.htaccess</context>
785 </contextlist>
786 <override>All</override>
787
788 <usage>
789     <p>Cette directive permet de sp&eacute;cifier la dur&eacute;e de vie de
790     l'interpr&eacute;teur Lua qui sera utilis&eacute; dans ce "r&eacute;pertoire". La valeur
791     par d&eacute;faut est "once".</p>
792
793    <dl>
794     <dt>once:</dt> <dd>utilise l'interpr&eacute;teur une fois.</dd>
795
796     <dt>request:</dt> <dd>utilise l'interpr&eacute;teur pour traiter tout ce
797     qui est bas&eacute; sur le m&ecirc;me fichier dans la requ&ecirc;te, et qui se trouve
798     aussi dans la port&eacute;e de la requ&ecirc;te.</dd>
799
800     <dt>conn:</dt> <dd>idem request, mais attach&eacute; &agrave; connection_rec</dd>
801
802     <dt>thread:</dt> <dd>Utilise l'interpr&eacute;teur pendant toute la dur&eacute;e
803     de vie du thread qui traite la requ&ecirc;te (disponible seulement avec
804     les MPMs thread&eacute;s).</dd>
805
806     <dt>server:</dt>  <dd>Le comportement est ici diff&eacute;rent, car la
807     port&eacute;e du serveur pr&eacute;sente une dur&eacute;e de vie assez longue, et
808     plusieurs threads vont partager le m&ecirc;me server_rec. Pour g&eacute;rer tout
809     ceci, les &eacute;tats lua du serveur sont stock&eacute;s dans une liste de ressources
810     apr. Les arguments <code>min</code> et <code>max</code> permettent
811     de sp&eacute;cifier les nombres minimaux et maximaux d'&eacute;tats lua &agrave; stocker
812     dans la liste.</dd>
813    </dl>
814    <p>En g&eacute;n&eacute;ral, les port&eacute;es <code>thread</code> et <code>server</code>
815    sont 2 &agrave; 3 fois plus rapides que les autres, car elles n'ont pas besoin
816    de r&eacute;g&eacute;n&eacute;rer de nouveaux &eacute;tats Lua &agrave; chaque requ&ecirc;te (comme c'est le
817    cas avec le MPM event, o&ugrave; m&ecirc;me les connexions persistantes utilisent un
818    nouveau thread pour chaque requ&ecirc;te). Si vous pensez que vos scripts
819    n'auront pas de probl&egrave;me s'il r&eacute;utilisent un &eacute;tat, alors les port&eacute;es
820    <code>thread</code> ou <code>server</code> doivent &ecirc;tre utilis&eacute;es car
821    elles pr&eacute;senteront de meilleures performances. Alors que la port&eacute;e
822    <code>thread</code> fournira les r&eacute;ponses les plus rapides, la port&eacute;e
823    <code>server</code> utilisera moins de m&eacute;moire car les &eacute;tats sont
824    rassembl&eacute;s dans des jeux, permettant par exemple &agrave; 1000 threads de
825    partager 100 &eacute;tats Lua, ne n&eacute;cessitant ainsi que 10% de la m&eacute;moire
826    requise par la port&eacute;e <code>thread</code>.
827     </p>
828 </usage>
829 </directivesynopsis>
830
831 <directivesynopsis>
832 <name>LuaMapHandler</name>
833 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
834 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
835 [nom-fonction]</syntax>
836 <contextlist><context>server config</context><context>virtual host</context>
837 <context>directory</context><context>.htaccess</context>
838 </contextlist>
839 <override>All</override>
840 <usage>
841     <p>Cette directive permet de faire correspondre un mod&egrave;le d'uri avec
842     une fonction de gestionnaire situ&eacute;e dans un fichier sp&eacute;cifique. Elle
843     utilise les expressions rationnelles PCRE pour mettre en
844     correspondance l'uri, et supporte les groupes de correspondance
845     d'interpolation dans le chemin du fichier et le nom de la fonction.
846     Prenez garde aux probl&egrave;mes de s&eacute;curit&eacute; en &eacute;crivant vos expressions
847     rationnelles.</p>
848    <example><title>Exemples :</title>
849     <highlight language="config">
850     LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
851     </highlight>
852    </example>
853         <p>Cette directive va faire correspondre des uri comme
854         /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
855         fonction de gestionnaire handle_show au niveau de la vm lua
856         apr&egrave;s chargement de ce fichier.</p>
857
858 <highlight language="config">
859     LuaMapHandler /bingo /scripts/wombat.lua
860 </highlight>
861         <p>Cette directive invoquera la fonction "handle" qui est la
862         valeur par d&eacute;faut si aucun nom de fonction sp&eacute;cifique n'est
863         sp&eacute;cifi&eacute;.</p>
864 </usage>
865 </directivesynopsis>
866
867 <directivesynopsis>
868 <name>LuaPackagePath</name>
869 <description>Ajoute un r&eacute;pertoire au package.path de lua</description>
870 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
871 <contextlist><context>server config</context><context>virtual host</context>
872 <context>directory</context><context>.htaccess</context>
873 </contextlist>
874 <override>All</override>
875     <usage><p>Cette directive permet d'ajouter un chemin &agrave; la liste des
876     chemins de recherche du module lua. Elle suit les m&ecirc;mes conventions
877     que lua. Ceci modifie le package.path dans les vms lua.</p>
878
879     <example><title>Exemples :</title>
880         <highlight language="config">
881 LuaPackagePath /scripts/lib/?.lua
882 LuaPackagePath /scripts/lib/?/init.lua
883     </highlight>
884     </example>
885 </usage>
886 </directivesynopsis>
887
888 <directivesynopsis>
889 <name>LuaPackageCPath</name>
890 <description>Ajoute un r&eacute;pertoire au package.cpath de lua</description>
891 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
892 <contextlist><context>server config</context><context>virtual host</context>
893 <context>directory</context><context>.htaccess</context>
894 </contextlist>
895 <override>All</override>
896
897 <usage>
898     <p>Cette directive permet d'ajouter un chemin &agrave; la liste des chemins
899     de recherche des biblioth&egrave;ques partag&eacute;es de lua. Ceci modifie le
900     package.cpath dans les vms lua.</p>
901
902 </usage>
903 </directivesynopsis>
904
905 <directivesynopsis>
906 <name>LuaCodeCache</name>
907 <description>Configure le cache de code compil&eacute;.</description>
908 <syntax>LuaCodeCache stat|forever|never</syntax>
909 <default>LuaCodeCache stat</default>
910 <contextlist>
911 <context>server config</context><context>virtual host</context>
912 <context>directory</context><context>.htaccess</context>
913 </contextlist>
914 <override>All</override>
915
916 <usage><p>
917     Cette directive permet de d&eacute;finir le comportement du cache de code
918     en m&eacute;moire. La valeur par d&eacute;faut est stat ; dans ce cas, le script
919     du niveau le plus haut (et pas les scripts inclus) est v&eacute;rifi&eacute; &agrave;
920     chaque fois que ce fichier est n&eacute;cessaire, et est recharg&eacute; si la
921     date de modification est plus r&eacute;cente que celle du script d&eacute;j&agrave;
922     charg&eacute;. Les autres valeurs permettent respectivement de garder le
923     fichier en cache perp&eacute;tuellement (forever - jamais v&eacute;rifi&eacute; ni
924     remplac&eacute;), ou de ne jamais le mettre en cache (never).</p>
925
926     <p>En g&eacute;n&eacute;ral, les valeurs stat et forever sont utilis&eacute;es pour un
927     serveur en production, et les valeurs stat ou never pour un serveur
928     en d&eacute;veloppement.</p>
929
930     <example><title>Exemples :</title>
931         <highlight language="config">
932 LuaCodeCache stat
933 LuaCodeCache forever
934 LuaCodeCache never
935     </highlight>
936     </example>
937
938 </usage>
939 </directivesynopsis>
940
941 <directivesynopsis>
942 <name>LuaHookTranslateName</name>
943 <description>Fournit un point d'entr&eacute;e &agrave; la phase du nom de
944 traduction du traitement de la requ&ecirc;te</description>
945 <syntax>LuaHookTranslateName  /chemin/vers/lua/script.lua  nom_fonction_hook [early|late]</syntax>
946 <contextlist><context>server config</context><context>virtual host</context>
947 </contextlist>
948 <override>All</override>
949 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
950 version 2.3.15 du serveur HTTP Apache.</compatibility>
951
952 <usage><p>
953     Cette directive permet d'ajouter un point d'entr&eacute;e (&agrave;
954     APR_HOOK_MIDDLE) &agrave; la phase du nom de traduction du traitement de la
955     requ&ecirc;te. La fonction hook accepte un seul argument, le request_rec,
956     et doit renvoyer un code d'&eacute;tat qui est soit un code d'erreur HTTP,
957     ou une constante d&eacute;finie dans le module apache2 :  apache2.OK,
958     apache2.DECLINED, ou apache2.DONE.</p>
959
960     <p>Pour ceux qui ne sont pas familiers avec les points d'entr&eacute;e
961     (hook), en gros, chaque hook sera invoqu&eacute; jusqu'&agrave; ce que l'un
962     d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
963     traduction, il doit juste renvoyer apache2.DECLINED. Si le
964     traitement de la requ&ecirc;te doit &ecirc;tre interrompu, la valeur renvoy&eacute;e
965     doit &ecirc;tre apache2.DONE.</p>
966
967     <p>Exemple :</p>
968
969 <highlight language="config">
970 # httpd.conf
971 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
972 </highlight>
973
974 <highlight language="lua">
975 -- /scripts/conf/hooks.lua --
976 require "apache2"
977 function silly_mapper(r)
978     if r.uri == "/" then
979         r.filename = "/var/www/home.lua"
980         return apache2.OK
981     else
982         return apache2.DECLINED
983     end
984 end
985 </highlight>
986
987    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
988    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
989    module="core">Directory</directive> ou <directive type="section"
990    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
991
992    <note><title>Ordonnancement</title><p>Les arguments optionnels
993    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
994    s'ex&eacute;cute par rapport aux autres modules.</p></note>
995 </usage>
996 </directivesynopsis>
997
998 <directivesynopsis>
999 <name>LuaHookFixups</name>
1000 <description>Fournit un point d'entr&eacute;e pour la phase de correction du
1001 traitement de la requ&ecirc;te</description>
1002 <syntax>LuaHookFixups  /chemin/vers/lua/script.lua hook_function_name</syntax>
1003 <contextlist><context>server config</context><context>virtual host</context>
1004 <context>directory</context><context>.htaccess</context>
1005 </contextlist>
1006 <override>All</override>
1007 <usage>
1008 <p>
1009     Idem LuaHookTranslateName, mais s'ex&eacute;cute durant la phase de
1010     correction.
1011 </p>
1012 </usage>
1013 </directivesynopsis>
1014
1015 <directivesynopsis>
1016 <name>LuaHookMapToStorage</name>
1017 <description>Fournit un point d'entr&eacute;e pour la phase map_to_storage du
1018 traitement de la requ&ecirc;te</description>
1019 <syntax>LuaHookMapToStorage  /chemin/vers/lua/script.lua hook_function_name</syntax>
1020 <contextlist><context>server config</context><context>virtual host</context>
1021 <context>directory</context><context>.htaccess</context>
1022 </contextlist>
1023 <override>All</override>
1024     <usage>
1025     <p>Identique &agrave; la directive
1026     <directive>LuaHookTranslateName</directive>, mais s'ex&eacute;cute &agrave; la
1027     phase map-to-storage du traitement de la requ&ecirc;te. Les modules comme
1028     mod_cache agissent pendant cette phase, ce qui permet de pr&eacute;senter
1029     un exemple int&eacute;ressant de ce que l'on peut faire ici :</p>
1030     <highlight language="config">
1031     LuaHookMapToStorage /path/to/lua/script.lua check_cache
1032     </highlight>
1033     <highlight language="lua">
1034 require"apache2"
1035 cached_files = {}
1036
1037 function read_file(filename) 
1038     local input = io.open(filename, "r")
1039     if input then
1040         local data = input:read("*a")
1041         cached_files[filename] = data
1042         file = cached_files[filename]
1043         input:close()
1044     end
1045     return cached_files[filename]
1046 end
1047
1048 function check_cache(r)
1049     if r.filename:match("%.png$") then -- Only match PNG files
1050         local file = cached_files[r.filename] -- Check cache entries
1051         if not file then
1052             file = read_file(r.filename)  -- Read file into cache
1053         end
1054         if file then -- If file exists, write it out
1055             r.status = 200
1056             r:write(file)
1057             r:info(("Sent %s to client from cache"):format(r.filename))
1058             return apache2.DONE -- skip default handler for PNG files
1059         end
1060     end
1061     return apache2.DECLINED -- If we had nothing to do, let others serve this.
1062 end
1063     </highlight>
1064
1065     </usage>
1066 </directivesynopsis>
1067
1068 <directivesynopsis>
1069 <name>LuaHookCheckUserID</name>
1070 <description>Fournit un point d'entr&eacute;e pour la phase check_user_id du
1071 traitement de la requ&ecirc;te</description>
1072 <syntax>LuaHookCheckUserID  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1073 <contextlist><context>server config</context><context>virtual host</context>
1074 <context>directory</context><context>.htaccess</context>
1075 </contextlist>
1076 <override>All</override>
1077 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1078 version 2.3.15 du serveur HTTP Apache.</compatibility>
1079 <usage><p>...</p>
1080    <note><title>Ordonnancement</title><p>Les arguments optionnels
1081    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1082    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1083 </usage>
1084 </directivesynopsis>
1085
1086 <directivesynopsis>
1087 <name>LuaHookTypeChecker</name>
1088 <description>Fournit un point d'entr&eacute;e pour la phase type_checker du
1089 traitement de la requ&ecirc;te</description>
1090 <syntax>LuaHookTypeChecker  /chemin/vers/lua/script.lua hook_function_name</syntax>
1091 <contextlist><context>server config</context><context>virtual host</context>
1092 <context>directory</context><context>.htaccess</context>
1093 </contextlist>
1094 <override>All</override>
1095     <usage><p>...</p></usage>
1096 </directivesynopsis>
1097
1098 <directivesynopsis>
1099 <name>LuaHookAuthChecker</name>
1100 <description>Fournit un point d'entr&eacute;e pour la phase auth_checker du
1101 traitement de la requ&ecirc;te</description>
1102 <syntax>LuaHookAuthChecker  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1103 <contextlist><context>server config</context><context>virtual host</context>
1104 <context>directory</context><context>.htaccess</context>
1105 </contextlist>
1106 <override>All</override>
1107 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1108 version 2.3.15 du serveur HTTP Apache.</compatibility>
1109     <usage>
1110 <p>Invoque une fonction lua au cours de la phase auth_checker du
1111 traitement de la requ&ecirc;te. Cette directive peut s'utiliser pour
1112 impl&eacute;menter une v&eacute;rification arbitraire de l'authentification et de
1113 l'autorisation. Voici un exemple tr&egrave;s simple :
1114 </p>
1115 <highlight language="lua">
1116 require 'apache2'
1117
1118 -- fonction d'accroche authcheck fictive
1119 -- Si la requ&ecirc;te ne contient aucune donn&eacute;e d'authentification, l'en-t&ecirc;te
1120 -- de la r&eacute;ponse est d&eacute;fini et un code 401 est renvoy&eacute; afin de demander au
1121 -- navigateur d'effectuer une authentification basique. Si la requ&ecirc;te
1122 -- comporte des donn&eacute;es d'authentification, elles ne sont pas vraiment
1123 -- consult&eacute;es, mais on admet la prise en compte de l'utilisateur 'foo' et
1124 -- on la valide. On v&eacute;rifie ensuite si l'utilisateur est bien 'foo' et on
1125 -- accepte la requ&ecirc;te.
1126 function authcheck_hook(r)
1127
1128    -- recherche des informations d'authentification
1129    auth = r.headers_in['Authorization']
1130    if auth ~= nil then
1131      -- d&eacute;finition d'un utilisateur par d&eacute;faut
1132      r.user = 'foo'
1133    end
1134
1135    if r.user == nil then
1136       r:debug("authcheck: user is nil, returning 401")
1137       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1138       return 401
1139    elseif r.user == "foo" then
1140       r:debug('user foo: OK')
1141    else
1142       r:debug("authcheck: user='" .. r.user .. "'")
1143       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1144       return 401
1145    end
1146    return apache2.OK
1147 end
1148 </highlight>
1149 <note><title>Ordonnancement</title><p>Les arguments optionnels
1150    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1151    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1152 </usage>
1153 </directivesynopsis>
1154
1155 <directivesynopsis>
1156 <name>LuaHookAccessChecker</name>
1157 <description>Fournit un point d'entr&eacute;e pour la phase access_checker du
1158 traitement de la requ&ecirc;te</description>
1159 <syntax>LuaHookAccessChecker  /chemin/vers/lua/script.lua  hook_function_name [early|late]</syntax>
1160 <contextlist><context>server config</context><context>virtual host</context>
1161 <context>directory</context><context>.htaccess</context>
1162 </contextlist>
1163 <override>All</override>
1164 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1165 version 2.3.15 du serveur HTTP Apache.</compatibility>
1166
1167 <usage>
1168 <p>Ajoute votre fonction d'accroche &agrave; la phase access_checker. Une
1169 fonction d'accroche access checker renvoie en g&eacute;n&eacute;ral OK, DECLINED, ou
1170 HTTP_FORBIDDEN.</p>
1171 <note><title>Ordonnancement</title><p>Les arguments optionnels
1172    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1173    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1174 </usage>
1175 </directivesynopsis>
1176 <directivesynopsis>
1177 <name>LuaHookInsertFilter</name>
1178 <description>Fournit un point d'entr&eacute;e pour la phase insert_filter du
1179 traitement de la requ&ecirc;te</description>
1180 <syntax>LuaHookInsertFilter  /chemin/vers/lua/script.lua hook_function_name</syntax>
1181 <contextlist><context>server config</context><context>virtual host</context>
1182 <context>directory</context><context>.htaccess</context>
1183 </contextlist>
1184 <override>All</override>
1185     <usage><p>Non encore impl&eacute;ment&eacute;</p></usage>
1186 </directivesynopsis>
1187
1188 <directivesynopsis>
1189 <name>LuaInherit</name>
1190 <description>Contr&ocirc;le la mani&egrave;re dont les sections de configuration
1191 parentes sont fusionn&eacute;es dans les enfants</description>
1192 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1193 <default>LuaInherit parent-first</default>
1194 <contextlist><context>server config</context><context>virtual host</context>
1195 <context>directory</context><context>.htaccess</context>
1196 </contextlist>
1197 <override>All</override>
1198 <compatibility>Versions 2.4.0 et sup&eacute;rieures</compatibility>
1199     <usage><p>Par d&eacute;faut, si des directives LuaHook* se trouvent dans
1200     des sections de configuration Directory ou Location qui se
1201     chevauchent, les scripts
1202     d&eacute;finis dans les sections les plus sp&eacute;cifiques s'ex&eacute;cutent
1203     <em>apr&egrave;s</em> ceux d&eacute;finis dans les sections plus g&eacute;n&eacute;riques
1204     (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1205     en sorte que le contexte parent ne s'applique pas du tout.</p>
1206
1207     <p>Jusqu'aux versions 2.3.x, le comportement par d&eacute;faut consistait &agrave;
1208     ignorer les directives LuaHook* situ&eacute;es dans les sections de
1209     configuration parentes.</p></usage>
1210 </directivesynopsis>
1211
1212 <directivesynopsis>
1213 <name>LuaQuickHandler</name>
1214 <description>Fournit un point d'entr&eacute;e pour la gestion rapide du
1215 traitement de la requ&ecirc;te</description>
1216 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1217 <contextlist><context>server config</context><context>virtual host</context>
1218 <context>directory</context><context>.htaccess</context>
1219 </contextlist>
1220 <override>All</override>
1221 <usage>
1222     <p>Cette phase s'ex&eacute;cute juste apr&egrave;s l'attribution de la requ&ecirc;te &agrave;
1223     un serveur virtuel, et permet d'effectuer certains traitements avant
1224     le d&eacute;roulement des autres phases, ou de servir une requ&ecirc;te sans
1225     avoir &agrave; la traduire, l'associer &agrave; un espace de stockage, etc...
1226     Comme cette phase s'ex&eacute;cute avant toute autre, les directives telles
1227     que <directive type="section" module="core">Location</directive> ou
1228     <directive type="section" module="core">Directory</directive> ne
1229     sont pas encore prises en compte, car Les URI n'ont pas encore &eacute;t&eacute;
1230     enti&egrave;rement interpr&eacute;t&eacute;s.
1231     </p>
1232    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
1233    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
1234    module="core">Directory</directive> ou <directive type="section"
1235    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1236 </usage>
1237 </directivesynopsis>
1238
1239 <directivesynopsis>
1240 <name>LuaAuthzProvider</name>
1241 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1242 </description>
1243 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1244 <contextlist><context>server config</context> </contextlist>
1245 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1246
1247 <usage>
1248 <p>Lorsqu'une fonction lua a &eacute;t&eacute; enregistr&eacute;e en tant que fournisseur
1249 d'autorisation, elle peut &ecirc;tre appel&eacute;e via la directive <directive
1250 module="mod_authz_core">Require</directive> :</p>
1251
1252
1253 <highlight language="config">
1254 LuaRoot /usr/local/apache2/lua
1255 LuaAuthzProvider foo authz.lua authz_check_foo
1256 &lt;Location /&gt;
1257   Require foo johndoe
1258 &lt;/Location&gt;
1259 </highlight>
1260 <highlight language="lua">
1261 require "apache2"
1262 function authz_check_foo(r, who)
1263     if r.user ~= who then return apache2.AUTHZ_DENIED
1264     return apache2.AUTHZ_GRANTED
1265 end
1266 </highlight>
1267
1268 </usage>
1269 </directivesynopsis>
1270
1271
1272 </modulesynopsis>
1273