Skip to content

docs: update PQC guide to follow standard template format - #14333

Open
lqiu96 wants to merge 1 commit into
pqc-user-guide-grpcfrom
pqc-guide-standard-format
Open

docs: update PQC guide to follow standard template format#14333
lqiu96 wants to merge 1 commit into
pqc-user-guide-grpcfrom
pqc-guide-standard-format

Conversation

@lqiu96

@lqiu96 lqiu96 commented Sep 9, 2026

Copy link
Copy Markdown
Member

This PR updates docs/post_quantum_cryptography_guide.md to follow the official Google Cloud Post-Quantum Cryptography documentation template format and moves external reading links to an Additional Resources section at the bottom.

Stacked on top of #14245.

@lqiu96
lqiu96 requested review from a team as code owners September 9, 2026 17:14

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request simplifies the Post-Quantum Cryptography (PQC) documentation by streamlining the overview, updating section headers, and reducing external links to a single resource. The review feedback suggests improving consistency by capitalizing "Post-Quantum" in the headers and formatting the technical identifier X25519MLKEM768 as inline code for better readability.

@@ -1,16 +1,12 @@
# Post-Quantum Cryptography (PQC) User Guide for Google Cloud Java Client Libraries
# Post-quantum Cryptography (PQC) Support

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.

medium

For consistency with the rest of the document (such as line 3), "Post-Quantum" should be capitalized with a capital "Q".

Suggested change
# Post-quantum Cryptography (PQC) Support
# Post-Quantum Cryptography (PQC) Support

For more information on Google Cloud's approach, see [Post-Quantum Cryptography on Google Cloud](https://cloud.google.com/security/resources/post-quantum-cryptography?hl=en).

To defend against this without sacrificing stability, Google Cloud Java client libraries adopt **Hybrid Key Exchange** (combining classical algorithms like `X25519` with standardized post-quantum algorithms like `ML-KEM-768`). This ensures connections remain secure even if an unforeseen mathematical weakness is discovered in either algorithm.
## Post-quantum key exchange

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.

medium

For consistency with the rest of the document, "Post-Quantum" should be capitalized with a capital "Q".

Suggested change
## Post-quantum key exchange
## Post-Quantum key exchange

- [How Google is preparing for a post-quantum world](https://cloud.google.com/blog/products/identity-security/how-google-is-preparing-for-a-post-quantum-world/?e=48754805)
- [PQC in Plaintext: Google Cloud's Post-Quantum Cryptography Roadmap](https://cloud.google.com/blog/products/identity-security/pqc-in-plaintext-google-clouds-post-quantum-cryptography-roadmap)
- [Post-Quantum Cryptography Standards: What you need to know](https://security.googleblog.com/2024/08/post-quantum-cryptography-standards.html)
Google Cloud client libraries support post-quantum key exchange using the X25519MLKEM768 hybrid mechanism for TLS 1.3 connections.

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.

medium

The hybrid mechanism identifier X25519MLKEM768 should be formatted as inline code (using backticks) to improve readability and distinguish it as a technical identifier.

@lqiu96
lqiu96 force-pushed the pqc-guide-standard-format branch from bc13607 to 87d5913 Compare September 9, 2026 17:17
@lqiu96
lqiu96 force-pushed the pqc-guide-standard-format branch from 87d5913 to dd6b2da Compare September 9, 2026 17:19
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.

1 participant