summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2020-10-06 11:31:41 -0400
committerEli Collins <elic@assurancetechnologies.com>2020-10-06 11:31:41 -0400
commit4fd7c8efa8027bfbc017fcbe0c5d85e6e1506696 (patch)
tree70244c85da09f80c5d9052390ead0259617d40c7 /docs
parentda2546cdc6252639f1cd5bc94cb98f05389c8909 (diff)
downloadpasslib-4fd7c8efa8027bfbc017fcbe0c5d85e6e1506696.tar.gz
docs / sha crypt: commented out the "implicit_rounds" param in docs,
it's not actually supported by using(), and isn't needed for users (issue 121)
Diffstat (limited to 'docs')
-rw-r--r--docs/lib/passlib.hash.sha256_crypt.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/lib/passlib.hash.sha256_crypt.rst b/docs/lib/passlib.hash.sha256_crypt.rst
index 907ce7a..8d3e950 100644
--- a/docs/lib/passlib.hash.sha256_crypt.rst
+++ b/docs/lib/passlib.hash.sha256_crypt.rst
@@ -70,9 +70,9 @@ An sha256-crypt hash string has the format :samp:`$5$rounds={rounds}${salt}${che
* :samp:`{checksum}` is 43 characters drawn from the same set, encoding a 256-bit
checksum (``cKhJImk5mfuSKV9b3mumNzlbstFUplKtQXXMo4G6Ep5`` in the example).
-There is also an alternate format :samp:`$5${salt}${checksum}`,
-which can be used when the rounds parameter is equal to 5000
-(see the ``implicit_rounds`` parameter above).
+The official implementation allows omitting the ``rounds`` section when it's set to 5000,
+resulting in an alternate hash format: :samp:`$5${salt}${checksum}`.
+(Passlib supports this via the ``implicit_rounds`` constructor parameter).
The algorithm used by SHA256-Crypt is laid out in detail
in the specification document linked to below [#f1]_.