vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-11-02 20:02:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

openvpn: correct spelling and grammar

Browse Source
This commit is contained in:
rebortg 2021-07-09 20:59:52 +02:00
parent 27e30ae8b6
commit 1fee56ba74
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/configuration/interfaces/openvpn.rst
View File

@ -1,3 +1,5 @@
:lastproofread: 2021-07-05
.. _openvpn: .. _openvpn:
####### #######
@ -95,7 +97,7 @@ Remote Configuration:
set interfaces openvpn vtun1 remote-address '10.255.1.1' set interfaces openvpn vtun1 remote-address '10.255.1.1'
The configurations above will default to using 256-bit AES in GCM mode The configurations above will default to using 256-bit AES in GCM mode
for encryption (if both sides supports NCP) and SHA-1 for HMAC authentication. for encryption (if both sides support NCP) and SHA-1 for HMAC authentication.
SHA-1 is considered weak, but other hashing algorithms are available, as are SHA-1 is considered weak, but other hashing algorithms are available, as are
encryption algorithms: encryption algorithms:
@ -120,7 +122,7 @@ OpenVPN version < 2.4.0.
aes256gcm AES algorithm with 256-bit key GCM aes256gcm AES algorithm with 256-bit key GCM
This sets the accepted ciphers to use when version => 2.4.0 and NCP is This sets the accepted ciphers to use when version => 2.4.0 and NCP is
enabled (which is default). Default NCP cipher for versions >= 2.4.0 is enabled (which is the default). Default NCP cipher for versions >= 2.4.0 is
aes256gcm. The first cipher in this list is what server pushes to clients. aes256gcm. The first cipher in this list is what server pushes to clients.
.. code-block:: none .. code-block:: none
@ -168,7 +170,7 @@ Remote Configuration:
set protocols static route 10.0.0.0/16 interface vtun1 set protocols static route 10.0.0.0/16 interface vtun1
Firewall policy can also be applied to the tunnel interface for `local`, `in`, Firewall policy can also be applied to the tunnel interface for `local`, `in`,
and `out` directions and function identically to ethernet interfaces. and `out` directions and functions identically to ethernet interfaces.
If making use of multiple tunnels, OpenVPN must have a way to distinguish If making use of multiple tunnels, OpenVPN must have a way to distinguish
between different tunnels aside from the pre-shared-key. This is either by between different tunnels aside from the pre-shared-key. This is either by
@ -358,7 +360,7 @@ updates
set interfaces openvpn vtun0 openvpn-option "--plugin /usr/lib/openvpn/openvpn-auth-ldap.so /config/auth/ldap-auth.config" set interfaces openvpn vtun0 openvpn-option "--plugin /usr/lib/openvpn/openvpn-auth-ldap.so /config/auth/ldap-auth.config"
The required config file may look like: The required config file may look like this:
.. code-block:: none .. code-block:: none
@ -472,12 +474,12 @@ example:
Client Client
====== ======
VyOS can not only act as an OpenVPN site-to-site or Server for multiple clients. VyOS can not only act as an OpenVPN site-to-site or server for multiple clients.
You can indeed also configure any VyOS OpenVPN interface as an OpenVPN client You can indeed also configure any VyOS OpenVPN interface as an OpenVPN client
connecting to a VyOS OpenVPN server or any other OpenVPN server. connecting to a VyOS OpenVPN server or any other OpenVPN server.
Given the following example we have one VyOS router acting as OpenVPN server Given the following example we have one VyOS router acting as OpenVPN server
and another VyOS router acting as OpenVPN client. The Server also pushes a and another VyOS router acting as OpenVPN client. The server also pushes a
static client IP address to the OpenVPN client. Remember, clients are identified static client IP address to the OpenVPN client. Remember, clients are identified
using their CN attribute in the SSL certificate. using their CN attribute in the SSL certificate.
@ -529,7 +531,7 @@ Client
Options Options
======= =======
We do not have CLI nodes for every single OpenVPN options. If an option is We do not have CLI nodes for every single OpenVPN option. If an option is
missing, a feature request should be opened at Phabricator_ so all users can missing, a feature request should be opened at Phabricator_ so all users can
benefit from it (see :ref:`issues_features`). benefit from it (see :ref:`issues_features`).
@ -547,7 +549,7 @@ if you pass invalid options/syntax.
Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file. Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.
.. note:: Sometimes option lines in the generated OpenVPN configurarion require .. note:: Sometimes option lines in the generated OpenVPN configuration require
quotes. This is done through a hack on our config generator. You can pass quotes. This is done through a hack on our config generator. You can pass
quotes using the ``&quot;`` statement. quotes using the ``&quot;`` statement.
@ -583,11 +585,11 @@ The following commands let you reset OpenVPN.
.. opcmd:: reset openvpn client <text> .. opcmd:: reset openvpn client <text>
Use this command to reset specified OpenVPN client. Use this command to reset the specified OpenVPN client.
.. opcmd:: reset openvpn interface <interface> .. opcmd:: reset openvpn interface <interface>
Uset this command to reset the OpenVPN process on a specific interface. Use this command to reset the OpenVPN process on a specific interface.