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="#scriptlog">ScriptLog</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
  71 </ul>
  72 <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>
  73 <ul class="seealso">
  74 <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  75 <li><code class="directive"><a href="../mod/core.html#options">Options</a></code> ExecCGI</li>
  76 <li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
  77 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
  78 <li><a href="../suexec.html">Running CGI programs under different
  79     user IDs</a></li>
  80 <li><a href="http://www.ietf.org/rfc/rfc3875">CGI Specification</a></li>
  81 <li><a href="#comments_section">Comments</a></li></ul></div>
  82 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  83 <div class="section">
  84 <h2><a name="env" id="env">CGI Environment variables</a></h2>
  85     <p>The server will set the CGI environment variables as described
  86     in the <a href="http://www.ietf.org/rfc/rfc3875">CGI specification</a>,
  87     with the following provisions:</p>
  88
  89     <dl>
  90       <dt>PATH_INFO</dt>
  91
  92       <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
  93       <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>
  94       /more/path/info</code> following the script filename in the URI),
  95       while the core server will return a 404 NOT FOUND error for requests
  96       with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting
  97       it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>
  98
  99       <dt>REMOTE_HOST</dt>
 100
 101       <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
 102       is off by default), and if a reverse DNS lookup of the accessing
 103       host's address indeed finds a host name.</dd>
 104
 105       <dt>REMOTE_IDENT</dt>
 106
 107       <dd>This will only be set if <code class="directive"><a href="../mod/mod_ident.html#identitycheck">IdentityCheck</a></code> is set to
 108       <code>on</code> and the accessing host supports the ident
 109       protocol. Note that the contents of this variable cannot be
 110       relied upon because it can easily be faked, and if there is a
 111       proxy between the client and the server, it is usually
 112       totally useless.</dd>
 113
 114       <dt>REMOTE_USER</dt>
 115
 116       <dd>This will only be set if the CGI script is subject to
 117       authentication.</dd>
 118
 119     </dl>
 120     <p>This module also leverages the core functions
 121        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga0e81f9571a8a73f5da0e89e1f46d34b1">ap_add_common_vars</a> and
 122        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga6b975cd7ff27a338cb8752381a4cc14f">ap_add_cgi_vars</a>
 123        to add environment variables like:</p>
 124        <dl>
 125            <dt>DOCUMENT_ROOT</dt>
 126
 127            <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> directive.</dd>
 128
 129            <dt>SERVER_NAME</dt>
 130
 131            <dd>The fully qualified domain name related to the request.</dd>
 132
 133            <dt>SERVER_ADDR</dt>
 134
 135            <dd>The IP address of the Virtual Host serving the request.</dd>
 136
 137            <dt>SERVER_ADMIN</dt>
 138
 139            <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code> directive.</dd>
 140       </dl>
 141     <p>For an exhaustive list it is suggested to write a basic CGI script
 142        that dumps all the environment variables passed by Apache in a convenient format.
 143     </p>
 144 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 145 <div class="section">
 146 <h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a></h2>
 147     <p>Debugging CGI scripts has traditionally been difficult, mainly
 148     because it has not been possible to study the output (standard
 149     output and error) for scripts which are failing to run
 150     properly. These directives provide more detailed logging of errors
 151     when they occur.</p>
 152
 153     <h3>CGI Logfile Format</h3>
 154       <p>When configured, the CGI error log logs any CGI which does not
 155       execute properly. Each CGI script which fails to operate causes
 156       several lines of information to be logged. The first two lines
 157       are always of the format:</p>
 158
 159       <div class="example"><p><code>
 160         %% [<var>time</var>] <var>request-line</var><br />
 161         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
 162       </code></p></div>
 163
 164       <p>If the error is that CGI script cannot be run, the log file
 165       will contain an extra two lines:</p>
 166
 167       <div class="example"><p><code>
 168         %%error<br />
 169         <var>error-message</var>
 170       </code></p></div>
 171
 172       <p>Alternatively, if the error is the result of the script
 173       returning incorrect header information (often due to a bug in
 174       the script), the following information is logged:</p>
 175
 176       <div class="example"><p><code>
 177         %request<br />
 178         <var>All HTTP request headers received</var><br />
 179         <var>POST or PUT entity (if any)</var><br />
 180         %response<br />
 181         <var>All headers output by the CGI script</var><br />
 182         %stdout<br />
 183         <var>CGI standard output</var><br />
 184         %stderr<br />
 185         <var>CGI standard error</var><br />
 186       </code></p></div>
 187
 188       <p>(The %stdout and %stderr parts may be missing if the script did
 189       not output anything on standard output or standard error).</p>
 190
 191 </div>
 192 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 193 <div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a></h2>
 194 <table class="directive">
 195 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>
 196 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>
 197 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 198 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 199 <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>
 200 </table>
 201     <p>The <code class="directive">ScriptLog</code> directive sets the CGI
 202     script error logfile. If no <code class="directive">ScriptLog</code> is given,
 203     no error log is created. If given, any CGI errors are logged into the
 204     filename given as argument. If this is a relative file or path it is
 205     taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
 206     </p>
 207
 208     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ScriptLog logs/cgi_log</pre>
 209 </div>
 210
 211     <p>This log will be opened as the user the child processes run
 212     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
 213     either the directory the script log is in needs to be writable
 214     by that user or the file needs to be manually created and set
 215     to be writable by that user. If you place the script log in
 216     your main logs directory, do <strong>NOT</strong> change the
 217     directory permissions to make it writable by the user the child
 218     processes run as.</p>
 219
 220     <p>Note that script logging is meant to be a debugging feature
 221     when writing CGI scripts, and is not meant to be activated
 222     continuously on running servers. It is not optimized for speed
 223     or efficiency, and may have security problems if used in a
 224     manner other than that for which it was designed.</p>
 225
 226 </div>
 227 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 228 <div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a></h2>
 229 <table class="directive">
 230 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded
 231 in the scriptlog</td></tr>
 232 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>
 233 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
 234 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 235 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 236 <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>
 237 </table>
 238     <p>The size of any PUT or POST entity body that is logged to
 239     the file is limited, to prevent the log file growing too big
 240     too quickly if large bodies are being received. By default, up
 241     to 1024 bytes are logged, but this can be changed with this
 242     directive.</p>
 243
 244 </div>
 245 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 246 <div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a></h2>
 247 <table class="directive">
 248 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>
 249 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>
 250 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
 251 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 252 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 253 <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>
 254 </table>
 255     <p><code class="directive">ScriptLogLength</code> can be used to limit the
 256     size of the CGI script logfile. Since the logfile logs a lot of
 257     information per CGI error (all request headers, all script output)
 258     it can grow to be a big file. To prevent problems due to unbounded
 259     growth, this directive can be used to set an maximum file-size for
 260     the CGI logfile. If the file exceeds this size, no more
 261     information will be written to it.</p>
 262
 263 </div>
 264 </div>
 265 <div class="bottomlang">
 266 <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English">&nbsp;en&nbsp;</a> |
 267 <a href="../fr/mod/mod_cgi.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 268 <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 269 <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 270 </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>
 271 <script type="text/javascript"><!--//--><![CDATA[//><!--
 272 var comments_shortname = 'httpd';
 273 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cgi.html';
 274 (function(w, d) {
 275     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 276         d.write('<div id="comments_thread"><\/div>');
 277         var s = d.createElement('script');
 278         s.type = 'text/javascript';
 279         s.async = true;
 280         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 281         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 282     }
 283     else {
 284         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 285     }
 286 })(window, document);
 287 //--><!]]></script></div><div id="footer">
 288 <p class="apache">Copyright 2017 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>
 289 <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[//><!--
 290 if (typeof(prettyPrint) !== 'undefined') {
 291     prettyPrint();
 292 }
 293 //--><!]]></script>
 294 </body></html>