Fix MSVC build issue from MbedTls issue 7087 #258

ccrugoPhilips · 2025-04-15T15:27:38Z

Description

Refactored code causing build issues with MSVC toolset v142 and prior. This has been tracked under MbedTls issue 7087.

PR checklist

changelog provided in Move the inclusion of crypto_sizes.h and crypto_struct.h in crypto.h #260
framework PR not required
mbedtls development PR not required because: change in TF-PSA-Crypto only
mbedtls 3.6 PR provided [3.6] Fix build C++ apps with MSVC mbedtls#10200
tests not required because: the change is validated by the current tests. We can't afford the effort required for non-regression testing right now. Covered by Add test to validate that headers can be used in C++ with Visual Studio mbedtls#1767.

ronald-cron-arm

Thanks for this contribution. We are not comfortable with the changes in crypto.h. Please see my comment below.

include/psa/crypto.h

ccrugoPhilips · 2025-04-18T10:11:31Z

A couple of additional remarks:

The build issues reported in Mbed-TLS/mbedtls#7087 are not present anymore with VS2022 (MSVC toolset v143).

Added an extra fix for a warning being treated as error when MBEDTLS_PSA_KEY_STORE_DYNAMIC is disabled.

ronald-cron-arm

Sorry for the delay.
Two nitpicks but otherwise this looks god to me. Unfortunately, this needs to be rebased though (conflicts with crypto_extra.h).
I've removed the commits related to crypto_extra.h in #260 and added there a change log that should cover both PRs.
Thus if possible on your side, please rebase. Otherwise if this is more convenient for you I can cherry-pick your commits in #260 and resolve the conflicts.
Otherwise @irwir proposed here a simpler solution it seems. Would this work for you?

ronald-cron-arm · 2025-05-27T09:30:41Z

include/psa/crypto_extra.h

+struct psa_pake_cipher_suite_s
+{


Suggested change

struct psa_pake_cipher_suite_s

{

struct psa_pake_cipher_suite_s {

ronald-cron-arm · 2025-05-27T10:06:57Z

include/psa/crypto_extra.h

+    /* A primitive of type compatible with algorithm */
+    psa_pake_primitive_t MBEDTLS_PRIVATE(primitive);
+    /* Stage of the PAKE operation: waiting for the setup, collecting inputs
+    * or computing. */


Suggested change

* or computing. */

* or computing. */

ccrugoPhilips · 2025-06-11T13:11:07Z

Sorry for the delay. Two nitpicks but otherwise this looks god to me. Unfortunately, this needs to be rebased though (conflicts with crypto_extra.h). I've removed the commits related to crypto_extra.h in #260 and added there a change log that should cover both PRs. Thus if possible on your side, please rebase. Otherwise if this is more convenient for you I can cherry-pick your commits in #260 and resolve the conflicts. Otherwise @irwir proposed here a simpler solution it seems. Would this work for you?

Hi there, I see that related PRs have already been merged and seems this PR is not necessary anymore; can you please confirm to close without merging. Happy the issue was finally addressed ;)

irwir · 2025-06-12T10:33:20Z

Happy the issue was finally addressed

Addressed, but not fully resolved.
You were given a link to my comment in the merged @ronald-cron-arm's PR; please read.

ronald-cron-arm · 2025-06-12T12:59:19Z

Sorry for the delay. Two nitpicks but otherwise this looks god to me. Unfortunately, this needs to be rebased though (conflicts with crypto_extra.h). I've removed the commits related to crypto_extra.h in #260 and added there a change log that should cover both PRs. Thus if possible on your side, please rebase. Otherwise if this is more convenient for you I can cherry-pick your commits in #260 and resolve the conflicts. Otherwise @irwir proposed here a simpler solution it seems. Would this work for you?

Hi there, I see that related PRs have already been merged and seems this PR is not necessary anymore; can you please confirm to close without merging. Happy the issue was finally addressed ;)

Hi, to address #7087, the changes needed in crypto.h are merged both in development(#260) and 3.6(Mbed-TLS/mbedtls#10196). We still have to merge the changes needed in crypto_extra.h. While looking at the backport in 3.6 (Mbed-TLS/mbedtls#10200) I realized that the changes proposed here and previously in #260 could be improved to be more aligned with how things are now organized in crypto.h . That what we have now in Mbed-TLS/mbedtls#10200, that is ready to merged. I plan to align this PR with Mbed-TLS/mbedtls#10200 regarding crypto_extra.h.

ronald-cron-arm · 2025-06-12T13:00:07Z

Happy the issue was finally addressed

Addressed, but not fully resolved. You were given a link to my comment in the merged @ronald-cron-arm's PR; please read.

Eventually I do not think we can just remove the declarations:
static psa_pake_cipher_suite_t psa_pake_cipher_suite_init(void);
static psa_pake_operation_t psa_pake_operation_init(void);

That the way we do it in crypto.h for the other xyz_init(void) functions: psa_key_attributes_init(), psa_hash_operation_init(), psa_mac_operation_init() ...

irwir · 2025-06-12T14:37:15Z

Eventually I do not think we can just remove the declarations

What is the reason?
If no code between forward declaration and function definition references the function, then forward declaration is pointless and safely could be removed.

ronald-cron-arm · 2025-06-12T14:51:23Z

Eventually I do not think we can just remove the declarations

What is the reason? If no code between forward declaration and function definition references the function, then forward declaration is pointless and safely could be removed.

I gave the reason above: alignment with how things are done for the other xyz_init() functions for the other algorithms in crypto.h. That way when PAKE APIs become official the move of the PAKE header code to crypto_struct.h, crypto.h ... is hopefully going to be easier.

irwir · 2025-06-12T15:55:33Z

alignment with how things are done for the other xyz_init() functions for the other algorithms in crypto.h

Alignment could have the opposite direction - in my case commenting out all forward declarations fixed the issue (4 lines in crypto.h, 2 lines in crypto_extra.h). But whatever, the current code is far from final.

Signed-off-by: Cesar Cruz <[email protected]> Signed-off-by: ccrugoPhilips <[email protected]>

Signed-off-by: ccrugoPhilips <[email protected]>

Signed-off-by: Ronald Cron <[email protected]>

ronald-cron-arm · 2025-06-16T08:55:17Z

Thus I have aligned the changes done to crypto_extra.h with the ones done in Mbed-TLS/mbedtls#10200. The result was 01284e6. Then I rebased to resolve the conflicts in crypto_extra.h due to the work on PAKE key confirmation that was merged as part of another thread of work.

In crypto_extra.h, move PAKE size calculation macros, the definition of psa_pake_cipher_suite_s and psa_pake_operation_s just after PAKE type and values definitions. This aligns with the order of crypto header inclusions in crypto.h: crypto_types.h, then crypto_values.h, then crypto_sizes.h, and then crypto_struct.h. Take care of keeping them outside of the pake Doxygen group as they used to be. Signed-off-by: Ronald Cron <[email protected]>

As the definition of psa_pake_operation_s has been moved the "xyt_t" structure types can not be used anymore (defined later). Signed-off-by: Ronald Cron <[email protected]>

Signed-off-by: Ronald Cron <[email protected]>

minosgalanakis

Looks good overall, in aligment with Mbed-TLS/mbedtls#10200 with only one missing bugfix on the backport.

minosgalanakis · 2025-06-17T21:32:49Z

core/psa_crypto_slot_management.c

@@ -660,7 +660,7 @@ psa_status_t psa_reserve_free_key_slot(psa_key_id_t *volatile_key_id,
            /* Refresh slot_idx, for when the slot is not the original
             * selected_slot but rather unused_persistent_key_slot.  */
            slot_idx = selected_slot - global_data.key_slots;
-            *volatile_key_id = PSA_KEY_ID_VOLATILE_MIN + slot_idx;
+            *volatile_key_id = PSA_KEY_ID_VOLATILE_MIN + (psa_key_id_t) slot_idx;


As discussed on the back-port PR was this fix required ?

minosgalanakis · 2025-06-17T21:45:08Z

include/psa/crypto_extra.h

+    psa_pake_family_t family;
+    uint16_t  bits;
+    psa_algorithm_t hash;
+    uint32_t key_confirmation;


This is a note for other reviewers: This API incompatibility is expected and introduced in #200

davidhorstmann-arm

LGTM, thanks!

Outdated

ccrugoPhilips force-pushed the fix/vs2019_build_issue_7087 branch from bb38edb to de8fa9e Compare April 15, 2025 15:29

ccrugoPhilips mentioned this pull request Apr 16, 2025

Upgrade Mbed-TLS to version >= 3.3.0 after issue with MSVC builds has been fixed philips-software/amp-embedded-infra-lib#240

Closed

ronald-cron-arm added enhancement New feature or request needs-work labels Apr 17, 2025

ronald-cron-arm requested changes Apr 17, 2025

View reviewed changes

include/psa/crypto.h Outdated Show resolved Hide resolved

ccrugoPhilips force-pushed the fix/vs2019_build_issue_7087 branch from fb49fd7 to 7a96523 Compare April 18, 2025 10:46

ccrugoPhilips requested a review from ronald-cron-arm April 18, 2025 11:09

ronald-cron-arm previously requested changes May 27, 2025

View reviewed changes

ronald-cron-arm mentioned this pull request May 27, 2025

Move the inclusion of crypto_sizes.h and crypto_struct.h in crypto.h #260

Merged

4 tasks

This was referenced May 28, 2025

[Backport 3.6] Move the inclusion of crypto_sizes.h and crypto_struct.h in crypto.h Mbed-TLS/mbedtls#10196

Merged

[3.6] Fix build C++ apps with MSVC Mbed-TLS/mbedtls#10200

Merged

ccrugoPhilips and others added 4 commits June 16, 2025 10:29

fix: linkeage erros from MbedTls issue 7087

c6831ca

Signed-off-by: Cesar Cruz <[email protected]> Signed-off-by: ccrugoPhilips <[email protected]>

fix: additional MSVC v142 build issue with tls1.3 configuration enabled.

31f7446

Signed-off-by: Cesar Cruz <[email protected]> Signed-off-by: ccrugoPhilips <[email protected]>

rolled back changes in crypto_struct.h and crypto.h

055d287

Signed-off-by: ccrugoPhilips <[email protected]>

Roll back changes in crypto_exta.h

48e0807

Signed-off-by: Ronald Cron <[email protected]>

ronald-cron-arm force-pushed the fix/vs2019_build_issue_7087 branch from 01284e6 to 72b1832 Compare June 16, 2025 08:51

ronald-cron-arm added the needs-ci Needs to pass CI tests label Jun 16, 2025

ronald-cron-arm added 2 commits June 16, 2025 11:35

Fix psa_pake_operation_s member types

162d773

As the definition of psa_pake_operation_s has been moved the "xyt_t" structure types can not be used anymore (defined later). Signed-off-by: Ronald Cron <[email protected]>

ronald-cron-arm force-pushed the fix/vs2019_build_issue_7087 branch from 72b1832 to 162d773 Compare June 16, 2025 09:36

Fix code style

4ed5626

Signed-off-by: Ronald Cron <[email protected]>

ronald-cron-arm added needs-review Every commit must be reviewed by at least two team members and removed needs-work needs-ci Needs to pass CI tests labels Jun 17, 2025

ronald-cron-arm requested a review from minosgalanakis June 17, 2025 12:58

minosgalanakis approved these changes Jun 17, 2025

View reviewed changes

ronald-cron-arm requested a review from davidhorstmann-arm June 18, 2025 12:30

davidhorstmann-arm approved these changes Jun 19, 2025

View reviewed changes

ronald-cron-arm added this pull request to the merge queue Jun 19, 2025

davidhorstmann-arm added approved Design and code approved - may be waiting for CI or backports and removed needs-review Every commit must be reviewed by at least two team members labels Jun 19, 2025

Merged via the queue into Mbed-TLS:development with commit 21de3e2 Jun 19, 2025
3 checks passed

ronald-cron-arm mentioned this pull request Jun 23, 2025

Unable to build simple c++ example with Visual Studio 15 2017 Mbed-TLS/mbedtls#7087

Closed

	struct psa_pake_cipher_suite_s
	{
	struct psa_pake_cipher_suite_s {

Fix MSVC build issue from MbedTls issue 7087 #258

Fix MSVC build issue from MbedTls issue 7087 #258

Uh oh!

Conversation

ccrugoPhilips commented Apr 15, 2025 • edited by ronald-cron-arm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

PR checklist

Uh oh!

ronald-cron-arm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ccrugoPhilips commented Apr 18, 2025

Uh oh!

ronald-cron-arm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ronald-cron-arm May 27, 2025

Choose a reason for hiding this comment

Uh oh!

ronald-cron-arm May 27, 2025

Choose a reason for hiding this comment

Uh oh!

ccrugoPhilips commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

irwir commented Jun 12, 2025

Uh oh!

ronald-cron-arm commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ronald-cron-arm commented Jun 12, 2025

Uh oh!

irwir commented Jun 12, 2025

Uh oh!

ronald-cron-arm commented Jun 12, 2025

Uh oh!

irwir commented Jun 12, 2025

Uh oh!

ronald-cron-arm commented Jun 16, 2025

Uh oh!

minosgalanakis left a comment

Choose a reason for hiding this comment

Uh oh!

minosgalanakis Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

minosgalanakis Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

davidhorstmann-arm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ccrugoPhilips commented Apr 15, 2025 •

edited by ronald-cron-arm

Loading

ronald-cron-arm left a comment •

edited

Loading

ccrugoPhilips commented Jun 11, 2025 •

edited

Loading

ronald-cron-arm commented Jun 12, 2025 •

edited

Loading