aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/primitives/index.rst1
-rw-r--r--docs/hazmat/primitives/otp.rst (renamed from docs/hazmat/oath.rst)14
-rw-r--r--docs/index.rst1
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/hazmat/primitives/index.rst b/docs/hazmat/primitives/index.rst
index 38ed24c9..9121d156 100644
--- a/docs/hazmat/primitives/index.rst
+++ b/docs/hazmat/primitives/index.rst
@@ -14,3 +14,4 @@ Primitives
rsa
constant-time
interfaces
+ otp
diff --git a/docs/hazmat/oath.rst b/docs/hazmat/primitives/otp.rst
index 91c23566..ad2c856a 100644
--- a/docs/hazmat/oath.rst
+++ b/docs/hazmat/primitives/otp.rst
@@ -1,18 +1,18 @@
.. hazmat::
-OATH
-====
+One Time Password
+=================
-.. currentmodule:: cryptography.hazmat.oath
+.. currentmodule:: cryptography.hazmat.primitives.otp
-This module contains algorithms under the umbrella of the
-Initiative for Open Authentication (OATH).
+This module contains algorithms for generating and verifying one
+time passwords.
Currently, it contains an algorithm for generating and verifying
one time password values based on Hash-based message authentication
codes (HMAC).
-.. currentmodule:: cryptography.hazmat.oath.hotp
+.. currentmodule:: cryptography.hazmat.primitives.otp.hotp
.. class:: HOTP(key, length, backend)
@@ -27,7 +27,7 @@ codes (HMAC).
>>> import os
>>> from cryptography.hazmat.backends import default_backend
- >>> from cryptography.hazmat.oath.hotp import HOTP
+ >>> from cryptography.hazmat.primitives.otp.hotp import HOTP
>>> key = b"12345678901234567890"
>>> hotp = HOTP(key, 6, backend=default_backend())
diff --git a/docs/index.rst b/docs/index.rst
index 40c418b0..176405b5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -75,7 +75,6 @@ The hazardous materials layer
hazmat/primitives/index
hazmat/backends/index
hazmat/bindings/index
- hazmat/oath
The ``cryptography`` open source project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~