mbedtls

This is an idiomatic Rust wrapper for MbedTLS, allowing you to use MbedTLS with only safe code while being able to use such great Rust features like error handling and closures.

Additionally, building on MbedTLS's focus on embedded use, this crate can be used in a no_std environment.

Building

This crate depends on the mbedtls-sys-auto crate, see below for build details.

Features

This is a list of the Cargo features available for mbedtls. Features in bold are enabled by default.

• aesni Enable support for the AES-NI instructions. On SGX, this feature is enabled automatically.
• core_io On no_std, you must enable this feature. It will supply the I/O Read and Write traits. Note: You need to add following into Cargo.toml to correctly compile code with old toolchain (nightly-2021-03-25) that support core-io feature

  proc-macro2 = { version = ">=1.0.24, <1.0.40" }
  quote = { version = "=1.0.10" }
  

• debug Enable debug printing to stdout. You need to configure the debug threshold at runtime.
• dsa Enable support for DSA signatures
• force_aesni_support MbedTLS normally uses runtime detection of AES-NI support. With this feature, always use AES-NI. This will result in undefined instruction exceptions on unsupported processors.
• legacy_protocols Enable support for SSLv3, TLSv1.0 and TLSv1.1
• padlock Enable support for VIA padlock.
• pkcs12 Enable code to parse PKCS12 files using yasna
• pkcs12_rc2 Enable use of RC2 crate to decrypt RC2-encrypted PKCS12 files
• pthread Enable mutex synchronization using pthreads.
• rdrand Enable the RDRAND random number generator.
• rust_threading Enable mutex synchronization using the std::sync::Mutex. spin_threading takes precedence over rust_threading.
• spin_threading Enable mutex synchronization using the spin crate.
• sgx Enables features recommended for x86_64-fortanix-unknown-sgx target.
• std If this feature is not enabled, this crate is a no_std crate. (An allocator is required) The necessary C functions to make MbedTLS work without libc will be provided.
• time Enable time support in mbedtls-sys.
• zlib Enable zlib support in mbedtls-sys.

PRs adding new features are encouraged.

mbedtls-sys-auto

Unfortunately, the mbedtls-sys crate on crates.io is claimed by another, apparently inactive, project.

To use this crate, you will need to have clang and cmake installed, see below for details.

Configuring and linking MbedTLS

MbedTLS has a plethora of compile-time configuration options that significantly impact what functionality is available. To make sure Rust's view of MbedTLS matches up with what's built in C, MbedTLS must be configured using Cargo features (see next section) and built using mbedtls-sys's build script.

The mbedtls-sys crate includes the MbedTLS source code, the MbedTLS version will have the same major.minor version as the crate. Instead of using the provided source, you can specify the path to your own source tree using the RUST_MBEDTLS_SYS_SOURCE environment variable. It is not recommended to use a custom source that is based on a different version of MbedTLS than the one provided in the crate.

The build script will perform the following steps:

1. generate an appropriate config.h (any existing config.h is ignored),
2. compile a statically-linked MbedTLS, this requires cmake to be installed,
3. generate Rust bindings based on the configuration, this requires clang to be installed.

Features

This is a list of the Cargo features available for mbedtls-sys. Features in bold are enabled by default.

• aesni Enable support for the AES-NI instructions.
• aes_alt Allow an alternative implementation of AES, replacing the T-tables code.
• custom_has_support Override runtime feature detection. In a dependent crate, you must define the functions mbedtls_aesni_has_support and mbedtls_padlock_has_support following the MbedTLS function signatures.
• custom_printf Provide a custom printf implementation. printf is only used for the self tests. In a dependent crate, you must define the mbedtls_printf function with the standard printf signature.
• custom_threading Provide a custom threading implementation. In a dependent crate, you must define the functions mbedtls_mutex_init, mbedtls_mutex_free, mbedtls_mutex_lock, and mbedtls_mutex_unlock following the MbedTLS function signatures.
• havege Enable the Hardware Volatile Entropy Gathering and Expansion (HAVEGE) algorithm.
• legacy_protocols Enable support for SSLv3, TLSv1.0 and TLSv1.1
• padlock Enable support for VIA padlock.
• pkcs11 Enable PKCS#11 support. This requires pkcs11-helper to be installed.
• pthread Enable threading support using pthreads.
• std If this feature is not enabled, this crate is a no_std crate. In a no_std configuration without libc, you need to provide your own versions of the following standard C functions: calloc/free, and strstr/strlen/strncpy/strncmp/strcmp/snprintf, and memmove/memcpy/memcmp/memset, and rand/printf. For printf, you can optionally use the custom_printf feature.
• time Enable time support.
• trusted_cert_callback Enable trusted certificate callback support.
• zlib Enable zlib support.

For the complete mapping of features to config.h defines, see [mbedtls-sys/build/config.rs]. PRs adding new features are encouraged.

MbedTLS version updates

Instructions for updating to new MbedTLS source code releases in mbedtls-sys/:

1. Wipe out vendor/ and replace it with the contents of the distribution tarball.
2. Cherry-pick any local changes from the previous version.
3. Use the command in build/headers.rs to generate the list of headers, and update that file as appropriate.
4. Check build/config.rs vs. vendor/include/mbedtls/config.h.
5. Update Cargo.toml version number.

mbedtls-selftest

This Rust crate is designed for separating self-test code that needs to export Rust functions and define C functions to be used by C mbedtls. By separating this code, different versions of Rust mbedtls crates can be used within a single crate, which helps to solve link name conflict errors.

Note: Although multiple versions of Rust mbedtls crates can be used within a single crate, only one mbedtls-selftest and one mbedtls-sys-auto crate can be used since they are built as native libraries.

Contributing

We gratefully accept bug reports and contributions from the community. By participating in this community, you agree to abide by Code of Conduct. All contributions are covered under the Developer's Certificate of Origin (DCO).

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

License

This project is primarily distributed under the terms of the Apache License version 2.0 and the GNU General Public License version 2, see LICENSE-APACHE and LICENSE-GPL for details.

A note about licensing

MbedTLS is dual-licensed Apache-2.0 / GPL-2.0+, and so are the mbedtls and mbedtls-sys-auto crates. However, the sources are distributed in two different single-licensed tarballs. The authors of the mbedtls and mbedtls-sys-auto crates do not warrant that the two versions of the MbedTLS code are exactly the same. This repository includes the Apache-2.0 version. Since Apache-2.0 is compatible with GPL-3.0+ this is probably not an issue for people whishing to use mbedtls-sys in a GPL-3.0+-licensed project, but if you want to use it in a GPL-2.0-licensed project, you should probably manually specify the GPL-2.0 source when building.