fix exploit that allowed an authorities to issue certs for objects that dont belong...
[sfa.git] / sfa / util / xrn.py
index c166400..d5410ab 100644 (file)
-import re
-
-from sfa.util.faults import *
-
-# for convenience and smoother translation - we should get rid of these functions eventually 
-def get_leaf(hrn): return Xrn(hrn).get_leaf()
-def get_authority(hrn): return Xrn(hrn).get_authority_hrn()
-def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)
-def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn
-
-def urn_to_sliver_id(urn, slice_id, node_id, index=0):
-    urn = urn.replace('+slice+', '+sliver+')    
-    return ":".join([urn, str(slice_id), str(node_id), str(index)])
-
-class Xrn:
-
-    ########## basic tools on HRNs
-    # split a HRN-like string into pieces
-    # this is like split('.') except for escaped (backslashed) dots
-    # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']
-    @staticmethod
-    def hrn_split(hrn):
-        return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
-
-    # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
-    @staticmethod
-    def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
-
-    # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
-    @staticmethod
-    def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
-    
-    # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
-    @staticmethod
-    def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
-    
-    # e.g. escape ('a.b') -> 'a\.b'
-    @staticmethod
-    def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
-    # e.g. unescape ('a\.b') -> 'a.b'
-    @staticmethod
-    def unescape(token): return token.replace('\\.','.')
-        
-    URN_PREFIX = "urn:publicid:IDN"
-
-    ########## basic tools on URNs
-    @staticmethod
-    def urn_full (urn):
-        if urn.startswith(Xrn.URN_PREFIX): return urn
-        else: return Xrn.URN_PREFIX+URN
-    @staticmethod
-    def urn_meaningful (urn):
-        if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]
-        else: return urn
-    @staticmethod
-    def urn_split (urn):
-        return Xrn.urn_meaningful(urn).split('+')
-
-    ####################
-    # the local fields that are kept consistent
-    # self.urn
-    # self.hrn
-    # self.type
-    # self.path
-    # provide either urn, or (hrn + type)
-    def __init__ (self, xrn, type=None):
-        if not xrn: xrn = ""
-        # user has specified xrn : guess if urn or hrn
-        if xrn.startswith(Xrn.URN_PREFIX):
-            self.hrn=None
-            self.urn=xrn
-            self.urn_to_hrn()
-        else:
-            self.urn=None
-            self.hrn=xrn
-            self.type=type
-            self.hrn_to_urn()
-# happens all the time ..
-#        if not type:
-#            debug_logger.debug("type-less Xrn's are not safe")
-
-    def get_urn(self): return self.urn
-    def get_hrn(self): return self.hrn
-    def get_type(self): return self.type
-    def get_hrn_type(self): return (self.hrn, self.type)
-
-    def _normalize(self):
-        if self.hrn is None: raise SfaAPIError, "Xrn._normalize"
-        if not hasattr(self,'leaf'): 
-            self.leaf=Xrn.hrn_split(self.hrn)[-1]
-        # self.authority keeps a list
-        if not hasattr(self,'authority'): 
-            self.authority=Xrn.hrn_auth_list(self.hrn)
-
-    def get_leaf(self):
-        self._normalize()
-        return self.leaf
-
-    def get_authority_hrn(self): 
-        self._normalize()
-        return '.'.join( self.authority )
-    
-    def get_authority_urn(self): 
-        self._normalize()
-        return ':'.join( [Xrn.unescape(x) for x in self.authority] )
-    
-    def urn_to_hrn(self):
-        """
-        compute tuple (hrn, type) from urn
-        """
-        
-#        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
-        if not self.urn.startswith(Xrn.URN_PREFIX):
-            raise SfaAPIError, "Xrn.urn_to_hrn"
-
-        parts = Xrn.urn_split(self.urn)
-        type=parts.pop(2)
-        # Remove the authority name (e.g. '.sa')
-        if type == 'authority':
-            name = parts.pop()
-            # Drop the sa. This is a bad hack, but its either this
-            # or completely change how record types are generated/stored   
-            if name != 'sa':
-                type = type + "+" + name
-
-        # convert parts (list) into hrn (str) by doing the following
-        # 1. remove blank parts
-        # 2. escape dots inside parts
-        # 3. replace ':' with '.' inside parts
-        # 3. join parts using '.' 
-        hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part]) 
-
-        self.hrn=str(hrn)
-        self.type=str(type)
-    
-    def hrn_to_urn(self):
-        """
-        compute urn from (hrn, type)
-        """
-
-#        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
-        if self.hrn.startswith(Xrn.URN_PREFIX):
-            raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
-
-        if self.type and self.type.startswith('authority'):
-            self.authority = Xrn.hrn_split(self.hrn)
-            type_parts = self.type.split("+")
-            self.type = type_parts[0]
-            name = 'sa'
-            if len(type_parts) > 1:
-                name = type_parts[1]
-        else:
-            self.authority = Xrn.hrn_auth_list(self.hrn)
-            name = Xrn.hrn_leaf(self.hrn)
-
-        authority_string = self.get_authority_urn()
-
-        if self.type == None:
-            urn = "+".join(['',authority_string,Xrn.unescape(name)])
-        else:
-            urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])
-        
-        self.urn = Xrn.URN_PREFIX + urn
-
-    def dump_string(self):
-        result="-------------------- XRN\n"
-        result += "URN=%s\n"%self.urn
-        result += "HRN=%s\n"%self.hrn
-        result += "TYPE=%s\n"%self.type
-        result += "LEAF=%s\n"%self.get_leaf()
-        result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
-        result += "AUTH(urn format)=%s\n"%self.get_authority_urn()
-        return result
-        
+#----------------------------------------------------------------------\r
+# Copyright (c) 2008 Board of Trustees, Princeton University\r
+#\r
+# Permission is hereby granted, free of charge, to any person obtaining\r
+# a copy of this software and/or hardware specification (the "Work") to\r
+# deal in the Work without restriction, including without limitation the\r
+# rights to use, copy, modify, merge, publish, distribute, sublicense,\r
+# and/or sell copies of the Work, and to permit persons to whom the Work\r
+# is furnished to do so, subject to the following conditions:\r
+#\r
+# The above copyright notice and this permission notice shall be\r
+# included in all copies or substantial portions of the Work.\r
+#\r
+# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS \r
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF \r
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND \r
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT \r
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, \r
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \r
+# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS \r
+# IN THE WORK.\r
+#----------------------------------------------------------------------\r
+\r
+import re\r
+\r
+from sfa.util.faults import *\r
+\r
+# for convenience and smoother translation - we should get rid of these functions eventually \r
+def get_leaf(hrn): return Xrn(hrn).get_leaf()\r
+def get_authority(hrn): return Xrn(hrn).get_authority_hrn()\r
+def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)\r
+def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn\r
+def hrn_authfor_hrn(parenthrn, hrn): return Xrn.hrn_is_auth_for_hrn(parenthrn, hrn)\r
+\r
+class Xrn:\r
+\r
+    ########## basic tools on HRNs\r
+    # split a HRN-like string into pieces\r
+    # this is like split('.') except for escaped (backslashed) dots\r
+    # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']\r
+    @staticmethod\r
+    def hrn_split(hrn):\r
+        return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]\r
+\r
+    # e.g. hrn_leaf ('a\.b.c.d') -> 'd'\r
+    @staticmethod\r
+    def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]\r
+\r
+    # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']\r
+    @staticmethod\r
+    def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]\r
+    \r
+    # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'\r
+    @staticmethod\r
+    def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))\r
+    \r
+    # e.g. escape ('a.b') -> 'a\.b'\r
+    @staticmethod\r
+    def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)\r
+\r
+    # e.g. unescape ('a\.b') -> 'a.b'\r
+    @staticmethod\r
+    def unescape(token): return token.replace('\\.','.')\r
+\r
+    # Return the HRN authority chain from top to bottom.\r
+    # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']\r
+    @staticmethod\r
+    def hrn_auth_chain(hrn):\r
+        parts = Xrn.hrn_auth_list(hrn)\r
+        chain = []\r
+        for i in range(len(parts)):\r
+            chain.append('.'.join(parts[:i+1]))\r
+        # Include the HRN itself?\r
+        #chain.append(hrn)\r
+        return chain\r
+\r
+    # Is the given HRN a true authority over the namespace of the other\r
+    # child HRN?\r
+    # A better alternative than childHRN.startswith(parentHRN)\r
+    # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,\r
+    # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False\r
+    # Also hrn_is_uauth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True\r
+    @staticmethod\r
+    def hrn_is_auth_for_hrn(parenthrn, hrn):\r
+        if parenthrn == hrn:\r
+            return True\r
+        for auth in Xrn.hrn_auth_chain(hrn):\r
+            if parenthrn == auth:\r
+                return True\r
+        return False\r
+\r
+    URN_PREFIX = "urn:publicid:IDN"\r
+\r
+    ########## basic tools on URNs\r
+    @staticmethod\r
+    def urn_full (urn):\r
+        if urn.startswith(Xrn.URN_PREFIX): return urn\r
+        else: return Xrn.URN_PREFIX+URN\r
+    @staticmethod\r
+    def urn_meaningful (urn):\r
+        if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]\r
+        else: return urn\r
+    @staticmethod\r
+    def urn_split (urn):\r
+        return Xrn.urn_meaningful(urn).split('+')\r
+\r
+    ####################\r
+    # the local fields that are kept consistent\r
+    # self.urn\r
+    # self.hrn\r
+    # self.type\r
+    # self.path\r
+    # provide either urn, or (hrn + type)\r
+    def __init__ (self, xrn, type=None):\r
+        if not xrn: xrn = ""\r
+        # user has specified xrn : guess if urn or hrn\r
+        if xrn.startswith(Xrn.URN_PREFIX):\r
+            self.hrn=None\r
+            self.urn=xrn\r
+            self.urn_to_hrn()\r
+        else:\r
+            self.urn=None\r
+            self.hrn=xrn\r
+            self.type=type\r
+            self.hrn_to_urn()\r
+# happens all the time ..\r
+#        if not type:\r
+#            debug_logger.debug("type-less Xrn's are not safe")\r
+\r
+    def get_urn(self): return self.urn\r
+    def get_hrn(self): return self.hrn\r
+    def get_type(self): return self.type\r
+    def get_hrn_type(self): return (self.hrn, self.type)\r
+\r
+    def _normalize(self):\r
+        if self.hrn is None: raise SfaAPIError, "Xrn._normalize"\r
+        if not hasattr(self,'leaf'): \r
+            self.leaf=Xrn.hrn_split(self.hrn)[-1]\r
+        # self.authority keeps a list\r
+        if not hasattr(self,'authority'): \r
+            self.authority=Xrn.hrn_auth_list(self.hrn)\r
+\r
+    def get_leaf(self):\r
+        self._normalize()\r
+        return self.leaf\r
+\r
+    def get_authority_hrn(self): \r
+        self._normalize()\r
+        return '.'.join( self.authority )\r
+    \r
+    def get_authority_urn(self): \r
+        self._normalize()\r
+        return ':'.join( [Xrn.unescape(x) for x in self.authority] )\r
+    \r
+    def urn_to_hrn(self):\r
+        """\r
+        compute tuple (hrn, type) from urn\r
+        """\r
+        \r
+#        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):\r
+        if not self.urn.startswith(Xrn.URN_PREFIX):\r
+            raise SfaAPIError, "Xrn.urn_to_hrn"\r
+\r
+        parts = Xrn.urn_split(self.urn)\r
+        type=parts.pop(2)\r
+        # Remove the authority name (e.g. '.sa')\r
+        if type == 'authority':\r
+            name = parts.pop()\r
+            # Drop the sa. This is a bad hack, but its either this\r
+            # or completely change how record types are generated/stored   \r
+            if name != 'sa':\r
+                type = type + "+" + name\r
+\r
+        # convert parts (list) into hrn (str) by doing the following\r
+        # 1. remove blank parts\r
+        # 2. escape dots inside parts\r
+        # 3. replace ':' with '.' inside parts\r
+        # 3. join parts using '.' \r
+        hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part]) \r
+\r
+        self.hrn=str(hrn)\r
+        self.type=str(type)\r
+    \r
+    def hrn_to_urn(self):\r
+        """\r
+        compute urn from (hrn, type)\r
+        """\r
+\r
+#        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):\r
+        if self.hrn.startswith(Xrn.URN_PREFIX):\r
+            raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn\r
+\r
+        if self.type and self.type.startswith('authority'):\r
+            self.authority = Xrn.hrn_split(self.hrn)\r
+            type_parts = self.type.split("+")\r
+            self.type = type_parts[0]\r
+            name = 'sa'\r
+            if len(type_parts) > 1:\r
+                name = type_parts[1]\r
+        else:\r
+            self.authority = Xrn.hrn_auth_list(self.hrn)\r
+            name = Xrn.hrn_leaf(self.hrn)\r
+\r
+        authority_string = self.get_authority_urn()\r
+\r
+        if self.type == None:\r
+            urn = "+".join(['',authority_string,Xrn.unescape(name)])\r
+        else:\r
+            urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])\r
+        \r
+        self.urn = Xrn.URN_PREFIX + urn\r
+\r
+    def dump_string(self):\r
+        result="-------------------- XRN\n"\r
+        result += "URN=%s\n"%self.urn\r
+        result += "HRN=%s\n"%self.hrn\r
+        result += "TYPE=%s\n"%self.type\r
+        result += "LEAF=%s\n"%self.get_leaf()\r
+        result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()\r
+        result += "AUTH(urn format)=%s\n"%self.get_authority_urn()\r
+        return result\r
+        \r