Added docs detailing containing latest protocol changes.

1 files changed, 77 insertions, 0 deletions

diff --git a/docs/updates/Crypto.md b/docs/updates/Crypto.md
new file mode 100644
index 00000000..6b489c3b
--- /dev/null
+++ b/docs/updates/Crypto.md
@@ -0,0 +1,77 @@
+Draft proposal for how crypto will be implemented.
+
+
+Encryption library used: http://nacl.cr.yp.to/
+
+
+When running the program for the first time the crypto_box_keypair() function is used to 
+generate the users public-private key pair. (32 bytes each)
+
+The generated public key is set as the client_id of the peer.
+
+Note that only the crypto connection runs on top of Lossless UDP. The friend requests do not.
+
+Adding a friend
+---------------
+
+Alice adds bob to her friends list by adding his 32 byte public key (client_id) to her friends list.  
+2 cases:  
+case 1: Alice adds Bobs public key and bob waits for Alice to attempt to connect to him.  
+case 2: Bob and Alice add their respective public keys to their friends list at the same time.  
+    
+case 1:  
+Alice sends a crypto request packet to bob with the encrypted part containing the friends request like so:  
+```
+[char with a value of 32][nospam number (4 bytes)][Message]
+```
+
+Ex message: hello bob it's me alice -_- add me pl0x.
+
+For more info on the nospam see: [[Spam Prevention]]
+        
+Bob receives the request and decrypts the message using the function crypto_box_open()
+        
+If the message decrypts successfully:   
+If Alice is already in Bobs friends list: case 2  
+If Alice is not in Bob's friends list and the nospam is good: Bob is prompt to add Alice and is shown the message from her.  
+If Bobs accepts Alice's friends request he adds her public key to his friends list.  
+
+case 2:  
+Bob and Alice both have the others public key in their friends list, they are ready for the next step:   Connecting to an already added friend
+
+In the next step only crypto_box() is used for encryption and only crypto_box_open() for decryption (just like in the last step.)
+
+
+Connecting to an already added friend
+-------------------------------------
+
+Alice and Bob are friends.  
+As soon as they connect they each generate a new keypair which will only be used for the current connection (The session keys).  
+They then send themselves the following packet (the crypto handshake) (encrypted part encrypted with the public nonce in the packet the public key of the receiver and private key of the sender) 
+```
+[char with a value of 02][Senders Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message containing: [random 24 bytes base nonce][session public key of the peer (32 bytes)]]
+```
+    
+If the packet is decrypted successfully:  
+Each start using the secret nonce, the public key provided by the other and their own session private key to encrypt data packets (adding to it + 1 for each packet.) 
+Each node sends themselves an empty data packet (data packet with 4 encrypted zero bytes)  
+Data packet:  
+````
+[char with a value of 03][Encrypted data]
+````
+Each data packet received is decrypted using the secret nonce sent to the other (with +1 added for the first packet +2 for the second, etc...) along with the private session key of the receiver.  
+Every data packet sent is encrypted using the secret nonce we received (with +1 added for the first packet +2 for the second, etc...), the session public key of the receiver and the session private key of the sender.  
+    
+The encrypted connection is only deemed successful when the empty data packet is received and decrypted successfully.
+
+
+Crypto request packets
+--------------------------------------
+
+```
+[char with a value of 32][Bob's (The reciever's) Public key (client_id) (32 bytes))][Alice's (The sender's) Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message]
+```
+
+The encrypted message is encrypted with crypto_box() (using Bobs public key, Alice's private key and the nonce (randomly generated 24 bytes)) and is a message from Alice in which she tells Bob who she is.
+
+Each node can route the request to the reciever if they are connected to him. This is to bypass bad NATs.