OpenVPN docs: converted to utf-8-unix encoding to remove DOS line endings 28/head
authorChristopher Howard <christopher.howard@qlfiles.net>
Tue, 2 Jan 2018 20:07:57 +0000 (11:07 -0900)
committerChristopher Howard <christopher.howard@qlfiles.net>
Tue, 2 Jan 2018 20:07:57 +0000 (11:07 -0900)
docs/OpenVPN_Layer_2_Server.md

index 149559ff99772ba0ee69b4d83d0533dd0e2c2ed5..2ecb817f9b163f9ec4ba09abddc14498273aea68 100644 (file)
@@ -1,95 +1,95 @@
-# OpenVPN Layer 2 Server\r
-\r
-## Introduction\r
-\r
-Librecmc can operate as an OpenVPN server. OpenVPN technology connects\r
-two networks via an encrypted tunnel. With proper server, network, and\r
-client configuration, OpenVPN allows a client outside of your LAN to\r
-see the LAN as though it were physically connected to the LAN.\r
-\r
-OpenVPN can run in layer 2 or layer 3 mode. In layer 3 mode, the\r
-remote client sees your LAN as though it is on the other side of an IP\r
-router. In layer 2 mode, the remote client sees your LAN as though\r
-they are both on the same Data Link segment (e.g., the same Ethernet\r
-link). Layer 3 mode is easier to set up, but layer 2 mode is sometimes\r
-desired to give clients a more direct exposure to services on the LAN.\r
-\r
-## Warnings\r
-\r
-This information is provided for educational purposes only and is not\r
-meant to be a guide to best network security practices. Readers are\r
-advised to study all relevant OpenVPN and network security\r
-documentation.\r
-\r
-## Required LibreCMC packages\r
-\r
-* openvpn-openssl\r
-* openvpn-easy-rsa\r
-* luci-app-openvpn\r
-\r
-## Interface Setup\r
-\r
-TODO\r
-\r
-## Certificate and Key Setup Instructions\r
-\r
-```\r
-cd /etc/easy-rsa\r
-source vars\r
-clean-all\r
-build-ca\r
-build-dh\r
-build-key-server myvpn\r
-openvpn --genkey --secret /etc/easy-rsa/keys/ta.key\r
-```\r
-\r
-N.B.: Using easy-rsa is a straightforward approach, but it may be\r
-possible to produce more secure certificates using openssl directly.\r
-\r
-## Server configuration\r
-\r
-For the `server bridge` option: The first two parameters are the ip\r
-and netmask of the gateway on the bridged subnet. The next two\r
-parameters indicate the pool-start-IP and pool-end-IP, which is the\r
-part of your IP address pool that you have reserved just for VPN\r
-clients. You must to make sure that the DHCP server for your LAN is\r
-not leasing out those IP addresses to local (non-vpn) clients.\r
-\r
-/etc/config/openvpn\r
-```\r
-config openvpn 'myvpn'\r
-       option enabled '1'\r
-       option dev 'tap0'\r
-       option port '1194'\r
-       option proto 'udp'\r
-       option status '/var/log/openvpn_status.log'\r
-       option log '/tmp/openvpn.log'\r
-       option verb '3'\r
-       option mute '5'\r
-       option keepalive '10 120'\r
-       option persist_key '1'\r
-       option persist_tun '1'\r
-       option user 'nobody'\r
-       option group 'nogroup'\r
-       option ca '/etc/easy-rsa/keys/ca.crt'\r
-       option cert '/etc/easy-rsa/keys/myvpn.crt'\r
-       option key '/etc/easy-rsa/keys/myvpn.key'\r
-       option dh '/etc/easy-rsa/keys/dh2048.pem'\r
-       option tls_server '1'\r
-       option tls_auth '/etc/easy-rsa/keys/ta.key 0'\r
-       option server_bridge '10.0.0.1 255.255.255.0 10.0.0.201 10.0.0.220'\r
-       option topology 'subnet'\r
-       option client_to_client '1'\r
-       list push 'persist-key'\r
-       list push 'persist-tun'\r
-       list push 'redirect-gateway def1'\r
-       # allow your clients to access to your network\r
-       list push 'route 10.0.0.0 255.255.255.0'\r
-       # push DNS to your clients\r
-       list push 'dhcp-option DNS 10.0.0.1'\r
-        # option comp_lzo 'no'\r
-```\r
-\r
-## Client setup information\r
-\r
-TODO\r
+# OpenVPN Layer 2 Server
+
+## Introduction
+
+Librecmc can operate as an OpenVPN server. OpenVPN technology connects
+two networks via an encrypted tunnel. With proper server, network, and
+client configuration, OpenVPN allows a client outside of your LAN to
+see the LAN as though it were physically connected to the LAN.
+
+OpenVPN can run in layer 2 or layer 3 mode. In layer 3 mode, the
+remote client sees your LAN as though it is on the other side of an IP
+router. In layer 2 mode, the remote client sees your LAN as though
+they are both on the same Data Link segment (e.g., the same Ethernet
+link). Layer 3 mode is easier to set up, but layer 2 mode is sometimes
+desired to give clients a more direct exposure to services on the LAN.
+
+## Warnings
+
+This information is provided for educational purposes only and is not
+meant to be a guide to best network security practices. Readers are
+advised to study all relevant OpenVPN and network security
+documentation.
+
+## Required LibreCMC packages
+
+* openvpn-openssl
+* openvpn-easy-rsa
+* luci-app-openvpn
+
+## Interface Setup
+
+TODO
+
+## Certificate and Key Setup Instructions
+
+```
+cd /etc/easy-rsa
+source vars
+clean-all
+build-ca
+build-dh
+build-key-server myvpn
+openvpn --genkey --secret /etc/easy-rsa/keys/ta.key
+```
+
+N.B.: Using easy-rsa is a straightforward approach, but it may be
+possible to produce more secure certificates using openssl directly.
+
+## Server configuration
+
+For the `server bridge` option: The first two parameters are the ip
+and netmask of the gateway on the bridged subnet. The next two
+parameters indicate the pool-start-IP and pool-end-IP, which is the
+part of your IP address pool that you have reserved just for VPN
+clients. You must to make sure that the DHCP server for your LAN is
+not leasing out those IP addresses to local (non-vpn) clients.
+
+/etc/config/openvpn
+```
+config openvpn 'myvpn'
+       option enabled '1'
+       option dev 'tap0'
+       option port '1194'
+       option proto 'udp'
+       option status '/var/log/openvpn_status.log'
+       option log '/tmp/openvpn.log'
+       option verb '3'
+       option mute '5'
+       option keepalive '10 120'
+       option persist_key '1'
+       option persist_tun '1'
+       option user 'nobody'
+       option group 'nogroup'
+       option ca '/etc/easy-rsa/keys/ca.crt'
+       option cert '/etc/easy-rsa/keys/myvpn.crt'
+       option key '/etc/easy-rsa/keys/myvpn.key'
+       option dh '/etc/easy-rsa/keys/dh2048.pem'
+       option tls_server '1'
+       option tls_auth '/etc/easy-rsa/keys/ta.key 0'
+       option server_bridge '10.0.0.1 255.255.255.0 10.0.0.201 10.0.0.220'
+       option topology 'subnet'
+       option client_to_client '1'
+       list push 'persist-key'
+       list push 'persist-tun'
+       list push 'redirect-gateway def1'
+       # allow your clients to access to your network
+       list push 'route 10.0.0.0 255.255.255.0'
+       # push DNS to your clients
+       list push 'dhcp-option DNS 10.0.0.1'
+        # option comp_lzo 'no'
+```
+
+## Client setup information
+
+TODO