sfa/trust/credential.py

   1 #----------------------------------------------------------------------
   2 # Copyright (c) 2008 Board of Trustees, Princeton University
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and/or hardware specification (the "Work") to
   6 # deal in the Work without restriction, including without limitation the
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Work, and to permit persons to whom the Work
   9 # is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Work.
  13 #
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
  21 # IN THE WORK.
  22 #----------------------------------------------------------------------
  23 ##
  24 # Implements SFA Credentials
  25 #
  26 # Credentials are signed XML files that assign a subject gid privileges to an object gid
  27 ##
  28
  29 ### $Id$
  30 ### $URL$
  31
  32 import os
  33 import datetime
  34 from tempfile import mkstemp
  35 from xml.dom.minidom import Document, parseString
  36 from dateutil.parser import parse
  37
  38 from sfa.util.faults import *
  39 from sfa.util.sfalogging import sfa_logger
  40 from sfa.trust.certificate import Keypair
  41 from sfa.trust.credential_legacy import CredentialLegacy
  42 from sfa.trust.rights import Right, Rights
  43 from sfa.trust.gid import GID
  44 from sfa.util.namespace import urn_to_hrn
  45
  46 # Two years, in seconds
  47 DEFAULT_CREDENTIAL_LIFETIME = 60 * 60 * 24 * 365 * 2
  48
  49
  50 # TODO:
  51 # . make privs match between PG and PL
  52 # . Need to add support for other types of credentials, e.g. tickets
  53
  54
  55 signature_template = \
  56 '''
  57 <Signature xml:id="Sig_%s" xmlns="http://www.w3.org/2000/09/xmldsig#">
  58     <SignedInfo>
  59       <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
  60       <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
  61       <Reference URI="#%s">
  62       <Transforms>
  63         <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
  64       </Transforms>
  65       <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
  66       <DigestValue></DigestValue>
  67       </Reference>
  68     </SignedInfo>
  69     <SignatureValue />
  70       <KeyInfo>
  71         <X509Data>
  72           <X509SubjectName/>
  73           <X509IssuerSerial/>
  74           <X509Certificate/>
  75         </X509Data>
  76       <KeyValue />
  77       </KeyInfo>
  78     </Signature>
  79 '''
  80
  81 ##
  82 # Convert a string into a bool
  83
  84 def str2bool(str):
  85     if str.lower() in ['yes','true','1']:
  86         return True
  87     return False
  88
  89
  90 ##
  91 # Utility function to get the text of an XML element
  92
  93 def getTextNode(element, subele):
  94     sub = element.getElementsByTagName(subele)[0]
  95     if len(sub.childNodes) > 0:
  96         return sub.childNodes[0].nodeValue
  97     else:
  98         return None
  99
 100 ##
 101 # Utility function to set the text of an XML element
 102 # It creates the element, adds the text to it,
 103 # and then appends it to the parent.
 104
 105 def append_sub(doc, parent, element, text):
 106     ele = doc.createElement(element)
 107     ele.appendChild(doc.createTextNode(text))
 108     parent.appendChild(ele)
 109
 110 ##
 111 # Signature contains information about an xmlsec1 signature
 112 # for a signed-credential
 113 #
 114
 115 class Signature(object):
 116
 117     def __init__(self, string=None):
 118         self.refid = None
 119         self.issuer_gid = None
 120         self.xml = None
 121         if string:
 122             self.xml = string
 123             self.decode()
 124
 125
 126     def get_refid(self):
 127         if not self.refid:
 128             self.decode()
 129         return self.refid
 130
 131     def get_xml(self):
 132         if not self.xml:
 133             self.encode()
 134         return self.xml
 135
 136     def set_refid(self, id):
 137         self.refid = id
 138
 139     def get_issuer_gid(self):
 140         if not self.gid:
 141             self.decode()
 142         return self.gid
 143
 144     def set_issuer_gid(self, gid):
 145         self.gid = gid
 146
 147     def decode(self):
 148         doc = parseString(self.xml)
 149         sig = doc.getElementsByTagName("Signature")[0]
 150         self.set_refid(sig.getAttribute("xml:id").strip("Sig_"))
 151         keyinfo = sig.getElementsByTagName("X509Data")[0]
 152         szgid = getTextNode(keyinfo, "X509Certificate")
 153         szgid = "-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----" % szgid
 154         self.set_issuer_gid(GID(string=szgid))
 155
 156     def encode(self):
 157         self.xml = signature_template % (self.get_refid(), self.get_refid())
 158
 159
 160 ##
 161 # A credential provides a caller gid with privileges to an object gid.
 162 # A signed credential is signed by the object's authority.
 163 #
 164 # Credentials are encoded in one of two ways.  The legacy style places
 165 # it in the subjectAltName of an X509 certificate.  The new credentials
 166 # are placed in signed XML.
 167 #
 168 # WARNING:
 169 # In general, a signed credential obtained externally should
 170 # not be changed else the signature is no longer valid.  So, once
 171 # you have loaded an existing signed credential, do not call encode() or sign() on it.
 172
 173 def filter_creds_by_caller(creds, caller_hrn):
 174         """
 175         Returns a list of creds who's gid caller matches the
 176         specified caller hrn
 177         """
 178         if not isinstance(creds, list): creds = [creds]
 179         caller_creds = []
 180         for cred in creds:
 181             try:
 182                 tmp_cred = Credential(string=cred)
 183                 if tmp_cred.get_gid_caller().get_hrn() == caller_hrn:
 184                     caller_creds.append(cred)
 185             except: pass
 186         return caller_creds
 187
 188 class Credential(object):
 189
 190     ##
 191     # Create a Credential object
 192     #
 193     # @param create If true, create a blank x509 certificate
 194     # @param subject If subject!=None, create an x509 cert with the subject name
 195     # @param string If string!=None, load the credential from the string
 196     # @param filename If filename!=None, load the credential from the file
 197     # FIXME: create and subject are ignored!
 198     def __init__(self, create=False, subject=None, string=None, filename=None):
 199         self.gidCaller = None
 200         self.gidObject = None
 201         self.expiration = None
 202         self.privileges = None
 203         self.issuer_privkey = None
 204         self.issuer_gid = None
 205         self.issuer_pubkey = None
 206         self.parent = None
 207         self.signature = None
 208         self.xml = None
 209         self.refid = None
 210         self.legacy = None
 211
 212         # Check if this is a legacy credential, translate it if so
 213         if string or filename:
 214             if string:
 215                 str = string
 216             elif filename:
 217                 str = file(filename).read()
 218                 self.filename=filename
 219
 220             if str.strip().startswith("-----"):
 221                 self.legacy = CredentialLegacy(False,string=str)
 222                 self.translate_legacy(str)
 223             else:
 224                 self.xml = str
 225                 self.decode()
 226
 227         # Find an xmlsec1 path
 228         self.xmlsec_path = ''
 229         paths = ['/usr/bin','/usr/local/bin','/bin','/opt/bin','/opt/local/bin']
 230         for path in paths:
 231             if os.path.isfile(path + '/' + 'xmlsec1'):
 232                 self.xmlsec_path = path + '/' + 'xmlsec1'
 233                 break
 234
 235     def get_subject(self):
 236         if not self.gidObject:
 237             self.decode()
 238         return self.gidObject.get_subject()
 239
 240     def get_signature(self):
 241         if not self.signature:
 242             self.decode()
 243         return self.signature
 244
 245     def set_signature(self, sig):
 246         self.signature = sig
 247
 248
 249     ##
 250     # Translate a legacy credential into a new one
 251     #
 252     # @param String of the legacy credential
 253
 254     def translate_legacy(self, str):
 255         legacy = CredentialLegacy(False,string=str)
 256         self.gidCaller = legacy.get_gid_caller()
 257         self.gidObject = legacy.get_gid_object()
 258         lifetime = legacy.get_lifetime()
 259         if not lifetime:
 260             # Default to two years
 261             self.set_lifetime(DEFAULT_CREDENTIAL_LIFETIME)
 262         else:
 263             self.set_lifetime(int(lifetime))
 264         self.lifeTime = legacy.get_lifetime()
 265         self.set_privileges(legacy.get_privileges())
 266         self.get_privileges().delegate_all_privileges(legacy.get_delegate())
 267
 268     ##
 269     # Need the issuer's private key and name
 270     # @param key Keypair object containing the private key of the issuer
 271     # @param gid GID of the issuing authority
 272
 273     def set_issuer_keys(self, privkey, gid):
 274         self.issuer_privkey = privkey
 275         self.issuer_gid = gid
 276
 277
 278     ##
 279     # Set this credential's parent
 280     def set_parent(self, cred):
 281         self.parent = cred
 282         self.updateRefID()
 283
 284     ##
 285     # set the GID of the caller
 286     #
 287     # @param gid GID object of the caller
 288
 289     def set_gid_caller(self, gid):
 290         self.gidCaller = gid
 291         # gid origin caller is the caller's gid by default
 292         self.gidOriginCaller = gid
 293
 294     ##
 295     # get the GID of the object
 296
 297     def get_gid_caller(self):
 298         if not self.gidCaller:
 299             self.decode()
 300         return self.gidCaller
 301
 302     ##
 303     # set the GID of the object
 304     #
 305     # @param gid GID object of the object
 306
 307     def set_gid_object(self, gid):
 308         self.gidObject = gid
 309
 310     ##
 311     # get the GID of the object
 312
 313     def get_gid_object(self):
 314         if not self.gidObject:
 315             self.decode()
 316         return self.gidObject
 317
 318     ##
 319     # set the lifetime of this credential
 320     #
 321     # @param lifetime lifetime of credential
 322     # . if lifeTime is a datetime object, it is used for the expiration time
 323     # . if lifeTime is an integer value, it is considered the number of seconds
 324     #   remaining before expiration
 325
 326     def set_lifetime(self, lifeTime):
 327         if isinstance(lifeTime, int):
 328             self.expiration = datetime.timedelta(seconds=lifeTime) + datetime.datetime.utcnow()
 329         else:
 330             self.expiration = lifeTime
 331
 332     ##
 333     # get the lifetime of the credential (in datetime format)
 334
 335     def get_lifetime(self):
 336         if not self.expiration:
 337             self.decode()
 338         return self.expiration
 339
 340
 341     ##
 342     # set the privileges
 343     #
 344     # @param privs either a comma-separated list of privileges of a Rights object
 345
 346     def set_privileges(self, privs):
 347         if isinstance(privs, str):
 348             self.privileges = Rights(string = privs)
 349         else:
 350             self.privileges = privs
 351
 352
 353     ##
 354     # return the privileges as a Rights object
 355
 356     def get_privileges(self):
 357         if not self.privileges:
 358             self.decode()
 359         return self.privileges
 360
 361     ##
 362     # determine whether the credential allows a particular operation to be
 363     # performed
 364     #
 365     # @param op_name string specifying name of operation ("lookup", "update", etc)
 366
 367     def can_perform(self, op_name):
 368         rights = self.get_privileges()
 369
 370         if not rights:
 371             return False
 372
 373         return rights.can_perform(op_name)
 374
 375
 376     ##
 377     # Encode the attributes of the credential into an XML string
 378     # This should be done immediately before signing the credential.
 379     # WARNING:
 380     # In general, a signed credential obtained externally should
 381     # not be changed else the signature is no longer valid.  So, once
 382     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 383
 384     def encode(self):
 385         # Create the XML document
 386         doc = Document()
 387         signed_cred = doc.createElement("signed-credential")
 388         doc.appendChild(signed_cred)
 389
 390         # Fill in the <credential> bit
 391         cred = doc.createElement("credential")
 392         cred.setAttribute("xml:id", self.get_refid())
 393         signed_cred.appendChild(cred)
 394         append_sub(doc, cred, "type", "privilege")
 395         append_sub(doc, cred, "serial", "8")
 396         append_sub(doc, cred, "owner_gid", self.gidCaller.save_to_string())
 397         append_sub(doc, cred, "owner_urn", self.gidCaller.get_urn())
 398         append_sub(doc, cred, "target_gid", self.gidObject.save_to_string())
 399         append_sub(doc, cred, "target_urn", self.gidObject.get_urn())
 400         append_sub(doc, cred, "uuid", "")
 401         if not self.expiration:
 402             self.set_lifetime(DEFAULT_CREDENTIAL_LIFETIME)
 403         self.expiration = self.expiration.replace(microsecond=0)
 404         append_sub(doc, cred, "expires", self.expiration.isoformat())
 405         privileges = doc.createElement("privileges")
 406         cred.appendChild(privileges)
 407
 408         if self.privileges:
 409             rights = self.get_privileges()
 410             for right in rights.rights:
 411                 priv = doc.createElement("privilege")
 412                 append_sub(doc, priv, "name", right.kind)
 413                 append_sub(doc, priv, "can_delegate", str(right.delegate).lower())
 414                 privileges.appendChild(priv)
 415
 416         # Add the parent credential if it exists
 417         if self.parent:
 418             sdoc = parseString(self.parent.get_xml())
 419             p_cred = doc.importNode(sdoc.getElementsByTagName("credential")[0], True)
 420             p = doc.createElement("parent")
 421             p.appendChild(p_cred)
 422             cred.appendChild(p)
 423
 424
 425         # Create the <signatures> tag
 426         signatures = doc.createElement("signatures")
 427         signed_cred.appendChild(signatures)
 428
 429         # Add any parent signatures
 430         if self.parent:
 431             for cur_cred in self.get_credential_list()[1:]:
 432                 sdoc = parseString(cur_cred.get_signature().get_xml())
 433                 ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 434                 signatures.appendChild(ele)
 435
 436         # Get the finished product
 437         self.xml = doc.toxml()
 438
 439
 440     def save_to_random_tmp_file(self):
 441         fp, filename = mkstemp(suffix='cred', text=True)
 442         fp = os.fdopen(fp, "w")
 443         self.save_to_file(filename, save_parents=True, filep=fp)
 444         return filename
 445
 446     def save_to_file(self, filename, save_parents=True, filep=None):
 447         if not self.xml:
 448             self.encode()
 449         if filep:
 450             f = filep
 451         else:
 452             f = open(filename, "w")
 453         f.write(self.xml)
 454         f.close()
 455         self.filename=filename
 456
 457     def save_to_string(self, save_parents=True):
 458         if not self.xml:
 459             self.encode()
 460         return self.xml
 461
 462     def get_refid(self):
 463         if not self.refid:
 464             self.refid = 'ref0'
 465         return self.refid
 466
 467     def set_refid(self, rid):
 468         self.refid = rid
 469
 470     ##
 471     # Figure out what refids exist, and update this credential's id
 472     # so that it doesn't clobber the others.  Returns the refids of
 473     # the parents.
 474
 475     def updateRefID(self):
 476         if not self.parent:
 477             self.set_refid('ref0')
 478             return []
 479
 480         refs = []
 481
 482         next_cred = self.parent
 483         while next_cred:
 484             refs.append(next_cred.get_refid())
 485             if next_cred.parent:
 486                 next_cred = next_cred.parent
 487             else:
 488                 next_cred = None
 489
 490
 491         # Find a unique refid for this credential
 492         rid = self.get_refid()
 493         while rid in refs:
 494             val = int(rid[3:])
 495             rid = "ref%d" % (val + 1)
 496
 497         # Set the new refid
 498         self.set_refid(rid)
 499
 500         # Return the set of parent credential ref ids
 501         return refs
 502
 503     def get_xml(self):
 504         if not self.xml:
 505             self.encode()
 506         return self.xml
 507
 508     ##
 509     # Sign the XML file created by encode()
 510     #
 511     # WARNING:
 512     # In general, a signed credential obtained externally should
 513     # not be changed else the signature is no longer valid.  So, once
 514     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 515
 516     def sign(self):
 517         if not self.issuer_privkey or not self.issuer_gid:
 518             return
 519         doc = parseString(self.get_xml())
 520         sigs = doc.getElementsByTagName("signatures")[0]
 521
 522         # Create the signature template to be signed
 523         signature = Signature()
 524         signature.set_refid(self.get_refid())
 525         sdoc = parseString(signature.get_xml())
 526         sig_ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 527         sigs.appendChild(sig_ele)
 528
 529         self.xml = doc.toxml()
 530
 531
 532         # Split the issuer GID into multiple certificates if it's a chain
 533         chain = GID(filename=self.issuer_gid)
 534         gid_files = []
 535         while chain:
 536             gid_files.append(chain.save_to_random_tmp_file(False))
 537             if chain.get_parent():
 538                 chain = chain.get_parent()
 539             else:
 540                 chain = None
 541
 542
 543         # Call out to xmlsec1 to sign it
 544         ref = 'Sig_%s' % self.get_refid()
 545         filename = self.save_to_random_tmp_file()
 546         signed = os.popen('%s --sign --node-id "%s" --privkey-pem %s,%s %s' \
 547                  % (self.xmlsec_path, ref, self.issuer_privkey, ",".join(gid_files), filename)).read()
 548         os.remove(filename)
 549
 550         for gid_file in gid_files:
 551             os.remove(gid_file)
 552
 553         self.xml = signed
 554
 555         # This is no longer a legacy credential
 556         if self.legacy:
 557             self.legacy = None
 558
 559         # Update signatures
 560         self.decode()
 561
 562
 563     ##
 564     # Retrieve the attributes of the credential from the XML.
 565     # This is automatically called by the various get_* methods of
 566     # this class and should not need to be called explicitly.
 567
 568     def decode(self):
 569         if not self.xml:
 570             return
 571         doc = parseString(self.xml)
 572         sigs = []
 573         signed_cred = doc.getElementsByTagName("signed-credential")
 574
 575         # Is this a signed-cred or just a cred?
 576         if len(signed_cred) > 0:
 577             cred = signed_cred[0].getElementsByTagName("credential")[0]
 578             signatures = signed_cred[0].getElementsByTagName("signatures")
 579             if len(signatures) > 0:
 580                 sigs = signatures[0].getElementsByTagName("Signature")
 581         else:
 582             cred = doc.getElementsByTagName("credential")[0]
 583
 584
 585         self.set_refid(cred.getAttribute("xml:id"))
 586         self.set_lifetime(parse(getTextNode(cred, "expires")))
 587         self.gidCaller = GID(string=getTextNode(cred, "owner_gid"))
 588         self.gidObject = GID(string=getTextNode(cred, "target_gid"))
 589
 590
 591         # Process privileges
 592         privs = cred.getElementsByTagName("privileges")[0]
 593         rlist = Rights()
 594         for priv in privs.getElementsByTagName("privilege"):
 595             kind = getTextNode(priv, "name")
 596             deleg = str2bool(getTextNode(priv, "can_delegate"))
 597             if kind == '*':
 598                 # Convert * into the default privileges for the credential's type
 599                 _ , type = urn_to_hrn(self.gidObject.get_urn())
 600                 rl = rlist.determine_rights(type, self.gidObject.get_urn())
 601                 for r in rl.rights:
 602                     rlist.add(r)
 603             else:
 604                 rlist.add(Right(kind.strip(), deleg))
 605         self.set_privileges(rlist)
 606
 607
 608         # Is there a parent?
 609         parent = cred.getElementsByTagName("parent")
 610         if len(parent) > 0:
 611             parent_doc = parent[0].getElementsByTagName("credential")[0]
 612             parent_xml = parent_doc.toxml()
 613             self.parent = Credential(string=parent_xml)
 614             self.updateRefID()
 615
 616         # Assign the signatures to the credentials
 617         for sig in sigs:
 618             Sig = Signature(string=sig.toxml())
 619
 620             for cur_cred in self.get_credential_list():
 621                 if cur_cred.get_refid() == Sig.get_refid():
 622                     cur_cred.set_signature(Sig)
 623
 624
 625     ##
 626     # Verify
 627     #   trusted_certs: A list of trusted GID filenames (not GID objects!)
 628     #                  Chaining is not supported within the GIDs by xmlsec1.
 629     #
 630     # Verify that:
 631     # . All of the signatures are valid and that the issuers trace back
 632     #   to trusted roots (performed by xmlsec1)
 633     # . The XML matches the credential schema
 634     # . That the issuer of the credential is the authority in the target's urn
 635     #    . In the case of a delegated credential, this must be true of the root
 636     # . That all of the gids presented in the credential are valid
 637     # . The credential is not expired
 638     #
 639     # -- For Delegates (credentials with parents)
 640     # . The privileges must be a subset of the parent credentials
 641     # . The privileges must have "can_delegate" set for each delegated privilege
 642     # . The target gid must be the same between child and parents
 643     # . The expiry time on the child must be no later than the parent
 644     # . The signer of the child must be the owner of the parent
 645     #
 646     # -- Verify does *NOT*
 647     # . ensure that an xmlrpc client's gid matches a credential gid, that
 648     #   must be done elsewhere
 649     #
 650     # @param trusted_certs: The certificates of trusted CA certificates
 651     def verify(self, trusted_certs):
 652         if not self.xml:
 653             self.decode()
 654
 655 #        trusted_cert_objects = [GID(filename=f) for f in trusted_certs]
 656         trusted_cert_objects = []
 657         ok_trusted_certs = []
 658         for f in trusted_certs:
 659             try:
 660                 # Failures here include unreadable files
 661                 # or non PEM files
 662                 trusted_cert_objects.append(GID(filename=f))
 663                 ok_trusted_certs.append(f)
 664             except Exception, exc:
 665                 sfa_logger().error("Failed to load trusted cert from %s: %r", f, exc)
 666         trusted_certs = ok_trusted_certs
 667
 668         # Use legacy verification if this is a legacy credential
 669         if self.legacy:
 670             self.legacy.verify_chain(trusted_cert_objects)
 671             if self.legacy.client_gid:
 672                 self.legacy.client_gid.verify_chain(trusted_cert_objects)
 673             if self.legacy.object_gid:
 674                 self.legacy.object_gid.verify_chain(trusted_cert_objects)
 675             return True
 676
 677         # make sure it is not expired
 678         if self.get_lifetime() < datetime.datetime.utcnow():
 679             raise CredentialNotVerifiable("Credential expired at %s" % self.expiration.isoformat())
 680
 681         # Verify the signatures
 682         filename = self.save_to_random_tmp_file()
 683         cert_args = " ".join(['--trusted-pem %s' % x for x in trusted_certs])
 684
 685         # Verify the gids of this cred and of its parents
 686         for cur_cred in self.get_credential_list():
 687             cur_cred.get_gid_object().verify_chain(trusted_cert_objects)
 688             cur_cred.get_gid_caller().verify_chain(trusted_cert_objects)
 689
 690         refs = []
 691         refs.append("Sig_%s" % self.get_refid())
 692
 693         parentRefs = self.updateRefID()
 694         for ref in parentRefs:
 695             refs.append("Sig_%s" % ref)
 696
 697         for ref in refs:
 698             verified = os.popen('%s --verify --node-id "%s" %s %s 2>&1' \
 699                             % (self.xmlsec_path, ref, cert_args, filename)).read()
 700             if not verified.strip().startswith("OK"):
 701                 raise CredentialNotVerifiable("xmlsec1 error verifying cert: " + verified)
 702         os.remove(filename)
 703
 704         # Verify the parents (delegation)
 705         if self.parent:
 706             self.verify_parent(self.parent)
 707
 708         # Make sure the issuer is the target's authority
 709         self.verify_issuer()
 710         return True
 711
 712     ##
 713     # Creates a list of the credential and its parents, with the root
 714     # (original delegated credential) as the last item in the list
 715     def get_credential_list(self):
 716         cur_cred = self
 717         list = []
 718         while cur_cred:
 719             list.append(cur_cred)
 720             if cur_cred.parent:
 721                 cur_cred = cur_cred.parent
 722             else:
 723                 cur_cred = None
 724         return list
 725
 726     ##
 727     # Make sure the credential's target gid was signed by (or is the same) the entity that signed
 728     # the original credential or an authority over that namespace.
 729     def verify_issuer(self):
 730         root_cred = self.get_credential_list()[-1]
 731         root_target_gid = root_cred.get_gid_object()
 732         root_cred_signer = root_cred.get_signature().get_issuer_gid()
 733
 734         if root_target_gid.is_signed_by_cert(root_cred_signer):
 735             # cred signer matches target signer, return success
 736             return
 737
 738         root_target_gid_str = root_target_gid.save_to_string()
 739         root_cred_signer_str = root_cred_signer.save_to_string()
 740         if root_target_gid_str == root_cred_signer_str:
 741             # cred signer is target, return success
 742             return
 743
 744         # See if it the signer is an authority over the domain of the target
 745         # Maybe should be (hrn, type) = urn_to_hrn(root_cred_signer.get_urn())
 746         root_cred_signer_type = root_cred_signer.get_type()
 747         if (root_cred_signer_type == 'authority'):
 748             #sfa_logger().debug('Cred signer is an authority')
 749             # signer is an authority, see if target is in authority's domain
 750             hrn = root_cred_signer.get_hrn()
 751             if root_target_gid.get_hrn().startswith(hrn):
 752                 return
 753
 754         # We've required that the credential be signed by an authority
 755         # for that domain. Reasonable and probably correct.
 756         # A looser model would also allow the signer to be an authority
 757         # in my control framework - eg My CA or CH. Even if it is not
 758         # the CH that issued these, eg, user credentials.
 759
 760         # Give up, credential does not pass issuer verification
 761
 762         raise CredentialNotVerifiable("Could not verify credential owned by %s for object %s. Cred signer %s not the trusted authority for Cred target %s" % (self.gidCaller.get_urn(), self.gidObject.get_urn(), root_cred_signer.get_hrn(), root_target_gid.get_hrn()))
 763
 764
 765     ##
 766     # -- For Delegates (credentials with parents) verify that:
 767     # . The privileges must be a subset of the parent credentials
 768     # . The privileges must have "can_delegate" set for each delegated privilege
 769     # . The target gid must be the same between child and parents
 770     # . The expiry time on the child must be no later than the parent
 771     # . The signer of the child must be the owner of the parent
 772     def verify_parent(self, parent_cred):
 773         # make sure the rights given to the child are a subset of the
 774         # parents rights (and check delegate bits)
 775         if not parent_cred.get_privileges().is_superset(self.get_privileges()):
 776             raise ChildRightsNotSubsetOfParent(
 777                 self.parent.get_privileges().save_to_string() + " " +
 778                 self.get_privileges().save_to_string())
 779
 780         # make sure my target gid is the same as the parent's
 781         if not parent_cred.get_gid_object().save_to_string() == \
 782            self.get_gid_object().save_to_string():
 783             raise CredentialNotVerifiable("Target gid not equal between parent and child")
 784
 785         # make sure my expiry time is <= my parent's
 786         if not parent_cred.get_lifetime() >= self.get_lifetime():
 787             raise CredentialNotVerifiable("Delegated credential expires after parent")
 788
 789         # make sure my signer is the parent's caller
 790         if not parent_cred.get_gid_caller().save_to_string(False) == \
 791            self.get_signature().get_issuer_gid().save_to_string(False):
 792             raise CredentialNotVerifiable("Delegated credential not signed by parent caller")
 793
 794         # Recurse
 795         if parent_cred.parent:
 796             parent_cred.verify_parent(parent_cred.parent)
 797
 798
 799     def delegate(self, delegee_gidfile, caller_keyfile, caller_gidfile):
 800         """
 801         Return a delegated copy of this credential, delegated to the
 802         specified gid's user.
 803         """
 804         # get the gid of the object we are delegating
 805         object_gid = self.get_gid_object()
 806         object_hrn = object_gid.get_hrn()
 807
 808         # the hrn of the user who will be delegated to
 809         delegee_gid = GID(filename=delegee_gidfile)
 810         delegee_hrn = delegee_gid.get_hrn()
 811
 812         #user_key = Keypair(filename=keyfile)
 813         #user_hrn = self.get_gid_caller().get_hrn()
 814         subject_string = "%s delegated to %s" % (object_hrn, delegee_hrn)
 815         dcred = Credential(subject=subject_string)
 816         dcred.set_gid_caller(delegee_gid)
 817         dcred.set_gid_object(object_gid)
 818         dcred.set_parent(self)
 819         dcred.set_lifetime(self.get_lifetime())
 820         dcred.set_privileges(self.get_privileges())
 821         dcred.get_privileges().delegate_all_privileges(True)
 822         #dcred.set_issuer_keys(keyfile, delegee_gidfile)
 823         dcred.set_issuer_keys(caller_keyfile, caller_gidfile)
 824         dcred.encode()
 825         dcred.sign()
 826
 827         return dcred
 828
 829     # only informative
 830     def get_filename(self):
 831         return getattr(self,'filename',None)
 832
 833     # @param dump_parents If true, also dump the parent certificates
 834     def dump (self, *args, **kwargs):
 835         print self.dump_string(*args, **kwargs)
 836
 837     def dump_string(self, dump_parents=False):
 838         result=""
 839         result += "CREDENTIAL %s\n" % self.get_subject()
 840         filename=self.get_filename()
 841         if filename: result += "Filename %s\n"%filename
 842         result += "      privs: %s\n" % self.get_privileges().save_to_string()
 843         gidCaller = self.get_gid_caller()
 844         if gidCaller:
 845             result += "  gidCaller:\n"
 846             result += gidCaller.dump_string(8, dump_parents)
 847
 848         gidObject = self.get_gid_object()
 849         if gidObject:
 850             result += "  gidObject:\n"
 851             result += gidObject.dump_string(8, dump_parents)
 852
 853         if self.parent and dump_parents:
 854             result += "PARENT"
 855             result += self.parent.dump_string(dump_parents)
 856         return result
 857