diff mbox series

[Openvpn-devel] Improve description of compat-mode

Message ID 20230301134449.2810039-1-arne@rfc2549.org
State Superseded
Headers show
Series [Openvpn-devel] Improve description of compat-mode | expand

Commit Message

Arne Schwabe March 1, 2023, 1:44 p.m. UTC 
Explicitly say that the version specified is the one of the peer and not
the version we try to emulate.

Change-Id: I3bd27a8d34d8cb4896a3b78508b7d16911571543
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
---
 doc/man-sections/generic-options.rst | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/doc/man-sections/generic-options.rst b/doc/man-sections/generic-options.rst
index c827651d6..ae20a261a 100644
--- a/doc/man-sections/generic-options.rst
+++ b/doc/man-sections/generic-options.rst
@@ -53,10 +53,16 @@  which mode OpenVPN is configured as.
   need for /dev/urandom to be available.
 
 --compat-mode version
-  This option provides a way to alter the default of OpenVPN to be more
-  compatible with the version ``version`` specified. All of the changes
-  this option does can also be achieved using individual configuration
-  options.
+  This option provides a convient way to alter the default of OpenVPN
+  to be more compatible with the version ``version`` specified. All of
+  the changes this option does can also be achieved using individual
+  configuration options.
+
+  The version specified is the version of OpenVPN peer OepnVPN should try
+  to compatible with. In general OpenVPN should be compatible with the last
+  two previous version without this option. E.g. OpenVPN 2.6.0 should be
+  compatible with 2.5.x and 2.4.x without this option. However, there might
+  be some edge cases that still require this option even in these cases.
 
   Note: Using this option reverts defaults to no longer recommended
   values and should be avoided if possible.
@@ -67,12 +73,15 @@  which mode OpenVPN is configured as.
   - 2.5.x or lower: ``--allow-compression asym`` is automatically added
     to the configuration if no other compression options are present.
   - 2.4.x or lower: The cipher in ``--cipher`` is appended to
-    ``--data-ciphers``
+    ``--data-ciphers``.
   - 2.3.x or lower: ``--data-cipher-fallback`` is automatically added with
-    the same cipher as ``--cipher``
+    the same cipher as ``--cipher``.
   - 2.3.6 or lower: ``--tls-version-min 1.0`` is added to the configuration
     when ``--tls-version-min`` is not explicitly set.
 
+  If not needed, this is option should be avoided. Setting this option can
+  lower security or disable features like data-channel offloading.
+
 --config file
   Load additional config options from ``file`` where each line corresponds
   to one command line option, but with the leading :code:`--` removed.