Skip to contentSkip to conversation

Fix mistyped option names

PATCH In review Magnus Kroken 2 participants 6 messages Aug 15, 2020 – Aug 16, 2020

lore
Share & tools
lore
#0 lore raw

cover Fix mistyped option names

While preparing a 2.5_beta1 package, I had to look back and forth betwenn various sources to get option names right. It seems that in some places names are altered to make grammatical sense, which I find confusing.

"Data cipher" and "compression" are simply words, and it makes sense to use the grammatically correct form whenever they are used. However I interpret --data-cipher, ``--data-cipher`` and --compression as literal, as the dashes and code highlighting hints that this is exactly how these are used in configuration and commands. There is no option --data-cipher in OpenVPN, so I would not expect the literal --data-cipher to appear anywhere, even when a sentence refers to one singular cipher in the list of --data-ciphers.

Magnus Kroken (2):
Changes.rst: fix mistyped option names
doc: fix typos in cipher-negotiation.rst

 Changes.rst                             | 10 +++++-----
 doc/man-sections/cipher-negotiation.rst |  4 ++--
 2 files changed, 7 insertions(+), 7 deletions(-)
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/2 Changes.rst: fix mistyped option names

---
 Changes.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Changes.rst +5 -5
index 0aee3603..f67e1d76 100644
@@ -34,7 +34,7 @@ Improved Data channel cipher negotiation
 Removal of BF-CBC support in default configuration:
     By default OpenVPN 2.5 will only accept AES-256-GCM and AES-128-GCM as
     data ciphers. OpenVPN 2.4 allows AES-256-GCM,AES-128-GCM and BF-CBC when
-    no --cipher and --ncp-cipher options are present. Accepting BF-CBC can be
+    no --cipher and --ncp-ciphers options are present. Accepting BF-CBC can be
     enabled by adding
 
         data-ciphers AES-256-GCM:AES-128-GCM:BF-CBC
@@ -101,7 +101,7 @@ Linux VRF support
 TLS 1.3 support
     TLS 1.3 support has been added to OpenVPN.  Currently, this requires
     OpenSSL 1.1.1+.
-    The options ``--tls-cipher-suites`` and ``--tls-groups`` have been
+    The options ``--tls-ciphersuites`` and ``--tls-groups`` have been
     added to fine tune TLS protocol options.  Most of the improvements
     were also backported to OpenVPN 2.4 as part of the maintainance
     releases.
@@ -112,7 +112,7 @@ Support setting DHCP search domain
     wintun support yet).  Other platforms need to support this via ``--up``
     script (Linux) or GUI (OSX/Tunnelblick).
 
-per-client changing of ``--data-cipher`` or ``data-ciphers-fallback``
+per-client changing of ``--data-ciphers`` or ``data-ciphers-fallback``
     from client-connect script/dir (NOTE: this only changes preference of
     ciphers for NCP, but can not override what the client announces as
     "willing to accept")
@@ -213,9 +213,9 @@ User-visible Changes
   the client configuration almost immediately as result of the
   faster connection setup feature.
 
-- ``--compression`` is nowadays considered risky, because attacks exist
+- ``--compress`` is nowadays considered risky, because attacks exist
   leveraging compression-inside-crypto to reveal plaintext (VORACLE).  So
-  by default, ``--compression xxx`` will now accept incoming compressed
+  by default, ``--compress xxx`` will now accept incoming compressed
   packets (for compatibility with peers that have not been upgraded yet),
   but will not use compression outgoing packets.  This can be controlled with
   the new option ``--allow-compression yes|no|asym``.
Signature · 1 line
2.20.1
#2 lore raw

[Openvpn-devel] [PATCH applied] Re: Changes.rst: fix mistyped option names

Your patch has been applied to the master and release/2.5 branch.

commit bf911882532f87ae866fc3662bf7e1e136a2195e (master) commit edc02b3be8fc50760df3e41438339759c45bfb23 (release/2.5)

Author: Magnus Kroken
Date:   Sat Aug 15 14:05:21 2020 +0200
     Changes.rst: fix mistyped option names

     Signed-off-by: Magnus Kroken <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg20749.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#3 lore raw

PATCH 2/2 doc: fix typos in cipher-negotiation.rst

In reply to Magnus Kroken
---
 doc/man-sections/cipher-negotiation.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/man-sections/cipher-negotiation.rst +2 -2
index f1433052..a2feb5f9 100644
@@ -38,7 +38,7 @@ options to avoid this behaviour.
 OpenVPN 3 clients
 -----------------
 Clients based on the OpenVPN 3.x library (https://github.com/openvpn/openvpn3/)
-do not have a configurable ``--ncp-ciphers`` or ``--data-cipher`` option. Instead
+do not have a configurable ``--ncp-ciphers`` or ``--data-ciphers`` option. Instead
 these clients will announce support for all their supported AEAD ciphers
 (`AES-256-GCM`, `AES-128-GCM` and in newer versions also `Chacha20-Poly1305`).
 
@@ -90,7 +90,7 @@ version. The default was never changed to ensure backwards compatibility.
 In OpenVPN 2.5 this behaviour has now been changed so that if the ``--cipher``
 is not explicitly set it does not allow the weak ``BF-CBC`` cipher any more
 and needs to explicitly added as ``--cipher BFC-CBC`` or added to
-``-data-ciphers``.
+``--data-ciphers``.
 
 We strongly recommend to switching away from BF-CBC to a
 more secure cipher as soon as possible instead.
Signature · 1 line
2.20.1
#4 lore raw

[Openvpn-devel] [PATCH applied] Re: doc: fix typos in cipher-negotiation.rst

Your patch has been applied to the master and release/2.5 branch.

commit e33f44754a5f81ea013070dba3cdc162f41d1257 (master) commit 4764868240ed215c91de659c742c393ebb602eeb (release/2.5)

Author: Magnus Kroken
Date:   Sat Aug 15 14:05:22 2020 +0200
     doc: fix typos in cipher-negotiation.rst

     Signed-off-by: Magnus Kroken <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg20748.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#5 lore raw
In reply to Magnus Kroken

Hi,

Quoted 5 lines · Magnus Kroken

While preparing a 2.5_beta1 package, I had to look back and forth betwenn various sources to get option names right. It seems that in some places names are altered to make grammatical sense, which I find confusing.

Thanks for pointing that out, and of course you are right that this needs fixing. Thanks for your patches, will apply ASAP (tomorrow-ish).

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...