diff mbox series

[Openvpn-devel] Improve description of compat-mode

Message ID 20230922134800.61755-1-frank@lichtenheld.com
State Not Applicable
Headers
Series [Openvpn-devel] Improve description of compat-mode |

Commit Message

Frank Lichtenheld Sept. 22, 2023, 1:48 p.m. UTC 
  From: Arne Schwabe <arne@rfc2549.org>

Explicitly say that the version specified is the one of the peer and not
the version we try to emulate.

Change-Id: I3bd27a8d34d8cb4896a3b78508b7d16911571543
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
---

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/34
This mail reflects revision 3 of this Change.
Acked-by according to Gerrit (reflected above):
Frank Lichtenheld <frank@lichtenheld.com>

Comments

Gert Doering Sept. 22, 2023, 2:32 p.m. UTC | #1 
Hi,

On Fri, Sep 22, 2023 at 03:48:00PM +0200, Frank Lichtenheld wrote:
> From: Arne Schwabe <arne@rfc2549.org>
> 
> Explicitly say that the version specified is the one of the peer and not
> the version we try to emulate.

This has been merged ages ago ;-)

commit daf66f4013d8facc085ea6cfaaf8a42f4d45a461
Author: Arne Schwabe <arne@rfc2549.org>
Date:   Mon Mar 20 17:55:38 2023 +0100

    Improve description of compat-mode
    
    Explicitly say that the version specified is the one of the peer and not
    the version we try to emulate.

gert
diff mbox series

Patch

diff --git a/doc/man-sections/generic-options.rst b/doc/man-sections/generic-options.rst
index c827651..97e1b5a 100644
--- a/doc/man-sections/generic-options.rst
+++ b/doc/man-sections/generic-options.rst
@@ -53,10 +53,17 @@ 
   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 convenient way to alter the defaults of OpenVPN
+  to be more compatible with the version ``version`` specified. All of
+  the changes this option applies can also be achieved using individual
+  configuration options.
+
+  The version specified with this option is the version of OpenVPN peer
+  OpenVPN should try to be 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 +74,15 @@ 
   - 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 required, 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.