aboutsummaryrefslogtreecommitdiff
path: root/src/lib/tls
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-04 11:51:38 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-04 11:51:38 -0500
commit76e8effc7b8e747cd34188a5a27e6d792a66ba7e (patch)
tree4f860630375bbed2e613f61c2c4473303be5451e /src/lib/tls
parentfd271363296b89cb3a11e97e507546b3600fde59 (diff)
downloadtor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.tar.gz
tor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.zip
Doxygen: document the rest of the directories in lib.
(This copies documentation from doc/HACKING/design, and edits for concisensess and clarity.)
Diffstat (limited to 'src/lib/tls')
-rw-r--r--src/lib/tls/lib_tls.dox11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/lib/tls/lib_tls.dox b/src/lib/tls/lib_tls.dox
index 9558687f66..f0dba269e8 100644
--- a/src/lib/tls/lib_tls.dox
+++ b/src/lib/tls/lib_tls.dox
@@ -1,4 +1,13 @@
/**
@dir /lib/tls
-@brief lib/tls
+@brief lib/tls: TLS library wrappers
+
+This module has compatibility wrappers around the library (NSS or OpenSSL,
+depending on configuration) that Tor uses to implement the TLS link security
+protocol.
+
+It also implements the logic for some legacy TLS protocol usage we used to
+support in old versions of Tor, involving conditional delivery of certificate
+chains (v1 link protocol) and conditional renegotiation (v2 link protocol).
+
**/