source: genesis/tools/gformat.py@ 10460

Last change on this file since 10460 was 10460, checked in by rick, 13 years ago

Allow us to run fat setups on high-memory boards.

  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 39.3 KB
Line 
1#!/usr/bin/env python
2#
3# vim:ts=2:et:sw=2:ai
4# Wireless Leiden configuration generator, based on yaml files'
5#
6# XXX: This should be rewritten to make use of the ipaddr.py library.
7#
8# Sample apache configuration (mind the AcceptPathInfo!)
9# ScriptAlias /wleiden/config /usr/local/www/genesis/tools/gformat.py
10# <Directory /usr/local/www/genesis>
11# Allow from all
12# AcceptPathInfo On
13# </Directory>
14#
15# Rick van der Zwet <info@rickvanderzwet.nl>
16#
17
18# Hack to make the script directory is also threated as a module search path.
19import sys
20import os
21import re
22sys.path.append(os.path.dirname(__file__))
23
24import cgi
25import cgitb
26import copy
27import glob
28import socket
29import string
30import subprocess
31import time
32import rdnap
33import make_network_kml
34from pprint import pprint
35from collections import defaultdict
36try:
37 import yaml
38except ImportError, e:
39 print e
40 print "[ERROR] Please install the python-yaml or devel/py-yaml package"
41 exit(1)
42
43try:
44 from yaml import CLoader as Loader
45 from yaml import CDumper as Dumper
46except ImportError:
47 from yaml import Loader, Dumper
48
49from jinja2 import Template
50
51import logging
52logging.basicConfig(format='# %(levelname)s: %(message)s' )
53logger = logging.getLogger()
54logger.setLevel(logging.DEBUG)
55
56
57if os.environ.has_key('CONFIGROOT'):
58 NODE_DIR = os.environ['CONFIGROOT']
59else:
60 NODE_DIR = os.path.abspath(os.path.dirname(__file__)) + '/../nodes'
61__version__ = '$Id: gformat.py 10460 2012-04-12 21:14:42Z rick $'
62
63
64files = [
65 'authorized_keys',
66 'dnsmasq.conf',
67 'dhcpd.conf',
68 'rc.conf.local',
69 'resolv.conf',
70 'motd',
71 'wleiden.yaml',
72 ]
73
74# Global variables uses
75OK = 10
76DOWN = 20
77UNKNOWN = 90
78
79def get_yaml(item):
80 """ Get configuration yaml for 'item'"""
81 gfile = os.path.join(NODE_DIR,item,'wleiden.yaml')
82
83 f = open(gfile, 'r')
84 datadump = yaml.load(f,Loader=Loader)
85 f.close()
86
87 # Preformat certain needed variables for formatting and push those into special object
88 datadump['autogen_iface_keys'] = get_interface_keys(datadump)
89
90 wlan_count=0
91 for key in datadump['autogen_iface_keys']:
92 if datadump[key]['type'] in ['11a', '11b', '11g', 'wireless']:
93 datadump[key]['autogen_ifname'] = 'wlan%i' % wlan_count
94 wlan_count += 1
95 else:
96 datadump[key]['autogen_ifname'] = datadump[key]['interface'].split(':')[0]
97
98 dhcp_interfaces = [datadump[key]['autogen_ifname'] for key in datadump['autogen_iface_keys'] if datadump[key]['dhcp']]
99 datadump['autogen_dhcp_interfaces'] = ','.join(dhcp_interfaces)
100 datadump['autogen_item'] = item
101
102 datadump['autogen_realname'] = get_realname(datadump)
103 datadump['autogen_domain'] = datadump['domain'] if datadump.has_key('domain') else 'wleiden.net.'
104 datadump['autogen_fqdn'] = datadump['autogen_realname'] + '.' + datadump['autogen_domain']
105 return datadump
106
107
108def store_yaml(datadump, header=False):
109 """ Store configuration yaml for 'item'"""
110 item = datadump['autogen_item']
111 gfile = os.path.join(NODE_DIR,item,'wleiden.yaml')
112
113 f = open(gfile, 'w')
114 f.write(generate_wleiden_yaml(datadump, header))
115 f.close()
116
117
118
119def make_relations():
120 """ Process _ALL_ yaml files to get connection relations """
121 errors = ""
122 poel = defaultdict(list)
123 for host in get_hostlist():
124 try:
125 datadump = get_yaml(host)
126 for iface_key in datadump['autogen_iface_keys']:
127 l = datadump[iface_key]['ip']
128 addr, mask = l.split('/')
129
130 # Not parsing of these folks please
131 if not valid_addr(addr):
132 continue
133
134 addr = parseaddr(addr)
135 mask = int(mask)
136 network = addr & ~((1 << (32 - mask)) - 1)
137 poel[network] += [(host,datadump[iface_key])]
138 except (KeyError, ValueError), e:
139 errors += "[FOUT] in '%s' interface '%s'" % (host,iface_key)
140 errors += e
141 continue
142 return (poel, errors)
143
144
145def get_proxylist():
146 """Get all available proxies proxyX sorting based on X number"""
147 proxylist = sorted([os.path.basename(x) for x in glob.glob("%s/proxy*" % NODE_DIR)],
148 key=lambda name: int(''.join([c for c in name if c in string.digits])),
149 cmp=lambda x,y: x - y) + sorted([os.path.basename(x) for x in glob.glob("%s/Proxy*" % NODE_DIR)])
150 return proxylist
151
152def get_hybridlist():
153 """Get all available proxies hybridX sorting based on X number"""
154 hybridlist = sorted([os.path.basename(x) for x in glob.glob("%s/hybrid*" % NODE_DIR)],
155 key=lambda name: int(''.join([c for c in name if c in string.digits])),
156 cmp=lambda x,y: x - y)
157 return hybridlist
158
159
160def valid_addr(addr):
161 """ Show which address is valid in which are not """
162 return str(addr).startswith('172.')
163
164
165def get_nodelist():
166 """ Get all available nodes - sorted """
167 nodelist = sorted([os.path.basename(x) for x in glob.glob("%s/CNode*" % NODE_DIR)])
168 return nodelist
169
170def get_hostlist():
171 """ Combined hosts and proxy list"""
172 return get_nodelist() + get_proxylist() + get_hybridlist()
173
174def angle_between_points(lat1,lat2,long1,long2):
175 """
176 Return Angle in radians between two GPS coordinates
177 See: http://stackoverflow.com/questions/3809179/angle-between-2-gps-coordinates
178 """
179 dy = lat2 - lat1
180 dx = math.cos(math.pi/180*lat1)*(long2 - long1)
181 angle = math.atan2(dy,dx)
182 return angle
183
184def angle_to_cd(angle):
185 """ Return Dutch Cardinal Direction estimation in 'one digit' of radian angle """
186
187 # For easy conversion get positive degree
188 degrees = math.degrees(angle)
189 if degrees < 0:
190 360 - abs(degrees)
191
192 # Numbers can be confusing calculate from the 4 main directions
193 p = 22.5
194 if degrees < p:
195 return "n"
196 elif degrees < (90 - p):
197 return "no"
198 elif degrees < (90 + p):
199 return "o"
200 elif degrees < (180 - p):
201 return "zo"
202 elif degrees < (180 + p):
203 return "z"
204 elif degrees < (270 - p):
205 return "zw"
206 elif degrees < (270 + p):
207 return "w"
208 elif degrees < (360 - p):
209 return "nw"
210 else:
211 return "n"
212
213
214def generate_title(nodelist):
215 """ Main overview page """
216 items = {'root' : "." }
217 output = """
218<html>
219 <head>
220 <title>Wireless leiden Configurator - GFormat</title>
221 <style type="text/css">
222 th {background-color: #999999}
223 tr:nth-child(odd) {background-color: #cccccc}
224 tr:nth-child(even) {background-color: #ffffff}
225 th, td {padding: 0.1em 1em}
226 </style>
227 </head>
228 <body>
229 <center>
230 <form type="GET" action="%(root)s">
231 <input type="hidden" name="action" value="update">
232 <input type="submit" value="Update Configuration Database (SVN)">
233 </form>
234 <table>
235 <caption><h3>Wireless Leiden Configurator</h3></caption>
236 """ % items
237
238 for node in nodelist:
239 items['node'] = node
240 output += '<tr><td><a href="%(root)s/%(node)s">%(node)s</a></td>' % items
241 for config in files:
242 items['config'] = config
243 output += '<td><a href="%(root)s/%(node)s/%(config)s">%(config)s</a></td>' % items
244 output += "</tr>"
245 output += """
246 </table>
247 <hr />
248 <em>%s</em>
249 </center>
250 </body>
251</html>
252 """ % __version__
253
254 return output
255
256
257
258def generate_node(node):
259 """ Print overview of all files available for node """
260 return "\n".join(files)
261
262def generate_node_overview(host):
263 """ Print overview of all files available for node """
264 datadump = get_yaml(host)
265 params = { 'host' : host }
266 output = "<em><a href='..'>Back to overview</a></em><hr />"
267 output += "<h2>Available files:</h2><ul>"
268 for cf in files:
269 params['cf'] = cf
270 output += '<li><a href="%(host)s/%(cf)s">%(cf)s</a></li>\n' % params
271 output += "</ul>"
272
273 # Generate and connection listing
274 output += "<h2>Connected To:</h2><ul>"
275 (poel, errors) = make_relations()
276 for network, hosts in poel.iteritems():
277 if host in [x[0] for x in hosts]:
278 if len(hosts) == 1:
279 # Single not connected interface
280 continue
281 for remote,ifacedump in hosts:
282 if remote == host:
283 # This side of the interface
284 continue
285 params = { 'remote': remote, 'remote_ip' : ifacedump['ip'] }
286 output += '<li><a href="%(remote)s">%(remote)s</a> -- %(remote_ip)s</li>\n' % params
287 output += "</ul>"
288 output += "<h2>MOTD details:</h2><pre>" + generate_motd(datadump) + "</pre>"
289
290 output += "<hr /><em><a href='..'>Back to overview</a></em>"
291 return output
292
293
294def generate_header(ctag="#"):
295 return """\
296%(ctag)s
297%(ctag)s DO NOT EDIT - Automatically generated by 'gformat'
298%(ctag)s Generated at %(date)s by %(host)s
299%(ctag)s
300""" % { 'ctag' : ctag, 'date' : time.ctime(), 'host' : socket.gethostname() }
301
302
303
304def parseaddr(s):
305 """ Process IPv4 CIDR notation addr to a (binary) number """
306 f = s.split('.')
307 return (long(f[0]) << 24L) + \
308 (long(f[1]) << 16L) + \
309 (long(f[2]) << 8L) + \
310 long(f[3])
311
312
313
314def showaddr(a):
315 """ Display IPv4 addr in (dotted) CIDR notation """
316 return "%d.%d.%d.%d" % ((a >> 24) & 0xff, (a >> 16) & 0xff, (a >> 8) & 0xff, a & 0xff)
317
318
319def is_member(ip, mask, canidate):
320 """ Return True if canidate is part of ip/mask block"""
321 ip_addr = gformat.parseaddr(ip)
322 ip_canidate = gformat.parseaddr(canidate)
323 mask = int(mask)
324 ip_addr = ip_addr & ~((1 << (32 - mask)) - 1)
325 ip_canidate = ip_canidate & ~((1 << (32 - mask)) - 1)
326 return ip_addr == ip_canidate
327
328
329
330def cidr2netmask(netmask):
331 """ Given a 'netmask' return corresponding CIDR """
332 return showaddr(0xffffffff & (0xffffffff << (32 - int(netmask))))
333
334def get_network(addr, mask):
335 return showaddr(parseaddr(addr) & ~((1 << (32 - int(mask))) - 1))
336
337
338def generate_dhcpd_conf(datadump):
339 """ Generate config file '/usr/local/etc/dhcpd.conf """
340 output = generate_header()
341 output += Template("""\
342# option definitions common to all supported networks...
343option domain-name "dhcp.{{ autogen_fqdn }}";
344
345default-lease-time 600;
346max-lease-time 7200;
347
348# Use this to enble / disable dynamic dns updates globally.
349#ddns-update-style none;
350
351# If this DHCP server is the official DHCP server for the local
352# network, the authoritative directive should be uncommented.
353authoritative;
354
355# Use this to send dhcp log messages to a different log file (you also
356# have to hack syslog.conf to complete the redirection).
357log-facility local7;
358
359#
360# Interface definitions
361#
362\n""").render(datadump)
363
364 for iface_key in datadump['autogen_iface_keys']:
365 if not datadump[iface_key].has_key('comment'):
366 datadump[iface_key]['comment'] = None
367 output += "## %(interface)s - %(desc)s - %(comment)s\n" % datadump[iface_key]
368
369 (addr, mask) = datadump[iface_key]['ip'].split('/')
370 datadump[iface_key]['addr'] = addr
371 datadump[iface_key]['netmask'] = cidr2netmask(mask)
372 datadump[iface_key]['subnet'] = get_network(addr, mask)
373 try:
374 (dhcp_start, dhcp_stop) = datadump[iface_key]['dhcp'].split('-')
375 except (AttributeError, ValueError):
376 output += "subnet %(subnet)s netmask %(netmask)s {\n ### not autoritive\n}\n\n" % datadump[iface_key]
377 continue
378
379 dhcp_part = ".".join(addr.split('.')[0:3])
380 datadump[iface_key]['dhcp_start'] = dhcp_part + "." + dhcp_start
381 datadump[iface_key]['dhcp_stop'] = dhcp_part + "." + dhcp_stop
382 output += """\
383subnet %(subnet)s netmask %(netmask)s {
384 range %(dhcp_start)s %(dhcp_stop)s;
385 option routers %(addr)s;
386 option domain-name-servers %(addr)s;
387}
388\n""" % datadump[iface_key]
389
390 return output
391
392
393
394def generate_dnsmasq_conf(datadump):
395 """ Generate configuration file '/usr/local/etc/dnsmasq.conf' """
396 output = generate_header()
397 output += Template("""\
398# DHCP server options
399dhcp-authoritative
400dhcp-fqdn
401domain=dhcp.{{ autogen_fqdn }}
402domain-needed
403expand-hosts
404log-async=100
405
406# Low memory footprint
407cache-size=10000
408
409\n""").render(datadump)
410
411 for iface_key in datadump['autogen_iface_keys']:
412 if not datadump[iface_key].has_key('comment'):
413 datadump[iface_key]['comment'] = None
414 output += "## %(interface)s - %(desc)s - %(comment)s\n" % datadump[iface_key]
415
416 try:
417 (dhcp_start, dhcp_stop) = datadump[iface_key]['dhcp'].split('-')
418 (ip, cidr) = datadump[iface_key]['ip'].split('/')
419 datadump[iface_key]['netmask'] = cidr2netmask(cidr)
420 except (AttributeError, ValueError):
421 output += "# not autoritive\n\n"
422 continue
423
424 dhcp_part = ".".join(ip.split('.')[0:3])
425 datadump[iface_key]['dhcp_start'] = dhcp_part + "." + dhcp_start
426 datadump[iface_key]['dhcp_stop'] = dhcp_part + "." + dhcp_stop
427 output += "dhcp-range=%(interface)s,%(dhcp_start)s,%(dhcp_stop)s,%(netmask)s,24h\n\n" % datadump[iface_key]
428
429 return output
430
431
432
433def generate_rc_conf_local(datadump):
434 """ Generate configuration file '/etc/rc.conf.local' """
435 if not datadump.has_key('ileiden'):
436 datadump['autogen_ileiden_enable'] = False
437 else:
438 datadump['autogen_ileiden_enable'] = datadump['ileiden']
439
440 ileiden_proxies = []
441 normal_proxies = []
442 for proxy in get_proxylist():
443 proxydump = get_yaml(proxy)
444 if proxydump['ileiden']:
445 ileiden_proxies.append(proxydump)
446 else:
447 normal_proxies.append(proxydump)
448 datadump['autogen_ileiden_proxies'] = ','.join([x['masterip'] for x in ileiden_proxies])
449 datadump['autogen_ileiden_proxies_names'] = ','.join([x['autogen_item'] for x in ileiden_proxies])
450 datadump['autogen_normal_proxies'] = ','.join([x['masterip'] for x in normal_proxies])
451 datadump['autogen_normal_proxies_names'] = ','.join([x['autogen_item'] for x in normal_proxies])
452
453 output = generate_header("#");
454 output += Template("""\
455hostname='{{ autogen_fqdn }}'
456location='{{ location }}'
457nodetype="{{ nodetype }}"
458
459#
460# Configured listings
461#
462captive_portal_whitelist=""
463captive_portal_interfaces="{{ autogen_dhcp_interfaces }}"
464# iLeiden Proxies {{ autogen_ileiden_proxies_names }}
465list_ileiden_proxies="{{ autogen_ileiden_proxies }}"
466# normal Proxies {{ autogen_normal_proxies_names }}
467list_normal_proxies="{{ autogen_normal_proxies }}"
468
469{% if nodetype == "Proxy" %}
470#
471# Proxy Configuration
472#
473{% if gateway -%}
474defaultrouter="{{ gateway }}"
475{% else -%}
476#defaultrouter="NOTSET"
477{% endif -%}
478internalif="{{ internalif }}"
479ileiden_enable="{{ autogen_ileiden_enable }}"
480gateway_enable="{{ autogen_ileiden_enable }}"
481pf_enable="yes"
482pf_rules="/etc/pf.conf"
483{% if autogen_ileiden_enable -%}
484pf_flags="-D ext_if={{ externalif }} -D int_if={{ internalif }} -D publicnat={80,443}"
485lvrouted_enable="{{ autogen_ileiden_enable }}"
486lvrouted_flags="-u -s s00p3rs3kr3t -m 28"
487{% else -%}
488pf_flags="-D ext_if={{ externalif }} -D int_if={{ internalif }} -D publicnat={0}"
489{% endif -%}
490{% if internalroute -%}
491static_routes="wleiden"
492route_wleiden="-net 172.16.0.0/12 {{ internalroute }}"
493{% endif -%}
494{% endif -%}
495
496{% if nodetype == "Hybrid" %}
497#
498# Hybrid Configuration
499#
500captive_portal_interfaces="{{ autogen_dhcp_interfaces }}"
501
502pf_rules="/etc/pf.hybrid.conf"
503{% if service_ileiden -%}
504# Service iLeiden
505pf_flags="-D ext_if={{ externalif }} -D captive_portal_interfaces=${captive_portal_interfaces:-'none'} -D publicnat=80,443"
506{% else -%}
507pf_flags="-D ext_if={{ externalif }} -D captive_portal_interfaces=${captive_portal_interfaces:-'none'} -D publicnat=0"
508{% endif -%}
509
510{% if service_proxy %}
511# Service Proxy
512tinyproxy_enable="yes"
513{% endif -%}
514
515{% if board == "ALIX2" %}
516# ''Fat'' configuration, board has 256MB RAM
517dnsmasq_enable="NO"
518named_enable="YES"
519dhcpd_enable="YES"
520{% endif -%}
521
522{% if gateway -%}
523defaultrouter="{{ gateway }}"
524{% endif -%}
525#
526# END Hybrid Configuration
527#
528{% endif -%}
529
530
531{% if nodetype == "CNode" %}
532#
533# NODE iLeiden Configuration
534#
535
536{% if tproxy -%}
537tproxy_enable='YES'
538tproxy_range='{{ tproxy }}'
539{% else -%}
540tproxy_enable='NO'
541{% endif -%}
542
543lvrouted_flags="-u -s s00p3rs3kr3t -m 28 -z $list_ileiden_proxies"
544{% endif %}
545\n
546""").render(datadump)
547
548 # lo0 configuration:
549 # - 172.32.255.1/32 is the proxy.wleiden.net deflector
550 # - masterip is special as it needs to be assigned to at
551 # least one interface, so if not used assign to lo0
552 addrs_list = { 'lo0' : [("127.0.0.1/8", "LocalHost"), ("172.31.255.1/32","Proxy IP")] }
553 iface_map = {'lo0' : 'lo0'}
554 dhclient_if = {'lo0' : False}
555
556 masterip_used = False
557 for iface_key in datadump['autogen_iface_keys']:
558 if datadump[iface_key]['ip'].startswith(datadump['masterip']):
559 masterip_used = True
560 break
561 if not masterip_used:
562 addrs_list['lo0'].append((datadump['masterip'] + "/32", 'Master IP Not used in interface'))
563
564 for iface_key in datadump['autogen_iface_keys']:
565 ifacedump = datadump[iface_key]
566 ifname = ifacedump['autogen_ifname']
567
568 # Flag dhclient is possible
569 dhclient_if[ifname] = ifacedump.has_key('dhcpclient') and ifacedump['dhcpclient']
570
571 # Add interface IP to list
572 item = (ifacedump['ip'], ifacedump['desc'])
573 if addrs_list.has_key(ifname):
574 addrs_list[ifname].append(item)
575 else:
576 addrs_list[ifname] = [item]
577
578 # Alias only needs IP assignment for now, this might change if we
579 # are going to use virtual accesspoints
580 if "alias" in iface_key:
581 continue
582
583 # XXX: Might want to deduct type directly from interface name
584 if ifacedump['type'] in ['11a', '11b', '11g', 'wireless']:
585 # Default to station (client) mode
586 ifacedump['wlanmode'] = "sta"
587 if ifacedump['mode'] in ['master', 'master-wds', 'ap', 'ap-wds']:
588 ifacedump['wlanmode'] = "ap"
589 # Default to 802.11b mode
590 ifacedump['mode'] = '11b'
591 if ifacedump['type'] in ['11a', '11b' '11g']:
592 ifacedump['mode'] = ifacedump['type']
593
594 if not ifacedump.has_key('channel'):
595 if ifacedump['type'] == '11a':
596 ifacedump['channel'] = 36
597 else:
598 ifacedump['channel'] = 1
599
600 # Allow special hacks at the back like wds and stuff
601 if not ifacedump.has_key('extra'):
602 ifacedump['extra'] = 'regdomain ETSI country NL'
603
604 output += "wlans_%(interface)s='%(autogen_ifname)s'\n" % ifacedump
605 output += ("create_args_%(autogen_ifname)s='wlanmode %(wlanmode)s mode " +\
606 "%(mode)s ssid %(ssid)s %(extra)s channel %(channel)s'\n") % ifacedump
607
608 elif ifacedump['type'] in ['ethernet', 'eth']:
609 # No special config needed besides IP
610 pass
611 else:
612 assert False, "Unknown type " + ifacedump['type']
613
614 # Print IP address which needs to be assigned over here
615 output += "\n"
616 for iface,addrs in sorted(addrs_list.iteritems()):
617 for addr, comment in sorted(addrs,key=lambda x: parseaddr(x[0].split('/')[0])):
618 output += "# %s || %s || %s\n" % (iface, addr, comment)
619
620 # Write DHCLIENT entry
621 if dhclient_if[iface]:
622 output += "ifconfig_%s='SYNCDHCP'\n\n" % (iface)
623 else:
624 output += "ipv4_addrs_%s='%s'\n\n" % (iface, " ".join([x[0] for x in addrs]))
625
626 return output
627
628
629
630
631def get_all_configs():
632 """ Get dict with key 'host' with all configs present """
633 configs = dict()
634 for host in get_hostlist():
635 datadump = get_yaml(host)
636 configs[host] = datadump
637 return configs
638
639
640def get_interface_keys(config):
641 """ Quick hack to get all interface keys, later stage convert this to a iterator """
642 return sorted([elem for elem in config.keys() if (elem.startswith('iface_') and not "lo0" in elem)])
643
644
645def get_used_ips(configs):
646 """ Return array of all IPs used in config files"""
647 ip_list = []
648 for config in configs:
649 ip_list.append(config['masterip'])
650 for iface_key in get_interface_keys(config):
651 l = config[iface_key]['ip']
652 addr, mask = l.split('/')
653 # Special case do not process
654 if valid_addr(addr):
655 ip_list.append(addr)
656 else:
657 logger.error("## IP '%s' in '%s' not valid" % (addr, config['nodename']))
658 return sorted(ip_list)
659
660
661
662def generate_resolv_conf(datadump):
663 """ Generate configuration file '/etc/resolv.conf' """
664 output = generate_header("#");
665 output += """\
666search wleiden.net
667"""
668 if datadump['nodetype'] == 'Proxy':
669 output += """\
670# Try local (cache) first
671nameserver 127.0.0.1
672nameserver 8.8.8.8 # Google Public NameServer
673nameserver 8.8.4.4 # Google Public NameServer
674"""
675 elif datadump['nodetype'] == 'Hybrid':
676 for proxy in get_proxylist():
677 proxy_ip = get_yaml(proxy)['masterip']
678 output += "nameserver %-15s # %s\n" % (proxy_ip, proxy)
679 output += """\
680nameserver 8.8.8.8 # Google Public NameServer
681nameserver 8.8.4.4 # Google Public NameServer
682"""
683 else:
684 output += """\
685# Try local (cache) first
686nameserver 127.0.0.1
687
688# Proxies are recursive nameservers
689# needs to be in resolv.conf for dnsmasq as well
690""" % datadump
691 for proxy in get_proxylist():
692 proxy_ip = get_yaml(proxy)['masterip']
693 output += "nameserver %-15s # %s\n" % (proxy_ip, proxy)
694
695 return output
696
697def generate_motd(datadump):
698 """ Generate configuration file '/etc/motd' """
699 output = """\
700FreeBSD 9.0-RELEASE (kernel.wleiden) #0 r230587: Sun Jan 29 17:09:57 CET 2012
701
702 WWW: %(autogen_fqdn)s - http://www.wirelessleiden.nl
703 Loc: %(location)s
704
705Interlinks:
706""" % datadump
707
708 # XXX: This is a hacky way to get the required data
709 for line in generate_rc_conf_local(datadump).split('\n'):
710 if '||' in line and not line[1:].split()[0] in ['lo0', 'ath0'] :
711 output += " - %s \n" % line[1:]
712 output += """\
713Attached bridges:
714"""
715 for iface_key in datadump['autogen_iface_keys']:
716 ifacedump = datadump[iface_key]
717 if ifacedump.has_key('ns_ip'):
718 output += " - %(interface)s || %(mode)s || %(ns_ip)s\n" % ifacedump
719
720 return output
721
722
723def format_yaml_value(value):
724 """ Get yaml value in right syntax for outputting """
725 if isinstance(value,str):
726 output = '"%s"' % value
727 else:
728 output = value
729 return output
730
731
732
733def format_wleiden_yaml(datadump):
734 """ Special formatting to ensure it is editable"""
735 output = "# Genesis config yaml style\n"
736 output += "# vim:ts=2:et:sw=2:ai\n"
737 output += "#\n"
738 iface_keys = [elem for elem in datadump.keys() if elem.startswith('iface_')]
739 for key in sorted(set(datadump.keys()) - set(iface_keys)):
740 output += "%-10s: %s\n" % (key, format_yaml_value(datadump[key]))
741
742 output += "\n\n"
743
744 key_order = [ 'comment', 'interface', 'ip', 'desc', 'sdesc', 'mode', 'type',
745 'extra_type', 'channel', 'ssid', 'dhcp' ]
746
747 for iface_key in sorted(iface_keys):
748 output += "%s:\n" % iface_key
749 for key in key_order + list(sorted(set(datadump[iface_key].keys()) - set(key_order))):
750 if datadump[iface_key].has_key(key):
751 output += " %-11s: %s\n" % (key, format_yaml_value(datadump[iface_key][key]))
752 output += "\n\n"
753
754 return output
755
756
757
758def generate_wleiden_yaml(datadump, header=True):
759 """ Generate (petty) version of wleiden.yaml"""
760 for key in datadump.keys():
761 if key.startswith('autogen_'):
762 del datadump[key]
763 # Interface autogen cleanups
764 elif type(datadump[key]) == dict:
765 for key2 in datadump[key].keys():
766 if key2.startswith('autogen_'):
767 del datadump[key][key2]
768
769 output = generate_header("#") if header else ''
770 output += format_wleiden_yaml(datadump)
771 return output
772
773
774def generate_yaml(datadump):
775 return generate_config(datadump['nodename'], "wleiden.yaml", datadump)
776
777
778
779def generate_config(node, config, datadump=None):
780 """ Print configuration file 'config' of 'node' """
781 output = ""
782 try:
783 # Load config file
784 if datadump == None:
785 datadump = get_yaml(node)
786
787 if config == 'wleiden.yaml':
788 output += generate_wleiden_yaml(datadump)
789 elif config == 'authorized_keys':
790 f = open(os.path.join(NODE_DIR,"global_keys"), 'r')
791 output += f.read()
792 f.close()
793 elif config == 'dnsmasq.conf':
794 output += generate_dnsmasq_conf(datadump)
795 elif config == 'dhcpd.conf':
796 output += generate_dhcpd_conf(datadump)
797 elif config == 'rc.conf.local':
798 output += generate_rc_conf_local(datadump)
799 elif config == 'resolv.conf':
800 output += generate_resolv_conf(datadump)
801 elif config == 'motd':
802 output += generate_motd(datadump)
803 else:
804 assert False, "Config not found!"
805 except IOError, e:
806 output += "[ERROR] Config file not found"
807 return output
808
809
810
811def process_cgi_request():
812 """ When calling from CGI """
813 # Update repository if requested
814 form = cgi.FieldStorage()
815 if form.getvalue("action") == "update":
816 print "Refresh: 5; url=."
817 print "Content-type:text/plain\r\n\r\n",
818 print "[INFO] Updating subverion, please wait..."
819 print subprocess.Popen(['svn', 'cleanup', "%s/.." % NODE_DIR], stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0],
820 print subprocess.Popen(['svn', 'up', "%s/.." % NODE_DIR], stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0],
821 print "[INFO] All done, redirecting in 5 seconds"
822 sys.exit(0)
823
824
825 base_uri = os.environ['PATH_INFO']
826 uri = base_uri.strip('/').split('/')
827
828 output = ""
829 if base_uri.endswith('/create/network.kml'):
830 output += "Content-type:application/vnd.google-earth.kml+xml\r\n\r\n"
831 output += make_network_kml.make_graph()
832 elif not uri[0]:
833 if is_text_request():
834 output += "Content-type:text/plain\r\n\r\n"
835 output += '\n'.join(get_hostlist())
836 else:
837 output += "Content-type:text/html\r\n\r\n"
838 output += generate_title(get_hostlist())
839 elif len(uri) == 1:
840 if is_text_request():
841 output += "Content-type:text/plain\r\n\r\n"
842 output += generate_node(uri[0])
843 else:
844 output += "Content-type:text/html\r\n\r\n"
845 output += generate_node_overview(uri[0])
846 elif len(uri) == 2:
847 output += "Content-type:text/plain\r\n\r\n"
848 output += generate_config(uri[0], uri[1])
849 else:
850 assert False, "Invalid option"
851 print output
852
853def get_realname(datadump):
854 # Proxy naming convention is special, as the proxy name is also included in
855 # the nodename, when it comes to the numbered proxies.
856 if datadump['nodetype'] == 'Proxy':
857 realname = datadump['nodetype'] + datadump['nodename'].replace('proxy','')
858 else:
859 # By default the full name is listed and also a shortname CNAME for easy use.
860 realname = datadump['nodetype'] + datadump['nodename']
861 return(realname)
862
863
864
865def make_dns(output_dir = 'dns', external = False):
866 items = dict()
867
868 # hostname is key, IP is value
869 wleiden_zone = dict()
870 wleiden_cname = dict()
871
872 pool = dict()
873 for node in get_hostlist():
874 logger.info("Processing host %s", node)
875 datadump = get_yaml(node)
876
877 # Proxy naming convention is special
878 fqdn = datadump['autogen_realname']
879 if datadump['nodetype'] == 'CNode':
880 wleiden_cname[datadump['nodename']] = fqdn
881
882 wleiden_zone[fqdn] = datadump['masterip']
883
884 # Hacking to get proper DHCP IPs and hostnames
885 for iface_key in get_interface_keys(datadump):
886 iface_name = datadump[iface_key]['interface'].replace(':',"-alias-")
887 (ip, cidr) = datadump[iface_key]['ip'].split('/')
888 try:
889 (dhcp_start, dhcp_stop) = datadump[iface_key]['dhcp'].split('-')
890 datadump[iface_key]['netmask'] = cidr2netmask(cidr)
891 dhcp_part = ".".join(ip.split('.')[0:3])
892 if ip != datadump['masterip']:
893 wleiden_zone["dhcp-gateway-%s.%s" % (iface_name, fqdn)] = ip
894 for i in range(int(dhcp_start), int(dhcp_stop) + 1):
895 wleiden_zone["dhcp-%s-%s.%s" % (i, iface_name, fqdn)] = "%s.%s" % (dhcp_part, i)
896 except (AttributeError, ValueError):
897 # First push it into a pool, to indentify the counter-part later on
898 addr = parseaddr(ip)
899 netmask = int(netmask)
900 addr = addr & ~((1 << (32 - netmask)) - 1)
901 if pool.has_key(addr):
902 pool[addr] += [(iface_name, fqdn, ip)]
903 else:
904 pool[addr] = [(iface_name, fqdn, ip)]
905 continue
906
907
908 def pool_to_name(node, pool_members):
909 """Convert the joined name to a usable pool name"""
910
911 # Get rid of the own entry
912 pool_members = list(set(pool_members) - set([fqdn]))
913
914 target = oldname = ''
915 for node in sorted(pool_members):
916 (name, number) = re.match('^([A-Za-z]+)([0-9]*)$',node).group(1,2)
917 target += "-" + number if name == oldname else "-" + node if target else node
918 oldname = name
919
920 return target
921
922
923 # WL uses an /29 to configure an interface. IP's are ordered like this:
924 # MasterA (.1) -- DeviceA (.2) <<>> DeviceB (.3) --- SlaveB (.4)
925
926 sn = lambda x: re.sub(r'(?i)^cnode','',x)
927
928 # Automatic naming convention of interlinks namely 2 + remote.lower()
929 for (key,value) in pool.iteritems():
930 # Make sure they are sorted from low-ip to high-ip
931 value = sorted(value, key=lambda x: parseaddr(x[2]))
932
933 if len(value) == 1:
934 (iface_name, fqdn, ip) = value[0]
935 wleiden_zone["2unused-%s.%s" % (iface_name, fqdn)] = ip
936
937 # Device DNS names
938 if 'cnode' in fqdn.lower():
939 wleiden_zone["d-at-%s.%s" % (iface_name, fqdn)] = showaddr(parseaddr(ip) + 1)
940 wleiden_cname["d-at-%s.%s" % (iface_name,sn(fqdn))] = "d-at-%s.%s" % (iface_name, fqdn)
941
942 elif len(value) == 2:
943 (a_iface_name, a_fqdn, a_ip) = value[0]
944 (b_iface_name, b_fqdn, b_ip) = value[1]
945 wleiden_zone["2%s.%s" % (b_fqdn,a_fqdn)] = a_ip
946 wleiden_zone["2%s.%s" % (a_fqdn,b_fqdn)] = b_ip
947
948 # Device DNS names
949 if 'cnode' in a_fqdn.lower() and 'cnode' in b_fqdn.lower():
950 wleiden_zone["d-at-%s.%s" % (a_iface_name, a_fqdn)] = showaddr(parseaddr(a_ip) + 1)
951 wleiden_zone["d-at-%s.%s" % (b_iface_name, b_fqdn)] = showaddr(parseaddr(b_ip) - 1)
952 wleiden_cname["d-at-%s.%s" % (a_iface_name,sn(a_fqdn))] = "d-at-%s.%s" % (a_iface_name, a_fqdn)
953 wleiden_cname["d-at-%s.%s" % (b_iface_name,sn(b_fqdn))] = "d-at-%s.%s" % (b_iface_name, b_fqdn)
954 wleiden_cname["d2%s.%s" % (sn(b_fqdn),sn(a_fqdn))] = "d-at-%s.%s" % (a_iface_name, a_fqdn)
955 wleiden_cname["d2%s.%s" % (sn(a_fqdn),sn(b_fqdn))] = "d-at-%s.%s" % (b_iface_name, b_fqdn)
956
957 else:
958 pool_members = [k[1] for k in value]
959 for item in value:
960 (iface_name, fqdn, ip) = item
961 pool_name = "2pool-" + showaddr(key).replace('.','-') + "-" + pool_to_name(fqdn,pool_members)
962 wleiden_zone["%s.%s" % (pool_name, fqdn)] = ip
963
964 # Include static DNS entries
965 # XXX: Should they override the autogenerated results?
966 # XXX: Convert input to yaml more useable.
967 # Format:
968 ##; this is a comment
969 ## roomburgh=CNodeRoomburgh1
970 ## apkerk1.CNodeVosko=172.17.176.8 ;this as well
971 dns = yaml.load(open(os.path.join(NODE_DIR,'../dns/staticDNS.yaml'),'r'))
972
973 # Hack to allow special entries, for development
974 wleiden_raw = dns['raw']
975 del dns['raw']
976
977 for comment, block in dns.iteritems():
978 for k,v in block.iteritems():
979 if valid_addr(v):
980 wleiden_zone[k] = v
981 else:
982 wleiden_cname[k] = v
983
984 details = dict()
985 # 24 updates a day allowed
986 details['serial'] = time.strftime('%Y%m%d%H')
987
988 if external:
989 dns_masters = ['siteview.wirelessleiden.nl', 'ns1.vanderzwet.net']
990 else:
991 dns_masters = ['sunny.wleiden.net']
992
993 details['master'] = dns_masters[0]
994 details['ns_servers'] = '\n'.join(['\tNS\t%s.' % x for x in dns_masters])
995
996 dns_header = '''
997$TTL 3h
998%(zone)s. SOA %(master)s. beheer.lijst.wirelessleiden.nl. ( %(serial)s 1d 12h 1w 3h )
999 ; Serial, Refresh, Retry, Expire, Neg. cache TTL
1000
1001%(ns_servers)s
1002 \n'''
1003
1004
1005 if not os.path.isdir(output_dir):
1006 os.makedirs(output_dir)
1007 details['zone'] = 'wleiden.net'
1008 f = open(os.path.join(output_dir,"db." + details['zone']), "w")
1009 f.write(dns_header % details)
1010
1011 for host,ip in wleiden_zone.iteritems():
1012 if valid_addr(ip):
1013 f.write("%s.wleiden.net. IN A %s \n" % (host.lower(), ip))
1014 for source,dest in wleiden_cname.iteritems():
1015 f.write("%s.wleiden.net. IN CNAME %s.wleiden.net.\n" % (source.lower(), dest.lower()))
1016 for source, dest in wleiden_raw.iteritems():
1017 f.write("%s.wleiden.net. %s\n" % (source, dest))
1018 f.close()
1019
1020 # Create whole bunch of specific sub arpa zones. To keep it compliant
1021 for s in range(16,32):
1022 details['zone'] = '%i.172.in-addr.arpa' % s
1023 f = open(os.path.join(output_dir,"db." + details['zone']), "w")
1024 f.write(dns_header % details)
1025
1026 #XXX: Not effient, fix to proper data structure and do checks at other
1027 # stages
1028 for host,ip in wleiden_zone.iteritems():
1029 if valid_addr(ip):
1030 if int(ip.split('.')[1]) == s:
1031 rev_ip = '.'.join(reversed(ip.split('.')))
1032 f.write("%s.in-addr.arpa. IN PTR %s.wleiden.net.\n" % (rev_ip.lower(), host.lower()))
1033 f.close()
1034
1035
1036def usage():
1037 print """Usage: %s <standalone [port] |test [test arguments]|static|dns>
1038Examples:
1039\tdns [outputdir] = Generate BIND compliant zone files in dns.
1040\tstandalone = Run configurator webserver [default port=8000]
1041\twind-export = Generate SQL import scripts for WIND database
1042\tfull-export = Generate yaml export script for heatmap.
1043\tstatic = Generate all config files and store on disk
1044\t with format ./static/%%NODE%%/%%FILE%%
1045\ttest CNodeRick dnsmasq.conf = Receive output of CGI script
1046\t for arguments CNodeRick/dnsmasq.conf
1047\tlist <all|nodes|proxies> = List systems which marked up.
1048"""
1049 exit(0)
1050
1051
1052def is_text_request():
1053 """ Find out whether we are calling from the CLI or any text based CLI utility """
1054 try:
1055 return os.environ['HTTP_USER_AGENT'].split()[0] in ['curl', 'fetch', 'wget']
1056 except KeyError:
1057 return True
1058
1059def main():
1060 """Hard working sub"""
1061 # Allow easy hacking using the CLI
1062 if not os.environ.has_key('PATH_INFO'):
1063 if len(sys.argv) < 2:
1064 usage()
1065
1066 if sys.argv[1] == "standalone":
1067 import SocketServer
1068 import CGIHTTPServer
1069 # Hop to the right working directory.
1070 os.chdir(os.path.dirname(__file__))
1071 try:
1072 PORT = int(sys.argv[2])
1073 except (IndexError,ValueError):
1074 PORT = 8000
1075
1076 class MyCGIHTTPRequestHandler(CGIHTTPServer.CGIHTTPRequestHandler):
1077 """ Serve this CGI from the root of the webserver """
1078 def is_cgi(self):
1079 if "favicon" in self.path:
1080 return False
1081
1082 self.cgi_info = (os.path.basename(__file__), self.path)
1083 self.path = ''
1084 return True
1085 handler = MyCGIHTTPRequestHandler
1086 SocketServer.TCPServer.allow_reuse_address = True
1087 httpd = SocketServer.TCPServer(("", PORT), handler)
1088 httpd.server_name = 'localhost'
1089 httpd.server_port = PORT
1090
1091 logger.info("serving at port %s", PORT)
1092 try:
1093 httpd.serve_forever()
1094 except KeyboardInterrupt:
1095 httpd.shutdown()
1096 logger.info("All done goodbye")
1097 elif sys.argv[1] == "test":
1098 os.environ['PATH_INFO'] = "/".join(sys.argv[2:])
1099 os.environ['SCRIPT_NAME'] = __file__
1100 process_cgi_request()
1101 elif sys.argv[1] == "unit-test":
1102 os.environ['SCRIPT_NAME'] = __file__
1103 for host in get_hostlist():
1104 for outfile in files:
1105 os.environ['PATH_INFO'] = "/".join([host,outfile])
1106 try:
1107 process_cgi_request()
1108 except Exception:
1109 print "# ERROR: %s" % os.environ['PATH_INFO']
1110 raise
1111
1112
1113 elif sys.argv[1] == "static":
1114 items = dict()
1115 for node in get_hostlist():
1116 items['node'] = node
1117 items['wdir'] = "./static/%(node)s" % items
1118 if not os.path.isdir(items['wdir']):
1119 os.makedirs(items['wdir'])
1120 datadump = get_yaml(node)
1121 for config in files:
1122 items['config'] = config
1123 logger.info("## Generating %(node)s %(config)s" % items)
1124 f = open("%(wdir)s/%(config)s" % items, "w")
1125 f.write(generate_config(node, config, datadump))
1126 f.close()
1127 elif sys.argv[1] == "wind-export":
1128 items = dict()
1129 for node in get_hostlist():
1130 datadump = get_yaml(node)
1131 sql = """INSERT IGNORE INTO nodes (name, name_ns, longitude, latitude)
1132 VALUES ('%(nodename)s', '%(nodename)s', %(latitude)s, %(longitude)s);""" % datadump;
1133 sql = """INSERT IGNORE INTO users_nodes (user_id, node_id, owner)
1134 VALUES (
1135 (SELECT id FROM users WHERE username = 'rvdzwet'),
1136 (SELECT id FROM nodes WHERE name = '%(nodename)s'),
1137 'Y');""" % datadump
1138 #for config in files:
1139 # items['config'] = config
1140 # print "## Generating %(node)s %(config)s" % items
1141 # f = open("%(wdir)s/%(config)s" % items, "w")
1142 # f.write(generate_config(node, config, datadump))
1143 # f.close()
1144 for node in get_hostlist():
1145 datadump = get_yaml(node)
1146 for iface_key in sorted([elem for elem in datadump.keys() if elem.startswith('iface_')]):
1147 ifacedump = datadump[iface_key]
1148 if ifacedump.has_key('mode') and ifacedump['mode'] == 'ap-wds':
1149 ifacedump['nodename'] = datadump['nodename']
1150 if not ifacedump.has_key('channel') or not ifacedump['channel']:
1151 ifacedump['channel'] = 0
1152 sql = """INSERT INTO links (node_id, type, ssid, protocol, channel, status)
1153 VALUES ((SELECT id FROM nodes WHERE name = '%(nodename)s'), 'ap',
1154 '%(ssid)s', 'IEEE 802.11b', %(channel)s, 'active');""" % ifacedump
1155 elif sys.argv[1] == "full-export":
1156 hosts = {}
1157 for node in get_hostlist():
1158 datadump = get_yaml(node)
1159 hosts[datadump['nodename']] = datadump
1160 print yaml.dump(hosts)
1161
1162 elif sys.argv[1] == "dns":
1163 make_dns(sys.argv[2] if len(sys.argv) > 2 else 'dns', 'external' in sys.argv)
1164 elif sys.argv[1] == "cleanup":
1165 # First generate all datadumps
1166 datadumps = dict()
1167 for host in get_hostlist():
1168 logger.info("# Processing: %s", host)
1169 # Set some boring default values
1170 datadump = { 'board' : 'UNKNOWN' }
1171 datadump.update(get_yaml(host))
1172 datadumps[datadump['autogen_realname']] = datadump
1173
1174
1175 for host,datadump in datadumps.iteritems():
1176 # Convert all yes and no to boolean values
1177 def fix_boolean(dump):
1178 for key in dump.keys():
1179 if type(dump[key]) == dict:
1180 dump[key] = fix_boolean(dump[key])
1181 elif str(dump[key]).lower() in ["yes", "true"]:
1182 dump[key] = True
1183 elif str(dump[key]).lower() in ["no", "false"]:
1184 # Compass richting no (Noord Oost) is valid input
1185 if key != "compass": dump[key] = False
1186 return dump
1187 datadump = fix_boolean(datadump)
1188
1189 if datadump['rdnap_x'] and datadump['rdnap_y']:
1190 datadump['latitude'], datadump['longitude'] = rdnap.rd2etrs(datadump['rdnap_x'], datadump['rdnap_y'])
1191 elif datadump['latitude'] and datadump['longitude']:
1192 datadump['rdnap_x'], datadump['rdnap_y'] = rdnap.etrs2rd(datadump['latitude'], datadump['longitude'])
1193
1194 if datadump['nodename'].startswith('Proxy'):
1195 datadump['nodename'] = datadump['nodename'].lower()
1196
1197 for iface_key in datadump['autogen_iface_keys']:
1198 # Wireless Leiden SSID have an consistent lowercase/uppercase
1199 if datadump[iface_key].has_key('ssid'):
1200 ssid = datadump[iface_key]['ssid']
1201 prefix = 'ap-WirelessLeiden-'
1202 if ssid.lower().startswith(prefix.lower()):
1203 datadump[iface_key]['ssid'] = prefix + ssid[len(prefix)].upper() + ssid[len(prefix) + 1:]
1204 if datadump[iface_key].has_key('ns_ip') and not datadump[iface_key].has_key('mode'):
1205 datadump[iface_key]['mode'] = 'autogen-FIXME'
1206 if not datadump[iface_key].has_key('desc'):
1207 datadump[iface_key]['desc'] = 'autogen-FIXME'
1208 store_yaml(datadump)
1209 elif sys.argv[1] == "list":
1210 if sys.argv[2] == "nodes":
1211 systems = get_nodelist()
1212 elif sys.argv[2] == "proxies":
1213 systems = get_proxylist()
1214 elif sys.argv[2] == "all":
1215 systems = get_hostlist()
1216 else:
1217 usage()
1218 for system in systems:
1219 datadump = get_yaml(system)
1220 if datadump['status'] == "up":
1221 print system
1222 elif sys.argv[1] == "create":
1223 if sys.argv[2] == "network.kml":
1224 print make_network_kml.make_graph()
1225 else:
1226 usage()
1227 usage()
1228 else:
1229 # Do not enable debugging for config requests as it highly clutters the output
1230 if not is_text_request():
1231 cgitb.enable()
1232 process_cgi_request()
1233
1234
1235if __name__ == "__main__":
1236 main()
Note: See TracBrowser for help on using the repository browser.