From patchwork Wed Jun 24 08:07:37 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Sommerseth X-Patchwork-Id: 1167 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director12.mail.ord1d.rsapps.net ([172.30.191.6]) by backend30.mail.ord1d.rsapps.net with LMTP id mE42Lh6X816NPQAAIUCqbw for ; Wed, 24 Jun 2020 14:10:38 -0400 Received: from proxy19.mail.ord1d.rsapps.net ([172.30.191.6]) by director12.mail.ord1d.rsapps.net with LMTP id 2DkVLh6X817LEAAAIasKDg ; Wed, 24 Jun 2020 14:10:38 -0400 Received: from smtp23.gate.ord1d ([172.30.191.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy19.mail.ord1d.rsapps.net with LMTP id 2CA0LR6X814pZgAAyH2SIw ; Wed, 24 Jun 2020 14:10:38 -0400 X-Spam-Threshold: 95 X-Spam-Score: 0 X-Spam-Flag: NO X-Virus-Scanned: OK X-Orig-To: openvpnslackdevel@openvpn.net X-Originating-Ip: [216.105.38.7] Authentication-Results: smtp23.gate.ord1d.rsapps.net; iprev=pass policy.iprev="216.105.38.7"; spf=pass smtp.mailfrom="openvpn-devel-bounces@lists.sourceforge.net" smtp.helo="lists.sourceforge.net"; dkim=fail (signature verification failed) header.d=sourceforge.net; dkim=fail (signature verification failed) header.d=sf.net; dmarc=fail (p=none; dis=none) header.from=openvpn.net X-Suspicious-Flag: YES X-Classification-ID: 01839b88-b646-11ea-8d34-525400bfb165-1-1 Received: from [216.105.38.7] ([216.105.38.7:44988] helo=lists.sourceforge.net) by smtp23.gate.ord1d.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id 02/26-19044-E1793FE5; Wed, 24 Jun 2020 14:10:38 -0400 Received: from [127.0.0.1] (helo=sfs-ml-2.v29.lw.sourceforge.com) by sfs-ml-2.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1jo9qM-0001Vo-Ar; Wed, 24 Jun 2020 18:09:54 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-2.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jo9qL-0001Va-Fi for openvpn-devel@lists.sourceforge.net; Wed, 24 Jun 2020 18:09:53 +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:References: In-Reply-To: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:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=MaVtIJYb750zrM85rM6I6HkHR0MQZaRD89ppwtuk+cg=; b=b+V4ZXR6d9eyWsZI76JLQI9LCb wGB3wEFAFaVIzg+JgPC1I6QX//PP2KmhodbyDpk4KgL4OOMEGbfm2C7HGJ6l+esltdyk+cuYHE5p+ 6bBYXuQ/NSMA5g0kT03iru8NhLFtBtbnyAUJ8Hqkgm/Wt/ygf0KZTJw7HAh+Or16szk4=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To: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:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=MaVtIJYb750zrM85rM6I6HkHR0MQZaRD89ppwtuk+cg=; b=P7xePjaONPIpDF0wWCigV1wJxW PfZ8Wul+qz77g/8uZqnCqgeEIBB5ZShLnRjOp9RYdcxWn8hmjanDjjJ/4DCODab/lLJhfBAx/EbLa 9gAG1KqCLqtOulATSTqE/rvaSewqcq4RCDsoccMBc4TrHZn2CJJeNPxAHBeAD3Kko1TY=; Received: from mx0.basenordic.cloud ([185.212.44.139]) by sfi-mx-4.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.2) id 1jo9qJ-00HEll-SQ for openvpn-devel@lists.sourceforge.net; Wed, 24 Jun 2020 18:09:53 +0000 Received: from localhost (unknown [IPv6:::1]) by mx0.basenordic.cloud (Postfix) with ESMTP id 2AABF8229D1 for ; Wed, 24 Jun 2020 18:09:44 +0000 (UTC) Received: from mx0.basenordic.cloud ([IPv6:::1]) by localhost (winterfell.topphemmelig.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id vulGfT7vDk63 for ; Wed, 24 Jun 2020 20:09:37 +0200 (CEST) Received: from zimbra.sommerseth.email (zimbra.sommerseth.email [172.16.33.42]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx0.basenordic.cloud (Postfix) with ESMTPS id 2B8FF83BAB3 for ; Wed, 24 Jun 2020 20:08:18 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by zimbra.sommerseth.email (Postfix) with ESMTP id 1C5EE4173003 for ; Wed, 24 Jun 2020 20:08:16 +0200 (CEST) Received: from zimbra.sommerseth.email ([127.0.0.1]) by localhost (zimbra.sommerseth.email [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id KT6iRvhEKWzR for ; Wed, 24 Jun 2020 20:08:15 +0200 (CEST) Received: from optimus.homebase.sommerseths.net (unknown [10.35.7.3]) by zimbra.sommerseth.email (Postfix) with ESMTPS id 308884173001 for ; Wed, 24 Jun 2020 20:08:11 +0200 (CEST) From: David Sommerseth To: openvpn-devel@lists.sourceforge.net Date: Wed, 24 Jun 2020 20:07:37 +0200 Message-Id: <20200624180741.426-8-davids@openvpn.net> X-Mailer: git-send-email 2.26.0 In-Reply-To: <20200624180741.426-1-davids@openvpn.net> References: <20200624180741.426-1-davids@openvpn.net> MIME-Version: 1.0 X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -0.0 SPF_HELO_PASS SPF: HELO matches SPF record 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record X-Headers-End: 1jo9qJ-00HEll-SQ Subject: [Openvpn-devel] [PATCH 07/11] doc/man: Move --dhcp-option from client to vpn-network section 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 Even though the --dhcp-option is only useful in a client context, it is more related to configuration of the VPN network interface and the related settings. Signed-off-by: David Sommerseth --- doc/man-sections/client-options.rst | 69 ------------------------ doc/man-sections/vpn-network-options.rst | 69 ++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 69 deletions(-) diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst index d6f9e6aa..966ede1e 100644 --- a/doc/man-sections/client-options.rst +++ b/doc/man-sections/client-options.rst @@ -146,75 +146,6 @@ configuration. --connect-timeout n See ``--server-poll-timeout``. ---dhcp-option args - Set additional network settings via DHCP. On Windows, this is parsed by - the ``tap-windows6`` or ``wintun`` driver. On other platforms these - options can be picked up by a ``--up`` script or plug-in if it has been - pushed by the OpenVPN server. The option will then be saved in the - client's environment before the ``--up`` script is called, under the name - :code:`foreign_option_{n}`. - - Valid syntax: - :: - - dhcp-options type [parm] - - :code:`DOMAIN` ``name`` - Set Connection-specific DNS Suffix to :code:`name`. - - :code:`DNS` ``address`` - Set primary domain name server IPv4 or IPv6 address. - Repeat this option to set secondary DNS server addresses. - - Note: DNS IPv6 servers are currently set using netsh (the existing - DHCP code can only do IPv4 DHCP, and that protocol only permits - IPv4 addresses anywhere). The option will be put into the - environment, so an ``--up`` script could act upon it if needed. - - :code:`WINS` ``address`` - Set primary WINS server address (NetBIOS over TCP/IP Name Server). - Repeat this option to set secondary WINS server addresses. - - :code:`NBDD` ``address`` - Set primary NBDD server address (NetBIOS over TCP/IP Datagram - Distribution Server). Repeat this option to set secondary NBDD - server addresses. - - :code:`NTP` ``address`` - Set primary NTP server address (Network Time Protocol). - Repeat this option to set secondary NTP server addresses. - - :code:`NBT` ``type`` - Set NetBIOS over TCP/IP Node type. Possible options: - - :code:`1` - b-node (broadcasts) - - :code:`2` - p-node (point-to-point name queries to a WINS server) - - :code:`4` - m-node (broadcast then query name server) - - :code:`8` - h-node (query name server, then broadcast). - - :code:`NBS` ``scope-id`` - Set NetBIOS over TCP/IP Scope. A NetBIOS Scope ID provides an - extended naming service for the NetBIOS over TCP/IP (Known as NBT) - module. The primary purpose of a NetBIOS scope ID is to isolate - NetBIOS traffic on a single network to only those nodes with the - same NetBIOS scope ID. The NetBIOS scope ID is a character string - that is appended to the NetBIOS name. The NetBIOS scope ID on two - hosts must match, or the two hosts will not be able to communicate. - The NetBIOS Scope ID also allows computers to use the same computer - name, as they have different scope IDs. The Scope ID becomes a part - of the NetBIOS name, making the name unique. (This description of - NetBIOS scopes courtesy of NeonSurge@abyss.com) - - :code:`DISABLE-NBT` - Disable Netbios-over-TCP/IP. - --explicit-exit-notify n In UDP client mode or point-to-point mode, send server/peer an exit notification if tunnel is restarted or OpenVPN process is exited. In diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst index fc18676e..d75cf540 100644 --- a/doc/man-sections/vpn-network-options.rst +++ b/doc/man-sections/vpn-network-options.rst @@ -88,6 +88,75 @@ routing. the TUN/TAP device used with ``--dev`` does not begin with :code:`tun` or :code:`tap`. +--dhcp-option args + Set additional network settings via DHCP. On Windows, this is parsed by + the ``tap-windows6`` or ``wintun`` driver. On other platforms these + options can be picked up by a ``--up`` script or plug-in if it has been + pushed by the OpenVPN server. The option will then be saved in the + client's environment before the ``--up`` script is called, under the name + :code:`foreign_option_{n}`. + + Valid syntax: + :: + + dhcp-options type [parm] + + :code:`DOMAIN` ``name`` + Set Connection-specific DNS Suffix to :code:`name`. + + :code:`DNS` ``address`` + Set primary domain name server IPv4 or IPv6 address. + Repeat this option to set secondary DNS server addresses. + + Note: DNS IPv6 servers are currently set using netsh (the existing + DHCP code can only do IPv4 DHCP, and that protocol only permits + IPv4 addresses anywhere). The option will be put into the + environment, so an ``--up`` script could act upon it if needed. + + :code:`WINS` ``address`` + Set primary WINS server address (NetBIOS over TCP/IP Name Server). + Repeat this option to set secondary WINS server addresses. + + :code:`NBDD` ``address`` + Set primary NBDD server address (NetBIOS over TCP/IP Datagram + Distribution Server). Repeat this option to set secondary NBDD + server addresses. + + :code:`NTP` ``address`` + Set primary NTP server address (Network Time Protocol). + Repeat this option to set secondary NTP server addresses. + + :code:`NBT` ``type`` + Set NetBIOS over TCP/IP Node type. Possible options: + + :code:`1` + b-node (broadcasts) + + :code:`2` + p-node (point-to-point name queries to a WINS server) + + :code:`4` + m-node (broadcast then query name server) + + :code:`8` + h-node (query name server, then broadcast). + + :code:`NBS` ``scope-id`` + Set NetBIOS over TCP/IP Scope. A NetBIOS Scope ID provides an + extended naming service for the NetBIOS over TCP/IP (Known as NBT) + module. The primary purpose of a NetBIOS scope ID is to isolate + NetBIOS traffic on a single network to only those nodes with the + same NetBIOS scope ID. The NetBIOS scope ID is a character string + that is appended to the NetBIOS name. The NetBIOS scope ID on two + hosts must match, or the two hosts will not be able to communicate. + The NetBIOS Scope ID also allows computers to use the same computer + name, as they have different scope IDs. The Scope ID becomes a part + of the NetBIOS name, making the name unique. (This description of + NetBIOS scopes courtesy of NeonSurge@abyss.com) + + :code:`DISABLE-NBT` + Disable Netbios-over-TCP/IP. + --ifconfig args Set TUN/TAP adapter parameters. It requires the *IP address* of the local VPN endpoint. For TUN devices in point-to-point mode, the next argument