diff options
| author | Tom Cocagne <devnull@localhost> | 2010-12-01 09:44:20 -0500 |
|---|---|---|
| committer | Tom Cocagne <devnull@localhost> | 2010-12-01 09:44:20 -0500 |
| commit | f649a03c1be597a4da12ee4d503043b153fe084b (patch) | |
| tree | 0bc812ab07cd8dac68bc7877f67d6aface4f77a6 | |
| parent | f61bbe69fa3593c2a60bf296add756e920941eeb (diff) | |
updated documentation
| -rw-r--r-- | README.txt | 17 | ||||
| -rw-r--r-- | doc/srp.rst | 43 |
2 files changed, 42 insertions, 18 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..1e9dcf7 --- /dev/null +++ b/README.txt @@ -0,0 +1,17 @@ + +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 10x faster than the pure Python implementation +and can take advantage of multiple CPUs. The ctypes/extension module will +be used if available, otherwise the library will fall back to the pure +Python implementation. + + +Installation: + python setup.py install + + +Documentation: + cd doc + sphinx-build -b html . <desired output directory>
\ No newline at end of file diff --git a/doc/srp.rst b/doc/srp.rst index ef55add..dafa45d 100644 --- a/doc/srp.rst +++ b/doc/srp.rst @@ -46,24 +46,31 @@ See http://srp.stanford.edu/ for a full description of the SRP protocol. Constants --------- -============== ============== -Hash Algorithm Number of Bits -============== ============== -SHA1 160 -SHA224 224 -SHA256 256 -SHA384 384 -SHA512 512 -============== ============== - -================= -Prime Number Size -================= -NG_1024 -NG_2048 -NG_4096 -NG_CUSTOM -================= + +.. table:: Hashing Algorithm Constants + + ============== ============== + Hash Algorithm Number of Bits + ============== ============== + SHA1 160 + SHA224 224 + SHA256 256 + SHA384 384 + SHA512 512 + ============== ============== + +Larger hashing algorithms will result in larger session keys. + +.. table:: Prime Number Constants + + ================= ============== + Prime Number Size Number of Bits + ================= ============== + NG_1024 1024 + NG_2048 2048 + NG_4096 4096 + NG_CUSTOM User Supplied + ================= ============== If NG_CUSTOM is used, the 'n_hex' and 'g_hex' parameters are required. These parameters must be ASCII text containing hexidecimal notation of the |