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