[Openvpn-devel] Move '--push-peer-info' documentation from 'server' to 'client options'

Message ID 20211207130436.22187-1-gert@greenie.muc.de
State Accepted
Headers show
Series [Openvpn-devel] Move '--push-peer-info' documentation from 'server' to 'client options' | expand

Commit Message

Gert Doering Dec. 7, 2021, 1:04 p.m. UTC
While --push-peer-info can be configured on the server, it's not really
intended for that, and it ended in the "SERVER OPTIONS" section by
mishap.  Fix that.

Reported-by: Stella Ashburne <rewefie@gmx.com>
Signed-off-by: Gert Doering <gert@greenie.muc.de>
---
 doc/man-sections/client-options.rst | 69 +++++++++++++++++++++++++++++
 doc/man-sections/server-options.rst | 69 -----------------------------
 2 files changed, 69 insertions(+), 69 deletions(-)

Comments

Frank Lichtenheld Dec. 10, 2021, 10:58 a.m. UTC | #1
Acked-By: Frank Lichtenheld <frank@lichtenheld.com>

Looks like an obvious improvement to me.

> Gert Doering <gert@greenie.muc.de> hat am 07.12.2021 14:04 geschrieben:
> 
>  
> While --push-peer-info can be configured on the server, it's not really
> intended for that, and it ended in the "SERVER OPTIONS" section by
> mishap.  Fix that.
> 
> Reported-by: Stella Ashburne <rewefie@gmx.com>
> Signed-off-by: Gert Doering <gert@greenie.muc.de>
> ---
>  doc/man-sections/client-options.rst | 69 +++++++++++++++++++++++++++++
>  doc/man-sections/server-options.rst | 69 -----------------------------
>  2 files changed, 69 insertions(+), 69 deletions(-)
--
Frank Lichtenheld
Gert Doering Dec. 10, 2021, 11:05 a.m. UTC | #2
Patch has been applied to the master and release/2.5 branch (doc fix).

commit 883cd6f4031ef9920580f0862594acbb45e4b0b8 (master)
commit c7a1e51496ea563aac9b2d525ad744a53b247bd4 (HEAD -> release/2.5)
Author: Gert Doering
Date:   Tue Dec 7 14:04:36 2021 +0100

     Move '--push-peer-info' documentation from 'server' to 'client options'

     Signed-off-by: Gert Doering <gert@greenie.muc.de>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <20211207130436.22187-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg23325.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst
index c5b7ad96..92a02e28 100644
--- a/doc/man-sections/client-options.rst
+++ b/doc/man-sections/client-options.rst
@@ -251,6 +251,75 @@  configuration.
   next remote succeeds. To silently ignore an option pushed by the server,
   use :code:`ignore`.
 
+--push-peer-info
+  Push additional information about the client to server. The following
+  data is always pushed to the server:
+
+  :code:`IV_VER=<version>`
+        The client OpenVPN version
+
+  :code:`IV_PLAT=[linux|solaris|openbsd|mac|netbsd|freebsd|win]`
+        The client OS platform
+
+  :code:`IV_LZO_STUB=1`
+        If client was built with LZO stub capability
+
+  :code:`IV_LZ4=1`
+        If the client supports LZ4 compressions.
+
+  :code:`IV_PROTO`
+    Details about protocol extensions that the peer supports. The
+    variable is a bitfield and the bits are defined as follows
+    (starting a bit 0 for the first (unused) bit:
+
+    - bit 1: The peer supports peer-id floating mechanism
+    - bit 2: The client expects a push-reply and the server may
+      send this reply without waiting for a push-request first.
+    - bit 3: The client is capable of doing key derivation using
+      RFC5705 key material exporter.
+    - bit 4: The client is capable of accepting additional arguments
+      to the `AUTH_PENDING` message.
+
+  :code:`IV_NCP=2`
+        Negotiable ciphers, client supports ``--cipher`` pushed by
+        the server, a value of 2 or greater indicates client supports
+        *AES-GCM-128* and *AES-GCM-256*.
+
+  :code:`IV_CIPHERS=<ncp-ciphers>`
+        The client announces the list of supported ciphers configured with the
+        ``--data-ciphers`` option to the server.
+
+  :code:`IV_GUI_VER=<gui_id> <version>`
+        The UI version of a UI if one is running, for example
+        :code:`de.blinkt.openvpn 0.5.47` for the Android app.
+
+  :code:`IV_SSO=[crtext,][openurl,][proxy_url]`
+        Additional authentication methods supported by the client.
+        This may be set by the client UI/GUI using ``--setenv``
+
+  When ``--push-peer-info`` is enabled the additional information consists
+  of the following data:
+
+  :code:`IV_HWADDR=<string>`
+        This is intended to be a unique and persistent ID of the client.
+        The string value can be any readable ASCII string up to 64 bytes.
+        OpenVPN 2.x and some other implementations use the MAC address of
+        the client's interface used to reach the default gateway. If this
+        string is generated by the client, it should be consistent and
+        preserved across independent session and preferably
+        re-installations and upgrades.
+
+  :code:`IV_SSL=<version string>`
+        The ssl version used by the client, e.g.
+        :code:`OpenSSL 1.0.2f 28 Jan 2016`.
+
+  :code:`IV_PLAT_VER=x.y`
+        The version of the operating system, e.g. 6.1 for Windows 7.
+
+  :code:`UV_<name>=<value>`
+        Client environment variables whose names start with
+        :code:`UV_`
+
 --remote args
   Remote host name or IP address, port and protocol.
 
diff --git a/doc/man-sections/server-options.rst b/doc/man-sections/server-options.rst
index f1d2ec31..8a030294 100644
--- a/doc/man-sections/server-options.rst
+++ b/doc/man-sections/server-options.rst
@@ -418,75 +418,6 @@  fast hardware. SSL/TLS authentication must be used in this mode.
   ``--echo``, ``--comp-lzo``, ``--socket-flags``, ``--sndbuf``,
   ``--rcvbuf``
 
---push-peer-info
-  Push additional information about the client to server. The following
-  data is always pushed to the server:
-
-  :code:`IV_VER=<version>`
-        The client OpenVPN version
-
-  :code:`IV_PLAT=[linux|solaris|openbsd|mac|netbsd|freebsd|win]`
-        The client OS platform
-
-  :code:`IV_LZO_STUB=1`
-        If client was built with LZO stub capability
-
-  :code:`IV_LZ4=1`
-        If the client supports LZ4 compressions.
-
-  :code:`IV_PROTO`
-    Details about protocol extensions that the peer supports. The
-    variable is a bitfield and the bits are defined as follows
-    (starting a bit 0 for the first (unused) bit:
-
-    - bit 1: The peer supports peer-id floating mechanism
-    - bit 2: The client expects a push-reply and the server may
-      send this reply without waiting for a push-request first.
-    - bit 3: The client is capable of doing key derivation using
-      RFC5705 key material exporter.
-    - bit 4: The client is capable of accepting additional arguments
-      to the `AUTH_PENDING` message.
-
-  :code:`IV_NCP=2`
-        Negotiable ciphers, client supports ``--cipher`` pushed by
-        the server, a value of 2 or greater indicates client supports
-        *AES-GCM-128* and *AES-GCM-256*.
-
-  :code:`IV_CIPHERS=<ncp-ciphers>`
-        The client announces the list of supported ciphers configured with the
-        ``--data-ciphers`` option to the server.
-
-  :code:`IV_GUI_VER=<gui_id> <version>`
-        The UI version of a UI if one is running, for example
-        :code:`de.blinkt.openvpn 0.5.47` for the Android app.
-
-  :code:`IV_SSO=[crtext,][openurl,][proxy_url]`
-        Additional authentication methods supported by the client.
-        This may be set by the client UI/GUI using ``--setenv``
-
-  When ``--push-peer-info`` is enabled the additional information consists
-  of the following data:
-
-  :code:`IV_HWADDR=<string>`
-        This is intended to be a unique and persistent ID of the client.
-        The string value can be any readable ASCII string up to 64 bytes.
-        OpenVPN 2.x and some other implementations use the MAC address of
-        the client's interface used to reach the default gateway. If this
-        string is generated by the client, it should be consistent and
-        preserved across independent session and preferably
-        re-installations and upgrades.
-
-  :code:`IV_SSL=<version string>`
-        The ssl version used by the client, e.g.
-        :code:`OpenSSL 1.0.2f 28 Jan 2016`.
-
-  :code:`IV_PLAT_VER=x.y`
-        The version of the operating system, e.g. 6.1 for Windows 7.
-
-  :code:`UV_<name>=<value>`
-        Client environment variables whose names start with
-        :code:`UV_`
-
 --push-remove opt
   Selectively remove all ``--push`` options matching "opt" from the option
   list for a client. ``opt`` is matched as a substring against the whole