<title>suEXEC Support - Apache HTTP Server</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 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.js" type="text/javascript">
+</script>
+
<link href="./images/favicon.ico" rel="shortcut icon" /></head>
<body id="manual-page"><div id="page-header">
-<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
-<p class="apache">Apache HTTP Server Version 2.3</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">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.5</p>
<img alt="" src="./images/feather.gif" /></div>
<div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
<div id="path">
-<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.3</a></div><div id="page-content"><div id="preamble"><h1>suEXEC Support</h1>
+<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.5</a></div><div id="page-content"><div id="preamble"><h1>suEXEC Support</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="./en/suexec.html" title="English"> en </a> |
+<a href="./fr/suexec.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
<a href="./ja/suexec.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="./ko/suexec.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
<a href="./tr/suexec.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
</div>
- <p>The <strong>suEXEC</strong> feature provides
- Apache users the ability
+ <p>The <strong>suEXEC</strong> feature provides users of the Apache
+ HTTP Server the ability
to run <strong>CGI</strong> and <strong>SSI</strong> programs
under user IDs different from the user ID of the calling
web server. Normally, when a CGI or SSI program executes, it
<li><img alt="" src="./images/down.gif" /> <a href="#debug">Debugging suEXEC</a></li>
<li><img alt="" src="./images/down.gif" /> <a href="#jabberwock">Beware the Jabberwock:
Warnings & Examples</a></li>
-</ul></div>
+</ul><ul class="seealso"><li><a href="#comments_section">Comments</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="before" id="before">Before we begin</a></h2>
<p>Before jumping head-first into this document,
- you should be aware of the assumptions made on the part of the
- Apache Group and this document.</p>
+ you should be aware that certain assumptions are made about you and
+ the environment in which you will be using suexec.</p>
<p>First, it is assumed that you are using a UNIX
derivative operating system that is capable of
security risks. It is <strong>highly</strong> recommended you
not alter the suEXEC code unless you are well versed in the
particulars of security programming and are willing to share
- your work with the Apache Group for consideration.</p>
+ your work with the Apache HTTP Server development team for consideration.</p>
<p>Fourth, and last, it has been the decision of
- the Apache Group to <strong>NOT</strong> make suEXEC part of
- the default installation of Apache. To this end, suEXEC
+ the Apache HTTP Server development team to <strong>NOT</strong> make suEXEC part of
+ the default installation of Apache httpd. To this end, suEXEC
configuration requires of the administrator careful attention
to details. After due consideration has been given to the
various settings for suEXEC, the administrator may install
these settings need to be carefully determined and specified by
the administrator to properly maintain system security during
the use of suEXEC functionality. It is through this detailed
- process that the Apache Group hopes to limit suEXEC
+ process that we hope to limit suEXEC
installation only to those who are careful and determined
enough to use it.</p>
taken to ensure your system's security.</p>
<p><strong>suEXEC</strong> is based on a setuid
- "wrapper" program that is called by the main Apache web server.
+ "wrapper" program that is called by the main Apache HTTP Server.
This wrapper is called when an HTTP request is made for a CGI
or SSI program that the administrator has designated to run as
a userid other than that of the main server. When such a
- request is made, Apache provides the suEXEC wrapper with the
+ request is made, Apache httpd provides the suEXEC wrapper with the
program's name and the user and group IDs under which the
program is to execute.</p>
<p class="indent">
The wrapper will only execute if it is given the proper
number of arguments. The proper argument format is known
- to the Apache web server. If the wrapper is not receiving
+ to the Apache HTTP Server. If the wrapper is not receiving
the proper number of arguments, it is either being
hacked, or there is something wrong with the suEXEC
- portion of your Apache binary.
+ portion of your Apache httpd binary.
</p>
</li>
<p class="indent">
- Presently, suEXEC does not allow <code><em>root</em></code>
+ suEXEC does not allow <code><em>root</em></code>
to execute CGI/SSI programs.
</p>
</li>
<p class="indent">
If it doesn't exist, it can't very well contain files. If we
- can't change directory to it, it might aswell not exist.
+ can't change directory to it, it might as well not exist.
</p>
</li>
<li>
- <strong>Is the directory within the Apache
- webspace?</strong>
+ <strong>Is the directory within the httpd webspace?</strong>
<p class="indent">
If the request is for a regular portion of the server, is
together with the <code>--enable-suexec</code> option to let
APACI accept your request for using the suEXEC feature.</dd>
+ <dt><code>--enable-suexec-capabilities</code></dt>
+
+ <dd><strong>Linux specific:</strong> Normally,
+ the <code>suexec</code> binary is installed "setuid/setgid
+ root", which allows it to run with the full privileges of the
+ root user. If this option is used, the <code>suexec</code>
+ binary will instead be installed with only the setuid/setgid
+ "capability" bits set, which is the subset of full root
+ priviliges required for suexec operation. Note that
+ the <code>suexec</code> binary may not be able to write to a log
+ file in this mode; it is recommended that the
+ <code>--with-suexec-syslog --without-suexec-logfile</code>
+ options are used in conjunction with this mode, so that syslog
+ logging is used instead.</dd>
+
<dt><code>--with-suexec-bin=<em>PATH</em></code></dt>
<dd>The path to the <code>suexec</code> binary must be hard-coded
<dt><code>--with-suexec-caller=<em>UID</em></code></dt>
<dd>The <a href="mod/mpm_common.html#user">username</a> under which
- Apache normally runs. This is the only user allowed to
- execute this program.</dd>
+ httpd normally runs. This is the only user allowed to
+ execute the suEXEC wrapper.</dd>
<dt><code>--with-suexec-userdir=<em>DIR</em></code></dt>
<dt><code>--with-suexec-docroot=<em>DIR</em></code></dt>
- <dd>Define as the DocumentRoot set for Apache. This will be
+ <dd>Define as the DocumentRoot set for httpd. This will be
the only hierarchy (aside from <code class="directive"><a href="./mod/mod_userdir.html#userdir">UserDir</a></code>s) that can be used for suEXEC behavior. The
default directory is the <code>--datadir</code> value with the suffix
"<code>/htdocs</code>", <em>e.g.</em> if you configure with
"<code>suexec_log</code>" and located in your standard logfile
directory (<code>--logfiledir</code>).</dd>
+ <dt><code>--with-suexec-syslog</code></dt>
+
+ <dd>If defined, suexec will log notices and errors to syslog
+ instead of a logfile. This option must be combined
+ with <code>--without-suexec-logfile</code>.</dd>
+
<dt><code>--with-suexec-safepath=<em>PATH</em></code></dt>
<dd>Define a safe PATH environment to pass to CGI
<p>If you have enabled the suEXEC feature with the
<code>--enable-suexec</code> option the <code>suexec</code> binary
- (together with Apache itself) is automatically built if you execute
+ (together with httpd itself) is automatically built if you execute
the <code>make</code> command.</p>
<p>After all components have been built you can execute the
always the possibility that a system or library call suEXEC uses
before this check may be exploitable on your system. To counter
this, and because it is best-practise in general, you should use
- filesystem permissions to ensure that only the group Apache
+ filesystem permissions to ensure that only the group httpd
runs as may execute suEXEC.</p>
<p>If for example, your web server is configured to run as:</p>
- <div class="example"><p><code>
- User www<br />
- Group webgroup<br />
- </code></p></div>
+ <pre class="prettyprint lang-config">
+User www
+Group webgroup
+ </pre>
+
<p>and <code class="program"><a href="./programs/suexec.html">suexec</a></code> is installed at
"/usr/local/apache2/bin/suexec", you should run:</p>
chmod 4750 /usr/local/apache2/bin/suexec<br />
</code></p></div>
- <p>This will ensure that only the group Apache runs as can even
+ <p>This will ensure that only the group httpd runs as can even
execute the suEXEC wrapper.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
<h2><a name="enable" id="enable">Enabling & Disabling
suEXEC</a></h2>
- <p>Upon startup of Apache, it looks for the file
+ <p>Upon startup of httpd, it looks for the file
<code class="program"><a href="./programs/suexec.html">suexec</a></code> in the directory defined by the
<code>--sbindir</code> option (default is
- "/usr/local/apache/sbin/suexec"). If Apache finds a properly
+ "/usr/local/apache/sbin/suexec"). If httpd finds a properly
configured suEXEC wrapper, it will print the following message
to the error log:</p>
it, or the executable is not installed <em>setuid root</em>.</p>
<p>If you want to enable the suEXEC mechanism for the first time
- and an Apache server is already running you must kill and
- restart Apache. Restarting it with a simple HUP or USR1 signal
+ and an Apache HTTP Server is already running you must kill and
+ restart httpd. Restarting it with a simple HUP or USR1 signal
will not be enough. </p>
<p>If you want to disable suEXEC you should kill and restart
- Apache after you have removed the <code class="program"><a href="./programs/suexec.html">suexec</a></code> file.</p>
+ httpd after you have removed the <code class="program"><a href="./programs/suexec.html">suexec</a></code> file.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
<div class="section">
<h2><a name="usage" id="usage">Using suEXEC</a></h2>
<p>The suEXEC wrapper will write log information
to the file defined with the <code>--with-suexec-logfile</code>
- option as indicated above. If you feel you have configured and
- installed the wrapper properly, have a look at this log and the
- error_log for the server to see where you may have gone astray.</p>
+ option as indicated above, or to syslog if <code>--with-suexec-syslog</code>
+ is used. If you feel you have configured and
+ installed the wrapper properly, have a look at the log and the
+ error_log for the server to see where you may have gone astray.
+ The output of <code>"suexec -V"</code> will show the options
+ used to compile suexec, if using a binary distribution.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
<div class="section">
<p><strong>NOTE!</strong> This section may not be
complete. For the latest revision of this section of the
- documentation, see the Apache Group's <a href="http://httpd.apache.org/docs/trunk/suexec.html">Online
+ documentation, see the <a href="http://httpd.apache.org/docs/trunk/suexec.html">Online
Documentation</a> version.</p>
<p>There are a few points of interest regarding
virtual host requests, or one top-level personal document
root for userdir requests. For example, if you have four
VirtualHosts configured, you would need to structure all
- of your VHosts' document roots off of one main Apache
+ of your VHosts' document roots off of one main httpd
document hierarchy to take advantage of suEXEC for
VirtualHosts. (Example forthcoming.)
</p>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="./en/suexec.html" title="English"> en </a> |
+<a href="./fr/suexec.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
<a href="./ja/suexec.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="./ko/suexec.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
<a href="./tr/suexec.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
-</div><div id="footer">
-<p class="apache">Copyright 2008 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>
-<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div>
+</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>
+<script type="text/javascript"><!--//--><![CDATA[//><!--
+var comments_shortname = 'httpd';
+var comments_identifier = 'http://httpd.apache.org/docs/trunk/suexec.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 2012 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>
+<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[//><!--
+if (typeof(prettyPrint) !== 'undefined') {
+ prettyPrint();
+}
+//--><!]]></script>
</body></html>
\ No newline at end of file