aboutsummaryrefslogtreecommitdiff
path: root/src/or/onion_tap.c
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2016-10-14 20:08:51 -0400
committerNick Mathewson <nickm@torproject.org>2016-10-17 10:16:59 -0400
commitaae034d13e458dfe82b503d3a1b54b0e5200b6b8 (patch)
treef2f69832a97045fbe2384e7320c73d3ea7c86ba8 /src/or/onion_tap.c
parent55c468c5211d5b74acb677767f14d91cd0304771 (diff)
downloadtor-aae034d13e458dfe82b503d3a1b54b0e5200b6b8.tar.gz
tor-aae034d13e458dfe82b503d3a1b54b0e5200b6b8.zip
Write a bunch of module documentation.
This commit adds or improves the module-level documenation for: buffers.c circuitstats.c command.c connection_edge.c control.c cpuworker.c crypto_curve25519.c crypto_curve25519.h crypto_ed25519.c crypto_format.c dircollate.c dirserv.c dns.c dns_structs.h fp_pair.c geoip.c hibernate.c keypin.c ntmain.c onion.c onion_fast.c onion_ntor.c onion_tap.c periodic.c protover.c protover.h reasons.c rephist.c replaycache.c routerlist.c routerparse.c routerset.c statefile.c status.c tor_main.c workqueue.c In particular, I've tried to explain (for each documented module) what each module does, what's in it, what the big idea is, why it belongs in Tor, and who calls it. In a few cases, I've added TODO notes about refactoring opportunities. I've also renamed an argument, and fixed a few DOCDOC comments.
Diffstat (limited to 'src/or/onion_tap.c')
-rw-r--r--src/or/onion_tap.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/or/onion_tap.c b/src/or/onion_tap.c
index abe779351f..2769300945 100644
--- a/src/or/onion_tap.c
+++ b/src/or/onion_tap.c
@@ -9,10 +9,22 @@
* \brief Functions to implement the original Tor circuit extension handshake
* (a.k.a TAP).
*
+ * The "TAP" handshake is the first one that was widely used in Tor: It
+ * combines RSA1024-OAEP and AES128-CTR to perform a hybrid encryption over
+ * the first message DH1024 key exchange. (The RSA-encrypted part of the
+ * encryption is authenticated; the AES-encrypted part isn't. This was
+ * not a smart choice.)
+ *
* We didn't call it "TAP" ourselves -- Ian Goldberg named it in "On the
* Security of the Tor Authentication Protocol". (Spoiler: it's secure, but
* its security is kind of fragile and implementation dependent. Never modify
* this implementation without reading and understanding that paper at least.)
+ *
+ * We have deprecated TAP since the ntor handshake came into general use. It
+ * is still used for hidden service IP and RP connections, however.
+ *
+ * This handshake, like the other circuit-extension handshakes, is
+ * invoked from onion.c.
**/
#include "or.h"