1 #----------------------------------------------------------------------
\r
2 # Copyright (c) 2008 Board of Trustees, Princeton University
\r
4 # Permission is hereby granted, free of charge, to any person obtaining
\r
5 # a copy of this software and/or hardware specification (the "Work") to
\r
6 # deal in the Work without restriction, including without limitation the
\r
7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
\r
8 # and/or sell copies of the Work, and to permit persons to whom the Work
\r
9 # is furnished to do so, subject to the following conditions:
\r
11 # The above copyright notice and this permission notice shall be
\r
12 # included in all copies or substantial portions of the Work.
\r
14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
\r
15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
\r
16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
\r
17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
\r
18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
\r
19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
\r
20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
\r
22 #----------------------------------------------------------------------
\r
24 # Implements SFA Credentials
\r
26 # Credentials are signed XML files that assign a subject gid privileges to an object gid
\r
30 from types import StringTypes
\r
32 from StringIO import StringIO
\r
33 from tempfile import mkstemp
\r
34 from xml.dom.minidom import Document, parseString
\r
38 from lxml import etree
\r
43 from sfa.util.faults import *
\r
44 from sfa.util.sfalogging import logger
\r
45 from sfa.util.sfatime import utcparse
\r
46 from sfa.trust.certificate import Keypair
\r
47 from sfa.trust.credential_legacy import CredentialLegacy
\r
48 from sfa.trust.rights import Right, Rights, determine_rights
\r
49 from sfa.trust.gid import GID
\r
50 from sfa.util.xrn import urn_to_hrn, hrn_authfor_hrn
\r
52 # 2 weeks, in seconds
\r
53 DEFAULT_CREDENTIAL_LIFETIME = 86400 * 14
\r
57 # . make privs match between PG and PL
\r
58 # . Need to add support for other types of credentials, e.g. tickets
\r
59 # . add namespaces to signed-credential element?
\r
61 signature_template = \
\r
63 <Signature xml:id="Sig_%s" xmlns="http://www.w3.org/2000/09/xmldsig#">
\r
65 <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
\r
66 <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
\r
67 <Reference URI="#%s">
\r
69 <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
\r
71 <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
\r
72 <DigestValue></DigestValue>
\r
87 # PG formats the template (whitespace) slightly differently.
\r
88 # Note that they don't include the xmlns in the template, but add it later.
\r
89 # Otherwise the two are equivalent.
\r
90 #signature_template_as_in_pg = \
\r
92 #<Signature xml:id="Sig_%s" >
\r
94 # <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
\r
95 # <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
\r
96 # <Reference URI="#%s">
\r
98 # <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
\r
100 # <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
\r
101 # <DigestValue></DigestValue>
\r
104 # <SignatureValue />
\r
107 # <X509SubjectName/>
\r
108 # <X509IssuerSerial/>
\r
109 # <X509Certificate/>
\r
117 # Convert a string into a bool
\r
118 # used to convert an xsd:boolean to a Python boolean
\r
120 if str.lower() in ['true','1']:
\r
126 # Utility function to get the text of an XML element
\r
128 def getTextNode(element, subele):
\r
129 sub = element.getElementsByTagName(subele)[0]
\r
130 if len(sub.childNodes) > 0:
\r
131 return sub.childNodes[0].nodeValue
\r
136 # Utility function to set the text of an XML element
\r
137 # It creates the element, adds the text to it,
\r
138 # and then appends it to the parent.
\r
140 def append_sub(doc, parent, element, text):
\r
141 ele = doc.createElement(element)
\r
142 ele.appendChild(doc.createTextNode(text))
\r
143 parent.appendChild(ele)
\r
146 # Signature contains information about an xmlsec1 signature
\r
147 # for a signed-credential
\r
150 class Signature(object):
\r
152 def __init__(self, string=None):
\r
154 self.issuer_gid = None
\r
161 def get_refid(self):
\r
171 def set_refid(self, id):
\r
174 def get_issuer_gid(self):
\r
179 def set_issuer_gid(self, gid):
\r
184 doc = parseString(self.xml)
\r
185 except ExpatError,e:
\r
186 logger.log_exc ("Failed to parse credential, %s"%self.xml)
\r
188 sig = doc.getElementsByTagName("Signature")[0]
\r
189 self.set_refid(sig.getAttribute("xml:id").strip("Sig_"))
\r
190 keyinfo = sig.getElementsByTagName("X509Data")[0]
\r
191 szgid = getTextNode(keyinfo, "X509Certificate")
\r
192 szgid = "-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----" % szgid
\r
193 self.set_issuer_gid(GID(string=szgid))
\r
196 self.xml = signature_template % (self.get_refid(), self.get_refid())
\r
200 # A credential provides a caller gid with privileges to an object gid.
\r
201 # A signed credential is signed by the object's authority.
\r
203 # Credentials are encoded in one of two ways. The legacy style places
\r
204 # it in the subjectAltName of an X509 certificate. The new credentials
\r
205 # are placed in signed XML.
\r
208 # In general, a signed credential obtained externally should
\r
209 # not be changed else the signature is no longer valid. So, once
\r
210 # you have loaded an existing signed credential, do not call encode() or sign() on it.
\r
212 def filter_creds_by_caller(creds, caller_hrn_list):
\r
214 Returns a list of creds who's gid caller matches the
\r
215 specified caller hrn
\r
217 if not isinstance(creds, list): creds = [creds]
\r
218 if not isinstance(caller_hrn_list, list):
\r
219 caller_hrn_list = [caller_hrn_list]
\r
223 tmp_cred = Credential(string=cred)
\r
224 if tmp_cred.get_gid_caller().get_hrn() in caller_hrn_list:
\r
225 caller_creds.append(cred)
\r
227 return caller_creds
\r
229 class Credential(object):
\r
232 # Create a Credential object
\r
234 # @param create If true, create a blank x509 certificate
\r
235 # @param subject If subject!=None, create an x509 cert with the subject name
\r
236 # @param string If string!=None, load the credential from the string
\r
237 # @param filename If filename!=None, load the credential from the file
\r
238 # FIXME: create and subject are ignored!
\r
239 def __init__(self, create=False, subject=None, string=None, filename=None):
\r
240 self.gidCaller = None
\r
241 self.gidObject = None
\r
242 self.expiration = None
\r
243 self.privileges = None
\r
244 self.issuer_privkey = None
\r
245 self.issuer_gid = None
\r
246 self.issuer_pubkey = None
\r
248 self.signature = None
\r
253 # Check if this is a legacy credential, translate it if so
\r
254 if string or filename:
\r
258 str = file(filename).read()
\r
260 if str.strip().startswith("-----"):
\r
261 self.legacy = CredentialLegacy(False,string=str)
\r
262 self.translate_legacy(str)
\r
267 # Find an xmlsec1 path
\r
268 self.xmlsec_path = ''
\r
269 paths = ['/usr/bin','/usr/local/bin','/bin','/opt/bin','/opt/local/bin']
\r
271 if os.path.isfile(path + '/' + 'xmlsec1'):
\r
272 self.xmlsec_path = path + '/' + 'xmlsec1'
\r
275 def get_subject(self):
\r
276 if not self.gidObject:
\r
278 return self.gidObject.get_printable_subject()
\r
280 def get_summary_tostring(self):
\r
281 if not self.gidObject:
\r
283 obj = self.gidObject.get_printable_subject()
\r
284 caller = self.gidCaller.get_printable_subject()
\r
285 exp = self.get_expiration()
\r
286 # Summarize the rights too? The issuer?
\r
287 return "[ Grant %s rights on %s until %s ]" % (caller, obj, exp)
\r
289 def get_signature(self):
\r
290 if not self.signature:
\r
292 return self.signature
\r
294 def set_signature(self, sig):
\r
295 self.signature = sig
\r
299 # Translate a legacy credential into a new one
\r
301 # @param String of the legacy credential
\r
303 def translate_legacy(self, str):
\r
304 legacy = CredentialLegacy(False,string=str)
\r
305 self.gidCaller = legacy.get_gid_caller()
\r
306 self.gidObject = legacy.get_gid_object()
\r
307 lifetime = legacy.get_lifetime()
\r
309 self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
\r
311 self.set_expiration(int(lifetime))
\r
312 self.lifeTime = legacy.get_lifetime()
\r
313 self.set_privileges(legacy.get_privileges())
\r
314 self.get_privileges().delegate_all_privileges(legacy.get_delegate())
\r
317 # Need the issuer's private key and name
\r
318 # @param key Keypair object containing the private key of the issuer
\r
319 # @param gid GID of the issuing authority
\r
321 def set_issuer_keys(self, privkey, gid):
\r
322 self.issuer_privkey = privkey
\r
323 self.issuer_gid = gid
\r
327 # Set this credential's parent
\r
328 def set_parent(self, cred):
\r
333 # set the GID of the caller
\r
335 # @param gid GID object of the caller
\r
337 def set_gid_caller(self, gid):
\r
338 self.gidCaller = gid
\r
339 # gid origin caller is the caller's gid by default
\r
340 self.gidOriginCaller = gid
\r
343 # get the GID of the object
\r
345 def get_gid_caller(self):
\r
346 if not self.gidCaller:
\r
348 return self.gidCaller
\r
351 # set the GID of the object
\r
353 # @param gid GID object of the object
\r
355 def set_gid_object(self, gid):
\r
356 self.gidObject = gid
\r
359 # get the GID of the object
\r
361 def get_gid_object(self):
\r
362 if not self.gidObject:
\r
364 return self.gidObject
\r
369 # Expiration: an absolute UTC time of expiration (as either an int or string or datetime)
\r
371 def set_expiration(self, expiration):
\r
372 if isinstance(expiration, (int, float)):
\r
373 self.expiration = datetime.datetime.fromtimestamp(expiration)
\r
374 elif isinstance (expiration, datetime.datetime):
\r
375 self.expiration = expiration
\r
376 elif isinstance (expiration, StringTypes):
\r
377 self.expiration = utcparse (expiration)
\r
379 logger.error ("unexpected input type in Credential.set_expiration")
\r
383 # get the lifetime of the credential (always in datetime format)
\r
385 def get_expiration(self):
\r
386 if not self.expiration:
\r
388 # at this point self.expiration is normalized as a datetime - DON'T call utcparse again
\r
389 return self.expiration
\r
393 def get_lifetime(self):
\r
394 return self.get_expiration()
\r
397 # set the privileges
\r
399 # @param privs either a comma-separated list of privileges of a Rights object
\r
401 def set_privileges(self, privs):
\r
402 if isinstance(privs, str):
\r
403 self.privileges = Rights(string = privs)
\r
405 self.privileges = privs
\r
409 # return the privileges as a Rights object
\r
411 def get_privileges(self):
\r
412 if not self.privileges:
\r
414 return self.privileges
\r
417 # determine whether the credential allows a particular operation to be
\r
420 # @param op_name string specifying name of operation ("lookup", "update", etc)
\r
422 def can_perform(self, op_name):
\r
423 rights = self.get_privileges()
\r
428 return rights.can_perform(op_name)
\r
432 # Encode the attributes of the credential into an XML string
\r
433 # This should be done immediately before signing the credential.
\r
435 # In general, a signed credential obtained externally should
\r
436 # not be changed else the signature is no longer valid. So, once
\r
437 # you have loaded an existing signed credential, do not call encode() or sign() on it.
\r
440 # Create the XML document
\r
442 signed_cred = doc.createElement("signed-credential")
\r
444 # Declare namespaces
\r
445 # Note that credential/policy.xsd are really the PG schemas
\r
446 # in a PL namespace.
\r
447 # Note that delegation of credentials between the 2 only really works
\r
448 # cause those schemas are identical.
\r
449 # Also note these PG schemas talk about PG tickets and CM policies.
\r
450 signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
\r
451 signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.planet-lab.org/resources/sfa/credential.xsd")
\r
452 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")
\r
454 # PG says for those last 2:
\r
455 # signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
\r
456 # 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")
\r
458 doc.appendChild(signed_cred)
\r
460 # Fill in the <credential> bit
\r
461 cred = doc.createElement("credential")
\r
462 cred.setAttribute("xml:id", self.get_refid())
\r
463 signed_cred.appendChild(cred)
\r
464 append_sub(doc, cred, "type", "privilege")
\r
465 append_sub(doc, cred, "serial", "8")
\r
466 append_sub(doc, cred, "owner_gid", self.gidCaller.save_to_string())
\r
467 append_sub(doc, cred, "owner_urn", self.gidCaller.get_urn())
\r
468 append_sub(doc, cred, "target_gid", self.gidObject.save_to_string())
\r
469 append_sub(doc, cred, "target_urn", self.gidObject.get_urn())
\r
470 append_sub(doc, cred, "uuid", "")
\r
471 if not self.expiration:
\r
472 self.set_expiration(datetime.datetime.utcnow() + datetime.timedelta(seconds=DEFAULT_CREDENTIAL_LIFETIME))
\r
473 self.expiration = self.expiration.replace(microsecond=0)
\r
474 append_sub(doc, cred, "expires", self.expiration.isoformat())
\r
475 privileges = doc.createElement("privileges")
\r
476 cred.appendChild(privileges)
\r
478 if self.privileges:
\r
479 rights = self.get_privileges()
\r
480 for right in rights.rights:
\r
481 priv = doc.createElement("privilege")
\r
482 append_sub(doc, priv, "name", right.kind)
\r
483 append_sub(doc, priv, "can_delegate", str(right.delegate).lower())
\r
484 privileges.appendChild(priv)
\r
486 # Add the parent credential if it exists
\r
488 sdoc = parseString(self.parent.get_xml())
\r
489 # If the root node is a signed-credential (it should be), then
\r
490 # get all its attributes and attach those to our signed_cred
\r
492 # Specifically, PG and PLadd attributes for namespaces (which is reasonable),
\r
493 # and we need to include those again here or else their signature
\r
494 # no longer matches on the credential.
\r
495 # We expect three of these, but here we copy them all:
\r
496 # signed_cred.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
\r
497 # and from PG (PL is equivalent, as shown above):
\r
498 # signed_cred.setAttribute("xsi:noNamespaceSchemaLocation", "http://www.protogeni.net/resources/credential/credential.xsd")
\r
499 # 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")
\r
502 # PL now also declares these, with different URLs, so
\r
503 # the code notices those attributes already existed with
\r
504 # different values, and complains.
\r
505 # This happens regularly on delegation now that PG and
\r
506 # PL both declare the namespace with different URLs.
\r
507 # If the content ever differs this is a problem,
\r
508 # but for now it works - different URLs (values in the attributes)
\r
509 # but the same actual schema, so using the PG schema
\r
510 # on delegated-to-PL credentials works fine.
\r
512 # Note: you could also not copy attributes
\r
513 # which already exist. It appears that both PG and PL
\r
514 # will actually validate a slicecred with a parent
\r
515 # signed using PG namespaces and a child signed with PL
\r
516 # namespaces over the whole thing. But I don't know
\r
517 # if that is a bug in xmlsec1, an accident since
\r
518 # the contents of the schemas are the same,
\r
519 # or something else, but it seems odd. And this works.
\r
520 parentRoot = sdoc.documentElement
\r
521 if parentRoot.tagName == "signed-credential" and parentRoot.hasAttributes():
\r
522 for attrIx in range(0, parentRoot.attributes.length):
\r
523 attr = parentRoot.attributes.item(attrIx)
\r
524 # returns the old attribute of same name that was
\r
525 # on the credential
\r
526 # Below throws InUse exception if we forgot to clone the attribute first
\r
527 oldAttr = signed_cred.setAttributeNode(attr.cloneNode(True))
\r
528 if oldAttr and oldAttr.value != attr.value:
\r
529 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)
\r
531 #raise CredentialNotVerifiable("Can't encode new valid delegated credential: %s" % msg)
\r
533 p_cred = doc.importNode(sdoc.getElementsByTagName("credential")[0], True)
\r
534 p = doc.createElement("parent")
\r
535 p.appendChild(p_cred)
\r
536 cred.appendChild(p)
\r
537 # done handling parent credential
\r
539 # Create the <signatures> tag
\r
540 signatures = doc.createElement("signatures")
\r
541 signed_cred.appendChild(signatures)
\r
543 # Add any parent signatures
\r
545 for cur_cred in self.get_credential_list()[1:]:
\r
546 sdoc = parseString(cur_cred.get_signature().get_xml())
\r
547 ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
\r
548 signatures.appendChild(ele)
\r
550 # Get the finished product
\r
551 self.xml = doc.toxml()
\r
554 def save_to_random_tmp_file(self):
\r
555 fp, filename = mkstemp(suffix='cred', text=True)
\r
556 fp = os.fdopen(fp, "w")
\r
557 self.save_to_file(filename, save_parents=True, filep=fp)
\r
560 def save_to_file(self, filename, save_parents=True, filep=None):
\r
566 f = open(filename, "w")
\r
570 def save_to_string(self, save_parents=True):
\r
575 def get_refid(self):
\r
577 self.refid = 'ref0'
\r
580 def set_refid(self, rid):
\r
584 # Figure out what refids exist, and update this credential's id
\r
585 # so that it doesn't clobber the others. Returns the refids of
\r
588 def updateRefID(self):
\r
589 if not self.parent:
\r
590 self.set_refid('ref0')
\r
595 next_cred = self.parent
\r
597 refs.append(next_cred.get_refid())
\r
598 if next_cred.parent:
\r
599 next_cred = next_cred.parent
\r
604 # Find a unique refid for this credential
\r
605 rid = self.get_refid()
\r
608 rid = "ref%d" % (val + 1)
\r
610 # Set the new refid
\r
611 self.set_refid(rid)
\r
613 # Return the set of parent credential ref ids
\r
622 # Sign the XML file created by encode()
\r
625 # In general, a signed credential obtained externally should
\r
626 # not be changed else the signature is no longer valid. So, once
\r
627 # you have loaded an existing signed credential, do not call encode() or sign() on it.
\r
630 if not self.issuer_privkey or not self.issuer_gid:
\r
632 doc = parseString(self.get_xml())
\r
633 sigs = doc.getElementsByTagName("signatures")[0]
\r
635 # Create the signature template to be signed
\r
636 signature = Signature()
\r
637 signature.set_refid(self.get_refid())
\r
638 sdoc = parseString(signature.get_xml())
\r
639 sig_ele = doc.importNode(sdoc.getElementsByTagName("Signature")[0], True)
\r
640 sigs.appendChild(sig_ele)
\r
642 self.xml = doc.toxml()
\r
645 # Split the issuer GID into multiple certificates if it's a chain
\r
646 chain = GID(filename=self.issuer_gid)
\r
649 gid_files.append(chain.save_to_random_tmp_file(False))
\r
650 if chain.get_parent():
\r
651 chain = chain.get_parent()
\r
656 # Call out to xmlsec1 to sign it
\r
657 ref = 'Sig_%s' % self.get_refid()
\r
658 filename = self.save_to_random_tmp_file()
\r
659 signed = os.popen('%s --sign --node-id "%s" --privkey-pem %s,%s %s' \
\r
660 % (self.xmlsec_path, ref, self.issuer_privkey, ",".join(gid_files), filename)).read()
\r
661 os.remove(filename)
\r
663 for gid_file in gid_files:
\r
664 os.remove(gid_file)
\r
668 # This is no longer a legacy credential
\r
672 # Update signatures
\r
677 # Retrieve the attributes of the credential from the XML.
\r
678 # This is automatically called by the various get_* methods of
\r
679 # this class and should not need to be called explicitly.
\r
684 doc = parseString(self.xml)
\r
686 signed_cred = doc.getElementsByTagName("signed-credential")
\r
688 # Is this a signed-cred or just a cred?
\r
689 if len(signed_cred) > 0:
\r
690 creds = signed_cred[0].getElementsByTagName("credential")
\r
691 signatures = signed_cred[0].getElementsByTagName("signatures")
\r
692 if len(signatures) > 0:
\r
693 sigs = signatures[0].getElementsByTagName("Signature")
\r
695 creds = doc.getElementsByTagName("credential")
\r
697 if creds is None or len(creds) == 0:
\r
698 # malformed cred file
\r
699 raise CredentialNotVerifiable("Malformed XML: No credential tag found")
\r
701 # Just take the first cred if there are more than one
\r
704 self.set_refid(cred.getAttribute("xml:id"))
\r
705 self.set_expiration(utcparse(getTextNode(cred, "expires")))
\r
706 self.gidCaller = GID(string=getTextNode(cred, "owner_gid"))
\r
707 self.gidObject = GID(string=getTextNode(cred, "target_gid"))
\r
710 # Process privileges
\r
711 privs = cred.getElementsByTagName("privileges")[0]
\r
713 for priv in privs.getElementsByTagName("privilege"):
\r
714 kind = getTextNode(priv, "name")
\r
715 deleg = str2bool(getTextNode(priv, "can_delegate"))
\r
717 # Convert * into the default privileges for the credential's type
\r
718 # Each inherits the delegatability from the * above
\r
719 _ , type = urn_to_hrn(self.gidObject.get_urn())
\r
720 rl = determine_rights(type, self.gidObject.get_urn())
\r
721 for r in rl.rights:
\r
725 rlist.add(Right(kind.strip(), deleg))
\r
726 self.set_privileges(rlist)
\r
729 # Is there a parent?
\r
730 parent = cred.getElementsByTagName("parent")
\r
731 if len(parent) > 0:
\r
732 parent_doc = parent[0].getElementsByTagName("credential")[0]
\r
733 parent_xml = parent_doc.toxml()
\r
734 self.parent = Credential(string=parent_xml)
\r
737 # Assign the signatures to the credentials
\r
739 Sig = Signature(string=sig.toxml())
\r
741 for cur_cred in self.get_credential_list():
\r
742 if cur_cred.get_refid() == Sig.get_refid():
\r
743 cur_cred.set_signature(Sig)
\r
748 # trusted_certs: A list of trusted GID filenames (not GID objects!)
\r
749 # Chaining is not supported within the GIDs by xmlsec1.
\r
751 # trusted_certs_required: Should usually be true. Set False means an
\r
752 # empty list of trusted_certs would still let this method pass.
\r
753 # It just skips xmlsec1 verification et al. Only used by some utils
\r
756 # . All of the signatures are valid and that the issuers trace back
\r
757 # to trusted roots (performed by xmlsec1)
\r
758 # . The XML matches the credential schema
\r
759 # . That the issuer of the credential is the authority in the target's urn
\r
760 # . In the case of a delegated credential, this must be true of the root
\r
761 # . That all of the gids presented in the credential are valid
\r
762 # . Including verifying GID chains, and includ the issuer
\r
763 # . The credential is not expired
\r
765 # -- For Delegates (credentials with parents)
\r
766 # . The privileges must be a subset of the parent credentials
\r
767 # . The privileges must have "can_delegate" set for each delegated privilege
\r
768 # . The target gid must be the same between child and parents
\r
769 # . The expiry time on the child must be no later than the parent
\r
770 # . The signer of the child must be the owner of the parent
\r
772 # -- Verify does *NOT*
\r
773 # . ensure that an xmlrpc client's gid matches a credential gid, that
\r
774 # must be done elsewhere
\r
776 # @param trusted_certs: The certificates of trusted CA certificates
\r
777 def verify(self, trusted_certs=None, schema=None, trusted_certs_required=True):
\r
781 # validate against RelaxNG schema
\r
782 if HAVELXML and not self.legacy:
\r
783 if schema and os.path.exists(schema):
\r
784 tree = etree.parse(StringIO(self.xml))
\r
785 schema_doc = etree.parse(schema)
\r
786 xmlschema = etree.XMLSchema(schema_doc)
\r
787 if not xmlschema.validate(tree):
\r
788 error = xmlschema.error_log.last_error
\r
789 message = "%s: %s (line %s)" % (self.get_summary_tostring(), error.message, error.line)
\r
790 raise CredentialNotVerifiable(message)
\r
792 if trusted_certs_required and trusted_certs is None:
\r
795 # trusted_cert_objects = [GID(filename=f) for f in trusted_certs]
\r
796 trusted_cert_objects = []
\r
797 ok_trusted_certs = []
\r
798 # If caller explicitly passed in None that means skip cert chain validation.
\r
799 # Strange and not typical
\r
800 if trusted_certs is not None:
\r
801 for f in trusted_certs:
\r
803 # Failures here include unreadable files
\r
805 trusted_cert_objects.append(GID(filename=f))
\r
806 ok_trusted_certs.append(f)
\r
807 except Exception, exc:
\r
808 logger.error("Failed to load trusted cert from %s: %r", f, exc)
\r
809 trusted_certs = ok_trusted_certs
\r
811 # Use legacy verification if this is a legacy credential
\r
813 self.legacy.verify_chain(trusted_cert_objects)
\r
814 if self.legacy.client_gid:
\r
815 self.legacy.client_gid.verify_chain(trusted_cert_objects)
\r
816 if self.legacy.object_gid:
\r
817 self.legacy.object_gid.verify_chain(trusted_cert_objects)
\r
820 # make sure it is not expired
\r
821 if self.get_expiration() < datetime.datetime.utcnow():
\r
822 raise CredentialNotVerifiable("Credential %s expired at %s" % (self.get_summary_tostring(), self.expiration.isoformat()))
\r
824 # Verify the signatures
\r
825 filename = self.save_to_random_tmp_file()
\r
826 if trusted_certs is not None:
\r
827 cert_args = " ".join(['--trusted-pem %s' % x for x in trusted_certs])
\r
829 # If caller explicitly passed in None that means skip cert chain validation.
\r
830 # - Strange and not typical
\r
831 if trusted_certs is not None:
\r
832 # Verify the gids of this cred and of its parents
\r
833 for cur_cred in self.get_credential_list():
\r
834 cur_cred.get_gid_object().verify_chain(trusted_cert_objects)
\r
835 cur_cred.get_gid_caller().verify_chain(trusted_cert_objects)
\r
838 refs.append("Sig_%s" % self.get_refid())
\r
840 parentRefs = self.updateRefID()
\r
841 for ref in parentRefs:
\r
842 refs.append("Sig_%s" % ref)
\r
845 # If caller explicitly passed in None that means skip xmlsec1 validation.
\r
846 # Strange and not typical
\r
847 if trusted_certs is None:
\r
850 # print "Doing %s --verify --node-id '%s' %s %s 2>&1" % \
\r
851 # (self.xmlsec_path, ref, cert_args, filename)
\r
852 verified = os.popen('%s --verify --node-id "%s" %s %s 2>&1' \
\r
853 % (self.xmlsec_path, ref, cert_args, filename)).read()
\r
854 if not verified.strip().startswith("OK"):
\r
855 # xmlsec errors have a msg= which is the interesting bit.
\r
856 mstart = verified.find("msg=")
\r
858 if mstart > -1 and len(verified) > 4:
\r
859 mstart = mstart + 4
\r
860 mend = verified.find('\\', mstart)
\r
861 msg = verified[mstart:mend]
\r
862 raise CredentialNotVerifiable("xmlsec1 error verifying cred %s using Signature ID %s: %s %s" % (self.get_summary_tostring(), ref, msg, verified.strip()))
\r
863 os.remove(filename)
\r
865 # Verify the parents (delegation)
\r
867 self.verify_parent(self.parent)
\r
869 # Make sure the issuer is the target's authority, and is
\r
870 # itself a valid GID
\r
871 self.verify_issuer(trusted_cert_objects)
\r
875 # Creates a list of the credential and its parents, with the root
\r
876 # (original delegated credential) as the last item in the list
\r
877 def get_credential_list(self):
\r
881 list.append(cur_cred)
\r
882 if cur_cred.parent:
\r
883 cur_cred = cur_cred.parent
\r
889 # Make sure the credential's target gid (a) was signed by or (b)
\r
890 # is the same as the entity that signed the original credential,
\r
891 # or (c) is an authority over the target's namespace.
\r
892 # Also ensure that the credential issuer / signer itself has a valid
\r
893 # GID signature chain (signed by an authority with namespace rights).
\r
894 def verify_issuer(self, trusted_gids):
\r
895 root_cred = self.get_credential_list()[-1]
\r
896 root_target_gid = root_cred.get_gid_object()
\r
897 root_cred_signer = root_cred.get_signature().get_issuer_gid()
\r
900 # Allow non authority to sign target and cred about target.
\r
902 # Why do we need to allow non authorities to sign?
\r
903 # If in the target gid validation step we correctly
\r
904 # checked that the target is only signed by an authority,
\r
905 # then this is just a special case of case 3.
\r
906 # This short-circuit is the common case currently -
\r
907 # and cause GID validation doesn't check 'authority',
\r
908 # this allows users to generate valid slice credentials.
\r
909 if root_target_gid.is_signed_by_cert(root_cred_signer):
\r
910 # cred signer matches target signer, return success
\r
914 # Allow someone to sign credential about themeselves. Used?
\r
915 # If not, remove this.
\r
916 #root_target_gid_str = root_target_gid.save_to_string()
\r
917 #root_cred_signer_str = root_cred_signer.save_to_string()
\r
918 #if root_target_gid_str == root_cred_signer_str:
\r
919 # # cred signer is target, return success
\r
924 # root_cred_signer is not the target_gid
\r
925 # So this is a different gid that we have not verified.
\r
926 # xmlsec1 verified the cert chain on this already, but
\r
927 # it hasn't verified that the gid meets the HRN namespace
\r
929 # Below we'll ensure that it is an authority.
\r
930 # But we haven't verified that it is _signed by_ an authority
\r
931 # We also don't know if xmlsec1 requires that cert signers
\r
932 # are marked as CAs.
\r
934 # Note that if verify() gave us no trusted_gids then this
\r
935 # call will fail. So skip it if we have no trusted_gids
\r
936 if trusted_gids and len(trusted_gids) > 0:
\r
937 root_cred_signer.verify_chain(trusted_gids)
\r
939 logger.debug("No trusted gids. Cannot verify that cred signer is signed by a trusted authority. Skipping that check.")
\r
941 # See if the signer is an authority over the domain of the target.
\r
942 # There are multiple types of authority - accept them all here
\r
943 # Maybe should be (hrn, type) = urn_to_hrn(root_cred_signer.get_urn())
\r
944 root_cred_signer_type = root_cred_signer.get_type()
\r
945 if (root_cred_signer_type.find('authority') == 0):
\r
946 #logger.debug('Cred signer is an authority')
\r
947 # signer is an authority, see if target is in authority's domain
\r
948 signerhrn = root_cred_signer.get_hrn()
\r
949 if hrn_authfor_hrn(signerhrn, root_target_gid.get_hrn()):
\r
952 # We've required that the credential be signed by an authority
\r
953 # for that domain. Reasonable and probably correct.
\r
954 # A looser model would also allow the signer to be an authority
\r
955 # in my control framework - eg My CA or CH. Even if it is not
\r
956 # the CH that issued these, eg, user credentials.
\r
958 # Give up, credential does not pass issuer verification
\r
960 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()))
\r
964 # -- For Delegates (credentials with parents) verify that:
\r
965 # . The privileges must be a subset of the parent credentials
\r
966 # . The privileges must have "can_delegate" set for each delegated privilege
\r
967 # . The target gid must be the same between child and parents
\r
968 # . The expiry time on the child must be no later than the parent
\r
969 # . The signer of the child must be the owner of the parent
\r
970 def verify_parent(self, parent_cred):
\r
971 # make sure the rights given to the child are a subset of the
\r
972 # parents rights (and check delegate bits)
\r
973 if not parent_cred.get_privileges().is_superset(self.get_privileges()):
\r
974 raise ChildRightsNotSubsetOfParent(("Parent cred ref %s rights " % parent_cred.get_refid()) +
\r
975 self.parent.get_privileges().save_to_string() + (" not superset of delegated cred %s ref %s rights " % (self.get_summary_tostring(), self.get_refid())) +
\r
976 self.get_privileges().save_to_string())
\r
978 # make sure my target gid is the same as the parent's
\r
979 if not parent_cred.get_gid_object().save_to_string() == \
\r
980 self.get_gid_object().save_to_string():
\r
981 raise CredentialNotVerifiable("Delegated cred %s: Target gid not equal between parent and child. Parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
\r
983 # make sure my expiry time is <= my parent's
\r
984 if not parent_cred.get_expiration() >= self.get_expiration():
\r
985 raise CredentialNotVerifiable("Delegated credential %s expires after parent %s" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
\r
987 # make sure my signer is the parent's caller
\r
988 if not parent_cred.get_gid_caller().save_to_string(False) == \
\r
989 self.get_signature().get_issuer_gid().save_to_string(False):
\r
990 raise CredentialNotVerifiable("Delegated credential %s not signed by parent %s's caller" % (self.get_summary_tostring(), parent_cred.get_summary_tostring()))
\r
993 if parent_cred.parent:
\r
994 parent_cred.verify_parent(parent_cred.parent)
\r
997 def delegate(self, delegee_gidfile, caller_keyfile, caller_gidfile):
\r
999 Return a delegated copy of this credential, delegated to the
\r
1000 specified gid's user.
\r
1002 # get the gid of the object we are delegating
\r
1003 object_gid = self.get_gid_object()
\r
1004 object_hrn = object_gid.get_hrn()
\r
1006 # the hrn of the user who will be delegated to
\r
1007 delegee_gid = GID(filename=delegee_gidfile)
\r
1008 delegee_hrn = delegee_gid.get_hrn()
\r
1010 #user_key = Keypair(filename=keyfile)
\r
1011 #user_hrn = self.get_gid_caller().get_hrn()
\r
1012 subject_string = "%s delegated to %s" % (object_hrn, delegee_hrn)
\r
1013 dcred = Credential(subject=subject_string)
\r
1014 dcred.set_gid_caller(delegee_gid)
\r
1015 dcred.set_gid_object(object_gid)
\r
1016 dcred.set_parent(self)
\r
1017 dcred.set_expiration(self.get_expiration())
\r
1018 dcred.set_privileges(self.get_privileges())
\r
1019 dcred.get_privileges().delegate_all_privileges(True)
\r
1020 #dcred.set_issuer_keys(keyfile, delegee_gidfile)
\r
1021 dcred.set_issuer_keys(caller_keyfile, caller_gidfile)
\r
1027 # only informative
\r
1028 def get_filename(self):
\r
1029 return getattr(self,'filename',None)
\r
1032 # Dump the contents of a credential to stdout in human-readable format
\r
1034 # @param dump_parents If true, also dump the parent certificates
\r
1035 def dump (self, *args, **kwargs):
\r
1036 print self.dump_string(*args, **kwargs)
\r
1039 def dump_string(self, dump_parents=False):
\r
1041 result += "CREDENTIAL %s\n" % self.get_subject()
\r
1042 filename=self.get_filename()
\r
1043 if filename: result += "Filename %s\n"%filename
\r
1044 result += " privs: %s\n" % self.get_privileges().save_to_string()
\r
1045 gidCaller = self.get_gid_caller()
\r
1047 result += " gidCaller:\n"
\r
1048 result += gidCaller.dump_string(8, dump_parents)
\r
1050 if self.get_signature():
\r
1051 print " gidIssuer:"
\r
1052 self.get_signature().get_issuer_gid().dump(8, dump_parents)
\r
1054 gidObject = self.get_gid_object()
\r
1056 result += " gidObject:\n"
\r
1057 result += gidObject.dump_string(8, dump_parents)
\r
1059 if self.parent and dump_parents:
\r
1060 result += "\nPARENT"
\r
1061 result += self.parent.dump_string(True)
\r