update read me

This commit is contained in:
beta 2019-05-04 09:51:54 -05:00
parent 93527b9071
commit 12d61f4538
5 changed files with 20 additions and 6 deletions

View File

@ -1,11 +1,11 @@
# Shape Game
## Setup
* use 3 linux computers connecting in a lan
* clone the repo `git clone <repo url>`
* install `sh install.sh`
* compile `make`
* Use 3 linux computers connecting in a lan
* Clone the repo `git clone <repo url>`
* 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 <server ip>`
* Eve `./bin/server.out 3 4444 <server ip>`
## 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)

BIN
pics/select_shape.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
pics/send.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

BIN
pics/server.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

BIN
pics/start.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB