]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Clarify that dklen is expected in bytes for the hashlib functions (GH-106624)
authorMathijs Mortimer <thiezn@users.noreply.github.com>
Wed, 22 May 2024 08:51:25 +0000 (10:51 +0200)
committerGitHub <noreply@github.com>
Wed, 22 May 2024 08:51:25 +0000 (11:51 +0300)
Doc/library/hashlib.rst

index 8cf413fbd1e0054a7a8d77ba84bf40d5a2060ac9..5d24b77e13bfcedb6e016c44fd00da44e421c965 100644 (file)
@@ -328,7 +328,7 @@ include a `salt <https://en.wikipedia.org/wiki/Salt_%28cryptography%29>`_.
    your application, read *Appendix A.2.2* of NIST-SP-800-132_. The answers
    on the `stackexchange pbkdf2 iterations question`_ explain in detail.
 
-   *dklen* is the length of the derived key. If *dklen* is ``None`` then the
+   *dklen* is the length of the derived key in bytes. If *dklen* is ``None`` then the
    digest size of the hash algorithm *hash_name* is used, e.g. 64 for SHA-512.
 
    >>> from hashlib import pbkdf2_hmac
@@ -357,7 +357,7 @@ include a `salt <https://en.wikipedia.org/wiki/Salt_%28cryptography%29>`_.
 
    *n* is the CPU/Memory cost factor, *r* the block size, *p* parallelization
    factor and *maxmem* limits memory (OpenSSL 1.1.0 defaults to 32 MiB).
-   *dklen* is the length of the derived key.
+   *dklen* is the length of the derived key in bytes.
 
    .. versionadded:: 3.6