diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-06-06 16:54:04 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-06 16:54:04 (GMT) |
| commit | 3d190513864bbb21529f49c858c4f8aa11dac9d0 (patch) | |
| tree | e9af3916f211ca01f986cada32741ec342f23c06 /Doc | |
| parent | fd247db57a536d62902b296af599505298fd1e70 (diff) | |
| download | cpython-3d190513864bbb21529f49c858c4f8aa11dac9d0.zip cpython-3d190513864bbb21529f49c858c4f8aa11dac9d0.tar.gz cpython-3d190513864bbb21529f49c858c4f8aa11dac9d0.tar.bz2 | |
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) (#93400)
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.
(cherry picked from commit 8241a6971e6051ba10040af6b50f9236faa0c892)
Co-authored-by: Noah Kantrowitz <noah@coderanger.net>
Diffstat (limited to 'Doc')
| -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. |