granicus.if.org Git - apache/blob - docs/manual/mod/mod_cgi.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_cgi - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_cgi</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_cgi.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  33 </div>
  34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts</td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>cgi_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_cgi.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>Any file that has the handler
  41     <code>cgi-script</code> will be treated
  42     as a CGI script, and run by the server, with its output being
  43     returned to the client. Files acquire this handler either by
  44     having a name containing an extension defined by the
  45     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> directive, or by being
  46     in a <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>
  47     directory.</p>
  48
  49     <p>For an introduction to using CGI scripts with Apache, see
  50     our tutorial on <a href="../howto/cgi.html">Dynamic Content
  51     With CGI</a>.</p>
  52
  53     <p>When using a multi-threaded MPM under unix, the module
  54     <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> should be used in place of
  55     this module. At the user level, the two modules are essentially
  56     identical.</p>
  57
  58     <p>For backward-compatibility, the cgi-script handler will also be activated
  59     for any file with the mime-type <code>application/x-httpd-cgi</code>. The
  60     use of the magic mime-type is deprecated.</p>
  61 </div>
  62 <div id="quickview"><h3>Topics</h3>
  63 <ul id="topics">
  64 <li><img alt="" src="../images/down.gif" /> <a href="#env">CGI Environment variables</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">CGI Debugging</a></li>
  66 </ul><h3 class="directives">Directives</h3>
  67 <ul id="toc">
  68 <li><img alt="" src="../images/down.gif" /> <a href="#cgiscripttimeout">CGIScriptTimeout</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
  72 </ul>
  73 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</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">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_cgi">Report a bug</a></li></ul><h3>See also</h3>
  74 <ul class="seealso">
  75 <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  76 <li><code class="directive"><a href="../mod/core.html#options">Options</a></code> ExecCGI</li>
  77 <li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
  78 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
  79 <li><a href="../suexec.html">Running CGI programs under different
  80     user IDs</a></li>
  81 <li><a href="http://www.ietf.org/rfc/rfc3875">CGI Specification</a></li>
  82 <li><a href="#comments_section">Comments</a></li></ul></div>
  83 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  84 <div class="section">
  85 <h2><a name="env" id="env">CGI Environment variables</a> <a title="Permanent link" href="#env" class="permalink">&para;</a></h2>
  86     <p>The server will set the CGI environment variables as described
  87     in the <a href="http://www.ietf.org/rfc/rfc3875">CGI specification</a>,
  88     with the following provisions:</p>
  89
  90     <dl>
  91       <dt>PATH_INFO</dt>
  92
  93       <dd>This will not be available if the <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code> directive is explicitly set to
  94       <code>off</code>.  The default behavior, if <code class="directive">AcceptPathInfo</code> is not given, is that <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> will accept path info (trailing <code>
  95       /more/path/info</code> following the script filename in the URI),
  96       while the core server will return a 404 NOT FOUND error for requests
  97       with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting
  98       it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>
  99
 100       <dt>REMOTE_HOST</dt>
 101
 102       <dd>This will only be set if <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> is set to <code>on</code> (it
 103       is off by default), and if a reverse DNS lookup of the accessing
 104       host's address indeed finds a host name.</dd>
 105
 106       <dt>REMOTE_IDENT</dt>
 107
 108       <dd>This will only be set if <code class="directive"><a href="../mod/mod_ident.html#identitycheck">IdentityCheck</a></code> is set to
 109       <code>on</code> and the accessing host supports the ident
 110       protocol. Note that the contents of this variable cannot be
 111       relied upon because it can easily be faked, and if there is a
 112       proxy between the client and the server, it is usually
 113       totally useless.</dd>
 114
 115       <dt>REMOTE_USER</dt>
 116
 117       <dd>This will only be set if the CGI script is subject to
 118       authentication.</dd>
 119
 120     </dl>
 121     <p>This module also leverages the core functions
 122        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga0e81f9571a8a73f5da0e89e1f46d34b1">ap_add_common_vars</a> and
 123        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga6b975cd7ff27a338cb8752381a4cc14f">ap_add_cgi_vars</a>
 124        to add environment variables like:</p>
 125        <dl>
 126            <dt>DOCUMENT_ROOT</dt>
 127
 128            <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> directive.</dd>
 129
 130            <dt>SERVER_NAME</dt>
 131
 132            <dd>The fully qualified domain name related to the request.</dd>
 133
 134            <dt>SERVER_ADDR</dt>
 135
 136            <dd>The IP address of the Virtual Host serving the request.</dd>
 137
 138            <dt>SERVER_ADMIN</dt>
 139
 140            <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code> directive.</dd>
 141       </dl>
 142     <p>For an exhaustive list it is suggested to write a basic CGI script
 143        that dumps all the environment variables passed by Apache in a convenient format.
 144     </p>
 145 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 146 <div class="section">
 147 <h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a> <a title="Permanent link" href="#cgi-debug" class="permalink">&para;</a></h2>
 148     <p>Debugging CGI scripts has traditionally been difficult, mainly
 149     because it has not been possible to study the output (standard
 150     output and error) for scripts which are failing to run
 151     properly. These directives provide more detailed logging of errors
 152     when they occur.</p>
 153
 154     <h3>CGI Logfile Format</h3>
 155       <p>When configured, the CGI error log logs any CGI which does not
 156       execute properly. Each CGI script which fails to operate causes
 157       several lines of information to be logged. The first two lines
 158       are always of the format:</p>
 159
 160       <div class="example"><p><code>
 161         %% [<var>time</var>] <var>request-line</var><br />
 162         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
 163       </code></p></div>
 164
 165       <p>If the error is that CGI script cannot be run, the log file
 166       will contain an extra two lines:</p>
 167
 168       <div class="example"><p><code>
 169         %%error<br />
 170         <var>error-message</var>
 171       </code></p></div>
 172
 173       <p>Alternatively, if the error is the result of the script
 174       returning incorrect header information (often due to a bug in
 175       the script), the following information is logged:</p>
 176
 177       <div class="example"><p><code>
 178         %request<br />
 179         <var>All HTTP request headers received</var><br />
 180         <var>POST or PUT entity (if any)</var><br />
 181         %response<br />
 182         <var>All headers output by the CGI script</var><br />
 183         %stdout<br />
 184         <var>CGI standard output</var><br />
 185         %stderr<br />
 186         <var>CGI standard error</var><br />
 187       </code></p></div>
 188
 189       <p>(The %stdout and %stderr parts may be missing if the script did
 190       not output anything on standard output or standard error).</p>
 191
 192 </div>
 193 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 194 <div class="directive-section"><h2><a name="CGIScriptTimeout" id="CGIScriptTimeout">CGIScriptTimeout</a> <a name="cgiscripttimeout" id="cgiscripttimeout">Directive</a> <a title="Permanent link" href="#cgiscripttimeout" class="permalink">&para;</a></h2>
 195 <table class="directive">
 196 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The length of time to wait for more output from the
 197 CGI program</td></tr>
 198 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIScriptTimeout <var>time</var>[s|ms]</code></td></tr>
 199 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>value of <code class="directive"><a href="../mod/core.html#timeout">Timeout</a></code> directive when
 200 unset</code></td></tr>
 201 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 202 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 203 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cgi</td></tr>
 204 </table>
 205     <p>This directive limits the length of time to wait for more output from
 206     the CGI program.  If the time is exceeded, the request and CGI are
 207     terminated.</p>
 208
 209     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CGIScriptTimeout 20</pre>
 210 </div>
 211
 212
 213 </div>
 214 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 215 <div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a> <a title="Permanent link" href="#scriptlog" class="permalink">&para;</a></h2>
 216 <table class="directive">
 217 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>
 218 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>
 219 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 220 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 221 <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>
 222 </table>
 223     <p>The <code class="directive">ScriptLog</code> directive sets the CGI
 224     script error logfile. If no <code class="directive">ScriptLog</code> is given,
 225     no error log is created. If given, any CGI errors are logged into the
 226     filename given as argument. If this is a relative file or path it is
 227     taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
 228     </p>
 229
 230     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ScriptLog logs/cgi_log</pre>
 231 </div>
 232
 233     <p>This log will be opened as the user the child processes run
 234     as, <em>i.e.</em> the user specified in the main <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code> directive. This means that
 235     either the directory the script log is in needs to be writable
 236     by that user or the file needs to be manually created and set
 237     to be writable by that user. If you place the script log in
 238     your main logs directory, do <strong>NOT</strong> change the
 239     directory permissions to make it writable by the user the child
 240     processes run as.</p>
 241
 242     <p>Note that script logging is meant to be a debugging feature
 243     when writing CGI scripts, and is not meant to be activated
 244     continuously on running servers. It is not optimized for speed
 245     or efficiency, and may have security problems if used in a
 246     manner other than that for which it was designed.</p>
 247
 248 </div>
 249 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 250 <div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a> <a title="Permanent link" href="#scriptlogbuffer" class="permalink">&para;</a></h2>
 251 <table class="directive">
 252 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded
 253 in the scriptlog</td></tr>
 254 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>
 255 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
 256 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 257 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 258 <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>
 259 </table>
 260     <p>The size of any PUT or POST entity body that is logged to
 261     the file is limited, to prevent the log file growing too big
 262     too quickly if large bodies are being received. By default, up
 263     to 1024 bytes are logged, but this can be changed with this
 264     directive.</p>
 265
 266 </div>
 267 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 268 <div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a> <a title="Permanent link" href="#scriptloglength" class="permalink">&para;</a></h2>
 269 <table class="directive">
 270 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>
 271 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>
 272 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
 273 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 274 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 275 <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>
 276 </table>
 277     <p><code class="directive">ScriptLogLength</code> can be used to limit the
 278     size of the CGI script logfile. Since the logfile logs a lot of
 279     information per CGI error (all request headers, all script output)
 280     it can grow to be a big file. To prevent problems due to unbounded
 281     growth, this directive can be used to set an maximum file-size for
 282     the CGI logfile. If the file exceeds this size, no more
 283     information will be written to it.</p>
 284
 285 </div>
 286 </div>
 287 <div class="bottomlang">
 288 <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English">&nbsp;en&nbsp;</a> |
 289 <a href="../fr/mod/mod_cgi.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 290 <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 291 <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 292 </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">Comments</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 again 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 Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 293 <script type="text/javascript"><!--//--><![CDATA[//><!--
 294 var comments_shortname = 'httpd';
 295 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cgi.html';
 296 (function(w, d) {
 297     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 298         d.write('<div id="comments_thread"><\/div>');
 299         var s = d.createElement('script');
 300         s.type = 'text/javascript';
 301         s.async = true;
 302         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 303         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 304     }
 305     else {
 306         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 307     }
 308 })(window, document);
 309 //--><!]]></script></div><div id="footer">
 310 <p class="apache">Copyright 2019 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 311 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 312 if (typeof(prettyPrint) !== 'undefined') {
 313     prettyPrint();
 314 }
 315 //--><!]]></script>
 316 </body></html>