summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces
diff options
context:
space:
mode:
authorOleksandr Kuchmystyi <o.kuchmystyi@vyos.io>2025-12-31 12:54:45 +0300
committerOleksandr Kuchmystyi <o.kuchmystyi@vyos.io>2025-12-31 12:54:45 +0300
commitce8bbaca5271c5ad3629244055b5b2f5b96b0c42 (patch)
tree1885c2093e9f5cbc6e074957018c096f391cfb5c /docs/configuration/interfaces
parent2a03cb0c2e5204d20decb1f7d050beeab1505b97 (diff)
downloadvyos-documentation-ce8bbaca5271c5ad3629244055b5b2f5b96b0c42.tar.gz
vyos-documentation-ce8bbaca5271c5ad3629244055b5b2f5b96b0c42.zip
openvpn: T7633: Add support for 'data-ciphers-fallback' in site-to-site tunnels
Diffstat (limited to 'docs/configuration/interfaces')
-rw-r--r--docs/configuration/interfaces/openvpn.rst34
1 files changed, 30 insertions, 4 deletions
diff --git a/docs/configuration/interfaces/openvpn.rst b/docs/configuration/interfaces/openvpn.rst
index a13ebad1..e2d16caf 100644
--- a/docs/configuration/interfaces/openvpn.rst
+++ b/docs/configuration/interfaces/openvpn.rst
@@ -57,10 +57,36 @@ Configuration
Administratively disable interface
-.. cfgcmd:: set interfaces openvpn <interface> encryption <cipher | data-ciphers> < 3des | aes128 | aes128gcm | none | ...>
-
- * ``cipher`` - Standard Data Encryption Algorithm
- * ``data-ciphers`` - Cipher negotiation list for use in server or client mode
+.. cfgcmd:: set interfaces openvpn <interface> encryption cipher < 3des | aes128 | aes128gcm | aes192 | aes192gcm | aes256 | aes256gcm | none >
+
+ Configure a single static encryption cipher for OpenVPN tunnels.
+
+ The ``cipher`` option directly maps to OpenVPN's ``--cipher`` directive and specifies
+ one symmetric encryption algorithm used for both control and data channels.
+ Historically, this was the default encryption method in all OpenVPN modes.
+ As of newer OpenVPN versions, this directive is considered **legacy** and
+ may only be used in compatibility scenarios.
+
+.. cfgcmd:: set interfaces openvpn <interface> encryption data-ciphers < 3des | aes128 | aes128gcm | aes192 | aes192gcm | aes256 | aes256gcm | none >
+
+ Configure a prioritized list of negotiated ciphers for use
+ with OpenVPN in *client* or *server* mode.
+
+ The ``data-ciphers`` option represents a list of supported encryption algorithms.
+ It corresponds to OpenVPN's ``--data-ciphers`` directive and enables **cipher negotiation**,
+ where both peers automatically agree on a mutually supported cipher during session startup.
+
+ .. note:: This option is not compatible with ``site-to-site`` mode.
+
+.. cfgcmd:: set interfaces openvpn <interface> encryption data-ciphers-fallback < 3des | aes128 | aes128gcm | aes192 | aes192gcm | aes256 | aes256gcm | none >
+
+ Define the fallback cipher for OpenVPN *site-to-site* tunnels.
+
+ The ``data-ciphers-fallback`` directive maps to OpenVPN's ``--data-ciphers-fallback`` option.
+ It specifies a single cipher to use when cipher negotiation is **not supported**.
+
+ .. note:: This option ensures consistent encryption setup between two static peers
+ that lack cipher negotiation capability.
.. cfgcmd:: set interfaces openvpn <interface> hash <md5 | sha1 | sha256 | ...>