[Openvpn-devel,8/9] Document stub-v2 being basically an alias for no compression at all

Message ID 20210512131511.1309914-9-arne@rfc2549.org
State Accepted
Headers show
Series
  • Miscellaneous cleanup patches/small fixes
Related show

Commit Message

Arne Schwabe May 12, 2021, 1:15 p.m.
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
---
 doc/man-sections/protocol-options.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Gert Doering May 14, 2021, 2:13 p.m. | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

Documentation is good!

(The whole section could use a rewrite by a native speaker who 
understands OpenVPN compression subtleties...)

Your patch has been applied to the master branch.

commit 59f640c28d61fea1efff5b1386dcf1a08dd0aad7
Author: Arne Schwabe
Date:   Wed May 12 15:15:10 2021 +0200

     Document stub-v2 being basically an alias for no compression at all

     Signed-off-by: Arne Schwabe <arne@rfc2549.org>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20210512131511.1309914-9-arne@rfc2549.org>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22346.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering
tincantech via Openvpn-devel June 20, 2021, 6:09 p.m. | #2
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi

text corrections.

Sorry about protonmail making '+' to '-'


‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐

On Wednesday, May 12th, 2021 at 14:15, Arne Schwabe <arne@rfc2549.org> wrote:

> Signed-off-by: Arne Schwabe arne@rfc2549.org
>
> doc/man-sections/protocol-options.rst | 5 +++++
>
> 1 file changed, 5 insertions(+)
>
> diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
>
> index 4b6928c68..34d4255ee 100644
>
> --- a/doc/man-sections/protocol-options.rst
>
> +++ b/doc/man-sections/protocol-options.rst
>
> @@ -96,6 +96,11 @@ configured in a compatible way between both the local and remote side.
>
> other variants always add one extra framing byte compared to no
>
> compression framing.
>
> -   Especially :code:`stub-v2` is essentially identical to no compression and
> -   no compression framing as its header indicates IP version 5 in a tun setup
> -   and can (ab)used to complete disable compression to clients. (See the
> -   :code:`migrate option below)
> -   If the `algorithm` parameter is :code:`stub`, :code:`stub-v2` or empty,

Re-write:

The :code:`stub-v2` is essentially identical to no compression and
no compression framing as its header indicates IP version 5 in a tun setup
and can be (ab)used to completely disable compression to clients. (See the
:code:`migrate` option below)
If the `algorithm` parameter is :code:`stub`, :code:`stub-v2` or empty,


>
>     compression will be turned off, but the packet framing for compression
>
>     will still be enabled, allowing a different setting to be pushed later.
>
>     --
>
>     2.31.1
>
>
> Openvpn-devel mailing list
>
> Openvpn-devel@lists.sourceforge.net
>
> https://lists.sourceforge.net/lists/listinfo/openvpn-devel
-----BEGIN PGP SIGNATURE-----
Version: ProtonMail

wsBzBAEBCAAGBQJgz4RlACEJEE+XnPZrkLidFiEECbw9RGejjXJ5xVVVT5ec
9muQuJ17fgf/SKzw7gpopswKR35nFGEW9F2hR7FMgKX7xBkhWLLUlENrD/Eq
LvQ39Y7+CK0+19MIJHed4hgSaBx4MK3Eb28XHMsm6y9Vz8lfM9/IeXsS3uXy
Ip9nCy4EpzPc62FWb93ysXyXRNS8GkYvZX50Oh3xV7glZMEwA5q7UGhRLsJY
3orWsnpT0PUTjrwB4Nm8ZDprXUEU1tsefTJn/HnbOzwlrCAa+b/W3xP8F7wn
YO4+bU3XP137bEV7t0FaB0qpTKXB2X+5j+A46T3jVjLOjHKSQipqgqSY0j5j
TJvwi5mjw0zaWCkFKBlrhp2f4Ybztd6OSB/JguxLE+jPkkWvEoRV2Q==
=ms4h
-----END PGP SIGNATURE-----
tincantech via Openvpn-devel June 20, 2021, 6:21 p.m. | #3
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Ignore me .. this has been applied

Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐

On Sunday, June 20th, 2021 at 19:09, tincantech via Openvpn-devel <openvpn-devel@lists.sourceforge.net> wrote:

> Hi
>
> text corrections.
>
> Sorry about protonmail making '+' to '-'
>
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
>
> On Wednesday, May 12th, 2021 at 14:15, Arne Schwabe arne@rfc2549.org wrote:
>
> > Signed-off-by: Arne Schwabe arne@rfc2549.org
> >
> > doc/man-sections/protocol-options.rst | 5 +++++
> >
> > 1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
> >
> > index 4b6928c68..34d4255ee 100644
> >
> > --- a/doc/man-sections/protocol-options.rst
> >
> > +++ b/doc/man-sections/protocol-options.rst
> >
> > @@ -96,6 +96,11 @@ configured in a compatible way between both the local and remote side.
> >
> > other variants always add one extra framing byte compared to no
> >
> > compression framing.
> >
> > -   Especially :code:`stub-v2` is essentially identical to no compression and
> > -   no compression framing as its header indicates IP version 5 in a tun setup
> > -   and can (ab)used to complete disable compression to clients. (See the
> > -   :code:`migrate option below)
> > -   If the `algorithm` parameter is :code:`stub`, :code:`stub-v2` or empty,
>
> Re-write:
>
> The :code:`stub-v2` is essentially identical to no compression and
>
> no compression framing as its header indicates IP version 5 in a tun setup
>
> and can be (ab)used to completely disable compression to clients. (See the
>
> :code:`migrate` option below)
>
> If the `algorithm` parameter is :code:`stub`, :code:`stub-v2` or empty,
>
> >     compression will be turned off, but the packet framing for compression
> >
> >     will still be enabled, allowing a different setting to be pushed later.
> >
> >     --
> >
> >     2.31.1
> >
> >
> > Openvpn-devel mailing list
> >
> > Openvpn-devel@lists.sourceforge.net
> >
> > https://lists.sourceforge.net/lists/listinfo/openvpn-devel
-----BEGIN PGP SIGNATURE-----
Version: ProtonMail

wsBzBAEBCAAGBQJgz4cFACEJEE+XnPZrkLidFiEECbw9RGejjXJ5xVVVT5ec
9muQuJ3SOwgAmIYtimEns1a2LT4CwKUU3lfhXEr2IHvNCZGbTl56p7FYgsVe
L3my1KclB/z6NVPydgBs/FAowSPOnWWoaWuh/+eMo1O8+nfA7+5YhNTL6Hyn
pRKJDJ6trAWXlGQm8N1kzRKUCjrDkPzFKoKsQvXgmjypQeyfwVLL4gJ+XQFk
gsP3gve88tb/q8F5FJfPcuM2NrNsLN0c+f4CKlfb6sr/U7ALp7Rf00hQ71CV
28RSZir15r+aahRmJs6SWng0K5gpN50Ed9PICBYQNmsQSqVAg6f2n1OA3ACQ
C68i58Vv85ElzG2VRymSzWAHdzA/KFM3qaKCnEZyviTkB00rbgWm0g==
=1Bdk
-----END PGP SIGNATURE-----

Patch

diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
index 4b6928c68..34d4255ee 100644
--- a/doc/man-sections/protocol-options.rst
+++ b/doc/man-sections/protocol-options.rst
@@ -96,6 +96,11 @@  configured in a compatible way between both the local and remote side.
   other variants always add one extra framing byte compared to no
   compression framing.
 
+  Especially :code:`stub-v2` is essentially identical to no compression and
+  no compression framing as its header indicates IP version 5 in a tun setup
+  and can (ab)used to complete disable compression to clients. (See the
+  :code:`migrate option below)
+
   If the ``algorithm`` parameter is :code:`stub`, :code:`stub-v2` or empty,
   compression will be turned off, but the packet framing for compression
   will still be enabled, allowing a different setting to be pushed later.