docs: update fips documentation to specify supported libcrypto #4857
Conversation
This file contains 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
Oct 22, 2024
There was a problem hiding this comment.
You probably also want to update https://github.com/aws/s2n-tls/blob/main/docs/BUILD.md#building-with-a-specific-libcrypto
lrstewart
reviewed
Oct 24, 2024
lrstewart
reviewed
Oct 25, 2024
lrstewart
reviewed
Oct 25, 2024
maddeleine
approved these changes
Oct 25, 2024
lrstewart
previously approved these changes
Oct 25, 2024
docs/BUILD.md
Outdated
Comment on lines
115
to
117
| - FIPS mode is supported when s2n-tls is linked with a FIPS validated version of [AWS-LC](https://github.com/aws/aws-lc/blob/main/crypto/fipsmodule/FIPS.md). | ||
| - [OpenSSL](https://www.openssl.org/) (versions 1.0.2 - 3.0) |
There was a problem hiding this comment.
Based on our offline convo related to the doc comment, "FIPS validated" isn't exactly right
Suggested change
| - FIPS mode is supported when s2n-tls is linked with a FIPS validated version of [AWS-LC](https://github.com/aws/aws-lc/blob/main/crypto/fipsmodule/FIPS.md). | |
| - [OpenSSL](https://www.openssl.org/) (versions 1.0.2 - 3.0) | |
| - FIPS mode is supported with versions of AWS-LC [that support | |
| * FIPS](https://github.com/aws/aws-lc/blob/main/crypto/fipsmodule/FIPS.md). | |
| - [OpenSSL](https://www.openssl.org/) (versions 1.0.2 - 3.0) |
lrstewart
approved these changes
Oct 25, 2024
dougch
approved these changes
Oct 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
This PR updates our documentation to specify the libcryptos (AWS-LC-FIPS or AWS-LC-FIPS-2022) with which s2n-tls offers FIPS mode.
I also updated our CI test to use a tagged version of AWS-LC-FIPS-2022.
Testing:
Tests should continue to pass.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.