This repository contains a simple implementation of an http webserver, together with its test, a doxygen documentation and a sample document root.
- Simple content serving from 3 different web roots (1 "protected" with basic authentication)
- Basic authentication with standard htpasswd file (SHA1 only)
The makefile provides 2 ways of installing and running the server. There is a manual way, and a full installation, which even populates the content folders.
No matter which way you prefer, you have to do the initial preparation and then continue with the manual way or the automatic way.
-
Install git and make
Example for Debian/Ubuntu:
sudo apt-get install git build-essential -y -
Install the needed libraries, if they are not already installed.
OpenSSL and the Magic library are needed.
Example for Debian/Ubuntu:
sudo apt-get install libmagic-dev # Install Magic sudo apt-get install libssl-dev # Install OpenSSL -
Clone the git repository to a folder you like to run the program from.
For this example we will assume that we clone to /home/user/documents and reference it through the whole readme.
Example if you have a valid ssh key added to GitLab:
cd /home/user/documents git clone ssh://git@git.fh-muenster.de:2323/lr413680/pse2019-gruppe09.gitExample if you want to use http, in this case you will be asked for your GitLab credentials:
cd /home/user/documents git clone https://git@git.fh-muenster.de:2323/lr413680/pse2019-gruppe09.git -
Now go into the newly created folder with the project in it by calling
cd ./pse2019-gruppe09/ -
Do the settings you want by editing http_settings.h. This has to be done before the build with make!
For example you can change the server port and buffersize and give it a unique name.
Note: Please only change the path settings, if you are using manual installation, because automatic installation only works with the standard folders! All other settings can be changed as you want.
Now we are ready to do the final installation by using one of the two ways.
The automatic version is the preferred one because of convenience.
If you install the program this way, the built executable will be copied to /usr/local/bin and you can call it from anywhere. For this you need to be able to call sudo.
Also the standard webroot is copied to /usr/local/webroot so you wont have to do anything.
IMPORTANT: For automatic installation it is required that all paths are default in the settings, otherwise the webroot wont be found!
-
Build the executable by calling make (you have to still be in the folder where you ended preperation)
make -
Call make install, to copy everything to the right place. For this you need to call it with sudo or the current user has to have write right to /usr/local/.
sudo make install -
At this point you should call make clean, even if it is not necessary
make clean -
Now the program is installed and can be called system wide by simply calling
http_server
If you dont longer need the server it can be deinstalled automatically. This will only work if the program was installed the automatic way!
To do so, simply call:
sudo make uninstall
This will delete the executable and the whole webroot. Keep that in mind to not loose your websites!
-
Copy the webroot to the path specified in the settings. You can also create the folders yourself, and directly put your own website, htpasswd and status pages.
Keep in mind that every path can be set to somewhere else, so simply copying the webroot may not work!
-
Build the executable by calling make (you have to still be in the folder where you ended preperation)
make -
In the folder you now find the executable called http_server. This file can be copied to anywhere you want, but for now we will assume that you leve it where it is.
Now if you are still in the folder where the file lies, you can start the server by calling:
./http_serveror if you are not in the folder where the file lies:
/home/user/documents/pse2019-gruppe09/http_server
Note: If you want to serve your own websites, simply put them into the webroot folders for the different host, specified in the settings.
The repository contains a test suite running in python, that checks each function of the server for normal operation.
After the installation of the server, you can confirm that everything is configured properly by running the tests.
If Python 3 is not installed already, you have to do it now by calling:
sudo apt-get install python3
Now to run the test, start the server, navigate to the test folder in the project folder (/home/user/documents/pse2019-gruppe09/test in our example) and run the test:
http_server
cd /home/user/documents/pse2019-gruppe09/test
python3 tests.py
When the program is finished, you can look at the output. The program will show a summary showing the number of failures and successful requests. If a test failed, scroll up to see which one it was, and what went wrong.
Note: If all tests fail and the failure is
"Connecting failed: [Errno 111] Connection refused"
check the port in the settings. If you changed it, you have to change it at the beginning of test.py too!
Settings have to be done before the build is done. To change the settings, open http_settings.h and edit it to your needs:
-
The name of the server to be put into the HTTP responses.
Default:
#define SERVER_NAME "HTTP-Server 09 1.0" -
The HTTP version to be send in the header.
Please only change if you know what you are doing, because the server is HTTP/1.1 changing this could make it incompatible to any browser!
Default:
#define HTTP_VERSION "HTTP/1.1"
-
The tcp port, the server listens on for requests. For usage of http standard port 80, the program has to be run as superuser so it is not used by default.
Default:
#define PORT 31337 -
The size of the buffer, used for reading messages from the tcp connection. Choose an appropriate size, if it is to small, longer messages can not be responded to. But keep in mind that the memory has to be allocated, so it also can not be infinitely huge.
Default this is set to 1 MB, because we are not handling any received content, so the messages should not be larger than that.
The value has to be given in bytes.
Default:
#define BUFFER_SIZE 1000000
-
This is the path where all files that should be served when no special host is requested or the host is unknown lie.
Default:
#define DEFAULT_DOCUMENT_ROOT "/usr/local/webroot/default/" -
This is the path where all files that should be served when the host "extern" is requested lie.
Default:
#define EXTERN_DOCUMENT_ROOT "/usr/local/webroot/extern/" -
This is the path where all files that should be served when the host "intern" is requested lie. Keep in mind that this document root, is "protected" via basic authentication. The credentials lie in the htpasswd file.
Default:
#define INTERN_DOCUMENT_ROOT "/usr/local/webroot/intern/" -
This path contains all status pages. Each status page is named after its status. Each status has its own site, and any html file with a fitting name can be used.
For example a page for status 505 is named: "505.html"
Default:
#define STATUS_SITE_PATH "/usr/local/webroot/status/" -
This path contains the htpasswd file. The server only supports SHA1 encrypted credentials, so keep in mind to set the -s flag when creating credentials with htpasswd.
This file can be created by the command:
htpasswd -s -c htpasswd [username]Using this command, the htpasswd file will be created or updated, the user [username] will be created and you will be promted to type in a password for the new user.
Default:
#define HTPASSWD_PATH "/usr/local/webroot/htpasswd"