diff --git a/doc/admin-guide/files/records.yaml.en.rst b/doc/admin-guide/files/records.yaml.en.rst index 91870b731a0..99385d83a28 100644 --- a/doc/admin-guide/files/records.yaml.en.rst +++ b/doc/admin-guide/files/records.yaml.en.rst @@ -3879,7 +3879,7 @@ SSL Termination Setting a value less than or equal to ``0`` effectively disables SSL session cache for the origin server. -.. ts:cv:: CONFIG proxy.config.ssl.session_cache.enabled INT 2 +.. ts:cv:: CONFIG proxy.config.ssl.session_cache.value INT 2 Enables the SSL session cache: @@ -3899,7 +3899,7 @@ SSL Termination entries in seconds. If it is ``0``, then the SSL library will use a default value, typically 300 seconds. Note: This option has no affect when using the |TS| session cache (option ``2`` in - ``proxy.config.ssl.session_cache.enabled``) + ``proxy.config.ssl.session_cache.value``) See :ref:`admin-performance-timeouts` for more discussion on |TS| timeouts. @@ -3941,9 +3941,9 @@ SSL Termination Take into account that setting the value to 0 will disable session caching for TLSv1.3 connections. - Lowering this setting to ``1`` can be interesting when ``proxy.config.ssl.session_cache.enabled`` is enabled because + Lowering this setting to ``1`` can be interesting when ``proxy.config.ssl.session_cache.value`` is enabled because otherwise for every new TLSv1.3 connection two session IDs will be inserted in the session cache. - On the other hand, if ``proxy.config.ssl.session_cache.enabled`` is disabled, using the default value is recommended. + On the other hand, if ``proxy.config.ssl.session_cache.value`` is disabled, using the default value is recommended. In those scenarios, increasing the number of tickets could be potentially beneficial for clients performing multiple requests over concurrent TLS connections as per RFC 8446 clients SHOULDN'T reuse TLS Tickets. diff --git a/doc/admin-guide/performance/index.en.rst b/doc/admin-guide/performance/index.en.rst index 689ef41ea46..17990d58ecc 100644 --- a/doc/admin-guide/performance/index.en.rst +++ b/doc/admin-guide/performance/index.en.rst @@ -528,7 +528,7 @@ SSL-Specific Options ~~~~~~~~~~~~~~~~~~~~ :ts:cv:`proxy.config.ssl.max_record_size` -:ts:cv:`proxy.config.ssl.session_cache.enabled` +:ts:cv:`proxy.config.ssl.session_cache.value` :ts:cv:`proxy.config.ssl.session_cache.size` Thread Types diff --git a/doc/developer-guide/api/functions/TSSslSession.en.rst b/doc/developer-guide/api/functions/TSSslSession.en.rst index 2e0ab9230bc..073faebba55 100644 --- a/doc/developer-guide/api/functions/TSSslSession.en.rst +++ b/doc/developer-guide/api/functions/TSSslSession.en.rst @@ -38,7 +38,7 @@ Description =========== These functions work with the internal ATS session cache. These functions are only useful if the ATS internal -session cache is enabled by setting :ts:cv:`proxy.config.ssl.session_cache.enabled` has been set to 2. +session cache is enabled by setting :ts:cv:`proxy.config.ssl.session_cache.value` has been set to 2. These functions tend to be used with the :enumerator:`TS_SSL_SESSION_HOOK`. diff --git a/doc/developer-guide/plugins/hooks-and-transactions/ssl-session-api.en.rst b/doc/developer-guide/plugins/hooks-and-transactions/ssl-session-api.en.rst index d6f050872d3..fc1d8c05399 100644 --- a/doc/developer-guide/plugins/hooks-and-transactions/ssl-session-api.en.rst +++ b/doc/developer-guide/plugins/hooks-and-transactions/ssl-session-api.en.rst @@ -31,7 +31,7 @@ to enable the plugin to update the session cache based on outside information, e This hook is invoked when a change has been made to the ATS session cache or a session has been accessed from ATS via OpenSSL. These hooks are only activated if the ATS implementation of the session cache is in -use. This means :ts:cv:`proxy.config.ssl.session_cache.enabled` has been set to 2. +use. This means :ts:cv:`proxy.config.ssl.session_cache.value` has been set to 2. The hook callback has the following signature