X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=make-secnet-sites;h=2162756140a159f5bae6d3b139027a0191c37fd8;hb=0184e49dab06fe87022b2dc80a319e5e58bdc41d;hp=1cc979b57e4c5c7ecb66ffcbee9edf19154541cd;hpb=92eddd582b64891d360ad7bbafdc1e228ee2037e;p=secnet.git diff --git a/make-secnet-sites b/make-secnet-sites index 1cc979b..2162756 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,8 +46,7 @@ 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. """ @@ -61,17 +60,24 @@ import sys import os import getopt import re +import argparse +import math -import ipaddr +import ipaddress # 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 +import base91 + +from argparseactionnoyes import ActionNoYes VERSION="0.1.18" +max_version = 1 + from sys import version_info if version_info.major == 2: # for python2 import codecs @@ -80,24 +86,201 @@ if version_info.major == 2: # for python2 import io open=lambda f,m='r': io.open(f,m,encoding='utf-8') -# Are we being invoked from userv? -service=0 -# If we are, which group does the caller want to modify? -group=None - -if len(sys.argv)<2: - inputfile=None - of=sys.stdout -else: - if sys.argv[1]=='-u': - if len(sys.argv)!=6: +max={'rsa_bits':8200,'name':33,'dh_bits':8200,'algname':127} + +def debugrepr(*args): + if debug_level > 0: + print(repr(args), file=sys.stderr) + +def base91s_encode(bindata): + return base91.encode(bindata).replace('"',"-") + +def base91s_decode(string): + return base91.decode(string.replace("-",'"')) + +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 False + + def _max_ok(self,what,maxlen): + if len(self._s) > maxlen: + return self._bad(what,'too long (max %d)' % maxlen) + return True + + 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 False + if bad.search(self._s): + #print(repr(self), file=sys.stderr) + return self._bad(what,'bad syntax') + return True + + 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,what='name'): + ok=self._re_ok(Tainted.bad_name,what) + 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) + + def hexid(self,byteslen,what): + ok=self._re_ok(Tainted.bad_hex,what,byteslen*2) + if ok: + if len(self._s) < byteslen*2: + ok=self._bad(what,'too short') + return self._rtn(ok,ifbad='00'*byteslen) + + 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) + + bad_base91=re.compile(r'[^!-~]|[\'\"\\]') + def base91(self,what='base91'): + ok=self._re_ok(Tainted.bad_base91,what,4096) + return self._rtn(ok) + +class ArgActionLambda(argparse.Action): + def __init__(self, fn, **kwargs): + self.fn=fn + argparse.Action.__init__(self,**kwargs) + def __call__(self,ap,ns,values,option_string): + self.fn(values,ns,ap,option_string) + +def parse_args(): + global service + global inputfile + global header + global groupfiledir + global sitesfile + global outputfile + global group + global user + global of + global prefix + global key_prefix + global debug_level + global output_version + + 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('--output-version', nargs=1, type=int, + help='sites file output version', + default=[max_version]) + ap.add_argument('--prefix', '-P', nargs=1, + help='set prefix') + ap.add_argument('--debug', '-D', action='count', default=0) + ap.add_argument('arg',nargs=argparse.REMAINDER) + av = ap.parse_args() + debug_level = av.debug + debugrepr('av',av) + service = 1 if av.userv else 0 + prefix = '' if av.prefix is None else av.prefix[0] + key_prefix = av.conf_key_prefix + output_version = av.output_version[0] + if service: + if len(av.arg)!=4: print("Wrong number of arguments") sys.exit(1) - service=1 - header=sys.argv[2] - groupfiledir=sys.argv[3] - sitesfile=sys.argv[4] - group=sys.argv[5] + (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) @@ -114,16 +297,12 @@ else: print("caller not in group %s"%group) sys.exit(1) else: - if sys.argv[1]=='-P': - prefix=sys.argv[2] - sys.argv[1:3]=[] - if len(sys.argv)>3: + if len(av.arg)>3: print("Too many arguments") sys.exit(1) - inputfile=sys.argv[1] - of=sys.stdout - if len(sys.argv)>2: - of=open(sys.argv[2],'w') + (inputfile, outputfile) = (av.arg + [None]*2)[0:2] + +parse_args() # Classes describing possible datatypes in the configuration file @@ -131,7 +310,9 @@ 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())) + def forsites(self,version,copy,fs): + return copy class conflist: "A list of some kind of configuration type." @@ -142,13 +323,16 @@ class conflist: self.list.append(self.subtype(w)) def __str__(self): return ', '.join(map(str, self.list)) + def forsites(self,version,copy,fs): + most_recent=self.list[len(self.list)-1] + return most_recent.forsites(version,copy,fs) def listof(subtype): return lambda w: conflist(subtype, w) 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 @@ -157,7 +341,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())) @@ -165,34 +349,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): @@ -201,28 +392,54 @@ class boolean (basetype): class num (basetype): "A decimal number" def __init__(self,w): - self.n=int(w[1]) + self.n=w[1].number(0,0x7fffffff) def __str__(self): return '%d'%(self.n) +class serial (basetype): + def __init__(self,w): + self.i=w[1].hexid(4,'serial') + def __str__(self): + return self.i + def forsites(self,version,copy,fs): + if version < 2: return [] + return copy + class address (basetype): "A DNS name and UDP port number" def __init__(self,w): - self.adr=w[1] - self.port=int(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): +class pubkey (basetype): + "Some kind of publie key" + def __init__(self,w): + self.a=w[1].name('algname') + self.d=w[2].base91(); + def __str__(self): + return 'make-public("%s","%s")'%(self.a,self.d) + +class rsakey (pubkey): "An RSA public key" def __init__(self,w): - self.l=int(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) + # this specialisation means we can generate files + # compatible with old secnet executables + +def somepubkey(w): + if w[0]=='pubkey': + return rsakey(w) + elif w[0]=='pub': + return pubkey(w) + else: + assert(False) # Possible properties of configuration nodes keywords={ @@ -236,7 +453,8 @@ keywords={ 'renegotiate-time':(num,"Time after key setup to begin renegotiation (ms)"), 'restrict-nets':(networks,"Allowable networks"), 'networks':(networks,"Claimed networks"), - 'pubkey':(rsakey,"RSA public site key"), + 'pub':(listof(somepubkey),"new style public site key"), + 'pubkey':(listof(somepubkey),"RSA public site key",'pub'), 'peer':(single_ipaddr,"Tunnel peer IP address"), 'address':(address,"External contact address and port"), 'mobile':(boolean,"Site is mobile"), @@ -266,8 +484,8 @@ class level: allow_properties={} require_properties={} def __init__(self,w): - self.type=w[0] - self.name=w[1] + self.type=w[0].keyword() + self.name=w[1].name() self.properties={} self.children={} def indent(self,w,t): @@ -275,17 +493,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") @@ -300,17 +523,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"% - ','.join(self.children.keys())) + ','.join(map(lambda i: i.kname(), + self.children.values()))) self.indent(w,ind) w.write("};\n") @@ -325,14 +549,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,','.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" @@ -344,7 +574,8 @@ class sitelevel(level): 'address':sp, 'networks':None, 'peer':None, - 'pubkey':(lambda n,v:"key %s;\n"%v), + 'pub':None, + 'pubkey':None, 'mobile':sp, }) require_properties={ @@ -353,15 +584,19 @@ class sitelevel(level): 'networks':"Networks claimed by the site", 'hash':"hash function", 'peer':"Gateway address of the site", - 'pubkey':"RSA public key of the site", + 'pub':"public key of the site", } 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.indent(w,ind+2) - w.write("name \"%s\";\n"%(np+self.name)) + w.write("key %s;\n"%str(self.properties["pub"].list[0])) self.output_props(w,ind+2) self.indent(w,ind+2) w.write("link netlink {\n"); @@ -378,45 +613,62 @@ 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) - complaints=complaints+1 + moan(("%s line %d: "%(file,line))+msg) def moan(msg): "Complain about something in general" global complaints print(msg); + if complaints is None: sys.exit(1) 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 w[0] in obj.properties: - obj.properties[w[0]].add(obj,w) + prop=w[0] + propname=prop.raw_mark_ok() + kw=keywords[propname] + if len(kw) >= 3: propname=kw[2] # for aliases + if propname in obj.properties: + obj.properties[propname].add(obj,w) else: - obj.properties[w[0]]=keywords[w[0]][0](w) - -def pline(i,allow_include=False): + obj.properties[propname]=kw[0](w) + return obj.properties[propname] + +class FilterState: + def __init__(self): + self.reset() + def reset(self): + # called when we enter a new node, + # in particular, at the start of each site + pass + +def pline(il,filterstate,allow_include=False): "Process a configuration file line" global allow_defs, obstack, root - w=i.rstrip('\n').split() - 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_core=lambda: ' '.join([ww.output() for ww in w]) + indent=' '*len(obstack) + copyout=lambda: [indent + copyout_core() + '\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") @@ -424,11 +676,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 keyword in levels: + 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] @@ -438,37 +691,43 @@ 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 w[1] in current.children: + 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.depth0: 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"% @@ -607,4 +869,11 @@ if service: f.close() os.rename(sitesfile+"-tmp",sitesfile) else: + if outputfile is None: + of=sys.stdout + else: + tmp_outputfile=outputfile+'~tmp~' + of=open(tmp_outputfile,'w') outputsites(of) + if outputfile is not None: + os.rename(tmp_outputfile,outputfile)