├── 02tun2socks ├── sample ├── Makefile ├── tun2socks-manager.conf.sample ├── README.md ├── tun2socks-manager └── LICENSE /02tun2socks: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | IF=$1 4 | STATUS=$2 5 | 6 | # We must exclude tun* device, but let's white list instead 7 | [[ $IF =~ ^eth[0-9] || $IF =~ ^wlan[0-9] || $IF =~ ^wl.[0-9] || $IF =~ ^en.[0-9] ]] || exit 0 8 | 9 | case "$2" in 10 | up | down) 11 | /usr/local/bin/tun2socks-manager update $IF $STATUS 12 | ;; 13 | esac 14 | -------------------------------------------------------------------------------- /sample: -------------------------------------------------------------------------------- 1 | # tun2socks-manager - example of network configuration 2 | # 3 | # Create a copy of this file in /etc/tun2socks-manager.d, using 4 | # network gateway as name. E.g. /etc/tun2socks-manager.d/192.168.1.1 for 5 | # gateway 192.168.1.1. 6 | 7 | # Must make sure that the local routes will preserve SSH connection 8 | # So either IP of the SSH server, or if connected via a proxy, 9 | # add the IP of that proxy. 10 | local 10.0.0.0/8 11 | local 172.19.0.0.0/16 12 | local 192.168.0.0/16 13 | 14 | locate 123.123.0.0/16 # Some corporate subnet to preserve 15 | 16 | # If no dns config, we will keep the one set by the NetworkManager 17 | dns 192.168.1.2 /example.com/ # Use some corporate DNS at 192.168.1.2, for resolution of *.example.com 18 | dns 8.8.8.8 # A general DNS server 19 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: 2 | @echo "Run 'make install' as root to install this script." 3 | 4 | SHELL:=/bin/bash 5 | BASE=tun2socks-manager 6 | BIN_DIR:=/usr/local/bin 7 | BIN:=$(BASE) 8 | 9 | .PHONY: install reconfigure uninstall purge 10 | 11 | install: 12 | [ $$(whoami) == "root" ] 13 | cp $(BIN) $(BIN_DIR)/$(BIN) 14 | mkdir -p /etc/NetworkManager/dispatcher.d 15 | cp 02tun2socks /etc/NetworkManager/dispatcher.d/ 16 | mkdir -p /etc/$(BASE).d 17 | cp -r sample /etc/$(BASE).d/ 18 | cp $(BASE).conf.sample /etc/ 19 | [ -e /etc/$(BASE).conf ] || mv /etc/$(BASE).conf.sample /etc/$(BASE).conf 20 | $(BIN_DIR)/$(BIN) install 21 | 22 | reconfigure: 23 | $(BIN_DIR)/$(BIN) uninstall 24 | $(BIN_DIR)/$(BIN) install 25 | 26 | uninstall: 27 | [ $$(whoami) == "root" ] 28 | [ -x $(BIN_DIR)/$(BIN) ] && $(BIN_DIR)/$(BIN) uninstall || true 29 | rm -f $(BIN_DIR)/$(BIN) 30 | rm -f /etc/NetworkManager/dispatcher.d/02tun2socks 31 | 32 | purge: uninstall 33 | [ $$(whoami) == "root" ] 34 | rm -rf /etc/$(BASE).d 35 | rm -f /etc/$(BASE).conf.sample /etc/$(BASE).conf 36 | 37 | -------------------------------------------------------------------------------- /tun2socks-manager.conf.sample: -------------------------------------------------------------------------------- 1 | ######################################################################## 2 | # tun2socks proxy 3 | ######################################################################## 4 | 5 | # Address and port of SSH SOCKS5 proxy to tunnel through. 6 | # This is the address given to SSH with '-D' parameter. 7 | #TUN2SOCKS_PROXY=127.0.0.1:1080 8 | 9 | # Address and port of udpgw proxy on remote SSH server. 10 | # This is the address given to badvpn-udpgw with '--listen-addr' 11 | # parameter on the remote SSH server. 12 | # Leave empty if badvpn-udpgw does not run on remote SSH server. 13 | #TUN2SOCKS_UDPGW_REMOTE=127.0.0.1:7300 14 | 15 | # badvpn-tun2socks log level (0-5/none/error/warning/notice/info/debug). 16 | #TUN2SOCKS_LOGLEVEL=none 17 | 18 | ######################################################################## 19 | # Virtual tun/tap interface 20 | ######################################################################## 21 | 22 | # IP address of tun/tap interface. 23 | #TUN_IP=10.0.10.1 24 | 25 | # CIDR mask of tun/tap interface. 26 | #TUN_IP_CIDR=24 27 | 28 | # IP address of tun/tap gateway. 29 | #TUN_IP_GW=10.0.10.2 30 | 31 | # tun/tap interface name. 32 | #TUN_IF=tun0 33 | 34 | ######################################################################## 35 | # Route table 36 | # 37 | # There should be no need to edit settings below. 38 | ######################################################################## 39 | 40 | # The name of the route table in iproute2. 41 | #IPROUTE_TABLE=tun 42 | 43 | # The ID of the route table (as in /etc/iproute2/rt_tables). 44 | #IPROUTE_TABLE_ID=100 45 | 46 | # The priority of the routing table in routing rules. 47 | # This priority must be lower than the one of the main routing table. 48 | #IPROUTE_TABLE_PRIO=1000 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tun2socks-manager 2 | 3 | Manage automatically SOCKS5 tunnel created with 4 | [tun2socks](https://github.com/ambrop72/badvpn/wiki/Tun2socks) from package 5 | [badvpn](https://github.com/ambrop72/badvpn). This allows for setting up a cheap VPN on top of 6 | for instance an SSH tunnel. 7 | 8 | ## Install client 9 | 10 | Install `dnsmasq-base`: 11 | 12 | ``` bash 13 | sudo apt install dnsmasq-base 14 | sudo vi /etc/NetworkManager/NetworkManager.conf 15 | # Edit as follows: 16 | # [main] 17 | # plugins=ifupdown,keyfile 18 | # +dns=dnsmasq 19 | sudo vi /etc/dhcp/dhclient.conf 20 | # Edit as follows: 21 | # #supersede domain-name "fugue.com home.vix.com"; 22 | # -#prepend domain-name-servers 127.0.0.1; 23 | # +prepend domain-name-servers 127.0.0.1; 24 | ``` 25 | 26 | Build `badvpn-tun2socks` from source: 27 | 28 | ``` bash 29 | sudo apt install cmake 30 | git clone https://github.com/ambrop72/badvpn.git 31 | cd badvpn 32 | mkdir badvpn-build 33 | cd badvpn-build 34 | cmake .. -DBUILD_NOTHING_BY_DEFAULT=1 -DBUILD_TUN2SOCKS=1 35 | make 36 | sudo cp tun2socks/badvpn-tun2socks /usr/local/bin 37 | ``` 38 | 39 | Install `tun2socks-manager`: 40 | 41 | ``` bash 42 | cd tun2socks-manager 43 | sudo make install 44 | ``` 45 | 46 | ## Install server 47 | 48 | By default tun2socks is configured to use UDP forwarding (parameter `TUN2SOCKS_UDPGW_REMOTE`) for better 49 | performance. This requires running `badvpn-udpgw` on the server side (as standard user, no root access 50 | mandatory). For instance: 51 | 52 | ``` bash 53 | git clone https://github.com/ambrop72/badvpn.git 54 | cd badvpn 55 | mkdir badvpn-build 56 | cd badvpn-build 57 | cmake .. -DBUILD_NOTHING_BY_DEFAULT=1 -DBUILD_UDPGW=1 58 | make 59 | sudo cp badvpn-udpgw /usr/local/bin # if no root: install in ~/bin 60 | ``` 61 | 62 | Then we need to run it automatically. Using systemd, we first create a service file 63 | `/etc/systemd/system/udpgw.service` containing: 64 | 65 | [Unit] 66 | Description=UDP forwarding for badvpn-tun2socks 67 | After=nss-lookup.target 68 | 69 | [Service] 70 | ExecStart=/usr/local/bin/badvpn-udpgw --loglevel none --listen-addr 127.0.0.1:7300 71 | User=udpgw 72 | 73 | [Install] 74 | WantedBy=multi-user.target 75 | 76 | Then we create the user, and enable / start the service: 77 | 78 | ```bash 79 | sudo useradd -m udpgw 80 | sudo systemctl enable udpgw 81 | sudo systemctl start udpgw 82 | ``` 83 | 84 | An non-root alternative is to edit the crontab (`crontab -e`) and add a user `@reboot` event: 85 | 86 | @reboot sleep 15 && ~/bin/badvpn-udpgw --loglevel none --listen-addr 127.0.0.1:7300 87 | 88 | ## Configure 89 | 90 | See file `/etc/tun2socks-manager.conf` and per-connection sample file in `/etc/tun2socks-manager.d`. 91 | 92 | ## Troubleshooting 93 | 94 | ### Error org.freedesktop.DBus.Error.ServiceUnknown with dnsmasq 95 | 96 | Error org.freedesktop.DBus.Error.ServiceUnknown: The name org.freedesktop.NetworkManager.dnsmasq 97 | was not provided by any .service files 98 | 99 | This is likely because `dnsmasq` is not running. Check that NetworkManager started it in background. 100 | Otherwise follows the install instructions above. 101 | 102 | ``` bash 103 | ps faux | grep dnsmasq 104 | # nobody 128496 0.0 0.0 12976 4548 ? S 10:06 0:00 /usr/sbin/dnsmasq --no-resolv 105 | # --keep-in-foreground --no-hosts --bind-interfaces --pid-file=/run/NetworkManager/dnsmasq.pid 106 | # --listen-address=127.0.0.1 --cache-size=400 --clear-on-reload --conf-file=/dev/null --proxy-dnssec 107 | # --enable-dbus=org.freedesktop.NetworkManager.dnsmasq --conf-dir=/etc/NetworkManager/dnsmasq.d 108 | ``` 109 | 110 | Also check that the parameter given to `--enable-dbus` matches the expected string. 111 | 112 | ### WiFi hot-spot no longer working ### 113 | 114 | The script heavily interferes with the routing table, and may interfere with the routing of IP packets 115 | from the WiFi interface. In particular, if the computer is also used as hotspot, the routing may be 116 | broken. 117 | 118 | $ ip route 119 | default via 10.137.3.254 dev enp0s31f6 proto dhcp metric 100 120 | 10.0.10.0/24 dev tun0 proto kernel scope link src 10.0.10.1 121 | 10.42.0.0/24 dev wlp1s0 proto kernel scope link src 10.42.0.1 metric 600 122 | 10.137.2.0/23 dev enp0s31f6 proto kernel scope link src 10.137.2.174 metric 100 123 | 124 | We see we have a dedicated route for the hotspot on itf wlsp1s0. However when looking in the tun 125 | table, we don't find such routing, but instead the routing is caught in a general routing rule. 126 | 127 | $ ip route show table tun 128 | default via 10.0.10.2 dev tun0 129 | 10.0.0.0/8 via 10.137.3.254 dev enp0s31f6 130 | 10.0.10.0/24 dev tun0 proto kernel scope link src 10.0.10.1 131 | 10.137.2.0/23 dev enp0s31f6 proto kernel scope link src 10.137.2.174 132 | ... 133 | 134 | To fix this, we must duplicate the hotspot routing rule in the tun table: 135 | 136 | sudo ip route add 10.42.0.0/24 dev wlp1s0 proto kernel scope link src 10.42.0.1 metric 600 table tun 137 | 138 | ## Debugging 139 | 140 | Messages are sent to `/var/log/messages`: 141 | 142 | ``` bash 143 | grep tun2socks-manager /var/log/messages 144 | ``` 145 | 146 | When troubleshooting, it helps to follow these messages in a separate window. For instance: 147 | 148 | ``` bash 149 | tail -f /var/log/messages 150 | ``` 151 | 152 | `tun2socks-manager` is installed as a Network Manager (NM) dispatcher script. When NM starts, 153 | it launches the tun2socks-manager with: 154 | 155 | ``` bash 156 | /usr/local/bin/tun2socks-manager start 157 | ``` 158 | 159 | Then, NM sends `up` or `down` event to the script, which updates the routing table based on configuration 160 | files in `/etc/tun2socks-manager.d/` . This can be triggered manually with: 161 | 162 | ``` bash 163 | /usr/local/bin/tun2socks-manager update eth0 up # Simulate up event on itf eth0 164 | ``` 165 | 166 | [//]: # ( vim: set tw=105 sw=4 fo=tcq2 spell: ) 167 | -------------------------------------------------------------------------------- /tun2socks-manager: -------------------------------------------------------------------------------- 1 | #! /bin/bash 2 | 3 | BASE=$(basename $0) 4 | CONFIG_MAIN_FILE=/etc/tun2socks-manager.conf 5 | CONFIG_GW_DIR=/etc/tun2socks-manager.d 6 | STATE=/var/run/$BASE 7 | 8 | # Read configuration. First set default values, then source local config 9 | TUN2SOCKS_PROXY=127.0.0.1:1080 10 | TUN2SOCKS_UDPGW_REMOTE=127.0.0.1:7300 11 | TUN2SOCKS_LOGLEVEL=none 12 | TUN_IP=10.0.10.1 13 | TUN_IP_CIDR=24 14 | TUN_IP_GW=10.0.10.2 15 | TUN_IF=tun0 16 | IPROUTE_TABLE=tun 17 | IPROUTE_TABLE_ID=100 18 | IPROUTE_TABLE_PRIO=1000 19 | 20 | . $CONFIG_MAIN_FILE 21 | 22 | # Functions to manipulate ip addresses 23 | ip_to_int() 24 | { 25 | local IP=$1 26 | echo $(( $(echo $IP | sed -r 's/^/(((/; s/\./)*256+/g') )) 27 | } 28 | 29 | cidr_to_int() 30 | { 31 | local CIDR=$1 32 | echo $(( (0xFFFFFFFF << (32-CIDR)) & 0xFFFFFFFF )) 33 | } 34 | 35 | int_to_ip() 36 | { 37 | local INT=$1 38 | local IP3=$(( (INT >> 24) & 0xFF )) 39 | local IP2=$(( (INT >> 16) & 0xFF )) 40 | local IP1=$(( (INT >> 8) & 0xFF )) 41 | local IP0=$(( INT & 0xFF )) 42 | echo "$IP3.$IP2.$IP1.$IP0" 43 | } 44 | 45 | cidr_to_mask() 46 | { 47 | local CIDR=$1 48 | int_to_ip $(cidr_to_int $CIDR) 49 | } 50 | 51 | ip_cidr_to_subnet() 52 | { 53 | local IP_INT=$(ip_to_int $1) 54 | local CIDR_INT=$(cidr_to_int $2) 55 | int_to_ip $((IP_INT & CIDR_INT)) 56 | } 57 | 58 | # 1: warning or non-permanent error 59 | # 3: permanent error (typically configuration error) 60 | die() 61 | { 62 | CODE=$1 63 | shift 64 | syslog_err "Error! $@" 65 | exit $CODE 66 | } 67 | 68 | syslog_err() 69 | { 70 | >&2 echo "$BASE: $@" 71 | syslog "$@" 72 | } 73 | 74 | syslog() 75 | { 76 | logger --id=$BASHPID -t $BASE -- "$@" 77 | } 78 | 79 | cmdlog() 80 | { 81 | # local txtrst=$'\e[0m' # Text Reset 82 | # local txtwht=$'\e[0;37m' # White 83 | 84 | # DEBUG - Uncomment lines below 85 | # >&2 echo "${txtwht}+ $@${txtrst}" 86 | # syslog "cmd: $@" 87 | "$@" 88 | } 89 | 90 | do_install() 91 | { 92 | # Skip if installed already 93 | egrep -q "^$IPROUTE_TABLE_ID $IPROUTE_TABLE\$" /etc/iproute2/rt_tables && return 0 94 | # Error if ID already taken 95 | egrep -q "^$IPROUTE_TABLE_ID " /etc/iproute2/rt_tables && die 3 "Table id $IPROUTE_TABLE_ID already defined." 96 | 97 | # All ok - Create new routing table 98 | syslog "Creating routing table '$IPROUTE_TABLE' (id=$IPROUTE_TABLE_ID)." 99 | echo "$IPROUTE_TABLE_ID $IPROUTE_TABLE" >> /etc/iproute2/rt_tables 100 | } 101 | 102 | do_uninstall() 103 | { 104 | # Delete routing table. Only delete our entry 105 | if egrep -q "^$IPROUTE_TABLE_ID $IPROUTE_TABLE\$" /etc/iproute2/rt_tables ; then 106 | syslog "Deleting routing table '$IPROUTE_TABLE' (id=$IPROUTE_TABLE_ID)." 107 | cmdlog sed -i "/^$IPROUTE_TABLE_ID $IPROUTE_TABLE\$/d" /etc/iproute2/rt_tables 108 | fi 109 | } 110 | 111 | do_start() 112 | { 113 | # Create new tun/tap device if necessary 114 | if ! ip link show $TUN_IF &> /dev/null; then 115 | syslog "Creating new tun/tap device $TUN_IF (name=$TUN_IF, ip4=$TUN_IP/$TUN_IP_CIDR)." 116 | cmdlog ip tuntap add dev $TUN_IF mode tun ${TUN_USER:+user $TUN_USER} 117 | cmdlog ip address add $TUN_IP/$TUN_IP_CIDR dev $TUN_IF 118 | fi 119 | 120 | # Start connection if not active yet 121 | if ! ip link show $TUN_IF | grep -q "[<,]UP[,>]" &> /dev/null; then 122 | syslog "Activating tun/tap device $TUN_IF." 123 | cmdlog ip link set dev $TUN_IF up 124 | fi 125 | 126 | # Start badvpn-tun2socks daemon if not running yet 127 | if ! pgrep badvpn-tun2sock &> /dev/null; then # pgrep is limited to the 15 characters in /proc/pid/stat 128 | syslog "Starting badvpn-tun2socks daemon." 129 | local TUN_IP_GW_MASK=$(cidr_to_mask $TUN_IP_CIDR) 130 | cmdlog su $TUN_USER -c "setsid -f badvpn-tun2socks --logger syslog --loglevel $TUN2SOCKS_LOGLEVEL \ 131 | --tundev $TUN_IF --netif-ipaddr $TUN_IP_GW --netif-netmask $TUN_IP_GW_MASK \ 132 | --socks-server-addr $TUN2SOCKS_PROXY ${TUN2SOCKS_UDPGW_REMOTE:+--udpgw-remote-server-addr $TUN2SOCKS_UDPGW_REMOTE}" 133 | fi 134 | } 135 | 136 | do_stop() 137 | { 138 | # Killing badvpn-tun2socks if it is running 139 | if pgrep badvpn-tun2sock &> /dev/null; then # pgrep is limited to the 15 characters in /proc/pid/stat 140 | syslog "Killing badvpn-tun2socks daemon." 141 | cmdlog pkill -9 badvpn-tun2sock 142 | fi 143 | 144 | # Delete tun/tap device $TUN_IF 145 | if ip link show $TUN_IF &> /dev/null; then 146 | syslog "Deleting interface $TUN_IF." 147 | ip tuntap delete dev $TUN_IF mode tun 148 | fi 149 | } 150 | 151 | get_current_gw_and_itf() 152 | { 153 | # Assuming pattern like: 154 | # 155 | # default via 10.137.3.254 dev enx3c18a0cff295 proto dhcp metric 100 156 | # 157 | read GW IF < <( ip route | awk -v TUN_IF=$TUN_IF 'BEGIN { metric=10000; IF="none"; GW="0.0.0.0" } { if($1 == "default" && $9 < metric && $5 != TUN_IF) { IF=$5; GW=$3; metric=$9 } } END { print GW " " IF }' ) 158 | } 159 | 160 | update_dnsmasq() 161 | { 162 | local CONFIG=$1 163 | syslog "Configuring upstream DNS servers in dnsmasq." 164 | syslog "- using '$CONFIG'." 165 | cmdlog dbus-send --system --print-reply --dest=org.freedesktop.NetworkManager.dnsmasq \ 166 | /uk/org/thekelleys/dnsmasq uk.org.thekelleys.SetDomainServers \ 167 | "array:string:$CONFIG" 168 | } 169 | 170 | do_up() 171 | { 172 | # Get current gateway and interface 173 | get_current_gw_and_itf 174 | syslog "Current gateway is $GW via interface $IF." 175 | if [ "$IF" == "none" ]; then 176 | > $STATE 177 | syslog "No default interface or gateway found." 178 | exit 0 179 | fi 180 | 181 | # Exit if we don't have a config file for the current gateway 182 | TUN_CFG_FILE=$CONFIG_GW_DIR/$GW 183 | if ! [ -e $TUN_CFG_FILE ]; then 184 | > $STATE 185 | syslog "No config for current gateway. Create file '$TUN_CFG_FILE' to setup a tunnel." 186 | exit 0 187 | fi 188 | 189 | # Add subnet route for tun0 (duplicate from main route) 190 | # ... When tun0 is up, kernel create a route in table main for subnet 10.0.10.0/24. 191 | # ... However our config may create another route in table tun that includes that subnet (e.g. 10.0.0.0/8). 192 | # ... If we don't duplicate kernet route in this table, this less specific route will take precedence, and 193 | # ... hence subnet 10.0.10.0/24 will become unreachable. 194 | syslog "Duplicating $TUN_IF link route from main table." 195 | local TUN_IP_SUBNET=$(ip_cidr_to_subnet $TUN_IP $TUN_IP_CIDR) 196 | TUN_ROUTE_MAIN=$(ip route | sed -rn "/^$TUN_IP_SUBNET\/$TUN_IP_CIDR/{s/linkdown +//; p}") 197 | [ -n "$TUN_ROUTE_MAIN" ] || die 1 "Cannot find $TUN_IF link route." 198 | cmdlog ip route add $TUN_ROUTE_MAIN table $IPROUTE_TABLE 199 | 200 | # We duplicate "proto kernel scope link" routes from the main table, to make sure these remain accessible 201 | syslog "Duplicating scope link routes from main table." 202 | while read subnet _dev dev _proto proto _scope scope _src src _metric metric ignore; do 203 | if [ "$_dev" == "dev" -a "$_proto" == "proto" -a "$_scope" == "scope" -a "$_src" == "src" ]; then 204 | if [ "$dev" != "$TUN_IF" -a "$proto" == "kernel" -a "$scope" == "link" ]; then 205 | if [ "$_metric" == "metric" ]; then 206 | syslog "Duplicating $subnet dev $dev proto $proto scope $scope src $src metric $metric" 207 | cmdlog ip route add $subnet dev $dev proto $proto scope $scope src $src metric $metric table $IPROUTE_TABLE 208 | else 209 | syslog "Duplicating $subnet dev $dev proto $proto scope $scope src $src" 210 | cmdlog ip route add $subnet dev $dev proto $proto scope $scope src $src table $IPROUTE_TABLE 211 | fi 212 | fi 213 | fi 214 | done < <(ip route) 215 | 216 | 217 | # Parsing configuration 218 | DNSMASQ_DNS_CONFIG= 219 | syslog "Applying configuration from file '$TUN_CFG_FILE'." 220 | while read CFG_TYPE A B C; do 221 | [ -n "$CFG_TYPE" ] || continue 222 | case $CFG_TYPE in 223 | local ) 224 | [[ $A =~ ^[0-9.]+(/[0-9]+)?$ ]] || die 3 "Bad route '$A' in file '$TUN_CFG_FILE'." 225 | syslog "- local route to net $A through interface $IF." 226 | cmdlog ip route add $A via $GW table $IPROUTE_TABLE 227 | ;; 228 | dns ) 229 | [[ $A =~ ^[0-9.]+$ ]] || die 3 "Bad DNS IP '$A' in file '$TUN_CFG_FILE'." 230 | if [ -n "$B" ]; then 231 | [[ $B =~ ^/[a-zA-Z_.-]*/$ ]] || die 3 "Bad DNS DOMAIN '$B' in file '$TUN_CFG_FILE'." 232 | DNSMASQ_DNS_CONFIG="${DNSMASQ_DNS_CONFIG:+$DNSMASQ_DNS_CONFIG,}$B$A" 233 | else 234 | DNSMASQ_DNS_CONFIG="${DNSMASQ_DNS_CONFIG:+$DNSMASQ_DNS_CONFIG,}$A" 235 | fi 236 | ;; 237 | *) 238 | die 3 "Unknown config '$CFG_TYPE'." 239 | esac 240 | done < <(sed -r 's/#.*//' "$TUN_CFG_FILE") 241 | 242 | syslog "Setting $TUN_IP_GW as default gateway in table $IPROUTE_TABLE." 243 | # Metric not needed. Will take precedence thanks to our new table and policy rule 244 | cmdlog ip route add default via $TUN_IP_GW table $IPROUTE_TABLE 245 | 246 | # Enable new routes and flush route cache 247 | syslog "Enabling route table '$IPROUTE_TABLE' and flushing cache." 248 | cmdlog ip rule add from all lookup $IPROUTE_TABLE prio $IPROUTE_TABLE_PRIO 249 | cmdlog ip route flush table cache 250 | 251 | echo "IF=$IF" > $STATE 252 | 253 | # Configure dnsmasq if necessary 254 | if [ -n "$DNSMASQ_DNS_CONFIG" ]; then 255 | update_dnsmasq "$DNSMASQ_DNS_CONFIG" 256 | echo "DNSMASQ_DNS_CONFIG=$DNSMASQ_DNS_CONFIG" >> $STATE 257 | fi 258 | } 259 | 260 | do_down() 261 | { 262 | > $STATE 263 | 264 | if ip rule | grep "^$IPROUTE_TABLE_PRIO" -q; then 265 | syslog "Removing rule for table $IPROUTE_TABLE." 266 | cmdlog ip rule del prio $IPROUTE_TABLE_PRIO 267 | fi 268 | 269 | # Remove all routes in tunnel table 270 | syslog "Flushing route table $IPROUTE_TABLE." 271 | cmdlog ip route flush table $IPROUTE_TABLE 272 | 273 | # Reset dnsmasq 274 | syslog "Reloading dnsmasq configuration." 275 | cmdlog pkill -SIGHUP NetworkManager # Reload dnsmasq configuration 276 | } 277 | 278 | usage() 279 | { 280 | echo "$BASE { install | uninstall | start | stop | up | down | update [IF] [STATUS] }" 281 | } 282 | 283 | check_root() 284 | { 285 | [ $(whoami) == "root" ] || die 3 "Run this script as root." 286 | } 287 | 288 | check_root 289 | 290 | shift $((OPTIND-1)) 291 | [ $# -ge 1 ] || usage 292 | COMMAND=$1 293 | shift 294 | 295 | # Only for update command 296 | CMD_IF=$1 297 | CMD_STATUS=$2 298 | 299 | syslog "Received command: $COMMAND${CMD_IF:+ $CMD_IF}${CMD_STATUS:+ $CMD_STATUS}." 300 | 301 | if [ "$COMMAND" = install ]; then 302 | do_install 303 | elif [ "$COMMAND" = uninstall ]; then 304 | do_down 305 | do_stop 306 | do_uninstall 307 | elif [ "$COMMAND" = start ]; then 308 | do_start 309 | elif [ "$COMMAND" = stop ]; then 310 | do_down 311 | do_stop 312 | elif [ "$COMMAND" = up ]; then 313 | do_start && do_up 314 | elif [ "$COMMAND" = down ]; then 315 | do_down 316 | elif [ "$COMMAND" = update ]; then 317 | if [ -n "$CMD_IF" -a "$CMD_STATUS" == down ]; then 318 | # An interface went down. Exit if we don't route through it 319 | if ! grep -q "^IF=$CMD_IF\$" $STATE; then 320 | DNSMASQ_DNS_CONFIG=$(<$STATE perl -lne 'print for /DNSMASQ_DNS_CONFIG=(.*)/g') 321 | if [ -n "$DNSMASQ_DNS_CONFIG" ]; then 322 | # NM may reconfigure dnsmasq in case an itf went down. 323 | # So let's make sure we keep our DNS settings. 324 | update_dnsmasq "$DNSMASQ_DNS_CONFIG" 325 | else 326 | syslog "No change needed in current tunnel." 327 | fi 328 | exit 0 329 | fi 330 | fi 331 | # We cannot do this if we want to restore hotspot route (that may went up and down separately) 332 | # if [ -n "$CMD_IF" -a "$CMD_STATUS" == up ]; then 333 | # # An interface went up. Exit if we route already through the (new) current gw 334 | # get_current_gw_and_itf 335 | # if grep -q "^IF=$IF\$" $STATE; then 336 | # syslog "No change needed in current tunnel (CMD_IF $CMD_IF)." 337 | # exit 0 338 | # fi 339 | # fi 340 | do_down && do_start && do_up 341 | else 342 | die 3 "Unknown command '$COMMAND'." 343 | fi 344 | 345 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------