Introduce Espressif common CONFIG_WOLFSSL_EXAMPLE_NAME, Kconfig #7866
Conversation
dgarske
requested review from
douzzer
and removed request for
ejohnstown,
dgarske,
bandi13 and
embhorn
| #define USE_CERT_BUFFERS_256 | ||
| /* Be sure to include in app when using example certs: */ |
There was a problem hiding this comment.
fix hard tabs in the indentation here.
There was a problem hiding this comment.
ah yes, interesting. Visual Studio usually converts to spaces at save time. Good catch. Fixed
| #define USE_CERT_BUFFERS_256 | ||
| /* Be sure to include in app when using example certs: */ |
| @@ -208,7 538,7 @@ | |||
| #define USE_FAST_MATH | |||
|
|
|||
| /***** Use SP_MATH *****/ | |||
| /* #undef USE_FAST_MATH */ | |||
| /* #undef USE_FAST_MATH */ | |||
There was a problem hiding this comment.
suggest you either snip out the added space after #undef, or snip out a space afterwards to get the */ to line up.
| bool "Enable RSA in my project" | ||
| default "n" | ||
| help | ||
| RSA is disabled by default. Select this option to enable. |
There was a problem hiding this comment.
Is RSA default-disabled just as a space-saving measure, due to the small target?
There was a problem hiding this comment.
yes, good question. Having the default for "works on more systems" is desirable, particularly something like the C2 or Arduino Nano with limited memory.
The sdkconfig.defaults can be used to set defaults, as well as sdkconfig.defaults.[target] (see example).
I've been reluctant to include all the sdkconfig.defaults.[target] files in all the examples without a compelling reason, but in the future it might be better to enable RSA by default, and then include a sdkconfig.defaults.esp32c2 file that disables it.
| #define WOLFSSL_ESP32_HW_LOCK_DEBUG | ||
| #define WOLFSSL_DEBUG_MUTEX | ||
| #define WOLFSSL_DEBUG_ESP_RSA_MULM_BITS |
There was a problem hiding this comment.
Does it make sense to enable debug gates in the example config? Maybe so. Just wondering if you considered the overhead.
Edit: There's actually another #define WOLFSSL_ESP32_HW_LOCK_DEBUG below, commented out.
There was a problem hiding this comment.
Does it make sense to enable debug gates in the example config? Maybe so.
Maybe, but not much interesting in this template example. I'll review with the other examples & see if any make sense without being too verbose. There's already some informative "always on" messages. See the ESP_LOGI() in the TLS Client Example. I'll definitely be adding more settings to control these from Kconfig / menuconfig.
Another #define WOLFSSL_ESP32_HW_LOCK_DEBUG below, commented out.
Good catch. I've removed the extra one.
gojimmypi
force-pushed
the
pr-espressif-config
branch
from
46280ff
to
a0fc2f0
Compare
|
Thanks, @douzzer for the code review and attention to detail. I believe I've tidied things up. |
|
retest this please |
Description
This PR introduces common KConfig and user setting files for the Espressif template app as it is the most basic example and least intrusive to change.
The intent is that all wolfSSL examples in all repos will have common
user_settings.h,CMakeLists.txtandKConfigfiles, with only thesdkconfig.defaultsvarying. Rather than propose all changes to all examples at once, this PR for only thetemplateexample is for simplified code review.Note that new configuration settings specific to ESP-IDF versions integrating wolfSSL are also included here. There's likely little to no effect on ESP-IDF versions that do not support the new features. As of the date of this PR, many features are only available on my ESP-IDF v5.2.2 fork.
The objective is to not only simplify the configuration of the
user_settings.hfile by utilizing themenuconfigcapabilities, but in doing so will also prevent changes from being needed when using the wolfSSL Managed Component. Recall that making changes, such as to theuser_settings.hfile, causes the component manager to complain about changes. This forces the user to convert the Managed Component to a regular component, defeating the purpose and value of having a managed component in the first place.Here's the new
idf.py menuconfigas viewed in VisualGDB. Note the dropdown also increases end-user awareness to the other examples available:Fixes zd#: Not "fixing" but related to 18228.
Testing
How did you test?
Tested only on Espressif targets.
Checklist