Home Explore Help
Sign In
OWEALs
/
wolfssl
mirror of https://github.com/wolfSSL/wolfssl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 5955603c51
Branches Tags
wolfssl
/
README

README 8.3 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 
  1. *** Description ***
    2. 

  2. 

  3. The wolfSSL embedded SSL library (formerly CyaSSL) is a lightweight SSL/TLS
    4. 

  4. library written in ANSI C and targeted for embedded, RTOS, and
    5. 

  5. resource-constrained environments - primarily because of its small size, speed,
    6. 

  6. and feature set.  It is commonly used in standard operating environments as well
    7. 

  7. because of its royalty-free pricing and excellent cross platform support.
    8. 

  8. wolfSSL supports industry standards up to the current TLS 1.3 and DTLS 1.2
    9. 

  9. levels, is up to 20 times smaller than OpenSSL, and offers progressive ciphers
    10. 

  10. such as ChaCha20, Curve25519, NTRU, and Blake2b. User benchmarking and feedback
    11. 

  11. reports dramatically better performance when using wolfSSL over OpenSSL.
    12. 

  12. 

  13. wolfSSL is powered by the wolfCrypt library. Two versions of the wolfCrypt
    14. 

  14. cryptography library have been FIPS 140-2 validated (Certificate #2425 and
    15. 

  15. certificate #3389). For additional information, visit the wolfCrypt FIPS FAQ
    16. 

  16. (https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com
    17. 

  17. 

  18. *** Why choose wolfSSL? ***
    19. 

  19. 

  20. There are many reasons to choose wolfSSL as your embedded SSL solution. Some of
    21. 

  21. the top reasons include size (typical footprint sizes range from 20-100 kB),
    22. 

  22. support for the newest standards (SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3,
    23. 

  23. DTLS 1.0, and DTLS 1.2), current and progressive cipher support (including
    24. 

  24. stream ciphers), multi-platform, royalty free, and an OpenSSL compatibility API
    25. 

  25. to ease porting into existing applications which have previously used the
    26. 

  26. OpenSSL package. For a complete feature list, see chapter 4 of the wolfSSL
    27. 

  27. manual. (https://www.wolfssl.com/docs/wolfssl-manual/ch4/)
    28. 

  28. 

  29. *** Notes, Please read ***
    30. 

  30. 

  31. Note 1)
    32. 

  32. wolfSSL as of 3.6.6 no longer enables SSLv3 by default.  wolfSSL also no longer
    33. 

  33. supports static key cipher suites with PSK, RSA, or ECDH. This means if you
    34. 

  34. plan to use TLS cipher suites you must enable DH (DH is on by default), or
    35. 

  35. enable ECC (ECC is on by default), or you must enable static key cipher suites
    36. 

  36. with
    37. 

  37. 

  38.     WOLFSSL_STATIC_DH
    39. 

  39.     WOLFSSL_STATIC_RSA
    40. 

  40.       or
    41. 

  41.     WOLFSSL_STATIC_PSK
    42. 

  42. 

  43. though static key cipher suites are deprecated and will be removed from future
    44. 

  44. versions of TLS.  They also lower your security by removing PFS.  Since current
    45. 

  45. NTRU suites available do not use ephemeral keys, WOLFSSL_STATIC_RSA needs to be
    46. 

  46. used in order to build with NTRU suites.
    47. 

  47. 

  48. When compiling ssl.c, wolfSSL will now issue a compiler error if no cipher
    49. 

  49. suites are available. You can remove this error by defining
    50. 

  50. WOLFSSL_ALLOW_NO_SUITES in the event that you desire that, i.e., you're not
    51. 

  51. using TLS cipher suites.
    52. 

  52. 

  53. Note 2)
    54. 

  54. wolfSSL takes a different approach to certificate verification than OpenSSL
    55. 

  55. does. The default policy for the client is to verify the server, this means
    56. 

  56. that if you don't load CAs to verify the server you'll get a connect error,
    57. 

  57. no signer error to confirm failure (-188).
    58. 

  58. 

  59. If you want to mimic OpenSSL behavior of having SSL_connect succeed even if
    60. 

  60. verifying the server fails and reducing security you can do this by calling:
    61. 

  61. 

  62.     wolfSSL_CTX_set_verify(ctx, SSL_VERIFY_NONE, 0);
    63. 

  63. 

  64. before calling wolfSSL_new();. Though it's not recommended.
    65. 

  65. 

  66. Note 3)
    67. 

  67. The enum values SHA, SHA256, SHA384, SHA512 are no longer available when
    68. 

  68. wolfSSL is built with --enable-opensslextra (OPENSSL_EXTRA) or with the macro
    69. 

  69. NO_OLD_SHA_NAMES. These names get mapped to the OpenSSL API for a single call
    70. 

  70. hash function. Instead the name WC_SHA, WC_SHA256, WC_SHA384 and WC_SHA512
    71. 

  71. should be used for the enum name.
    72. 

  72. 

  73. *** end Notes ***
    74. 

  74. 

  75. 

  76. # wolfSSL Release 4.7.0 (February 16, 2021)
    77. 

  77. Release 4.7.0 of wolfSSL embedded TLS has bug fixes and new features including:
    78. 

  78. 

  79. ### New Feature Additions
    80. 

  80. * Compatibility Layer expansion SSL_get_verify_mode, X509_VERIFY_PARAM API, X509_STORE_CTX API added
    81. 

  81. * WOLFSSL_PSK_IDENTITY_ALERT macro added for enabling a subset of TLS alerts
    82. 

  82. * Function wolfSSL_CTX_NoTicketTLSv12 added to enable turning off session tickets with TLS 1.2 while keeping TLS 1.3 session tickets available
    83. 

  83. * Implement RFC 5705: Keying Material Exporters for TLS
    84. 

  84. * Added --enable-reproducible-build flag for making more deterministic library outputs to assist debugging
    85. 

  85. * Added support for S/MIME (Secure/Multipurpose Internet Mail Extensions) bundles
    86. 

  86. 

  87. ### Fixes
    88. 

  88. * Fix to free mutex when cert manager is free’d
    89. 

  89. * Compatibility layer EVP function to return the correct block size and type
    90. 

  90. * DTLS secure renegotiation fixes including resetting timeout and retransmit on duplicate HelloRequest
    91. 

  91. * Fix for edge case with shrink buffer and secure renegotiation
    92. 

  92. * Compile fix for type used with curve448 and PPC64
    93. 

  93. * Fixes for SP math all with PPC64 and other embedded compilers
    94. 

  94. * SP math all fix when performing montgomery reduction on one word modulus
    95. 

  95. * Fixes to SP math all to better support digit size of 8-bit
    96. 

  96. * Fix for results of edge case with SP integer square operation
    97. 

  97. * Stop non-ct mod inv from using register x29 with SP ARM64 build
    98. 

  98. * Fix edge case when generating z value of ECC with SP code
    99. 

  99. * Fixes for PKCS7 with crypto callback (devId) with RSA and RNG
    100. 

  100. * Fix for compiling builds with RSA verify and public only
    101. 

  101. * Fix for PKCS11 not properly exporting the public key due to a missing key type field
    102. 

  102. * Call certificate callback with certificate depth issues
    103. 

  103. * Fix for out-of-bounds read in TLSX_CSR_Parse()
    104. 

  104. * Fix incorrect AES-GCM tag generation in the EVP layer
    105. 

  105. * Fix for out of bounds write with SP math all enabled and an edge case of calling sp_tohex on the result of sp_mont_norm
    106. 

  106. * Fix for parameter check in sp_rand_prime to handle 0 length values
    107. 

  107. * Fix for edge case of failing malloc resulting in an out of bounds write with SHA256/SHA512 when small stack is enabled
    108. 

  108. 

  109. 

  110. ### Improvements/Optimizations
    111. 

  111. * Added --enable-wolftpm option for easily building wolfSSL to be used with wolfTPM
    112. 

  112. * DTLS macro WOLFSSL_DTLS_RESEND_ONLY_TIMEOUT added for resending flight only after a timeout
    113. 

  113. * Update linux kernel module to use kvmalloc and kvfree
    114. 

  114. * Add user settings option to cmake build
    115. 

  115. * Added support for AES GCM session ticket encryption
    116. 

  116. * Thread protection for global RNG used by wolfSSL_RAND_bytes function calls
    117. 

  117. * Sanity check on FIPs configure flag used against the version of FIPs bundle
    118. 

  118. * --enable-aesgcm=table now is compatible with --enable-linuxkm
    119. 

  119. * Increase output buffer size that wolfSSL_RAND_bytes can handle
    120. 

  120. * Out of directory builds resolved, wolfSSL can now be built in a separate directory than the root wolfssl directory
    121. 

  121. 

  122. ### Vulnerabilities
    123. 

  123. * [HIGH] CVE-2021-3336: In earlier versions of wolfSSL there exists a potential man in the middle attack on TLS 1.3 clients. Malicious attackers with a privileged network position can impersonate TLS 1.3 servers and bypass authentication. Users that have applications with client side code and have TLS 1.3 turned on, should update to the latest version of wolfSSL. Users that do not have TLS 1.3 turned on, or that are server side only, are NOT affected by this report. For the code change see https://github.com/wolfSSL/wolfssl/pull/3676. Thanks to Aina Toky Rasoamanana and Olivier Levillain from Télécom SudParis for the report.
    124. 

  124. * [LOW] In the case of using custom ECC curves there is the potential for a crafted compressed ECC key that has a custom prime value to cause a hang when imported. This only affects applications that are loading in ECC keys with wolfSSL builds that have compressed ECC keys and custom ECC curves enabled.
    125. 

  125. * [LOW] With TLS 1.3 authenticated-only ciphers a section of the server hello could contain 16 bytes of uninitialized data when sent to the connected peer. This affects only a specific build of wolfSSL with TLS 1.3 early data enabled and using authenticated-only ciphers with TLS 1.3.
    126. 

  126. 

  127. 

  128. For additional vulnerability information visit the vulnerability page at
    129. 

  129. https://www.wolfssl.com/docs/security-vulnerabilities/
    130. 

  130. 

  131. See INSTALL file for build instructions.
    132. 

  132. More info can be found on-line at https://wolfssl.com/wolfSSL/Docs.html
    133. 

  133. 

  134. 

  135. 

  136. *** Resources ***
    137. 

  137. 

  138. 

  139. [wolfSSL Website](https://www.wolfssl.com/)
    140. 

  140. 

  141. [wolfSSL Wiki](https://github.com/wolfSSL/wolfssl/wiki)
    142. 

  142. 

  143. [FIPS FAQ](https://wolfssl.com/license/fips)
    144. 

  144. 

  145. [wolfSSL Documents](https://wolfssl.com/wolfSSL/Docs.html)
    146. 

  146. 

  147. [wolfSSL Manual](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-toc.html)
    148. 

  148. 

  149. [wolfSSL API Reference]
    150. 

  150. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-17-wolfssl-api-reference.html)
    151. 

  151. 

  152. [wolfCrypt API Reference]
    153. 

  153. (https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-18-wolfcrypt-api-reference.html)
    154. 

  154. 

  155. [TLS 1.3](https://www.wolfssl.com/docs/tls13/)
    156. 

  156. 

  157. [wolfSSL Vulnerabilities]
    158. 

  158. (https://www.wolfssl.com/docs/security-vulnerabilities/)
    159.