diff options
author | k clair <kclair@riseup.net> | 2012-10-09 11:22:02 -0700 |
---|---|---|
committer | k clair <kclair@riseup.net> | 2012-10-09 11:22:02 -0700 |
commit | 9db8b1a8c13009741606236bc00d1de827caf790 (patch) | |
tree | 187fd9a0c3f743cd76338ca89cc05007e8d02534 /srp-1.0/README.txt |
source tarball downloaded from http://pypi.python.org/packages/source/s/srp/srp-1.0.tar.gz
Diffstat (limited to 'srp-1.0/README.txt')
-rw-r--r-- | srp-1.0/README.txt | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/srp-1.0/README.txt b/srp-1.0/README.txt new file mode 100644 index 0000000..4902c9f --- /dev/null +++ b/srp-1.0/README.txt @@ -0,0 +1,33 @@ + +This package provides an implementation of the Secure Remote +Password protocol (SRP). SRP is a cryptographically +strong authentication protocol for password-based, mutual +authentication over an insecure network connection. + +It consists of 3 modules: A pure Python implementation, A ctypes + +OpenSSL implementation, and a C extension module. The ctypes & +extension modules are approximately 10-20x faster than the pure Python +implementation and can take advantage of multiple CPUs. The extension +module will be used if available, otherwise the library will fall back +to the ctypes implementation followed by the pure Python +implementation. + +Note: The test_srp.py script prints the performance timings for each +combination of hash algorithm and prime number size. This may be of +use in deciding which pair of parameters to use in the unlikely +event that the defaults are unacceptable. + +Installation: + python setup.py install + +Validity & Performance Testing: + python setup.py build + python test_srp.py + +Documentation: + cd srp/doc + sphinx-build -b html . <desired output directory> + + +** Note: The Sphinx documentation system is easy-installable: + easy-install sphinx |