Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ssl.session_cache.enabled to be session_cache.value #11902

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/admin-guide/files/records.yaml.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/admin-guide/performance/index.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSSslSession.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down