Skip to content

gh-99108: Implement HACL* HMAC #130157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 55 commits into from
Apr 4, 2025
Merged

Conversation

picnixz
Copy link
Member

@picnixz picnixz commented Feb 15, 2025

This supersedes #126359.

Ideally, I'd like this to be part of 3.14 but we only have two alpha releases until the first beta.

Note that the HACL* HMAC implementation does not support truncated SHA-2-512/224 (which is different from SHA-2/224) so we need to either ask HACL* to do it or document it in the hmac module documentation.

For reviews, I would strongly advise review commit by commit instead of the entire file. Each commit should compile separately (assuming preceeding ones are present, maybe except the first few commits are not compiling due to some configure/build I forgot to put it at that time, but otherwise the interface was written incrementally).

cc @msprotz @gpshead


📚 Documentation preview 📚: https://cpython-previews--130157.org.readthedocs.build/

@picnixz picnixz force-pushed the feat/hmac/hacl-99108 branch 2 times, most recently from 21fcd9a to 583c1f4 Compare February 15, 2025 14:15
@picnixz
Copy link
Member Author

picnixz commented Feb 15, 2025

@msprotz I'm not sure if it's an HACL issue or not, but Lib_IntVector_Intrinsics_vec256 in libintvector.h is conditionnally exposed, yet it's unconditionally used in _hacl/Hacl_Streaming_Types.h.

@msprotz
Copy link
Contributor

msprotz commented Feb 17, 2025

You are correct -- there is one additional step to do to handle this case. Note that HMAC is the first time we have a file that contains references to vec128/vec256 yet may be compiled on a system that has no such types. (Previously, Blake2b_256 was only ever built if vec256 was known at build-time to exist, and likewise with Blake2s_128.)

One option is to conditional includes, but that leads to other difficulties, such as having to hide cases of the agile hmac state union behind #ifdef, and then propagating #ifdefs everywhere in this file. This is error-prone and a lot of maintenance.

The other option we've done is simply to #define Lib_IntVector_Intrinsics_vec256 void * in case the build determines that HACL_CAN_COMPILE_VEC256 is false (and likewise with vec128). This solves all of the problems above and avoids a complicated include dance.

What I don't understand / remember, though, is why this isn't done directly inside libintvector.h. (We currently do it in our mini-configure for CI purposes and emit those #ifdefs in config.h.)

I'd be curious to see if you could manually patch libintvector.h to define those types to void* (in the #else case of #ifdef HACL_CAN_COMPILE_VEC256, and likewise for VEC128) and then see if we get a good build? I would then be happy to upstream this fix. Thank you!

@picnixz picnixz force-pushed the feat/hmac/hacl-99108 branch 2 times, most recently from a993e69 to 8ce1524 Compare March 12, 2025 12:04
@picnixz picnixz force-pushed the feat/hmac/hacl-99108 branch from 8ce1524 to dcb89f5 Compare March 12, 2025 12:22
@picnixz
Copy link
Member Author

picnixz commented Mar 12, 2025

I'll wait for #130960 to be merged so that I don't need to re-update the SBOMs etc.

@picnixz picnixz force-pushed the feat/hmac/hacl-99108 branch 7 times, most recently from 22e3003 to 56b3c8f Compare March 16, 2025 10:41
@gpshead
Copy link
Member

gpshead commented Mar 29, 2025

I'd (1) leave the SIMD detection for a followup PR and (2) keep the pedantic checks for the return code.

similarly, documentation updates we're not clear on the need for can be considered separately.

@msprotz
Copy link
Contributor

msprotz commented Mar 29, 2025

Agreed that SIMD can be left for later -- this should be transparent from the point of view of the clients.

Copy link
Member

@chris-eibl chris-eibl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you @picnixz!

picnixz and others added 2 commits March 29, 2025 17:18
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@picnixz picnixz requested a review from hugovk March 30, 2025 08:29
@picnixz picnixz added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Apr 1, 2025
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @picnixz for commit 258aa20 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F130157%2Fmerge

If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again.

@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Apr 1, 2025
@picnixz picnixz added the 🔨 test-with-refleak-buildbots Test PR w/ refleak buildbots; report in status section label Apr 1, 2025
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @picnixz for commit 258aa20 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F130157%2Fmerge

If you want to schedule another build, you need to add the 🔨 test-with-refleak-buildbots label again.

@bedevere-bot bedevere-bot removed the 🔨 test-with-refleak-buildbots Test PR w/ refleak buildbots; report in status section label Apr 1, 2025
@picnixz
Copy link
Member Author

picnixz commented Apr 1, 2025

I expect failures on some FIPS-only build bots but that's fine because the test suite is already failing on them. And some failures on other build bots as well (like aarch64 which is known to be flaky these past days). Once all build bots are fine, I'll merge it (but only on Friday, as I'm leaving in a few hours) [so please don't merge it since I want to write the commit message, TiA]

@picnixz picnixz merged commit 0a97427 into python:main Apr 4, 2025
42 checks passed
@picnixz picnixz deleted the feat/hmac/hacl-99108 branch April 4, 2025 17:04
@picnixz
Copy link
Member Author

picnixz commented Apr 4, 2025

Thank you all for the feedback, especially @msprotz for the upstream work! The next step is to enable the SIMD support.

picnixz added a commit to picnixz/cpython that referenced this pull request Apr 5, 2025
A new extension module, `_hmac`, now exposes the HACL* HMAC (formally verified) implementation.

The HACL* implementation is used as a fallback implementation when the OpenSSL implementation of HMAC
is not available or disabled. For now, only named hash algorithms are recognized and SIMD support provided
by HACL* for the BLAKE2 hash functions is not yet used.
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
A new extension module, `_hmac`, now exposes the HACL* HMAC (formally verified) implementation.

The HACL* implementation is used as a fallback implementation when the OpenSSL implementation of HMAC
is not available or disabled. For now, only named hash algorithms are recognized and SIMD support provided
by HACL* for the BLAKE2 hash functions is not yet used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants