[tor-commits] [bridgedb/master] Add a module docstring to bridgedb.crypto.

[isis at torproject.org]

commit a41cf0d90fd80243c0e0b81a1648c5f19598772c
Author: Isis Lovecruft <isis at torproject.org>
Date:   Tue Mar 4 04:46:27 2014 +0000

    Add a module docstring to bridgedb.crypto.
---
 lib/bridgedb/crypto.py |   24 ++++++++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)

diff --git a/lib/bridgedb/crypto.py b/lib/bridgedb/crypto.py
index 6b16e49..d615489 100644
--- a/lib/bridgedb/crypto.py
+++ b/lib/bridgedb/crypto.py
@@ -3,17 +3,33 @@
 # This file is part of BridgeDB, a Tor bridge distribution system.
 #
 # :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis at torproject.org>
-#           please also see AUTHORS file
-# :copyright: (c) 2007-2013, The Tor Project, Inc.
-#             (c) 2007-2013, all entities within the AUTHORS file
+# :copyright: (c) 2007-2014, The Tor Project, Inc.
+#             (c) 2013-2014, Isis Lovecruft
+#             (c) 2007-2014, all entities within the AUTHORS file
 # :license: 3-clause BSD, see included LICENSE for information
 
+"""crypto - BridgeDB general cryptographic utilities.
+
+**Module Overview:**
+
+..
+  crypto
+   |_getKey() - Load the master key from a file, or create a new one.
+   |
+   \_SSLVerifyingContextFactory - OpenSSL.SSL.Context factory which verifies
+      |                           certificate chains and matches hostnames.
+      |_getContext() - Retrieve an SSL context configured for certificate
+      |                verification.
+      |_getHostnameFromURL() - Parses the hostname from the request URL.
+      \_verifyHostname() - Check that the cert CN matches the request
+                           hostname.
+
+"""
 
 from __future__ import absolute_import
 from __future__ import unicode_literals
 
 import logging
-
 import os
 
 import OpenSSL.rand