aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank Lichtenheld2024-03-25 08:15:20 +0100
committerGert Doering2024-03-25 16:24:32 +0100
commit3fdf5aa04f7b96a3b7110f75306306ac5d7ed5fd (patch)
tree82015a46312001f777633f24b98bdbcffdc4558e
parentb0fc10abd06fa2307e95c8a60fa94f7ccc08d2ac (diff)
downloadopenvpn-3fdf5aa04f7b96a3b7110f75306306ac5d7ed5fd.zip
openvpn-3fdf5aa04f7b96a3b7110f75306306ac5d7ed5fd.tar.gz
documentation: make section levels consistent
Previously the sections "Encryption Options" and "Data channel cipher negotiation" were on the same level as "OPTIONS", which makes no sense. Instead move them and their subsections one level down. Use ` since that was already in use in section "Virtual Routing and Forwarding". Change-Id: Ib5a7f9a978bda5ad58830e43580232660401f66d Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com> Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org> Message-Id: <20240325071520.12513-1-gert@greenie.muc.de> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28453.html Signed-off-by: Gert Doering <gert@greenie.muc.de>
-rw-r--r--doc/man-sections/cipher-negotiation.rst16
-rw-r--r--doc/man-sections/encryption-options.rst6
-rw-r--r--doc/man-sections/pkcs11-options.rst2
-rw-r--r--doc/man-sections/renegotiation.rst2
-rw-r--r--doc/man-sections/tls-options.rst2
5 files changed, 14 insertions, 14 deletions
diff --git a/doc/man-sections/cipher-negotiation.rst b/doc/man-sections/cipher-negotiation.rst
index 949ff86..1285e82 100644
--- a/doc/man-sections/cipher-negotiation.rst
+++ b/doc/man-sections/cipher-negotiation.rst
@@ -1,12 +1,12 @@
Data channel cipher negotiation
-===============================
+-------------------------------
OpenVPN 2.4 and higher have the capability to negotiate the data cipher that
is used to encrypt data packets. This section describes the mechanism in more detail and the
different backwards compatibility mechanism with older server and clients.
OpenVPN 2.5 and later behaviour
---------------------------------
+```````````````````````````````
When both client and server are at least running OpenVPN 2.5, that the order of
the ciphers of the server's ``--data-ciphers`` is used to pick the data cipher.
That means that the first cipher in that list that is also in the client's
@@ -25,7 +25,7 @@ For backwards compatibility OpenVPN 2.6 and later with ``--compat-mode 2.4.x``
``--cipher`` option to this list.
OpenVPN 2.4 clients
--------------------
+```````````````````
The negotiation support in OpenVPN 2.4 was the first iteration of the implementation
and still had some quirks. Its main goal was "upgrade to AES-256-GCM when possible".
An OpenVPN 2.4 client that is built against a crypto library that supports AES in GCM
@@ -40,7 +40,7 @@ always have the `AES-256-GCM` and `AES-128-GCM` ciphers to the ``--ncp-ciphers``
options to avoid this behaviour.
OpenVPN 3 clients
------------------
+`````````````````
Clients based on the OpenVPN 3.x library (https://github.com/openvpn/openvpn3/)
do not have a configurable ``--ncp-ciphers`` or ``--data-ciphers`` option. Newer
versions by default disable legacy AES-CBC, BF-CBC, and DES-CBC ciphers.
@@ -52,7 +52,7 @@ included in the server's ``--data-ciphers`` option.
OpenVPN 2.3 and older clients (and clients with ``--ncp-disable``)
-------------------------------------------------------------------
+``````````````````````````````````````````````````````````````````
When a client without cipher negotiation support connects to a server the
cipher specified with the ``--cipher`` option in the client configuration
must be included in the ``--data-ciphers`` option of the server to allow
@@ -65,7 +65,7 @@ If the client is 2.3 or older and has been configured with the
cipher used by the client is necessary.
OpenVPN 2.4 server
-------------------
+``````````````````
When a client indicates support for `AES-128-GCM` and `AES-256-GCM`
(with ``IV_NCP=2``) an OpenVPN 2.4 server will send the first
cipher of the ``--ncp-ciphers`` to the OpenVPN client regardless of what
@@ -76,7 +76,7 @@ option is required. OpenVPN 2.5+ will only announce the ``IV_NCP=2`` flag if
those ciphers are present.
OpenVPN 2.3 and older servers (and servers with ``--ncp-disable``)
-------------------------------------------------------------------
+``````````````````````````````````````````````````````````````````
The cipher used by the server must be included in ``--data-ciphers`` to
allow the client connecting to a server without cipher negotiation
support.
@@ -89,7 +89,7 @@ If the server is 2.3 or older and has been configured with the
cipher used by the server is necessary.
Blowfish in CBC mode (BF-CBC) deprecation
-------------------------------------------
+`````````````````````````````````````````
The ``--cipher`` option defaulted to `BF-CBC` in OpenVPN 2.4 and older
version. The default was never changed to ensure backwards compatibility.
In OpenVPN 2.5 this behaviour has now been changed so that if the ``--cipher``
diff --git a/doc/man-sections/encryption-options.rst b/doc/man-sections/encryption-options.rst
index 3b26782..49385d6 100644
--- a/doc/man-sections/encryption-options.rst
+++ b/doc/man-sections/encryption-options.rst
@@ -1,8 +1,8 @@
Encryption Options
-==================
+------------------
SSL Library information
------------------------
+```````````````````````
--show-ciphers
(Standalone) Show all cipher algorithms to use with the ``--cipher``
@@ -32,7 +32,7 @@ SSL Library information
``--ecdh-curve`` and ``tls-groups`` options.
Generating key material
------------------------
+```````````````````````
--genkey args
(Standalone) Generate a key to be used of the type keytype. if keyfile
diff --git a/doc/man-sections/pkcs11-options.rst b/doc/man-sections/pkcs11-options.rst
index de1662b..dfc27af 100644
--- a/doc/man-sections/pkcs11-options.rst
+++ b/doc/man-sections/pkcs11-options.rst
@@ -1,5 +1,5 @@
PKCS#11 / SmartCard options
----------------------------
+```````````````````````````
--pkcs11-cert-private args
Set if access to certificate object should be performed after login.
diff --git a/doc/man-sections/renegotiation.rst b/doc/man-sections/renegotiation.rst
index c548440..1e7c340 100644
--- a/doc/man-sections/renegotiation.rst
+++ b/doc/man-sections/renegotiation.rst
@@ -1,5 +1,5 @@
Data Channel Renegotiation
---------------------------
+``````````````````````````
When running OpenVPN in client/server mode, the data channel will use a
separate ephemeral encryption key which is rotated at regular intervals.
diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
index 460cecf..de74c0d 100644
--- a/doc/man-sections/tls-options.rst
+++ b/doc/man-sections/tls-options.rst
@@ -1,5 +1,5 @@
TLS Mode Options
-----------------
+````````````````
TLS mode is the most powerful crypto mode of OpenVPN in both security
and flexibility. TLS mode works by establishing control and data