Skip to content

Document crypto/x509 in the FIPS User Guide - #2661

Merged
Quim Muntal (qmuntal) merged 2 commits into
microsoft/mainfrom
copilot/add-crypto-x509-to-fips-user-guide
Oct 28, 2026
Merged

Quim Muntal (qmuntal) merged 2 commits into
microsoft/mainfrom
copilot/add-crypto-x509-to-fips-user-guide

Conversation

Copilot AI commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

The FIPS User Guide mentions crypto/x509 only in the TLS context, leaving its own APIs undocumented despite their reliance on FIPS-sensitive crypto primitives.

  • Signing and verification: Add dedicated coverage of certificate, CSR, and CRL APIs, including custom signers, underlying crypto requirements, and platform versus Go chain verification.
  • Security boundaries: Clarify that parsing does not establish trust and that legacy PEM encryption is unsuitable for FIPS-approved key protection, even with AES.
  • Documentation integration: Register the package in the structured source and regenerate the guide and table of contents.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

Co-authored-by: qmuntal <3747816+qmuntal@users.noreply.github.com>
Copilot AI changed the title [WIP] Add crypto/x509 to FIPS User Guide Document crypto/x509 in the FIPS User Guide Oct 28, 2026
@qmuntal
Quim Muntal (qmuntal) marked this pull request as ready for review October 28, 2026 13:18
@qmuntal
Quim Muntal (qmuntal) requested a review from a team as a code owner October 28, 2026 13:18
Copilot AI balanced review requested due to automatic review settings October 28, 2026 13:18

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.

🟢 Approval recommended

No active review issues remain for the added crypto/x509 FIPS guidance.

No open issues 🎉

What changed in this PR

Adds dedicated crypto/x509 coverage to the FIPS User Guide, addressing issue #694 by explaining how its APIs depend on FIPS-sensitive cryptographic primitives.

Changes:

  • Documents certificate, CSR, and CRL signing and verification, including custom signers and platform verification.
  • Clarifies parsing and trust boundaries and warns against legacy PEM encryption for FIPS-approved key protection.
  • Registers the package, regenerates the guide, and adds heading and table-of-contents coverage checks.
File Description
eng/​doc/​fips/​UserGuide.md Adds generated x509 guidance and table-of-contents entries.
eng/​_util/​cmd/​updatecryptodocs/​userguide_content.go Defines the x509 guidance in the structured documentation source.
eng/​_util/​cmd/​updatecryptodocs/​updatecryptodocs_test.go Checks x509 API headings and table-of-contents entries.
eng/​_util/​cmd/​updatecryptodocs/​packages.go Registers x509 as a User Guide package.

Review effort: Balanced

@qmuntal
Quim Muntal (qmuntal) merged commit 259790a into microsoft/main Oct 28, 2026
70 checks passed
@qmuntal
Quim Muntal (qmuntal) deleted the copilot/add-crypto-x509-to-fips-user-guide branch October 28, 2026 16:46
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.

Add crypto/x509 to FIPS User Guide

4 participants