<!--- This file has the version text in `idf_published_versions.txt` automatically replaced. Edit with caution. ---> This is the Espressif Component Version of [v5.6.6-stable](https://github.com/wolfSSL/wolfssl/releases/tag/v5.6.6-stable), Staging Preview (version ^5.6.6-Stable-Update2-ESP32). NOTE: This is a slightly-modified version that includes: - [PR #7077](https://github.com/wolfSSL/wolfssl/pull/7077) wolfSSL_NewThread() type update for Espressif FreeRTOS. [Patch](https://patch-diff.githubusercontent.com/raw/wolfSSL/wolfssl/pull/7081.patch) - [PR #7081](https://github.com/wolfSSL/wolfssl/pull/7081) Add wolfcrypt SHA support for ESP32-C2/ESP8684. [Patch](https://patch-diff.githubusercontent.com/raw/wolfSSL/wolfssl/pull/7081.patch) For questions or beta test of this library, please send a message to support@wolfssl.com For details on how wolfSSL is published to the ESP Component Registry, see the [INSTALL.md](https://github.com/wolfssl/wolfssl/tree/master/IDE/Espressif/component-manager/INSTALL.md) file. See the [wolfSSL Manual](https://www.wolfssl.com/documentation/manuals/wolfssl/index.html). The [wolfSSL embedded TLS library](https://www.wolfssl.com/products/wolfssl/) is a lightweight, portable, C-language-based SSL/TLS library targeted at IoT, embedded, and RTOS environments primarily because of its size, speed, and feature set. It works seamlessly in desktop, enterprise, and cloud environments as well. wolfSSL supports industry standards up to the current [TLS 1.3](https://www.wolfssl.com/tls13) and DTLS 1.3, is up to 20 times smaller than OpenSSL, offers a simple API, an OpenSSL compatibility layer, OCSP and CRL support, is backed by the robust [wolfCrypt cryptography library](https://github.com/wolfssl/wolfssl/tree/master/wolfcrypt), and much more. The CMVP has issued FIPS 140-2 Certificates #3389 and #2425 for the wolfCrypt Module developed by wolfSSL Inc. For more information, see our [FIPS FAQ](https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com. # Getting Started Check out the Examples on the right pane of the [wolfssl component page](https://components.espressif.com/components/wolfssl/wolfssl/). Typically you need only 4 lines to run an example from scratch in the EDP-IDF environment: ```bash . ~/esp/esp-idf/export.sh idf.py create-project-from-example "gojimmypi/mywolfssl^5.6.6-Stable-Update2-ESP32" cd wolfssl_benchmark idf.py -b 115200 flash monitor ``` or for VisualGDB: ```bash . /mnt/c/SysGCC/esp32/esp-idf/v5.1/export.sh idf.py create-project-from-example "gojimmypi/mywolfssl^5.6.6-Stable-Update2-ESP32" cd wolfssl_benchmark idf.py -b 115200 flash monitor ``` ### Espressif Component Notes Here are some ESP Registry-specific details of the wolfssl component. #### Component Name The naming convention of the build-system name of a dependency installed by the component manager is always `namespace__component`. The namespace for wolfSSL is `wolfssl`. The build-system name is thus `wolfssl__wolfssl`. We'll soon be publishing `wolfssl__wolfssh`, `wolfssl__wolfmqtt` and more. A project `cmakelists.txt` doesn't need to mention it at all when using wolfSSL as a managed component. #### Component Manager To check which version of the [Component Manager](https://docs.espressif.com/projects/idf-component-manager/en/latest/getting_started/index.html#checking-the-idf-component-manager-version) is currently available, use the command: ``` python -m idf_component_manager -h ``` The Component Manager should have been installed during the [installation of the ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/#installation). If your version of ESP-IDF doesn't come with the IDF Component Manager, you can [install it](https://docs.espressif.com/projects/idf-component-manager/en/latest/guides/updating_component_manager.html#installing-and-updating-the-idf-component-manager): ``` python -m pip install --upgrade idf-component-manager ``` For further details on the Espressif Component Manager, see the [idf-component-manager repo](https://github.com/espressif/idf-component-manager/). #### Contact Have a specific request or questions? We'd love to hear from you! Please contact us at [support@wolfssl.com](mailto:support@wolfssl.com?subject=Espressif%20Component%20Question) or [open an issue on GitHub](https://github.com/wolfSSL/wolfssl/issues/new/choose). # Licensing and Support wolfSSL (formerly known as CyaSSL) and wolfCrypt are either licensed for use under the GPLv2 (or at your option any later version) or a standard commercial license. For our users who cannot use wolfSSL under GPLv2 (or any later version), a commercial license to wolfSSL and wolfCrypt is available. See the [LICENSE.txt](./LICENSE.txt), visit [wolfssl.com/license](https://www.wolfssl.com/license/), contact us at [licensing@wolfssl.com](mailto:licensing@wolfssl.com?subject=Espressif%20Component%20License%20Question) or call +1 425 245 8247 View Commercial Support Options: [wolfssl.com/products/support-and-maintenance](https://www.wolfssl.com/products/support-and-maintenance/) # wolfSSL Embedded SSL/TLS Library The [wolfSSL embedded SSL library](https://www.wolfssl.com/products/wolfssl/) (formerly CyaSSL) is a lightweight SSL/TLS library written in ANSI C and targeted for embedded, RTOS, and resource-constrained environments - primarily because of its small size, speed, and feature set. It is commonly used in standard operating environments as well because of its royalty-free pricing and excellent cross platform support. wolfSSL supports industry standards up to the current [TLS 1.3](https://www.wolfssl.com/tls13) and DTLS 1.3, is up to 20 times smaller than OpenSSL, and offers progressive ciphers such as ChaCha20, Curve25519, Blake2b and Post-Quantum TLS 1.3 groups. User benchmarking and feedback reports dramatically better performance when using wolfSSL over OpenSSL. wolfSSL is powered by the wolfCrypt cryptography library. Two versions of wolfCrypt have been FIPS 140-2 validated (Certificate #2425 and certificate #3389). FIPS 140-3 validation is in progress. For additional information, visit the [wolfCrypt FIPS FAQ](https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com. ## Why Choose wolfSSL? There are many reasons to choose wolfSSL as your embedded, desktop, mobile, or enterprise SSL/TLS solution. Some of the top reasons include size (typical footprint sizes range from 20-100 kB), support for the newest standards (SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3, DTLS 1.0, DTLS 1.2, and DTLS 1.3), current and progressive cipher support (including stream ciphers), multi-platform, royalty free, and an OpenSSL compatibility API to ease porting into existing applications which have previously used the OpenSSL package. For a complete feature list, see [Chapter 4](https://www.wolfssl.com/docs/wolfssl-manual/ch4/) of the wolfSSL manual. ## Notes, Please Read ### Note 1 wolfSSL as of 3.6.6 no longer enables SSLv3 by default. wolfSSL also no longer supports static key cipher suites with PSK, RSA, or ECDH. This means if you plan to use TLS cipher suites you must enable DH (DH is on by default), or enable ECC (ECC is on by default), or you must enable static key cipher suites with one or more of the following defines: ``` WOLFSSL_STATIC_DH WOLFSSL_STATIC_RSA WOLFSSL_STATIC_PSK ``` Though static key cipher suites are deprecated and will be removed from future versions of TLS. They also lower your security by removing PFS. When compiling `ssl.c`, wolfSSL will now issue a compiler error if no cipher suites are available. You can remove this error by defining `WOLFSSL_ALLOW_NO_SUITES` in the event that you desire that, i.e., you're not using TLS cipher suites. ### Note 2 wolfSSL takes a different approach to certificate verification than OpenSSL does. The default policy for the client is to verify the server, this means that if you don't load CAs to verify the server you'll get a connect error, no signer error to confirm failure (-188). If you want to mimic OpenSSL behavior of having `SSL_connect` succeed even if verifying the server fails and reducing security you can do this by calling: ```c wolfSSL_CTX_set_verify(ctx, WOLFSSL_VERIFY_NONE, NULL); ``` before calling `wolfSSL_new();`. Though it's not recommended. ### Note 3 The enum values SHA, SHA256, SHA384, SHA512 are no longer available when wolfSSL is built with `--enable-opensslextra` (`OPENSSL_EXTRA`) or with the macro `NO_OLD_SHA_NAMES`. These names get mapped to the OpenSSL API for a single call hash function. Instead the name `WC_SHA`, `WC_SHA256`, `WC_SHA384` and `WC_SHA512` should be used for the enum name. # wolfSSL Release 5.6.6 (Dec 19, 2023) Release 5.6.6 has been developed according to wolfSSL's development and QA process (see link below) and successfully passed the quality criteria. https://www.wolfssl.com/about/wolfssl-software-development-process-quality-assurance NOTE: * --enable-heapmath is being deprecated and will be removed by 2024 REMINDER: When working with AES Block Cipher algorithms, `wc_AesInit()` should always be called first to initialize the `Aes` structure, before calling other Aes API functions. Recently we found several places in our documentation, comments, and codebase where this pattern was not observed. We have since fixed this omission in several PRs for this release. ## Vulnerabilities * [Medium] CVE-2023-6935: After review of the previous RSA timing fix in wolfSSL 5.6.4, additional changes were found to be required. A complete resistant change is delivered in this release. This fix is for the Marvin attack, leading to being able to decrypt a saved TLS connection and potentially forge a signature after probing with a very large number of trial connections. This issue is around RSA decryption and affects the optional static RSA cipher suites on the server side, which are considered weak, not recommended to be used and are off by default in wolfSSL (even with `--enable-all`). Static RSA cipher suites were also removed from the TLS 1.3 protocol and are only present in TLS 1.2 and lower. All padding versions of RSA decrypt are affected since the code under review is outside of the padding processing. Information about the private keys is NOT compromised in affected code. It is recommended to disable static RSA cipher suites and update the version of wolfSSL used if using RSA private decryption alone outside of TLS. Thanks to Hubert Kario for the report. The fix for this issue is located in the following GitHub Pull Request: https://github.com/wolfSSL/wolfssl/pull/6955. * [Low] CVE-2023-6936: A potential heap overflow read is possible in servers connecting over TLS 1.3 when the optional `WOLFSSL_CALLBACKS` has been defined. The out of bounds read can occur when a server receives a malicious malformed ClientHello. Users should either discontinue use of `WOLFSSL_CALLBACKS` on the server side or update versions of wolfSSL to 5.6.6. Thanks to the tlspuffin fuzzer team for the report which was designed and developed by; Lucca Hirschi (Inria, LORIA), Steve Kremer (Inria, LORIA), and Max Ammann (Trail of Bits). The fix for this issue is located in the following GitHub Pull Request: https://github.com/wolfSSL/wolfssl/pull/6949. * [Low] A side channel vulnerability with AES T-Tables is possible in a very controlled environment where precision sub-cache-line inspection can happen, such as inside an Intel SGX enclave. This can lead to recovery of the AES key. To prevent this type of attack, wolfSSL added an AES bitsliced implementation which can be enabled with the “`--enable-aes-bitsliced`” configure option. Thanks to Florian Sieck, Zhiyuan Zhang, Sebastian Berndt, Chitchanok Chuengsatiansup, Thomas Eisenbarth, and Yuval Yarom for the report (Universities of Lübeck, Melbourne, Adelaide and Bochum). The fix for this issue is located in the following GitHub Pull Request: https://github.com/wolfSSL/wolfssl/pull/6854. * [Low] CVE-2023-6937: wolfSSL prior to 5.6.6 did not check that messages in a single (D)TLS record do not span key boundaries. As a result, it was possible to combine (D)TLS messages using different keys into one (D)TLS record. The most extreme edge case is that, in (D)TLS 1.3, it was possible that an unencrypted (D)TLS 1.3 record from the server containing first a ServerHello message and then the rest of the first server flight would be accepted by a wolfSSL client. In (D)TLS 1.3 the handshake is encrypted after the ServerHello but a wolfSSL client would accept an unencrypted flight from the server. This does not compromise key negotiation and authentication so it is assigned a low severity rating. Thanks to Johannes Wilson for the report (Sectra Communications and Linköping University). The fix for this issue is located in the following GitHub Pull Request: https://github.com/wolfSSL/wolfssl/pull/7029. ## New Feature Additions * Build option for disabling CRL date checks (`WOLFSSL_NO_CRL_DATE_CHECK`) (PR 6927) * Support for STM32WL55 and improvements to PKA ECC support (PR 6937) * Add option to skip cookie exchange on DTLS 1.3 session resumption (PR 6929) * Add implementation of SRTP KDF and SRTCP KDF (`--enable-srtp-kdf`) (PR 6888) * Add `wolfSSL_EXTENDED_KEY_USAGE_free()` (PR 6916) * Add AES bitsliced implementation that is cache attack safe (`--enable-aes-bitsliced`) (PR 6854) * Add memcached support and automated testing (PR 6430, 7022) * Add Hardware Encryption Acceleration for ESP32-C3, ESP32-C6, and ESP32-S2 (PR 6990) * Add (D)TLS 1.3 support for 0.5-RTT data (PR 7010) ## Enhancements and Optimizations * Better built in testing of “`--sys-ca-certs`” configure option (PR 6910) * Updated CMakeLists.txt for Espressif wolfSSL component usage (PR 6877) * Disable TLS 1.1 by default (unless SSL 3.0 or TLS 1.0 is enabled) (PR 6946) * Add “`--enable-quic`” to “`--enable-all`” configure option (PR 6957) * Add support to SP C implementation for RSA exponent up to 64-bits (PR 6959) * Add result of “`HAVE___UINT128_T`” to options.h for CMake builds (PR 6965) * Add optimized assembly for AES-GCM on ARM64 using hardware crypto instructions (PR 6967) * Add built-in cipher suite tests for DTLS 1.3 PQC (PR 6952) * Add wolfCrypt test and unit test to ctest (PR 6977) * Move OpenSSL compatibility crypto APIs into `ssl_crypto.c` file (PR 6935) * Validate time generated from XGMTIME() (PR 6958) * Allow wolfCrypt benchmark to run with microsecond accuracy (PR 6868) * Add GitHub Actions testing with nginx 1.24.0 (PR 6982) * Allow encoding of CA:FALSE BasicConstraint during cert generation (PR 6953) * Add CMake option to enable DTLS-SRTP (PR 6991) * Add CMake options for enabling QUIC and cURL (PR 7049) * Improve RSA blinding to make code more constant time (PR 6955) * Refactor AES-NI implementation macros to allow dynamic fallback to C (PR 6981) * Default to native Windows threading API on MinGW (PR 7015) * Return better error codes from OCSP response check (PR 7028) * Updated Espressif ESP32 TLS client and server examples (PR 6844) * Add/clean up support for ESP-IDF v5.1 for a variety of ESP32 chips (PR 7035, 7037) * Add API to choose dynamic certs based on client ciphers/sigalgs (PR 6963) * Improve Arduino IDE 1.5 project file to match recursive style (PR 7007) * Simplify and improve apple-universal build script (PR 7025) ## Fixes * Fix for async edge case with Intel QuickAssist/Cavium Nitrox (PR 6931) * Fix for building PKCS#7 with RSA disabled (PR 6902) * Fix for advancing output pointer in `wolfSSL_i2d_X509()` (PR 6891) * Fix for `EVP_EncodeBlock()` appending a newline (PR 6900) * Fix for `wolfSSL_RSA_verify_PKCS1_PSS()` with `RSA_PSS_SALTLEN_AUTO` (PR 6938) * Fixes for CODESonar reports around `isalpha()` and `isalnum()` calls (PR 6810) * Fix for SP ARM64 integer math to avoid compiler optimization issues (PR 6942) * Fix for SP Thumb2 inline assembly to add IAR build support (PR 6943, 6971) * Fix for SP Thumb2 to make functions not inlined (PR 6993) * Fix for SP Cortex-M assembly large build with IAR (PR 6954) * Fix for SP ARM64 assembly montgomery reduction by 4 (PR 6947) * Fix for SP ARM64 P-256 for not inlining functions for iOS compatibility (PR 6979) * Fix for `WOLFSSL_CALLBACKS` and potential memory error (PR 6949) * Fixes for wolfSSL’s Zephyr OS port (PR 6930) * Fix for build errors when building for NXP mmCAU (`FREESCALE_MMCAU`) (PR 6970) * Fix for TLS 1.3 `SendBuffered()` return code in non-blocking mode (PR 7001) * Fix for TLS `Hmac_UpdateFinal()` when padding byte is invalid (PR 6998) * Fix for ARMv8 AES-GCM streaming to check size of IV before storing (PR 6996) * Add missing calls to `wc_AesInit()` before `wc_AesSetKey()` (PR 7011) * Fix build errors with DTLS 1.3 enabled but TLS 1.2 disabled (PR 6976) * Fixes for building wolfSSL in Visual Studio (PR 7040) For additional vulnerability information visit the vulnerability page at: https://www.wolfssl.com/docs/security-vulnerabilities/ See INSTALL file for build instructions. More info can be found on-line at: https://wolfssl.com/wolfSSL/Docs.html # Resources [wolfSSL Website](https://www.wolfssl.com/) [wolfSSL Wiki](https://github.com/wolfSSL/wolfssl/wiki) [FIPS 140-2/140-3 FAQ](https://wolfssl.com/license/fips) [wolfSSL Documentation](https://wolfssl.com/wolfSSL/Docs.html) [wolfSSL Manual](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-toc.html) [wolfSSL API Reference](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-17-wolfssl-api-reference.html) [wolfCrypt API Reference](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-18-wolfcrypt-api-reference.html) [TLS 1.3](https://www.wolfssl.com/docs/tls13/) [wolfSSL Vulnerabilities](https://www.wolfssl.com/docs/security-vulnerabilities/) [Additional wolfSSL Examples](https://github.com/wolfssl/wolfssl-examples)
# wolfSSL Template Project This is an example of a minimally viable wolfSSL template to get started with your own project. For general information on [wolfSSL examples for Espressif](../README.md), see the [README](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/ESP-IDF/README.md) file. ### Prerequisites It is assumed the [ESP-IDF environment](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/) has been installed. ### Files Included - [main.c](./main/main.c) with a simple call to an Espressif library (`ESP_LOGI`) and a call to a wolfSSL library (`esp_ShowExtendedSystemInfo`) . - See [components/wolfssl/include](./components/wolfssl/include/user_settings.h) directory to edit the wolfSSL `user_settings.h`. - Edit [main/CMakeLists.txt](./main/CMakeLists.txt) to add/remove source files. - The [components/wolfssl/CMakeLists.txt](./components/wolfssl/CMakeLists.txt) typically does not need to be changed. - Optional [VisualGDB Project](./VisualGDB/wolfssl_template_IDF_v5.1_ESP32.vgdbproj) for Visual Studio using ESP32 and ESP-IDF v5.1. - Edit the project [CMakeLists.txt](./CMakeLists.txt) to optionally point this project's wolfSSL component source code at a different directory: ``` set(WOLFSSL_ROOT "~/workspace/wolfssl-other-source") ``` ## Getting Started: Here's an example using the command-line [idf.py](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-py.html). Edit your `WRK_IDF_PATH`to point to your ESP-IDF install directory. ``` WRK_IDF_PATH=/mnt/c/SysGCC/esp32/esp-idf/v5.1 echo "Run export.sh from ${WRK_IDF_PATH}" . ${WRK_IDF_PATH}/export.sh # build the example: idf.py build # optionally erase the flash idf.py erase-flash -p /dev/ttyS19 -b 115200 # flash the code onto the serial device at /dev/ttyS19 idf.py flash -p /dev/ttyS19 -b 115200 # build, flash, and view UART output with one command: idf.py flash -p /dev/ttyS19 -b 115200 monitor ``` Press `Ctrl+]` to exit `idf.py monitor`. See [additional monitor keyboard commands](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html). ## Other Examples: For examples, see: - [TLS Client](../wolfssl_client/README.md) - [TLS Server](../wolfssl_server/README.md) - [Benchmark](../wolfssl_benchmark/README.md) - [Test](../wolfssl_test/README.md) - [wolfssl-examples](https://github.com/wolfSSL/wolfssl-examples/tree/master/ESP32) - [wolfssh-examples](https://github.com/wolfSSL/wolfssh-examples/tree/main/Espressif) See the README.md file in the upper level 'examples' directory for [more information about examples](../README.md).
# wolfSSL Benchmark Example This ESP32 example uses the [wolfSSL wolfcrypt Benchmark Application](https://github.com/wolfSSL/wolfssl/tree/master/wolfcrypt/benchmark). For general information on [wolfSSL examples for Espressif](../README.md), see the [README](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/ESP-IDF/README.md) file. ## Espressif ESP Component Registry See the wolfSSL namespace at [components.espressif.com](https://components.espressif.com/components?q=wolfssl) ## Windows COM Port All of these examples use COM20 on Windows. The DOS `change port` command can be use to assign any other local port to `COM20` as needed: ``` change port com20=com23 ``` ## VisualGDB Open the VisualGDB Visual Studio Project file in the VisualGDB directory and click the "Start" button. No wolfSSL setup is needed. You may need to adjust your specific COM port. The default is `COM20`. Include in the respective project `./VisualGDB` directory are [VisualGDB](https://visualgdb.com/) project files. Individual project files are included for convenience to new users, as there are [difficulties switching between ESP-IDF Versions or Chipsets](https://sysprogs.com/w/forums/topic/difficulties-switching-espressif-esp-idf-version-or-chipset/) using the VisualGDB extension. The naming convention for project files is: `[project name]_IDF_[Version]_[chipset].vgdbproj`. The solution files (filename[.sln]) often will contain shortcuts to commonly used source and configuration files used by the respective project. -------- |------------- |------------- | ChipSet | ESP-IDF v4.4 | ESP-IDF v5.1 | -------- |------------- |------------- | ESP32 | x | | ESP32-S2 | | | ESP32-S3 | x | x | ESP32-C3 | x | x | ESP32-C6 | | | The default directories are: - `C:\SysGCC` - The root directory install of VisualGDB - `C:\SysGCC\esp32` - The default for ESP-IDF v5.x - `C:\SysGCC\esp32-8.4` - Many need to manually select this name for ESP-IDF v4.x install - `C:\SysGCC\esp8266`- The default for ESP8266 Windows ports assigned with the `change port` command may not appear in the VisualGDB dropdowns but can still be used when manually typed. See the [feature request](https://sysprogs.com/w/forums/topic/feature-request-show-windows-change-port-results-in-com-port-dropdown-lists/). ## ESP-IDF Commandline 1. `idf.py menuconfig` to configure the program. 1-1. Example Configuration -> BENCH_ARG : argument that you want to use. Default is "-lng 0" The list of argument can be find in help. When you want to run the benchmark program 1. `idf.py -p <PORT> flash` to compile and load the firmware 2. `idf.py monitor` to see the message See the README.md file in the upper level 'examples' directory for more information about examples. ## Performance Reminder than when building on WSL in `/mnt/c` there will be a noticeable performance degradation at compile time. Using `~/` will be faster at the cost of shared filesystems. Example build on WSL: ``` Optionally update toolchain cd /mnt/c/SysGCC/esp32/esp-idf/master git fetch git pull git submodule update --init --recursive cd /mnt/c/workspace/wolfssl/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark # Pick ESP-IDF install directory, this one for v5.1 in VisualGDB WRK_IDF_PATH=/mnt/c/SysGCC/esp32/esp-idf/v5.1 WRK_IDF_PATH=/mnt/c/SysGCC/esp32-8.4/esp-idf/v4.4.1 WRK_IDF_PATH=~/esp/esp-idf . $WRK_IDF_PATH/export.sh # Set target SoC idf.py set-target esp32c3 # Optionally erase # Build and flash idf.py build flash -p /dev/ttyS20 -b 115200 monitor ``` ## Example Output Note the default wolfSSL `user_settings.h` is configured by default to be the most compatible across the widest ranges of targets. Contact wolfSSL at support@wolfssl.com for help in optimizing for your particular application, or see the [docs](https://www.wolfssl.com/documentation/manuals/wolfssl/index.html). Compiled and flashed with `idf.py build flash -p /dev/ttyS7 -b 115200 monitor`: ``` --- idf_monitor on /dev/ttyS7 115200 --- --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H --- (377) cpu_start: Starting scheduler ets Jun 8 2016 00:22:57 rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT) configsip: 0, SPIWP:0xee clk_drv:0x00,q_drv:0x00,d_drv:0x00,cs0_drv:0x00,hd_drv:0x00,wp_drv:0x00 mode:DIO, clock div:2 load:0x3fff0030,len:6664 load:0x40078000,len:14848 load:0x40080400,len:3792 0x40080400: _init at ??:? entry 0x40080694 I (27) boot: ESP-IDF v4.4.2-dirty 2nd stage bootloader I (27) boot: compile time 13:41:41 I (27) boot: chip revision: 1 I (30) boot_comm: chip revision: 1, min. bootloader chip revision: 0 I (37) boot.esp32: SPI Speed : 40MHz I (42) boot.esp32: SPI Mode : DIO I (46) boot.esp32: SPI Flash Size : 2MB I (51) boot: Enabling RNG early entropy source... I (56) boot: Partition Table: I (60) boot: ## Label Usage Type ST Offset Length I (67) boot: 0 nvs WiFi data 01 02 00009000 00006000 I (75) boot: 1 phy_init RF data 01 01 0000f000 00001000 I (82) boot: 2 factory factory app 00 00 00010000 00100000 I (90) boot: End of partition table I (94) boot_comm: chip revision: 1, min. application chip revision: 0 I (101) esp_image: segment 0: paddr=00010020 vaddr=3f400020 size=12bf4h ( 76788) map I (137) esp_image: segment 1: paddr=00022c1c vaddr=3ffb0000 size=02420h ( 9248) load I (141) esp_image: segment 2: paddr=00025044 vaddr=40080000 size=0afd4h ( 45012) load I (161) esp_image: segment 3: paddr=00030020 vaddr=400d0020 size=33148h (209224) map I (237) esp_image: segment 4: paddr=00063170 vaddr=4008afd4 size=00550h ( 1360) load I (238) esp_image: segment 5: paddr=000636c8 vaddr=50000000 size=00010h ( 16) load I (249) boot: Loaded app from partition at offset 0x10000 I (249) boot: Disabling RNG early entropy source... I (266) cpu_start: Pro cpu up. I (266) cpu_start: Starting app cpu, entry point is 0x40081098 0x40081098: call_start_cpu1 at /mnt/c/SysGCC/esp32/esp-idf/v4.4.2/components/esp_system/port/cpu_start.c:160 I (0) cpu_start: App cpu up. I (280) cpu_start: Pro cpu start user code I (280) cpu_start: cpu freq: 240000000 I (280) cpu_start: Application information: I (285) cpu_start: Project name: wolfssl_benchmark I (291) cpu_start: App version: v5.5.3-stable-108-gbd7b442df-di I (298) cpu_start: Compile time: Nov 17 2022 14:10:03 I (304) cpu_start: ELF file SHA256: fbb520f5bbf963a0... I (310) cpu_start: ESP-IDF: v4.4.2-dirty I (316) heap_init: Initializing. RAM available for dynamic allocation: I (323) heap_init: At 3FFAE6E0 len 00001920 (6 KiB): DRAM I (329) heap_init: At 3FFB3DE8 len 0002C218 (176 KiB): DRAM I (335) heap_init: At 3FFE0440 len 00003AE0 (14 KiB): D/IRAM I (341) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM I (348) heap_init: At 4008B524 len 00014ADC (82 KiB): IRAM I (355) spi_flash: detected chip: generic I (359) spi_flash: flash io: dio W (362) spi_flash: Detected size(4096k) larger than the size in the binary image header(2048k). Using the size in the binary image header. I (377) cpu_start: Starting scheduler on PRO CPU. I (0) cpu_start: Starting scheduler on APP CPU. I (391) wolfssl_benchmark: app_main CONFIG_BENCH_ARGV = -lng 0 I (397) wolfssl_benchmark: construct_argv arg:-lng 0 ------------------------------------------------------------------------------ wolfSSL version 5.5.3 ------------------------------------------------------------------------------ wolfCrypt Benchmark (block bytes 1024, min 1.0 sec each) RNG 1 MiB took 1.017 seconds, 1.320 MiB/s AES-128-CBC-enc 6 MiB took 1.002 seconds, 5.726 MiB/s AES-128-CBC-dec 5 MiB took 1.000 seconds, 5.347 MiB/s AES-192-CBC-enc 6 MiB took 1.004 seconds, 5.714 MiB/s AES-192-CBC-dec 5 MiB took 1.001 seconds, 5.341 MiB/s AES-256-CBC-enc 6 MiB took 1.000 seconds, 5.713 MiB/s AES-256-CBC-dec 5 MiB took 1.002 seconds, 5.336 MiB/s AES-128-GCM-enc 300 KiB took 1.004 seconds, 298.805 KiB/s AES-128-GCM-dec 300 KiB took 1.004 seconds, 298.805 KiB/s AES-192-GCM-enc 300 KiB took 1.007 seconds, 297.915 KiB/s AES-192-GCM-dec 300 KiB took 1.008 seconds, 297.619 KiB/s AES-256-GCM-enc 300 KiB took 1.011 seconds, 296.736 KiB/s AES-256-GCM-dec 300 KiB took 1.011 seconds, 296.736 KiB/s GMAC Default 403 KiB took 1.002 seconds, 402.196 KiB/s 3DES 450 KiB took 1.028 seconds, 437.743 KiB/s MD5 14 MiB took 1.001 seconds, 13.756 MiB/s SHA 14 MiB took 1.001 seconds, 14.463 MiB/s SHA-256 14 MiB took 1.000 seconds, 14.233 MiB/s SHA-512 17 MiB took 1.000 seconds, 16.626 MiB/s HMAC-MD5 14 MiB took 1.000 seconds, 13.599 MiB/s HMAC-SHA 14 MiB took 1.000 seconds, 13.989 MiB/s HMAC-SHA256 14 MiB took 1.000 seconds, 13.940 MiB/s HMAC-SHA512 16 MiB took 1.000 seconds, 16.064 MiB/s PBKDF2 640 bytes took 1.009 seconds, 634.291 bytes/s RSA 2048 public 52 ops took 1.022 sec, avg 19.654 ms, 50.881 ops/sec RSA 2048 private 4 ops took 1.056 sec, avg 264.000 ms, 3.788 ops/sec ECC [ SECP256R1] 256 key gen 4 ops took 1.216 sec, avg 304.000 ms, 3.289 ops/sec ECDHE [ SECP256R1] 256 agree 4 ops took 1.215 sec, avg 303.750 ms, 3.292 ops/sec ECDSA [ SECP256R1] 256 sign 4 ops took 1.226 sec, avg 306.500 ms, 3.263 ops/sec ECDSA [ SECP256R1] 256 verify 2 ops took 1.172 sec, avg 586.000 ms, 1.706 ops/sec CURVE 25519 key gen 3 ops took 1.279 sec, avg 426.333 ms, 2.346 ops/sec CURVE 25519 agree 4 ops took 1.701 sec, avg 425.250 ms, 2.352 ops/sec ED 25519 key gen 46 ops took 1.008 sec, avg 21.913 ms, 45.635 ops/sec ED 25519 sign 42 ops took 1.038 sec, avg 24.714 ms, 40.462 ops/sec ED 25519 verify 26 ops took 1.009 sec, avg 38.808 ms, 25.768 ops/sec Benchmark complete ``` ## Known Issues and Common Issues ### Permission denied Delete project directory `build`, `.visualgdb` and `.vs` directories. Ensure no other build process is using the same files in Windows, WSL, Visual Studio, VSCode, etc. Example message: ``` -- Building ESP-IDF components for target esp32 CMake Error at /mnt/c/SysGCC/esp32/esp-idf/v4.4.2/tools/cmake/component.cmake:131 (file): file failed to open for writing (Permission denied): /mnt/c/workspace-pr/wolfssl/IDE/Espressif/ESP-IDF/examples/wolfssl_test/build/bootloader/component_properties.temp.cmake ``` ### user_settings.h: No such file or directory Ensure wolfSSL is installed in the ESP-IDF or local project `components` directory. Example message: ``` esp-idf/main/CMakeFiles/__idf_main.dir/main.c.obj -c ../main/main.c ../main/main.c:27:10: fatal error: user_settings.h: No such file or directory #include <user_settings.h> ^~~~~~~~~~~~~~~~~ compilation terminated. ``` A 'clean` may be needed after freshly installing a new component: ``` idf.py clean build flash -p /dev/ttyS7 -b 115200 monitor ``` See the README.md file in the upper level 'examples' directory for [more information about examples](../README.md).
# wolfSSL TLS Client Example This is the wolfSSL TLS Client demo, typically used with the [Espressif TLS Server](../wolfssl_server/README.md) or the CLI [Server](https://github.com/wolfSSL/wolfssl/tree/master/examples/server). When using the CLI, see the [example parameters](/IDE/Espressif/ESP-IDF/examples#interaction-with-wolfssl-cli). For general information on [wolfSSL examples for Espressif](../README.md), see the [README](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/ESP-IDF/README.md) file. ## VisualGDB Open the VisualGDB Visual Studio Project file in the VisualGDB directory and click the "Start" button. No wolfSSL setup is needed. You may need to adjust your specific COM port. The default is `COM20`. ## ESP-IDF Commandline 1. `idf.py menuconfig` to config the project 1-1. Example Configuration -> Target host ip address : the host that you want to connect to.(default is 127.0.0.1) 1-2. Example Connection Configuration -> WIFI SSID: your own WIFI, which is connected to the Internet.(default is "myssid") WIFI Password: WIFI password, and default is "mypassword" Note: the example program uses 11111 port. If you want to use different port , you need to modify DEFAULT_PORT definition in the code. When you want to test the wolfSSL client 1. `idf.py -p <PORT> flash` and then `idf.py monitor` to load the firmware and see the context 2. You can use <wolfssl>/examples/server/server program for test. e.g. Launch ./examples/server/server -v 4 -b -i -d ## SM Ciphers #### Working Linux Client to ESP32 Server Command: ``` cd /mnt/c/workspace/wolfssl-$USER/IDE/Espressif/ESP-IDF/examples/wolfssl_server . /mnt/c/SysGCC/esp32/esp-idf/v5.1/export.sh idf.py flash -p /dev/ttyS19 -b 115200 monitor ``` ``` cd /mnt/c/workspace/wolfssl-$USER ./examples/client/client -h 192.168.1.108 -v 4 -l TLS_SM4_GCM_SM3 -c ./certs/sm2/client-sm2.pem -k ./certs/sm2/client-sm2-priv.pem -A ./certs/sm2/root-sm2.pem -C ``` Output: ```text SSL version is TLSv1.3 SSL cipher suite is TLS_SM4_GCM_SM3 SSL curve name is SM2P256V1 I hear you fa shizzle! ``` #### Linux client to Linux server: ``` ./examples/client/client -h 127.0.0.1 -v 4 -l ECDHE-ECDSA-SM4-CBC-SM3 -c ./certs/sm2/client-sm2.pem -k ./certs/sm2/client-sm2-priv.pem -A ./certs/sm2/root-sm2.pem -C ./examples/server/server -v 3 -l ECDHE-ECDSA-SM4-CBC-SM3 -c ./certs/sm2/server-sm2.pem -k ./certs/sm2/server-sm2-priv.pem -A ./certs/sm2/client-sm2.pem -V ``` See the README.md file in the upper level 'examples' directory for [more information about examples](../README.md).
# wolfSSL TLS Server Example This is the wolfSSL TLS Server demo, typically used with the [Espressif TLS Client](../wolfssl_client/README.md) or the CLI [Client](https://github.com/wolfSSL/wolfssl/tree/master/examples/client). When using the CLI, see the [example parameters](/IDE/Espressif/ESP-IDF/examples#interaction-with-wolfssl-cli). For general information on [wolfSSL examples for Espressif](../README.md), see the [README](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/ESP-IDF/README.md) file. ## VisualGDB Open the VisualGDB Visual Studio Project file in the VisualGDB directory and click the "Start" button. No wolfSSL setup is needed. You may need to adjust your specific COM port. The default is `COM20`. ## ESP-IDF Commandline The Example contains a wolfSSL simple server. 1. `idf.py menuconfig` to configure the project 1-1. Example Connection Configuration -> WIFI SSID : your own WIFI, which is connected to the Internet.(default is "myssid") WIFI Password : WIFI password, and default is "mypassword" When you want to test the wolfSSL simple server demo 1. `idf.py -p <PORT> flash` to compile the code and load the firmware 2. `idf.py monitor` to see the context. The assigned IP address can be found in output message. 3. Once the server connects to the wifi, it is waiting for client request. ("Waiting for a connection..." message will be displayed.) 4. You can use <wolfssl>/examples/client to test the server e.g ./example/client/client -h xx.xx.xx See the README.md file in the upper level 'examples' directory for more information about examples. ``` # . /mnt/c/SysGCC/esp32/esp-idf/master/export.sh . /mnt/c/SysGCC/esp32/esp-idf/v5.1/export.sh cd /mnt/c/workspace/wolfssl-$USER/IDE/Espressif/ESP-IDF/examples/wolfssl_server # optionally erase idf.py erase-flash -p /dev/ttyS19 -b 115200 # Program flash idf.py flash -p /dev/ttyS19 -b 115200 monitor ``` Linux Client to x108 SM server ``` cd /mnt/c/workspace/wolfssl-$USER # show the ciphers ./examples/client/client -e ./examples/client/client -h 192.168.1.108 -v 4 -l TLS_SM4_GCM_SM3 -c ./certs/sm2/client-sm2.pem -k ./certs/sm2/client-sm2-priv.pem -A ./certs/sm2/root-sm2.pem -C ``` Linux Server ``` ./examples/server/server -v 4 -l TLS13-SM4-CCM-SM3 -c ./certs/sm2/server-sm2.pem -k ./certs/sm2/server-sm2-priv.pem -A ./certs/sm2/client-sm2.pem -V ``` Cipers to consider ``` TLS13-AES128-GCM-SHA256: TLS13-AES256-GCM-SHA384: TLS13-CHACHA20-POLY1305-SHA256: TLS13-SM4-GCM-SM3: TLS13-SM4-CCM-SM3: ECDHE-ECDSA-SM4-CBC-SM3: ECDHE-ECDSA-SM4-GCM-SM3: ECDHE-ECDSA-SM4-CCM-SM3 DHE-RSA-AES128-SHA: DHE-RSA-AES256-SHA: ECDHE-RSA-AES128-SHA: ECDHE-RSA-AES256-SHA: ECDHE-ECDSA-AES128-SHA: ECDHE-ECDSA-AES256-SHA: DHE-RSA-AES128-SHA256: DHE-RSA-AES256-SHA256: DHE-RSA-AES128-GCM-SHA256: DHE-RSA-AES256-GCM-SHA384: ECDHE-RSA-AES128-GCM-SHA256: ECDHE-RSA-AES256-GCM-SHA384: ECDHE-ECDSA-AES128-GCM-SHA256: ECDHE-ECDSA-AES256-GCM-SHA384: ECDHE-RSA-AES128-SHA256: ECDHE-ECDSA-AES128-SHA256: ECDHE-RSA-AES256-SHA384: ECDHE-ECDSA-AES256-SHA384: ECDHE-RSA-CHACHA20-POLY1305: ECDHE-ECDSA-CHACHA20-POLY1305: DHE-RSA-CHACHA20-POLY1305: ECDHE-RSA-CHACHA20-POLY1305-OLD: ECDHE-ECDSA-CHACHA20-POLY1305-OLD: DHE-RSA-CHACHA20-POLY1305-OLD: ``` See the README.md file in the upper level 'examples' directory for [more information about examples](../README.md).
# wolfSSL Crypt Test Example This is the ESP32 Version of the [wolfSSL wolfcrypt test application](https://github.com/wolfSSL/wolfssl/tree/master/wolfcrypt/test). For general information on [wolfSSL examples for Espressif](../README.md), see the [README](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/ESP-IDF/README.md) file. ## ESP Registry The easiest way to get started with wolfSSL is by using the [ESP Registry](https://components.espressif.com/components/wolfssl/wolfssl/) examples. ``` . ~/esp/esp-idf/export.sh idf.py create-project-from-example "wolfssl/wolfssl^5.6.0-stable:wolfssl_test" cd wolfssl_benchmark idf.py -b 115200 flash monitor ``` ## VisualGDB Open the VisualGDB Visual Studio Project file in the [VisualGDB directory](./VisualGDB/README.md) and click the "Start" button. No wolfSSL setup is needed. You may need to adjust your specific COM port. The default is `COM20`. ## ESP-IDF Commandline 1. `idf.py menuconfig` to configure the program. 1-1. Example Configuration -> TEST_ARG : argument that you want to use. Default is "-lng 0" The list of argument can be find in help. When you want to run the test program 1. `idf.py -p <PORT> flash` to compile and load the firmware 2. `idf.py monitor` to see the message See the README.md file in the upper level 'examples' directory for more information about examples. Reminder than when building on WSL in `/mnt/c` there will be a noticeable performance degradation at compile time. Using `~/` will be faster at the cost of shared filesystems. Example build on WSL, assuming `git clone` from `c:\workspace`: ``` WRK_IDF_PATH=/mnt/c/SysGCC/esp32/esp-idf/v5.1 echo "Run export.sh from ${WRK_IDF_PATH}" . ${WRK_IDF_PATH}/export.sh # switch to test example cd /mnt/c/workspace/wolfssl/IDE/Espressif/ESP-IDF/examples/wolfssl_test # Pick ESP-IDF install directory, this one for v5.1 in VisualGDB . /mnt/c/SysGCC/esp32/esp-idf/v5.1/export.sh # set target chipset idf.py set-target esp32s3 # erase idf.py erase-flash -p /dev/ttyS24 -b 115200 # start with a low upload speed, then increase as found operational idf.py # build and flash, in this example to COM24 idf.py build flash -p /dev/ttyS24 -b 115200 monitor ``` ## Example Output Note the default wolfSSL `user_settings.h` is configured by default to be the most compatible across the widest ranges of targets. Contact wolfSSL at support@wolfssl.com for help in optimizing for your particular application, or see the [docs](https://www.wolfssl.com/documentation/manuals/wolfssl/index.html). Compiled and flashed with `idf.py build flash -p /dev/ttyS7 -b 115200 monitor`: ``` ets Jun 8 2016 00:22:57 rst:0x3 (SW_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT) configsip: 0, SPIWP:0xee clk_drv:0x00,q_drv:0x00,d_drv:0x00,cs0_drv:0x00,hd_drv:0x00,wp_drv:0x00 mode:DIO, clock div:2 load:0x3fff0030,len:6612 load:0x40078000,len:14788 load:0x40080400,len:3792 entry 0x40080694 I (26) boot: ESP-IDF v4.4.1-dirty 2nd stage bootloader I (26) boot: compile time 15:25:38 I (26) boot: chip revision: 1 I (29) boot_comm: chip revision: 1, min. bootloader chip revision: 0 I (37) boot.esp32: SPI Speed : 40MHz I (41) boot.esp32: SPI Mode : DIO I (46) boot.esp32: SPI Flash Size : 2MB I (50) boot: Enabling RNG early entropy source... I (56) boot: Partition Table: I (59) boot: ## Label Usage Type ST Offset Length I (67) boot: 0 nvs WiFi data 01 02 00009000 00006000 I (74) boot: 1 phy_init RF data 01 01 0000f000 00001000 I (81) boot: 2 factory factory app 00 00 00010000 00100000 I (89) boot: End of partition table I (93) boot_comm: chip revision: 1, min. application chip revision: 0 I (100) esp_image: segment 0: paddr=00010020 vaddr=3f400020 size=16ca4h ( 93348) map I (143) esp_image: segment 1: paddr=00026ccc vaddr=3ffb0000 size=024d4h ( 9428) load I (147) esp_image: segment 2: paddr=000291a8 vaddr=40080000 size=06e70h ( 28272) load I (160) esp_image: segment 3: paddr=00030020 vaddr=400d0020 size=412d8h (266968) map I (257) esp_image: segment 4: paddr=00071300 vaddr=40086e70 size=045a8h ( 17832) load I (265) esp_image: segment 5: paddr=000758b0 vaddr=50000000 size=00010h ( 16) load I (270) boot: Loaded app from partition at offset 0x10000 I (270) boot: Disabling RNG early entropy source... I (285) cpu_start: Pro cpu up. I (286) cpu_start: Starting app cpu, entry point is 0x40081088 I (273) cpu_start: App cpu up. I (300) cpu_start: Pro cpu start user code I (300) cpu_start: cpu freq: 160000000 I (300) cpu_start: Application information: I (305) cpu_start: Project name: wolfssl_test I (310) cpu_start: App version: v5.5.3-stable-108-gbd7b442df-di I (317) cpu_start: Compile time: Nov 17 2022 15:24:40 I (323) cpu_start: ELF file SHA256: 90957eeb4f0d2246... I (329) cpu_start: ESP-IDF: v4.4.1-dirty I (335) heap_init: Initializing. RAM available for dynamic allocation: I (342) heap_init: At 3FFAE6E0 len 00001920 (6 KiB): DRAM I (348) heap_init: At 3FFB2DF0 len 0002D210 (180 KiB): DRAM I (354) heap_init: At 3FFE0440 len 00003AE0 (14 KiB): D/IRAM I (360) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM I (367) heap_init: At 4008B418 len 00014BE8 (82 KiB): IRAM I (374) spi_flash: detected chip: generic I (378) spi_flash: flash io: dio W (382) spi_flash: Detected size(4096k) larger than the size in the binary image header(2048k). Using the size in the binary image header. I (396) cpu_start: Starting scheduler on PRO CPU. I (0) cpu_start: Starting scheduler on APP CPU. ------------------------------------------------------------------------------ wolfSSL version 5.5.3 ------------------------------------------------------------------------------ error test passed! MEMORY test passed! base64 test passed! asn test passed! RANDOM test passed! MD5 test passed! MD4 test passed! SHA test passed! SHA-256 test passed! SHA-512 test passed! Hash test passed! HMAC-MD5 test passed! HMAC-SHA test passed! HMAC-SHA256 test passed! HMAC-SHA512 test passed! HMAC-KDF test passed! TLSv1.3 KDF test passed! GMAC test passed! DES test passed! DES3 test passed! AES test passed! AES192 test passed! AES256 test passed! AES-GCM test passed! RSA test passed! PWDBASED test passed! ECC test passed! ECC buffer test passed! CURVE25519 test passed! ED25519 test passed! logging test passed! time test passed! mutex test passed! Test complete I (136548) wolfcrypt_test: Exiting main with return code: 0 I (136548) wolfssl_test: wolf_test_task complete success result code = 0 ``` See the README.md file in the upper level 'examples' directory for [more information about examples](../README.md).
idf.py add-dependency "wolfssl/wolfssl^5.6.6-stable-update2-esp32"
To create a project from this example, run:
idf.py create-project-from-example "wolfssl/wolfssl^5.6.6-stable-update2-esp32:template"
To create a project from this example, run:
idf.py create-project-from-example "wolfssl/wolfssl^5.6.6-stable-update2-esp32:wolfssl_benchmark"
To create a project from this example, run:
idf.py create-project-from-example "wolfssl/wolfssl^5.6.6-stable-update2-esp32:wolfssl_client"
To create a project from this example, run:
idf.py create-project-from-example "wolfssl/wolfssl^5.6.6-stable-update2-esp32:wolfssl_server"
To create a project from this example, run:
idf.py create-project-from-example "wolfssl/wolfssl^5.6.6-stable-update2-esp32:wolfssl_test"