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)
235 class ArgActionLambda(argparse.Action):
236 def __init__(self, fn, **kwargs):
238 argparse.Action.__init__(self,**kwargs)
239 def __call__(self,ap,ns,values,option_string):
240 self.fn(values,ns,ap,option_string)
255 global output_version
257 ap = argparse.ArgumentParser(description='process secnet sites files')
258 ap.add_argument('--userv', '-u', action='store_true',
259 help='userv service fragment update mode')
260 ap.add_argument('--conf-key-prefix', action=ActionNoYes,
262 help='prefix conf file key names derived from sites data')
263 ap.add_argument('--output-version', nargs=1, type=int,
264 help='sites file output version',
265 default=[max_version])
266 ap.add_argument('--prefix', '-P', nargs=1,
268 ap.add_argument('--debug', '-D', action='count', default=0)
269 ap.add_argument('arg',nargs=argparse.REMAINDER)
271 debug_level = av.debug
273 service = 1 if av.userv else 0
274 prefix = '' if av.prefix is None else av.prefix[0]
275 key_prefix = av.conf_key_prefix
276 output_version = av.output_version[0]
279 print("Wrong number of arguments")
281 (header, groupfiledir, sitesfile, group) = av.arg
282 group = Tainted(group,0,'command line')
283 # untrusted argument from caller
284 if "USERV_USER" not in os.environ:
285 print("Environment variable USERV_USER not found")
287 user=os.environ["USERV_USER"]
288 # Check that group is in USERV_GROUP
289 if "USERV_GROUP" not in os.environ:
290 print("Environment variable USERV_GROUP not found")
292 ugs=os.environ["USERV_GROUP"]
294 for i in ugs.split():
297 print("caller not in group %s"%group)
301 print("Too many arguments")
303 (inputfile, outputfile) = (av.arg + [None]*2)[0:2]
307 # Classes describing possible datatypes in the configuration file
310 "Common protocol for configuration types."
312 complain("%s %s already has property %s defined"%
313 (obj.type,obj.name,w[0].raw()))
314 def forsites(self,version,copy,fs):
318 "A list of some kind of configuration type."
319 def __init__(self,subtype,w):
321 self.list=[subtype(w)]
323 self.list.append(self.subtype(w))
325 return ', '.join(map(str, self.list))
326 def forsites(self,version,copy,fs):
327 most_recent=self.list[len(self.list)-1]
328 return most_recent.forsites(version,copy,fs)
330 return lambda w: conflist(subtype, w)
332 class single_ipaddr (basetype):
334 def __init__(self,w):
335 self.addr=ipaddress.ip_address(w[1].raw_mark_ok())
337 return '"%s"'%self.addr
339 class networks (basetype):
340 "A set of IP addresses specified as a list of networks"
341 def __init__(self,w):
342 self.set=ipaddrset.IPAddressSet()
344 x=ipaddress.ip_network(i.raw_mark_ok(),strict=True)
347 return ",".join(map((lambda n: '"%s"'%n), self.set.networks()))
349 class dhgroup (basetype):
350 "A Diffie-Hellman group"
351 def __init__(self,w):
352 self.mod=w[1].bignum_16('dh','dh mod')
353 self.gen=w[2].bignum_16('dh','dh gen')
355 return 'diffie-hellman("%s","%s")'%(self.mod,self.gen)
357 class hash (basetype):
358 "A choice of hash function"
359 def __init__(self,w):
362 if (self.ht!='md5' and self.ht!='sha1'):
363 complain("unknown hash type %s"%(self.ht))
368 return '%s'%(self.ht)
370 class email (basetype):
372 def __init__(self,w):
373 self.addr=w[1].email()
375 return '<%s>'%(self.addr)
377 class boolean (basetype):
379 def __init__(self,w):
381 if re.match('[TtYy1]',v.raw()):
384 elif re.match('[FfNn0]',v.raw()):
388 complain("invalid boolean value");
390 return ['False','True'][self.b]
392 class num (basetype):
394 def __init__(self,w):
395 self.n=w[1].number(0,0x7fffffff)
399 class serial (basetype):
400 def __init__(self,w):
401 self.i=w[1].hexid(4,'serial')
404 def forsites(self,version,copy,fs):
405 if version < 2: return []
408 class address (basetype):
409 "A DNS name and UDP port number"
410 def __init__(self,w):
412 self.port=w[2].number(1,65536,'port')
414 return '"%s"; port %d'%(self.adr,self.port)
416 class rsakey (basetype):
418 def __init__(self,w):
419 self.l=w[1].number(0,max['rsa_bits'],'rsa len')
420 self.e=w[2].bignum_10('rsa','rsa e')
421 self.n=w[3].bignum_10('rsa','rsa n')
422 if len(w) >= 5: w[4].email()
424 return 'rsa-public("%s","%s")'%(self.e,self.n)
426 # Possible properties of configuration nodes
428 'contact':(email,"Contact address"),
429 'dh':(dhgroup,"Diffie-Hellman group"),
430 'hash':(hash,"Hash function"),
431 'key-lifetime':(num,"Maximum key lifetime (ms)"),
432 'setup-timeout':(num,"Key setup timeout (ms)"),
433 'setup-retries':(num,"Maximum key setup packet retries"),
434 'wait-time':(num,"Time to wait after unsuccessful key setup (ms)"),
435 'renegotiate-time':(num,"Time after key setup to begin renegotiation (ms)"),
436 'restrict-nets':(networks,"Allowable networks"),
437 'networks':(networks,"Claimed networks"),
438 'pubkey':(listof(rsakey),"RSA public site key"),
439 'peer':(single_ipaddr,"Tunnel peer IP address"),
440 'address':(address,"External contact address and port"),
441 'mobile':(boolean,"Site is mobile"),
445 "Simply output a property - the default case"
446 return "%s %s;\n"%(name,value)
448 # All levels support these properties
450 'contact':(lambda name,value:"# Contact email address: %s\n"%(value)),
457 'renegotiate-time':sp,
458 'restrict-nets':(lambda name,value:"# restrict-nets %s\n"%value),
462 "A level in the configuration hierarchy"
466 require_properties={}
467 def __init__(self,w):
468 self.type=w[0].keyword()
469 self.name=w[1].name()
472 def indent(self,w,t):
474 def prop_out(self,n):
475 return self.allow_properties[n](n,str(self.properties[n]))
476 def output_props(self,w,ind):
477 for i in sorted(self.properties.keys()):
478 if self.allow_properties[i]:
480 w.write("%s"%self.prop_out(i))
482 return ((self.type[0].upper() if key_prefix else '')
484 def output_data(self,w,path):
487 w.write("%s {\n"%(self.kname()))
488 self.output_props(w,ind+2)
489 if self.depth==1: w.write("\n");
490 for k in sorted(self.children.keys()):
492 c.output_data(w,path+(c,))
496 class vpnlevel(level):
497 "VPN level in the configuration hierarchy"
501 allow_properties=global_properties.copy()
503 'contact':"VPN admin contact address"
505 def __init__(self,w):
506 level.__init__(self,w)
507 def output_vpnflat(self,w,path):
508 "Output flattened list of site names for this VPN"
511 w.write("%s {\n"%(self.kname()))
512 for i in self.children.keys():
513 self.children[i].output_vpnflat(w,path+(self,))
516 w.write("all-sites %s;\n"%
517 ','.join(map(lambda i: i.kname(),
518 self.children.values())))
522 class locationlevel(level):
523 "Location level in the configuration hierarchy"
527 allow_properties=global_properties.copy()
529 'contact':"Location admin contact address",
531 def __init__(self,w):
532 level.__init__(self,w)
533 self.group=w[2].groupname()
534 def output_vpnflat(self,w,path):
537 # The "path=path,self=self" abomination below exists because
538 # Python didn't support nested_scopes until version 2.1
541 w.write("%s %s;\n"%(self.kname(),','.join(
542 map(lambda x,path=path,self=self:
543 '/'.join([prefix+"vpn-data"] + list(map(
546 self.children.values()))))
548 class sitelevel(level):
549 "Site level (i.e. a leafnode) in the configuration hierarchy"
553 allow_properties=global_properties.copy()
554 allow_properties.update({
562 'dh':"Diffie-Hellman group",
563 'contact':"Site admin contact address",
564 'networks':"Networks claimed by the site",
565 'hash':"hash function",
566 'peer':"Gateway address of the site",
567 'pubkey':"RSA public key of the site",
569 def __init__(self,w):
570 level.__init__(self,w)
571 def output_data(self,w,path):
573 np='/'.join(map(lambda i: i.name, path))
575 w.write("%s {\n"%(self.kname()))
577 w.write("name \"%s\";\n"%(np,))
579 w.write("key %s;\n"%str(self.properties["pubkey"].list[0]))
580 self.output_props(w,ind+2)
582 w.write("link netlink {\n");
584 w.write("routes %s;\n"%str(self.properties["networks"]))
586 w.write("ptp-address %s;\n"%str(self.properties["peer"]))
592 # Levels in the configuration file
594 levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel}
597 "Complain about a particular input line"
598 moan(("%s line %d: "%(file,line))+msg)
600 "Complain about something in general"
603 if complaints is None: sys.exit(1)
604 complaints=complaints+1
606 class UntaintedRoot():
607 def __init__(self,s): self._s=s
608 def name(self): return self._s
609 def keyword(self): return self._s
611 root=level([UntaintedRoot(x) for x in ['root','root']])
612 # All vpns are children of this node
614 allow_defs=0 # Level above which new definitions are permitted
616 def set_property(obj,w):
617 "Set a property on a configuration node"
619 propname=prop.raw_mark_ok()
620 kw=keywords[propname]
621 if len(kw) >= 3: propname=kw[2] # for aliases
622 if propname in obj.properties:
623 obj.properties[propname].add(obj,w)
625 obj.properties[propname]=kw[0](w)
626 return obj.properties[propname]
632 # called when we enter a new node,
633 # in particular, at the start of each site
636 def pline(il,filterstate,allow_include=False):
637 "Process a configuration file line"
638 global allow_defs, obstack, root
639 w=il.rstrip('\n').split()
640 if len(w)==0: return ['']
641 w=list([Tainted(x) for x in w])
643 current=obstack[len(obstack)-1]
644 copyout_core=lambda: ' '.join([ww.output() for ww in w])
645 indent=' '*len(obstack)
646 copyout=lambda: [indent + copyout_core() + '\n']
647 if keyword=='end-definitions':
648 keyword.raw_mark_ok()
649 allow_defs=sitelevel.depth
652 if keyword=='include':
653 if not allow_include:
654 complain("include not permitted here")
657 complain("include requires one argument")
659 newfile=os.path.join(os.path.dirname(file),w[1].raw_mark_ok())
660 # ^ user of "include" is trusted so raw_mark_ok is good
661 return pfilepath(newfile,allow_include=allow_include)
662 if keyword.raw() in levels:
663 # We may go up any number of levels, but only down by one
664 newdepth=levels[keyword.raw_mark_ok()].depth
665 currentdepth=len(obstack) # actually +1...
666 if newdepth<=currentdepth:
667 obstack=obstack[:newdepth]
668 if newdepth>currentdepth:
669 complain("May not go from level %d to level %d"%
670 (currentdepth-1,newdepth))
671 # See if it's a new one (and whether that's permitted)
673 current=obstack[len(obstack)-1]
675 if tname in current.children:
677 current=current.children[tname]
678 if service and group and current.depth==2:
679 if group!=current.group:
680 complain("Incorrect group!")
684 # Ignore depth check for now
685 nl=levels[keyword.raw()](w)
686 if nl.depth<allow_defs:
687 complain("New definitions not allowed at "
689 # we risk crashing if we continue
691 current.children[tname]=nl
694 obstack.append(current)
696 if keyword.raw() not in current.allow_properties:
697 complain("Property %s not allowed at %s level"%
698 (keyword.raw(),current.type))
700 elif current.depth == vpnlevel.depth < allow_defs:
701 complain("Not allowed to set VPN properties here")
704 prop=set_property(current,w)
706 out=prop.forsites(output_version,out,filterstate)
707 if len(out)==0: return [indent + '#', copyout_core(), '\n']
708 return [indent + ' '.join(out) + '\n']
710 complain("unknown keyword '%s'"%(keyword.raw()))
712 def pfilepath(pathname,allow_include=False):
714 outlines=pfile(pathname,f.readlines(),allow_include=allow_include)
718 def pfile(name,lines,allow_include=False):
724 filterstate = FilterState()
727 if (i[0]=='#'): continue
728 outlines += pline(i,filterstate,allow_include=allow_include)
732 "Output include file for secnet configuration"
733 w.write("# secnet sites file autogenerated by make-secnet-sites "
734 +"version %s\n"%VERSION)
735 w.write("# %s\n"%time.asctime(time.localtime(time.time())))
736 w.write("# Command line: %s\n\n"%' '.join(sys.argv))
738 # Raw VPN data section of file
739 w.write(prefix+"vpn-data {\n")
740 for i in root.children.values():
741 i.output_data(w,(i,))
744 # Per-VPN flattened lists
745 w.write(prefix+"vpn {\n")
746 for i in root.children.values():
747 i.output_vpnflat(w,())
750 # Flattened list of sites
751 w.write(prefix+"all-sites %s;\n"%",".join(
752 map(lambda x:"%svpn/%s/all-sites"%(prefix,x.kname()),
753 root.children.values())))
759 # Sanity check section
760 # Delete nodes where leaf=0 that have no children
763 "Number of leafnodes below node n"
765 for i in n.children.keys():
766 if live(n.children[i]): return 1
769 "Delete nodes that have no leafnode children"
770 for i in list(n.children.keys()):
771 delempty(n.children[i])
772 if not live(n.children[i]):
775 # Check that all constraints are met (as far as I can tell
776 # restrict-nets/networks/peer are the only special cases)
778 def checkconstraints(n,p,ra):
780 new_p.update(n.properties)
781 for i in n.require_properties.keys():
783 moan("%s %s is missing property %s"%
785 for i in new_p.keys():
786 if i not in n.allow_properties:
787 moan("%s %s has forbidden property %s"%
789 # Check address range restrictions
790 if "restrict-nets" in n.properties:
791 new_ra=ra.intersection(n.properties["restrict-nets"].set)
794 if "networks" in n.properties:
795 if not n.properties["networks"].set <= new_ra:
796 moan("%s %s networks out of bounds"%(n.type,n.name))
797 if "peer" in n.properties:
798 if not n.properties["networks"].set.contains(
799 n.properties["peer"].addr):
800 moan("%s %s peer not in networks"%(n.type,n.name))
801 for i in n.children.keys():
802 checkconstraints(n.children[i],new_p,new_ra)
805 headerinput=pfilepath(header,allow_include=True)
806 userinput=sys.stdin.readlines()
807 pfile("user input",userinput)
809 if inputfile is None:
810 pfile("stdin",sys.stdin.readlines())
815 checkconstraints(root,{},ipaddrset.complete_set())
818 if complaints==1: print("There was 1 problem.")
819 else: print("There were %d problems."%(complaints))
821 complaints=None # arranges to crash if we complain later
824 # Put the user's input into their group file, and rebuild the main
826 f=open(groupfiledir+"/T"+group.groupname(),'w')
827 f.write("# Section submitted by user %s, %s\n"%
828 (user,time.asctime(time.localtime(time.time()))))
829 f.write("# Checked by make-secnet-sites version %s\n\n"%VERSION)
830 for i in userinput: f.write(i)
833 os.rename(groupfiledir+"/T"+group.groupname(),
834 groupfiledir+"/R"+group.groupname())
835 f=open(sitesfile+"-tmp",'w')
836 f.write("# sites file autogenerated by make-secnet-sites\n")
837 f.write("# generated %s, invoked by %s\n"%
838 (time.asctime(time.localtime(time.time())),user))
839 f.write("# use make-secnet-sites to turn this file into a\n")
840 f.write("# valid /etc/secnet/sites.conf file\n\n")
841 for i in headerinput: f.write(i)
842 files=os.listdir(groupfiledir)
845 j=open(groupfiledir+"/"+i)
848 f.write("# end of sites file\n")
850 os.rename(sitesfile+"-tmp",sitesfile)
852 if outputfile is None:
855 tmp_outputfile=outputfile+'~tmp~'
856 of=open(tmp_outputfile,'w')
858 if outputfile is not None:
859 os.rename(tmp_outputfile,outputfile)