readme

This is the Expressif Component Version 5.6 of wolfSSL, test #8 (v1.0.7-dev) For questions or beta test of this library, please send a message to support@wolfssl.com # 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.2, 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, and DTLS 1.2), 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. <a href="https://repology.org/project/wolfssl/versions"> <img src="https://repology.org/badge/vertical-allrepos/wolfssl.svg" alt="Packaging status" align="right"> </a> ## 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.0 (Mar 24, 2023) Release 5.6.0 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 * This release makes ASN Template the default with ./configure, the previous ASN parsing can be built with --enable-asn=original Release 5.6.0 of wolfSSL embedded TLS has bug fixes and new features including: ## New Feature Additions * ASN template is now the default ASN parsing implementation when compiling with configure * Added in support for TLS v1.3 Encrypted Client Hello (ECH) and HPKE (Hybrid Public Key Encryption) * DTLS 1.3 stateless server ClientHello parsing support added ### Ports * Add RX64/RX71 SHA hardware support * Port to RT1170 and expand NXP CAAM driver support * Add NuttX integration files for ease of use * Updated Stunnel support for version 5.67 Compatibility Layer * Add in support for AES-CCM with EVP * BN compatibility API refactoring and separate API created * Expanding public key type cipher suite list strings support ### Misc. * Support pthread_rwlock and add enable option * Add wolfSSL_CertManagerLoadCABuffer_ex() that takes a user certificate chain flag and additional verify flag options * Docker build additions for wolfSSL library and wolfCLU application * Add favorite drink pilot attribute type to get it from the encoding * Added in support for indefinite length BER parsing with PKCS12 * Add dynamic session cache which allocates sessions from the heap with macro SESSION_CACHE_DYNAMIC_MEM ## Improvements / Optimizations ### Tests * Additional CI (continuous integration) testing and leveraging of GitHub workflows * Add CI testing for wpa_supplicant, OpenWrt and OpenVPN using GitHub workflows * Add compilation of Espressif to GitHub workflows tests * Refactoring and improving error results with wolfCrypt unit test application * Minor warning fixes from Coverity static analysis scan * Add new SHA-512/224 and SHA-512/256 tests * Used codespell and fixed some minor typos ### Ports * Improve TLS1.2 client authentication to use TSIP * Updated Kyber macro to be WOLFSSL_HAVE_KYBER and made changes that make Kyber work on STM32 * AES-GCM Windows assembly additions * CRLF line endings, trailing spaces for C# Wrapper Projects Compatibility Layer * Update `PubKey` and `Key` PEM-to-DER APIs to support return of needed DER size * Allow reading ENC EC PRIVATE KEY as well via wolfSSL_PEM_read_bio_ECPrivateKey * Improve wolfSSL_EC_POINT_cmp to handle Jacobian ordinates * Fix issue with BIO_reset() and add BIO_FLAGS_MEM_RDONLY flag support for read only BIOs ### SP * In SP math library rework mod 3 and use count leading zero instruction * Fix with SP ECC sign to reject the random k generated when r is 0 * With SP math add better detection of when add won't work and double is needed with point_add_qz1 internal function * With SP int fail when buffer writing to is too small for number rather than discarding the extra values ### Builds * Define WOLFSSL_SP_SMALL_STACK if wolfSSL is build with --enable-smallstack * Fix CMake to exclude libm when DH is not enabled * Allow building of SAKKE as external non-FIPS algorithm with wolfmikey product * Add option to add library suffix, --with-libsuffix * ASN template compile option WOLFSSL_ASN_INT_LEAD_0_ANY to allow leading zeros * Add user_settings.h template for wolfTPM to examples/configs/user_settings_wolftpm.h * Purge the AES variant of Dilithium * Expand WOLFSSL_NO_ASN_STRICT to allow parsing of explicit ECC public key * Remove relocatable text in ARMv7a AES assembly for use with FIPS builds * Expand checking for hardware that supports ARMv7a neon with autotools configure * Sanity check on allocation fails with DSA and FP_ECC build when zeroizing internal buffer * Additional TLS alerts sent when compiling with WOLFSSL_EXTRA_ALERTS macro defined ### Benchmarking * Update wolfCrypt benchmark Windows build files to support x64 Platform * Add SHA512/224 and SHA512/256 benchmarks, fixed CVS macro and display sizes * Separate AES-GCM streaming runs when benchmarked * No longer call external implementation of Kyber from benchmark * Fix for benchmarking shake with custom block size * Fixes for benchmark help `-alg` list and block format Documentation/Examples * Document use of wc_AesFree() and update documentation of Ed25519 with Doxygen * Move the wolfSSL Configuration section higher in QUIC.md * Add Japanese Doxygen documentation for cmac.h, quic.h and remove incomplete Japanese doxygen in asn_public.h * Espressif examples run with local wolfSSL now with no additional setup needed * Added a fix for StartTLS use In the example client * Add a base-line user_settings.h for use with FIPS 140-3 in XCode example app ### Optimizations * AES-NI usage added for AES modes ECB/CTR/XTS ### Misc * Update AES-GCM stream decryption to allow long IVs * Internal refactor to use wolfSSL_Ref functions when incrementing or decrementing the structures reference count and fixes for static analysis reports * Cleanup function logging making adjustments to the debug log print outs * Remove realloc dependency in DtlsMsgCombineFragBuckets function * Refactor to use WOLFSSL_CTX’s cipher suite list when possible * Update internal padding of 0’s with DSA sign and additional tests with mp_to_unsigned_bin_len function * With DTLS SRTP use wolfSSL_export_keying_material instead of wc_PRF_TLS * Updated macro naming from HAVE_KYBER to be WOLFSSL_HAVE_KYBER * Update AES XTS encrypt to handle in-place encryption properly * With TLS 1.3 add option to require only PSK with DHE ## Fixes ### Ports * Fix for AES use with CAAM on imx8qxp with SECO builds * Fix for PIC32 crypto HW and unused `TLSX_SetResponse` * Fix warning if ltime is unsigned seen with QNX build * Updates and fix for Zephyr project support * Include sys/time.h for WOLFSSL_RIOT_OS * Move X509_V errors from enums to defines for use with HAProxy CLI * Fix IAR compiler warnings resolved * Fix for STM32 Hash peripherals (like on F437) with FIFO depth = 1 * ESP32 fix for SHA384 init with hardware acceleration ### Builds * Add WOLFSSL_IP_ALT_NAME macro define to --enable-curl * Fixes for building with C++17 and avoiding clashing with byte naming * Fixes SP math all build issue with small-stack and no hardening * Fix for building with ASN template with `NO_ASN_TIME` defined * Fix building FIPSv2 with WOLFSSL_ECDSA_SET_K defined * Don't allow aesgcm-stream option with kcapi * Fix DTLS test case for when able to read peers close notify alert on FreeBSD systems * Fix for "expression must have a constant value" in tls13.c with Green Hills compiler * Fixes for building KCAPI with opensslextra enabled * Fix warnings of shadows min and subscript with i486-netbsd-gcc compiler * Fix issue with async and `WOLFSSL_CHECK_ALERT_ON_ERR` * Fix for PKCS7 with asynchronous crypto enabled ### Math Library * SP Aarch64 fix for conditional changed in asm needing "cc" and fix for ECC P256 mont reduce * In SP builds add sanity check with DH exp. to check the output length for minimum size * In SP math fix scalar length check with EC scalar multiply * With SP int fix handling negative character properly with read radix * Add error checks before setting variable err in SP int with the function sp_invmod_mont_ct * Fix to add sanity check for malloc of zero size in fastmath builds * In fastmath fix a possible overflow in fp_to_unsigned_bin_len length check * Heapmath fast mod. reduce fix ### Compatibility Layer * Fixes for encoding/decoding ecc public keys and ensure i2d public key functions do not include any private key information * Fix for EVP_EncryptUpdate to update outl on empty input * Fix SE050 RSA public key loading and RSA/ECC SE050 TLS Compatibility * Rework EC API and validate point after setting it * Fix for X509 RSA PSS with compatibility layer functions * Fix size of structures used with SHA operations when built with opensslextra for Espressif hardware accelerated hashing * Added sanity check on key length with wolfSSL_CMAC_Init function * Fix for return value type conversion of bad mutex error in logging function * Fix NID conflict NID_givenName and NID_md5WithRSAEncryption * Fix unguarded XFPRINTF calls with opensslextra build * Fix wolfSSL_ASN1_INTEGER_to_BN for negative values * Fix for potential ASN1_STRING leak in wolfSSL_X509_NAME_ENTRY_create_by_txt and wolfSSL_X509_NAME_ENTRY_create_by_NID when memory allocation fails ### Misc. * Add sanity check to prevent an out of bounds read with OCSP response decoding * Sanity check to not allow 0 length with bit string and integer when parsing ASN1 syntax * Adjust RNG sanity checks and remove error prone first byte comparison * With PKCS7 add a fix for GetAsnTimeString() to correctly increment internal data pointer * PKCS7 addition of sequence around algo parameters with authenvelop * DSA fixes for clearing mp_int before re-reading data and avoid mp_clear without first calling mp_init * Fix for SRTP setting bitfield when it is encoded for the TLS extension * Fix for handling small http headers when doing CRL verification * Fix for ECCSI hash function to validate the output size and curve size * Fix for value of givenName and name being reversed with CSR generation * Fix for error type returned (OCSP_CERT_UNKNOWN) with OCSP verification * Fix for a potential memory leak with ProcessCSR when handling OCSP responses * Fix for VERIFY_SKIP_DATE flag not ignoring date errors when set * Fix for zlib decompression buffer issue with PKCS7 * Fix for DTLS message pool send size used and DTLS server saving of the handshake sequence * Fix to propagate WOLFSSL_TICKET_RET_CREATE error return value from DoDecryptTicket() * Fix for handling long session IDs with TLS 1.3 session tickets * Fix for AES-GCM streaming when caching an IV * Fix for test case with older selftest that returns bad padding instead of salt len error * Add fix for siphash cache and added in additional tests * Fix potential out of bounds memset to 0 in error case with session export function used with --enable-sessionexport builds * Fix possible NULL dereference in TLSX_CSR_Parse with TLS 1.3 * Fix for sanity check on RSA pad length with no padding using the build macro WC_RSA_NO_PADDING 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)

readme of wolfssl_benchmark example

# wolfSSL Benchmark Example The Example contains of wolfSSL benchmark program. ## 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 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 install wolfSSL component # cd /mnt/c/workspace/wolfssl/IDE/Espressif/ESP-IDF ./setup.sh cd /mnt/c/workspace/wolfssl/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark # Pick ESP-IDF install directory, this one for v4.4.2 in VisualGDB . /mnt/c/SysGCC/esp32/esp-idf/v4.4.2/export.sh idf.py build flash -p /dev/ttyS20 -b 921600 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 921600 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 921600 monitor ``` ### ESP Component Registry This tag is used to include this file in the ESP Component Registry: __ESP_COMPONENT_SOURCE__

readme of wolfssl_test example

# wolfSSL Crypt Test Example The Example contains of wolfSSL test program. [RSA peripheral 50% slower on ESP32-S3/C3 than S2](https://www.esp32.com/viewtopic.php?t=23830) [ GPIO6,GPIO7,GPIO8,and GPIO9 changed for ESP32-WROOM-32E](https://esp32.com/viewtopic.php?t=29058) ## 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 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`: ``` # Optionally install wolfSSL component # cd /mnt/c/workspace/wolfssl/IDE/Espressif/ESP-IDF ./setup.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 v4.4.2 in VisualGDB . /mnt/c/SysGCC/esp32/esp-idf/v4.4.2/export.sh # build and flash, in this example to COM20 idf.py build flash -p /dev/ttyS20 -b 921600 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 921600 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 ``` # This tag is used to include this file in the ESP Component Registry: # __ESP_COMPONENT_SOURCE__

Supports all targets

License: GPL-2.0-only

To add this component to your project, run:

idf.py add-dependency "wolfssl/wolfssl^1.0.7-dev"

or download archive

Examples:

wolfssl_benchmark

more details

wolfssl_test

more details

Stats

  • Downloaded in total
    Downloaded in total 156 times
  • Downloaded this version
    This version: 8 times

Badge

wolfssl/wolfssl version: 1.0.7-dev |