Skip to content

Commit

Permalink
📝 Make sure the phrase "constant-time compare" actually appears in th…
Browse files Browse the repository at this point in the history
…e 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.
  • Loading branch information
coderanger authored Jun 1, 2022
1 parent 705eaec commit 8241a69
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Doc/library/secrets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 8241a69

Please sign in to comment.