README 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. *** Description ***
  2. The wolfSSL embedded SSL library (formerly CyaSSL) is a lightweight SSL/TLS
  3. library written in ANSI C and targeted for embedded, RTOS, and
  4. resource-constrained environments - primarily because of its small size, speed,
  5. and feature set. It is commonly used in standard operating environments as well
  6. because of its royalty-free pricing and excellent cross platform support.
  7. wolfSSL supports industry standards up to the current TLS 1.3 and DTLS 1.2
  8. levels, is up to 20 times smaller than OpenSSL, and offers progressive ciphers
  9. such as ChaCha20, Curve25519, and Blake2b. User benchmarking and feedback
  10. reports dramatically better performance when using wolfSSL over OpenSSL.
  11. wolfSSL is powered by the wolfCrypt library. Two versions of the wolfCrypt
  12. cryptography library have been FIPS 140-2 validated (Certificate #2425 and
  13. certificate #3389). For additional information, visit the wolfCrypt FIPS FAQ
  14. (https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com
  15. *** Why choose wolfSSL? ***
  16. There are many reasons to choose wolfSSL as your embedded SSL solution. Some of
  17. the top reasons include size (typical footprint sizes range from 20-100 kB),
  18. support for the newest standards (SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3,
  19. DTLS 1.0, and DTLS 1.2), current and progressive cipher support (including
  20. stream ciphers), multi-platform, royalty free, and an OpenSSL compatibility API
  21. to ease porting into existing applications which have previously used the
  22. OpenSSL package. For a complete feature list, see chapter 4 of the wolfSSL
  23. manual. (https://www.wolfssl.com/docs/wolfssl-manual/ch4/)
  24. *** Notes, Please read ***
  25. Note 1)
  26. wolfSSL as of 3.6.6 no longer enables SSLv3 by default. wolfSSL also no longer
  27. supports static key cipher suites with PSK, RSA, or ECDH. This means if you
  28. plan to use TLS cipher suites you must enable DH (DH is on by default), or
  29. enable ECC (ECC is on by default), or you must enable static key cipher suites
  30. with
  31. WOLFSSL_STATIC_DH
  32. WOLFSSL_STATIC_RSA
  33. or
  34. WOLFSSL_STATIC_PSK
  35. though static key cipher suites are deprecated and will be removed from future
  36. versions of TLS. They also lower your security by removing PFS.
  37. When compiling ssl.c, wolfSSL will now issue a compiler error if no cipher
  38. suites are available. You can remove this error by defining
  39. WOLFSSL_ALLOW_NO_SUITES in the event that you desire that, i.e., you're not
  40. using TLS cipher suites.
  41. Note 2)
  42. wolfSSL takes a different approach to certificate verification than OpenSSL
  43. does. The default policy for the client is to verify the server, this means
  44. that if you don't load CAs to verify the server you'll get a connect error,
  45. no signer error to confirm failure (-188).
  46. If you want to mimic OpenSSL behavior of having SSL_connect succeed even if
  47. verifying the server fails and reducing security you can do this by calling:
  48. wolfSSL_CTX_set_verify(ctx, SSL_VERIFY_NONE, 0);
  49. before calling wolfSSL_new();. Though it's not recommended.
  50. Note 3)
  51. The enum values SHA, SHA256, SHA384, SHA512 are no longer available when
  52. wolfSSL is built with --enable-opensslextra (OPENSSL_EXTRA) or with the macro
  53. NO_OLD_SHA_NAMES. These names get mapped to the OpenSSL API for a single call
  54. hash function. Instead the name WC_SHA, WC_SHA256, WC_SHA384 and WC_SHA512
  55. should be used for the enum name.
  56. *** end Notes ***
  57. # wolfSSL Release 5.5.4 (Dec 21, 2022)
  58. Release 5.5.4 of wolfSSL embedded TLS has bug fixes and new features including:
  59. Release 5.5.4 has been developed according to wolfSSL's development and QA process (see link below) and successfully passed the quality criteria.
  60. https://www.wolfssl.com/about/wolfssl-software-development-process-quality-assurance
  61. ## New Feature Additions
  62. * QUIC related changes for HAProxy integration and config option
  63. * Support for Analog Devices MAXQ1080 and MAXQ1065
  64. * Testing and build of wolfSSL with NuttX
  65. * New software based entropy gatherer with configure option --enable-entropy-memuse
  66. * NXP SE050 feature expansion and fixes, adding in RSA support and conditional compile of AES and CMAC
  67. * Support for multi-threaded sniffer
  68. ## Improvements / Optimizations
  69. ### Benchmark and Tests
  70. * Add alternate test case for unsupported static memory API when testing mutex allocations
  71. * Additional unit test cases added for AES CCM 256-bit
  72. * Initialize and free AES object with benchmarking AES-OFB
  73. * Kyber with DTLS 1.3 tests added
  74. * Tidy up Espressif ESP32 test and benchmark examples
  75. * Rework to be able to run API tests individually and add display of time taken per test
  76. ### Build and Port Improvements
  77. * Add check for 64-bit ABI on MIPS64 before declaring a 64-bit CPU
  78. * Add support to detect SIZEOF_LONG in armclang and diab
  79. * Added in a simple example working on Rx72n
  80. * Update azsphere support to prevent compilation of file included inline
  81. * --enable-brainpool configure option added and default to on when custom curves are also on
  82. * Add RSA PSS salt defines to engine builds if not FIPS v2
  83. ### Post Quantum
  84. * Remove kyber-90s and route all Kyber through wolfcrypt
  85. * Purge older version of NTRU and SABER from wolfSSL
  86. ### SP Math
  87. * Support static memory build with sp-math
  88. * SP C, SP int: improve performance
  89. * SP int: support mingw64 again
  90. * SP int: enhancements to guess 64-bit type and check on NO_64BIT macro set before using long long
  91. * SP int: check size required when using sp_int on stack
  92. * SP: --enable-sp-asm now enables SP by default if not set
  93. * SP: support aarch64 big endian
  94. ### DTLS
  95. * Allow DTLS 1.3 to compile when FIPS is enabled
  96. * Allow for stateless DTLS client hello parsing
  97. ### Misc.
  98. * Easier detection of DRBG health when using Intel’s RDRAND by updating the structures status value
  99. * Detection of duplicate known extensions with TLS
  100. * PKCS#11 handle a user PIN that is a NULL_PTR, compile time check in finding keys, add initialization API
  101. * Update max Cert Policy size based on RFC 5280
  102. * Add Android CA certs path for wolfSSL_CTX_load_system_CA_certs()
  103. * Improve logic for enabling system CA certs on Apple devices
  104. * Stub functions to allow for cpuid public functions with non-intel builds
  105. * Increase RNG_SECURITY_STRENGTH for FIPS
  106. * Improvements in OpenSSL Compat ERR Queue handling
  107. * Support ASN1/DER CRLs in LoadCertByIssuer
  108. * Expose more ECC math functions and improve async shared secret
  109. * Improvement for sniffer error messages
  110. * Warning added that renegotiation in TLS 1.3 requires session ticket
  111. * Adjustment for TLS 1.3 post auth support
  112. * Rework DH API and improve PEM read/write
  113. ## Fixes
  114. ### Build Fixes
  115. * Fix --enable-devcrypto build error for sys without u_int8_t type
  116. * Fix casts in evp.c and build issue in ParseCRL
  117. * Fixes for compatibility layer building with heap hint and OSSL callbacks
  118. * fix compile error due to Werro=undef on gcc-4.8
  119. * Fix mingw-w64 build issues on windows
  120. * Xcode project fixes for different build settings
  121. * Initialize variable causing failures with gcc-11 and gcc-12 with a unique wolfSSL build configuration
  122. * Prevent WOLFSSL_NO_MALLOC from breaking RSA certificate verification
  123. * Fixes for various tests that do not properly handle `WC_PENDING_E` with async. builds
  124. * Fix for misc `HashObject` to be excluded for `WOLFCRYPT_ONLY`
  125. ### OCSP Fixes
  126. * Correctly save next status with OCSP response verify
  127. * When the OCSP responder returns an unknown exception, continue through to checking the CRL
  128. ### Math Fixes
  129. * Fix for implicit conversion with 32-bit in SP math
  130. * Fix for error checks when modulus is even with SP int build
  131. * Fix for checking of err in _sp_exptmod_nct with SP int build
  132. * ECC cofactor fix when checking scalar bits
  133. * ARM32 ASM: don't use ldrd on user data
  134. * SP int, fix when ECC specific size code included
  135. ### Port Fixes
  136. * Fixes for STM32 PKA ECC (not 256-bit) and improvements for AES-GCM
  137. * Fix for cryptocell signature verification with ECC
  138. * Benchmark devid changes, CCM with SECO fix, set IV on AES import into SECO
  139. ### Compat. Layer Fixes
  140. * Fix for handling DEFAULT:... cipher suite list
  141. * Fix memory leak in wolfSSL_X509_NAME_ENTRY_get_object
  142. * Set alt name type to V_ASN1_IA5STRING
  143. * Update name hash functions wolfSSL_X509_subject_name_hash and wolfSSL_X509_issuer_name_hash to hash the canonical form of subject
  144. * Fix wolfSSL_set_SSL_CTX() to be usable during handshake
  145. * Fix X509_get1_ocsp to set num of elements in stack
  146. * X509v3 EXT d2i: fix freeing of aia
  147. * Fix to remove recreation of certificate with wolfSSL_PEM_write_bio_X509()
  148. * Link newly created x509 store's certificate manager to self by default to assist with CRL verification
  149. * Fix for compatibility `EC_KEY_new_by_curve_name` to not create a key if the curve is not found
  150. ### Misc.
  151. * Free potential signer malloc in a fail case
  152. * fix other name san parsing and add RID cert to test parsing
  153. * WOLFSSL_OP_NO_TICKET fix for TLSv1.2
  154. * fix ASN template parsing of X509 subject directory attribute
  155. * Fix the wrong IV size with the cipher suite TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256
  156. * Fix incorrect self signed error return when compiled with certreq and certgen.
  157. * Fix wrong function name in debug comment with wolfSSL_X509_get_name_oneline()
  158. * Fix for decryption after second handshake with async sniffer
  159. * Allow session tickets to properly resume when using PQ KEMs
  160. * Add sanity overflow check to DecodeAltNames input buffer access
  161. For additional vulnerability information visit the vulnerability page at:
  162. https://www.wolfssl.com/docs/security-vulnerabilities/
  163. See INSTALL file for build instructions.
  164. More info can be found on-line at: https://wolfssl.com/wolfSSL/Docs.html
  165. *** Resources ***
  166. [wolfSSL Website](https://www.wolfssl.com/)
  167. [wolfSSL Wiki](https://github.com/wolfSSL/wolfssl/wiki)
  168. [FIPS FAQ](https://wolfssl.com/license/fips)
  169. [wolfSSL Documents](https://wolfssl.com/wolfSSL/Docs.html)
  170. [wolfSSL Manual](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-toc.html)
  171. [wolfSSL API Reference]
  172. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-17-wolfssl-api-reference.html)
  173. [wolfCrypt API Reference]
  174. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-18-wolfcrypt-api-reference.html)
  175. [TLS 1.3](https://www.wolfssl.com/docs/tls13/)
  176. [wolfSSL Vulnerabilities]
  177. (https://www.wolfssl.com/docs/security-vulnerabilities/)
  178. Additional wolfSSL Examples](https://github.com/wolfssl/wolfssl-examples)