docs: Add FIPS documentation to BUILDING.md and README.md #2387
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
Add a new FIPS Mode section to BUILDING.md with build instructions and platform limitations. Update README.md to clarify that static FIPS builds are only supported on Linux platforms. This documentation helps users understand FIPS support in AWS-LC.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2387 +/- ##
=======================================
Coverage 78.85% 78.85%
=======================================
Files 640 640
Lines 109560 109560
Branches 15520 15521 +1
=======================================
+ Hits 86389 86394 +5
+ Misses 22471 22469 -2
+ Partials 700 697 -3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Add a new FIPS Mode section to BUILDING.md with build instructions and platform limitations. Update README.md to clarify that static FIPS builds are only supported on Linux platforms. This documentation helps users understand FIPS support in AWS-LC.
Issues:
n/a
Description of changes:
While trying to use Nix on darwin-aarch64, I realized the FIPS build instructions are somewhat lacking.
Call-outs:
Yes, one could just read the CMakeLists.txt file.
Testing:
How is this change tested (unit tests, fuzz tests, etc.)? Documentation...
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.