Update debian/rules, bump build dependencies in debian/control
[debian/iodine.git] / debian / iodine-jigger
1 #! /bin/bash
2
3 ### Script to set up an iodine tunnel route traffic through it
4 ###
5 ### Copyright 2008 Barak A. Pearlmutter <bap@debian.org>
6 ###
7 ### License: MIT
8 ###
9 ### Permission to use, copy, modify, and distribute this software for
10 ### any purpose with or without fee is hereby granted, provided that
11 ### the above copyright notice and this permission notice appear in
12 ### all copies.
13 ###
14 ### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
15 ### WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
16 ### WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
17 ### AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
18 ### CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
19 ### LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20 ### NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21 ### CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22
23 ## Cause script to bail immediately on failed command
24 set -e
25
26 ## Options for user to set.
27
28 ## Minimal customization: put the two lines
29 ##  subdomain=your.tunnel.sub.domain
30 ##  passwd=password_for_that_tunnel
31 ## in the file /etc/default/iodine-client.
32
33 echo "${iodine_client_rc:=/etc/default/iodine-client}" > /dev/null
34
35 if [ -r ${iodine_client_rc} ]; then
36     . ${iodine_client_rc}
37 else
38     echo WARNING: Cannot read ${iodine_client_rc}
39 fi
40
41 if [ -z ${subdomain} ]; then
42     read -p "DNS tunnel DNS subdomain: " subdomain
43 fi
44
45 if [ -z ${subdomain} ]; then
46     echo ERROR: Must set subdomain.
47     exit 1
48 fi
49
50 if [ -z ${passwd} ]; then
51     read -p "Password for DNS tunnel over ${subdomain}: " passwd
52 fi
53
54 ## This is a host name used for testing DNS and for pinging
55 echo "${testhost:=slashdot.org}"                > /dev/null
56
57 ## Set if local network should be taken down and then up
58 echo "${bounce_localnet:=true}"                 > /dev/null
59
60 ## Set for testing network availability via ping at various points
61 echo "${test_ping_localnet:=true}"              > /dev/null
62 echo "${test_ping_tunnel:=true}"                > /dev/null
63 echo "${test_ping_final:=true}"                 > /dev/null
64
65 ## Set if the script cannot find and then incorrectly guesses the
66 ## local network router
67 echo "${default_router}"                        > /dev/null
68
69 ## Set if script uses the wrong hardware interface
70 echo "${interface}"                             > /dev/null
71
72 ## Set if the script should continue even if a command fails.
73 ## Used to test script when running as non-root.
74 if [ $(whoami) = root ]; then
75     echo "${continue_on_error:=false}"          > /dev/null
76 else
77     echo "${continue_on_error:=true}"           > /dev/null
78 fi
79
80 ## DEBIAN PACKAGES TO INSTALL: these are needed to run this script
81 ##  iodine (for /usr/sbin/iodine)
82 ##  iproute (for /bin/ip)
83 ##  ipcalc (for /usr/bin/ipcalc)
84 ##  dnsutils (for /usr/bin/dig)
85 ##  fping (for /usr/bin/fping)
86 ##  gawk (for /usr/bin/gawk, to use gensub())
87
88 ## The default tunnel MTU is 1024.
89 ## If local DNS server restricts to 512 byte packets then do this:
90 # ifconfig ${d} mtu 220
91
92 ## TO DO
93 ## - avoid double ping when DNS server and local router are the same
94 ## - option to not kill existing iodine DNS tunnels, in case there
95 ##   are meant to be more than one
96 ## - sanify check whether default_router is on local network
97
98 echo ==== Creating IP-over-DNS tunnel over local network connection...
99
100
101 ## Find a network interface
102
103 if [ -z ${interface} ]; then
104     interface=$(tail --lines=+3 /proc/net/wireless \
105         | head -1 | tr -d : | awk '{print $1}')
106 fi
107
108 if [ -z ${interface} ]; then
109     interface=$(ifconfig -a | egrep '^[^ ].*encap:Ethernet' \
110         | head -1 | awk '{print $1}')
111 fi
112
113 if [ -z ${interface} ]; then
114     echo ERROR: No network interface found.
115     exit 1
116 fi
117
118 echo ==== Local network interface: ${interface}
119
120 ## Down any existing DNS tunnel (wish there were "approved" way to do this)
121
122 echo ==== Killing existing DNS tunnels...
123 if killall --quiet --wait --verbose --signal HUP iodine; then
124     sleep 2
125 fi
126
127 ## Stabilize local network
128
129 if ${bounce_localnet}; then
130     echo ==== Bouncing local network connection...
131     ifdown --force ${interface} || true
132     ifup ${interface} || ${continue_on_error}
133 fi
134
135 ## Fetch some information about the local network
136
137 addr=$(ip -4 addr show dev ${interface} scope global \
138     | tail -1 | awk '{print $2}')
139 prefix_len=$(echo ${addr} | sed 'sX^.*/XX')
140 local_net=$(ipcalc --nobinary ${addr} | awk '$1=="Network:" {print $2}')
141
142 echo ==== Local address: ${addr}
143 echo ==== Local network: ${local_net}
144
145 router=$(ip -4 route list dev ${interface} \
146     | awk '$1=="default" {print $3}' | head -1)
147 if [ -z ${router} ]; then
148     ## This can happen when the default local route is already deleted
149     if [ -z ${default_router} ]; then
150         echo WARNING: no default route, guessing local router IP address.
151         ## Minimum address on local net is usually right
152         router=$(ipcalc --nobinary ${addr} | awk '$1=="HostMin:" {print $2}')
153     else
154         echo WARNING: no default route, using configured default router.
155         ## But sometimes need to hardwire...
156         router=${default_router}
157     fi
158 fi
159
160 echo ==== Local network router: ${router}
161
162 ## Test DNS service
163
164 testhost_ip=$(dig +short -t A -q ${testhost})
165 if [ -z ${testhost_ip} ]; then
166     echo WARNING: Failure on DNS lookup of ${testhost}.
167 fi
168
169 ## fetch DNS servers
170
171 nameservers=$(awk '$1=="nameserver" {print $2}' /etc/resolv.conf)
172 if [ -n "${nameservers}" ]; then
173     echo ==== DNS servers: ${nameservers}
174 else
175     echo ERROR: No DNS servers found.
176     exit 1
177 fi
178
179 ## Test if local network is up
180
181 if ${test_ping_localnet}; then
182     echo ==== Ping test of  local network router and DNS servers...
183     fping -C1 ${router} ${nameservers} \
184         || echo WARNING: Ping test failed.
185 fi
186
187 ## Add point-to-point routes for any non-local DNS servers
188
189 for n in ${nameservers}; do
190     n_net=$(ipcalc --nobinary ${n}/${prefix_len} | awk '$1=="Network:" {print $2}')
191     if [ "${n_net}" != "${local_net}" ]; then
192         echo ==== Adding point-to-point route for DNS server ${n}
193         ## remove point-to-point route first, in case it is already present
194         ip -4 route del ${n}/32 || true
195         ip -4 route add ${n}/32 via ${router} || ${continue_on_error}
196     fi
197 done
198
199 ## Bring up DNS tunnel
200
201 echo ==== Creating IP-over-DNS tunnel...
202 iodine -P "${passwd}" "${subdomain}" || ${continue_on_error}
203
204 ## Find DNS tunnel interface
205
206 tunnel_interface=$(ifconfig -a | egrep '^dns' | awk '{print $1}' | head -1)
207 if [ -z "${tunnel_interface}" ]; then
208     echo WARNING: Cannot find DNS tunnel interface, using default.
209     tunnel_interface=dns0
210 fi
211 echo ==== DNS tunnel interface: ${tunnel_interface}
212
213 ## Figure out router at other end of tunnel, assuming router uses final octet .1
214 ## (There should be some way to get this information out of iodine, since
215 ## it *prints* it as it sets up the tunnel, so it does know it.)
216
217 tunnel_remote=$(ip -4 address show dev ${tunnel_interface} \
218     | gawk '$1=="inet" {print gensub("[.][0-9]*/.*", ".1", 1, $2)}' | head -1)
219
220 if [ -z ${tunnel_remote} ]; then
221     echo ERROR: Cannot find DNS tunnel remote endpoint.
222     ${continue_on_error}
223     ## set something random if debugging
224     echo WARNING: Confabulating DNS tunnel remote endpoint.
225     tunnel_remote=192.168.253.1
226 fi
227
228 echo ==== DNS tunnel remote endpoint: ${tunnel_remote}
229
230 if ${test_ping_tunnel}; then
231     echo ==== Ping test of local router, nameserver, and DNS tunnel...
232     fping -C1 ${router} ${nameservers} ${tunnel_remote} \
233         || echo WARNING: Ping test failed.
234 fi
235
236 ## Modify routing table to send trafic via DNS tunnel
237
238 echo ==== Setting default route through DNS tunnel...
239
240 ## Remove default route via local router
241 ip -4 route del default via ${router} || ${continue_on_error}
242 ## Add default via tunnel
243 ip -4 route add default via ${tunnel_remote} || ${continue_on_error}
244
245 ## Test if all is well
246
247 if ${test_ping_final}; then
248     echo ==== Ping test of local router, nameserver, DNS tunnel, external test host...
249     fping -C1 ${router} ${nameservers} ${tunnel_remote} ${testhost_ip:-${testhost}} \
250         || echo WARNING: Ping test failed.
251 fi