Skip to content

Update FIPS user guide#2393

Merged
dagood merged 1 commit into
microsoft/mainfrom
dev/mclayton/bump-darwin-sha3
Jul 7, 2026
Merged

Update FIPS user guide#2393
dagood merged 1 commit into
microsoft/mainfrom
dev/mclayton/bump-darwin-sha3

Conversation

@michelle-clayton-work

@michelle-clayton-work michelle-clayton-work commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Add missing functions to guide

closes: https://github.com/microsoft/go-lab/issues/459

Copilot AI review requested due to automatic review settings July 2, 2026 19:16
@michelle-clayton-work michelle-clayton-work requested a review from a team as a code owner July 2, 2026 19:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the FIPS user guide (eng/doc/fips/UserGuide.md) to document additional crypto APIs (HKDF, ML-DSA, ML-KEM, SHA-3 family) and clarify TLS behavior in newer Go versions.

Changes:

  • Added new sections documenting crypto/hkdf, crypto/mldsa, crypto/mlkem, and crypto/sha3 backend support details.
  • Expanded the TLS guidance to describe Microsoft-recommended TLS defaults and additional FIPS-mode key exchange groups.
  • Updated the document’s TOC and reference links to include the newly documented functions/APIs.

Comment thread eng/doc/fips/UserGuide.md Outdated
@dagood

dagood commented Jul 2, 2026

Copy link
Copy Markdown
Member

Probably worth waiting and reapplying this on top of the structure added by

@dagood

dagood commented Jul 2, 2026

Copy link
Copy Markdown
Member

About waiting for #2394:

I'm fine with going ahead here and reconciling the other way, my thought is just that it might be easier to review the changes without markdown formatting being a factor.

@karianna

karianna commented Jul 5, 2026

Copy link
Copy Markdown
Member

@dagood - #2394 is now merged

Add the crypto/sha3, crypto/hkdf, crypto/pbkdf2, crypto/mlkem, and crypto/mldsa
sections to the FIPS User Guide and refresh the crypto/tls section (ML-KEM key
exchange groups, updated FIPS cipher suites, ChaCha20-Poly1305 note, and the
ms_tlsprofile/ms_tlsx25519 GODEBUG settings). Authored in the updatecryptodocs
generator and regenerated.
@michelle-clayton-work michelle-clayton-work force-pushed the dev/mclayton/bump-darwin-sha3 branch from 782e066 to dfbaa3a Compare July 6, 2026 19:55

@dagood dagood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! I didn't review every specific note for correctness (not super up to speed on crypto backend changes) but nothing stood out to me, and it can be fixed later if necessary.

@dagood dagood merged commit 4d3b085 into microsoft/main Jul 7, 2026
57 checks passed
@dagood dagood deleted the dev/mclayton/bump-darwin-sha3 branch July 7, 2026 17:03
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.

5 participants