blob: f9570ba31e51321185f414c1d5033c59cb938db6 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr"><head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_cgi - Serveur HTTP Apache Version 2.4</title>
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
<script src="../style/scripts/prettify.min.js" type="text/javascript">
</script>
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
<body>
<div id="page-header">
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a></p>
<p class="apache">Serveur HTTP Apache Version 2.4</p>
<img alt="" src="../images/feather.png" /></div>
<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
<div id="path">
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">Serveur HTTP</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.4</a> &gt; <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Module Apache mod_cgi</h1>
<div class="toplang">
<p><span>Langues Disponibles: </span><a href="../en/mod/mod_cgi.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
<a href="../fr/mod/mod_cgi.html" title="Français">&nbsp;fr&nbsp;</a> |
<a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Exécution des scripts CGI</td></tr>
<tr><th><a href="module-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Identificateur de Module:</a></th><td>cgi_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Fichier Source:</a></th><td>mod_cgi.c</td></tr></table>
<h3>Sommaire</h3>
<p>Tout fichier pris en compte par le gestionnaire
<code>cgi-script</code> sera traité en tant que script CGI et
exécuté par le serveur, sa sortie étant renvoyée au client. Les
fichiers sont associés à ce gestionnaire soit parce qu'ils possèdent
un nom contenant une extension définie par la directive <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code>, soit parce qu'ils se
situent dans un répertoire défini par une directive <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>.</p>
<p>Comme introduction à l'utilisation des scripts CGI avec Apache,
voir notre tutoriel <a href="../howto/cgi.html">Les contenus
dynamiques avec CGI</a>.</p>
<p>Il est recommandé d'utiliser le module <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code>
à la place de <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> lorsqu'on utilise un module MPM
multi-threadé sous Unix. Vus de l'utilisateur, les deux modules
sont pratiquement identiques.</p>
<p>À des fins de compatibilité ascendante, le gestionnaire
cgi-script sera aussi activé pour tout fichier possédant le type
MIME <code>application/x-httpd-cgi</code>. L'utilisation du type
MIME magic est obsolète.</p>
</div>
<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3>Sujets</h3>
<ul id="topics">
<li><img alt="" src="../images/down.gif" /> <a href="#env">Les variables d'environnement CGI</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">Débogage des scripts CGI</a></li>
</ul><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
</ul>
<h3>Traitement des bugs</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">Journal des modifications de httpd</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_cgi">Problèmes connus</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_cgi">Signaler un bug</a></li></ul><h3>Voir aussi</h3>
<ul class="seealso">
<li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
<li><code class="directive"><a href="../mod/core.html#options">Options</a></code> ExecCGI</li>
<li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
<li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
<li><a href="../suexec.html">Exécuter des programmes CGI sous des
utilisateurs différents</a></li>
<li><a href="http://www.ietf.org/rfc/rfc3875">La spécification
CGI</a></li>
<li><a href="#comments_section">Commentaires</a></li></ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="env" id="env">Les variables d'environnement CGI</a></h2>
<p>Le serveur va définir les variables d'environnement CGI comme
décrit dans la <a href="http://www.ietf.org/rfc/rfc3875">Spécification CGI</a>, de la
manière suivante :</p>
<dl>
<dt>PATH_INFO</dt>
<dd>Cette variable ne sera pas disponible si la directive
<code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code> est
explicitement définie à <code>off</code>. Par défaut, si la
directive <code class="directive">AcceptPathInfo</code> n'est pas définie,
<code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> acceptera des informations de chemin (en
ajoutant /infos/chemin après le nom du script dans l'URI), alors
que le serveur de base retournera une erreur 404 NOT FOUND pour
les requêtes contenant des informations de chemin supplémentaires.
Ne pas définir la directive <code class="directive">AcceptPathInfo</code>
a le même effet sur les requêtes avec <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> que
de la définir à <code>On</code>.</dd>
<dt>REMOTE_HOST</dt>
<dd>Cette variable ne sera définie que si la directive <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> est définie à
<code>on</code> (elle est à <code>off</code> par défaut), et si
une recherche DNS inverse sur l'adresse IP de l'hôte client
aboutit effectivement à un nom d'hôte.</dd>
<dt>REMOTE_IDENT</dt>
<dd>Cette variable ne sera définie que si la directive <code class="directive"><a href="../mod/mod_ident.html#identitycheck">IdentityCheck</a></code>
est définie à <code>on</code>, et si l'hôte client supporte le
protocole ident. Notez que l'on ne peut accorder une confiance
aveugle au contenu de cette variable car il peut être aisément
falsifié, et si un mandataire s'intercale entre le client et le
serveur, il est totalement inutilisable.</dd>
<dt>REMOTE_USER</dt>
<dd>Cette variable ne sera définie que si le script CGI fait
l'objet d'une authentification.</dd>
</dl>
<p>Ce module utilise aussi les fonctions de base <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga0e81f9571a8a73f5da0e89e1f46d34b1">ap_add_common_vars</a>
et <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga6b975cd7ff27a338cb8752381a4cc14f">ap_add_cgi_vars</a>
pour ajouter des variables d'environnement comme :</p>
<dl>
<dt>DOCUMENT_ROOT</dt>
<dd>Prend la valeur définie par la directive <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.</dd>
<dt>SERVER_NAME</dt>
<dd>Le nom de domaine pleinement qualifié pour la requête considérée</dd>
<dt>SERVER_ADDR</dt>
<dd>L'adresse IP du serveur virtuel qui traite la requête</dd>
<dt>SERVER_ADMIN</dt>
<dd>Prend la valeur définie par la directive <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code>.</dd>
</dl>
<p>Pour une liste exhaustive de ces variables, vous pouvez écrire un script
CGI basique qui extrait toutes les variables d'environnement passées par
Apache selon un format adapté.
</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="cgi-debug" id="cgi-debug">Débogage des scripts CGI</a></h2>
<p>Le débogage des scripts CGI était difficile par le passé,
principalement parce qu'il n'était pas possible d'étudier la sortie
(sortie standard et erreurs) des scripts dont l'exécution échouait.
Les directives qui suivent permettent une journalisation plus détaillée des
erreurs.</p>
<h3>Format du fichier journal CGI</h3>
<p>Lorsqu'il est configuré, le journal des erreurs CGI enregistre
la sortie de tout programme CGI dont l'exécution ne s'effectue pas
correctement. Un script CGI dont l'exécution échoue provoque la
journalisation d'une grande quantité d'informations. Les deux
premières lignes possèdent toujours le format suivant :</p>
<div class="example"><p><code>
%% [<var>date</var>] <var>requête</var><br />
%% <var>état HTTP</var> <var>nom du script CGI</var>
</code></p></div>
<p>Si le script CGI n'a pas pu démarrer, le fichier journal
contiendra les deux lignes supplémentaires suivantes :</p>
<div class="example"><p><code>
%%erreur<br />
<var>message d'erreur</var>
</code></p></div>
<p>Par contre, si l'erreur provient du renvoi par le script
d'informations incorrectes dans les en-têtes (dû souvent à une
bogue du script), les informations suivantes sont journalisées
:</p>
<div class="example"><p><code>
%requête<br />
<var>Tous les en-têtes de requête HTTP reçus</var><br />
<var>Les entités POST ou PUT (s'il en existe)</var><br />
%réponse<br />
<var>Tous les en-têtes générés par le script CGI</var><br />
%stdout<br />
<var>la sortie standard CGI</var><br />
%stderr<br />
<var>la sortie d'erreurs standard CGI</var><br />
</code></p></div>
<p>(Les parties %stdout et %stderr seront absentes si le script
n'a rien envoyé sur la sortie standard ou la sortie
d'erreurs).</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="scriptlog" id="scriptlog">Directive</a> <a name="ScriptLog" id="ScriptLog">ScriptLog</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Chemin du fichier journal des erreurs du script
CGI</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>ScriptLog <var>chemin fichier</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
</table>
<p>La directive <code class="directive">ScriptLog</code> permet de définir
le chemin du fichier journal des erreurs du script CGI. Si cette
directive n'est pas définie, aucune journalisation des erreurs n'est
effectuée. Si elle est définie, toute erreur CGI sera enregistrée
dans le fichier dont le nom est fourni en argument. S'il s'agit d'un
chemin de fichier relatif, il est considéré par rapport au
répertoire défini par la directive <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
</p>
<div class="example"><h3>Exemple</h3><pre class="prettyprint lang-config">ScriptLog logs/cgi_log</pre>
</div>
<p>Ce journal sera ouvert par l'utilisateur sous lequel les
processus enfants s'exécutent, c'est à dire l'utilisateur spécifié
par la directive du serveur <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code>. Ceci implique que le
répertoire dans lequel se trouve le journal doit être accessible en
écriture pour cet utilisateur, ou bien que le fichier est créé
manuellement et accessible en écriture pour cet utilisateur. Si vous
placez le journal du script dans votre répertoire principal des
journaux, ne modifiez <strong>JAMAIS</strong> les permissions de ce
dernier afin de le le rendre accessible en écriture par
l'utilisateur sous lequel les processus enfants s'exécutent.</p>
<p>Notez que l'on ne doit activer la journalisation des scripts
qu'à des fins de débogage lors de l'écriture de scripts CGI, et non
de manière permanente sur un serveur en production. Elle n'est pas
optimisée en terme de performances et d'efficacité, et peut
présenter des problèmes de sécurité si on l'utilise dans un cadre
autre que celui pour lequel elle a été conçue.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a> <a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Taille maximale des requêtes PUT ou POST qui seront
enregistrées dans le journal du script</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>ScriptLogBuffer <var>octets</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Défaut:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
</table>
<p>Cette directive permet de limiter la taille du corps de toute
entité PUT ou POST qui sera enregistrée dans le journal, afin
de prévenir une croissance trop importante et trop rapide du fichier
journal due à la réception de corps de requête de grandes tailles.
Cette directive permet de modifier cette taille maximale, dont la
valeur par défaut est de 1024 octets.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="scriptloglength" id="scriptloglength">Directive</a> <a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Taille maximale du fichier journal des scripts
CGI</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>ScriptLogLength <var>octets</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Défaut:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
</table>
<p>La directive <code class="directive">ScriptLogLength</code> permet de
définir la taille maximale du fichier journal des scripts CGI. Comme
le fichier journal accumule une grande quantité d'informations par
erreur CGI (tous les en-têtes de la requête, toutes les sorties du
script), il peut vite atteindre une grande taille. En limitant la
taille du fichier, cette directive permet d'éviter les problèmes que
causerait sa croissance sans limites. Lorsque le fichier a atteint
cette taille maximale, plus aucune information n'y est
enregistrée.</p>
</div>
</div>
<div class="bottomlang">
<p><span>Langues Disponibles: </span><a href="../en/mod/mod_cgi.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
<a href="../fr/mod/mod_cgi.html" title="Français">&nbsp;fr&nbsp;</a> |
<a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
</div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Commentaires</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
<script type="text/javascript"><!--//--><![CDATA[//><!--
var comments_shortname = 'httpd';
var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_cgi.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
}
else {
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
}
})(window, document);
//--><!]]></script></div><div id="footer">
<p class="apache">Copyright 2022 The Apache Software Foundation.<br />Autorisé sous <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>