Browse Source
vpnbypass: updates to 1.3.2-1
bugfix: domain names bypass rename config file update Makefile updated README link updated shellcheck compatibility support for 21.02.0-rc2 and later updated code for interface triggers add newline to test.sh Signed-off-by: Stan Grishin <stangri@melmac.net>lilik-openwrt-22.03
Stan Grishin
3 years ago
5 changed files with 38 additions and 132 deletions
Unified View
Diff Options
-
+7 -13net/vpnbypass/Makefile
-
+2 -99net/vpnbypass/files/README.md
-
+0 -0net/vpnbypass/files/vpnbypass.config
-
+28 -19net/vpnbypass/files/vpnbypass.init
-
+1 -1net/vpnbypass/test.sh
+ 7
- 13
net/vpnbypass/Makefile
View File
+ 2
- 99
net/vpnbypass/files/README.md
View File
| @ -1,100 +1,3 @@ | |||||
| <!-- markdownlint-disable MD013 --> | |||||
| # VPN Bypass | |||||
| # README | |||||
| [](http://hits.dwyl.com/stangri/openwrt/vpnbypass) | |||||
| A simple [procd](https://openwrt.org/docs/techref/procd)-based ```vpnbypass``` service for OpenWrt/LEDE Project. This is useful if your router accesses Internet through a VPN client/tunnel, but you want specific traffic (ports, IP ranges, domains or local IP ranges) to be routed outside of this tunnel. | |||||
| ## Features | |||||
| - Define local ports so traffic to them is routed outside of the VPN tunnel (by default it routes Plex Media Server traffic (port 32400) outside of the VPN tunnel). | |||||
| - Define IPs/subnets in local networks so their traffic is routed outside the VPN tunnel (by default it routes traffic from 192.168.1.81-192.168.1.87 outside the VPN tunnel). | |||||
| - Define remote IP ranges that are accessed outside the VPN tunnel (by default, LogmeIn Hamachi traffic (25.0.0.0/8) is routed outside the VPN tunnel). | |||||
| - Creates list of domain names which should be accessed outside the VPN tunnel (useful for Netflix, Hulu, etc). | |||||
| - Does not reside in RAM -- creates `iptables` rules which are automatically updated on WAN up/down events. | |||||
| - A companion package (`luci-app-vpnbypass`) is provided so all features may be configured from the Web UI. | |||||
| - Proudly made in Canada, using locally-sourced electrons. | |||||
| ## Screenshot (luci-app-vpnbypass) | |||||
|  | |||||
| ## Requirements | |||||
| This service requires the following packages to be installed on your router: ```ipset``` and ```iptables```. Additionally, if you want to use the Domain Bypass feature, you need to install ```dnsmasq-full``` (```dnsmasq-full``` requires you uninstall ```dnsmasq``` first). | |||||
| To fully satisfy the requirements for both IP/Port VPN Bypass and Domain Bypass features connect via ssh to your router and run the following commands: | |||||
| ```sh | |||||
| opkg update; opkg remove dnsmasq; opkg install ipset iptables dnsmasq-full | |||||
| ``` | |||||
| To satisfy the requirements for just IP/Port VPN Bypass connect to your router via ssh and run the following commands: | |||||
| ```sh | |||||
| opkg update; opkg install ipset iptables | |||||
| ``` | |||||
| ### Unmet dependencies | |||||
| If you are running a development (trunk/snapshot) build of OpenWrt/LEDE Project on your router and your build is outdated (meaning that packages of the same revision/commit hash are no longer available and when you try to satisfy the [requirements](#requirements) you get errors), please flash either current LEDE release image or current development/snapshot image. | |||||
| ## How to install | |||||
| <!--- | |||||
| #### From Web UI/Luci | |||||
| Navigate to System->Software page on your router and then perform the following actions: | |||||
| 1. Click "Update Lists" | |||||
| 2. Wait for the update process to finish. | |||||
| 3. In the "Download and install package:" field type ```vpnbypass luci-app-vpnbypass``` | |||||
| 4. Click "OK" to install ```vpnbypass``` and ```luci-app-vpnbypass``` | |||||
| If you get an ```Unknown package 'vpnbypass'``` error, your router is not set up with the access to a repository containing these packages and you need to add the custom repository to your router first. | |||||
| #### From console/ssh | |||||
| ---> | |||||
| Please ensure that the [requirements](#requirements) are satisfied and install ```vpnbypass``` and ```luci-app-vpnbypass``` from the Web UI or connect to your router via ssh and run the following commands: | |||||
| ```sh | |||||
| opkg update | |||||
| opkg install vpnbypass luci-app-vpnbypass | |||||
| ``` | |||||
| If these packages are not found in the official feed/repo for your version of OpenWrt/LEDE Project, you will need to add a custom repo to your router following instructions on [GitHub](https://github.com/stangri/openwrt_packages/blob/master/README.md#on-your-router)/[jsDelivr](https://cdn.jsdelivr.net/gh/stangri/openwrt_packages/README.md#on-your-router) first. | |||||
| These packages have been designed to be backwards compatible with OpenWrt 19.07, OpenWrt 18.06, LEDE Project 17.01 and OpenWrt 15.05. However, on systems older than OpenWrt 18.06.6 and/or a system which has deviated too far (or haven't been updated to keep in-sync) with official OpenWrt release you may get a message about missing ```luci-compat``` dependency, which (and only which) you can safely ignore and force-install the luci app using ```opkg install --force-depends``` command instead of ```opkg install```. | |||||
| ## Default Settings | |||||
| The default configuration ships with the service disabled, use the Web UI to enable/start the service or run ```uci set vpnbypass.config.enabled=1; uci commit vpnbypass;```. It routes Plex Media Server traffic (port 32400) and LogmeIn Hamachi traffic (25.0.0.0/8) outside of the VPN tunnel. Internet traffic from local IPs `192.168.1.81-192.168.1.87` is also routed outside the VPN tunnel. You can safely delete these example rules if they do not apply to you. | |||||
| ## Documentation / Discussion | |||||
| Please head to [OpenWrt Forum](https://forum.openwrt.org/t/vpn-bypass-split-tunneling-service-luci-ui/1106) for discussions of this service. | |||||
| ### Bypass Domains Format/Syntax | |||||
| Domain lists should be in the following format/syntax: ```/domain1.com/domain2.com/vpnbypass```. Please do not forget the leading ```/``` and trailing ```/vpnbypass```. There is no validation if you enter something incorrectly -- it simply will not work. Please see [Notes/Known Issues](#notesknown-issues) if you wish to edit this setting manually, without using the Web UI. | |||||
| ## What's New | |||||
| 1.3.0: | |||||
| - No longer depends on hardcoded WAN interface name (```wan```) works with other interface names (like ```wwan```). | |||||
| - Table ID, IPSET name and FW_MARK as well as FW_MASK can be defined in config file. | |||||
| - Uses iptables, not ip rules for handling local IPs/ranges. | |||||
| - More reliable creation/destruction of VPNBYPASS iptables chain. | |||||
| - Updated Web UI enables, starts and stops the service. | |||||
| ## Notes/Known Issues | |||||
| 1. Domains to be accessed outside of VPN tunnel are handled by dnsmasq and thus are not defined in ```/etc/config/vpnpass```, but rather in ```/etc/config/dhcp```. To add/delete/edit domains you can use VPN Bypass Web UI or you can edit ```/etc/config/dhcp``` manually or run the following commands: | |||||
| ```sh | |||||
| uci add_list dhcp.@dnsmasq[-1].ipset='/github.com/plex.tv/google.com/vpnbypass' | |||||
| uci add_list dhcp.@dnsmasq[-1].ipset='/hulu.com/netflix.com/nhl.com/vpnbypass' | |||||
| uci commit dhcp | |||||
| /etc/init.d/dnsmasq restart | |||||
| ``` | |||||
| This feature requires ```dnsmasq-full``` to work. See the [Requirements](#requirements) section for more details. | |||||
| README has been moved to [https://docs.openwrt.melmac.net/vpnbypass/](https://docs.openwrt.melmac.net/vpnbypass/). | |||||
net/vpnbypass/files/vpnbypass.conf → net/vpnbypass/files/vpnbypass.config
View File
+ 28
- 19
net/vpnbypass/files/vpnbypass.init
View File
+ 1
- 1
net/vpnbypass/test.sh
View File
| @ -1,3 +1,3 @@ | |||||
| #!/bin/sh | #!/bin/sh | ||||
| /etc/init.d/"$1" version 2>&1 | grep "$2" | |||||
| /etc/init.d/"$1" version 2>&1 | grep "$2" | |||||