README 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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.2 (Oct 28, 2022)
  58. Release 5.5.2 of wolfSSL embedded TLS has bug fixes and new features including:
  59. ## Vulnerabilities
  60. * [Med] In the case that the WOLFSSL_CALLBACKS macro is set when building wolfSSL, there is a potential heap over read of 5 bytes when handling TLS 1.3 client connections. This heap over read is limited to wolfSSL builds explicitly setting the macro WOLFSSL_CALLBACKS, the feature does not get turned on by any other build options. The macro WOLFSSL_CALLBACKS is intended for debug use only, but if having it enabled in production, users are recommended to disable WOLFSSL_CALLBACKS. Users enabling WOLFSSL_CALLBACKS are recommended to update their version of wolfSSL. Thanks to Lucca Hirschi and Steve Kremer from LORIA, Inria and Max Ammann from Trail of Bits for finding and reporting the bug with the tlspuffin tool developed partly at LORIA and Trail of Bits. CVE 2022-42905
  61. Release 5.5.2 of wolfSSL embedded TLS has bug fixes and new features including:
  62. ## New Feature Additions
  63. * Add function wolfSSL_CTX_load_system_CA_certs to load system CA certs into a WOLFSSL_CTX and --sys-ca-certs option to example client
  64. * Add wolfSSL_set1_host to OpenSSL compatible API
  65. * Added the function sk_X509_shift
  66. * AES x86 ASM for AES-CBC and GCM performance enhancements
  67. * Add assembly for AES for ARM32 without using crypto hardware instructions
  68. * Xilinx Versal port and hardware acceleration tie in
  69. * SP Cortex-M support for ICCARM
  70. ## Enhancements
  71. * Add snifftest vcxproj file and documentation
  72. * Nucleus Thread Types supported
  73. * Handle certificates with RSA-PSS signature that have RSAk public keys
  74. * Small stack build improvements
  75. * DTLS 1.3 improvements for Alerts and unit tests
  76. * Add a binary search for CRL
  77. * Improvement of SSL/CTX_set_max_early_data() for client side
  78. * Remove unused ASN1_GENERALIZEDTIME enum value from wolfssl/ssl.h
  79. * Add user_settings.h for Intel/M1 FIPSv2 macOS C++ projects
  80. * Add dtlscid.test to ‘make check’ unit testing
  81. * Generate an assembler-safe user_settings.h in configure.ac and CMakeLists.txt
  82. * ForceZero enabled with USE_FAST_MATH
  83. * Add TLS 1.3 support of ticketNonce sizes bigger than MAX_TICKET_NONCE_SZ
  84. * FIPSv2 builds on win10 adjust for new fastmath default in settings.h
  85. * Add IRQ install for Aruix example
  86. ## Fixes
  87. * When looking up the session by ID on the server, check that the protocol version of the SSL and session match on TLS 1.3 or not
  88. * Fix for potential EVP_PKEY_DH memory leak with OPENSSL_EXTRA
  89. * Curve448 32-bit C code: handle corner case
  90. * Fixup builds using WOLFSSL_LOG_PRINTF
  91. * Correct DIST_POINT_NAME type value
  92. * Do not perform IV Wrap test when using cert3389 inlined armasm
  93. * Fix for Linux kernel module and stdio.h
  94. * (D)TLS: send alert on version mismatch
  95. * Fix PKCS#7 SignedData verification when signer cert is not first in SET
  96. * Fix bug with wolfIO_TcpConnect not working with timeout on Windows
  97. * Fix output length bug in SP non-blocking ECC shared secret gen
  98. * Fix build with enable-fastmath and disable-rsa
  99. * Correct wolfSSL_sk_X509_new in OpenSSL compatible API
  100. * Fixes for SP and x86_64 with MSVC
  101. * Fix wrong size using DTLSv1.3 in RestartHandshakeHashWithCookie
  102. * Fix redundant file include with TI RTOS build
  103. * Fix wolfCrypt only build with wincrypt.h
  104. * DTLS 1.2: Reset state when sending HelloVerifyRequest
  105. For additional vulnerability information visit the vulnerability page at:
  106. https://www.wolfssl.com/docs/security-vulnerabilities/
  107. See INSTALL file for build instructions.
  108. More info can be found on-line at: https://wolfssl.com/wolfSSL/Docs.html
  109. *** Resources ***
  110. [wolfSSL Website](https://www.wolfssl.com/)
  111. [wolfSSL Wiki](https://github.com/wolfSSL/wolfssl/wiki)
  112. [FIPS FAQ](https://wolfssl.com/license/fips)
  113. [wolfSSL Documents](https://wolfssl.com/wolfSSL/Docs.html)
  114. [wolfSSL Manual](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-toc.html)
  115. [wolfSSL API Reference]
  116. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-17-wolfssl-api-reference.html)
  117. [wolfCrypt API Reference]
  118. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-18-wolfcrypt-api-reference.html)
  119. [TLS 1.3](https://www.wolfssl.com/docs/tls13/)
  120. [wolfSSL Vulnerabilities]
  121. (https://www.wolfssl.com/docs/security-vulnerabilities/)
  122. Additional wolfSSL Examples](https://github.com/wolfssl/wolfssl-examples)