diff options
| author | Steven Buss <steven.buss@gmail.com> | 2015-04-13 13:35:54 -0400 |
|---|---|---|
| committer | Steven Buss <steven.buss@gmail.com> | 2015-04-13 18:20:47 -0400 |
| commit | ec60cae651465695e49c08d48b1ec200f758efec (patch) | |
| tree | 5f0f28f65ff1e63b7893ced1c1e814893014d21a | |
| parent | e079c554e7b3506dfd8be56b2fd20336c79ce7a0 (diff) | |
| download | cryptography-ec60cae651465695e49c08d48b1ec200f758efec.tar.gz cryptography-ec60cae651465695e49c08d48b1ec200f758efec.tar.bz2 cryptography-ec60cae651465695e49c08d48b1ec200f758efec.zip | |
Update docs
| -rw-r--r-- | docs/exceptions.rst | 6 | ||||
| -rw-r--r-- | docs/hazmat/primitives/twofactor.rst | 13 |
2 files changed, 9 insertions, 10 deletions
diff --git a/docs/exceptions.rst b/docs/exceptions.rst index 28da8ecc..59d7d9d7 100644 --- a/docs/exceptions.rst +++ b/docs/exceptions.rst @@ -37,9 +37,3 @@ Exceptions This is raised when the verify method of a key derivation function's computed key does not match the expected key. - - -.. class:: InvalidToken - - This is raised when the verify method of a one time password function's - computed token does not match the expected token. 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. |