ESP32 Espressif Improvements - Roadmap Summary

[gojimmypi]

Version

Latest master branch

Description

There are a large numbers of improvements in my fork that not only address several open issues, but also include numerous other improvements, both Espressif-specific and general library updates.

The changes will be documented and managed in this separate issue. Many of them are interrelated, but some can be extracted into separate pull requests from ED25519_SHA2_fix:

Actively working on:

• Improving wolfSSL integration with the Espressif ESP-IDF #7640 see also esp-idf #13966
• Duplicate macro definition warnings: Espressif project missing WOLFSSL_USER_SETTINGS #6848
• wolfMQTT unexpectedly attempts single-use Espressif hardware lock wolfMQTT#353
• [Bug]: wolfSSL_free crash on ESP32s3 #6637
• New and updated VisualGDB Project and solution files #6609
• SM Cipher: sample certificate files need a header file for embedded apps. #6681 (see #6825)

Issues:

• Feature Request: local project user_settings.h for no-setup Espressif #6118.
• Various uninitialized variables and typos #6025.
• Missing SHA2 test #5989.
• Espressif CMake set CMAKE_C_FLAGS unreliable results project-wide #5727.
• Espressif ESP-IDF component install fails when target directory path has embedded spaces #5154.
• Espressif idf refuses to clean shared VisualGDB build directory wolfssl-examples#369

Done, pending user acceptance:

• Support for Espressif ESP-IDF v5 #5909. See Support for Espressif ESP-IDF v5 #5909 (comment)
• Compilation error when defining OPENSSL_ALL or OPENSSL_EXTRA on ESP-IDFv5 : ssl.c:18011:22: error: size of array 'sha_test' is negative #6028.

Pull Requests:

• New wolfcrypt Hardware Acceleration SHA Copy Tests #6134.
• Check final SHA buffer blocksize #5998.
• Validate subjAltName for uuid and similar URNs #5964.
• Esp32s3 support #5950.
• Add config check automation tool for wolfSSL configure #5876.

Espressif specific:

• Transfer espressif/esp-wolfssl to wolfSSL.
• Add the Github action to upload the component to the registry into the esp-wolfssl repository. An example can be seen here.
• Update wolfssl​ submodule to one of the recent release tags.
• Remove the legacy GNU Make build system.
• Remove support for EoL versions of IDF.
• Port the CI scripts from Espressif Gitlab-based ones to Github Actions.
• Add a component version badge to README.
• Review and update the README as necessary.

Espressif RISC-V:

• Implement wolfSSL Hardware Acceleration on the ESP32-C3, ESP32-C6, etc.
• Add example core woldSSL RISC-V projects in Espressif/ESP-IDF/examples.
• Add example RISC-V projects in wolfssl-examples.
• Add example RISC-V projects in wolfssh-examples.

Espressif Arduino:

• [Bug]: wolfssl_server.ino doesn't even compile for ESP32 boards #6360

Other Improvements:

• Update Espressif examples to use new "no setup" CMakeFiles.txt wolfssl-examples#385
• Update Espressif SSH examples to use new "no setup" CMakeFiles.txt wolfssh#514
• Update examples in wolfssl-examples to support ESP-IDF v5.
• Update SSH examples in wolfssh-examples to support ESP-IDF v5.
• Create a stand-alone ESP32 CSR Key/Sign Example from the WIP #6205 Example.
• Implement and expand KConfig support.
• Fix HW math acceleration in TFM. See interim fix in ESP32 TFM fix for RSA key size 512 and 2048 #6286

Mothballed, to address later:

• Add SM Cipher certificate test header: certs_test_sm.h #6825
• SM Cipher: sample certificate files need a header file for embedded apps. #6681
• Feature Request: Comprehensive Espressif Math Tests #6385 (see #6380)
• [Bug]: TFM math with Espressif HW not honoring fp_int [used] length: s_fp_add error #6380 (fixed in [Espressif HW Improvements #6624]- New wolfcrypt Hardware Acceleration SHA Copy Tests #6134
• RSA call to TFM overwrites math operands #6359
• Various uninitialized variables and typos #6025
• Missing SHA2 test #5989
• Check final SHA buffer blocksize #5998
• Target-specific autogen? Espressif in particular. #5883.
• implement ShowExtendedSystemInfo() in version.c #6149. (see esp_ShowExtendedSystemInfo in esp32-crypt.h )
  (Espressif HW Improvements #6624))

Done - wolfSSL

• Introduce WOLFSSL_ESPIDF_EXIT_MESSAGE macro #7067
• New Espressif Component Manager Integration Needed #5319. See (PR #6708)
• Espressif benchmark update #7037
• Espressif wolfcrypt updates #7035
• Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990
• wolfSSL GitHooks spawn .git/hooks/pre-push: incompatible on Visual Studio Windows WSL #6779
• ESP32 debug only: Mode REVERT to ESP32_SHA_SW #6811
• Espressif ESP32 Benchmark, Test, TLS 1.3 Client & Server Updates #6844
• [Bug]: ed25519_test fails on ESP32 #5948.
• Espressif ESP32-S3 does not support AES-192 Hardware Acceleration #6375 (fixed in #6624)
• [Bug]: Enabling OPENSSL_ALL on the ESP32 causes compile error related to WOLFSSL_SP_INT_NEGATIVE #6373
• WOLFSSL_SP_INT_NEGATIVE declaration for all Espressif chipsets #6374
• [Bug]: Espressif SHA224 Fails wolfssl_test #6059.
• Espressif examples run with local wolfSSL (no setup!) #6018
• Add Espressif ESP-IDF template project #6682
• Espressif HW Improvements #6624
• Confirm wolfSSL works in namespace in the ESP-IDF component registry, https://components.espressif.com/.
• wolfcrypt/settings.h: use default realloc on EspressIf #6210.
• Espressif HW Improvements #6624
• testwolfctypt missing embedded filesystem read-only memory test #6522 for ESP32-S3 Linux (fixed in Add wolfcrypt test: R/O filesystem const memory pointer #6523)
• Add wolfcrypt test: R/O filesystem const memory pointer #6523
• Espressif refactor WROOM32 ESP32 #6587
• wolfcrypt polish: init, checks, corrections #6249.
• platform-specific VisualGDB test & benchmark projects #6285
• Various Espressif HW crypto, SHA2, AES, MP updates. #6287
• ESP32 TFM fix for RSA key size 512 and 2048 #6286 (fixed in #6624)
• [Bug]: Invalid CSR generated by ESP32s3 #6205 (fixed in [Espressif HW Improvements #6624]
• Add wolfSSL Encryption Library Support for Espressif ESP32-C6 #6163.
• Missing explicit support for Espressif ESP32 WROVER, C3, S3 #5215.

Done - wolfSSH

• internal.c var initialization for Espressif Component Manager  wolfssh#589
• wolfSSH Espressif ESP32 Managed Component Support wolfssh#588. See (wolfSSH PR #601)

Done - wolfMQTT

• wolfMQTT Espressif ESP32 Managed Component Support wolfMQTT#352

Have an idea for other improvements? Feel free to open a new issue or send us an email facts@wolfssl.com