diff options
author | Noah Kantrowitz <noah@coderanger.net> | 2022-06-01 01:35:28 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-01 01:35:28 (GMT) |
commit | 8241a6971e6051ba10040af6b50f9236faa0c892 (patch) | |
tree | b5132147eb617cf191448b82373b7a81a781dddf | |
parent | 705eaec28f7bee530b1c1635ba385a49a1feaf32 (diff) | |
download | cpython-8241a6971e6051ba10040af6b50f9236faa0c892.zip cpython-8241a6971e6051ba10040af6b50f9236faa0c892.tar.gz cpython-8241a6971e6051ba10040af6b50f9236faa0c892.tar.bz2 |
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396)
This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
-rw-r--r-- | Doc/library/secrets.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst index c22da72..eda4616 100644 --- a/Doc/library/secrets.rst +++ b/Doc/library/secrets.rst @@ -129,7 +129,7 @@ Other functions .. function:: compare_digest(a, b) Return ``True`` if strings *a* and *b* are equal, otherwise ``False``, - in such a way as to reduce the risk of + 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. |