Review some re6stnet options and update demo
[re6stnet.git] / re6stnet
1 #!/usr/bin/env python
2 import atexit, errno, logging, os, select
3 import signal, sqlite3, 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', required=True, 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
36     _ = parser.add_argument_group('routing').add_argument
37     _('-B', dest='babel_args', metavar='ARG', action='append', default=[],
38         help="Extra arguments to forward to Babel.")
39     _('--babel-pidfile', metavar='PID', default='/var/run/re6st-babeld.pid',
40         help="Specify a file to write our process id to"
41              " (option -I of Babel).")
42     _('--hello', type=int, default=15,
43         help="Hello interval in seconds, for both wired and wireless"
44              " connections. OpenVPN ping-exit option is set to 4 times the"
45              " hello interval. It takes between 3 and 4 times the"
46              " hello interval for Babel to re-establish connection with a"
47              " node for which the direct connection has been cut.")
48
49     _ = parser.add_argument_group('tunnelling').add_argument
50     _('-O', dest='openvpn_args', metavar='ARG', action='append', default=[],
51         help="Extra arguments to forward to both server and client OpenVPN"
52              " subprocesses. Often used to configure verbosity.")
53     _('--ovpnlog', action='store_true',
54         help="Tell each OpenVPN subprocess to log to a dedicated file.")
55     _('--encrypt', action='store_true',
56         help='Specify that tunnels should be encrypted.')
57     _('--pp', nargs=2, action='append', metavar=('PORT', 'PROTO'),
58         help="Port and protocol to be announced to other peers, ordered by"
59              " preference. For each protocol (either udp or tcp), start one"
60              " openvpn server on the first given port."
61              " (default: --pp 1194 udp --pp 1194 tcp)")
62     _('--dh', required=True,
63         help='File containing Diffie-Hellman parameters in .pem format')
64     _('--ca', required=True, help=parser._ca_help)
65     _('--cert', required=True,
66         help="Local peer's signed certificate in .pem format."
67              " Common name defines the allocated prefix in the network.")
68     _('--key', required=True,
69         help="Local peer's private key in .pem format.")
70     _('--client-count', default=10, type=int,
71         help="Number of client tunnels to set up.")
72     _('--max-clients', type=int,
73         help="Maximum number of accepted clients per OpenVPN server. (default:"
74              " client-count * 2, which actually represents the average number"
75              " of tunnels to other peers)")
76     _('--tunnel-refresh', default=300, type=int,
77         help="Interval in seconds between two tunnel refresh: the worst"
78              " tunnel is closed if the number of client tunnels has reached"
79              " its maximum number (client-count).")
80
81     return parser.parse_args()
82
83
84 def main():
85     # Get arguments
86     config = getConfig()
87     network = utils.networkFromCa(config.ca)
88     prefix = utils.binFromSubnet(utils.subnetFromCert(config.cert))
89     config.openvpn_args += (
90         '--ca', config.ca,
91         '--cert', config.cert,
92         '--key', config.key)
93
94     # Set logging
95     utils.setupLog(config.verbose, os.path.join(config.log, 're6stnet.log'))
96
97     logging.trace("Configuration:\n%r", config)
98     utils.makedirs(config.state)
99     db_path = os.path.join(config.state, 'peers.db')
100     if config.ovpnlog:
101         plib.ovpn_log = config.log
102
103     # Create and open read_only pipe to get server events
104     logging.info('Creating pipe for server events...')
105     r_pipe, write_pipe = os.pipe()
106     read_pipe = os.fdopen(r_pipe)
107
108     signal.signal(signal.SIGHUP, lambda *args: sys.exit(-1))
109     signal.signal(signal.SIGTERM, lambda *args: sys.exit())
110
111     if config.max_clients is None:
112         config.max_clients = config.client_count * 2
113
114     address = []
115     if config.pp:
116         pp = [(int(port), proto) for port, proto in config.pp]
117     else:
118         pp = (1194, 'udp'), (1194, 'tcp')
119     ip_changed = lambda ip: [(ip, str(port), proto) for port, proto in pp]
120     forwarder = None
121     if config.ip == 'upnp' or not config.ip:
122         logging.info('Attempting automatic configuration via UPnP...')
123         try:
124             from re6st.upnpigd import Forwarder
125             forwarder = Forwarder()
126         except Exception, e:
127             if config.ip:
128                 raise
129             logging.info("%s: assume we are not NATed", e)
130         else:
131             atexit.register(forwarder.clear)
132             for port, proto in pp:
133                 ip, port = forwarder.addRule(port, proto)
134                 address.append((ip, str(port), proto))
135     elif config.ip != 'any':
136         address = ip_changed(config.ip)
137     if address:
138         ip_changed = None
139
140     try:
141         # Init db and tunnels
142         peer_db = db.PeerDB(db_path, config.registry, config.key, prefix)
143         tunnel_manager = tunnel.TunnelManager(write_pipe, peer_db,
144             config.openvpn_args, config.hello, config.tunnel_refresh,
145             config.client_count, config.iface_list, network, prefix, address,
146             ip_changed, config.encrypt)
147
148         server_tunnels = {}
149         for x in pp:
150             server_tunnels.setdefault('re6stnet-' + x[1], x)
151         subnet = network + prefix
152         config.babel_args += tunnel_manager.free_interface_set
153         config.babel_args += config.iface_list
154         config.babel_args += server_tunnels
155         router = plib.router(network, utils.ipFromBin(subnet), len(subnet),
156             config.hello, os.path.join(config.log, 'babeld.log'),
157             os.path.join(config.state, 'babeld.state'),
158             config.babel_pidfile, *config.babel_args)
159
160         # main loop
161         try:
162             server_process = []
163             for iface, (port, proto) in server_tunnels.iteritems():
164                 server_process.append(plib.server(iface,
165                     utils.ipFromBin(subnet, '1') if proto == pp[0][1] else None,
166                     len(network) + len(prefix),
167                     config.max_clients, config.dh, write_pipe, port,
168                     proto, config.hello, config.encrypt, *config.openvpn_args))
169             while True:
170                 next = tunnel_manager.next_refresh
171                 if forwarder:
172                     next = min(next, forwarder.next_refresh)
173                 r = [read_pipe, tunnel_manager.sock]
174                 try:
175                     r = select.select(r, [], [], max(0, next - time.time()))[0]
176                 except select.error as e:
177                     if e.args[0] != errno.EINTR:
178                         raise
179                     continue
180                 if read_pipe in r:
181                     tunnel_manager.handleTunnelEvent(read_pipe.readline())
182                 if tunnel_manager.sock in r:
183                     tunnel_manager.handlePeerEvent()
184                 t = time.time()
185                 if t >= tunnel_manager.next_refresh:
186                     tunnel_manager.refresh()
187                 if forwarder and t >= forwarder.next_refresh:
188                     forwarder.refresh()
189         finally:
190             router.terminate()
191             for p in server_process:
192                 try:
193                     p.kill()
194                 except:
195                     pass
196             try:
197                 tunnel_manager.killAll()
198             except:
199                 pass
200     except sqlite3.Error:
201         logging.exception("Restarting with empty cache")
202         os.rename(db_path, db_path + '.bak')
203         try:
204             sys.exitfunc()
205         finally:
206             os.execvp(sys.argv[0], sys.argv)
207     except KeyboardInterrupt:
208         return 0
209     except Exception:
210         f = traceback.format_exception(*sys.exc_info())
211         logging.error('%s%s', f.pop(), ''.join(f))
212         sys.exit(1)
213
214 if __name__ == "__main__":
215     main()