From patchwork Tue Feb 6 14:10:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Frank Lichtenheld X-Patchwork-Id: 3603 Return-Path: Delivered-To: patchwork@openvpn.net Received: by 2002:a05:7000:e883:b0:554:adf7:68e6 with SMTP id oz3csp535683mab; Tue, 6 Feb 2024 06:11:56 -0800 (PST) X-Forwarded-Encrypted: i=2; AJvYcCWqmp2oHs2orbHtzg/34ibxjgHtkGZHOn/XdghPZkUWBZQRMOakOFp60rRbBPFypiyyNxyj+wjVED9u2iV1ve3BfW91GWg= X-Google-Smtp-Source: AGHT+IGBmtJbacCgKt0Kedrxo2jA8JbepAvSVKdkL7Gq9QVV28f4HmuSQNbVspXmGOBXNKhcgPUq X-Received: by 2002:a92:c26c:0:b0:363:b9d6:126a with SMTP id h12-20020a92c26c000000b00363b9d6126amr3120981ild.1.1707228716354; Tue, 06 Feb 2024 06:11:56 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1707228716; cv=none; d=google.com; s=arc-20160816; b=TV4uAadxWrdxiocgvRhN5MXymtaVmE0/W+4Wj8JOHyiaAzjGYJsLPUiEk9UNulT0RI 3k4WilkuqoNYB43d5xLkmZ/T7kxXWRBI2fle8/XtFgHg2TNrcxG8BNLBih+/YdCUg9yt KU4F6frchd1C+upxeZLhZVZtKDcsEjg1WJ0MkX5otyd55IHibkDIFHxyD+mHQx74TxOw PjFOLPjfLrdA2nlBx18Aqc2bgHJ7EN4/X6I0l8CqJzU4MTdv/6PRQzwizxLTUFhhxKzo nFkQ+GgcoNNLiTNML08NZsdtp9JBzq5lGtYgxpuLXBWmCpDAi3Itcnn/CFyBC+kfgfIp 3iVw== 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=p2+Nl3ckTr7y1j2bEPYOKo8SZIAfULU1hAH2w65iIEM=; fh=DPt2ZHfyCGpMb4QBX7rOcbMDQ0Iga+IGm7B2UGOiNJE=; b=053N3HasH+iaOcLOG621Uyr4o/y6lVFQDDmoxH1LtnmG5ycfkZ2K31VFf9EEs8xLxx K1ryz1EUsQx+9tCQjycF9rHHSrzRNdquvL3DHiloDHVULaRodb7EqapOTpG0a59gjGF7 BGCivMADK5HjknxaFBSa9+MfZmg044iWFkQJTINQ5STZehF4+LHO/8b6fA+yvzxXcATA 95Ysky0vTGbiIHbR2siepvoykS3Xrcu+8ghUHvXcC+9gSIC38EPsed7y3P6PvNTIVmxh tiAIXFrY6amuGkuizl7JJ5a8xwMB0eMKwBL3oDtFWDXc2lE293f7xhqEWElu9PXmfvOK LxQA==; darn=openvpn.net ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=DwaoVgj1; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=Ux7NPtEg; dkim=neutral (body hash did not verify) header.i=@lichtenheld.com header.s=MBO0001 header.b=STsktK4d; 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 X-Forwarded-Encrypted: i=0; AJvYcCXQPEbvBmMXQiXunZDgP6OLANIM5vT+6svILI6i9LvyClSeLPkTrOYWtUrYNvBo5APb0gue2x/VW+0RYd1bMF1blIyvDjKxYsQKb6/29wwXJXLBZ48YB9Cn/DymUobfaSumg2DG1UZEHbpq6RCsVm93y2mn5g4= Received: from lists.sourceforge.net (lists.sourceforge.net. [216.105.38.7]) by mx.google.com with ESMTPS id r5-20020a63fc45000000b005be09b723b7si1717350pgk.636.2024.02.06.06.11.55 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 06 Feb 2024 06:11:56 -0800 (PST) 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=DwaoVgj1; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=Ux7NPtEg; dkim=neutral (body hash did not verify) header.i=@lichtenheld.com header.s=MBO0001 header.b=STsktK4d; 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 1rXMAM-0008Gk-K3; Tue, 06 Feb 2024 14:11:15 +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 1rXMAJ-0008Gd-QP for openvpn-devel@lists.sourceforge.net; Tue, 06 Feb 2024 14:11:13 +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=mXTntATyna1ijkj5BeAXWey3caI6Kf1CUJjiv7l2Qow=; b=DwaoVgj12JNEF2aXTsGaCPiEnX DxyCNjllivB+IjZZ95z63SzJbFSzYhmSY0YoW+3Xaye2yUMGPCP0V0RvfCTPDohq7IntCUivWS0a4 LOvMjaPUHO9LA75JGl2tPRTcs1KS5pg1t+hPFL8vCI/ClOFfFuvFCO3jItffeByrjqX0=; 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=mXTntATyna1ijkj5BeAXWey3caI6Kf1CUJjiv7l2Qow=; b=U x7NPtEgPdi1+vX3h93o3gpHYr3rAbhEL07f4XiQaV4peX77qZwBncDiMGjZU+TCZc8gxPtPpsCFj6 LN8jHgTU0qNNw6UiD5Ns5/uD/cDOq6wNpz0/E3ASdLSw9Tp61Zh9ZKxnSJYYVxXrhDw64uJ6D9kk1 Z68L3jtqB2mQyo3s=; Received: from mout-p-201.mailbox.org ([80.241.56.171]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.95) id 1rXMAD-00018f-TP for openvpn-devel@lists.sourceforge.net; Tue, 06 Feb 2024 14:11:11 +0000 Received: from smtp202.mailbox.org (smtp202.mailbox.org [10.196.197.202]) (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-201.mailbox.org (Postfix) with ESMTPS id 4TTlXL0vsNz9sS2 for ; Tue, 6 Feb 2024 15:10:58 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lichtenheld.com; s=MBO0001; t=1707228658; 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=mXTntATyna1ijkj5BeAXWey3caI6Kf1CUJjiv7l2Qow=; b=STsktK4dP9Of2+ozVuWu52ksPizXF8E+AwHco5b7K0CzlTtAomGKDYMp0X0TSMQHhoK6TU pE55qlHKd5msrDhubxO85WK60M4Tms3Z++CcIZJGEHg5b8BS6qqHop/LD7i7Ox7IqZNgKj ikh6xM3fx9FBFnyoFlPfpwO+kutpAyc5aEetMiWcF+JgRHzqEKoizSk6/7rDI38emSLopx aWH80Bks3O22obgBtRfO7NrWhjFIW/8YFwQJhWVrJJXBJO/+tRx6HZJ+Io+QzSU/ch/d2y xyDEVCBKE6E/jVMMBG4Gn9Hj8U8jni3szZGUy0FpkPfPf1tplx7vlMS1Vh6MqQ== From: Frank Lichtenheld To: openvpn-devel@lists.sourceforge.net Date: Tue, 6 Feb 2024 15:10:57 +0100 Message-Id: <20240206141057.46249-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: - description of IV_PROTO was outdated, missing a lot of flags - complete list of compression flags, but separate them out - various other style/grammar/typo fixes Change-Id: I7f854a5a14d2a2a391ebb78a2a92b3e14cfd8be6 Signed-off-by: Frank Lichtenheld --- doc/man-sections/client-options.rst | 44 ++++++++++++++++++++--------- 1 file changed, [...] 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.171 listed in list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -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 -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.0 T_SCC_BODY_TEXT_LINE No description available. X-Headers-End: 1rXMAD-00018f-TP Subject: [Openvpn-devel] [PATCH] documentation: Update and fix documentation for --push-peer-info 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?1790159058622520063?= X-GMAIL-MSGID: =?utf-8?q?1790159058622520063?= - description of IV_PROTO was outdated, missing a lot of flags - complete list of compression flags, but separate them out - various other style/grammar/typo fixes Change-Id: I7f854a5a14d2a2a391ebb78a2a92b3e14cfd8be6 Signed-off-by: Frank Lichtenheld --- doc/man-sections/client-options.rst | 44 ++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 13 deletions(-) This patch should be applied to release/2.6 and master. diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst index 54c4ec63..cd3e565f 100644 --- a/doc/man-sections/client-options.rst +++ b/doc/man-sections/client-options.rst @@ -339,31 +339,31 @@ configuration. :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: + variable is a bitfield and the bits are defined as follows: + - bit 0: Reserved, should always be zero - 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. + to the ``AUTH_PENDING`` message. + - bit 5: The client supports doing feature negotiation in P2P mode + - bit 6: The client is capable of parsing and receiving the ``--dns`` pushed option + - bit 7: The client is capable of sending exit notification via control channel using ``EXIT`` message. Also, the client is accepting the protocol-flags pushed option for the EKM capability + - bit 8: The client is capable of accepting ``AUTH_FAILED,TEMP`` messages + - bit 9: The client is capable of dynamic tls-crypt :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*. + *AES-GCM-128* and *AES-GCM-256*. IV_NCP is *deprecated* in + favor of ``IV_CIPHERS``. - :code:`IV_CIPHERS=` + :code:`IV_CIPHERS=` The client announces the list of supported ciphers configured with the ``--data-ciphers`` option to the server. @@ -379,6 +379,23 @@ configuration. Additional authentication methods supported by the client. This may be set by the client UI/GUI using ``--setenv`` + The following flags depend on which compression formats are compiled in + and whether compression is allowed by options. See `Protocol options`_ + for more details. + + :code:`IV_LZO=1` + If client supports LZO compression. + + :code:`IV_LZO_STUB=1` + If client was built with LZO stub capability. This is only sent if + ``IV_LZO=1`` is not sent. + + :code:`IV_LZ4=1` and :code:`IV_LZ4v2=1` + If the client supports LZ4 compression. + + :code:`IV_COMP_STUB=1` and :code:`IV_COMP_STUBv2=1` + If the client supports stub compression. + When ``--push-peer-info`` is enabled the additional information consists of the following data: @@ -388,15 +405,16 @@ configuration. 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 + preserved across independent sessions and preferably re-installations and upgrades. :code:`IV_SSL=` - The ssl version used by the client, e.g. + The ssl library 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. + This is only sent on Windows operating systems. :code:`UV_=` Client environment variables whose names start with