Template:Networking rut manual vpn: Difference between revisions

From Teltonika Networks Wiki
m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) (.*) (.*) (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}")
No edit summary
(101 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
==Summary==
==Summary==


<b>Virtual Private Network</b> (<b>VPN</b>) 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:
<b>Virtual Private Network</b> (<b>VPN</b>) 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:
<ul>
<ul>
     <li>providing access between remote private networks;</li>
     <li>access between remote private networks;</li>
     <li>providing data encryption and anonymity when browsing the Internet.</li>
     <li>data encryption;</li>
    <li>anonymity when browsing the Internet.</li>
</ul>
</ul>


This chapter of the user manual provides an overview of the Firewall page for {{{name}}} devices.
This page is an overview of different types of VPNs supported by {{{name}}} routers.


==OpenVPN==
==OpenVPN==
Line 26: Line 18:
===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 New' button. An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration" list. A maximum of six OpenVPN client instances are allowed to be added.
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 New' button. An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration" list. A maximum of six OpenVPN client instances are allowed to be added.


To begin configuration, click the 'Edit' button next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
To begin configuration, click the 'Edit' button next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:


[[File:{{{file_openvpn_client_config}}}|border|class=tlt-border]]
[[File:{{{file_openvpn_client_config}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 37: Line 29:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
      <td>Enable OpenVPN config from file</td>
      <td>yes | no; default: <b>no</b></td>
      <td>Enables custom OpenVPN configuration from file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 63: Line 50:
         <td>Transfer protocol used for the OpenVPN connection.
         <td>Transfer protocol used for the OpenVPN connection.
             <ul>
             <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>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol 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>
                 <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>
             </ul>
Line 77: Line 64:
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Turns LZO data compression on or off.</td>
       <td>Turns LZO data compression on or off.</td>
    </tr>
    <tr>
      <td>Encryption</td>
      <td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-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>Algorithm used for packet encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 95: Line 87:
             </ul>
             </ul>
         </td>
         </td>
    </tr>
    <tr>
      <td>Encryption</td>
      <td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64 | AES-128-CFB 128 | AES-128-CFB1 128 | AES-128-CFB8 128 | AES-128-OFB 128 | AES-128-CBC 128 | AES-128-GCM 128 | AES-192-CFB 192 | AES-192-CFB1 192 | AES-192-CFB8 192 | AES-192-OFB 192 | AES-192-CBC 192 | AES-192-GCM 192 | AES-256-CFB 256 | AES-256-CFB1 256 | AES-256-CFB8 256 | AES-256-OFB 256 | AES-256-CBC 256 | AES-256-GCM 256 | none ; default: <b>BF-CBC 128</b></td>
      <td>Algorithm used for packet encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 134: Line 121:
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
         <td>ip; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>IP address of the remote OpenVPN network (server) interface.</td>
         <td>IP address of the remote network OpenVPN (server) interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 160: Line 147:
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Extra OpenVPN options to be used by the OpenVPN instance.</td>
         <td>Extra OpenVPN options to be used by the OpenVPN instance.</td>
    </tr>
    <tr>
    <td>Use PKCS #12 format</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Use PKCS #12 archive file format to bundle all the members of a chain of trust.</td>
    </tr>
    <tr>
    <td>PKCS #12 passphrase</td>
        <td>string; default: <b>none</b></td>
        <td>Passphrase to decrypt PKCS #12 certificates.</td>
    </tr>
    <tr>
    <td>PKCS #12 certificate chain</td>
        <td>string; default: <b>none</b></td>
        <td>Uploads PKCS #12 certificate chain file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 183: Line 155:
     <tr>
     <tr>
       <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Additional HMAC authentication</td>
       <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> Additional HMAC authentication</td>
       <td>none | Authentication only (tls-auth) | Authentication and encryption (tls-crypt); default: <b>none</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
       <td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>
     </tr>
     </tr>
Line 199: Line 171:
       <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: #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 (CA) 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>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>
     </tr>
     </tr>
     <tr>
     <tr>
Line 243: Line 215:
To begin configuration, click the 'Edit' button next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
To begin configuration, click the 'Edit' button next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:


[[File:{{{file_openvpn_server_config}}}|border|class=tlt-border]]
[[File:{{{file_openvpn_server_config}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 250: Line 222:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
      <td>Enable OpenVPN config from file</td>
      <td>yes | no; default: <b>no</b></td>
      <td>Enables custom OpenVPN configuration from file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 276: Line 243:
         <td>Transfer protocol used for the connection.
         <td>Transfer protocol used for the connection.
             <ul>
             <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>Transmission Control Protocol</b> (<b>TCP</b>) - most commonly used protocol in the Internet protocol 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>
                 <li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls).</li>
             </ul>
             </ul>
Line 290: Line 257:
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Turns LZO data compression on or off.</td>
       <td>Turns LZO data compression on or off.</td>
    </tr>
    <tr>
      <td>Encryption</td>
      <td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-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>Algorithm used for packet encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 307: Line 279:
             </ul>
             </ul>
         </td>
         </td>
    </tr>
    <tr>
      <td>Encryption</td>
      <td>DES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64 | AES-128-CFB 128 | AES-128-CFB1 128 | AES-128-CFB8 128 | AES-128-OFB 128 | AES-128-CBC 128 | AES-128-GCM 128 | AES-192-CFB 192 | AES-192-CFB1 192 | AES-192-CFB8 192 | AES-192-OFB 192 | AES-192-CBC 192 | AES-192-GCM 192 | AES-256-CFB 256 | AES-256-CFB1 256 | AES-256-CFB8 256 | AES-256-OFB 256 | AES-256-CBC 256 | AES-256-GCM 256 | none ; default: <b>BF-CBC 128</b></td>
      <td>Algorithm used for packet encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 321: Line 288:
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
     <td><span style="color: purple;">Static key:</span> Remote tunnel endpoint IP</td>
         <td>ip; default: <b>none</b></td>
         <td>ip; default: <b>none</b></td>
         <td>IP address of the remote OpenVPN network (client) interface.</td>
         <td>IP address of the remote OpenVPN (client) network interface.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 372: Line 339:
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>When enabled allows multiple clients to connect using the same certificates.</td>
         <td>When enabled allows multiple clients to connect using the same certificates.</td>
    </tr>
      <tr>
    <td>Use PKCS #12 format</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Use PKCS #12 archive file format to bundle all the members of a chain of trust.</td>
    </tr>
    <tr>
    <td>PKCS #12 passphrase</td>
        <td>string; default: <b>none</b></td>
        <td>Passphrase to decrypt PKCS #12 certificates.</td>
    </tr>
    <tr>
    <td>PKCS #12 certificate chain</td>
        <td>string; default: <b>none</b></td>
        <td>Uploads PKCS #12 certificate chain file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: #0054a6;">TLS/Password:</span> User name</td>
       <td><span style="color: #0054a6;">TLS/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 this OpenVPN server.</td>
       <td>Username used for authentication to the OpenVPN server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color: #0054a6;">TLS/Password:</span> Password</td>
       <td><span style="color: #0054a6;">TLS/Password:</span> Password</td>
       <td>string; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>Password used for authentication to this OpenVPN server.</td>
       <td>Password used for authentication to the OpenVPN server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 427: Line 379:
         <td>.pem file | .crl file; default: <b>none</b></td>
         <td>.pem file | .crl file; 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>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>
    </tr>
    <tr>
    <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Enable manual ccd upload</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Enable manual upload of client-config-dir files.</td>
     </tr>
     </tr>
</table>
</table>
Line 453: Line 400:
The TLS Clients section can be found in the OpenVPN Server configuration window, provided that the OpenVPN server uses TLS or TLS/Password authentication methods. To create a new TLS client, type in the new client‘s name in the text field found bellow the TLS Clients tab and click the 'Add' button. Refer to the figure and table below for information on the TLS Clients' configuration fields:
The TLS Clients section can be found in the OpenVPN Server configuration window, provided that the OpenVPN server uses TLS or TLS/Password authentication methods. To create a new TLS client, type in the new client‘s name in the text field found bellow the TLS Clients tab and click the 'Add' button. Refer to the figure and table below for information on the TLS Clients' configuration fields:


[[File:{{{file_openvpn_tls_clients_config}}}|border|class=tlt-border]]
[[File:{{{file_openvpn_tls_clients_config}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 460: Line 407:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
      <td>VPN instance name</td>
      <td>string; default: <b>none</b></td>
      <td>Indicates which OpenVPN instance the TLS Client will be associated with. When left empty, this field is filled automatically.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 493: Line 445:
</table>
</table>


{{#ifeq:{{{series}}}|RUT9XX||{{Template:Networking_rut2xx_manual_vpn_ipsec
==IPsec==
| file_ipsec_config          = {{{file_ipsec_config}}}
| file_ipsec_phase          = {{{file_ipsec_phase}}}
| file_ipsec_main_mode      = {{{file_ipsec_main_mode}}}
| file_ipsec_aggressive_mode = {{{file_ipsec_aggressive_mode}}}
| file_ipsec_psk            = {{{file_ipsec_psk}}}
}}}}
 
{{#ifeq:{{{series}}}|RUT2XX||{{Template:Networking_rut9xx_manual_vpn_ipsec
| file_ipsec_config          = {{{file_ipsec_config}}}
| file_ipsec_phase          = {{{file_ipsec_phase}}}
| file_ipsec_main_mode      = {{{file_ipsec_main_mode}}}
| file_ipsec_aggressive_mode = {{{file_ipsec_aggressive_mode}}}
| file_ipsec_psk            = {{{file_ipsec_psk}}}
}}}}
 
{{#ifeq:{{{series}}}|RUT9XX||{{Template:Networking_rutxxx_manual_vpn_gre
| file_gre_config_main      = {{{file_gre_config_main}}}
| file_gre_config_routing  = {{{file_gre_config_routing}}}
}}}}
 
{{#ifeq:{{{series}}}|RUT2XX||{{Template:Networking_rut9xx_manual_vpn_gre
| file_gre_config_main      = {{{file_gre_config_main}}}
| file_gre_config_routing  = {{{file_gre_config_routing}}}
}}}}


==PPTP==
To create a new IPsec instance, go to the <i>Services → VPN → IPsec</i> section, enter a custom name and click "Add". An IPsec instance with the given name will appear in the "IPsec Configuration" list.


<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.
To begin configuration, click the 'Edit' button located next to the instance.


===PPTP client===
===IPsec configuration===
----
----
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 New' button. A PPTP client instance with the given name will appear in the "PPTP Configuration" list.
The <b>IPsec configuration</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 general settings section.


To begin configuration, click the 'Edit' button located next to the client instance. Refer to the figure and table below for information on the PPTP client's configuration fields:
[[File:{{{file_ipsec_config}}}]]
 
[[File:{{{file_pptp_client_config}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 538: Line 464:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Enable</td>
    <td>Enable</td>
      <td>yes | no; default: <b>no</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>Turns the PPTP instance on or off.</td>
        <td>Turns the IPsec instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Use as default gateway</td>
    <td>IKE version</td>
      <td>yes | no; default: <b>no</b></td>
        <td>IKEv1 | IKEv2; default: <b>IKEv1</b></td>
      <td>When turned on, this connection will become the router'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.<br><b>NOTE</b>: this can only be used when [[{{{name}}}_WAN#Operation_Modes|WAN Failover]] is turned off.</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>
     <tr>
     <tr>
       <td>Client to client</td>
       <td>Mode</td>
       <td>yes | no; default: <b>no</b></td>
       <td>Main | Aggressive; default: <b>Main</b></td>
       <td>Adds a route that makes other PPTP clients accessible within the PPTP network.</td>
       <td>Internet Security and Key Management Protocol (ISAKMP) phase 1 exchange mode.
            <ul>
                <li><b>Main</b> - performs three two-way exchanges between the initiator and the receiver (a total of 9 messages).</li>
                <li><b>Aggressive</b> - performs fewer exchanges 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.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Server</td>
       <td>Type</td>
       <td>ip | host; default: <b>none</b></td>
       <td>Tunnel | Transport; default: <b>Tunnel</b></td>
       <td>IP address or hostname of a PPTP server.</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>Username</td>
    <td>My identifier type</td>
      <td>string; default: <b>none</b></td>
        <td>FQDN | User FQDN | Address; default: <b>FQDN</b></td>
      <td>Username used for authentication to the PPTP server.</td>
        <td>Defines the type of identity used in user (IPsec instance) authentication.
            <ul>
                <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>User FQDN</b> - identity defined by fully qualified username string (for example, <i>username@something.somedomain.com</i>). Only supported with IKEv2.</li>
                <li><b>Address</b> - identity by IP address.</li>
            </ul>
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Password</td>
    <td>On startup</td>
      <td>string; default: <b>none</b></td>
        <td>Ignore | Add | Route | Start; default: <b>Start</b></td>
      <td>Password used for authentication to the PPTP server.</td>
        <td>Defines how the instance should act on router startup.
            <ul>
                <li><b>Ignore</b> - does not start the tunnel.</li>
                <li><b>Add</b> - loads a connection without starting it.</li>
                <li><b>Route</b> - starts the tunnel only if there is traffic.</li>
                <li><b>Start</b> - starts the tunnel on router startup.</li>
            </ul>
        </td>
     </tr>
     </tr>
</table>
===PPTP server===
----
A <b>PPTP server</b> is an entity that waits for incoming connections from PPTP clients. To create a new server instance, go to the <i>Services → VPN → PPTP</i> section, select <i>Role: Server</i>, enter a custom name and click the 'Add New' button. A PPTP server instance with the given name will appear in the "PPTP Configuration" list. Only one PPTP server instance is allowed to be added.
A 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 'Edit' button located next to the server instance. Refer to the figure and table below for information on the PPTP server's configuration fields:
[[File:{{{file_pptp_server_config}}}]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td>My identifier</td>
      <th>Value</th>
        <td>ip | string; default: <b>none</b></td>
      <th>Description</th>
        <td>Defines how the user (IPsec instance) will be identified during authentication.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td><span style="color: red;">Tunnel:</span> Local IP address/Subnet mask</td>
       <td>yes | no; default: <b>no</b></td>
       <td>ip/netmask | default: <b>none</b></td>
       <td>Turns the PPTP instance on or off.</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>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Local IP</td>
       <td>Left firewall</td>
       <td>ip; default: <b>192.168.0.1</b></td>
       <td>off | on; default: <b>on</b></td>
       <td>IP address of this PPTP network interface.</td>
       <td>Adds neccessary firewall rules to allow traffic of this IPsec instance on this router.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Remote IP range start</td>
    <td>Force encapsulation</td>
      <td>ip; default: <b>192.168.0.20</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>PPTP IP address leases will begin from the address specified in this field.</td>
        <td>Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Remote IP range end</td>
    <td>Dead Peer Detection</td>
      <td>ip; default: <b>192.168.0.30</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>PPTP IP address leases will end with the address specified in this field.</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>User name</td>
    <td><span style="color: #0054a6;">Dead Peer Detection:</span> Delay (sec)</td>
      <td>string; default: <b>youruser</b></td>
        <td>integer; default: <b>none</b></td>
      <td>Username used for authentication to this PPTP server.</td>
        <td>The frequency of checking whether a peer is still availaible or not.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Password</td>
    <td><span style="color: #0054a6;">Dead Peer Detection:</span> Timeout (sec)</td>
      <td>string; default: <b>yourpass</b></td>
        <td>integer; default: <b>none</b></td>
      <td>Password used for authentication to this PPTP server.</td>
        <td>Time limit after which the IPsec instance will stop checking the availability of a peer and determine it to be "dead" if no response is received.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>PPTP Client's IP</td>
       <td>Remote VPN endpoint</td>
       <td>ip; default: <b>none</b></td>
       <td>host | 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 or hostname of the remote IPsec instance.</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 New' button. An L2TP client
instance with the given name will appear in the "L2TP Configuration" list.
To begin configuration, click the 'Edit button located next to the client instance. Refer
to the figure and table below for information on the L2TP client's configuration fields:
[[File:Networking_{{lc:{{{series}}}}}_vpn_l2tp_client_configuration_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
    <td><span style="color: red;">Tunnel:</span> Remote IP address/subnet mask</td>
      <th>Value</th>
        <td>ip/netmask; default: <b>none</b></td>
      <th>Description</th>
        <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>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Enable</td>
    <td>Right firewall</td>
      <td>yes | no; default: <b>no</b></td>
        <td>yes | no; default: <b>yes</b></td>
      <td>Turns the L2TP instance on or off.</td>
        <td>Adds neccessary firewall rules to allow traffic of from the opposite IPsec instance on this router.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Server</td>
    <td><span style="color: purple;">Transport:</span> Use with DMVPN</td>
      <td>ip | host; default: <b>none</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>IP address or hostname of an L2TP server.</td>
        <td>Adds several necessary options to make DMVPN work.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Username</td>
       <td>Enable keepalive</td>
       <td>string; default: <b>none</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Username used in authorization to the L2TP server.</td>
       <td>When enabled, the instance sends ICMP packets to the specified host at the specified frequency. If no response is received, the router will attempt to restart the connection.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Password</td>
       <td>Host</td>
       <td>string; default: <b>none</b></td>
       <td>host | ip; default: <b>none</b></td>
       <td>Password used in authorization to the L2TP server.</td>
       <td>Hostname or IP address to which keepalive ICMP packets will be sent to.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Authentication</td>
    <td>Ping period (sec)</td>
      <td>string; default: <b>none</b></td>
        <td>integer [0..9999999]; default: <b>none</b></td>
      <td>Optional. Password used in L2TP tunnel CHAP authentication.</td>
        <td>The frequency at which keepalive ICMP packets will be sent to the specified host or IP address.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Keep alive</td>
    <td>Allow WebUI access</td>
      <td>integer; default: <b>none</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>Frequency (in seconds) at which LCP echo requests are sent to the remote instance in order to determine the health of the connection.</td>
        <td>Allows WebUI access for hosts in the VPN network.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Default route</td>
    <td>Custom options</td>
      <td>yes | no; default: <b>no</b></td>
        <td>ipsec options; default: <b>none</b></td>
      <td>When turned on, this connection will become the router's 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.<br><b>NOTE</b>: this can only be used when [[{{{name}}} _WAN#Operation_Modes|WAN Failover]] is turned off.</td>
        <td>Provides the possibility to further customize the connection by adding extra IPsec options.</td>
     </tr>
     </tr>
</table>
</table>


===L2TP server===
<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>
            <li>Blue for <span style="color: #0054a6;">Dead Peer Detection: Enabled</span></li>
        </ul>
    </li>
    <li>After changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-right side of the page.</li>
</ul>
 
===Phase settings===
----
----
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 New' 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.
IKE (Internet Key Exchange) is a protocol used to set up security associations (SAs) for the IPsec connection. This process is required before the IPsec tunnel can be established. It is done in two phases:
 
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 'Edit' button located next to the server instance. Refer to the figure and table below for information on the L2TP server's configuration fields:
<table border=1; style="border-collapse: collapse;">
 
[[File:Networking_rutxxx_vpn_l2tp_server_configuration_v1.png]]
 
<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>yes | no; default: <b>no</b></td>
            <ul>
      <td>Turns the L2TP instance on or off.</td>
                <li>Establishes a secure channel between peers</li>
                <li>Authenticates peers</li>
                <li>Negotiates SA policy</li>
                <li>Shares secret keys</li>
                <li>Establishes secure tunnel for phase 2</li>
            </ul>
        </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>
     <tr style="vertical-align: top;">
      <td>Local IP</td>
        <td><b>Phase 2</b>
      <td>ip; default: <b>192.168.0.1</b></td>
            <ul>
      <td>IP address of this L2TP network interface.</td>
                <li>Sets up matching IPsec SAs</li>
    </tr>
                <li>Periodically renegotiates IPsec SAs</li>
    <tr>
            </ul>
      <td>Remote IP range begin</td>
        </td>
      <td>ip; default: <b>192.168.0.20</b></td>
        <td colspan="2">Quick mode
      <td>L2TP IP address leases will begin from the address specified in this field.</td>
            <ul>
    </tr>
                <li>3 packets exchanged</li>
    <tr>
                <li>IPsec SA parameters (ESP/AH, SHA/MD5) established</li>
      <td>Remote IP range end</td>
                <li>SA lifetime set</li>
      <td>ip; default: <b>192.168.0.30</b></td>
            </ul>
      <td>L2TP IP address leases will end with the address specified in this field.</td>
        </td>
    </tr>
    <tr>
      <td>User name</td>
      <td>string; default: <b>user</b></td>
      <td>Username used for authentication to this L2TP server.</td>
    </tr>
    <tr>
      <td>Password</td>
      <td>string; default: <b>pass</b></td>
      <td>Password used for authentication to this L2TP server.</td>
    </tr>
    <tr>
      <td>L2TP Client's IP</td>
      <td>ip; default: <b>none</b></td>
      <td>Assigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.</td>
     </tr>
     </tr>
</table>
</table>
 
<br>
==SSTP==
<table>
 
    <tr>
<b>Secure Socket Tunneling Protocol</b> (<b>SSTP</b>) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
        <td><b>Figure 1</b></td>
 
        <td><b>Figure 2</b></td>
===SSTP configuration===
    </tr>
    <tr>
        <td width=500>[[File:{{{file_ipsec_main_mode}}}]]</td>
        <td width=500>[[File:{{{file_ipsec_aggressive_mode}}}]]</td>
    </tr>
</table>
----
----
To create a new SSTP instance, go to the <i>Services → VPN → SSTP</i> section, enter a custom name and click the 'Add' button. An SSTP instance with the given name will appear in the "SSTP Configuration" list.
[[File:{{{file_ipsec_phase}}}]]
 
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:{{{file_sstp_config}}}]]


<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>
        <td>Enabled</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Turns the SSTP instance on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Use as default gateway</td>
    <td>Encryption algorithm</td>
         <td>yes | no; default: <b>no</b></td>
         <td>DES | 3DES | AES128 | AES192 | AES256; default: <b>3DES</b></td>
         <td>When turned on, this connection will become the router's 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.<br><b>NOTE</b>: this can only be used when [[{{{name}}} _WAN#Operation_Modes|WAN Failover]] is turned off.</td>
         <td>Algorithm used for data encryption.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Server IP address</td>
    <td>Authentication/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 an SSTP server.</td>
         <td>Algorithm used for exchanging authentication and hash information.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Username</td>
    <td>DH group/PFS group</td>
         <td>string; default: <b>none</b></td>
         <td>MODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096; default: <b>MODP1536</b></td>
         <td>Username used for authentication to the SSTP server.</td>
         <td></td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Password</td>
    <td>Lifetime</td>
         <td>string; default: <b>none</b></td>
         <td>integer; default: <b>8 hours</b></td>
         <td>Password used for authentication to the SSTP server.</td>
         <td>Defines a time period after which the phase will re-initiate its exchange of information.</td>
    </tr>
    <tr>
        <td>CA cert</td>
        <td>.crt file; default: <b>none</b></td>
        <td>Uploads a Certificate authority (CA) file.</td>
     </tr>
     </tr>
</table>
</table>


{{#ifeq:{{{series}}}|RUT2XX||{{Template:Networking_rut9xx_manual_vpn_stunnel
===Pre-shared keys===
| file_stunnel_globals    = {{{file_stunnel_globals}}}
----
| file_stunnel_client_server_config  = {{{file_stunnel_client_server_config}}}
| name = {{{name}}}
}}}}
 
{{#ifeq:{{{series}}}|RUT9XX||{{Template:Networking_rut2xx_manual_vpn_stunnel
| file_stunnel_globals    = {{{file_stunnel_globals}}}
| file_stunnel_client_server_config  = {{{file_stunnel_client_server_config}}}
| name = {{{name}}}
}}}}
 
{{#ifeq:{{{series}}}|RUT2XX||{{Template:Networking_rutxxx_manual_vpn_dmvpn
| file_dmvpn_config      = {{{file_dmvpn_config}}}
| file_dmvpn_gre_config  = {{{file_dmvpn_gre_config}}}
| file_dmvpn_ipsec_config = {{{file_dmvpn_ipsec_config}}}
| file_dmvpn_nhrp_config  = {{{file_dmvpn_nhrp_config}}}
}}}}
 
{{Template:Networking_rutxxx_manual_vpn_zerotier
| name                  = {{{name}}}
| file_zerotier_general = {{{file_zerotier_general}}}
| file_zerotier_vpn    = {{{file_zerotier_vpn}}}
}}


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

Revision as of 14:12, 2 July 2019

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 different types of VPNs supported by {{{name}}} routers.

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.

{{{name}}} routers run OpenVPN version 2.4.5.

OpenVPN client


An OpenVPN client is an entity that initiates a connection to an OpenVPN server. To create a new client instance, go to the Services → VPN → OpenVPN section, select Role: Client, enter a custom name and click the 'Add New' button. An OpenVPN client instance with the given name will appear in the "OpenVPN Configuration" list. A maximum of six OpenVPN client instances are allowed to be added.

To begin configuration, click the 'Edit' button next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:

[[File:{{{file_openvpn_client_config}}}]]

Field Value Description
Enable yes | no; default: no Turns the OpenVPN instance on or off.
TUN/TAP TUN (tunnel) | TAP (bridged); default: TUN (tunnel) Virtual network device type.
  • TUN - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), used when routing is required.
  • TAP - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), used when bridging is required.
Protocol UDP | TCP; default: UDP Transfer protocol used for the OpenVPN connection.
  • Transmission Control Protocol (TCP) - most commonly used protocol in the Internet protocol 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).
  • User Datagram Protocol (UDP) - 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).
Port integer [0..65535]; default: 1194 TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side.
NOTE: traffic on the selected port will be automatically allowed in the router's firewall rules.
LZO yes | no; default: no Turns LZO data compression on or off.
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-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; default: BF-CBC 128 Algorithm used for packet encryption.
Authentication TLS | Static Key | Password | TLS/Password; default: TLS Authentication mode, used to secure data sessions.
  • Static key is a secret key used for server–client authentication.
  • TLS authentication mode uses X.509 type certificates:
    • Certificate Authority (CA)
    • Client certificate
    • Client key
    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.
  • Password is a simple username/password based authentication where the owner of the OpenVPN server provides the login data.
  • TLS/Password uses both TLS and username/password authentication.
TLS: TLS cipher All | DHE+RSA | Custom; default: All Packet encryption algorithm cipher.
TLS: Allowed TLS ciphers All | DHE+RSA | Custom; default: All A list of TLS ciphers accepted for this connection.
Remote host/IP address ip; default: none IP address or hostname of an OpenVPN server.
Resolve retry integer | infinite; default: infinite In case server hostname resolve fails, this field indicates the amount of time (in seconds) to retry the resolve. Specify infinite to retry indefinitely.
Keep alive two integers separated by a space; default: none 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.
Example: 10 120
Static key: Local tunnel endpoint IP ip; default: none IP address of the local OpenVPN network interface.
Static key: Remote tunnel endpoint IP ip; default: none IP address of the remote network OpenVPN (server) interface.
Remote network IP address ip; default: none LAN IP address of the remote network (server).
Remote network IP netmask netmask; default: none LAN IP subnet mask of the remote network (server).
Password: User name string; default: none Username used for authentication to the OpenVPN server.
Password: Password string; default: none Password used for authentication to the OpenVPN server.
Extra options string; default: none Extra OpenVPN options to be used by the OpenVPN instance.
TLS/Password: HMAC authentication algorithm none | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 HMAC authentication algorithm type.
TLS/Password: Additional HMAC authentication yes | no; default: no An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.
TLS/Password: HMAC authentication key .key file; default: none Uploads an HMAC authentication key file.
TLS/Password: HMAC key direction 0 | 1 | none; default: 1 The value of the key direction parameter should be complementary on either side (client and server) of the connection. If one side uses 0, the other side should use 1, or both sides should omit the parameter altogether.
TLS/Password: Certificate authority .ca file; default: none 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.
TLS: Client certificate .crt file; default: none 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.
TLS: Client key .key file; default: none Authenticates the client to the server and establishes precisely who they are.
TLS: Private key decryption password (optional) string; default: none A password used to decrypt the server's private key. Use only if server's .key file is encrypted with a password.
Static key: Static pre-shared key .key file; default: none Uploads a secret key file used for server–client 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 Authentication: TLS
    • Purple for Authentication: Static key
    • Blue for Authentication: Password
  • After changing any of the parameters, don't forget to click the Save 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. To create a new server instance, go to the Services → VPN → OpenVPN section, select Role: Server, enter a custom name and click the 'Add New' 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.

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 'Edit' button next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:

[[File:{{{file_openvpn_server_config}}}]]

Field Value Description
Enable yes | no; default: no Turns the OpenVPN instance on or off.
TUN/TAP TUN (tunnel) | TAP (bridged); default: TUN (tunnel) Virtual network device type.
  • TUN - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), used when routing is required.
  • TAP - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), used when bridging is required.
Protocol UDP | TCP; default: UDP Transfer protocol used for the connection.
  • Transmission Control Protocol (TCP) - most commonly used protocol in the Internet protocol 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).
  • User Datagram Protocol (UDP) - 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).
Port integer [0..65535]; default: 1194 TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side.
NOTE: traffic on the selected port will be automatically allowed in the router's firewall rules.
LZO yes | no; default: no Turns LZO data compression on or off.
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-40CBC 40 | CAST5-CBC 128 | RC2-64-CBC 64| AES-128-CBC 128 | AES-192-CBC 192 | AES-256-CBC 256 | none; default: BF-CBC 128 Algorithm used for packet encryption.
Authentication TLS | Static Key | TLS/Password; default: TLS Authentication mode, used to secure data sessions.
  • Static key is a secret key used for server–client authentication.
  • TLS authentication mode uses X.509 type certificates:
    • Certificate Authority (CA)
    • Client certificate
    • Client key
    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.
  • TLS/Password uses both TLS and username/password authentication.
Static key: Local tunnel endpoint IP ip; default: none IP address of the local OpenVPN network interface.
Static key: Remote tunnel endpoint IP ip; default: none IP address of the remote OpenVPN (client) network interface.
Static key: Remote network IP address ip; default: none LAN IP address of the remote network (client).
Static key: Remote network IP netmask netmask; default: none LAN IP subnet mask of the remote network (client).
TLS/TLS/Password: TLS cipher All | DHE+RSA | Custom; default: All Packet encryption algorithm cipher.
TLS/Password: Allowed TLS ciphers All | DHE+RSA | Custom; default: All A list of TLS ciphers accepted for this connection.
TLS/TLS/Password: Client to client yes | no; default: no Allows OpenVPN clients to communicate with each other on the VPN network.
TLS/TLS/Password: Keep alive two integers separated by a space; default: none 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.
Example: 10 120
TLS/TLS/Password: Virtual network IP address ip; default: none IP address of the OpenVPN network.
TLS/TLS/Password: Virtual network netmask netmask; default: none Subnet mask of the OpenVPN network.
TLS/TLS/Password: Push option OpenVPN options; default: none Push options are a way to "push" routes and other additional OpenVPN options to connecting clients.
TLS/TLS/Password: Allow duplicate certificates yes | no; default: no When enabled allows multiple clients to connect using the same certificates.
TLS/Password: User name string; default: none Username used for authentication to the OpenVPN server.
TLS/Password: Password string; default: none Password used for authentication to the OpenVPN server.
Static key: Static pre-shared key .key file; default: none Uploads a secret key file used for server–client authentication.
TLS/TLS/Password: Certificate authority .ca file; default: none 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.
TLS/TLS/Password: Server certificate .crt file; default: none A type of digital certificate that is used to identify the OpenVPN server.
TLS/TLS/Password: Server key .key file; default: none Authenticates clients to the server.
TLS/TLS/Password: Diffie Hellman parameters .pem file; default: none DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange.
TLS/TLS/Password: CRL file (optional) .pem file | .crl file; default: none 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.

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
    • Purple for Authentication: Static key
    • Blue for Authentication: TLS/Password
  • After changing any of the parameters, don't forget to click the Save 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:

[[File:{{{file_openvpn_tls_clients_config}}}]]

Field Value Description
VPN instance name string; default: none Indicates which OpenVPN instance the TLS Client will be associated with. When left empty, this field is filled automatically.
Endpoint name string; default: none A custom name for the client.
Common name (CN) string; default: none Client’s Common Name (CN) found in the client certificate file.
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.
Private network ip; default: none Client’s private network (LAN) IP address.
Private netmask ip; default: none Client’s private network (LAN) IP netmask.

IPsec

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

To begin configuration, click the 'Edit' button located next to the instance.

IPsec configuration


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

[[File:{{{file_ipsec_config}}}]]

Field Value Description
Enable yes | no; default: no Turns the IPsec instance on or off.
IKE version 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).
Mode Main | Aggressive; default: Main Internet Security and Key Management Protocol (ISAKMP) phase 1 exchange mode.
  • Main - performs three two-way exchanges between the initiator and the receiver (a total of 9 messages).
  • Aggressive - performs fewer exchanges 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.
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).
My identifier type FQDN | User FQDN | Address; default: FQDN Defines the type of identity used in user (IPsec instance) authentication.
  • 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.
  • User FQDN - identity defined by fully qualified username string (for example, [email protected]). Only supported with IKEv2.
  • Address - identity by IP address.
On startup Ignore | Add | Route | Start; default: Start Defines how the instance should act on router startup.
  • Ignore - does not start the tunnel.
  • Add - loads a connection without starting it.
  • Route - starts the tunnel only if there is traffic.
  • Start - starts the tunnel on router startup.
My identifier ip | string; default: none Defines how the user (IPsec instance) will be identified during authentication.
Tunnel: Local IP address/Subnet mask ip/netmask | default: none 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.
Left firewall off | on; default: on Adds neccessary firewall rules to allow traffic of this IPsec instance on this router.
Force encapsulation yes | no; default: no Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.
Dead Peer Detection yes | no; default: no 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: Delay (sec) integer; default: none The frequency of checking whether a peer is still availaible or not.
Dead Peer Detection: Timeout (sec) integer; default: none Time limit after which the IPsec instance will stop checking the availability of a peer and determine it to be "dead" if no response is received.
Remote VPN endpoint host | ip; default: none IP address or hostname of the remote IPsec instance.
Tunnel: Remote IP address/subnet mask ip/netmask; default: none 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.
Right firewall yes | no; default: yes Adds neccessary firewall rules to allow traffic of from the opposite IPsec instance on this router.
Transport: Use with DMVPN yes | no; default: no Adds several necessary options to make DMVPN work.
Enable keepalive yes | no; default: no When enabled, the instance sends ICMP packets to the specified host at the specified frequency. If no response is received, the router will attempt to restart the connection.
Host host | ip; default: none Hostname or IP address to which keepalive ICMP packets will be sent to.
Ping period (sec) integer [0..9999999]; default: none The frequency at which keepalive ICMP packets will be sent to the specified host or IP address.
Allow WebUI access yes | no; default: no Allows WebUI access for hosts in the VPN network.
Custom options ipsec options; default: none Provides the possibility to further customize the connection by adding extra IPsec options.

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
    • Blue for Dead Peer Detection: Enabled
  • After changing any of the parameters, don't forget to click the Save button located at the bottom-right side of the page.

Phase settings


IKE (Internet Key Exchange) is a protocol used to set up security associations (SAs) for the IPsec connection. This process is required before the 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
[[File:{{{file_ipsec_main_mode}}}]] [[File:{{{file_ipsec_aggressive_mode}}}]]

[[File:{{{file_ipsec_phase}}}]]

Field Value Description
Encryption algorithm DES | 3DES | AES128 | AES192 | AES256; default: 3DES Algorithm used for data encryption.
Authentication/Hash algorithm MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1 Algorithm used for exchanging authentication and hash information.
DH group/PFS group MODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096; default: MODP1536
Lifetime integer; default: 8 hours Defines a time period after which the phase will re-initiate its exchange of information.

Pre-shared keys


[[File:{{{file_ipsec_psk}}}]]