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")
75 from argparseactionnoyes import ActionNoYes
81 from sys import version_info
82 if version_info.major == 2: # for python2
84 sys.stdin = codecs.getreader('utf-8')(sys.stdin)
85 sys.stdout = codecs.getwriter('utf-8')(sys.stdout)
87 open=lambda f,m='r': io.open(f,m,encoding='utf-8')
89 max={'rsa_bits':8200,'name':33,'dh_bits':8200}
93 print(repr(args), file=sys.stderr)
95 def base91s_encode(bindata):
96 return base91.encode(bindata).replace('"',"-")
98 def base91s_decode(string):
99 return base91.decode(string.replace("-",'"'))
102 def __init__(self,s,tline=None,tfile=None):
105 self._line=line if tline is None else tline
106 self._file=file if tfile is None else tfile
111 return not self.__eq__(e)
113 raise RuntimeError('direct use of Tainted value')
115 return 'Tainted(%s)' % repr(self._s)
117 def _bad(self,what,why):
118 assert(self._ok is not True)
120 complain('bad parameter: %s: %s' % (what, why))
123 def _max_ok(self,what,maxlen):
124 if len(self._s) > maxlen:
125 return self._bad(what,'too long (max %d)' % maxlen)
128 def _re_ok(self,bad,what,maxlen=None):
129 if maxlen is None: maxlen=max[what]
130 self._max_ok(what,maxlen)
131 if self._ok is False: return False
132 if bad.search(self._s):
133 #print(repr(self), file=sys.stderr)
134 return self._bad(what,'bad syntax')
137 def _rtnval(self, is_ok, ifgood, ifbad=''):
139 assert(self._ok is not False)
143 assert(self._ok is not True)
147 def _rtn(self, is_ok, ifbad=''):
148 return self._rtnval(is_ok, self._s, ifbad)
152 def raw_mark_ok(self):
153 # caller promises to throw if syntax was dangeorus
154 return self._rtn(True)
157 if self._ok is False: return ''
158 if self._ok is True: return self._s
159 print('%s:%d: unchecked/unknown additional data "%s"' %
160 (self._file,self._line,self._s),
164 bad_name=re.compile(r'^[^a-zA-Z]|[^-_0-9a-zA-Z]')
165 # secnet accepts _ at start of names, but we reserve that
167 def name(self,what='name'):
168 ok=self._re_ok(Tainted.bad_name,what)
170 '_line%d_%s' % (self._line, id(self)))
173 ok=self._s in keywords or self._s in levels
175 complain('unknown keyword %s' % self._s)
178 bad_hex=re.compile(r'[^0-9a-fA-F]')
179 def bignum_16(self,kind,what):
180 maxlen=(max[kind+'_bits']+3)/4
181 ok=self._re_ok(Tainted.bad_hex,what,maxlen)
184 bad_num=re.compile(r'[^0-9]')
185 def bignum_10(self,kind,what):
186 maxlen=math.ceil(max[kind+'_bits'] / math.log10(2))
187 ok=self._re_ok(Tainted.bad_num,what,maxlen)
190 def number(self,minn,maxx,what='number'):
192 ok=self._re_ok(Tainted.bad_num,what,10)
196 ok=self._bad(what,'out of range %d..%d'
198 return self._rtnval(ok,v,minn)
200 def hexid(self,byteslen,what):
201 ok=self._re_ok(Tainted.bad_hex,what,byteslen*2)
203 if len(self._s) < byteslen*2:
204 ok=self._bad(what,'too short')
205 return self._rtn(ok,ifbad='00'*byteslen)
207 bad_host=re.compile(r'[^-\][_.:0-9a-zA-Z]')
208 # We permit _ so we can refer to special non-host domains
209 # which have A and AAAA RRs. This is a crude check and we may
210 # still produce config files with syntactically invalid
211 # domains or addresses, but that is OK.
213 ok=self._re_ok(Tainted.bad_host,'host/address',255)
216 bad_email=re.compile(r'[^-._0-9a-z@!$%^&*=+~/]')
217 # ^ This does not accept all valid email addresses. That's
218 # not really possible with this input syntax. It accepts
219 # all ones that don't require quoting anywhere in email
220 # protocols (and also accepts some invalid ones).
222 ok=self._re_ok(Tainted.bad_email,'email address',1023)
225 bad_groupname=re.compile(r'^[^_A-Za-z]|[^-+_0-9A-Za-z]')
227 ok=self._re_ok(Tainted.bad_groupname,'group name',64)
230 bad_base91=re.compile(r'[^!-~]|[\'\"\\]')
231 def base91(self,what='base91'):
232 ok=self._re_ok(Tainted.bad_base91,what,4096)
248 global output_version
250 ap = argparse.ArgumentParser(description='process secnet sites files')
251 ap.add_argument('--userv', '-u', action='store_true',
252 help='userv service fragment update mode')
253 ap.add_argument('--conf-key-prefix', action=ActionNoYes,
255 help='prefix conf file key names derived from sites data')
256 ap.add_argument('--output-version', nargs=1, type=int,
257 help='sites file output version',
258 default=[max_version])
259 ap.add_argument('--prefix', '-P', nargs=1,
261 ap.add_argument('--debug', '-D', action='count', default=0)
262 ap.add_argument('arg',nargs=argparse.REMAINDER)
264 debug_level = av.debug
266 service = 1 if av.userv else 0
267 prefix = '' if av.prefix is None else av.prefix[0]
268 key_prefix = av.conf_key_prefix
269 output_version = av.output_version[0]
272 print("Wrong number of arguments")
274 (header, groupfiledir, sitesfile, group) = av.arg
275 group = Tainted(group,0,'command line')
276 # untrusted argument from caller
277 if "USERV_USER" not in os.environ:
278 print("Environment variable USERV_USER not found")
280 user=os.environ["USERV_USER"]
281 # Check that group is in USERV_GROUP
282 if "USERV_GROUP" not in os.environ:
283 print("Environment variable USERV_GROUP not found")
285 ugs=os.environ["USERV_GROUP"]
287 for i in ugs.split():
290 print("caller not in group %s"%group)
294 print("Too many arguments")
296 (inputfile, outputfile) = (av.arg + [None]*2)[0:2]
300 # Classes describing possible datatypes in the configuration file
303 "Common protocol for configuration types."
305 complain("%s %s already has property %s defined"%
306 (obj.type,obj.name,w[0].raw()))
309 "A list of some kind of configuration type."
310 def __init__(self,subtype,w):
312 self.list=[subtype(w)]
314 self.list.append(self.subtype(w))
316 return ', '.join(map(str, self.list))
318 return lambda w: conflist(subtype, w)
320 class single_ipaddr (basetype):
322 def __init__(self,w):
323 self.addr=ipaddress.ip_address(w[1].raw_mark_ok())
325 return '"%s"'%self.addr
327 class networks (basetype):
328 "A set of IP addresses specified as a list of networks"
329 def __init__(self,w):
330 self.set=ipaddrset.IPAddressSet()
332 x=ipaddress.ip_network(i.raw_mark_ok(),strict=True)
335 return ",".join(map((lambda n: '"%s"'%n), self.set.networks()))
337 class dhgroup (basetype):
338 "A Diffie-Hellman group"
339 def __init__(self,w):
340 self.mod=w[1].bignum_16('dh','dh mod')
341 self.gen=w[2].bignum_16('dh','dh gen')
343 return 'diffie-hellman("%s","%s")'%(self.mod,self.gen)
345 class hash (basetype):
346 "A choice of hash function"
347 def __init__(self,w):
350 if (self.ht!='md5' and self.ht!='sha1'):
351 complain("unknown hash type %s"%(self.ht))
356 return '%s'%(self.ht)
358 class email (basetype):
360 def __init__(self,w):
361 self.addr=w[1].email()
363 return '<%s>'%(self.addr)
365 class boolean (basetype):
367 def __init__(self,w):
369 if re.match('[TtYy1]',v.raw()):
372 elif re.match('[FfNn0]',v.raw()):
376 complain("invalid boolean value");
378 return ['False','True'][self.b]
380 class num (basetype):
382 def __init__(self,w):
383 self.n=w[1].number(0,0x7fffffff)
387 class address (basetype):
388 "A DNS name and UDP port number"
389 def __init__(self,w):
391 self.port=w[2].number(1,65536,'port')
393 return '"%s"; port %d'%(self.adr,self.port)
395 class rsakey (basetype):
397 def __init__(self,w):
398 self.l=w[1].number(0,max['rsa_bits'],'rsa len')
399 self.e=w[2].bignum_10('rsa','rsa e')
400 self.n=w[3].bignum_10('rsa','rsa n')
401 if len(w) >= 5: w[4].email()
403 return 'rsa-public("%s","%s")'%(self.e,self.n)
405 # Possible properties of configuration nodes
407 'contact':(email,"Contact address"),
408 'dh':(dhgroup,"Diffie-Hellman group"),
409 'hash':(hash,"Hash function"),
410 'key-lifetime':(num,"Maximum key lifetime (ms)"),
411 'setup-timeout':(num,"Key setup timeout (ms)"),
412 'setup-retries':(num,"Maximum key setup packet retries"),
413 'wait-time':(num,"Time to wait after unsuccessful key setup (ms)"),
414 'renegotiate-time':(num,"Time after key setup to begin renegotiation (ms)"),
415 'restrict-nets':(networks,"Allowable networks"),
416 'networks':(networks,"Claimed networks"),
417 'pubkey':(listof(rsakey),"RSA public site key"),
418 'peer':(single_ipaddr,"Tunnel peer IP address"),
419 'address':(address,"External contact address and port"),
420 'mobile':(boolean,"Site is mobile"),
424 "Simply output a property - the default case"
425 return "%s %s;\n"%(name,value)
427 # All levels support these properties
429 'contact':(lambda name,value:"# Contact email address: %s\n"%(value)),
436 'renegotiate-time':sp,
437 'restrict-nets':(lambda name,value:"# restrict-nets %s\n"%value),
441 "A level in the configuration hierarchy"
445 require_properties={}
446 def __init__(self,w):
447 self.type=w[0].keyword()
448 self.name=w[1].name()
451 def indent(self,w,t):
453 def prop_out(self,n):
454 return self.allow_properties[n](n,str(self.properties[n]))
455 def output_props(self,w,ind):
456 for i in sorted(self.properties.keys()):
457 if self.allow_properties[i]:
459 w.write("%s"%self.prop_out(i))
461 return ((self.type[0].upper() if key_prefix else '')
463 def output_data(self,w,path):
466 w.write("%s {\n"%(self.kname()))
467 self.output_props(w,ind+2)
468 if self.depth==1: w.write("\n");
469 for k in sorted(self.children.keys()):
471 c.output_data(w,path+(c,))
475 class vpnlevel(level):
476 "VPN level in the configuration hierarchy"
480 allow_properties=global_properties.copy()
482 'contact':"VPN admin contact address"
484 def __init__(self,w):
485 level.__init__(self,w)
486 def output_vpnflat(self,w,path):
487 "Output flattened list of site names for this VPN"
490 w.write("%s {\n"%(self.kname()))
491 for i in self.children.keys():
492 self.children[i].output_vpnflat(w,path+(self,))
495 w.write("all-sites %s;\n"%
496 ','.join(map(lambda i: i.kname(),
497 self.children.values())))
501 class locationlevel(level):
502 "Location level in the configuration hierarchy"
506 allow_properties=global_properties.copy()
508 'contact':"Location admin contact address",
510 def __init__(self,w):
511 level.__init__(self,w)
512 self.group=w[2].groupname()
513 def output_vpnflat(self,w,path):
516 # The "path=path,self=self" abomination below exists because
517 # Python didn't support nested_scopes until version 2.1
520 w.write("%s %s;\n"%(self.kname(),','.join(
521 map(lambda x,path=path,self=self:
522 '/'.join([prefix+"vpn-data"] + list(map(
525 self.children.values()))))
527 class sitelevel(level):
528 "Site level (i.e. a leafnode) in the configuration hierarchy"
532 allow_properties=global_properties.copy()
533 allow_properties.update({
541 'dh':"Diffie-Hellman group",
542 'contact':"Site admin contact address",
543 'networks':"Networks claimed by the site",
544 'hash':"hash function",
545 'peer':"Gateway address of the site",
546 'pubkey':"RSA public key of the site",
548 def __init__(self,w):
549 level.__init__(self,w)
550 def output_data(self,w,path):
552 np='/'.join(map(lambda i: i.name, path))
554 w.write("%s {\n"%(self.kname()))
556 w.write("name \"%s\";\n"%(np,))
558 w.write("key %s;\n"%str(self.properties["pubkey"].list[0]))
559 self.output_props(w,ind+2)
561 w.write("link netlink {\n");
563 w.write("routes %s;\n"%str(self.properties["networks"]))
565 w.write("ptp-address %s;\n"%str(self.properties["peer"]))
571 # Levels in the configuration file
573 levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel}
576 "Complain about a particular input line"
577 moan(("%s line %d: "%(file,line))+msg)
579 "Complain about something in general"
582 if complaints is None: sys.exit(1)
583 complaints=complaints+1
585 class UntaintedRoot():
586 def __init__(self,s): self._s=s
587 def name(self): return self._s
588 def keyword(self): return self._s
590 root=level([UntaintedRoot(x) for x in ['root','root']])
591 # All vpns are children of this node
593 allow_defs=0 # Level above which new definitions are permitted
595 def set_property(obj,w):
596 "Set a property on a configuration node"
598 propname=prop.raw_mark_ok()
599 kw=keywords[propname]
600 if len(kw) >= 3: propname=kw[2] # for aliases
601 if propname in obj.properties:
602 obj.properties[propname].add(obj,w)
604 obj.properties[propname]=kw[0](w)
610 # called when we enter a new node,
611 # in particular, at the start of each site
614 def pline(il,filterstate,allow_include=False):
615 "Process a configuration file line"
616 global allow_defs, obstack, root
617 w=il.rstrip('\n').split()
618 if len(w)==0: return ['']
619 w=list([Tainted(x) for x in w])
621 current=obstack[len(obstack)-1]
622 copyout_core=lambda: ' '.join([ww.output() for ww in w])
623 indent=' '*len(obstack)
624 copyout=lambda: [indent + copyout_core() + '\n']
625 if keyword=='end-definitions':
626 keyword.raw_mark_ok()
627 allow_defs=sitelevel.depth
630 if keyword=='include':
631 if not allow_include:
632 complain("include not permitted here")
635 complain("include requires one argument")
637 newfile=os.path.join(os.path.dirname(file),w[1].raw_mark_ok())
638 # ^ user of "include" is trusted so raw_mark_ok is good
639 return pfilepath(newfile,allow_include=allow_include)
640 if keyword.raw() in levels:
641 # We may go up any number of levels, but only down by one
642 newdepth=levels[keyword.raw_mark_ok()].depth
643 currentdepth=len(obstack) # actually +1...
644 if newdepth<=currentdepth:
645 obstack=obstack[:newdepth]
646 if newdepth>currentdepth:
647 complain("May not go from level %d to level %d"%
648 (currentdepth-1,newdepth))
649 # See if it's a new one (and whether that's permitted)
651 current=obstack[len(obstack)-1]
653 if tname in current.children:
655 current=current.children[tname]
656 if service and group and current.depth==2:
657 if group!=current.group:
658 complain("Incorrect group!")
662 # Ignore depth check for now
663 nl=levels[keyword.raw()](w)
664 if nl.depth<allow_defs:
665 complain("New definitions not allowed at "
667 # we risk crashing if we continue
669 current.children[tname]=nl
672 obstack.append(current)
674 if keyword.raw() not in current.allow_properties:
675 complain("Property %s not allowed at %s level"%
676 (keyword.raw(),current.type))
678 elif current.depth == vpnlevel.depth < allow_defs:
679 complain("Not allowed to set VPN properties here")
682 set_property(current,w)
685 complain("unknown keyword '%s'"%(keyword.raw()))
687 def pfilepath(pathname,allow_include=False):
689 outlines=pfile(pathname,f.readlines(),allow_include=allow_include)
693 def pfile(name,lines,allow_include=False):
699 filterstate = FilterState()
702 if (i[0]=='#'): continue
703 outlines += pline(i,filterstate,allow_include=allow_include)
707 "Output include file for secnet configuration"
708 w.write("# secnet sites file autogenerated by make-secnet-sites "
709 +"version %s\n"%VERSION)
710 w.write("# %s\n"%time.asctime(time.localtime(time.time())))
711 w.write("# Command line: %s\n\n"%' '.join(sys.argv))
713 # Raw VPN data section of file
714 w.write(prefix+"vpn-data {\n")
715 for i in root.children.values():
716 i.output_data(w,(i,))
719 # Per-VPN flattened lists
720 w.write(prefix+"vpn {\n")
721 for i in root.children.values():
722 i.output_vpnflat(w,())
725 # Flattened list of sites
726 w.write(prefix+"all-sites %s;\n"%",".join(
727 map(lambda x:"%svpn/%s/all-sites"%(prefix,x.kname()),
728 root.children.values())))
734 # Sanity check section
735 # Delete nodes where leaf=0 that have no children
738 "Number of leafnodes below node n"
740 for i in n.children.keys():
741 if live(n.children[i]): return 1
744 "Delete nodes that have no leafnode children"
745 for i in list(n.children.keys()):
746 delempty(n.children[i])
747 if not live(n.children[i]):
750 # Check that all constraints are met (as far as I can tell
751 # restrict-nets/networks/peer are the only special cases)
753 def checkconstraints(n,p,ra):
755 new_p.update(n.properties)
756 for i in n.require_properties.keys():
758 moan("%s %s is missing property %s"%
760 for i in new_p.keys():
761 if i not in n.allow_properties:
762 moan("%s %s has forbidden property %s"%
764 # Check address range restrictions
765 if "restrict-nets" in n.properties:
766 new_ra=ra.intersection(n.properties["restrict-nets"].set)
769 if "networks" in n.properties:
770 if not n.properties["networks"].set <= new_ra:
771 moan("%s %s networks out of bounds"%(n.type,n.name))
772 if "peer" in n.properties:
773 if not n.properties["networks"].set.contains(
774 n.properties["peer"].addr):
775 moan("%s %s peer not in networks"%(n.type,n.name))
776 for i in n.children.keys():
777 checkconstraints(n.children[i],new_p,new_ra)
780 headerinput=pfilepath(header,allow_include=True)
781 userinput=sys.stdin.readlines()
782 pfile("user input",userinput)
784 if inputfile is None:
785 pfile("stdin",sys.stdin.readlines())
790 checkconstraints(root,{},ipaddrset.complete_set())
793 if complaints==1: print("There was 1 problem.")
794 else: print("There were %d problems."%(complaints))
796 complaints=None # arranges to crash if we complain later
799 # Put the user's input into their group file, and rebuild the main
801 f=open(groupfiledir+"/T"+group.groupname(),'w')
802 f.write("# Section submitted by user %s, %s\n"%
803 (user,time.asctime(time.localtime(time.time()))))
804 f.write("# Checked by make-secnet-sites version %s\n\n"%VERSION)
805 for i in userinput: f.write(i)
808 os.rename(groupfiledir+"/T"+group.groupname(),
809 groupfiledir+"/R"+group.groupname())
810 f=open(sitesfile+"-tmp",'w')
811 f.write("# sites file autogenerated by make-secnet-sites\n")
812 f.write("# generated %s, invoked by %s\n"%
813 (time.asctime(time.localtime(time.time())),user))
814 f.write("# use make-secnet-sites to turn this file into a\n")
815 f.write("# valid /etc/secnet/sites.conf file\n\n")
816 for i in headerinput: f.write(i)
817 files=os.listdir(groupfiledir)
820 j=open(groupfiledir+"/"+i)
823 f.write("# end of sites file\n")
825 os.rename(sitesfile+"-tmp",sitesfile)
827 if outputfile is None:
830 tmp_outputfile=outputfile+'~tmp~'
831 of=open(tmp_outputfile,'w')
833 if outputfile is not None:
834 os.rename(tmp_outputfile,outputfile)