Changes

Template:Networking rut manual vpn (view source)

Revision as of 09:07, 2 July 2019

204 bytes added , 09:07, 2 July 2019

no edit summary

Line 32: Line 32:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Turns the OpenVPN instance on or off.</td>

</tr>

<tr>

−

<td>TUN (tunnel) | TAP (bridged); ~~Default~~: TUN (tunnel)</td>

+

<td>TUN (tunnel) | TAP (bridged); default: TUN (tunnel)</td>

<td>Virtual network device type.

<ul>

Line 47: Line 47:

<tr>

<td>Protocol</td>

−

<td>UDP | TCP; ~~Default~~: UDP</td>

+

<td>UDP | TCP; default: UDP</td>

<td>Transfer protocol used for the OpenVPN connection.

<ul>

Line 57: Line 57:

<tr>

−

<td>integer [0..65535]; ~~Default~~: 1194</td>

+

<td>integer [0..65535]; default: 1194</td>

<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. NOTE: traffic on the selected port will be automatically allowed in the router's firewall rules.</td>

</tr>

<tr>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Turns LZO data compression on or off.</td>

</tr>

<tr>

<td>Encryption</td>

−

+

<td>Algorithm used for packet encryption.</td>

</tr>

<tr>

<td>Authentication</td>

−

<td>TLS | Static Key | Password | TLS/Password; ~~Default~~: TLS</td>

+

<td>TLS | Static Key | Password | TLS/Password; default: TLS</td>

<td>Authentication mode, used to secure data sessions.

<ul>

Line 90: Line 90:

<tr>

<td>TLS: TLS cipher</td>

−

<td>All | DHE+RSA | Custom; ~~Default~~: All</td>

+

<td>All | DHE+RSA | Custom; default: All</td>

<td>Packet encryption algorithm cipher.</td>

</tr>

<tr>

<td>TLS: Allowed TLS ciphers</td>

−

<td>All | DHE+RSA | Custom; ~~Default~~: All</td>

+

<td>All | DHE+RSA | Custom; default: All</td>

<td>A list of TLS ciphers accepted for this connection.</td>

</tr>

<tr>

<td>Remote host/IP address</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address or hostname of an OpenVPN server.</td>

</tr>

<tr>

<td>Resolve retry</td>

−

<td>integer | infinite; ~~Default~~: infinite</td>

+

<td>integer | infinite; default: infinite</td>

<td>In case server hostname resolve fails, this field indicates the amount of time (in seconds) to retry the resolve. Specify infinite to retry indefinitely.</td>

</tr>

<tr>

<td>Keep alive</td>

−

<td>two integers separated by a space; ~~Default~~: none</td>

+

<td>two integers separated by a space; default: none</td>

<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specfiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances. Example: 10 120</td>

</tr>

<tr>

<td>Static key: Local tunnel endpoint IP</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address of the local OpenVPN network interface.</td>

</tr>

<tr>

<td>Static key: Remote tunnel endpoint IP</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address of the remote network OpenVPN (server) interface.</td>

</tr>

<tr>

<td>Remote network IP address</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>LAN IP address of the remote network (server).</td>

</tr>

<tr>

<td>Remote network IP netmask</td>

−

<td>netmask; ~~Default~~: none</td>

+

<td>netmask; default: none</td>

<td>LAN IP subnet mask of the remote network (server).</td>

</tr>

<tr>

<td>Password: User name</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Username used for authentication to the OpenVPN server.</td>

</tr>

<tr>

<td>Password: Password</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Password used for authentication to the OpenVPN server.</td>

</tr>

<tr>

<td>Extra options</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Extra OpenVPN options to be used by the OpenVPN instance.</td>

</tr>

<tr>

<td>TLS/Password: HMAC authentication algorithm</td>

−

<td>none | SHA1 | SHA256 | SHA384 | SHA512; ~~Default~~: SHA1</td>

+

<td>none | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1</td>

<td>HMAC authentication algorithm type.</td>

</tr>

<tr>

<td>TLS/Password: Additional HMAC authentication</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>An additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.</td>

</tr>

<tr>

<td>TLS/Password: HMAC authentication key</td>

−

<td>.key file; ~~Default~~: none</td>

+

<td>.key file; default: none</td>

<td>Uploads an HMAC authentication key file.</td>

</tr>

<tr>

<td>TLS/Password: HMAC key direction</td>

−

<td>0 | 1 | none; ~~Default~~: 1</td>

+

<td>0 | 1 | none; default: 1</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 0, the other side should use 1, or both sides should omit the parameter altogether.</td>

</tr>

<tr>

<td>TLS/Password: Certificate authority</td>

−

<td>.ca file; ~~Default~~: none</td>

+

<td>.ca file; default: none</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>

<td>TLS: Client certificate</td>

−

<td>.crt file; ~~Default~~: none</td>

+

<td>.crt file; default: none</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>

<td>TLS: Client key</td>

−

<td>.key file; ~~Default~~: none</td>

+

<td>.key file; default: none</td>

<td>Authenticates the client to the server and establishes precisely who they are.</td>

</tr>

<tr>

<td>TLS: Private key decryption password (optional)</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</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>

<td>Static key: Static pre-shared key</td>

−

<td>.key file; ~~Default~~: none</td>

+

<td>.key file; default: none</td>

<td>Uploads a secret key file used for server–client authentication.</td>

</tr>

Line 225: Line 225:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Turns the OpenVPN instance on or off.</td>

</tr>

<tr>

−

<td>TUN (tunnel) | TAP (bridged); ~~Default~~: TUN (tunnel)</td>

+

<td>TUN (tunnel) | TAP (bridged); default: TUN (tunnel)</td>

<td>Virtual network device type.

<ul>

Line 240: Line 240:

<tr>

<td>Protocol</td>

−

<td>UDP | TCP; ~~Default~~: UDP</td>

+

<td>UDP | TCP; default: UDP</td>

<td>Transfer protocol used for the connection.

<ul>

Line 250: Line 250:

<tr>

−

<td>integer [0..65535]; ~~Default~~: 1194</td>

+

<td>integer [0..65535]; default: 1194</td>

<td>TCP/UDP port number used for the connection. Make sure it matches the port number specified on the server side. NOTE: traffic on the selected port will be automatically allowed in the router's firewall rules.</td>

</tr>

<tr>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Turns LZO data compression on or off.</td>

</tr>

<tr>

<td>Encryption</td>

−

+

<td>Algorithm used for packet encryption.</td>

</tr>

<tr>

<td>Authentication</td>

−

<td>TLS | Static Key | TLS/Password; ~~Default~~: TLS</td>

+

<td>TLS | Static Key | TLS/Password; default: TLS</td>

<td>Authentication mode, used to secure data sessions.

<ul>

Line 282: Line 282:

<tr>

<td>Static key: Local tunnel endpoint IP</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address of the local OpenVPN network interface.</td>

</tr>

<tr>

<td>Static key: Remote tunnel endpoint IP</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address of the remote OpenVPN (client) network interface.</td>

</tr>

<tr>

<td>Static key: Remote network IP address</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>LAN IP address of the remote network (client).</td>

</tr>

<tr>

<td>Static key: Remote network IP netmask</td>

−

<td>netmask; ~~Default~~: none</td>

+

<td>netmask; default: none</td>

<td>LAN IP subnet mask of the remote network (client).</td>

</tr>

<tr>

<td>TLS/TLS/Password: TLS cipher</td>

−

<td>All | DHE+RSA | Custom; ~~Default~~: All</td>

+

<td>All | DHE+RSA | Custom; default: All</td>

<td>Packet encryption algorithm cipher.</td>

</tr>

<tr>

<td>TLS/Password: Allowed TLS ciphers</td>

−

<td>All | DHE+RSA | Custom; ~~Default~~: All</td>

+

<td>All | DHE+RSA | Custom; default: All</td>

<td>A list of TLS ciphers accepted for this connection.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Client to client</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Allows OpenVPN clients to communicate with each other on the VPN network.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Keep alive</td>

−

<td>two integers separated by a space; ~~Default~~: none</td>

+

<td>two integers separated by a space; default: none</td>

<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specifiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances. Example: 10 120</td>

</tr>

<tr>

<td>TLS/TLS/Password: Virtual network IP address</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>IP address of the OpenVPN network.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Virtual network netmask</td>

−

<td>netmask; ~~Default~~: none</td>

+

<td>netmask; default: none</td>

<td>Subnet mask of the OpenVPN network.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Push option</td>

−

<td>OpenVPN options; ~~Default~~: none</td>

+

<td>OpenVPN options; default: none</td>

<td>Push options are a way to "push" routes and other additional OpenVPN options to connecting clients.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Allow duplicate certificates</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>When enabled allows multiple clients to connect using the same certificates.</td>

</tr>

<tr>

<td>TLS/Password: User name</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Username used for authentication to the OpenVPN server.</td>

</tr>

<tr>

<td>TLS/Password: Password</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Password used for authentication to the OpenVPN server.</td>

</tr>

<tr>

<td>Static key: Static pre-shared key</td>

−

<td>.key file; ~~Default~~: none</td>

+

<td>.key file; default: none</td>

<td>Uploads a secret key file used for server–client authentication.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Certificate authority</td>

−

<td>.ca file; ~~Default~~: none</td>

+

<td>.ca file; default: none</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>

<td>TLS/TLS/Password: Server certificate</td>

−

<td>.crt file; ~~Default~~: none</td>

+

<td>.crt file; default: none</td>

<td>A type of digital certificate that is used to identify the OpenVPN server.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Server key</td>

−

<td>.key file; ~~Default~~: none</td>

+

<td>.key file; default: none</td>

<td>Authenticates clients to the server.</td>

</tr>

<tr>

<td>TLS/TLS/Password: Diffie Hellman parameters</td>

−

<td>.pem file; ~~Default~~: none</td>

+

<td>.pem file; default: none</td>

<td>DH parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange.</td>

</tr>

<tr>

<td>TLS/TLS/Password: CRL file (optional)</td>

−

<td>.pem file | .crl file; ~~Default~~: none</td>

+

<td>.pem file | .crl file; default: none</td>

<td>A certificate revocation list (CRL) file is a list of certificates that have been revoked by the certificate authority (CA). It indicates which certificates are no longer acccepted by the CA and therefore cannot be authenticated to the server.</td>

</tr>

Line 410: Line 410:

<tr>

<td>VPN instance name</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Indicates which OpenVPN instance the TLS Client will be associated with. When left empty, this field is filled automatically.</td>

</tr>

<tr>

<td>Endpoint name</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>A custom name for the client.</td>

</tr>

<tr>

<td>Common name (CN)</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</td>

<td>Client’s Common Name (CN) found in the client certificate file.</td>

</tr>

<tr>

<td>Virtual local endpoint</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>Client’s local address in the virtual network.</td>

</tr>

<tr>

<td>Virtual remote endpoint</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>Client’s remote address in the virtual network.</td>

</tr>

<tr>

<td>Private network</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>Client’s private network (LAN) IP address.</td>

</tr>

<tr>

<td>Private netmask</td>

−

<td>ip; ~~Default~~: none</td>

+

<td>ip; default: none</td>

<td>Client’s private network (LAN) IP netmask.</td>

</tr>

Line 465: Line 465:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Turns the IPsec instance on or off.</td>

</tr>

<tr>

<td>IKE version</td>

−

<td>IKEv1 | IKEv2; ~~Default~~: IKEv1</td>

+

<td>IKEv1 | IKEv2; default: IKEv1</td>

<td>Internet Key Exchange (IKE) version used for key exchange.

<ul>

Line 480: Line 480:

<tr>

−

<td>Main | Aggressive; ~~Default~~: Main</td>

+

<td>Main | Aggressive; default: Main</td>

<td>Internet Security and Key Management Protocol (ISAKMP) phase 1 exchange mode.

<ul>

Line 490: Line 490:

<tr>

−

<td>Tunnel | Transport; ~~Default~~: Tunnel</td>

+

<td>Tunnel | Transport; default: Tunnel</td>

<td>Type of connection.

<ul>

Line 500: Line 500:

<tr>

<td>My identifier type</td>

−

<td>FQDN | User FQDN | Address; ~~Default~~: FQDN</td>

+

<td>FQDN | User FQDN | Address; default: FQDN</td>

<td>Defines the type of identity used in user (IPsec instance) authentication.

<ul>

Line 511: Line 511:

<tr>

<td>On startup</td>

−

<td>Ignore | Add | Route | Start; ~~Default~~: Start</td>

+

<td>Ignore | Add | Route | Start; default: Start</td>

−

<td>Defines how the instance should act on router ~~startput~~.

+

<td>Defines how the instance should act on router startup.

<ul>

−

<li>Ignore - </li>

+

<li>Ignore - does not start the tunnel.</li>

−

+

<li>Add - loads a connection without starting it.</li>

−

+

<li>Route - starts the tunnel only if there is traffic.</li>

+

<li>Start - starts the tunnel on router startup.</li>

</ul>

</td>

Line 522: Line 523:

<tr>

<td>My identifier</td>

−

<td>ip | string; ~~Default~~: none</td>

+

<td>ip | string; default: none</td>

<td>Defines how the user (IPsec instance) will be identified during authentication.</td>

</tr>

<tr>

<td>Tunnel: Local IP address/Subnet mask</td>

−

<td>ip/netmask | ~~Default~~: none</td>

+

<td>ip/netmask | default: none</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>

<td>Left firewall</td>

−

<td>off | on; ~~Default~~: on</td>

+

<td>off | on; default: on</td>

<td>Adds neccessary firewall rules to allow traffic of this IPsec instance on this router.</td>

</tr>

<tr>

<td>Force encapsulation</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Forces UDP encapsulation for ESP packets even if a "no NAT" situation is detected.</td>

</tr>

<tr>

<td>Dead Peer Detection</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>A function used during Internet Key Exchange (IKE) to detect a "dead" peer. It used to reduce traffic by minimizing the number of messages when the opposite peer in unavailable and as failover mechanism.</td>

</tr>

<tr>

<td>Dead Peer Detection: Delay (sec)</td>

−

<td>integer; ~~Default~~: none</td>

+

<td>integer; default: none</td>

<td>The frequency of checking whether a peer is still availaible or not.</td>

</tr>

<tr>

<td>Dead Peer Detection: Timeout (sec)</td>

−

<td>integer; ~~Default~~: none</td>

+

<td>integer; default: none</td>

<td>Time limit after which the IPsec instance will stop checking the availability of a peer and determine it to be "dead" if no response is received.</td>

</tr>

<tr>

<td>Remote VPN endpoint</td>

−

<td>host | ip; ~~Default~~: none</td>

+

<td>host | ip; default: none</td>

<td>IP address or hostname of the remote IPsec instance.</td>

</tr>

<tr>

<td>Tunnel: Remote IP address/subnet mask</td>

−

<td>ip/netmask; ~~Default~~: none</td>

+

<td>ip/netmask; default: none</td>

<td>Remote network IP address and subnet mask used to determine which part of the network can be accessed in the VPN network. Netmask range [0..32]. This value must differ from the device’s LAN IP.</td>

</tr>

<tr>

<td>Right firewall</td>

−

<td>yes | no; ~~Default~~: yes</td>

+

<td>yes | no; default: yes</td>

<td>Adds neccessary firewall rules to allow traffic of from the opposite IPsec instance on this router.</td>

</tr>

<tr>

<td>Transport: Use with DMVPN</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Adds several necessary options to make DMVPN work.</td>

</tr>

<tr>

<td>Enable keepalive</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>When enabled, the instance sends ICMP packets to the specified host at the specified frequency. If no response is received, the router will attempt to restart the connection.</td>

</tr>

<tr>

−

<td>host | ip; ~~Default~~: none</td>

+

<td>host | ip; default: none</td>

<td>Hostname or IP address to which keepalive ICMP packets will be sent to.</td>

</tr>

<tr>

<td>Ping period (sec)</td>

−

<td>integer [0..9999999]; ~~Default~~: none</td>

+

<td>integer [0..9999999]; default: none</td>

<td>The frequency at which keepalive ICMP packets will be sent to the specified host or IP address.</td>

</tr>

<tr>

<td>Allow WebUI access</td>

−

<td>yes | no; ~~Default~~: no</td>

+

<td>yes | no; default: no</td>

<td>Allows WebUI access for hosts in the VPN network.</td>

</tr>

<tr>

<td>Custom options</td>

−

<td>ipsec options; ~~Default~~: none</td>

+

<td>ipsec options; default: none</td>

<td>Provides the possibility to further customize the connection by adding extra IPsec options.</td>

</tr>

Line 684: Line 685:

<tr>

<td>Encryption algorithm</td>

−

<td>DES | 3DES | AES128 | AES192 | AES256; ~~Default~~: 3DES</td>

+

<td>DES | 3DES | AES128 | AES192 | AES256; default: 3DES</td>

<td>Algorithm used for data encryption.</td>

</tr>

<tr>

<td>Authentication/Hash algorithm</td>

−

<td>MD5 | SHA1 | SHA256 | SHA384 | SHA512; ~~Default~~: SHA1</td>

+

<td>MD5 | SHA1 | SHA256 | SHA384 | SHA512; default: SHA1</td>

<td>Algorithm used for exchanging authentication and hash information.</td>

</tr>

Line 699: Line 700:

<tr>

<td>Lifetime</td>

−

<td>integer; ~~Default~~: 8 hours</td>

+

<td>integer; default: 8 hours</td>

<td>Defines a time period after which the phase will re-initiate its exchange of information.</td>

</tr>

Dziugas

Bureaucrats, Interface administrators, Administrators

31,703

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rut manual vpn (view source)

Revision as of 09:07, 2 July 2019

Navigation menu

Personal tools

NAVIGATION

Tools

Categories