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 import os
  30 from types import StringTypes
  31 import datetime
  32 from StringIO import StringIO
  33 from tempfile import mkstemp
  34 from xml.dom.minidom import Document, parseString
  35
  36 HAVELXML = False
  37 try:
  38     from lxml import etree
  39     HAVELXML = True
  40 except:
  41     pass
  42
  43 from xml.parsers.expat import ExpatError
  44
  45 from sfa.util.faults import CredentialNotVerifiable, ChildRightsNotSubsetOfParent
  46 from sfa.util.sfalogging import logger
  47 from sfa.util.sfatime import utcparse
  48 from sfa.trust.credential_legacy import CredentialLegacy
  49 from sfa.trust.rights import Right, Rights, determine_rights
  50 from sfa.trust.gid import GID
  51 from sfa.util.xrn import urn_to_hrn, hrn_authfor_hrn
  52
  53 # 2 weeks, in seconds
  54 DEFAULT_CREDENTIAL_LIFETIME = 86400 * 31
  55
  56
  57 # TODO:
  58 # . make privs match between PG and PL
  59 # . Need to add support for other types of credentials, e.g. tickets
  60 # . add namespaces to signed-credential element?
  61
  62 signature_template = \
  63 '''
  64 <Signature xml:id="Sig_%s" xmlns="http://www.w3.org/2000/09/xmldsig#">
  65   <SignedInfo>
  66     <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
  67     <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
  68     <Reference URI="#%s">
  69       <Transforms>
  70         <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
  71       </Transforms>
  72       <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
  73       <DigestValue></DigestValue>
  74     </Reference>
  75   </SignedInfo>
  76   <SignatureValue />
  77   <KeyInfo>
  78     <X509Data>
  79       <X509SubjectName/>
  80       <X509IssuerSerial/>
  81       <X509Certificate/>
  82     </X509Data>
  83     <KeyValue />
  84   </KeyInfo>
  85 </Signature>
  86 '''
  87
  88 # PG formats the template (whitespace) slightly differently.
  89 # Note that they don't include the xmlns in the template, but add it later.
  90 # Otherwise the two are equivalent.
  91 #signature_template_as_in_pg = \
  92 #'''
  93 #<Signature xml:id="Sig_%s" >
  94 # <SignedInfo>
  95 #  <CanonicalizationMethod      Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
  96 #  <SignatureMethod      Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
  97 #  <Reference URI="#%s">
  98 #    <Transforms>
  99 #      <Transform         Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
 100 #    </Transforms>
 101 #    <DigestMethod        Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
 102 #    <DigestValue></DigestValue>
 103 #    </Reference>
 104 # </SignedInfo>
 105 # <SignatureValue />
 106 # <KeyInfo>
 107 #  <X509Data >
 108 #   <X509SubjectName/>
 109 #   <X509IssuerSerial/>
 110 #   <X509Certificate/>
 111 #  </X509Data>
 112 #  <KeyValue />
 113 # </KeyInfo>
 114 #</Signature>
 115 #'''
 116
 117 ##
 118 # Convert a string into a bool
 119 # used to convert an xsd:boolean to a Python boolean
 120 def str2bool(str):
 121     if str.lower() in ['true','1']:
 122         return True
 123     return False
 124
 125
 126 ##
 127 # Utility function to get the text of an XML element
 128
 129 def getTextNode(element, subele):
 130     sub = element.getElementsByTagName(subele)[0]
 131     if len(sub.childNodes) > 0:
 132         return sub.childNodes[0].nodeValue
 133     else:
 134         return None
 135
 136 ##
 137 # Utility function to set the text of an XML element
 138 # It creates the element, adds the text to it,
 139 # and then appends it to the parent.
 140
 141 def append_sub(doc, parent, element, text):
 142     ele = doc.createElement(element)
 143     ele.appendChild(doc.createTextNode(text))
 144     parent.appendChild(ele)
 145
 146 ##
 147 # Signature contains information about an xmlsec1 signature
 148 # for a signed-credential
 149 #
 150
 151 class Signature(object):
 152
 153     def __init__(self, string=None):
 154         self.refid = None
 155         self.issuer_gid = None
 156         self.xml = None
 157         if string:
 158             self.xml = string
 159             self.decode()
 160
 161
 162     def get_refid(self):
 163         if not self.refid:
 164             self.decode()
 165         return self.refid
 166
 167     def get_xml(self):
 168         if not self.xml:
 169             self.encode()
 170         return self.xml
 171
 172     def set_refid(self, id):
 173         self.refid = id
 174
 175     def get_issuer_gid(self):
 176         if not self.gid:
 177             self.decode()
 178         return self.gid
 179
 180     def set_issuer_gid(self, gid):
 181         self.gid = gid
 182
 183     def decode(self):
 184         try:
 185             doc = parseString(self.xml)
 186         except ExpatError,e:
 187             logger.log_exc ("Failed to parse credential, %s"%self.xml)
 188             raise
 189         sig = doc.getElementsByTagName("Signature")[0]
 190         self.set_refid(sig.getAttribute("xml:id").strip("Sig_"))
 191         keyinfo = sig.getElementsByTagName("X509Data")[0]
 192         szgid = getTextNode(keyinfo, "X509Certificate")
 193         szgid = "-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----" % szgid
 194         self.set_issuer_gid(GID(string=szgid))
 195
 196     def encode(self):
 197         self.xml = signature_template % (self.get_refid(), self.get_refid())
 198
 199
 200 ##
 201 # A credential provides a caller gid with privileges to an object gid.
 202 # A signed credential is signed by the object's authority.
 203 #
 204 # Credentials are encoded in one of two ways.  The legacy style places
 205 # it in the subjectAltName of an X509 certificate.  The new credentials
 206 # are placed in signed XML.
 207 #
 208 # WARNING:
 209 # In general, a signed credential obtained externally should
 210 # not be changed else the signature is no longer valid.  So, once
 211 # you have loaded an existing signed credential, do not call encode() or sign() on it.
 212
 213 def filter_creds_by_caller(creds, caller_hrn_list):
 214         """
 215         Returns a list of creds who's gid caller matches the
 216         specified caller hrn
 217         """
 218         if not isinstance(creds, list): creds = [creds]
 219         if not isinstance(caller_hrn_list, list):
 220             caller_hrn_list = [caller_hrn_list]
 221         caller_creds = []
 222         for cred in creds:
 223             try:
 224                 tmp_cred = Credential(string=cred)
 225                 if tmp_cred.get_gid_caller().get_hrn() in caller_hrn_list:
 226                     caller_creds.append(cred)
 227             except: pass
 228         return caller_creds
 229
 230 class Credential(object):
 231
 232     ##
 233     # Create a Credential object
 234     #
 235     # @param create If true, create a blank x509 certificate
 236     # @param subject If subject!=None, create an x509 cert with the subject name
 237     # @param string If string!=None, load the credential from the string
 238     # @param filename If filename!=None, load the credential from the file
 239     # FIXME: create and subject are ignored!
 240     def __init__(self, create=False, subject=None, string=None, filename=None):
 241         self.gidCaller = None
 242         self.gidObject = None
 243         self.expiration = None
 244         self.privileges = None
 245         self.issuer_privkey = None
 246         self.issuer_gid = None
 247         self.issuer_pubkey = None
 248         self.parent = None
 249         self.signature = None
 250         self.xml = None
 251         self.refid = None
 252         self.legacy = None
 253
 254         # Check if this is a legacy credential, translate it if so
 255         if string or filename:
 256             if string:
 257                 str = string
 258             elif filename:
 259                 str = file(filename).read()
 260
 261             if str.strip().startswith("-----"):
 262                 self.legacy = CredentialLegacy(False,string=str)
 263                 self.translate_legacy(str)
 264             else:
 265                 self.xml = str
 266                 self.decode()
 267
 268         # Find an xmlsec1 path
 269         self.xmlsec_path = ''
 270         paths = ['/usr/bin','/usr/local/bin','/bin','/opt/bin','/opt/local/bin']
 271         for path in paths:
 272             if os.path.isfile(path + '/' + 'xmlsec1'):
 273                 self.xmlsec_path = path + '/' + 'xmlsec1'
 274                 break
 275         if not self.xmlsec_path:
 276             logger.warn("Could not locate binary for xmlsec1 - SFA will be unable to sign stuff !!")
 277
 278     def get_subject(self):
 279         if not self.gidObject:
 280             self.decode()
 281         return self.gidObject.get_subject()
 282
 283     # sounds like this should be __repr__ instead ??
 284     def get_summary_tostring(self):
 285         if not self.gidObject:
 286             self.decode()
 287         obj = self.gidObject.get_printable_subject()
 288         caller = self.gidCaller.get_printable_subject()
 289         exp = self.get_expiration()
 290         # Summarize the rights too? The issuer?
 291         return "[ Grant %s rights on %s until %s ]" % (caller, obj, exp)
 292
 293     def get_signature(self):
 294         if not self.signature:
 295             self.decode()
 296         return self.signature
 297
 298     def set_signature(self, sig):
 299         self.signature = sig
 300
 301
 302     ##
 303     # Translate a legacy credential into a new one
 304     #
 305     # @param String of the legacy credential
 306
 307     def translate_legacy(self, str):
 308         legacy = CredentialLegacy(False,string=str)
 309         self.gidCaller = legacy.get_gid_caller()
 310         self.gidObject = legacy.get_gid_object()
 311         lifetime = legacy.get_lifetime()
 312         if not lifetime:
 313             self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
 314         else:
 315             self.set_expiration(int(lifetime))
 316         self.lifeTime = legacy.get_lifetime()
 317         self.set_privileges(legacy.get_privileges())
 318         self.get_privileges().delegate_all_privileges(legacy.get_delegate())
 319
 320     ##
 321     # Need the issuer's private key and name
 322     # @param key Keypair object containing the private key of the issuer
 323     # @param gid GID of the issuing authority
 324
 325     def set_issuer_keys(self, privkey, gid):
 326         self.issuer_privkey = privkey
 327         self.issuer_gid = gid
 328
 329
 330     ##
 331     # Set this credential's parent
 332     def set_parent(self, cred):
 333         self.parent = cred
 334         self.updateRefID()
 335
 336     ##
 337     # set the GID of the caller
 338     #
 339     # @param gid GID object of the caller
 340
 341     def set_gid_caller(self, gid):
 342         self.gidCaller = gid
 343         # gid origin caller is the caller's gid by default
 344         self.gidOriginCaller = gid
 345
 346     ##
 347     # get the GID of the object
 348
 349     def get_gid_caller(self):
 350         if not self.gidCaller:
 351             self.decode()
 352         return self.gidCaller
 353
 354     ##
 355     # set the GID of the object
 356     #
 357     # @param gid GID object of the object
 358
 359     def set_gid_object(self, gid):
 360         self.gidObject = gid
 361
 362     ##
 363     # get the GID of the object
 364
 365     def get_gid_object(self):
 366         if not self.gidObject:
 367             self.decode()
 368         return self.gidObject
 369
 370     ##
 371     # Expiration: an absolute UTC time of expiration (as either an int or string or datetime)
 372     #
 373     def set_expiration(self, expiration):
 374         if isinstance(expiration, (int, float)):
 375             self.expiration = datetime.datetime.fromtimestamp(expiration)
 376         elif isinstance (expiration, datetime.datetime):
 377             self.expiration = expiration
 378         elif isinstance (expiration, StringTypes):
 379             self.expiration = utcparse (expiration)
 380         else:
 381             logger.error ("unexpected input type in Credential.set_expiration")
 382
 383
 384     ##
 385     # get the lifetime of the credential (always in datetime format)
 386
 387     def get_expiration(self):
 388         if not self.expiration:
 389             self.decode()
 390         # at this point self.expiration is normalized as a datetime - DON'T call utcparse again
 391         return self.expiration
 392
 393     ##
 394     # For legacy sake
 395     def get_lifetime(self):
 396         return self.get_expiration()
 397
 398     ##
 399     # set the privileges
 400     #
 401     # @param privs either a comma-separated list of privileges of a Rights object
 402
 403     def set_privileges(self, privs):
 404         if isinstance(privs, str):
 405             self.privileges = Rights(string = privs)
 406         else:
 407             self.privileges = privs
 408
 409     ##
 410     # return the privileges as a Rights object
 411
 412     def get_privileges(self):
 413         if not self.privileges:
 414             self.decode()
 415         return self.privileges
 416
 417     ##
 418     # determine whether the credential allows a particular operation to be
 419     # performed
 420     #
 421     # @param op_name string specifying name of operation ("lookup", "update", etc)
 422
 423     def can_perform(self, op_name):
 424         rights = self.get_privileges()
 425
 426         if not rights:
 427             return False
 428
 429         return rights.can_perform(op_name)
 430
 431
 432     ##
 433     # Encode the attributes of the credential into an XML string
 434     # This should be done immediately before signing the credential.
 435     # WARNING:
 436     # In general, a signed credential obtained externally should
 437     # not be changed else the signature is no longer valid.  So, once
 438     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 439
 440     def encode(self):
 441         # Create the XML document
 442         doc = Document()
 443         signed_cred = doc.createElement("signed-credential")
 444
 445 # Declare namespaces
 446 # Note that credential/policy.xsd are really the PG schemas
 447 # in a PL namespace.
 448 # Note that delegation of credentials between the 2 only really works
 449 # cause those schemas are identical.
 450 # Also note these PG schemas talk about PG tickets and CM policies.
 451         signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
 452         signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.planet-lab.org/resources/sfa/credential.xsd")
 453         signed_cred.setAttribute("xsi:schemaLocation", "http://www.planet-lab.org/resources/sfa/ext/policy/1 http://www.planet-lab.org/resources/sfa/ext/policy/1/policy.xsd")
 454
 455 # PG says for those last 2:
 456 #        signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
 457 #        signed_cred.setAttribute("xsi:schemaLocation", "http://www.protogeni.net/resources/credential/ext/policy/1 http://www.protogeni.net/resources/credential/ext/policy/1/policy.xsd")
 458
 459         doc.appendChild(signed_cred)
 460
 461         # Fill in the <credential> bit
 462         cred = doc.createElement("credential")
 463         cred.setAttribute("xml:id", self.get_refid())
 464         signed_cred.appendChild(cred)
 465         append_sub(doc, cred, "type", "privilege")
 466         append_sub(doc, cred, "serial", "8")
 467         append_sub(doc, cred, "owner_gid", self.gidCaller.save_to_string())
 468         append_sub(doc, cred, "owner_urn", self.gidCaller.get_urn())
 469         append_sub(doc, cred, "target_gid", self.gidObject.save_to_string())
 470         append_sub(doc, cred, "target_urn", self.gidObject.get_urn())
 471         append_sub(doc, cred, "uuid", "")
 472         if not self.expiration:
 473             self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
 474         self.expiration = self.expiration.replace(microsecond=0)
 475         append_sub(doc, cred, "expires", self.expiration.isoformat())
 476         privileges = doc.createElement("privileges")
 477         cred.appendChild(privileges)
 478
 479         if self.privileges:
 480             rights = self.get_privileges()
 481             for right in rights.rights:
 482                 priv = doc.createElement("privilege")
 483                 append_sub(doc, priv, "name", right.kind)
 484                 append_sub(doc, priv, "can_delegate", str(right.delegate).lower())
 485                 privileges.appendChild(priv)
 486
 487         # Add the parent credential if it exists
 488         if self.parent:
 489             sdoc = parseString(self.parent.get_xml())
 490             # If the root node is a signed-credential (it should be), then
 491             # get all its attributes and attach those to our signed_cred
 492             # node.
 493             # Specifically, PG and PLadd attributes for namespaces (which is reasonable),
 494             # and we need to include those again here or else their signature
 495             # no longer matches on the credential.
 496             # We expect three of these, but here we copy them all:
 497 #        signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
 498 # and from PG (PL is equivalent, as shown above):
 499 #        signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
 500 #        signed_cred.setAttribute("xsi:schemaLocation", "http://www.protogeni.net/resources/credential/ext/policy/1 http://www.protogeni.net/resources/credential/ext/policy/1/policy.xsd")
 501
 502             # HOWEVER!
 503             # PL now also declares these, with different URLs, so
 504             # the code notices those attributes already existed with
 505             # different values, and complains.
 506             # This happens regularly on delegation now that PG and
 507             # PL both declare the namespace with different URLs.
 508             # If the content ever differs this is a problem,
 509             # but for now it works - different URLs (values in the attributes)
 510             # but the same actual schema, so using the PG schema
 511             # on delegated-to-PL credentials works fine.
 512
 513             # Note: you could also not copy attributes
 514             # which already exist. It appears that both PG and PL
 515             # will actually validate a slicecred with a parent
 516             # signed using PG namespaces and a child signed with PL
 517             # namespaces over the whole thing. But I don't know
 518             # if that is a bug in xmlsec1, an accident since
 519             # the contents of the schemas are the same,
 520             # or something else, but it seems odd. And this works.
 521             parentRoot = sdoc.documentElement
 522             if parentRoot.tagName == "signed-credential" and parentRoot.hasAttributes():
 523                 for attrIx in range(0, parentRoot.attributes.length):
 524                     attr = parentRoot.attributes.item(attrIx)
 525                     # returns the old attribute of same name that was
 526                     # on the credential
 527                     # Below throws InUse exception if we forgot to clone the attribute first
 528                     oldAttr = signed_cred.setAttributeNode(attr.cloneNode(True))
 529                     if oldAttr and oldAttr.value != attr.value:
 530                         msg = "Delegating cred from owner %s to %s over %s replaced attribute %s value '%s' with '%s'" % (self.parent.gidCaller.get_urn(), self.gidCaller.get_urn(), self.gidObject.get_urn(), oldAttr.name, oldAttr.value, attr.value)
 531                         logger.warn(msg)
 532                         #raise CredentialNotVerifiable("Can't encode new valid delegated credential: %s" % msg)
 533
 534             p_cred = doc.importNode(sdoc.getElementsByTagName("credential")[0], True)
 535             p = doc.createElement("parent")
 536             p.appendChild(p_cred)
 537             cred.appendChild(p)
 538         # done handling parent credential
 539
 540         # Create the <signatures> tag
 541         signatures = doc.createElement("signatures")
 542         signed_cred.appendChild(signatures)
 543
 544         # Add any parent signatures
 545         if self.parent:
 546             for cur_cred in self.get_credential_list()[1:]:
 547                 sdoc = parseString(cur_cred.get_signature().get_xml())
 548                 ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 549                 signatures.appendChild(ele)
 550
 551         # Get the finished product
 552         self.xml = doc.toxml()
 553
 554
 555     def save_to_random_tmp_file(self):
 556         fp, filename = mkstemp(suffix='cred', text=True)
 557         fp = os.fdopen(fp, "w")
 558         self.save_to_file(filename, save_parents=True, filep=fp)
 559         return filename
 560
 561     def save_to_file(self, filename, save_parents=True, filep=None):
 562         if not self.xml:
 563             self.encode()
 564         if filep:
 565             f = filep
 566         else:
 567             f = open(filename, "w")
 568         f.write(self.xml)
 569         f.close()
 570
 571     def save_to_string(self, save_parents=True):
 572         if not self.xml:
 573             self.encode()
 574         return self.xml
 575
 576     def get_refid(self):
 577         if not self.refid:
 578             self.refid = 'ref0'
 579         return self.refid
 580
 581     def set_refid(self, rid):
 582         self.refid = rid
 583
 584     ##
 585     # Figure out what refids exist, and update this credential's id
 586     # so that it doesn't clobber the others.  Returns the refids of
 587     # the parents.
 588
 589     def updateRefID(self):
 590         if not self.parent:
 591             self.set_refid('ref0')
 592             return []
 593
 594         refs = []
 595
 596         next_cred = self.parent
 597         while next_cred:
 598             refs.append(next_cred.get_refid())
 599             if next_cred.parent:
 600                 next_cred = next_cred.parent
 601             else:
 602                 next_cred = None
 603
 604
 605         # Find a unique refid for this credential
 606         rid = self.get_refid()
 607         while rid in refs:
 608             val = int(rid[3:])
 609             rid = "ref%d" % (val + 1)
 610
 611         # Set the new refid
 612         self.set_refid(rid)
 613
 614         # Return the set of parent credential ref ids
 615         return refs
 616
 617     def get_xml(self):
 618         if not self.xml:
 619             self.encode()
 620         return self.xml
 621
 622     ##
 623     # Sign the XML file created by encode()
 624     #
 625     # WARNING:
 626     # In general, a signed credential obtained externally should
 627     # not be changed else the signature is no longer valid.  So, once
 628     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 629
 630     def sign(self):
 631         if not self.issuer_privkey or not self.issuer_gid:
 632             return
 633         doc = parseString(self.get_xml())
 634         sigs = doc.getElementsByTagName("signatures")[0]
 635
 636         # Create the signature template to be signed
 637         signature = Signature()
 638         signature.set_refid(self.get_refid())
 639         sdoc = parseString(signature.get_xml())
 640         sig_ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 641         sigs.appendChild(sig_ele)
 642
 643         self.xml = doc.toxml()
 644
 645
 646         # Split the issuer GID into multiple certificates if it's a chain
 647         chain = GID(filename=self.issuer_gid)
 648         gid_files = []
 649         while chain:
 650             gid_files.append(chain.save_to_random_tmp_file(False))
 651             if chain.get_parent():
 652                 chain = chain.get_parent()
 653             else:
 654                 chain = None
 655
 656
 657         # Call out to xmlsec1 to sign it
 658         ref = 'Sig_%s' % self.get_refid()
 659         filename = self.save_to_random_tmp_file()
 660         signed = os.popen('%s --sign --node-id "%s" --privkey-pem %s,%s %s' \
 661                  % (self.xmlsec_path, ref, self.issuer_privkey, ",".join(gid_files), filename)).read()
 662         os.remove(filename)
 663
 664         for gid_file in gid_files:
 665             os.remove(gid_file)
 666
 667         self.xml = signed
 668
 669         # This is no longer a legacy credential
 670         if self.legacy:
 671             self.legacy = None
 672
 673         # Update signatures
 674         self.decode()
 675
 676
 677     ##
 678     # Retrieve the attributes of the credential from the XML.
 679     # This is automatically called by the various get_* methods of
 680     # this class and should not need to be called explicitly.
 681
 682     def decode(self):
 683         if not self.xml:
 684             return
 685         doc = parseString(self.xml)
 686         sigs = []
 687         signed_cred = doc.getElementsByTagName("signed-credential")
 688
 689         # Is this a signed-cred or just a cred?
 690         if len(signed_cred) > 0:
 691             creds = signed_cred[0].getElementsByTagName("credential")
 692             signatures = signed_cred[0].getElementsByTagName("signatures")
 693             if len(signatures) > 0:
 694                 sigs = signatures[0].getElementsByTagName("Signature")
 695         else:
 696             creds = doc.getElementsByTagName("credential")
 697
 698         if creds is None or len(creds) == 0:
 699             # malformed cred file
 700             raise CredentialNotVerifiable("Malformed XML: No credential tag found")
 701
 702         # Just take the first cred if there are more than one
 703         cred = creds[0]
 704
 705         self.set_refid(cred.getAttribute("xml:id"))
 706         self.set_expiration(utcparse(getTextNode(cred, "expires")))
 707         self.gidCaller = GID(string=getTextNode(cred, "owner_gid"))
 708         self.gidObject = GID(string=getTextNode(cred, "target_gid"))
 709
 710
 711         # Process privileges
 712         privs = cred.getElementsByTagName("privileges")[0]
 713         rlist = Rights()
 714         for priv in privs.getElementsByTagName("privilege"):
 715             kind = getTextNode(priv, "name")
 716             deleg = str2bool(getTextNode(priv, "can_delegate"))
 717             if kind == '*':
 718                 # Convert * into the default privileges for the credential's type
 719                 # Each inherits the delegatability from the * above
 720                 _ , type = urn_to_hrn(self.gidObject.get_urn())
 721                 rl = determine_rights(type, self.gidObject.get_urn())
 722                 for r in rl.rights:
 723                     r.delegate = deleg
 724                     rlist.add(r)
 725             else:
 726                 rlist.add(Right(kind.strip(), deleg))
 727         self.set_privileges(rlist)
 728
 729
 730         # Is there a parent?
 731         parent = cred.getElementsByTagName("parent")
 732         if len(parent) > 0:
 733             parent_doc = parent[0].getElementsByTagName("credential")[0]
 734             parent_xml = parent_doc.toxml()
 735             self.parent = Credential(string=parent_xml)
 736             self.updateRefID()
 737
 738         # Assign the signatures to the credentials
 739         for sig in sigs:
 740             Sig = Signature(string=sig.toxml())
 741
 742             for cur_cred in self.get_credential_list():
 743                 if cur_cred.get_refid() == Sig.get_refid():
 744                     cur_cred.set_signature(Sig)
 745
 746
 747     ##
 748     # Verify
 749     #   trusted_certs: A list of trusted GID filenames (not GID objects!)
 750     #                  Chaining is not supported within the GIDs by xmlsec1.
 751     #
 752     #   trusted_certs_required: Should usually be true. Set False means an
 753     #                 empty list of trusted_certs would still let this method pass.
 754     #                 It just skips xmlsec1 verification et al. Only used by some utils
 755     #
 756     # Verify that:
 757     # . All of the signatures are valid and that the issuers trace back
 758     #   to trusted roots (performed by xmlsec1)
 759     # . The XML matches the credential schema
 760     # . That the issuer of the credential is the authority in the target's urn
 761     #    . In the case of a delegated credential, this must be true of the root
 762     # . That all of the gids presented in the credential are valid
 763     #    . Including verifying GID chains, and includ the issuer
 764     # . The credential is not expired
 765     #
 766     # -- For Delegates (credentials with parents)
 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     #
 773     # -- Verify does *NOT*
 774     # . ensure that an xmlrpc client's gid matches a credential gid, that
 775     #   must be done elsewhere
 776     #
 777     # @param trusted_certs: The certificates of trusted CA certificates
 778     def verify(self, trusted_certs=None, schema=None, trusted_certs_required=True):
 779         if not self.xml:
 780             self.decode()
 781
 782         # validate against RelaxNG schema
 783         if HAVELXML and not self.legacy:
 784             if schema and os.path.exists(schema):
 785                 tree = etree.parse(StringIO(self.xml))
 786                 schema_doc = etree.parse(schema)
 787                 xmlschema = etree.XMLSchema(schema_doc)
 788                 if not xmlschema.validate(tree):
 789                     error = xmlschema.error_log.last_error
 790                     message = "%s: %s (line %s)" % (self.get_summary_tostring(), error.message, error.line)
 791                     raise CredentialNotVerifiable(message)
 792
 793         if trusted_certs_required and trusted_certs is None:
 794             trusted_certs = []
 795
 796 #        trusted_cert_objects = [GID(filename=f) for f in trusted_certs]
 797         trusted_cert_objects = []
 798         ok_trusted_certs = []
 799         # If caller explicitly passed in None that means skip cert chain validation.
 800         # Strange and not typical
 801         if trusted_certs is not None:
 802             for f in trusted_certs:
 803                 try:
 804                     # Failures here include unreadable files
 805                     # or non PEM files
 806                     trusted_cert_objects.append(GID(filename=f))
 807                     ok_trusted_certs.append(f)
 808                 except Exception, exc:
 809                     logger.error("Failed to load trusted cert from %s: %r", f, exc)
 810             trusted_certs = ok_trusted_certs
 811
 812         # Use legacy verification if this is a legacy credential
 813         if self.legacy:
 814             self.legacy.verify_chain(trusted_cert_objects)
 815             if self.legacy.client_gid:
 816                 self.legacy.client_gid.verify_chain(trusted_cert_objects)
 817             if self.legacy.object_gid:
 818                 self.legacy.object_gid.verify_chain(trusted_cert_objects)
 819             return True
 820
 821         # make sure it is not expired
 822         if self.get_expiration() < datetime.datetime.utcnow():
 823             raise CredentialNotVerifiable("Credential %s expired at %s" % (self.get_summary_tostring(), self.expiration.isoformat()))
 824
 825         # Verify the signatures
 826         filename = self.save_to_random_tmp_file()
 827         if trusted_certs is not None:
 828             cert_args = " ".join(['--trusted-pem %s' % x for x in trusted_certs])
 829
 830         # If caller explicitly passed in None that means skip cert chain validation.
 831         # - Strange and not typical
 832         if trusted_certs is not None:
 833             # Verify the gids of this cred and of its parents
 834             for cur_cred in self.get_credential_list():
 835                 cur_cred.get_gid_object().verify_chain(trusted_cert_objects)
 836                 cur_cred.get_gid_caller().verify_chain(trusted_cert_objects)
 837
 838         refs = []
 839         refs.append("Sig_%s" % self.get_refid())
 840
 841         parentRefs = self.updateRefID()
 842         for ref in parentRefs:
 843             refs.append("Sig_%s" % ref)
 844
 845         for ref in refs:
 846             # If caller explicitly passed in None that means skip xmlsec1 validation.
 847             # Strange and not typical
 848             if trusted_certs is None:
 849                 break
 850
 851 #            print "Doing %s --verify --node-id '%s' %s %s 2>&1" % \
 852 #                (self.xmlsec_path, ref, cert_args, filename)
 853             verified = os.popen('%s --verify --node-id "%s" %s %s 2>&1' \
 854                             % (self.xmlsec_path, ref, cert_args, filename)).read()
 855             if not verified.strip().startswith("OK"):
 856                 # xmlsec errors have a msg= which is the interesting bit.
 857                 mstart = verified.find("msg=")
 858                 msg = ""
 859                 if mstart > -1 and len(verified) > 4:
 860                     mstart = mstart + 4
 861                     mend = verified.find('\\', mstart)
 862                     msg = verified[mstart:mend]
 863                 raise CredentialNotVerifiable("xmlsec1 error verifying cred %s using Signature ID %s: %s %s" % (self.get_summary_tostring(), ref, msg, verified.strip()))
 864         os.remove(filename)
 865
 866         # Verify the parents (delegation)
 867         if self.parent:
 868             self.verify_parent(self.parent)
 869
 870         # Make sure the issuer is the target's authority, and is
 871         # itself a valid GID
 872         self.verify_issuer(trusted_cert_objects)
 873         return True
 874
 875     ##
 876     # Creates a list of the credential and its parents, with the root
 877     # (original delegated credential) as the last item in the list
 878     def get_credential_list(self):
 879         cur_cred = self
 880         list = []
 881         while cur_cred:
 882             list.append(cur_cred)
 883             if cur_cred.parent:
 884                 cur_cred = cur_cred.parent
 885             else:
 886                 cur_cred = None
 887         return list
 888
 889     ##
 890     # Make sure the credential's target gid (a) was signed by or (b)
 891     # is the same as the entity that signed the original credential,
 892     # or (c) is an authority over the target's namespace.
 893     # Also ensure that the credential issuer / signer itself has a valid
 894     # GID signature chain (signed by an authority with namespace rights).
 895     def verify_issuer(self, trusted_gids):
 896         root_cred = self.get_credential_list()[-1]
 897         root_target_gid = root_cred.get_gid_object()
 898         root_cred_signer = root_cred.get_signature().get_issuer_gid()
 899
 900         # Case 1:
 901         # Allow non authority to sign target and cred about target.
 902         #
 903         # Why do we need to allow non authorities to sign?
 904         # If in the target gid validation step we correctly
 905         # checked that the target is only signed by an authority,
 906         # then this is just a special case of case 3.
 907         # This short-circuit is the common case currently -
 908         # and cause GID validation doesn't check 'authority',
 909         # this allows users to generate valid slice credentials.
 910         if root_target_gid.is_signed_by_cert(root_cred_signer):
 911             # cred signer matches target signer, return success
 912             return
 913
 914         # Case 2:
 915         # Allow someone to sign credential about themeselves. Used?
 916         # If not, remove this.
 917         #root_target_gid_str = root_target_gid.save_to_string()
 918         #root_cred_signer_str = root_cred_signer.save_to_string()
 919         #if root_target_gid_str == root_cred_signer_str:
 920         #    # cred signer is target, return success
 921         #    return
 922
 923         # Case 3:
 924
 925         # root_cred_signer is not the target_gid
 926         # So this is a different gid that we have not verified.
 927         # xmlsec1 verified the cert chain on this already, but
 928         # it hasn't verified that the gid meets the HRN namespace
 929         # requirements.
 930         # Below we'll ensure that it is an authority.
 931         # But we haven't verified that it is _signed by_ an authority
 932         # We also don't know if xmlsec1 requires that cert signers
 933         # are marked as CAs.
 934
 935         # Note that if verify() gave us no trusted_gids then this
 936         # call will fail. So skip it if we have no trusted_gids
 937         if trusted_gids and len(trusted_gids) > 0:
 938             root_cred_signer.verify_chain(trusted_gids)
 939         else:
 940             logger.debug("No trusted gids. Cannot verify that cred signer is signed by a trusted authority. Skipping that check.")
 941
 942         # See if the signer is an authority over the domain of the target.
 943         # There are multiple types of authority - accept them all here
 944         # Maybe should be (hrn, type) = urn_to_hrn(root_cred_signer.get_urn())
 945         root_cred_signer_type = root_cred_signer.get_type()
 946         if (root_cred_signer_type.find('authority') == 0):
 947             #logger.debug('Cred signer is an authority')
 948             # signer is an authority, see if target is in authority's domain
 949             signerhrn = root_cred_signer.get_hrn()
 950             if hrn_authfor_hrn(signerhrn, root_target_gid.get_hrn()):
 951                 return
 952
 953         # We've required that the credential be signed by an authority
 954         # for that domain. Reasonable and probably correct.
 955         # A looser model would also allow the signer to be an authority
 956         # in my control framework - eg My CA or CH. Even if it is not
 957         # the CH that issued these, eg, user credentials.
 958
 959         # Give up, credential does not pass issuer verification
 960
 961         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()))
 962
 963
 964     ##
 965     # -- For Delegates (credentials with parents) verify that:
 966     # . The privileges must be a subset of the parent credentials
 967     # . The privileges must have "can_delegate" set for each delegated privilege
 968     # . The target gid must be the same between child and parents
 969     # . The expiry time on the child must be no later than the parent
 970     # . The signer of the child must be the owner of the parent
 971     def verify_parent(self, parent_cred):
 972         # make sure the rights given to the child are a subset of the
 973         # parents rights (and check delegate bits)
 974         if not parent_cred.get_privileges().is_superset(self.get_privileges()):
 975             raise ChildRightsNotSubsetOfParent(("Parent cred ref %s rights " % parent_cred.get_refid()) +
 976                 self.parent.get_privileges().save_to_string() + (" not superset of delegated cred %s ref %s rights " % (self.get_summary_tostring(), self.get_refid())) +
 977                 self.get_privileges().save_to_string())
 978
 979         # make sure my target gid is the same as the parent's
 980         if not parent_cred.get_gid_object().save_to_string() == \
 981            self.get_gid_object().save_to_string():
 982             raise CredentialNotVerifiable("Delegated cred %s: Target gid not equal between parent and child. Parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 983
 984         # make sure my expiry time is <= my parent's
 985         if not parent_cred.get_expiration() >= self.get_expiration():
 986             raise CredentialNotVerifiable("Delegated credential %s expires after parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 987
 988         # make sure my signer is the parent's caller
 989         if not parent_cred.get_gid_caller().save_to_string(False) == \
 990            self.get_signature().get_issuer_gid().save_to_string(False):
 991             raise CredentialNotVerifiable("Delegated credential %s not signed by parent %s's caller" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 992
 993         # Recurse
 994         if parent_cred.parent:
 995             parent_cred.verify_parent(parent_cred.parent)
 996
 997
 998     def delegate(self, delegee_gidfile, caller_keyfile, caller_gidfile):
 999         """
1000         Return a delegated copy of this credential, delegated to the
1001         specified gid's user.
1002         """
1003         # get the gid of the object we are delegating
1004         object_gid = self.get_gid_object()
1005         object_hrn = object_gid.get_hrn()
1006
1007         # the hrn of the user who will be delegated to
1008         delegee_gid = GID(filename=delegee_gidfile)
1009         delegee_hrn = delegee_gid.get_hrn()
1010
1011         #user_key = Keypair(filename=keyfile)
1012         #user_hrn = self.get_gid_caller().get_hrn()
1013         subject_string = "%s delegated to %s" % (object_hrn, delegee_hrn)
1014         dcred = Credential(subject=subject_string)
1015         dcred.set_gid_caller(delegee_gid)
1016         dcred.set_gid_object(object_gid)
1017         dcred.set_parent(self)
1018         dcred.set_expiration(self.get_expiration())
1019         dcred.set_privileges(self.get_privileges())
1020         dcred.get_privileges().delegate_all_privileges(True)
1021         #dcred.set_issuer_keys(keyfile, delegee_gidfile)
1022         dcred.set_issuer_keys(caller_keyfile, caller_gidfile)
1023         dcred.encode()
1024         dcred.sign()
1025
1026         return dcred
1027
1028     # only informative
1029     def get_filename(self):
1030         return getattr(self,'filename',None)
1031
1032     ##
1033     # Dump the contents of a credential to stdout in human-readable format
1034     #
1035     # @param dump_parents If true, also dump the parent certificates
1036     def dump (self, *args, **kwargs):
1037         print self.dump_string(*args, **kwargs)
1038
1039
1040     def dump_string(self, dump_parents=False, show_xml=False):
1041         result=""
1042         result += "CREDENTIAL %s\n" % self.get_subject()
1043         filename=self.get_filename()
1044         if filename: result += "Filename %s\n"%filename
1045         result += "      privs: %s\n" % self.get_privileges().save_to_string()
1046         gidCaller = self.get_gid_caller()
1047         if gidCaller:
1048             result += "  gidCaller:\n"
1049             result += gidCaller.dump_string(8, dump_parents)
1050
1051         if self.get_signature():
1052             print "  gidIssuer:"
1053             self.get_signature().get_issuer_gid().dump(8, dump_parents)
1054
1055         gidObject = self.get_gid_object()
1056         if gidObject:
1057             result += "  gidObject:\n"
1058             result += gidObject.dump_string(8, dump_parents)
1059
1060         if self.parent and dump_parents:
1061             result += "\nPARENT"
1062             result += self.parent.dump_string(True)
1063
1064         if show_xml:
1065             try:
1066                 tree = etree.parse(StringIO(self.xml))
1067                 aside = etree.tostring(tree, pretty_print=True)
1068                 result += "\nXML\n"
1069                 result += aside
1070                 result += "\nEnd XML\n"
1071             except:
1072                 import traceback
1073                 print "exc. Credential.dump_string / XML"
1074                 traceback.print_exc()
1075
1076         return result