DOCUMENTATION

Welcome to the wolfSSL product documentation. Please use the following resources to help answer any questions you might have, or use it as a starting place for learning how you can implement and use our products.  If you have any questions that are unanswered here, please view our Frequently Asked Questions (FAQ), contact us, or reach out to our support team.

Many of the sub-documents below are contained in the comprehensive wolfSSL Manual.

If you would like more detailed information about RAM (stack/heap) usage, please contact us for the wolfSSL Resource Use document.

Need FIPS 140-2 / FIPS 140-3? wolfCrypt has been FIPS 140-2 Level 1 validated twice, and is on the NIST Modules in Process List for FIPS 140-3 Level 1.  Visit our FIPS page for more information.

Featured

Edit
wolfSSL FAQSome of the most common issues and questions that are received by our wolfSSL security experts, along with their responses.
wolfCrypt FIPS 140-2/3 FAQFrequently Asked Questions about the FIPS 140-2 validated version of wolfCrypt.
DO-178C DAL ALearn about DO-178C DAL A certification, and how wolfSSL offers support for complete certification
TLS 1.3 Usage and InformationLearn about TLS 1.3 and how to use it with wolfSSL!
SSL/TLS TutorialA step-by-step tutorial on adding SSL and TLS to a simple application using wolfSSL.
wolfSSL / wolfCrypt BenchmarksExisting library benchmarks, benchmark application usage
wolfSSL Quickstart GuideQuickstart to getting up and running with wolfSSL on a desktop system
wolfSSL Porting GuideTips and guidance on porting wolfSSL to new platforms and environments.
Implementing Hardware Cryptographic SupportGuide on how to add support for cryptographic offloading to hardware using wolfCrypt.
Best Practices for Embedded DevicesPractices to keep in mind when using SSL/TLS in an embedded environment.
wolfSSL Tuning GuideTips on optimizing wolfSSL for footprint size or performance

wolfSSL and wolfCrypt Libraries

Edit
wolfSSL ManualBuilding wolfSSL, Getting Started, API Reference, Features, etc.
wolfSSL Manual PDFwolfSSL Manual, PDF format.
wolfSSL API ReferenceAPI reference for the wolfSSL embedded SSL/TLS library
wolfCrypt API ReferenceAPI reference for the wolfCrypt encryption library
wolfSSL FAQSome of the most common issues and questions that are received by our wolfSSL security experts, along with their responses.
wolfSSL FIPS Ready User GuideUser guide for building on and using wolfSSL FIPS Ready.
wolfSSL Renesas SupportDetails on wolfSSL support for both the Renesas CS+ and e2studio development environments
wolfSSL Renesas TSIP SupportDetails on wolfSSL support Renesas TSIP driver.
wolfSSL Espressif SupportwolfSSL provides support for use with the Espressif IoT Development Framework (ESP-IDF)
wolfSSL NXP SupportwolfSSL has support for NXP.
wolfSSL STM32 SupportwolfSSL has support for ST platforms and hardware crypto.
wolfSSL PIC32 SupportwolfSSL has support for Microchip PIC32.
wolfSSL Texas Instruments SupportwolfSSL has support for Texas Instruments and TI-RTOS.
wolfSSL for Keil MDK-ARMGetting started using wolfSSL with Keil MDK-ARM
wolfSSL with Visual StudioGetting started using wolfSSL in Visual Studio on Windows
wolfSSL with uTaskerGetting started using wolfSSL for uTasker
wolfSSL Atmel ATECC508A/608AUsing wolfSSL and wolfCrypt with Atmel ATECC508A/608A
Asynchronous with Intel QuickAssistwolfSSL / wolfCrypt async support with Intel QuickAssist
wolfSSL Hardware Cryptography SupportList of Hardware Acceleration/Cryptography Supported by wolfSSL
wolfSSL Static Buffer AllocationDocumentation and User Guide for wolfSSL's Static Buffer Allocation Option
wolfSSL Application Binary CompatibilityList of a subset of wolfSSL ABI that will be compatible across all releases of wolfSSL

wolfSSH Library

Edit
wolfSSH ManualBuilding and using wolfSSH
wolfSSH Manual PDFwolfSSH Manual, PDF format.
Building wolfSSH on WindowsBuilding the wolfSSH library on Windows devices using Visual Studio

wolfMQTT Library

Edit
wolfMQTT ManualwolfMQTT Client Library Manual
wolfMQTT Manual PDFwolfMQTT Manual, PDF format.

wolfTPM Library

Edit
wolfTPM ManualwolfTPM TPM 2.0 Library Manual
wolfTPM Manual PDFwolfTPM Manual, PDF format.

wolfBoot Secure Bootloader

Edit
wolfBoot ManualwolfBoot Secure Bootloader Manual
wolfBoot Manual PDFwolfBoot Manual, PDF format.

wolfSentry Embedded IDPS

Edit
wolfSentry ManualwolfSentry Embedded IDPS Manual
wolfSentry Manual PDFwolfSentry Manual, PDF format.

wolfEngine OpenSSL Engine

Edit
wolfEngine ManualwolfEngine Library Manual
wolfEngine Manual PDFwolfEngine Manual, PDF format.

wolfSSL JNI / JSSE Provider

Edit
wolfSSL Java JSSE Provider ManualwolfSSL Java JSSE Provider Manual
wolfSSL Java JSSE Provider PDF ManualwolfSSL JNI/JSSE Manual, PDF format.
Installing a JSSE Provider in AndroidHow to install a Java JSSE Provider, and wolfJSSE, into Android OSP.
wolfSSL JNI ManualBuilding and using the wolfSSL JNI wrapper
JNI API DocumentationJavadocs for wolfSSL JNI

wolfCrypt JNI / JCE Provider

Edit
wolfCrypt JNI/JCE ManualUsing wolfCrypt JNI wrapper and wolfCrypt JCE Provider
wolfCrypt JNI/JCE Manual PDFwolfCrypt JNI/JCE Manual, PDF format.
Javadocs API DocumentationJavadocs for wolfCrypt JNI/JCE

wolfCLU Command Line Utility

Edit
wolfCLU ManualwolfCLU Command Line Utility Manual
wolfCLU Manual PDFwolfCLU Manual, PDF format.

wolfSSL C# Wrapper

Edit
wolfSSL C# ManualBuilding and using the wolfSSL C# wrapper
C# API DocumentationAPI docs for wolfSSL C# wrapper

Miscellaneous

Edit
Choosing the Correct TechnologyChoosing the correct wolfSSL technology for your needs
wolfSSL vs. OpenSSLCurious how wolfSSL and OpenSSL compare?
SSL Library OverviewPurpose and overview of SSL as a library
MIT Kerberos: Java GSS-API WrapperJava GSS-API interface to the MIT Kerberos library, created for use with Android NDK applications.
MIT Kerberos: Android NDK Example AppExample Android NDK application using the above Java GSS-API interface to the MIT Kerberos libraries.
wolfSSL Getting Started for Yocto and OpenEmbeddedGetting started guide for using wolfSSL products and examples in Yocto and OpenEmbedded Projects.
Guide to OpenEmbedded and Yocto ProjectBasic guide to writing a bitbake recipe for OpenEmbedded and Yocto Projects.

Reference

Edit
Algorithm and Protocol ReferenceRFC’s, algorithms, and protocols used in the wolfSSL embedded SSL products.
Media and PressPress kit, presentations, papers, videos and photos of wolfSSL products and events.
Case StudieswolfSSL Case Studies