libmbedtls/mbedtls/README.md

1 README for Mbed TLS
4 …nd the SSL/TLS and DTLS protocols. Its small code footprint makes it suitable for embedded systems.
6 …[PSA Cryptography API](#psa-cryptography-api). This is currently a preview for evaluation purposes…
11 …ogrammatic way using the Python 3 script `scripts/config.py` (use `--help` for usage instructions).
22 Documentation for the PSA Cryptography API is available [on GitHub](https://arm-software.github.io/…
30 For other sources of documentation, see the [SUPPORT](SUPPORT.md) document.
41 The main systems used for development are CMake and GNU Make. Those systems are always complete and…
43 …to. As a result, some linkers will expect flags to be in a specific order, for example the GNU lin…
67 * Perl, for some library source files and for Visual Studio build files.
68 * Python 3.8 and some Python packages, for some library source files, sample programs and test data…
73 * A C compiler for the host platform, for some test data.
75 If you are cross-compiling, you must set the `CC` environment variable to a C compiler for the host…
107 …for a Windows platform, you should use `WINDOWS_BUILD=1` if the target is Windows but the build en…
109 …ridden separately using `WARNING_CFLAGS`. Some directory-specific options (for example, `-I` direc…
111 …ting `CFLAGS=-O2 -Werror` for example. Setting `WARNING_CFLAGS` is useful when you want to get rid…
113 …for options to manually add or remove for specific platforms. You can also check [the Mbed TLS Kno…
137 To configure CMake for building shared libraries, use:
141 …d modes available within the CMake buildsystem. Most of them are available for gcc and clang, thou…
146 …for memory errors. (This includes LeakSanitizer, with recent version of gcc and clang.) (With rece…
148 -   `MemSan`. This instruments the code with MemorySanitizer to check for uninitialised memory read…
152 Switching build modes in CMake is simple. For debug mode, enter at the command line:
163 These variables need to be adjusted when invoking cmake for the first time,
164 for example:
195 Mbed TLS provides a package config file for consumption as a dependency in other
228 The build files for Microsoft Visual Studio are generated for Visual Studio 2017.
237 We've included example programs for a lot of different features and uses in [`programs/`](programs/…
245 For machines with a Unix shell and OpenSSL (and optionally GnuTLS) installed, additional test scrip…
247 -   `tests/ssl-opt.sh` runs integration tests for various TLS options (renegotiation, resumption, e…
253 Instead of manually installing the required versions of all tools required for testing, it is possi…
285 …al memory, which allows the library to be implemented in an isolated space for additional security…
286 …allows substituting alternative implementations at build time or run time, for example, in order t…
287 * All access to the keys happens through key identifiers, which allows support for external cryptop…
298 …for most operations. To enable this support, activate the compilation option `MBEDTLS_USE_PSA_CRYP…
302 …for cryptographic accelerators, secure elements and random generators. This is work in progress. P…
304 Please see the [PSA driver example and guide](docs/psa-driver-example-and-guide.md) for information…
306 …l generally want to enable two compilation options (see the reference manual for more information):
309 …he code of the corresponding software implementation. This is not yet supported for all mechanisms.
314 …for the full text of these licenses, and [the 'License and Copyright' section in the contributing …
326 …m the community. Please see the [contributing guidelines](CONTRIBUTING.md) for details on how to d…
331 …y in Mbed TLS, please email <mbed-tls-security@lists.trustedfirmware.org>. For more information, s…
333 * Please see [`SUPPORT.md`](SUPPORT.md) for other channels for discussion and support about Mbed TL…