RUT200 VPN

Wiki mirrorView source
The information in this page is updated in accordance with firmware version RUT2M_R_00.07.22.1.

Summary

Virtual Private Network (VPN) is a method of connecting multiple private networks across the Internet. VPNs can serve to achieve many different goals, but some of its main purposes are:
  • access between remote private networks;
  • data encryption;
  • anonymity when browsing the Internet.
This page is an overview of the different types of VPNs supported by RUT200 devices.

OpenVPN

OpenVPN is an open-source software application that implements virtual private network (VPN) techniques for creating secure point-to-point or site-to-site connections in routed or bridged configurations and remote access facilities. It is often regarded as being the most universal VPN protocol because of its flexibility, support of SSL/TLS security, multiple encryption methods, many networking features and compatibility with most OS platforms.
Note: OpenVPN DCO kernel module moved to package manager on some devices. Please visit System → Package Manager page.

OpenVPN Client

An OpenVPN client is an entity that initiates a connection to an OpenVPN server.
Client statusValueDescription
Export-(interactive button)Exports the instance configuration to .ovpn file.
Edit-(interactive button)Opens the instance configuration window.
Delete-(interactive button)Removes an instance.
To begin configuration, click 'Add' button, select Role: Client. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
General sectionValueDescription
Enable configurationoff | on; default: offEnable current configuration.
RoleClient | Server; default: ClientChoose a role for OpenVPN isntance.
Namestring; default: instance1Name of the OpenVPN instance.
Configuration typeManual | Upload config file | External services; default: ManualChoose configuration type.
VPN providersExpress VPN | Nord VPN; default: Nord VPNRepresents a list of available VPN providers.
VPN serversUnited Kingdom | USA | Australia | South Africa | Custom; default: United KingdomRepresents a list of available VPN servers.
Usernamestring; default: noneUsername used for authentication to the VPN server.
Passwordstring; default: nonePassword used for authentication to the VPN server.
Enable parsingoff | on; default: offBy enabling parsing, you can modify the configuration in the future.
OpenVPN configuration file-(interactive button)Upload OpenVPN configuration. Warning! This will overwrite your current configuration.
AuthenticationTLS | TLS/Password | Password | Static key; default: TLSChoose a method to authenticate your OpenVPN network.
TUN/TAPTUN (tunnel) | TAP (bridged); default: TUN (tunnel)Virtual VPN interface type.
TopologyNET30 | P2P | SUBNET (not shown with Static key); default: NET30Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.
ProtocolUDP | TCP | UDP4 | TCP4 | UDP6 | TCP6; default: UDPThe transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.
Portinteger [0..65535]; default: 1194TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.
Extra optionsstring; default: noneEnter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.
Network sectionValueDescription
Static key: Local tunnel endpoint IPip; default: noneIP address of the virtual local network interface.
Static key: Remote tunnel endpoint IPip; default: noneIP address of the virtual remote network interface.
Remote host/IP addressip; default: noneIP address or domain name of the OpenVPN server.
Remote networkip4; default: noneIP address of the remote LAN.
TAP (bridged): Bridgelan | none; default: lanAssign a TAP interface to a bridge..
Static key: Local tunnel endpoint IPv6ip; default: noneIPv6 address of the virtual local network interface.
Static key: Remote tunnel endpoint IPv6ip; default: noneIPv6 address of the virtual remote network interface.
LZONone | Adaptive | Yes | No; default: NoneUse fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.
Resolve retryinteger | infinite; default: infiniteTry to resolve the server hostname for X seconds before giving up.
Keep alivetwo integers separated by a space; default: noneTry to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.
Security sectionValueDescription
TLS/Password/Password: User namestring; default: noneVPN client username.
TLS/Password/Password: Passwordstring; default: noneVPN client password.
EncryptionDES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-64CBC 64 | AES-128-CBC 128 | AES-128-CFB 128 | AES-128-CFB1 128 | AES-128-CFB8 128 | AES-128-OFB 128 | AES-128-GCM 128 | AES-192-CBC 192 | AES-192-CFB 192 | AES-192-CFB1 192 | AES-192-CFB8 192 | AES-192-OFB 192 | AES-192-GCM 192 | AES-256-CBC 256 | AES-256-CFB 256 | AES-256-CFB1 256 | AES-256-CFB8 256 | AES-256-OFB 256 | AES-256-GCM 256 | none; default: AES-256-CBC 256Packet encryption algorithm (cipher).
Data ciphersdepends on authentication; default: AES-256-CBCSelect allowed data ciphers from the list; add a custom value if needed.
Authentication algorithmnone | MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1HMAC authentication algorithm type.
TLS/TLS/Password/Password:Additional HMAC authenticationNone | Authentication only (tls-auth) | Authentication only (tls-auth); default: NoneAdd an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.
TLS/TLS/Password/Password: HMAC key direction0 | 1; default: 1The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).
Certificates sectionValueDescription
TLS/TLS/Password/Password:Use PKCS #12 formatoff | on; default: offUse PKCS #12 archive file format to bundle all the members of a chain of trust.
TLS/TLS/Password/Password: PKCS #12 certificate chain-(interactive button)Uploads a PKCS #12 certificate chain file.
TLS/TLS/Password/Password: PKCS #12 passphrasestring; default: nonePassphrase to decrypt PKCS #12 certificates.
TLS/TLS/Password/Password: Certificate files from deviceoff | on; default: offChoose this option if you want to select certificate files from the device.
TLS/TLS/Password/Password: Store client key in TPMoff | on; default: onWhen enabled, key will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
TLS/TLS/Password/Password: Certificate authority.ca file; default: noneThe digital certificate verifies the ownership of a public key by the named subject of the certificate.
TLS/TLS/Password: Client certificate.crt file; default: noneIdentify a client or a user, authenticating the client to the server and establishing precisely who they are.
TLS/TLS/Password: Client key.key file; default: noneIt has been generated for the same purpose as a client certificate.
TLS/TLS/Password: Private key decryption password (optional)string; default: noneDecrypt private key with password (Optional).
Static key: Static pre-shared key.key file; default: noneA pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Red for Authentication: TLS
    • Olive for Authentication: TLS/Password
    • Purple for Authentication: Static key
    • Blue for Authentication: Password
    • Brown for OpenVPN config from file
  • After changing any of the parameters, don't forget to click the Save & Apply button located at the bottom-right side of the page.

OpenVPN Server

An OpenVPN server is an entity that waits for incoming connections from OpenVPN clients. Only one OpenVPN server instance is allowed to be added.
A server needs to have a public IP address in order to be available from the public network (the Internet).
Server statusValueDescription
Export-(interactive button)Exports the instance configuration to .ovpn file.
Generate client configuration*-(interactive button)Redirects to "Generate client configuration" window.
Edit-(interactive button)Opens the instance configuration window.
Delete-(interactive button)Removes an instance.
*Generate client configuration window:
Server statusValueDescription
Remote host/IP addressIPIP address or domain name of the OpenVPN server.
Client certificate.crt fileThe certificate will be added to the generated client configuration file.
Client key.key fileThe private key will be added to the generated client configuration file.
Download-(interactive button)Downloads the client configuration to .ovpn file.

To begin configuration, click 'Add' button, select Role: Server. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
General sectionValueDescription
Enable configurationoff | on; default: offEnable current configuration.
RoleClient | Server; default: ServerChoose a role for OpenVPN isntance.
Namestring; default: instance1Name of the OpenVPN instance.
Configuration typeManual | Upload config file; default: ManualChoose configuration type.
Enable parsingoff | on; default: offBy enabling parsing, you can modify the configuration in the future.
OpenVPN configuration file-(interactive button)Upload OpenVPN configuration. Warning! This will overwrite your current configuration.
AuthenticationTLS | TLS/Password | Password | Static key; default: TLSChoose a method to authenticate your OpenVPN network.
TUN/TAPTUN (tunnel) | TAP (bridged); default: TUN (tunnel)Virtual VPN interface type.
TopologyNET30 | P2P | SUBNET (not shown with Static key); default: NET30Virtual addressing topology determines how IP addressing and routing are handled between the server and clients.
ProtocolUDP | TCP | UDP4 | TCP4 | UDP6 | TCP6; default: UDPThe transport protocol used for the connection. Note: UDP and TCP do not support IPv6 connections, use UDP6 or TCP6 instead.
Portinteger [0..65535]; default: 1194TCP/UDP port for both local and remote endpoints. Make sure that this port is open in the firewall.
Push option (not shown with Static key)string; default: nonePush a configuration option back to the client for remote execution.
Extra optionsstring; default: noneEnter any additional options to be added to the OpenVPN configuration. If an option is already in use, the new option will take precedence.
Network sectionValueDescription
TLS/TLS/Password/Password: Virtual network IP addressip4; default: noneIP address used for the virtual network.
TLS/TLS/Password/Password: Virtual network netmasknetmask; default: noneSubnet mask used for the virtual network.
Static key: Local tunnel endpoint IPip; default: noneIP address of the virtual local network interface.
Static key: Remote tunnel endpoint IPip; default: noneIP address of the virtual remote network interface.
TLS/TLS/Password/Password: Assign IP startIP; default: noneAssign IP addresses starting from a pool of subnets to be dynamically allocated to connecting clients.
TLS/TLS/Password/Password: Assign IP endIP; default: noneAssign IP addresses ending at a pool of subnets to be dynamically allocated to connecting clients.
TLS/TLS/Password/Password: Virtual network IPv6 addressip6; default: noneIPv6 address used for the virtual network.
TLS/TLS/Password/Password: Assign IPv6 addressip6; default: noneSpecify an IPv6 address pool for dynamic assignment to clients.
Static key: Local tunnel endpoint IPv6ip; default: noneIPv6 address of the virtual local network interface.
Static key: Remote tunnel endpoint IPv6ip; default: noneIPv6 address of the virtual remote network interface.
TAP (bridged): Bridgelan interface | none; default: lanAssign a TAP interface to a bridge.
TAP (bridged): Gateway IP addressIPv4; default: noneIP address and netmask of the bridge interface on the VPN server. This address is assigned to the TAP interface and advertised to VPN clients as their gateway.
LZONone | Adaptive | Yes | No; default: NoneUse fast LZO compression. With LZO compression, your VPN connection will generate less network traffic.
Client to clientoff | on; default: offAllow client-to-client traffic.
Resolve retryinteger | infinite; default: infiniteTry to resolve the server hostname for X seconds before giving up.
Keep alivetwo integers separated by a space; default: noneTry to keep the connection alive. Two values are required: ping_interval and ping_restart, e.g., 10 120.
Security sectionValueDescription
TLS/Password/Password: Usernames & Passwords-(interactive button)File containing usernames and passwords against which the server can authenticate clients. Each username and password pair should be placed on a single line and separated by a space.
EncryptionDES-CBC 64 | RC2-CBC 128 | DES-EDE-CBC 128 | DES-EDE3-CBC 192 | DESX-CBC 192 | BF-CBC 128 | RC2-40-CBC 40 | CAST5-CBC 128 | RC2-64CBC 64 | AES-128-CBC 128 | AES-128-CFB 128 | AES-128-CFB1 128 | AES-128-CFB8 128 | AES-128-OFB 128 | AES-128-GCM 128 | AES-192-CBC 192 | AES-192-CFB 192 | AES-192-CFB1 192 | AES-192-CFB8 192 | AES-192-OFB 192 | AES-192-GCM 192 | AES-256-CBC 256 | AES-256-CFB 256 | AES-256-CFB1 256 | AES-256-CFB8 256 | AES-256-OFB 256 | AES-256-GCM 256 | none; default: AES-256-CBC 256Packet encryption algorithm (cipher).
Data ciphersdepends on authentication; default: AES-256-CBCSelect allowed data ciphers from the list; add a custom value if needed.
TLS/TLS/Password/Password: Allow duplicate certificatesoff | on; default: offAll clients can have the same certificates.
Authentication algorithmnone | MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1HMAC authentication algorithm type.
TLS/TLS/Password/Password:Additional HMAC authenticationNone | Authentication only (tls-auth) | Authentication only (tls-auth); default: NoneAdd an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.
TLS/TLS/Password/Password: HMAC key direction0 | 1; default: 1The HMAC authentication key direction value is arbitrary and must be opposite between communicating parties (or omitted entirely).
Certificates sectionValueDescription
TLS/TLS/Password/Password:Use PKCS #12 formatoff | on; default: offUse PKCS #12 archive file format to bundle all the members of a chain of trust.
TLS/TLS/Password/Password: PKCS #12 certificate chain-(interactive button)Uploads a PKCS #12 certificate chain file.
TLS/TLS/Password/Password: Certificate files from deviceoff | on; default: offChoose this option if you want to select certificate files from the device.
TLS/TLS/Password/Password: Store server key in TPMoff | on; default: onWhen enabled, key will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
TLS/TLS/Password/Password: Certificate authority.ca file; default: noneThe digital certificate verifies the ownership of a public key by the named subject of the certificate.
TLS/TLS/Password/Password: Server certificate.crt file; default: noneCertificate servers validate or certify keys as part of a public key infrastructure.
TLS/TLS/Password/Password: Server key.key file; default: noneIt has been generated for the same purpose as the server certificate.
TLS/TLS/Password/Password: Diffie Hellman parameters.pem file; default: noneDiffie-Hellman key exchange is a specific method of exchanging cryptographic keys.
TLS/TLS/Password/Password: CRL file (optional).pem file | .crl file; Default: noneRevoking a certificate means to invalidate a previously signed certificate so that it can no longer be used for authentication purposes. Upload a .pem revocation file.
TLS/TLS/Password/Password: PKCS #12 passphrasestring; default: nonePassphrase to decrypt PKCS #12 certificates.
TLS/TLS/Password/Password: Private key decryption password (optional)string; default: noneDecrypt private key with password (Optional).
Static key: Static pre-shared key-(interactive button)A pre-shared key (PSK) is a shared secret that was previously shared between two parties using some secure channel before it needs to be used.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Red for Authentication: TLS
    • Olive for Authentication: TLS/Passwords
    • Purple for Authentication: Static key
    • Blue for Authentication: Password
    • Brown for OpenVPN config from file
  • After changing any of the parameters, don't forget to click the Save & Apply button located at the bottom-right side of the page.

TLS Clients

TLS Clients is a way to differentiate clients by their Common Names (CN), which are found in the client certificate file. It can be used to assign specific VPN addresses to corresponding clients and bind them to their LAN addresses, making the server aware of which client has which LAN IP address.
The TLS Clients section can be found in the OpenVPN Server configuration window, provided that the OpenVPN server uses TLS or TLS/Password authentication methods. To create a new TLS client, type in the new client‘s name in the text field found bellow the TLS Clients tab and click the 'Add' button. Refer to the figure and table below for information on the TLS Clients' configuration fields:
FieldValueDescription
Common name (CN)string; default: noneClient certificate CN field (e.g.,s [email protected]).
Virtual local subnetIPv4 with subnet; default: noneIP address and subnet mask for the client's virtual local interface.
Virtual local endpointip; default: noneClient’s local address in the virtual network.
Virtual remote endpointip; default: noneClient’s remote address in the virtual network.
Local tunnel endpoint IPv6ip; default: noneIPv6 address of virtual local network interface.
Private network IPv6ip; default: noneClient’s private network (LAN) IPv6 address.
Private networkip; default: noneClient’s private network (LAN) IP address.
Covered Networknetwork(); default: noneSelects which networks should be made accessible to this client.

OpenVPN Server Brute-force Prevention

OpenVPN Servers with Authentication set to TLS/Password or Password, Protocol set to UDP and running on Port 1194 have a feature where after a client attempts to connect to the server 10 times with incorrect credentials (password and/or username) they are then blocked from the server.
To check which addresses are blocked one first needs to connect to their device's CLI.
After connecting to your device's CLI use the command ipset list and find the section named ipb_port. There under Members you should see all IP addresses that are blocked.
Name: ipb_port
Type: hash:ip,port
Revision: 5
Header: family inet hashsize 1024 maxelem 65536
Size in memory: 164
References: 2
Number of entries: 1
Members:
188.XXX.XXX.XXX,udp:1194
Another way to check blocked IP addresses is to use the command ubus call ip_block show. This will show all ip addresses that failed to connect to your device. If the counter atribute of the IP address entry is larger or equal then max_attempt_count then that IP address is blocked.
{
	"globals": {
		"max_attempt_count": 10
	},
	"ip_blockd 188.XXX.XXX.XXX": {
		"ip": "188.XXX.XXX.XXX",
		"port": "udp:1194",
		"counter": "1"
	},
	"ip_blockd 188.XXX.XXX.XXX": {
		"ip": "188.XXX.XXX.XXX",
		"port": "udp:1194",
		"counter": "10"
	}
}
To unblock a blocked client's IP address use the command ubus call ip_block unblock '{"ip":"<blocked_ip_address>","port":"udp:1194"} (replace <blocked_ip_address> inside the quotes with your blocked IP address). If the IP address was unblocked succesfully you should see a similar response:
{
	"unblocked": {
		"ip": "188.XXX.XXX.XXX",
		"port": "udp:1194"
	}
}

GRE

Generic Routing Encapsulation (GRE) is a tunneling protocol used to establish point-to-point connections between remote private networks. GRE tunnels encapsulate data packets in order to route other protocols over IP networks.

GRE: Main & Tunnel Settings

To create a new GRE instance, go to the Services → VPN → GRE section, enter a custom name and click the 'Add' button. A GRE instance with the given name will appear in the "GRE Configuration" list.
To begin configuration, click the button that looks like a pencil located next to the instance. Refer to the figure and table below for information on the fields located in the GRE instance configuration section.
FieldValueDescription
Enabledoff | on; default: offTurns the GRE instance on or off.
IPv6off | on; default: offUse IPv4 or IPv6 for the GRE tunnel.
Tunnel sourcenetwork interface; default: -Network interface used to establish the GRE Tunnel.
Remote endpoint IP addressipv4/ipv6; default: noneExternal IP address of another GRE instance used to establish the initial connection between peers.
MTUinteger; default: 1476Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.
Outbound keyinteger [0..4294967295]; default: noneKey for outgoing packets. This value should match the 'Inbound key' value set on the opposite GRE instance or both key values should be omitted on both sides.
Inbound keyinteger [0..4294967295]; default: noneKey for incoming packets. This value should match the 'Outbound key' value set on the opposite GRE instance or both key values should be omitted on both sides.
Path MTU Discoveryoff | on; default: offWhen unchecked, sets the nopmtudisc option for tunnel. Can not be used together with the TTL option.
TTLinteger [0..255]; default: 255Sets a custom TTL (Time to Live) value for encapsulated packets. TTL is a field in the IP packet header which is initially set by the sender and decreased by 1 on each hop. When it reaches 0 it is dropped and the last host to receive the packet sends an ICMP "Time Exceeded" message back to the source.
Keep aliveoff | on; default: offThe 'keep alive' feature sends packets to the remote instance in order to determine the health of the connection. If no response is received for [Keep alive retries] times, the device will mark the tunnel as DOWN.
Keep alive intervalinteger [1..255]; default: 20Frequency (in seconds) at which 'keep alive' packets are sent to the remote instance.
Keep alive retriesinteger [1..255]; default: 3Amount of keep alive packets to lose before marking tunnel as DOWN.
Local GRE interface IP addressipv4; default: noneIP address of the local GRE Tunnel network interface.
Local GRE interface netmasknetmask; default: noneSubnet mask of the local GRE Tunnel network interface.
Local GRE interface IPv6 addressipv6; default: noneIPv6 address of the local GRE Tunnel instance.

GRE: Routing Settings

Routing settings are used to configure routes to networks that are behind the device that hosts the opposite GRE instance. To add a new route, simply click the 'Add' button. For information on configuring the route refer to the figure and table below.
IPv4 routing settingsValueDescriptionIPv6 routing settingsValueDescription
Remote subnet IPv4 addressipv4; default: noneLAN IPv4 address of the device that hosts the remote GRE Tunnel instance.
Remote subnet netmasknetmask; default: noneSubnet mask of the network behind the device that hosts the remote GRE instance.
Actions-(interactive button)Removes configuration.
Remote subnet IPv6 addressipv6; default: noneLAN IPv6 address of the device that hosts the remote GRE Tunnel instance.
Actions-(interactive button)Removes configuration.

IPsec

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

IPsec Instance

The general settings section is used to configure the main IPsec parameters. Refer to the figure and table below for information on the configuration fields located in the general settings section.
FieldValueDescription
Enableoff | on; default: offTurns the IPsec instance on or off.
Remote endpointhost | ip; default: noneDomain names, ip addresses (with or without network mask), %any, %any4, %any6 values are accepted (e.g., 192.168.1.1 or example.com).
Key exchangeIKEv1 | IKEv2; default: IKEv1Internet 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).
Authentication methodPre-shared key | X.509 | EAP | PKCS#12; default: Pre-shared keySpecify authentication method. Choose between Pre-shared key and X.509 certificates.
PKCS#12: PKCS12 container-(interactive button)Upload PKCS12 container file.
PKCS#12: PKCS12 decryption passphrasestring; default: nonePassphrase to decrypt PKCS12 container.
Pre-shared key: Pre shared keystring; default: noneA shared password used for authentication between IPsec peers before a secure channel is established.
X.509: | EAP: Certificate files from deviceoff | on; default: offChoose this option if you want to select certificate files from device. Certificate files can be generated here
X.509: | EAP: Store keys in TPMoff | on; default: onWhen enabled, key will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support and works with IKEv2 (key exchange).
X.509: | EAP: KeyA private key file; default: noneA private key file.
X.509: | EAP: Key decryption passphraseA password for private key files; default: noneIf the private key file is encrypted, the passphrase must be defined.
X.509: | EAP: Local Certificate.der file; default: noneA local certificate file.
X.509: | EAP: CA Certificate.der file; default: noneA certificate authority file.
Local identifierip | string; default: noneDefines how the user (left participant) will be identified during authentication. Maximum length of value is 255.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Remote identifierip | string; default: noneDefines how the right participant will be identified during authentication. Maximum length of value is 255.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Multiple secretsoff | on; default: offEnable to show Global Secret Settings section for configuring multiple secrets.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Chocolate for Authentication method: Pre-shared key
    • Dark red for Authentication method: X.509/EAP
    • Blue for Authentication method: PKCS#12

Global Secrets Settings

This section is displayed when Multiple secrets is enabled in General settings. You can add new instances by pressing Add.
FieldValueDescription
ID Selector%any, IP or FQDN; default: noneEach secret can be preceded by a list of optional ID selectors. A selector is an IP address, a Fully Qualified Domain Name, user@FQDN or %any. When using IKEv1 use IP address. Maximum length of value is 255. NOTE: IKEv1 only supports IP address ID selector.
TypePSK | XAUTH | EAP | RSA | PKCS#12; default: PSKMake sure to turn on the "Enable XAUTH" option in connection settings, if you want to use XAUTH type secrets.
Secretstring; default: noneA shared password (or EAP key file) to authenticate between the peers. Minimum length is 5 symbols. All characters are allowed except `.
RSA | PKCS#12: SecretPrivate key file; default: noneA private key file.
RSA | PKCS#12: Key decryption passphraseA password for private key files; default: noneIf the private key file is encrypted, the passphrase must be defined.
Actions-(interactive button)Deletes global secret.

IPsec Instance: Connection Configuration

The connection settings section is used to configure the main parameters of an IPsec connection. Refer to the figure and table below for information on the configuration fields located in the connection settings section.

General Settings

FieldValueDescription
ModeStart | Add | Route; default: StartSpecifies which operation will be done automatically at IPSec startup.
TypeTunnel | Transport; default: TunnelType of connection.
  • Tunnel - protects internal routing information by encapsulating the entire IP packet (IP header and payload); commonly used in site-to-site VPN connections; supports NAT traversal.
  • Transport - only encapsulates IP payload data; used in client-to-site VPN connections; does not support NAT traversal; usually implemented with other tunneling protocols (for example, L2TP).
Tunnel: Default routeoff | on; default: offTurn on to route all traffic through IPSec tunnel.
Tunnel: Route based IPsecoff | on; default: offIPsec VPN tunnel created between two end points.
Tunnel: IP addressIP adress; default: noneAssign an IP address to XFRM interface.
Tunnel: MTUinteger [68..9200]; default: noneSets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.
Tunnel: Local subnetip/netmask | default: nonePrivate subnet behind the left (local) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.
Tunnel: Remote subnetip/netmask; default: nonePrivate subnet behind the right (remote) participant, expressed as network/netmask. IKEv2 supports multiple subnets, IKEv1 only interprets the first subnet.
Transport: Bind toGRE interface; L2TP interface; default: noneBind to GRE or L2TP interface to create GRE/L2TP over IPsec.
Enable XAuthon | off; default: offEnables Extended Authentication.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Red for Type: Tunnel
    • Purple for Type: Transport

Advanced settings

FieldValueDescription
Aggressiveoff | on; default: offTurn aggressive mode on or off for outgoing connections. Aggressive mode performs fewer exchanges (a total of 4 messages) than Main mode (a total of 6 messages) by storing most data into the first exchange. In aggressive mode, the information is exchanged before there is a secure channel, making it less secure but faster than main mode.
Aggressive mode is available only with IKEv1; if IKEv2 is selected this field becomes hidden.
Force encapsulationoff | on; default: offForces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.
Local firewalloff | on; default: onAdds necessary firewall rules to allow traffic of this IPsec instance on this device.
Remote firewalloff | on; default: offAdds necessary firewall rules to allow traffic of from the opposite IPsec instance on this device.
Compatibility modeoff | on; default: offTurns on compatibility mode to help deal with a 3rd party remote peer with multiple subnets.
Inactivityinteger; default: noneDefines timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.
Dead Peer Detectionoff | on; default: onA function used during Internet Key Exchange (IKE) to detect a "dead" peer. It used to reduce traffic by minimizing the number of messages when the opposite peer in unavailable and as failover mechanism.
Dead Peer Detection: DPD actionRestart | Hold | Clear | None; default: RestartControls the use of the Dead Peer Detection protocol where notification messages are periodically sent in order to check the liveliness of the IPsec peer.
Dead Peer Detection: DPD Delayinteger; default: noneThe frequency of sending R_U_THERE messages or INFORMATIONAL exchanges to peer.
Dead Peer Detection: DPD Timeoutinteger; default: noneDefines the timeout interval, after which all connections to a peer are deleted in case of inactivity.
XAuth identitystring; default: noneThe identity/username the client uses to reply to an XAuth request. If not defined, the IKEv1 identity will be used as XAuth identity.
Tunnel: Remote source IPip; default: noneThe internal source IP to use in a tunnel for the remote (right) peer.
Tunnel: Local source IPip; default: noneThe internal (left) source IP to use in a tunnel, also known as virtual IP.
Tunnel: Remote DNSip; default: noneList of DNS server addresses to exchange as configuration attributes. On the responder, only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned to the client.
Locally allowed protocolsstring; default: noneAllowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.
Remotely allowed protocolsstring; default: noneAllowed protocols and ports over connection, also called Port Selectors. Defines in form of 'protocol/port' eg:'17/1701' or '17/%any' or 'udp/l2f'.
Custom optionstring; default: noneSyntax option = value. Following characters are accepted: a-zA-Z0-9=/_.:{}%\s-
Tunnel: Passthrough interfacesnetwork interfaces; default: noneNetwork interfaces to include in IPsec Passthrough.
Tunnel: Local passthrough subnetsip/netmask; default: noneIPv4 or IPv6 address/subnet.
Tunnel: Remote passthrough subnetsip/netmask; default: noneIPv4 or IPv6 address/subnet.
Flush conntrackoff | on; default: offFlush conntrack after IPsec makes a successful connection.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Red for Type: Tunnel
    • Blue for Dead Peer Detection: Enabled

IPsec instance: proposal settings

The proposal settings section is used to configure IKE (Internet Key Exchange) phase 1 & 2 settings. IKE is a protocol used to set up security associations (SAs) for the IPsec connection. This process is required before any IPsec tunnel can be established. It is done in two phases:
PhaseMode
Phase 1
  • Establishes a secure channel between peers
  • Authenticates peers
  • Negotiates SA policy
  • Shares secret keys
  • Establishes secure tunnel for phase 2
Main mode (figure 1)
  • 6 packets exchanged
  • Identity protected during exchange
Aggressive mode (figure 2)
  • 3 packets exchanged
  • Identity information exchanged before a secure channel is established
Phase 2
  • Sets up matching IPsec SAs
  • Periodically renegotiates IPsec SAs
Quick mode
  • 3 packets exchanged
  • IPsec SA parameters (ESP/AH, SHA/MD5) established
  • SA lifetime set
Figure 1

Figure 2

Phase 1

FieldValueDescription
Encryption algorithm3DES | DES | AES 128 | AES 192 | AES 256 | AES 128 CTR | AES 192 CTR | AES 256 CTR | AES128 CCM8 | AES192 CCM8 | AES256 CCM8 | AES128 GCM8 | AES192 GCM8 | AES256 GCM8 | AES128 CCM12 | AES192 CCM12 | AES256 CCM12 | AES128 GCM12 | AES192 GCM12 | AES256 GCM12 | AES128 CCM16 | AES192 CCM16 | AES256 CCM16 | AES128 GCM16 | AES192 GCM16 | AES256 GCM16 | ChaCha20 Poly1305; default: AES 128Algorithm used for data encryption.
AuthenticationMD5 | SHA1 | SHA256 | SHA384 | SHA512 | AESXCBC; default: SHA1Algorithm used for exchanging authentication and hash information.
DH groupMODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | MODP8192 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521 | ECP224 BP | ECP256 BP | ECP384 BP | ECP512 BP | Curve25519 | Curve448; default: MODP1536Diffie-Hellman (DH) group used in the key exchange process. Higher group numbers provide more security, but take longer and use more resources to compute the key. Must match with another incoming connection to establish IPSec.
Force crypto proposaloff | on; default: offOnly chosen proposals will be used when turned on.
IKE Lifetimestring; default: noneHow long the keying channel of a connection (ISAKMP or IKE SA) should last before being renegotiated. The time is specified in seconds. The s, m, h and d suffixes explicitly define the units for seconds, minutes, hours and days, respectively.

Phase 2

FieldValueDescription
Encryption algorithm3DES | DES | AES 128 | AES 192 | AES 256 | AES 128 CTR | AES 192 CTR | AES 256 CTR | AES128 CCM8 | AES192 CCM8 | AES256 CCM8 | AES128 GCM8 | AES192 GCM8 | AES256 GCM8 | AES128 CCM12 | AES192 CCM12 | AES256 CCM12 | AES128 GCM12 | AES192 GCM12 | AES256 GCM12 | AES128 CCM16 | AES192 CCM16 | AES256 CCM16 | AES128 GCM16 | AES192 GCM16 | AES256 GCM16 | ChaCha20 Poly1305; default: AES 128Algorithm used for data encryption.
Hash algorithmMD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1Algorithm used for exchanging authentication and hash information.
PFS groupMODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | MODP8192 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521 | No PFS; default: MODP768The PFS (Perfect Forward Secrecy). Must match with another incoming connection to establish IPSec.
Force crypto proposaloff | on; default: offOnly chosen proposals will be used when turned on.
Lifetimestring; default: noneHow long the keying channel of a connection (ISAKMP or IKE SA) should last before being renegotiated. The time is specified in seconds. The s, m, h and d suffixes explicitly define the units for seconds, minutes, hours and days, respectively.

PPTP

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

PPTP client

A PPTP client is an entity that initiates a connection to a PPTP server. To create a new client instance, go to the Services → VPN → PPTP section and click the 'Add' button:
You should be redirected to the configuration page for the newly added PPTP configuration (choose Role: Client) which should look similar to this:
FieldValueDescription
Enableoff | on; default: offTurns the PPTP instance on or off.
RoleClient | Server; default: ClientChoose a role for PPTP instance.
Namestring; default: noneName of the PPTP instance.
Serverip | host; default: noneIP address or hostname of a PPTP server.
Usernamestring; default: noneUsername used for authentication to the PPTP server.
Passwordstring; default: nonePassword used for authentication to the PPTP server.
Client to clientoff | on; default: offAdds route to make other PPTP clients reachable.
Default routeoff | on; default: offWhen selected, this connection will become the device's default route. This means that all traffic directed to the Internet will go through the PPTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.
MPPE EncryptionNone | Stateless | Stateful; default: StatelessMPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.
MPPE Key lengthSelectible: 40 | 56 | 128; default: 128Encryption strength for MPPE.
Custom optionsSelectible: refuse-pap | refuse-eap | refuse-chap | refuse-mschap | noipdefault | noauth | nobsdcomp | nodeflate | idle 0 | maxfail 0 | +Add new; default: allCustom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.
After successful configuration, you can see the status of PPTP clients:

PPTP server

A PPTP server is an entity that waits for incoming connections from PPTP clients. To create a new server instance, go to the Services → VPN → PPTP section and click the 'Add' button:
You should be redirected to the configuration page for the newly added PPTP configuration (choose Role: Server) which should look similar to this:
FieldValueDescription
Enableoff | on; default: offTurns the PPTP instance on or off.
RoleClient | Server; default: ClientChoose a role for PPTP instance.
Namestring; default: noneName of the PPTP instance.
Local IPip; default: 192.168.0.1IP address of this PPTP network interface.
Remote IP range startip; default: 192.168.0.20PPTP IP address leases will begin from the address specified in this field.
Remote IP range endip; default: 192.168.0.30PPTP IP address leases will end with the address specified in this field.
Timeoutinteger; default: noneTime in seconds. If no packets pass through the tunnel between this server and a client, the server will terminate the connection to that client after the amount of time specified in this field passes.
Primary DNSip; default: noneIP address of the primary DNS server.
Secondary DNSip; default: noneIP address of the secondary DNS server.
Client to clientoff | on; default: offAdd route to make other PPTP clients accessible.
MPPE EncryptionNone | Stateless | Stateful; default: StatelessMPPE (Microsoft Point-to-Point Encryption) – a method of encrypting data transferred across connections.
MPPE Key lengthSelectible: 40 | 56 | 128; default: 128Encryption strength for MPPE.
Custom optionsSelectible: proxyarp | encounter | auth | lcp-echo-failure 3 | lcp-echo-interval 60 | default-asyncmap | mtu 1482 | mru 1482 | nobsdcomp | nodeflate | require-mschap-v2 | refuse-chap | refuse-mschap | refuse-eap | refuse-pap | logfd 2 | +Add new; default: allCustom PPPD (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.
After successful configuration, you can see the status of PPTP server:
The User List section is used to keep authentication settings required to successfully connect to this server. The list is empty by default. Click the 'Add' button to create a new PPTP User:
FieldValueDescription
Usernamestring; default: noneUsername used for authentication to this PPTP server.
Passwordstring; default: nonePassword used for authentication to this PPTP server.
PPTP Client's IPip; default: noneAssigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.
Note: there can only be one PPTP Server configuration on the device.

SSTP

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

SSTP configuration

To create a new SSTP instance, go to the Services → VPN → SSTP section, enter a custom name and click the 'Add' button. An SSTP instance with the given name will appear in the "SSTP Configuration" list.
To begin configuration, click the 'Edit' button located next to the instance. Refer to the figure and table below for information on the SSTP instance's configuration fields:
FieldValueDescription
Enableoff | on; default: offTurns the SSTP instance on or off.
Server IP address or host nameIPv4/IPv6 | host; default: noneIP address and port (optional, default 443) of the remote SSTP server (e.g., example.com/example or 192.168.1.1/example or [::8a2e:370:7334]/example).
User namestring; default: noneUsername used for authentication to the SSTP server.
Passwordstring; default: nonePassword used for authentication to the SSTP server.
Certificate files from deviceoff | on; default: offTurn on this option if you want to select generated certificate files from device.
CA cert.crt file; default: noneUpload a Certificate authority (CA) file.
Default routeoff | on; default: offWhen selected, this connection will become the device's default route. This means that all traffic directed to the Internet will go through the SSTP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.
Auth optionsNoauth | Refuse-pap | Refuse-eap | Refuse-chap | Refuse-mschap | +Add custom option; default: Noauth

Stunnel

Stunnel is an open-source a proxy service that adds TLS encryption to clients and servers already existing on a VPN network. TLS encryption provided by Stunnel can be used as an additional layer of encryption for data sent by VPN. This procedure increases the security of the established connection and provides higher chances of passing a Deep packet inspection (DPI) check.

Stunnel globals

The Stunnel Globals section is used to manage the Stunnel service as a whole. Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
Note: Stunnel is additional software that can be installed from the System → Package Manager page.
FieldValueDescription
Enabledoff | on; default: offTurns the Stunnel service on or off. If this is unchecked, Stunnel instances will not start (even if they are enabled individually); therefore, it is necessary to check this field in order to make Stunnel active on the router.
Debug Levelinteger [0..7]; default: 5Debugging to log output level.
  • 0 (emergency) - a panic condition, i.e., system is no longer usable.
  • 1 (alert) - a condition that must be corrected immediately.
  • 2 (critical) - critical conditions, device errors.
  • 3 (error) - errors that are fatal to the operation, but not the service or application (can't open a required file, missing data, etc.) Solving these types of errors will usually require user intervention.
  • 4 (warning) - anything that can potentially cause application oddities, but for which the system is automatically recovering from (e.g., retrying an operation, missing secondary data, etc.)
  • 5 (notice) - conditions that are not error conditions, but that may require special handling.
  • 6 (info) - general useful information (e.g., configuration changes, starts and stops of services, etc.)
  • 7 (debug) - contains basic information that is diagnostically helpful to most people (i.e., not just engineers).
Use alternative configoff | on; default: offTurns the possibility to upload an external Stunnel configuration file on or off.if you turn this on, other Stunnel configurations present in the router will become inactive.
Upload alternative configfile; default: noneUploads an Stunnel configuration file.

Stunnel instance

To create a new Stunnel instance, go to the Services → VPN → Stunnel section, enter a custom name and click the 'Add' button. An Stunnel instance with the given name will appear in the "Stunnel Configuration" list.
To begin configuration, click the 'Edit' button located next to the instance. Refer to the figure and table below for information on the Stunnel instance's configuration fields:
FieldValueDescription
Enableoff | on; default: offTurns the Stunnel instance on or off.
Operating ModeServer | Client; default: ServerSelects the Stunnel instance's role.
  • Server - listens for connecting Stunnel clients.
  • Client - listens for connecting clients and connects to an Stunnel server.
Listen IPip; default: noneMakes the instance "listen" for incoming connections on the specified IP address. When left empty, the value of this field defaults to localhost (127.0.0.1).
Listen Portinteger [0..65535]; default: noneMakes the instance "listen" for incoming connections on the specified TCP port. Make sure you chose a port that is not being used by another service. You will also have to allow traffic on the specified port.
Connect IP'sipv4/ipv6:port; default: noneIP:Port to listen for VPN connections (using 'host_ip:port' convention (e.g., 127.0.0.1:6001 or [::0000:8a2e:0370]:7334).If no host IP is specified only port number, then localhost will be used as a host.) Must contain at least one item. If multiple options are specified, remote address is chosen using a round-robin algorithm.
TLS CipherNone | Secure | Custom; default: NonePacket encryption algorithm cipher.
Custom: Allowed TLS Ciphersstring; default: noneA list of TLS ciphers accepted for this connection.
Application ProtocolConnect | SMTP | Not specified; default: Not specifiedThis option enables initial, protocol-specific negotiation of the TLS encryption. The protocol option should not be used with TLS encryption on a separate port.
Connect: Protocol AuthenticationBasic | NTLM; default: BasicAuthentication type for the protocol negotiations.
SMTP: Protocol AuthenticationPlain | Login; default: PlainAuthentication type for the protocol negotiations.
Store key in TPMoff | on; default: onWhen enabled, key will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
Certificate File.crt file; default: noneTLS client or server certificate file.
Private Key.key file; default: noneTLS client or server key file.
Remote server certificate.crt file; default: noneCertificate file of the remote peer (server) in pem format.
Additional notes:
  • Some configuration fields become available only when certain other parameters are selected. The names of the parameters are followed by a prefix that specifies the authentication type under which they become visible. Different color codes are used for different prefixes:
    • Blue for TLS Cipher: Custom
    • Dark red for Application Protocol: Connect
    • Chocolate for Application Protocol: SMTP

DMVPN

Dynamic Multipoint VPN (DMVPN) is a method of building scalable IPsec VPNs. DMVPN is configured as a hub-and-spoke network, where tunnels between spokes are built dynamically; therefore, no change in configuration is required on the hub in order to connect new spokes. Note: DMPVN is additional software that can be installed from the System → Package Manager page.

DMVPN configuration

To create a new DMVPN instance, go to the Services → VPN → DMVPN section, enter a custom name and click the 'Add' button. A DMVPN instance with the given name will appear in the "DMVPN Configuration" list.
To begin configuration, click the button that looks like a pencil located next to the instance. Refer to the figures and tables below for information on the DMVPN instance configuration:
FieldValueDescription
Enabledoff | on; default: offTurns the DMVPN instance on or off.
Working modeSpoke | Hub; default: SpokeSelects the role of this instance
  • Hub - the central instance of DMVPN that connects other peers (spokes) into single network. There is no need to reconfigure the hub when connecting new spokes to it.
  • Spoke - an instance that connects to the hub.
Hub addressip | host; default: noneIP address or hostname of a DMVPN hub.
FieldValueDescription
Use IPv6off | on; default: offUse IPv6 address to create a tunnel.
Tunnel sourcenetwork interface; default: AnyNetwork interface used to establish the GRE Tunnel.
Local GRE interface IP addressip; default: noneIP address of the local GRE Tunnel instance.
Spoke: Remote GRE interface IP addressip; default: noneIP address of the remote GRE Tunnel instance.
Hub: Local GRE interface netmasknetmask; default: noneSubnet mask of the local GRE Tunnel instance.
GRE MTUinteger; default: 1476Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.
Outbound keyinteger [0..65535]; default: noneA key used to identify outgoing GRE packets. This value should match the Inbound key value set on the opposite GRE tunnel instance or both key values should be omitted on both sides.
Inbound keyinteger [0..65535]; default: noneA key used to identify incoming GRE packets. This value should match the Outbound key value set on the opposite GRE instance or both key values should be omitted on both sides.
FieldValueDescription
Local identifierip | string; default: noneDefines how the user (IPsec instance) will be identified during authentication.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Remote identifierip | string; default: noneDefines how the right participant will be identified during authentication.
  • IP - Internet Protocol address.
  • FQDN - identity defined by fully qualified domain name. It is the complete domain name for a host (for example, something.somedomain.com). Only supported with IKEv2.
Pre-shared keystring; default: noneA shared password used for authentication between IPsec peers.
Encryption algorithm3DES | AES 128 | AES 192 | AES 256 | AES128 GCM8 | AES192 GCM8 | AES256 GCM8 | AES128 GCM12 | AES192 GCM12 | AES256 GCM12 | AES128 GCM16 | AES192 GCM16 | AES256 GCM16; default: AES 128Algorithm used for data encryption.
Authentication/Hash algorithmMD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1Algorithm used for exchanging authentication and hash information.
DH/PFS groupMODP768 | MODP1024 | MODP1536 | MODP2048 | MODP3072 | MODP4096 | ECP192 | ECP224 | ECP256 | ECP384 | ECP521; default: MODP1536Diffie-Hellman (DH) group used in the key exchange process. Higher group numbers provide more security, but take longer and use more resources to compute the key. Must match with another incoming connection to establish IPSec.
Force crypto proposaloff | on; default: offOnly chosen proposals will be used when turned on.
IKE Lifetimestring; default: noneHow long the keying channel of a connection (ISAKMP or IKE SA) should last before being renegotiated. The time is specified in seconds. The s, m, h and d suffixes explicitly define the units for seconds, minutes, hours and days, respectively.
Note: on some devices, the NHRP parameters are visible after installing the NHRP package from the System → Package Manager page.
FieldValueDescription
NHRP network IDinteger; default: 1An identifier used to define the NHRP domain. This is a local parameter and its value does not need to match the values specified on other domains. However, the NHRP ID is added to packets which arrive on the GRE interface; therefore, it may be helpful to use the same ID for troubleshooting purposes.
NHRP authentication keystring; default: noneA key used in NHRP authentication.
NHRP hold timeinteger; default: 7200Specifies the holding time for NHRP Registration Requests and Resolution Replies sent from this interface or shortcut-target. The hold time is specified in seconds and defaults to two hours.
Redirectoff | on; default: offEnables or disables DMVPN traffic redirection.
Hub: NFLOG groupinteger [1..65535]; default: noneSpecify NFLOG group to be used by NHRP instance
Multicastoff | on; default: offAllow use of dynamic routing protocols that use multicast.
NHRP multicast NFLOG groupinteger [1..65535}; default: noneSpecify NFLOG group to be used by NHRP instance for multicast traffic.

L2TP

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

L2TP client

An L2TP client is an entity that initiates a connection to an L2TP server. To create a new client instance, go to the Services → VPN → L2TP section, select Role: Client, enter a custom name and click the 'Add' button. An L2TP client instance with the given name will appear in the "L2TP Configuration" list.
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the L2TP client's configuration fields:
FieldValueDescription
Enableoff | on; default: offTurns the L2TP instance on or off.
Serverip | host; default: noneA domain name or IP address (IPv4 or IPv6) with an optional port (values from 1 to 65535) is required (e.g., 192.168.1.1, ::0000:8a2e:0370:7334, example.com, or 192.168.1.1:80).
Usernamestring; default: noneUsername used for authentication to the L2TP server.
Passwordstring; default: nonePassword used for authentication to the L2TP server.
CHAP secretstring; default: noneA secret used for L2TP Tunnel Authentication.
MTU[68..9200]; default: noneSets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.
Default routeoff | on; default: offWhen turned on, this connection will become device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.
Allow CHAPon | off; default: onAllows CHAP authentication method to be used.
Allow PAPon | off; default: offAllows PAP authentication method to be used.
Allow MSCHAP-v2on | off; default: onAllow MSCHAP-v2 authentication method to be used.
Custom optionsstring; default: noneCustom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.

Active L2TP client instance example:

L2TP server

An L2TP server is an entity that waits for incoming connections from L2TP clients. To create a new server instance, go to the Services → VPN → L2TP section, select Role: Server, enter a custom name and click the 'Add' button. An L2TP server instance with the given name will appear in the "L2TP Configuration" list. Only one L2TP server instance is allowed to be added.
A server needs to have a public IP address in order to be available from the public network (the Internet).
To begin configuration, click the button that looks like a pencil next to the server instance. Refer to the figure and table below for information on the L2TP server's configuration fields:
FieldValueDescription
Enableoff | on; default: offTurns the L2TP instance on or off.
Use IPv6off | on; default: offL2TPv6 support package is required to enable this option. Enables an IPv6 socket to accept L2TP connections over IPv6. Note: L2TPv6 support is additional software on some devices that can be installed from the System → Package Manager page.
Local IPip; default: 192.168.0.1IP address of this L2TP network interface.
Remote IP range beginip; default: 192.168.0.20L2TP IP address leases will begin from the address specified in this field.
Remote IP range endip; default: 192.168.0.30L2TP IP address leases will end with the address specified in this field.
Portinteger [1..65535]; default: nonePort for binding.
Enable CHAPon | off; default: offChallenge-Handshake Authentication Protocol for L2TP.
CHAP Secretstring; default: noneA secret used for L2TP Tunnel Authentication.
CHAP authenticationon | off; default: onWhen turned on it requires CHAP authentication method to be used, when turned off it refuses CHAP authentication method.
PAP authenticationon | off; default: offWhen turned on it requires PAP authentication method to be used, when turned off it refuses PAP authentication method.
MSCHAP-v2 authenticationon | off; default: onWhen turned on it requires MSCHAP-v2 authentication method to be used, when turned off it refuses MSCHAP-v2 authentication method.
Custom optionsstring without "`" or "'"; default: Custom pppd (Point-to-Point Protocol Daemon) options are used to configure and manage PPP connections.
FieldValueDescription
User namestring; default: userUsername used for authentication to this L2TP server.
Passwordstring; default: passPassword used for authentication to this L2TP server.
L2TP Client's IPip; default: noneAssigns an IP address to the client that uses the adjacent authentication info. This field is optional and if left empty the client will simply receive an IP address from the IP pool defined above.

Active L2TP server instance example:

L2TPv3

L2TPv3 (Layer Two Tunneling Protocol Version 3) is a point-to-point layer two over IP tunnel. This means you can tunnel L2 protocols like Ethernet, Frame-relay, ATM, HDLC, PPP, etc. over an IP network.
To create a new L2TPv3 instance, go to the Services → VPN → L2TPv3 section, enter a custom name and click the 'Add' button. You will be redirected to instance configuration page and L2TPv3 instance with the given name will appear in the "L2TPv3 Configuration" list.

Instance configuration

FieldValueDescription
Enableoff | on; default: offTurns the L2TPv3 instance on or off.
Local addressip; default: noneWAN or LAN interface IPv4 or IPv6 address.
Tunnel IDinteger [1..4294967295]; default: noneID of tunnel is specified from 1 to 4294967295. The value used must be unique between instances and match the peer tunnel ID value being used at the peer.
Session IDinteger [1..4294967295]; default: noneID of peer's session is specified from 1 to 4294967295. The value used must be unique between instances match the tunnel ID value being used at the peer.
Cookiehexidecimal form with specific length [8,16]; default: noneMust be specified in hexidecimal form and be length of 8 or 16 (eg.: 89ABCDEF).

Peer settings

FieldValueDescription
Peer addressip | hostname; default: nonePeer endpoint IP address or domain name.
Peer Tunnel IDinteger [1..4294967295]; default: noneID of peer's tunnel is specified from 1 to 4294967295. It must match other end tunnel ID.
Peer Session IDinteger [1..4294967295]; default: noneID of peer's session is specified from 1 to 4294967295. It must match other end session ID.
Peer Cookiehexidecimal form with specific length [8,16]; default: noneMust be specified in hexidecimal form and be length of 8 or 16. eg.: 89ABCDEF. It must match other end Cookie.

Instance Settings

FieldValueDescription
Bridge toNone | LAN; default: NonePeer Endpoint IP address.
IPv4 AddressIPv4; default: noneIP address of standalone L2TPv3 interface.
IPv6 AddressIPv6; default: noneIPv6 address of standalone L2TPv3 interface. CIDR notation: address/prefix.
Netmasknetmask; default: noneNetmask of standalone L2TPv3 interface.
MTUinteger [64..9000]; default: noneSets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.
EncapsulationIP | UDP; default: IPSpecify technology to use when connecting to other end.
Layer 2 specific header typeNone | Linux Default; default: Linux DefaultIt might be neccessary to set this option to none when using other hardware.

ZeroTier

ZeroTier One is an open source software which can establish Peer to Peer VPN (P2PVPN) connection between various devices running various operating systems. It also provides network management possibilities such as routing and creating firewall rules.
Note: ZeroTier is additional software that can be installed from the System → Package Manager page.
In order to create a new ZeroTier Instance, look to the Add New ZeroTier Configuration section; enter a custom name and click the 'Add' button:

You should be redirected to the configuration page for the newly added ZeroTier Instance which should look similar to this:
FieldValueDescription
Enabledoff | on; default: offTurns the ZeroTier Instance on or off.

ZeroTier network configuration instance should look similar to this:
FieldValueDescription
Enabledoff | on; default: offTurns the ZeroTier Instance on or off.
Portinteger [0..65535]; default: 9993ZeroTier Network port.
Network IDhex string; default: noneZeroTier Network ID. Log in to your ZeroTier account in order to locate the ZeroTier Network ID, which should be a string of hexadecimal characters.
Bridge toNone | LAN; default: NoneSpecify to which interface this ZeroTier instance should be bridged to.
Allow default routeoff | on; default: offAllows ZeroTier to override system default route.
Allow global IPoff | on; default: offAllows ZeroTier managed IPs and routes to overlap public IP space.
Allow managed IPoff | on; default: onAssigns ZeroTier managed IPs and routes.
Allow DNSoff | on; default: offApplies DNS servers that are set at the network controller.
Custom planet file-(interactive button)Custom planet file contains user-defined roots, enabling the use of private root servers.

WireGuard

WireGuard is simple, fast, lean, and modern VPN that utilizes secure and trusted cryptography. It intends to be more performant than OpenVPN. WireGuard is designed as general purpose VPN, fit for many different circumstances and while it is currently under heavy development, it already might be regarded as the most secure, easiest to use, and simplest VPN solution.
WireGuard works by adding an interface which acts as a tunnel. To create one enter its name and click the Add button. This should add a new Wireguard instance and open a configuration window.

General Instance Settings

This section contains General settings of created WireGuard Instance. Here you can find its Public and Private keys and generate them, specify Port and IP addresses for communication.
FieldValueDescription
Enableoff | on; default: offTurns WireGuard Instance on or off.
Private Keystring; default: -Private Key used in authentication.
Public Keystring; default: -Public Key used in authentication.
Generate key pair-(interactive button)Click to generate Public Key and Private Key.
IP Addressesip; default: 10.5.0.1/24A single IP address or a list of them for this instance associated with public keys.

Advanced Settings

Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
FieldValueDescription
Metricpositive integer; default: noneSpecify (Optional) metric for this tunnel interface. Lower number means higher priority.
Listen portinteger [1..65535]; default: 51820Required. UDP port used for outgoing and incoming packets.
MTUinteger [68..9200]; default: noneMaximum Transmission Unit of tunnel interface. Range [68 to 9200]. If not specified, the MTU is automatically determined by physical interface MTU value.
DNS serversip; default: noneDNS server(s) for this Wireguard interface.
Watchdog intervalinteger [0..60]; default: noneOptional. Interval in minutes to re-resolve hostnames for inactive WireGuard peers if domain is used. If not specified and domain is used, hostnames will be checked every minute.

Peers

The Peers section is used to create and configure all the peers for this interface. To create one enter its name and click the Add button.

General Peer Settings

In the General section of Peer instance you can configure basic information about the endpoint to allow communications.
FieldValueDescription
Public Keystring; default: noneBase64-encoded public key of peer.
Endpoint hostdomain name | ip; default: noneHost of peer. Names are resolved prior to bringing up the interface.
Allowed IPsip; default: 10.5.0.2/32IP addresses and prefixes that this peer is allowed to use inside the tunnel. Usually the peer's tunnel IP addresses and the networks the peer routes through the tunnel.
Descriptionstring; default: noneDescription of the peer.
Route Allowed IPsoff | on; default: offCreate routes for Allowed IPs for this peer.

Advanced Peer Settings

In the Advanced section of Peer instance you are able to configure additional settings such as its Description, Endpoint Host and Port, Preshared Key and other. See more information below.
FieldValueDescription
Tunnel sourceAny | LAN | WAN | Mobile; default: AnyInterface to bind this instance to.
Tunnel source modePrefer | Persist; default: PreferChoose whether to persist or prefer the connection on the selected interface.
Pre-Shared Keystring; default: noneBase64-encoded pre-shared key. Adds in an additional layer of symmetric-key cryptography for post-quantum resistance.
Endpoint Portinteger [1..65535]; default: nonePort of peer.
Persistent Keep Aliveinteger [0..65535]; default: noneSeconds between keep alive messages. Default is 0 (disabled). Recommended value if this device is behind a NAT is 25. Range [0 to 65535].
Routing tablestring; default: noneDefines which routing table to use for this peer routes, not necessary to configure for most setups..

QR Settings

FieldValueDescription
Server IPIP address; default: NoneSpecifies which interface's IP address should be bound to the hostname.
Tunnel addressIP; default: 10.5.0.2/32Choose whether to persist or prefer the connection on the selected interface.
Peer allowed IPsAll IPv4 | All IPv6 | LAN; default: All IPv4 (0.0.0.0/0)Required. IP addresses and prefixes that this peer is allowed to use inside the tunnel. Usually the peer's tunnel IP addresses and the networks the peer routes through the tunnel.
QR codeInteractive buttonGenerates single-use QR code.

Tinc

Tinc is a Virtual Private Network (VPN) daemon that uses tunnelling and encryption to create a secure private network between hosts on the Internet. Tinc is Free Software and licensed under the [General Public License] version 2 or later. Because the VPN appears to the IP level network code as a normal network device, there is no need to adapt any existing software. This allows VPN sites to share information with each other over the Internet without exposing any information to others.
Note: Tinc VPN is additional software that can be installed from the System → Package Manager page.
Tinc works by adding an interface which acts as Router/Switch/Hub mode. To create one enter its name and click the Add button. This should add a new Tinc interface and open a configuration window

General Interface Settings

This section contains General settings of created Tinc Interface. Here you can find its Public and Private keys, specify Subnet and Host to Connect to for communication.
FieldValueDescription
Enableoff | on; default: offTurns Tinc Interface on or off.
Local tunnel endpoint IPipv4 with or without mask; default: noneIP address of virtual local network interface.
Local tunnel endpoint IPv6ipv6 with or without mask; default: noneIPv6 address of virtual local network interface.
Subnetip with subnet; default: noneSubnets that peers are allowed to access. You can add multiple subnet entries for each daemon.
Private Key.key file; default: noneGenerated RSA private key.
Public Key.key file; default: noneGenerated RSA public key.
Host to Connect toNot specified | Host name; default: Not specifiedSpecifies which other tinc daemon to connect to on startup. Multiple variables may be specified, in which case outgoing connections to each specified tinc daemon are made.

Advanced Settings

Advanced Settings section.
FieldValueDescription
Portinteger [1..65535]; default: 655Configure the port on which this tinc daemon will listen for incoming connections.
Address FamilyAny | IPv4 | IPv6; default: AnyThis option affects the address family of listening and outgoing sockets.
Bind To Addressip; default: noneAddresses for Tinc VPN to use for listening sockets.
Bind To InterfaceAny | LAN | WAN | WAN6 | Mobile; default: AnyInterface to listen for incoming connections.
Key Expireinteger; default: 3600This option controls the time the encryption keys used to encrypt the data are Valid.
ModeRouter | Switch | Hub; default: RouterThis option selects the way packets are routed to other daemons.
Ping Intervalinteger; default: 60The number of seconds of inactivity that tinc will wait before sending a probe to the other end.
Ping Timeoutinteger; default: 5The number of seconds to wait for a response to pings or to allow meta connections to block. If the other end doesn't respond within this time, the connection is terminated, and the others will be notified of this.

Hosts

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

General Tinc Host Settings

In the General section of Hosts instance you can configure basic information about the host.
FieldValueDescription
Enableoff | on; default: offTurn this tinc host on/off.
Descriptionstring; default: noneOptional. Description of host.
AddressIP addresses with an optional port number; default: noneRemote host's IP address or domain name, optionally followed by a port number (e.g., example.com:8080). If no port is specified, the default port (655) will be used.
SubnetIPv4, IPv6 or MAC addresses; default: noneSpecify the host-side subnets you need to access. You can add multiple subnet entries for each daemon.
Public Key.key file; default: noneGenerated RSA public key.

EoIP

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

Note: EoIP is additional software that can be installed from the System → Package Manager page.

Topology

EoIP configuration

To create a new EoIP instance, go to the Services → VPN → EoIP page and click the 'Add' button. The "EoIP Configuration" window will appear.
The following is the instance configuration window:
FieldValueDescription
Enableon | off; default: offEnable current configuration.
Namestring; default: instance1Name of the EoIP instance.
Tunnel IDinteger [1..65536]; default: emptyUnique tunnel identifier, which must match other side of the tunnel.
Use IPv6on | off; default: offThe parameter specifies the local IP address used as the source for sending traffic through a tunnel.
Local IPIPv4/IPv6 addresses; default: emptyThe parameter specifies the local IP address used as the source for sending traffic through a tunnel.
Dynamicon | off; default: offAllow the connection. If you enable it, be aware that there is no authorization and it is not secure. Avoid using this feature on a public IP or a network where you do not have full control over all hosts.
Remote IPIPv4/IPv6 addresses; default: emptyThe parameter specifies the IP address of the remote endpoint that the tunnel will connect to.
Bridgeinterface; default: noneAssign an EoIP interface to a bridge.
MTUinteger [68..9200]; default: noneMTU for the tunnel interface.