Documentation

Browsing the source code

In order to get a better understanding of how some parts of PolarSSL operate and to provide easy access to parts of the library, all source codes are browsable online from the Source Code page.

PolarSSL Tutorial

The PolarSSL Tutorial shows how to modify an application to integrate with the PolarSSL SSL/TLS stack. This generic tutorial steps through the motions of adapting an existing application and highlights the changes that should be made.

High Level Design document

For better understanding the internal structure of the PolarSSL library, the High Level Design document contains descriptions of the external environment the software runs on, an overview of its components and some example scenarios. It thus forms an overview of the separate module level designs, but also includes some system-level information about its use and platform.

PolarSSL API documentation

The entire source code of the PolarSSL library is documented with Doxygen. The resulting descriptions can be found in the API documentation.

How to build PolarSSL

PolarSSL supports a number of different build platforms for UNIX and Windows environments. The instructions for using the build environments is available on the How to build PolarSSL page.

Frequently Asked Questions

If you have a question, please look at the FrequentlyAskedQuestions page to see if it was already answered for you!

Reference documents

Almost all of the cryptographic and SSL/TLS related parts are based on public standards and other publicly available information. An overview of the used references is on the Reference documents page.

Security Advisories

All security related information is released on the Security page. This page also contains links to all released advisories.