diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-01-06 20:49:48 +0000 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-01-06 20:49:48 +0000 |
| commit | 6b46fac5fd0b0449f7bc750085fe93ff5c8c2d59 (patch) | |
| tree | de2a9b7d0c9525f9518ed459dccd15ce7c6514a3 /docs/lib | |
| parent | 7616b3f692a403d56813d85e7a7a71b13fd7f1b5 (diff) | |
| download | passlib-6b46fac5fd0b0449f7bc750085fe93ff5c8c2d59.tar.gz | |
doc cleanups
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/passlib.gen.rst | 5 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.rst | 26 | ||||
| -rw-r--r-- | docs/lib/passlib.hash/algorithms.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.hash/contexts.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.hash/implementation.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.hash/quickstart.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.hash/utils.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.rng.rst | 71 |
8 files changed, 25 insertions, 97 deletions
diff --git a/docs/lib/passlib.gen.rst b/docs/lib/passlib.gen.rst index c657b12..b8778e9 100644 --- a/docs/lib/passlib.gen.rst +++ b/docs/lib/passlib.gen.rst @@ -1,8 +1,8 @@ ================================================ -:mod:`bps.security.pwgen` -- Password Generation +:mod:`passlib.gen` -- Password Generation ================================================ -.. module:: bps.security.pwgen +.. module:: passlib.gen :synopsis: password generation algorithms The following single function allows @@ -12,4 +12,3 @@ easy password generation in a number of styles: .. todo:: document internal classes - diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst index b2f0aa1..0f2bfb0 100644 --- a/docs/lib/passlib.hash.rst +++ b/docs/lib/passlib.hash.rst @@ -1,8 +1,8 @@ ============================================= -:mod:`bps.security.pwhash` - Password Hashing +:mod:`passlib.hash` - Password Hashing ============================================= -.. module:: bps.security.pwhash +.. module:: passlib.hash :synopsis: password hashing (unix-crypt, md5-crypt, etc) Overview @@ -21,24 +21,24 @@ The algorithms currently supported by default in BPS: * MD5-Crypt * BCrypt * SHA-Crypt (256 & 512 bit modes) - + * PostgreSQL & MySQL password hashes Sections ======== The documentation for the pwhash module is broken into the following sections: -* :doc:`Quick Start <bps.security.pwhash/quickstart>` -- frontend funcs for quickly creating / validating hashes -* :doc:`Crypt Contexts <bps.security.pwhash/contexts>` -- for using just the algorithms your application needs -* :doc:`Crypt Algorithms <bps.security.pwhash/algorithms>` -- details of the algorithms BPS implements -* :doc:`Implementing a Custom Crypt Algorithm <bps.security.pwhash/implementation>` -- Roll your own -* :doc:`Helper Functions <bps.security.pwhash/utils>` +* :doc:`Quick Start <passlib.hash/quickstart>` -- frontend funcs for quickly creating / validating hashes +* :doc:`Crypt Contexts <passlib.hash/contexts>` -- for using just the algorithms your application needs +* :doc:`Crypt Algorithms <passlib.hash/algorithms>` -- details of the algorithms BPS implements +* :doc:`Implementing a Custom Crypt Algorithm <passlib.hash/implementation>` -- Roll your own +* :doc:`Helper Functions <passlib.hash/utils>` .. toctree:: :hidden: - bps.security.pwhash/quickstart - bps.security.pwhash/contexts - bps.security.pwhash/algorithms - bps.security.pwhash/implementation - bps.security.pwhash/utils + passlib.hash/quickstart + passlib.hash/contexts + passlib.hash/algorithms + passlib.hash/implementation + passlib.hash/utils diff --git a/docs/lib/passlib.hash/algorithms.rst b/docs/lib/passlib.hash/algorithms.rst index 6973313..730743f 100644 --- a/docs/lib/passlib.hash/algorithms.rst +++ b/docs/lib/passlib.hash/algorithms.rst @@ -1,8 +1,8 @@ ============================================= -:mod:`bps.security.pwhash` - Crypt Algorithms +:mod:`passlib.hash` - Crypt Algorithms ============================================= -.. currentmodule:: bps.security.pwhash +.. currentmodule:: passlib.hash All of the crypt algorithms must inherit from :class:`CryptAlgorithm`, which defines a common interface all algorithms must support. diff --git a/docs/lib/passlib.hash/contexts.rst b/docs/lib/passlib.hash/contexts.rst index 3312355..3718df3 100644 --- a/docs/lib/passlib.hash/contexts.rst +++ b/docs/lib/passlib.hash/contexts.rst @@ -1,8 +1,8 @@ ============================================= -:mod:`bps.security.pwhash` - Crypt Contexts +:mod:`passlib.hash` - Crypt Contexts ============================================= -.. currentmodule:: bps.security.pwhash +.. currentmodule:: passlib.hash For more complex deployment scenarios than the frontend functions described in :doc:`Quick Start <quickstart>`, diff --git a/docs/lib/passlib.hash/implementation.rst b/docs/lib/passlib.hash/implementation.rst index 2bf1661..7f603c9 100644 --- a/docs/lib/passlib.hash/implementation.rst +++ b/docs/lib/passlib.hash/implementation.rst @@ -1,8 +1,8 @@ =================================================================== -:mod:`bps.security.pwhash` - Implementing a Custom Crypt Algorithm +:mod:`passlib.hash` - Implementing a Custom Crypt Algorithm =================================================================== -.. currentmodule:: bps.security.pwhash +.. currentmodule:: passlib.hash New password algorithms can be implemented by subclassing :class:`CryptAlgorithm`, diff --git a/docs/lib/passlib.hash/quickstart.rst b/docs/lib/passlib.hash/quickstart.rst index 44e3fa3..94bc40d 100644 --- a/docs/lib/passlib.hash/quickstart.rst +++ b/docs/lib/passlib.hash/quickstart.rst @@ -1,8 +1,8 @@ ======================================== -:mod:`bps.security.pwhash` - Quick Start +:mod:`passlib.hash` - Quick Start ======================================== -.. currentmodule:: bps.security.pwhash +.. currentmodule:: passlib.hash Usage Example ============= diff --git a/docs/lib/passlib.hash/utils.rst b/docs/lib/passlib.hash/utils.rst index 897349d..345e80b 100644 --- a/docs/lib/passlib.hash/utils.rst +++ b/docs/lib/passlib.hash/utils.rst @@ -1,8 +1,8 @@ ============================================= -:mod:`bps.security.pwhash` - Helper Functions +:mod:`passlib.hash` - Helper Functions ============================================= -.. currentmodule:: bps.security.pwhash +.. currentmodule:: passlib.hash A couple of utility functions are available, mainly useful when writing custom password hash algorithms. diff --git a/docs/lib/passlib.rng.rst b/docs/lib/passlib.rng.rst deleted file mode 100644 index 5869ff4..0000000 --- a/docs/lib/passlib.rng.rst +++ /dev/null @@ -1,71 +0,0 @@ -================================================= -:mod:`bps.rng` -- Random Number Generation -================================================= - -.. module:: bps.rng - :synopsis: random number generation - -This module is essentially just a wrapper for stdlib's -random module. It provides a few additional -methods for managing & getting random numbers, -but also provides a more useful interface -for the *type* of randomness you want. - -Random Number Generators -======================== -The following random number generator -instances are always available from this module: - -.. data:: random - - This will be an instance of the best pseudo random number generator - available (currently the python builtin prng), with as good - an entropic source as is available for seeding via - the seed() and reseed() methods. - Use this for most non-cryptographic purposes. - -.. data:: srandom - - This will be an instance of the strongest random number generator - available on your system. It will use python's SystemRandom - if os.urandom support is available, otherwise it will fall back - to the same generator as prandom. This should be used - for cryptographic purposes over the normal prng. - - .. warning:: - If urandom is present, this is dependant on the strength - of your system's urandom implementation. If urandom is missing, - the fallback (normal) may not have enough entropy to defend - from attackers. To help this somewhat, it is recommended - to call ``strong.reseed()`` before calls which will consume - randomness for critical purposes, just to help scramble things - as best as possible (reseed is a no-op if urandom is being used). - -.. data:: drandom - - This is a variant of the *random* generator, - except that all outside entropic - sources are disabled, so that it's state is completely - deteremined by the value passed into seed(). - - This is mainly useful in unitests, when you need - to reliably repeat the same results over an over. - -Extra Methods -============= -In addition to the methods provided by stdlib's random module, -all the above rngs will contain the following extra methods: - -.. function:: reseed() - - Unlike seed(), which attempts to set the random number generator's - state explicitly, this method attempts to pull in outside - entropy sources (current rng state, time, etc) to help - randomize the state of your prng as much as possible. - - .. todo:: - In the future, need a way for app to add entropy to the system. - -.. function:: getrandbytes() - -.. function:: weightedchoice() |
