diff options
Diffstat (limited to 'extra/wolfssl/wolfssl/README.md')
| -rw-r--r-- | extra/wolfssl/wolfssl/README.md | 210 |
1 files changed, 74 insertions, 136 deletions
diff --git a/extra/wolfssl/wolfssl/README.md b/extra/wolfssl/wolfssl/README.md index 18b3665f..381a05fb 100644 --- a/extra/wolfssl/wolfssl/README.md +++ b/extra/wolfssl/wolfssl/README.md @@ -1,7 +1,3 @@ -<a href="https://repology.org/project/wolfssl/versions"> - <img src="https://repology.org/badge/vertical-allrepos/wolfssl.svg" alt="Packaging status" align="right"> -</a> - # wolfSSL Embedded SSL/TLS Library The [wolfSSL embedded SSL library](https://www.wolfssl.com/products/wolfssl/) @@ -10,7 +6,7 @@ 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 +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 @@ -27,8 +23,8 @@ or contact fips@wolfssl.com. 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, +(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/) @@ -79,150 +75,93 @@ single call hash function. Instead the name `WC_SHA`, `WC_SHA256`, `WC_SHA384` a `WC_SHA512` should be used for the enum name. -# wolfSSL Release 5.6.3 (Jun 20, 2023) - -Release 5.6.3 has been developed according to wolfSSL's development and QA process (see link below) and successfully passed the quality criteria. +# wolfSSL Release 5.6.6 (Dec 19, 2023) -Release 5.6.3 of wolfSSL embedded TLS has 4 bug fixes: +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 -* Fix for setting the atomic macro options introduced in release 5.6.2. This issue affects GNU gcc autoconf builds. The fix resolves a potential mismatch of the generated macros defined in options.h file and the macros used when the wolfSSL library is compiled. In version 5.6.2 this mismatch could result in unstable runtime behavior. -* Fix for invalid suffix error with Windows build using the macro GCM_TABLE_4BIT. -* Improvements to Encrypted Memory support (WC_PROTECT_ENCRYPTED_MEM) implementations for modular exponentiation in SP math-all (sp_int.c) and TFM (tfm.c). -* Improvements to SendAlert for getting output buffer. +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. -# wolfSSL Release 5.6.2 (Jun 09, 2023) +## Vulnerabilities -Release 5.6.2 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 +* [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. -NOTE: * --enable-heapmath is being deprecated and will be removed by 2024 +* [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. -Release 5.6.2 of wolfSSL embedded TLS has bug fixes and new features including: +* [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. -## Vulnerabilities -* [Low] In cases where a malicious agent could analyze cache timing at a very detailed level, information about the AES key used could be leaked during T/S Box lookups. One such case was shown on RISC-V hardware using the MicroWalk tool (https://github.com/microwalk-project/Microwalk). A hardened version of T/S Box lookups was added in wolfSSL to help mitigate this potential attack and is now on by default with RISC-V builds and can be enabled on other builds if desired by compiling wolfSSL with the macro WOLFSSL_AES_TOUCH_LINES. Thanks to Jan Wichelmann, Christopher Peredy, Florian Sieck, Anna Pätschke, Thomas Eisenbarth (University of Lübeck): MAMBO-V: Dynamic Side-Channel Leakage Analysis on RISC-V. Fixed in the following GitHub pull request https://github.com/wolfSSL/wolfssl/pull/6309 -* [High] In previous versions of wolfSSL if a TLS 1.3 client gets neither a PSK (pre shared key) extension nor a KSE (key share extension) when connecting to a malicious server, a default predictable buffer gets used for the IKM value when generating the session master secret. Using a potentially known IKM value when generating the session master secret key compromises the key generated, allowing an eavesdropper to reconstruct it and potentially allowing surreptitious access to or meddling with message contents in the session. This issue does not affect client validation of connected servers, nor expose private key information, but could result in an insecure TLS 1.3 session when not controlling both sides of the connection. We recommend that TLS 1.3 client side users update the version of wolfSSL used. Thanks to Johannes from Sectra Communications and Linköping University for the report. Fixed in the following GitHub pull request https://github.com/wolfSSL/wolfssl/pull/6412 +* [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 -### New Ports and Expansions -* Add support for STM32H5 -* Add support for Renesas TSIP v1.17 -* Add Renesas SCE RSA crypto-only support -* STARCORE DSP port and example builds added -* Add the function wc_PKCS7_SetDefaultSignedAttribs for setting PKCS7 signed attributes to use with PKCS7 bundle creation -* NXP IMX6Q CAAM port with QNX and performance optimizations for AES-CTR - -### New Build Options -* ASN.1 print utility to decode ASN.1 syntax and print out human readable text --enable-asn-print. Utility app is located in the directory ./examples/asn1/ -* Add introspection for math build, wc_GetMathInfo() to get information about the math library compiled into the linked wolfSSL library -* Implement TLS recommendations from RFC 9325 for hardening TLS/DTLS security. Enabled with the autoconf flag --enable-harden-tls. -* Add option to support disabling thread local storage, --disable-threadlocal -* Added wc_DsaSign_ex() and wc_DsaVerify_ex() for handling alternative digest algorithms with DSA Sign/Verify -* Implement atomic operations interface. Macros auto-detect if atomic operations are expected to be available, can be turned off with the macro WOLFSSL_NO_ATOMICS -* Added support for DTLS 1.3 Authentication and Integrity-Only Cipher Suites -* Expand crypto callback to have a device ID find callback function with wc_CryptoCb_SetDeviceFindCb. Enabled with the macro WOLF_CRYPTO_CB_FIND +* 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 -### Optimizations -* Increased performance with ChaCha20 C implementation and general XOR operations -* Added integer type to the ASN.1 sequencing with ASN.1 Integer sequence -* With wolfSSL_get_x509_next_altname reset alt name list to head once cycled through if compiling with the macro WOLFSSL_MULTICIRCULATE_ALTNAMELIST -* Additional key validity sanity checks on input to wolfSSL_EC_KEY_set_private_key -* adds support for TLSv1.3 stateful session tickets when using SSL_OP_NO_TICKET - -### Memory Optimizations -* Improvements to stack usage and management with SP int math library -* Optimization to TLS 1.3 server to remove caching messages for Ed25519/Ed448 -* Added a HAVE_CURL macro build for building a subset of the wolfSSL library when linking with cURL -* Memory usage improvement with reducing the size of alignment needed with AES -* Reduce run time memory used with ECC operations and ALT_ECC_SIZE -* Fixes and improvements for building edge cases such as crypto callback without hash-drbg with low footprint options -* Support HAVE_SESSION_TICKET build option without depending on realloc - -### Documentation -* Instructions for GPDMA on STM32 configuration added -* Add in instructions for compiling with zephyr on STM32 -* Documentation fixup for wolfSSL_get_chain_cert() -* Fix the file pointed to in the TI RTOS documentation that we maintain -* Documentation for wolfSSL_CertManagerFreeCRL -* Updates made to AES and Chacha documentation -* Update Japanese comments for Ed25519, AES, and other miscellaneous items - -### Tests -* Add in an option for easily testing malloc failures when building with WOLFSSL_MEM_FAIL_COUNT macro -* Updated in process for using Expect vs Assert to facilitate more malloc failure tests -* Enhance wolfCrypt test for builds that do not have ECC SECP curves enabled -* ESP32 platform-specific VisualGDB test & benchmark projects -* Update to dependencies in docker container file used for tests -* Fix up for base 10 output with bundled benchmark application - -### Port Updates -* Zephyr port update, compile time warning fixes, misc. fixes when used with TLS and update of includes -* Update RIOT-OS to not compile out use of writev by default -* Update Micrium port to enable use of STM32_RNG -* Micrium updates for XMEMOVE and XSTRTOK use -* Various Espressif HW crypto, SHA2, AES, MP updates -* Added in ASIO build option with CMake builds - -### General Enhancements -* Global codebase cleanup for C89 compliance and wolfCrypt -Wconversion hygiene -* PKCS#11 enhancement adding a callback for RSA key size when using a hardware key, by default 2048 bit key is used -* Allow for unknown OIDs in extensions in wolfSSL_X509_set_ext() -* Allow user to override XSTAT by defining the macro XSTAT when compiling -* Support UPN and SID with x509 certificate extensions and custom OID build -* Write next IV in wolfSSL_DES_ede3_cbc_encrypt for better handling of inline encryption -* Adding NO_ASN_TIME_CHECK build option for compiling out certificate before/after checks -* Improve different peer recvfrom handling and error reporting with ipv4 vs ipv6 +* 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 STM32 ECC sign and verify out of bounds buffer write when the hash length passed in is larger than the key size. Thanks to Maximilian for the report. -* Fix to skip Async_DevCtxInit when using init rsa/ecc label/id api's -* Revert WOLFSSL_NO_ASN_STRICT macro guard around alternate names directory list -* In async mode, don't retry decrypting if a valid error is encountered on a packet parse attempt -* Add additional sanity check on PKCS7 index value in wc_PKCS7_DecryptKekri -* Fix for padding when using an AuthEnvelope PKCS7 type with GCM/CCM stream ciphers -* Fix siphash assembly so that no register is left behind -* Fix to not send a TLS 1.3 session ID resume response when resuming and downgrading to a protocol less than TLS 1.3 -* Fix overwriting serialNumber by favouriteDrink when generating a certificate using Cert struct -* Fix for the default realloc used with EspressIf builds -* Track SetDigest usage to avoid invalid free under error conditions -* DTLS v1.3 fix for epoch 0 check on plaintext message -* Fix for session ticket memory leak in wolfSSL_Cleanup -* Fixes for propagating SendAlert errors when the peer disconnects -* Replace XMEMCPY with XMEMMOVE to fix valgrind-3.15.0 reports "Source and destination overlap in memcpy" when using --enable-aesgcm-stream -* Fix for potential out-of-bounds write edge case in fp_mod_2d with --enable-fastmath math library -* Fix getting ECC key size in stm32_ecc_sign_hash_ex -* Fix for case where wc_PeekErrorNodeLineData was not unlocking error queue on error -* Fix for async ECC shared secret state -* Fix for better error checking with sp_gcd with SP int math library -* Fix memory leak in TLSX_KeyShare_Setup when handling an error case -* Fix for double free edge case in InitOCSPRequest when handling a memory allocation failure -* X509 NAME Entry fix for leaking memory on error case -* Fix wolfssl_asn1_time_to_tm setting unexpected fields in tm struct -* Fix for FIPS ECC integrity check with crypto callback set -* BN_to_ASN1_INTEGER fix for handling leading zero byte padding when needed -* Fix a typo in PP macro and add a ceiling to guard against implementation bugs -* DTLS 1.3 fix for using the correct label when deriving the resumption key -* OCSP fix for GetDateInfo edge case with non ASN template builds -* Allow a user set certificate callback function to override the skipAddCA flag when parsing a certificate -* SP int: sp_radix_size when radix 10 fix temp size for handling edge case -* Fixes and improvements for handling failures with memory allocations -* Fix for DecodeECC_DSA_Sig to handle r and s being initialized -* Fix for wc_ecc_is_point to ensure that the x and y are in range [0, p-1] and z is one (affine ordinates) - -### Build Fixes -* Fix for building on Windows with CMake and using USER_SETTINGS and fix for options.h creation with CMake when using USER_SETTINGS -* CMake fixes and improvements for use with mingw32 -* Fix for building with wpas and x509 small options -* Check if colrm is available for options.h creation when using autoconf -* Clean up NO_BIG_INT build, removing WOLFSSL_SP_MATH macro and heapmath compile -* Fix PKCS#7 build with NO_PKCS7_STREAM -* Fix compilation error in CC-RX and remove unnecessary public key import -* SP Build fixes for ARM assembly with ARMv6 clz and ARM thumb debug build -* For to not advertise support for RSA in TLS extensions when compiled with NO_RSA + +* 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/ @@ -230,7 +169,6 @@ 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/) |