summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAgatha <agatha@ubuntu.(none)>2014-03-04 07:48:38 -0500
committerAgatha <agatha@ubuntu.(none)>2014-03-04 07:48:38 -0500
commit1cb38abf999b5bc0b0eddad43760c31580dc2d48 (patch)
tree435ff4475844fa20bc8796ce6d106c305115e0d8 /docs
parent602c71bc17d4c23f6d0968aa09b9b058bff57862 (diff)
Minor documentation cleanup
This commit fixes some typos and grammar mistakes. It also fixes some of the long text lines and generally makes the documentation more readable.
Diffstat (limited to 'docs')
-rw-r--r--docs/Hardening.txt2
-rw-r--r--docs/Hardening_docs.txt25
-rw-r--r--docs/Prevent_Tracking.txt42
-rw-r--r--docs/TCP_Network.txt10
4 files changed, 44 insertions, 35 deletions
diff --git a/docs/Hardening.txt b/docs/Hardening.txt
index d95b2cda..50ccfd53 100644
--- a/docs/Hardening.txt
+++ b/docs/Hardening.txt
@@ -21,7 +21,7 @@ The only people we really trust on the network are the nodes in our friends
21list. 21list.
22 22
23 23
24The behavior of each Tox node is easily predictable this means that it possible 24The behavior of each Tox node is easily predictable. This means that it possible
25for Tox nodes to test the nodes that they are connected to to see if they 25for Tox nodes to test the nodes that they are connected to to see if they
26behave like normal Tox nodes and only send nodes that are confirmed to behave 26behave like normal Tox nodes and only send nodes that are confirmed to behave
27like real Tox nodes as part of send node replies when other nodes query them. 27like real Tox nodes as part of send node replies when other nodes query them.
diff --git a/docs/Hardening_docs.txt b/docs/Hardening_docs.txt
index c5de6ade..53a61034 100644
--- a/docs/Hardening_docs.txt
+++ b/docs/Hardening_docs.txt
@@ -1,21 +1,30 @@
1Hardening request packets are sent as crypto request packets (see crypto docs.) 1Hardening request packets are sent as crypto request packets (see crypto docs.)
2NOTE: currently only get nodes requests are tested in the code which is why there is only one test (more will be added soon.) 2NOTE: currently only get nodes requests are tested in the code which is why
3there is only one test (more will be added soon.)
3 4
4All hardening requests must contain exactly 768 bytes of data. (The data sent must be padded with zeros if it is smaller than that.) 5All hardening requests must contain exactly 768 bytes of data. (The data sent
6must be padded with zeros if it is smaller than that.)
5 7
61. Get the information (IP_port, client_id) of the node we want to test. 81. Get the information (IP_port, client_id) of the node we want to test.
72. Find a couple random nodes that is not that node (one for each test.) 92. Find a couple random nodes that is not that node (one for each test.)
83. Send crypto request packets to each of these random nodes with the data being: 103. Send crypto request packets to each of these random nodes with the data being:
9 11
10[byte with value: 02 (get nodes test request)][struct Node_format (the node to test.)][client_id(32 bytes) the id to query the node with.][padding] 12[byte with value: 02 (get nodes test request)][struct Node_format (the node to
13test.)][client_id(32 bytes) the id to query the node with.][padding]
11 14
124. The random node receives a packet. 154. The random node receives a packet.
13-The packet is a get nodes test request: 16-The packet is a get nodes test request:
14 send a get_node request to that node with the id to query in the request. 17 send a get_node request to that node with the id to query in the request.
15 when a send_node response is received, send the following response to the person who sent us the get nodes test request packet: 18 when a send_node response is received, send the following response to the
16 [byte with value: 03 (get nodes test response)][client_id(32 bytes): the id of the tested node][The list of nodes it responded with in IPv6 Node format (struct Node_Format)] 19 person who sent us the get nodes test request packet:
17 PROTIP: (get node requests and response contain an encrypted part that you can use to store information so that you don't 20 [byte with value: 03 (get nodes test response)][client_id(32 bytes):
18 have to store in your memory where/if to send back the response from the send node) 21 the id of the tested node][The list of nodes it responded with in IPv6
22 Node format (struct Node_Format)]
23 PROTIP: (get node requests and response contain an encrypted part that you
24 can use to store information so that you don't
25 have to store in your memory where/if to send back the response from the
26 send node)
19 27
205. Receive the test responses. 285. Receive the test responses.
21-If the test(s) pass (the nodes behave in a satisfactory manner), make these nodes have priority over those who don't pass the test(s). 29-If the test(s) pass (the nodes behave in a satisfactory manner), make these
30nodes have priority over those who don't pass the test(s).
diff --git a/docs/Prevent_Tracking.txt b/docs/Prevent_Tracking.txt
index 07e8ae1e..c5f33e96 100644
--- a/docs/Prevent_Tracking.txt
+++ b/docs/Prevent_Tracking.txt
@@ -21,36 +21,36 @@ So, every node in the DHT now has a temporary keypair not related to their real
21long term one. 21long term one.
22 22
23But, how do people find themselves then? We have to add a way for people to 23But, how do people find themselves then? We have to add a way for people to
24tell their friends what their DHT public key is, we also have to somehow make 24tell their friends what their DHT public key is. We also have to somehow make
25it so people can send/receive friend requests, this has to be done without non 25it so people can send/receive friend requests. This has to be done without
26friends being able to find out where a node is. 26non-friends being able to find out where a node is.
27 27
28The solution: Onion routing + enable the storage of some small amount of data 28The solution: Onion routing + enable the storage of some small amount of data
29on 29on DHT nodes.
30DHT nodes.
31 30
32 31
33Alice and bob are friends, before joining the DHT they generate temporary 32Alice and bob are friends. Before joining the DHT they generate temporary
34session keypairs to be used for the DHT instead of their long term keys. 33session keypairs to be used for the DHT instead of their long term keys.
35 34
36Bob finds a bunch of random nodes then picks 3 random working ones (A, B, C). 35Bob finds a bunch of random nodes then picks 3 random working ones (A, B, C).
37 36
38Bob gets the know working node with an id closest to his real one from his list (D) 37Bob gets the known working node with an id closest to his real one from his list (D)
39 38
40Bob then creates an onion (the packet will go through A, B, C and will end up at D) 39Bob then creates an onion (the packet will go through A, B, C and will end up at D)
41announce request packet with his real public key, ping_id as zeros and 40announce request packet with his real public key, ping_id as zeros and
42searching for his real public key. 41searching for his real public key.
43 42
44Bob will announce response packets and will recursively send onion announce request packets 43Bob will announce response packets and will recursively send onion announce request
45to closer and closer nodes until he finds the ones closest to his real public key. 44packets to closer and closer nodes until he finds the ones closest to his real public key.
46 45
47Once he has done this, he will send some onion announce request packets with the right ping_id previously 46Once he has done this, he will send some onion announce request packets with the right
48received from the node when he queried it to announce himself to the node. 47ping_id previously received from the node when he queried it to announce himself to the node.
49 48
50The nodes he announces himself to keep the information to send onion packets to that node in memory. 49The nodes he announces himself to keep the information to send onion packets to that node in
50memory.
51 51
52Alice meanwhile searches for the Nodes closest to Bobs real id using a temporary keypair and announce 52Alice meanwhile searches for the nodes closest to Bobs real id using a temporary keypair and
53request packets, she does this until she finds nodes that respond with a ping_id of zero. 53announce request packets. She does this until she finds nodes that respond with a ping_id of zero.
54 54
55She sends data to route request packet with information telling Bob her temporary id in the DHT 55She sends data to route request packet with information telling Bob her temporary id in the DHT
56(or a friend request if she is not friends with him). 56(or a friend request if she is not friends with him).
@@ -58,9 +58,9 @@ She sends data to route request packet with information telling Bob her temporar
58Bob finds her by using her temporary id and they connect to each other. 58Bob finds her by using her temporary id and they connect to each other.
59 59
60 60
61NOTE: crypto_box is used for all the asymmetric encryption and crypto_secretbox is used for all the symmetric. 61NOTE: crypto_box is used for all the asymmetric encryption and crypto_secretbox is used for all
62Also every DHT node have a random symmetric key which they use to encrypt the stuff in normal get node request that is 62the symmetric. Also every DHT node have a random symmetric key which they use to encrypt the stuff
63used to encrypt stuff in the following. 63in normal get node request that is used to encrypt stuff in the following.
64 64
65Onion packet (request): 65Onion packet (request):
66 66
@@ -151,7 +151,7 @@ encrypted with temp symmetric key of Node A: [IP_Port (of us)][data to send back
151 151
152Data packets: 152Data packets:
153 153
154To tell our friend what our DHT public key is so that he can connect to us we send a data packet with id 156 and 154To tell our friend what our DHT public key is so that he can connect to us we send a data packet
155the data being:[uint64_t (in network byte order) no_replay, the packet will only be accepted if this number is bigger than the last one recieved] 155with id 156 and the data being:[uint64_t (in network byte order) no_replay, the packet will only be
156[our dht public key][Node_Format * (maximum of 8) nodes closest to us so that the friend can find us faster] 156accepted if this number is bigger than the last one recieved] [our dht public key][Node_Format * (
157 157maximum of 8) nodes closest to us so that the friend can find us faster]
diff --git a/docs/TCP_Network.txt b/docs/TCP_Network.txt
index e8608791..b1059892 100644
--- a/docs/TCP_Network.txt
+++ b/docs/TCP_Network.txt
@@ -14,8 +14,8 @@ How it's probably going to work:
141. Alice, a Tox client on a TCP only network generates a temporary public key 141. Alice, a Tox client on a TCP only network generates a temporary public key
15and connects to a bootstrap node. 15and connects to a bootstrap node.
16 16
172. Using the bootstrap node she find and connects to a couple (exact number 172. Using the bootstrap node she finds and connects to a (exact number to be
18to be determined later) number of random nodes that have TCP relay support. 18determined later) number of random nodes that have TCP relay support.
19 19
203. She uses the onion through the TCP relay connections to send friend requests 203. She uses the onion through the TCP relay connections to send friend requests
21or tell online friends which TCP nodes she is connected to and her temporary 21or tell online friends which TCP nodes she is connected to and her temporary
@@ -28,8 +28,8 @@ with alice using that temporary public key.
285. That connection is used by both to transmit encrypted Messenger and A/V 285. That connection is used by both to transmit encrypted Messenger and A/V
29packets. 29packets.
30 30
316. If one of the nodes shuts down while it is currently routing traffic, Alice 316. If one of the nodes shuts down while it is routing traffic, Alice and Bob
32and bob just switch to one of the other nodes they are both connected to. 32just switch to one of the other nodes to which they are both connected.
33 33
34 34
35Actual detailed implementation details coming soon. 35Actual implementation details coming soon.