Using the modified Apache web server in OpenBSD
Apache's httpd is a good web server. OpenBSD is a good operating system. How can we make the combination work even better?
We can add compression of the HTTP data transfer if the client's browser supports it (and unless they are using something truly ancient or bizarre, it should).
This should improve page load time and it may significantly reduce bandwidth utilization at both the server and client ends. How much of an improvement? Since images are already compressed, the improvement you get will depend on how much of a typical page is HTML (the content and the markup, including style details) as opposed to image comment.
But won't this increase the server CPU load? Surprisingly, not nearly as much as you would expect! That is, unless you are dynamically generating your pages, and maybe not even then. Linux Journal had an article about this.
If you are concerned, here is the result of using
to run the command:
top -d 1
on this server as it was generating this page. Really.
load averages: 0.26, 0.49, 0.42 07:16:04 29 processes: 1 running, 27 idle, 1 on processor CPU states: 0.6% user, 0.0% nice, 2.1% system, 0.1% interrupt, 97.2% idle Memory: Real: 20M/420M act/tot Free: 1588M Swap: 0K/262M used/tot PID USERNAME PRI NICE SIZE RES STATE WAIT TIME CPU COMMAND 6636 www 2 0 3032K 5152K sleep netcon 3:42 0.00% httpd 26650 www 2 0 3012K 5108K sleep netcon 3:41 0.00% httpd 11832 www 2 0 3060K 5160K sleep netcon 3:39 0.00% httpd 19790 www 2 0 3072K 5184K sleep netcon 3:35 0.00% httpd 10584 www 2 0 3040K 5168K sleep netcon 3:33 0.00% httpd 24205 www 2 0 3036K 5172K sleep netcon 3:32 0.00% httpd 10779 www -6 0 3064K 5172K sleep piperd 3:31 0.00% httpd 21734 www 2 0 3036K 5156K sleep netcon 3:31 0.00% httpd 12248 www 2 0 3048K 5176K sleep netcon 3:29 0.00% httpd 21463 www 2 0 3040K 5152K sleep netcon 3:26 0.00% httpd 25738 root 2 0 2844K 5848K sleep select 0:06 0.00% httpd 5211 root 2 0 1060K 1764K sleep select 0:00 0.00% sendmail 22672 root 2 0 504K 1272K sleep select 0:28 0.00% sshd 26009 _syslogd 2 0 444K 732K sleep poll 0:10 0.00% syslogd 1445 root 2 0 604K 832K sleep select 0:00 0.00% cron 21620 _ntp 2 0 540K 756K idle poll 0:00 0.00% ntpd 1 root 10 0 420K 288K sleep wait 0:01 0.00% init 26734 root 2 0 544K 720K idle poll 0:00 0.00% ntpd
You can click the Reload button and you will see that things change slightly. The time (end of first line) is local time at the server, UTC-4. I would expect the CPU to be almost 100% idle, unless you happen to have loaded this page while the server is busy running a scheduled job or some other infrequent task.
What are we working with?
OpenBSD comes with something that isn't exactly Apache's httpd. The web server is the result of an OpenBSD code audit, bug patching, and hardening of something out of the Apache 1.3 web server product line. As the OpenBSD documentation says, "The OpenBSD team has added default chrooting, privilege revocation, and other security-related improvements."
Step 1 — Install the mod_gzip package
The mod_gzip Apache module is not included in the stock
It is part of the
packages and ports system.
If you have downloaded the full set of packages, you
have the file you need.
If not, it can be as simple as this if you use
# setenv PKG_PATH ftp://ftp.openbsd.org/pub/OpenBSD/`uname -r`/packages/`uname -m` # pkg_add mod_gzip
# PKG_PATH=ftp://ftp.openbsd.org/pub/OpenBSD/`uname -r`/packages/`uname -m` # pkg_add mod_gzip
Notice that those are backquotes
for command substitution!
uname commands run first,
producing output similar to
Those results are then placed into the assignment of the
Step 2 — Modify your Apache configuration file
has a nice description of how to get mod_gzip to work
in many situations,
click here to see that.
I have based what I did on his work, with some
additions required for OpenBSD or any other similarly
root, start editing
and search for the string
When you installed that package, a post-install script within
the package should have added a line loading that module.
If it did not,
find the area of the file where modules are loaded and
add a similar line (and, to help yourself in the future,
a comment!) like the following:
# Add compression LoadModule gzip_module /usr/lib/apache/modules/mod_gzip.so
Now add a stanza directly below that. It should be similar to the following, but you may want to adjust the minimum and maximum file sizes:
Step 3 — Set up the
Here is the trick required to get this to work on OpenBSD or any other chroot environment, something that isn't frequently mentioned in the documentation.
Remember that you told your compression module to
/tmp as a working area.
However, the OpenBSD web server process is using
to run in an unusual environment
(unless you have changed
to make it behave otherwise).
httpd process is running in a "sandbox" of
Its notion of the root of the file system isn't the real root.
This means that there is no "
no way to go up one level and get out of the
jail (or gaol as it's spelled in Britain).
httpd process thinks is
is really the
So, we have to create something that will appear to
be a proper
/tmp for that process.
# cd /var/www # mkdir tmp # chmod 1777 tmp
Step 4 — Let's see if that works!
Stop the running web server process:
# pkill httpd
Make sure that really worked:
# ps axuww | egrep 'PID|httpd' # lsof -i tcp:80
You may need to give an active request a moment or two to
lsof is in
root doesn't have that in the path.
Once the coast is clear, start a fresh web server process:
Yes, I probably could have done this with a HUP signal, but killing it off and starting a new one makes it a little easier to avoid sysadmin confusion. If you are concerned about not refusing a single request, look into doing it this way:
# pkill -HUP httpd
Who cares about mod_gzip, how did you do that
This page exists as an HTML file on the server containing a block like the below. The web server process executes the PHP code on the server and inserts the output in the page.
<pre style="background: #000000; color: #00ff00; font-size: 85%; padding: 5px 3px 5px 3px; border: medium solid orange;"> <?php @ passthru ('top -d 1 | grep -v "^$"'); ?> </pre> </div>
And, because of the
discussed above I had to do the following on the server
to get those two commands to work:
# cd /var/www # mkdir usr usr/bin # cp /bin/sh bin # cp /usr/bin/grep /usr/bin/top usr/bin # ldd bin/sh usr/bin/* [ ... hmm, need to include some shared libraries ... ] # mkdir usr/lib usr/libexec # cp /usr/lib/libc.so.* /usr/lib/libcurses.so.* /usr/lib/libz.so.* /usr/lib # cp /usr/libexec/ld.so usr/libexec