docs: tighten TLS 1.3 + PQ guidance and align proto/docs layering#44950
Closed
Copilot wants to merge 4 commits into
Closed
docs: tighten TLS 1.3 + PQ guidance and align proto/docs layering#44950Copilot wants to merge 4 commits into
Copilot wants to merge 4 commits into
Conversation
…e documentation Agent-Logs-Url: https://github.com/envoyproxy/envoy/sessions/6541830a-305b-4a29-bd95-8dc0fba57ff2 Co-authored-by: phlax <454682+phlax@users.noreply.github.com>
Agent-Logs-Url: https://github.com/envoyproxy/envoy/sessions/ab804083-6b35-478f-93f8-472bc5d36594 Co-authored-by: phlax <454682+phlax@users.noreply.github.com>
Agent-Logs-Url: https://github.com/envoyproxy/envoy/sessions/ab804083-6b35-478f-93f8-472bc5d36594 Co-authored-by: phlax <454682+phlax@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update TLS defaults and cipher suites documentation based on review feedback
docs: tighten TLS 1.3 + PQ guidance and align proto/docs layering
May 8, 2026
This file contains hidden or 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
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.
This updates PR #44944 per review by removing repetitive/internals-heavy wording and keeping TLS behavior guidance at the right level: concise in proto comments, detailed in architecture docs. The result preserves the original scope (TLS defaults, TLS 1.3 cipher-suite handling, PQ guidance) without changing runtime behavior.
TLS 1.3 wording in
TlsParameters.cipher_suites(proto)cipher_suites.PQ guidance made operator-facing
SSL_CTX_set1_curves_list).ecdh_curves.%DOWNSTREAM_TLS_GROUP%/%UPSTREAM_TLS_GROUP%.Detailed TLS 1.3 content kept in
ssl.rstdocs/root/intro/arch_overview/security/ssl.rst.Changelog/docs wording alignment
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
mirror.bazel.build/build/bazel_root/install/fb2a7f6d344d2f4e335882534df59296/embedded_tools/jdk/bin/java bazel(envoy) --add-opens=java.base/java.lang=ALL-UNNAMED -Xverify:none -Djava.util.logging.config.file=/build/bazel_root/base/javalog.properties -Dcom.google.devtools.build.lib.util.LogHandlerQuerier.class=com.google.devtools.build.lib.util.SimpleLogHandler$HandlerQuerier -XX:-MaxFDLimit -Djava.library.path=/build/bazel_root/install/fb2a7f6d344d2f4e335882534df59296/embedded_tools/jdk/lib:/build/bazel_root/install/fb2a7f6d344d2f4e335882534df59296/embedded_tools/jdk/lib/server:/build/bazel_root/install/fb2a7f6d344d2f4e335882534df59296/ -Dfile.encoding=ISO-8859-1 -Duser.country= -Duser.language= -Duser.variant= -Xmx3g -DBAZEL_TRACK_SOURCE_DIRECTORIES=1 -Djavax.net.ssl.trustStore=/tmp/custom-cacerts -Djavax.net.ssl.trustStorePassword=changeit -jar /build/bazel_root/install/fb2a7f6d344d2f4e335882534df59296/A-server.jar --max_idle_secs=10800 --noshutdown_on_low_sys_mem --connect_timeout_secs=30(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
Update pull request #44944 in repository
envoyproxy/envoybased on review feedback.Context:
docs: refresh TLS defaults, TLS 1.3 cipher suites, and post-quantum key exchange documentationcopilot/refresh-tls-documentationRequested changes from review:
api/envoy/extensions/transport_sockets/tls/v3/common.proto, the new TLS 1.3 note undercipher_suitesis considered repetitive because the preceding line already says the field has no effect for TLS 1.3. Reduce or remove the repeated wording. Prefer moving the fuller explanation to the higher-level docs and, if useful, add only a brief cross-reference from the proto comment.SSL_CTX_set1_curves_list.ecdh_curves.%DOWNSTREAM_TLS_GROUP%/%UPSTREAM_TLS_GROUP%as the way to observe the negotiated group.docs/root/intro/arch_overview/security/ssl.rst, keep the fuller TLS 1.3 explanation and list of negotiable TLS 1.3 cipher suites, since that is the better location for the detail than the proto field comment.Implementation guidance:
The following is the prior conversation context from the user's chat exploration (may be truncated):
User: we need to update thiks pr based on feedback
the one bit of pushback im wondering - where it says - this is repeated on the line above - they are separate fields - but then perhaps that is an argument to moving it up (and perhaps linking)
Assistant: Yes — I think your instinct is right: “they are separate fields” is true, but the reviewer’s point still stands.
Direct recommendation: move the fuller TLS 1.3 explanation to the higher-level
ssl.rstsection and keep the proto field comment minimal, with a cross-reference.What the feedback is really saying:
cipher_suites, you already say “this setting has no effect when negotiating TLS 1.3.”So I’d update the PR like this:
api/.../v3/common.proto.. note::block undercipher_suites.arch_overview_ssl_tls_defaults.”cipher_suitescontrols.docs/root/intro/arch_overview/security/ssl.rstcipher_suitesPQ text
ecdh_curvesexplicitly to enable it%DOWNSTREAM_TLS_GROUP%/%UPSTREAM_TLS_GROUP%to observe itssl.rst.Based on the review, the concrete asks are:
cipher_suitesSSL_CTX_set1_curves_listA good compromise for the proto comment is:
And for PQ something more like: