From 509566df89a5fd4920a9db91dfb74c2f2b1f96f6 Mon Sep 17 00:00:00 2001 From: James Peach Date: Wed, 27 Oct 2021 13:58:04 +1100 Subject: [PATCH 1/2] doc: fix link formatting for TLS session_timeout Fix the session_timeout formatting so that it links to the RFC reference correctly. Make some minor grammar improvements. Signed-off-by: James Peach --- api/envoy/api/v2/auth/tls.proto | 7 +++---- api/envoy/extensions/transport_sockets/tls/v3/tls.proto | 7 +++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/api/envoy/api/v2/auth/tls.proto b/api/envoy/api/v2/auth/tls.proto index 201973a2b9de..0cf8c09340d7 100644 --- a/api/envoy/api/v2/auth/tls.proto +++ b/api/envoy/api/v2/auth/tls.proto @@ -81,10 +81,9 @@ message DownstreamTlsContext { bool disable_stateless_session_resumption = 7; } - // If specified, session_timeout will change maximum lifetime (in seconds) of TLS session - // Currently this value is used as a hint to `TLS session ticket lifetime (for TLSv1.2) - // ` - // only seconds could be specified (fractional seconds are going to be ignored). + // If specified, session_timeout will change the maximum lifetime (in seconds) of the TLS session. + // Currently this value is used as a hint for the `TLS session ticket lifetime (for TLSv1.2) `_. + // Only seconds can be specified (fractional seconds are ignored). google.protobuf.Duration session_timeout = 6 [(validate.rules).duration = { lt {seconds: 4294967296} gte {} diff --git a/api/envoy/extensions/transport_sockets/tls/v3/tls.proto b/api/envoy/extensions/transport_sockets/tls/v3/tls.proto index f680207955a8..ce3b31072def 100644 --- a/api/envoy/extensions/transport_sockets/tls/v3/tls.proto +++ b/api/envoy/extensions/transport_sockets/tls/v3/tls.proto @@ -109,10 +109,9 @@ message DownstreamTlsContext { bool disable_stateless_session_resumption = 7; } - // If specified, session_timeout will change maximum lifetime (in seconds) of TLS session - // Currently this value is used as a hint to `TLS session ticket lifetime (for TLSv1.2) - // ` - // only seconds could be specified (fractional seconds are going to be ignored). + // If specified, session_timeout will change the maximum lifetime (in seconds) of the TLS session. + // Currently this value is used as a hint for the `TLS session ticket lifetime (for TLSv1.2) `_. + // Only seconds can be specified (fractional seconds are ignored). google.protobuf.Duration session_timeout = 6 [(validate.rules).duration = { lt {seconds: 4294967296} gte {} From 76bbfe9a1251829156da85d197265d56601d8c50 Mon Sep 17 00:00:00 2001 From: James Peach Date: Thu, 28 Oct 2021 08:09:06 +1100 Subject: [PATCH 2/2] Quote the session_timeout field name Signed-off-by: James Peach --- api/envoy/api/v2/auth/tls.proto | 2 +- api/envoy/extensions/transport_sockets/tls/v3/tls.proto | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api/envoy/api/v2/auth/tls.proto b/api/envoy/api/v2/auth/tls.proto index 0cf8c09340d7..3f7255379ab7 100644 --- a/api/envoy/api/v2/auth/tls.proto +++ b/api/envoy/api/v2/auth/tls.proto @@ -81,7 +81,7 @@ message DownstreamTlsContext { bool disable_stateless_session_resumption = 7; } - // If specified, session_timeout will change the maximum lifetime (in seconds) of the TLS session. + // If specified, ``session_timeout`` will change the maximum lifetime (in seconds) of the TLS session. // Currently this value is used as a hint for the `TLS session ticket lifetime (for TLSv1.2) `_. // Only seconds can be specified (fractional seconds are ignored). google.protobuf.Duration session_timeout = 6 [(validate.rules).duration = { diff --git a/api/envoy/extensions/transport_sockets/tls/v3/tls.proto b/api/envoy/extensions/transport_sockets/tls/v3/tls.proto index ce3b31072def..1bf15d2222d2 100644 --- a/api/envoy/extensions/transport_sockets/tls/v3/tls.proto +++ b/api/envoy/extensions/transport_sockets/tls/v3/tls.proto @@ -109,7 +109,7 @@ message DownstreamTlsContext { bool disable_stateless_session_resumption = 7; } - // If specified, session_timeout will change the maximum lifetime (in seconds) of the TLS session. + // If specified, ``session_timeout`` will change the maximum lifetime (in seconds) of the TLS session. // Currently this value is used as a hint for the `TLS session ticket lifetime (for TLSv1.2) `_. // Only seconds can be specified (fractional seconds are ignored). google.protobuf.Duration session_timeout = 6 [(validate.rules).duration = {