0
edits
Changes
Template:Networking rutos manual vpn (view source)
Revision as of 15:11, 8 September 2021
, 15:11, 8 September 2021→OpenVPN Client
<!-- Template uses {{{name}}}, {{{series}}} -->
<!-- Template uses {{{name}}}, {{{series}}} -->
{{Template:Networking_rutos_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03.1
| fw_version = {{{series}}}_R_00.07.01
| series = {{{series}}}
| series = {{{series}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.3 and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT2XX_R_00.01.14.1 and earlier) user manual page.</i>|}}
==Summary==
==Summary==
<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 regarded 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.
<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 regarded 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}}} devices run OpenVPN version <b>2.4.5</b>.
{{{name}}} devices run OpenVPN version <b>2.5.2</b>.
===OpenVPN client===
===OpenVPN Client===
----
----
An <b>OpenVPN client</b> is an entity that initiates a connection to an OpenVPN server. To create a new client instance, go to the <i>Services → VPN → OpenVPN</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button. An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration" list.
An <b>OpenVPN client</b> is an entity that initiates a connection to an OpenVPN server. To create a new client instance, go to the <i>Services → VPN → OpenVPN</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button. An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration" list.
To begin configuration, click the button that looks liek a pencil next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
[[File:Networking_trb2_vpn_openvpn_client_configuration_v1.png|border|class=tlt-border]]
[[File:Networking_trb2_vpn_openvpn_client_configuration_v2.png|border|class=tlt-border|]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the OpenVPN instance on or off.</td>
<td>Turns the OpenVPN instance on or off.</td>
</tr>
<tr>
<td>Enable external Services</td>
<td>off {{!}}<span style="color:#FF8000 ;"> on</span>; default: <b>off</b></td>
<td>Turns the OpenVPN external Services on or off.</td>
</tr>
<tr>
<td><span style="color:#FF8000 ;">VPN providers</span></td>
<td>Express VPN {{!}} Nord VPN; default: <b>Nord VPN</b></td>
<td>Represents a list of available VPN providers. </td>
</tr>
<tr>
<td><span style="color:#FF8000 ;">VPN servers</span></td>
<td>United Kingdom {{!}} USA {{!}} Australia {{!}} South Africa {{!}} Custom; default: <b>United Kingdom</b></td>
<td>Represents a list of available VPN servers. </td>
</tr>
</tr>
<tr>
<tr>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enables or disables custom OpenVPN config from file.</td>
<td>Enables or disables custom OpenVPN config from file.</td>
</tr>
<tr>
<td><span style="color:#FF8000 ;">Username</span></td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to the VPN server.</td>
</tr>
<tr>
<td><span style="color:#FF8000 ;">Password</span></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the VPN server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Extra OpenVPN options to be used by the OpenVPN instance.</td>
<td>Extra OpenVPN options to be used by the OpenVPN instance.</td>
</tr>
</tr>
<tr>
<td>Certificate files from device</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn on this option if you want to select generated certificate files from device.</td>
</tr>
<tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td>
</ul>
</ul>
===OpenVPN server===
===OpenVPN Server===
----
----
An <b>OpenVPN server</b> is an entity that waits for incoming connections from OpenVPN clients. To create a new server instance, go to the <i>Services → VPN → OpenVPN</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. 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.
An <b>OpenVPN server</b> is an entity that waits for incoming connections from OpenVPN clients. To create a new server instance, go to the <i>Services → VPN → OpenVPN</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. 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.
<b>Generic Routing Encapsulation</b> (<b>GRE</b>) is a tunneling protocol used to establish point-to-point connections between remote private networks. GRE tunnels encapsulate data packets in order to route other protocols over IP networks.
<b>Generic Routing Encapsulation</b> (<b>GRE</b>) is a tunneling protocol used to establish point-to-point connections between remote private networks. GRE tunnels encapsulate data packets in order to route other protocols over IP networks.
===GRE: main & tunnel settings===
===GRE: Main & Tunnel Settings===
----
----
To create a new GRE instance, go to the <i>Services → VPN → GRE</i> section, enter a custom name and click the 'Add' button. A GRE instance with the given name will appear in the "GRE Configuration" list.
To create a new GRE instance, go to the <i>Services → VPN → GRE</i> section, enter a custom name and click the 'Add' button. A GRE instance with the given name will appear in the "GRE Configuration" list.
</table>
</table>
===GRE: routing settings===
===GRE: Routing Settings===
----
----
<b>Routing settings</b> are used to configure routes to networks that are behind the device that hosts the opposite GRE instance. To add a new route, simply click the 'Add' button. For information on configuring the route refer to the figure and table below.
<b>Routing settings</b> are used to configure routes to networks that are behind the device that hosts the opposite GRE instance. To add a new route, simply click the 'Add' button. For information on configuring the route refer to the figure and table below.
To begin configuration, click the button that looks like a pencil located next to the instance.
To begin configuration, click the button that looks like a pencil located next to the instance.
===IPsec instance===
===IPsec Instance===
----
----
The <b>general settings</b> section is used to configure the main IPsec parameters. Refer to the figure and table below for information on the configuration fields located in the general settings section.
The <b>general settings</b> section is used to configure the main IPsec parameters. Refer to the figure and table below for information on the configuration fields located in the general settings section.
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_general_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>A shared password used for authentication between IPsec peers before a secure channel is established.</td>
<td>A shared password used for authentication between IPsec peers before a secure channel is established.</td>
</tr>
</tr>
<!-- removed on 7.0, to return on 7.1 <tr>
<td><span style="color:darkred">Certificate files from device</span></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn on this option if you want to select generated certificate files from device.</td>
</tr> -->
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> Key</td>
<td><span style="color:darkred">X.509:</span> Key</td>
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td>Multiple secrets</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable to show <b>Global Secret Settings</b> section for configuring multiple secrets.</td>
</tr>
</tr>
</table>
</table>
</ul>
</ul>
====Advanced settings====
====Global Secrets Settings====
----
----
This section is displayed when <b>Multiple secrets</b> is enabled in General settings. You can add new instances by pressing <b>Add</b>.
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings_global_secrets_settings.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_general_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Remote Certificate</td>
<td>ID Selector</td>
<td>.crt file; default: <b>none</b></td>
<td>%any, IP or FQDN; default: <b>none</b></td>
<td>A remote certificate file.</td>
<td>Each secret can be preceded by a list of optional ID selectors. A selector is an IP address, a Fully Qualified Domain Name, user@FQDN or %any. When using IKEv1 use IP address.</br><b>NOTE:</b> IKEv1 only supports IP address ID selector.</td>
</tr>
</tr>
</table>
<tr>
<td>Type</td>
<td>psk {{!}} xauth; default: <b>psk</b></td>
<td>IPSec secret type.</br><b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
</tr>
<tr>
<td>Secret</td>
<td>string; default: <b>none</b></td>
<td>A shared password to authenticate between the peers. Minimum length is 5 symbols. All characters are allowed except `.</td>
</tr>
</table>
===IPsec instance: connection settings===
====Advanced Settings====
----
The <b>Advanced settings</b> section is only visible when <b>X.509</b> is selected as Authentication method.
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<!-- removed on 7.0, to return on 7.1 <tr>
<td>Certificate files from device</td>
<td>off | on; default: <b>off</b></td>
<td>Uses certificate file generated on this device instead of uploading. (You can generate certificates within this device via the System → Administration → [[{{{name}}}_Administration#Certificates|Certificates]] page.)</td>
</tr> -->
<tr>
<td>Remote Certificate</td>
<td>.crt file; default: <b>none</b></td>
<td>Selects a certificate file from a computer.</td>
</tr>
</table>
===IPsec Instance: Connection Settings===
----
----
The <b>connection settings</b> section is used to configure the main parameters of an IPsec connection. Refer to the figure and table below for information on the configuration fields located in the connection settings section.
The <b>connection settings</b> section is used to configure the main parameters of an IPsec connection. Refer to the figure and table below for information on the configuration fields located in the connection settings section.
====General settings====
====General Settings====
----
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_connection_settings_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_connection_settings_general_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td><span style="color: red;">Tunnel:</span> Default route</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn on to route all traffic through IPSec tunnel.</td>
</tr>
</tr>
<tr>
<tr>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
</table>
</table>
----
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_connection_settings_advanced_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Aggressive</td>
<td>Aggressive</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn aggressive mode on or off for outgoing connections.</td>
<td>Turn aggressive mode on or off for outgoing connections. Aggressive mode performs fewer exchanges (a total of 4 messages) than Main mode (a total of 6 messages) by storing most data into the first exchange. In aggressive mode, the information is exchanged before there is a secure channel, making it less secure but faster than main mode.<br>Aggressive mode is available only with IKEv1; if IKEv2 is selected this field becomes hidden.</td>
</tr>
</tr>
<tr>
<tr>
<td>Local firewall</td>
<td>Local firewall</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Adds neccessary firewall rules to allow traffic of this IPsec instance on this device.</td>
<td>Adds necessary firewall rules to allow traffic of this IPsec instance on this device.</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote firewall</td>
<td>Remote firewall</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Adds neccessary firewall rules to allow traffic of from the opposite IPsec instance on this device.</td>
<td>Adds necessary firewall rules to allow traffic of from the opposite IPsec instance on this device.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: red;">Tunnel:</span> Passthrough</td>
<td><span style="color: red;">Tunnel:</span> Passthrough interfaces</td>
<td>interface(s); default: <b>none</b></td>
<td>network interfaces; default: <b>none</b></td>
<td>Choose interface(s) for passthrough.</td>
<td>Network interfaces to include in IPsec Passthrough.</td>
</tr>
<tr>
<td><span style="color: red;">Tunnel:</span> Passthrough subnets</td>
<td>ip/netmask; default: <b>none</b></td>
<td>Networks to include in IPsec Passthrough.</td>
</tr>
</tr>
</table>
</table>
===PPTP client===
===PPTP client===
----
----
A <b>PPTP client</b> is an entity that initiates a connection to a PPTP server. To create a new client instance, go to the <i>Services → VPN → PPTP</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button. A PPTP client instance with the given name will appear in the "PPTP Configuration" list.
A <b>PPTP client</b> is an entity that initiates a connection to a PPTP server. To create a new client instance, go to the <i>Services → VPN → PPTP</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button:
[[File:Networking_rutos_vpn_pptp_client_add_button.png|border|class=tlt-border]]
You should be redirected to the configuration page for the newly added PPTP Client which should look similar to this:
[[File:Networking_rutx_vpn_pptp_client_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_pptp_client.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
===PPTP server===
===PPTP server===
----
----
A <b>PPTP server</b> is an entity that waits for incoming connections from PPTP clients. To create a new server instance, go to the <i>Services → VPN → PPTP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. A PPTP server instance with the given name will appear in the "PPTP Configuration" list. Only one PPTP server instance is allowed to be added.
A <b>PPTP server</b> is an entity that waits for incoming connections from PPTP clients. To create a new server instance, go to the <i>Services → VPN → PPTP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button:
[[File:Networking_rutos_vpn_pptp_server_add_button.png|border|class=tlt-border]]
You should be redirected to the configuration page for the newly added PPTP Server which should look similar to this:
[[File:Networking_rutx_vpn_pptp_server_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_pptp_server.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>User name</td>
<td>Timeout</td>
<td>string; default: '''none'''</td>
<td>integer; default: <b>none</b></td>
<td>Username used for authentication to this PPTP server.</td>
<td>Time in seconds. If no packets pass through the tunnel between this server and a client, the server will terminate the connection to that client after the amount of time specified in this field passes.</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>Primary DNS</td>
<td>string; default: '''none'''</td>
<td>ip; default: <b>none</b></td>
<td>Password used for authentication to this PPTP server.</td>
<td>IP address of the primary DNS server.</td>
</tr>
</tr>
<tr>
<tr>
<td>PPTP Client's IP</td>
<td>Secondary DNS</td>
<td>ip; default: <b>none</b></td>
<td>ip; default: <b>none</b></td>
<td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
<td>IP address of the secondary DNS server.</td>
</tr>
</tr>
</table>
</table>
----
The <b>User List</b> section is used to user authentication settings required to successfully connect to this server. The list is empty by default. Click the 'Add' button to create a new PPTP User:
[[File:Networking_rutos_vpn_pptp_server_user_list_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_pptp_server_user_list.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>Username</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to the SSTP server.</td>
<td>Username used for authentication to this PPTP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the SSTP server.</td>
<td>Password used for authentication to this PPTP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>CA cert</td>
<td>PPTP Client's IP</td>
<td>.crt file; default: <b>none</b></td>
<td>ip; default: <b>none</b></td>
<td>Upload a Certificate authority (CA) file.</td>
<td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
</tr>
</tr>
</table>
</table>
<b>Note:</b> there can only one PPTP Server configuration on the device.
==SSTP==
===Stunnel globals===
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
{{#ifeq: TRB1 | RUTX | |
</br><u><b>Note:</b> SSTP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
===SSTP configuration===
----
----
To create a new SSTP instance, go to the Services → VPN → SSTP section, enter a custom name and click the 'Add' button.
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
An SSTP instance with the given name will appear in the "SSTP Configuration" list.
To begin configuration, click the 'Edit' button located next to the instance.
Refer to the figure and table below for information on the SSTP instance's configuration fields:
[[File:Networking_rutx_vpn_stunnel_globals_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_sstp_sstp_instance.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Field</th>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the SSTP instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Server IP address</td>
<td>ip {{!}} host; default: <b>none</b></td>
<td>IP address or hostname of a SSTP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>User name</td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to the SSTP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the SSTP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Certificate files from device</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn on this option if you want to select generated certificate files from device.</td>
</tr>
</tr>
<tr>
<tr>
<td>CA cert</td>
<td>.crt file; default: <b>none</b></td>
<td>Upload a Certificate authority (CA) file.</td>
</tr>
</tr>
<tr>
<tr>
<td>Default route</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>When turned on, this connection will become the device default route. This means that all traffic directed to the Internet will go through the SSTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet. <br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.</td>
</tr>
</tr>
</table>
==Stunnel==
Stunnel is an open-source a proxy service that adds TLS encryption to clients and servers already existing on a VPN network.
TLS encryption provided by Stunnel can be used as an additional layer of encryption for data sent by VPN.
This procedure increases the security of the established connection and provides higher chances of passing a Deep packet inspection (DPI) check.
===Stunnel globals===
----
The Stunnel Globals section is used to manage the Stunnel service as a whole.
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
{{#ifeq: {{{series}}} | RUTX | |
</br><u><b>Note:</b> Stunnel is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
[[File:Networking_rutos_manual_vpn_stunnel_globals.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<td>Listen Port</td>
<th>Field</th>
<td>integer [0..65535]; default: <b>none</b></td>
<th>Value</th>
<td>Makes the instance "listen" for incoming connections on the specified TCP port. Make sure you chose a port that is not being used by another service. You will also have to allow traffic on the specified port.</td>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Connect IP's</td>
<td>Enabled</td>
<td>ip:port; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>IP:Port to listen for VPN connections. When left empty the value of this field is interpreted as <i>localhost</i>.
<td>Turns the Stunnel service on or off. If this is unchecked, Stunnel instances will not start (even if they are enabled individually); therefore, it is necessary to check this field in order to make Stunnel active on the router.</td>
</tr>
</tr>
<tr>
<tr>
<td>TLS Cipher</td>
<td>Debug Level</td>
<td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
<td>integer [0..7]; default: <b>5</b></td>
<td>Packet encryption algorithm cipher.</td>
<td>Debugging to log output level.
<ul>
<li><b>0 (emergency)</b> - a panic condition, i.e., system is no longer usable.</li>
<li><b>1 (alert)</b> - a condition that must be corrected immediately.</li>
<li><b>2 (critical)</b> - critical conditions, device errors.</li>
<li><b>3 (error)</b> - errors that are fatal to the operation, but not the service or application (can't open a required file, missing data, etc.) Solving these types of errors will usually require user intervention.</li>
<li><b>4 (warning)</b> - anything that can potentially cause application oddities, but for which the system is automatically recovering from (e.g., retrying an operation, missing secondary data, etc.)</li>
<li><b>5 (notice)</b> - conditions that are not error conditions, but that may require special handling.</li>
<li><b>6 (info)</b> - general useful information (e.g., configuration changes, starts and stops of services, etc.)</li>
<li><b>7 (debug)</b> - contains basic information that is diagnostically helpful to most people (i.e., not just engineers).</li>
</ul>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
<td>Use alternative config</td>
<td>string; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>A list of TLS ciphers accepted for this connection.</td>
<td>Turns the possibility to upload an external Stunnel configuration file on or off.if you turn this on, other Stunnel configurations present in the router will become inactive.</td>
</tr>
</tr>
<tr>
<tr>
<td>Application Protocol</td>
<td>Upload alternative config</td>
<td>Connect {{!}} SMTP {{!}} Not specified; default: <b>Not specified</b></td>
<td>file; default: <b>none</b></td>
<td>This option enables initial, protocol-specific negotiation of the TLS encryption. The protocol option should not be used with TLS encryption on a separate port.</td>
<td>Uploads an Stunnel configuration file.</td>
</tr>
</tr>
</table>
===Stunnel instance===
----
To create a new Stunnel instance, go to the <i>Services → VPN → Stunnel</i> section, enter a custom name and click the 'Add' button.
An Stunnel instance with the given name will appear in the "Stunnel Configuration" list.
To begin configuration, click the 'Edit' button located next to the instance.
Refer to the figure and table below for information on the Stunnel instance's configuration fields:
[[File:Networking_rutos_manual_vpn_stunnel_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<td><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
<th>Field</th>
<td>Plain {{!}} Login; default: <b>Plain</b></td>
<th>Value</th>
<td>Authentication type for the protocol negotiations.</td>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Certificate File</td>
<td>Enable</td>
<td>.crt file; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>TLS client or server certificate file.</td>
<td>Turns the Stunnel instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Private Key</td>
<td>Operating Mode</td>
<td>.key file; default: <b>none</b></td>
<td>Server {{!}} Client; default: <b>Server</b></td>
<td>TLS client or server key file.</td>
<td>Selects the Stunnel instance's role.
<ul>
<li><b>Server</b> - listens for connecting Stunnel clients.</li>
<li><b>Client</b> - listens for connecting clients and connects to an Stunnel server.</li>
</ul>
</td>
</tr>
<tr>
<td>Listen IP</td>
<td>ip; default: <b>none</b></td>
<td>Makes the instance "listen" for incoming connections on the specified IP address. When left empty, the value of this field defaults to <i>localhost</i> (<i>127.0.0.1</i>).</td>
</tr>
<tr>
<td>Listen Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Makes the instance "listen" for incoming connections on the specified TCP port. Make sure you chose a port that is not being used by another service. You will also have to allow traffic on the specified port.</td>
</tr>
</tr>
</table>
<tr>
<td>Connect IP's</td>
<td>ip:port; default: <b>none</b></td>
<td>IP:Port to listen for VPN connections. When left empty the value of this field is interpreted as <i>localhost</i>.
Must contain at least one item. If multiple options are specified, remote address is chosen using a round-robin algorithm.</td>
</tr>
</tr>
<tr>
<tr>
<td>TLS Cipher</td>
<td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
<td>Packet encryption algorithm cipher.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
<td>string; default: <b>none</b></td>
<td>A list of TLS ciphers accepted for this connection.</td>
</tr>
</tr>
<tr>
<tr>
<td>Application Protocol</td>
<td>Connect {{!}} SMTP {{!}} Not specified; default: <b>Not specified</b></td>
<td>This option enables initial, protocol-specific negotiation of the TLS encryption. The protocol option should not be used with TLS encryption on a separate port.</td>
</tr>
</tr>
</table>
<tr>
<br>
<td><span style="color:darkred">Connect:</span> Protocol Authentication</td>
<td>Basic {{!}} NTLM; default: <b>Basic</b></td>
<td>Authentication type for the protocol negotiations.</td>
<table class="nd-mantable">
<th>Field</th>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
<td>Plain {{!}} Login; default: <b>Plain</b></td>
<td>Authentication type for the protocol negotiations.</td>
</tr>
</tr>
<tr>
<tr>
<td>Certificate File</td>
<td>.crt file; default: <b>none</b></td>
<td>TLS client or server certificate file.</td>
</tr>
</tr>
<tr>
<tr>
<td>Private Key</td>
<td>.key file; default: <b>none</b></td>
<td>TLS client or server key file.</td>
</tr>
</tr>
</table>
</table>
<table class="nd-mantable">
<b>Additional notes</b>:
<tr>
<ul>
<th>Field</th>
<li>Some configuration fields become available only when certain other parameters are 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 prefixes:
<th>Value</th>
<ul>
<li>Blue for <span style="color: #0054a6;">TLS Cipher: Custom</span></li>
<li>Dark red for <span style="color: darkred;">Application Protocol: Connect</span></li>
<li>Chocolate for <span style="color: chocolate;">Application Protocol: SMTP</span></li>
</ul>
</li>
</ul>
==DMVPN==
<b>Dynamic Multipoint VPN</b> (<b>DMVPN</b>) is a method of building scalable IPsec VPNs. DMVPN is configured as a hub-and-spoke network, where tunnels between spokes are built dynamically; therefore, no change in configuration is required on the hub in order to connect new spokes.
{{#ifeq: {{{series}}} | RUTX | |
</br><u><b>Note:</b> DMPVN is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
===DMVPN configuration===
----
To create a new DMVPN instance, go to the <i>Services → VPN → DMVPN</i> section, enter a custom name and click the 'Add' button. A DMVPN instance with the given name will appear in the "DMVPN Configuration" list.
To begin configuration, click the button that looks like a pencil located next to the instance. Refer to the figures and tables below for information on the DMVPN instance configuration:
[[File:Networking_rutos_manual_vpn_dmvpn_dmvpn_parameters_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Enabled</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the DMVPN instance on or off.</td>
</tr>
<tr>
<tr>
<td>Working mode</td>
<td>Spoke {{!}} Hub; default: <b>Spoke</b></td>
<td>Selects the role of this instance
<ul>
<ul>
<li><b>IP</b> - Internet Protocol address.</li>
<li><b>Hub</b> - the central instance of DMVPN that connects other peers (spokes) into single network. There is no need to reconfigure the hub when connecting new spokes to it.</li>
<li><b>FQDN</b> - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, <i>something.somedomain.com</i>). Only supported with IKEv2.</li>
<li><b>Spoke</b> - an instance that connects to the hub.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
<tr>
<tr>
<td>Hub address</td>
<td>ip {{!}} host; default: '''none'''</td>
<td>IP address or hostname of a DMVPN hub.</td>
</tr>
</tr>
</table>
<br>
----
[[File:Networking_rutos_manual_vpn_dmvpn_gre_parameters_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Tunnel source</td>
<td>network interface; default: <b>none</b></td>
<td>Network interface used to establish the GRE Tunnel.</td>
</tr>
</tr>
<tr>
<tr>
<td>Local GRE interface IP address</td>
<td>ip; default: <b>none</b></td>
<td>IP address of the local GRE Tunnel instance.</td>
</tr>
</tr>
<tr>
<tr>
<td>Force crypto proposal</td>
<td><span style="color: red;">Spoke:</span> Remote GRE interface IP address</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>ip; default: <b>none</b></td>
<td>Only chosen proposals will be used when turned on.</td>
<td>IP address of the remote GRE Tunnel instance.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: purple;">Hub:</span> Local GRE interface netmask</td>
<td>netmask; default: <b>none</b></td>
<td>Subnet mask of the local GRE Tunnel instance.</td>
</tr>
<tr>
<td>GRE MTU</td>
<td>integer; default: <b>none</b></td>
<td>Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.</td>
</tr>
<tr>
<td>GRE keys</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify incoming and outgoing GRE packets.</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
----
----
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_dmvpn_ipsec_parameters_configuration_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Local identifier</td>
<td>ip {{!}} string; default: <b>none</b></td>
<td>Defines how the user (IPsec instance) will be identified during authentication.
<ul>
<li><b>IP</b> - Internet Protocol address.</li>
<li><b>FQDN</b> - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, <i>something.somedomain.com</i>). Only supported with IKEv2.</li>
</ul>
</td>
<tr>
<tr>
<td>Remote identifier</td>
<td>ip {{!}} string; default: <b>none</b></td>
<td>A key used in NHRP authentication.</td>
<td>Defines how the right participant will be identified during authentication.
<ul>
<li><b>IP</b> - Internet Protocol address.</li>
<li><b>FQDN</b> - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, <i>something.somedomain.com</i>). Only supported with IKEv2.</li>
</ul>
</td>
</tr>
<tr>
<td>Pre-shared key</td>
<td>string; default: <b>none</b></td>
<td>A shared password used for authentication between IPsec peers.</td>
</tr>
</tr>
<tr>
<tr>
<td>Encryption algorithm</td>
<td>3DES {{!}} AES 128 {{!}} AES 192 {{!}} AES 256 {{!}} AES128 GCM8 {{!}} AES192 GCM8 {{!}} AES256 GCM8 {{!}} AES128 GCM12 {{!}} AES192 GCM12 {{!}} AES256 GCM12 {{!}} AES128 GCM16 {{!}} AES192 GCM16 {{!}} AES256 GCM16; default: <b>AES 128</b></td>
<td>Algorithm used for data encryption.</td>
</tr>
<tr>
<td>Authentication/Hash algorithm</td>
<td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
<td>Algorithm used for exchanging authentication and hash information.</td>
</tr>
</tr>
<tr>
<tr>
<td>DH/PFS group</td>
<td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521; default: <b>MODP1536</b></td>
<td>Diffie-Hellman (DH) group used in the key exchange process. Higher group numbers provide more security, but take longer and use more resources to compute the key. Must match with another incoming connection to establish IPSec. </td>
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>Force crypto proposal</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the L2TP instance on or off.</td>
<td>Only chosen proposals will be used when turned on.</td>
</tr>
</tr>
<tr>
<tr>
<td>IKE Lifetime</td>
<td>string; default: <b>none</b></td>
<td>How long the keying channel of a connection (ISAKMP or IKE SA) should last before being renegotiated. The time is specified in seconds. The s, m, h and d suffixes explicitly define the units for seconds, minutes, hours and days, respectively.</td>
</tr>
</table>
<br>
----
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Username</td>
<td>NHRP network ID</td>
<td>string; default: <b>none</b></td>
<td>integer; default: <b>1</b></td>
<td>Username used for authentication to the L2TP server.</td>
<td>An identifier used to define the NHRP domain. This is a local parameter and its value does not need to match the values specified on other domains. However, the NHRP ID is added to packets which arrive on the GRE interface; therefore, it may be helpful to use the same ID for troubleshooting purposes.</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>NHRP authentication key</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>A key used in NHRP authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td>Default route</td>
<td>NHRP hold time</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>integer; default: <b>7200</b></td>
<td>When turned on, this connection will become device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.{{#ifeq:{{{series}}}|RUTX|<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
<td>Specifies the holding time for NHRP Registration Requests and Resolution Replies sent from this interface or shortcut-target. The hold time is specified in seconds and defaults to two hours.</td>
</tr>
</tr>
</table>
</table>
===L2TP server===
==L2TP==
In computer networking, <b>Layer 2 Tunneling Protocol</b> (<b>L2TP</b>) is a tunneling protocol used to support virtual private networks (VPNs). It is more secure than PPTP but, because it encapsulates the transferred data twice, but it is slower and uses more CPU power.
===L2TP client===
----
----
An <b>L2TP server</b> is an entity that waits for incoming connections from L2TP clients. To create a new server instance, go to the <i>Services → VPN → L2TP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. An L2TP server instance with the given name will appear in the "L2TP Configuration" list. Only one L2TP server instance is allowed to be added.
An <b>L2TP client</b> is an entity that initiates a connection to an L2TP server. To create a new client instance, go to the <i>Services → VPN → L2TP</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button. An L2TP client instance with the given name will appear in the "L2TP Configuration" list.
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the L2TP client's configuration fields:
[[File:Networking_rutos_manual_vpn_l2tp_client.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_l2tp_server_configuration_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Local IP</td>
<td>Server</td>
<td>ip; default: <b>192.168.0.1</b></td>
<td>ip {{!}} host; default: <b>none</b></td>
<td>IP address of this L2TP network interface.</td>
<td>IP address or hostname of an L2TP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote IP range begin</td>
<td>Username</td>
<td>ip; default: <b>192.168.0.20</b></td>
<td>string; default: <b>none</b></td>
<td>L2TP IP address leases will begin from the address specified in this field.</td>
<td>Username used for authentication to the L2TP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote IP range end</td>
<td>Password</td>
<td>ip; default: <b>192.168.0.30</b></td>
<td>string; default: <b>none</b></td>
<td>L2TP IP address leases will end with the address specified in this field.</td>
<td>Password used for authentication to the L2TP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>User name</td>
<td>Default route</td>
<td>string; default: <b>user</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Username used for authentication to this L2TP server.</td>
<td>When turned on, this connection will become device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.{{#ifeq:{{{series}}}|RUTX|<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
</tr>
</tr>
</table>
===L2TP server===
----
An <b>L2TP server</b> is an entity that waits for incoming connections from L2TP clients. To create a new server instance, go to the <i>Services → VPN → L2TP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. An L2TP server instance with the given name will appear in the "L2TP Configuration" list. Only one L2TP 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 button that looks like a pencil next to the server instance. Refer to the figure and table below for information on the L2TP server's configuration fields:
[[File:Networking_rutx_vpn_l2tp_server_configuration_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<td>Password</td>
<th>Field</th>
<td>string; default: <b>pass</b></td>
<th>Value</th>
<td>Password used for authentication to this L2TP server.</td>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the L2TP instance on or off.</td>
</tr>
<tr>
<td>Local IP</td>
<td>ip; default: <b>192.168.0.1</b></td>
<td>IP address of this L2TP network interface.</td>
</tr>
<tr>
<td>Remote IP range begin</td>
<td>ip; default: <b>192.168.0.20</b></td>
<td>L2TP IP address leases will begin from the address specified in this field.</td>
</tr>
<tr>
<td>Remote IP range end</td>
<td>ip; default: <b>192.168.0.30</b></td>
<td>L2TP IP address leases will end with the address specified in this field.</td>
</tr>
</tr>
<tr>
<tr>
<td>L2TP Client's IP</td>
<td>User name</td>
<td>string; default: <b>user</b></td>
<td>Username used for authentication to this L2TP server.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>pass</b></td>
<td>Password used for authentication to this L2TP server.</td>
</tr>
<tr>
<td>L2TP Client's IP</td>
<td>ip; default: <b>none</b></td>
<td>ip; default: <b>none</b></td>
<td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
<td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
</tr>
</table>
==L2TPv3==
L2TPv3 (Layer Two Tunneling Protocol Version 3) is a point-to-point layer two over IP tunnel. This means you can tunnel L2 protocols like Ethernet, Frame-relay, ATM, HDLC, PPP, etc. over an IP network.
===Local settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_local_settings_v1.png]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the L2TPv3 instance on or off.</td>
</tr>
<tr>
<td>Local address</td>
<td>ip; default: <b>none</b></td>
<td>IP address of device's WAN. Note: If left empty, it will take IP address automatically from main WAN interface. <td>
</tr>
<tr>
<td>Tunnel ID</td>
<td>integer [1..4294967295]; default: <b>none</b></td>
<td>Uniquely identifies the tunnel. The value used must match the peer tunnel ID value being used at the peer.</td>
</tr>
<tr>
<td>Session ID</td>
<td>integer [1..4294967295]; default: <b>none</b></td>
<td>The value used must match the tunnel ID value being used at the peer.</td>
</tr>
<tr>
<td>Cookie</td>
<td>string; default: <b>none</b></td>
<td>Must be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF.</td>
</tr>
</table>
===Peer settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_peer_settings_v1.png]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Peer address</td>
<td>ip; default: <b>none</b></td>
<td>Peer Endpoint IP address.</td>
</tr>
<tr>
<td>Peer Tunnel ID</td>
<td>integer [1..4294967295]; default: <b>none</b></td>
<td>ID of peer's tunnel is specified from 1 to 4294967295. It must match other end tunnel ID.<td>
</tr>
<tr>
<td>Peer Session ID</td>
<td>integer [1..4294967295]; default: <b>none</b></td>
<td>UID of peer's session is specified from 1 to 4294967295. It must match other end session ID. </td>
</tr>
<tr>
<td>Peer Cookie</td>
<td>string; default: <b>none</b></td>
<td>Must be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF. It must match other end Cookie.</td>
</tr>
</table>
===Instance Settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_instance_settings_v1.png]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Bridge to</td>
<td>None {{!}} LAN; default: <b>None</b></td>
<td>Peer Endpoint IP address.</td>
</tr>
<tr>
<td>IP Address</td>
<td>ip; default: <b>none</b></td>
<td>IP address of standalone L2TPv3 interface.<td>
</tr>
<tr>
<td>Netmask</td>
<td>netmask; default: <b>none</b></td>
<td>Netmask of standalone L2TPv3 interface. </td>
</tr>
<tr>
<td>MTU</td>
<td>integer [64..9000]; default: <b>none</b></td>
<td>Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.</td>
</tr>
<tr>
<td>Encapsulation</td>
<td>IP {{!}} UDP; default: <b>IP</b></td>
<td>Specify technology to use when connecting to other end.</td>
</tr>
<tr>
<td>Layer 2 specific header type</td>
<td>None {{!}} Linux Default; default: <b>Linux Default</b></td>
<td>It might be neccessary to set this option to none when using other hardware.</td>
</tr>
</table>
==ZeroTier==
<b>ZeroTier One</b> is an open source software which can establish Peer to Peer VPN (P2PVPN) connection between various devices running various operating systems. It also provides network management possibilities such as routing and creating firewall rules.
<u><b>Note:</b> ZeroTier is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
----
In order to create a new ZeroTier Instance, look to the Add New ZeroTier Configuration section; enter a custom name and click the 'Add' button:
[[File:Networking_rutos_manual_vpn_zerotier_add_button.png|border|class=tlt-border]]
You should be redirected to the configuration page for the newly added ZeroTier Instance which should look similar to this:
[[File:Networking_rutos_manual_vpn_zerotier_instance.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enabled</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the ZeroTier Instance on or off.</td>
</tr>
<tr>
<td>Networks/td>
<td>hex string; default: <b>none</b></td>
<td>ZeroTier Network ID. Log in to your ZeroTier account in order to locate the ZeroTier Network ID, which should be a string of hexadecimal characters.</td>
</tr>
<tr>
<td>Port/td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>ZeroTier Network port.</td>
</tr>
</table>
==WireGuard==
'''WireGuard''' is simple, fast, lean, and modern VPN that utilizes secure and trusted cryptography.
It intends to be more performant than OpenVPN. WireGuard is designed as general purpose VPN, fit for
many different circumstances and while it is currently under heavy development, it already
might be regarded as the most secure, easiest to use, and simplest VPN solution.
<u><b>Note:</b> WireGuard is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
WireGuard works by adding an interface which acts as a tunnel. To create one enter its name and click the <b>Add</b> button.
To configure it click the <b>Edit</b> [[File:Networking_rutx_manual_edit_button_v1.png]] button.
[[File:Networking_rutx_vpn_wireguard_v1.png|border|class=tlt-border]]
===General Instance Settings===
----
This section contains General settings of created WireGuard Instance. Here you can find its Public and
Private keys and generate them, specify Port and IP addresses for communication.
[[File:Networking_rutx_vpn_wireguard_instance_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns WireGuard Instance on or off.</td>
</tr>
<tr>
<td>Private Key</td>
<td>string; default: <b>none</b></td>
<td>Private Key used in authentication.</td>
</tr>
<tr>
<td>Public Key</td>
<td>string; default: <b>-</b></td>
<td>Public Key used in authentication.</td>
</tr>
<tr>
<td>Generate</td>
<td>-(interactive button)</td>
<td>Click to generate Public Key and Private Key.</td>
</tr>
<tr>
<td>Listen Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify port to listen for incomming connections. It will be set to a random integer if left empty.</td>
</tr>
<tr>
<td>IP Addresses</td>
<td>ip; default: <b>none</b></td>
<td>A single IP address or a list of them for this instance associated with public keys.</td>
</tr>
</table>
====Advanced Settings====
----
Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
[[File:Networking_rutx_vpn_wireguard_instance_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Metric</td>
<td>positive integer; default: <b>none</b></td>
<td>Specify metric for this tunnel interface. Lower number means higher priority.</td>
</tr>
<tr>
<td>MTU</td>
<td>integer [1280..1420]; default: <b>none</b></td>
<td>Maximum Transmission Unit for this tunnel interface.</td>
</tr>
</table>
===Peers===
----
The Peers section is used to create and configure all the peers for this interface.
To create one enter its name and click the <b>Add</b> button.
To configure it click the <b>Edit</b> [[File:Networking_rutx_manual_edit_button_v1.png]] button.
[[File:Networking_rutx_vpn_wireguard_instance_peer_v2.png|border|class=tlt-border]]
====General Peer Settings====
----
In the General section of Peer instance you can configure basic information about the endpoint to allow communications.
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Public Key</td>
<td>string; default: <b>none</b></td>
<td>Endpoint's Public Key.</td>
</tr>
<tr>
<td>Allowed IPs</td>
<td>ip; default: <b>none</b></td>
<td>A single IP address or a list of them which are allowed to communicate with this peer.</td>
</tr>
</table>
====Advanced Peer Settings====
----
In the Advanced section of Peer instance you are able to configure additional
settings such as its Description, Endpoint Host and Port, Preshared Key and other.
See more information below.
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Description of this peer.</td>
</tr>
<tr>
<td>Pre-Shared Key</td>
<td>string; default: <b>none</b></td>
<td>Base64-encoded preshared key. Adds in an additional layer of symmetric-key cryptography for post-quantum resistance.</td>
</tr>
<tr>
<td>Route Allowed IPs</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
</tr>
<tr>
<td>Endpoint Host</td>
<td>ip {{!}} url; default: <b>none</b></td>
<td>IP or URL of Remote Endpoint.</td>
</tr>
<tr>
<td>Endpoint Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify port to connect to Remote Endpoint. It will be set to <b>51820</b> if left empty.</td>
</tr>
<tr>
<td>Persistent Keep Alive</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify time amount in seconds between Keep Alive messages. By default this option is <b>0</b> which means it is disabled. Recommended value for a device behind NAT is 25.</td>
</tr>
</tr>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
