Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme #323

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Update readme #323

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58d103e
docs: update README.md
Taowyoo Oct 19, 2023
8f99497
docs: update README
Taowyoo Oct 19, 2023
49a675c
docs: fix typos
Taowyoo Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
> [!WARNING]
> The state of this repertory is changed to maintenance. We will not accept any more feature requests. Please check [Change of status](#change-of-status) for details


# mbedtls

[![Build Status](https://travis-ci.com/fortanix/rust-mbedtls.svg?branch=master)](https://travis-ci.com/fortanix/rust-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.

## Change of status

We discovered that `mbedtls 3.X` is not thread safe and will not work properly with multiple threads.
And the new PSA approach does not match our needs. So we now decided to stay on mbedtls `2.28.X`; and the state of this repertory is changed to maintenance. We will not accept any more feature requests.

Related issue: [#320](https://github.com/fortanix/rust-mbedtls/issues/320)

Reference links:

- Design changes:
- https://lists.trustedfirmware.org/archives/list/[email protected]/message/RJ7YPNBNWUNW2ICQJ72H2JMKPDKGQOLT/
- Bugs
- https://github.com/fortanix/rust-mbedtls/issues/301
- https://github.com/fortanix/rust-mbedtls/issues/293
- https://github.com/Mbed-TLS/mbedtls/issues/3263

## Building

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