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.04.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_v2.png|border|class=tlt-border|]]
[[File:Networking_trb2_vpn_openvpn_client_configuration_v2.png|border|class=tlt-border|]]
</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>
<tr>
<!-- removed on 7.0, to return on 7.1 <tr>
<td><span style="color:darkred">Certificate files from device</span></td>
<td><span style="color:darkred">Certificate files from device</span></td>
<td>off {{!}} on; default: <b>off</b></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>
<td>Turn on this option if you want to select generated certificate files from device.</td>
</tr>
</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]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>ID Selector</td>
<td>%any, IP or FQDN; default: <b>none</b></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>
<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>
====Advanced Settings====
----
----
The <b>Advanced settings</b> section is only visible when <b>X.509</b> is selected as Authentication method.
The <b>Advanced settings</b> section is only visible when <b>X.509</b> is selected as Authentication method.
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_general_advanced_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<th>Description</th>
<th>Description</th>
</tr>
</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>
<tr>
<td>Remote Certificate</td>
<td>Remote Certificate</td>
<td>.crt file; default: <b>none</b></td>
<td>.crt file; default: <b>none</b></td>
<td>A remote certificate file.</td>
<td>Selects a certificate file from a computer.</td>
</tr>
</tr>
</table>
</table>
===IPsec instance: connection settings===
===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]]
[[File:Networking_rutx_vpn_pptp_client_configuration_v2.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_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">
<table class="nd-mantable">
<tr>
<tr>
<th>Field</th>
<th>Field</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>Certificate files from device</td>
<td>PPTP Client's IP</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>ip; default: <b>none</b></td>
<td>Turn on this option if you want to select generated certificate files from device.</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>
<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>
</table>
<tr>
<td>CA cert</td>
===Stunnel instance===
<td>.crt file; default: <b>none</b></td>
<td>Upload a Certificate authority (CA) file.</td>
</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>
</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 Stunnel instance's configuration fields:
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
{{#ifeq: {{{series}}} | RUTX | |
[[File:Networking_rutx_vpn_stunnel_instance_v1.png|border|class=tlt-border]]
</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">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>Enabled</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the Stunnel instance on or off.</td>
<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>Operating Mode</td>
<td>Debug Level</td>
<td>Server {{!}} Client; default: <b>Server</b></td>
<td>integer [0..7]; default: <b>5</b></td>
<td>Selects the Stunnel instance's role.
<td>Debugging to log output level.
<ul>
<ul>
<li><b>Server</b> - listens for connecting Stunnel clients.</li>
<li><b>0 (emergency)</b> - a panic condition, i.e., system is no longer usable.</li>
<li><b>Client</b> - listens for connecting clients and connects to an Stunnel server.</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>
</ul>
</tr>
</tr>
<tr>
<tr>
<td>Listen IP</td>
<td>Use alternative config</td>
<td>ip; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</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>
<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>Listen Port</td>
<td>Upload alternative config</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>file; 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>
<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>TLS Cipher</td>
<th>Field</th>
<td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
<th>Value</th>
<td>Packet encryption algorithm cipher.</td>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
<td>Enable</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 Stunnel instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Application Protocol</td>
<td>Operating Mode</td>
<td>Connect {{!}} SMTP {{!}} Not specified; default: <b>Not specified</b></td>
<td>Server {{!}} Client; default: <b>Server</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>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>
<tr>
<tr>
<td><span style="color:darkred">Connect:</span> Protocol Authentication</td>
<td>Listen IP</td>
<td>Basic {{!}} NTLM; default: <b>Basic</b></td>
<td>ip; default: <b>none</b></td>
<td>Authentication type for the protocol negotiations.</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>
<tr>
<tr>
<td><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
<td>Listen Port</td>
<td>Plain {{!}} Login; default: <b>Plain</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Authentication type for the protocol negotiations.</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>
<tr>
<tr>
<td>Certificate File</td>
<td>Connect IP's</td>
<td>.crt file; default: <b>none</b></td>
<td>ip:port; default: <b>none</b></td>
<td>TLS client or server certificate file.</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>
<td>TLS Cipher</td>
<td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
<td>Packet encryption algorithm cipher.</td>
</tr>
</tr>
<tr>
<tr>
<td>Private Key</td>
<td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
<td>.key file; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>TLS client or server key file.</td>
<td>A list of TLS ciphers accepted for this connection.</td>
</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>
<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:
<ul>
<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.
</tr>
</tr>
<tr>
<tr>
<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>
</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>
<br>
<b>Additional notes</b>:
<ul>
<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:
<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===
----
----
[[File:Networking_rutx_vpn_dmvpn_gre_parameters_configuration_v1.png]]
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">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Tunnel source</td>
<td>Enabled</td>
<td>network interface; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Network interface used to establish the GRE Tunnel.</td>
<td>Turns the DMVPN instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Local GRE interface IP address</td>
<td>Working mode</td>
<td>ip; default: <b>none</b></td>
<td>Spoke {{!}} Hub; default: <b>Spoke</b></td>
<td>IP address of the local GRE Tunnel instance.</td>
<td>Selects the role of this instance
<ul>
<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>Spoke</b> - an instance that connects to the hub.</li>
</ul>
</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: red;">Spoke:</span> Remote GRE interface IP address</td>
<td>Hub address</td>
<td>ip; default: <b>none</b></td>
<td>ip {{!}} host; default: '''none'''</td>
<td>IP address of the remote GRE Tunnel instance.</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>
<td><span style="color: purple;">Hub:</span> Local GRE interface netmask</td>
<th>Field</th>
<td>netmask; default: <b>none</b></td>
<th>Value</th>
<th>Description</th>
</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>
<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>
<td><span style="color: red;">Spoke:</span> Remote GRE interface IP address</td>
<td>ip; default: <b>none</b></td>
<td>IP address of the remote GRE Tunnel instance.</td>
</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>
<td>Subnet mask of the local GRE Tunnel instance.</td>
</tr>
</tr>
</tr>
</tr>
</table>
</table>
==L2TP==
==L2TP==
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:
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_rutx_vpn_l2tp_client_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_l2tp_client.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<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>
</tr>
</table>
</table>
