diff --git a/Readme.md b/Readme.md index e6271d7..311edff 100644 --- a/Readme.md +++ b/Readme.md @@ -1,11 +1,11 @@ # Shape Game ## Setup -* use 3 linux computers connecting in a lan -* clone the repo `git clone ` -* install `sh install.sh` -* compile `make` +* Use 3 linux computers connecting in a lan +* Clone the repo `git clone ` +* Install `sh install.sh` (this will work only with aptitude ) +* Compile `make` * Start server `./bin/server.out 4444` -* get server ip `ifconfig` +* Get server ip `ifconfig` * Take note of `eth0` or `enp2s0`; **note::** the numbers might be different * Start a client @@ -13,5 +13,19 @@ * Bob `./bin/server.out 2 4444 ` * Eve `./bin/server.out 3 4444 ` -## How it works +## How to run +Using the `up`, `down`, `left`, `right` arrow keys to change shape. `space bar` will send the message openly, which will demo the unsecured connection. `enter \ return ` will demo the encrypted message. +### Encryption +encryption is done by mapping shapes to fruit. As Eve only knows what shapes are Alice and Bob and use their fruit code to translate shapes to fruit and vise versa + +## Example +### Server +![pics/server.png](pics/server.png) +### Client +Starting +![pics/start.png](pics/start.png) +Clients select shape before send +![pics/select_shape.png](pics/select_shape.png) +Alice send message to Bob non-encrypted while bob used encryption. Take note that Eve can only read Alice's message. +![pics/send.png](pics/send.png) diff --git a/pics/select_shape.png b/pics/select_shape.png new file mode 100644 index 0000000..68d6b66 Binary files /dev/null and b/pics/select_shape.png differ diff --git a/pics/send.png b/pics/send.png new file mode 100644 index 0000000..bf6f035 Binary files /dev/null and b/pics/send.png differ diff --git a/pics/server.png b/pics/server.png new file mode 100644 index 0000000..7414ddd Binary files /dev/null and b/pics/server.png differ diff --git a/pics/start.png b/pics/start.png new file mode 100644 index 0000000..7e1c2e4 Binary files /dev/null and b/pics/start.png differ