docs(bindings): expand readme for s2n-tls #5505
Open
Conversation
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
lrstewart
reviewed
Sep 12, 2025
Comment on lines
+11
to
+12
| - TLS 1.3 stateless session resumption | ||
| - Early Data |
Contributor
There was a problem hiding this comment.
Do we actually have bindings for early data?
Comment on lines
+6
to
+8
|
|
||
| ## Features | ||
| - SSLv3 - TLS 1.3 |
Contributor
There was a problem hiding this comment.
If we're listing SSLv3... should we list renegotiation too? 😬
Comment on lines
+6
to
+7
|
|
||
| ## Features |
Contributor
There was a problem hiding this comment.
We might not be perfect about updating this, and it's probably not exhaustive now. So maybe instead:
Suggested change
| ## Features | |
| ## Features | |
| Available features include: |
|
|
||
| ## 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?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description of changes:
Our previous README was very sparse. This new readme mentions some of the features, and calls out the libcrypto configuration.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.