docs(bindings): expand readme for s2n-tls #5505
+25
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,25 @@ | ||
| # s2n-tls | ||
|
|
||
| s2n-tls is a C99 implementation of the TLS protocol. This crate provides idiomatic Rust bindings for the underlying C library. For additional Rust ecosystem integrations see | ||
| - [s2n-tls-tokio](https://crates.io/crates/s2n-tls-tokio): integrations for the tokio async runtime | ||
| - [s2n-tls-hyper](https://crates.io/crates/s2n-tls-hyper): integrations for the hyper HTTP library | ||
|
|
||
| ## Features | ||
| - SSLv3 - TLS 1.3 | ||
|
Comment on lines
+6
to
+8
Contributor
There was a problem hiding this comment. If we're listing SSLv3... should we list renegotiation too? 😬 |
||
| - PQ algorithms including ML-KEM and ML-DSA | ||
| - TLS 1.2 stateful and stateless session resumption | ||
| - TLS 1.3 stateless session resumption | ||
| - Early Data | ||
|
Comment on lines
+11
to
+12
Contributor
There was a problem hiding this comment. Do we actually have bindings for early data? |
||
| - TLS 1.3 PSK Authentication | ||
| - Private Key offload | ||
| - JA3 and JA4 client hello fingerprinting | ||
|
|
||
| ## Build | ||
|
|
||
| Consuming projects will need a C compiler (Clang or GCC) to build. | ||
|
|
||
| If "fips" is enabled, then consuming projects will also need **CMake** and **Go** due to the underlying AWS-LC-FIPS dependency. | ||
|
|
||
| ## Cryptography Provider | ||
|
|
||
| By default, the s2n-tls bindings will rely on [aws-lc-rs](https://crates.io/crates/aws-lc-rs) for cryptography. To use a FIPS validated libcrypto, customers can enable the `fips` feature flag in `s2n-tls`. This enables the `fips` feature in the underlying AWS-LC libcrypto. | ||
|
Contributor
There was a problem hiding this comment. Should we also mention that technically you can make it build with a different libcrypto if you really try? There was a problem hiding this comment. If we allow building with a different libcrypto, can we also include documentation about how to do it? |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might not be perfect about updating this, and it's probably not exhaustive now. So maybe instead: