summaryrefslogtreecommitdiff
path: root/docs/lib
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2016-11-10 20:17:07 -0500
committerEli Collins <elic@assurancetechnologies.com>2016-11-10 20:17:07 -0500
commitec573fe344d3d2574f8a657bc701fd18d91f3d22 (patch)
tree7de5e80a595ae23087d2f37746bcca0634b06bb1 /docs/lib
parent47b1d1524dbde0e2ff004f6b2c76f9038cf5958f (diff)
downloadpasslib-ec573fe344d3d2574f8a657bc701fd18d91f3d22.tar.gz
totp: TOTP.normalize_token() turned into hybrid method, made public;
TOTP.normalize_time() turned into class method, made public.
Diffstat (limited to 'docs/lib')
-rw-r--r--docs/lib/passlib.totp.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/lib/passlib.totp.rst b/docs/lib/passlib.totp.rst
index d9cd5cc..7a891fb 100644
--- a/docs/lib/passlib.totp.rst
+++ b/docs/lib/passlib.totp.rst
@@ -66,13 +66,6 @@ Most of this information will be serialized by :meth:`TOTP.to_uri` and :meth:`TO
.. autoattribute:: TOTP.alg
.. autoattribute:: TOTP.period
-..
- Undocumented Helper Methods
- ---------------------------
-
- .. automethod:: TOTP.normalize_token
- .. automethod:: TOTP.normalize_time
-
Token Generation
================
Token generation is generally useful client-side, and for generating
@@ -157,6 +150,15 @@ these methods will automatically encrypt the resulting keys.
* The :ref:`totp-storing-instances` tutorial for more details.
+Helper Methods
+==============
+While :meth:`TOTP.generate`, :meth:`TOTP.match`, and :meth:`TOTP.verify`
+automatically handle normalizing tokens & time values, the following methods
+are exposed in case they are useful in other contexts:
+
+.. automethod:: TOTP.normalize_token
+.. automethod:: TOTP.normalize_time
+
AppWallet
=========
The :class:`!AppWallet` class is used internally by the :meth:`TOTP.using` method