diff options
| author |   Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-11-26 01:49:23 -0800 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2022-11-26 15:19:23 +0530 |
| commit | f98322920ea5dda233a8c20aff32f7b8f8ea2317 (patch) | |
| tree | a18347f733e0731b93711d1de05dd49dc36c7dbe | |
| parent | Fix typo in `__match_args__` doc (GH-99785) (diff) | |
| download | cpython-f98322920ea5dda233a8c20aff32f7b8f8ea2317.tar.gz cpython-f98322920ea5dda233a8c20aff32f7b8f8ea2317.tar.bz2 cpython-f98322920ea5dda233a8c20aff32f7b8f8ea2317.zip | |
[3.11] gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512) (#99791)
gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)
Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.
(cherry picked from commit 47d673d81fc315069c14f9438ebe61fb70ef1ccc)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
| -rw-r--r-- | Doc/library/secrets.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst index dc8e5f46fb5..4405dfc0535 100644 --- a/Doc/library/secrets.rst +++ b/Doc/library/secrets.rst @@ -128,7 +128,9 @@ Other functions .. function:: compare_digest(a, b) - Return ``True`` if strings *a* and *b* are equal, otherwise ``False``, + Return ``True`` if strings or + :term:`bytes-like objects <bytes-like object>` + *a* and *b* are equal, otherwise ``False``, using a "constant-time compare" to reduce the risk of `timing attacks <https://codahale.com/a-lesson-in-timing-attacks/>`_. See :func:`hmac.compare_digest` for additional details. |