aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/twofactor.rst
diff options
context:
space:
mode:
authorSteven Buss <steven.buss@gmail.com>2015-04-13 13:35:54 -0400
committerSteven Buss <steven.buss@gmail.com>2015-04-13 18:20:47 -0400
commitec60cae651465695e49c08d48b1ec200f758efec (patch)
tree5f0f28f65ff1e63b7893ced1c1e814893014d21a /docs/hazmat/primitives/twofactor.rst
parente079c554e7b3506dfd8be56b2fd20336c79ce7a0 (diff)
downloadcryptography-ec60cae651465695e49c08d48b1ec200f758efec.tar.gz
cryptography-ec60cae651465695e49c08d48b1ec200f758efec.tar.bz2
cryptography-ec60cae651465695e49c08d48b1ec200f758efec.zip
Update docs
Diffstat (limited to 'docs/hazmat/primitives/twofactor.rst')
-rw-r--r--docs/hazmat/primitives/twofactor.rst13
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/hazmat/primitives/twofactor.rst b/docs/hazmat/primitives/twofactor.rst
index 89d81222..dd3e0250 100644
--- a/docs/hazmat/primitives/twofactor.rst
+++ b/docs/hazmat/primitives/twofactor.rst
@@ -11,6 +11,11 @@ Currently, it contains an algorithm for generating and verifying
one time password values based on Hash-based message authentication
codes (HMAC).
+.. class:: InvalidToken
+
+ This is raised when the verify method of a one time password function's
+ computed token does not match the expected token.
+
.. currentmodule:: cryptography.hazmat.primitives.twofactor.hotp
.. class:: HOTP(key, length, algorithm, backend)
@@ -66,8 +71,8 @@ codes (HMAC).
:param bytes hotp: The one time password value to validate.
:param int counter: The counter value to validate against.
- :raises cryptography.exceptions.InvalidToken: This is raised when the
- supplied HOTP does not match the expected HOTP.
+ :raises cryptography.hazmat.primitives.twofactor.InvalidToken: This
+ is raised when the supplied HOTP does not match the expected HOTP.
Throttling
~~~~~~~~~~
@@ -164,5 +169,5 @@ similar to the following code.
:param bytes totp: The one time password value to validate.
:param int time: The time value to validate against.
- :raises cryptography.exceptions.InvalidToken: This is raised when the
- supplied TOTP does not match the expected TOTP.
+ :raises cryptography.hazmat.primitives.twofactor.InvalidToken: This
+ is raised when the supplied TOTP does not match the expected TOTP.