X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=secnet.git;a=blobdiff_plain;f=make-secnet-sites;h=c26cab0922e3f308f30c2dbff637150be59a3b33;hp=f4e86020a45f8e6f807c7037a8fb74ba8f3dc06d;hb=351fc77c719a6fae532c76d2271b2f4ddafa6527;hpb=c701f16694e3f89fb6721ab1bb91ab5b66229a94 diff --git a/make-secnet-sites b/make-secnet-sites index f4e8602..c26cab0 100755 --- a/make-secnet-sites +++ b/make-secnet-sites @@ -1,4 +1,4 @@ -#! /usr/bin/env python +#! /usr/bin/env python3 # # This file is part of secnet. # See README for full list of copyright holders. @@ -46,33 +46,230 @@ no-suppress-args cd ~/secnet/sites-test/ execute ~/secnet/make-secnet-sites.py -u vpnheader groupfiles sites -This program is part of secnet. It relies on the "ipaddr" library from -Cendio Systems AB. +This program is part of secnet. """ +from __future__ import print_function +from __future__ import unicode_literals +from builtins import int + import string import time import sys import os import getopt import re +import argparse +import math -import ipaddr +import ipaddress -sys.path.insert(0,"/usr/local/share/secnet") -sys.path.insert(0,"/usr/share/secnet") +# entry 0 is "near the executable", or maybe from PYTHONPATH=., +# which we don't want to preempt +sys.path.insert(1,"/usr/local/share/secnet") +sys.path.insert(1,"/usr/share/secnet") import ipaddrset +from argparseactionnoyes import ActionNoYes + VERSION="0.1.18" +from sys import version_info +if version_info.major == 2: # for python2 + import codecs + sys.stdin = codecs.getreader('utf-8')(sys.stdin) + sys.stdout = codecs.getwriter('utf-8')(sys.stdout) + import io + open=lambda f,m='r': io.open(f,m,encoding='utf-8') + +max={'rsa_bits':8200,'name':33,'dh_bits':8200} + +class Tainted: + def __init__(self,s,tline=None,tfile=None): + self._s=s + self._ok=None + self._line=line if tline is None else tline + self._file=file if tfile is None else tfile + def __eq__(self,e): + return self._s==e + def __ne__(self,e): + # for Python2 + return not self.__eq__(e) + def __str__(self): + raise RuntimeError('direct use of Tainted value') + def __repr__(self): + return 'Tainted(%s)' % repr(self._s) + + def _bad(self,what,why): + assert(self._ok is not True) + self._ok=False + complain('bad parameter: %s: %s' % (what, why)) + return self + + def _max_ok(self,what,maxlen): + if len(self._s) > maxlen: + self._bad(what,'too long (max %d)' % maxlen) + return self + + def _re_ok(self,bad,what,maxlen=None): + if maxlen is None: maxlen=max[what] + self._max_ok(what,maxlen) + if self._ok is False: return self + if bad.search(self._s): return self._bad(what,'bad syntax') + return self + + def _rtnval(self, is_ok, ifgood, ifbad=''): + if is_ok: + assert(self._ok is not False) + self._ok=True + return ifgood + else: + assert(self._ok is not True) + self._ok=False + return ifbad + + def _rtn(self, is_ok, ifbad=''): + return self._rtnval(is_ok, self._s, ifbad) + + def raw(self): + return self._s + def raw_mark_ok(self): + # caller promises to throw if syntax was dangeorus + return self._rtn(True) + + def output(self): + if self._ok is False: return '' + if self._ok is True: return self._s + print('%s:%d: unchecked/unknown additional data "%s"' % + (self._file,self._line,self._s), + file=sys.stderr) + sys.exit(1) + + bad_name=re.compile(r'^[^a-zA-Z]|[^-_0-9a-zA-Z]') + # secnet accepts _ at start of names, but we reserve that + bad_name_counter=0 + def name(self): + ok=self._re_ok(Tainted.bad_name,'name') + return self._rtn(ok, + '_line%d_%s' % (self._line, id(self))) + + def keyword(self): + ok=self._s in keywords or self._s in levels + if not ok: + complain('unknown keyword %s' % self._s) + return self._rtn(ok) + + bad_hex=re.compile(r'[^0-9a-fA-F]') + def bignum_16(self,kind,what): + maxlen=(max[kind+'_bits']+3)/4 + ok=self._re_ok(Tainted.bad_hex,what,maxlen) + return self._rtn(ok) + + bad_num=re.compile(r'[^0-9]') + def bignum_10(self,kind,what): + maxlen=math.ceil(max[kind+'_bits'] / math.log10(2)) + ok=self._re_ok(Tainted.bad_num,what,maxlen) + return self._rtn(ok) + + def number(self,minn,maxx,what='number'): + # not for bignums + ok=self._re_ok(Tainted.bad_num,what,10) + if ok: + v=int(self._s) + if vmaxx: + ok=self._bad(what,'out of range %d..%d' + % (minn,maxx)) + return self._rtnval(ok,v,minn) + + bad_host=re.compile(r'[^-\][_.:0-9a-zA-Z]') + # We permit _ so we can refer to special non-host domains + # which have A and AAAA RRs. This is a crude check and we may + # still produce config files with syntactically invalid + # domains or addresses, but that is OK. + def host(self): + ok=self._re_ok(Tainted.bad_host,'host/address',255) + return self._rtn(ok) + + bad_email=re.compile(r'[^-._0-9a-z@!$%^&*=+~/]') + # ^ This does not accept all valid email addresses. That's + # not really possible with this input syntax. It accepts + # all ones that don't require quoting anywhere in email + # protocols (and also accepts some invalid ones). + def email(self): + ok=self._re_ok(Tainted.bad_email,'email address',1023) + return self._rtn(ok) + + bad_groupname=re.compile(r'^[^_A-Za-z]|[^-+_0-9A-Za-z]') + def groupname(self): + ok=self._re_ok(Tainted.bad_groupname,'group name',64) + return self._rtn(ok) + +def parse_args(): + global service + global inputfile + global header + global groupfiledir + global sitesfile + global group + global user + global of + global prefix + global key_prefix + + ap = argparse.ArgumentParser(description='process secnet sites files') + ap.add_argument('--userv', '-u', action='store_true', + help='userv service fragment update mode') + ap.add_argument('--conf-key-prefix', action=ActionNoYes, + default=True, + help='prefix conf file key names derived from sites data') + ap.add_argument('--prefix', '-P', nargs=1, + help='set prefix') + ap.add_argument('arg',nargs=argparse.REMAINDER) + av = ap.parse_args() + #print(repr(av), file=sys.stderr) + service = 1 if av.userv else 0 + prefix = '' if av.prefix is None else av.prefix[0] + key_prefix = av.conf_key_prefix + if service: + if len(av.arg)!=4: + print("Wrong number of arguments") + sys.exit(1) + (header, groupfiledir, sitesfile, group) = av.arg + group = Tainted(group,0,'command line') + # untrusted argument from caller + if "USERV_USER" not in os.environ: + print("Environment variable USERV_USER not found") + sys.exit(1) + user=os.environ["USERV_USER"] + # Check that group is in USERV_GROUP + if "USERV_GROUP" not in os.environ: + print("Environment variable USERV_GROUP not found") + sys.exit(1) + ugs=os.environ["USERV_GROUP"] + ok=0 + for i in ugs.split(): + if group==i: ok=1 + if not ok: + print("caller not in group %s"%group) + sys.exit(1) + else: + if len(av.arg)>3: + print("Too many arguments") + sys.exit(1) + (inputfile, outputfile) = (av.arg + [None]*2)[0:2] + if outputfile is None: of=sys.stdout + else: of=open(outputfile,'w') + +parse_args() + # Classes describing possible datatypes in the configuration file class basetype: "Common protocol for configuration types." def add(self,obj,w): complain("%s %s already has property %s defined"% - (obj.type,obj.name,w[0])) + (obj.type,obj.name,w[0].raw())) class conflist: "A list of some kind of configuration type." @@ -89,7 +286,7 @@ def listof(subtype): class single_ipaddr (basetype): "An IP address" def __init__(self,w): - self.addr=ipaddr.IPAddress(w[1]) + self.addr=ipaddress.ip_address(w[1].raw_mark_ok()) def __str__(self): return '"%s"'%self.addr @@ -98,7 +295,7 @@ class networks (basetype): def __init__(self,w): self.set=ipaddrset.IPAddressSet() for i in w[1:]: - x=ipaddr.IPNetwork(i,strict=True) + x=ipaddress.ip_network(i.raw_mark_ok(),strict=True) self.set.append([x]) def __str__(self): return ",".join(map((lambda n: '"%s"'%n), self.set.networks())) @@ -106,34 +303,41 @@ class networks (basetype): class dhgroup (basetype): "A Diffie-Hellman group" def __init__(self,w): - self.mod=w[1] - self.gen=w[2] + self.mod=w[1].bignum_16('dh','dh mod') + self.gen=w[2].bignum_16('dh','dh gen') def __str__(self): return 'diffie-hellman("%s","%s")'%(self.mod,self.gen) class hash (basetype): "A choice of hash function" def __init__(self,w): - self.ht=w[1] + hname=w[1] + self.ht=hname.raw() if (self.ht!='md5' and self.ht!='sha1'): complain("unknown hash type %s"%(self.ht)) + self.ht=None + else: + hname.raw_mark_ok() def __str__(self): return '%s'%(self.ht) class email (basetype): "An email address" def __init__(self,w): - self.addr=w[1] + self.addr=w[1].email() def __str__(self): return '<%s>'%(self.addr) class boolean (basetype): "A boolean" def __init__(self,w): - if re.match('[TtYy1]',w[1]): + v=w[1] + if re.match('[TtYy1]',v.raw()): self.b=True - elif re.match('[FfNn0]',w[1]): + v.raw_mark_ok() + elif re.match('[FfNn0]',v.raw()): self.b=False + v.raw_mark_ok() else: complain("invalid boolean value"); def __str__(self): @@ -142,26 +346,25 @@ class boolean (basetype): class num (basetype): "A decimal number" def __init__(self,w): - self.n=string.atol(w[1]) + self.n=w[1].number(0,0x7fffffff) def __str__(self): return '%d'%(self.n) class address (basetype): "A DNS name and UDP port number" def __init__(self,w): - self.adr=w[1] - self.port=string.atoi(w[2]) - if (self.port<1 or self.port>65535): - complain("invalid port number") + self.adr=w[1].host() + self.port=w[2].number(1,65536,'port') def __str__(self): return '"%s"; port %d'%(self.adr,self.port) class rsakey (basetype): "An RSA public key" def __init__(self,w): - self.l=string.atoi(w[1]) - self.e=w[2] - self.n=w[3] + self.l=w[1].number(0,max['rsa_bits'],'rsa len') + self.e=w[2].bignum_10('rsa','rsa e') + self.n=w[3].bignum_10('rsa','rsa n') + if len(w) >= 5: w[4].email() def __str__(self): return 'rsa-public("%s","%s")'%(self.e,self.n) @@ -207,7 +410,8 @@ class level: allow_properties={} require_properties={} def __init__(self,w): - self.name=w[1] + self.type=w[0].keyword() + self.name=w[1].name() self.properties={} self.children={} def indent(self,w,t): @@ -215,17 +419,22 @@ class level: def prop_out(self,n): return self.allow_properties[n](n,str(self.properties[n])) def output_props(self,w,ind): - for i in self.properties.keys(): + for i in sorted(self.properties.keys()): if self.allow_properties[i]: self.indent(w,ind) w.write("%s"%self.prop_out(i)) - def output_data(self,w,ind,np): + def kname(self): + return ((self.type[0].upper() if key_prefix else '') + + self.name) + def output_data(self,w,path): + ind = 2*len(path) self.indent(w,ind) - w.write("%s {\n"%(self.name)) + w.write("%s {\n"%(self.kname())) self.output_props(w,ind+2) if self.depth==1: w.write("\n"); - for c in self.children.values(): - c.output_data(w,ind+2,np+self.name+"/") + for k in sorted(self.children.keys()): + c=self.children[k] + c.output_data(w,path+(c,)) self.indent(w,ind) w.write("};\n") @@ -240,17 +449,18 @@ class vpnlevel(level): } def __init__(self,w): level.__init__(self,w) - def output_vpnflat(self,w,ind,h): + def output_vpnflat(self,w,path): "Output flattened list of site names for this VPN" + ind=2*(len(path)+1) self.indent(w,ind) - w.write("%s {\n"%(self.name)) + w.write("%s {\n"%(self.kname())) for i in self.children.keys(): - self.children[i].output_vpnflat(w,ind+2, - h+"/"+self.name+"/"+i) + self.children[i].output_vpnflat(w,path+(self,)) w.write("\n") self.indent(w,ind+2) w.write("all-sites %s;\n"% - string.join(self.children.keys(),',')) + ','.join(map(lambda i: i.kname(), + self.children.values()))) self.indent(w,ind) w.write("};\n") @@ -265,14 +475,20 @@ class locationlevel(level): } def __init__(self,w): level.__init__(self,w) - self.group=w[2] - def output_vpnflat(self,w,ind,h): + self.group=w[2].groupname() + def output_vpnflat(self,w,path): + ind=2*(len(path)+1) self.indent(w,ind) - # The "h=h,self=self" abomination below exists because + # The "path=path,self=self" abomination below exists because # Python didn't support nested_scopes until version 2.1 - w.write("%s %s;\n"%(self.name,string.join( - map(lambda x,h=h,self=self: - h+"/"+x,self.children.keys()),','))) + # + #"/"+self.name+"/"+i + w.write("%s %s;\n"%(self.kname(),','.join( + map(lambda x,path=path,self=self: + '/'.join([prefix+"vpn-data"] + list(map( + lambda i: i.kname(), + path+(self,x)))), + self.children.values())))) class sitelevel(level): "Site level (i.e. a leafnode) in the configuration hierarchy" @@ -297,11 +513,13 @@ class sitelevel(level): } def __init__(self,w): level.__init__(self,w) - def output_data(self,w,ind,np): + def output_data(self,w,path): + ind=2*len(path) + np='/'.join(map(lambda i: i.name, path)) self.indent(w,ind) - w.write("%s {\n"%(self.name)) + w.write("%s {\n"%(self.kname())) self.indent(w,ind+2) - w.write("name \"%s\";\n"%(np+self.name)) + w.write("name \"%s\";\n"%(np,)) self.output_props(w,ind+2) self.indent(w,ind+2) w.write("link netlink {\n"); @@ -318,45 +536,52 @@ class sitelevel(level): # (depth,properties) levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel} -# Reserved vpn/location/site names -reserved={'all-sites':None} -reserved.update(keywords) -reserved.update(levels) - def complain(msg): "Complain about a particular input line" global complaints - print ("%s line %d: "%(file,line))+msg + print(("%s line %d: "%(file,line))+msg) complaints=complaints+1 def moan(msg): "Complain about something in general" global complaints - print msg; + print(msg); complaints=complaints+1 -root=level(['root','root']) # All vpns are children of this node +class UntaintedRoot(): + def __init__(self,s): self._s=s + def name(self): return self._s + def keyword(self): return self._s + +root=level([UntaintedRoot(x) for x in ['root','root']]) +# All vpns are children of this node obstack=[root] allow_defs=0 # Level above which new definitions are permitted -prefix='' def set_property(obj,w): "Set a property on a configuration node" - if obj.properties.has_key(w[0]): - obj.properties[w[0]].add(obj,w) + prop=w[0] + if prop.raw() in obj.properties: + obj.properties[prop.raw_mark_ok()].add(obj,w) else: - obj.properties[w[0]]=keywords[w[0]][0](w) + obj.properties[prop.raw()]=keywords[prop.raw_mark_ok()][0](w) + -def pline(i,allow_include=False): +def pline(il,allow_include=False): "Process a configuration file line" global allow_defs, obstack, root - w=string.split(i.rstrip('\n')) - if len(w)==0: return [i] + w=il.rstrip('\n').split() + if len(w)==0: return [''] + w=list([Tainted(x) for x in w]) keyword=w[0] current=obstack[len(obstack)-1] + copyout=lambda: [' '*len(obstack) + + ' '.join([ww.output() for ww in w]) + + '\n'] if keyword=='end-definitions': + keyword.raw_mark_ok() allow_defs=sitelevel.depth obstack=[root] - return [i] + return copyout() if keyword=='include': if not allow_include: complain("include not permitted here") @@ -364,11 +589,12 @@ def pline(i,allow_include=False): if len(w) != 2: complain("include requires one argument") return [] - newfile=os.path.join(os.path.dirname(file),w[1]) + newfile=os.path.join(os.path.dirname(file),w[1].raw_mark_ok()) + # ^ user of "include" is trusted so raw_mark_ok is good return pfilepath(newfile,allow_include=allow_include) - if levels.has_key(keyword): + if keyword.raw() in levels: # We may go up any number of levels, but only down by one - newdepth=levels[keyword].depth + newdepth=levels[keyword.raw_mark_ok()].depth currentdepth=len(obstack) # actually +1... if newdepth<=currentdepth: obstack=obstack[:newdepth] @@ -378,37 +604,39 @@ def pline(i,allow_include=False): # See if it's a new one (and whether that's permitted) # or an existing one current=obstack[len(obstack)-1] - if current.children.has_key(w[1]): + tname=w[1].name() + if tname in current.children: # Not new - current=current.children[w[1]] + current=current.children[tname] if service and group and current.depth==2: if group!=current.group: complain("Incorrect group!") + w[2].groupname() else: # New # Ignore depth check for now - nl=levels[keyword](w) + nl=levels[keyword.raw()](w) if nl.depth3: - print "Too many arguments" - sys.exit(1) - pfilepath(sys.argv[1]) - of=sys.stdout - if len(sys.argv)>2: - of=open(sys.argv[2],'w') - # Sanity check section # Delete nodes where leaf=0 that have no children @@ -515,11 +695,10 @@ def live(n): return 0 def delempty(n): "Delete nodes that have no leafnode children" - for i in n.children.keys(): + for i in list(n.children.keys()): delempty(n.children[i]) if not live(n.children[i]): del n.children[i] -delempty(root) # Check that all constraints are met (as far as I can tell # restrict-nets/networks/peer are the only special cases) @@ -528,46 +707,59 @@ def checkconstraints(n,p,ra): new_p=p.copy() new_p.update(n.properties) for i in n.require_properties.keys(): - if not new_p.has_key(i): + if i not in new_p: moan("%s %s is missing property %s"% (n.type,n.name,i)) for i in new_p.keys(): - if not n.allow_properties.has_key(i): + if i not in n.allow_properties: moan("%s %s has forbidden property %s"% (n.type,n.name,i)) # Check address range restrictions - if n.properties.has_key("restrict-nets"): + if "restrict-nets" in n.properties: new_ra=ra.intersection(n.properties["restrict-nets"].set) else: new_ra=ra - if n.properties.has_key("networks"): + if "networks" in n.properties: if not n.properties["networks"].set <= new_ra: moan("%s %s networks out of bounds"%(n.type,n.name)) - if n.properties.has_key("peer"): + if "peer" in n.properties: if not n.properties["networks"].set.contains( n.properties["peer"].addr): moan("%s %s peer not in networks"%(n.type,n.name)) for i in n.children.keys(): checkconstraints(n.children[i],new_p,new_ra) +if service: + headerinput=pfilepath(header,allow_include=True) + userinput=sys.stdin.readlines() + pfile("user input",userinput) +else: + if inputfile is None: + pfile("stdin",sys.stdin.readlines()) + else: + pfilepath(inputfile) + +delempty(root) checkconstraints(root,{},ipaddrset.complete_set()) if complaints>0: - if complaints==1: print "There was 1 problem." - else: print "There were %d problems."%(complaints) + if complaints==1: print("There was 1 problem.") + else: print("There were %d problems."%(complaints)) sys.exit(1) +complaints=None # arranges to crash if we complain later if service: # Put the user's input into their group file, and rebuild the main # sites file - f=open(groupfiledir+"/T"+group,'w') + f=open(groupfiledir+"/T"+group.groupname(),'w') f.write("# Section submitted by user %s, %s\n"% (user,time.asctime(time.localtime(time.time())))) f.write("# Checked by make-secnet-sites version %s\n\n"%VERSION) for i in userinput: f.write(i) f.write("\n") f.close() - os.rename(groupfiledir+"/T"+group,groupfiledir+"/R"+group) + os.rename(groupfiledir+"/T"+group.groupname(), + groupfiledir+"/R"+group.groupname()) f=open(sitesfile+"-tmp",'w') f.write("# sites file autogenerated by make-secnet-sites\n") f.write("# generated %s, invoked by %s\n"%