Log environment at startup
[re6stnet.git] / re6stnet
1 #!/usr/bin/python
2 import atexit, errno, logging, os, select, signal
3 import sqlite3, subprocess, sys, time, traceback
4 from re6st import plib, utils, db, tunnel
5
6
7 def getConfig():
8     parser = utils.ArgParser(fromfile_prefix_chars='@',
9         description="Resilient virtual private network application.")
10     _ = parser.add_argument
11
12     _('--ip',
13         help="IP address advertised to other nodes. Special values:\n"
14              "- upnp: force autoconfiguration via UPnP\n"
15              "- any: ask peers our IP\n"
16              " (default: ask peers if UPnP fails)")
17     _('--registry', metavar='URL',
18         help="Public HTTP URL of the registry, for bootstrapping.")
19     _('-l', '--log', default='/var/log/re6stnet',
20         help="Path to the directory used for log files:\n"
21              "- re6stnet.log: log file of re6stnet itself\n"
22              "- babeld.log: log file of router\n"
23              "- <iface>.log: 1 file per spawned OpenVPN\n")
24     _('-s', '--state', default='/var/lib/re6stnet',
25         help="Path to re6stnet state directory:\n"
26              "- peers.db: cache of peer addresses\n"
27              "- babeld.state: see option -S of babeld\n")
28     _('-v', '--verbose', default=1, type=int, metavar='LEVEL',
29         help="Log level of re6stnet itself. 0 disables logging."
30              " Use SIGUSR1 to reopen log."
31              " See also --babel-verb and --verb for logs of spawned processes.")
32     _('-i', '--interface', action='append', dest='iface_list', default=[],
33         help="Extra interface for LAN discovery. Highly recommanded if there"
34              " are other re6st node on the same network segment.")
35     _('-I', '--main-interface', metavar='IFACE', default='lo',
36         help="Set re6stnet IP on given interface. Any interface not used for"
37              " tunnelling can be chosen.")
38     _('--up', metavar='CMD',
39         help="Shell command to run after successful initialization.")
40     _('--daemon', action='append', metavar='CMD',
41         help="Same as --up, but run in background: the command will be killed"
42              " at exit (with a TERM signal, followed by KILL 5 seconds later"
43              " if process is still alive).")
44
45     _ = parser.add_argument_group('routing').add_argument
46     _('-B', dest='babel_args', metavar='ARG', action='append', default=[],
47         help="Extra arguments to forward to Babel.")
48     _('--babel-pidfile', metavar='PID', default='/var/run/re6st-babeld.pid',
49         help="Specify a file to write our process id to"
50              " (option -I of Babel).")
51     _('--hello', type=int, default=15,
52         help="Hello interval in seconds, for both wired and wireless"
53              " connections. OpenVPN ping-exit option is set to 4 times the"
54              " hello interval. It takes between 3 and 4 times the"
55              " hello interval for Babel to re-establish connection with a"
56              " node for which the direct connection has been cut.")
57     _('--table', type=int, default=42,
58         help="Use given table id. Set 0 to use the main table, if:\n"
59              "- you are a gateway of this network (the default route will be"
60              "  exported)\n"
61              "- or you want to use the default route of this network for all"
62              " communications (in this case, make sure you don't already have"
63              " a default route).\n")
64     _ = parser.add_argument_group('tunnelling').add_argument
65     _('-O', dest='openvpn_args', metavar='ARG', action='append', default=[],
66         help="Extra arguments to forward to both server and client OpenVPN"
67              " subprocesses. Often used to configure verbosity.")
68     _('--ovpnlog', action='store_true',
69         help="Tell each OpenVPN subprocess to log to a dedicated file.")
70     _('--encrypt', action='store_true',
71         help='Specify that tunnels should be encrypted.')
72     _('--pp', nargs=2, action='append', metavar=('PORT', 'PROTO'),
73         help="Port and protocol to be announced to other peers, ordered by"
74              " preference. For each protocol (either udp or tcp), start one"
75              " openvpn server on the first given port."
76              " (default: --pp 1194 udp --pp 1194 tcp)")
77     _('--dh',
78         help='File containing Diffie-Hellman parameters in .pem format')
79     _('--ca', required=True, help=parser._ca_help)
80     _('--cert', required=True,
81         help="Local peer's signed certificate in .pem format."
82              " Common name defines the allocated prefix in the network.")
83     _('--key', required=True,
84         help="Local peer's private key in .pem format.")
85     _('--client-count', default=10, type=int,
86         help="Number of client tunnels to set up.")
87     _('--max-clients', type=int,
88         help="Maximum number of accepted clients per OpenVPN server. (default:"
89              " client-count * 2, which actually represents the average number"
90              " of tunnels to other peers)")
91     _('--tunnel-refresh', default=300, type=int,
92         help="Interval in seconds between two tunnel refresh: the worst"
93              " tunnel is closed if the number of client tunnels has reached"
94              " its maximum number (client-count).")
95     _('--client', metavar='HOST,PORT,PROTO[;...]',
96         help="Do not run any OpenVPN server, but only 1 OpenVPN client,"
97              " with specified remotes. Any other option not required in this"
98              " mode is ignored (e.g. client-count, max-clients, etc.)")
99
100     return parser.parse_args()
101
102
103 def main():
104     # Get arguments
105     config = getConfig()
106     network = utils.networkFromCa(config.ca)
107     prefix = utils.binFromSubnet(utils.subnetFromCert(config.cert))
108     config.openvpn_args += (
109         '--ca', config.ca,
110         '--cert', config.cert,
111         '--key', config.key)
112     # TODO: verify certificates (should we moved to M2Crypto ?)
113
114     # Set logging
115     utils.setupLog(config.verbose, os.path.join(config.log, 're6stnet.log'))
116
117     logging.trace("Environment: %r", os.environ)
118     logging.trace("Configuration: %r", config)
119     utils.makedirs(config.state)
120     db_path = os.path.join(config.state, 'peers.db')
121     if config.ovpnlog:
122         plib.ovpn_log = config.log
123
124     signal.signal(signal.SIGHUP, lambda *args: sys.exit(-1))
125     signal.signal(signal.SIGTERM, lambda *args: sys.exit())
126
127     if config.max_clients is None:
128         config.max_clients = config.client_count * 2
129
130     address = []
131     server_tunnels = {}
132     if config.client:
133         config.babel_args.append('re6stnet')
134     elif config.max_clients:
135         if config.pp:
136             pp = [(int(port), proto) for port, proto in config.pp]
137         else:
138             pp = (1194, 'udp'), (1194, 'tcp')
139         ip_changed = lambda ip: [(ip, str(port), proto) for port, proto in pp]
140         forwarder = None
141         if config.ip == 'upnp' or not config.ip:
142             logging.info('Attempting automatic configuration via UPnP...')
143             try:
144                 from re6st.upnpigd import Forwarder
145                 forwarder = Forwarder()
146             except Exception, e:
147                 if config.ip:
148                     raise
149                 logging.info("%s: assume we are not NATed", e)
150             else:
151                 atexit.register(forwarder.clear)
152                 for port, proto in pp:
153                     ip, port = forwarder.addRule(port, proto)
154                     address.append((ip, str(port), proto))
155         elif config.ip != 'any':
156             address = ip_changed(config.ip)
157         if address:
158             ip_changed = None
159         for x in pp:
160             server_tunnels.setdefault('re6stnet-' + x[1], x)
161
162     def call(cmd):
163         logging.debug('%r', cmd)
164         p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
165                                   stderr=subprocess.PIPE)
166         stdout, stderr = p.communicate()
167         if p.returncode:
168             raise EnvironmentError("%r failed with error %u\n%s"
169                                    % (' '.join(cmd), p.returncode, stderr))
170         return stdout
171     def required(arg):
172         if not getattr(config, arg):
173             sys.exit("error: argument --%s is required" % arg)
174     def ip(object, *args):
175         args = ['ip', '-6', object, 'add'] + list(args)
176         call(args)
177         args[3] = 'del'
178         cleanup.append(lambda: subprocess.call(args))
179
180     try:
181         subnet = network + prefix
182         my_ip = '%s/%s' % (utils.ipFromBin(subnet, '1'), len(subnet))
183         my_subnet = '%s/%u' % (utils.ipFromBin(subnet), len(subnet))
184         my_network = "%s/%u" % (utils.ipFromBin(network), len(network))
185         os.environ['re6stnet_ip'] = my_ip
186         os.environ['re6stnet_iface'] = config.main_interface
187         os.environ['re6stnet_subnet'] = my_subnet
188         os.environ['re6stnet_network'] = my_network
189
190         # Init db and tunnels
191         tunnel_interfaces = server_tunnels.keys()
192         timeout = 4 * config.hello
193         if config.client_count and not config.client:
194             required('registry')
195             # Create and open read_only pipe to get server events
196             r_pipe, write_pipe = os.pipe()
197             read_pipe = os.fdopen(r_pipe)
198             peer_db = db.PeerDB(db_path, config.registry, config.key, prefix)
199             tunnel_manager = tunnel.TunnelManager(write_pipe, peer_db,
200                 config.openvpn_args, timeout, config.tunnel_refresh,
201                 config.client_count, config.iface_list, network, prefix,
202                 address, ip_changed, config.encrypt)
203             tunnel_interfaces += tunnel_manager.new_iface_list
204         else:
205             tunnel_manager = write_pipe = None
206
207         cleanup = []
208         try:
209             # Source address selection is defined by RFC 6724, and in most
210             # applications, it usually works  thanks to rule 5 (prefer outgoing
211             # interface). But here, it rarely applies because we use several
212             # interfaces to connect to a re6st network.
213             # Rule 7 is little strange because it prefers temporary addresses
214             # over IP with a longer matching prefix (rule 8, which is not even
215             # mandatory).
216             # So only rule 6 can make the difference, i.e. prefer same label.
217             # The value of the label does not matter, except that it must be
218             # different from ::/0's (normally equal to 1).
219             # XXX: This does not work with extra interfaces that already have
220             #      an public IP so Babel must be changed to set a source
221             #      address on routes it installs.
222             ip('addrlabel', 'prefix', my_network, 'label', '99')
223             # prepare persistent interfaces
224             if config.client:
225                 cleanup.append(plib.client('re6stnet', config.client,
226                     config.encrypt, '--ping-restart', str(timeout),
227                     *config.openvpn_args).stop)
228             elif server_tunnels:
229                 required('dh')
230                 for iface, (port, proto) in server_tunnels.iteritems():
231                     cleanup.append(plib.server(iface, config.max_clients,
232                         config.dh, write_pipe, port, proto, config.encrypt,
233                         '--ping-exit', str(timeout), *config.openvpn_args).stop)
234
235             ip('addr', my_ip, 'dev', config.main_interface)
236             if_rt = ['ip', '-6', 'route', 'del',
237                      'fe80::/64', 'dev', config.main_interface]
238             if config.main_interface == 'lo':
239                 # WKRD: Removed this useless route now, since the kernel does
240                 #       not even remove it on exit.
241                 subprocess.call(if_rt)
242             if_rt[4] = my_subnet
243             cleanup.append(lambda: subprocess.call(if_rt))
244             x = [my_network]
245             if config.table:
246                 x += 'table', str(config.table)
247                 try:
248                     ip('rule', 'from', *x)
249                 except EnvironmentError:
250                     logging.error("It seems that your kernel was compiled"
251                         " without support for source address based routing"
252                         " (CONFIG_IPV6_SUBTREES). Consider using --table=0"
253                         " option if you can't change your kernel.")
254                     raise
255                 ip('rule', 'to', *x)
256                 call(if_rt)
257                 if_rt += x[1:]
258                 call(if_rt[:3] + ['add', 'proto', 'static'] + if_rt[4:])
259             ip('route', 'unreachable', *x)
260
261             config.babel_args += config.iface_list
262             cleanup.append(plib.router(subnet, config.hello, config.table,
263                 os.path.join(config.log, 'babeld.log'),
264                 os.path.join(config.state, 'babeld.state'),
265                 config.babel_pidfile, tunnel_interfaces,
266                 *config.babel_args).stop)
267             if config.up:
268                 r = os.system(config.up)
269                 if r:
270                     sys.exit(r)
271             for cmd in config.daemon or ():
272                 cleanup.append(utils.Popen(cmd, shell=True).stop)
273
274             # main loop
275             if tunnel_manager is None:
276                 sys.exit(os.WEXITSTATUS(os.wait()[1]))
277             cleanup += tunnel_manager.delInterfaces, tunnel_manager.killAll
278             while True:
279                 next = tunnel_manager.next_refresh
280                 if forwarder:
281                     next = min(next, forwarder.next_refresh)
282                 r = [read_pipe, tunnel_manager.sock]
283                 try:
284                     r = select.select(r, [], [], max(0, next - time.time()))[0]
285                 except select.error as e:
286                     if e.args[0] != errno.EINTR:
287                         raise
288                     continue
289                 if read_pipe in r:
290                     tunnel_manager.handleTunnelEvent(read_pipe.readline())
291                 if tunnel_manager.sock in r:
292                     tunnel_manager.handlePeerEvent()
293                 t = time.time()
294                 if t >= tunnel_manager.next_refresh:
295                     tunnel_manager.refresh()
296                 if forwarder and t >= forwarder.next_refresh:
297                     forwarder.refresh()
298         finally:
299             while cleanup:
300                 try:
301                     cleanup.pop()()
302                 except:
303                     pass
304     except sqlite3.Error:
305         logging.exception("Restarting with empty cache")
306         os.rename(db_path, db_path + '.bak')
307         try:
308             sys.exitfunc()
309         finally:
310             os.execvp(sys.argv[0], sys.argv)
311     except KeyboardInterrupt:
312         return 0
313     except Exception:
314         f = traceback.format_exception(*sys.exc_info())
315         logging.error('%s%s', f.pop(), ''.join(f))
316         sys.exit(1)
317
318 if __name__ == "__main__":
319     main()