summaryrefslogtreecommitdiff
path: root/README.txt
blob: 4902c9f73e01644dac0f2aa86a58cd054f7373d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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