aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives
diff options
context:
space:
mode:
authorAyrx <terrycwk1994@gmail.com>2014-02-18 12:33:55 +0800
committerAyrx <terrycwk1994@gmail.com>2014-02-21 11:13:35 +0800
commit8c1ad596b02f89cde6040e8626e07ca352182130 (patch)
tree49a82f2d0dae83dbda4fa0726071dbc04dbd3936 /docs/hazmat/primitives
parent26d276f2a9f7b1ca155cb7cced139b2d15baf272 (diff)
downloadcryptography-8c1ad596b02f89cde6040e8626e07ca352182130.tar.gz
cryptography-8c1ad596b02f89cde6040e8626e07ca352182130.tar.bz2
cryptography-8c1ad596b02f89cde6040e8626e07ca352182130.zip
Changed module name from otp to twofactor.
Diffstat (limited to 'docs/hazmat/primitives')
-rw-r--r--docs/hazmat/primitives/index.rst2
-rw-r--r--docs/hazmat/primitives/twofactor.rst (renamed from docs/hazmat/primitives/otp.rst)13
2 files changed, 7 insertions, 8 deletions
diff --git a/docs/hazmat/primitives/index.rst b/docs/hazmat/primitives/index.rst
index 9121d156..5199d493 100644
--- a/docs/hazmat/primitives/index.rst
+++ b/docs/hazmat/primitives/index.rst
@@ -14,4 +14,4 @@ Primitives
rsa
constant-time
interfaces
- otp
+ twofactor
diff --git a/docs/hazmat/primitives/otp.rst b/docs/hazmat/primitives/twofactor.rst
index ad2c856a..2b811e1e 100644
--- a/docs/hazmat/primitives/otp.rst
+++ b/docs/hazmat/primitives/twofactor.rst
@@ -1,18 +1,17 @@
.. hazmat::
-One Time Password
-=================
+Two-factor Authentication
+=========================
-.. currentmodule:: cryptography.hazmat.primitives.otp
+.. currentmodule:: cryptography.hazmat.primitives.twofactor
-This module contains algorithms for generating and verifying one
-time passwords.
+This module contains algorithms related to two-factor authentication.
Currently, it contains an algorithm for generating and verifying
one time password values based on Hash-based message authentication
codes (HMAC).
-.. currentmodule:: cryptography.hazmat.primitives.otp.hotp
+.. currentmodule:: cryptography.hazmat.primitives.twofactor.hotp
.. class:: HOTP(key, length, backend)
@@ -27,7 +26,7 @@ codes (HMAC).
>>> import os
>>> from cryptography.hazmat.backends import default_backend
- >>> from cryptography.hazmat.primitives.otp.hotp import HOTP
+ >>> from cryptography.hazmat.primitives.twofactor.hotp import HOTP
>>> key = b"12345678901234567890"
>>> hotp = HOTP(key, 6, backend=default_backend())