From patchwork Wed Jul 1 12:40:31 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: tincanteksup X-Patchwork-Id: 1197 X-Patchwork-Delegate: davids@openvpn.net Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director9.mail.ord1d.rsapps.net ([172.31.255.6]) by backend30.mail.ord1d.rsapps.net with LMTP id mLLrFC8R/V4wTAAAIUCqbw for ; Wed, 01 Jul 2020 18:41:51 -0400 Received: from proxy19.mail.iad3b.rsapps.net ([172.31.255.6]) by director9.mail.ord1d.rsapps.net with LMTP id aDf+ES8R/V73NAAAalYnBA ; Wed, 01 Jul 2020 18:41:51 -0400 Received: from smtp40.gate.iad3b ([172.31.255.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy19.mail.iad3b.rsapps.net with LMTP id YEUSDC8R/V68DgAAIG4riQ ; Wed, 01 Jul 2020 18:41:51 -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: smtp40.gate.iad3b.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; dkim=fail (signature verification failed) header.d=gmail.com; dmarc=fail (p=none; dis=none) header.from=gmail.com X-Suspicious-Flag: YES X-Classification-ID: 0b800724-bbec-11ea-b274-5254000cc6d4-1-1 Received: from [216.105.38.7] ([216.105.38.7:46074] helo=lists.sourceforge.net) by smtp40.gate.iad3b.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id AB/B2-03489-B211DFE5; Wed, 01 Jul 2020 18:41:47 -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 1jqlPP-0004mL-Ts; Wed, 01 Jul 2020 22:40:51 +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 1jqlPP-0004mE-5M for openvpn-devel@lists.sourceforge.net; Wed, 01 Jul 2020 22:40:51 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To: MIME-Version:Content-Type:Content-Transfer-Encoding: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=M15Hh1j6lHteS3/eHMy+dksczHYE7WUztVGFbQoLlNA=; b=KQ2jU7+AXRfmbY4KUuB9T7hAzn u/Mll4D8115I0cNRVLsp0OdwHSSEADdtsq+W+MPIs7pU58FHG9Mz2zAU/IaIeODYaFEqhsoCkqUZN bIuMCdT6sOG6glCcbVwCCmj+JB+PWjNTOP6K/Q98xMtD9fMivpk5uzj8w7cderS6rtSw=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:MIME-Version: Content-Type:Content-Transfer-Encoding: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=M15Hh1j6lHteS3/eHMy+dksczHYE7WUztVGFbQoLlNA=; b=Ss4Yl9nIBVn1/nIuvsZy98dULY aGOlkObZ+3K5fa3Wg2r+Axmk8KIlvvenOHUEOw8iRVxYSvOF4bbwTX0rsiykVj83u33V9gNQFfu4Z QYXjCfu3rJJYc0CJkEij6wkghfdxvz3ODQVmDV8G3QyAIUUTgDTLpTvDgNTkG1jfeYoM=; Received: from mail-wm1-f48.google.com ([209.85.128.48]) by sfi-mx-1.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.92.2) id 1jqlPN-009A8r-VM for openvpn-devel@lists.sourceforge.net; Wed, 01 Jul 2020 22:40:51 +0000 Received: by mail-wm1-f48.google.com with SMTP id j18so24323477wmi.3 for ; Wed, 01 Jul 2020 15:40:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=M15Hh1j6lHteS3/eHMy+dksczHYE7WUztVGFbQoLlNA=; b=GV2EOEJ3UVUee9p4EAwdmwIMhWA1bF7Jic9j9gvOhcM1vX9VJ3dvG9HSXWb65lvLC8 r+c/bRO9D0JWU88yPfnA4fd0fIjYVyssOMbdKSZTIFAJNWIYsBVtkOygLWc1LKkRSDVo FdTN4L8hpGjE2ArzA2/aqVUuNRVgADPXnn2mXK8J/FEMuISM5ggUBX4bNiSUraLQZgnM 0QwysK/95rfmed8InuTeIRqN9z4sDzLIrFQGjdRO5/kFQtEvSdo7GjX0HMSh4DJEBO46 bDr/TPGw6PXGyEZ0EJJRRD613oCuLPdxwghgYzy46tTBx9cOEk3B0k1TySAT38ktlPx3 yFOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=M15Hh1j6lHteS3/eHMy+dksczHYE7WUztVGFbQoLlNA=; b=K+a1sRxRhKQ09n/dRaF7TGHm2pFmDCWP7r6dQ9Ti/TGkYYITCgTHlyPrmfNJ6fLk4k /0oirtXqQY+9m1pybfLgzpOQX4bSSoHBsrWJgS0RimcmXpWjrbRcnyl3hKDIPIAYxdnJ 530k3xUzCS58wTeKP7eol4JcR/HJW+HbiUm03lE9mehSfsTZz8G6ulmaXbsP8fCeiJ8I c2FwBEsknI8UxB0JhHAQL+uFwsPvvbSQEsLUfEQWzlSGS/lxg6CTiI9v7/5wv1wep53P Pxh3QjXKC7aAMBpsS559+R+yiRmMJZ9zQ6UjWAFMvaIkgrbRdWzl/hyAkt+nrb5N9D4k RTBw== X-Gm-Message-State: AOAM533aosQGUcQPjjdxZGdfdraoQPQZEm+1zyPN8ma6HDXrFp+48OUc 5TjlFUouVNHqmY6kJGGxAAAhkfCm X-Google-Smtp-Source: ABdhPJzaOOzWAp13pFTTPbCl9gIbBlHpU0N1SANbt50eRXKD5ddV02zPVsa5/a7bGTAA+GkUQePluw== X-Received: by 2002:a7b:ca4c:: with SMTP id m12mr28919726wml.33.1593643243347; Wed, 01 Jul 2020 15:40:43 -0700 (PDT) Received: from localhost.localdomain (79-71-166-1.dynamic.dsl.as9105.com. [79.71.166.1]) by smtp.gmail.com with ESMTPSA id r10sm8782819wrm.17.2020.07.01.15.40.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 01 Jul 2020 15:40:42 -0700 (PDT) From: Richard Bonhomme To: openvpn-devel@lists.sourceforge.net Date: Wed, 1 Jul 2020 23:40:31 +0100 Message-Id: <20200701224031.15113-1-tincanteksup@gmail.com> X-Mailer: git-send-email 2.17.1 X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (tincanteksup[at]gmail.com) -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 RCVD_IN_MSPIKE_H2 RBL: Average reputation (+2) [209.85.128.48 listed in wl.mailspike.net] -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [209.85.128.48 listed in list.dnswl.org] X-Headers-End: 1jqlPN-009A8r-VM Subject: [Openvpn-devel] [Patch] New man page corrections - protocol-options.rst 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: , MIME-Version: 1.0 Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox Signed-off-by: Richard Bonhomme --- doc/man-sections/protocol-options.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst index 5bc072af..a5a1253a 100644 --- a/doc/man-sections/protocol-options.rst +++ b/doc/man-sections/protocol-options.rst @@ -1,7 +1,7 @@ Protocol options ---------------- -Options in this section affects features available in the OpenVPN wire -protocol. Many of these options also defines the encryption options +Options in this section affect features available in the OpenVPN wire +protocol. Many of these options also define the encryption options of the data channel in the OpenVPN wire protocol. These options must be configured in a compatible way between both the local and remote side. @@ -9,15 +9,15 @@ configured in a compatible way between both the local and remote side. Authenticate data channel packets and (if enabled) ``tls-auth`` control channel packets with HMAC using message digest algorithm ``alg``. (The default is ``SHA1`` ). HMAC is a commonly used message authentication - algorithm (MAC) that uses a data string, a secure hash algorithm, and a - key, to produce a digital signature. + algorithm (MAC) that uses a data string, a secure hash algorithm and a + key to produce a digital signature. The OpenVPN data channel protocol uses encrypt-then-mac (i.e. first - encrypt a packet, then HMAC the resulting ciphertext), which prevents + encrypt a packet then HMAC the resulting ciphertext), which prevents padding oracle attacks. - If an AEAD cipher mode (e.g. GCM) is chosen, the specified ``--auth`` - algorithm is ignored for the data channel, and the authentication method + If an AEAD cipher mode (e.g. GCM) is chosen then the specified ``--auth`` + algorithm is ignored for the data channel and the authentication method of the AEAD cipher is used instead. Note that ``alg`` still specifies the digest used for ``tls-auth``. @@ -55,7 +55,7 @@ configured in a compatible way between both the local and remote side. --compress algorithm **DEPRECATED** Enable a compression algorithm. Compression is generally - not recommended. VPN tunnels which uses compression are suspectible to + not recommended. VPN tunnels which use compression are susceptible to the VORALCE attack vector. The ``algorithm`` parameter may be :code:`lzo`, :code:`lz4`, or empty. @@ -161,7 +161,7 @@ configured in a compatible way between both the local and remote side. either specify ``--cipher BF-CBC`` or ``--cipher AES-256-CBC`` and both will work. - Note, for using NCP with a OpenVPN 2.4 peer this list must include the + Note for using NCP with an OpenVPN 2.4 peer: This list must include the :code:`AES-256-GCM` and :code:`AES-128-GCM` ciphers. This list is restricted to be 127 chars long after conversion to OpenVPN