From patchwork Thu Mar 21 16:16:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Frank Lichtenheld X-Patchwork-Id: 3661 Return-Path: Delivered-To: patchwork@openvpn.net Received: by 2002:a05:7000:c315:b0:55c:c090:46f0 with SMTP id jk21csp449404mab; Thu, 21 Mar 2024 09:17:16 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCUOEBU2WwF9dgpkcU2w7Ajp/cjiVxpPPZrJtmdBDdElrhT51wvgJPbyU8Uy9MiSZqMcsurxUZNTRkHCZ04/pPftk+wlHf4= X-Google-Smtp-Source: AGHT+IEt1WnvjpSmDpyqGzJkYCVW+s/J1ZpGYTzWNVp5SM/TK/FXcgnM1Z6TZQOd591sgvFiTnuY X-Received: by 2002:a17:902:e746:b0:1de:ddc6:27a6 with SMTP id p6-20020a170902e74600b001deddc627a6mr5575177plf.2.1711037836365; Thu, 21 Mar 2024 09:17:16 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1711037836; cv=none; d=google.com; s=arc-20160816; b=V9hrNYamY8BZY3YcTls4fYDdmWP7TIf1S13OF7plOnBq2crFEjoapA7NEwTrbOaPOh u2fmN8lzR7jme7U/iE9x5UG5PIATfIOpPMembeH/aGjh9Id6Okaw5tptMYzNukndxoMi cXDCOZvf4xhJ7ml5GHhy6Mzx9Kf5kjSfohXxCln7kSWfNP+Ye4E6YbbY/B6N+gKpcTtx iQ0nhVQnc11rkOA1zcmzTwi8QSHLRRfuWJRJMBGMSvffhnbQtvPutHeBbvc74y9L51Oz Crso/AMzgwBBwfKAm9zt9cNlZdZulM8zWuOtMwk28k/IPDz9tw70TWmZXoOqEa63XpDR QQuA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=errors-to:content-transfer-encoding:list-subscribe:list-help :list-post:list-archive:list-unsubscribe:list-id:precedence:subject :mime-version:message-id:date:to:from:dkim-signature:dkim-signature :dkim-signature; bh=YgGsjokbgWrZMHjPsRLcVVRQvnoM/7dv9hFHoPfR3ew=; fh=4NbAC/LsuMLI0S0hprUlLSLCiHwg6SCAifhH718Jh0Q=; b=sXwSJ4Owx3CQZ/rA/sm4xeGAsf5ew1taWHCxEL5Z36Npjz8vDzkxC20rPmSs2CXu3z Y+qbVuiGG8X2xENRnLnlgsnpgrNoYppwe/XcQZj+yDnCxZjZ8c/lx5BrA9iJOQ4d5wIu rGCB3uHCgLCkbXqAy53FWBsGvmo+K3ejDFABHT2T0lWJNMeh7rN5HqvgevbPcW2FbD3c bwyNrBxikIDerWhrQMuu/PMJ6ZIDuosgqOnx/WzOkH7Gzk7qsg6Hv6wzo91z2rPrmw/C 3oDhCWJQqDKaRqObHiQFJmbHva+ye2mwTzhRvOcXQn8q5I3IAFdNu1/Ag1eJTs50DK16 S3cg==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=lLAtvH9P; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=CdrQSdOv; dkim=neutral (body hash did not verify) header.i=@lichtenheld.com header.s=MBO0001 header.b=kbjNsdZ7; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net Received: from lists.sourceforge.net (lists.sourceforge.net. [216.105.38.7]) by mx.google.com with ESMTPS id n9-20020a170902d2c900b001e007479acfsi28865plc.120.2024.03.21.09.17.16 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 21 Mar 2024 09:17:16 -0700 (PDT) Received-SPF: pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) client-ip=216.105.38.7; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=lLAtvH9P; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=CdrQSdOv; dkim=neutral (body hash did not verify) header.i=@lichtenheld.com header.s=MBO0001 header.b=kbjNsdZ7; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net Received: from [127.0.0.1] (helo=sfs-ml-1.v29.lw.sourceforge.com) by sfs-ml-1.v29.lw.sourceforge.com with esmtp (Exim 4.95) (envelope-from ) id 1rnL5q-0001Co-4e; Thu, 21 Mar 2024 16:16:38 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-1.v29.lw.sourceforge.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1rnL5n-0001Cf-2O for openvpn-devel@lists.sourceforge.net; Thu, 21 Mar 2024 16:16:36 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:Message-Id: Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=nr7RWZLYfb3W+nV6//nnqr1oOM1r3gBKbnADVZ6XrG4=; b=lLAtvH9PdW/vnPxjNA4Gx7fd4m u4GZ+7YQZkMaUeDrkvmNBbAQ6cjiQforCEnVo0PLuxs9rgcQQulb98BkkNWCEhyZJEFNllDpjw+bn UghDyHrMONuFem5EiDx7RhVACUw2XEaK4ek36bWW83oz793iVDbSYWA6SSjvZjB0KfXQ=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:Message-Id:Date:Subject:To:From: Sender:Reply-To:Cc:Content-Type:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To: References:List-Id:List-Help:List-Unsubscribe:List-Subscribe:List-Post: List-Owner:List-Archive; bh=nr7RWZLYfb3W+nV6//nnqr1oOM1r3gBKbnADVZ6XrG4=; b=C drQSdOvXLYehKNAoo77PS/pv0dNRcE8yGqd+sdtEWYZtflpGWxvdQRdL9IsKh+jtewfnvwwllVPcZ EFqQeKdLvNQVuvHra3vgDgDR2afoKYj2ayj5xVHo1jKMHec6Qwfw3Jx+KifcIKcCbMwiUwBjhQjDK LDWjcmkG7sUdVQvw=; Received: from mout-p-103.mailbox.org ([80.241.56.161]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.95) id 1rnL5k-00030A-O6 for openvpn-devel@lists.sourceforge.net; Thu, 21 Mar 2024 16:16:35 +0000 Received: from smtp102.mailbox.org (smtp102.mailbox.org [10.196.197.102]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-103.mailbox.org (Postfix) with ESMTPS id 4V0rDm47jFz9scG for ; Thu, 21 Mar 2024 17:16:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lichtenheld.com; s=MBO0001; t=1711037784; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=nr7RWZLYfb3W+nV6//nnqr1oOM1r3gBKbnADVZ6XrG4=; b=kbjNsdZ7S1YvPpb0pCAbpgsleUKljZOTKYa8b1l5mDKFtCQJ3DRT9yrgQ3D4ZcOmD/ypyK qbABB3bScHRtzxYQOHENBt06pNndWZteGLPf8ctHnijoTdOj41w/3ZeuNkDV96hUehAOW5 4ZKrwSrT8dN/6JktNhOENPb+Dh19pLpfmyWu4Mwg7Us7Nd2IJHzvvsBgCVKER/gXgPtX72 pUIEn9M27PdieTXHGoPycSbpzdNqCbdy+XBfWokSDZvuncsIGY9Qqpuq9/yoq3ttxSOTZg XBe6+Pgi0ERC4BbBZm68w763X+4NMMCDLl9w4V/zQ9fbfp/OyFPHYDarvYLUBw== From: Frank Lichtenheld To: openvpn-devel@lists.sourceforge.net Date: Thu, 21 Mar 2024 17:16:23 +0100 Message-Id: <20240321161623.2794161-1-frank@lichtenheld.com> MIME-Version: 1.0 X-Spam-Score: -0.9 (/) X-Spam-Report: Spam detection software, running on the system "util-spamd-2.v13.lw.sourceforge.com", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: - Remove obsolete ifconfig_broadcast. Since this was removed in 2.5.0, do not add a removal note but just completely remove it. - Add missing documentation of IPv6 variants for ifconfig_pool_* variabl [...] Content analysis details: (-0.9 points, 6.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.7 RCVD_IN_DNSWL_LOW RBL: Sender listed at https://www.dnswl.org/, low trust [80.241.56.161 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-Headers-End: 1rnL5k-00030A-O6 Subject: [Openvpn-devel] [PATCH] script-options.rst: Update ifconfig_* variables X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox X-GMAIL-THRID: =?utf-8?q?1794153210411862955?= X-GMAIL-MSGID: =?utf-8?q?1794153210411862955?= - Remove obsolete ifconfig_broadcast. Since this was removed in 2.5.0, do not add a removal note but just completely remove it. - Add missing documentation of IPv6 variants for ifconfig_pool_* variables. Github: #527 Change-Id: Ia8c8de6799f0291fc900628fbd06c8a414e741ca Signed-off-by: Frank Lichtenheld Acked-by: Gert Doering --- doc/man-sections/script-options.rst | 38 ++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/doc/man-sections/script-options.rst b/doc/man-sections/script-options.rst index e05100a2..0d1f9aec 100644 --- a/doc/man-sections/script-options.rst +++ b/doc/man-sections/script-options.rst @@ -682,13 +682,6 @@ instances. recorded to this environmental variable sequence prior to ``--up`` script execution. -:code:`ifconfig_broadcast` - The broadcast address for the virtual ethernet segment which is derived - from the ``--ifconfig`` option when ``--dev tap`` is used. Set prior to - OpenVPN calling the :code:`ifconfig` or :code:`netsh` (windows version - of ifconfig) commands which normally occurs prior to ``--up`` script - execution. - :code:`ifconfig_ipv6_local` The local VPN endpoint IPv6 address specified in the ``--ifconfig-ipv6`` option (first parameter). Set prior to OpenVPN @@ -731,30 +724,53 @@ instances. occurs prior to ``--up`` script execution. :code:`ifconfig_pool_local_ip` - The local virtual IP address for the TUN/TAP tunnel taken from an + The local virtual IPv4 address for the TUN/TAP tunnel taken from an ``--ifconfig-push`` directive if specified, or otherwise from the ifconfig pool (controlled by the ``--ifconfig-pool`` config file directive). Only set for ``--dev tun`` tunnels. This option is set on the server prior to execution of the ``--client-connect`` and ``--client-disconnect`` scripts. +:code:`ifconfig_pool_local_ip6` + The local virtual IPv6 address for the TUN/TAP tunnel taken from an + ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the + ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file + directive). Only set for ``--dev tun`` tunnels. This option is set on + the server prior to execution of the ``--client-connect`` and + ``--client-disconnect`` scripts. + :code:`ifconfig_pool_netmask` - The virtual IP netmask for the TUN/TAP tunnel taken from an + The virtual IPv4 netmask for the TUN/TAP tunnel taken from an ``--ifconfig-push`` directive if specified, or otherwise from the ifconfig pool (controlled by the ``--ifconfig-pool`` config file directive). Only set for ``--dev tap`` tunnels. This option is set on the server prior to execution of the ``--client-connect`` and ``--client-disconnect`` scripts. +:code:`ifconfig_pool_ip6_netbits` + The virtual IPv6 prefix length for the TUN/TAP tunnel taken from an + ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the + ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file + directive). Only set for ``--dev tap`` tunnels. This option is set on + the server prior to execution of the ``--client-connect`` and + ``--client-disconnect`` scripts. + :code:`ifconfig_pool_remote_ip` - The remote virtual IP address for the TUN/TAP tunnel taken from an + The remote virtual IPv4 address for the TUN/TAP tunnel taken from an ``--ifconfig-push`` directive if specified, or otherwise from the ifconfig pool (controlled by the ``--ifconfig-pool`` config file directive). This option is set on the server prior to execution of the ``--client-connect`` and ``--client-disconnect`` scripts. +:code:`ifconfig_pool_remote_ip6` + The remote virtual IPv6 address for the TUN/TAP tunnel taken from an + ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the + ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file + directive). This option is set on the server prior to execution of the + ``--client-connect`` and ``--client-disconnect`` scripts. + :code:`link_mtu` - No longer passed to scripts since OpenVPN 2.6.0. Used to be the + *REMOVED* No longer passed to scripts since OpenVPN 2.6.0. Used to be the maximum packet size (not including the IP header) of tunnel data in UDP tunnel transport mode.