Difference between revisions of "Template:Networking rut manual vpn"
From Teltonika Networks Wiki
Gytispieze (talk | contribs) 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}}} }} }}") |
|||
| (129 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==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> | + | <li>access between remote private networks;</li> |
| − | <li> | + | <li>data encryption;</li> |
| + | <li>anonymity when browsing the Internet.</li> | ||
</ul> | </ul> | ||
| − | This | + | This page is an overview of different types of VPNs supported by {{{name}}} routers. |
==OpenVPN== | ==OpenVPN== | ||
| − | <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 | + | <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 regarding 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 <b>2.4.5</b>. | {{{name}}} routers run OpenVPN version <b>2.4.5</b>. | ||
| + | |||
| + | For more in-depth guides refer to our <b>[[OpenVPN configuration examples]]</b> page. | ||
===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 | + | 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 Services → VPN → OpenVPN section, select <i>Role: Client</i>, enter a custom name and click "Add New". 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 | + | 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}}} | + | [[File:{{{file_openvpn_client_config}}}]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
<tr> | <tr> | ||
| − | <th>Field</th> | + | <th>Field name</th> |
<th>Value</th> | <th>Value</th> | ||
<th>Description</th> | <th>Description</th> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
| − | <td>Turns the OpenVPN instance | + | <td>Turns the OpenVPN instance ON or OFF.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>TUN/TAP</td> | <td>TUN/TAP</td> | ||
| − | <td>TUN (tunnel) | TAP (bridged); | + | <td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td> |
| − | <td>Virtual network device type. | + | <td>Virtual network device type. |
<ul> | <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>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally 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> | + | <li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required.</li> |
</ul> | </ul> | ||
</td> | </td> | ||
| Line 60: | Line 49: | ||
<tr> | <tr> | ||
<td>Protocol</td> | <td>Protocol</td> | ||
| − | <td>UDP | TCP; | + | <td>UDP | TCP; Default: <b>UDP</b></td> |
| − | <td>Transfer protocol used for the | + | <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 | + | <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, | + | <li><b>User Datagram Protocol</b> (<b>UDP</b>) - packets are sent to the recipient without error-checking or back-and-forth quality control, meaning that when packets are lost, they are gone forever. This makes it less reliable but faster than TCP; therefore, it should be used when transfer speed is crucial (for example, video streaming, live calls).</li> |
</ul> | </ul> | ||
</td> | </td> | ||
| Line 70: | Line 59: | ||
<tr> | <tr> | ||
<td>Port</td> | <td>Port</td> | ||
| − | <td>integer [0..65535]; | + | <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. | + | <td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>LZO</td> | <td>LZO</td> | ||
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
| − | <td> | + | <td>Enables LZO data compression.</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 in packet encryption.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Authentication</td> | <td>Authentication</td> | ||
| − | <td>TLS | Static Key | Password | TLS/Password; | + | <td>TLS | Static Key | Password | TLS/Password; Default: <b>TLS</b></td> |
<td>Authentication mode, used to secure data sessions. | <td>Authentication mode, used to secure data sessions. | ||
<ul> | <ul> | ||
| Line 95: | Line 89: | ||
</ul> | </ul> | ||
</td> | </td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS:</span> TLS cipher</td> | <td><span style="color: red;">TLS:</span> TLS cipher</td> | ||
| − | <td>All | DHE+RSA | Custom; | + | <td>All | DHE+RSA | Custom; Default: <b>All</b></td> |
<td>Packet encryption algorithm cipher.</td> | <td>Packet encryption algorithm cipher.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Remote host / IP address</td> | |
| − | + | <td>ip; Default: <b>none</b></td> | |
| − | |||
| − | |||
| − | |||
| − | <td>Remote host/IP address</td> | ||
| − | <td>ip; | ||
<td>IP address or hostname of an OpenVPN server.</td> | <td>IP address or hostname of an OpenVPN server.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Resolve retry</td> | <td>Resolve retry</td> | ||
| − | <td>integer | infinite; | + | <td>integer | infinite; Default: <b>infinite</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>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> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Keep alive</td> | <td>Keep alive</td> | ||
| − | <td>two integers separated by a space; | + | <td>two integers separated by a space; Default: <b>none</b></td> |
| − | <td>Defines two time intervals: | + | <td>Defines two time intervals: one is used to periodically send ICMP request to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</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> Local tunnel endpoint IP</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
| − | <td>IP address of the local | + | <td>OpenVPN IP address of the local network interface.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<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; | + | <td>ip; Default: <b>none</b></td> |
| − | <td>IP address of the remote | + | <td>OpenVPN IP address of the remote network (server) interface.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Remote network IP address</td> | <td>Remote network IP address</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
| − | <td>LAN IP address of the remote network ( | + | <td>LAN IP address of the remote network (client).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Remote network IP netmask</td> | <td>Remote network IP netmask</td> | ||
| − | <td>netmask; | + | <td>netmask; Default: <b>none</b></td> |
| − | <td>LAN IP subnet mask of the remote network ( | + | <td>LAN IP subnet mask of the remote network (client).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: #0054a6;">Password:</span> User name</td> | <td><span style="color: #0054a6;">Password:</span> User name</td> | ||
| − | <td>string; | + | <td>string; Default: <b>none</b></td> |
| − | <td> | + | <td>User name used for authentication to the OpenVPN server.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: #0054a6;">Password:</span> Password</td> | <td><span style="color: #0054a6;">Password:</span> Password</td> | ||
| − | <td>string; | + | <td>string; Default: <b>none</b></td> |
| − | <td>Password used for authentication to the OpenVPN server.</td> | + | <td>Password name used for authentication to the OpenVPN server.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Extra options</td> | <td>Extra options</td> | ||
| − | <td>string; | + | <td>string; Default: <b>none</b></td> |
| − | <td>Extra | + | <td>Extra options to be used by the OpenVPN instance.</td> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">Password:</span> HMAC authentication algorithm</td> | ||
| − | <td>none | SHA1 | SHA256 | SHA384 | SHA512; | + | <td>none | 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: #0054a6;">Password:</span> Additional HMAC authentication</td> | ||
| − | <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> | ||
<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: #0054a6;">Password:</span> HMAC authentication key</td> | ||
| − | <td>.key file; | + | <td>.key file; Default: <b>none</b></td> |
<td>Uploads an HMAC authentication key file.</td> | <td>Uploads an HMAC authentication key 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: #0054a6;">Password:</span> HMAC key direction</td> | ||
| − | <td>0 | 1 | none; | + | <td>0 | 1 | none; Default: <b>1</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>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> | ||
</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: #0054a6;">Password:</span> Certificate authority</td> | ||
| − | <td>.ca file; | + | <td>.ca file; Default: <b>none</b></td> |
| − | <td>Certificate authority | + | <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> | ||
<td><span style="color: red;">TLS:</span> Client certificate</td> | <td><span style="color: red;">TLS:</span> Client certificate</td> | ||
| − | <td>.crt file; | + | <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>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> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS:</span> Client key</td> | <td><span style="color: red;">TLS:</span> Client key</td> | ||
| − | <td>.key file; | + | <td>.key file; Default: <b>none</b></td> |
<td>Authenticates the client to the server and establishes precisely who they are.</td> | <td>Authenticates the client to the server and establishes precisely who they are.</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> Private key decryption password (optional)</td> | ||
| − | <td>string; | + | <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>A password used to decrypt the server's private key. Use only if server's .key file is encrypted with a password.</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; | + | <td>.key file; Default: <b>none</b></td> |
<td>Uploads a secret key file used for server–client authentication.</td> | <td>Uploads a secret key file used for server–client authentication.</td> | ||
</tr> | </tr> | ||
| Line 225: | Line 194: | ||
<b>Additional notes</b>: | <b>Additional notes</b>: | ||
<ul> | <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 | + | <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 praefixa: |
<ul> | <ul> | ||
<li>Red for <span style="color: red;">Authentication: TLS</span></li> | <li>Red for <span style="color: red;">Authentication: TLS</span></li> | ||
| Line 232: | Line 201: | ||
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li>After changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom- | + | <li>After changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li> |
</ul> | </ul> | ||
===OpenVPN server=== | ===OpenVPN server=== | ||
---- | ---- | ||
| − | An <b>OpenVPN server</b> is an entity that waits for incoming connections from OpenVPN clients. To create a new server instance, go to the | + | 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 Services → VPN → OpenVPN section, select <i>Role: Server</i>, enter a custom name and click "Add New". 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 [[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 | + | 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}}} | + | [[File:{{{file_openvpn_server_config}}}]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
<tr> | <tr> | ||
| − | <th>Field</th> | + | <th>Field name</th> |
<th>Value</th> | <th>Value</th> | ||
<th>Description</th> | <th>Description</th> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
| − | <td>Turns the OpenVPN instance | + | <td>Turns the OpenVPN instance ON or OFF.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>TUN/TAP</td> | <td>TUN/TAP</td> | ||
| − | <td>TUN (tunnel) | TAP (bridged); | + | <td>TUN (tunnel) | TAP (bridged); Default: <b>TUN (tunnel)</b></td> |
<td>Virtual network device type. | <td>Virtual network device type. | ||
<ul> | <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>TUN</b> - a virtual point-to-point IP link which operates at the network layer (OSI layer 3), generally 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> | + | <li><b>TAP</b> - a virtual Ethernet adapter (switch), operates at the data link layer (OSI layer 2), generally used when bridging is required.</li> |
</ul> | </ul> | ||
</td> | </td> | ||
| Line 273: | Line 237: | ||
<tr> | <tr> | ||
<td>Protocol</td> | <td>Protocol</td> | ||
| − | <td>UDP | TCP; | + | <td>UDP | TCP; Default: <b>UDP</b></td> |
<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 | + | <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 283: | Line 247: | ||
<tr> | <tr> | ||
<td>Port</td> | <td>Port</td> | ||
| − | <td>integer [0..65535]; | + | <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. | + | <td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>LZO</td> | <td>LZO</td> | ||
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
| − | <td> | + | <td>Enables LZO data compression.</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> | ||
<td>Authentication</td> | <td>Authentication</td> | ||
| − | <td>TLS | Static Key | TLS/Password; | + | <td>TLS | Static Key | TLS/Password; Default: <b>TLS</b></td> |
<td>Authentication mode, used to secure data sessions. | <td>Authentication mode, used to secure data sessions. | ||
<ul> | <ul> | ||
| Line 307: | Line 276: | ||
</ul> | </ul> | ||
</td> | </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> Local tunnel endpoint IP</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
| − | <td>IP address of the local | + | <td>OpenVPN IP address of the local network interface.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<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; | + | <td>ip; Default: <b>none</b></td> |
| − | <td>IP address of the remote | + | <td>OpenVPN IP address of the remote network (server) interface.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: purple;">Static key:</span> Remote network IP address</td> | <td><span style="color: purple;">Static key:</span> Remote network IP address</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>LAN IP address of the remote network (client).</td> | <td>LAN IP address of the remote network (client).</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: purple;">Static key:</span> Remote network IP netmask</td> | <td><span style="color: purple;">Static key:</span> Remote network IP netmask</td> | ||
| − | <td>netmask; | + | <td>netmask; Default: <b>none</b></td> |
<td>LAN IP subnet mask of the remote network (client).</td> | <td>LAN IP subnet mask of the remote network (client).</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> TLS cipher</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> TLS cipher</td> | ||
| − | <td>All | DHE+RSA | Custom; | + | <td>All | DHE+RSA | Custom; Default: <b>All</b></td> |
<td>Packet encryption algorithm cipher.</td> | <td>Packet encryption algorithm cipher.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Client to client</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Client to client</td> | ||
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
<td>Allows OpenVPN clients to communicate with each other on the VPN network.</td> | <td>Allows OpenVPN clients to communicate with each other on the VPN network.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Keep alive</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Keep alive</td> | ||
| − | <td>two integers separated by a space; | + | <td>two integers separated by a space; Default: <b>none</b></td> |
| − | <td>Defines two time intervals: | + | <td>Defines two time intervals: one is used to periodically send ICMP request by the client to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice.<br>Example: 10 120</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> | + | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network IP address</td> |
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>IP address of the OpenVPN network.</td> | <td>IP address of the OpenVPN network.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> | + | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Vitual network netmask</td> |
| − | <td>netmask; | + | <td>netmask; Default: <b>none</b></td> |
<td>Subnet mask of the OpenVPN network.</td> | <td>Subnet mask of the OpenVPN network.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Push option</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Push option</td> | ||
| − | <td>OpenVPN options; | + | <td>OpenVPN options; Default: <b>none</b></td> |
<td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients.</td> | <td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients.</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: #0054a6;">TLS/Password:</span> Allow duplicate certificates</td> | ||
| − | <td>yes | no; | + | <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> | ||
<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; | + | <td>string; Default: <b>none</b></td> |
| − | <td> | + | <td>User name 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; | + | <td>string; Default: <b>none</b></td> |
| − | <td>Password used for authentication to | + | <td>Password name used for authentication to the OpenVPN server.</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; | + | <td>.key file; Default: <b>none</b></td> |
<td>Uploads a secret key file used for server–client authentication.</td> | <td>Uploads a secret key file used for server–client authentication.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Certificate authority</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Certificate authority</td> | ||
| − | <td>.ca file; | + | <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>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> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server certificate</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server certificate</td> | ||
| − | <td>.crt file; | + | <td>.crt file; Default: <b>none</b></td> |
<td>A type of digital certificate that is used to identify the OpenVPN server.</td> | <td>A type of digital certificate that is used to identify the OpenVPN server.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server key</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Server key</td> | ||
| − | <td>.key file; | + | <td>.key file; Default: <b>none</b></td> |
<td>Authenticates clients to the server.</td> | <td>Authenticates clients to the server.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Diffie Hellman parameters</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> Diffie Hellman parameters</td> | ||
| − | <td>.pem file; | + | <td>.pem file; Default: <b>none</b></td> |
<td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange.</td> | <td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> CRL file (optional)</td> | <td><span style="color: red;">TLS</span>/<span style="color: #0054a6;">TLS/Password:</span> CRL file (optional)</td> | ||
| − | <td>.pem file | .crl file; | + | <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 | + | <td>A certificate revocation list (CRL) file is a list of certificates that have been revoked the 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> | ||
</table> | </table> | ||
| Line 437: | Line 376: | ||
<b>Additional notes</b>: | <b>Additional notes</b>: | ||
<ul> | <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 | + | <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 praefixa: |
<ul> | <ul> | ||
<li>Red for <span style="color: red;">Authentication: TLS</span></li> | <li>Red for <span style="color: red;">Authentication: TLS</span></li> | ||
| Line 444: | Line 383: | ||
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li>After changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom- | + | <li>After changing any of the parameters, don't forget to click the <b>Save</b> button located at the bottom-left of the page.</li> |
</ul> | </ul> | ||
| Line 451: | Line 390: | ||
<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. | <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 | + | 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 press the "Add" button. Refer to the figure and table below for information on the TLS Clients' configuration fields: |
| − | [[File:{{{file_openvpn_tls_clients_config}}} | + | [[File:{{{file_openvpn_tls_clients_config}}}]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
<tr> | <tr> | ||
| − | <th>Field</th> | + | <th>Field name</th> |
<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>With what VPN instance should the TLS Client be associated with. When left empty, this field filled automatically.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Endpoint name</td> | <td>Endpoint name</td> | ||
| − | <td>string; | + | <td>string; Default: <b>none</b></td> |
<td>A custom name for the client.</td> | <td>A custom name for the client.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Common name (CN)</td> | <td>Common name (CN)</td> | ||
| − | <td>string; | + | <td>string; Default: <b>none</b></td> |
<td>Client’s Common Name (CN) found in the client certificate file.</td> | <td>Client’s Common Name (CN) found in the client certificate file.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Virtual local endpoint</td> | <td>Virtual local endpoint</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>Client’s local address in the virtual network.</td> | <td>Client’s local address in the virtual network.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Virtual remote endpoint</td> | <td>Virtual remote endpoint</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>Client’s remote address in the virtual network.</td> | <td>Client’s remote address in the virtual network.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Private network</td> | <td>Private network</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>Client’s private network (LAN) IP address.</td> | <td>Client’s private network (LAN) IP address.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Private netmask</td> | <td>Private netmask</td> | ||
| − | <td>ip; | + | <td>ip; Default: <b>none</b></td> |
<td>Client’s private network (LAN) IP netmask.</td> | <td>Client’s private network (LAN) IP netmask.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | ==IPsec== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ===IPsec configuration=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | = | ||
| − | |||
| − | |||
| − | |||
| − | |||
---- | ---- | ||
| − | |||
| − | + | [[File:{{{file_ipsec_config}}}]] | |
| − | |||
| − | [[File:{{{ | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
<tr> | <tr> | ||
| − | <th>Field</th> | + | <th>Field name</th> |
<th>Value</th> | <th>Value</th> | ||
<th>Description</th> | <th>Description</th> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Enable</td> | |
| − | + | <td>yes | no; Default: <b>no</b></td> | |
| − | + | <td>Turns the IPsec instance ON or OFF.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>IKE version</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> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Mode</td> |
| − | <td> | + | <td>Main | Aggressive; Default: <b>Main</b></td> |
| − | <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> | + | <td>Type</td> |
| − | <td> | + | <td>Tunnel | Transport; Default: <b>Tunnel</b></td> |
| − | <td>IP | + | <td>Type of connection. |
| + | <ul> | ||
| + | <li><b>Tunnel</b> - protects internal routing information by encapsulating the entire IP packet (IP header and payload); is commonly used in site-to-site VPN connections; supports NAT traversal.</li> | ||
| + | <li><b>Transport</b> - only encapsulates IP payload data; is use 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>My identifier type</td> | |
| − | + | <td>FQDN | User FQDN | Address; Default: <b>FQDN</b></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, something.somedomain.com). Only supported with IKEv2.</li> | |
| − | + | <li><b>User FQDN</b> - identity defined by fully qualified username string (for example, <i>[email protected]</i>). Only supported with IKEv2.</li> | |
| − | + | <li><b>Address</b> - identity by IP address.</li> | |
| − | + | </ul> | |
| − | + | </td> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>On startup</td> | |
| − | + | <td>Ignore | Add | Route | Start; Default: <b>Start</b></td> | |
| − | + | <td></td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>My identifier</td> | |
| − | + | <td>ip | string; Default: <b>none</b></td> | |
| − | + | <td>Defines how the user (IPsec instance) will be identified during authentication.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td><span style="color: red;">Tunnel:</span> Local IP address/Subnet mask</td> |
| − | <td>ip | + | <td>ip/netmask | Default: <b>none</b></td> |
| − | <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> | + | <td>Left firewall</td> |
| − | <td> | + | <td>yes | no; Default: <b>yes</b></td> |
| − | <td> | + | <td>Excludes IPsec instance from firewall rules.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Force encapsulation</td> | |
| − | + | <td>yes | no; Default: <b>no</b></td> | |
| − | + | <td>Forces UDP encapsulation for ESP packets even if no NAT situation is detected.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Dead Peer Detection</td> | |
| − | + | <td>yes | no; Default: <b>no</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> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | used | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td><span style="color: #0054a6;">Dead Peer Detection:</span> Delay (sec)</td> | |
| − | + | <td>integer; Default: <b>none</b></td> | |
| − | + | <td>The frequency of checking whether a peer is still availaible or not.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td><span style="color: #0054a6;">Dead Peer Detection:</span> Timeout (sec)</td> | |
| − | + | <td>integer; Default: <b>none</b></td> | |
| − | + | <td>Time limit after 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> | + | <td>Remote VPN endpoint</td> |
| − | <td> | + | <td>host | ip; Default: <b>none</b></td> |
| − | <td> | + | <td>IP address or hostname of the remote IPsec instance.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td><span style="color: red;">Tunnel:</span> Remote IP address/subnet mask</td> | |
| − | + | <td>ip/netmask; 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 values must differ from the device’s LAN IP.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Right firewall</td> | |
| − | + | <td>yes | no; Default: <b>yes</b></td> | |
| − | + | <td>Excludes remote side IPsec instance from firewall rules.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td><span style="color: purple;">Transport:</span> Use with DMVPN</td> | |
| − | + | <td>yes | no; Default: <b>no</b></td> | |
| − | + | <td>Adds several necessary options to make DMVPN work.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Enable keepalive</td> |
| − | <td>yes | no; | + | <td>yes | no; Default: <b>no</b></td> |
| − | <td>When | + | <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>Host</td> | |
| − | < | + | <td>host | ip; Default: <b>none</b></td> |
| − | < | + | <td>Hostname or IP address to which keepalive ICMP packets will be sent to.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Ping period (sec)</td> | |
| − | + | <td>integer [0..9999999]; Default: <b>none</b></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>Allow WebUI access</td> | |
| − | + | <td>yes | no; Default: <b>no</b></td> | |
| − | + | <td>Allows WebUI access for hosts in the VPN network.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>Custom options</td> | |
| − | + | <td>ipsec options; Default: <b>none</b></td> | |
| − | + | <td>Provides the possibility to further customize the connection by adding extra IPsec options.</td> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
</table> | </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 praefixa: | ||
| + | <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-left of the page.</li> | ||
| + | </ul> | ||
| − | + | ====Phase settings==== | |
| − | |||
| − | === | ||
---- | ---- | ||
| − | |||
| − | + | [[File:{{{file_ipsec_phase}}}]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ===Pre-shared keys=== | |
| − | + | ---- | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[ | + | [[File:{{{file_ipsec_psk}}}]] |
Revision as of 15:04, 15 May 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 regarding 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.
For more in-depth guides refer to our OpenVPN configuration examples page.
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 "Add New". 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 name | 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.
|
| Protocol | UDP | TCP; Default: UDP | Transfer protocol used for the connection.
|
| 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. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router. |
| LZO | yes | no; Default: no | Enables LZO data compression. |
| 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 in packet encryption. |
| Authentication | TLS | Static Key | Password | TLS/Password; Default: TLS | Authentication mode, used to secure data sessions.
|
| TLS: TLS cipher | All | DHE+RSA | Custom; Default: All | Packet encryption algorithm cipher. |
| 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: one is used to periodically send ICMP request to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice. Example: 10 120 |
| Static key: Local tunnel endpoint IP | ip; Default: none | OpenVPN IP address of the local network interface. |
| Static key: Remote tunnel endpoint IP | ip; Default: none | OpenVPN IP address of the remote network (server) interface. |
| Remote network IP address | ip; Default: none | LAN IP address of the remote network (client). |
| Remote network IP netmask | netmask; Default: none | LAN IP subnet mask of the remote network (client). |
| Password: User name | string; Default: none | User name used for authentication to the OpenVPN server. |
| Password: Password | string; Default: none | Password name used for authentication to the OpenVPN server. |
| Extra options | string; Default: none | Extra 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 praefixa:
- 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-left 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 "Add New". 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 name | 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.
|
| Protocol | UDP | TCP; Default: UDP | Transfer protocol used for the connection.
|
| 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. When you enable the OpenVPN instance, a firewall rule allowing traffic on the selected port is automatically generated on the router. |
| LZO | yes | no; Default: no | Enables LZO data compression. |
| 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: Local tunnel endpoint IP | ip; Default: none | OpenVPN IP address of the local network interface. |
| Static key: Remote tunnel endpoint IP | ip; Default: none | OpenVPN IP address of the remote network (server) 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/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: one is used to periodically send ICMP request by the client to the OpenVPN server, the other defines a time window, which is used to restart the OpenVPN service, if no ICMP response is received during the window time slice. Example: 10 120 |
| TLS/TLS/Password: Vitual network IP address | ip; Default: none | IP address of the OpenVPN network. |
| TLS/TLS/Password: Vitual 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 | User name used for authentication to the OpenVPN server. |
| TLS/Password: Password | string; Default: none | Password name 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 the 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 praefixa:
- 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-left 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 press 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 name | Value | Description |
|---|---|---|
| VPN instance name | string; Default: none | With what VPN instance should the TLS Client be associated with. When left empty, this field 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
IPsec configuration
[[File:{{{file_ipsec_config}}}]]
| Field name | 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.
|
| Mode | Main | Aggressive; Default: Main | Internet Security and Key Management Protocol (ISAKMP) phase 1 exchange mode.
|
| Type | Tunnel | Transport; Default: Tunnel | Type of connection.
|
| My identifier type | FQDN | User FQDN | Address; Default: FQDN | Defines the type of identity used in user (IPsec instance) authentication.
|
| On startup | Ignore | Add | Route | Start; Default: Start | |
| 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 | yes | no; Default: yes | Excludes IPsec instance from firewall rules. |
| Force encapsulation | yes | no; Default: no | Forces UDP encapsulation for ESP packets even if 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 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 values must differ from the device’s LAN IP. |
| Right firewall | yes | no; Default: yes | Excludes remote side IPsec instance from firewall rules. |
| 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 praefixa:
- 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-left of the page.
Phase settings
[[File:{{{file_ipsec_phase}}}]]
[[File:{{{file_ipsec_psk}}}]]
