chiark / gitweb /
test-example: all-privkeys: Define, and indirect through, a variable
[secnet.git] / make-secnet-sites
index b4cd9afb80ac404c03b6f3575718cbf0863e3005..9e4538b01e4f719ea3ece7ad6d1396dd53edd106 100755 (executable)
@@ -70,11 +70,14 @@ import ipaddress
 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 = 2
+
 from sys import version_info
 if version_info.major == 2:  # for python2
     import codecs
@@ -83,7 +86,17 @@ if version_info.major == 2:  # for python2
     import io
     open=lambda f,m='r': io.open(f,m,encoding='utf-8')
 
-max={'rsa_bits':8200,'name':33,'dh_bits':8200}
+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):
@@ -116,7 +129,9 @@ class Tainted:
                if maxlen is None: maxlen=max[what]
                self._max_ok(what,maxlen)
                if self._ok is False: return False
-               if bad.search(self._s): return self._bad(what,'bad syntax')
+               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=''):
@@ -149,8 +164,8 @@ class Tainted:
        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')
+       def name(self,what='name'):
+               ok=self._re_ok(Tainted.bad_name,what)
                return self._rtn(ok,
                                 '_line%d_%s' % (self._line, id(self)))
 
@@ -182,6 +197,13 @@ class Tainted:
                                             % (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
@@ -205,17 +227,85 @@ class Tainted:
                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)
+
+class PkmBase():
+       def site_start(self,pubkeys_path):
+               self._pa=pubkeys_path
+               self._fs = FilterState()
+       def site_serial(self,serial): pass
+       def write_key(self,k): pass
+       def site_finish(self,confw): pass
+
+class PkmSingle(PkmBase):
+       opt = 'single'
+       help = 'write one public key per site to sites.conf'
+       def site_start(self,pubkeys_path):
+               PkmBase.site_start(self,pubkeys_path)
+               self._outk = []
+       def write_key(self,k):
+               if k.okforonlykey(output_version,self._fs):
+                       self._outk.append(k)
+       def site_finish(self,confw):
+               if len(self._outk) == 0:
+                       complain("site with no public key");
+               elif len(self._outk) != 1:
+                       debugrepr('outk ', self._outk)
+                       complain(
+ "site with multiple public keys, without --pubkeys-install (maybe --output-version=1 would help"
+                       )
+               else:
+                       confw.write("key %s;\n"%str(self._outk[0]))
+
+class PkmInstall(PkmBase):
+       opt = 'install'
+       help = 'install public keys in public key directory'
+       def site_start(self,pubkeys_path):
+               PkmBase.site_start(self,pubkeys_path)
+               self._pw=open(self._pa+'~tmp','w')
+       def site_serial(self,serial):
+               self._pw.write('serial %s\n' % serial)
+       def write_key(self,k):
+               wout=k.forpub(output_version,self._fs)
+               self._pw.write(' '.join(wout))
+               self._pw.write('\n')
+       def site_finish(self,confw):
+               self._pw.close()
+               os.rename(self._pa+'~tmp',self._pa+'~update')
+               PkmElide.site_finish(self,confw)
+
+class PkmElide(PkmBase):
+       opt = 'elide'
+       help = 'no public keys in sites.conf output nor in directory'
+       def site_finish(self,confw):
+               confw.write("peer-keys \"%s\";\n"%self._pa);
+
 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
+       global pubkeys_dir
+       global pubkeys_mode
 
        ap = argparse.ArgumentParser(description='process secnet sites files')
        ap.add_argument('--userv', '-u', action='store_true',
@@ -223,14 +313,33 @@ def parse_args():
        ap.add_argument('--conf-key-prefix', action=ActionNoYes,
                        default=True,
                 help='prefix conf file key names derived from sites data')
+       def add_pkm(how):
+               ap.add_argument('--pubkeys-'+how().opt, action=ArgActionLambda,
+                       nargs=0,
+                       fn=(lambda v,ns,*x: setattr(ns,'pkm',how)),
+                       help=how().help)
+       add_pkm(PkmInstall)
+       add_pkm(PkmSingle)
+       add_pkm(PkmElide)
+       ap.add_argument('--pubkeys-dir',  nargs=1,
+                       help='public key directory',
+                       default=['/var/lib/secnet/pubkeys'])
+       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()
-       #print(repr(av), file=sys.stderr)
+       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]
+       pubkeys_dir = av.pubkeys_dir[0]
+       pubkeys_mode = getattr(av,'pkm',PkmSingle)
        if service:
                if len(av.arg)!=4:
                        print("Wrong number of arguments")
@@ -258,8 +367,6 @@ def parse_args():
                        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()
 
@@ -270,6 +377,8 @@ class basetype:
        def add(self,obj,w):
                complain("%s %s already has property %s defined"%
                        (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."
@@ -280,6 +389,9 @@ 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)
 
@@ -350,6 +462,15 @@ class num (basetype):
        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):
@@ -358,15 +479,93 @@ class address (basetype):
        def __str__(self):
                return '"%s"; port %d'%(self.adr,self.port)
 
-class rsakey (basetype):
-       "An RSA public key"
+class inpub (basetype):
+       def forsites(self,version,xcopy,fs):
+               return self.forpub(version,fs)
+
+class pubkey (inpub):
+       "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)
+       def forpub(self,version,fs):
+               if version < 2: return []
+               return ['pub', self.a, self.d]
+       def okforonlykey(self,version,fs):
+               return len(self.forpub(version,fs)) != 0
+
+class rsakey (pubkey):
+       "An old-style RSA public key"
        def __init__(self,w):
                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()
+               self.a='rsa1'
+               self.d=base91s_encode(b'%d %s %s' %
+                                     (self.l,
+                                      self.e.encode('ascii'),
+                                      self.n.encode('ascii')))
+               # ^ this allows us to use the pubkey.forsites()
+               # method for output in versions>=2
        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 forpub(self,version,fs):
+               if version < 2:
+                       if fs.pkg != '00000000': return []
+                       return ['pubkey', str(self.l), self.e, self.n]
+               return pubkey.forpub(self,version,fs)
+
+class rsakey_newfmt(rsakey):
+       "An old-style RSA public key in new-style sites format"
+       # This is its own class simply to have its own constructor.
+       def __init__(self,w):
+               self.a=w[1].name()
+               assert(self.a == 'rsa1')
+               self.d=w[2].base91()
+               try:
+                       w_inner=list(map(Tainted,
+                                       ['X-PUB-RSA1'] +
+                                       base91s_decode(self.d)
+                                       .decode('ascii')
+                                       .split(' ')))
+               except UnicodeDecodeError:
+                       complain('rsa1 key in new format has bad base91')
+               #print(repr(w_inner), file=sys.stderr)
+               rsakey.__init__(self,w_inner)
+
+class pubkey_group(inpub):
+       "Public key group introducer"
+       # appears in the site's list of keys mixed in with the keys
+       def __init__(self,w,fallback):
+               self.i=w[1].hexid(4,'pkg-id')
+               self.fallback=fallback
+       def forpub(self,version,fs):
+               fs.pkg=self.i
+               if version < 2: return []
+               return ['pkgf' if self.fallback else 'pkg', self.i]
+       def okforonlykey(self,version,fs):
+               self.forpub(version,fs)
+               return False
+       
+def somepubkey(w):
+       #print(repr(w), file=sys.stderr)
+       if w[0]=='pubkey':
+               return rsakey(w)
+       elif w[0]=='pub' and w[1]=='rsa1':
+               return rsakey_newfmt(w)
+       elif w[0]=='pub':
+               return pubkey(w)
+       elif w[0]=='pkg':
+               return pubkey_group(w,False)
+       elif w[0]=='pkgf':
+               return pubkey_group(w,True)
+       else:
+               assert(False)
 
 # Possible properties of configuration nodes
 keywords={
@@ -380,7 +579,11 @@ 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"),
+ 'serial':(serial,"public key set serial"),
+ 'pkg':(listof(somepubkey),"start of public key group",'pub'),
+ 'pkgf':(listof(somepubkey),"start of fallback public key group",'pub'),
+ 'pub':(listof(somepubkey),"new style public site key"),
+ 'pubkey':(listof(somepubkey),"Old-style RSA public site key",'pub'),
  'peer':(single_ipaddr,"Tunnel peer IP address"),
  'address':(address,"External contact address and port"),
  'mobile':(boolean,"Site is mobile"),
@@ -500,7 +703,11 @@ class sitelevel(level):
         'address':sp,
         'networks':None,
         'peer':None,
-        'pubkey':(lambda n,v:"key %s;\n"%v),
+         'serial':None,
+        'pkg':None,
+        'pkgf':None,
+        'pub':None,
+        'pubkey':None,
         'mobile':sp,
        })
        require_properties={
@@ -509,8 +716,11 @@ 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",
        }
+       def mangle_name(self):
+               return self.name.replace('/',',')
+       def pubkeys_path(self):
+               return pubkeys_dir + '/peer.' + self.mangle_name()
        def __init__(self,w):
                level.__init__(self,w)
        def output_data(self,w,path):
@@ -520,6 +730,20 @@ class sitelevel(level):
                w.write("%s {\n"%(self.kname()))
                self.indent(w,ind+2)
                w.write("name \"%s\";\n"%(np,))
+               self.indent(w,ind+2)
+
+               pkm = pubkeys_mode()
+               debugrepr('pkm ',pkm)
+               pkm.site_start(self.pubkeys_path())
+               if 'serial' in self.properties:
+                       pkm.site_serial(self.properties['serial'])
+
+               for k in self.properties["pub"].list:
+                       debugrepr('pubkeys ', k)
+                       pkm.write_key(k)
+
+               pkm.site_finish(w)
+
                self.output_props(w,ind+2)
                self.indent(w,ind+2)
                w.write("link netlink {\n");
@@ -538,13 +762,12 @@ levels={'vpn':vpnlevel, 'location':locationlevel, 'site':sitelevel}
 
 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
 
 class UntaintedRoot():
@@ -560,13 +783,24 @@ allow_defs=0   # Level above which new definitions are permitted
 def set_property(obj,w):
        "Set a property on a configuration node"
        prop=w[0]
-       if prop.raw() in obj.properties:
-               obj.properties[prop.raw_mark_ok()].add(obj,w)
+       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[prop.raw()]=keywords[prop.raw_mark_ok()][0](w)
-
-
-def pline(il,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
+               self.pkg = '00000000'
+
+def pline(il,filterstate,allow_include=False):
        "Process a configuration file line"
        global allow_defs, obstack, root
        w=il.rstrip('\n').split()
@@ -574,9 +808,9 @@ def pline(il,allow_include=False):
        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']
+       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
@@ -623,6 +857,7 @@ def pline(il,allow_include=False):
                                sys.exit(1)
                        current.children[tname]=nl
                        current=nl
+               filterstate.reset()
                obstack.append(current)
                return copyout()
        if keyword.raw() not in current.allow_properties:
@@ -633,8 +868,11 @@ def pline(il,allow_include=False):
                complain("Not allowed to set VPN properties here")
                return []
        else:
-               set_property(current,w)
-               return copyout()
+               prop=set_property(current,w)
+               out=[copyout_core()]
+               out=prop.forsites(output_version,out,filterstate)
+               if len(out)==0: return [indent + '#', copyout_core(), '\n']
+               return [indent + ' '.join(out) + '\n']
 
        complain("unknown keyword '%s'"%(keyword.raw()))
 
@@ -650,10 +888,11 @@ def pfile(name,lines,allow_include=False):
        file=name
        line=0
        outlines=[]
+       filterstate = FilterState()
        for i in lines:
                line=line+1
                if (i[0]=='#'): continue
-               outlines += pline(i,allow_include=allow_include)
+               outlines += pline(i,filterstate,allow_include=allow_include)
        return outlines
 
 def outputsites(w):
@@ -777,4 +1016,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)