diff options
author | Tom Cocagne <devnull@localhost> | 2011-04-01 00:14:29 -0400 |
---|---|---|
committer | Tom Cocagne <devnull@localhost> | 2011-04-01 00:14:29 -0400 |
commit | df477f67f50cfbbd6ed189ea983a2c991e4cb143 (patch) | |
tree | 7617893e88510ab4494a16c7ce3ff14273bc3798 /README.txt | |
parent | eddf3e82d22944c022e4e48d214f08c95ddae5a9 (diff) |
Documentation updates for 1.0
Diffstat (limited to 'README.txt')
-rw-r--r-- | README.txt | 30 |
1 files changed, 22 insertions, 8 deletions
@@ -1,19 +1,33 @@ -This package provides a Python Implementation of the Secure Remote -Password Protocol. 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. +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 doc sphinx-build -b html . <desired output directory> + +** Note: The Sphinx documentation system is easy-installable: + easy-install sphinx |