ffi-tox 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ea0d69f0ac06a753a7fb1299542b5f5ebfe935d
+  data.tar.gz: ecbc2f0a1fec17416aa57890fe6be315225d7d18
+SHA512:
+  metadata.gz: 68ae7ba6278cb10d41dbe042f59d10304444b25ef7802c0c19919e3ca63a93c86efb6cb5af63cb979906da9f6cacab43ddf85a434092bd550ed41151dbe7ff01
+  data.tar.gz: 678b27211d2dd376c8ee8d631c2f44b8da2b9039c68fa535e36bfeeb06dab5554cbc286b356183053fc5d6e61031e1a2f67e429c839bce17f14086bca6a28a41

data/ProjectTox-Core/CMakeLists.txt

@@ -1,11 +1,31 @@
 cmake_minimum_required(VERSION 2.6.0)
 
+set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
+if(NOT WIN32)
+	option(USE_NACL "Use NaCl library instead of libsodium")
+endif()
+
+if(USE_NACL)
+	find_package(NaCl REQUIRED)
+
+	include_directories(${NACL_INCLUDE_DIR})
+	add_definitions(-DVANILLA_NACL)
+
+	set(LINK_CRYPTO_LIBRARY ${NACL_LIBRARIES})
+endif()
+
 #MinGW prints more warnings for -Wall than gcc does, thus causing build to fail
 if(NOT WIN32)
 	if(("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU") OR ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang"))
 		message(STATUS "==== ${CMAKE_C_COMPILER_ID} detected - Adding compiler flags ====")
 		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Werror")
 	endif()
+	find_package(SODIUM REQUIRED)
+endif()
+
+if(NOT USE_NACL)
+	 set(LINK_CRYPTO_LIBRARY ${SODIUM_LIBRARY})
 endif()
 
 macro(linkCoreLibraries exe_name)
@@ -16,8 +36,10 @@ macro(linkCoreLibraries exe_name)
 		${CMAKE_SOURCE_DIR}/sodium/lib/libsodium.a
 			ws2_32)
 	else()
+		include_directories(${SODIUM_INCLUDE_DIR})
 		target_link_libraries(${exe_name} core
-			sodium)
+			${LINK_CRYPTO_LIBRARY})
+
 	endif()
 endmacro()
 
@@ -25,4 +47,4 @@ cmake_policy(SET CMP0011 NEW)
 
 add_subdirectory(core)
 add_subdirectory(testing)
-add_subdirectory(other)
+add_subdirectory(other)

data/ProjectTox-Core/INSTALL.md

@@ -1,12 +1,25 @@
+#Install Instructions
+
+- [Installation](#installation)
+    - [Linux](#linux)
+    - [OS X](#osx)
+      - [Homebrew](#homebrew)
+      - [Non-Homebrew](#non-homebrew)
+    - [Windows](#windows)
+- [Usage](#usage)
+
+<a name="installation" />
 ##Installation
 
+<a name="linux" />
 ###Linux:
 
 Build dependencies:
 
 ```bash
-apt-get install build-essential libtool autotools-dev automake libconfig-dev ncurses-dev cmake
+apt-get install build-essential libtool autotools-dev automake libconfig-dev ncurses-dev cmake checkinstall
 ```
+Note that `libconfig-dev` should be >= 1.4.
 
 You should get and install [libsodium](https://github.com/jedisct1/libsodium):
 ```bash
@@ -15,15 +28,18 @@ cd libsodium
 git checkout tags/0.4.2
 ./autogen.sh
 ./configure && make check
-sudo make install
+sudo checkinstall --install --pkgname libsodium --pkgversion 0.4.2 --nodoc
 sudo ldconfig
 ```
 
-Then clone this repo and run:
+Then clone this repo and generate makefile:
 ```bash
+git clone git://github.com/irungentoo/ProjectTox-Core.git
+cd ProjectTox-Core
 mkdir build && cd build
 cmake ..
 ```
+Note that you should call cmake on the root [`CMakeLists.txt`](/CMakeLists.txt) file only.
 
 Then you can build any of the [`/testing`](/testing) and [`/other`](/other) that are currently supported on your platform by running:
 ```bash
@@ -39,9 +55,22 @@ Or you could just build everything that is supported on your platform by running
 make
 ```
 
-###OSX:
+<a name="osx" />
+###OS X:
 
-Much the same as above, remember to install the latest XCode and the developer tools (Preferences -> Downloads -> Command Line Tools).
+<a name="homebrew" />
+####Homebrew:
+```
+brew install libtool automake autoconf libconfig libsodium cmake
+cmake .
+make
+sudo make install
+```
+
+<a name="non-homebrew" />
+####Non-homebrew:
+
+Much the same as Linux, remember to install the latest XCode and the developer tools (Preferences -> Downloads -> Command Line Tools).
 Users running Mountain Lion and the latest version of XCode (4.6.3) will also need to install libtool, automake and autoconf.
 They are easy enough to install, grab them from http://www.gnu.org/software/libtool/, http://www.gnu.org/software/autoconf/ and http://www.gnu.org/software/automake/, then follow these steps for each:
 
@@ -58,6 +87,7 @@ Another thing you may want to install is the latest gcc, this caused me a few pr
 no longer includes gcc and instead uses LLVM-GCC, a nice install guide can be found at
 http://caiustheory.com/install-gcc-421-apple-build-56663-with-xcode-42
 
+<a name="windows" />
 ###Windows:
 
 You should install:
@@ -75,6 +105,7 @@ Navigate in `cmd` to this repo and run:
 mkdir build && cd build
 cmake -G "MinGW Makefiles" ..
 ```
+Note that you should call cmake on the root [`CMakeLists.txt`](/CMakeLists.txt) file only.
 
 Then you can build any of the [`/testing`](/testing) and [`/other`](/other) that are currently supported on your platform by running:
 ```cmd
@@ -89,3 +120,8 @@ Or you could just build everything that is supported on your platform by running
 ```bash
 mingw32-make
 ```
+
+<a name="usage" />
+## Usage
+
+- [Start Guide](start_guide.md)

data/ProjectTox-Core/README.md

@@ -1,54 +1,53 @@
 ![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")
-Project Tox, _also known as Tox_, is a FOSS instant messaging application aimed to replace Skype.<br />
+Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.<br />
 
-With the rise of governmental monitoring programs, Tox aims to be an easy to use application that allows people to connect with friends and loved ones without the worry of privacy.<br /> <br />
+With the rise of governmental monitoring programs, Tox aims to be an easy to use, all-in-one communication platform (including audio, and videochats in the future) that ensures their users full privacy and secure message delivery.<br /> <br />
 
 
 
-
-**IRC**: #tox on Freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).<br />
+**IRC**: #tox on freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).<br />
 **Website**: [http://tox.im](http://tox.im)
 
 **Website translations**: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)<br/>
 **Qt GUI**: [see nurupo's repository](https://github.com/nurupo/ProjectTox-Qt-GUI)
 
+**How to build Tox on Linux**: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)<br />
+**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ)<br />
+**For Mac OSX read INSTALL.md**
+
+### Objectives:
 
+Keep everything really simple.
 
 ## The Complex Stuff:
-+ Tox must use UDP simply because you can't hole punch with TCP. It's possible, but it doesn't work all the time.
-+ Every peer is represented as a byte string (the public key of the peer [client id])
++ Tox must use UDP simply because [hole punching](http://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
++ Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (the public key of the peer [client ID]).
 + We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.
 + Once the client has the IP of that peer, they start initiating a secure connection with each other. (See [Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto))
-+ When both peers are securely connect with the encryption, they can securely exchange messages, initiate a video chat, send files, etc.<br />
-+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core) 
++ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications.
++ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
 
 ## Roadmap:
-- [x] Get our DHT working perfectly.(Done, needs large scale testing though.)
-- [x] Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)
+- [x] Get our DHT working perfectly. (Done, needs large scale testing though)
+- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see `DHT_sendfiletest.c` for an example)
 - [x] Encryption. (Done)
-- [ ] Get a simple text only im client working perfectly. (This is where we are)
-- [ ] Streaming media
-- [ ] ???
+- [  ] Get a simple text only IM client working perfectly. (This is where we are)
+- [  ] Streaming media
+- [  ] ???
 
 For further information, check our [To-do list](https://github.com/irungentoo/ProjectTox-Core/wiki/TODO)
 
-
-### Important-stuff:
-
-Use the same UDP socket for everything
-
-Keep everything really simple.
-
-### Details and Documents:
-
-[DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br />
-[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br />
-[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br />
-[Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas)
-
 ### Why are you doing this? There are already a bunch of free skype alternatives.
-The goal of this project is to create a configuration-free p2p skype 
+The goal of this project is to create a configuration-free P2P skype 
 replacement. Configuration-free means that the user will simply have to open the program and 
 without any account configuration will be capable of adding people to his 
-friends list and start conversing with them. There are many so called skype replacements and all of them are either hard to 
-configure for the normal user or suffer from being much too centralized.
+friends list and start conversing with them. There are many so-called skype replacements and all of them are either hard to 
+configure for the normal user or suffer from being way too centralized.
+
+### Documentation:
+
+- [Installation](/INSTALL.md)
+- [DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br />
+- [Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br />
+- [Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br />
+- [Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas)

data/ProjectTox-Core/cmake/FindLIBCONFIG.cmake

@@ -0,0 +1,15 @@
+# Find LIBCONFIG
+#
+# LIBCONFIG_INCLUDE_DIR
+# LIBCONFIG_LIBRARY
+# LIBCONFIG_FOUND
+#
+
+FIND_PATH(LIBCONFIG_INCLUDE_DIR NAMES libconfig.h)
+
+FIND_LIBRARY(LIBCONFIG_LIBRARY NAMES config)
+
+INCLUDE(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(LIBCONFIG DEFAULT_MSG LIBCONFIG_LIBRARY LIBCONFIG_INCLUDE_DIR)
+
+MARK_AS_ADVANCED(LIBCONFIG_INCLUDE_DIR LIBCONFIG_LIBRARY)

data/ProjectTox-Core/cmake/FindNaCl.cmake

@@ -0,0 +1,17 @@
+find_path(NACL_INCLUDE_DIR crypto_box.h
+	$ENV{NACL_INCLUDE_DIR} /usr/include/nacl/
+	DOC "Directory which contain NaCl headers")
+
+find_path(NACL_LIBRARY_DIR libnacl.a
+	$ENV{NACL_LIBRARY_DIR} /usr/lib/nacl
+	DOC "Directory which contain libnacl.a, cpucycles.o, and randombytes.o")
+
+if(NACL_LIBRARY_DIR)
+	set(NACL_LIBRARIES
+		"${NACL_LIBRARY_DIR}/cpucycles.o"
+		"${NACL_LIBRARY_DIR}/libnacl.a"
+		"${NACL_LIBRARY_DIR}/randombytes.o")
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(NaCl DEFAULT_MSG NACL_INCLUDE_DIR NACL_LIBRARY_DIR NACL_LIBRARIES)

data/ProjectTox-Core/cmake/FindSODIUM.cmake

@@ -0,0 +1,15 @@
+# Find SODIUM
+#
+# SODIUM_INCLUDE_DIR
+# SODIUM_LIBRARY
+# SODIUM_FOUND
+#
+
+FIND_PATH(SODIUM_INCLUDE_DIR NAMES sodium.h)
+
+FIND_LIBRARY(SODIUM_LIBRARY NAMES sodium)
+
+INCLUDE(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(SODIUM DEFAULT_MSG SODIUM_LIBRARY SODIUM_INCLUDE_DIR)
+
+MARK_AS_ADVANCED(SODIUM_INCLUDE_DIR SODIUM_LIBRARY)

data/ProjectTox-Core/core/CMakeLists.txt

@@ -3,6 +3,8 @@ project(core C)
 
 if(WIN32)
 	include_directories(${CMAKE_HOME_DIRECTORY}/sodium/include/)
+else(WIN32)
+	include_directories(${SODIUM_INCLUDE_DIR})
 endif()
 
 set(core_sources

data/ProjectTox-Core/core/Lossless_UDP.c

@@ -308,12 +308,16 @@ IP_Port connection_ip(int connection_id)
 /* returns the number of packets in the queue waiting to be successfully sent. */
 uint32_t sendqueue(int connection_id)
 {
+    if (connection_id < 0 || connection_id >= MAX_CONNECTIONS)
+        return 0;
     return connections[connection_id].sendbuff_packetnum - connections[connection_id].successful_sent;
 }
 
 /* returns the number of packets in the queue waiting to be successfully read with read_packet(...) */
 uint32_t recvqueue(int connection_id)
 {
+    if (connection_id < 0 || connection_id >= MAX_CONNECTIONS)
+        return 0;
     return connections[connection_id].recv_packetnum - connections[connection_id].successful_read;
 }
 
@@ -321,6 +325,8 @@ uint32_t recvqueue(int connection_id)
    return -1 if no packet in queue */
 char id_packet(int connection_id)
 {
+    if (connection_id < 0 || connection_id >= MAX_CONNECTIONS)
+        return -1;
     if (recvqueue(connection_id) != 0 && connections[connection_id].status != 0)
         return connections[connection_id].recvbuffer[connections[connection_id].successful_read % MAX_QUEUE_NUM].data[0];
     return -1;

data/ProjectTox-Core/core/Messenger.c

@@ -99,18 +99,21 @@ int getclient_id(int friend_id, uint8_t *client_id)
    client_id is the client id of the friend
    data is the data and length is the length
    returns the friend number if success
-   return -1 if failure. */
+   return -1 if key length is wrong.
+   return -2 if user's own key
+   return -3 if already a friend
+   return -4 for other*/
 int m_addfriend(uint8_t *client_id, uint8_t *data, uint16_t length)
 {
     if (length == 0 || length >=
         (MAX_DATA_SIZE - crypto_box_PUBLICKEYBYTES - crypto_box_NONCEBYTES - crypto_box_BOXZEROBYTES + crypto_box_ZEROBYTES))
         return -1;
     if (memcmp(client_id, self_public_key, crypto_box_PUBLICKEYBYTES) == 0)
-        return -1;
+        return -2;
     if (getfriend_id(client_id) != -1)
-        return -1;
+        return -3;
     uint32_t i;
-    for (i = 0; i <= numfriends; ++i) {
+    for (i = 0; i <= numfriends; ++i) { /*TODO: dynamic memory allocation, this will segfault if there are more than MAX_NUM_FRIENDS*/
         if(friendlist[i].status == 0) {
             DHT_addfriend(client_id);
             friendlist[i].status = 1;
@@ -126,7 +129,7 @@ int m_addfriend(uint8_t *client_id, uint8_t *data, uint16_t length)
             return i;
         }
     }
-    return -1;
+    return -4;
 }
 
 int m_addfriend_norequest(uint8_t * client_id)
@@ -134,7 +137,7 @@ int m_addfriend_norequest(uint8_t * client_id)
     if (getfriend_id(client_id) != -1)
         return -1;
     uint32_t i;
-    for (i = 0; i <= numfriends; ++i) {
+    for (i = 0; i <= numfriends; ++i) {/*TODO: dynamic memory allocation, this will segfault if there are more than MAX_NUM_FRIENDS*/
         if(friendlist[i].status == 0) {
             DHT_addfriend(client_id);
             friendlist[i].status = 2;
@@ -163,11 +166,13 @@ int m_delfriend(int friendnumber)
     free(friendlist[friendnumber].userstatus);
     memset(&friendlist[friendnumber], 0, sizeof(Friend));
     uint32_t i;
+
     for (i = numfriends; i != 0; --i) {
-        if (friendlist[i].status != 0)
+        if (friendlist[i-1].status != 0)
             break;
     }
     numfriends = i;
+
     return 0;
 }
 
@@ -178,7 +183,7 @@ int m_delfriend(int friendnumber)
    return 0 if there is no friend with that number */
 int m_friendstatus(int friendnumber)
 {
-    if (friendnumber < 0 || friendnumber >= MAX_NUM_FRIENDS)
+    if (friendnumber < 0 || friendnumber >= numfriends)
         return 0;
     return friendlist[friendnumber].status;
 }
@@ -188,7 +193,7 @@ int m_friendstatus(int friendnumber)
    return 0 if it was not */
 int m_sendmessage(int friendnumber, uint8_t *message, uint32_t length)
 {
-    if (friendnumber < 0 || friendnumber >= MAX_NUM_FRIENDS)
+    if (friendnumber < 0 || friendnumber >= numfriends)
         return 0;
     if (length >= MAX_DATA_SIZE || friendlist[friendnumber].status != 4)
         /* this does not mean the maximum message length is MAX_DATA_SIZE - 1, it is actually 17 bytes less. */
@@ -240,6 +245,16 @@ int setname(uint8_t * name, uint16_t length)
     return 0;
 }
 
+/* get our nickname
+   put it in name 
+   name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH bytes.
+   return the length of the name */
+uint16_t getself_name(uint8_t *name)
+{
+    memcpy(name, self_name, self_name_length);
+    return self_name_length;
+} 
+
 /* get name of friendnumber
    put it in name
    name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH bytes.

data/ProjectTox-Core/core/Messenger.h

@@ -46,11 +46,14 @@ extern "C" {
     to an absurdly large number later */
 
 /* add a friend
-    set the data that will be sent along with friend request
-    client_id is the client id of the friend
-    data is the data and length is the length
-    returns the friend number if success
-    return -1 if failure. */
+   set the data that will be sent along with friend request
+   client_id is the client id of the friend
+   data is the data and length is the length
+   returns the friend number if success
+   return -1 if key length is wrong.
+   return -2 if user's own key
+   return -3 if already a friend
+   return -4 for other*/
 int m_addfriend(uint8_t *client_id, uint8_t *data, uint16_t length);
 
 
@@ -92,6 +95,11 @@ int m_sendmessage(int friendnumber, uint8_t *message, uint32_t length);
    return -1 if failure */
 int setname(uint8_t *name, uint16_t length);
 
+/* get our nickname
+   put it in name 
+   return the length of the name*/
+uint16_t getself_name(uint8_t *name);
+
 /* get name of friendnumber
     put it in name
     name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.