diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2016-07-15 15:19:13 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2016-07-15 15:19:13 -0400 |
| commit | f95fbd9d0761ea39cea1a8535a06441fe653e9b0 (patch) | |
| tree | 85b7457b9487bf3946da165e7c31d19b1a6aa77e /docs | |
| parent | 69138846405513588c47cac5ead19987b83942ad (diff) | |
| download | passlib-f95fbd9d0761ea39cea1a8535a06441fe653e9b0.tar.gz | |
docs: corrected / updated various bits of text, especially TOTP docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/lib/passlib.exc.rst | 7 | ||||
| -rw-r--r-- | docs/lib/passlib.totp.rst | 4 | ||||
| -rw-r--r-- | docs/new_app_quickstart.rst | 8 |
3 files changed, 12 insertions, 7 deletions
diff --git a/docs/lib/passlib.exc.rst b/docs/lib/passlib.exc.rst index 81c97b2..f90f330 100644 --- a/docs/lib/passlib.exc.rst +++ b/docs/lib/passlib.exc.rst @@ -21,7 +21,12 @@ Exceptions .. autoexception:: PasslibSecurityError -.. autoexception:: TokenReuseError +TOTP Exceptions +--------------- +.. autoexception:: TokenError +.. autoexception:: MalformedTokenError +.. autoexception:: InvalidTokenError +.. autoexception:: UsedTokenError Warnings ======== diff --git a/docs/lib/passlib.totp.rst b/docs/lib/passlib.totp.rst index e535a39..fdb5fe4 100644 --- a/docs/lib/passlib.totp.rst +++ b/docs/lib/passlib.totp.rst @@ -68,8 +68,8 @@ Helper Classes Deviations ========== -* The TOTP Spec [#totpspec]_ includes an potentially offset from the base time (``T0``). - Passlib omits this (fixing it at ``0``), but so do pretty much all other TOTP implementations. +* The TOTP Spec [#totpspec]_ includes an param (``T0)``) providing an optional offset from the base time. + Passlib omits this parameter (fixing it at ``0``), but so do pretty much all other TOTP implementations. .. rubric:: Footnotes diff --git a/docs/new_app_quickstart.rst b/docs/new_app_quickstart.rst index 508a385..2dccb30 100644 --- a/docs/new_app_quickstart.rst +++ b/docs/new_app_quickstart.rst @@ -66,12 +66,12 @@ All four hashes share the following properties: * variable rounds for configuring flexible cpu cost on a per-hash basis. * at least 96 bits of salt. * basic algorithm has seen heavy scrutiny and use for at least 10 years - (except for Argon2, from is from circa 2013). + (except for Argon2, born around 2013). * in use across a number of OSes and/or a wide variety of applications. Argon2 is much younger than the others, but has seen heavy scrunity, and was purpose-designed for password hashing. In the near future, it stands likely to -become *THE* recommended standard. +become *the* recommended standard. .. rst-class:: html-toggle @@ -180,8 +180,8 @@ standard format for encoding password hashes using this algorithm Furthermore, when compared to Argon2 and BCrypt, PBKDF2 has proven more susceptible to cracking using modern GPU-based techniques. -Making Descision ----------------- +Making a Decision +----------------- For new applications, this decision comes down to a couple of questions: 1. Does the hash need to be natively supported by your operating system's :func:`!crypt` api, |