Jump to content
  • EN

Template:Networking rutos manual vpn: Difference between revisions

From Teltonika Networks Wiki
← Older edit
VisualWikitext
No edit summary
 
(127 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<!-- 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}}} | 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>|}}
==Summary==
==Summary==


Line 23: Line 24:
<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.5.3</b>.
<u><b>Note:</b> OpenVPN DCO kernel module moved to package manager on some devices. Please visit <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>


===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.
 
[[File:Networking_rutos_vpn_openvpn_client_status.png|border|class=tlt-border|]]
 
<table class="nd-mantable">
    <tr>
        <th>Client status</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Export</td>
        <td>-(interactive button)</td>
      <td>Exports the instance configuration to .ovpn file.</td>
    </tr>
    <tr>
      <td>Edit</td>
        <td>-(interactive button)</td>
      <td>Opens the instance configuration window.</td>
    </tr>
    <tr>
      <td>Delete</td>
        <td>-(interactive button)</td>
      <td>Removes an instance.</td>
    </tr>
</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 OpenVPN client's configuration fields:
To begin configuration, click 'Add' button, select <i>Role: Client</i>. Refer to the figure and table below for information on the OpenVPN client's configuration fields:


[[File:Networking_trb2_vpn_openvpn_client_configuration_v2.png|border|class=tlt-border|]]
[[File:Networking_rutos_vpn_openvpn_client_configuration_v5.png|border|class=tlt-border|]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>General section</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable configuration</td>
      <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>Enable current configuration.</td>
    </tr>
    <tr>
      <td>Role</td>
      <td>Client {{!}} Server; default: <b>Client</b></td>
      <td>Choose a role for OpenVPN isntance.</td>
    </tr>
    <tr>
      <td>Name</td>
      <td>string; default: <b>instance1</b></td>
      <td>Name of the OpenVPN instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable external Services</td>
       <td>Configuration type</td>
       <td>off {{!}}<span style="color:#FF8000 ;"> on</span>; default: <b>off</b></td>
       <td>Manual {{!}} <span style="color:#8B4513;">Upload config file</span> {{!}} <span style="color:#FF8000 ;">External services</span>; default: <b>Manual</b></td>
       <td>Turns the OpenVPN external Services on or off.</td>
       <td>Choose configuration type.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 58: Line 94:
       <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>
      <td>Enable OpenVPN config from file</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Enables or disables custom OpenVPN config from file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 73: Line 104:
       <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><span style="color:#8B4513;">Enable parsing</span></td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>By enabling parsing, you can modify the configuration in the future.</td>
    </tr>
    <tr>
      <td><span style="color:#8B4513;">OpenVPN configuration file</span></td>
      <td>-(interactive button)</td>
      <td>Upload OpenVPN configuration. Warning! This will overwrite your current configuration.</td>
    </tr>
        <tr>
    <td>Authentication</td>
        <td><span style="color: red;">TLS</span> {{!}} <span style="color: olive;">TLS/Password</span> {{!}} <span style="color: #0054a6;">Password</span> {{!}} <span style="color: purple;">Static key</span>; default: <b>TLS</b></td>
        <td>Choose a method to authenticate your OpenVPN network.</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><span style="color:brown ;">TUN (tunnel)</span> {{!}} TAP (bridged); default: <b>TUN (tunnel)</b></td>
       <td>Virtual network device type.
       <td>Virtual VPN interface type.</td>
            <ul>
    </tr>
                <li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), used when routing is required.</li>
    <tr>
                <li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), used when bridging is required.</li>
      <td><span style="color:brown ;">Topology</span></td>
            </ul>
      <td>NET30 {{!}} P2P {{!}} SUBNET (not shown with Static key); default: NET30</td>
        </td>
      <td>Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.</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 {{!}} UDP4 {{!}} TCP4 {{!}} UDP6 {{!}} TCP6; default: <b>UDP</b></td>
         <td>Transfer protocol used by the OpenVPN connection.
         <td>The transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.</td>
            <ul>
                <li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet Protocol (IP) suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, in file transfer).</li>
                <li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, in video streaming, live calls).</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Port</td>
     <td>Port</td>
         <td>integer [0..65535]; default: <b>1194</b></td>
         <td>integer [0..65535]; default: <b>1194</b></td>
         <td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side.<br><b>NOTE</b>: traffic on the selected port will be automatically allowed in the device firewall rules.</td>
         <td>TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>LZO</td>
    <td>Extra options</td>
      <td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
        <td>string; default: <b>none</b></td>
      <td>Turns LZO data compression on or off.</td>
        <td>Enter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.</td>
     </tr>
     </tr>
</table>
[[File:Networking_rutos_vpn_openvpn_client_configuration_network.png|border|class=tlt-border|]]
<table class="nd-mantable">
     <tr>
     <tr>
      <td>Encryption</td>
        <th>Network section</th>
       <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>
       <th>Value</th>
       <td>Algorithm used for packet encryption.</td>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Authentication</td>
     <td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
        <td>TLS {{!}} Static Key {{!}} Password {{!}} TLS/Password; default: <b>TLS</b></td>
         <td>ip; default: <b>none</b></td>
         <td>Authentication mode, used to secure data sessions.
        <td>IP address of the virtual local network interface.</td>
            <ul>
                <li><b>Static key</b> is a secret key used for server–client authentication.</li>
                <li><b>TLS</b> authentication mode uses X.509 type certificates:
                    <ul>
                        <li>Certificate Authority (CA)</li>
                        <li>Client certificate</li>
                        <li>Client key</li>
                    </ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
                </li>
                <li><b>Password</b> is a simple username/password based authentication where the owner of the OpenVPN server provides the login data.</li>
                <li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS:</span> TLS cipher</td>
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
         <td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
         <td>ip; default: <b>none</b></td>
         <td>Packet encryption algorithm cipher.</td>
         <td>IP address of the virtual remote network interface.</td>
    </tr>
    <tr>
    <td><span style="color: red;">TLS:</span> Allowed TLS ciphers</td>
        <td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
        <td>A list of TLS ciphers accepted by this connection.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Remote host/IP address</td>
       <td>Remote host/IP address</td>
       <td>ip; default: <b>none</b></td>
       <td>ip; default: <b>none</b></td>
       <td>IP address or hostname of an OpenVPN server.</td>
       <td>IP address or domain name of the OpenVPN server.</td>
    </tr> 
    <tr>
    <td>Remote network</td>
        <td>ip4; default: <b>none</b></td>
        <td>IP address of the remote LAN.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Resolve retry</td>
    <td>TAP (bridged): Bridge</td>
      <td>integer {{!}} infinite; default: <b>infinite</b></td>
        <td>lan {{!}} none; default: <b>lan</b></td>
      <td>In case server hostname resolve fails, this field indicates the amount of time (in seconds) to retry the resolve. Specify <i>infinite</i> to retry indefinitely.</td>
        <td>Assign a TAP interface to a bridge..</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep alive</td>
     <td><span style="color: purple;">Static key:</span> Local tunnel endpoint IPv6</td>
         <td>two integers separated by a space; default: <b>none</b></td>
         <td>ip; default: <b>none</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>IPv6 address of the virtual local network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IPv6</td>
         <td>ip; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>IP address of the local OpenVPN network interface.</td>
         <td>IPv6 address of the virtual remote network interface.</td>
    </tr>
    <tr>
      <td>LZO</td>
      <td>None {{!}} Adaptive {{!}} Yes {{!}} No; default: <b>None</b></td>
      <td>Use fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
      <td>Resolve retry</td>
        <td>ip; default: <b>none</b></td>
      <td>integer {{!}} infinite; default: <b>infinite</b></td>
        <td>IP address of the remote OpenVPN network (server) interface.</td>
      <td>Try to resolve the server hostname for X seconds before giving up.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Remote network IP address</td>
     <td>Keep alive</td>
         <td>ip; default: <b>none</b></td>
         <td>two integers separated by a space; default: <b>none</b></td>
         <td>LAN IP address of the remote network (server).</td>
         <td>Try to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.</td>
     </tr>
     </tr>
</table>
[[File:Networking_rutos_vpn_openvpn_client_configuration_security.png|border|class=tlt-border|]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td>Remote network IP netmask</td>
        <th>Security section</th>
        <td>netmask; default: <b>none</b></td>
      <th>Value</th>
        <td>LAN IP subnet mask of the remote network (server).</td>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: #0054a6;">Password:</span> User name</td>
       <td><span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: User name</td>
       <td>string; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>Username used for authentication to the OpenVPN server.</td>
       <td>VPN client username.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: #0054a6;">Password:</span> Password</td>
       <td><span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Password</td>
       <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>VPN client password.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Extra options</td>
      <td>Encryption</td>
        <td>string; default: <b>none</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>Extra OpenVPN options to be used by the OpenVPN instance.</td>
      <td>Packet encryption algorithm (cipher).</td>
     </tr>
     </tr>
  <tr>
        <td>Certificate files from device</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Turn on this option if you want to select generated certificate files from device.</td>
  </tr>
     <tr>
     <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td>
      <td>Data ciphers</td>
         <td>none {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
      <td>depends on authentication; default: <b>AES-256-CBC</b></td>
      <td>Select allowed data ciphers from the list; add a custom value if needed.</td>
    </tr>   
    <tr>
    <td>Authentication algorithm</td>
         <td>none {{!}} MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
         <td>HMAC authentication algorithm type.</td>
         <td>HMAC authentication algorithm type.</td>
     </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: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span>Additional HMAC authentication</td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>None {{!}} Authentication only (tls-auth) {{!}} Authentication only (tls-auth); default: <b>None</b></td>
       <td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
       <td>Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
    </tr>
    <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> HMAC key direction</td>
      <td>0 {{!}} 1; default: <b>1</b></td>
      <td>The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).</td>
    </tr>
</table>
 
[[File:Networking_rutos_vpn_openvpn_client_configuration_certificates.png|border|class=tlt-border|]]
 
<table class="nd-mantable">
    <tr>
        <th>Certificates section</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span>Use PKCS #12 format</td>
        <td>off {{!}} <span style="color: orange;">on</span>; default: <b>off</b></td>
        <td>Use PKCS #12 archive file format to bundle all the members of a chain of trust.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication key</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> <span style="color: orange;">PKCS #12 certificate chain</span></td>
      <td>.key file; default: <b>none</b></td>
        <td>-(interactive button)</td>
      <td>Uploads an HMAC authentication key file.</td>
        <td>Uploads a PKCS #12 certificate chain file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC key direction</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> <span style="color: orange;">PKCS #12 passphrase</span></td>
      <td>0 {{!}} 1 {{!}} none; default: <b>1</b></td>
        <td>string; default: <b>none</b></td>
      <td>The value of the key direction parameter should be complementary on either side (client and server) of the connection. If one side uses <i>0</i>, the other side should use <i>1</i>, or both sides should omit the parameter altogether.</td>
        <td>Passphrase to decrypt PKCS #12 certificates.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Certificate authority</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> Certificate files from device</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Choose this option if you want to select certificate files from the device.</td>
    </tr>
    <tr>
       <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> Certificate authority</td>
       <td>.ca file; default: <b>none</b></td>
       <td>.ca file; default: <b>none</b></td>
       <td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.</td>
       <td>The digital certificate verifies the ownership of a public key by the named subject of the certificate.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS:</span> Client certificate</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>: Client certificate</td>
         <td>.crt file; default: <b>none</b></td>
         <td>.crt file; default: <b>none</b></td>
         <td>Client certificate is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity.</td>
         <td>Identify a client or a user, authenticating the client to the server and establishing precisely who they are.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS:</span> Client key</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>: Client key</td>
         <td>.key file; default: <b>none</b></td>
         <td>.key file; default: <b>none</b></td>
         <td>Authenticates the client to the server and establishes precisely who they are.</td>
         <td>It has been generated for the same purpose as a client certificate.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS:</span> Private key decryption password (optional)</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>: Private key decryption password (optional)</td>
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>A password used to decrypt the server's private key. Use only if server's .key file is encrypted with a password.</td>
         <td>Decrypt private key with password (Optional).</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
     <td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
         <td>.key file; default: <b>none</b></td>
         <td>.key file; default: <b>none</b></td>
         <td>Uploads a secret key file used for server–client authentication.</td>
         <td>A pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.</td>
     </tr>
     </tr>
</table>
</table>
Line 244: Line 312:
         <ul>
         <ul>
             <li>Red for <span style="color: red;">Authentication: TLS</span></li>
             <li>Red for <span style="color: red;">Authentication: TLS</span></li>
            <li>Olive for <span style="color: olive;">Authentication: TLS/Password</span></li>
             <li>Purple for <span style="color: purple;">Authentication: Static key</span></li>
             <li>Purple for <span style="color: purple;">Authentication: Static key</span></li>
             <li>Blue for <span style="color: #0054a6;">Authentication: Password</span></li>
             <li>Blue for <span style="color: #0054a6;">Authentication: Password</span></li>
            <li>Brown for <span style="color: #8B4513;">OpenVPN config from file</span></li>
         </ul>
         </ul>
     </li>
     </li>
Line 253: Line 323:
===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. Only one OpenVPN server instance is allowed to be added.


A server needs to have a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]] in order to be available from the public network (the Internet).
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 OpenVPN server's configuration fields:
[[File:Networking_rutos_vpn_openvpn_server_status.png|border|class=tlt-border|]]
 
[[File:Networking_rutx_vpn_openvpn_server_configuration_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Server status</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Export</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>-(interactive button)</td>
       <td>Turns the OpenVPN instance on or off.</td>
       <td>Exports the instance configuration to .ovpn file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable OpenVPN config from file</td>
       <td>Edit</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>-(interactive button)</td>
       <td>Enables or disables custom OpenVPN config from file.</td>
       <td>Opens the instance configuration window.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>TUN/TAP</td>
       <td>Delete</td>
      <td>TUN (tunnel) {{!}} TAP (bridged); default: <b>TUN (tunnel)</b></td>
        <td>-(interactive button)</td>
       <td>Virtual network device type.
       <td>Removes an instance.</td>
            <ul>
                <li><b>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), used when routing is required.</li>
                <li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), used when bridging is required.</li>
            </ul>
        </td>
     </tr>
     </tr>
</table>
To begin configuration, click 'Add' button, select <i>Role: Server</i>. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
[[File:Networking_rutos_vpn_openvpn_server_configuration_v5.png|border|class=tlt-border|]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td>Protocol</td>
         <th>General section</th>
         <td>UDP {{!}} TCP{{#ifeq:{{{series}}}|RUTX| {{!}} <span style="color: #20C0D7;"><b>UDP6</b></span> {{!}} <span style="color: #20C0D7;"><b>TCP6</b></span>}}; default: <b>UDP</b></td>
      <th>Value</th>
        <td>Transfer protocol used by the OpenVPN connection.
      <th>Description</th>
            <ul>
                <li><b>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet Protocol (IP) suite. It ensures the recipient will receive packets in the order they were sent by numbering, analysing response messages, checking for errors and resending them if an issue occurs. It should be used when reliability is crucial (for example, file transfer).</li>
                <li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls).</li>
            </ul>
        </td>Which SERVER LAN networks should be reachable from this client
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Port</td>
      <td>Enable configuration</td>
         <td>integer [0..65535]; default: <b>1194</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
        <td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side.<br><b>NOTE</b>: traffic on the selected port will be automatically allowed in device firewall rules.</td>
      <td>Enable current configuration.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>LZO</td>
       <td>Role</td>
       <td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
       <td>Client {{!}} Server; default: <b>Server</b></td>
       <td>Turns LZO data compression on or off.</td>
       <td>Choose a role for OpenVPN isntance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Encryption</td>
       <td>Name</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>string; default: <b>instance1</b></td>
       <td>Algorithm used for packet encryption.</td>
       <td>Name of the OpenVPN instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Authentication</td>
      <td>Configuration type</td>
        <td>TLS {{!}} Static Key {{!}} TLS/Password; default: <b>TLS</b></td>
      <td>Manual {{!}} <span style="color:#8B4513;">Upload config file</span>; default: <b>Manual</b></td>
        <td>Authentication mode, used to secure data sessions.
      <td>Choose configuration type.</td>
            <ul>
                <li><b>Static key</b> is a secret key used for server–client authentication.</li>
                <li><b>TLS</b> authentication mode uses X.509 type certificates:
                    <ul>
                        <li>Certificate Authority (CA)</li>
                        <li>Client certificate</li>
                        <li>Client key</li>
                    </ul>All mentioned certificates can be generated using OpenVPN or Open SSL utilities on any type of host machine. One of the most popular utilities used for this purpose is called Easy-RSA.
                </li>
                <li><b>TLS/Password</b> uses both TLS and username/password authentication.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
      <td><span style="color:#8B4513;">Enable parsing</span></td>
        <td>ip; default: <b>none</b></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>IP address of the local OpenVPN network interface.</td>
      <td>By enabling parsing, you can modify the configuration in the future.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
      <td><span style="color:#8B4513;">OpenVPN configuration file</span></td>
         <td>ip; default: <b>none</b></td>
      <td>-(interactive button)</td>
         <td>IP address of the remote OpenVPN network (client) interface.</td>
      <td>Upload OpenVPN configuration. Warning! This will overwrite your current configuration.</td>
    </tr>
        <tr>
    <td>Authentication</td>
         <td><span style="color: red;">TLS</span> {{!}} <span style="color: olive;">TLS/Password</span> {{!}} <span style="color: #0054a6;">Password</span> {{!}} <span style="color: purple;">Static key</span>; default: <b>TLS</b></td>
         <td>Choose a method to authenticate your OpenVPN network.</td>
    </tr>
    <tr>
      <td>TUN/TAP</td>
      <td><span style="color:brown ;">TUN (tunnel)</span> {{!}} TAP (bridged); default: <b>TUN (tunnel)</b></td>
      <td>Virtual VPN interface type.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: purple;">Static key:</span> Remote network IP address</td>
      <td><span style="color:brown ;">Topology</span></td>
        <td>ip; default: <b>none</b></td>
      <td>NET30 {{!}} P2P {{!}} SUBNET (not shown with Static key); default: NET30</td>
        <td>LAN IP address of the remote network (client).</td>
      <td>Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: purple;">Static key:</span> Remote network IP netmask</td>
     <td>Protocol</td>
         <td>netmask; default: <b>none</b></td>
         <td>UDP {{!}} TCP {{!}} UDP4 {{!}} TCP4 {{!}} UDP6 {{!}} TCP6; default: <b>UDP</b></td>
         <td>LAN IP subnet mask of the remote network (client).</td>
         <td>The transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> TLS cipher</td>
     <td>Port</td>
         <td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
         <td>integer [0..65535]; default: <b>1194</b></td>
         <td>Packet encryption algorithm cipher.</td>
         <td>TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS/Password:</span> Allowed TLS ciphers</td>
     <td><span style="color:brown ;">Push option (not shown with Static key)</span></td>
         <td>All {{!}} DHE+RSA {{!}} Custom; default: <b>All</b></td>
         <td>string; default: <b>none</b></td>
         <td>A list of TLS ciphers accepted by this connection.</td>
         <td>Push a configuration option back to the client for remote execution.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Client to client</td>
    <td>Extra options</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>string; default: <b>none</b></td>
      <td>Allows OpenVPN clients to communicate with each other on the VPN network.</td>
        <td>Enter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.</td>
     </tr>
     </tr>
</table>
[[File:Networking_rutos_vpn_openvpn_server_configuration_network.png|border|class=tlt-border|]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Keep alive</td>
        <th>Network section</th>
        <td>two integers separated by a space; default: <b>none</b></td>
      <th>Value</th>
        <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 specifiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances.<br><b>Example</b>: <i>10 120</i></td>
      <th>Description</th>
     </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: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Virtual network IP address</td>
         <td>ip4; default: <b>none</b></td>
         <td>ip4; default: <b>none</b></td>
         <td>IPv4 address of the OpenVPN network.</td>
         <td>IP address used for the virtual network.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Virtual network netmask</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Virtual network netmask</td>
         <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 used for the virtual network.</td>
     </tr>
     </tr>
     <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><span style="color: purple;">Static key:</span> Local tunnel endpoint IP</td>
         <td>ip6; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>IPv6 address of the OpenVPN network.</td>
         <td>IP address of the virtual local network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Push option</td>
    <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
      <td>OpenVPN options; default: <b>none</b></td>
        <td>ip; default: <b>none</b></td>
      <td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients.</td>
        <td>IP address of the virtual remote network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Allow duplicate certificates</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Assign IP start</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>IP; default: <b>none</b></td>
         <td>When enabled allows multiple clients to connect using the same certificates.</td>
         <td>Assign IP addresses starting from a pool of subnets to be dynamically allocated to connecting clients.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: #0054a6;">TLS/Password:</span> User name</td>
    <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Assign IP end</td>
      <td>string; default: <b>none</b></td>
        <td>IP; default: <b>none</b></td>
      <td>Username used for authentication to this OpenVPN server.</td>
        <td>Assign IP addresses ending at a pool of subnets to be dynamically allocated to connecting clients.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: #0054a6;">TLS/Password:</span> Password</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Virtual network IPv6 address</td>
      <td>string; default: <b>none</b></td>
        <td>ip6; default: <b>none</b></td>
      <td>Password used for authentication to this OpenVPN server.</td>
        <td>IPv6 address used for the virtual network.</td>
    </tr>
    <tr>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Assign IPv6 address</td>
        <td>ip6; default: <b>none</b></td>
        <td>Specify an IPv6 address pool for dynamic assignment to clients.</td>
    </tr>
    <tr>
    <td><span style="color: purple;">Static key:</span> Local tunnel endpoint IPv6</td>
        <td>ip; default: <b>none</b></td>
        <td>IPv6 address of the virtual local network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: purple;">Static key:</span> Static pre-shared key</td>
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IPv6</td>
         <td>.key file; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>Uploads a secret key file used for server–client authentication.</td>
         <td>IPv6 address of the virtual remote network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Certificate authority</td>
    <td>TAP (bridged): Bridge</td>
      <td>.ca file; default: <b>none</b></td>
        <td>lan {{!}} none; default: <b>lan</b></td>
      <td>Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.</td>
        <td>Assign a TAP interface to a bridge..</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span>  Server certificate</td>
      <td>LZO</td>
        <td>.crt file; default: <b>none</b></td>
      <td>None {{!}} Adaptive {{!}} Yes {{!}} No; default: <b>None</b></td>
        <td>A type of digital certificate that is used to identify the OpenVPN server.</td>
      <td>Use fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span>  Server key</td>
      <td>Client to client</td>
        <td>.key file; default: <b>none</b></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Authenticates clients to the server.</td>
      <td>Allow client-to-client traffic.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Diffie Hellman parameters</td>
      <td>Resolve retry</td>
        <td>.pem file; default: <b>none</b></td>
      <td>integer {{!}} infinite; default: <b>infinite</b></td>
        <td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange.</td>
      <td>Try to resolve the server hostname for X seconds before giving up.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> CRL file (optional)</td>
     <td>Keep alive</td>
         <td>.pem file {{!}} .crl file; Default: <b>none</b></td>
         <td>two integers separated by a space; default: <b>none</b></td>
         <td>A certificate revocation list (CRL) file is a list of certificates that have been revoked by the certificate authority (CA). It indicates which certificates are no longer acccepted by the CA and therefore cannot be authenticated to the server.</td>
         <td>Try to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.</td>
     </tr>
     </tr>
</table>
</table>


<b>Additional notes</b>:
[[File:Networking_rutos_vpn_openvpn_server_configuration_security.png|border|class=tlt-border|]]
<ul>
 
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
<table class="nd-mantable">
        <ul>
     <tr>
            <li>Red for <span style="color: red;">Authentication: TLS</span></li>
         <th>Security section</th>
            <li>Purple for <span style="color: purple;">Authentication: Static key</span></li>
       <th>Value</th>
            <li>Blue for <span style="color: #0054a6;">Authentication: TLS/Password</span></li>
        </ul>
    </li>
    <li>After changing any of the parameters, don't forget to click the <b>Save & Apply</b> button located at the bottom-right side of the page.</li>
</ul>
 
====TLS Clients====
----
<b>TLS Clients</b> is a way to differentiate clients by their Common Names (CN), which are found in the client certificate file. It can be used to assign specific VPN addresses to corresponding clients and bind them to their LAN addresses, making the server aware of which client has which LAN IP address.
 
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_rutos_vpn_openvpn_tls_clients.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>Endpoint name</td>
       <td><span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Usernames & Passwords</td>
      <td>string; default: <b>none</b></td>
      <td>-(interactive button)</td>
       <td>A custom name for the client.</td>
       <td>File containing usernames and passwords against which the server can authenticate clients. Each username and password pair should be placed on a single line and separated by a space.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Common name (CN)</td>
      <td>Encryption</td>
        <td>string; default: <b>none</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>Client’s Common Name (CN) found in the client certificate file.</td>
      <td>Packet encryption algorithm (cipher).</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Virtual local endpoint</td>
      <td>Data ciphers</td>
        <td>ip; default: <b>none</b></td>
      <td>depends on authentication; default: <b>AES-256-CBC</b></td>
        <td>Client’s local address in the virtual network.</td>
      <td>Select allowed data ciphers from the list; add a custom value if needed.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Virtual remote endpoint</td>
       <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> Allow duplicate certificates</td>
       <td>ip; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Client’s remote address in the virtual network.</td>
       <td>All clients can have the same certificates.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Private network</td>
     <td>Authentication algorithm</td>
         <td>ip; default: <b>none</b></td>
         <td>none {{!}} MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
         <td>Client’s private network (LAN) IP address.</td>
         <td>HMAC authentication algorithm type.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Private netmask</td>
      <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span>Additional HMAC authentication</td>
        <td>netmask; default: <b>none</b></td>
      <td>None {{!}} Authentication only (tls-auth) {{!}} Authentication only (tls-auth); default: <b>None</b></td>
        <td>Client’s private network (LAN) IP netmask.</td>
      <td>Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Covered Network</td>
      <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> HMAC key direction</td>
        <td>network(); default: <b>none</b></td>
      <td>0 {{!}} 1; default: <b>1</b></td>
        <td>Selects which networks should be made accessible to this client.</td>
      <td>The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).</td>
     </tr>
     </tr>
</table>
</table>


==GRE==
[[File:Networking_rutos_vpn_openvpn_server_configuration_certificates.png|border|class=tlt-border|]]
 
<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">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Certificates section</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Enabled</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span>Use PKCS #12 format</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>off {{!}} <span style="color: orange;">on</span>; default: <b>off</b></td>
         <td>Turns the GRE instance on or off.</td>
         <td>Use PKCS #12 archive file format to bundle all the members of a chain of trust.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Tunnel source</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> <span style="color: orange;">PKCS #12 certificate chain</span></td>
      <td>network interface; default: <b>none</b></td>
        <td>-(interactive button)</td>
      <td>Network interface used to establish the GRE Tunnel.</td>
        <td>Uploads a PKCS #12 certificate chain file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Remote endpoint IP address</td>
      <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Certificate authority</td>
        <td>ip; default: <b>none</b></td>
      <td>.ca file; default: <b>none</b></td>
        <td>External IP address of another GRE instance used to establish the initial connection between peers.</td>
      <td>The digital certificate verifies the ownership of a public key by the named subject of the certificate.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>MTU</td>
    <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Server certificate</td>
      <td>integer; default: <b>1476</b></td>
        <td>.crt file; 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>
        <td>Certificate servers validate or certify keys as part of a public key infrastructure.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>TTL</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Server key</td>
         <td>integer [0..255]; default: <b>255</b></td>
         <td>.key file; default: <b>none</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>
         <td>It has been generated for the same purpose as the server certificate.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Outbound key</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: Diffie Hellman parameters</td>
         <td>integer [0..65535]; default: <b>none</b></td>
         <td>.pem file; 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>
         <td>Diffie-Hellman key exchange is a specific method of exchanging cryptographic keys.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Inbound key</td>
     <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password</span>: CRL file (optional)</td>
         <td>integer [0..65535]; default: <b>none</b></td>
         <td>.pem file {{!}} .crl file; 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>
         <td>Revoking a certificate means to invalidate a previously signed certificate so that it can no longer be used for authentication purposes. Upload a .pem revocation file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Path MTU Discovery</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> <span style="color: orange;">PKCS #12 passphrase</span></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>string; default: <b>none</b></td>
         <td>When unchecked, sets the <i>nopmtudisc</i> option for tunnel. Can not be used together with the TTL option.</td>
         <td>Passphrase to decrypt PKCS #12 certificates.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Keep alive</td>
        <td><span style="color: red;">TLS</span>/<span style="color: olive;">TLS/Password</span>/<span style="color: #0054a6;">Password:</span> Private key decryption password (optional)</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>string; default: <b>none</b></td>
         <td>Turns "keep alive" on or off. The "keep alive" feature sends packets to the remote instance in order to determine the health of the connection. If no response is received, the device will attempt to re-establish the tunnel.</td>
         <td>Decrypt private key with password (Optional).</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Keep alive interval</td>
         <td><span style="color: purple;">Static key</span>: Static pre-shared key</td>
         <td>integer [0..255]; default: <b>none</b></td>
         <td>-(interactive button)</td>
        <td>Frequency (in seconds) at which "keep alive" packets are sent to the remote instance.</td>
         <td>A pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.</td>
    </tr>
    <tr>
    <td>Local GRE interface IP address</td>
        <td>ip; default: <b>none</b></td>
         <td>IP address of the local GRE Tunnel network interface.</td>
    </tr>
    <tr>
    <td>Local GRE interface netmask</td>
         <td>netmask; default: <b>none</b></td>
        <td>Subnet mask of the local GRE Tunnel network interface.</td>
     </tr>
     </tr>
</table>
</table>


===GRE: Routing Settings===
<b>Additional notes</b>:
<ul>
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
        <ul>
            <li>Red for <span style="color: red;">Authentication: TLS</span></li>
            <li>Olive for <span style="color: olive;">Authentication: TLS/Passwords</span></li>
            <li>Purple for <span style="color: purple;">Authentication: Static key</span></li>
            <li>Blue for <span style="color: #0054a6;">Authentication: Password</span></li>
            <li>Brown for <span style="color: #8B4513;">OpenVPN config from file</span></li>
        </ul>
    </li>
    <li>After changing any of the parameters, don't forget to click the <b>Save & Apply</b> button located at the bottom-right side of the page.</li>
</ul>
 
====TLS Clients====
----
----
<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>TLS Clients</b> is a way to differentiate clients by their Common Names (CN), which are found in the client certificate file. It can be used to assign specific VPN addresses to corresponding clients and bind them to their LAN addresses, making the server aware of which client has which LAN IP address.
 
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_gre_gre_configuration_routing_settings_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_openvpn_tls_clients_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 592: Line 648:
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Remote subnet IP address</td>
     <td>Common name (CN)</td>
        <td>string; default: <b>none</b></td>
        <td>Client certificate CN field (e.g.,s [email protected]).</td>
    </tr>
    <tr>
    <td>Virtual local endpoint</td>
         <td>ip; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>IP address of the network behind the device that hosts the remote GRE instance.</td>
         <td>Client’s local address in the virtual network.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Remote subnet netmask</td>
      <td>Virtual remote endpoint</td>
         <td>netmask; default: <b>none</b></td>
      <td>ip; default: <b>none</b></td>
         <td>Subnet mask of the network behind the device that hosts the remote GRE instance.</td>
      <td>Client’s remote address in the virtual network.</td>
    </tr>
    <tr>
      <td>Local tunnel endpoint IPv6</td>
      <td>ip; default: <b>none</b></td>
      <td>IPv6 address of virtual local network interface.</td>
    </tr>
    <tr>
     <td>Private network IPv6</td>
         <td>ip; default: <b>none</b></td>
         <td>Client’s private network (LAN) IPv6 address.</td>
    </tr>
    <tr>
    <td>Private network</td>
        <td>ip; default: <b>none</b></td>
        <td>Client’s private network (LAN) IP address.</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>


==IPsec==
====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.


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.
<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>


To begin configuration, click the button that looks like a pencil located next to the instance.
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.


===IPsec Instance===
<pre>
----
{
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.
"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>


[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings.png|border|class=tlt-border]]
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:


<table class="nd-mantable">
<pre>
     <tr>
{
         <th>Field</th>
"unblocked": {
       <th>Value</th>
"ip": "188.XXX.XXX.XXX",
       <th>Description</th>
"port": "udp:1194"
     </tr>
}
}
</pre>
 
{{#ifeq: {{{name}}} | TAP200 | |
==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_v5.png|border|class=tlt-border]]
 
<table class="nd-mantable">
     <tr>
         <th>Field</th>
       <th>Value</th>
       <th>Description</th>
     </tr>
     <tr>
     <tr>
     <td>Enable</td>
     <td>Enabled</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns the IPsec instance on or off.</td>
         <td>Turns the GRE instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Remote endpoint</td>
    <td>IPv6</td>
      <td>host {{!}} ip; default: <b>none</b></td>
        <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
      <td>IP address or hostname of the remote IPsec instance.</td>
        <td>Use IPv4 or IPv6 for the GRE tunnel.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Authentication method</td>
       <td>Tunnel source</td>
       <td>Pre-shared key {{!}} X.509; default: <b>Pre-shared key</b></td>
       <td>network interface; default: <b>-</b></td>
       <td>Specify authentication method. Choose between Pre-shared key and X.509 certificates.</td>
       <td>Network interface used to establish the GRE Tunnel.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color:chocolate">Pre-shared key:</span> Pre shared key</td>
     <td>Remote endpoint IP address</td>
        <td>string; default: <b>none</b></td>
        <td>ipv4/<span style="color:blue">ipv6</span>; default: <b>none</b></td>
         <td>A shared password used for authentication between IPsec peers before a secure channel is established.</td>
         <td>External IP address of another GRE instance used to establish the initial connection between peers.</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>MTU</td>
        <td>.der file; default: <b>none</b></td>
      <td>integer; default: <b>1476</b></td>
        <td>A public key file.</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><span style="color:darkred">X.509:</span> Local Certificate</td>
     <td>Outbound key</td>
         <td>.der file; default: <b>none</b></td>
         <td>integer [0..4294967295]; default: <b>none</b></td>
         <td>A local certificate file.</td>
         <td>Key for 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>
     <tr>
     <tr>
     <td><span style="color:darkred">X.509:</span> CA Certificate</td>
     <td>Inbound key</td>
         <td>.der file; default: <b>none</b></td>
         <td>integer [0..4294967295]; default: <b>none</b></td>
         <td>A certificate authority file.</td>
         <td>Key for 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>
     <tr>
     <tr>
     <td>Local identifier</td>
     <td>Path MTU Discovery</td>
         <td>ip {{!}} string; default: <b>none</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Defines how the user (left participant) will be identified during authentication.
         <td>When unchecked, sets the <i>nopmtudisc</i> option for tunnel. Can not be used together with the TTL option.</td>
            <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>Remote identifier</td>
     <td>TTL</td>
         <td>ip {{!}} string; default: <b>none</b></td>
         <td>integer [0..255]; default: <b>255</b></td>
         <td>Defines how the right participant will be identified during authentication.
        <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>
            <ul>
    </tr>
                <li><b>IP</b> - Internet Protocol address.</li>
    <tr>
                <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>
    <td>Keep alive</td>
            </ul>
        <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
         </td>
         <td>The 'keep alive' feature sends packets to the remote instance in order to determine the health of the connection. If no response is received for [Keep alive retries] times, the device will mark the tunnel as DOWN.</td>
    </tr>
    <tr>
    <td><span style="color:blue">Keep alive interval</span></td>
        <td>integer [1..255]; default: <b>20</b></td>
        <td>Frequency (in seconds) at which 'keep alive' packets are sent to the remote instance.</td>
    </tr>
    <tr>
    <td><span style="color:blue">Keep alive retries</span></td>
        <td>integer [1..255]; default: <b>3</b></td>
        <td>Amount of keep alive packets to lose before marking tunnel as DOWN.</td>
    </tr>
    <tr>
    <td>Local GRE interface IP address</td>
        <td>ipv4; default: <b>none</b></td>
        <td>IP address of the local GRE Tunnel network interface.</td>
    </tr>
    <tr>
    <td>Local GRE interface netmask</td>
        <td>netmask; default: <b>none</b></td>
         <td>Subnet mask of the local GRE Tunnel network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Multiple secrets</td>
    <td>Local GRE interface IPv6 address</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>ipv6; default: <b>none</b></td>
      <td>Enable to show <b>Global Secret Settings</b> section for configuring multiple secrets.</td>
        <td>IPv6 address of the local GRE Tunnel instance.</td>
     </tr>
     </tr>
</table>
</table>


<b>Additional notes</b>:
===GRE: Routing Settings===
<ul>
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
        <ul>
            <li>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>
        </ul>
    </li>
</ul>
 
====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>.
<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.


[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings_global_secrets_settings.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_gre_gre_configuration_routing_settings_v4.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>IPv4 routing settings</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>ID Selector</td>
     <td>Remote subnet IPv4 address</td>
         <td>%any, IP or FQDN; default: <b>none</b></td>
         <td>ipv4; 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>LAN IPv4 address of the device that hosts the remote GRE Tunnel instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Type</td>
    <td>Remote subnet netmask</td>
      <td>psk {{!}} xauth; default: <b>psk</b></td>
        <td>netmask; default: <b>none</b></td>
      <td>IPSec secret type.</br><b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
        <td>Subnet mask of the network behind the device that hosts the remote GRE instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Secret</td>
    <td>Actions</td>
      <td>string; default: <b>none</b></td>
        <td>-(interactive button)</td>
      <td>A shared password to authenticate between the peers. Minimum length is 5 symbols. All characters are allowed except `.</td>
        <td>Removes configuration.</td>
     </tr>
     </tr>
</table>
====Advanced Settings====
----
The <b>Advanced settings</b> section is only visible when <b>X.509</b> is selected as Authentication method.
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>IPv6 routing settings</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>
    <!-- removed on 7.0, to return on 7.1 <tr>
    <td>Certificate files from device</td>
        <td>off | on; default: <b>off</b></td>
        <td>Uses certificate file generated on this device instead of uploading. (You can generate certificates within this device via the System → Administration → [[{{{name}}}_Administration#Certificates|Certificates]] page.)</td>
    </tr> -->
     <tr>
     <tr>
     <td>Remote Certificate</td>
     <td>Remote subnet IPv6 address</td>
         <td>.crt file; default: <b>none</b></td>
         <td>ipv6; default: <b>none</b></td>
         <td>Selects a certificate file from a computer.</td>
         <td>LAN IPv6 address of the device that hosts the remote GRE Tunnel instance.</td>
    </tr>
    <tr>
    <td>Actions</td>
        <td>-(interactive button)</td>
        <td>Removes configuration.</td>
     </tr>
     </tr>
</table>
</table>


===IPsec Instance: Connection Settings===
==IPsec==
----
 
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.


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.
[[File:Networking rutos vpn ipsec add button_v1.png|border|class=tlt-border]]


====General Settings====
===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.


[[File:Networking_rutos_vpn_ipsec_connection_settings_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">
Line 769: Line 894:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Mode</td>
    <td>Enable</td>
      <td>Start {{!}} Add {{!}} Route; default: <b>Start</b></td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>Specifies which operation will be done automatically at IPSec startup.</td>
        <td>Turns the IPsec instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Type</td>
       <td>Remote endpoint</td>
       <td>Tunnel {{!}} Transport; default: <b>Tunnel</b></td>
       <td>host {{!}} ip; default: <b>none</b></td>
       <td>Type of connection.
       <td>Domain names, ip addresses (with or without network mask), %any, %any4, %any6 values are accepted (e.g., 192.168.1.1 or example.com).</td>
            <ul>
                <li><b>Tunnel</b> - protects internal routing information by encapsulating the entire IP packet (IP header and payload); commonly used in site-to-site VPN connections; supports NAT traversal.</li>
                <li><b>Transport</b> - only encapsulates IP payload data; used in client-to-site VPN connections; does not support NAT traversal; usually implemented with other tunneling protocols (for example, L2TP).</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: red;">Tunnel:</span> Default route</td>
      <td>Authentication method</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td><span style="color:chocolate">Pre-shared key</span> {{!}} <span style="color:darkred">X.509 {{!}} EAP</span> {{!}} <span style="color:blue">PKCS#12</span>; default: <b>Pre-shared key</b></td>
         <td>Turn on to route all traffic through IPSec tunnel.</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>-(interactive button)</td>
         <td>Upload PKCS12 container file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color: red;">Tunnel:</span> Local subnet</td>
    <td><span style="color:blue">PKCS#12:</span> PKCS12 decryption passphrase</td>
      <td>ip/netmask {{!}} default: <b>none</b></td>
        <td>string; default: <b>none</b></td>
      <td>Local IP address and subnet mask used to determine which part of the network can be accessed in the VPN network. Netmask range [0..32]. If left empty, IP address will be selected automatically.</td>
        <td>Passphrase to decrypt PKCS12 container.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Tunnel:</span> Remote subnet</td>
     <td><span style="color:chocolate">Pre-shared key:</span> Pre shared key</td>
         <td>ip/netmask; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Remote network IP address and subnet mask used to determine which part of the network can be accessed in the VPN network. Netmask range [0..32]. This value must differ from the device’s LAN IP.</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: purple;">Transport:</span> Bind to</td>
     <td><span style="color:darkred">X.509: {{!}} EAP:</span> Certificate files from device</td>
         <td>GRE interface; L2TP interface; default: <b>none</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Bind to GRE or L2TP interface to create GRE/L2TP over IPsec.</td>
         <td>Choose this option if you want to select certificate files from device. Certificate files can be generated [[{{{name}}}_Administration#Certificates|here]]</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Key exchange</td>
     <td><span style="color:darkred">X.509: {{!}} EAP:</span> Key</td>
        <td>IKEv1 {{!}} IKEv2; default: <b>IKEv1</b></td>
         <td>A private key file; default: <b>none</b></td>
         <td>Internet Key Exchange (IKE) version used for key exchange.
        <td>A private key file.</td>
            <ul>
     </tr>
                <li><b>IKEv1</b> - more commonly used but contains known issues, for example, dealing with NAT.</li>
                <li><b>IKEv2</b> - updated version with increased and improved capabilities, such as integrated NAT support, supported multihosting, deprecated exchange modes (does not use main or aggressive mode; only 4 messages required to establish a connection).</li>
            </ul>
        </td>
     </tr>
</table>
 
<b>Additional notes</b>:
<ul>
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
        <ul>
            <li>Red for <span style="color: red;">Type: Tunnel</span></li>
            <li>Purple for <span style="color: purple;">Type: Transport</span></li>
        </ul>
    </li>
</ul>
 
====Advanced settings====
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings.png|border|class=tlt-border]]
 
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td><span style="color:darkred">X.509: {{!}} EAP:</span> Key decryption passphrase</td>
      <th>Value</th>
        <td>A password for private key files; default: <b>none</b></td>
      <th>Description</th>
        <td>If the private key file is encrypted, the passphrase must be defined.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Aggressive</td>
    <td><span style="color:darkred">X.509: {{!}} EAP:</span> Local Certificate</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>.der file; default: <b>none</b></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>
        <td>A local certificate file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Force encapsulation</td>
     <td><span style="color:darkred">X.509: {{!}} EAP:</span> CA Certificate</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>.der file; default: <b>none</b></td>
         <td>Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.</td>
         <td>A certificate authority file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Local firewall</td>
    <td>Local identifier</td>
      <td>off {{!}} on; default: <b>on</b></td>
        <td>ip {{!}} string; default: <b>none</b></td>
      <td>Adds necessary firewall rules to allow traffic of this IPsec instance on this device.</td>
        <td>Defines how the user (left participant) will be identified during authentication. Maximum length of value is 255.
            <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>Remote firewall</td>
     <td>Remote identifier</td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>ip {{!}} string; default: <b>none</b></td>
         <td>Adds necessary firewall rules to allow traffic of from the opposite IPsec instance on this device.</td>
         <td>Defines how the right participant will be identified during authentication. Maximum length of value is 255.
            <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>Compatibility mode</td>
      <td>Multiple secrets</td>
        <td>off {{!}} on; default: <b>off</b></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>
      <td>Enable to show <b>Global Secret Settings</b> section for configuring multiple secrets.</td>
     </tr>
     </tr>
</table>
<b>Additional notes</b>:
<ul>
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
        <ul>
            <li>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/EAP</span></li>
            <li>Blue for <span style="color: blue;">Authentication method: PKCS#12</span></li>
        </ul>
    </li>
</ul>
====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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td>Inactivity</td>
        <th>Field</th>
        <td>integer; default: <b>none</b></td>
      <th>Value</th>
        <td>Defines timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.</td>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Dead Peer Detection</td>
     <td>ID Selector</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>%any, IP or FQDN; default: <b>none</b></td>
         <td>A function used during Internet Key Exchange (IKE) to detect a "dead" peer. It used to reduce traffic by minimizing the number of messages when the opposite peer in unavailable and as failover mechanism.</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. Maximum length of value is 255. <b>NOTE:</b> IKEv1 only supports IP address ID selector.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD action</td>
      <td>Type</td>
        <td>Restart {{!}} Hold {{!}} Clear {{!}} None; default: <b>Restart</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>Controls the use of the Dead Peer Detection protocol where notification messages are periodically sent in order to check the liveliness of the IPsec peer.</td>
      <td>Make sure to turn on the "Enable XAUTH" option in connection settings, if you want to use XAUTH type secrets.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD Delay</td>
      <td>Secret</td>
        <td>integer; default: <b>none</b></td>
      <td>string; default: <b>none</b></td>
        <td>The frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.</td>
      <td>A shared password (or EAP key file) to authenticate between the peers. Minimum length is 5 symbols. All characters are allowed except `.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD Timeout</td>
     <td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Secret</td>
         <td>integer; default: <b>none</b></td>
         <td>Private key file; default: <b>none</b></td>
         <td>Defines the timeout interval, after which all connections to a peer are deleted in case of inactivity.</td>
         <td>A private key file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>XAuth identity</td>
     <td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Key decryption passphrase</td>
         <td>string; default: <b>none</b></td>
         <td>A password for private key files; 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>
         <td>If the private key file is encrypted, the passphrase must be defined.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Tunnel:</span> Remote source IP</td>
     <td>Actions</td>
         <td>ip; default: <b>none</b></td>
         <td>-(interactive button)</td>
         <td>The internal source IP to use in a tunnel for the remote (right) peer.</td>
         <td>Deletes global secret.</td>
     </tr>
     </tr>
</table>
===IPsec Instance: Connection Settings===
----
The <b>connection settings</b> section is used to configure the main parameters of an IPsec connection. Refer to the figure and table below for information on the configuration fields located in the connection settings section.
====General Settings====
----
[[File:Networking rutos vpn ipsec connection settings general settings v5.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td><span style="color: red;">Tunnel:</span> Local source IP</td>
        <th>Field</th>
        <td>ip; default: <b>none</b></td>
      <th>Value</th>
        <td>The internal (left) source IP to use in a tunnel, also known as virtual IP.</td>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
    <td><span style="color: red;">Tunnel:</span> Remote DNS</td>
      <td>Mode</td>
        <td>ip; default: <b>none</b></td>
      <td>Start {{!}} Add {{!}} Route; default: <b>Start</b></td>
        <td>List of DNS server addresses to exchange as configuration attributes. On the responder, only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned to the client.</td>
      <td>Specifies which operation will be done automatically at IPSec startup.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Locally allowed protocols</td>
      <td>Type</td>
        <td>string; default: <b>none</b></td>
      <td>Tunnel {{!}} Transport; default: <b>Tunnel</b></td>
        <td>Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.</td>
      <td>Type of connection.
            <ul>
                <li><b>Tunnel</b> - protects internal routing information by encapsulating the entire IP packet (IP header and payload); commonly used in site-to-site VPN connections; supports NAT traversal.</li>
                <li><b>Transport</b> - only encapsulates IP payload data; used in client-to-site VPN connections; does not support NAT traversal; usually implemented with other tunneling protocols (for example, L2TP).</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Remotely allowed protocols</td>
     <td><span style="color: red;">Tunnel:</span> Default route</td>
         <td>string; default: <b>none</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.</td>
         <td>Turn on to route all traffic through IPSec tunnel.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Custom option</td>
     <td><span style="color: red;">Tunnel:</span> Route based IPsec</td>
         <td>string; default: <b>none</b></td>
         <td>off {{!}} <span style="color: olive;">on</span>; default: <b>off</b></td>
         <td>Add custom connection parameters.</td>
         <td>IPsec VPN tunnel created between two end points.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Local source IP</td>
     <td><span style="color: red;">Tunnel:</span> <span style="color: olive;">IP address</span></td>
         <td>ip; default: <b>none</b></td>
         <td>IP adress; default: <b>none</b></td>
         <td>The internal (left) source IP to use in a tunnel, also known as virtual IP.</td>
         <td>Assign an IP address to XFRM interface.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Tunnel:</span> <span style="color: olive;">MTU</span></td>
        <td>integer [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><span style="color: red;">Tunnel:</span> Passthrough interfaces</td>
      <td><span style="color: red;">Tunnel:</span> Local subnet</td>
        <td>network interfaces; default: <b>none</b></td>
      <td>ip/netmask {{!}} default: <b>none</b></td>
        <td>Network interfaces to include in IPsec Passthrough.</td>
      <td>Private subnet behind the left (local) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Tunnel:</span> Passthrough subnets</td>
     <td><span style="color: red;">Tunnel:</span> Remote subnet</td>
         <td>ip/netmask; default: <b>none</b></td>
         <td>ip/netmask; default: <b>none</b></td>
         <td>Networks to include in IPsec Passthrough.</td>
         <td>Private subnet behind the right (remote) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.</td>
    </tr>
    <tr>
    <td><span style="color: purple;">Transport:</span> Bind to</td>
        <td>GRE interface; L2TP interface; default: <b>none</b></td>
        <td>Bind to GRE or L2TP interface to create GRE/L2TP over IPsec.</td>
    </tr>
    <tr>
    <td>Key exchange</td>
        <td>IKEv1 {{!}} IKEv2; default: <b>IKEv1</b></td>
        <td>Internet Key Exchange (IKE) version used for key exchange.
            <ul>
                <li><b>IKEv1</b> - more commonly used but contains known issues, for example, dealing with NAT.</li>
                <li><b>IKEv2</b> - updated version with increased and improved capabilities, such as integrated NAT support, supported multihosting, deprecated exchange modes (does not use main or aggressive mode; only 4 messages required to establish a connection).</li>
            </ul>
        </td>
    </tr>
    <tr>
    <td>Enable XAuth</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Enables Extended Authentication.</td>
     </tr>
     </tr>
</table>
</table>
Line 942: Line 1,123:
         <ul>
         <ul>
             <li>Red for <span style="color: red;">Type: Tunnel</span></li>
             <li>Red for <span style="color: red;">Type: Tunnel</span></li>
             <li>Blue for <span style="color: #0054a6;">Dead Peer Detection: Enabled</span></li>
             <li>Purple for <span style="color: purple;">Type: Transport</span></li>
         </ul>
         </ul>
     </li>
     </li>
</ul>
</ul>


===IPsec instance: proposal settings===
====Advanced settings====
----
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings_v5.png|border|class=tlt-border]]


The <b>proposal settings</b> section is used to configure IKE (Internet Key Exchange) phase 1 & 2 settings.
<table class="nd-mantable">
IKE is a protocol used to set up security associations (SAs) for the IPsec connection.
    <tr>
This process is required before any IPsec tunnel can be established.
        <th>Field</th>
It is done in two phases:
      <th>Value</th>
 
      <th>Description</th>
<table style="border-collapse: collapse;" border="1;">
    </tr>
     <tr>
     <tr>
        <th width="400"><span style="color: #0054A6;">Phase</span></th>
      <td>Aggressive</td>
        <th colspan="2"><span style="color: #0054A6;">Mode</span></th>
      <td>off {{!}} on; default: <b>off</b></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 style="vertical-align: top;">
     <tr>
        <td><b>Phase 1</b>
    <td>Force encapsulation</td>
            <ul>
        <td>off {{!}} on; default: <b>off</b></td>
                <li>Establishes a secure channel between peers</li>
         <td>Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.</td>
                <li>Authenticates peers</li>
    </tr>
                <li>Negotiates SA policy</li>
    <tr>
                <li>Shares secret keys</li>
      <td>Local firewall</td>
                <li>Establishes secure tunnel for phase 2</li>
      <td>off {{!}} on; default: <b>on</b></td>
            </ul>
      <td>Adds necessary firewall rules to allow traffic of this IPsec instance on this device.</td>
         </td>
        <td width="350">Main mode (figure 1)
            <ul>
                <li>6 packets exchanged</li>
                <li>Identity protected during exchange</li>
            </ul>
        </td>
        <td width="350">Aggressive mode (figure 2)
            <ul>
                <li>3 packets exchanged</li>
                <li>Identity information exchanged before a secure channel is established</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr style="vertical-align: top;">
     <tr>
        <td><b>Phase 2</b>
    <td>Remote firewall</td>
            <ul>
        <td>off {{!}} on; default: <b>on</b></td>
                <li>Sets up matching IPsec SAs</li>
         <td>Adds necessary firewall rules to allow traffic of from the opposite IPsec instance on this device.</td>
                <li>Periodically renegotiates IPsec SAs</li>
            </ul>
        </td>
         <td colspan="2">Quick mode
            <ul>
                <li>3 packets exchanged</li>
                <li>IPsec SA parameters (ESP/AH, SHA/MD5) established</li>
                <li>SA lifetime set</li>
            </ul>
        </td>
     </tr>
     </tr>
</table>
<br>
<table>
    <tr>
        <td><b>Figure 1</b><br><br></td>
        <td><b>Figure 2</b><br><br></td>
    </tr>
    <tr>
        <td width="500" valign="top">[[File:Networking_device_vpn_ipsec_main_mode_scheme_v3.png]]</td>
        <td width="500" valign="top">[[File:Networking_device_vpn_ipsec_aggressive_mode_scheme_v4.png]]</td>
    </tr>
</table>
====Phase 1====
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase1_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td>Compatibility mode</td>
      <th>Value</th>
        <td>off {{!}} on; default: <b>off</b></td>
      <th>Description</th>
        <td>Turns on compatibility mode to help deal with a 3rd party remote peer with multiple subnets.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Encryption algorithm</td>
     <td>Inactivity</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>integer; default: <b>none</b></td>
         <td>Algorithm used for data encryption.</td>
         <td>Defines timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Authentication</td>
     <td>Dead Peer Detection</td>
         <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>Algorithm used for exchanging authentication and hash information.</td>
         <td>A function used during Internet Key Exchange (IKE) to detect a "dead" peer. It used to reduce traffic by minimizing the number of messages when the opposite peer in unavailable and as failover mechanism.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>DH group</td>
     <td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD action</td>
         <td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521 {{!}} No PFS; default: <b>MODP1536</b></td>
         <td>Restart {{!}} Hold {{!}} Clear {{!}} None; default: <b>Restart</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>Controls the use of the Dead Peer Detection protocol where notification messages are periodically sent in order to check the liveliness of the IPsec peer.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Force crypto proposal</td>
    <td><span style="color: #0054a6;">Dead Peer Detection:</span> DPD Delay</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>integer; default: <b>none</b></td>
      <td>Only chosen proposals will be used when turned on.</td>
        <td>The frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>IKE Lifetime</td>
     <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>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>
         <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>
</table>
====Phase 2====
----
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase2_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td><span style="color: red;">Tunnel:</span> Remote source IP</td>
      <th>Value</th>
        <td>ip; default: <b>none</b></td>
      <th>Description</th>
        <td>The internal source IP to use in a tunnel for the remote (right) peer.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Encryption algorithm</td>
     <td><span style="color: red;">Tunnel:</span> Local source IP</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>ip; default: <b>none</b></td>
         <td>Algorithm used for data encryption.</td>
         <td>The internal (left) source IP to use in a tunnel, also known as virtual IP.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Hash algorithm</td>
     <td><span style="color: red;">Tunnel:</span> Remote DNS</td>
         <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>MD5</b></td>
         <td>ip; default: <b>none</b></td>
         <td>Algorithm used for exchanging authentication and hash information.</td>
         <td>List of DNS server addresses to exchange as configuration attributes. On the responder, only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned to the client.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>PFS group</td>
     <td>Locally allowed protocols</td>
         <td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521 {{!}} No PFS; default: <b>MODP768</b></td>
         <td>string; default: <b>none</b></td>
         <td>The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec. </td>
         <td>Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Force crypto proposal</td>
    <td>Remotely allowed protocols</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>string; default: <b>none</b></td>
      <td>Only chosen proposals will be used when turned on.</td>
        <td>Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Lifetime</td>
     <td>Custom option</td>
         <td>string; default: <b>none</b></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>
         <td>Syntax option = value. Following characters are accepted: a-zA-Z0-9=/_.:{}%\s-</td>
     </tr>
     </tr>
</table>
==PPTP==
<b>Point-to-Point Tunneling Protocol</b> (<b>PPTP</b>) is a type of VPN protocol that uses a TCP control channel and a Generic Routing Encapsulation tunnel to encapsulate PPP packets.
===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:
[[File:Networking_rutos_vpn_pptp_client_add_button.png|border|class=tlt-border]]
You should be redirected to the configuration page for the newly added PPTP Client which should look similar to this:
[[File:Networking_rutos_vpn_pptp_client_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td>Local source IP</td>
      <th>Value</th>
        <td>ip; default: <b>none</b></td>
      <th>Description</th>
        <td>The internal (left) source IP to use in a tunnel, also known as virtual IP.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Enable</td>
    <td><span style="color: red;">Tunnel:</span> Passthrough interfaces</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>network interfaces; default: <b>none</b></td>
      <td>Turns the PPTP instance on or off.</td>
        <td>Network interfaces to include in IPsec Passthrough.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Server</td>
    <td><span style="color: red;">Tunnel:</span> Passthrough subnets</td>
      <td>ip {{!}} host; default: <b>none</b></td>
        <td>ip/netmask; default: <b>none</b></td>
      <td>IP address or hostname of a PPTP server.</td>
        <td>IPv4 or IPv6 subnet.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Username</td>
    <td>Flush conntrack</td>
      <td>string; default: <b>none</b></td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>Username used for authentication to the PPTP server.</td>
        <td>Flush conntrack after IPsec makes a successful connection.</td>
     </tr>
     </tr>
    <tr>
</table>
      <td>Password</td>
 
      <td>string; default: <b>none</b></td>
<b>Additional notes</b>:
      <td>Password used for authentication to the PPTP server.</td>
<ul>
    </tr>
    <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:
    <tr>
        <ul>
      <td>Client to client</td>
            <li>Red for <span style="color: red;">Type: Tunnel</span></li>
      <td>off {{!}} on; default: <b>off</b></td>
            <li>Blue for <span style="color: #0054a6;">Dead Peer Detection: Enabled</span></li>
      <td>Adds route to make other PPTP clients reachable.</td>
        </ul>
    </tr>
     </li>
    <tr>
</ul>
      <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 PPTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.</td>
     </tr>
</table>


===PPTP server===
===IPsec instance: proposal settings===
----
----
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]]
The <b>proposal settings</b> section is used to configure IKE (Internet Key Exchange) phase 1 & 2 settings.
IKE is a protocol used to set up security associations (SAs) for the IPsec connection.
This process is required before any IPsec tunnel can be established.
It is done in two phases:


You should be redirected to the configuration page for the newly added PPTP Server which should look similar to this:
<table style="border-collapse: collapse;" border="1;">
 
[[File:Networking_rutos_vpn_pptp_server.png|border|class=tlt-border]]
 
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th width="400"><span style="color: #0054A6;">Phase</span></th>
      <th>Value</th>
        <th colspan="2"><span style="color: #0054A6;">Mode</span></th>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr style="vertical-align: top;">
      <td>Enable</td>
        <td><b>Phase 1</b>
      <td>off {{!}} on; default: <b>off</b></td>
            <ul>
      <td>Turns the PPTP instance on or off.</td>
                <li>Establishes a secure channel between peers</li>
    </tr>
                <li>Authenticates peers</li>
    <tr>
                <li>Negotiates SA policy</li>
      <td>Local IP</td>
                <li>Shares secret keys</li>
      <td>ip; default: <b>192.168.0.1</b></td>
                <li>Establishes secure tunnel for phase 2</li>
      <td>IP address of this PPTP network interface.</td>
            </ul>
    </tr>
        </td>
    <tr>
        <td width="350">Main mode (figure 1)
      <td>Remote IP range start</td>
            <ul>
      <td>ip; default: <b>192.168.0.20</b></td>
                <li>6 packets exchanged</li>
      <td>PPTP IP address leases will begin from the address specified in this field.</td>
                <li>Identity protected during exchange</li>
            </ul>
        </td>
        <td width="350">Aggressive mode (figure 2)
            <ul>
                <li>3 packets exchanged</li>
                <li>Identity information exchanged before a secure channel is established</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr style="vertical-align: top;">
      <td>Remote IP range end</td>
        <td><b>Phase 2</b>
      <td>ip; default: <b>192.168.0.30</b></td>
            <ul>
      <td>PPTP IP address leases will end with the address specified in this field.</td>
                <li>Sets up matching IPsec SAs</li>
    </tr>
                <li>Periodically renegotiates IPsec SAs</li>
    <tr>
            </ul>
      <td>Timeout</td>
        </td>
      <td>integer; default: <b>none</b></td>
        <td colspan="2">Quick mode
      <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>
            <ul>
    </tr>
                <li>3 packets exchanged</li>
    <tr>
                <li>IPsec SA parameters (ESP/AH, SHA/MD5) established</li>
      <td>Primary DNS</td>
                <li>SA lifetime set</li>
      <td>ip; default: <b>none</b></td>
            </ul>
      <td>IP address of the primary DNS server.</td>
        </td>
    </tr>
    <tr>
      <td>Secondary DNS</td>
      <td>ip; default: <b>none</b></td>
      <td>IP address of the secondary DNS server.</td>
     </tr>
     </tr>
</table>
</table>
<br>
<table>
    <tr>
        <td><b>Figure 1</b><br><br></td>
        <td><b>Figure 2</b><br><br></td>
    </tr>
    <tr>
        <td width="500" valign="top">[[File:Networking_device_vpn_ipsec_main_mode_scheme_v3.png]]</td>
        <td width="500" valign="top">[[File:Networking_device_vpn_ipsec_aggressive_mode_scheme_v4.png]]</td>
    </tr>
</table>
====Phase 1====
----
----
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_ipsec_ipsec_configuration_proposal_settings_phase1_v3.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">
Line 1,205: Line 1,331:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Username</td>
    <td>Encryption algorithm</td>
      <td>string; default: <b>none</b></td>
        <td>3DES {{!}} DES {{!}} AES 128 {{!}} AES 192 {{!}} AES 256 {{!}} AES128 GCM8 {{!}} AES192 GCM8 {{!}} AES256 GCM8 {{!}} AES128 GCM12 {{!}} AES192 GCM12 {{!}} AES256 GCM12 {{!}} AES128 GCM16 {{!}} AES192 GCM16 {{!}} AES256 GCM16 {{!}} ChaCha20 Poly1305; default: <b>AES 128</b></td>
      <td>Username used for authentication to this PPTP server.</td>
        <td>Algorithm used for data encryption.</td>
    </tr>
    <tr>
    <td>Authentication</td>
        <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
        <td>Algorithm used for exchanging authentication and hash information.</td>
    </tr>
    <tr>
    <td>DH group</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>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Password</td>
       <td>Force crypto proposal</td>
       <td>string; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Password used for authentication to this PPTP server.</td>
       <td>Only chosen proposals will be used when turned on.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>PPTP Client's IP</td>
    <td>IKE Lifetime</td>
      <td>ip; default: <b>none</b></td>
        <td>string; 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>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>
</table>


<b>Note:</b> there can only be one PPTP Server configuration on the device.
====Phase 2====
----


==SSTP==
[[File:Networking_rutx_vpn_ipsec_ipsec_configuration_proposal_settings_phase2_v3.png|border|class=tlt-border]]
 
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
{{#ifeq: TRB1 | RUTX | |
</br><u><b>Note:</b> SSTP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
===SSTP configuration===
----
 
To create a new SSTP instance, go to the Services → VPN → SSTP section, enter a custom name and click the 'Add' button.
An SSTP instance with the given name will appear in the "SSTP Configuration" list.
 
To begin configuration, click the 'Edit' button located next to the instance.
Refer to the figure and table below for information on the SSTP instance's configuration fields:
 
[[File:Networking_rutos_manual_vpn_sstp_sstp_instance.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 1,247: Line 1,369:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Enable</td>
    <td>Encryption algorithm</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>3DES {{!}} DES {{!}} AES 128 {{!}} AES 192 {{!}} AES 256 {{!}} AES128 GCM8 {{!}} AES192 GCM8 {{!}} AES256 GCM8 {{!}} AES128 GCM12 {{!}} AES192 GCM12 {{!}} AES256 GCM12 {{!}} AES128 GCM16 {{!}} AES192 GCM16 {{!}} AES256 GCM16 {{!}} ChaCha20 Poly1305; default: <b>AES 128</b></td>
      <td>Turns the SSTP instance on or off.</td>
        <td>Algorithm used for data encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Server IP address</td>
    <td>Hash algorithm</td>
      <td>ip {{!}} host; default: <b>none</b></td>
        <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
      <td>IP address or hostname of a SSTP server.</td>
        <td>Algorithm used for exchanging authentication and hash information.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>User name</td>
    <td>PFS group</td>
      <td>string; default: <b>none</b></td>
        <td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521 {{!}} No PFS; default: <b>MODP768</b></td>
      <td>Username used for authentication to the SSTP server.</td>
        <td>The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec. </td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Password</td>
       <td>Force crypto proposal</td>
       <td>string; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Password used for authentication to the SSTP server.</td>
       <td>Only chosen proposals will be used when turned on.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Certificate files from device</td>
    <td>Lifetime</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>string; default: <b>none</b></td>
      <td>Turn on this option if you want to select generated certificate files from device.</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>
      <td>CA cert</td>
      <td>.crt file; default: <b>none</b></td>
      <td>Upload a Certificate authority (CA) file.</td>
    </tr>
    <tr>
      <td>Default route</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>When turned on, this connection will become the device default route. This means that all traffic directed to the Internet will go through the SSTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet. <br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.</td>
     </tr>
     </tr>
</table>
</table>


==Stunnel==
==PPTP==


Stunnel is an open-source a proxy service that adds TLS encryption to clients and servers already existing on a VPN network.
<b>Point-to-Point Tunneling Protocol</b> (<b>PPTP</b>) is a type of VPN protocol that uses a TCP control channel and a Generic Routing Encapsulation tunnel to encapsulate PPP packets.
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===
===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:


The Stunnel Globals section is used to manage the Stunnel service as a whole.  
[[File:Networking_rutos_vpn_pptp_client_add_button.png|border|class=tlt-border]]
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
 
{{#ifeq: {{{series}}} | RUTX | | 
You should be redirected to the configuration page for the newly added PPTP Client which should look similar to this:
</br><u><b>Note:</b> Stunnel is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
 
}}
[[File:Networking_rutos_vpn_pptp_client_v4.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_stunnel_globals.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>Value</th>
        <th>Description</th>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Enabled</td>
      <td>Enable</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>off {{!}} on; default: <b>off</b></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>
      <td>Turns the PPTP instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Debug Level</td>
      <td>Server</td>
        <td>integer [0..7]; default: <b>5</b></td>
      <td>ip {{!}} host; default: <b>none</b></td>
        <td>Debugging to log output level.
      <td>IP address or hostname of a PPTP server.</td>
            <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>Use alternative config</td>
      <td>Username</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>string; default: <b>none</b></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>
      <td>Username used for authentication to the PPTP server.</td>
    </tr>
    <tr>
      <td>Password</td>
      <td>string; default: <b>none</b></td>
      <td>Password used for authentication to the PPTP server.</td>
    </tr>
    <tr>
      <td>Client to client</td>
      <td><span style="color:blue">off</span> {{!}} on; default: <b>off</b></td>
      <td>Adds route to make other PPTP clients reachable.</td>
    </tr>
    <tr>
      <td><span style="color:blue">Default route</span></td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>When selected, this connection will become the device's 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>
    </tr>
    <tr>
      <td>MPPE Encryption</td>
      <td>None {{!}} <span style="color:red">Stateless</span> {{!}} <span style="color:red">Stateful</span>; default: <b>Stateless</b></td>
      <td>MPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Upload alternative config</td>
      <td><span style="color:red">MPPE Key length</span></td>
        <td>file; default: <b>none</b></td>
      <td>Selectible: 40 {{!}} 56 {{!}} 128; default: <b>128</b></td>
        <td>Uploads an Stunnel configuration file.</td>
      <td>Encryption strength for MPPE.</td>
     </tr>
     </tr>
        <tr>
      <td>Custom options</td>
      <td>Selectible: refuse-pap {{!}} refuse-eap {{!}} refuse-chap {{!}} refuse-mschap {{!}} noipdefault {{!}} noauth {{!}} nobsdcomp {{!}} nodeflate {{!}} idle 0 {{!}} maxfail 0 {{!}} +Add new; default: <b>all</b></td>
      <td>Custom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.</td>
    </tr>   
</table>
</table>


===Stunnel instance===
===PPTP server===
----
----
To create a new Stunnel instance, go to the <i>Services → VPN → Stunnel</i> section, enter a custom name and click the 'Add' button.
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:
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.  
[[File:Networking_rutos_vpn_pptp_server_add_button.png|border|class=tlt-border]]
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]]
You should be redirected to the configuration page for the newly added PPTP Server which should look similar to this:
 
[[File:Networking_rutos_vpn_pptp_server_v1.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>Value</th>
        <th>Description</th>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Enable</td>
      <td>Enable</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Turns the Stunnel instance on or off.</td>
      <td>Turns the PPTP instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Operating Mode</td>
      <td>Local IP</td>
        <td>Server {{!}} Client; default: <b>Server</b></td>
      <td>ip; default: <b>192.168.0.1</b></td>
        <td>Selects the Stunnel instance's role.
      <td>IP address of this PPTP network interface.</td>
            <ul>
                <li><b>Server</b> - listens for connecting Stunnel clients.</li>
                <li><b>Client</b> - listens for connecting clients and connects to an Stunnel server.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Listen IP</td>
      <td>Remote IP range start</td>
        <td>ip; default: <b>none</b></td>
      <td>ip; default: <b>192.168.0.20</b></td>
        <td>Makes the instance "listen" for incoming connections on the specified IP address. When left empty, the value of this field defaults to <i>localhost</i> (<i>127.0.0.1</i>).</td>
      <td>PPTP IP address leases will begin from the address specified in this field.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Listen Port</td>
      <td>Remote IP range end</td>
        <td>integer [0..65535]; default: <b>none</b></td>
      <td>ip; default: <b>192.168.0.30</b></td>
        <td>Makes the instance "listen" for incoming connections on the specified TCP port. Make sure you chose a port that is not being used by another service. You will also have to allow traffic on the specified port.</td>
      <td>PPTP IP address leases will end with the address specified in this field.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Connect IP's</td>
      <td>Timeout</td>
        <td>ip:port; default: <b>none</b></td>
      <td>integer; 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>.
      <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>
 
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>Primary DNS</td>
        <td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
      <td>ip; default: <b>none</b></td>
        <td>Packet encryption algorithm cipher.</td>
      <td>IP address of the primary DNS server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
      <td>Secondary DNS</td>
        <td>string; default: <b>none</b></td>
      <td>ip; default: <b>none</b></td>
        <td>A list of TLS ciphers accepted for this connection.</td>
      <td>IP address of the secondary DNS server.</td>
     </tr>
     </tr>
        <tr>
      <td>Client to client</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Add route to make other PPTP clients accessible.</td>
    </tr>
     <tr>
     <tr>
        <td>Application Protocol</td>
      <td>MPPE Encryption</td>
        <td>Connect {{!}} SMTP {{!}} Not specified; default: <b>Not specified</b></td>
      <td>None {{!}} <span style="color:red">Stateless</span> {{!}} <span style="color:red">Stateful</span>; default: <b>Stateless</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>MPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td><span style="color:darkred">Connect:</span> Protocol Authentication</td>
      <td><span style="color:red">MPPE Key length</span></td>
         <td>Basic {{!}} NTLM; default: <b>Basic</b></td>
      <td>Selectible: 40 {{!}} 56 {{!}} 128; default: <b>128</b></td>
        <td>Authentication type for the protocol negotiations.</td>
      <td>Encryption strength for MPPE.</td>
    </tr>
         <tr>
      <td>Custom options</td>
      <td>Selectible: proxyarp {{!}} encounter {{!}} auth {{!}} lcp-echo-failure 3 {{!}} lcp-echo-interval 60 {{!}} default-asyncmap {{!}} mtu 1482 {{!}} mru 1482 {{!}} nobsdcomp {{!}} nodeflate {{!}} require-mschap-v2 {{!}} refuse-chap {{!}} refuse-mschap {{!}} refuse-eap {{!}} refuse-pap {{!}} logfd 2 {{!}} +Add new; default: <b>all</b></td>
      <td>Custom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.</td>
     </tr>
     </tr>
</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_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_pptp_server_user_list_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
         <td><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
         <th>Field</th>
        <td>Plain {{!}} Login; default: <b>Plain</b></td>
      <th>Value</th>
        <td>Authentication type for the protocol negotiations.</td>
      <th>Description</th>
    </tr>
    <tr>
      <td>Username</td>
      <td>string; default: <b>none</b></td>
      <td>Username used for authentication to this PPTP server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Certificate File</td>
      <td>Password</td>
        <td>.crt file; default: <b>none</b></td>
      <td>string; default: <b>none</b></td>
        <td>TLS client or server certificate file.</td>
      <td>Password used for authentication to this PPTP server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Private Key</td>
      <td>PPTP Client's IP</td>
        <td>.key file; default: <b>none</b></td>
      <td>ip; default: <b>none</b></td>
        <td>TLS client or server key file.</td>
      <td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
     </tr>
     </tr>
</table>
</table>


<b>Additional notes</b>:
<b>Note:</b> there can only be one PPTP Server configuration on the device.
<ul>
 
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
==SSTP==
        <ul>
            <li>Blue for <span style="color: #0054a6;">TLS Cipher: Custom</span></li>
            <li>Dark red for <span style="color: darkred;">Application Protocol: Connect</span></li>
            <li>Chocolate for <span style="color: chocolate;">Application Protocol: SMTP</span></li>
        </ul>
    </li>
</ul>


==DMVPN==
<b>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>}}


<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.
===SSTP configuration===
{{#ifeq: {{{series}}} | RUTX | |
</br><u><b>Note:</b> DMPVN is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
===DMVPN configuration===
----
----
To create a new DMVPN instance, go to the <i>Services → VPN → DMVPN</i> section, enter a custom name and click the 'Add' button. A DMVPN instance with the given name will appear in the "DMVPN Configuration" list.


To begin configuration, click the button that looks like a pencil located next to the instance. Refer to the figures and tables below for information on the DMVPN instance configuration:
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:


[[File:Networking_rutos_manual_vpn_dmvpn_dmvpn_parameters_configuration.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_sstp_sstp_instance_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 1,454: Line 1,590:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enabled</td>
       <td>Enable</td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the DMVPN instance on or off.</td>
       <td>Turns the SSTP instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Working mode</td>
       <td>Server IP address or host name</td>
       <td>Spoke {{!}} Hub; default: <b>Spoke</b></td>
       <td>ip {{!}} host; default: <b>none</b></td>
       <td>Selects the role of this instance
       <td>IP address and port (optional, default 443) of the remote SSTP server (e.g., 1.2.3.4, 1.2.3.4:1234, example.com:12).</td>
            <ul>
                <li><b>Hub</b> - the central instance of DMVPN that connects other peers (spokes) into single network. There is no need to reconfigure the hub when connecting new spokes to it.</li>
                <li><b>Spoke</b> - an instance that connects to the hub.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Hub address</td>
       <td>User name</td>
       <td>ip {{!}} host; default: '''none'''</td>
       <td>string; default: <b>none</b></td>
       <td>IP address or hostname of a DMVPN hub.</td>
       <td>Username used for authentication to the SSTP server.</td>
     </tr>
     </tr>
</table>
<br>
----
[[File:Networking_rutos_manual_vpn_dmvpn_gre_parameters_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
      <td>Password</td>
       <th>Value</th>
       <td>string; default: <b>none</b></td>
       <th>Description</th>
       <td>Password used for authentication to the SSTP server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Tunnel source</td>
       <td>Certificate files from device</td>
       <td>network interface; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Network interface used to establish the GRE Tunnel.</td>
       <td>Turn on this option if you want to select generated certificate files from device.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Local GRE interface IP address</td>
       <td>CA cert</td>
       <td>ip; default: <b>none</b></td>
       <td>.crt file; default: <b>none</b></td>
       <td>IP address of the local GRE Tunnel instance.</td>
       <td>Upload a Certificate authority (CA) file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: red;">Spoke:</span> Remote GRE interface IP address</td>
       <td>Default route</td>
       <td>ip; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>IP address of the remote GRE Tunnel instance.</td>
       <td>When selected, this connection will become the device's 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.</td>
    </tr>
    <tr>
      <td><span style="color: purple;">Hub:</span> Local GRE interface netmask</td>
      <td>netmask; default: <b>none</b></td>
      <td>Subnet mask of the local GRE Tunnel instance.</td>
    </tr>
    <tr>
      <td>GRE MTU</td>
      <td>integer; default: <b>none</b></td>
      <td>Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>GRE keys</td>
       <td>Auth options</td>
       <td>integer [0..65535]; default: <b>none</b></td>
       <td>Noauth {{!}} Refuse-pap {{!}} Refuse-eap {{!}} Refuse-chap {{!}} Refuse-mschap {{!}} +Add custom option; default: <b>Noauth</b></td>
       <td>A key used to identify incoming and outgoing GRE packets.</td>
       <td></td>
     </tr>
     </tr>
</table>
</table>
<br>
----
[[File:Networking_rutx_vpn_dmvpn_ipsec_parameters_configuration_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
==Stunnel==
     <tr>
 
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_v1.png|border|class=tlt-border]]
 
<table class="nd-mantable">
     <tr>
         <th>Field</th>
         <th>Field</th>
      <th>Value</th>
        <th>Value</th>
      <th>Description</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enabled</td>
        <td>off {{!}} on; default: <b>off</b></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>Local identifier</td>
        <td>Debug Level</td>
         <td>ip {{!}} string; default: <b>none</b></td>
         <td>integer [0..7]; default: <b>5</b></td>
         <td>Defines how the user (IPsec instance) will be identified during authentication.          
         <td>Debugging to log output level.
             <ul>
             <ul>
                 <li><b>IP</b> - Internet Protocol address.</li>
                 <li><b>0 (emergency)</b> - a panic condition, i.e., system is no longer usable.</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>1 (alert)</b> - a condition that must be corrected immediately.</li>
            </ul>
                <li><b>2 (critical)</b> - critical conditions, device errors.</li>
        </td>
                <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>
    <tr>
                <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>
    <td>Remote identifier</td>
                <li><b>5 (notice)</b> - conditions that are not error conditions, but that may require special handling.</li>
        <td>ip {{!}} string; default: <b>none</b></td>
                 <li><b>6 (info)</b> - general useful information (e.g., configuration changes, starts and stops of services, etc.)</li>
        <td>Defines how the right participant will be identified during authentication.
                 <li><b>7 (debug)</b> - contains basic information that is diagnostically helpful to most people (i.e., not just engineers).</li>
            <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>
             </ul>
        </td>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Pre-shared key</td>
        <td>Use alternative config</td>
         <td>string; default: <b>none</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>A shared password used for authentication between IPsec peers.</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>Encryption algorithm</td>
        <td>Upload alternative config</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>file; default: <b>none</b></td>
         <td>Algorithm used for data encryption.</td>
         <td>Uploads an Stunnel configuration file.</td>
     </tr>
     </tr>
</table>
===Stunnel instance===
----
To create a new Stunnel instance, go to the <i>Services → VPN → Stunnel</i> section, enter a custom name and click the 'Add' button.
An Stunnel instance with the given name will appear in the "Stunnel Configuration" list.
To begin configuration, click the 'Edit' button located next to the instance.
Refer to the figure and table below for information on the Stunnel instance's configuration fields:
[[File:Networking_rutos_manual_vpn_stunnel_configuration_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
    <td>Authentication/Hash algorithm</td>
        <th>Field</th>
         <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
         <th>Value</th>
         <td>Algorithm used for exchanging authentication and hash information.</td>
         <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>DH/PFS group</td>
        <td>Enable</td>
         <td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521; default: <b>MODP1536</b></td>
         <td>off {{!}} on; default: <b>off</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>Turns the Stunnel instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Force crypto proposal</td>
        <td>Operating Mode</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Server {{!}} <span style="color:olive">Client</span>; default: <b>Server</b></td>
      <td>Only chosen proposals will be used when turned on.</td>
        <td>Selects the Stunnel instance's role.
     </tr>
            <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>
    <td>IKE Lifetime</td>
        <td>Listen IP</td>
         <td>string; default: <b>none</b></td>
         <td>ip; 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>
         <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>
</table>
<br>
----
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <td>Listen Port</td>
      <th>Value</th>
        <td>integer [0..65535]; default: <b>none</b></td>
      <th>Description</th>
        <td>Makes the instance "listen" for incoming connections on the specified TCP port. Make sure you chose a port that is not being used by another service. You will also have to allow traffic on the specified port.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>NHRP network ID</td>
        <td>Connect IP's</td>
      <td>integer; default: <b>1</b></td>
        <td>ipv4/ipv6:port; default: <b>none</b></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>
        <td>IP:Port to listen for VPN connections (using 'host_ip:port' convention (e.g., 127.0.0.1:6001 or [::0000:8a2e:0370]:7334).If no host IP is specified only port number, then localhost will be used as a host.)
 
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>NHRP authentication key</td>
        <td>TLS Cipher</td>
      <td>string; default: <b>none</b></td>
        <td>None {{!}} Secure {{!}} Custom; default: <b>None</b></td>
         <td>A key used in NHRP authentication.</td>  
         <td>Packet encryption algorithm cipher.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>NHRP hold time</td>
        <td><span style="color:#0054a6">Custom:</span> Allowed TLS Ciphers</td>
      <td>integer; default: <b>7200</b></td>
        <td>string; default: <b>none</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>A list of TLS ciphers accepted for this connection.</td>
     </tr>
     </tr>
</table>
==L2TP==
In computer networking, <b>Layer 2 Tunneling Protocol</b> (<b>L2TP</b>) is a tunneling protocol used to support virtual private networks (VPNs). It is more secure than PPTP but, because it encapsulates the transferred data twice, but it is slower and uses more CPU power.
===L2TP client===
----
An <b>L2TP client</b> is an entity that initiates a connection to an L2TP server. To create a new client instance, go to the <i>Services → VPN → L2TP</i> section, select <i>Role: Client</i>, enter a custom name and click the 'Add' button. An L2TP client instance with the given name will appear in the "L2TP Configuration" list.
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the L2TP client's configuration fields:
[[File:Networking_rutos_manual_vpn_l2tp_client.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <td>Application Protocol</td>
      <th>Value</th>
        <td><span style="color:darkred">Connect</span> {{!}} <span style="color:chocolate">SMTP</span> {{!}} Not specified; default: <b>Not specified</b></td>
      <th>Description</th>
        <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>Enable</td>
        <td><span style="color:darkred">Connect:</span> Protocol Authentication</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Basic {{!}} NTLM; default: <b>Basic</b></td>
      <td>Turns the L2TP instance on or off.</td>
        <td>Authentication type for the protocol negotiations.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Server</td>
        <td><span style="color:chocolate">SMTP:</span> Protocol Authentication</td>
      <td>ip {{!}} host; default: <b>none</b></td>
        <td>Plain {{!}} Login; default: <b>Plain</b></td>
      <td>IP address or hostname of an L2TP server.</td>
        <td>Authentication type for the protocol negotiations.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Username</td>
        <td>Certificate File</td>
      <td>string; default: <b>none</b></td>
        <td>.crt file; default: <b>none</b></td>
      <td>Username used for authentication to the L2TP server.</td>
        <td>TLS client or server certificate file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Password</td>
        <td>Private Key</td>
      <td>string; default: <b>none</b></td>
        <td>.key file; default: <b>none</b></td>
      <td>Password used for authentication to the L2TP server.</td>
        <td>TLS client or server key file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Default route</td>
        <td><span style="color:olive">Remote server certificate</span></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>.crt file; default: <b>none</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>Certificate file of the remote peer (server) in pem format.</td>
     </tr>
     </tr>
</table>
</table>


===L2TP server===
<b>Additional notes</b>:
----
<ul>
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.
    <li>Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
        <ul>
            <li>Blue for <span style="color: #0054a6;">TLS Cipher: Custom</span></li>
            <li>Dark red for <span style="color: darkred;">Application Protocol: Connect</span></li>
            <li>Chocolate for <span style="color: chocolate;">Application Protocol: SMTP</span></li>
        </ul>
    </li>
</ul>
 
==DMVPN==
 
<b>Dynamic Multipoint VPN</b> (<b>DMVPN</b>) is a method of building scalable IPsec VPNs. DMVPN is configured as a hub-and-spoke network, where tunnels between spokes are built dynamically; therefore, no change in configuration is required on the hub in order to connect new spokes.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
<u><b>Note:</b> DMPVN is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>}}


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).
===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 next to the server instance. Refer to the figure and table below for information on the L2TP server's configuration fields:
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_rutx_vpn_l2tp_server_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_dmvpn_dmvpn_parameters_configuration_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 1,664: Line 1,808:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enabled</td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the L2TP instance on or off.</td>
       <td>Turns the DMVPN instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Local IP</td>
       <td>Working mode</td>
       <td>ip; default: <b>192.168.0.1</b></td>
       <td>Spoke {{!}} Hub; default: <b>Spoke</b></td>
       <td>IP address of this L2TP network interface.</td>
       <td>Selects the role of this instance
    </tr>
            <ul>
    <tr>
                <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>
      <td>Remote IP range begin</td>
                <li><b>Spoke</b> - an instance that connects to the hub.</li>
      <td>ip; default: <b>192.168.0.20</b></td>
            </ul>
      <td>L2TP IP address leases will begin from the address specified in this field.</td>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Remote IP range end</td>
       <td>Hub address</td>
       <td>ip; default: <b>192.168.0.30</b></td>
       <td>ip {{!}} host; default: '''none'''</td>
       <td>L2TP IP address leases will end with the address specified in this field.</td>
       <td>IP address or hostname of a DMVPN hub.</td>
     </tr>
     </tr>
</table>
<br>
----
[[File:Networking rutos manual vpn dmvpn gre parameters configuration v4.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
      <td>User name</td>
        <th>Field</th>
       <td>string; default: <b>user</b></td>
       <th>Value</th>
       <td>Username used for authentication to this L2TP server.</td>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Password</td>
       <td>Tunnel source</td>
       <td>string; default: <b>pass</b></td>
       <td>network interface; default: <b>Any</b></td>
       <td>Password used for authentication to this L2TP server.</td>
       <td>Network interface used to establish the GRE Tunnel.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>L2TP Client's IP</td>
       <td>Local GRE interface IP address</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 local GRE Tunnel instance.</td>
     </tr>
     </tr>
</table>
==L2TPv3==
L2TPv3 (Layer Two Tunneling Protocol Version 3) is a point-to-point layer two over IP tunnel. This means you can tunnel L2 protocols like Ethernet, Frame-relay, ATM, HDLC, PPP, etc. over an IP network.
===Local settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_local_settings_v1.png]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
      <td><span style="color: red;">Spoke:</span> Remote GRE interface IP address</td>
       <th>Value</th>
       <td>ip; default: <b>none</b></td>
       <th>Description</th>
       <td>IP address of the remote GRE Tunnel instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td><span style="color: purple;">Hub:</span> Local GRE interface netmask</td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>netmask; default: <b>none</b></td>
       <td>Turns the L2TPv3 instance on or off.</td>
       <td>Subnet mask of the local GRE Tunnel instance.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Local address</td>
       <td>GRE MTU</td>
       <td>ip; default: <b>none</b></td>
       <td>integer; default: <b>1476</b></td>
       <td>IP address of device's WAN. Note: If left empty, it will take IP address automatically from main WAN interface. <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>Tunnel ID</td>
       <td>Outbound key</td>
       <td>integer [1..4294967295]; default: <b>none</b></td>
       <td>integer [0..65535]; 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>
       <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>
     <tr>
     <tr>
       <td>Session ID</td>
       <td>Inbound key</td>
       <td>integer [1..4294967295]; default: <b>none</b></td>
       <td>integer [0..65535]; default: <b>none</b></td>
       <td>The value used must match the tunnel ID value being used at the peer.</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>
      <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>
     </tr>
</table>
</table>
<br>
----
[[File:Networking_rutx_vpn_dmvpn_ipsec_parameters_configuration_v3.png|border|class=tlt-border]]


===Peer settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_peer_settings_v1.png]]
<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
Line 1,750: Line 1,885:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Peer address</td>
    <td>Local identifier</td>
      <td>ip; default: <b>none</b></td>
        <td>ip {{!}} string; default: <b>none</b></td>
      <td>Peer Endpoint IP address.</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>
     <tr>
     <tr>
      <td>Peer Tunnel ID</td>
    <td>Remote identifier</td>
      <td>integer [1..4294967295]; default: <b>none</b></td>
        <td>ip {{!}} string; 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>
        <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>Peer Session ID</td>
    <td>Pre-shared key</td>
      <td>integer [1..4294967295]; default: <b>none</b></td>
        <td>string; 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>
        <td>A shared password used for authentication between IPsec peers.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Peer Cookie</td>
    <td>Encryption algorithm</td>
      <td>string; default: <b>none</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>AES 128</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>
        <td>Algorithm used for data encryption.</td>
     </tr>
     </tr>
</table>
===Instance Settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_instance_settings_v1.png]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td>Authentication/Hash algorithm</td>
      <th>Value</th>
        <td>MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
      <th>Description</th>
        <td>Algorithm used for exchanging authentication and hash information.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Bridge to</td>
    <td>DH/PFS group</td>
      <td>None {{!}} LAN; default: <b>None</b></td>
        <td>MODP768 {{!}} MODP1024 {{!}} MODP1536 {{!}} MODP2048 {{!}} MODP3072 {{!}} MODP4096 {{!}} ECP192 {{!}} ECP224 {{!}} ECP256 {{!}} ECP384 {{!}} ECP521; default: <b>MODP1536</b></td>
      <td>Peer Endpoint IP address.</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>IP Address</td>
       <td>Force crypto proposal</td>
       <td>ip; default: <b>none</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>IP address of standalone L2TPv3 interface.<td>
       <td>Only chosen proposals will be used when turned on.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Netmask</td>
    <td>IKE Lifetime</td>
      <td>netmask; default: <b>none</b></td>
        <td>string; default: <b>none</b></td>
      <td>Netmask of standalone L2TPv3 interface. </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>
----
<u><b>Note:</b> on some devices, the NHRP parameters are visible after installing the NHRP package from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
[[File:Networking_rutx_vpn_dmvpn_nhrp_parameters_configuration_v4.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
      <td>MTU</td>
        <th>Field</th>
       <td>integer [64..9000]; default: <b>none</b></td>
       <th>Value</th>
       <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>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Encapsulation</td>
       <td>NHRP network ID</td>
       <td>IP {{!}} UDP; default: <b>IP</b></td>
       <td>integer; default: <b>1</b></td>
       <td>Specify technology to use when connecting to other end.</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>
      <td>NHRP authentication key</td>
      <td>string; default: <b>none</b></td>
        <td>A key used in NHRP authentication.</td>
    </tr>
    <tr>
      <td>NHRP hold time</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>
    </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>
      <td>Multicast</td>
      <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
      <td>Allow use of dynamic routing protocols that use multicast.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Layer 2 specific header type</td>
       <td><span style="color:blue">NHRP multicast NFLOG group</span></td>
       <td>None {{!}} Linux Default; default: <b>Linux Default</b></td>
       <td>integer [1..65535}; default: <b>none</b></td>
       <td>It might be neccessary to set this option to none when using other hardware.</td>
       <td>Specify NFLOG group to be used by NHRP instance for multicast traffic.</td>
     </tr>
     </tr>
</table>
</table>


==ZeroTier==
==L2TP==


<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.
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.


<u><b>Note:</b> ZeroTier is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
===L2TP client===
----
----
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:
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.


[[File:Networking_rutos_manual_vpn_zerotier_add_button.png|border|class=tlt-border]]
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:
 
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_l2tp_client_v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 1,833: Line 2,003:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enabled</td>
       <td>Enable</td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the ZeroTier Instance on or off.</td>
       <td>Turns the L2TP instance on or off.</td>
    </tr>
    <tr>
      <td>Server</td>
      <td>ip {{!}} host; default: <b>none</b></td>
      <td>A domain name or IP address (IPv4 or IPv6) with an optional port (values from 1 to 65535) is required (e.g., 192.168.1.1, ::0000:8a2e:0370:7334, example.com, or 192.168.1.1:80).</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Networks</td>
       <td>Username</td>
       <td>hex string; default: <b>none</b></td>
       <td>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>
       <td>Username used for authentication to the L2TP server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Port</td>
       <td>Password</td>
       <td>integer [0..65535]; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>ZeroTier Network port.</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>
</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_v1.png|border|class=tlt-border]]
===General Instance Settings===
----
This section contains General settings of created WireGuard Instance. Here you can find its Public and
Private keys and generate them, specify Port and IP addresses for communication.
[[File:Networking_rutx_vpn_wireguard_instance_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
      <td>MTU</td>
       <th>Value</th>
       <td>[68..9200]; default: <b>none</b></td>
       <th>Description</th>
       <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>Enable</td>
      <td>Default route</td>
        <td>off | on; default: <b>off</b></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Turns WireGuard Instance on or 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>
     <tr>
     <tr>
    <td>Private Key</td>
      <td>Allow CHAP</td>
        <td>string; default: <b>none</b></td>
      <td>on {{!}} off; default: <b>on</b></td>
        <td>Private Key used in authentication.</td>
      <td>Allows CHAP authentication method to be used.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Public Key</td>
       <td>Allow PAP</td>
        <td>string; default: <b>-</b></td>
      <td>on {{!}} off; default: <b>off</b></td>
        <td>Public Key used in authentication.</td>
      <td>Allows PAP authentication method to be used.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Generate</td>
      <td>Allow MSCHAP-v2</td>
        <td>-(interactive button)</td>
      <td>on {{!}} off; default: <b>on</b></td>
        <td>Click to generate Public Key and Private Key.</td>
      <td>Allow MSCHAP-v2 authentication method to be used.</td>
     </tr>
     </tr>  
     <tr>
     <tr>
    <td>Listen Port</td>
      <td>Custom options</td>
        <td>integer [0..65535]; default: <b>none</b></td>
      <td>string; 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>
      <td>Custom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.</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>




====Advanced Settings====
<b>Active L2TP client instance example:</b>
----
 
[[File:Networking rutos manual vpn l2tp active client_v1.png|border|class=tlt-border]]
 
===L2TP server===
----
----
An <b>L2TP server</b> is an entity that waits for incoming connections from L2TP clients. To create a new server instance, go to the <i>Services → VPN → L2TP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add' button. An L2TP server instance with the given name will appear in the "L2TP Configuration" list. Only one L2TP server instance is allowed to be added.
A server needs to have a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]] in order to be available from the public network (the Internet).


Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
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_wireguard_instance_advanced_v1.png|border|class=tlt-border]]
 
[[File:Networking_rutx_vpn_l2tp_server_configuration_v6.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 1,920: Line 2,082:
     </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 the L2TP instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>MTU</td>
      <td>Use IPv6</td>
        <td>integer [1280..1420]; default: <b>none</b></td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Maximum Transmission Unit for this tunnel interface.</td>
      <td>L2TPv6 support package is required to enable this option. Enables an IPv6 socket to accept L2TP connections over IPv6. <b>Note:</b> L2TPv6 support is additional software on some devices that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</td>
     </tr>
     </tr>
</table>
===Peers===
----
The Peers section is used to create and configure all the peers for this interface.
To create one enter its name and click the <b>Add</b> button.
To configure it click the <b>Edit</b> [[File:Networking_rutx_manual_edit_button_v1.png]] button.
[[File:Networking_rutx_vpn_wireguard_instance_peer_v2.png|border|class=tlt-border]]
====General Peer Settings====
----
In the General section of Peer instance you can configure basic information about the endpoint to allow communications. 
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
      <td>Local IP</td>
       <th>Value</th>
       <td>ip; default: <b>192.168.0.1</b></td>
       <th>Description</th>
       <td>IP address of this L2TP network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Public Key</td>
      <td>Remote IP range begin</td>
        <td>string; default: <b>none</b></td>
      <td>ip; default: <b>192.168.0.20</b></td>
        <td>Endpoint's Public Key.</td>
      <td>L2TP IP address leases will begin from the address specified in this field.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Allowed IPs</td>
      <td>Remote IP range end</td>
        <td>ip; default: <b>none</b></td>
      <td>ip; default: <b>192.168.0.30</b></td>
        <td>A single IP address or a list of them which are allowed to communicate with this peer.</td>
      <td>L2TP IP address leases will end with the address specified in this field.</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>
        <th>Field</th>
      <td>Port</td>
       <th>Value</th>
       <td>integer [1..65535]; default: <b>none</b></td>
       <th>Description</th>
       <td>Port for binding.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Description</td>
      <td>Enable CHAP</td>
        <td>string; default: <b>none</b></td>
      <td><span style="color:blue">on</span> {{!}} off; default: <b>off</b></td>
        <td>Description of this peer.</td>
      <td>Challenge-Handshake Authentication Protocol for L2TP.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Pre-Shared Key</td>
      <td><span style="color:blue">CHAP Secret</span></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>A secret used for L2TP Tunnel Authentication.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Route Allowed IPs</td>
       <td>CHAP authentication</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>on {{!}} off; default: <b>on</b></td>
        <td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
      <td>When turned on it requires CHAP authentication method to be used, when turned off it refuses CHAP authentication method.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Endpoint Host</td>
      <td>PAP authentication</td>
        <td>ip {{!}} url; default: <b>none</b></td>
      <td>on {{!}} off; default: <b>off</b></td>
        <td>IP or URL of Remote Endpoint.</td>
      <td>When turned on it requires PAP authentication method to be used, when turned off it refuses PAP authentication method.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Endpoint Port</td>
      <td>MSCHAP-v2 authentication</td>
        <td>integer [0..65535]; default: <b>none</b></td>
      <td>on {{!}} off; default: <b>on</b></td>
        <td>Specify port to connect to Remote Endpoint. It will be set to <b>51820</b> if left empty.</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>Custom options</td>
      <td>string without "`" or "'"; default: </td>
      <td>Custom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.</td>
     </tr>
     </tr>
     <tr>
</table>
    <td>Persistent Keep Alive</td>
 
        <td>integer [0..65535]; default: <b>none</b></td>
[[File:Networking_rutx_vpn_l2tp_server_user_list_v1.png|border|class=tlt-border]]
        <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>
   
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </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>
     </tr>
</table>
</table>
<b>Active L2TP server instance example:</b>
----
[[File:Networking rutx vpn l2tp active server_v1.png|border|class=tlt-border]]
==L2TPv3==
L2TPv3 (Layer Two Tunneling Protocol Version 3) is a point-to-point layer two over IP tunnel. This means you can tunnel L2 protocols like Ethernet, Frame-relay, ATM, HDLC, PPP, etc. over an IP network.
To create a new L2TPv3 instance, go to the <i>Services → VPN → L2TPv3</i> section, enter a custom name and click the 'Add' button. You will be redirected to instance configuration page and L2TPv3 instance with the given name will appear in the "L2TPv3 Configuration" list.
===Instance configuration===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_local_settings_v2.png]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Turns the L2TPv3 instance on or off.</td>
    </tr>
    <tr>
      <td>Local address</td>
      <td>ip; default: <b>none</b></td>
      <td>IP address of device's WAN. Note: If left empty, it will take IP address automatically from main WAN interface.</td>
    </tr>
    <tr>
      <td>Tunnel ID</td>
      <td>integer [1..4294967295]; default: <b>none</b></td>
      <td>Uniquely identifies the tunnel. The value used must match the peer tunnel ID value being used at the peer.</td>
    </tr>
    <tr>
      <td>Session ID</td>
      <td>integer [1..4294967295]; default: <b>none</b></td>
      <td>The value used must match the tunnel ID value being used at the peer.</td>
    </tr>
    <tr>
      <td>Cookie</td>
      <td>string; default: <b>none</b></td>
      <td>Must be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF.</td>
    </tr>
</table>
===Peer settings===
----
[[File:Networking_rutos_vpn_l2tpv3_configuration_peer_settings_v2.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_v2.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_v3.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_v3.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_v4.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>
    <tr>
      <td>Custom planet file</td>
      <td>-(interactive button)</td>
      <td>Custom planet file contains user-defined roots, enabling the use of private root servers.</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_v4.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>10.5.0.1/24</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_v4.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>
    <tr>
    <td>Watchdog interval</td>
        <td>integer [0..60]; default: <b>none</b></td>
        <td>Optional. Interval in minutes to re-resolve hostnames for inactive WireGuard peers if domain is used. If not specified and domain is used, hostnames will be checked every minute.</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_v4.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>10.5.0.2/32</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_v3.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 {{!}} <span style="color: red;">LAN {{!}} WAN {{!}} Mobile</span>; default: <b>Any</b></td>
        <td>Interface to bind this instance to.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Tunnel source mode</span></td>
        <td>Prefer {{!}} Persist; default: <b>Prefer</b></td>
        <td>Choose whether to persist or prefer the connection on the selected interface.</td>
    </tr>
    <tr>
    <td>Pre-Shared Key</td>
        <td>string; default: <b>none</b></td>
        <td>Base64-encoded pre-shared 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>
====QR Settings====
----
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_qr_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Server IP</td>
        <td>IP address; default: <b>None</b></td>
        <td>Specifies which interface's IP address should be bound to the hostname.</td>
    </tr>
    <tr>
    <td>Tunnel address</td>
        <td>IP; default: <b>10.5.0.2/32</b></td>
        <td>Choose whether to persist or prefer the connection on the selected interface.</td>
    </tr>
    <tr>
    <td>Peer allowed IPs</td>
        <td>All IPv4 {{!}} All IPv6 {{!}} LAN; default: <b>All IPv4 (0.0.0.0/0)</b></td>
        <td>Required. 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>QR code</td>
        <td>Interactive button</td>
        <td>Generates single-use QR code.</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.
<u><b>Note:</b> Tinc VPN is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
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_v1.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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Enable</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Turns Tinc Interface on or off.</td>
    </tr>
    <tr>
    <td>Local tunnel endpoint IP</td>
        <td>ipv4 with or without mask; default: <b>none</b></td>
        <td>IP address of virtual local network interface.</td>
    </tr>
    <tr>
    <td>Local tunnel endpoint IPv6</td>
        <td>ipv6 with or without mask; default: <b>none</b></td>
        <td>IPv6 address of virtual local network interface.</td>
    </tr>
    <tr>
    <td>Subnet</td>
        <td>ip with subnet; default: <b>none</b></td>
        <td>Subnets that peers are allowed to access. You can add multiple subnet entries 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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [1..65535]; default: <b>655</b></td>
        <td>Configure the port on which this tinc daemon will listen for incoming connections.</td>
    </tr>
    <tr>
    <td>Address Family</td>
        <td>Any {{!}} IPv4 {{!}} IPv6; 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_v1.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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Enable</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>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 addresses with an optional port number; default: <b>none</b></td>
        <td>Remote host's IP address or domain name, optionally followed by a port number (e.g., example.com:8080). If no port is specified, the default port (655) will be used.</td>
    </tr>
    <tr>
      <td>Subnet</td>
        <td>IPv4, IPv6 or MAC addresses; default: <b>none</b></td>
        <td>Specify the host-side subnets you need to access. You can add multiple subnet entries 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>
{{#ifeq: {{{tailscale}}} | 1 |
==Tailscale==
Tailscale is a zero-config, mesh VPN service that securely connects devices and services, regardless of their location or network. It uses the open-source WireGuard protocol to establish encrypted, peer-to-peer connections, creating a private network, or "tailnet," between your devices.
<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>Tailscale status</td>
        <td>-(interactive status)</td>
        <td>Shows health status and messages about Tailscale.</td>
    </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>
      <td><span style="color: green;">Exit node IP</span></td>
        <td>ip; default: <b>none</b></td>
        <td>IP address of the exit node.</td>
    </tr>
    <tr>
      <td>Accept routes</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Accept subnet routes that other nodes advertise.</td>
    </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>
    </tr>
</table>|}}
{{#ifeq: {{{netbird}}} | 1 |
==NetBird==
NetBird is an open-source, zero-trust networking platform that simplifies the creation of secure private networks for both home and organizational use. It leverages WireGuard® to establish direct, point-to-point connections between devices, forming a secure, overlay network without the need for traditional VPN setups.
<u><b>Note:</b> NetBird is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
[[File:Networking rutx vpn netbird 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>Enable NetBird service.</td>
    </tr>
    <tr>
    <td>NetBird status</td>
        <td>-(interactive status)</td>
        <td>Shows health status and messages about NetBird.</td>
    </tr>
    <tr>
    <td>Authentication method</td>
        <td><span style="color: blue;">Use login URL</span> {{!}} <span style="color: red;">Use authentication key</span>; default: <b><span style="color: blue;">Use login URL</span></b></td>
        <td>Selects method to authenticate your tailscale network.</td>
    </tr>
    <tr>
    <td><span style="color: blue;">NetBird login</span></td>
        <td>-(interactive link)</td>
        <td>Sign in using your NetBird account credentials. Clicking this button will open the NetBird authentication page in a new window.</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>Admin URL</td>
        <td>a full URL; default: <b>none</b></td>
        <td>Default admin panel URL is https://app.netbird.io:443.</td>
    </tr>
    <tr>
    <td>Management URL</td>
        <td>a full URL; default: <b>none</b></td>
        <td>Default management service URL is https://api.netbird.io:443.</td>
    </tr>
    <tr>
    <td>Allow SSH</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Allow SSH server on peer.</td>
    </tr>
</table>|}}
==EoIP==
<b>EoIP</b> is a MikroTik RouterOS protocol based on GRE RFC 1701 that creates an Ethernet tunnel between two routers on top of an IP connection. At current moment it is easiest way to create stateless tunnel with Mikrotik.
<br><u><b>Note:</b> EoIP is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
===Topology===
[[File:Networking_rutx_vpn_eoip_topology.png|border|class=tlt-border]]
===EoIP configuration===
To create a new EoIP instance, go to the Services → VPN → EoIP page and click the 'Add' button. The "EoIP Configuration" window will appear.
[[File:Networking_rutx_vpn_eoip_add_button.png|border|class=tlt-border]]
The following is the instance configuration window:
[[File:Networking_rutx_vpn_eoip_instance_configuration_window_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Enable</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Enable current configuration.</td>
    </tr>
    <tr>
    <td>Name</td>
        <td>string; default: <b>instance1</b></td>
        <td>Name of the EoIP instance.</td>
    </tr>
    <tr>
    <td>Tunnel ID</td>
        <td>integer [1..65536]; default: <b>empty</b></td>
        <td>Unique tunnel identifier, which must match other side of the tunnel.</td>
    </tr>
    <tr>
    <td>Use IPv6</td>
        <td><span style="color:blue">on</span> {{!}} off; default: <b>off</b></td>
        <td>The parameter specifies the local IP address used as the source for sending traffic through a tunnel.</td>
    </tr>
    <tr>
    <td>Local IP</td>
        <td>IPv4/<span style="color:blue">IPv6</span> addresses; default: <b>empty</b></td>
        <td>The parameter specifies the local IP address used as the source for sending traffic through a tunnel.</td>
    </tr>
    <tr>
    <td>Dynamic</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Allow the connection. If you enable it, be aware that there is no authorization and it is not secure. Avoid using this feature on a public IP or a network where you do not have full control over all hosts.</td>
    </tr>
    <tr>
    <td>Remote IP</td>
        <td>IPv4/<span style="color:blue">IPv6</span> addresses; default: <b>empty</b></td>
        <td>The parameter specifies the IP address of the remote endpoint that the tunnel will connect to.</td>
    </tr>
    <tr>
    <td>Bridge</td>
        <td>interface; default: <b>none</b></td>
        <td>Assign an EoIP interface to a bridge.</td>
    </tr>
</table>
{{#ifeq: {{{openconnect}}} | 1 |
==OpenConnect==
<b>OpenConnect</b> is a cross-platform multi-protocol SSL VPN client which supports a number of VPN protocols: Cisco AnyConnect, Array Networks SSL VPN, Juniper SSL VPN, Pulse Connect Secure, Palo Alto Networks GlobalProtect SSL VPN, F5 Big-IP SSL VPN, Fortinet Fortigate SSL VPN.
<br><u><b>Note:</b> OpenConnect is additional software on some devices that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
===OpenConnect configuration===
In order to create a new OpenConnect Instance, look to the "Add new instance" section, enter a custom name and click the 'Add' button:
[[File:Networking_rutos_manual_vpn_openconnection_add_button.png|border|class=tlt-border]]
You should be redirected to the configuration page for the newly added OpenConnect instance which should look similar to this:
[[File:Networking_rutos_manual_vpn_openconnection_instance_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Enable</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Turns the OpenConnect Tunnel instance on or off.</td>
    </tr>
    <tr>
    <td>VPN protocol</td>
        <td>Any Connect {{!}} Network Connect {{!}} Global Protect {{!}} Pulse Secure {{!}} SSL VPN; default: <b>Any Connect</b></td>
        <td>VPN protocol to be used for the connection.</td>
    </tr>
    <tr>
    <td>Server</td>
        <td>domain name {{!}} ipv4; default: <b>none</b></td>
        <td>Server address.</td>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [1..65535}; default: <b>none</b></td>
        <td>Server port.</td>
    </tr>
    <tr>
    <td>Username</td>
        <td>string; default: <b>none</b></td>
        <td>Username used for VPN connection.</td>
    </tr>
    <tr>
    <td>Password</td>
        <td>string; default: <b>none</b></td>
        <td>Password used for VPN connection.</td>
    </tr>
    <tr>
    <td>Certificate files from device</td>
        <td>on {{!}} off; default: <b>off</b></td>
        <td>Choose this option if you want to select certificate files from the device. Certificate files can be generated [[{{{device}}}__Administration#Certificates|here]].</td>
    </tr>
    <tr>
    <td>User certificate</td>
        <td>certificate file; default: <b>none</b></td>
        <td>User certificate used to authenticate to the server.</td>
    </tr>
    <tr>
    <td>CA certificate</td>
        <td>certificate authority file; default: <b>none</b></td>
        <td>CA certificate used to verify the server certificate.</td>
    </tr>
    <tr>
    <td>User private key</td>
        <td>key file; default: <b>none</b></td>
        <td>User private key used to authenticate to the server.</td>
    </tr>
    <tr>
    <td>Server fingerprint</td>
        <td>sha1: {{!}} sha256: {{!}} pin-sha256:; default: <b>none</b></td>
        <td>Server fingerprint to trust.</td>
    </tr>
    <tr>
    <td>Get server fingerprint</td>
        <td>-(interactive button)</td>
        <td>A custom button that fetches the server's fingerprint and adds it to the configuration</td>
    </tr>
</table>|}}}}


[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]

Latest revision as of 08:46, 27 October 2025

The information in this page is updated in accordance with firmware version .

Summary

Virtual Private Network (VPN) is a method of connecting multiple private networks across the Internet. VPNs can serve to achieve many different goals, but some of its main purposes are:

  • access between remote private networks;
  • data encryption;
  • anonymity when browsing the Internet.

This page is an overview of the different types of VPNs supported by {{{name}}} devices.

OpenVPN

OpenVPN 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.

Note: OpenVPN DCO kernel module moved to package manager on some devices. Please visit System → [[{{{name}}} Package Manager|Package Manager]] page.

OpenVPN Client

An OpenVPN client is an entity that initiates a connection to an OpenVPN server.

Client status Value Description
Export -(interactive button) Exports the instance configuration to .ovpn file.
Edit -(interactive button) Opens the instance configuration window.
Delete -(interactive button) Removes an instance.

To begin configuration, click 'Add' button, select Role: Client. Refer to the figure and table below for information on the OpenVPN client's configuration fields:

General section Value Description
Enable configuration off | on; default: off Enable current configuration.
Role Client | Server; default: Client Choose a role for OpenVPN isntance.
Name string; default: instance1 Name of the OpenVPN instance.
Configuration type Manual | Upload config file | External services; default: Manual Choose configuration type.
VPN providers Express VPN | Nord VPN; default: Nord VPN Represents a list of available VPN providers.
VPN servers United Kingdom | USA | Australia | South Africa | Custom; default: United Kingdom Represents a list of available VPN servers.
Username string; default: none Username used for authentication to the VPN server.
Password string; default: none Password used for authentication to the VPN server.
Enable parsing off | on; default: off By enabling parsing, you can modify the configuration in the future.
OpenVPN configuration file -(interactive button) Upload OpenVPN configuration. Warning! This will overwrite your current configuration.
Authentication TLS | TLS/Password | Password | Static key; default: TLS Choose a method to authenticate your OpenVPN network.
TUN/TAP TUN (tunnel) | TAP (bridged); default: TUN (tunnel) Virtual VPN interface type.
Topology NET30 | P2P | SUBNET (not shown with Static key); default: NET30 Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.
Protocol UDP | TCP | UDP4 | TCP4 | UDP6 | TCP6; default: UDP The transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.
Port integer [0..65535]; default: 1194 TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.
Extra options string; default: none Enter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.

Network section Value Description
Static key: Local tunnel endpoint IP ip; default: none IP address of the virtual local network interface.
Static key: Remote tunnel endpoint IP ip; default: none IP address of the virtual remote network interface.
Remote host/IP address ip; default: none IP address or domain name of the OpenVPN server.
Remote network ip4; default: none IP address of the remote LAN.
TAP (bridged): Bridge lan | none; default: lan Assign a TAP interface to a bridge..
Static key: Local tunnel endpoint IPv6 ip; default: none IPv6 address of the virtual local network interface.
Static key: Remote tunnel endpoint IPv6 ip; default: none IPv6 address of the virtual remote network interface.
LZO None | Adaptive | Yes | No; default: None Use fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.
Resolve retry integer | infinite; default: infinite Try to resolve the server hostname for X seconds before giving up.
Keep alive two integers separated by a space; default: none Try to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.

Security section Value Description
TLS/Password/Password: User name string; default: none VPN client username.
TLS/Password/Password: Password string; default: none VPN client password.
Encryption 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: AES-256-CBC 256 Packet encryption algorithm (cipher).
Data ciphers depends on authentication; default: AES-256-CBC Select allowed data ciphers from the list; add a custom value if needed.
Authentication algorithm none | MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 HMAC authentication algorithm type.
TLS/TLS/Password/Password:Additional HMAC authentication None | Authentication only (tls-auth) | Authentication only (tls-auth); default: None Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.
TLS/TLS/Password/Password: HMAC key direction 0 | 1; default: 1 The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).

Certificates section Value Description
TLS/TLS/Password/Password:Use PKCS #12 format off | on; default: off Use PKCS #12 archive file format to bundle all the members of a chain of trust.
TLS/TLS/Password/Password: PKCS #12 certificate chain -(interactive button) Uploads a PKCS #12 certificate chain file.
TLS/TLS/Password/Password: PKCS #12 passphrase string; default: none Passphrase to decrypt PKCS #12 certificates.
TLS/TLS/Password/Password: Certificate files from device off | on; default: off Choose this option if you want to select certificate files from the device.
TLS/TLS/Password/Password: Certificate authority .ca file; default: none The digital certificate verifies the ownership of a public key by the named subject of the certificate.
TLS/TLS/Password: Client certificate .crt file; default: none Identify a client or a user, authenticating the client to the server and establishing precisely who they are.
TLS/TLS/Password: Client key .key file; default: none It has been generated for the same purpose as a client certificate.
TLS/TLS/Password: Private key decryption password (optional) string; default: none Decrypt private key with password (Optional).
Static key: Static pre-shared key .key file; default: none A pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.

Additional notes:

  • 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:
    • Red for Authentication: TLS
    • Olive for Authentication: TLS/Password
    • Purple for Authentication: Static key
    • Blue for Authentication: Password
    • Brown for OpenVPN config from file
  • After changing any of the parameters, don't forget to click the Save & Apply button located at the bottom-right side of the page.

OpenVPN Server

An OpenVPN server is an entity that waits for incoming connections from OpenVPN clients. Only one OpenVPN server instance is allowed to be added.

A server needs to have a public IP address in order to be available from the public network (the Internet).

Server status Value Description
Export -(interactive button) Exports the instance configuration to .ovpn file.
Edit -(interactive button) Opens the instance configuration window.
Delete -(interactive button) Removes an instance.

To begin configuration, click 'Add' button, select Role: Server. Refer to the figure and table below for information on the OpenVPN server's configuration fields:

General section Value Description
Enable configuration off | on; default: off Enable current configuration.
Role Client | Server; default: Server Choose a role for OpenVPN isntance.
Name string; default: instance1 Name of the OpenVPN instance.
Configuration type Manual | Upload config file; default: Manual Choose configuration type.
Enable parsing off | on; default: off By enabling parsing, you can modify the configuration in the future.
OpenVPN configuration file -(interactive button) Upload OpenVPN configuration. Warning! This will overwrite your current configuration.
Authentication TLS | TLS/Password | Password | Static key; default: TLS Choose a method to authenticate your OpenVPN network.
TUN/TAP TUN (tunnel) | TAP (bridged); default: TUN (tunnel) Virtual VPN interface type.
Topology NET30 | P2P | SUBNET (not shown with Static key); default: NET30 Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.
Protocol UDP | TCP | UDP4 | TCP4 | UDP6 | TCP6; default: UDP The transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.
Port integer [0..65535]; default: 1194 TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.
Push option (not shown with Static key) string; default: none Push a configuration option back to the client for remote execution.
Extra options string; default: none Enter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.

Network section Value Description
TLS/TLS/Password/Password: Virtual network IP address ip4; default: none IP address used for the virtual network.
TLS/TLS/Password/Password: Virtual network netmask netmask; default: none Subnet mask used for the virtual network.
Static key: Local tunnel endpoint IP ip; default: none IP address of the virtual local network interface.
Static key: Remote tunnel endpoint IP ip; default: none IP address of the virtual remote network interface.
TLS/TLS/Password/Password: Assign IP start IP; default: none Assign IP addresses starting from a pool of subnets to be dynamically allocated to connecting clients.
TLS/TLS/Password/Password: Assign IP end IP; default: none Assign IP addresses ending at a pool of subnets to be dynamically allocated to connecting clients.
TLS/TLS/Password/Password: Virtual network IPv6 address ip6; default: none IPv6 address used for the virtual network.
TLS/TLS/Password/Password: Assign IPv6 address ip6; default: none Specify an IPv6 address pool for dynamic assignment to clients.
Static key: Local tunnel endpoint IPv6 ip; default: none IPv6 address of the virtual local network interface.
Static key: Remote tunnel endpoint IPv6 ip; default: none IPv6 address of the virtual remote network interface.
TAP (bridged): Bridge lan | none; default: lan Assign a TAP interface to a bridge..
LZO None | Adaptive | Yes | No; default: None Use fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.
Client to client off | on; default: off Allow client-to-client traffic.
Resolve retry integer | infinite; default: infinite Try to resolve the server hostname for X seconds before giving up.
Keep alive two integers separated by a space; default: none Try to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.

Security section Value Description
TLS/Password/Password: Usernames & Passwords -(interactive button) File containing usernames and passwords against which the server can authenticate clients. Each username and password pair should be placed on a single line and separated by a space.
Encryption 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: AES-256-CBC 256 Packet encryption algorithm (cipher).
Data ciphers depends on authentication; default: AES-256-CBC Select allowed data ciphers from the list; add a custom value if needed.
TLS/TLS/Password/Password: Allow duplicate certificates off | on; default: off All clients can have the same certificates.
Authentication algorithm none | MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 HMAC authentication algorithm type.
TLS/TLS/Password/Password:Additional HMAC authentication None | Authentication only (tls-auth) | Authentication only (tls-auth); default: None Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.
TLS/TLS/Password/Password: HMAC key direction 0 | 1; default: 1 The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).

Certificates section Value Description
TLS/TLS/Password/Password:Use PKCS #12 format off | on; default: off Use PKCS #12 archive file format to bundle all the members of a chain of trust.
TLS/TLS/Password/Password: PKCS #12 certificate chain -(interactive button) Uploads a PKCS #12 certificate chain file.
TLS/TLS/Password/Password: Certificate authority .ca file; default: none The digital certificate verifies the ownership of a public key by the named subject of the certificate.
TLS/TLS/Password/Password: Server certificate .crt file; default: none Certificate servers validate or certify keys as part of a public key infrastructure.
TLS/TLS/Password/Password: Server key .key file; default: none It has been generated for the same purpose as the server certificate.
TLS/TLS/Password/Password: Diffie Hellman parameters .pem file; default: none Diffie-Hellman key exchange is a specific method of exchanging cryptographic keys.
TLS/TLS/Password/Password: CRL file (optional) .pem file | .crl file; Default: none Revoking a certificate means to invalidate a previously signed certificate so that it can no longer be used for authentication purposes. Upload a .pem revocation file.
TLS/TLS/Password/Password: PKCS #12 passphrase string; default: none Passphrase to decrypt PKCS #12 certificates.
TLS/TLS/Password/Password: Private key decryption password (optional) string; default: none Decrypt private key with password (Optional).
Static key: Static pre-shared key -(interactive button) A pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.

Additional notes:

  • 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:
    • Red for Authentication: TLS
    • Olive for Authentication: TLS/Passwords
    • Purple for Authentication: Static key
    • Blue for Authentication: Password
    • Brown for OpenVPN config from file
  • After changing any of the parameters, don't forget to click the Save & Apply button located at the bottom-right side of the page.

TLS Clients

TLS Clients is a way to differentiate clients by their Common Names (CN), which are found in the client certificate file. It can be used to assign specific VPN addresses to corresponding clients and bind them to their LAN addresses, making the server aware of which client has which LAN IP address.

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:

Field Value Description
Common name (CN) string; default: none Client certificate CN field (e.g.,s [email protected]).
Virtual local endpoint ip; default: none Client’s local address in the virtual network.
Virtual remote endpoint ip; default: none Client’s remote address in the virtual network.
Local tunnel endpoint IPv6 ip; default: none IPv6 address of virtual local network interface.
Private network IPv6 ip; default: none Client’s private network (LAN) IPv6 address.
Private network ip; default: none Client’s private network (LAN) IP address.
Covered Network network(); default: none Selects which networks should be made accessible to this client.

OpenVPN Server Brute-force Prevention

OpenVPN Servers with Authentication set to TLS/Password or Password, Protocol set to UDP and running on Port 1194 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 CLI.

After connecting to your device's CLI use the command ipset list and find the section named ipb_port. There under Members you should see all IP addresses that are blocked. 

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

Another way to check blocked IP addresses is to use the command ubus call ip_block show. This will show all ip addresses that failed to connect to your device. If the counter atribute of the IP address entry is larger or equal then max_attempt_count then that IP address is blocked. 

{
	"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"
	}
}

To unblock a blocked client's IP address use the command ubus call ip_block unblock '{"ip":"<blocked_ip_address>","port":"udp:1194"} (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: 

{
	"unblocked": {
		"ip": "188.XXX.XXX.XXX",
		"port": "udp:1194"
	}
}

GRE

Generic Routing Encapsulation (GRE) 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 Services → VPN → GRE 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.

Field Value Description
Enabled off | on; default: off Turns the GRE instance on or off.
IPv6 off | on; default: off Use IPv4 or IPv6 for the GRE tunnel.
Tunnel source network interface; default: - Network interface used to establish the GRE Tunnel.
Remote endpoint IP address ipv4/ipv6; default: none External IP address of another GRE instance used to establish the initial connection between peers.
MTU integer; default: 1476 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.
Outbound key integer [0..4294967295]; default: none Key for 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.
Inbound key integer [0..4294967295]; default: none Key for 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.
Path MTU Discovery off | on; default: off When unchecked, sets the nopmtudisc option for tunnel. Can not be used together with the TTL option.
TTL integer [0..255]; default: 255 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.
Keep alive off | on; default: off The 'keep alive' feature sends packets to the remote instance in order to determine the health of the connection. If no response is received for [Keep alive retries] times, the device will mark the tunnel as DOWN.
Keep alive interval integer [1..255]; default: 20 Frequency (in seconds) at which 'keep alive' packets are sent to the remote instance.
Keep alive retries integer [1..255]; default: 3 Amount of keep alive packets to lose before marking tunnel as DOWN.
Local GRE interface IP address ipv4; default: none IP address of the local GRE Tunnel network interface.
Local GRE interface netmask netmask; default: none Subnet mask of the local GRE Tunnel network interface.
Local GRE interface IPv6 address ipv6; default: none IPv6 address of the local GRE Tunnel instance.

GRE: Routing Settings

Routing settings 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.

IPv4 routing settings Value Description
Remote subnet IPv4 address ipv4; default: none LAN IPv4 address of the device that hosts the remote GRE Tunnel instance.
Remote subnet netmask netmask; default: none Subnet mask of the network behind the device that hosts the remote GRE instance.
Actions -(interactive button) Removes configuration.
IPv6 routing settings Value Description
Remote subnet IPv6 address ipv6; default: none LAN IPv6 address of the device that hosts the remote GRE Tunnel instance.
Actions -(interactive button) Removes configuration.

IPsec

To create a new IPsec instance, go to the Services → VPN → IPsec section, enter a custom name and click the 'Add' button. An IPsec instance with the given name will appear in the "IPsec Configuration" list.

IPsec Instance

The general settings 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.

Field Value Description
Enable off | on; default: off Turns the IPsec instance on or off.
Remote endpoint host | ip; default: none Domain names, ip addresses (with or without network mask), %any, %any4, %any6 values are accepted (e.g., 192.168.1.1 or example.com).
Authentication method Pre-shared key | X.509 | EAP | PKCS#12; default: Pre-shared key Specify authentication method. Choose between Pre-shared key and X.509 certificates.
PKCS#12: PKCS12 container -(interactive button) Upload PKCS12 container file.
PKCS#12: PKCS12 decryption passphrase string; default: none Passphrase to decrypt PKCS12 container.
Pre-shared key: Pre shared key string; default: none A shared password used for authentication between IPsec peers before a secure channel is established.
X.509: | EAP: Certificate files from device off | on; default: off Choose this option if you want to select certificate files from device. Certificate files can be generated [[{{{name}}}_Administration#Certificates|here]]
X.509: | EAP: Key A private key file; default: none A private key file.
X.509: | EAP: Key decryption passphrase A password for private key files; default: none If the private key file is encrypted, the passphrase must be defined.
X.509: | EAP: Local Certificate .der file; default: none A local certificate file.
X.509: | EAP: CA Certificate .der file; default: none A certificate authority file.
Local identifier ip | string; default: none Defines how the user (left participant) will be identified during authentication. Maximum length of value is 255.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Remote identifier ip | string; default: none Defines how the right participant will be identified during authentication. Maximum length of value is 255.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Multiple secrets off | on; default: off Enable to show Global Secret Settings section for configuring multiple secrets.

Additional notes:

  • 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:
    • Chocolate for Authentication method: Pre-shared key
    • Dark red for Authentication method: X.509/EAP
    • Blue for Authentication method: PKCS#12

Global Secrets Settings

This section is displayed when Multiple secrets is enabled in General settings. You can add new instances by pressing Add.

Field Value Description
ID Selector %any, IP or FQDN; default: none 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. Maximum length of value is 255. NOTE: IKEv1 only supports IP address ID selector.
Type PSK | XAUTH | EAP | RSA | PKCS#12; default: PSK Make sure to turn on the "Enable XAUTH" option in connection settings, if you want to use XAUTH type secrets.
Secret string; default: none A shared password (or EAP key file) to authenticate between the peers. Minimum length is 5 symbols. All characters are allowed except `.
RSA | PKCS#12: Secret Private key file; default: none A private key file.
RSA | PKCS#12: Key decryption passphrase A password for private key files; default: none If the private key file is encrypted, the passphrase must be defined.
Actions -(interactive button) Deletes global secret.

IPsec Instance: Connection Settings

The connection settings 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

Field Value Description
Mode Start | Add | Route; default: Start Specifies which operation will be done automatically at IPSec startup.
Type Tunnel | Transport; default: Tunnel Type of connection.
  • Tunnel - protects internal routing information by encapsulating the entire IP packet (IP header and payload); commonly used in site-to-site VPN connections; supports NAT traversal.
  • Transport - only encapsulates IP payload data; used in client-to-site VPN connections; does not support NAT traversal; usually implemented with other tunneling protocols (for example, L2TP).
Tunnel: Default route off | on; default: off Turn on to route all traffic through IPSec tunnel.
Tunnel: Route based IPsec off | on; default: off IPsec VPN tunnel created between two end points.
Tunnel: IP address IP adress; default: none Assign an IP address to XFRM interface.
Tunnel: MTU integer [68..9200]; default: none 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.
Tunnel: Local subnet ip/netmask | default: none Private subnet behind the left (local) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.
Tunnel: Remote subnet ip/netmask; default: none Private subnet behind the right (remote) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.
Transport: Bind to GRE interface; L2TP interface; default: none Bind to GRE or L2TP interface to create GRE/L2TP over IPsec.
Key exchange IKEv1 | IKEv2; default: IKEv1 Internet Key Exchange (IKE) version used for key exchange.
  • IKEv1 - more commonly used but contains known issues, for example, dealing with NAT.
  • IKEv2 - updated version with increased and improved capabilities, such as integrated NAT support, supported multihosting, deprecated exchange modes (does not use main or aggressive mode; only 4 messages required to establish a connection).
Enable XAuth on | off; default: off Enables Extended Authentication.

Additional notes:

  • 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:
    • Red for Type: Tunnel
    • Purple for Type: Transport

Advanced settings

Field Value Description
Aggressive off | on; default: off 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.
Aggressive mode is available only with IKEv1; if IKEv2 is selected this field becomes hidden.
Force encapsulation off | on; default: off Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.
Local firewall off | on; default: on Adds necessary firewall rules to allow traffic of this IPsec instance on this device.
Remote firewall off | on; default: on Adds necessary firewall rules to allow traffic of from the opposite IPsec instance on this device.
Compatibility mode off | on; default: off Turns on compatibility mode to help deal with a 3rd party remote peer with multiple subnets.
Inactivity integer; default: none Defines timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.
Dead Peer Detection off | on; default: on A function used during Internet Key Exchange (IKE) to detect a "dead" peer. It used to reduce traffic by minimizing the number of messages when the opposite peer in unavailable and as failover mechanism.
Dead Peer Detection: DPD action Restart | Hold | Clear | None; default: Restart Controls the use of the Dead Peer Detection protocol where notification messages are periodically sent in order to check the liveliness of the IPsec peer.
Dead Peer Detection: DPD Delay integer; default: none The frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.
Dead Peer Detection: DPD Timeout integer; default: none Defines the timeout interval, after which all connections to a peer are deleted in case of inactivity.
XAuth identity string; default: none The identity/username the client uses to reply to an XAuth request. If not defined, the IKEv1 identity will be used as XAuth identity.
Tunnel: Remote source IP ip; default: none The internal source IP to use in a tunnel for the remote (right) peer.
Tunnel: Local source IP ip; default: none The internal (left) source IP to use in a tunnel, also known as virtual IP.
Tunnel: Remote DNS ip; default: none List of DNS server addresses to exchange as configuration attributes. On the responder, only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned to the client.
Locally allowed protocols string; default: none Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.
Remotely allowed protocols string; default: none Allowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.
Custom option string; default: none Syntax option = value. Following characters are accepted: a-zA-Z0-9=/_.:{}%\s-
Local source IP ip; default: none The internal (left) source IP to use in a tunnel, also known as virtual IP.
Tunnel: Passthrough interfaces network interfaces; default: none Network interfaces to include in IPsec Passthrough.
Tunnel: Passthrough subnets ip/netmask; default: none IPv4 or IPv6 subnet.
Flush conntrack off | on; default: off Flush conntrack after IPsec makes a successful connection.

Additional notes:

  • 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:
    • Red for Type: Tunnel
    • Blue for Dead Peer Detection: Enabled

IPsec instance: proposal settings

The proposal settings section is used to configure IKE (Internet Key Exchange) phase 1 & 2 settings. IKE is a protocol used to set up security associations (SAs) for the IPsec connection. This process is required before any IPsec tunnel can be established. It is done in two phases:

Phase Mode
Phase 1
  • Establishes a secure channel between peers
  • Authenticates peers
  • Negotiates SA policy
  • Shares secret keys
  • Establishes secure tunnel for phase 2
 Main mode (figure 1)
  • 6 packets exchanged
  • Identity protected during exchange
 Aggressive mode (figure 2)
  • 3 packets exchanged
  • Identity information exchanged before a secure channel is established
Phase 2
  • Sets up matching IPsec SAs
  • Periodically renegotiates IPsec SAs
 Quick mode
  • 3 packets exchanged
  • IPsec SA parameters (ESP/AH, SHA/MD5) established
  • SA lifetime set


Figure 1

 Figure 2

Phase 1

Field Value Description
Encryption algorithm 3DES | DES | AES 128 | AES 192 | AES 256 | AES128 GCM8 | AES192 GCM8 | AES256 GCM8 | AES128 GCM12 | AES192 GCM12 | AES256 GCM12 | AES128 GCM16 | AES192 GCM16 | AES256 GCM16 | ChaCha20 Poly1305; default: AES 128 Algorithm used for data encryption.
Authentication MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 Algorithm used for exchanging authentication and hash information.
DH group MODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521 | No PFS; default: MODP1536 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.
Force crypto proposal off | on; default: off Only chosen proposals will be used when turned on.
IKE Lifetime string; default: none 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.

Phase 2

Field Value Description
Encryption algorithm 3DES | DES | AES 128 | AES 192 | AES 256 | AES128 GCM8 | AES192 GCM8 | AES256 GCM8 | AES128 GCM12 | AES192 GCM12 | AES256 GCM12 | AES128 GCM16 | AES192 GCM16 | AES256 GCM16 | ChaCha20 Poly1305; default: AES 128 Algorithm used for data encryption.
Hash algorithm MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 Algorithm used for exchanging authentication and hash information.
PFS group MODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521 | No PFS; default: MODP768 The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec.
Force crypto proposal off | on; default: off Only chosen proposals will be used when turned on.
Lifetime string; default: none 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.

PPTP

Point-to-Point Tunneling Protocol (PPTP) is a type of VPN protocol that uses a TCP control channel and a Generic Routing Encapsulation tunnel to encapsulate PPP packets.

PPTP client

A PPTP client is an entity that initiates a connection to a PPTP server. To create a new client instance, go to the Services → VPN → PPTP section, select Role: Client, enter a custom name and click the 'Add' button:

You should be redirected to the configuration page for the newly added PPTP Client which should look similar to this:

Field Value Description
Enable off | on; default: off Turns the PPTP instance on or off.
Server ip | host; default: none IP address or hostname of a PPTP server.
Username string; default: none Username used for authentication to the PPTP server.
Password string; default: none Password used for authentication to the PPTP server.
Client to client off | on; default: off Adds route to make other PPTP clients reachable.
Default route off | on; default: off When selected, this connection will become the device's 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.
MPPE Encryption None | Stateless | Stateful; default: Stateless MPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.
MPPE Key length Selectible: 40 | 56 | 128; default: 128 Encryption strength for MPPE.
Custom options Selectible: refuse-pap | refuse-eap | refuse-chap | refuse-mschap | noipdefault | noauth | nobsdcomp | nodeflate | idle 0 | maxfail 0 | +Add new; default: all Custom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.

PPTP server

A PPTP server is an entity that waits for incoming connections from PPTP clients. To create a new server instance, go to the Services → VPN → PPTP section, select Role: Server, enter a custom name and click the 'Add' button:

You should be redirected to the configuration page for the newly added PPTP Server which should look similar to this:

Field Value Description
Enable off | on; default: off Turns the PPTP instance on or off.
Local IP ip; default: 192.168.0.1 IP address of this PPTP network interface.
Remote IP range start ip; default: 192.168.0.20 PPTP IP address leases will begin from the address specified in this field.
Remote IP range end ip; default: 192.168.0.30 PPTP IP address leases will end with the address specified in this field.
Timeout integer; default: none 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.
Primary DNS ip; default: none IP address of the primary DNS server.
Secondary DNS ip; default: none IP address of the secondary DNS server.
Client to client off | on; default: off Add route to make other PPTP clients accessible.
MPPE Encryption None | Stateless | Stateful; default: Stateless MPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.
MPPE Key length Selectible: 40 | 56 | 128; default: 128 Encryption strength for MPPE.
Custom options Selectible: proxyarp | encounter | auth | lcp-echo-failure 3 | lcp-echo-interval 60 | default-asyncmap | mtu 1482 | mru 1482 | nobsdcomp | nodeflate | require-mschap-v2 | refuse-chap | refuse-mschap | refuse-eap | refuse-pap | logfd 2 | +Add new; default: all Custom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.

The User List 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:

Field Value Description
Username string; default: none Username used for authentication to this PPTP server.
Password string; default: none Password used for authentication to this PPTP server.
PPTP Client's IP ip; default: none 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.

Note: there can only be one PPTP Server configuration on the device.

SSTP

Secure Socket Tunneling Protocol (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
Note: SSTP is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

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:

Field Value Description
Enable off | on; default: off Turns the SSTP instance on or off.
Server IP address or host name ip | host; default: none IP address and port (optional, default 443) of the remote SSTP server (e.g., 1.2.3.4, 1.2.3.4:1234, example.com:12).
User name string; default: none Username used for authentication to the SSTP server.
Password string; default: none Password used for authentication to the SSTP server.
Certificate files from device off | on; default: off Turn on this option if you want to select generated certificate files from device.
CA cert .crt file; default: none Upload a Certificate authority (CA) file.
Default route off | on; default: off When selected, this connection will become the device's 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.
Auth options Noauth | Refuse-pap | Refuse-eap | Refuse-chap | Refuse-mschap | +Add custom option; default: Noauth

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.
Note: Stunnel is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Field Value Description
Enabled off | on; default: off 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.
Debug Level integer [0..7]; default: 5 Debugging to log output level.
  • 0 (emergency) - a panic condition, i.e., system is no longer usable.
  • 1 (alert) - a condition that must be corrected immediately.
  • 2 (critical) - critical conditions, device errors.
  • 3 (error) - 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.
  • 4 (warning) - 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.)
  • 5 (notice) - conditions that are not error conditions, but that may require special handling.
  • 6 (info) - general useful information (e.g., configuration changes, starts and stops of services, etc.)
  • 7 (debug) - contains basic information that is diagnostically helpful to most people (i.e., not just engineers).
Use alternative config off | on; default: off 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.
Upload alternative config file; default: none Uploads an Stunnel configuration file.

Stunnel instance

To create a new Stunnel instance, go to the Services → VPN → Stunnel 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:

Field Value Description
Enable off | on; default: off Turns the Stunnel instance on or off.
Operating Mode Server | Client; default: Server Selects the Stunnel instance's role.
  • Server - listens for connecting Stunnel clients.
  • Client - listens for connecting clients and connects to an Stunnel server.
Listen IP ip; default: none Makes the instance "listen" for incoming connections on the specified IP address. When left empty, the value of this field defaults to localhost (127.0.0.1).
Listen Port integer [0..65535]; default: none 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.
Connect IP's ipv4/ipv6:port; default: none IP:Port to listen for VPN connections (using 'host_ip:port' convention (e.g., 127.0.0.1:6001 or [::0000:8a2e:0370]:7334).If no host IP is specified only port number, then localhost will be used as a host.) Must contain at least one item. If multiple options are specified, remote address is chosen using a round-robin algorithm.
TLS Cipher None | Secure | Custom; default: None Packet encryption algorithm cipher.
Custom: Allowed TLS Ciphers string; default: none A list of TLS ciphers accepted for this connection.
Application Protocol Connect | SMTP | Not specified; default: Not specified 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.
Connect: Protocol Authentication Basic | NTLM; default: Basic Authentication type for the protocol negotiations.
SMTP: Protocol Authentication Plain | Login; default: Plain Authentication type for the protocol negotiations.
Certificate File .crt file; default: none TLS client or server certificate file.
Private Key .key file; default: none TLS client or server key file.
Remote server certificate .crt file; default: none Certificate file of the remote peer (server) in pem format.

Additional notes:

  • 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:
    • Blue for TLS Cipher: Custom
    • Dark red for Application Protocol: Connect
    • Chocolate for Application Protocol: SMTP

DMVPN

Dynamic Multipoint VPN (DMVPN) 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. Note: DMPVN is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

DMVPN configuration

To create a new DMVPN instance, go to the Services → VPN → DMVPN 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:

Field Value Description
Enabled off | on; default: off Turns the DMVPN instance on or off.
Working mode Spoke | Hub; default: Spoke Selects the role of this instance
  • Hub - 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.
  • Spoke - an instance that connects to the hub.
Hub address ip | host; default: none IP address or hostname of a DMVPN hub.


Field Value Description
Tunnel source network interface; default: Any Network interface used to establish the GRE Tunnel.
Local GRE interface IP address ip; default: none IP address of the local GRE Tunnel instance.
Spoke: Remote GRE interface IP address ip; default: none IP address of the remote GRE Tunnel instance.
Hub: Local GRE interface netmask netmask; default: none Subnet mask of the local GRE Tunnel instance.
GRE MTU integer; default: 1476 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.
Outbound key integer [0..65535]; default: none A key used to identify outgoing GRE packets. This value should match the Inbound key value set on the opposite GRE tunnel instance or both key values should be omitted on both sides.
Inbound key integer [0..65535]; default: none A key used to identify incoming GRE 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.


Field Value Description
Local identifier ip | string; default: none Defines how the user (IPsec instance) will be identified during authentication.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Remote identifier ip | string; default: none Defines how the right participant will be identified during authentication.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Pre-shared key string; default: none A shared password used for authentication between IPsec peers.
Encryption algorithm 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: AES 128 Algorithm used for data encryption.
Authentication/Hash algorithm MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 Algorithm used for exchanging authentication and hash information.
DH/PFS group MODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521; default: MODP1536 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.
Force crypto proposal off | on; default: off Only chosen proposals will be used when turned on.
IKE Lifetime string; default: none 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.


Note: on some devices, the NHRP parameters are visible after installing the NHRP package from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Field Value Description
NHRP network ID integer; default: 1 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.
NHRP authentication key string; default: none A key used in NHRP authentication.
NHRP hold time integer; default: 7200 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.
Redirect off | on; default: off Enables or disables DMVPN traffic redirection.
Hub: NFLOG group integer [1..65535]; default: none Specify NFLOG group to be used by NHRP instance
Multicast off | on; default: off Allow use of dynamic routing protocols that use multicast.
NHRP multicast NFLOG group integer [1..65535}; default: none Specify NFLOG group to be used by NHRP instance for multicast traffic.

L2TP

In computer networking, Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs). It is more secure than PPTP but, because it encapsulates the transferred data twice, but it is slower and uses more CPU power.

L2TP client

An L2TP client is an entity that initiates a connection to an L2TP server. To create a new client instance, go to the Services → VPN → L2TP section, select Role: Client, 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:

Field Value Description
Enable off | on; default: off Turns the L2TP instance on or off.
Server ip | host; default: none A domain name or IP address (IPv4 or IPv6) with an optional port (values from 1 to 65535) is required (e.g., 192.168.1.1, ::0000:8a2e:0370:7334, example.com, or 192.168.1.1:80).
Username string; default: none Username used for authentication to the L2TP server.
Password string; default: none Password used for authentication to the L2TP server.
CHAP secret string; default: none A secret used for L2TP Tunnel Authentication.
MTU [68..9200]; default: none 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.
Default route off | on; default: off 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.
Allow CHAP on | off; default: on Allows CHAP authentication method to be used.
Allow PAP on | off; default: off Allows PAP authentication method to be used.
Allow MSCHAP-v2 on | off; default: on Allow MSCHAP-v2 authentication method to be used.
Custom options string; default: none Custom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.


Active L2TP client instance example:

L2TP server

An L2TP server is an entity that waits for incoming connections from L2TP clients. To create a new server instance, go to the Services → VPN → L2TP section, select Role: Server, enter a custom name and click the 'Add' button. An L2TP server instance with the given name will appear in the "L2TP Configuration" list. Only one L2TP server instance is allowed to be added.

A server needs to have a 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:

Field Value Description
Enable off | on; default: off Turns the L2TP instance on or off.
Use IPv6 off | on; default: off L2TPv6 support package is required to enable this option. Enables an IPv6 socket to accept L2TP connections over IPv6. Note: L2TPv6 support is additional software on some devices that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.
Local IP ip; default: 192.168.0.1 IP address of this L2TP network interface.
Remote IP range begin ip; default: 192.168.0.20 L2TP IP address leases will begin from the address specified in this field.
Remote IP range end ip; default: 192.168.0.30 L2TP IP address leases will end with the address specified in this field.
Port integer [1..65535]; default: none Port for binding.
Enable CHAP on | off; default: off Challenge-Handshake Authentication Protocol for L2TP.
CHAP Secret string; default: none A secret used for L2TP Tunnel Authentication.
CHAP authentication on | off; default: on When turned on it requires CHAP authentication method to be used, when turned off it refuses CHAP authentication method.
PAP authentication on | off; default: off When turned on it requires PAP authentication method to be used, when turned off it refuses PAP authentication method.
MSCHAP-v2 authentication on | off; default: on When turned on it requires MSCHAP-v2 authentication method to be used, when turned off it refuses MSCHAP-v2 authentication method.
Custom options string without "`" or "'"; default: Custom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.

Field Value Description
User name string; default: user Username used for authentication to this L2TP server.
Password string; default: pass Password used for authentication to this L2TP server.
L2TP Client's IP ip; default: none 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.


Active L2TP server instance example:

L2TPv3

L2TPv3 (Layer Two Tunneling Protocol Version 3) is a point-to-point layer two over IP tunnel. This means you can tunnel L2 protocols like Ethernet, Frame-relay, ATM, HDLC, PPP, etc. over an IP network.

To create a new L2TPv3 instance, go to the Services → VPN → L2TPv3 section, enter a custom name and click the 'Add' button. You will be redirected to instance configuration page and L2TPv3 instance with the given name will appear in the "L2TPv3 Configuration" list.

Instance configuration

Field Value Description
Enable off | on; default: off Turns the L2TPv3 instance on or off.
Local address ip; default: none IP address of device's WAN. Note: If left empty, it will take IP address automatically from main WAN interface.
Tunnel ID integer [1..4294967295]; default: none Uniquely identifies the tunnel. The value used must match the peer tunnel ID value being used at the peer.
Session ID integer [1..4294967295]; default: none The value used must match the tunnel ID value being used at the peer.
Cookie string; default: none Must be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF.

Peer settings

Field Value Description
Peer address ip; default: none Peer Endpoint IP address.
Peer Tunnel ID integer [1..4294967295]; default: none ID of peer's tunnel is specified from 1 to 4294967295. It must match other end tunnel ID.
Peer Session ID integer [1..4294967295]; default: none UID of peer's session is specified from 1 to 4294967295. It must match other end session ID.
Peer Cookie string; default: none Must be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF. It must match other end Cookie.

Instance Settings

Field Value Description
Bridge to None | LAN; default: None Peer Endpoint IP address.
IP Address ip; default: none IP address of standalone L2TPv3 interface.
Netmask netmask; default: none Netmask of standalone L2TPv3 interface.
MTU integer [64..9000]; default: none 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.
Encapsulation IP | UDP; default: IP Specify technology to use when connecting to other end.
Layer 2 specific header type None | Linux Default; default: Linux Default It might be neccessary to set this option to none when using other hardware.

ZeroTier

ZeroTier One 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.

Note: ZeroTier is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

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:


You should be redirected to the configuration page for the newly added ZeroTier Instance which should look similar to this:

Field Value Description
Enabled off | on; default: off Turns the ZeroTier Instance on or off.


ZeroTier network configuration instance should look similar to this:

Field Value Description
Enabled off | on; default: off Turns the ZeroTier Instance on or off.
Port integer [0..65535]; default: 9993 ZeroTier Network port.
Network ID hex string; default: none 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.
Bridge to None | LAN; default: None Specify to which interface this ZeroTier instance should be bridged to.
Allow default route off | on; default: off Allows ZeroTier to override system default route.
Allow global IP off | on; default: off Allows ZeroTier managed IPs and routes to overlap public IP space.
Allow managed IP off | on; default: on Assigns ZeroTier managed IPs and routes.
Allow DNS off | on; default: off Applies DNS servers that are set at the network controller.
Custom planet file -(interactive button) Custom planet file contains user-defined roots, enabling the use of private root servers.

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 Add button. This should add a new Wireguard instance and open a configuration window.

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.

Field Value Description
Enable off | on; default: off Turns WireGuard Instance on or off.
Private Key string; default: - Private Key used in authentication.
Public Key string; default: - Public Key used in authentication.
Generate key pair -(interactive button) Click to generate Public Key and Private Key.
IP Addresses ip; default: 10.5.0.1/24 A single IP address or a list of them for this instance associated with public keys.


Advanced Settings

Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.

Field Value Description
Metric positive integer; default: none Specify (Optional) metric for this tunnel interface. Lower number means higher priority.
Listen port integer [1..65535]; default: 51820 Required. UDP port used for outgoing and incoming packets.
MTU integer [68..9200]; default: none Maximum Transmission Unit of tunnel interface. Range [68 to 9200]. If not specified, the MTU is automatically determined by physical interface MTU value.
DNS servers ip; default: none DNS server(s) for this Wireguard interface.
Watchdog interval integer [0..60]; default: none Optional. Interval in minutes to re-resolve hostnames for inactive WireGuard peers if domain is used. If not specified and domain is used, hostnames will be checked every minute.

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 Add button.


General Peer Settings

In the General section of Peer instance you can configure basic information about the endpoint to allow communications.

Field Value Description
Public Key string; default: none Base64-encoded public key of peer.
Endpoint host domain name | ip; default: none Host of peer. Names are resolved prior to bringing up the interface.
Allowed IPs ip; default: 10.5.0.2/32 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.
Description string; default: none Description of the peer.
Route Allowed IPs off | on; default: off Create routes for Allowed IPs for this peer.

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.

Field Value Description
Tunnel source Any | LAN | WAN | Mobile; default: Any Interface to bind this instance to.
Tunnel source mode Prefer | Persist; default: Prefer Choose whether to persist or prefer the connection on the selected interface.
Pre-Shared Key string; default: none Base64-encoded pre-shared key. Adds in an additional layer of symmetric-key cryptography for post-quantum resistance.
Endpoint Port integer [1..65535]; default: none Port of peer.
Persistent Keep Alive integer [0..65535]; default: none Seconds between keep alive messages. Default is 0 (disabled). Recommended value if this device is behind a NAT is 25. Range [0 to 65535].
Routing table string; default: none Defines which routing table to use for this peer routes, not necessary to configure for most setups..

QR Settings

Field Value Description
Server IP IP address; default: None Specifies which interface's IP address should be bound to the hostname.
Tunnel address IP; default: 10.5.0.2/32 Choose whether to persist or prefer the connection on the selected interface.
Peer allowed IPs All IPv4 | All IPv6 | LAN; default: All IPv4 (0.0.0.0/0) Required. 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.
QR code Interactive button Generates single-use QR code.

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 [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.

Note: Tinc VPN is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Tinc works by adding an interface which acts as Router/Switch/Hub mode. To create one enter its name and click the Add button. This should add a new Tinc interface and open a configuration window

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.

Field Value Description
Enable off | on; default: off Turns Tinc Interface on or off.
Local tunnel endpoint IP ipv4 with or without mask; default: none IP address of virtual local network interface.
Local tunnel endpoint IPv6 ipv6 with or without mask; default: none IPv6 address of virtual local network interface.
Subnet ip with subnet; default: none Subnets that peers are allowed to access. You can add multiple subnet entries for each daemon.
Private Key .key file; default: none Generated RSA private key.
Public Key .key file; default: none Generated RSA public key.
Host to Connect to Not specified | Host name; default: Not specified 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.

Advanced Settings

Advanced Settings section.

Field Value Description
Port integer [1..65535]; default: 655 Configure the port on which this tinc daemon will listen for incoming connections.
Address Family Any | IPv4 | IPv6; default: Any This option affects the address family of listening and outgoing sockets.
Bind To Address ip; default: none Addresses for Tinc VPN to use for listening sockets.
Bind To Interface Any | LAN | WAN | WAN6 | Mobile; default: Any Interface to listen for incoming connections.
Key Expire integer; default: 3600 This option controls the time the encryption keys used to encrypt the data are Valid.
Mode Router | Switch | Hub; default: Router This option selects the way packets are routed to other daemons.
Ping Interval integer; default: 60 The number of seconds of inactivity that tinc will wait before sending a probe to the other end.
Ping Timeout integer; default: 5 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.

Hosts

The Hosts section is used to add your VPN hosts. To create one enter its name and click the Add button. To configure it click the Edit button.


General Tinc Host Settings

In the General section of Hosts instance you can configure basic information about the host.

Field Value Description
Enable off | on; default: off Turn this tinc host on/off.
Description string; default: none Optional. Description of host.
Address IP addresses with an optional port number; default: none Remote host's IP address or domain name, optionally followed by a port number (e.g., example.com:8080). If no port is specified, the default port (655) will be used.
Subnet IPv4, IPv6 or MAC addresses; default: none Specify the host-side subnets you need to access. You can add multiple subnet entries for each daemon.
Public Key .key file; default: none Generated RSA public key.



EoIP

EoIP is a MikroTik RouterOS protocol based on GRE RFC 1701 that creates an Ethernet tunnel between two routers on top of an IP connection. At current moment it is easiest way to create stateless tunnel with Mikrotik.


Note: EoIP is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Topology

EoIP configuration

To create a new EoIP instance, go to the Services → VPN → EoIP page and click the 'Add' button. The "EoIP Configuration" window will appear.

The following is the instance configuration window:

Field Value Description
Enable on | off; default: off Enable current configuration.
Name string; default: instance1 Name of the EoIP instance.
Tunnel ID integer [1..65536]; default: empty Unique tunnel identifier, which must match other side of the tunnel.
Use IPv6 on | off; default: off The parameter specifies the local IP address used as the source for sending traffic through a tunnel.
Local IP IPv4/IPv6 addresses; default: empty The parameter specifies the local IP address used as the source for sending traffic through a tunnel.
Dynamic on | off; default: off Allow the connection. If you enable it, be aware that there is no authorization and it is not secure. Avoid using this feature on a public IP or a network where you do not have full control over all hosts.
Remote IP IPv4/IPv6 addresses; default: empty The parameter specifies the IP address of the remote endpoint that the tunnel will connect to.
Bridge interface; default: none Assign an EoIP interface to a bridge.

[[Category:{{{name}}} Services section]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_vpn&oldid=159354"