python3 - 2to3 + miscell obvious tweaks
[sfa.git] / sfa / trust / gid.py
index 678c1a3..7387902 100644 (file)
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Work.
 #
-# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
-# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS 
+# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
 # IN THE WORK.
 #----------------------------------------------------------------------
 ##
 # descendant of the certificate class.
 ##
 
-### $Id$
-### $URL$
-import xmlrpclib
+
+
 import uuid
 
-import sfa.util.sfalogging
 from sfa.trust.certificate import Certificate
-from sfa.util.namespace import *
+
+from sfa.util.faults import GidInvalidParentHrn, GidParentHrn
+from sfa.util.xrn import hrn_to_urn, urn_to_hrn, hrn_authfor_hrn
+from sfa.util.sfalogging import logger
+from sfa.util.py23 import xmlrpc_client
 
 ##
 # Create a new uuid. Returns the UUID as a string.
 
+
 def create_uuid():
     return str(uuid.uuid4().int)
 
@@ -52,7 +55,7 @@ def create_uuid():
 #
 # URN is a human readable identifier of form:
 #   "urn:publicid:IDN+toplevelauthority[:sub-auth.]*[\res. type]\ +object name"
-#   For  example, urn:publicid:IDN+planetlab:us:arizona+user+bakers      
+#   For  example, urn:publicid:IDN+planetlab:us:arizona+user+bakers
 #
 # PUBLIC_KEY is the public key of the principal identified by the UUID/HRN.
 # It is a Keypair object as defined in the cert.py module.
@@ -66,10 +69,6 @@ def create_uuid():
 
 
 class GID(Certificate):
-    uuid = None
-    hrn = None
-    urn = None
-
     ##
     # Create a new GID object
     #
@@ -77,12 +76,19 @@ class GID(Certificate):
     # @param subject If subject!=None, create the X509 cert and set the subject name
     # @param string If string!=None, load the GID from a string
     # @param filename If filename!=None, load the GID from a file
+    # @param lifeDays life of GID in days - default is 1825==5 years
+    # @param email Email address to put in subjectAltName - default is None
+
+    def __init__(self, create=False, subject=None, string=None, filename=None,
+                 uuid=None, hrn=None, urn=None, lifeDays=1825, email=None):
+        self.uuid = None
+        self.hrn = None
+        self.urn = None
+        self.email = None  # for adding to the SubjectAltName
+        Certificate.__init__(self, lifeDays, create, subject, string, filename)
 
-    def __init__(self, create=False, subject=None, string=None, filename=None, uuid=None, hrn=None, urn=None):
-        
-        Certificate.__init__(self, create, subject, string, filename)
         if subject:
-            sfa.util.sfalogging.logger.debug("Creating GID for subject: %s" % subject)
+            logger.debug("Creating GID for subject: %s" % subject)
         if uuid:
             self.uuid = int(uuid)
         if hrn:
@@ -92,6 +98,10 @@ class GID(Certificate):
             self.urn = urn
             self.hrn, type = urn_to_hrn(urn)
 
+        if email:
+            logger.debug("Creating GID for subject using email: %s" % email)
+            self.set_email(email)
+
     def set_uuid(self, uuid):
         if isinstance(uuid, str):
             self.uuid = int(uuid)
@@ -114,18 +124,27 @@ class GID(Certificate):
     def set_urn(self, urn):
         self.urn = urn
         self.hrn, type = urn_to_hrn(urn)
+
     def get_urn(self):
         if not self.urn:
             self.decode()
-        return self.urn            
+        return self.urn
+
+    # Will be stuffed into subjectAltName
+    def set_email(self, email):
+        self.email = email
+
+    def get_email(self):
+        if not self.email:
+            self.decode()
+        return self.email
 
     def get_type(self):
         if not self.urn:
             self.decode()
         _, t = urn_to_hrn(self.urn)
         return t
-    
+
     ##
     # Encode the GID fields and package them into the subject-alt-name field
     # of the X509 certificate. This must be called prior to signing the
@@ -136,16 +155,16 @@ class GID(Certificate):
             urn = self.urn
         else:
             urn = hrn_to_urn(self.hrn, None)
-            
-        str = "URI:" + urn
+
+        string = "URI:" + urn
 
         if self.uuid:
-            str += ", " + "URI:" + uuid.UUID(int=self.uuid).urn
-        
-        self.set_data(str, 'subjectAltName')
+            string += ", " + "URI:" + uuid.UUID(int=self.uuid).urn
 
-        
+        if self.email:
+            string += ", " + "email:" + self.email
 
+        self.set_data(string, 'subjectAltName')
 
     ##
     # Decode the subject-alt-name field of the X509 certificate into the
@@ -157,7 +176,7 @@ class GID(Certificate):
         dict = {}
         if data:
             if data.lower().startswith('uri:http://<params>'):
-                dict = xmlrpclib.loads(data[11:])[0][0]
+                dict = xmlrpc_client.loads(data[11:])[0][0]
             else:
                 spl = data.split(', ')
                 for val in spl:
@@ -165,10 +184,15 @@ class GID(Certificate):
                         dict['uuid'] = uuid.UUID(val[4:]).int
                     elif val.lower().startswith('uri:urn:publicid:idn+'):
                         dict['urn'] = val[4:]
-                    
+                    elif val.lower().startswith('email:'):
+                        # FIXME: Ensure there isn't cruft in that address...
+                        # EG look for email:copy,....
+                        dict['email'] = val[6:]
+
         self.uuid = dict.get("uuid", None)
         self.urn = dict.get("urn", None)
-        self.hrn = dict.get("hrn", None)    
+        self.hrn = dict.get("hrn", None)
+        self.email = dict.get("email", None)
         if self.urn:
             self.hrn = urn_to_hrn(self.urn)[0]
 
@@ -178,43 +202,74 @@ class GID(Certificate):
     # @param indent specifies a number of spaces to indent the output
     # @param dump_parents If true, also dump the parents of the GID
 
-    def dump(self, indent=0, dump_parents=False):
-        print " "*indent, " hrn:", self.get_hrn()
-        print " "*indent, " urn:", self.get_urn()
-        print " "*indent, "uuid:", self.get_uuid()
+    def dump(self, *args, **kwargs):
+        print(self.dump_string(*args, **kwargs))
+
+    def dump_string(self, indent=0, dump_parents=False):
+        result = " " * (indent - 2) + "GID\n"
+        result += " " * indent + "hrn:" + str(self.get_hrn()) + "\n"
+        result += " " * indent + "urn:" + str(self.get_urn()) + "\n"
+        result += " " * indent + "uuid:" + str(self.get_uuid()) + "\n"
+        if self.get_email() is not None:
+            result += " " * indent + "email:" + str(self.get_email()) + "\n"
+        filename = self.get_filename()
+        if filename:
+            result += "Filename %s\n" % filename
 
         if self.parent and dump_parents:
-            print " "*indent, "parent:"
-            self.parent.dump(indent+4, dump_parents)
+            result += " " * indent + "parent:\n"
+            result += self.parent.dump_string(indent + 4, dump_parents)
+        return result
 
     ##
     # Verify the chain of authenticity of the GID. First perform the checks
     # of the certificate class (verifying that each parent signs the child,
     # etc). In addition, GIDs also confirm that the parent's HRN is a prefix
-    # of the child's HRN.
+    # of the child's HRN, and the parent is of type 'authority'.
     #
     # Verifying these prefixes prevents a rogue authority from signing a GID
     # for a principal that is not a member of that authority. For example,
     # planetlab.us.arizona cannot sign a GID for planetlab.us.princeton.foo.
 
-    def verify_chain(self, trusted_certs = None):
+    def verify_chain(self, trusted_certs=None):
+        logger.debug(10*'=' + " GID.verify_chain with {} trusted certs"
+                     .format(len(trusted_certs)))
+        logger.debug("on {}".format(self.pretty_name()))
         # do the normal certificate verification stuff
-        trusted_root = Certificate.verify_chain(self, trusted_certs)        
-       
+        trusted_root = Certificate.verify_chain(self, trusted_certs)
+
         if self.parent:
             # make sure the parent's hrn is a prefix of the child's hrn
-            if not self.get_hrn().startswith(self.parent.get_hrn()):
-                #print self.get_hrn(), " ", self.parent.get_hrn()
-                raise GidParentHrn("This cert %s HRN doesnt start with parent HRN %s" % (self.get_hrn(), self.parent.get_hrn()))
+            if not hrn_authfor_hrn(self.parent.get_hrn(), self.get_hrn()):
+                raise GidParentHrn(
+                    "This cert HRN {} isn't in the namespace for parent HRN {}"
+                    .format(self.get_hrn(), self.parent.get_hrn()))
+
+            # Parent must also be an authority (of some type) to sign a GID
+            # There are multiple types of authority - accept them all here
+            if not self.parent.get_type().find('authority') == 0:
+                raise GidInvalidParentHrn(
+                    "This cert {}'s parent {} is not an authority (is a %{})"
+                    .format(self.get_hrn(), self.parent.get_hrn(), self.parent.get_type()))
+
+            # Then recurse up the chain - ensure the parent is a trusted
+            # root or is in the namespace of a trusted root
+            self.parent.verify_chain(trusted_certs)
         else:
             # make sure that the trusted root's hrn is a prefix of the child's
             trusted_gid = GID(string=trusted_root.save_to_string())
             trusted_type = trusted_gid.get_type()
             trusted_hrn = trusted_gid.get_hrn()
-            #if trusted_type == 'authority':
+            # if trusted_type == 'authority':
             #    trusted_hrn = trusted_hrn[:trusted_hrn.rindex('.')]
             cur_hrn = self.get_hrn()
-            if not self.get_hrn().startswith(trusted_hrn):
-                raise GidParentHrn("Trusted roots HRN %s isnt start of this cert %s" % (trusted_hrn, cur_hrn))
+            if not hrn_authfor_hrn(trusted_hrn, cur_hrn):
+                raise GidParentHrn(
+                    "Trusted root with HRN {} isn't a namespace authority for this cert: {}"
+                    .format(trusted_hrn, cur_hrn))
 
-        return
+            # There are multiple types of authority - accept them all here
+            if not trusted_type.find('authority') == 0:
+                raise GidInvalidParentHrn(
+                    "This cert {}'s trusted root signer {} is not an authority (is a {})"
+                    .format(self.get_hrn(), trusted_hrn, trusted_type))