Assignment 1: Silly Web Proxy (25 marks)

Due: Thursday, February 2, 2012 (11:59pm)

The purpose of this assignment is to learn about the World Wide Web and the HyperText Transfer Protocol (HTTP). Along the way, you will also learn a bit about client-server socket programming, Web proxies, network debugging, and more.

Although it is only January at the moment, it is time to start thinking about some fun April Fool's jokes that you can play on your family and friends in the spring. Since you are now taking the Networks class, you can ramp things up a notch this year in a technologically-savvy way. In particular, you are going to implement a Web proxy that alters selected content on a Web page before it gets displayed in a Web browser. This should be a fun way to confuse your family and friends!

A Web proxy is a software entity that functions as an intermediary between a Web client (browser) and a Web server. The Web proxy intercepts Web requests from clients and reformulates the requests for transmission to a Web server. When a response is received from the Web server, the proxy sends the response back to the client. From the server's point of view, the proxy is the client. Similarly, from the client's point of view, the proxy is the server. A Web proxy thus provides a single point of control to regulate Internet access between clients and servers. This is also a natural point to implement content manipulation, if so desired.

In this assignment, you will implement and test a simple Web proxy in C or C++. The goals of the assignment are to build a properly functioning Web proxy for simple Web pages, and then to apply some simple content manipulation techniques to alter some of the content being displayed. In particular, you are required to reverse any text strings that appear within HTML level 1 (h1) header formatting commands. For example, a Web page that contains the snippet

Assignment 1

would have this header text rendered as

1 tnemngissA

You can assume that each HTML header tag is properly terminated on the Web page.

The most important HTTP command for your Web proxy to handle is the "GET" request, which specifies the URL for an object to be retrieved. In the basic operation of your proxy, it should be able to parse, understand, and forward to the Web server a (possibly modified) version of the client request. Similarly, the proxy should be able to parse, understand, and return to the client a (possibly modified) version of the response that the Web server provided to the proxy. Your proxy should be able to handle response codes such as 200 (OK) and 404 (Not Found) correctly, notifying the client as appropriate. HTTP request redirection (302) should also be supported. Reasonable handling of browser-initiated Conditional GET requests and 304 (Not Modified) responses is also desirable, but not mandatory.

You will need at least one TCP (stream) socket for client-proxy communication, and at least one additional TCP (stream) socket for proxy-server communication. If you want your proxy to support multiple concurrent HTTP transactions (recommended), you will need to fork child processes (or threads) for request handling as well. Each child process or thread will use its own socket instances for its communications with the client and with the server.

You should be able to compile and run your Web proxy on any department machine, or even your home machine. You should be able to use your proxy from a modern Web browser (e.g., Internet Explorer, Mozilla Firefox, Chrome, Safari), and from any machine (either on campus or at home). To test the proxy, you will have to configure your Web browser to use your specific Web proxy (e.g., look for menu selections like Tools, Internet Options, Proxies).

As you design and build your Web proxy, give careful consideration to how you will debug and test it. For example, you may want to print out information about requests and responses received, processed, forwarded, redirected, or altered. Once you become confident with the basic operation of your Web proxy, you can toggle off the verbose debugging output. If you are testing on your home network, you can also use tools like wireshark or tcpdump to collect network packet traces. By studying the HTTP/TCP packets going to and from your proxy, you can convince yourself (and perhaps your TA) that it is working properly.

The primary test of correctness for your proxy is a simple visual test. That is, for most Web pages, the content displayed by your Web browser should look the same regardless of whether you are using your Web proxy or retrieving content directly from the Web server. The only differences appear when you try to access content that has HTML header formatting, such as this simple test file. In this case, the hilarious reversal of text will occur. What a hoot!

When you are finished, please email your solution in electronic form to your TA, attaching a single gzipped tar file. Your submission should include the source code for your Web proxy, a brief user manual describing how to compile and use your proxy, and a description of the testing done with your proxy.

The proposed grading scheme for the assignment is as follows:

• 10 marks for the design and implementation of a functional Web proxy that can handle simple HTTP GET interactions between client and server, using either HTTP/1.0 or HTTP/1.1. This basic proxy should be able to deliver Web pages in unaltered form, and be able to handle HTTP redirection when it occurs. Your implementation should include proper use of TCP/IP socket programming in C or C++, and reasonably commented code. Two of the 10 marks will be awarded for suitable design of a non-blocking (i.e., multi-process or multi-threaded) proxy.
• 5 marks for that part of your silly Web proxy that can parse HTML pages and selectively alter the socket byte stream within h1 header formatting commands. To obtain full marks, you must be able to process all such occurrences on a given Web page. Partial marks (2 out of 5) will be awarded if you can only handle one such occurrence.
• 5 marks for a clear and concise user manual (about 1 page) that describes how to compile, configure, and use your Web proxy. Make sure to indicate the required features and optional features (if any) that the proxy supports. Make sure to clarify where and how the testing was done (e.g., home, university, office), what works, and what does not. Be honest!
• 5 marks for a suitable demonstration of the workings of your proxy to your TA (or prof) at a mutually convenient time. The latter is particularly important if your Web proxy is not fully working.
• up to 3 bonus marks are available for any other (reasonably clever) features that you choose to add to your silly Web proxy in preparation for April Fool's Day.

Please remember that assignments are to be done individually, and submitted to your assigned TA on time. Have fun!

TIPS

If you have never done socket programming in C before, you should make sure to get to your tutorial on January 18. You may also find the following two examples highly instructive. The first is echoserver.c, which simply repeats back to you whatever you type. The second is myserver.c, which tells you how many letters there are in a given word. You can invoke it using myclient.c

Focus on the basic HTTP proxy functionality first, by simply forwarding everything that you receive from the client directly to the server, and everything you receive from the server directly back to the client. Then add more functionality, such as HTTP redirection, text parsing, and text reversal.

BIG HINT: Your proxy will need one socket for talking to the client, and another socket for talking to the server. Make sure to keep track of which one is which!

Additional Hint: Your proxy will actually need to dynamically create a socket for every new server that it talks to. Make sure to manage these properly.

Small Hint: Start with very simple HTML text files, such as the simple test file. Once you have this working, then you can try more complicated Web pages with embedded objects, images, and such.