base on A modern TLS library in Rust <p align="center"> <img width="460" height="300" src="https://raw.githubusercontent.com/rustls/rustls/main/admin/rustls-logo-web.png"> </p> <p align="center"> Rustls is a modern TLS library written in Rust. </p> # Status Rustls is used in production at many organizations and projects. We aim to maintain reasonable API surface stability but the API may evolve as we make changes to accommodate new features or performance improvements. We have a [roadmap](ROADMAP.md) for our future plans. We also have [benchmarks](BENCHMARKING.md) to prevent performance regressions and to let you evaluate rustls on your target hardware. If you'd like to help out, please see [CONTRIBUTING.md](CONTRIBUTING.md). [](https://github.com/rustls/rustls/actions/workflows/build.yml?query=branch%3Amain) [](https://codecov.io/gh/rustls/rustls/) [](https://docs.rs/rustls/) [](https://discord.gg/MCSB76RU96) [](https://www.bestpractices.dev/projects/9034) ## Changelog The detailed list of changes in each release can be found at https://github.com/rustls/rustls/releases. # Documentation https://docs.rs/rustls/ # Approach Rustls is a TLS library that aims to provide a good level of cryptographic security, requires no configuration to achieve that security, and provides no unsafe features or obsolete cryptography by default. Rustls implements TLS1.2 and TLS1.3 for both clients and servers. See [the full list of protocol features](https://docs.rs/rustls/latest/rustls/manual/_04_features/index.html). ### Platform support While Rustls itself is platform independent, by default it uses [`aws-lc-rs`] for implementing the cryptography in TLS. See [the aws-lc-rs FAQ][aws-lc-rs-platforms-faq] for more details of the platform/architecture support constraints in aws-lc-rs. [`ring`] is also available via the `ring` crate feature: see [the supported `ring` target platforms][ring-target-platforms]. By providing a custom instance of the [`crypto::CryptoProvider`] struct, you can replace all cryptography dependencies of rustls. This is a route to being portable to a wider set of architectures and environments, or compliance requirements. See the [`crypto::CryptoProvider`] documentation for more details. Specifying `default-features = false` when depending on rustls will remove the dependency on aws-lc-rs. Rustls requires Rust 1.63 or later. It has an optional dependency on zlib-rs which requires 1.75 or later. [ring-target-platforms]: https://github.com/briansmith/ring/blob/2e8363b433fa3b3962c877d9ed2e9145612f3160/include/ring-core/target.h#L18-L64 [`crypto::CryptoProvider`]: https://docs.rs/rustls/latest/rustls/crypto/struct.CryptoProvider.html [`ring`]: https://crates.io/crates/ring [aws-lc-rs-platforms-faq]: https://aws.github.io/aws-lc-rs/faq.html#can-i-run-aws-lc-rs-on-x-platform-or-architecture [`aws-lc-rs`]: https://crates.io/crates/aws-lc-rs ### Cryptography providers Since Rustls 0.22 it has been possible to choose the provider of the cryptographic primitives that Rustls uses. This may be appealing if you have specific platform, compliance or feature requirements that aren't met by the default provider, [`aws-lc-rs`]. Users that wish to customize the provider in use can do so when constructing `ClientConfig` and `ServerConfig` instances using the `with_crypto_provider` method on the respective config builder types. See the [`crypto::CryptoProvider`] documentation for more details. #### Built-in providers Rustls ships with two built-in providers controlled with associated feature flags: * [`aws-lc-rs`] - enabled by default, available with the `aws_lc_rs` feature flag enabled. * [`ring`] - available with the `ring` feature flag enabled. See the documentation for [`crypto::CryptoProvider`] for details on how providers are selected. #### Third-party providers The community has also started developing third-party providers for Rustls: * [`rustls-mbedtls-provider`] - a provider that uses [`mbedtls`] for cryptography. * [`rustls-openssl`] - a provider that uses [OpenSSL] for cryptography. * [`rustls-post-quantum`]: an experimental provider that adds support for post-quantum key exchange to the default aws-lc-rs provider. * [`boring-rustls-provider`] - a work-in-progress provider that uses [`boringssl`] for cryptography. * [`rustls-rustcrypto`] - an experimental provider that uses the crypto primitives from [`RustCrypto`] for cryptography. * [`rustls-symcrypt`] - a provider that uses Microsoft's [SymCrypt] library. * [`rustls-wolfcrypt-provider`] - a work-in-progress provider that uses [`wolfCrypt`] for cryptography. [`rustls-mbedtls-provider`]: https://github.com/fortanix/rustls-mbedtls-provider [`mbedtls`]: https://github.com/Mbed-TLS/mbedtls [`rustls-openssl`]: https://github.com/tofay/rustls-openssl [OpenSSL]: https://openssl-library.org/ [`rustls-symcrypt`]: https://github.com/microsoft/rustls-symcrypt [SymCrypt]: https://github.com/microsoft/SymCrypt [`boring-rustls-provider`]: https://github.com/janrueth/boring-rustls-provider [`boringssl`]: https://github.com/google/boringssl [`rustls-rustcrypto`]: https://github.com/RustCrypto/rustls-rustcrypto [`RustCrypto`]: https://github.com/RustCrypto [`rustls-post-quantum`]: https://crates.io/crates/rustls-post-quantum [`rustls-wolfcrypt-provider`]: https://github.com/wolfSSL/rustls-wolfcrypt-provider [`wolfCrypt`]: https://www.wolfssl.com/products/wolfcrypt #### Custom provider We also provide a simple example of writing your own provider in the [`custom-provider`] example. This example implements a minimal provider using parts of the [`RustCrypto`] ecosystem. See the [Making a custom CryptoProvider] section of the documentation for more information on this topic. [`custom-provider`]: https://github.com/rustls/rustls/tree/main/provider-example/ [`RustCrypto`]: https://github.com/RustCrypto [Making a custom CryptoProvider]: https://docs.rs/rustls/latest/rustls/crypto/struct.CryptoProvider.html#making-a-custom-cryptoprovider # Example code Our [examples] directory contains demos that show how to handle I/O using the [`stream::Stream`] helper, as well as more complex asynchronous I/O using [`mio`]. If you're already using Tokio for an async runtime you may prefer to use [`tokio-rustls`] instead of interacting with rustls directly. The [`mio`] based examples are the most complete, and discussed below. Users new to Rustls may prefer to look at the simple client/server examples before diving in to the more complex MIO examples. [examples]: examples/ [`stream::Stream`]: https://docs.rs/rustls/latest/rustls/struct.Stream.html [`mio`]: https://docs.rs/mio/latest/mio/ [`tokio-rustls`]: https://docs.rs/tokio-rustls/latest/tokio_rustls/ ## Client example program The MIO client example program is named `tlsclient-mio`. Some sample runs: ``` $ cargo run --bin tlsclient-mio -- --http mozilla-modern.badssl.com HTTP/1.1 200 OK Server: nginx/1.6.2 (Ubuntu) Date: Wed, 01 Jun 2016 18:44:00 GMT Content-Type: text/html Content-Length: 644 (...) ``` or ``` $ cargo run --bin tlsclient-mio -- --http expired.badssl.com TLS error: InvalidCertificate(Expired) Connection closed ``` Run `cargo run --bin tlsclient-mio -- --help` for more options. ## Server example program The MIO server example program is named `tlsserver-mio`. Here's a sample run; we start a TLS echo server, then connect to it with `openssl` and `tlsclient-mio`: ``` $ cargo run --bin tlsserver-mio -- --certs test-ca/rsa-2048/end.fullchain --key test-ca/rsa-2048/end.key -p 8443 echo & $ echo hello world | openssl s_client -ign_eof -quiet -connect localhost:8443 depth=2 CN = ponytown RSA CA verify error:num=19:self signed certificate in certificate chain hello world ^C $ echo hello world | cargo run --bin tlsclient-mio -- --cafile test-ca/rsa-2048/ca.cert -p 8443 localhost hello world ^C ``` Run `cargo run --bin tlsserver-mio -- --help` for more options. # License Rustls is distributed under the following three licenses: - Apache License version 2.0. - MIT license. - ISC license. These are included as LICENSE-APACHE, LICENSE-MIT and LICENSE-ISC respectively. You may use this software under the terms of any of these licenses, at your option. # Project Membership - Joe Birr-Pixton ([@ctz], Project Founder - full-time funded by [Prossimo]) - Dirkjan Ochtman ([@djc], Co-maintainer) - Daniel McCarney ([@cpu], Co-maintainer - half-time funded by [Prossimo]) - Josh Aas ([@bdaehlie], Project Management) [@ctz]: https://github.com/ctz [@djc]: https://github.com/djc [@cpu]: https://github.com/cpu [@bdaehlie]: https://github.com/bdaehlie [Prossimo]: https://www.memorysafety.org/initiative/rustls/ # Code of conduct This project adopts the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct). Please email [email protected] to report any instance of misconduct, or if you have any comments or questions on the Code of Conduct. ", Assign "at most 3 tags" to the expected json: {"id":"2610","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"