WolfSSL

{{Short description|Implementation of Transport Layer Security}}

{{Multiple issues|

{{COI|date=November 2020}}

{{external links|date=July 2017}}

}}

{{lowercase title}}

{{Infobox software

| name = wolfSSL

| logo =

| screenshot =

| caption =

| developer = Todd Ouska

| released = {{Start date|2006|02|19}}{{cite web |title=wolfSSL ChangeLog |url=https://www.wolfssl.com/wolfSSL/Docs-wolfssl-changelog.html}}

| latest release version = {{wikidata|property|preferred|references|edit|Q5197351|P348|P548=Q2804309}}

| latest release date = {{wikidata|qualifier|preferred|single|Q5197351|P348|P548=Q2804309|P577}}

| latest preview version = {{wikidata|property|preferred|references|edit|Q5197351|P348|P548=Q51930650}}

| latest preview date = {{wikidata|qualifier|preferred|single|Q5197351|P348|P548=Q51930650|P577}}

| operating_system = Multi-platform

| programming_language = C

| genre = Cryptography library

| license = GPL-2.0-or-later or proprietary{{cite web|url=https://github.com/wolfSSL/wolfssl/blob/master/LICENSING|title=LICENSING|website=GitHub }}

| website = {{URL|www.wolfssl.com}}

| repo = {{URL|github.com/wolfssl/wolfssl}}

}}

wolfSSL is a small, portable, embedded SSL/TLS library targeted for use by embedded systems developers. It is an open source implementation of TLS (SSL 3.0, TLS 1.0, 1.1, 1.2, 1.3, and DTLS 1.0, 1.2, and 1.3) written in the C programming language. It includes SSL/TLS client libraries and an SSL/TLS server implementation as well as support for multiple APIs, including those defined by SSL and TLS. wolfSSL also includes an OpenSSL compatibility interface with the most commonly used OpenSSL functions.[https://www.wolfssl.com/wolfSSL/Products.html wolfSSL – Embedded Communications Products]{{Cite web|url=https://www.allaboutcircuits.com/news/what-you-need-to-know-about-the-tls-1.3-protocol-and-wolfssls-ssl-tls-libra/|title=What You Need to Know About the TLS 1.3 Protocol and wolfSSL's SSL/TLS Libraries|website=www.allaboutcircuits.com|language=en|access-date=2018-12-28}}

Platforms

wolfSSL is currently available for Microsoft Windows, Linux, macOS, Solaris, ESP32, ESP8266, ThreadX, VxWorks, FreeBSD, NetBSD, OpenBSD, embedded Linux, Yocto Project, OpenEmbedded, WinCE, Haiku, OpenWrt, iPhone, Android, Wii, and GameCube through DevKitPro support, QNX, MontaVista, Tron variants, NonStop OS, OpenCL, Micrium's MicroC/OS-II, FreeRTOS, SafeRTOS, Freescale MQX, Nucleus, TinyOS, TI-RTOS, HP-UX, uTasker, uT-kernel, embOS, INtime, mbed, RIOT, CMSIS-RTOS, FROSTED, Green Hills INTEGRITY, Keil RTX, TOPPERS, PetaLinux, Apache Mynewt, and PikeOS.{{Cite web|url=https://www.wolfssl.com/products/wolfssl/|title=wolfSSL Embedded SSL/TLS Library {{!}} wolfSSL Products|language=en-US|access-date=2019-01-31}}

History

The genesis of wolfSSL dates to 2004. OpenSSL was available at the time, and was dual licensed under the OpenSSL License and the SSLeay license.[https://www.openssl.org/source/license.html OpenSSL: Source, License] yaSSL, alternatively, was developed and dual-licensed under both a commercial license and the GPL.[https://www.wolfssl.com/wolfSSL/License.html wolfSSL – License] yaSSL offered a more modern API, commercial style developer support and was complete with an OpenSSL compatibility layer. The first major user of wolfSSL/CyaSSL/yaSSL was MySQL.{{Cite web |url=http://dev.mysql.com/doc/refman/5.7/en/building-with-secure-connection-support.html |title=MySQL, Building MySQL with Support for Secure Connections |access-date=2016-06-12 |archive-date=2017-07-06 |archive-url=https://web.archive.org/web/20170706085054/https://dev.mysql.com/doc/refman/5.7/en/building-with-secure-connection-support.html |url-status=dead }} Through bundling with MySQL, yaSSL has achieved extremely high distribution volumes in the millions.

In February 2019, Daniel Stenberg, the creator of cURL, was hired by the wolfSSL project to work on cURL.[https://www.helpnetsecurity.com/2019/02/07/daniel-stemberg-joins-wolfssl/ Daniel Stenberg, founder and Chief Architect of cURL, joins wolfSSL]

Protocols

{{main|Transport Layer Security}}

The wolfSSL lightweight SSL library implements the following protocols:[https://www.wolfssl.com/wolfSSL/Docs-cyassl-manual-4-features.html wolfSSL – Docs | CyaSSL Manual – Chapter 4 (Features)]

Protocol Notes:

  • SSL 2.0 – SSL 2.0 was deprecated (prohibited) in 2011 by RFC 6176. wolfSSL does not support it.
  • SSL 3.0 – SSL 3.0 was deprecated (prohibited) in 2015 by RFC 7568. In response to the POODLE attack, SSL 3.0 has been disabled by default since wolfSSL 3.6.6, but can be enabled with a compile-time option.

[https://www.wolfssl.com/wolfSSL/Blog/Entries/2015/8/24_wolfSSL_3.6.6_is_Now_Available.html "wolfSSL 3.6.6 is Now Available"].

Algorithms

wolfSSL uses the following cryptography libraries:

=wolfCrypt=

By default, wolfSSL uses the cryptographic services provided by wolfCrypt.[https://www.wolfssl.com/wolfSSL/Docs-wolfssl-manual-10-wolfcrypt-usage-reference.html wolfSSL – Docs | wolfSSL Manual – Chapter 10 (wolfCrypt Usage Reference)] wolfCrypt Provides RSA, ECC, DSS, Diffie–Hellman, EDH, NTRU (deprecated and removed), DES, Triple DES, AES (CBC, CTR, CCM, GCM), Camellia, IDEA, ARC4, HC-128, ChaCha20, MD2, MD4, MD5, SHA-1, SHA-2, SHA-3, BLAKE2, RIPEMD-160, Poly1305, Random Number Generation, Large Integer support, base 16/64 encoding/decoding, and post-quantum cryptographic algorithms: ML-KEM (certified under FIPS 203) and ML-DSA (certified under FIPS 204).

wolfCrypt also includes support for the recent X25519 and Ed25519 algorithms.

wolfCrypt acts as a back-end crypto implementation for several popular software packages and libraries, including MIT Kerberos[http://web.mit.edu/kerberos/ Kerberos: The Network Authentication Protocol] (where it can be enabled using a build option).

=NTRU=

CyaSSL+ includes NTRU[http://securityinnovation.com/cryptolab/ NTRU CryptoLabs] {{webarchive|url=https://archive.today/20130202075746/http://securityinnovation.com/cryptolab/ |date=2013-02-02 }} public key encryption. The addition of NTRU in CyaSSL+ was a result of the partnership between yaSSL and Security Innovation. NTRU works well in mobile and embedded environments due to the reduced bit size needed to provide the same security as other public key systems. In addition, it's not known to be vulnerable to quantum attacks. Several cipher suites utilizing NTRU are available with CyaSSL+ including AES-256, RC4, and HC-128.

Hardware Integration

= Secure Element Support =

wolfSSL supports the following Secure Elements:

= Technology Support =

wolfSSL supports the following hardware technologies:

  • Intel SGX (Software Guard Extensions) [https://www.wolfssl.com/wolfssl-with-intel-sgx/ wolfSSL – wolfSSL with Intel® SGX] - Intel SGX allows a smaller attack surface and has been shown to provide a higher level of security for executing code without a significant impact on performance.

= Hardware Encryption Support =

The following tables list wolfSSL's support for using various devices' hardware encryption with various algorithms.

class="wikitable"

|+AES cipher modes

!Device

!AES-GCM

!AES-CCM

!AES-CBC

!AES-ECB

!AES-CTR

[http://www.intel.com/content/www/us/en/architecture-and-technology/advanced-encryption-standard--aes-/data-protection-aes-general-technology.html Intel AES-NI]

(Xeon and Core processor families)

|All

|All

|All

|All

|All

[https://www.nxp.com/ Freescale]

Cryptographic Accelerator and Assurance Module (CAAM)

|

|All

|All

|All

|All

[http://www.nxp.com/assets/documents/data/en/application-notes/AN2788.pdf Freescale Coldfire SEC]

(NXP MCF547X and MCF548X)

|

|

|All

|

|

[http://www.nxp.com/assets/documents/data/en/application-notes/AN4307.pdf Freescale Kinetis MMCAU]

K50, K60, K70, and K80 (ARM Cortex-M4 core)

|All

|All

|All

|All

|

STMicroelectronics STM32

F1, F2, F4, L1, W Series (ARM Cortex - M3/M4)

|

|

|All

|

|All

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|

|

|All

|

|

[http://www.microchip.com/design-centers/32-bit Microchip PIC32 MX/MZ]

(Embedded Connectivity)

|All

|

|All

|

|All

[http://www.ti.com/product/TM4C1294NCPDT Texas Instruments TM4C1294]

(ARM Cortex-M4F)

|All

|All

|All

|All

|All

[https://www.nordicsemi.com/Products/nRF51-Series-SoC Nordic NRF51] {{Webarchive|url=https://web.archive.org/web/20180619035750/https://www.nordicsemi.com/Products/nRF51-Series-SoC |date=2018-06-19 }}

(Series SoC family, 32-bit ARM Cortex M0 processor core)

|

|

|

|128-bit

|

[https://www.arm.com/files/downloads/ARMv8_Architecture.pdf ARMv8]

|All

|

|All

|

|All

[https://www.wolfssl.com/docs/intel-quickassist/ Intel QuickAssist Technology]

|All

|

|All

|

|

[https://www.wolfssl.com/nxp-kinetis-k8x-ltc-support-for-pki-rsaecc-with-tls13/ Freescale NXP LTC]

|All

|All

|All

|All

|All

[https://www.wolfssl.com/wolfssl-xilinx-support/ Xilinx Zynq UltraScale+]

|256-bit

|

|

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m3g-evaluation-kit-ra6m3-mcu-group-graphics-expansion-boards Renesas RX65N (R5F565NEHDFB)]

|All

|

|All

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/rx72n-envision-kit-rx72n-envision-kit Renesas RX72N (RTK5RX72N0C00000BJ)]

|All

|

|All

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus Renesas RX MPU (R5F571MLDDFC)]

|All

|

|All

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/renesas-synergy-platform-mcus/ysdks7g2e40-dk-s7g2-development-kit Renesas Synergy DK-S7G2]

|

|

|128-bit

|

|

- "All" denotes 128, 192, and 256-bit supported block sizes

class="wikitable"

|+DES/3DES cipher modes

!Device

!DES-CBC

!DES-ECB

!3DES-CBC

[http://www.nxp.com/assets/documents/data/en/application-notes/AN2788.pdf Freescale Coldfire SEC]

(NXP MCF547X and MCF548X)

|64 bit

|

|192 bit

[http://www.nxp.com/assets/documents/data/en/application-notes/AN4307.pdf Freescale Kinetis MMCAU]

K50, K60, K70, and K80 (ARM Cortex-M4 core)

|64 bit

|

|192 bit

STMicroelectronics STM32

F1, F2, F4, L1, W Series (ARM Cortex - M3/M4)

|64 bit

|64 bit (encrypt)

|192 bit

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|192 bit

|

|

[http://www.microchip.com/design-centers/32-bit Microchip PIC32 MX/MZ]

(Embedded Connectivity)

|64 bit

|

|192 bit

[http://www.ti.com/product/TM4C1294NCPDT Texas Instruments TM4C1294]

(ARM Cortex-M4F)

|64 bit

|

|192 bit

class="wikitable"

|+Stream ciphers

!Device

!RC4

!ChaCha20

AVX1/AVX2

(Intel and AMD x86)

|

|Supported

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|2048 bit max.

|

class="wikitable"

|+Hashing algorithm support

!Device

!MD5

!SHA1

!SHA2

!SHA-256

!SHA-384

!SHA-512

AVX1/AVX2

(Intel and AMD x86)

|

|

|

|Supported

|Supported

|Supported

[http://www.nxp.com/assets/documents/data/en/application-notes/AN4307.pdf Freescale Kinetis MMCAU]

K50, K60, K70, and K80 (ARM Cortex-M4 core)

|Supported

|Supported

|

|Supported

|

|

STMicroelectronics STM32

F1, F2, F4, L1, W Series (ARM Cortex - M3/M4)

|Supported

|Supported

|

|

|

|

[http://www.microchip.com/design-centers/32-bit Microchip PIC32 MX/MZ]

(Embedded Connectivity)

|Supported

|Supported

|

|Supported

|

|

[https://www.arm.com/files/downloads/ARMv8_Architecture.pdf ARMv8]

|

|

|

|Supported

|

|

[https://www.wolfssl.com/docs/intel-quickassist/ Intel QuickAssist Technology]

|Supported

|Supported

|Supported

|

|

|

[https://www.wolfssl.com/nxp-kinetis-k8x-ltc-support-for-pki-rsaecc-with-tls13/ Freescale NXP LTC]

|

|Supported

|

|Supported

|

|

[https://www.wolfssl.com/wolfssl-xilinx-support/ Xilinx Zynq UltraScale+]

|

|

|

|

|Supported

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/renesas-synergy-platform-mcus/ysdks7g2e40-dk-s7g2-development-kit Renesas Synergy DK-S7G2]

|

|Supported

|

|Supported

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m3g-evaluation-kit-ra6m3-mcu-group-graphics-expansion-boards Renesas RX65N (R5F565NEHDFB)]

|

|

|

|Supported

|

|Supported

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/rx72n-envision-kit-rx72n-envision-kit Renesas RX72N (RTK5RX72N0C00000BJ)]

|Supported

|

|

|Supported

|

|Supported

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus Renesas RX MPU (R5F571MLDDFC)]

|

|

|

|Supported

|Supported

|Supported

class="wikitable"

|+Key operations: generation and exchange, elliptic curve cryptography

!Device

!RSA

!ECC

!ECC-DHE

!X25519

!Ed25519

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|512–4096 bit

|NIST Prime

192, 224, 256, 384, 521

|

|

|

[http://www.microchip.com/wwwproducts/en/ATECC508A Microchip]/[http://www.atmel.com/Images/Atmel-8923S-CryptoAuth-ATECC508A-Datasheet-Summary.pdf Atmel]

ATECC508A (compatible with any MPU or MCU including: Atmel SMART and AVR MCUs)

|

|256 bit

(NIST-P256)

|

|

|

[https://www.wolfssl.com/docs/intel-quickassist/ Intel QuickAssist Technology]

|512–4096 bit

|128, 256 bit

|

|

|

[https://www.wolfssl.com/nxp-kinetis-k8x-ltc-support-for-pki-rsaecc-with-tls13/ Freescale NXP LTC]

|512 - 4096 bit

|128, 256 bit

|128, 256 bit

|256 bit

|256 bit

[https://www.wolfssl.com/wolfssl-xilinx-support/ Xilinx Zynq UltraScale+]

|2048–4096 bit

|

|

|

|

class="wikitable"

|+MAC algorithms

!Device

!HMAC-MD5

!HMAC-SHA1

!HMAC-SHA2

!HMAC-SHA256

!SHA-3

!Poly1305

AVX1/AVX2

(Intel and AMD x86)

|

|

|

|

|

|Supported

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|Supported

|Supported

|

|Supported

|Supported

|

[http://www.microchip.com/design-centers/32-bit Microchip PIC32 MX/MZ]

(Embedded Connectivity)

|Supported

|Supported

|

|Supported

|

|

[https://www.wolfssl.com/docs/intel-quickassist/ Intel QuickAssist Technology]

|

|Supported

|Supported

|

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m3g-evaluation-kit-ra6m3-mcu-group-graphics-expansion-boards Renesas RX65N (R5F565NEHDFB)]

|Supported

|

|

|Supported

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/rx72n-envision-kit-rx72n-envision-kit Renesas RX72N (RTK5RX72N0C00000BJ)]

|

|

|

|

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus Renesas RX MPU (R5F571MLDDFC)]

|Supported

|

|

|Supported

|

|

[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/renesas-synergy-platform-mcus/ysdks7g2e40-dk-s7g2-development-kit Renesas Synergy DK-S7G2]

|

|

|

|Supported

|

|

class="wikitable"

|+Random number generation

!Device

!RNG

STMicroelectronics STM32

F1, F2, F4, L1, W Series (ARM Cortex - M3/M4)

|Supported

[http://cavium.com/processor_security.html Cavium NITROX]

(III/V PX processors)

|Supported

[https://www.nordicsemi.com/Products/nRF51-Series-SoC Nordic NRF51] {{Webarchive|url=https://web.archive.org/web/20180619035750/https://www.nordicsemi.com/Products/nRF51-Series-SoC |date=2018-06-19 }}

(Series SoC family, 32-bit ARM Cortex M0 processor core)

|Supported

Certifications

wolfSSL supports the following certifications:

  • Federal Information Processing Standards (FIPS 140)
  • FIPS 140-2 and FIPS 140-3[https://www.wolfssl.com/license/fips WOLFCRYPT FIPS 140-2 and FIPS 140-3]
  • wolfCrypt FIPS Module: 3.6.0 ([https://csrc.nist.gov/Projects/cryptographic-module-validation-program/Certificate/2425 NIST certificate #2425]) - Historical
  • wolfCrypt FIPS Module: 4.0 ([https://csrc.nist.gov/Projects/cryptographic-module-validation-program/Certificate/3389 NIST certificate #3389]) - Historical
  • wolfCrypt FIPS Module: v5.2.1 ([https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/4718 NIST certificate #4718]) - Active
  • Radio Technical Commission for Aeronautics (RTCA)
  • DO-178C
  • wolfCrypt COTS DO-178C certification kit (DAL A) [https://www.wolfssl.com/wolfssl-support-178-dal/ wolfSSL Support for DO-178C DAL A]

Licensing

wolfSSL is dual licensed:

  • Licensed under the GPL-2.0-or-later license. This is good for GPL open source projects and evaluation.
  • Licensed under a commercial non-GPL license. This comes with additional support and maintenance packages and is priced at 6,000 USD per product or SKU as of 2022.

See also

References

{{Reflist|30em}}