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. It relies on the "ipaddr" library from
54 from __future__ import print_function
65 # entry 0 is "near the executable", or maybe from PYTHONPATH=.,
66 # which we don't want to preempt
67 sys.path.insert(1,"/usr/local/share/secnet")
68 sys.path.insert(1,"/usr/share/secnet")
73 # Are we being invoked from userv?
75 # If we are, which group does the caller want to modify?
84 print("Wrong number of arguments")
88 groupfiledir=sys.argv[3]
91 if "USERV_USER" not in os.environ:
92 print("Environment variable USERV_USER not found")
94 user=os.environ["USERV_USER"]
95 # Check that group is in USERV_GROUP
96 if "USERV_GROUP" not in os.environ:
97 print("Environment variable USERV_GROUP not found")
99 ugs=os.environ["USERV_GROUP"]
101 for i in ugs.split():
104 print("caller not in group %s"%group)
107 if sys.argv[1]=='-P':
111 print("Too many arguments")
113 inputfile=sys.argv[1]
116 of=open(sys.argv[2],'w')
118 # Classes describing possible datatypes in the configuration file
121 "Common protocol for configuration types."
123 complain("%s %s already has property %s defined"%
124 (obj.type,obj.name,w[0]))
127 "A list of some kind of configuration type."
128 def __init__(self,subtype,w):
130 self.list=[subtype(w)]
132 self.list.append(self.subtype(w))
134 return ', '.join(map(str, self.list))
136 return lambda w: conflist(subtype, w)
138 class single_ipaddr (basetype):
140 def __init__(self,w):
141 self.addr=ipaddr.IPAddress(w[1])
143 return '"%s"'%self.addr
145 class networks (basetype):
146 "A set of IP addresses specified as a list of networks"
147 def __init__(self,w):
148 self.set=ipaddrset.IPAddressSet()
150 x=ipaddr.IPNetwork(i,strict=True)
153 return ",".join(map((lambda n: '"%s"'%n), self.set.networks()))
155 class dhgroup (basetype):
156 "A Diffie-Hellman group"
157 def __init__(self,w):
161 return 'diffie-hellman("%s","%s")'%(self.mod,self.gen)
163 class hash (basetype):
164 "A choice of hash function"
165 def __init__(self,w):
167 if (self.ht!='md5' and self.ht!='sha1'):
168 complain("unknown hash type %s"%(self.ht))
170 return '%s'%(self.ht)
172 class email (basetype):
174 def __init__(self,w):
177 return '<%s>'%(self.addr)
179 class boolean (basetype):
181 def __init__(self,w):
182 if re.match('[TtYy1]',w[1]):
184 elif re.match('[FfNn0]',w[1]):
187 complain("invalid boolean value");
189 return ['False','True'][self.b]
191 class num (basetype):
193 def __init__(self,w):
194 self.n=string.atol(w[1])
198 class address (basetype):
199 "A DNS name and UDP port number"
200 def __init__(self,w):
202 self.port=string.atoi(w[2])
203 if (self.port<1 or self.port>65535):
204 complain("invalid port number")
206 return '"%s"; port %d'%(self.adr,self.port)
208 class rsakey (basetype):
210 def __init__(self,w):
211 self.l=string.atoi(w[1])
215 return 'rsa-public("%s","%s")'%(self.e,self.n)
217 # Possible properties of configuration nodes
219 'contact':(email,"Contact address"),
220 'dh':(dhgroup,"Diffie-Hellman group"),
221 'hash':(hash,"Hash function"),
222 'key-lifetime':(num,"Maximum key lifetime (ms)"),
223 'setup-timeout':(num,"Key setup timeout (ms)"),
224 'setup-retries':(num,"Maximum key setup packet retries"),
225 'wait-time':(num,"Time to wait after unsuccessful key setup (ms)"),
226 'renegotiate-time':(num,"Time after key setup to begin renegotiation (ms)"),
227 'restrict-nets':(networks,"Allowable networks"),
228 'networks':(networks,"Claimed networks"),
229 'pubkey':(rsakey,"RSA public site key"),
230 'peer':(single_ipaddr,"Tunnel peer IP address"),
231 'address':(address,"External contact address and port"),
232 'mobile':(boolean,"Site is mobile"),
236 "Simply output a property - the default case"
237 return "%s %s;\n"%(name,value)
239 # All levels support these properties
241 'contact':(lambda name,value:"# Contact email address: %s\n"%(value)),
248 'renegotiate-time':sp,
249 'restrict-nets':(lambda name,value:"# restrict-nets %s\n"%value),
253 "A level in the configuration hierarchy"
257 require_properties={}
258 def __init__(self,w):
262 def indent(self,w,t):
264 def prop_out(self,n):
265 return self.allow_properties[n](n,str(self.properties[n]))
266 def output_props(self,w,ind):
267 for i in self.properties.keys():
268 if self.allow_properties[i]:
270 w.write("%s"%self.prop_out(i))
271 def output_data(self,w,ind,np):
273 w.write("%s {\n"%(self.name))
274 self.output_props(w,ind+2)
275 if self.depth==1: w.write("\n");
276 for c in self.children.values():
277 c.output_data(w,ind+2,np+self.name+"/")
281 class vpnlevel(level):
282 "VPN level in the configuration hierarchy"
286 allow_properties=global_properties.copy()
288 'contact':"VPN admin contact address"
290 def __init__(self,w):
291 level.__init__(self,w)
292 def output_vpnflat(self,w,ind,h):
293 "Output flattened list of site names for this VPN"
295 w.write("%s {\n"%(self.name))
296 for i in self.children.keys():
297 self.children[i].output_vpnflat(w,ind+2,
298 h+"/"+self.name+"/"+i)
301 w.write("all-sites %s;\n"%
302 ','.join(self.children.keys()))
306 class locationlevel(level):
307 "Location level in the configuration hierarchy"
311 allow_properties=global_properties.copy()
313 'contact':"Location admin contact address",
315 def __init__(self,w):
316 level.__init__(self,w)
318 def output_vpnflat(self,w,ind,h):
320 # The "h=h,self=self" abomination below exists because
321 # Python didn't support nested_scopes until version 2.1
322 w.write("%s %s;\n"%(self.name,','.join(
323 map(lambda x,h=h,self=self:
324 h+"/"+x,self.children.keys()))))
326 class sitelevel(level):
327 "Site level (i.e. a leafnode) in the configuration hierarchy"
331 allow_properties=global_properties.copy()
332 allow_properties.update({
336 'pubkey':(lambda n,v:"key %s;\n"%v),
340 'dh':"Diffie-Hellman group",
341 'contact':"Site admin contact address",
342 'networks':"Networks claimed by the site",
343 'hash':"hash function",
344 'peer':"Gateway address of the site",
345 'pubkey':"RSA public key of the site",
347 def __init__(self,w):
348 level.__init__(self,w)
349 def output_data(self,w,ind,np):
351 w.write("%s {\n"%(self.name))
353 w.write("name \"%s\";\n"%(np+self.name))
354 self.output_props(w,ind+2)
356 w.write("link netlink {\n");
358 w.write("routes %s;\n"%str(self.properties["networks"]))
360 w.write("ptp-address %s;\n"%str(self.properties["peer"]))
366 # Levels in the configuration file
368 levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel}
370 # Reserved vpn/location/site names
371 reserved={'all-sites':None}
372 reserved.update(keywords)
373 reserved.update(levels)
376 "Complain about a particular input line"
378 print(("%s line %d: "%(file,line))+msg)
379 complaints=complaints+1
381 "Complain about something in general"
384 complaints=complaints+1
386 root=level(['root','root']) # All vpns are children of this node
388 allow_defs=0 # Level above which new definitions are permitted
391 def set_property(obj,w):
392 "Set a property on a configuration node"
393 if w[0] in obj.properties:
394 obj.properties[w[0]].add(obj,w)
396 obj.properties[w[0]]=keywords[w[0]][0](w)
398 def pline(i,allow_include=False):
399 "Process a configuration file line"
400 global allow_defs, obstack, root
401 w=i.rstrip('\n').split()
402 if len(w)==0: return [i]
404 current=obstack[len(obstack)-1]
405 if keyword=='end-definitions':
406 allow_defs=sitelevel.depth
409 if keyword=='include':
410 if not allow_include:
411 complain("include not permitted here")
414 complain("include requires one argument")
416 newfile=os.path.join(os.path.dirname(file),w[1])
417 return pfilepath(newfile,allow_include=allow_include)
418 if keyword in levels:
419 # We may go up any number of levels, but only down by one
420 newdepth=levels[keyword].depth
421 currentdepth=len(obstack) # actually +1...
422 if newdepth<=currentdepth:
423 obstack=obstack[:newdepth]
424 if newdepth>currentdepth:
425 complain("May not go from level %d to level %d"%
426 (currentdepth-1,newdepth))
427 # See if it's a new one (and whether that's permitted)
429 current=obstack[len(obstack)-1]
430 if w[1] in current.children:
432 current=current.children[w[1]]
433 if service and group and current.depth==2:
434 if group!=current.group:
435 complain("Incorrect group!")
438 # Ignore depth check for now
439 nl=levels[keyword](w)
440 if nl.depth<allow_defs:
441 complain("New definitions not allowed at "
443 # we risk crashing if we continue
445 current.children[w[1]]=nl
447 obstack.append(current)
449 if keyword not in current.allow_properties:
450 complain("Property %s not allowed at %s level"%
451 (keyword,current.type))
453 elif current.depth == vpnlevel.depth < allow_defs:
454 complain("Not allowed to set VPN properties here")
457 set_property(current,w)
460 complain("unknown keyword '%s'"%(keyword))
462 def pfilepath(pathname,allow_include=False):
464 outlines=pfile(pathname,f.readlines(),allow_include=allow_include)
468 def pfile(name,lines,allow_include=False):
476 if (i[0]=='#'): continue
477 outlines += pline(i,allow_include=allow_include)
481 "Output include file for secnet configuration"
482 w.write("# secnet sites file autogenerated by make-secnet-sites "
483 +"version %s\n"%VERSION)
484 w.write("# %s\n"%time.asctime(time.localtime(time.time())))
485 w.write("# Command line: %s\n\n"%' '.join(sys.argv))
487 # Raw VPN data section of file
488 w.write(prefix+"vpn-data {\n")
489 for i in root.children.values():
490 i.output_data(w,2,"")
493 # Per-VPN flattened lists
494 w.write(prefix+"vpn {\n")
495 for i in root.children.values():
496 i.output_vpnflat(w,2,prefix+"vpn-data")
499 # Flattened list of sites
500 w.write(prefix+"all-sites %s;\n"%",".join(
501 map(lambda x:"%svpn/%s/all-sites"%(prefix,x),
502 root.children.keys())))
508 # Sanity check section
509 # Delete nodes where leaf=0 that have no children
512 "Number of leafnodes below node n"
514 for i in n.children.keys():
515 if live(n.children[i]): return 1
518 "Delete nodes that have no leafnode children"
519 for i in n.children.keys():
520 delempty(n.children[i])
521 if not live(n.children[i]):
524 # Check that all constraints are met (as far as I can tell
525 # restrict-nets/networks/peer are the only special cases)
527 def checkconstraints(n,p,ra):
529 new_p.update(n.properties)
530 for i in n.require_properties.keys():
532 moan("%s %s is missing property %s"%
534 for i in new_p.keys():
535 if i not in n.allow_properties:
536 moan("%s %s has forbidden property %s"%
538 # Check address range restrictions
539 if "restrict-nets" in n.properties:
540 new_ra=ra.intersection(n.properties["restrict-nets"].set)
543 if "networks" in n.properties:
544 if not n.properties["networks"].set <= new_ra:
545 moan("%s %s networks out of bounds"%(n.type,n.name))
546 if "peer" in n.properties:
547 if not n.properties["networks"].set.contains(
548 n.properties["peer"].addr):
549 moan("%s %s peer not in networks"%(n.type,n.name))
550 for i in n.children.keys():
551 checkconstraints(n.children[i],new_p,new_ra)
554 headerinput=pfilepath(header,allow_include=True)
555 userinput=sys.stdin.readlines()
556 pfile("user input",userinput)
558 if inputfile is None:
559 pfile("stdin",sys.stdin.readlines())
564 checkconstraints(root,{},ipaddrset.complete_set())
567 if complaints==1: print("There was 1 problem.")
568 else: print("There were %d problems."%(complaints))
572 # Put the user's input into their group file, and rebuild the main
574 f=open(groupfiledir+"/T"+group,'w')
575 f.write("# Section submitted by user %s, %s\n"%
576 (user,time.asctime(time.localtime(time.time()))))
577 f.write("# Checked by make-secnet-sites version %s\n\n"%VERSION)
578 for i in userinput: f.write(i)
581 os.rename(groupfiledir+"/T"+group,groupfiledir+"/R"+group)
582 f=open(sitesfile+"-tmp",'w')
583 f.write("# sites file autogenerated by make-secnet-sites\n")
584 f.write("# generated %s, invoked by %s\n"%
585 (time.asctime(time.localtime(time.time())),user))
586 f.write("# use make-secnet-sites to turn this file into a\n")
587 f.write("# valid /etc/secnet/sites.conf file\n\n")
588 for i in headerinput: f.write(i)
589 files=os.listdir(groupfiledir)
592 j=open(groupfiledir+"/"+i)
595 f.write("# end of sites file\n")
597 os.rename(sitesfile+"-tmp",sitesfile)