Add introspection for math build and math cleanups #6123

dgarske · 2023-02-22T20:43:17Z

Description

Add introspection for math build.
Raise build error if more than one math library used.
Cleanups for building with WOLFCRYPT_ONLY and NO_BIG_INT.
Refactor math headers to use wolfmath.h
Fix ESP32 to support using any multi-precision math option.
Refactor of the opaque math variable type MATH_INT_T used by crypto hardware (QuickAssist, SE050, ESP32 and STM32).
Stop forcing use of fast math by default for platforms in settings.h.

Note: For users that still want to use fast math (tfm.c) they will need to add USE_FAST_MATH to their build settings.
Applies To:

WOLFSSL_ESPWROOM32
WOLFSSL_ESPWROOM32SE
MICROCHIP_PIC32
WOLFSSL_PICOTCP_DEMO
WOLFSSL_UTASKER
WOLFSSL_NRF5x
FREERTOS_TCP
WOLFSSL_TIRTOS
EBSNET
FREESCALE_COMMON
FREESCALE_KSDK_BM
WOLFSSL_DEOS
MICRIUM
WOLFSSL_SGX

Example Output:

Math: 	Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c
	Single Precision: ecc 256 384 521 rsa/dh 2048 3072 4096 asm sp_x86_64.c

Math: 	Multi-Precision: Disabled
	Single Precision: ecc 256 2048 3072 sp_c64.c

Math: 	Multi-Precision: Fast max-bits=4096 not-constant-time tfm.c
	Single Precision: ecc 256 2048 3072 sp_c64.c

Math: 	Multi-Precision: Fast max-bits=4096 not-constant-time tfm.c

Math: 	Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c
	Single Precision: ecc 256 384 521 rsa/dh 2048 3072 4096 sp_c64.c small

Testing

./configure --enable-usersettings --disable-examples && make
./wolfcrypt/test/testwolfcrypt

/* Place into user_settings.h */
/* Configuration example for ECC SP math only */
#define NO_BIG_INT
#define NO_RSA
#define NO_DSA
#define NO_DH
#define WOLFCRYPT_ONLY
#define HAVE_ECC
#define WOLFSSL_SP_MATH
#define WOLFSSL_HAVE_SP_ECC

Checklist

added tests
updated/added doxygen
updated appropriate READMEs
Updated manual and documentation

dgarske · 2023-02-23T15:34:56Z

Retest this please

josepho0918 · 2023-02-24T00:49:26Z

The macro USE_FAST_MATH are defined for lots of platforms by default in settings.h. They should be removed and let user to specify which math library to use.

dgarske · 2023-02-24T00:51:06Z

The macro USE_FAST_MATH are defined for lots of platforms by default in settings.h. They should be removed and let user to specify which math library to use.

This is very good feedback! I will adjust.

douzzer

this is great -- and dovetails with the testwolfcrypt retval refactor I'm churning through.

douzzer · 2023-02-24T07:31:04Z

wolfssl/wolfcrypt/settings.h

+#if (defined(WOLFSSL_SP_MATH_ALL) && \
+        (defined(USE_FAST_MATH) || defined(USE_INTEGER_HEAP_MATH))) || \
+    (defined(USE_FAST_MATH) && defined(USE_INTEGER_HEAP_MATH))
+    #error Cannot enable more than one multiple precision math library!


missed an opportunity for a really fun preprocessor construction here (this actually works!)

#if defined(WOLFSSL_SP_MATH_ALL) + defined(USE_FAST_MATH) + defined(USE_INTEGER_HEAP_MATH) > 1 #error nope #endif

not seriously suggesting... not even sure it's portable.

Yours is much more elegant, but I cannot guarantee portability. I think they would have to =1 and that is just not a guarantee.

IDE/Espressif/ESP-IDF/test/test_wolfssl.c

gojimmypi · 2023-02-24T22:55:53Z

wolfcrypt/benchmark/benchmark.c

@@ -2842,6 +2843,10 @@ int benchmark_init(void)
        return EXIT_FAILURE;
    }

+#ifdef HAVE_WC_INTROSPECTION
+    printf("Math: %s\n", wc_GetMathInfo());


Do we have something that will be more embedded-friendly than printf ?

printf is fine for embedded targets. it even works (more or less) in newlib-nano. troubles arise with fprintf though, so your point is well taken.

gojimmypi · 2023-02-24T22:58:22Z

Turning on

#define HAVE_WC_INTROSPECTION

and I see this new information at the beginning of tests:

It might be nice to have something other than printf().

gojimmypi · 2023-02-24T23:03:41Z

wolfssl/wolfcrypt/settings.h

@@ -2033,7 +2025,7 @@ extern void uITRON4_free(void *p) ;
        #undef HAVE_ECC_KEY_IMPORT
        #define HAVE_ECC_KEY_IMPORT
    #endif
-    #ifndef NO_ECC_KEY_EXPORT
+    #if !defined(NO_ECC_KEY_EXPORT) && !defined(NO_BIG_INT)


This is curious logic. Perhaps add a comment as to why !defined(NO_BIG_INT) is now required for HAVE_ECC_KEY_EXPORT ?

gojimmypi · 2023-02-24T23:04:55Z

wolfssl/wolfcrypt/settings.h

@@ -2503,7 +2495,7 @@ extern void uITRON4_free(void *p) ;
 #endif

 /* warning for not using harden build options (default with ./configure) */
-#ifndef WC_NO_HARDEN
+#if !defined(WC_NO_HARDEN) && !defined(NO_BIG_INT)


This too is curious. How is !defined(NO_BIG_INT) related to the !defined(WC_NO_HARDEN) here?

stale

wolfssl/wolfcrypt/types.h

dgarske · 2023-03-27T23:53:09Z

Retest this please

dgarske · 2023-03-28T15:30:52Z

retest this please

bandi13 · 2023-03-29T04:20:56Z

Jenkins retest this please

* Add introspection for math build. * Raise build error if more than one multi-precision math library used. * Fix ESP32 to support using any multi-precision math option. * Refactor math headers to use `wolfmath.h` * Refactor of the opaque math variable type `MATH_INT_T` used by crypto hardware (QuickAssist, SE050, ESP32 and STM32). * Cleanups for building with `WOLFCRYPT_ONLY` and `NO_BIG_INT`. * Stop forcing use of fast math by default for platforms in settings.h. Note: For users that still want to use fast math (tfm.c) they will need to add USE_FAST_MATH to their build settings. Applies To: ``` WOLFSSL_ESPWROOM32 WOLFSSL_ESPWROOM32SE MICROCHIP_PIC32 WOLFSSL_PICOTCP_DEMO WOLFSSL_UTASKER WOLFSSL_NRF5x FREERTOS_TCP WOLFSSL_TIRTOS EBSNET FREESCALE_COMMON FREESCALE_KSDK_BM WOLFSSL_DEOS MICRIUM WOLFSSL_SGX ```

dgarske requested review from douzzer and SparkiDev February 22, 2023 20:43

dgarske self-assigned this Feb 22, 2023

SparkiDev approved these changes Feb 22, 2023

View reviewed changes

dgarske force-pushed the math_info branch from 0cd3546 to 4ff4f90 Compare February 23, 2023 17:31

dgarske assigned douzzer and SparkiDev and unassigned dgarske Feb 23, 2023

dgarske force-pushed the math_info branch from 4ff4f90 to 0483606 Compare February 23, 2023 20:11

dgarske assigned dgarske, douzzer and SparkiDev and unassigned douzzer, SparkiDev and dgarske Feb 23, 2023

SparkiDev approved these changes Feb 23, 2023

View reviewed changes

dgarske unassigned SparkiDev Feb 24, 2023

dgarske assigned dgarske and unassigned douzzer Feb 24, 2023

douzzer approved these changes Feb 24, 2023

View reviewed changes

douzzer self-requested a review February 24, 2023 07:40

douzzer previously requested changes Feb 24, 2023

View reviewed changes

IDE/Espressif/ESP-IDF/test/test_wolfssl.c Show resolved Hide resolved

dgarske force-pushed the math_info branch from 2f865bf to 77778e5 Compare February 24, 2023 15:18

dgarske requested review from gojimmypi and douzzer February 24, 2023 17:47

dgarske force-pushed the math_info branch 2 times, most recently from 49b4b07 to 65609db Compare February 24, 2023 19:11

gojimmypi reviewed Feb 24, 2023

View reviewed changes

dgarske force-pushed the math_info branch from 8ac0fcb to 6704623 Compare February 28, 2023 21:15

SparkiDev requested changes Feb 28, 2023

View reviewed changes

wolfssl/wolfcrypt/types.h Show resolved Hide resolved

gojimmypi mentioned this pull request Feb 28, 2023

20230223-refactor-test-c-error-codes #6135

Merged

dgarske assigned dgarske and unassigned douzzer and SparkiDev Mar 3, 2023

gojimmypi mentioned this pull request Mar 20, 2023

implement ShowExtendedSystemInfo() in version.c #6149

Closed

4 tasks

dgarske force-pushed the math_info branch from 6704623 to 9d5b5e9 Compare March 27, 2023 16:31

dgarske added a commit to dgarske/wolfAsyncCrypt that referenced this pull request Mar 27, 2023

Adjust math to use refactor from wolfSSL/wolfssl#6123

d83efdd

dgarske requested a review from SparkiDev March 27, 2023 21:16

dgarske assigned SparkiDev and unassigned dgarske Mar 27, 2023

SparkiDev approved these changes Mar 27, 2023

View reviewed changes

SparkiDev assigned dgarske and unassigned SparkiDev Mar 27, 2023

dgarske force-pushed the math_info branch from 9d5b5e9 to 22a5a5c Compare March 30, 2023 21:43

dgarske assigned SparkiDev and unassigned dgarske Mar 30, 2023

SparkiDev merged commit 6bed0c5 into wolfSSL:master Mar 30, 2023

gojimmypi mentioned this pull request Apr 6, 2023

Software-only support for recent esp32 targets #6256

Closed

4 tasks

dgarske mentioned this pull request Jul 10, 2023

Fix for SP math only case to ensure fast math and heap math are disabled #6590

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add introspection for math build and math cleanups #6123

Add introspection for math build and math cleanups #6123

dgarske commented Feb 22, 2023 •

edited

Loading

dgarske commented Feb 23, 2023

josepho0918 commented Feb 24, 2023

dgarske commented Feb 24, 2023

douzzer left a comment

douzzer Feb 24, 2023

dgarske Feb 24, 2023

gojimmypi Feb 24, 2023

douzzer Feb 24, 2023

gojimmypi commented Feb 24, 2023

gojimmypi Feb 24, 2023

gojimmypi Feb 24, 2023

dgarske commented Mar 27, 2023

dgarske commented Mar 28, 2023

bandi13 commented Mar 29, 2023

Add introspection for math build and math cleanups #6123

Add introspection for math build and math cleanups #6123

Conversation

dgarske commented Feb 22, 2023 • edited Loading

Description

Testing

Checklist

dgarske commented Feb 23, 2023

josepho0918 commented Feb 24, 2023

dgarske commented Feb 24, 2023

douzzer left a comment

Choose a reason for hiding this comment

douzzer Feb 24, 2023

Choose a reason for hiding this comment

dgarske Feb 24, 2023

Choose a reason for hiding this comment

gojimmypi Feb 24, 2023

Choose a reason for hiding this comment

douzzer Feb 24, 2023

Choose a reason for hiding this comment

gojimmypi commented Feb 24, 2023

gojimmypi Feb 24, 2023

Choose a reason for hiding this comment

gojimmypi Feb 24, 2023

Choose a reason for hiding this comment

dgarske commented Mar 27, 2023

dgarske commented Mar 28, 2023

bandi13 commented Mar 29, 2023

dgarske commented Feb 22, 2023 •

edited

Loading