diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2020-10-06 11:31:41 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2020-10-06 11:31:41 -0400 |
| commit | 4fd7c8efa8027bfbc017fcbe0c5d85e6e1506696 (patch) | |
| tree | 70244c85da09f80c5d9052390ead0259617d40c7 /passlib | |
| parent | da2546cdc6252639f1cd5bc94cb98f05389c8909 (diff) | |
| download | passlib-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 'passlib')
| -rw-r--r-- | passlib/handlers/sha2_crypt.py | 46 |
1 files changed, 30 insertions, 16 deletions
diff --git a/passlib/handlers/sha2_crypt.py b/passlib/handlers/sha2_crypt.py index 6223616..e6060c5 100644 --- a/passlib/handlers/sha2_crypt.py +++ b/passlib/handlers/sha2_crypt.py @@ -414,14 +414,9 @@ class sha256_crypt(_SHA2_Common): Optional number of rounds to use. Defaults to 535000, must be between 1000 and 999999999, inclusive. - :type implicit_rounds: bool - :param implicit_rounds: - this is an internal option which generally doesn't need to be touched. - - this flag determines whether the hash should omit the rounds parameter - when encoding it to a string; this is only permitted by the spec for rounds=5000, - and the flag is ignored otherwise. the spec requires the two different - encodings be preserved as they are, instead of normalizing them. + .. note:: + per the official specification, when the rounds parameter is set to 5000, + it may be omitted from the hash string. :type relaxed: bool :param relaxed: @@ -432,6 +427,18 @@ class sha256_crypt(_SHA2_Common): that are too small or too large, and ``salt`` strings that are too long. .. versionadded:: 1.6 + + .. + commented out, currently only supported by :meth:`hash`, and not via :meth:`using`: + + :type implicit_rounds: bool + :param implicit_rounds: + this is an internal option which generally doesn't need to be touched. + + this flag determines whether the hash should omit the rounds parameter + when encoding it to a string; this is only permitted by the spec for rounds=5000, + and the flag is ignored otherwise. the spec requires the two different + encodings be preserved as they are, instead of normalizing them. """ #=================================================================== # class attrs @@ -473,14 +480,9 @@ class sha512_crypt(_SHA2_Common): Optional number of rounds to use. Defaults to 656000, must be between 1000 and 999999999, inclusive. - :type implicit_rounds: bool - :param implicit_rounds: - this is an internal option which generally doesn't need to be touched. - - this flag determines whether the hash should omit the rounds parameter - when encoding it to a string; this is only permitted by the spec for rounds=5000, - and the flag is ignored otherwise. the spec requires the two different - encodings be preserved as they are, instead of normalizing them. + .. note:: + per the official specification, when the rounds parameter is set to 5000, + it may be omitted from the hash string. :type relaxed: bool :param relaxed: @@ -491,6 +493,18 @@ class sha512_crypt(_SHA2_Common): that are too small or too large, and ``salt`` strings that are too long. .. versionadded:: 1.6 + + .. + commented out, currently only supported by :meth:`hash`, and not via :meth:`using`: + + :type implicit_rounds: bool + :param implicit_rounds: + this is an internal option which generally doesn't need to be touched. + + this flag determines whether the hash should omit the rounds parameter + when encoding it to a string; this is only permitted by the spec for rounds=5000, + and the flag is ignored otherwise. the spec requires the two different + encodings be preserved as they are, instead of normalizing them. """ #=================================================================== |