toxcore/README.md

Tox
===

Current IRC: #InsertProjectNameHere
on Freenode or [webchat](https://webchat.freenode.net/)


Proposal of a free as in freedom skype replacement:

## Basics:

UDP must be used for everything simply because you can't do hole punching with TCP (well you can but it doesn't work all the time)
    
Every peer is represented as a byte string (the client id) (it is the hash (SHA-256?) of the public key of the peer). (if you want to add someone you need that id (either ask that person directly or maybe through some kind of search engine?))
    
Use something torrent DHT style 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.(asymmetric encryption(RSA?)  is used to encrypt the session keys for the symmetric(AES?) encryption so that they are exchanged securely) 
(We can't use public key encryption for everything it's too fucking slow) man in the middle attacks are avoided because the id is the hash of the public key (the client can be sure it's legit.)
    
When both peers are securely connected with the encryption(AES?) they can securely exchange messages, initiate a video chat, send files, etc...
    
Your client stores the id of the peers along with their public keys used to initiate the connection (this is your contacts list)

## Roadmap:

1. Get our DHT working perfectly.(Done, needs large scale testing though.)
2. Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)
3. Encryption. (this is where we are now)
4. Optimize for streaming media.
5. 

## TODO:
    
See: [docs/TODO.txt](https://github.com/irungentoo/InsertProjectNameHere/blob/master/docs/TODO.txt)

### Important-stuff:

Use the same UDP socket for everything

Keep everything really simple.

### Details:

DHT protocol:
    see: [docs/DHT.txt](/docs/DHT.txt)
    
Lossless UDP protocol:
    Either we find one with an already working implementation (Didn't find a good implementation, writing my own)
    see also: [docs/Lossless_UDP.txt](/docs/Lossless_UDP.txt)
Even more header fixing 2013-06-26 06:46:45 +08:00			`Tox`
Initial commit 2013-06-24 08:12:13 +08:00			`===`
Update README.md 2013-06-24 08:15:33 +08:00
Added IRC. 2013-06-24 08:42:35 +08:00			`Current IRC: #InsertProjectNameHere`
GitHub does not support IRC:// links 2013-06-26 07:00:55 +08:00			`on Freenode or [webchat](https://webchat.freenode.net/)`
Added IRC. 2013-06-24 08:42:35 +08:00

Update README.md 2013-06-24 08:15:33 +08:00			`Proposal of a free as in freedom skype replacement:`

More header markdown cleanup 2013-06-26 06:45:41 +08:00			`## Basics:`
Update README.md 2013-06-24 08:15:33 +08:00
Stuff added 2013-06-27 02:07:01 +08:00			`UDP must be used for everything simply because you can't do hole punching with TCP (well you can but it doesn't work all the time)`
Update README.md 2013-06-24 08:15:33 +08:00
Add .txt links 2013-06-26 07:08:32 +08:00			`Every peer is represented as a byte string (the client id) (it is the hash (SHA-256?) of the public key of the peer). (if you want to add someone you need that id (either ask that person directly or maybe through some kind of search engine?))`
Update README.md 2013-06-24 08:15:33 +08:00
Removed many indents for readability 2013-06-26 06:54:52 +08:00			`Use something torrent DHT style so that peers can find the ip of the other peers when they have their id.`
Update README.md 2013-06-24 08:15:33 +08:00
Removed many indents for readability 2013-06-26 06:54:52 +08:00			`Once the client has the ip of that peer they start initiating a secure connection with each other.(asymmetric encryption(RSA?) is used to encrypt the session keys for the symmetric(AES?) encryption so that they are exchanged securely)`
			`(We can't use public key encryption for everything it's too fucking slow) man in the middle attacks are avoided because the id is the hash of the public key (the client can be sure it's legit.)`
Update README.md 2013-06-24 08:15:33 +08:00
Added small things to readme. 2013-06-26 08:41:13 +08:00			`When both peers are securely connected with the encryption(AES?) they can securely exchange messages, initiate a video chat, send files, etc...`
Update README.md 2013-06-24 08:15:33 +08:00
Removed many indents for readability 2013-06-26 06:54:52 +08:00			`Your client stores the id of the peers along with their public keys used to initiate the connection (this is your contacts list)`
Update README.md 2013-06-24 08:15:33 +08:00
Testing if removing the after-hash marks is valid markdown 2013-06-26 06:52:34 +08:00			`## Roadmap:`
Update README.md 2013-06-24 08:15:33 +08:00
Updated docs. 2013-06-26 08:33:23 +08:00			`1. Get our DHT working perfectly.(Done, needs large scale testing though.)`
Added a new test program. Fixed some stuff in Lossless UDP. 2013-07-01 05:19:15 +08:00			`2. Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)`
			`3. Encryption. (this is where we are now)`
			`4. Optimize for streaming media.`
			`5.`
Update README.md 2013-06-24 08:15:33 +08:00
Testing if removing the after-hash marks is valid markdown 2013-06-26 06:52:34 +08:00			`## TODO:`
Fixed one possible bug in the DHT and added a basic TODO list. Fixed a possible segfault which could have been cause by handling an empty packet. 2013-06-26 05:16:45 +08:00
Add .txt links 2013-06-26 07:08:32 +08:00			`See: [docs/TODO.txt](https://github.com/irungentoo/InsertProjectNameHere/blob/master/docs/TODO.txt)`
Fixed one possible bug in the DHT and added a basic TODO list. Fixed a possible segfault which could have been cause by handling an empty packet. 2013-06-26 05:16:45 +08:00
More header markdown cleanup 2013-06-26 06:45:41 +08:00			`### Important-stuff:`
Update README.md 2013-06-24 08:15:33 +08:00
Removed many indents for readability 2013-06-26 06:54:52 +08:00			`Use the same UDP socket for everything`
Update README.md 2013-06-24 08:15:33 +08:00
Updated docs. 2013-06-26 20:32:42 +08:00			`Keep everything really simple.`

Testing if removing the after-hash marks is valid markdown 2013-06-26 06:52:34 +08:00			`### Details:`
Update README.md 2013-06-24 08:15:33 +08:00
Removed many indents for readability 2013-06-26 06:54:52 +08:00			`DHT protocol:`
Relative links in Readme. 2013-06-27 07:55:34 +08:00			`see: [docs/DHT.txt](/docs/DHT.txt)`
Update README.md 2013-06-24 08:15:33 +08:00
Updated docs. 2013-06-26 08:33:23 +08:00			`Lossless UDP protocol:`
Added Draft of proposed Lossless UDP protocol. 2013-06-27 07:47:38 +08:00			`Either we find one with an already working implementation (Didn't find a good implementation, writing my own)`
Relative links in Readme. 2013-06-27 07:55:34 +08:00			`see also: [docs/Lossless_UDP.txt](/docs/Lossless_UDP.txt)`