Skip to content
This repository has been archived by the owner on Mar 4, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (30 loc) · 4.25 KB

README.md

File metadata and controls

55 lines (30 loc) · 4.25 KB
Raw

mbed TLS

mbed TLS (formerly known as PolarSSL) makes it trivially easy for developers to include cryptographic and SSL/TLS capabilities in their embedded products, with a minimal code footprint. It offers an SSL library with an intuitive API and readable source code.

The Beta release of mbed TLS integrates the mbed TLS library into mbed OS, mbed SDK and yotta. This is a preview release intended for evaluation only and is not recommended for deployment. It currently implements no secure source of random numbers, weakening its security.

Sample programs

This release includes the following examples:

  1. TLS client: found in test/example-tls-client. Downloads a test file from an HTTPS server and looks for a specific string in that file.

  2. Self test: found in test/example-selftest. Tests different basic functions in the mbed TLS library.

  3. Benchmark: found in test/example-benchmark. Measures the time taken to perform basic cryptographic functions used in the library.

These examples are integrated as yotta tests, so that they are built automatically when you build mbed TLS. You'll find more examples in the various test/example-* directories.

Running mbed TLS

To build and run the example, please follow the instructions in the TLS client example directory. These include a list of prerequisites and an explanation of building mbed TLS with yotta.

Configuring mbed TLS features

mbed TLS makes it easy to disable any feature during compilation that isn't required for a particular project. The default configuration enables all modern and widely-used features, which should meet the needs of new projects, and disables all features that are older or less common, to minimize the code footprint.

The list of available compilation flags is presented in the fully documented config.h file, present in the mbedtls directory of the yotta module.

If you need to adjust those flags, you can provide your own configuration file with suitable #define and #undef statements. These will be included between the default definitions and the sanity checks. Your configuration file should be in your application's include directory, and can be named freely; you just need to let mbed TLS know the file's name. To do that, use yotta's configuration system. The file's name should be in your config.json file, under mbedtls, as the key user-config-file. For example:

{
   "mbedtls": {
      "user-config-file": "\"myapp/my_mbedtls_config_changes.h\""
   }
}

Please note: you need to provide the exact name that will be used in the #include directive, including the <> or quotes around the name.

Contributing

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:

  • Simple bug fixes to existing code do not contain copyright themselves and we can integrate without issue. The same is true of trivial contributions.

  • For larger contributions, such as a new feature, the code can possibly fall under copyright law. We then need your consent to share in the ownership of the copyright. We have a form for this, which we will send to you in case you submit a contribution or pull request that we deem this necessary for.

To contribute, please:

  • Check for open issues or start a discussion around a feature idea or a bug.

  • Fork the mbed TLS repository on GitHub to start making your changes. As a general rule, you should use the "development" branch as a basis.

  • Write a test that shows that the bug was fixed or that the feature works as expected.

  • Send a pull request and bug us until it gets merged and published. We will include your name in the ChangeLog :)