2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision : 1330964 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
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
16 http://www.apache.org/licenses/LICENSE-2.0
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.
25 <modulesynopsis metafile="mod_cgi.xml.meta">
28 <description>Exécution des scripts CGI</description>
30 <sourcefile>mod_cgi.c</sourcefile>
31 <identifier>cgi_module</identifier>
34 <p>Tout fichier pris en compte par le gestionnaire
35 <code>cgi-script</code> sera traité en tant que script CGI et
36 exécuté par le serveur, sa sortie étant renvoyée au client. Les
37 fichiers sont associés à ce gestionnaire soit parce qu'ils possèdent
38 un nom contenant une extension définie par la directive <directive
39 module="mod_mime">AddHandler</directive>, soit parce qu'ils se
40 situent dans un répertoire défini par une directive <directive
41 module="mod_alias">ScriptAlias</directive>.</p>
43 <p>Comme introduction à l'utilisation des scripts CGI avec Apache,
44 voir notre tutoriel <a href="../howto/cgi.html">Les contenus
45 dynamiques avec CGI</a>.</p>
47 <p>Le module <module>mod_cgid</module> doit être utilisé à la place
48 du module <module>mod_cgi</module> lorsqu'on utilise un module MPM
49 multi-threadé sous Unix. Vus de l'utilisateur, les deux modules
50 sont pratiquement identiques.</p>
52 <p>À des fins de compatibilité ascendante, le gestionnaire
53 cgi-script sera également activé pour tout fichier possédant le type
54 MIME <code>application/x-httpd-cgi</code>. L'utilisation du type
55 MIME magic est obsolète.</p>
58 <seealso><directive module="core">AcceptPathInfo</directive></seealso>
59 <seealso><directive module="core">Options</directive> ExecCGI</seealso>
60 <seealso><directive module="mod_alias">ScriptAlias</directive></seealso>
61 <seealso><directive module="mod_mime">AddHandler</directive></seealso>
62 <seealso><a href="../suexec.html">Exécuter des programmes CGI sous des
63 utilisateurs différents</a></seealso>
64 <seealso><a href="http://www.ietf.org/rfc/rfc3875">La spécification
67 <section id="env"><title>Les variables d'environnement CGI</title>
68 <p>Le serveur va définir les variables d'environnement CGI comme
69 décrit dans la <a
70 href="http://www.ietf.org/rfc/rfc3875">Spécification CGI</a>, de la
71 manière suivante :</p>
76 <dd>Cette variable ne sera pas disponible si la directive
77 <directive module="core">AcceptPathInfo</directive> est
78 explicitement définie à <code>off</code>. Par défaut, si la
79 directive <directive>AcceptPathInfo</directive> n'est pas définie,
80 <module>mod_cgi</module> acceptera des informations de chemin (en
81 ajoutant /infos/chemin après le nom du script dans l'URI), alors
82 que le serveur de base retournera une erreur 404 NOT FOUND pour
83 les requêtes contenant des informations de chemin supplémentaires.
84 Ne pas définir la directive <directive>AcceptPathInfo</directive>
85 a le même effet sur les requêtes avec <module>mod_cgi</module> que
86 de la définir à <code>On</code>.</dd>
90 <dd>Cette variable ne sera définie que si la directive <directive
91 module="core">HostnameLookups</directive> est définie à
92 <code>on</code> (elle est à <code>off</code> par défaut), et si
93 une recherche DNS inverse sur l'adresse IP de l'hôte client
94 aboutit effectivement à un nom d'hôte.</dd>
98 <dd>Cette variable ne sera définie que si la directive <directive
99 module="mod_ident">IdentityCheck</directive>
100 est définie à <code>on</code>, et si l'hôte client supporte le
101 protocole ident. Notez que l'on ne peut accorder une confiance
102 aveugle au contenu de cette variable car il peut être aisément
103 falsifié, et si un mandataire s'intercale entre le client et le
104 serveur, il est totalement inutilisable.</dd>
108 <dd>Cette variable ne sera définie que si le script CGI fait
109 l'objet d'une authentification.</dd>
113 <section id="cgi-debug"><title>Débogage des scripts CGI</title>
114 <p>Le débogage des scripts CGI était difficile par le passé,
115 principalement parce qu'il n'était pas possible d'étudier la sortie
116 (sortie standard et erreurs) des scripts dont l'exécution échouait.
117 Ces directives permettent une journalisation plus détaillée des
120 <section><title>Format du fichier journal CGI</title>
121 <p>Lorsqu'il est configuré, le journal des erreurs CGI enregistre
122 la sortie de tout programme CGI dont l'exécution ne s'effectue pas
123 correctement. Un script CGI dont l'exécution échoue provoque la
124 journalisation d'une grande quantité d'informations. Les deux
125 premières lignes possèdent toujours le format suivant :</p>
128 %% [<var>date</var>] <var>requête</var><br />
129 %% <var>état HTTP</var> <var>nom du script CGI</var>
132 <p>Si le script CGI n'a pas pu démarrer, le fichier journal
133 contiendra les deux lignes supplémentaires suivantes :</p>
137 <var>message d'erreur</var>
140 <p>Par contre, si l'erreur provient du renvoi par le script
141 d'informations incorrectes dans les en-têtes (dû souvent à une
142 bogue du script), les informations suivantes sont journalisées
147 <var>Tous les en-têtes de requête HTTP reçus</var><br />
148 <var>Les entités POST ou PUT (s'il en existe)</var><br />
149 %réponse<br />
150 <var>Tous les en-têtes générés par le script CGI</var><br />
152 <var>la sortie standard CGI</var><br />
154 <var>la sortie d'erreurs standard CGI</var><br />
157 <p>(Les parties %stdout et %stderr seront absentes si le script
158 n'a rien envoyé sur la sortie standard ou la sortie
164 <name>ScriptLog</name>
165 <description>Chemin du fichier journal des erreurs du script
167 <syntax>ScriptLog <var>chemin fichier</var></syntax>
168 <contextlist><context>server config</context>
169 <context>virtual host</context></contextlist>
170 <modulelist><module>mod_cgi</module><module>mod_cgid</module>
174 <p>La directive <directive>ScriptLog</directive> définit
175 le chemin du fichier journal des erreurs du script CGI. Si cette
176 directive n'est pas définie, aucune journalisation des erreurs n'est
177 effectuée. Si elle est définie, toute erreur CGI sera enregistrée
178 dans le fichier dont le nom est fourni en argument. S'il s'agit d'un
179 chemin de fichier relatif, il est considéré par rapport au
180 répertoire défini par la directive <directive
181 module="core">ServerRoot</directive>.
184 <example><title>Exemple</title>
185 <highlight language="config">
186 ScriptLog logs/cgi_log
190 <p>Ce journal sera ouvert par l'utilisateur sous lequel les
191 processus enfants s'exécutent, c'est à dire l'utilisateur spécifié
192 par la directive du serveur <directive
193 module="mod_unixd">User</directive>. Ceci implique que soit le
194 répertoire dans lequel se trouve le journal doit être accessible en
195 écriture pour cet utilisateur, soit le fichier doit être créé
196 manuellement et accessible en écriture pour cet utilisateur. Si vous
197 placez le journal du script dans votre répertoire principal des
198 journaux, ne modifiez <strong>PAS</strong> les permissions de ce
199 dernier afin de le le rendre accessible en écriture par
200 l'utilisateur sous lequel les processus enfants s'exécutent.</p>
202 <p>Notez que l'on ne doit activer la journalisation des scripts
203 qu'à des fins de débogage lors de l'écriture de scripts CGI, et non
204 de manière permanente sur un serveur en production. Elle n'est pas
205 optimisée en ce qui concerne la vitesse et l'efficacité, et peut
206 présenter des problèmes de sécurité si on l'utilise dans un cadre
207 autre que celui pour lequel elle a été conçue.</p>
212 <name>ScriptLogLength</name>
213 <description>Taille maximale du fichier journal des scripts
215 <syntax>ScriptLogLength <var>octets</var></syntax>
216 <default>ScriptLogLength 10385760</default>
217 <contextlist><context>server config</context>
218 <context>virtual host</context></contextlist>
219 <modulelist><module>mod_cgi</module><module>mod_cgid</module>
223 <p>La directive <directive>ScriptLogLength</directive>
224 définit la taille maximale du fichier journal des scripts CGI. Comme
225 le fichier journal accumule une grande quantité d'informations par
226 erreur CGI (tous les en-têtes de la requête, toutes les sorties du
227 script), il peut vite atteindre une grande taille. En limitant la
228 taille du fichier, cette directive permet d'éviter les problèmes que
229 causerait sa croissance sans limites. Lorsque le fichier a atteint
230 cette taille maximale, plus aucune information n'y est
231 enregistrée.</p>
236 <name>ScriptLogBuffer</name>
237 <description>Taille maximale des requêtes PUT ou POST qui seront
238 enregistrées dans le journal du script</description>
239 <syntax>ScriptLogBuffer <var>octets</var></syntax>
240 <default>ScriptLogBuffer 1024</default>
241 <contextlist><context>server config</context>
242 <context>virtual host</context></contextlist>
243 <modulelist><module>mod_cgi</module><module>mod_cgid</module>
247 <p>Cette directive limite la taille du corps de toute
248 entité PUT ou POST qui sera enregistrée dans le journal, afin
249 de prévenir une croissance trop importante et trop rapide du fichier
250 journal due à la réception de corps de requête de grandes tailles.
251 Cette directive modifie cette taille maximale, dont la
252 valeur par défaut est de 1024 octets.</p>