-#! /usr/bin/env python
-# Copyright (C) 2001-2002 Stephen Early <steve@greenend.org.uk>
+#! /usr/bin/env python3
#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# This file is part of secnet.
+# See README for full list of copyright holders.
+#
+# secnet is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
+# secnet is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# version 3 along with secnet; if not, see
+# https://www.gnu.org/licenses/gpl.html.
"""VPN sites file manipulation.
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
-# The ipaddr library is installed as part of secnet
-sys.path.append("/usr/local/share/secnet")
-sys.path.append("/usr/share/secnet")
-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
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')
+
+def parse_args():
+ global service
+ global inputfile
+ global header
+ global groupfiledir
+ global sitesfile
+ global group
+ global user
+ global of
+
+ 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('--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
+ if service:
+ if len(av.arg)!=4:
+ print("Wrong number of arguments")
+ sys.exit(1)
+ (header, groupfiledir, sitesfile, group) = av.arg
+ 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(sys.argv[2],'w')
+
+parse_args()
+
# Classes describing possible datatypes in the configuration file
-class single_ipaddr:
+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]))
+
+class conflist:
+ "A list of some kind of configuration type."
+ def __init__(self,subtype,w):
+ self.subtype=subtype
+ self.list=[subtype(w)]
+ def add(self,obj,w):
+ self.list.append(self.subtype(w))
+ def __str__(self):
+ return ', '.join(map(str, self.list))
+def listof(subtype):
+ return lambda w: conflist(subtype, w)
+
+class single_ipaddr (basetype):
"An IP address"
def __init__(self,w):
- self.addr=ipaddr.ipaddr(w[1])
+ self.addr=ipaddress.ip_address(w[1])
def __str__(self):
- return '"%s"'%self.addr.ip_str()
+ return '"%s"'%self.addr
-class networks:
+class networks (basetype):
"A set of IP addresses specified as a list of networks"
def __init__(self,w):
- self.set=ipaddr.ip_set()
+ self.set=ipaddrset.IPAddressSet()
for i in w[1:]:
- x=string.split(i,"/")
- self.set.append(ipaddr.network(x[0],x[1],
- ipaddr.DEMAND_NETWORK))
+ x=ipaddress.ip_network(i,strict=True)
+ self.set.append([x])
def __str__(self):
- return string.join(map(lambda x:'"%s/%s"'%(x.ip_str(),
- x.mask.netmask_bits_str),
- self.set.as_list_of_networks()),",")
+ return ",".join(map((lambda n: '"%s"'%n), self.set.networks()))
-class dhgroup:
+class dhgroup (basetype):
"A Diffie-Hellman group"
def __init__(self,w):
self.mod=w[1]
def __str__(self):
return 'diffie-hellman("%s","%s")'%(self.mod,self.gen)
-class hash:
+class hash (basetype):
"A choice of hash function"
def __init__(self,w):
- self.ht=w[1]
+ hname=w[1]
+ self.ht=hname
if (self.ht!='md5' and self.ht!='sha1'):
complain("unknown hash type %s"%(self.ht))
def __str__(self):
return '%s'%(self.ht)
-class email:
+class email (basetype):
"An email address"
def __init__(self,w):
self.addr=w[1]
def __str__(self):
return '<%s>'%(self.addr)
-class num:
+class boolean (basetype):
+ "A boolean"
+ def __init__(self,w):
+ if re.match('[TtYy1]',w[1]):
+ self.b=True
+ elif re.match('[FfNn0]',w[1]):
+ self.b=False
+ else:
+ complain("invalid boolean value");
+ def __str__(self):
+ return ['False','True'][self.b]
+
+class num (basetype):
"A decimal number"
def __init__(self,w):
- self.n=string.atol(w[1])
+ self.n=int(w[1])
def __str__(self):
return '%d'%(self.n)
-class address:
+class address (basetype):
"A DNS name and UDP port number"
def __init__(self,w):
self.adr=w[1]
- self.port=string.atoi(w[2])
+ self.port=int(w[2])
if (self.port<1 or self.port>65535):
complain("invalid port number")
def __str__(self):
return '"%s"; port %d'%(self.adr,self.port)
-class rsakey:
+class rsakey (basetype):
"An RSA public key"
def __init__(self,w):
- self.l=string.atoi(w[1])
+ self.l=int(w[1])
self.e=w[2]
self.n=w[3]
def __str__(self):
'pubkey':(rsakey,"RSA public site key"),
'peer':(single_ipaddr,"Tunnel peer IP address"),
'address':(address,"External contact address and port"),
+ 'mobile':(boolean,"Site is mobile"),
}
def sp(name,value):
allow_properties={}
require_properties={}
def __init__(self,w):
+ self.type=w[0]
self.name=w[1]
self.properties={}
self.children={}
w.write("\n")
self.indent(w,ind+2)
w.write("all-sites %s;\n"%
- string.join(self.children.keys(),','))
+ ','.join(self.children.keys()))
self.indent(w,ind)
w.write("};\n")
self.indent(w,ind)
# The "h=h,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(
+ w.write("%s %s;\n"%(self.name,','.join(
map(lambda x,h=h,self=self:
- h+"/"+x,self.children.keys()),',')))
+ h+"/"+x,self.children.keys()))))
class sitelevel(level):
"Site level (i.e. a leafnode) in the configuration hierarchy"
'networks':None,
'peer':None,
'pubkey':(lambda n,v:"key %s;\n"%v),
+ 'mobile':sp,
})
require_properties={
'dh':"Diffie-Hellman group",
'contact':"Site admin contact address",
- 'address':"Site external access address",
'networks':"Networks claimed by the site",
'hash':"hash function",
'peer':"Gateway address of the site",
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
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]):
- complain("%s %s already has property %s defined"%
- (obj.type,obj.name,w[0]))
+ prop=w[0]
+ if prop in obj.properties:
+ obj.properties[prop].add(obj,w)
else:
- obj.properties[w[0]]=keywords[w[0]][0](w)
+ obj.properties[prop]=keywords[prop][0](w)
-def pline(i):
+def pline(i,allow_include=False):
"Process a configuration file line"
global allow_defs, obstack, root
- w=string.split(i)
- if len(w)==0: return
+ w=i.rstrip('\n').split()
+ if len(w)==0: return [i]
keyword=w[0]
current=obstack[len(obstack)-1]
if keyword=='end-definitions':
allow_defs=sitelevel.depth
obstack=[root]
- return
- if levels.has_key(keyword):
+ return [i]
+ if keyword=='include':
+ if not allow_include:
+ complain("include not permitted here")
+ return []
+ if len(w) != 2:
+ complain("include requires one argument")
+ return []
+ newfile=os.path.join(os.path.dirname(file),w[1])
+ return pfilepath(newfile,allow_include=allow_include)
+ if keyword in levels:
# We may go up any number of levels, but only down by one
newdepth=levels[keyword].depth
currentdepth=len(obstack) # actually +1...
# 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]
+ 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!")
if nl.depth<allow_defs:
complain("New definitions not allowed at "
"level %d"%nl.depth)
- current.children[w[1]]=nl
+ # we risk crashing if we continue
+ sys.exit(1)
+ current.children[tname]=nl
current=nl
obstack.append(current)
- return
- if current.allow_properties.has_key(keyword):
- set_property(current,w)
- return
- else:
+ return [i]
+ if keyword not in current.allow_properties:
complain("Property %s not allowed at %s level"%
(keyword,current.type))
- return
+ return []
+ elif current.depth == vpnlevel.depth < allow_defs:
+ complain("Not allowed to set VPN properties here")
+ return []
+ else:
+ set_property(current,w)
+ return [i]
complain("unknown keyword '%s'"%(keyword))
-def pfile(name,lines):
+def pfilepath(pathname,allow_include=False):
+ f=open(pathname)
+ outlines=pfile(pathname,f.readlines(),allow_include=allow_include)
+ f.close()
+ return outlines
+
+def pfile(name,lines,allow_include=False):
"Process a file"
global file,line
file=name
line=0
+ outlines=[]
for i in lines:
line=line+1
if (i[0]=='#'): continue
- if (i[len(i)-1]=='\n'): i=i[:len(i)-1] # strip trailing LF
- pline(i)
+ outlines += pline(i,allow_include=allow_include)
+ return outlines
def outputsites(w):
"Output include file for secnet configuration"
w.write("# secnet sites file autogenerated by make-secnet-sites "
+"version %s\n"%VERSION)
w.write("# %s\n"%time.asctime(time.localtime(time.time())))
- w.write("# Command line: %s\n\n"%string.join(sys.argv))
+ w.write("# Command line: %s\n\n"%' '.join(sys.argv))
# Raw VPN data section of file
- w.write("vpn-data {\n")
+ w.write(prefix+"vpn-data {\n")
for i in root.children.values():
i.output_data(w,2,"")
w.write("};\n")
# Per-VPN flattened lists
- w.write("vpn {\n")
+ w.write(prefix+"vpn {\n")
for i in root.children.values():
- i.output_vpnflat(w,2,"vpn-data")
+ i.output_vpnflat(w,2,prefix+"vpn-data")
w.write("};\n")
# Flattened list of sites
- w.write("all-sites %s;\n"%string.join(map(lambda x:"vpn/%s/all-sites"%
- x,root.children.keys()),","))
-
-# Are we being invoked from userv?
-service=0
-# If we are, which group does the caller want to modify?
-group=None
+ w.write(prefix+"all-sites %s;\n"%",".join(
+ map(lambda x:"%svpn/%s/all-sites"%(prefix,x),
+ root.children.keys())))
line=0
file=None
complaints=0
-if len(sys.argv)<2:
- pfile("stdin",sys.stdin.readlines())
- of=sys.stdout
-else:
- if sys.argv[1]=='-u':
- if len(sys.argv)!=6:
- 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]
- if not os.environ.has_key("USERV_USER"):
- print "Environment variable USERV_USER not found"
- sys.exit(1)
- user=os.environ["USERV_USER"]
- # Check that group is in USERV_GROUP
- if not os.environ.has_key("USERV_GROUP"):
- print "Environment variable USERV_GROUP not found"
- sys.exit(1)
- ugs=os.environ["USERV_GROUP"]
- ok=0
- for i in string.split(ugs):
- if group==i: ok=1
- if not ok:
- print "caller not in group %s"%group
- sys.exit(1)
- f=open(header)
- headerinput=f.readlines()
- f.close()
- pfile(header,headerinput)
- userinput=sys.stdin.readlines()
- pfile("user input",userinput)
- else:
- if len(sys.argv)>3:
- print "Too many arguments"
- sys.exit(1)
- f=open(sys.argv[1])
- pfile(sys.argv[1],f.readlines())
- f.close()
- 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
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)
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"):
- # I'd like to do this:
- # n.properties["networks"].set.is_subset(new_ra)
- # but there isn't an is_subset() method
- # Instead we see if we intersect with the complement of new_ra
- rac=new_ra.complement()
- i=rac.intersection(n.properties["networks"].set)
- if not i.is_empty():
+ 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)
-checkconstraints(root,{},ipaddr.complete_set)
+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)
if service:
~ianmdlvl / secnet.git / blobdiff