#!/usr/bin/env python from defusedxml.common import EntitiesForbidden from pytest import raises import saml2_data import saml2 from saml2 import class_name from saml2 import create_class_from_xml_string from saml2 import make_vals from saml2 import md from saml2.saml import Attribute from saml2.saml import Issuer from saml2.saml import NameID from saml2.saml import SubjectConfirmation from saml2.saml import SubjectConfirmationData from saml2.saml import SubjectLocality ITEMS = { NameID: [ """ roland@example.com """, """ _1632879f09d08ea5ede2dc667cbed7e429ebc4335c """, """ test """, ], Issuer: """ http://www.example.com/test """, SubjectLocality: """ """, SubjectConfirmationData: """ """, SubjectConfirmation: """ test@example.com """, } # def pytest_generate_tests(metafunc): # if "target_class" in metafunc.funcargnames: # for tcl,xml in ITEMS.items(): # metafunc.addcall(funcargs={"target_class":tcl,"xml_string":xml}) def _eq(l1, l2): return set(l1) == set(l2) def test_create_class_from_xml_string_nameid(): kl = create_class_from_xml_string(NameID, ITEMS[NameID][0]) assert kl != None assert kl.format == "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" assert kl.sp_provided_id == "sp provided id" assert kl.text.strip() == "roland@example.com" assert _eq(kl.keyswv(), ["sp_provided_id", "format", "text"]) assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:NameID" assert _eq(kl.keys(), ["sp_provided_id", "sp_name_qualifier", "name_qualifier", "format", "text"]) kl = create_class_from_xml_string(NameID, ITEMS[NameID][1]) assert kl != None assert kl.format == "urn:oasis:names:tc:SAML:2.0:nameid-format:transient" assert kl.sp_name_qualifier == "https://foo.example.com/sp" assert kl.text.strip() == "_1632879f09d08ea5ede2dc667cbed7e429ebc4335c" assert _eq(kl.keyswv(), ["sp_name_qualifier", "format", "text"]) assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:NameID" kl = create_class_from_xml_string(NameID, ITEMS[NameID][2]) assert kl != None assert kl.format == "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" assert kl.name_qualifier == "http://authentic.example.com/saml/metadata" assert kl.sp_name_qualifier == "http://auth.example.com/saml/metadata" assert kl.text.strip() == "test" assert _eq(kl.keyswv(), ["sp_name_qualifier", "format", "name_qualifier", "text"]) assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:NameID" def test_create_class_from_xml_string_issuer(): kl = create_class_from_xml_string(Issuer, ITEMS[Issuer]) assert kl != None assert kl.text.strip() == "http://www.example.com/test" assert _eq(kl.keyswv(), ["text"]) assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:Issuer" def test_create_class_from_xml_string_subject_locality(): kl = create_class_from_xml_string(SubjectLocality, ITEMS[SubjectLocality]) assert kl != None assert _eq(kl.keyswv(), ["address", "dns_name"]) assert kl.address == "127.0.0.1" assert kl.dns_name == "localhost" assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:SubjectLocality" def test_create_class_from_xml_string_subject_confirmation_data(): kl = create_class_from_xml_string(SubjectConfirmationData, ITEMS[SubjectConfirmationData]) assert kl != None assert _eq(kl.keyswv(), ["in_response_to", "not_on_or_after", "not_before", "recipient"]) assert kl.in_response_to == "_1683146e27983964fbe7bf8f08961108d166a652e5" assert kl.not_on_or_after == "2010-02-18T13:52:13.959Z" assert kl.not_before == "2010-01-16T12:00:00Z" assert kl.recipient == "http://192.168.0.10/saml/sp" assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:SubjectConfirmationData" def test_create_class_from_xml_string_subject_confirmation(): kl = create_class_from_xml_string(SubjectConfirmation, ITEMS[SubjectConfirmation]) assert kl != None assert _eq(kl.keyswv(), ["method", "name_id", "subject_confirmation_data"]) assert kl.method == "urn:oasis:names:tc:SAML:2.0:cm:bearer" name_id = kl.name_id assert _eq(name_id.keyswv(), ["format", "name_qualifier", "text"]) assert name_id.format == "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" assert name_id.name_qualifier == "http://authentic.example.com/saml/metadata" assert name_id.text.strip() == "test@example.com" subject_confirmation_data = kl.subject_confirmation_data assert _eq(subject_confirmation_data.keyswv(), ["not_on_or_after", "recipient", "in_response_to"]) assert subject_confirmation_data.recipient == "http://auth.example.com/saml/proxySingleSignOnRedirect" assert subject_confirmation_data.not_on_or_after == "2010-02-17T17:02:38Z" assert subject_confirmation_data.in_response_to == "_59B3A01B03334032C31E434C63F89E3E" assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:SubjectConfirmation" def test_create_class_from_xml_string_wrong_class_spec(): kl = create_class_from_xml_string(SubjectConfirmationData, ITEMS[SubjectConfirmation]) assert kl == None def test_create_class_from_xml_string_xxe(): xml = """ ]> &lol1; """ with raises(EntitiesForbidden): create_class_from_xml_string(NameID, xml) def test_ee_1(): ee = saml2.extension_element_from_string("""bar""") assert ee != None print(ee.__dict__) assert ee.attributes == {} assert ee.tag == "foo" assert ee.namespace == None assert ee.children == [] assert ee.text == "bar" def test_ee_2(): ee = saml2.extension_element_from_string("""bar""") assert ee != None print(ee.__dict__) assert ee.attributes == {"id": "xyz"} assert ee.tag == "foo" assert ee.namespace == None assert ee.children == [] assert ee.text == "bar" def test_ee_3(): ee = saml2.extension_element_from_string( """ bar""" ) assert ee != None print(ee.__dict__) assert ee.attributes == {"id": "xyz"} assert ee.tag == "foo" assert ee.namespace == "urn:mace:example.com:saml:ns" assert ee.children == [] assert ee.text == "bar" def test_ee_4(): ee = saml2.extension_element_from_string( """ xyztre""" ) assert ee != None print(ee.__dict__) assert ee.attributes == {} assert ee.tag == "foo" assert ee.namespace == "urn:mace:example.com:saml:ns" assert len(ee.children) == 2 assert ee.text.strip() == "" cid = ee.find_children("id", "urn:mace:example.com:saml:namespace") assert cid == [] ids = ee.find_children("id", "urn:mace:example.com:saml:ns") assert ids != [] cid = ids[0] print(cid.__dict__) assert cid.attributes == {} assert cid.tag == "id" assert cid.namespace == "urn:mace:example.com:saml:ns" assert cid.children == [] assert cid.text.strip() == "xyz" def test_ee_5(): ee = saml2.extension_element_from_string( """ bar""" ) ce = saml2.extension_element_from_string( """ rev""" ) ee.children.append(ce) assert ee != None print(ee.__dict__) assert ee.attributes == {} assert ee.tag == "foo" assert ee.namespace == "urn:mace:example.com:saml:ns" assert len(ee.children) == 1 assert ee.text.strip() == "bar" c = ee.children[0] print(c.__dict__) child = ee.find_children(namespace="urn:mace:example.com:saml:cu") assert len(child) == 1 child = ee.find_children(namespace="urn:mace:example.com:saml:ns") assert len(child) == 0 child = ee.find_children("educause", "urn:mace:example.com:saml:cu") assert len(child) == 1 child = ee.find_children("edugain", "urn:mace:example.com:saml:cu") assert len(child) == 0 print(ee.to_string()) def test_ee_6(): ee = saml2.extension_element_from_string( """ bar""" ) ce = saml2.extension_element_from_string( """ rev""" ) et = ee.transfer_to_element_tree() ce.become_child_element_of(et) pee = saml2._extension_element_from_element_tree(et) assert pee != None print(pee.__dict__) assert pee.attributes == {} assert pee.tag == "foo" assert pee.namespace == "urn:mace:example.com:saml:ns" assert len(pee.children) == 1 assert pee.text.strip() == "bar" c = pee.children[0] print(c.__dict__) child = pee.find_children(namespace="urn:mace:example.com:saml:cu") assert len(child) == 1 child = pee.find_children(namespace="urn:mace:example.com:saml:ns") assert len(child) == 0 child = pee.find_children("educause", "urn:mace:example.com:saml:cu") assert len(child) == 1 child = pee.find_children("edugain", "urn:mace:example.com:saml:cu") assert len(child) == 0 print(pee.to_string()) NAMEID_WITH_ATTRIBUTE_EXTENSION = """ roland@example.com """ def test_nameid_with_extension(): kl = create_class_from_xml_string(NameID, NAMEID_WITH_ATTRIBUTE_EXTENSION) assert kl != None print(kl.__dict__) assert kl.format == "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" assert kl.sp_provided_id == "sp provided id" assert kl.text.strip() == "roland@example.com" assert _eq(kl.keyswv(), ["sp_provided_id", "format", "extension_attributes", "text"]) assert class_name(kl) == "urn:oasis:names:tc:SAML:2.0:assertion:NameID" assert _eq(kl.keys(), ["sp_provided_id", "sp_name_qualifier", "name_qualifier", "format", "text"]) assert kl.extension_attributes == {"{urn:mace:example.com:saml:assertion}Foo": "BAR"} SUBJECT_CONFIRMATION_WITH_MEMBER_EXTENSION = """ test@example.com Excellent """ def test_subject_confirmation_with_extension(): kl = create_class_from_xml_string(SubjectConfirmation, SUBJECT_CONFIRMATION_WITH_MEMBER_EXTENSION) assert kl != None print(kl.__dict__) assert kl.extension_attributes == {} assert kl.method == "urn:oasis:names:tc:SAML:2.0:cm:bearer" name_id = kl.name_id assert _eq(name_id.keyswv(), ["format", "name_qualifier", "text"]) assert name_id.format == "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" assert name_id.name_qualifier == "http://authentic.example.com/saml/metadata" assert name_id.text.strip() == "test@example.com" subject_confirmation_data = kl.subject_confirmation_data assert _eq(subject_confirmation_data.keyswv(), ["not_on_or_after", "recipient", "in_response_to"]) assert subject_confirmation_data.recipient == "http://auth.example.com/saml/proxySingleSignOnRedirect" assert subject_confirmation_data.not_on_or_after == "2010-02-17T17:02:38Z" assert subject_confirmation_data.in_response_to == "_59B3A01B03334032C31E434C63F89E3E" assert len(kl.extension_elements) == 1 ee = kl.extension_elements[0] assert ee.tag == "Trustlevel" assert ee.namespace == "urn:mace:example.com:saml:assertion" assert ee.text.strip() == "Excellent" def test_to_fro_string_1(): kl = create_class_from_xml_string(SubjectConfirmation, SUBJECT_CONFIRMATION_WITH_MEMBER_EXTENSION) txt = kl.to_string() cpy = create_class_from_xml_string(SubjectConfirmation, txt) print(kl.__dict__) print(cpy.__dict__) assert kl.text.strip() == cpy.text.strip() assert _eq(kl.keyswv(), cpy.keyswv()) assert len(kl.extension_elements) == len(cpy.extension_elements) klee = kl.extension_elements[0] cpyee = cpy.extension_elements[0] assert klee.text.strip() == cpyee.text.strip() assert klee.tag == cpyee.tag assert klee.namespace == cpyee.namespace def test_make_vals_str(): kl = make_vals("Jeter", md.GivenName, part=True) assert isinstance(kl, md.GivenName) assert kl.text == "Jeter" def test_make_vals_list_of_strs(): cp = md.ContactPerson() make_vals(["Derek", "Sanderson"], md.GivenName, cp, "given_name") assert len(cp.given_name) == 2 assert _eq([i.text for i in cp.given_name], ["Sanderson", "Derek"]) def test_attribute_element_to_extension_element(): attr = create_class_from_xml_string(Attribute, saml2_data.TEST_ATTRIBUTE) ee = saml2.element_to_extension_element(attr) print(ee.__dict__) assert ee.tag == "Attribute" assert ee.namespace == "urn:oasis:names:tc:SAML:2.0:assertion" assert _eq(ee.attributes.keys(), ["FriendlyName", "Name", "NameFormat"]) assert ee.attributes["FriendlyName"] == "test attribute" assert ee.attributes["Name"] == "testAttribute" assert ee.attributes["NameFormat"] == "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" assert len(ee.children) == 2 for child in ee.children: # children are also extension element instances assert child.namespace == "urn:oasis:names:tc:SAML:2.0:assertion" assert child.tag == "AttributeValue" def test_ee_7(): ee = saml2.extension_element_from_string( """ http://federationX.org https://federationX.org/?ID=a87s76a5765da76576a57as """ ) print(ee.__dict__) assert len(ee.children) == 2 for child in ee.children: assert child.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert _eq(["AssertingEntity", "RetrievalEndpoint"], [c.tag for c in ee.children]) aes = [c for c in ee.children if c.tag == "AssertingEntity"] assert len(aes) == 1 assert len(aes[0].children) == 1 assert _eq(aes[0].attributes.keys(), []) nid = aes[0].children[0] assert nid.tag == "NameID" assert nid.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert len(nid.children) == 0 assert _eq(nid.attributes.keys(), ["Format"]) assert nid.text.strip() == "http://federationX.org" def test_ee_xxe(): xml = """ ]> &lol1; """ with raises(EntitiesForbidden): saml2.extension_element_from_string(xml) def test_extension_element_loadd(): ava = { "attributes": {}, "tag": "ExternalEntityAttributeAuthority", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "children": [ { "tag": "AssertingEntity", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "children": [ { "tag": "NameID", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "text": "http://federationX.org", "attributes": {"Format": "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"}, } ], }, { "tag": "RetrievalEndpoint", "namespace": "urn:oasis:names:tc:SAML:metadata" ":dynamicsaml", "text": "https://federationX.org/?ID=a87s76a5765da76576a57as", }, ], } ee = saml2.ExtensionElement(ava["tag"]).loadd(ava) print(ee.__dict__) assert len(ee.children) == 2 for child in ee.children: assert child.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert _eq(["AssertingEntity", "RetrievalEndpoint"], [c.tag for c in ee.children]) aes = [c for c in ee.children if c.tag == "AssertingEntity"] assert len(aes) == 1 assert len(aes[0].children) == 1 assert _eq(aes[0].attributes.keys(), []) nid = aes[0].children[0] assert nid.tag == "NameID" assert nid.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert len(nid.children) == 0 assert _eq(nid.attributes.keys(), ["Format"]) assert nid.text.strip() == "http://federationX.org" def test_extensions_loadd(): ava = { "extension_elements": [ { "attributes": {}, "tag": "ExternalEntityAttributeAuthority", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "children": [ { "tag": "AssertingEntity", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "children": [ { "tag": "NameID", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "text": "http://federationX.org", "attributes": {"Format": "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"}, } ], }, { "tag": "RetrievalEndpoint", "namespace": "urn:oasis:names:tc:SAML:metadata:dynamicsaml", "text": "https://federationX.org/?ID=a87s76a5765da76576a57as", }, ], } ], "extension_attributes": { "foo": "bar", }, } extension = saml2.SamlBase() extension.loadd(ava) print(extension.__dict__) assert len(extension.extension_elements) == 1 ee = extension.extension_elements[0] assert len(ee.children) == 2 for child in ee.children: assert child.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert _eq(["AssertingEntity", "RetrievalEndpoint"], [c.tag for c in ee.children]) aes = [c for c in ee.children if c.tag == "AssertingEntity"] assert len(aes) == 1 assert len(aes[0].children) == 1 assert _eq(aes[0].attributes.keys(), []) nid = aes[0].children[0] assert nid.tag == "NameID" assert nid.namespace == "urn:oasis:names:tc:SAML:metadata:dynamicsaml" assert len(nid.children) == 0 assert _eq(nid.attributes.keys(), ["Format"]) assert nid.text.strip() == "http://federationX.org" assert list(extension.extension_attributes.keys()) == ["foo"] assert extension.extension_attributes["foo"] == "bar"