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 post to our Support Forums.
Many of the sub-documents below are contained in the comprehensive wolfSSL Manual, available for download below. The wolfSSL manual is available in both HTML and PDF formats.
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? wolfSSL has you covered with our wolfCrypt library. wolfCrypt has been FIPS 140-2 Level 1 validated (Certificate #2425 and Certificate #3389). Visit our FIPS FAQ for more information.
Additionally, the documentation for wolfSSL's software API is generated with Doxygen, a useful tool licensed under the GNU General Public License. (Doxygen homepage: http://www.doxygen.nl)
FEATURED
| wolfSSL Manual | Building wolfSSL, Getting Started, API Reference, Features, etc. |
| wolfSSL FAQ | Some of the most common issues and questions that are received by our wolfSSL security experts, along with their responses. |
| FIPS 140-2 FAQ | Frequently Asked Questions about the FIPS 140-2 validated version of wolfCrypt. |
| TLS 1.3 Usage and Information | Learn about TLS 1.3 and how to use it with wolfSSL! |
| SSL Tutorial | A step-by-step tutorial on adding SSL and TLS to a simple application using wolfSSL. |
| wolfSSL API Reference | API reference for the wolfSSL embedded SSL/TLS library |
| wolfCrypt API Reference | API reference for the wolfCrypt encryption library |
| wolfSSL / wolfCrypt Benchmarks | Existing library benchmarks, benchmark application usage |
| wolfSSL Quickstart Guide | Quickstart to getting up and running with wolfSSL on a desktop system |
| wolfMQTT User Manual | wolfMQTT client library user manual |
| wolfSSL Porting Guide | Tips and guidance on porting wolfSSL to new platforms and environments. |
| Implementing Hardware Cryptographic Support | Guide on how to add support for cryptographic offloading to hardware using wolfCrypt. |
| Best Practices for Embedded Devices | Practices to keep in mind when using SSL/TLS in an embedded environment. |
| wolfSSL Tuning Guide | Tips on optimizing wolfSSL for footprint size or performance |
| wolfSSH User Manual | wolfSSH embedded library user manual |
TECHNICAL DOCUMENTATION
|
wolfSSL/wolfCrypt
|
|
| wolfSSL Manual | Building wolfSSL, Getting Started, API Reference, Features, etc. |
| wolfSSL Renesas Support | Details on wolfSSL support for both the Renesas CS+ and e2studio development environments |
| wolfSSL Renesas TSIP Support | Details on wolfSSL support Renesas TSIP driver. |
| wolfSSL Espressif Support | wolfSSL provides support for use with the Espressif IoT Development Framework (ESP-IDF) |
| wolfSSL NXP Support | wolfSSL has support for NXP. |
| wolfSSL STM32 Support | wolfSSL has support for STM32F2 hardware crypto and RNG. |
| wolfSSL PIC32 Support | wolfSSL has support for Microchip PIC32. |
| wolfSSL Texas Instruments Support | wolfSSL has support for Texas Instruments and TI-RTOS. |
| wolfSSL for Keil MDK-ARM | Getting started using wolfSSL with Keil MDK-ARM |
| wolfSSL with Visual Studio | Getting started using wolfSSL in Visual Studio on Windows |
| wolfSSL with uTasker | Getting started using wolfSSL for uTasker |
| wolfSSL Atmel ATECC508A | Using wolfSSL and wolfCrypt with Atmel ATECC508A |
| Asynchronous with Intel QuickAssist | wolfSSL / wolfCrypt async support with Intel QuickAssist |
| wolfSSL Hardware Cryptography Support | List of Hardware Acceleration/Cryptography Supported by wolfSSL |
| wolfSSL Static Buffer Allocation | Documentation and User Guide for wolfSSL's Static Buffer Allocation Option |
|
wolfSSH
|
|
| wolfSSH User Manual | Building and using wolfSSH |
| Building wolfSSH on Windows | Building the wolfSSH library on Windows devices using Visual Studio |
|
wolfSSL JNI
|
|
| wolfSSL JNI Manual | Building and using the wolfSSL JNI wrapper |
| JNI API Documentation | Javadocs for wolfSSL JNI |
|
wolfSSL JNI and JCE Provider
|
|
| wolfCrypt JNI/JCE User Manual | Using wolfCrypt JNI wrapper and wolfCrypt JCE Provider |
|
wolfSSL C#
|
|
| wolfSSL C# Manual | Building and using the wolfSSL C# wrapper |
| C# API Documentation | API docs for wolfSSL C# wrapper |
|
yaSSL / TaoCrypt
|
|
| yaSSL Architecture and Design | Cryptography, TCP/IP, Certificates, Input/Output, Threads, Memory Usage |
| yaSSL API Reference | TaoCrypt and yaSSL API Reference |
MISCELLANEOUS
| Choosing the Correct Technology | Choosing the correct wolfSSL technology for your needs |
| wolfSSL vs. OpenSSL | Curious how wolfSSL and OpenSSL compare? |
| SSL Library Overview | Purpose and overview of SSL as a library |
| MIT Kerberos: Java GSS-API Wrapper | Java GSS-API interface to the MIT Kerberos library, created for use with Android NDK applications. |
| MIT Kerberos: Android NDK Example App | Example Android NDK application using the above Java GSS-API interface to the MIT Kerberos libraries. |
| wolfSSL Getting Started for Yocto and OpenEmbedded | Getting started guide for using wolfSSL products and examples in Yocto and OpenEmbedded Projects. |
| Guide to OpenEmbedded and Yocto Project | Basic guide to writing a bitbake recipe for OpenEmbedded and Yocto Projects. |
REFERENCE
| Algorithm and Protocol Reference | RFC’s, algorithms, and protocols used in the wolfSSL embedded SSL products. |
| Media and Press | Press kit, presentations, papers, videos and photos of wolfSSL products and events. |
| Case Studies | wolfSSL Case Studies |