31,703
edits
Changes
Template:Networking rut manual vpn (view source)
Revision as of 10:29, 13 May 2019
, 10:29, 13 May 2019Created page with "==Summary== <b>Virtual Private Network</b> (<b>VPN</b>) is a method of connecting multiple private networks across the Internet. VPNs can serve to achieve many different goal..."
==Summary==
<b>Virtual Private Network</b> (<b>VPN</b>) is a method of connecting multiple private networks across the Internet. VPNs can serve to achieve many different goals, but some of its main purposes are:
<ul>
<li>access between remote private networks;</li>
<li>data encryption;</li>
<li>anonymity when browsing the Internet.</li>
</ul>
This page is an overview of different types of VPNs supported by {{{name}}} routers.
==OpenVPN==
<b>OpenVPN</b> is an open-source software application that implements virtual private network (VPN) techniques for creating secure point-to-point or site-to-site connections in routed or bridged configurations and remote access facilities. It is often regarding as being the most universal VPN protocol because of its flexibility, support of SSL/TLS security, multiple encryption methods, many networking features and compatibility with most OS platforms.
{{{name}}} routers run OpenVPN version <b>2.4.5</b>.
For more in-depth guides refer to our <b>[[OpenVPN configuration examples]]</b> page.
===OpenVPN client===
----
An <b>OpenVPN client</b> is an entity that initiates a connection to an OpenVPN server. To create a new server intance, go to the Services → VPN → OpenVPN section, select <i>Role: Client</i>, enter a custom name and click "Add New". An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration list". A maximum of six OpenVPN client instances are allowed to be added.
To begin configuration, click the "Edit" button next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
[[File:{{{file_openvpn_client_config}}}]]
<table class="nd-mantable">
<tr>
<th>Field name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; Default: <b>no</b></td>
<td>Turns the OpenVPN instance ON or OFF</td>
</tr>
<tr>
<td>TUN/TAP</td>
<td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<ul>
<li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally used when routing is required</li>
<li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>UDP | TCP; Default: <b>UDP</b></td>
<td>Transfer protocol used for the connection. The
<ul>
<li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, file transfer)</li>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls)</li>
</ul>
</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; Default: <b>1194</b></td>
<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router</td>
</tr>
<tr>
<td>LZO</td>
<td>yes | no; Default: <b>no</b></td>
<td>Enables LZO data compression</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; Default: <b>BF-CBC 128</b></td>
<td>Packet encryption algorithm</td>
</tr>
<tr>
<td>Authentication</td>
<td>TLS | Static Key | Password | TLS/Password; Default: <b>TLS</b></td>
<td>Authentication mode, used to secure data sessions.
<ul>
<li><b>Static key</b> is a secret key used for server–client authentication.</li>
<li><b>TLS</b> authentication mode uses X.509 type certificates:
<ul>
<li>Certificate Authority (CA)</li>
<li>Client certificate</li>
<li>Client key</li>
</ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
</li>
<li><b>Password</b> is a simple username/password based authentication where the owner of the OpenVPN server provides the login data.</li>
<li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
</ul>
</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> TLS cipher</td>
<td>All | DHE+RSA | Custom; Default: <b>All</b></td>
<td>Packet encryption algorithm cipher</td>
</tr>
<tr>
<td>Remote host / IP address</td>
<td>ip; Default: <b>none</b></td>
<td>IP address or hostname of an OpenVPN server</td>
</tr>
<tr>
<td>Resolve retry</td>
<td>integer | infinite; Default: <b>infinite</b></td>
<td>In case server hostname resolve fails, this field indicates the amount of time (in seconds) to retry the resolve. Specify <i>infinite</i> to retry indefinitely</td>
</tr>
<tr>
<td>Keep alive</td>
<td>two integers separated by a space; Default: <b>none</b></td>
<td>Defines two time intervals: one is used to periodically send ICMP request to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the local network interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the remote network (server) interface</td>
</tr>
<tr>
<td>Remote network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>LAN IP address of the remote network (client)</td>
</tr>
<tr>
<td>Remote network IP netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: #0054a6;">Password:</span> User name</td>
<td>string; Default: <b>none</b></td>
<td>User name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: #0054a6;">Password:</span> Password</td>
<td>string; Default: <b>none</b></td>
<td>Password name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td>Extra options</td>
<td>string; Default: <b>none</b></td>
<td>Extra options to be used by the OpenVPN instance</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td>
<td>none | SHA1 | SHA256 | SHA384 | SHA512; Default: <b>SHA1</b></td>
<td>HMAC authentication algorithm type</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Additional HMAC authentication</td>
<td>yes | no; Default: <b>no</b></td>
<td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads an HMAC authentication key file</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC key direction</td>
<td>0 | 1 | none; Default: <b>1</b></td>
<td>The value of the key direction parameter should be complementary on either side (client and server) of the connection. If one side uses <i>0</i>, the other side should use <i>1</i>, or both sides should omit the parameter altogether</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Certificate authority</td>
<td>.ca file; Default: <b>none</b></td>
<td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Client certificate</td>
<td>.crt file; Default: <b>none</b></td>
<td>Client certificate is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Client key</td>
<td>.key file; Default: <b>none</b></td>
<td>Authenticates the client to the server and establishes precisely who they are</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Private key decryption password (optional)</td>
<td>string; Default: <b>none</b></td>
<td>A password used to decrypt the server's private key. Use only if server's .key file is encrypted with a password</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads a secret key file used for server–client authentication</td>
</tr>
</table>
<ul>
<li><b>Additional note 1</b>: some parameters become available only when a certain authentication type is selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different praefixa:
<ul>
<li>Red for <span style="color: red;">TLS</span></li>
<li>Purple for <span style="color: purple;">Static key</span></li>
<li>Blue for <span style="color: #0054a6;">Password</span></li>
</ul>
</li>
<li><b>Additional note 2</b>: after changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li>
</ul>
===OpenVPN server===
----
An <b>OpenVPN server</b> is an entity that waits for incoming connections from OpenVPN clients. To create a new server intance, go to the Services → VPN → OpenVPN section, select <i>Role: Server</i>, enter a custom name and click "Add New". An OpenVPN server instance with the given name will appear in the "OpenVPN Configuration list". Only one OpenVPN server instance is allowed to be added.
A server needs to have a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]] in order to be available from the public network (the Internet).
To begin configuration, click the "Edit" button next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
[[File:{{{file_openvpn_server_config}}}]]
<table class="nd-mantable">
<tr>
<th>Field name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; Default: <b>no</b></td>
<td>Turns the OpenVPN instance ON or OFF</td>
</tr>
<tr>
<td>TUN/TAP</td>
<td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<ul>
<li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally used when routing is required</li>
<li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>UDP | TCP; Default: <b>UDP</b></td>
<td>Transfer protocol used for the connection. The
<ul>
<li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, file transfer)</li>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls)</li>
</ul>
</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; Default: <b>1194</b></td>
<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router</td>
</tr>
<tr>
<td>LZO</td>
<td>yes | no; Default: <b>no</b></td>
<td>Enables LZO data compression</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; Default: <b>BF-CBC 128</b></td>
<td>Packet encryption algorithm</td>
</tr>
<tr>
<td>Authentication</td>
<td>TLS | Static Key | TLS/Password; Default: <b>TLS</b></td>
<td>Authentication mode, used to secure data sessions.
<ul>
<li><b>Static key</b> is a secret key used for server–client authentication.</li>
<li><b>TLS</b> authentication mode uses X.509 type certificates:
<ul>
<li>Certificate Authority (CA)</li>
<li>Client certificate</li>
<li>Client key</li>
</ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
</li>
<li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
</ul>
</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the local network interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the remote network (server) interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>LAN IP address of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote network IP netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> TLS cipher</td>
<td>All | DHE+RSA | Custom; Default: <b>All</b></td>
<td>Packet encryption algorithm cipher</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Client to client</td>
<td>yes | no; Default: <b>no</b></td>
<td>Allows OpenVPN clients to communicate with each other on the VPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Keep alive</td>
<td>two integers separated by a space; Default: <b>none</b></td>
<td>Defines two time intervals: one is used to periodically send ICMP request by the client to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>IP address of the OpenVPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>Subnet mask of the OpenVPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Push option</td>
<td>OpenVPN options; Default: <b>none</b></td>
<td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Allow duplicate certificates</td>
<td>yes | no; Default: <b>no</b></td>
<td>When enabled allows multiple clients to connect using the same certificates</td>
</tr>
<tr>
<td><span style="color: #0054a6;">TLS/Password:</span> User name</td>
<td>string; Default: <b>none</b></td>
<td>User name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: #0054a6;">TLS/Password:</span> Password</td>
<td>string; Default: <b>none</b></td>
<td>Password name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads a secret key file used for server–client authentication</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Certificate authority</td>
<td>.ca file; Default: <b>none</b></td>
<td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server certificate</td>
<td>.crt file; Default: <b>none</b></td>
<td>A type of digital certificate that is used to identify the OpenVPN server</td>
</tr>
<tr>
<td><<span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server key</td>
<td>.key file; Default: <b>none</b></td>
<td>Authenticates clients to the server</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Diffie Hellman parameters</td>
<td>.pem file; Default: <b>none</b></td>
<td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> CRL file (optional)</td>
<td>.pem file | .crl file; Default: <b>none</b></td>
<td>A certificate revocation list (CRL) file is a list of certificates that have been revoked the the certificate authority (CA). It indicates which certificates are no longer acccepted by the CA and therefore cannot be authenticated to the server</td>
</tr>
</table>
<ul>
<li><b>Additional note 1</b>: some parameters become available only when a certain authentication type is selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different praefixa:
<ul>
<li>Red for <span style="color: red;">TLS</span></li>
<li>Purple for <span style="color: purple;">Static key</span></li>
<li>Blue for <span style="color: #0054a6;">TLS/Password</span></li>
</ul>
</li>
<li><b>Additional note 2</b>: after changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li>
</ul>
====TLS Clients====
----
[[File:{{{file_openvpn_tls_clients_config}}}]]
<b>Virtual Private Network</b> (<b>VPN</b>) is a method of connecting multiple private networks across the Internet. VPNs can serve to achieve many different goals, but some of its main purposes are:
<ul>
<li>access between remote private networks;</li>
<li>data encryption;</li>
<li>anonymity when browsing the Internet.</li>
</ul>
This page is an overview of different types of VPNs supported by {{{name}}} routers.
==OpenVPN==
<b>OpenVPN</b> is an open-source software application that implements virtual private network (VPN) techniques for creating secure point-to-point or site-to-site connections in routed or bridged configurations and remote access facilities. It is often regarding as being the most universal VPN protocol because of its flexibility, support of SSL/TLS security, multiple encryption methods, many networking features and compatibility with most OS platforms.
{{{name}}} routers run OpenVPN version <b>2.4.5</b>.
For more in-depth guides refer to our <b>[[OpenVPN configuration examples]]</b> page.
===OpenVPN client===
----
An <b>OpenVPN client</b> is an entity that initiates a connection to an OpenVPN server. To create a new server intance, go to the Services → VPN → OpenVPN section, select <i>Role: Client</i>, enter a custom name and click "Add New". An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration list". A maximum of six OpenVPN client instances are allowed to be added.
To begin configuration, click the "Edit" button next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
[[File:{{{file_openvpn_client_config}}}]]
<table class="nd-mantable">
<tr>
<th>Field name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; Default: <b>no</b></td>
<td>Turns the OpenVPN instance ON or OFF</td>
</tr>
<tr>
<td>TUN/TAP</td>
<td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<ul>
<li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally used when routing is required</li>
<li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>UDP | TCP; Default: <b>UDP</b></td>
<td>Transfer protocol used for the connection. The
<ul>
<li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, file transfer)</li>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls)</li>
</ul>
</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; Default: <b>1194</b></td>
<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router</td>
</tr>
<tr>
<td>LZO</td>
<td>yes | no; Default: <b>no</b></td>
<td>Enables LZO data compression</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; Default: <b>BF-CBC 128</b></td>
<td>Packet encryption algorithm</td>
</tr>
<tr>
<td>Authentication</td>
<td>TLS | Static Key | Password | TLS/Password; Default: <b>TLS</b></td>
<td>Authentication mode, used to secure data sessions.
<ul>
<li><b>Static key</b> is a secret key used for server–client authentication.</li>
<li><b>TLS</b> authentication mode uses X.509 type certificates:
<ul>
<li>Certificate Authority (CA)</li>
<li>Client certificate</li>
<li>Client key</li>
</ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
</li>
<li><b>Password</b> is a simple username/password based authentication where the owner of the OpenVPN server provides the login data.</li>
<li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
</ul>
</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> TLS cipher</td>
<td>All | DHE+RSA | Custom; Default: <b>All</b></td>
<td>Packet encryption algorithm cipher</td>
</tr>
<tr>
<td>Remote host / IP address</td>
<td>ip; Default: <b>none</b></td>
<td>IP address or hostname of an OpenVPN server</td>
</tr>
<tr>
<td>Resolve retry</td>
<td>integer | infinite; Default: <b>infinite</b></td>
<td>In case server hostname resolve fails, this field indicates the amount of time (in seconds) to retry the resolve. Specify <i>infinite</i> to retry indefinitely</td>
</tr>
<tr>
<td>Keep alive</td>
<td>two integers separated by a space; Default: <b>none</b></td>
<td>Defines two time intervals: one is used to periodically send ICMP request to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the local network interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the remote network (server) interface</td>
</tr>
<tr>
<td>Remote network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>LAN IP address of the remote network (client)</td>
</tr>
<tr>
<td>Remote network IP netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: #0054a6;">Password:</span> User name</td>
<td>string; Default: <b>none</b></td>
<td>User name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: #0054a6;">Password:</span> Password</td>
<td>string; Default: <b>none</b></td>
<td>Password name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td>Extra options</td>
<td>string; Default: <b>none</b></td>
<td>Extra options to be used by the OpenVPN instance</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td>
<td>none | SHA1 | SHA256 | SHA384 | SHA512; Default: <b>SHA1</b></td>
<td>HMAC authentication algorithm type</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Additional HMAC authentication</td>
<td>yes | no; Default: <b>no</b></td>
<td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads an HMAC authentication key file</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC key direction</td>
<td>0 | 1 | none; Default: <b>1</b></td>
<td>The value of the key direction parameter should be complementary on either side (client and server) of the connection. If one side uses <i>0</i>, the other side should use <i>1</i>, or both sides should omit the parameter altogether</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Certificate authority</td>
<td>.ca file; Default: <b>none</b></td>
<td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Client certificate</td>
<td>.crt file; Default: <b>none</b></td>
<td>Client certificate is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Client key</td>
<td>.key file; Default: <b>none</b></td>
<td>Authenticates the client to the server and establishes precisely who they are</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> Private key decryption password (optional)</td>
<td>string; Default: <b>none</b></td>
<td>A password used to decrypt the server's private key. Use only if server's .key file is encrypted with a password</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads a secret key file used for server–client authentication</td>
</tr>
</table>
<ul>
<li><b>Additional note 1</b>: some parameters become available only when a certain authentication type is selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different praefixa:
<ul>
<li>Red for <span style="color: red;">TLS</span></li>
<li>Purple for <span style="color: purple;">Static key</span></li>
<li>Blue for <span style="color: #0054a6;">Password</span></li>
</ul>
</li>
<li><b>Additional note 2</b>: after changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li>
</ul>
===OpenVPN server===
----
An <b>OpenVPN server</b> is an entity that waits for incoming connections from OpenVPN clients. To create a new server intance, go to the Services → VPN → OpenVPN section, select <i>Role: Server</i>, enter a custom name and click "Add New". An OpenVPN server instance with the given name will appear in the "OpenVPN Configuration list". Only one OpenVPN server instance is allowed to be added.
A server needs to have a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]] in order to be available from the public network (the Internet).
To begin configuration, click the "Edit" button next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
[[File:{{{file_openvpn_server_config}}}]]
<table class="nd-mantable">
<tr>
<th>Field name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; Default: <b>no</b></td>
<td>Turns the OpenVPN instance ON or OFF</td>
</tr>
<tr>
<td>TUN/TAP</td>
<td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<ul>
<li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally used when routing is required</li>
<li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>UDP | TCP; Default: <b>UDP</b></td>
<td>Transfer protocol used for the connection. The
<ul>
<li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, file transfer)</li>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls)</li>
</ul>
</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; Default: <b>1194</b></td>
<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router</td>
</tr>
<tr>
<td>LZO</td>
<td>yes | no; Default: <b>no</b></td>
<td>Enables LZO data compression</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; Default: <b>BF-CBC 128</b></td>
<td>Packet encryption algorithm</td>
</tr>
<tr>
<td>Authentication</td>
<td>TLS | Static Key | TLS/Password; Default: <b>TLS</b></td>
<td>Authentication mode, used to secure data sessions.
<ul>
<li><b>Static key</b> is a secret key used for server–client authentication.</li>
<li><b>TLS</b> authentication mode uses X.509 type certificates:
<ul>
<li>Certificate Authority (CA)</li>
<li>Client certificate</li>
<li>Client key</li>
</ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
</li>
<li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
</ul>
</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the local network interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
<td>ip; Default: <b>none</b></td>
<td>OpenVPN IP address of the remote network (server) interface</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>LAN IP address of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Remote network IP netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client)</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> TLS cipher</td>
<td>All | DHE+RSA | Custom; Default: <b>All</b></td>
<td>Packet encryption algorithm cipher</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Client to client</td>
<td>yes | no; Default: <b>no</b></td>
<td>Allows OpenVPN clients to communicate with each other on the VPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Keep alive</td>
<td>two integers separated by a space; Default: <b>none</b></td>
<td>Defines two time intervals: one is used to periodically send ICMP request by the client to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network IP address</td>
<td>ip; Default: <b>none</b></td>
<td>IP address of the OpenVPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network netmask</td>
<td>netmask; Default: <b>none</b></td>
<td>Subnet mask of the OpenVPN network</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Push option</td>
<td>OpenVPN options; Default: <b>none</b></td>
<td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Allow duplicate certificates</td>
<td>yes | no; Default: <b>no</b></td>
<td>When enabled allows multiple clients to connect using the same certificates</td>
</tr>
<tr>
<td><span style="color: #0054a6;">TLS/Password:</span> User name</td>
<td>string; Default: <b>none</b></td>
<td>User name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: #0054a6;">TLS/Password:</span> Password</td>
<td>string; Default: <b>none</b></td>
<td>Password name used for authentication to the OpenVPN server</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
<td>.key file; Default: <b>none</b></td>
<td>Uploads a secret key file used for server–client authentication</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Certificate authority</td>
<td>.ca file; Default: <b>none</b></td>
<td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server certificate</td>
<td>.crt file; Default: <b>none</b></td>
<td>A type of digital certificate that is used to identify the OpenVPN server</td>
</tr>
<tr>
<td><<span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server key</td>
<td>.key file; Default: <b>none</b></td>
<td>Authenticates clients to the server</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Diffie Hellman parameters</td>
<td>.pem file; Default: <b>none</b></td>
<td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> CRL file (optional)</td>
<td>.pem file | .crl file; Default: <b>none</b></td>
<td>A certificate revocation list (CRL) file is a list of certificates that have been revoked the the certificate authority (CA). It indicates which certificates are no longer acccepted by the CA and therefore cannot be authenticated to the server</td>
</tr>
</table>
<ul>
<li><b>Additional note 1</b>: some parameters become available only when a certain authentication type is selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different praefixa:
<ul>
<li>Red for <span style="color: red;">TLS</span></li>
<li>Purple for <span style="color: purple;">Static key</span></li>
<li>Blue for <span style="color: #0054a6;">TLS/Password</span></li>
</ul>
</li>
<li><b>Additional note 2</b>: after changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li>
</ul>
====TLS Clients====
----
[[File:{{{file_openvpn_tls_clients_config}}}]]
