fileServer

Project 5, CS270: Systems Programming with Dr.Raphael Finkel, a file server written in C.
Authors: Tanner Palin and Will Shapiro.
Sources and Credits: We were able to create this server by following an outline found here written by Brian Hall.

Compilation

• Running make from the command line will compile the server as well as the Client methods.
• Running make clean will clean up all resulting executables and object files.
• Running make zip will zip all of our .c files and README.md into a project5.zip for submission.

Server

Our actual file server is found within the filed.c file.
Our main() within filed.c is a little verbose and it would be ideal to seperate the different cases into different procedures. However, due to time-constraints for this project, we let decided that this would be alright for the minimally viable solution.

filed Usage

To start the server, you must execute the following bash command line instruction after compilation:

./filed port secretKey

• Where port is the port number that the server will begin listening to.
• secretKey is the secret key (unsigned int) that clients must use to authenticate their request.

The server will then listen to the port and display rudimentary information about the requests that it receives.

API Client methods

We have four different files which will make different requests to our server found in filed.c These three methods can be found in: newKey.c, fileGet.c, fileDigest.c, and fileRun.c

newKey Usage

When performing a newKey request, the execution from the command line should like:

./newKey machineName port secretKey newSecretKey

• Where machineName is the IP Address of DNS Name of the machine that the server is running on.
• port is the port number that the server will be listening to on the machine.
• secretKey is the current secret key (a 32-bit unsigned integer) that the server is using to authenticate requests.
• newSecretKey is the new secret key (32-bit unsigned integer) that the server will use upon success of the request.

fileGet Usage

When performing a fileGet request, the execution from the command line should like:

./fileGet machineName port secretKey fileName

• Where machineName is the IP Address of DNS Name of the machine that the server is running on.
  
• port is the port number that the server will be listening to on the machine.
• secretKey is the current secret key (a 32-bit unsigned integer) that the server is using to authenticate requests.
  
• fileName is the name of a file (100 character maximum) stored on the server.

Upon success of this request, the client will receive the first 100 bytes of the file stored on the server.

fileDigest Usage

When performing a fileDigest request, the execution from the command line should like:

./fileDigest machineName port secretKey fileName

• Where machineName is the IP Address of DNS Name of the machine that the server is running on.
  
• port is the port number that the server will be listening to on the machine.
• secretKey is the current secret key (a 32-bit unsigned integer) that the server is using to authenticate requests.
  
• fileName is the name of a file (100 character maximum) stored on the server.

Upon success of this request, the client will receive a 100 byte cryptographic digest of the file stored on the server.

fileRun Usage

When performing a fileRun request, the execution from the command line should like:

./fileRun machineName port secretKey runType

• Where machineName is the IP Address of DNS Name of the machine that the server is running on.
  
• port is the port number that the server will be listening to on the machine.
• secretKey is the current secret key (a 32-bit unsigned integer) that the server is using to authenticate requests.
  
• runType is an abbreviation for the execution type. Either: "inet", "service", "hosts", or "identity".
  • inet runs the following bash command line instruction /bin/ip address POSSIBLE BUG ALERT
  • service runs the following bash command line instruction /bin/cat /etc/services POSSIBLE BUG ALERT
  • hosts runs the following bash command line instruction /bin/cat /etc/hosts POSSIBLE BUG ALERT
  • identity runs the following bash command line instruction /bin/hostname POSSIBLE BUG ALERT

Upon success of this request, the client will receive 100 bytes of output from the execution of the run type.

Examples

A working example of executables can be found in the finkelServer folder. Use localhost or 127.0.0.1 for the machine name in the command line of your client applications if the server and client are running on the same machine.