[Python-checkins] 📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396)

miss-islington webhook-mailer at python.org
Tue May 31 21:35:39 EDT 2022


https://github.com/python/cpython/commit/8241a6971e6051ba10040af6b50f9236faa0c892
commit: 8241a6971e6051ba10040af6b50f9236faa0c892
branch: main
author: Noah Kantrowitz <noah at coderanger.net>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-05-31T18:35:28-07:00
summary:

📝 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.

files:
M Doc/library/secrets.rst

diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst
index c22da727b55c9..eda4616da5ec9 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.
 



More information about the Python-checkins mailing list