From 628fb787a6c117a96ad21009de1e7eb177035643 Mon Sep 17 00:00:00 2001 From: Rich Bowen Date: Thu, 11 Mar 2010 14:17:41 +0000 Subject: [PATCH] This is part of the attempt to purge the use of 'Apache' to mean 'Apache HTTP Server' or 'httpd'. However, in the process, has come to light that it seems that this document is *WAY* overdue for a major rewrite. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@921860 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/suexec.xml | 51 +++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/docs/manual/suexec.xml b/docs/manual/suexec.xml index 5fe6dcaf20..2fa5369ccc 100644 --- a/docs/manual/suexec.xml +++ b/docs/manual/suexec.xml @@ -25,8 +25,8 @@ suEXEC Support -

The suEXEC feature provides - Apache users the ability +

The suEXEC feature provides users of the Apache + HTTP Server the ability to run CGI and SSI programs under user IDs different from the user ID of the calling web server. Normally, when a CGI or SSI program executes, it @@ -45,8 +45,8 @@

Before we begin

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.

+ you should be aware that certain assumptions are made about you and + the environment in which you will be using suexec.

First, it is assumed that you are using a UNIX derivative operating system that is capable of @@ -71,11 +71,11 @@ security risks. It is highly 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.

+ your work with the Apache HTTP Server development team for consideration.

Fourth, and last, it has been the decision of - the Apache Group to NOT make suEXEC part of - the default installation of Apache. To this end, suEXEC + the Apache HTTP Server development team to NOT make suEXEC part of + the default installation of Apache htpd. 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 @@ -83,7 +83,7 @@ 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.

@@ -99,11 +99,11 @@ taken to ensure your system's security.

suEXEC 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.

@@ -130,10 +130,10 @@

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.

@@ -244,8 +244,7 @@
  • - Is the directory within the Apache - webspace? + Is the directory within the httpd webspace?

    If the request is for a regular portion of the server, is @@ -370,7 +369,7 @@

    --with-suexec-caller=UID
    The username under which - Apache normally runs. This is the only user allowed to + httpd normally runs. This is the only user allowed to execute this program.
    --with-suexec-userdir=DIR
    @@ -395,7 +394,7 @@
    --with-suexec-docroot=DIR
    -
    Define as the DocumentRoot set for Apache. This will be +
    Define as the DocumentRoot set for httpd. This will be the only hierarchy (aside from UserDirs) that can be used for suEXEC behavior. The default directory is the --datadir value with the suffix @@ -436,7 +435,7 @@

    If you have enabled the suEXEC feature with the --enable-suexec option the suexec binary - (together with Apache itself) is automatically built if you execute + (together with httpd itself) is automatically built if you execute the make command.

    After all components have been built you can execute the @@ -462,7 +461,7 @@ 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.

    If for example, your web server is configured to run as:

    @@ -480,7 +479,7 @@ chmod 4750 /usr/local/apache2/bin/suexec
    -

    This will ensure that only the group Apache runs as can even +

    This will ensure that only the group httpd runs as can even execute the suEXEC wrapper.

    • @@ -489,10 +488,10 @@
    Enabling & Disabling suEXEC -

    Upon startup of Apache, it looks for the file +

    Upon startup of httpd, it looks for the file suexec in the directory defined by the --sbindir 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:

    @@ -505,11 +504,11 @@ it, or the executable is not installed setuid root.

    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.

    If you want to disable suEXEC you should kill and restart - Apache after you have removed the suexec file.

    + httpd after you have removed the suexec file.

    Using suEXEC @@ -556,7 +555,7 @@

    NOTE! This section may not be complete. For the latest revision of this section of the - documentation, see the Apache Group's Online Documentation version.

    @@ -576,7 +575,7 @@ 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.)

    -- 2.40.0