summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2012-03-09 18:45:34 -0500
committerEli Collins <elic@assurancetechnologies.com>2012-03-09 18:45:34 -0500
commit72ec6bedc4fdad8845b39788430f32345234ca67 (patch)
treecfd206065093a58646f6b4bef9415804b6c0d96a /docs
parente0803178ae49f1fbaa367a7564b9877eacce628e (diff)
downloadpasslib-72ec6bedc4fdad8845b39788430f32345234ca67.tar.gz
utils.handlers framework reworked; removed a bunch of boilerplate code
* StaticHandler is now subclass of GenericHandler - _calc_checksum() should be implemented instead of encrypt(). (compatibility stub added so old code should continue to work) - _norm_hash() no longer needs to handle ->unicode conversion - default from_string() contains a bunch of features, including stripping a known prefix, etc. * context kwds now pulled into constructor, so GenericHandler supports context kwds properly; HasUserContext mixin added to support common 'user' context kwd * identify_regexp & identify_prefix removed, functionality rolled into default GenericHandler.identify() implementation. - default identify checks _hash_regex as potential way to identify hashes * HasStubChecksum removed, functionality rolled into GenericHandler * HasRawChecksum now just sets a flag, functionality moved into GenericHandler * HasManyIdents._parse_ident() helper added to valid & split identifier from hashes. * GenericHandler._norm_checksum() is now strict about unicode / bytes
Diffstat (limited to 'docs')
-rw-r--r--docs/lib/passlib.utils.handlers.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/lib/passlib.utils.handlers.rst b/docs/lib/passlib.utils.handlers.rst
index 325c730..8d0e202 100644
--- a/docs/lib/passlib.utils.handlers.rst
+++ b/docs/lib/passlib.utils.handlers.rst
@@ -8,17 +8,18 @@
.. module:: passlib.utils.handlers
:synopsis: helper classes for writing password hash handlers
+.. warning::
+
+ This module is primarily used as an internal support module.
+ It's interface has not been finalized yet, and may change between major
+ releases of Passlib.
+
.. todo::
This module, and the instructions on how to write a custom handler,
definitely need to be rewritten for clarity. They are not yet
organized, and may leave out some important details.
-.. note::
-
- Since this module is primarily a support module used internally
- by Passlib, it's interface may change slightly between major releases.
-
Implementing Custom Handlers
============================
All that is required in order to write a custom handler that will work with