Skip to content

Commit 5ab628f

Browse files
miss-islingtonStanFromIrelandeli-schwartz
authored
[3.13] gh-129327: revise hashlib documentation to account for FIPS removing sha1 (GH-132729) (#132740)
gh-129327: revise hashlib documentation to account for FIPS removing sha1 (GH-132729) * gh-129327: revise hashlib documentation to account for FIPS removing sha1 More generally, the current documentation is a bit scattered, talking about what terms are "equal" despite those terms not being very interesting and given the term "secure hash", probably wrong (because md5 and sha1 are not secure anymore). Let's talk about cryptographically secure instead, and note that two of them aren't. And then we can also link to the source for NIST going through the removal process for SHA1. * Add Gregors Suggestion * Clean up --------- (cherry picked from commit a16586c) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Eli Schwartz <eschwartz@gentoo.org>
1 parent 47c8df6 commit 5ab628f

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

Diff for: Doc/library/hashlib.rst

+6-7
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,11 @@
2020

2121
--------------
2222

23-
This module implements a common interface to many different secure hash and
24-
message digest algorithms. Included are the FIPS secure hash algorithms SHA1,
25-
SHA224, SHA256, SHA384, SHA512, (defined in `the FIPS 180-4 standard`_),
26-
the SHA-3 series (defined in `the FIPS 202 standard`_) as well as RSA's MD5
27-
algorithm (defined in internet :rfc:`1321`). The terms "secure hash" and
28-
"message digest" are interchangeable. Older algorithms were called message
29-
digests. The modern term is secure hash.
23+
This module implements a common interface to many different hash algorithms.
24+
Included are the FIPS secure hash algorithms SHA224, SHA256, SHA384, SHA512,
25+
(defined in `the FIPS 180-4 standard`_), the SHA-3 series (defined in `the FIPS
26+
202 standard`_) as well as the legacy algorithms SHA1 (`formerly part of FIPS`_)
27+
and the MD5 algorithm (defined in internet :rfc:`1321`).
3028

3129
.. note::
3230

@@ -812,6 +810,7 @@ Domain Dedication 1.0 Universal:
812810
.. _the FIPS 180-4 standard: https://csrc.nist.gov/pubs/fips/180-4/upd1/final
813811
.. _the FIPS 202 standard: https://csrc.nist.gov/pubs/fips/202/final
814812
.. _HACL\* project: https://github.com/hacl-star/hacl-star
813+
.. _formerly part of FIPS: https://csrc.nist.gov/news/2023/decision-to-revise-fips-180-4
815814

816815

817816
.. _hashlib-seealso:

0 commit comments

Comments
 (0)