sys/psa_crypto: Add generic HMAC implementation #20758

Wer-Wolf · 2024-06-22T21:36:40Z

Contribution description

This PR adds a generic HMAC implementation for the PSA crypto API. This HMAC implementation can work with all
hashing algorithms already supported by the PSA crypto API.

This means that in order to add support for a new HMAC algorithm, only the hashing algorithm implementation is necessary,
the rest will be handled by the generic HMAC.

In order to support the full PSA MAC API, this PR also adds support for the multi-part MAC API. It also removes support for hardware acceleration of the SHA-256 HMAC, since a full-fledged hardware acceleration is expected to be provided in the near future.

Last but not least, a unittest for the generic HMAC is provided.

Testing procedure

The test-hashes unittest also tests the generic HMAC, so running those tests should be suitable to test the generic HMAC.

This PR depends on #20698, and also depends on a follow-up PR which will reintroduce proper hardware acceleration.

riot-ci · 2024-06-24T09:23:24Z

Murdock results

✔️ PASSED

3606e9b tests/sys/psa_crypto_mac: Add tests for generic HMAC implementations

Success	Failures	Total	Runtime
146606	0	146606	03h:17m:36s

Artifacts

Documentation preview

mguetschow

Thorough implementation, good coding style overall, well done! I have some comments inline below :)

mguetschow · 2024-06-24T09:14:25Z

sys/psa_crypto/Makefile.dep

+ifneq (,$(filter psa_mac_hmac_sha_512_backend_riot,$(USEMODULE)))
+  USEMODULE += psa_hash
+  USEMODULE += psa_hash_sha_512
+  USEMODULE += psa_riot_mac_hmac_generic
 endif


This is (obviously) still missing the logic for SHA-3 support. Will need to be added after #20698 is merged. Just leaving the note here to not forget about it.

Yes, i should have mentioned that.

sys/psa_crypto/doc.txt

sys/psa_crypto/include/psa_hmac.h

tests/unittests/tests-hashes/tests-hashes-sha384-hmac.c

tests/unittests/tests-hashes/tests-hashes.h

Einhornhool

This looks nice and it's a good idea to have a generic implementation.
I added a few comments :)

sys/psa_crypto/psa_hmac.c

sys/psa_crypto/doc.txt

sys/psa_crypto/psa_hmac.c

mguetschow · 2024-07-09T09:22:58Z

Thanks @Wer-Wolf for addressing all the comments, looks good to me from the implementation side. There are still some open change requests on @daria-gauster's test code, would someone of you mind addressing those too?

Wer-Wolf · 2024-07-09T09:49:29Z

I will take care of this too.

mguetschow

Some more comments below :)

tests/unittests/tests-hashes/Makefile.include

tests/unittests/tests-hashes/tests-hashes.c

tests/unittests/tests-hashes/tests-hashes.h

tests/sys/psa_crypto_mac/Makefile

mguetschow · 2024-07-15T09:30:20Z

Also the current test implementation fails on the CI: https://ci.riot-os.org/details/f921c2a1211244a0b9ee984ef457e915

I'd propose to mimic the other tests, then it should work.

tests/sys/psa_crypto_mac/test_hmac_sha512.c

mguetschow

Nice work on the tests as well! Just minor suggestions.

After updating the boards in the Makefile.ci that don't fit the test application anymore (CI is currently generating a list of compile failures), you may squash the commits together before a last round of review.

tests/sys/psa_crypto_mac/Makefile

tests/sys/psa_crypto_mac/test_hmac_sha384.c

tests/sys/psa_crypto_mac/test_hmac_sha512.c

tests/sys/psa_crypto_mac/tests_gen_hmac.h

mguetschow · 2024-07-26T08:00:34Z

Ah, and now that #20698 has been merged, this one probably needs some updates to support SHA-3 as well.

Wer-Wolf · 2024-07-27T23:30:41Z

Ah, and now that #20698 has been merged, this one probably needs some updates to support SHA-3 as well.

I suggest that this happens in a separate PR.

Wer-Wolf · 2024-07-28T22:55:01Z

Are the reworked tests ok?

mguetschow

Just had a quick look at your changes on the test code. Two comments below.

tests/sys/psa_crypto_mac/test_hmac_sha384.c

mguetschow · 2024-07-29T12:14:03Z

Ah, and now that #20698 has been merged, this one probably needs some updates to support SHA-3 as well.

I suggest that this happens in a separate PR.

Sounds like a good idea to keep PRs small :)

mguetschow · 2024-07-30T08:31:47Z

Feel free to squash the changes together for a hopefully last round of review :)

Wer-Wolf · 2024-08-07T05:33:52Z

I found some issues while working on the HMAC hardware acceleration. If the fixup commits are fine, then i can squash them into the other commits too.

sys/psa_crypto/psa_crypto.c

The PSA crypto specification states that when creating keys, the usage flags PSA_KEY_USAGE_SIGN_HASH/PSA_KEY_USAGE_VERIFY_HASH automatically set the usage flags PSA_KEY_USAGE_SIGN_MESSAGE/PSA_KEY_USAGE_VERIFY_MESSAGE on the key. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Prepare to support the multi-part MAC API by creating appropriate dispatchers for both algorithm and location backends. Since there are no supported backends at the moment, the dispatcher always returns PSA_ERROR_NOT_SUPPORTED for now. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

The initial implementation was inspired by MbedTLS, with the addition of the MD2 and MD4 algorithms. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

This support macro will be needed by the generic hmac implementation. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

This additional macro will be used by the generic hmac implementation to calculate the size of the internal buffers. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Add a generic HMAC implementation based on the PSA hashing API. In order to support a specific HMAC algorithm, all what has to be implemented is a backend for the PSA hashing API. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

The generic HMAC implementation can only be used by going through the dispatcher. Do the necessary wire-up so that applications using the PSA crypto API can use the generic HMAC implementation. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

The old HMAC implementation only supported the SHA256 hashing algorithm and only implemented the single-part MAC function. Replace it with the generic HMAC implementation which supports all hashing algorithms and is already used for the multi-part MAC functions. A side effect of this commit is that the cryptocell HMAC implementation is not used anymore. This will be fixed in a later commit which introduces broad hardare-acceleration for HMAC. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Implement the PSA MAC verification API. Currently only the generic HMAC backend is available for MAC verification, but hardware-accelerated backends can be added later. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Add some documentation regarding the steps for adding support for new HMAC algorithms to the generic HMAC implementation. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Add tests for the generic HMAC implementation. Authored-by: Daria Zatokovenko <daria.zatokovenko@gmail.com> Signed-off-by: Armin Wolf <W_Armin@gmx.de>

mguetschow · 2025-01-09T15:07:34Z

@Wer-Wolf what is your status on this one? I could benefit from PSA crypto support for HMAC soonish.

If you don't have time right now, maybe give a short list of things that still need to be done to get this in?

Wer-Wolf · 2025-01-09T15:11:15Z

I am currently busy with my bachelor thesis, so i have little time for bringing this PR to mainline.

We still need to:

move the PSA data types into separate headers (i.e. hash data types need to be a separate header, etc)
fit in the generic HMAC
test it

Wer-Wolf requested a review from miri64 as a code owner June 22, 2024 21:36

github-actions bot added Area: doc Area: Documentation Area: tests Area: tests and testing framework Area: sys Area: System labels Jun 22, 2024

waehlisch requested a review from Einhornhool June 22, 2024 23:54

mguetschow self-requested a review June 24, 2024 07:39

mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jun 24, 2024

mguetschow requested changes Jun 24, 2024

View reviewed changes

Einhornhool reviewed Jun 25, 2024

View reviewed changes

sys/psa_crypto/psa_hmac.c Outdated Show resolved Hide resolved

sys/psa_crypto/doc.txt Outdated Show resolved Hide resolved

sys/psa_crypto/doc.txt Outdated Show resolved Hide resolved

sys/psa_crypto/psa_hmac.c Outdated Show resolved Hide resolved

daria-gauster requested review from leandrolanzieri, aabadie and MichelRottleuthner as code owners July 12, 2024 20:11

daria-gauster force-pushed the generic_hmac_sha512_test branch from 408da13 to 4e1838c Compare July 12, 2024 20:20

mguetschow requested changes Jul 15, 2024

View reviewed changes

mguetschow reviewed Jul 24, 2024

View reviewed changes

tests/sys/psa_crypto_mac/test_hmac_sha512.c Outdated Show resolved Hide resolved

mguetschow requested changes Jul 26, 2024

View reviewed changes

mguetschow reviewed Jul 29, 2024

View reviewed changes

tests/sys/psa_crypto_mac/test_hmac_sha384.c Show resolved Hide resolved

tests/sys/psa_crypto_mac/test_hmac_sha384.c Show resolved Hide resolved

Wer-Wolf force-pushed the generic_hmac_sha512_test branch from 9024d0a to c058591 Compare August 6, 2024 16:55

mguetschow reviewed Aug 20, 2024

View reviewed changes

sys/psa_crypto/psa_crypto.c Outdated Show resolved Hide resolved

Wer-Wolf and others added 11 commits August 22, 2024 18:59

sys/psa_crypto: Implement PSA_HASH_BLOCK_LENGTH()

95400a7

The initial implementation was inspired by MbedTLS, with the addition of the MD2 and MD4 algorithms. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

sys/psa_crypto: Implement PSA_MAC_MAX_SIZE()

92fc1de

This support macro will be needed by the generic hmac implementation. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

sys/psa_crypto: Add PSA_HMAC_BLOCK_MAX_SIZE()

b54214a

This additional macro will be used by the generic hmac implementation to calculate the size of the internal buffers. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

sys/psa_crypto: Add generic HMAC implementation

476719c

Add a generic HMAC implementation based on the PSA hashing API. In order to support a specific HMAC algorithm, all what has to be implemented is a backend for the PSA hashing API. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

sys/psa_crypto: Implement psa_mac_verify()

3573476

Implement the PSA MAC verification API. Currently only the generic HMAC backend is available for MAC verification, but hardware-accelerated backends can be added later. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

sys/psa_crypto: Document the generic HMAC implementation

5ccb81d

Add some documentation regarding the steps for adding support for new HMAC algorithms to the generic HMAC implementation. Signed-off-by: Armin Wolf <W_Armin@gmx.de>

tests/sys/psa_crypto_mac: Add tests for generic HMAC implementations

3606e9b

Add tests for the generic HMAC implementation. Authored-by: Daria Zatokovenko <daria.zatokovenko@gmail.com> Signed-off-by: Armin Wolf <W_Armin@gmx.de>

Wer-Wolf force-pushed the generic_hmac_sha512_test branch from 1d04cdf to 3606e9b Compare August 22, 2024 17:08

Wer-Wolf mentioned this pull request Sep 7, 2024

Various PSA Crypto fixes #20854

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sys/psa_crypto: Add generic HMAC implementation #20758

sys/psa_crypto: Add generic HMAC implementation #20758

Wer-Wolf commented Jun 22, 2024 •

edited

Loading

riot-ci commented Jun 24, 2024 •

edited

Loading

mguetschow left a comment

mguetschow Jun 24, 2024

Wer-Wolf Jun 24, 2024

Einhornhool left a comment

mguetschow commented Jul 9, 2024

Wer-Wolf commented Jul 9, 2024

mguetschow left a comment

mguetschow commented Jul 15, 2024

mguetschow left a comment

mguetschow commented Jul 26, 2024

Wer-Wolf commented Jul 27, 2024

Wer-Wolf commented Jul 28, 2024

mguetschow left a comment

mguetschow commented Jul 29, 2024

mguetschow commented Jul 30, 2024

Wer-Wolf commented Aug 7, 2024

mguetschow commented Jan 9, 2025

Wer-Wolf commented Jan 9, 2025

sys/psa_crypto: Add generic HMAC implementation #20758

Are you sure you want to change the base?

sys/psa_crypto: Add generic HMAC implementation #20758

Conversation

Wer-Wolf commented Jun 22, 2024 • edited Loading

Contribution description

Testing procedure

riot-ci commented Jun 24, 2024 • edited Loading

Murdock results

Artifacts

mguetschow left a comment

Choose a reason for hiding this comment

mguetschow Jun 24, 2024

Choose a reason for hiding this comment

Wer-Wolf Jun 24, 2024

Choose a reason for hiding this comment

Einhornhool left a comment

Choose a reason for hiding this comment

mguetschow commented Jul 9, 2024

Wer-Wolf commented Jul 9, 2024

mguetschow left a comment

Choose a reason for hiding this comment

mguetschow commented Jul 15, 2024

mguetschow left a comment

Choose a reason for hiding this comment

mguetschow commented Jul 26, 2024

Wer-Wolf commented Jul 27, 2024

Wer-Wolf commented Jul 28, 2024

mguetschow left a comment

Choose a reason for hiding this comment

mguetschow commented Jul 29, 2024

mguetschow commented Jul 30, 2024

Wer-Wolf commented Aug 7, 2024

mguetschow commented Jan 9, 2025

Wer-Wolf commented Jan 9, 2025

Wer-Wolf commented Jun 22, 2024 •

edited

Loading

riot-ci commented Jun 24, 2024 •

edited

Loading