mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-11-30 02:34:20 +01:00
825ebd483f
Conflicts:
mbedtls.doxyfile - PROJECT_NAME - mbed TLS v2.16.6 chosen.
doc_mainpage.h - mbed TLS v2.16.6 version chosen.
hmac_drbg.h - line 260, extended description chosen.
- line 313, extended description chosen.
- line 338, extended description chosen.
version.h - 2.16.6 chosen.
CMakeLists.txt - 2.16.6 chosen.
test_suite_version.data - 2.16.6 chosen.
Makefile - 141 - manual correction - baremetal version of C_SOURCE_FILES
with variables for directories plus 2.16.6 CTAGS addition.
pkparse.c - lines 846 onwards - the asn1_get_nonzero_mpi implementation chosen.
ssl_tls.c - line 5269 - edited manually, left the ret=0, because baremetal has
a different behaviour since commit 87b5626, but added a debug
message that's new in 2.16.6.
all.sh:
- component_build_deprecated - chosen the refactored version from 2.16.6,
but with extra flags from baremetal.
- rest of the _no_xxx tests - merged make options to have PTHREAD=1 and
other changes from 2.16.6 (like -O1 instead of -O0).
- component_build_arm_none_eabi_gcc_no_64bit_multiplication - added
TINYCRYPT_BUILD=0 to the 2.16.6 version of make.
x509/req_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/crl_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/cert_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_mail_client.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_pthread_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_fork_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client1.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client2.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
- line 132 - new options of both branches added.
- skip close notify handled as in 2.16.6, but with `ssl` instead of `&ssl`.
- Merged the 2.16.6 usage split with additional baremetal usages.
- Merged options from baremetal and 2.16.6.
ssl_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_server2.c - Merged the 2.16.6 usage split with additional baremetal usages.
config.pl - fixed missing defines from the documentation, removed duplicates,
and reorganised so that the documentation and excluded list
are ordered in the same way.
test_suite_x509parse.data - only added the two new pathlen tests.
x509_crt.c - change the return code by removing
MBEDTLS_ERR_X509_INVALID_EXTENSIONS, since it's added by
x509_crt_frame_parse_ext not by an "or", but by "+=".
Changelog - Assigned all entries to appropriate sections.
ssl-opt.sh - line 8263 - merged options.
- removed lines 1165 - 1176 - there was a duplicate test, probably
an artifact of previous merges.
check-files.py - sticked to old formatting.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
181 lines
11 KiB
Markdown
181 lines
11 KiB
Markdown
README for Mbed TLS
|
|
===================
|
|
|
|
Mbed TLS is a C library that implements cryptographic primitives, X.509 certificate manipulation and the SSL/TLS and DTLS protocols. Its small code footprint makes it suitable for embedded systems.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
Mbed TLS should build out of the box on most systems. Some platform specific options are available in the fully documented configuration file `include/mbedtls/config.h`, which is also the place where features can be selected. This file can be edited manually, or in a more programmatic way using the Perl script `scripts/config.pl` (use `--help` for usage instructions).
|
|
|
|
Compiler options can be set using conventional environment variables such as `CC` and `CFLAGS` when using the Make and CMake build system (see below).
|
|
|
|
Compiling
|
|
---------
|
|
|
|
There are currently three active build systems used within Mbed TLS releases:
|
|
|
|
- GNU Make
|
|
- CMake
|
|
- Microsoft Visual Studio (Microsoft Visual Studio 2010 or later)
|
|
|
|
The main systems used for development are CMake and GNU Make. Those systems are always complete and up-to-date. The others should reflect all changes present in the CMake and Make build system, although features may not be ported there automatically.
|
|
|
|
The Make and CMake build systems create three libraries: libmbedcrypto, libmbedx509, and libmbedtls. Note that libmbedtls depends on libmbedx509 and libmbedcrypto, and libmbedx509 depends on libmbedcrypto. As a result, some linkers will expect flags to be in a specific order, for example the GNU linker wants `-lmbedtls -lmbedx509 -lmbedcrypto`. Also, when loading shared libraries using dlopen(), you'll need to load libmbedcrypto first, then libmbedx509, before you can load libmbedtls.
|
|
|
|
### Make
|
|
|
|
We require GNU Make. To build the library and the sample programs, GNU Make and a C compiler are sufficient. Some of the more advanced build targets require some Unix/Linux tools.
|
|
|
|
We intentionally only use a minimum of functionality in the makefiles in order to keep them as simple and independent of different toolchains as possible, to allow users to more easily move between different platforms. Users who need more features are recommended to use CMake.
|
|
|
|
In order to build from the source code using GNU Make, just enter at the command line:
|
|
|
|
make
|
|
|
|
In order to run the tests, enter:
|
|
|
|
make check
|
|
|
|
The tests need Python to be built and Perl to be run. If you don't have one of them installed, you can skip building the tests with:
|
|
|
|
make no_test
|
|
|
|
You'll still be able to run a much smaller set of tests with:
|
|
|
|
programs/test/selftest
|
|
|
|
In order to build for a Windows platform, you should use `WINDOWS_BUILD=1` if the target is Windows but the build environment is Unix-like (for instance when cross-compiling, or compiling from an MSYS shell), and `WINDOWS=1` if the build environment is a Windows shell (for instance using mingw32-make) (in that case some targets will not be available).
|
|
|
|
Setting the variable `SHARED` in your environment will build shared libraries in addition to the static libraries. Setting `DEBUG` gives you a debug build. You can override `CFLAGS` and `LDFLAGS` by setting them in your environment or on the make command line; compiler warning options may be overridden separately using `WARNING_CFLAGS`. Some directory-specific options (for example, `-I` directives) are still preserved.
|
|
|
|
Please note that setting `CFLAGS` overrides its default value of `-O2` and setting `WARNING_CFLAGS` overrides its default value (starting with `-Wall -W`), so if you just want to add some warning options to the default ones, you can do so by setting `CFLAGS=-O2 -Werror` for example. Setting `WARNING_CFLAGS` is useful when you want to get rid of its default content (for example because your compiler doesn't accept `-Wall` as an option). Directory-specific options cannot be overridden from the command line.
|
|
|
|
Depending on your platform, you might run into some issues. Please check the Makefiles in `library/`, `programs/` and `tests/` for options to manually add or remove for specific platforms. You can also check [the Mbed TLS Knowledge Base](https://tls.mbed.org/kb) for articles on your platform or issue.
|
|
|
|
In case you find that you need to do something else as well, please let us know what, so we can add it to the [Mbed TLS Knowledge Base](https://tls.mbed.org/kb).
|
|
|
|
### CMake
|
|
|
|
In order to build the source using CMake in a separate directory (recommended), just enter at the command line:
|
|
|
|
mkdir /path/to/build_dir && cd /path/to/build_dir
|
|
cmake /path/to/mbedtls_source
|
|
make
|
|
|
|
In order to run the tests, enter:
|
|
|
|
make test
|
|
|
|
The test suites need Python to be built and Perl to be executed. If you don't have one of these installed, you'll want to disable the test suites with:
|
|
|
|
cmake -DENABLE_TESTING=Off /path/to/mbedtls_source
|
|
|
|
If you disabled the test suites, but kept the programs enabled, you can still run a much smaller set of tests with:
|
|
|
|
programs/test/selftest
|
|
|
|
To configure CMake for building shared libraries, use:
|
|
|
|
cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On /path/to/mbedtls_source
|
|
|
|
There are many different build modes available within the CMake buildsystem. Most of them are available for gcc and clang, though some are compiler-specific:
|
|
|
|
- `Release`. This generates the default code without any unnecessary information in the binary files.
|
|
- `Debug`. This generates debug information and disables optimization of the code.
|
|
- `Coverage`. This generates code coverage information in addition to debug information.
|
|
- `ASan`. This instruments the code with AddressSanitizer to check for memory errors. (This includes LeakSanitizer, with recent version of gcc and clang.) (With recent version of clang, this mode also instruments the code with UndefinedSanitizer to check for undefined behaviour.)
|
|
- `ASanDbg`. Same as ASan but slower, with debug information and better stack traces.
|
|
- `MemSan`. This instruments the code with MemorySanitizer to check for uninitialised memory reads. Experimental, needs recent clang on Linux/x86\_64.
|
|
- `MemSanDbg`. Same as MemSan but slower, with debug information, better stack traces and origin tracking.
|
|
- `Check`. This activates the compiler warnings that depend on optimization and treats all warnings as errors.
|
|
|
|
Switching build modes in CMake is simple. For debug mode, enter at the command line:
|
|
|
|
cmake -D CMAKE_BUILD_TYPE=Debug /path/to/mbedtls_source
|
|
|
|
To list other available CMake options, use:
|
|
|
|
cmake -LH
|
|
|
|
Note that, with CMake, you can't adjust the compiler or its flags after the
|
|
initial invocation of cmake. This means that `CC=your_cc make` and `make
|
|
CC=your_cc` will *not* work (similarly with `CFLAGS` and other variables).
|
|
These variables need to be adjusted when invoking cmake for the first time,
|
|
for example:
|
|
|
|
CC=your_cc cmake /path/to/mbedtls_source
|
|
|
|
If you already invoked cmake and want to change those settings, you need to
|
|
remove the build directory and create it again.
|
|
|
|
Note that it is possible to build in-place; this will however overwrite the
|
|
provided Makefiles (see `scripts/tmp_ignore_makefiles.sh` if you want to
|
|
prevent `git status` from showing them as modified). In order to do so, from
|
|
the Mbed TLS source directory, use:
|
|
|
|
cmake .
|
|
make
|
|
|
|
If you want to change `CC` or `CFLAGS` afterwards, you will need to remove the
|
|
CMake cache. This can be done with the following command using GNU find:
|
|
|
|
find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
|
|
|
|
You can now make the desired change:
|
|
|
|
CC=your_cc cmake .
|
|
make
|
|
|
|
Regarding variables, also note that if you set CFLAGS when invoking cmake,
|
|
your value of CFLAGS doesn't override the content provided by cmake (depending
|
|
on the build mode as seen above), it's merely prepended to it.
|
|
|
|
### Microsoft Visual Studio
|
|
|
|
The build files for Microsoft Visual Studio are generated for Visual Studio 2010.
|
|
|
|
The solution file `mbedTLS.sln` contains all the basic projects needed to build the library and all the programs. The files in tests are not generated and compiled, as these need Python and perl environments as well. However, the selftest program in `programs/test/` is still available.
|
|
|
|
Example programs
|
|
----------------
|
|
|
|
We've included example programs for a lot of different features and uses in [`programs/`](programs/README.md). Most programs only focus on a single feature or usage scenario, so keep that in mind when copying parts of the code.
|
|
|
|
Tests
|
|
-----
|
|
|
|
Mbed TLS includes an elaborate test suite in `tests/` that initially requires Python to generate the tests files (e.g. `test\_suite\_mpi.c`). These files are generated from a `function file` (e.g. `suites/test\_suite\_mpi.function`) and a `data file` (e.g. `suites/test\_suite\_mpi.data`). The `function file` contains the test functions. The `data file` contains the test cases, specified as parameters that will be passed to the test function.
|
|
|
|
For machines with a Unix shell and OpenSSL (and optionally GnuTLS) installed, additional test scripts are available:
|
|
|
|
- `tests/ssl-opt.sh` runs integration tests for various TLS options (renegotiation, resumption, etc.) and tests interoperability of these options with other implementations.
|
|
- `tests/compat.sh` tests interoperability of every ciphersuite with other implementations.
|
|
- `tests/scripts/test-ref-configs.pl` test builds in various reduced configurations.
|
|
- `tests/scripts/key-exchanges.pl` test builds in configurations with a single key exchange enabled
|
|
- `tests/scripts/all.sh` runs a combination of the above tests, plus some more, with various build options (such as ASan, full `config.h`, etc).
|
|
|
|
Configurations
|
|
--------------
|
|
|
|
We provide some non-standard configurations focused on specific use cases in the `configs/` directory. You can read more about those in `configs/README.txt`
|
|
|
|
Porting Mbed TLS
|
|
----------------
|
|
|
|
Mbed TLS can be ported to many different architectures, OS's and platforms. Before starting a port, you may find the following Knowledge Base articles useful:
|
|
|
|
- [Porting Mbed TLS to a new environment or OS](https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS)
|
|
- [What external dependencies does Mbed TLS rely on?](https://tls.mbed.org/kb/development/what-external-dependencies-does-mbedtls-rely-on)
|
|
- [How do I configure Mbed TLS](https://tls.mbed.org/kb/compiling-and-building/how-do-i-configure-mbedtls)
|
|
|
|
License
|
|
-------
|
|
|
|
Unless specifically indicated otherwise in a file, Mbed TLS files are provided under the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license. See [here](./apache-2.0.txt) for the full text of this license. Contributors must accept that their contributions are made under both the Apache-2.0 AND [GPL-2.0-or-later](https://spdx.org/licenses/GPL-2.0-or-later.html) licenses. This enables LTS (Long Term Support) branches of the software to be provided under either the Apache-2.0 OR GPL-2.0-or-later licenses.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
We gratefully accept bug reports and contributions from the community. Please see the [contributing guidelines](CONTRIBUTING.md) for details on how to do this.
|