From 5101ef756a18baf5d7e794d15577fa73ef2a18fa Mon Sep 17 00:00:00 2001 From: Andrew Date: Sat, 20 Jul 2013 10:39:05 -0400 Subject: Fixed comments in other files as per request of jvrv --- core/net_crypto.h | 108 +++++++++++++++++++++++++++--------------------------- 1 file changed, 54 insertions(+), 54 deletions(-) (limited to 'core/net_crypto.h') diff --git a/core/net_crypto.h b/core/net_crypto.h index df2cb9ca..0bf21f60 100644 --- a/core/net_crypto.h +++ b/core/net_crypto.h @@ -26,111 +26,111 @@ #include "Lossless_UDP.h" -//Our public key. +/* Our public key. */ extern uint8_t self_public_key[crypto_box_PUBLICKEYBYTES]; extern uint8_t self_secret_key[crypto_box_SECRETKEYBYTES]; #define ENCRYPTION_PADDING (crypto_box_ZEROBYTES - crypto_box_BOXZEROBYTES) -//encrypts plain of length length to encrypted of length + 16 using the -//public key(32 bytes) of the receiver and the secret key of the sender and a 24 byte nonce -//return -1 if there was a problem. -//return length of encrypted data if everything was fine. +/* encrypts plain of length length to encrypted of length + 16 using the + public key(32 bytes) of the receiver and the secret key of the sender and a 24 byte nonce + return -1 if there was a problem. + return length of encrypted data if everything was fine. */ int encrypt_data(uint8_t * public_key, uint8_t * secret_key, uint8_t * nonce, uint8_t * plain, uint32_t length, uint8_t * encrypted); -//decrypts encrypted of length length to plain of length length - 16 using the -//public key(32 bytes) of the sender, the secret key of the receiver and a 24 byte nonce -//return -1 if there was a problem(decryption failed) -//return length of plain data if everything was fine. +/* decrypts encrypted of length length to plain of length length - 16 using the + public key(32 bytes) of the sender, the secret key of the receiver and a 24 byte nonce + return -1 if there was a problem(decryption failed) + return length of plain data if everything was fine. */ int decrypt_data(uint8_t * public_key, uint8_t * secret_key, uint8_t * nonce, uint8_t * encrypted, uint32_t length, uint8_t * plain); -//fill the given nonce with random bytes. +/* fill the given nonce with random bytes. */ void random_nonce(uint8_t * nonce); -//return 0 if there is no received data in the buffer -//return -1 if the packet was discarded. -//return length of received data if successful +/* return 0 if there is no received data in the buffer + return -1 if the packet was discarded. + return length of received data if successful */ int read_cryptpacket(int crypt_connection_id, uint8_t * data); -//return 0 if data could not be put in packet queue -//return 1 if data was put into the queue +/* return 0 if data could not be put in packet queue + return 1 if data was put into the queue */ int write_cryptpacket(int crypt_connection_id, uint8_t * data, uint32_t length); -//send a friend request to peer with public_key and ip_port. -//Data represents the data we send with the friends request. -//returns -1 on failure -//returns a positive friend request id that can be used later to see if it was sent correctly on success. +/* send a friend request to peer with public_key and ip_port. + Data represents the data we send with the friends request. + returns -1 on failure + returns a positive friend request id that can be used later to see if it was sent correctly on success. */ int send_friendrequest(uint8_t * public_key, IP_Port ip_port, uint8_t * data, uint32_t length); -//return -1 if failure -//return 0 if connection is still trying to send the request. -//return 1 if sent correctly -//return 2 if connection timed out +/* return -1 if failure + return 0 if connection is still trying to send the request. + return 1 if sent correctly + return 2 if connection timed out */ int check_friendrequest(int friend_request); -//puts the public key of the friend if public_key, the data from the request -//in data if a friend request was sent to us and returns the length of the data. -//return -1 if no valid friend requests. +/* puts the public key of the friend if public_key, the data from the request + in data if a friend request was sent to us and returns the length of the data. + return -1 if no valid friend requests. */ int handle_friendrequest(uint8_t * public_key, uint8_t * data); -//Start a secure connection with other peer who has public_key and ip_port -//returns -1 if failure -//returns crypt_connection_id of the initialized connection if everything went well. +/* Start a secure connection with other peer who has public_key and ip_port + returns -1 if failure + returns crypt_connection_id of the initialized connection if everything went well. */ int crypto_connect(uint8_t * public_key, IP_Port ip_port); -//kill a crypto connection -//return 0 if killed successfully -//return 1 if there was a problem. +/* kill a crypto connection + return 0 if killed successfully + return 1 if there was a problem. */ int crypto_kill(int crypt_connection_id); -//handle an incoming connection -//return -1 if no crypto inbound connection -//return incoming connection id (Lossless_UDP one) if there is an incoming crypto connection -//Put the public key of the peer in public_key, the secret_nonce from the handshake into secret_nonce -//and the session public key for the connection in session_key -//to accept it see: accept_crypto_inbound(...) -//to refuse it just call kill_connection(...) on the connection id +/* handle an incoming connection + return -1 if no crypto inbound connection + return incoming connection id (Lossless_UDP one) if there is an incoming crypto connection + Put the public key of the peer in public_key, the secret_nonce from the handshake into secret_nonce + and the session public key for the connection in session_key + to accept it see: accept_crypto_inbound(...) + to refuse it just call kill_connection(...) on the connection id */ int crypto_inbound(uint8_t * public_key, uint8_t * secret_nonce, uint8_t * session_key); -//accept an incoming connection using the parameters provided by crypto_inbound -//return -1 if not successful -//returns the crypt_connection_id if successful +/* accept an incoming connection using the parameters provided by crypto_inbound + return -1 if not successful + returns the crypt_connection_id if successful */ int accept_crypto_inbound(int connection_id, uint8_t * public_key, uint8_t * secret_nonce, uint8_t * session_key); -//return 0 if no connection, 1 we have sent a handshake, 2 if connexion is not confirmed yet -//(we have received a handshake but no empty data packet), 3 if the connection is established. -//4 if the connection is timed out and waiting to be killed +/* return 0 if no connection, 1 we have sent a handshake, 2 if connexion is not confirmed yet + (we have received a handshake but no empty data packet), 3 if the connection is established. + 4 if the connection is timed out and waiting to be killed */ int is_cryptoconnected(int crypt_connection_id); -//Generate our public and private keys -//Only call this function the first time the program starts. +/* Generate our public and private keys + Only call this function the first time the program starts. */ void new_keys(); -//save the public and private keys to the keys array -//Length must be crypto_box_PUBLICKEYBYTES + crypto_box_SECRETKEYBYTES +/* save the public and private keys to the keys array + Length must be crypto_box_PUBLICKEYBYTES + crypto_box_SECRETKEYBYTES */ void save_keys(uint8_t * keys); -//load the public and private keys from the keys array -//Length must be crypto_box_PUBLICKEYBYTES + crypto_box_SECRETKEYBYTES +/* load the public and private keys from the keys array + Length must be crypto_box_PUBLICKEYBYTES + crypto_box_SECRETKEYBYTES */ void load_keys(uint8_t * keys); -//run this to (re)initialize net_crypto -//sets all the global connection variables to their default values. +/* run this to (re)initialize net_crypto + sets all the global connection variables to their default values. */ void initNetCrypto(); -//main loop +/* main loop */ void doNetCrypto(); -- cgit v1.2.3