1 #! /usr/bin/env python3
3 # This file is part of secnet.
4 # See README for full list of copyright holders.
6 # secnet is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # secnet is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # version 3 along with secnet; if not, see
18 # https://www.gnu.org/licenses/gpl.html.
20 """VPN sites file manipulation.
22 This program enables VPN site descriptions to be submitted for
23 inclusion in a central database, and allows the resulting database to
24 be turned into a secnet configuration file.
26 A database file can be turned into a secnet configuration file simply:
27 make-secnet-sites.py [infile [outfile]]
29 It would be wise to run secnet with the "--just-check-config" option
30 before installing the output on a live system.
32 The program expects to be invoked via userv to manage the database; it
33 relies on the USERV_USER and USERV_GROUP environment variables. The
34 command line arguments for this invocation are:
36 make-secnet-sites.py -u header-filename groupfiles-directory output-file \
39 All but the last argument are expected to be set by userv; the 'group'
40 argument is provided by the user. A suitable userv configuration file
46 cd ~/secnet/sites-test/
47 execute ~/secnet/make-secnet-sites.py -u vpnheader groupfiles sites
49 This program is part of secnet.
53 from __future__ import print_function
54 from __future__ import unicode_literals
55 from builtins import int
68 # entry 0 is "near the executable", or maybe from PYTHONPATH=.,
69 # which we don't want to preempt
70 sys.path.insert(1,"/usr/local/share/secnet")
71 sys.path.insert(1,"/usr/share/secnet")
76 from sys import version_info
77 if version_info.major == 2: # for python2
79 sys.stdin = codecs.getreader('utf-8')(sys.stdin)
80 sys.stdout = codecs.getwriter('utf-8')(sys.stdout)
82 open=lambda f,m='r': io.open(f,m,encoding='utf-8')
84 max={'rsa_bits':8200,'name':33,'dh_bits':8200}
96 return not self.__eq__(e)
98 raise RuntimeError('direct use of Tainted value')
100 return 'Tainted(%s)' % repr(self._s)
102 def _bad(self,what,why):
103 assert(self._ok is not True)
105 complain('bad parameter: %s: %s' % (what, why))
108 def _max_ok(self,what,maxlen):
109 if len(self._s) > maxlen:
110 self._bad(what,'too long (max %d)' % maxlen)
113 def _re_ok(self,bad,what,maxlen=None):
114 if maxlen is None: maxlen=max[what]
115 self._max_ok(what,maxlen)
116 if self._ok is False: return self
117 if bad.search(self._s): return self._bad(what,'bad syntax')
120 def _rtnval(self, is_ok, ifgood, ifbad=''):
122 assert(self._ok is not False)
126 assert(self._ok is not True)
130 def _rtn(self, is_ok, ifbad=''):
131 return self._rtnval(is_ok, self._s, ifbad)
135 def raw_mark_ok(self):
136 # caller promises to throw if syntax was dangeorus
137 return self._rtn(True)
140 if self._ok is False: return ''
141 if self._ok is True: return self._s
142 print('%s:%d: unchecked/unknown additional data "%s"' %
143 (self._file,self._line,self._s),
147 bad_name=re.compile(r'^[^a-zA-Z]|[^-_0-9a-zA-Z]')
148 # secnet accepts _ at start of names, but we reserve that
151 ok=self._re_ok(Tainted.bad_name,'name')
153 '_line%d_%s' % (self._line, id(self)))
156 ok=self._s in keywords or self._s in levels
158 complain('unknown keyword %s' % self._s)
161 bad_hex=re.compile(r'[^0-9a-fA-F]')
162 def bignum_16(self,kind,what):
163 maxlen=(max[kind+'_bits']+3)/4
164 ok=self._re_ok(Tainted.bad_hex,what,maxlen)
167 bad_num=re.compile(r'[^0-9]')
168 def bignum_10(self,kind,what):
169 maxlen=math.ceil(max[kind+'_bits'] / math.log10(2))
170 ok=self._re_ok(Tainted.bad_num,what,maxlen)
173 def number(self,minn,maxx,what='number'):
175 ok=self._re_ok(Tainted.bad_num,what,10)
179 ok=self._bad(what,'out of range %d..%d'
181 return self._rtnval(ok,v,minn)
183 bad_host=re.compile(r'[^-\][_.:0-9a-zA-Z]')
184 # We permit _ so we can refer to special non-host domains
185 # which have A and AAAA RRs. This is a crude check and we may
186 # still produce config files with syntactically invalid
187 # domains or addresses, but that is OK.
189 ok=self._re_ok(Tainted.bad_host,'host/address',255)
192 bad_email=re.compile(r'[^-._0-9a-z@!$%^&*=+~/]')
193 # ^ This does not accept all valid email addresses. That's
194 # not really possible with this input syntax. It accepts
195 # all ones that don't require quoting anywhere in email
196 # protocols (and also accepts some invalid ones).
198 ok=self._re_ok(Tainted.bad_email,'email address',1023)
201 bad_groupname=re.compile(r'^[^_A-Za-z]|[^-+_0-9A-Za-z]')
203 ok=self._re_ok(Tainted.bad_groupname,'group name',64)
216 ap = argparse.ArgumentParser(description='process secnet sites files')
217 ap.add_argument('--userv', '-u', action='store_true',
218 help='userv service fragment update mode')
219 ap.add_argument('--prefix', '-P', nargs=1,
221 ap.add_argument('arg',nargs=argparse.REMAINDER)
223 #print(repr(av), file=sys.stderr)
224 service = 1 if av.userv else 0
227 print("Wrong number of arguments")
229 (header, groupfiledir, sitesfile, group) = av.arg
230 if "USERV_USER" not in os.environ:
231 print("Environment variable USERV_USER not found")
233 user=os.environ["USERV_USER"]
234 # Check that group is in USERV_GROUP
235 if "USERV_GROUP" not in os.environ:
236 print("Environment variable USERV_GROUP not found")
238 ugs=os.environ["USERV_GROUP"]
240 for i in ugs.split():
243 print("caller not in group %s"%group)
247 print("Too many arguments")
249 (inputfile, outputfile) = (av.arg + [None]*2)[0:2]
250 if outputfile is None: of=sys.stdout
251 else: of=open(sys.argv[2],'w')
255 # Classes describing possible datatypes in the configuration file
258 "Common protocol for configuration types."
260 complain("%s %s already has property %s defined"%
261 (obj.type,obj.name,w[0].raw()))
264 "A list of some kind of configuration type."
265 def __init__(self,subtype,w):
267 self.list=[subtype(w)]
269 self.list.append(self.subtype(w))
271 return ', '.join(map(str, self.list))
273 return lambda w: conflist(subtype, w)
275 class single_ipaddr (basetype):
277 def __init__(self,w):
278 self.addr=ipaddress.ip_address(w[1].raw_mark_ok())
280 return '"%s"'%self.addr
282 class networks (basetype):
283 "A set of IP addresses specified as a list of networks"
284 def __init__(self,w):
285 self.set=ipaddrset.IPAddressSet()
287 x=ipaddress.ip_network(i.raw_mark_ok(),strict=True)
290 return ",".join(map((lambda n: '"%s"'%n), self.set.networks()))
292 class dhgroup (basetype):
293 "A Diffie-Hellman group"
294 def __init__(self,w):
295 self.mod=w[1].bignum_16('dh','dh mod')
296 self.gen=w[2].bignum_16('dh','dh gen')
298 return 'diffie-hellman("%s","%s")'%(self.mod,self.gen)
300 class hash (basetype):
301 "A choice of hash function"
302 def __init__(self,w):
305 if (self.ht!='md5' and self.ht!='sha1'):
306 complain("unknown hash type %s"%(self.ht))
311 return '%s'%(self.ht)
313 class email (basetype):
315 def __init__(self,w):
316 self.addr=w[1].email()
318 return '<%s>'%(self.addr)
320 class boolean (basetype):
322 def __init__(self,w):
324 if re.match('[TtYy1]',v.raw()):
327 elif re.match('[FfNn0]',v.raw()):
331 complain("invalid boolean value");
333 return ['False','True'][self.b]
335 class num (basetype):
337 def __init__(self,w):
338 self.n=w[1].number(0,0x7fffffff)
342 class address (basetype):
343 "A DNS name and UDP port number"
344 def __init__(self,w):
346 self.port=w[2].number(1,65536,'port')
348 return '"%s"; port %d'%(self.adr,self.port)
350 class rsakey (basetype):
352 def __init__(self,w):
353 self.l=w[1].number(0,max['rsa_bits'],'rsa len')
354 self.e=w[2].bignum_10('rsa','rsa e')
355 self.n=w[3].bignum_10('rsa','rsa n')
356 if len(w) >= 5: w[4].email()
358 return 'rsa-public("%s","%s")'%(self.e,self.n)
360 # Possible properties of configuration nodes
362 'contact':(email,"Contact address"),
363 'dh':(dhgroup,"Diffie-Hellman group"),
364 'hash':(hash,"Hash function"),
365 'key-lifetime':(num,"Maximum key lifetime (ms)"),
366 'setup-timeout':(num,"Key setup timeout (ms)"),
367 'setup-retries':(num,"Maximum key setup packet retries"),
368 'wait-time':(num,"Time to wait after unsuccessful key setup (ms)"),
369 'renegotiate-time':(num,"Time after key setup to begin renegotiation (ms)"),
370 'restrict-nets':(networks,"Allowable networks"),
371 'networks':(networks,"Claimed networks"),
372 'pubkey':(rsakey,"RSA public site key"),
373 'peer':(single_ipaddr,"Tunnel peer IP address"),
374 'address':(address,"External contact address and port"),
375 'mobile':(boolean,"Site is mobile"),
379 "Simply output a property - the default case"
380 return "%s %s;\n"%(name,value)
382 # All levels support these properties
384 'contact':(lambda name,value:"# Contact email address: %s\n"%(value)),
391 'renegotiate-time':sp,
392 'restrict-nets':(lambda name,value:"# restrict-nets %s\n"%value),
396 "A level in the configuration hierarchy"
400 require_properties={}
401 def __init__(self,w):
402 self.type=w[0].keyword()
403 self.name=w[1].name()
406 def indent(self,w,t):
408 def prop_out(self,n):
409 return self.allow_properties[n](n,str(self.properties[n]))
410 def output_props(self,w,ind):
411 for i in self.properties.keys():
412 if self.allow_properties[i]:
414 w.write("%s"%self.prop_out(i))
415 def output_data(self,w,ind,np):
417 w.write("%s {\n"%(self.name))
418 self.output_props(w,ind+2)
419 if self.depth==1: w.write("\n");
420 for c in self.children.values():
421 c.output_data(w,ind+2,np+self.name+"/")
425 class vpnlevel(level):
426 "VPN level in the configuration hierarchy"
430 allow_properties=global_properties.copy()
432 'contact':"VPN admin contact address"
434 def __init__(self,w):
435 level.__init__(self,w)
436 def output_vpnflat(self,w,ind,h):
437 "Output flattened list of site names for this VPN"
439 w.write("%s {\n"%(self.name))
440 for i in self.children.keys():
441 self.children[i].output_vpnflat(w,ind+2,
442 h+"/"+self.name+"/"+i)
445 w.write("all-sites %s;\n"%
446 ','.join(self.children.keys()))
450 class locationlevel(level):
451 "Location level in the configuration hierarchy"
455 allow_properties=global_properties.copy()
457 'contact':"Location admin contact address",
459 def __init__(self,w):
460 level.__init__(self,w)
461 self.group=w[2].groupname()
462 def output_vpnflat(self,w,ind,h):
464 # The "h=h,self=self" abomination below exists because
465 # Python didn't support nested_scopes until version 2.1
466 w.write("%s %s;\n"%(self.name,','.join(
467 map(lambda x,h=h,self=self:
468 h+"/"+x,self.children.keys()))))
470 class sitelevel(level):
471 "Site level (i.e. a leafnode) in the configuration hierarchy"
475 allow_properties=global_properties.copy()
476 allow_properties.update({
480 'pubkey':(lambda n,v:"key %s;\n"%v),
484 'dh':"Diffie-Hellman group",
485 'contact':"Site admin contact address",
486 'networks':"Networks claimed by the site",
487 'hash':"hash function",
488 'peer':"Gateway address of the site",
489 'pubkey':"RSA public key of the site",
491 def __init__(self,w):
492 level.__init__(self,w)
493 def output_data(self,w,ind,np):
495 w.write("%s {\n"%(self.name))
497 w.write("name \"%s\";\n"%(np+self.name))
498 self.output_props(w,ind+2)
500 w.write("link netlink {\n");
502 w.write("routes %s;\n"%str(self.properties["networks"]))
504 w.write("ptp-address %s;\n"%str(self.properties["peer"]))
510 # Levels in the configuration file
512 levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel}
514 # Reserved vpn/location/site names
515 reserved={'all-sites':None}
516 reserved.update(keywords)
517 reserved.update(levels)
520 "Complain about a particular input line"
522 print(("%s line %d: "%(file,line))+msg)
523 complaints=complaints+1
525 "Complain about something in general"
528 complaints=complaints+1
530 class UntaintedRoot():
531 def __init__(self,s): self._s=s
532 def name(self): return self._s
533 def keyword(self): return self._s
535 root=level([UntaintedRoot(x) for x in ['root','root']])
536 # All vpns are children of this node
538 allow_defs=0 # Level above which new definitions are permitted
541 def set_property(obj,w):
542 "Set a property on a configuration node"
544 if prop.raw() in obj.properties:
545 obj.properties[prop.raw_mark_ok()].add(obj,w)
547 obj.properties[prop.raw()]=keywords[prop.raw_mark_ok()][0](w)
550 def pline(il,allow_include=False):
551 "Process a configuration file line"
552 global allow_defs, obstack, root
553 w=il.rstrip('\n').split()
554 if len(w)==0: return ['']
555 w=list([Tainted(x) for x in w])
557 current=obstack[len(obstack)-1]
558 copyout=lambda: [' '*len(obstack) +
559 ' '.join([ww.output() for ww in w]) +
561 if keyword=='end-definitions':
562 keyword.raw_mark_ok()
563 allow_defs=sitelevel.depth
566 if keyword=='include':
567 if not allow_include:
568 complain("include not permitted here")
571 complain("include requires one argument")
573 newfile=os.path.join(os.path.dirname(file),w[1].raw_mark_ok())
574 # ^ user of "include" is trusted so raw_mark_ok is good
575 return pfilepath(newfile,allow_include=allow_include)
576 if keyword.raw() in levels:
577 # We may go up any number of levels, but only down by one
578 newdepth=levels[keyword.raw_mark_ok()].depth
579 currentdepth=len(obstack) # actually +1...
580 if newdepth<=currentdepth:
581 obstack=obstack[:newdepth]
582 if newdepth>currentdepth:
583 complain("May not go from level %d to level %d"%
584 (currentdepth-1,newdepth))
585 # See if it's a new one (and whether that's permitted)
587 current=obstack[len(obstack)-1]
589 if tname in current.children:
591 current=current.children[tname]
592 if service and group and current.depth==2:
593 if group!=current.group:
594 complain("Incorrect group!")
598 # Ignore depth check for now
599 nl=levels[keyword.raw()](w)
600 if nl.depth<allow_defs:
601 complain("New definitions not allowed at "
603 # we risk crashing if we continue
605 current.children[tname]=nl
607 obstack.append(current)
609 if keyword.raw() not in current.allow_properties:
610 complain("Property %s not allowed at %s level"%
611 (keyword.raw(),current.type))
613 elif current.depth == vpnlevel.depth < allow_defs:
614 complain("Not allowed to set VPN properties here")
617 set_property(current,w)
620 complain("unknown keyword '%s'"%(keyword.raw()))
622 def pfilepath(pathname,allow_include=False):
624 outlines=pfile(pathname,f.readlines(),allow_include=allow_include)
628 def pfile(name,lines,allow_include=False):
636 if (i[0]=='#'): continue
637 outlines += pline(i,allow_include=allow_include)
641 "Output include file for secnet configuration"
642 w.write("# secnet sites file autogenerated by make-secnet-sites "
643 +"version %s\n"%VERSION)
644 w.write("# %s\n"%time.asctime(time.localtime(time.time())))
645 w.write("# Command line: %s\n\n"%' '.join(sys.argv))
647 # Raw VPN data section of file
648 w.write(prefix+"vpn-data {\n")
649 for i in root.children.values():
650 i.output_data(w,2,"")
653 # Per-VPN flattened lists
654 w.write(prefix+"vpn {\n")
655 for i in root.children.values():
656 i.output_vpnflat(w,2,prefix+"vpn-data")
659 # Flattened list of sites
660 w.write(prefix+"all-sites %s;\n"%",".join(
661 map(lambda x:"%svpn/%s/all-sites"%(prefix,x),
662 root.children.keys())))
668 # Sanity check section
669 # Delete nodes where leaf=0 that have no children
672 "Number of leafnodes below node n"
674 for i in n.children.keys():
675 if live(n.children[i]): return 1
678 "Delete nodes that have no leafnode children"
679 for i in list(n.children.keys()):
680 delempty(n.children[i])
681 if not live(n.children[i]):
684 # Check that all constraints are met (as far as I can tell
685 # restrict-nets/networks/peer are the only special cases)
687 def checkconstraints(n,p,ra):
689 new_p.update(n.properties)
690 for i in n.require_properties.keys():
692 moan("%s %s is missing property %s"%
694 for i in new_p.keys():
695 if i not in n.allow_properties:
696 moan("%s %s has forbidden property %s"%
698 # Check address range restrictions
699 if "restrict-nets" in n.properties:
700 new_ra=ra.intersection(n.properties["restrict-nets"].set)
703 if "networks" in n.properties:
704 if not n.properties["networks"].set <= new_ra:
705 moan("%s %s networks out of bounds"%(n.type,n.name))
706 if "peer" in n.properties:
707 if not n.properties["networks"].set.contains(
708 n.properties["peer"].addr):
709 moan("%s %s peer not in networks"%(n.type,n.name))
710 for i in n.children.keys():
711 checkconstraints(n.children[i],new_p,new_ra)
714 headerinput=pfilepath(header,allow_include=True)
715 userinput=sys.stdin.readlines()
716 pfile("user input",userinput)
718 if inputfile is None:
719 pfile("stdin",sys.stdin.readlines())
724 checkconstraints(root,{},ipaddrset.complete_set())
727 if complaints==1: print("There was 1 problem.")
728 else: print("There were %d problems."%(complaints))
730 complaints=None # arranges to crash if we complain later
733 # Put the user's input into their group file, and rebuild the main
735 f=open(groupfiledir+"/T"+group,'w')
736 f.write("# Section submitted by user %s, %s\n"%
737 (user,time.asctime(time.localtime(time.time()))))
738 f.write("# Checked by make-secnet-sites version %s\n\n"%VERSION)
739 for i in userinput: f.write(i)
742 os.rename(groupfiledir+"/T"+group,groupfiledir+"/R"+group)
743 f=open(sitesfile+"-tmp",'w')
744 f.write("# sites file autogenerated by make-secnet-sites\n")
745 f.write("# generated %s, invoked by %s\n"%
746 (time.asctime(time.localtime(time.time())),user))
747 f.write("# use make-secnet-sites to turn this file into a\n")
748 f.write("# valid /etc/secnet/sites.conf file\n\n")
749 for i in headerinput: f.write(i)
750 files=os.listdir(groupfiledir)
753 j=open(groupfiledir+"/"+i)
756 f.write("# end of sites file\n")
758 os.rename(sitesfile+"-tmp",sitesfile)