Skip to content

FIPS readme: streamline FIPS preference eval#2247

Merged
dagood merged 2 commits intomicrosoft/mainfrom
dev/dagood/fips-docs
Apr 23, 2026
Merged

FIPS readme: streamline FIPS preference eval#2247
dagood merged 2 commits intomicrosoft/mainfrom
dev/dagood/fips-docs

Conversation

@dagood
Copy link
Copy Markdown
Member

@dagood dagood commented Apr 23, 2026

Streamline the FIPS mode preference eval list to (try to) make it easier to take in. Expand on why someone would potentially want Disabled ❌. Clarify(-ish) that the fix isn't in yet by specifying (As of Go 1.27, 1.26.3-1, and 1.25.10-1.).

Co-authored-by: Copilot <copilot@github.com>
Copilot AI review requested due to automatic review settings April 23, 2026 17:34
@dagood dagood requested a review from a team as a code owner April 23, 2026 17:34
@dagood
Copy link
Copy Markdown
Member Author

dagood commented Apr 23, 2026

I considered a mermaid diagram for the sequence:

flowchart LR
    A[Program starts] --> B{GODEBUG fips140\nsetting present?}
    B -- Yes --> B2{fips140 value?}
    B2 -- "off" --> Disabled["Disabled ❌"]
    B2 -- "on | only | debug" --> Enabled["Enabled ✅"]
    B2 -- "[other]" --> C
    B -- No --> C{GOFIPS=1 or\nGOLANG_FIPS=1?}
    C -- Yes --> Enabled
    C -- No --> D{Platform-specific\npreference detected?}
    D -- Yes --> Enabled
    D -- No --> E{requirefips\nbuild option?}
    E -- Yes --> Enabled
    E -- No --> NoPref["No preference ❔"]
Loading

...But ultimately, I think it's simple enough already.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the FIPS documentation to make the runtime “FIPS preference evaluation” logic easier to follow and to better explain the rationale for explicitly disabling FIPS preference.

Changes:

  • Rewrites the runtime preference-evaluation list into a shorter, ordered set of rules.
  • Adds a “Disabled ❌” behavior section and an explanatory note (container scenario) for why disabling may be desirable.
  • Adds a version-scoping note indicating when GODEBUG=fips140=off behavior applies.

Comment thread eng/doc/fips/README.md Outdated
Comment thread eng/doc/fips/README.md Outdated
@dagood dagood merged commit fe05dca into microsoft/main Apr 23, 2026
59 checks passed
@dagood dagood deleted the dev/dagood/fips-docs branch April 23, 2026 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants