219
edits
Changes
no edit summary
<!-- Template uses {{{name}}}, {{{series}}} -->
<!-- Template uses {{{name}}}, {{{series}}} -->
{{Template:Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.04.1
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} 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 {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} 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.3</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_rutos_vpn_openvpn_client_configuration_v4.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>
<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>Enable OpenVPN config from file</td>
<td>Enable OpenVPN config from file</td>
<td>off {{!}} <span style="color:#ffce33 ;">on</span>; default: <b>off</b></td>
<td>Enables or disables custom OpenVPN config from file.</td>
</tr>
<tr>
<td><span style="color:#ffce33 ;">OpenVPN configuration file</span></td>
<td>-(interactive button)</td>
<td>Upload OpenVPN configuration. Warning! This will overwrite your current configuration.</td>
</tr>
<tr>
<td><span style="color:#ffce33 ;">Upload OpenVPN authentications files</span></td>
<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>Upload OpenVPN authentication files, which will be automatically included in configuration.</td>
</tr>
</tr>
<tr>
<tr>
<td>TUN/TAP</td>
<td>TUN/TAP</td>
<td>TUN (tunnel) {{!}} TAP (bridged); default: <b>TUN (tunnel)</b></td>
<td>TUN (tunnel) {{!}} <span style="color:brown ;">TAP (bridged)</span>; default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<td>Virtual network device type.
<ul>
<ul>
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td><span style="color:brown ;">Bridge</span></td>
<td>Bridge interface for TAP; default: br-lan</td>
<td>Assign a TAP interface to a bridge.</td>
</tr>
</tr>
<tr>
<tr>
<td>Protocol</td>
<td>Protocol</td>
<td>UDP {{!}} TCP{{#ifeq:{{{series}}}|RUTX| {{!}} UDP6 {{!}} TCP6}}; default: <b>UDP</b></td>
<td>UDP {{!}} TCP {{!}} <span style="color: green;"><b>UDP6</b></span> {{!}} <span style="color: green;"><b>TCP6</b></span>; default: <b>UDP</b></td>
<td>Transfer protocol used by the OpenVPN connection.
<td>Transfer protocol used by the OpenVPN connection.
<ul>
<ul>
<td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
<td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
<td>Turns LZO data compression on or off.</td>
<td>Turns LZO data compression on or off.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: red;">TLS:</span> TLS cipher</td>
<td>Encryption</td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64CBC 64 {{!}} AES-128-CBC 128 {{!}} AES-128-CFB 128 {{!}} AES-128-CFB1 128 {{!}} AES-128-CFB8 128 {{!}} AES-128-OFB 128 {{!}} AES-128-GCM 128 {{!}} AES-192-CBC 192 {{!}} AES-192-CFB 192 {{!}} AES-192-CFB1 192 {{!}} AES-192-CFB8 192 {{!}} AES-192-OFB 192 {{!}} AES-192-GCM 192 {{!}} AES-256-CBC 256 {{!}} AES-256-CFB 256 {{!}} AES-256-CFB1 256 {{!}} AES-256-CFB8 256 {{!}} AES-256-OFB 256 {{!}} AES-256-GCM 256 {{!}} none; default: <b>AES-256-CBC 256</b></td>
<td>Algorithm used for packet encryption.</td>
</tr>
<tr>
<td><span style="color: red;">TLS:</span> TLS cipher</td>
<td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
<td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
<td>Packet encryption algorithm cipher.</td>
<td>Packet encryption algorithm cipher.</td>
<tr>
<tr>
<td>Keep alive</td>
<td>Keep alive</td>
<td>two integers separated by a space; default: <b>none</b></td>
<td>two integers separated by a space; default: <b>10 120</b></td>
<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specfiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances.<br><b>Example</b>: <i>10 120</i></td>
<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specfiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances.<br><b>Example</b>: <i>10 120</i></td>
</tr>
</tr>
<tr>
<tr>
<td>Remote network IP address</td>
<td>Remote network IP address</td>
<td>ip; default: <b>none</b></td>
<td>ip4; default: <b>none</b></td>
<td>LAN IP address of the remote network (server).</td>
<td>LAN IP address of the remote network (server).</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote network IP netmask</td>
<td>Remote network netmask</td>
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (server).</td>
<td>LAN IP subnet mask of the remote network (server).</td>
</tr>
<tr>
<td><span style="color: green;">Remote network IPv6 address</span></td>
<td>ip6; default: <b>none</b></td>
<td>IPv6 address of the remote network (server). This field is becomes visible when protocol is set to UDP6 or TCP6</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the OpenVPN server.</td>
<td>Password used for authentication to the OpenVPN server.</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span>Use PKCS #12 format</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turn PKCS #12 format on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<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>
<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>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Additional HMAC authentication</td>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span>Additional HMAC authentication</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
<td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</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.
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 OpenVPN server's configuration fields:
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 OpenVPN server's configuration fields:
[[File:Networking_rutx_vpn_openvpn_server_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_openvpn_server_configuration_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Protocol</td>
<td>Protocol</td>
<td>UDP {{!}} TCP{{#ifeq:{{{series}}}|RUTX| {{!}} UDP6 {{!}} TCP6}}; default: <b>UDP</b></td>
<td>UDP {{!}} TCP {{!}} <span style="color: green;"><b>UDP6</b></span> {{!}} <span style="color: green;"><b>TCP6</b></span>; default: <b>UDP</b></td>
<td>Transfer protocol used by the OpenVPN connection.
<td>Transfer protocol used by the OpenVPN connection.
<ul>
<ul>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls).</li>
<li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls).</li>
</ul>
</ul>
</td>
</td>Which SERVER LAN networks should be reachable from this client
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Encryption</td>
<td>Encryption</td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-40CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64-CBC 64{{!}} AES-128-CBC 128 {{!}} AES-192-CBC 192 {{!}} AES-256-CBC 256 {{!}} none; default: <b>BF-CBC 128</b></td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64CBC 64 {{!}} AES-128-CBC 128 {{!}} AES-128-CFB 128 {{!}} AES-128-CFB1 128 {{!}} AES-128-CFB8 128 {{!}} AES-128-OFB 128 {{!}} AES-128-GCM 128 {{!}} AES-192-CBC 192 {{!}} AES-192-CFB 192 {{!}} AES-192-CFB1 192 {{!}} AES-192-CFB8 192 {{!}} AES-192-OFB 192 {{!}} AES-192-GCM 192 {{!}} AES-256-CBC 256 {{!}} AES-256-CFB 256 {{!}} AES-256-CFB1 256 {{!}} AES-256-CFB8 256 {{!}} AES-256-OFB 256 {{!}} AES-256-GCM 256 {{!}} none; default: <b>AES-256-CBC 256</b></td>
<td>Algorithm used for packet encryption.</td>
<td>Algorithm used for packet encryption.</td>
</tr>
</tr>
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client).</td>
<td>LAN IP subnet mask of the remote network (client).</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Authentication algorithm</td>
<td>None {{!}} MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
<td>Algorithm used for exchanging authentication and hash information.</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Virtual network IP address</td>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Virtual network IP address</td>
<td>ip; default: <b>none</b></td>
<td>ip4; default: <b>none</b></td>
<td>IP address of the OpenVPN network.</td>
<td>IPv4 address of the OpenVPN network.</td>
</tr>
</tr>
<tr>
<tr>
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>Subnet mask of the OpenVPN network.</td>
<td>Subnet mask of the OpenVPN network.</td>
</tr>
<tr>
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> <span style="color: #20C0D7;"><b>Virtual network IPv6 address</b></span></td>
<td>ip6; default: <b>none</b></td>
<td>IPv6 address of the OpenVPN network. This field becomes visible when protocol is set to UDP6 or TCP6</td>
</tr>
</tr>
<tr>
<tr>
The TLS Clients section can be found in the OpenVPN Server configuration window, provided that the OpenVPN server uses TLS or TLS/Password authentication methods. To create a new TLS client, type in the new client‘s name in the text field found bellow the TLS Clients tab and click the 'Add' button. Refer to the figure and table below for information on the TLS Clients' configuration fields:
The TLS Clients section can be found in the OpenVPN Server configuration window, provided that the OpenVPN server uses TLS or TLS/Password authentication methods. To create a new TLS client, type in the new client‘s name in the text field found bellow the TLS Clients tab and click the 'Add' button. Refer to the figure and table below for information on the TLS Clients' configuration fields:
[[File:Networking_rutx_vpn_openvpn_tls_clients_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_openvpn_tls_clients.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>Client’s private network (LAN) IP netmask.</td>
<td>Client’s private network (LAN) IP netmask.</td>
</tr>
<tr>
<td>Covered Network</td>
<td>network(); default: <b>none</b></td>
<td>Selects which networks should be made accessible to this client.</td>
</tr>
</tr>
</table>
</table>
===GRE: main & tunnel settings===
====PKCS #12====
----
----
Enable <b>PKCS #12 format</b> if you wish to use a PKCS #12 archive file format to bundle all the members of a chain of trust instead of uploading certificates separately.
PKCS #12 configuration settings become visible when the <b>Use PKCS #12 format</b> slider is turned on.
[[File:Networking_rutx_vpn_gre_gre_configuration_main_settings_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_openvpn_pkcs_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Use PKCS #12 format</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the GRE instance on or off.</td>
<td>Turn PKCS #12 format on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Tunnel source</td>
<td>PKCS #12 passphrase</td>
<td>network interface; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Network interface used to establish the GRE Tunnel.</td>
<td>Passphrase used to decrypt PKCS #12 certificates.</td>
</tr>
</tr>
<tr>
<tr>
<td>PKCS #12 certificate chain</td>
<td>ip; default: <b>none</b></td>
<td>-(interactive button)</td>
<td>Use to upload certificate chain file.</td>
</tr>
</tr>
</table>
====OpenVPN Server Brute-force Prevention====
----
OpenVPN Servers with <b>Authentication</b> set to <b>TLS/Password</b> or <b>Password</b>, <b>Protocol</b> set to <b>UDP</b> and running on <b>Port 1194</b> have a feature where after a client attempts to connect to the server 10 times with incorrect credentials (password and/or username) they are then blocked from the server.
To check which addresses are blocked one first needs to connect to their device's [[Command_Line_Interfaces_RutOS|CLI]].
After connecting to your device's CLI use the command <b>ipset list</b> and find the section named <b>ipb_port</b>. There under <b>Members</b> you should see all IP addresses that are blocked.
<pre>
Name: ipb_port
Type: hash:ip,port
Revision: 5
Header: family inet hashsize 1024 maxelem 65536
Size in memory: 164
References: 2
Number of entries: 1
Members:
188.XXX.XXX.XXX,udp:1194
</pre>
Another way to check blocked IP addresses is to use the command <b>ubus call ip_block show</b>. This will show all ip addresses that failed to connect to your device. If the <b>counter</b> atribute of the IP address entry is larger or equal then <b>max_attempt_count</b> then that IP address is blocked.
<pre>
{
"globals": {
"max_attempt_count": 10
},
"ip_blockd 188.XXX.XXX.XXX": {
"ip": "188.XXX.XXX.XXX",
"port": "udp:1194",
"counter": "1"
},
"ip_blockd 188.XXX.XXX.XXX": {
"ip": "188.XXX.XXX.XXX",
"port": "udp:1194",
"counter": "10"
}
}
</pre>
To unblock a blocked client's IP address use the command <b>ubus call ip_block unblock '{"ip":"<blocked_ip_address>","port":"udp:1194"}</b> (replace <blocked_ip_address> inside the quotes with your blocked IP address). If the IP address was unblocked succesfully you should see a similar response:
<pre>
{
"unblocked": {
"ip": "188.XXX.XXX.XXX",
"port": "udp:1194"
}
}
</pre>
==GRE==
<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===
----
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 begin configuration, click the button that looks like a pencil located next to the instance. Refer to the figure and table below for information on the fields located in the GRE instance configuration section.
[[File:Networking_rutx_vpn_gre_gre_configuration_main_settings_v2.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>Inbound key</td>
<td>Enabled</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>A key used to identify incoming packets. This value should match the "Outbound key" value set on the opposite GRE instance or both key values should be omitted on both sides.</td>
<td>Turns the GRE instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Path MTU Discovery</td>
<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>Remote endpoint IP address</td>
<td>ip; default: <b>none</b></td>
<td>External IP address of another GRE instance used to establish the initial connection between peers.</td>
</tr>
<tr>
<td>MTU</td>
<td>integer; default: <b>1476</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>TTL</td>
<td>integer [0..255]; default: <b>255</b></td>
<td>Sets a custom TTL (Time to Live) value for encapsulated packets. TTL is a field in the IP packet header which is initially set by the sender and decreased by 1 on each hop. When it reaches 0 it is dropped and the last host to receive the packet sends an ICMP "Time Exceeded" message back to the source.</td>
</tr>
<tr>
<td>Outbound key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify outgoing packets. This value should match the "Inbound key" value set on the opposite GRE instance or both key values should be omitted on both sides.</td>
</tr>
<tr>
<td>Inbound key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify incoming packets. This value should match the "Outbound key" value set on the opposite GRE instance or both key values should be omitted on both sides.</td>
</tr>
<tr>
<td>Path MTU Discovery</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>off {{!}} on; default: <b>on</b></td>
<td>When unchecked, sets the <i>nopmtudisc</i> option for tunnel. Can not be used together with the TTL option.</td>
<td>When unchecked, sets the <i>nopmtudisc</i> option for tunnel. Can not be used together with the TTL option.</td>
</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 create a new IPsec instance, go to the <i>Services → VPN → IPsec</i> section, enter a custom name and click the 'Add' button. An IPsec instance with the given name will appear in the "IPsec Configuration" list.
To create a new IPsec instance, go to the <i>Services → VPN → IPsec</i> section, enter a custom name and click the 'Add' button. An IPsec instance with the given name will appear in the "IPsec Configuration" list.
[[File:Networking rutos vpn ipsec add button.png|border|class=tlt-border]]
===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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Authentication method</td>
<td>Authentication method</td>
<td>Pre-shared key {{!}} X.509; default: <b>Pre-shared key</b></td>
<td>Pre-shared key {{!}} <span style="color:darkred">X.509 {{!}} EAP</span> {{!}} <span style="color:blue">PKCS#12</span>; default: <b>Pre-shared key</b></td>
<td>Specify authentication method. Choose between Pre-shared key and X.509 certificates.</td>
<td>Specify authentication method. Choose between Pre-shared key and X.509 certificates.</td>
</tr>
<tr>
<td><span style="color:blue">PKCS#12:</span> PKCS12 container</td>
<td>string; default: <b>none</b></td>
<td></td>
</tr>
<tr>
<td><span style="color:blue">PKCS#12:</span> PKCS12 decryption passphrase</td>
<td>string; default: <b>none</b></td>
<td></td>
</tr>
</tr>
<tr>
<tr>
<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: {{!}} EAP:</span> Key</td>
<td>.key file; default: <b>none</b></td>
<td>A private key file; default: <b>none</b></td>
<td>A public key file.</td>
<td>A private key file.</td>
</tr>
<tr>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> Key decryption passphrase</td>
<td>A password for private key files; default: <b>none</b></td>
<td>If the private key file is encrypted, the passphrase must be defined.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> Local Certificate</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> Local Certificate</td>
<td>.pem file; default: <b>none</b></td>
<td>.der file; default: <b>none</b></td>
<td>A local certificate file.</td>
<td>A local certificate file.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> CA Certificate</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> CA Certificate</td>
<td>.crt file; default: <b>none</b></td>
<td>.der file; default: <b>none</b></td>
<td>A certificate authority file.</td>
<td>A certificate authority file.</td>
</tr>
</tr>
</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>
<li>Chocolate for <span style="color: chocolate;">Authentication method: Pre-shared key</span></li>
<li>Chocolate for <span style="color: chocolate;">Authentication method: Pre-shared key</span></li>
<li>Dark red for <span style="color: darkred;">Authentication method: X.509</span></li>
<li>Dark red for <span style="color: darkred;">Authentication method: X.509/EAP</span></li>
<li>Blue for <span style="color: blue;">Authentication method: PKCS#12</span></li>
</ul>
</ul>
</li>
</li>
</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. <b>NOTE:</b> IKEv1 only supports IP address ID selector.</td>
</tr>
<tr>
<td>Type</td>
<td>PSK {{!}} XAUTH {{!}} EAP {{!}} <span style="color:darkred">RSA</span> {{!}} <span style="color:darkred">PKCS#12</span>; default: <b>PSK</b></td>
<td>IPSec secret type. <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>
<tr>
<td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Secret</td>
<td>Private key file; default: <b>none</b></td>
<td>A private key file.</td>
</tr>
<tr>
<td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Key decryption passphrase</td>
<td>A password for private key files; default: <b>none</b></td>
<td>If the private key file is encrypted, the passphrase must be defined.</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 v3.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>
<tr>
<tr>
<td><span style="color: purple;">Transport:</span> Bind to</td>
<td><span style="color: purple;">Transport:</span> Bind to</td>
<td>GRE interface; default: <b>none</b></td>
<td>GRE interface; L2TP interface; default: <b>none</b></td>
<td>Bind to GRE interface to create GRE over IPsec.</td>
<td>Bind to GRE or L2TP interface to create GRE/L2TP over IPsec.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: red;">Tunnel:</span> Default route</td>
<td>Enable XAuth</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>on {{!}} off; default: <b>off</b></td>
<td>Turn on to route all traffic through IPSec tunnel.</td>
<td>Enables Extended Authentication.</td>
</tr>
</tr>
</table>
</table>
====Advanced settings====
====Advanced settings====
----
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings_v3.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_connection_settings_advanced_v1.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>
<td>Compatibility mode</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns on compatibility mode to help deal with a 3rd party remote peer with multiple subnets.</td>
</tr>
</tr>
<tr>
<tr>
<td>integer; default: <b>none</b></td>
<td>integer; default: <b>none</b></td>
<td>The frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.</td>
<td>The frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.</td>
</tr>
<tr>
<td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD Timeout</td>
<td>integer; default: <b>none</b></td>
<td>Defines the timeout interval, after which all connections to a peer are deleted in case of inactivity.</td>
</tr>
<tr>
<td>XAuth identity</td>
<td>string; default: <b>none</b></td>
<td>The identity/username the client uses to reply to an XAuth request. If not defined, the IKEv1 identity will be used as XAuth identity.</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>
----
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase1_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase1_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>DH group</td>
<td>DH group</td>
<td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521; default: <b>MODP1536</b></td>
<td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521 {{!}} No PFS; 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>
<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>
----
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase2_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase2_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Hash algorithm</td>
<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>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>3DES</b></td>
<td>Algorithm used for data encryption.</td>
<td>Algorithm used for data encryption.</td>
</tr>
</tr>
<tr>
<tr>
<td>Hash algorithm</td>
<td>Hash algorithm</td>
<td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
<td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>MD5</b></td>
<td>Algorithm used for exchanging authentication and hash information.</td>
<td>Algorithm used for exchanging authentication and hash information.</td>
</tr>
</tr>
<tr>
<tr>
<td>PFS group</td>
<td>PFS group</td>
<td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521; default: <b>MODP1536</b></td>
<td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521 {{!}} No PFS; default: <b>MODP768</b></td>
<td>The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec. </td>
<td>The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec. </td>
</tr>
</tr>
===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_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the PPTP server.</td>
<td>Password used for authentication to the PPTP server.</td>
</tr><tr>
</tr>
<td>Default route</td>
<tr>
<td>Client to client</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Adds route to make other PPTP clients reachable.</td>
</tr>
<tr>
<td>Default route</td>
<td>off {{!}} on; default: <b>off</b></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 PPTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.</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 PPTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.</td>
===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 keep 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_rutx_vpn_sstp_configuration_v1.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>
<tr>
<tr>
<td>Enable</td>
<td>Username</td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to this PPTP server.</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>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>
<b>Note:</b> there can only be one PPTP Server configuration on the device.
==SSTP==
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> SSTP is additional software that can be installed from the <b>System → [[{{{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.
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:
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
[[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.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> Stunnel is additional software that can be installed from the <b>System → [[{{{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>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>Enabled</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 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>Application Protocol</td>
<td>Debug Level</td>
<td>Connect {{!}} SMTP {{!}} Not specified; default: <b>Not specified</b></td>
<td>integer [0..7]; default: <b>5</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>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:darkred">Connect:</span> Protocol Authentication</td>
<td>Use alternative config</td>
<td>Basic {{!}} NTLM; default: <b>Basic</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Authentication type for the protocol negotiations.</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><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
<td>Upload alternative config</td>
<td>Plain {{!}} Login; default: <b>Plain</b></td>
<td>file; default: <b>none</b></td>
<td>Authentication type for the protocol negotiations.</td>
<td>Uploads an Stunnel configuration file.</td>
</tr>
</tr>
</table>
<td>.crt file; default: <b>none</b></td>
===Stunnel instance===
<td>TLS client or server certificate file.</td>
----
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>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Private Key</td>
<td>Enable</td>
<td>.key file; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>TLS client or server key file.</td>
<td>Turns the Stunnel instance on or off.</td>
</tr>
<tr>
<td>Operating Mode</td>
<td>Server {{!}} Client; default: <b>Server</b></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>
<th>Field</th>
<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>
<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>
<tr>
<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>
<th>Field</th>
<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>
<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>
<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>
<th>Description</th>
<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.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> DMPVN is additional software that can be installed from the <b>System → [[{{{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>
</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 v3.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>Any</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>
</table>
<tr>
<br>
<td>GRE MTU</td>
<td>integer; default: <b>1476</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>Outbound key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify outgoing GRE packets. This value should match the <b>Inbound key</b> value set on the opposite GRE tunnel instance or both key values should be omitted on both sides.</td>
</tr>
<tr>
<td>Inbound key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify incoming GRE packets. This value should match the <b>Outbound key</b> value set on the opposite GRE instance or both key values should be omitted on both sides.</td>
</tr>
</table>
<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>
<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>
<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>Username</td>
<td>Force crypto proposal</td>
<td>string; default: <b>none</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Username used for authentication to the L2TP server.</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>
</tr>
</table>
<br>
----
----
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v3.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>Enable</td>
<td>NHRP network ID</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>integer; default: <b>1</b></td>
<td>Turns the L2TP instance on or off.</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>Local IP</td>
<td>NHRP authentication key</td>
<td>ip; default: <b>192.168.0.1</b></td>
<td>string; default: <b>none</b></td>
<td>A key used in NHRP authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote IP range begin</td>
<td>NHRP hold time</td>
<td>ip; default: <b>192.168.0.20</b></td>
<td>integer; default: <b>7200</b></td>
<td>L2TP IP address leases will begin from the address specified in this field.</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>
<tr>
<tr>
<td>Remote IP range end</td>
<td>Redirect</td>
<td>ip; default: <b>192.168.0.30</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>L2TP IP address leases will end with the address specified in this field.</td>
<td>Enables or disables DMVPN traffic redirection.</td>
</tr>
</tr>
<tr>
<tr>
<td>User name</td>
<td><span style="color: purple;">Hub:</span> NFLOG group</td>
<td>integer [1..65535]; default: <b>none</b></td>
<td>Username used for authentication to this L2TP server.</td>
<td>Specify NFLOG group to be used by NHRP instance </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>
==WireGuard==
==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.
It intends to be more performant than OpenVPN. WireGuard is designed as general purpose VPN, fit for
===L2TP client===
===General Instance Settings===
----
----
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_rutx_vpn_wireguard_instance_general_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_l2tp_client_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns the L2TP instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>Server</td>
<td>ip {{!}} host; default: <b>none</b></td>
<td>IP address or hostname of an L2TP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Public Key</td>
<td>Username</td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to the L2TP server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the L2TP server.</td>
</tr>
<tr>
<td>CHAP secret</td>
<td>string; default: <b>none</b></td>
<td>A secret used for L2TP Tunnel Authentication.</td>
</tr>
<tr>
<td>MTU</td>
<td>[68..9200]; 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>Default route</td>
<td>off {{!}} on; default: <b>off</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.{{#switch:{{{series}}}|RUTX|RUTM=<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
</tr>
<tr>
<td>Allow CHAP</td>
<td>on | off; default: <b>on</b></td>
<td>Allows CHAP authentication method to be used.</td>
</tr>
</tr>
<tr>
<tr>
<td>Allow PAP</td>
<td>on | off; default: <b>off</b></td>
<td>Allows PAP authentication method to be used.</td>
</tr>
</tr>
<tr>
<tr>
<td>Allow MSCHAP-v2</td>
<td>on | off; default: <b>on</b></td>
<td>Allow MSCHAP-v2 authentication method to be used.</td>
</tr>
</tr>
</table>
</table>
<b>Active L2TP client instance example:</b>
----
----
[[File:Networking rutos manual vpn l2tp active client.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
===L2TP server===
<tr>
----
<th>Field</th>
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.
<th>Value</th>
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>
<th>Field</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<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>
<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>
</table>
<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>
<td>Enable CHAP</td>
<td>on | off; default: <b>off</b></td>
<td>Challenge-Handshake Authentication Protocol for L2TP.</td>
</tr>
<tr>
<td>CHAP authentication</td>
<td>on | off; default: <b>on</b></td>
<td>When turned on it requires CHAP authentication method to be used, when turned off it refuses CHAP authentication method.</td>
</tr>
<tr>
<td>PAP authentication</td>
<td>on | off; default: <b>off</b></td>
<td>When turned on it requires PAP authentication method to be used, when turned off it refuses PAP authentication method.</td>
</tr>
<tr>
<td>MSCHAP-v2 authentication</td>
<td>on | off; default: <b>on</b></td>
<td>When turned on it requires MSCHAP-v2 authentication method to be used, when turned off it refuses MSCHAP-v2 authentication method.</td>
</tr>
<tr>
<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>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>
===Peers===
<b>Active L2TP server instance example:</b>
----
----
The Peers section is used to create and configure all the peers for this interface.
[[File:Networking rutx vpn l2tp active server.png|border|class=tlt-border]]
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.
==L2TPv3==
[[File:Networking_rutx_vpn_wireguard_instance_peer_v2.png|border|class=tlt-border]]
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.
====General Peer Settings====
===Local settings===
----
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_local_settings_v1.png]]
In the General section of Peer instance you can configure basic information about the endpoint to allow communications.
<table class="nd-mantable">
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_general_v1.png|border|class=tlt-border]]
<tr>
<th>Field</th>
<table class="nd-mantable">
<th>Value</th>
<tr>
<th>Description</th>
<th>Field</th>
</tr>
<th>Value</th>
<tr>
<th>Description</th>
<td>Enable</td>
</tr>
<td>off {{!}} on; default: <b>off</b></td>
<tr>
<td>Turns the L2TPv3 instance on or off.</td>
<td>Public Key</td>
</tr>
<td>string; default: <b>none</b></td>
<tr>
<td>Endpoint's Public Key.</td>
<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>System → [[{{{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_v2.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_v2.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>
</table>
ZeroTier network configuration instance should look similar to this:
[[File:Networking rutos manual vpn zerotier network instance_v2.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>Port</td>
<td>integer [0..65535]; default: <b>9993</b></td>
<td>ZeroTier Network port.</td>
</tr>
<tr>
<td>Network ID</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>Bridge to</td>
<td>None {{!}} LAN; default: <b>None</b></td>
<td>Specify to which interface this ZeroTier instance should be bridged to. </td>
</tr>
<tr>
<td>Allow default route</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Allows ZeroTier to override system default route</td>
</tr>
<tr>
<td>Allow global IP</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Allows ZeroTier managed IPs and routes to overlap public IP space</td>
</tr>
<tr>
<td>Allow managed IP</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Assigns ZeroTier managed IPs and routes </td>
</tr>
<tr>
<td>Allow DNS</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Applies DNS servers that are set at the network controller</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.
WireGuard works by adding an interface which acts as a tunnel. To create one enter its name and click the <b>Add</b> button. This should add a new Wireguard instance and open a configuration window.
[[File:Networking_rutx_vpn_wireguard_v2.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_v3.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>-</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 key pair</td>
<td>-(interactive button)</td>
<td>Click to generate Public Key and Private Key.</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_rutos_vpn_wireguard_instance_advanced_v3.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 (Optional) metric for this tunnel interface. Lower number means higher priority.</td>
</tr>
<tr>
<td>Listen port</td>
<td>integer [1..65535]; default: <b>51820</b></td>
<td>Required. UDP port used for outgoing and incoming packets.</td>
</tr>
<tr>
<td>MTU</td>
<td>integer [68..9200]; default: <b>none</b></td>
<td>Maximum Transmission Unit of tunnel interface. Range [68 to 9200]. If not specified, the MTU is automatically determined by physical interface MTU value.</td>
</tr>
<tr>
<td>DNS servers</td>
<td>ip; default: <b>none</b></td>
<td>DNS server(s) for this Wireguard 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.
[[File:Networking_rutx_vpn_wireguard_instance_peer_v3.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_rutos_vpn_wireguard_instance_peer_instance_general_v3.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>Base64-encoded public key of peer.</td>
</tr>
<tr>
<td>Endpoint host</td>
<td>domain name {{!}} ip; default: <b>none</b></td>
<td>Host of peer. Names are resolved prior to bringing up the interface.</td>
</tr>
<tr>
<td>Allowed IPs</td>
<td>ip; default: <b>none</b></td>
<td>IP addresses and prefixes that this peer is allowed to use inside the tunnel. Usually the peer's tunnel IP addresses and the networks the peer routes through the tunnel.</td>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Description of the peer.</td>
</tr>
<tr>
<td>Route Allowed IPs</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Create routes for Allowed IPs for 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_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Tunnel source</td>
<td>Any {{!}} LAN {{!}} WAN {{!}} Mobile; default: <b>Any</b></td>
<td>Interface to bind this instance to.</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>Endpoint Port</td>
<td>integer [1..65535]; default: <b>none</b></td>
<td>Port of peer.</td>
</tr>
<tr>
<td>Persistent Keep Alive</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Seconds between keep alive messages. Default is 0 (disabled). Recommended value if this device is behind a NAT is 25. Range [0 to 65535].</td>
</tr>
<tr>
<td>Routing table</td>
<td>string; default: <b>none</b></td>
<td>Defines which routing table to use for this peer routes, not necessary to configure for most setups..</td>
</tr>
</table>
==Tinc==
'''Tinc''' is a Virtual Private Network (VPN) daemon that uses tunnelling and encryption to create a secure private network between hosts on the Internet. Tinc is Free Software and licensed under the [https://www.gnu.org/licenses/old-licenses/gpl-2.0.html|GNU General Public License] version 2 or later. Because the VPN appears to the IP level network code as a normal network device, there is no need to adapt any existing software. This allows VPN sites to share information with each other over the Internet without exposing any information to others.
Tinc works by adding an interface which acts as Router/Switch/Hub mode. To create one enter its name and click the <b>Add</b> button. This should add a new Tinc interface and open a configuration window
[[File:Networking_rutx_vpn_tinc.png|border|class=tlt-border]]
===General Interface Settings===
----
This section contains General settings of created Tinc Interface. Here you can find its Public and
Private keys, specify Subnet and Host to Connect to for communication.
[[File:Networking_rutx_vpn_tinc_instance_general.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 Tinc Interface on or off.</td>
</tr>
<tr>
<td>Subnet</td>
<td>ip; default: <b>none</b></td>
<td>The subnet which this tinc daemon will serve. Multiple subnet lines can be specified for each Daemon.</td>
</tr>
<tr>
<td>Private Key</td>
<td>.key file; default: <b>none</b></td>
<td>Generated RSA private key.</td>
</tr>
<tr>
<td>Public Key</td>
<td>.key file; default: <b>none</b></td>
<td>Generated RSA public key.</td>
</tr>
<tr>
<td>Host to Connect to</td>
<td>Not specified | Host name; default: <b>Not specified</b></td>
<td>Specifies which other tinc daemon to connect to on startup. Multiple variables may be specified, in which case outgoing connections to each specified tinc daemon are made.</td>
</tr>
</table>
====Advanced Settings====
----
Advanced Settings section.
[[File:Networking_rutos_vpn_tinc_instance_advanced.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Address Family</td>
<td>Any | IPv4 | IPPv6; default: <b>Any</b></td>
<td>This option affects the address family of listening and outgoing sockets.</td>
</tr>
<tr>
<td>Bind To Address</td>
<td>ip; default: <b>none</b></td>
<td>Addresses for Tinc VPN to use for listening sockets.</td>
</tr>
<tr>
<td>Bind To Interface</td>
<td>Any | LAN | WAN | WAN6 | Mobile; default: <b>Any</b></td>
<td>Interface to listen for incoming connections.</td>
</tr>
<tr>
<td>Key Expire</td>
<td>integer; default: <b>3600</b></td>
<td>This option controls the time the encryption keys used to encrypt the data are Valid.</td>
</tr>
<tr>
<td>Mode</td>
<td>Router | Switch | Hub; default: <b>Router</b></td>
<td>This option selects the way packets are routed to other daemons.</td>
</tr>
<tr>
<td>Ping Interval</td>
<td>integer; default: <b>60</b></td>
<td>The number of seconds of inactivity that tinc will wait before sending a probe to the other end.</td>
</tr>
<tr>
<td>Ping Timeout</td>
<td>integer; default: <b>5</b></td>
<td>The number of seconds to wait for a response to pings or to allow meta connections to block. If the other end doesn't respond within this time, the connection is terminated, and the others will be notified of this.</td>
</tr>
</table>
===Hosts===
----
The Hosts section is used to add your VPN hosts.
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_tinc_instance_hosts.png|border|class=tlt-border]]
====General Tinc Host Settings====
----
In the General section of Hosts instance you can configure basic information about the host.
[[File:Networking_rutos_vpn_tinc_instance_hosts_general.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>Turn this tinc host on/off.</td>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Optional. Description of host.</td>
</tr>
<tr>
<td>Address</td>
<td>ip; default: <b>none</b></td>
<td>It must resolve to the external IP address where the host can be reached, not the one that is internal to the VPN.</td>
</tr>
<tr>
<td>Subnet</td>
<td>ip; default: <b>none</b></td>
<td>The subnet which this tinc daemon will serve. Multiple subnet lines can be specified for each Daemon.</td>
</tr>
<tr>
<td>Public Key</td>
<td>.key file; default: <b>none</b></td>
<td>Generated RSA public key.</td>
</tr>
</table>
==Tailscale==
Tailscale is a straightforward peer-to-peer VPN service that utilizes the open-source WireGuard protocol.
<u><b>Note:</b> Tailscale is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
[[File:Networking rutx vpn tailscale 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>Authentication method</td>
<td>Use login url | <span style="color: red;">Use authentication key</span>; default: <b>Use login url</b></td>
<td>Selects method to authenticate your tailscale network.</td>
</tr>
<tr>
<td><span style="color: red;">Authentication key</span></td>
<td>string; default: <b>none</b></td>
<td>Provide an auth key to automatically authenticate the node as your user account.</td>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns tailscale service off or on.</td>
</tr>
<tr>
<td>Login server</td>
<td>full url; default: <b>https://controlplane.tailscale.com</b></td>
<td>Provide the base URL of a control server. If you are using Headscale for your control server, use your Headscale instance’s URL.</td>
</tr>
<tr>
<td>Advertise routes</td>
<td>ipv4 or ipv6 with mask; default: <b>none</b></td>
<td>Expose physical subnet routes to your entire Tailscale network.</td>
</tr>
<tr>
<td>Default route</td>
<td><span style="color: green;">on</span> | off; default: <b>off</b></td>
<td>Route traffic through another exit node.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: green;">Exit node IP</span></td>
<td>ip; default: <b>none</b></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>
<td>IP address of the exit node.</td>
</tr>
</tr>
<tr>
<tr>
<td>Accept routes</td>
<td>string; default: <b>none</b></td>
<td>on | off; default: <b>off</b></td>
<td>Description of this peer.</td>
<td>Accept subnet routes that other nodes advertise.</td>
</tr>
</tr>
<tr>
<tr>
<td>Exit node</td>
<td>on | off; default: <b>off</b></td>
<td>Offer to be an exit node for outbound internet traffic from the Tailscale network.</td>
<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>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]