Mention GODEBUG=fips140 in FIPS docs #1508
Open
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
karianna
approved these changes
Jan 21, 2025
gdams
approved these changes
Jan 22, 2025
dagood
requested changes
Jan 22, 2025
| @@ -42,7 +42,7 @@ The Microsoft Go fork provides several ways to configure the crypto backend and | |||
| - [`GOEXPERIMENT` `allowcryptofallback`](#build-option-to-use-go-crypto-if-the-backend-compatibility-check-fails) | |||
| - [`import _ "crypto/tls/fipsonly"` source change](#tls-with-fips-compliant-settings) | |||
| - Runtime configuration: | |||
| - [`GOFIPS` environment variable](#usage-runtime) | |||
| - [`GODEBUG=fips140` setting](#usage-runtime) | |||
There was a problem hiding this comment.
I think GOFIPS should still be mentioned here until it's no longer in a supported version of Microsoft Go. (At least, this list was intended to include everything.)
| @@ -42,7 +42,7 @@ The Microsoft Go fork provides several ways to configure the crypto backend and | |||
| - [`GOEXPERIMENT` `allowcryptofallback`](#build-option-to-use-go-crypto-if-the-backend-compatibility-check-fails) | |||
There was a problem hiding this comment.
Line above this one (too far from a diff to comment directly) mentions requirefips and should maybe also mention GOFIPS140=latest.
| The following sections describe how to enable FIPS mode and the effect of the `GODEBUG=fips140` setting on each supported platform. | ||
|
|
||
| > [!NOTE] | ||
| > Since Go 1.24, setting `GOFIPS=1` is equivalent to setting `GODEBUG=fips140=on`. The latter is the recommended way to enable FIPS mode. Support for the `GOFIPS` environment variable will be removed in Go 1.25. |
There was a problem hiding this comment.
I think this doesn't make it clear what GOFIPS=1 means in Go 1.23.
Co-authored-by: Davis Goodin <[email protected]>
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.
For #1445.