source: genesis/tools/gformat.py@ 10524

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

Makes it crystal clear which part belong to which function.
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 39.6 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 10524 2012-04-17 08:48:39Z 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 # Use some boring defaults
84 datadump = { 'service_proxy' : False, 'service_ileiden' : False }
85 f = open(gfile, 'r')
86 datadump.update(yaml.load(f,Loader=Loader))
87 f.close()
88
89 # Preformat certain needed variables for formatting and push those into special object
90 datadump['autogen_iface_keys'] = get_interface_keys(datadump)
91
92 wlan_count=0
93 for key in datadump['autogen_iface_keys']:
94 if datadump[key]['type'] in ['11a', '11b', '11g', 'wireless']:
95 datadump[key]['autogen_ifname'] = 'wlan%i' % wlan_count
96 wlan_count += 1
97 else:
98 datadump[key]['autogen_ifname'] = datadump[key]['interface'].split(':')[0]
99
100 dhcp_interfaces = [datadump[key]['autogen_ifname'] for key in datadump['autogen_iface_keys'] if datadump[key]['dhcp']]
101 datadump['autogen_dhcp_interfaces'] = ','.join(dhcp_interfaces)
102 datadump['autogen_item'] = item
103
104 datadump['autogen_realname'] = get_realname(datadump)
105 datadump['autogen_domain'] = datadump['domain'] if datadump.has_key('domain') else 'wleiden.net.'
106 datadump['autogen_fqdn'] = datadump['autogen_realname'] + '.' + datadump['autogen_domain']
107 return datadump
108
109
110def store_yaml(datadump, header=False):
111 """ Store configuration yaml for 'item'"""
112 item = datadump['autogen_item']
113 gfile = os.path.join(NODE_DIR,item,'wleiden.yaml')
114
115 f = open(gfile, 'w')
116 f.write(generate_wleiden_yaml(datadump, header))
117 f.close()
118
119
120
121def make_relations():
122 """ Process _ALL_ yaml files to get connection relations """
123 errors = ""
124 poel = defaultdict(list)
125 for host in get_hostlist():
126 try:
127 datadump = get_yaml(host)
128 for iface_key in datadump['autogen_iface_keys']:
129 l = datadump[iface_key]['ip']
130 addr, mask = l.split('/')
131
132 # Not parsing of these folks please
133 if not valid_addr(addr):
134 continue
135
136 addr = parseaddr(addr)
137 mask = int(mask)
138 network = addr & ~((1 << (32 - mask)) - 1)
139 poel[network] += [(host,datadump[iface_key])]
140 except (KeyError, ValueError), e:
141 errors += "[FOUT] in '%s' interface '%s'" % (host,iface_key)
142 errors += e
143 continue
144 return (poel, errors)
145
146
147def get_proxylist():
148 """Get all available proxies proxyX sorting based on X number"""
149 proxylist = sorted([os.path.basename(x) for x in glob.glob("%s/proxy*" % NODE_DIR)],
150 key=lambda name: int(''.join([c for c in name if c in string.digits])),
151 cmp=lambda x,y: x - y) + sorted([os.path.basename(x) for x in glob.glob("%s/Proxy*" % NODE_DIR)])
152 return proxylist
153
154def get_hybridlist():
155 """Get all available hybrid nodes/proxies"""
156 hybridlist = sorted([os.path.basename(x) for x in glob.glob("%s/Hybrid*" % NODE_DIR)])
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 for host in get_hybridlist():
449 hostdump = get_yaml(host)
450 if hostdump['service_ileiden']:
451 ileiden_proxies.append(hostdump)
452 if hostdump['service_proxy']:
453 normal_proxies.append(hostdump)
454
455 datadump['autogen_ileiden_proxies'] = ','.join([x['masterip'] for x in ileiden_proxies])
456 datadump['autogen_ileiden_proxies_names'] = ','.join([x['autogen_item'] for x in ileiden_proxies])
457 datadump['autogen_normal_proxies'] = ','.join([x['masterip'] for x in normal_proxies])
458 datadump['autogen_normal_proxies_names'] = ','.join([x['autogen_item'] for x in normal_proxies])
459
460 output = generate_header("#");
461 output += Template("""\
462hostname='{{ autogen_fqdn }}'
463location='{{ location }}'
464nodetype="{{ nodetype }}"
465
466#
467# Configured listings
468#
469captive_portal_whitelist=""
470captive_portal_interfaces="{{ autogen_dhcp_interfaces }}"
471# iLeiden Proxies {{ autogen_ileiden_proxies_names }}
472list_ileiden_proxies="{{ autogen_ileiden_proxies }}"
473# normal Proxies {{ autogen_normal_proxies_names }}
474list_normal_proxies="{{ autogen_normal_proxies }}"
475
476{% if nodetype == "Proxy" %}
477#
478# Proxy Configuration
479#
480{% if gateway -%}
481defaultrouter="{{ gateway }}"
482{% else -%}
483#defaultrouter="NOTSET"
484{% endif -%}
485internalif="{{ internalif }}"
486ileiden_enable="{{ autogen_ileiden_enable }}"
487gateway_enable="{{ autogen_ileiden_enable }}"
488pf_enable="yes"
489pf_rules="/etc/pf.conf"
490{% if autogen_ileiden_enable -%}
491pf_flags="-D ext_if={{ externalif }} -D int_if={{ internalif }} -D publicnat={80,443}"
492lvrouted_enable="{{ autogen_ileiden_enable }}"
493lvrouted_flags="-u -s s00p3rs3kr3t -m 28"
494{% else -%}
495pf_flags="-D ext_if={{ externalif }} -D int_if={{ internalif }} -D publicnat={0}"
496{% endif -%}
497{% if internalroute -%}
498static_routes="wleiden"
499route_wleiden="-net 172.16.0.0/12 {{ internalroute }}"
500{% endif -%}
501{% endif -%}
502
503{% if nodetype == "Hybrid" %}
504#
505# Hybrid Configuration
506#
507captive_portal_interfaces="{{ autogen_dhcp_interfaces|default('none', true) }}"
508externalif="{{ externalif|default('vr0', true) }}"
509masterip="{{ masterip }}"
510
511pf_rules="/etc/pf.hybrid.conf"
512pf_flags_hybrid="-D ext_if=$externalif -D ext_if_net=$externalif:network -D captive_portal_interfaces=$captive_portal_interfaces -D masterip=$masterip"
513{% if service_ileiden -%}
514# Service iLeiden
515service_ileiden="yes"
516pf_flags="$pf_flags_hybrid -D publicnat=80,443"
517{% else -%}
518pf_flags="$pf_flags_hybrid -D publicnat=0"
519{% endif -%}
520
521{% if service_proxy %}
522# Service Proxy
523service_proxy="yes"
524tinyproxy_enable="yes"
525{% else -%}
526service_proxy="no"
527pen_wrapper_enable="yes"
528{% endif -%}
529
530{% if board == "ALIX2" %}
531# ''Fat'' configuration, board has 256MB RAM
532dnsmasq_enable="NO"
533named_enable="YES"
534dhcpd_enable="YES"
535{% endif -%}
536
537{% if gateway -%}
538defaultrouter="{{ gateway }}"
539{% endif -%}
540#
541# END Hybrid Configuration
542#
543{% endif -%}
544
545
546{% if nodetype == "CNode" %}
547#
548# NODE iLeiden Configuration
549#
550
551{% if tproxy -%}
552tproxy_enable='YES'
553tproxy_range='{{ tproxy }}'
554{% else -%}
555tproxy_enable='NO'
556{% endif -%}
557
558lvrouted_flags="-u -s s00p3rs3kr3t -m 28 -z $list_ileiden_proxies"
559{% endif %}
560\n
561""").render(datadump)
562
563 # lo0 configuration:
564 # - 172.32.255.1/32 is the proxy.wleiden.net deflector
565 # - masterip is special as it needs to be assigned to at
566 # least one interface, so if not used assign to lo0
567 addrs_list = { 'lo0' : [("127.0.0.1/8", "LocalHost"), ("172.31.255.1/32","Proxy IP")] }
568 iface_map = {'lo0' : 'lo0'}
569 dhclient_if = {'lo0' : False}
570
571 masterip_used = False
572 for iface_key in datadump['autogen_iface_keys']:
573 if datadump[iface_key]['ip'].startswith(datadump['masterip']):
574 masterip_used = True
575 break
576 if not masterip_used:
577 addrs_list['lo0'].append((datadump['masterip'] + "/32", 'Master IP Not used in interface'))
578
579 for iface_key in datadump['autogen_iface_keys']:
580 ifacedump = datadump[iface_key]
581 ifname = ifacedump['autogen_ifname']
582
583 # Flag dhclient is possible
584 dhclient_if[ifname] = ifacedump.has_key('dhcpclient') and ifacedump['dhcpclient']
585
586 # Add interface IP to list
587 item = (ifacedump['ip'], ifacedump['desc'])
588 if addrs_list.has_key(ifname):
589 addrs_list[ifname].append(item)
590 else:
591 addrs_list[ifname] = [item]
592
593 # Alias only needs IP assignment for now, this might change if we
594 # are going to use virtual accesspoints
595 if "alias" in iface_key:
596 continue
597
598 # XXX: Might want to deduct type directly from interface name
599 if ifacedump['type'] in ['11a', '11b', '11g', 'wireless']:
600 # Default to station (client) mode
601 ifacedump['wlanmode'] = "sta"
602 if ifacedump['mode'] in ['master', 'master-wds', 'ap', 'ap-wds']:
603 ifacedump['wlanmode'] = "ap"
604 # Default to 802.11b mode
605 ifacedump['mode'] = '11b'
606 if ifacedump['type'] in ['11a', '11b' '11g']:
607 ifacedump['mode'] = ifacedump['type']
608
609 if not ifacedump.has_key('channel'):
610 if ifacedump['type'] == '11a':
611 ifacedump['channel'] = 36
612 else:
613 ifacedump['channel'] = 1
614
615 # Allow special hacks at the back like wds and stuff
616 if not ifacedump.has_key('extra'):
617 ifacedump['extra'] = 'regdomain ETSI country NL'
618
619 output += "wlans_%(interface)s='%(autogen_ifname)s'\n" % ifacedump
620 output += ("create_args_%(autogen_ifname)s='wlanmode %(wlanmode)s mode " +\
621 "%(mode)s ssid %(ssid)s %(extra)s channel %(channel)s'\n") % ifacedump
622
623 elif ifacedump['type'] in ['ethernet', 'eth']:
624 # No special config needed besides IP
625 pass
626 else:
627 assert False, "Unknown type " + ifacedump['type']
628
629 # Print IP address which needs to be assigned over here
630 output += "\n"
631 for iface,addrs in sorted(addrs_list.iteritems()):
632 for addr, comment in sorted(addrs,key=lambda x: parseaddr(x[0].split('/')[0])):
633 output += "# %s || %s || %s\n" % (iface, addr, comment)
634
635 # Write DHCLIENT entry
636 if dhclient_if[iface]:
637 output += "ifconfig_%s='SYNCDHCP'\n\n" % (iface)
638 else:
639 output += "ipv4_addrs_%s='%s'\n\n" % (iface, " ".join([x[0] for x in addrs]))
640
641 return output
642
643
644
645
646def get_all_configs():
647 """ Get dict with key 'host' with all configs present """
648 configs = dict()
649 for host in get_hostlist():
650 datadump = get_yaml(host)
651 configs[host] = datadump
652 return configs
653
654
655def get_interface_keys(config):
656 """ Quick hack to get all interface keys, later stage convert this to a iterator """
657 return sorted([elem for elem in config.keys() if (elem.startswith('iface_') and not "lo0" in elem)])
658
659
660def get_used_ips(configs):
661 """ Return array of all IPs used in config files"""
662 ip_list = []
663 for config in configs:
664 ip_list.append(config['masterip'])
665 for iface_key in get_interface_keys(config):
666 l = config[iface_key]['ip']
667 addr, mask = l.split('/')
668 # Special case do not process
669 if valid_addr(addr):
670 ip_list.append(addr)
671 else:
672 logger.error("## IP '%s' in '%s' not valid" % (addr, config['nodename']))
673 return sorted(ip_list)
674
675
676
677def generate_resolv_conf(datadump):
678 """ Generate configuration file '/etc/resolv.conf' """
679 # XXX: This should properly going to be an datastructure soon
680 datadump['autogen_header'] = generate_header("#")
681 datadump['autogen_edge_nameservers'] = ''
682 for host in get_proxylist():
683 hostdump = get_yaml(host)
684 datadump['autogen_edge_nameservers'] += "nameserver %(masterip)-15s # %(autogen_realname)s\n" % hostdump
685 for host in get_hybridlist():
686 hostdump = get_yaml(host)
687 if hostdump['service_proxy'] or hostdump['service_ileiden']:
688 datadump['autogen_edge_nameservers'] += "nameserver %(masterip)-15s # %(autogen_realname)s\n" % hostdump
689
690 return Template("""\
691{{ autogen_header }}
692search wleiden.net
693
694# Try local (cache) first
695nameserver 127.0.0.1
696
697{% if service_proxy or service_ileiden or nodetype == 'Proxy' -%}
698nameserver 8.8.8.8 # Google Public NameServer
699nameserver 8.8.4.4 # Google Public NameServer
700{% else -%}
701{{ autogen_edge_nameservers }}
702{% endif -%}
703""").render(datadump)
704
705
706
707def generate_motd(datadump):
708 """ Generate configuration file '/etc/motd' """
709 output = """\
710FreeBSD 9.0-RELEASE (kernel.wleiden) #0 r230587: Sun Jan 29 17:09:57 CET 2012
711
712 WWW: %(autogen_fqdn)s - http://www.wirelessleiden.nl
713 Loc: %(location)s
714
715Interlinks:
716""" % datadump
717
718 # XXX: This is a hacky way to get the required data
719 for line in generate_rc_conf_local(datadump).split('\n'):
720 if '||' in line and not line[1:].split()[0] in ['lo0', 'ath0'] :
721 output += " - %s \n" % line[1:]
722 output += """\
723Attached bridges:
724"""
725 for iface_key in datadump['autogen_iface_keys']:
726 ifacedump = datadump[iface_key]
727 if ifacedump.has_key('ns_ip'):
728 output += " - %(interface)s || %(mode)s || %(ns_ip)s\n" % ifacedump
729
730 return output
731
732
733def format_yaml_value(value):
734 """ Get yaml value in right syntax for outputting """
735 if isinstance(value,str):
736 output = '"%s"' % value
737 else:
738 output = value
739 return output
740
741
742
743def format_wleiden_yaml(datadump):
744 """ Special formatting to ensure it is editable"""
745 output = "# Genesis config yaml style\n"
746 output += "# vim:ts=2:et:sw=2:ai\n"
747 output += "#\n"
748 iface_keys = [elem for elem in datadump.keys() if elem.startswith('iface_')]
749 for key in sorted(set(datadump.keys()) - set(iface_keys)):
750 output += "%-10s: %s\n" % (key, format_yaml_value(datadump[key]))
751
752 output += "\n\n"
753
754 key_order = [ 'comment', 'interface', 'ip', 'desc', 'sdesc', 'mode', 'type',
755 'extra_type', 'channel', 'ssid', 'dhcp' ]
756
757 for iface_key in sorted(iface_keys):
758 output += "%s:\n" % iface_key
759 for key in key_order + list(sorted(set(datadump[iface_key].keys()) - set(key_order))):
760 if datadump[iface_key].has_key(key):
761 output += " %-11s: %s\n" % (key, format_yaml_value(datadump[iface_key][key]))
762 output += "\n\n"
763
764 return output
765
766
767
768def generate_wleiden_yaml(datadump, header=True):
769 """ Generate (petty) version of wleiden.yaml"""
770 for key in datadump.keys():
771 if key.startswith('autogen_'):
772 del datadump[key]
773 # Interface autogen cleanups
774 elif type(datadump[key]) == dict:
775 for key2 in datadump[key].keys():
776 if key2.startswith('autogen_'):
777 del datadump[key][key2]
778
779 output = generate_header("#") if header else ''
780 output += format_wleiden_yaml(datadump)
781 return output
782
783
784def generate_yaml(datadump):
785 return generate_config(datadump['nodename'], "wleiden.yaml", datadump)
786
787
788
789def generate_config(node, config, datadump=None):
790 """ Print configuration file 'config' of 'node' """
791 output = ""
792 try:
793 # Load config file
794 if datadump == None:
795 datadump = get_yaml(node)
796
797 if config == 'wleiden.yaml':
798 output += generate_wleiden_yaml(datadump)
799 elif config == 'authorized_keys':
800 f = open(os.path.join(NODE_DIR,"global_keys"), 'r')
801 output += f.read()
802 f.close()
803 elif config == 'dnsmasq.conf':
804 output += generate_dnsmasq_conf(datadump)
805 elif config == 'dhcpd.conf':
806 output += generate_dhcpd_conf(datadump)
807 elif config == 'rc.conf.local':
808 output += generate_rc_conf_local(datadump)
809 elif config == 'resolv.conf':
810 output += generate_resolv_conf(datadump)
811 elif config == 'motd':
812 output += generate_motd(datadump)
813 else:
814 assert False, "Config not found!"
815 except IOError, e:
816 output += "[ERROR] Config file not found"
817 return output
818
819
820
821def process_cgi_request():
822 """ When calling from CGI """
823 # Update repository if requested
824 form = cgi.FieldStorage()
825 if form.getvalue("action") == "update":
826 print "Refresh: 5; url=."
827 print "Content-type:text/plain\r\n\r\n",
828 print "[INFO] Updating subverion, please wait..."
829 print subprocess.Popen(['svn', 'cleanup', "%s/.." % NODE_DIR], stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0],
830 print subprocess.Popen(['svn', 'up', "%s/.." % NODE_DIR], stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0],
831 print "[INFO] All done, redirecting in 5 seconds"
832 sys.exit(0)
833
834
835 base_uri = os.environ['PATH_INFO']
836 uri = base_uri.strip('/').split('/')
837
838 output = ""
839 if base_uri.endswith('/create/network.kml'):
840 output += "Content-type:application/vnd.google-earth.kml+xml\r\n\r\n"
841 output += make_network_kml.make_graph()
842 elif not uri[0]:
843 if is_text_request():
844 output += "Content-type:text/plain\r\n\r\n"
845 output += '\n'.join(get_hostlist())
846 else:
847 output += "Content-type:text/html\r\n\r\n"
848 output += generate_title(get_hostlist())
849 elif len(uri) == 1:
850 if is_text_request():
851 output += "Content-type:text/plain\r\n\r\n"
852 output += generate_node(uri[0])
853 else:
854 output += "Content-type:text/html\r\n\r\n"
855 output += generate_node_overview(uri[0])
856 elif len(uri) == 2:
857 output += "Content-type:text/plain\r\n\r\n"
858 output += generate_config(uri[0], uri[1])
859 else:
860 assert False, "Invalid option"
861 print output
862
863def get_realname(datadump):
864 # Proxy naming convention is special, as the proxy name is also included in
865 # the nodename, when it comes to the numbered proxies.
866 if datadump['nodetype'] == 'Proxy':
867 realname = datadump['nodetype'] + datadump['nodename'].replace('proxy','')
868 else:
869 # By default the full name is listed and also a shortname CNAME for easy use.
870 realname = datadump['nodetype'] + datadump['nodename']
871 return(realname)
872
873
874
875def make_dns(output_dir = 'dns', external = False):
876 items = dict()
877
878 # hostname is key, IP is value
879 wleiden_zone = dict()
880 wleiden_cname = dict()
881
882 pool = dict()
883 for node in get_hostlist():
884 logger.info("Processing host %s", node)
885 datadump = get_yaml(node)
886
887 # Proxy naming convention is special
888 fqdn = datadump['autogen_realname']
889 if datadump['nodetype'] in ['CNode', 'Hybrid']:
890 wleiden_cname[datadump['nodename']] = fqdn
891
892 wleiden_zone[fqdn] = datadump['masterip']
893
894 # Hacking to get proper DHCP IPs and hostnames
895 for iface_key in get_interface_keys(datadump):
896 iface_name = datadump[iface_key]['interface'].replace(':',"-alias-")
897 (ip, cidr) = datadump[iface_key]['ip'].split('/')
898 try:
899 (dhcp_start, dhcp_stop) = datadump[iface_key]['dhcp'].split('-')
900 datadump[iface_key]['netmask'] = cidr2netmask(cidr)
901 dhcp_part = ".".join(ip.split('.')[0:3])
902 if ip != datadump['masterip']:
903 wleiden_zone["dhcp-gateway-%s.%s" % (iface_name, fqdn)] = ip
904 for i in range(int(dhcp_start), int(dhcp_stop) + 1):
905 wleiden_zone["dhcp-%s-%s.%s" % (i, iface_name, fqdn)] = "%s.%s" % (dhcp_part, i)
906 except (AttributeError, ValueError):
907 # First push it into a pool, to indentify the counter-part later on
908 addr = parseaddr(ip)
909 cidr = int(cidr)
910 addr = addr & ~((1 << (32 - cidr)) - 1)
911 if pool.has_key(addr):
912 pool[addr] += [(iface_name, fqdn, ip)]
913 else:
914 pool[addr] = [(iface_name, fqdn, ip)]
915 continue
916
917
918 def pool_to_name(node, pool_members):
919 """Convert the joined name to a usable pool name"""
920
921 # Get rid of the own entry
922 pool_members = list(set(pool_members) - set([fqdn]))
923
924 target = oldname = ''
925 for node in sorted(pool_members):
926 (name, number) = re.match('^([A-Za-z]+)([0-9]*)$',node).group(1,2)
927 target += "-" + number if name == oldname else "-" + node if target else node
928 oldname = name
929
930 return target
931
932
933 # WL uses an /29 to configure an interface. IP's are ordered like this:
934 # MasterA (.1) -- DeviceA (.2) <<>> DeviceB (.3) --- SlaveB (.4)
935
936 sn = lambda x: re.sub(r'(?i)^cnode','',x)
937
938 # Automatic naming convention of interlinks namely 2 + remote.lower()
939 for (key,value) in pool.iteritems():
940 # Make sure they are sorted from low-ip to high-ip
941 value = sorted(value, key=lambda x: parseaddr(x[2]))
942
943 if len(value) == 1:
944 (iface_name, fqdn, ip) = value[0]
945 wleiden_zone["2unused-%s.%s" % (iface_name, fqdn)] = ip
946
947 # Device DNS names
948 if 'cnode' in fqdn.lower():
949 wleiden_zone["d-at-%s.%s" % (iface_name, fqdn)] = showaddr(parseaddr(ip) + 1)
950 wleiden_cname["d-at-%s.%s" % (iface_name,sn(fqdn))] = "d-at-%s.%s" % (iface_name, fqdn)
951
952 elif len(value) == 2:
953 (a_iface_name, a_fqdn, a_ip) = value[0]
954 (b_iface_name, b_fqdn, b_ip) = value[1]
955 wleiden_zone["2%s.%s" % (b_fqdn,a_fqdn)] = a_ip
956 wleiden_zone["2%s.%s" % (a_fqdn,b_fqdn)] = b_ip
957
958 # Device DNS names
959 if 'cnode' in a_fqdn.lower() and 'cnode' in b_fqdn.lower():
960 wleiden_zone["d-at-%s.%s" % (a_iface_name, a_fqdn)] = showaddr(parseaddr(a_ip) + 1)
961 wleiden_zone["d-at-%s.%s" % (b_iface_name, b_fqdn)] = showaddr(parseaddr(b_ip) - 1)
962 wleiden_cname["d-at-%s.%s" % (a_iface_name,sn(a_fqdn))] = "d-at-%s.%s" % (a_iface_name, a_fqdn)
963 wleiden_cname["d-at-%s.%s" % (b_iface_name,sn(b_fqdn))] = "d-at-%s.%s" % (b_iface_name, b_fqdn)
964 wleiden_cname["d2%s.%s" % (sn(b_fqdn),sn(a_fqdn))] = "d-at-%s.%s" % (a_iface_name, a_fqdn)
965 wleiden_cname["d2%s.%s" % (sn(a_fqdn),sn(b_fqdn))] = "d-at-%s.%s" % (b_iface_name, b_fqdn)
966
967 else:
968 pool_members = [k[1] for k in value]
969 for item in value:
970 (iface_name, fqdn, ip) = item
971 pool_name = "2pool-" + showaddr(key).replace('.','-') + "-" + pool_to_name(fqdn,pool_members)
972 wleiden_zone["%s.%s" % (pool_name, fqdn)] = ip
973
974 # Include static DNS entries
975 # XXX: Should they override the autogenerated results?
976 # XXX: Convert input to yaml more useable.
977 # Format:
978 ##; this is a comment
979 ## roomburgh=CNodeRoomburgh1
980 ## apkerk1.CNodeVosko=172.17.176.8 ;this as well
981 dns = yaml.load(open(os.path.join(NODE_DIR,'../dns/staticDNS.yaml'),'r'))
982
983 # Hack to allow special entries, for development
984 wleiden_raw = dns['raw']
985 del dns['raw']
986
987 for comment, block in dns.iteritems():
988 for k,v in block.iteritems():
989 if valid_addr(v):
990 wleiden_zone[k] = v
991 else:
992 wleiden_cname[k] = v
993
994 details = dict()
995 # 24 updates a day allowed
996 details['serial'] = time.strftime('%Y%m%d%H')
997
998 if external:
999 dns_masters = ['siteview.wirelessleiden.nl', 'ns1.vanderzwet.net']
1000 else:
1001 dns_masters = ['sunny.wleiden.net']
1002
1003 details['master'] = dns_masters[0]
1004 details['ns_servers'] = '\n'.join(['\tNS\t%s.' % x for x in dns_masters])
1005
1006 dns_header = '''
1007$TTL 3h
1008%(zone)s. SOA %(master)s. beheer.lijst.wirelessleiden.nl. ( %(serial)s 1d 12h 1w 3h )
1009 ; Serial, Refresh, Retry, Expire, Neg. cache TTL
1010
1011%(ns_servers)s
1012 \n'''
1013
1014
1015 if not os.path.isdir(output_dir):
1016 os.makedirs(output_dir)
1017 details['zone'] = 'wleiden.net'
1018 f = open(os.path.join(output_dir,"db." + details['zone']), "w")
1019 f.write(dns_header % details)
1020
1021 for host,ip in wleiden_zone.iteritems():
1022 if valid_addr(ip):
1023 f.write("%s.wleiden.net. IN A %s \n" % (host.lower(), ip))
1024 for source,dest in wleiden_cname.iteritems():
1025 f.write("%s.wleiden.net. IN CNAME %s.wleiden.net.\n" % (source.lower(), dest.lower()))
1026 for source, dest in wleiden_raw.iteritems():
1027 f.write("%s.wleiden.net. %s\n" % (source, dest))
1028 f.close()
1029
1030 # Create whole bunch of specific sub arpa zones. To keep it compliant
1031 for s in range(16,32):
1032 details['zone'] = '%i.172.in-addr.arpa' % s
1033 f = open(os.path.join(output_dir,"db." + details['zone']), "w")
1034 f.write(dns_header % details)
1035
1036 #XXX: Not effient, fix to proper data structure and do checks at other
1037 # stages
1038 for host,ip in wleiden_zone.iteritems():
1039 if valid_addr(ip):
1040 if int(ip.split('.')[1]) == s:
1041 rev_ip = '.'.join(reversed(ip.split('.')))
1042 f.write("%s.in-addr.arpa. IN PTR %s.wleiden.net.\n" % (rev_ip.lower(), host.lower()))
1043 f.close()
1044
1045
1046def usage():
1047 print """Usage: %s <standalone [port] |test [test arguments]|static|dns>
1048Examples:
1049\tdns [outputdir] = Generate BIND compliant zone files in dns.
1050\tstandalone = Run configurator webserver [default port=8000]
1051\twind-export = Generate SQL import scripts for WIND database
1052\tfull-export = Generate yaml export script for heatmap.
1053\tstatic = Generate all config files and store on disk
1054\t with format ./static/%%NODE%%/%%FILE%%
1055\ttest CNodeRick dnsmasq.conf = Receive output of CGI script
1056\t for arguments CNodeRick/dnsmasq.conf
1057\tlist <all|nodes|proxies> = List systems which marked up.
1058"""
1059 exit(0)
1060
1061
1062def is_text_request():
1063 """ Find out whether we are calling from the CLI or any text based CLI utility """
1064 try:
1065 return os.environ['HTTP_USER_AGENT'].split()[0] in ['curl', 'fetch', 'wget']
1066 except KeyError:
1067 return True
1068
1069def main():
1070 """Hard working sub"""
1071 # Allow easy hacking using the CLI
1072 if not os.environ.has_key('PATH_INFO'):
1073 if len(sys.argv) < 2:
1074 usage()
1075
1076 if sys.argv[1] == "standalone":
1077 import SocketServer
1078 import CGIHTTPServer
1079 # Hop to the right working directory.
1080 os.chdir(os.path.dirname(__file__))
1081 try:
1082 PORT = int(sys.argv[2])
1083 except (IndexError,ValueError):
1084 PORT = 8000
1085
1086 class MyCGIHTTPRequestHandler(CGIHTTPServer.CGIHTTPRequestHandler):
1087 """ Serve this CGI from the root of the webserver """
1088 def is_cgi(self):
1089 if "favicon" in self.path:
1090 return False
1091
1092 self.cgi_info = (os.path.basename(__file__), self.path)
1093 self.path = ''
1094 return True
1095 handler = MyCGIHTTPRequestHandler
1096 SocketServer.TCPServer.allow_reuse_address = True
1097 httpd = SocketServer.TCPServer(("", PORT), handler)
1098 httpd.server_name = 'localhost'
1099 httpd.server_port = PORT
1100
1101 logger.info("serving at port %s", PORT)
1102 try:
1103 httpd.serve_forever()
1104 except KeyboardInterrupt:
1105 httpd.shutdown()
1106 logger.info("All done goodbye")
1107 elif sys.argv[1] == "test":
1108 os.environ['PATH_INFO'] = "/".join(sys.argv[2:])
1109 os.environ['SCRIPT_NAME'] = __file__
1110 process_cgi_request()
1111 elif sys.argv[1] == "unit-test":
1112 os.environ['SCRIPT_NAME'] = __file__
1113 for host in get_hostlist():
1114 for outfile in files:
1115 os.environ['PATH_INFO'] = "/".join([host,outfile])
1116 try:
1117 process_cgi_request()
1118 except Exception:
1119 print "# ERROR: %s" % os.environ['PATH_INFO']
1120 raise
1121
1122
1123 elif sys.argv[1] == "static":
1124 items = dict()
1125 for node in get_hostlist():
1126 items['node'] = node
1127 items['wdir'] = "./static/%(node)s" % items
1128 if not os.path.isdir(items['wdir']):
1129 os.makedirs(items['wdir'])
1130 datadump = get_yaml(node)
1131 for config in files:
1132 items['config'] = config
1133 logger.info("## Generating %(node)s %(config)s" % items)
1134 f = open("%(wdir)s/%(config)s" % items, "w")
1135 f.write(generate_config(node, config, datadump))
1136 f.close()
1137 elif sys.argv[1] == "wind-export":
1138 items = dict()
1139 for node in get_hostlist():
1140 datadump = get_yaml(node)
1141 sql = """INSERT IGNORE INTO nodes (name, name_ns, longitude, latitude)
1142 VALUES ('%(nodename)s', '%(nodename)s', %(latitude)s, %(longitude)s);""" % datadump;
1143 sql = """INSERT IGNORE INTO users_nodes (user_id, node_id, owner)
1144 VALUES (
1145 (SELECT id FROM users WHERE username = 'rvdzwet'),
1146 (SELECT id FROM nodes WHERE name = '%(nodename)s'),
1147 'Y');""" % datadump
1148 #for config in files:
1149 # items['config'] = config
1150 # print "## Generating %(node)s %(config)s" % items
1151 # f = open("%(wdir)s/%(config)s" % items, "w")
1152 # f.write(generate_config(node, config, datadump))
1153 # f.close()
1154 for node in get_hostlist():
1155 datadump = get_yaml(node)
1156 for iface_key in sorted([elem for elem in datadump.keys() if elem.startswith('iface_')]):
1157 ifacedump = datadump[iface_key]
1158 if ifacedump.has_key('mode') and ifacedump['mode'] == 'ap-wds':
1159 ifacedump['nodename'] = datadump['nodename']
1160 if not ifacedump.has_key('channel') or not ifacedump['channel']:
1161 ifacedump['channel'] = 0
1162 sql = """INSERT INTO links (node_id, type, ssid, protocol, channel, status)
1163 VALUES ((SELECT id FROM nodes WHERE name = '%(nodename)s'), 'ap',
1164 '%(ssid)s', 'IEEE 802.11b', %(channel)s, 'active');""" % ifacedump
1165 elif sys.argv[1] == "full-export":
1166 hosts = {}
1167 for node in get_hostlist():
1168 datadump = get_yaml(node)
1169 hosts[datadump['nodename']] = datadump
1170 print yaml.dump(hosts)
1171
1172 elif sys.argv[1] == "dns":
1173 make_dns(sys.argv[2] if len(sys.argv) > 2 else 'dns', 'external' in sys.argv)
1174 elif sys.argv[1] == "cleanup":
1175 # First generate all datadumps
1176 datadumps = dict()
1177 for host in get_hostlist():
1178 logger.info("# Processing: %s", host)
1179 # Set some boring default values
1180 datadump = { 'board' : 'UNKNOWN' }
1181 datadump.update(get_yaml(host))
1182 datadumps[datadump['autogen_realname']] = datadump
1183
1184
1185 for host,datadump in datadumps.iteritems():
1186 # Convert all yes and no to boolean values
1187 def fix_boolean(dump):
1188 for key in dump.keys():
1189 if type(dump[key]) == dict:
1190 dump[key] = fix_boolean(dump[key])
1191 elif str(dump[key]).lower() in ["yes", "true"]:
1192 dump[key] = True
1193 elif str(dump[key]).lower() in ["no", "false"]:
1194 # Compass richting no (Noord Oost) is valid input
1195 if key != "compass": dump[key] = False
1196 return dump
1197 datadump = fix_boolean(datadump)
1198
1199 if datadump['rdnap_x'] and datadump['rdnap_y']:
1200 datadump['latitude'], datadump['longitude'] = rdnap.rd2etrs(datadump['rdnap_x'], datadump['rdnap_y'])
1201 elif datadump['latitude'] and datadump['longitude']:
1202 datadump['rdnap_x'], datadump['rdnap_y'] = rdnap.etrs2rd(datadump['latitude'], datadump['longitude'])
1203
1204 if datadump['nodename'].startswith('Proxy'):
1205 datadump['nodename'] = datadump['nodename'].lower()
1206
1207 for iface_key in datadump['autogen_iface_keys']:
1208 # Wireless Leiden SSID have an consistent lowercase/uppercase
1209 if datadump[iface_key].has_key('ssid'):
1210 ssid = datadump[iface_key]['ssid']
1211 prefix = 'ap-WirelessLeiden-'
1212 if ssid.lower().startswith(prefix.lower()):
1213 datadump[iface_key]['ssid'] = prefix + ssid[len(prefix)].upper() + ssid[len(prefix) + 1:]
1214 if datadump[iface_key].has_key('ns_ip') and not datadump[iface_key].has_key('mode'):
1215 datadump[iface_key]['mode'] = 'autogen-FIXME'
1216 if not datadump[iface_key].has_key('desc'):
1217 datadump[iface_key]['desc'] = 'autogen-FIXME'
1218 store_yaml(datadump)
1219 elif sys.argv[1] == "list":
1220 if sys.argv[2] == "nodes":
1221 systems = get_nodelist()
1222 elif sys.argv[2] == "proxies":
1223 systems = get_proxylist()
1224 elif sys.argv[2] == "all":
1225 systems = get_hostlist()
1226 else:
1227 usage()
1228 for system in systems:
1229 datadump = get_yaml(system)
1230 if datadump['status'] == "up":
1231 print system
1232 elif sys.argv[1] == "create":
1233 if sys.argv[2] == "network.kml":
1234 print make_network_kml.make_graph()
1235 else:
1236 usage()
1237 usage()
1238 else:
1239 # Do not enable debugging for config requests as it highly clutters the output
1240 if not is_text_request():
1241 cgitb.enable()
1242 process_cgi_request()
1243
1244
1245if __name__ == "__main__":
1246 main()
Note: See TracBrowser for help on using the repository browser.