tinc-vpn.org Git - wiki/blob - examples/redirect-gateway.mdwn

   1 [[!meta title="redirect-gateway"]]
   2
   3 ## Example: redirecting the default gateway to a host on the VPN
   4
   5 It is possible to have one node forward all of its network traffic to a host on the VPN,
   6 effectively using this VPN host as the default gateway.
   7 In OpenVPN, there is the `--redirect-gateway` option that does this for a client.
   8 With tinc, there is no such option, but the behaviour can be replicated with a host-up and host-down script.
   9 First there is an explaination of the theory behind redirecting the default gateway,
  10 then example scripts will follow.
  11
  12 [[!toc levels=2]]
  13
  14 ### Theory
  15
  16 Normally, there are two entries in the routing table.
  17 One is the route for the local network,
  18 which tells the kernel which IP addresses are directly reachable.
  19 The second is the "default gateway",
  20 which tells the kernel that in order to reach the rest of the Internet,
  21 traffic should be sent to the gateway of the local network.
  22 Usually the gateway is a router or firewall device,
  23 and its IPv4 address usually ends in `.1`.
  24 An example output of `route -n` on Linux:
  25
  26         Kernel IP routing table
  27         Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
  28         192.168.1.0     0.0.0.0         255.255.255.0   U     0      0        0 eth0
  29         0.0.0.0         192.168.1.1     0.0.0.0         UG    0      0        0 eth0
  30
  31 Here, the LAN has the IPv4 address range 192.168.1.0/24, and the gateway is 192.168.1.1.
  32 Suppose we have a VPN with address range 172.16.0.0/16, on which a server exists with address 172.16.1.1.
  33 If we have a VPN connection, and the client wants to replace the standard default route with a default route pointing to 172.16.1.1,
  34 then there is a problem: the kernel does not know anymore how to send the encapsulated VPN packets to the server anymore.
  35 So we need to add an exception for traffic to the real IP address of the VPN server.
  36 Suppose its real address is 192.0.32.10, then the routing table should become:
  37
  38         Kernel IP routing table
  39         Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
  40         172.16.1.1      0.0.0.0         255.255.255.255 UH    0      0        0 vpn
  41         192.0.32.10     192.168.1.1     255.255.255.255 UGH   0      0        0 eth0
  42         192.168.1.0     0.0.0.0         255.255.255.0   U     0      0        0 eth0
  43         0.0.0.0         172.16.1.1      0.0.0.0         UG    0      0        0 vpn
  44
  45 This will ensure the local LAN is reachable, that the VPN server's real IP address is reachable via the original gateway,
  46 that the VPN server's VPN IP address is reachable on the vpn interface,
  47 and that all other traffic goes via the server on the VPN.
  48
  49 It is better not to remove the original default gateway route,
  50 since someone might kill the `tincd` process, such that it doesn't get a chance to restore the original.
  51 Instead, we use a trick where we add two /1 routes instead of one /0 route:
  52
  53         Kernel IP routing table
  54         Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
  55         172.16.1.1      0.0.0.0         255.255.255.255 UH    0      0        0 vpn
  56         192.0.32.10     192.168.1.1     255.255.255.255 UGH   0      0        0 eth0
  57         192.168.1.0     0.0.0.0         255.255.255.0   U     0      0        0 eth0
  58         128.0.0.0       172.16.1.1      128.0.0.0       UG    0      0        0 vpn
  59         0.0.0.0         172.16.1.1      128.0.0.0       UG    0      0        0 vpn
  60         0.0.0.0         192.168.1.1     0.0.0.0         UG    0      0        0 eth0
  61
  62 Since both /1 cover all possible addresses, the real default route will never be used while the two /1 routes are present.
  63
  64 ### Scripts
  65
  66 Lets assume we have two nodes called `client` and `server`, and the netname is `myvpn`.
  67 Also, we assume the server has been properly configured to perform routing or masquerading between the VPN and the Internet for the clients that will use it as their default gateway.
  68 Then, only two scripts are necessary on the client.
  69 The following scripts are Linux specific:
  70
  71 `/etc/tinc/myvpn/hosts/server-up`:
  72
  73         #!/bin/sh
  74         VPN_GATEWAY=172.16.1.1
  75         ORIGINAL_GATEWAY=`ip route show | grep ^default | cut -d ' ' -f 2-5`
  76
  77         ip route add $REMOTEADDRESS $ORIGINAL_GATEWAY
  78         ip route add $VPN_GATEWAY dev $INTERFACE
  79         ip route add 0.0.0.0/1 via $VPN_GATEWAY dev $INTERFACE
  80         ip route add 128.0.0.0/1 via $VPN_GATEWAY dev $INTERFACE
  81
  82 `/etc/tinc/myvpn/hosts/server-down`:
  83
  84         #!/bin/sh
  85         ORIGINAL_GATEWAY=`ip route show | grep ^default | cut -d ' ' -f 2-5`
  86
  87         ip route del $REMOTEADDRESS $ORIGINAL_GATEWAY
  88         ip route del $VPN_GATEWAY dev $INTERFACE
  89         ip route del 0.0.0.0/1 dev $INTERFACE
  90         ip route del 128.0.0.0/1 dev $INTERFACE
  91
  92 These script use the iproute2 commands, because they are easier to work with.
  93 The `VPN_GATEWAY` variable has to be filled in by hand.
  94 The `ORIGINAL_GATEWAY` variable copies the relevant information from the original default route
  95 to create the exception route to the VPN server.
  96
  97 ### Further configuration
  98
  99 One must also ensure the tinc daemons know which node to send all packets to.
 100 Make sure the following line is in `/etc/tinc/myvpn/hosts/server`:
 101
 102         Subnet = 0.0.0.0/0
 103
 104 Make sure you have masquerading or another form of routing set up on the server.
 105 Do not forget to allow forwarding of packets; check your firewall settings, and
 106 make sure forwarding is enabled in the kernel:
 107
 108         echo 1 >/proc/sys/net/ipv4/ip_forward
 109
 110 You can also set up portforwarding or proxies to be able to connect to services
 111 running on the clients from the rest of the Internet.
 112
 113 ### Router versus switch mode
 114
 115 The examples given above will work with both router and switch mode.
 116 However, in router mode, there is actually no such thing as a gateway route.
 117 In that mode, the following four lines in the tinc-up script:
 118
 119         VPN_GATEWAY=...
 120
 121         ip route add $VPN_GATEWAY dev $INTERFACE
 122         ip route add 0.0.0.0/1 via $VPN_GATEWAY dev $INTERFACE
 123         ip route add 128.0.0.0/1 via $VPN_GATEWAY dev $INTERFACE
 124
 125 Can be replaced with the following two lines without any problem:
 126
 127         ip route add 0.0.0.0/1 dev $INTERFACE
 128         ip route add 128.0.0.0/1 dev $INTERFACE