Mark Radbourne / Mbed 2 deprecated iothub_client_sample_amqp

Demo using MBED TLS

Dependencies:   EthernetInterface NTPClient iothub_amqp_transport iothub_client mbed-rtos mbed

Fork of iothub_client_sample_amqp by Azure IoT

mbedtls/README.md@58:f50b97b08851, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:20:03 2017 +0000
Revision:
58:f50b97b08851
Sample using MBED TLS

Who changed what in which revision?

UserRevisionLine numberNew contents of line
markrad 58:f50b97b08851 1 README for mbed TLS
markrad 58:f50b97b08851 2 ===================
markrad 58:f50b97b08851 3
markrad 58:f50b97b08851 4 Configuration
markrad 58:f50b97b08851 5 -------------
markrad 58:f50b97b08851 6
markrad 58:f50b97b08851 7 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).
markrad 58:f50b97b08851 8
markrad 58:f50b97b08851 9 Compiler options can be set using conventional environment variables such as `CC` and `CFLAGS` when using the Make and CMake build system (see below).
markrad 58:f50b97b08851 10
markrad 58:f50b97b08851 11 Compiling
markrad 58:f50b97b08851 12 ---------
markrad 58:f50b97b08851 13
markrad 58:f50b97b08851 14 There are currently four active build systems used within mbed TLS releases:
markrad 58:f50b97b08851 15
markrad 58:f50b97b08851 16 - yotta
markrad 58:f50b97b08851 17 - Make
markrad 58:f50b97b08851 18 - CMake
markrad 58:f50b97b08851 19 - Microsoft Visual Studio (Visual Studio 6 and Visual Studio 2010)
markrad 58:f50b97b08851 20
markrad 58:f50b97b08851 21 The main systems used for development are CMake and 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.
markrad 58:f50b97b08851 22
markrad 58:f50b97b08851 23 Yotta, as a build system, is slightly different from the other build systems:
markrad 58:f50b97b08851 24
markrad 58:f50b97b08851 25 - it provides a minimalistic configuration file by default
markrad 58:f50b97b08851 26 - depending on the yotta target, features of mbed OS may be used in examples and tests
markrad 58:f50b97b08851 27
markrad 58:f50b97b08851 28 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.
markrad 58:f50b97b08851 29
markrad 58:f50b97b08851 30 ### Yotta
markrad 58:f50b97b08851 31
markrad 58:f50b97b08851 32 [yotta](http://yottabuild.org) is a package manager and build system developed by mbed, and is the build system of mbed OS 16.03. To install it on your platform, please follow the yotta [installation instructions](http://docs.yottabuild.org/#installing).
markrad 58:f50b97b08851 33
markrad 58:f50b97b08851 34 Once yotta is installed, you can use it to download the latest version of mbed TLS from the yotta registry with:
markrad 58:f50b97b08851 35
markrad 58:f50b97b08851 36 yotta install mbedtls
markrad 58:f50b97b08851 37
markrad 58:f50b97b08851 38 and build it with:
markrad 58:f50b97b08851 39
markrad 58:f50b97b08851 40 yotta build
markrad 58:f50b97b08851 41
markrad 58:f50b97b08851 42 If, on the other hand, you already have a copy of mbed TLS from a source other than the yotta registry, for example from cloning our GitHub repository, or from downloading a tarball of the standalone edition, then you'll first need to generate the yotta module by running:
markrad 58:f50b97b08851 43
markrad 58:f50b97b08851 44 yotta/create-module.sh
markrad 58:f50b97b08851 45
markrad 58:f50b97b08851 46 This should be executed from the root mbed TLS project directory. This will create the yotta module in the `yotta/module` directory within it. You can then change to that directory and build as usual:
markrad 58:f50b97b08851 47
markrad 58:f50b97b08851 48 cd yotta/module
markrad 58:f50b97b08851 49 yotta build
markrad 58:f50b97b08851 50
markrad 58:f50b97b08851 51 In any case, you'll probably want to set the yotta target before building unless it has already been set globally. For more information on using yotta, please consult the [yotta documentation](http://docs.yottabuild.org/).
markrad 58:f50b97b08851 52
markrad 58:f50b97b08851 53 For more details on the yotta/mbed OS edition of mbed TLS, including example programs, please consult the [Readme at the root of the yotta module](https://github.com/ARMmbed/mbedtls/blob/development/yotta/data/README.md).
markrad 58:f50b97b08851 54
markrad 58:f50b97b08851 55 ### Make
markrad 58:f50b97b08851 56
markrad 58:f50b97b08851 57 We intentionally only use the minimum of `Make` functionality, as a lot of `Make` features are not supported on all different implementations of Make or on different platforms. As such, the Makefiles sometimes require some manual changes or export statements in order to work for your platform.
markrad 58:f50b97b08851 58
markrad 58:f50b97b08851 59 In order to build from the source code using Make, just enter at the command line:
markrad 58:f50b97b08851 60
markrad 58:f50b97b08851 61 make
markrad 58:f50b97b08851 62
markrad 58:f50b97b08851 63 In order to run the tests, enter:
markrad 58:f50b97b08851 64
markrad 58:f50b97b08851 65 make check
markrad 58:f50b97b08851 66
markrad 58:f50b97b08851 67 The tests need Perl to be built and run. If you don't have Perl installed, you can skip building the tests with:
markrad 58:f50b97b08851 68
markrad 58:f50b97b08851 69 make no_test
markrad 58:f50b97b08851 70
markrad 58:f50b97b08851 71 You'll still be able to run a much smaller set of tests with:
markrad 58:f50b97b08851 72
markrad 58:f50b97b08851 73 programs/test/selftest
markrad 58:f50b97b08851 74
markrad 58:f50b97b08851 75 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).
markrad 58:f50b97b08851 76
markrad 58:f50b97b08851 77 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; if you do so, essential parts such as `-I` will still be preserved. Warning options may be overridden separately using `WARNING_CFLAGS`.
markrad 58:f50b97b08851 78
markrad 58:f50b97b08851 79 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.
markrad 58:f50b97b08851 80
markrad 58:f50b97b08851 81 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).
markrad 58:f50b97b08851 82
markrad 58:f50b97b08851 83 ### CMake
markrad 58:f50b97b08851 84
markrad 58:f50b97b08851 85 In order to build the source using CMake, just enter at the command line:
markrad 58:f50b97b08851 86
markrad 58:f50b97b08851 87 cmake .
markrad 58:f50b97b08851 88 make
markrad 58:f50b97b08851 89
markrad 58:f50b97b08851 90 In order to run the tests, enter:
markrad 58:f50b97b08851 91
markrad 58:f50b97b08851 92 make test
markrad 58:f50b97b08851 93
markrad 58:f50b97b08851 94 The test suites need Perl to be built. If you don't have Perl installed, you'll want to disable the test suites with:
markrad 58:f50b97b08851 95
markrad 58:f50b97b08851 96 cmake -DENABLE_TESTING=Off .
markrad 58:f50b97b08851 97
markrad 58:f50b97b08851 98 If you disabled the test suites, but kept the programs enabled, you can still run a much smaller set of tests with:
markrad 58:f50b97b08851 99
markrad 58:f50b97b08851 100 programs/test/selftest
markrad 58:f50b97b08851 101
markrad 58:f50b97b08851 102 To configure CMake for building shared libraries, use:
markrad 58:f50b97b08851 103
markrad 58:f50b97b08851 104 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
markrad 58:f50b97b08851 105
markrad 58:f50b97b08851 106 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:
markrad 58:f50b97b08851 107
markrad 58:f50b97b08851 108 - Release. This generates the default code without any unnecessary information in the binary files.
markrad 58:f50b97b08851 109 - Debug. This generates debug information and disables optimization of the code.
markrad 58:f50b97b08851 110 - Coverage. This generates code coverage information in addition to debug information.
markrad 58:f50b97b08851 111 - 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.)
markrad 58:f50b97b08851 112 - ASanDbg. Same as ASan but slower, with debug information and better stack traces.
markrad 58:f50b97b08851 113 - MemSan. This instruments the code with MemorySanitizer to check for uninitialised memory reads. Experimental, needs recent clang on Linux/x86\_64.
markrad 58:f50b97b08851 114 - MemSanDbg. Same as MemSan but slower, with debug information, better stack traces and origin tracking.
markrad 58:f50b97b08851 115 - Check. This activates the compiler warnings that depend on optimization and treats all warnings as errors.
markrad 58:f50b97b08851 116
markrad 58:f50b97b08851 117 Switching build modes in CMake is simple. For debug mode, enter at the command line:
markrad 58:f50b97b08851 118
markrad 58:f50b97b08851 119 cmake -D CMAKE_BUILD_TYPE=Debug .
markrad 58:f50b97b08851 120
markrad 58:f50b97b08851 121 To list other available CMake options, use:
markrad 58:f50b97b08851 122
markrad 58:f50b97b08851 123 cmake -LH
markrad 58:f50b97b08851 124
markrad 58:f50b97b08851 125 Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first, e.g. (using GNU find):
markrad 58:f50b97b08851 126
markrad 58:f50b97b08851 127 find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
markrad 58:f50b97b08851 128 CC=gcc CFLAGS='-fstack-protector-strong -Wa,--noexecstack' cmake .
markrad 58:f50b97b08851 129
markrad 58:f50b97b08851 130 ### Microsoft Visual Studio
markrad 58:f50b97b08851 131
markrad 58:f50b97b08851 132 The build files for Microsoft Visual Studio are generated for Visual Studio 2010.
markrad 58:f50b97b08851 133
markrad 58:f50b97b08851 134 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 a perl environment as well. However, the selftest program in `programs/test/` is still available.
markrad 58:f50b97b08851 135
markrad 58:f50b97b08851 136 Example programs
markrad 58:f50b97b08851 137 ----------------
markrad 58:f50b97b08851 138
markrad 58:f50b97b08851 139 We've included example programs for a lot of different features and uses in `programs/`. Most programs only focus on a single feature or usage scenario, so keep that in mind when copying parts of the code.
markrad 58:f50b97b08851 140
markrad 58:f50b97b08851 141 Tests
markrad 58:f50b97b08851 142 -----
markrad 58:f50b97b08851 143
markrad 58:f50b97b08851 144 mbed TLS includes an elaborate test suite in `tests/` that initially requires Perl 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.
markrad 58:f50b97b08851 145
markrad 58:f50b97b08851 146 For machines with a Unix shell and OpenSSL (and optionally GnuTLS) installed, additional test scripts are available:
markrad 58:f50b97b08851 147
markrad 58:f50b97b08851 148 - `tests/ssl-opt.sh` runs integration tests for various TLS options (renegotiation, resumption, etc.) and tests interoperability of these options with other implementations.
markrad 58:f50b97b08851 149 - `tests/compat.sh` tests interoperability of every ciphersuite with other implementations.
markrad 58:f50b97b08851 150 - `tests/scripts/test-ref-configs.pl` test builds in various reduced configurations.
markrad 58:f50b97b08851 151 - `tests/scripts/key-exchanges.pl` test builds in configurations with a single key exchange enabled
markrad 58:f50b97b08851 152 - `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).
markrad 58:f50b97b08851 153
markrad 58:f50b97b08851 154 Configurations
markrad 58:f50b97b08851 155 --------------
markrad 58:f50b97b08851 156
markrad 58:f50b97b08851 157 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`
markrad 58:f50b97b08851 158
markrad 58:f50b97b08851 159 Contributing
markrad 58:f50b97b08851 160 ------------
markrad 58:f50b97b08851 161
markrad 58:f50b97b08851 162 We gratefully accept bug reports and contributions from the community. There are some requirements we need to fulfill in order to be able to integrate contributions:
markrad 58:f50b97b08851 163
markrad 58:f50b97b08851 164 - All contributions, whether large or small require a Contributor's License Agreement (CLA) to be accepted. This is because source code can possibly fall under copyright law and we need your consent to share in the ownership of the copyright.
markrad 58:f50b97b08851 165 - We would ask that contributions conform to [our coding standards](https://tls.mbed.org/kb/development/mbedtls-coding-standards), and that contributions should be fully tested before submission.
markrad 58:f50b97b08851 166 - As with any open source project, contributions will be reviewed by the project team and community and may need some modifications to be accepted.
markrad 58:f50b97b08851 167
markrad 58:f50b97b08851 168 To accept the Contributor’s Licence Agreement (CLA), individual contributors can do this by creating an mbed account and [accepting the online agreement here with a click through](https://developer.mbed.org/contributor_agreement/). Alternatively, for contributions from corporations, or those that do not wish to create an mbed account, a slightly different agreement can be found [here](https://www.mbed.com/en/about-mbed/contributor-license-agreements/). This agreement should be signed and returned to ARM as described in the instructions given.
markrad 58:f50b97b08851 169
markrad 58:f50b97b08851 170 ### Making a Contribution
markrad 58:f50b97b08851 171
markrad 58:f50b97b08851 172 1. [Check for open issues](https://github.com/ARMmbed/mbedtls/issues) or [start a discussion](https://tls.mbed.org/discussions) around a feature idea or a bug.
markrad 58:f50b97b08851 173 2. Fork the [mbed TLS repository on GitHub](https://github.com/ARMmbed/mbedtls) to start making your changes. As a general rule, you should use the "development" branch as a basis.
markrad 58:f50b97b08851 174 3. Write a test which shows that the bug was fixed or that the feature works as expected.
markrad 58:f50b97b08851 175 4. Send a pull request and bug us until it gets merged and published. Contributions may need some modifications, so work with us to get your change accepted. We will include your name in the ChangeLog :)
markrad 58:f50b97b08851 176