CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Mbed TLS documentation hub — Mbed TLS documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />  <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script data-url_root="#" id="documentation_options" src="_static/documentation_options.js?v=df4b10f6"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=4825356b"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex/" /> <link rel="search" title="Search" href="search/" /> <link rel="next" title="Getting Started" href="getting_started/" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="mbed-tls" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> Mbed TLS </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search/" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption" role="heading"><span class="caption-text">Contents</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="getting_started/">Getting Started</a></li> <li class="toctree-l1"><a class="reference external" href="https://mbed-tls.readthedocs.io/projects/api">API Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="project/">Project</a></li> <li class="toctree-l1"><a class="reference internal" href="reviews/">Reviews</a></li> <li class="toctree-l1"><a class="reference internal" href="security-advisories/">Security Advisories</a></li> <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING/">Contributing to This Documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="kb/">Knowledge Base</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">Mbed TLS</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Mbed TLS documentation hub</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.md.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="mbed-tls-documentation-hub"> <h1>Mbed TLS documentation hub<a class="headerlink" href="#mbed-tls-documentation-hub" title="Permalink to this heading"></a></h1> <p>Mbed TLS provides an open-source implementation of cryptographic primitives, X.509 certificate handling and the SSL/TLS and DTLS protocols. It provides a reference implementation of the <a class="reference external" href="https://arm-software.github.io/psa-api/crypto/">PSA Cryptography API</a>. The project also supports the PSA Cryptoprocessor Driver Interface which enables support for cryptoprocessor drivers. The small code footprint makes the project suitable for embedded systems. It has many users, including <a class="reference external" href="https://www.trustedfirmware.org/projects/tf-a/">TF-A</a>, <a class="reference external" href="https://www.trustedfirmware.org/projects/tf-m/">TF-M</a> and <a class="reference external" href="https://www.trustedfirmware.org/projects/op-tee/">OP-TEE</a>.</p> <p>This documentation is undergoing continuous improvement over time to address gaps, etc. We welcome contributions!</p> <p>For more information, see the following:</p> <ul class="simple"> <li><p><a class="reference external" href="https://github.com/Mbed-TLS/mbedtls">GitHub repository</a></p></li> <li><p><a class="reference external" href="https://github.com/Mbed-TLS/mbedtls-docs">Documentation GitHub repository</a></p></li> <li><p><a class="reference external" href="https://www.trustedfirmware.org/projects/mbed-tls/">Mbed TLS website</a></p></li> <li><p><a class="reference external" href="https://arm-software.github.io/psa-api/crypto/">PSA Crypto API specification</a></p></li> </ul> <p>For questions and discussions:</p> <ul class="simple"> <li><p><a class="reference external" href="https://lists.trustedfirmware.org/mailman3/lists/mbed-tls.lists.trustedfirmware.org/">The Mbed TLS mailing list</a>.</p></li> <li><p>The <code class="docutils literal notranslate"><span class="pre">#mbed-tls</span></code> channel on the <a class="reference external" href="https://discord.com/channels/1106321706588577904/1144310640341700739">TrustedFirmware Discord server</a> - use the <a class="reference external" href="https://discord.gg/5PpXhvda5p">invite link</a> to join.</p></li> </ul> <p>Security vulnerabilities:</p> <ul class="simple"> <li><p>Please see our <a class="reference internal" href="project/vulnerabilities/"><span class="std std-doc">process for reporting vulnerabilities</span></a>.</p></li> </ul> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Contents</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="getting_started/">Getting Started</a><ul> <li class="toctree-l2"><a class="reference internal" href="getting_started/downloading/">Downloading</a></li> <li class="toctree-l2"><a class="reference internal" href="getting_started/building/">Building</a></li> <li class="toctree-l2"><a class="reference internal" href="getting_started/psa/">Using PSA</a></li> </ul> </li> <li class="toctree-l1"><a class="reference external" href="https://mbed-tls.readthedocs.io/projects/api">API Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="project/">Project</a><ul> <li class="toctree-l2"><a class="reference internal" href="project/roadmap/">Roadmap</a></li> <li class="toctree-l2"><a class="reference internal" href="project/long-term-plans/">Long-term plans for Mbed TLS</a></li> <li class="toctree-l2"><a class="reference internal" href="project/external-trusted-reviewers/">External Trusted Reviewers</a></li> <li class="toctree-l2"><a class="reference internal" href="project/vulnerabilities/">Security Vulnerability Processes</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="reviews/">Reviews</a><ul> <li class="toctree-l2"><a class="reference internal" href="reviews/review-for-contributors/">Guidelines for Contributors</a></li> <li class="toctree-l2"><a class="reference internal" href="reviews/review_guidelines/">Guidelines for Reviewers</a></li> <li class="toctree-l2"><a class="reference internal" href="reviews/review-priorities/">PR Prioritisation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="security-advisories/">Security Advisories</a><ul> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2025-03-2/">Potential authentication bypass in TLS handshake</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2025-03-1/">TLS clients may unwittingly skip server authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-10-1/">Buffer underrun in pkwrite when writing an opaque key pair</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-08-3/">Limited authentication bypass in TLS 1.3 optional client authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-08-2/">Stack buffer overflow in ECDSA signature conversion functions</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-08-1/">CTR_DRBG prioritized over HMAC_DRBG as the PSA DRBG</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-03/">Insecure handling of shared memory in PSA Crypto APIs</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-01-2/">Buffer overflow in mbedtls_x509_set_extension()</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2024-01-1/">Timing side channel in private key RSA operations.</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2023-10-2/">Buffer overflow in TLS handshake parsing with ECDH</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2023-10-1/">Buffer overread in TLS stream cipher suites</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2022-07/">Buffer overread in DTLS ClientHello parsing</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2021-12/">Double Free in <code class="docutils literal notranslate"><span class="pre">mbedtls_ssl_set_session()</span></code> in an error case.</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2021-07-2/">Local side channel attack on static Diffie-Hellman with Montgomery curves</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2021-07-1/">Local side channel attack on RSA</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-09-3/">Protocol weakness in DHE-PSK key exchange</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-09-2/">Local side channel attack on RSA and static Diffie-Hellman</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-09-1/">Local side channel attack on classical CBC decryption in (D)TLS</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-07/">Side-channel attack on ECC key import and validation</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-04/">Side channel attack on ECDSA</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2020-02/">Cache attack against RSA key import in SGX</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2019-12/">Side channel attack on ECDSA</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2019-10/">Side channel attack on deterministic ECDSA</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2018-03/">Mbed TLS Security Advisory 2018-03</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2018-02/">Mbed TLS Security Advisory 2018-02</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2018-01/">mbed TLS Security Advisory 2018-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2017-02/">mbed TLS Security Advisory 2017-02</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2017-01/">mbed TLS Security Advisory 2017-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/mbedtls-security-advisory-2015-01/">mbed TLS Security Advisory 2015-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2014-04/">PolarSSL Security Advisory 2014-04</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2014-03-poodle-attack-on-ssl-v3/">PolarSSL Security Advisory 2014-03</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2014-02/">PolarSSL Security Advisory 2014-02</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2014-01/">PolarSSL Security Advisory 2014-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2013-05/">PolarSSL Security Advisory 2013-05</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2013-04/">PolarSSL Security Advisory 2013-04</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2013-03/">PolarSSL Security Advisory 2013-03</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2013-02/">PolarSSL Security Advisory 2013-02</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2013-01/">PolarSSL Security Advisory 2013-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2012-01/">PolarSSL Security Advisory 2012-01</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2011-02/">PolarSSL Security Advisory 2011-02</a></li> <li class="toctree-l2"><a class="reference internal" href="security-advisories/polarssl-security-advisory-2011-01/">PolarSSL Security Advisory 2011-01</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING/">Contributing to This Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="CONTRIBUTING/#making-a-contribution">Making a Contribution</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="kb/">Knowledge Base</a><ul> <li class="toctree-l2"><a class="reference internal" href="kb/attacks/">Attacks</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/compiling-and-building/">Compiling and Building</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/cryptography/">Cryptography</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/development/">Development</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/generic/">Generic</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/how-to/">How to</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/licensing/">Licensing</a></li> <li class="toctree-l2"><a class="reference internal" href="kb/testing/">Testing Mbed TLS</a></li> </ul> </li> </ul> </div> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="getting_started/" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright The Mbed TLS Contributors.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>