summaryrefslogtreecommitdiff
path: root/src/lib/tls/lib_tls.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-15 09:27:26 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-15 09:28:12 -0500
commit8b91680d5c57fc35275b32aea57555d8ef7d61ba (patch)
tree5040bae10d88ba7810d5c9b5517e1e355a080f11 /src/lib/tls/lib_tls.md
parent3a7369d0cfa567cdb02063e1dad176c92ef2c7fe (diff)
downloadtor-8b91680d5c57fc35275b32aea57555d8ef7d61ba.tar.gz
tor-8b91680d5c57fc35275b32aea57555d8ef7d61ba.zip
Doxygen: rename all .dox files to end with .md
Using a standard ending here will let other tools that expect markdown understand our output here. This commit was automatically generated with: for fn in $(find src -name '*.dox'); do \ git mv "$fn" "${fn%.dox}.md"; \ done
Diffstat (limited to 'src/lib/tls/lib_tls.md')
-rw-r--r--src/lib/tls/lib_tls.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib/tls/lib_tls.md b/src/lib/tls/lib_tls.md
new file mode 100644
index 0000000000..26fea723f9
--- /dev/null
+++ b/src/lib/tls/lib_tls.md
@@ -0,0 +1,11 @@
+@dir /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).
+