This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: sha3: Replace Keccak Code Package with tiny_sha3
Type: enhancement Stage: resolved
Components: Extension Modules Versions: Python 3.11
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: christian.heimes Nosy List: christian.heimes, gregory.p.smith, illia-v
Priority: normal Keywords: patch

Created on 2022-03-23 09:06 by christian.heimes, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 32060 merged christian.heimes, 2022-03-23 09:20
PR 28768 illia-v, 2022-03-26 20:38
PR 24601 illia-v, 2022-03-26 20:39
Messages (2)
msg415861 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2022-03-23 09:06
The Keccak Code Package (kcp) provides the reference implementation for SHA3 and SHAKE hashing algorithms. CPython has vendored a copy of KCP since I added SHA3 in 3.6.

CPython 3.10 and newer require OpenSSL >= 1.1.1, which provide an optimized implementation of SHA3 and SHAKE on all platforms. The vast majority of users now use SHA3 from OpenSSL instead our _sha3 module with KCP. Both the KCP and _sha3 module are large. The KCP has 230kB of code. The _sha3 shared library is 390kB on Linux X86_64, stripped 90kB.

I would like to reduce the size of our bundled code. Since SHA3 and SHAKE are listed in hashlib.algorithms_guaranteed and OpenSSL is optional, we cannot just drop the _sha3 module. Instead I propose to replace the implementation with tiny_sha3 https://github.com/mjosaarinen/tiny_sha3 . The tiny implementation is 13 kB of code. The resulting _sha3 shared library is 69 kB (stripped 25 kB).

A Python build without OpenSSL bindings will have a working but slower SHA3 implementation.
msg416089 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2022-03-26 20:36
New changeset 5fd8c574e016aec85725ddc5ced8742267b0e1b3 by Christian Heimes in branch 'main':
bpo-47098: Replace Keccak Code Package with tiny_sha3 (GH-32060)
https://github.com/python/cpython/commit/5fd8c574e016aec85725ddc5ced8742267b0e1b3
History
Date User Action Args
2022-04-11 14:59:57adminsetgithub: 91254
2022-03-28 06:18:53christian.heimessetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2022-03-26 20:39:31illia-vsetpull_requests: + pull_request30216
2022-03-26 20:38:47illia-vsetnosy: + illia-v
pull_requests: + pull_request30215
2022-03-26 20:36:12christian.heimessetmessages: + msg416089
2022-03-23 09:20:04christian.heimessetkeywords: + patch
stage: patch review
pull_requests: + pull_request30161
2022-03-23 09:06:22christian.heimescreate