7,851
edits
Changes
Template:Networking rutos manual vpn (view source)
Revision as of 15:26, 20 December 2023
, 15:26, 20 December 2023no edit summary
<!-- Template uses {{{name}}}, {{{series}}} -->
<!-- Template uses {{{name}}}, {{{series}}} -->
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| 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_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#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_rutos_manual_latest_fw | series = RUT2XX}} 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==
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:
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_rutos_vpn_openvpn_client_configuration_v3.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>United Kingdom {{!}} USA {{!}} Australia {{!}} South Africa {{!}} Custom; default: <b>United Kingdom</b></td>
<td>United Kingdom {{!}} USA {{!}} Australia {{!}} South Africa {{!}} Custom; default: <b>United Kingdom</b></td>
<td>Represents a list of available VPN servers. </td>
<td>Represents a list of available VPN servers. </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 VPN server.</td>
<td>Password used for authentication to the VPN server.</td>
</tr>
<tr>
<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>Upload OpenVPN authentication files, which will be automatically included in configuration.</td>
</tr>
</tr>
<tr>
<tr>
<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>
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-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>
<tr>
<tr>
<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>
<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>
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>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>
</table>
</table>
====OpenVPN Server Brute-force Prevention====
===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.
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.
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.
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_rutos_vpn_ipsec_ipsec_instance_general_settings.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>
</tr> -->
</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>.der 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>.der 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>.der 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>
<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>
<td>ID Selector</td>
<td>ID Selector</td>
<td>%any, IP or FQDN; default: <b>none</b></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>
<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>
<tr>
<tr>
<td>Type</td>
<td>Type</td>
<td>psk {{!}} xauth; default: <b>psk</b></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.</br><b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
<td>IPSec secret type. <b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></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>
<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>
====Advanced 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_rutos_vpn_ipsec_connection_settings_general_settings.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>Enable XAuth</td>
<td>on {{!}} off; default: <b>off</b></td>
<td>Enables Extended Authentication.</td>
</tr>
</tr>
</table>
</table>
====Advanced settings====
====Advanced settings====
----
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
----
----
[[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">
----
----
[[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">
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
{{#ifeq: {{{series}}} | RUTX | |
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</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>
</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===
===SSTP configuration===
The Stunnel Globals section is used to manage the Stunnel service as a whole.
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.
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
{{#ifeq: {{{series}}} | RUTX | |
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</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>
</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]]
[[File:Networking_rutos_manual_vpn_stunnel_globals.png|border|class=tlt-border]]
<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.
<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 | |
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</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>
</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===
===DMVPN configuration===
<br>
<br>
----
----
[[File:Networking_rutos_manual_vpn_dmvpn_gre_parameters_configuration.png|border|class=tlt-border]]
[[File:Networking rutos manual vpn dmvpn gre parameters configuration v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Tunnel source</td>
<td>Tunnel source</td>
<td>network interface; default: <b>none</b></td>
<td>network interface; default: <b>Any</b></td>
<td>Network interface used to establish the GRE Tunnel.</td>
<td>Network interface used to establish the GRE Tunnel.</td>
</tr>
</tr>
<tr>
<tr>
<td>GRE MTU</td>
<td>GRE MTU</td>
<td>integer; default: <b>none</b></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>
<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>
<tr>
<tr>
<td>GRE keys</td>
<td>Outbound key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>A key used to identify incoming and outgoing GRE packets.</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>
</tr>
</table>
</table>
<br>
<br>
----
----
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>integer; default: <b>7200</b></td>
<td>integer; default: <b>7200</b></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>
<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>
<td>Redirect</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enables or disables DMVPN traffic redirection.</td>
</tr>
<tr>
<td><span style="color: purple;">Hub:</span> NFLOG group</td>
<td>integer [1..65535]; default: <b>none</b></td>
<td>Specify NFLOG group to be used by NHRP instance </td>
</tr>
</tr>
</table>
</table>
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_rutos_manual_vpn_l2tp_client.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">
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the L2TP server.</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>
<tr>
<tr>
<td>Default route</td>
<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 device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.{{#ifeq:{{{series}}}|RUTX|<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
<td>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>
<td>Allow PAP</td>
<td>on | off; default: <b>off</b></td>
<td>Allows PAP authentication method to be used.</td>
</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]]
===L2TP server===
===L2TP server===
<td>ip; default: <b>192.168.0.30</b></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>
<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>
<tr>
<tr>
</tr>
</tr>
</table>
</table>
<b>Active L2TP server instance example:</b>
----
[[File:Networking rutx vpn l2tp active server.png|border|class=tlt-border]]
==L2TPv3==
==L2TPv3==
<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.
<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>
<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:
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]]
[[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:
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]]
[[File:Networking_rutos_manual_vpn_zerotier_instance_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Turns the ZeroTier Instance on or off.</td>
<td>Turns the ZeroTier Instance on or off.</td>
</tr>
</tr>
</table>
</table>
ZeroTier network configuration instance should look similar to this:
[[File:Networking rutos manual vpn zerotier network instance_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<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>
<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>
<tr>
<tr>
<td>Public Key</td>
<td>Allow default route</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Allows ZeroTier to override system default route</td>
</tr>
</tr>
<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>
<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>
<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>
</tr>
</table>
</table>
==WireGuard==
====Advanced Settings====
'''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_v1.png|border|class=tlt-border]]
===General Instance Settings===
----
----
This section contains General settings of created WireGuard Instance. Here you can find its Public and
Private keys and generate them, specify Port and IP addresses for communication.
[[File:Networking_rutos_vpn_wireguard_instance_advanced_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Metric</td>
<td>Enable</td>
<td>positive integer; default: <b>none</b></td>
<td>off | on; default: <b>off</b></td>
<td>Specify metric for this tunnel interface. Lower number means higher priority.</td>
<td>Turns WireGuard Instance on or off.</td>
</tr>
</tr>
<tr>
<tr>
<td>MTU</td>
<td>Private Key</td>
<td>integer [1280..1420]; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Maximum Transmission Unit for this tunnel interface.</td>
<td>Private Key used in authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td>DNS servers</td>
<td>Public Key</td>
<td>ip | ips; default: <b>none</b></td>
<td>string; default: <b>-</b></td>
<td>DNS server(s) for this Wireguard interface.</td>
<td>Public Key used in authentication.</td>
</tr>
<tr>
<td>Generate</td>
<td>-(interactive button)</td>
<td>Click to generate Public Key and Private Key.</td>
</tr>
<tr>
<td>Listen Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify port to listen for incomming connections. It will be set to a random integer if left empty.</td>
</tr>
<tr>
<td>IP Addresses</td>
<td>ip; default: <b>none</b></td>
<td>A single IP address or a list of them for this instance associated with public keys.</td>
</tr>
</tr>
</table>
</table>
===Peers===
====Advanced Settings====
----
----
Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
[[File:Networking_rutos_vpn_wireguard_instance_advanced_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Public Key</td>
<td>Metric</td>
<td>string; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>Endpoint's Public Key.</td>
<td>Specify metric for this tunnel interface. Lower number means higher priority.</td>
</tr>
</tr>
<tr>
<tr>
<td>Allowed IPs</td>
<td>MTU</td>
<td>ip; default: <b>none</b></td>
<td>integer [1280..1420]; 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>Maximum Transmission Unit for this tunnel interface.</td>
</tr>
</tr>
<tr>
<tr>
<td>Description</td>
<td>DNS servers</td>
<td>string; default: <b>none</b></td>
<td>ip | ips; default: <b>none</b></td>
<td>Description of the peer.</td>
<td>DNS server(s) for this Wireguard interface.</td>
</tr>
</tr>
</table>
</table>
====Advanced Peer Settings====
===Peers===
----
The Peers section is used to create and configure all the peers for this interface.
To create one enter its name and click the <b>Add</b> button.
To configure it click the <b>Edit</b> [[File:Networking_rutx_manual_edit_button_v1.png]] button.
[[File:Networking_rutx_vpn_wireguard_instance_peer_v2.png|border|class=tlt-border]]
====General Peer Settings====
----
----
In the Advanced section of Peer instance you are able to configure additional
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_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Description</td>
<td>Public Key</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Description of this peer.</td>
<td>Endpoint's Public Key.</td>
</tr>
<tr>
<td>Allowed IPs</td>
<td>ip; default: <b>none</b></td>
<td>A single IP address or a list of them which are allowed to communicate with this peer.</td>
</tr>
</tr>
<tr>
<tr>
<td>Pre-Shared Key</td>
<td>Description</td>
<td>string; default: <b>none</b></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>
<td>Description of the peer.</td>
</tr>
</tr>
<tr>
<tr>
<td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
<td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
</tr>
</tr>
</table>
====Advanced Peer Settings====
----
In the Advanced section of Peer instance you are able to configure additional
settings such as its Description, Endpoint Host and Port, Preshared Key and other.
See more information below.
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_advanced_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<td>Endpoint Host</td>
<th>Field</th>
<td>ip {{!}} url; default: <b>none</b></td>
<th>Value</th>
<td>IP or URL of Remote Endpoint.</td>
<th>Description</th>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Description of this peer.</td>
</tr>
</tr>
<tr>
<tr>
<td>Endpoint Port</td>
<td>Pre-Shared Key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Specify port to connect to Remote Endpoint. It will be set to <b>51820</b> if left empty.</td>
<td>Base64-encoded preshared key. Adds in an additional layer of symmetric-key cryptography for post-quantum resistance.</td>
</tr>
</tr>
<tr>
<tr>
<td>Persistent Keep Alive</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>
<td>Endpoint Host</td>
<td>ip {{!}} url; default: <b>none</b></td>
<td>IP or URL of Remote Endpoint.</td>
</tr>
<tr>
<td>Endpoint Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify port to connect to Remote Endpoint. It will be set to <b>51820</b> if left empty.</td>
</tr>
<tr>
<td>Persistent Keep Alive</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify time amount in seconds between Keep Alive messages. By default this option is <b>0</b> which means it is disabled. Recommended value for a device behind NAT is 25.</td>
<td>Specify time amount in seconds between Keep Alive messages. By default this option is <b>0</b> which means it is disabled. Recommended value for a device behind NAT is 25.</td>
</tr>
</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>
</tr>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
