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
 276     def get_subject(self):
 277         if not self.gidObject:
 278             self.decode()
 279         return self.gidObject.get_printable_subject()
 280
 281     # sounds like this should be __repr__ instead ??
 282     def get_summary_tostring(self):
 283         if not self.gidObject:
 284             self.decode()
 285         obj = self.gidObject.get_printable_subject()
 286         caller = self.gidCaller.get_printable_subject()
 287         exp = self.get_expiration()
 288         # Summarize the rights too? The issuer?
 289         return "[ Grant %s rights on %s until %s ]" % (caller, obj, exp)
 290
 291     def get_signature(self):
 292         if not self.signature:
 293             self.decode()
 294         return self.signature
 295
 296     def set_signature(self, sig):
 297         self.signature = sig
 298
 299
 300     ##
 301     # Translate a legacy credential into a new one
 302     #
 303     # @param String of the legacy credential
 304
 305     def translate_legacy(self, str):
 306         legacy = CredentialLegacy(False,string=str)
 307         self.gidCaller = legacy.get_gid_caller()
 308         self.gidObject = legacy.get_gid_object()
 309         lifetime = legacy.get_lifetime()
 310         if not lifetime:
 311             self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
 312         else:
 313             self.set_expiration(int(lifetime))
 314         self.lifeTime = legacy.get_lifetime()
 315         self.set_privileges(legacy.get_privileges())
 316         self.get_privileges().delegate_all_privileges(legacy.get_delegate())
 317
 318     ##
 319     # Need the issuer's private key and name
 320     # @param key Keypair object containing the private key of the issuer
 321     # @param gid GID of the issuing authority
 322
 323     def set_issuer_keys(self, privkey, gid):
 324         self.issuer_privkey = privkey
 325         self.issuer_gid = gid
 326
 327
 328     ##
 329     # Set this credential's parent
 330     def set_parent(self, cred):
 331         self.parent = cred
 332         self.updateRefID()
 333
 334     ##
 335     # set the GID of the caller
 336     #
 337     # @param gid GID object of the caller
 338
 339     def set_gid_caller(self, gid):
 340         self.gidCaller = gid
 341         # gid origin caller is the caller's gid by default
 342         self.gidOriginCaller = gid
 343
 344     ##
 345     # get the GID of the object
 346
 347     def get_gid_caller(self):
 348         if not self.gidCaller:
 349             self.decode()
 350         return self.gidCaller
 351
 352     ##
 353     # set the GID of the object
 354     #
 355     # @param gid GID object of the object
 356
 357     def set_gid_object(self, gid):
 358         self.gidObject = gid
 359
 360     ##
 361     # get the GID of the object
 362
 363     def get_gid_object(self):
 364         if not self.gidObject:
 365             self.decode()
 366         return self.gidObject
 367
 368     ##
 369     # Expiration: an absolute UTC time of expiration (as either an int or string or datetime)
 370     #
 371     def set_expiration(self, expiration):
 372         if isinstance(expiration, (int, float)):
 373             self.expiration = datetime.datetime.fromtimestamp(expiration)
 374         elif isinstance (expiration, datetime.datetime):
 375             self.expiration = expiration
 376         elif isinstance (expiration, StringTypes):
 377             self.expiration = utcparse (expiration)
 378         else:
 379             logger.error ("unexpected input type in Credential.set_expiration")
 380
 381
 382     ##
 383     # get the lifetime of the credential (always in datetime format)
 384
 385     def get_expiration(self):
 386         if not self.expiration:
 387             self.decode()
 388         # at this point self.expiration is normalized as a datetime - DON'T call utcparse again
 389         return self.expiration
 390
 391     ##
 392     # For legacy sake
 393     def get_lifetime(self):
 394         return self.get_expiration()
 395
 396     ##
 397     # set the privileges
 398     #
 399     # @param privs either a comma-separated list of privileges of a Rights object
 400
 401     def set_privileges(self, privs):
 402         if isinstance(privs, str):
 403             self.privileges = Rights(string = privs)
 404         else:
 405             self.privileges = privs
 406
 407     ##
 408     # return the privileges as a Rights object
 409
 410     def get_privileges(self):
 411         if not self.privileges:
 412             self.decode()
 413         return self.privileges
 414
 415     ##
 416     # determine whether the credential allows a particular operation to be
 417     # performed
 418     #
 419     # @param op_name string specifying name of operation ("lookup", "update", etc)
 420
 421     def can_perform(self, op_name):
 422         rights = self.get_privileges()
 423
 424         if not rights:
 425             return False
 426
 427         return rights.can_perform(op_name)
 428
 429
 430     ##
 431     # Encode the attributes of the credential into an XML string
 432     # This should be done immediately before signing the credential.
 433     # WARNING:
 434     # In general, a signed credential obtained externally should
 435     # not be changed else the signature is no longer valid.  So, once
 436     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 437
 438     def encode(self):
 439         # Create the XML document
 440         doc = Document()
 441         signed_cred = doc.createElement("signed-credential")
 442
 443 # Declare namespaces
 444 # Note that credential/policy.xsd are really the PG schemas
 445 # in a PL namespace.
 446 # Note that delegation of credentials between the 2 only really works
 447 # cause those schemas are identical.
 448 # Also note these PG schemas talk about PG tickets and CM policies.
 449         signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
 450         signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.planet-lab.org/resources/sfa/credential.xsd")
 451         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")
 452
 453 # PG says for those last 2:
 454 #        signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
 455 #        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")
 456
 457         doc.appendChild(signed_cred)
 458
 459         # Fill in the <credential> bit
 460         cred = doc.createElement("credential")
 461         cred.setAttribute("xml:id", self.get_refid())
 462         signed_cred.appendChild(cred)
 463         append_sub(doc, cred, "type", "privilege")
 464         append_sub(doc, cred, "serial", "8")
 465         append_sub(doc, cred, "owner_gid", self.gidCaller.save_to_string())
 466         append_sub(doc, cred, "owner_urn", self.gidCaller.get_urn())
 467         append_sub(doc, cred, "target_gid", self.gidObject.save_to_string())
 468         append_sub(doc, cred, "target_urn", self.gidObject.get_urn())
 469         append_sub(doc, cred, "uuid", "")
 470         if not self.expiration:
 471             self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
 472         self.expiration = self.expiration.replace(microsecond=0)
 473         append_sub(doc, cred, "expires", self.expiration.isoformat())
 474         privileges = doc.createElement("privileges")
 475         cred.appendChild(privileges)
 476
 477         if self.privileges:
 478             rights = self.get_privileges()
 479             for right in rights.rights:
 480                 priv = doc.createElement("privilege")
 481                 append_sub(doc, priv, "name", right.kind)
 482                 append_sub(doc, priv, "can_delegate", str(right.delegate).lower())
 483                 privileges.appendChild(priv)
 484
 485         # Add the parent credential if it exists
 486         if self.parent:
 487             sdoc = parseString(self.parent.get_xml())
 488             # If the root node is a signed-credential (it should be), then
 489             # get all its attributes and attach those to our signed_cred
 490             # node.
 491             # Specifically, PG and PLadd attributes for namespaces (which is reasonable),
 492             # and we need to include those again here or else their signature
 493             # no longer matches on the credential.
 494             # We expect three of these, but here we copy them all:
 495 #        signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
 496 # and from PG (PL is equivalent, as shown above):
 497 #        signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
 498 #        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")
 499
 500             # HOWEVER!
 501             # PL now also declares these, with different URLs, so
 502             # the code notices those attributes already existed with
 503             # different values, and complains.
 504             # This happens regularly on delegation now that PG and
 505             # PL both declare the namespace with different URLs.
 506             # If the content ever differs this is a problem,
 507             # but for now it works - different URLs (values in the attributes)
 508             # but the same actual schema, so using the PG schema
 509             # on delegated-to-PL credentials works fine.
 510
 511             # Note: you could also not copy attributes
 512             # which already exist. It appears that both PG and PL
 513             # will actually validate a slicecred with a parent
 514             # signed using PG namespaces and a child signed with PL
 515             # namespaces over the whole thing. But I don't know
 516             # if that is a bug in xmlsec1, an accident since
 517             # the contents of the schemas are the same,
 518             # or something else, but it seems odd. And this works.
 519             parentRoot = sdoc.documentElement
 520             if parentRoot.tagName == "signed-credential" and parentRoot.hasAttributes():
 521                 for attrIx in range(0, parentRoot.attributes.length):
 522                     attr = parentRoot.attributes.item(attrIx)
 523                     # returns the old attribute of same name that was
 524                     # on the credential
 525                     # Below throws InUse exception if we forgot to clone the attribute first
 526                     oldAttr = signed_cred.setAttributeNode(attr.cloneNode(True))
 527                     if oldAttr and oldAttr.value != attr.value:
 528                         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)
 529                         logger.warn(msg)
 530                         #raise CredentialNotVerifiable("Can't encode new valid delegated credential: %s" % msg)
 531
 532             p_cred = doc.importNode(sdoc.getElementsByTagName("credential")[0], True)
 533             p = doc.createElement("parent")
 534             p.appendChild(p_cred)
 535             cred.appendChild(p)
 536         # done handling parent credential
 537
 538         # Create the <signatures> tag
 539         signatures = doc.createElement("signatures")
 540         signed_cred.appendChild(signatures)
 541
 542         # Add any parent signatures
 543         if self.parent:
 544             for cur_cred in self.get_credential_list()[1:]:
 545                 sdoc = parseString(cur_cred.get_signature().get_xml())
 546                 ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 547                 signatures.appendChild(ele)
 548
 549         # Get the finished product
 550         self.xml = doc.toxml()
 551
 552
 553     def save_to_random_tmp_file(self):
 554         fp, filename = mkstemp(suffix='cred', text=True)
 555         fp = os.fdopen(fp, "w")
 556         self.save_to_file(filename, save_parents=True, filep=fp)
 557         return filename
 558
 559     def save_to_file(self, filename, save_parents=True, filep=None):
 560         if not self.xml:
 561             self.encode()
 562         if filep:
 563             f = filep
 564         else:
 565             f = open(filename, "w")
 566         f.write(self.xml)
 567         f.close()
 568
 569     def save_to_string(self, save_parents=True):
 570         if not self.xml:
 571             self.encode()
 572         return self.xml
 573
 574     def get_refid(self):
 575         if not self.refid:
 576             self.refid = 'ref0'
 577         return self.refid
 578
 579     def set_refid(self, rid):
 580         self.refid = rid
 581
 582     ##
 583     # Figure out what refids exist, and update this credential's id
 584     # so that it doesn't clobber the others.  Returns the refids of
 585     # the parents.
 586
 587     def updateRefID(self):
 588         if not self.parent:
 589             self.set_refid('ref0')
 590             return []
 591
 592         refs = []
 593
 594         next_cred = self.parent
 595         while next_cred:
 596             refs.append(next_cred.get_refid())
 597             if next_cred.parent:
 598                 next_cred = next_cred.parent
 599             else:
 600                 next_cred = None
 601
 602
 603         # Find a unique refid for this credential
 604         rid = self.get_refid()
 605         while rid in refs:
 606             val = int(rid[3:])
 607             rid = "ref%d" % (val + 1)
 608
 609         # Set the new refid
 610         self.set_refid(rid)
 611
 612         # Return the set of parent credential ref ids
 613         return refs
 614
 615     def get_xml(self):
 616         if not self.xml:
 617             self.encode()
 618         return self.xml
 619
 620     ##
 621     # Sign the XML file created by encode()
 622     #
 623     # WARNING:
 624     # In general, a signed credential obtained externally should
 625     # not be changed else the signature is no longer valid.  So, once
 626     # you have loaded an existing signed credential, do not call encode() or sign() on it.
 627
 628     def sign(self):
 629         if not self.issuer_privkey or not self.issuer_gid:
 630             return
 631         doc = parseString(self.get_xml())
 632         sigs = doc.getElementsByTagName("signatures")[0]
 633
 634         # Create the signature template to be signed
 635         signature = Signature()
 636         signature.set_refid(self.get_refid())
 637         sdoc = parseString(signature.get_xml())
 638         sig_ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
 639         sigs.appendChild(sig_ele)
 640
 641         self.xml = doc.toxml()
 642
 643
 644         # Split the issuer GID into multiple certificates if it's a chain
 645         chain = GID(filename=self.issuer_gid)
 646         gid_files = []
 647         while chain:
 648             gid_files.append(chain.save_to_random_tmp_file(False))
 649             if chain.get_parent():
 650                 chain = chain.get_parent()
 651             else:
 652                 chain = None
 653
 654
 655         # Call out to xmlsec1 to sign it
 656         ref = 'Sig_%s' % self.get_refid()
 657         filename = self.save_to_random_tmp_file()
 658         signed = os.popen('%s --sign --node-id "%s" --privkey-pem %s,%s %s' \
 659                  % (self.xmlsec_path, ref, self.issuer_privkey, ",".join(gid_files), filename)).read()
 660         os.remove(filename)
 661
 662         for gid_file in gid_files:
 663             os.remove(gid_file)
 664
 665         self.xml = signed
 666
 667         # This is no longer a legacy credential
 668         if self.legacy:
 669             self.legacy = None
 670
 671         # Update signatures
 672         self.decode()
 673
 674
 675     ##
 676     # Retrieve the attributes of the credential from the XML.
 677     # This is automatically called by the various get_* methods of
 678     # this class and should not need to be called explicitly.
 679
 680     def decode(self):
 681         if not self.xml:
 682             return
 683         doc = parseString(self.xml)
 684         sigs = []
 685         signed_cred = doc.getElementsByTagName("signed-credential")
 686
 687         # Is this a signed-cred or just a cred?
 688         if len(signed_cred) > 0:
 689             creds = signed_cred[0].getElementsByTagName("credential")
 690             signatures = signed_cred[0].getElementsByTagName("signatures")
 691             if len(signatures) > 0:
 692                 sigs = signatures[0].getElementsByTagName("Signature")
 693         else:
 694             creds = doc.getElementsByTagName("credential")
 695
 696         if creds is None or len(creds) == 0:
 697             # malformed cred file
 698             raise CredentialNotVerifiable("Malformed XML: No credential tag found")
 699
 700         # Just take the first cred if there are more than one
 701         cred = creds[0]
 702
 703         self.set_refid(cred.getAttribute("xml:id"))
 704         self.set_expiration(utcparse(getTextNode(cred, "expires")))
 705         self.gidCaller = GID(string=getTextNode(cred, "owner_gid"))
 706         self.gidObject = GID(string=getTextNode(cred, "target_gid"))
 707
 708
 709         # Process privileges
 710         privs = cred.getElementsByTagName("privileges")[0]
 711         rlist = Rights()
 712         for priv in privs.getElementsByTagName("privilege"):
 713             kind = getTextNode(priv, "name")
 714             deleg = str2bool(getTextNode(priv, "can_delegate"))
 715             if kind == '*':
 716                 # Convert * into the default privileges for the credential's type
 717                 # Each inherits the delegatability from the * above
 718                 _ , type = urn_to_hrn(self.gidObject.get_urn())
 719                 rl = determine_rights(type, self.gidObject.get_urn())
 720                 for r in rl.rights:
 721                     r.delegate = deleg
 722                     rlist.add(r)
 723             else:
 724                 rlist.add(Right(kind.strip(), deleg))
 725         self.set_privileges(rlist)
 726
 727
 728         # Is there a parent?
 729         parent = cred.getElementsByTagName("parent")
 730         if len(parent) > 0:
 731             parent_doc = parent[0].getElementsByTagName("credential")[0]
 732             parent_xml = parent_doc.toxml()
 733             self.parent = Credential(string=parent_xml)
 734             self.updateRefID()
 735
 736         # Assign the signatures to the credentials
 737         for sig in sigs:
 738             Sig = Signature(string=sig.toxml())
 739
 740             for cur_cred in self.get_credential_list():
 741                 if cur_cred.get_refid() == Sig.get_refid():
 742                     cur_cred.set_signature(Sig)
 743
 744
 745     ##
 746     # Verify
 747     #   trusted_certs: A list of trusted GID filenames (not GID objects!)
 748     #                  Chaining is not supported within the GIDs by xmlsec1.
 749     #
 750     #   trusted_certs_required: Should usually be true. Set False means an
 751     #                 empty list of trusted_certs would still let this method pass.
 752     #                 It just skips xmlsec1 verification et al. Only used by some utils
 753     #
 754     # Verify that:
 755     # . All of the signatures are valid and that the issuers trace back
 756     #   to trusted roots (performed by xmlsec1)
 757     # . The XML matches the credential schema
 758     # . That the issuer of the credential is the authority in the target's urn
 759     #    . In the case of a delegated credential, this must be true of the root
 760     # . That all of the gids presented in the credential are valid
 761     #    . Including verifying GID chains, and includ the issuer
 762     # . The credential is not expired
 763     #
 764     # -- For Delegates (credentials with parents)
 765     # . The privileges must be a subset of the parent credentials
 766     # . The privileges must have "can_delegate" set for each delegated privilege
 767     # . The target gid must be the same between child and parents
 768     # . The expiry time on the child must be no later than the parent
 769     # . The signer of the child must be the owner of the parent
 770     #
 771     # -- Verify does *NOT*
 772     # . ensure that an xmlrpc client's gid matches a credential gid, that
 773     #   must be done elsewhere
 774     #
 775     # @param trusted_certs: The certificates of trusted CA certificates
 776     def verify(self, trusted_certs=None, schema=None, trusted_certs_required=True):
 777         if not self.xml:
 778             self.decode()
 779
 780         # validate against RelaxNG schema
 781         if HAVELXML and not self.legacy:
 782             if schema and os.path.exists(schema):
 783                 tree = etree.parse(StringIO(self.xml))
 784                 schema_doc = etree.parse(schema)
 785                 xmlschema = etree.XMLSchema(schema_doc)
 786                 if not xmlschema.validate(tree):
 787                     error = xmlschema.error_log.last_error
 788                     message = "%s: %s (line %s)" % (self.get_summary_tostring(), error.message, error.line)
 789                     raise CredentialNotVerifiable(message)
 790
 791         if trusted_certs_required and trusted_certs is None:
 792             trusted_certs = []
 793
 794 #        trusted_cert_objects = [GID(filename=f) for f in trusted_certs]
 795         trusted_cert_objects = []
 796         ok_trusted_certs = []
 797         # If caller explicitly passed in None that means skip cert chain validation.
 798         # Strange and not typical
 799         if trusted_certs is not None:
 800             for f in trusted_certs:
 801                 try:
 802                     # Failures here include unreadable files
 803                     # or non PEM files
 804                     trusted_cert_objects.append(GID(filename=f))
 805                     ok_trusted_certs.append(f)
 806                 except Exception, exc:
 807                     logger.error("Failed to load trusted cert from %s: %r", f, exc)
 808             trusted_certs = ok_trusted_certs
 809
 810         # Use legacy verification if this is a legacy credential
 811         if self.legacy:
 812             self.legacy.verify_chain(trusted_cert_objects)
 813             if self.legacy.client_gid:
 814                 self.legacy.client_gid.verify_chain(trusted_cert_objects)
 815             if self.legacy.object_gid:
 816                 self.legacy.object_gid.verify_chain(trusted_cert_objects)
 817             return True
 818
 819         # make sure it is not expired
 820         if self.get_expiration() < datetime.datetime.utcnow():
 821             raise CredentialNotVerifiable("Credential %s expired at %s" % (self.get_summary_tostring(), self.expiration.isoformat()))
 822
 823         # Verify the signatures
 824         filename = self.save_to_random_tmp_file()
 825         if trusted_certs is not None:
 826             cert_args = " ".join(['--trusted-pem %s' % x for x in trusted_certs])
 827
 828         # If caller explicitly passed in None that means skip cert chain validation.
 829         # - Strange and not typical
 830         if trusted_certs is not None:
 831             # Verify the gids of this cred and of its parents
 832             for cur_cred in self.get_credential_list():
 833                 cur_cred.get_gid_object().verify_chain(trusted_cert_objects)
 834                 cur_cred.get_gid_caller().verify_chain(trusted_cert_objects)
 835
 836         refs = []
 837         refs.append("Sig_%s" % self.get_refid())
 838
 839         parentRefs = self.updateRefID()
 840         for ref in parentRefs:
 841             refs.append("Sig_%s" % ref)
 842
 843         for ref in refs:
 844             # If caller explicitly passed in None that means skip xmlsec1 validation.
 845             # Strange and not typical
 846             if trusted_certs is None:
 847                 break
 848
 849 #            print "Doing %s --verify --node-id '%s' %s %s 2>&1" % \
 850 #                (self.xmlsec_path, ref, cert_args, filename)
 851             verified = os.popen('%s --verify --node-id "%s" %s %s 2>&1' \
 852                             % (self.xmlsec_path, ref, cert_args, filename)).read()
 853             if not verified.strip().startswith("OK"):
 854                 # xmlsec errors have a msg= which is the interesting bit.
 855                 mstart = verified.find("msg=")
 856                 msg = ""
 857                 if mstart > -1 and len(verified) > 4:
 858                     mstart = mstart + 4
 859                     mend = verified.find('\\', mstart)
 860                     msg = verified[mstart:mend]
 861                 raise CredentialNotVerifiable("xmlsec1 error verifying cred %s using Signature ID %s: %s %s" % (self.get_summary_tostring(), ref, msg, verified.strip()))
 862         os.remove(filename)
 863
 864         # Verify the parents (delegation)
 865         if self.parent:
 866             self.verify_parent(self.parent)
 867
 868         # Make sure the issuer is the target's authority, and is
 869         # itself a valid GID
 870         self.verify_issuer(trusted_cert_objects)
 871         return True
 872
 873     ##
 874     # Creates a list of the credential and its parents, with the root
 875     # (original delegated credential) as the last item in the list
 876     def get_credential_list(self):
 877         cur_cred = self
 878         list = []
 879         while cur_cred:
 880             list.append(cur_cred)
 881             if cur_cred.parent:
 882                 cur_cred = cur_cred.parent
 883             else:
 884                 cur_cred = None
 885         return list
 886
 887     ##
 888     # Make sure the credential's target gid (a) was signed by or (b)
 889     # is the same as the entity that signed the original credential,
 890     # or (c) is an authority over the target's namespace.
 891     # Also ensure that the credential issuer / signer itself has a valid
 892     # GID signature chain (signed by an authority with namespace rights).
 893     def verify_issuer(self, trusted_gids):
 894         root_cred = self.get_credential_list()[-1]
 895         root_target_gid = root_cred.get_gid_object()
 896         root_cred_signer = root_cred.get_signature().get_issuer_gid()
 897
 898         # Case 1:
 899         # Allow non authority to sign target and cred about target.
 900         #
 901         # Why do we need to allow non authorities to sign?
 902         # If in the target gid validation step we correctly
 903         # checked that the target is only signed by an authority,
 904         # then this is just a special case of case 3.
 905         # This short-circuit is the common case currently -
 906         # and cause GID validation doesn't check 'authority',
 907         # this allows users to generate valid slice credentials.
 908         if root_target_gid.is_signed_by_cert(root_cred_signer):
 909             # cred signer matches target signer, return success
 910             return
 911
 912         # Case 2:
 913         # Allow someone to sign credential about themeselves. Used?
 914         # If not, remove this.
 915         #root_target_gid_str = root_target_gid.save_to_string()
 916         #root_cred_signer_str = root_cred_signer.save_to_string()
 917         #if root_target_gid_str == root_cred_signer_str:
 918         #    # cred signer is target, return success
 919         #    return
 920
 921         # Case 3:
 922
 923         # root_cred_signer is not the target_gid
 924         # So this is a different gid that we have not verified.
 925         # xmlsec1 verified the cert chain on this already, but
 926         # it hasn't verified that the gid meets the HRN namespace
 927         # requirements.
 928         # Below we'll ensure that it is an authority.
 929         # But we haven't verified that it is _signed by_ an authority
 930         # We also don't know if xmlsec1 requires that cert signers
 931         # are marked as CAs.
 932
 933         # Note that if verify() gave us no trusted_gids then this
 934         # call will fail. So skip it if we have no trusted_gids
 935         if trusted_gids and len(trusted_gids) > 0:
 936             root_cred_signer.verify_chain(trusted_gids)
 937         else:
 938             logger.debug("No trusted gids. Cannot verify that cred signer is signed by a trusted authority. Skipping that check.")
 939
 940         # See if the signer is an authority over the domain of the target.
 941         # There are multiple types of authority - accept them all here
 942         # Maybe should be (hrn, type) = urn_to_hrn(root_cred_signer.get_urn())
 943         root_cred_signer_type = root_cred_signer.get_type()
 944         if (root_cred_signer_type.find('authority') == 0):
 945             #logger.debug('Cred signer is an authority')
 946             # signer is an authority, see if target is in authority's domain
 947             signerhrn = root_cred_signer.get_hrn()
 948             if hrn_authfor_hrn(signerhrn, root_target_gid.get_hrn()):
 949                 return
 950
 951         # We've required that the credential be signed by an authority
 952         # for that domain. Reasonable and probably correct.
 953         # A looser model would also allow the signer to be an authority
 954         # in my control framework - eg My CA or CH. Even if it is not
 955         # the CH that issued these, eg, user credentials.
 956
 957         # Give up, credential does not pass issuer verification
 958
 959         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()))
 960
 961
 962     ##
 963     # -- For Delegates (credentials with parents) verify that:
 964     # . The privileges must be a subset of the parent credentials
 965     # . The privileges must have "can_delegate" set for each delegated privilege
 966     # . The target gid must be the same between child and parents
 967     # . The expiry time on the child must be no later than the parent
 968     # . The signer of the child must be the owner of the parent
 969     def verify_parent(self, parent_cred):
 970         # make sure the rights given to the child are a subset of the
 971         # parents rights (and check delegate bits)
 972         if not parent_cred.get_privileges().is_superset(self.get_privileges()):
 973             raise ChildRightsNotSubsetOfParent(("Parent cred ref %s rights " % parent_cred.get_refid()) +
 974                 self.parent.get_privileges().save_to_string() + (" not superset of delegated cred %s ref %s rights " % (self.get_summary_tostring(), self.get_refid())) +
 975                 self.get_privileges().save_to_string())
 976
 977         # make sure my target gid is the same as the parent's
 978         if not parent_cred.get_gid_object().save_to_string() == \
 979            self.get_gid_object().save_to_string():
 980             raise CredentialNotVerifiable("Delegated cred %s: Target gid not equal between parent and child. Parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 981
 982         # make sure my expiry time is <= my parent's
 983         if not parent_cred.get_expiration() >= self.get_expiration():
 984             raise CredentialNotVerifiable("Delegated credential %s expires after parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 985
 986         # make sure my signer is the parent's caller
 987         if not parent_cred.get_gid_caller().save_to_string(False) == \
 988            self.get_signature().get_issuer_gid().save_to_string(False):
 989             raise CredentialNotVerifiable("Delegated credential %s not signed by parent %s's caller" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
 990
 991         # Recurse
 992         if parent_cred.parent:
 993             parent_cred.verify_parent(parent_cred.parent)
 994
 995
 996     def delegate(self, delegee_gidfile, caller_keyfile, caller_gidfile):
 997         """
 998         Return a delegated copy of this credential, delegated to the
 999         specified gid's user.
1000         """
1001         # get the gid of the object we are delegating
1002         object_gid = self.get_gid_object()
1003         object_hrn = object_gid.get_hrn()
1004
1005         # the hrn of the user who will be delegated to
1006         delegee_gid = GID(filename=delegee_gidfile)
1007         delegee_hrn = delegee_gid.get_hrn()
1008
1009         #user_key = Keypair(filename=keyfile)
1010         #user_hrn = self.get_gid_caller().get_hrn()
1011         subject_string = "%s delegated to %s" % (object_hrn, delegee_hrn)
1012         dcred = Credential(subject=subject_string)
1013         dcred.set_gid_caller(delegee_gid)
1014         dcred.set_gid_object(object_gid)
1015         dcred.set_parent(self)
1016         dcred.set_expiration(self.get_expiration())
1017         dcred.set_privileges(self.get_privileges())
1018         dcred.get_privileges().delegate_all_privileges(True)
1019         #dcred.set_issuer_keys(keyfile, delegee_gidfile)
1020         dcred.set_issuer_keys(caller_keyfile, caller_gidfile)
1021         dcred.encode()
1022         dcred.sign()
1023
1024         return dcred
1025
1026     # only informative
1027     def get_filename(self):
1028         return getattr(self,'filename',None)
1029
1030     ##
1031     # Dump the contents of a credential to stdout in human-readable format
1032     #
1033     # @param dump_parents If true, also dump the parent certificates
1034     def dump (self, *args, **kwargs):
1035         print self.dump_string(*args, **kwargs)
1036
1037
1038     def dump_string(self, dump_parents=False):
1039         result=""
1040         result += "CREDENTIAL %s\n" % self.get_subject()
1041         filename=self.get_filename()
1042         if filename: result += "Filename %s\n"%filename
1043         result += "      privs: %s\n" % self.get_privileges().save_to_string()
1044         gidCaller = self.get_gid_caller()
1045         if gidCaller:
1046             result += "  gidCaller:\n"
1047             result += gidCaller.dump_string(8, dump_parents)
1048
1049         if self.get_signature():
1050             print "  gidIssuer:"
1051             self.get_signature().get_issuer_gid().dump(8, dump_parents)
1052
1053         gidObject = self.get_gid_object()
1054         if gidObject:
1055             result += "  gidObject:\n"
1056             result += gidObject.dump_string(8, dump_parents)
1057
1058         if self.parent and dump_parents:
1059             result += "\nPARENT"
1060             result += self.parent.dump_string(True)
1061
1062         return result