Contents of this page are obsolete. This page is preserved and stored at this URL just from historical viewpoint. Original URL was http://www.mm.media.kyoto-u.ac.jp/members/kameda/...
Please visit www.kameda-lab.org for recent information. (2002/12/06, kameda@ieee.org)

Apache suEXEC Support

What is suEXEC?

The suEXEC feature, introduced in Apache 1.2 provides the ability to run CGI programs under user ids different from the user id of the calling web-server. Used properly, this feature can reduce considerably the insecurity of allowing users to run CGI programs. At the same time, improperly configured, this facility can crash your computer, burn your house down and steal all the money from your retirement fund. :-) If you aren't familiar with managing setuid root programs and the security issues they present, we highly recommend that you not consider using this feature.

Enabling suEXEC Support

Having said all that, enabling this feature is purposefully difficult with the intent that it will only be installed by users determined to use it and is not part of the normal install/compile process.

Configuring the suEXEC wrapper

cd support [ENTER]

Edit the suexec.h file and change the following macros to match your local Apache installation.

From support/suexec.h

/*
 * HTTPD_USER -- Define as the username under which Apache normally
 *               runs.  This is the only user allowed to execute
 *               this program.
 */
#define HTTPD_USER "www"

/*
 * LOG_EXEC -- Define this as a filename if you want all suEXEC
 *             transactions and errors logged for auditing and
 *             debugging purposes.
 */
#define LOG_EXEC "/usr/local/etc/httpd/logs/cgi.log"

/*
 * DOC_ROOT -- Define as the DocumentRoot set for Apache.  This
 *             will be the only hierarchy (aside from UserDirs)
 *             that can be used for suEXEC behavior.
 */
#define DOC_ROOT "/usr/local/etc/httpd/htdocs"

/*
 * SAFE_PATH -- Define a safe PATH environment to pass to CGI executables.
 *
 */
#define SAFE_PATH "/usr/local/bin:/usr/bin:/bin"

Compiling the suEXEC wrapper

cc suexec.c -o suexec [ENTER]

This should create the suexec wrapper executable.

Compiling Apache for suEXEC support

From src/httpd.h

/* The path to the suEXEC wrapper */
#ifndef SUEXEC_BIN
#define SUEXEC_BIN "/usr/local/etc/httpd/sbin/suexec"
#endif

If your installation requires location of the wrapper program in a different directory, edit src/httpd.h and recompile your Apache server. See Compiling and Installing Apache for more info on this process.

Installing the suEXEC wrapper

suexec

SUEXEC_BIN

In order for the wrapper to set the user id for execution requests it must me installed as owner root and must have the setuserid execution bit set for file modes. If you are not running a root user shell, do so now and execute the following commands.

chown root /usr/local/etc/httpd/sbin/suexec [ENTER]

chmod 4711 /usr/local/etc/httpd/sbin/suexec [ENTER]

Change the path to the suEXEC wrapper to match your system installation.

Security Model of suEXEC

The suEXEC wrapper supplied with Apache performs the following security checks before it will execute any program passed to it for execution.

User executing the wrapper must be a valid user on this system.
User executing the wrapper must be the compiled in HTTPD_USER.
The command that the request wishes to execute must not contain a /.
The command being executed must reside under the compiled in DOC_ROOT.
The current working directory must be a directory.
The current working directory must not be writable by group or other.
The command being executed cannot be a symbolic link.
The command being executed cannot be writable by group or other.
The command being executed cannot be a setuid or setgid program.
The target UID and GID must be a valid user and group on this system.
The target UID and GID to execute as, must match the UID and GID of the directory.
The target execution UID and GID must not be the privledged ID 0.

If any of these issues are too restrictive, or do not seem restrictive enough, you are welcome to install your own version of the wrapper. We've given you the rope, now go have fun with it. :-)

Using suEXEC

After properly installing the suexec wrapper executable, you must kill and restart the Apache server. A simple kill -1 `cat httpd.pid` will not be enough. Upon startup of the web-server, if Apache finds a properly configured suexec wrapper, it will print the following message to the console.

Configuring Apache for use with suexec wrapper.

If you don't see this message at server startup, the server is most likely not finding the wrapper program where it expects it, or the executable is not installed setuid root. Check your installation and try again.

One way to use suEXEC is through the User and Group directives in VirtualHost definitions. By setting these directives to values different from the main server user id, all requests for CGI resources will be executed as the User and Group defined for that <VirtualHost>. If only one or neither of these directives are specified for a <VirtualHost> then the main server userid is assumed.

suEXEC can also be used to to execute CGI programs as the user to which the request is being directed. This is accomplished by using the ~ character prefixing the user id for whom execution is desired. The only requirement needed for this feature to work is for CGI execution to be enabled for the user and that the script must meet the scrutiny of the security checks above.

Debugging suEXEC

The suEXEC wrapper will write log information to the location defined in the suexec.h 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.