Skip to contentSkip to conversation

man: Clarify IV_HWADDR

PATCH Superseded David Sommerseth 2 participants 4 messages Jul 9, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man: Clarify IV_HWADDR

From: David Sommerseth <[email protected]...>

The IV_HWADDR description was only partially correct, as there are more implementations using other values than the MAC address of the default gateway.

The intention of this value is to provide a unique identifier of the client and on some platforms this is not possible to retrieve other than to generate this information.

The 64 bytes limitation is an arbitrary value, it is not enforced by OpenVPN 2.x. But it was considered a good idea to at least have some reasonable upper limit of how long this string can be, at least for those implementing support for this information.

---
 doc/man-sections/server-options.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
doc/man-sections/server-options.rst +7 -2
index 047f2270..b026ac7b 100644
@@ -467,8 +467,13 @@ fast hardware. SSL/TLS authentication must be used in this mode.
   When ``--push-peer-info`` is enabled the additional information consists
   of the following data:
 
-  :code:`IV_HWADDR=<mac address>`
-        The MAC address of clients default gateway
+  :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 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.
Signature · 1 line
2.27.0
#1 lore raw

Hi,

Quoted 5 lines · David Sommerseth

From: David Sommerseth <[email protected]...>

The IV_HWADDR description was only partially correct, as there are more implementations using other values than the MAC address of the default gateway.

Feature ACK, but this text is actually still factually wrong:

doc/man-sections/server-options.rst fast hardware. SSL/TLS authentication must be used in this mode. · line 474

Quoted 5 lines
doc/man-sections/server-options.rst +5 -0
+  :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 default gateway. If this string is generated by the

It was never "the MAC address of the default gateway" (which would be "the plastic router in the corner", and specifically depending on "which network is this client in, right now?").

It is the MAC address of the *client* interface that is used to reach the default gateway.

So maybe a better wording would be

"... use the MAC address of the client's interface used to reach the default gateway."

(it's the client's interface MAC, not the gateway's MAC).

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]...
#2 lore raw

PATCH v2 1/1 man: Clarify IV_HWADDR

In reply to David Sommerseth

From: David Sommerseth <[email protected]...>

The IV_HWADDR description was only partially correct, as there are more implementations using other values than the MAC address of the default gateway.

The intention of this value is to provide a unique identifier of the client and on some platforms this is not possible to retrieve other than to generate this information.

The 64 bytes limitation is an arbitrary value, it is not enforced by OpenVPN 2.x. But it was considered a good idea to at least have some reasonable upper limit of how long this string can be, at least for those implementing support for this information.

---

v2 - Implement further clarifications from Gert

---
 doc/man-sections/server-options.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
doc/man-sections/server-options.rst +8 -2
index 047f2270..71547335 100644
@@ -467,8 +467,14 @@ fast hardware. SSL/TLS authentication must be used in this mode.
   When ``--push-peer-info`` is enabled the additional information consists
   of the following data:
 
-  :code:`IV_HWADDR=<mac address>`
-        The MAC address of clients default gateway
+  :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.
Signature · 1 line
2.27.0
Acked-by on v2 1/1
#3 lore raw

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

commit 51d85a9d287f44c373eaa514c6a52e1078c27c43 (master) commit 6204dc7cb8e1731fc0fdf6c2fcd016f9c049ac69 (release/2.5)

Author: David Sommerseth
Date:   Fri Jul 9 15:48:49 2021 +0200
     man: Clarify IV_HWADDR

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

--
kind regards,

Gert Doering