Merge pull request #22 from its-dirg/saml-metadata-logo

Fix #19: don't assume 'lang' is specified in logo.

Author: RebeckaG

src/satosa/backends/saml2.py

@@ -297,7 +297,7 @@ def get_metadata_desc(self):
                 for name in ui_info.get("display_name", []):
                     ui_info_desc.add_display_name(name["text"], name["lang"])
                 for logo in ui_info.get("logo", []):
-                    ui_info_desc.add_logo(logo["text"], logo["width"], logo["height"], logo["lang"])
+                    ui_info_desc.add_logo(logo["text"], logo["width"], logo["height"], logo.get("lang"))
                 description.ui_info = ui_info_desc
 
             entity_descriptions.append(description)

src/satosa/metadata_creation/description.py

@@ -77,20 +77,24 @@ def add_display_name(self, text, lang):
         """
         self._display_name.append({"text": text, "lang": lang})
 
-    def add_logo(self, text, width, height, lang):
+    def add_logo(self, text, width, height, lang=None):
         """
         Binds a logo to the given language
         :type text: str
         :type width: str
         :type height: str
-        :type lang: str
+        :type lang: Optional[str]
 
         :param text: Path to logo
         :param width: width of logo
         :param height: height of logo
         :param lang: language
         """
-        self._logos.append({"text": text, "width": width, "height": height, "lang": lang})
+
+        logo_entry ={"text": text, "width": width, "height": height}
+        if lang:
+            logo_entry["lang"] = lang
+        self._logos.append(logo_entry)
 
     def to_dict(self):
         """

tests/satosa/backends/test_saml2.py

@@ -205,3 +205,31 @@ def test_get_metadata_desc(self, sp_conf, idp_conf):
         assert ui_info["display_name"] == expected_ui_info["display_name"]
         assert ui_info["description"] == expected_ui_info["description"]
         assert ui_info["logo"] == expected_ui_info["logo"]
+
+    def test_get_metadata_desc_with_logo_without_lang(self, sp_conf, idp_conf):
+        # add logo without 'lang'
+        idp_conf["service"]["idp"]["ui_info"]["logo"] = [{"text": "https://idp.example.com/static/logo.png",
+                                                          "width": "120", "height": "60"}]
+
+        sp_conf["metadata"]["inline"] = [create_metadata_from_config_dict(idp_conf)]
+        # instantiate new backend, with a single backing IdP
+        samlbackend = SAMLBackend(None, INTERNAL_ATTRIBUTES, {"sp_config": sp_conf}, "base_url", "saml_backend")
+        entity_descriptions = samlbackend.get_metadata_desc()
+
+        assert len(entity_descriptions) == 1
+
+        idp_desc = entity_descriptions[0].to_dict()
+
+        assert idp_desc["entityid"] == urlsafe_b64encode(idp_conf["entityid"].encode("utf-8")).decode("utf-8")
+        assert idp_desc["contact_person"] == idp_conf["contact_person"]
+
+        assert idp_desc["organization"]["name"][0] == tuple(idp_conf["organization"]["name"][0])
+        assert idp_desc["organization"]["display_name"][0] == tuple(idp_conf["organization"]["display_name"][0])
+        assert idp_desc["organization"]["url"][0] == tuple(idp_conf["organization"]["url"][0])
+
+        expected_ui_info = idp_conf["service"]["idp"]["ui_info"]
+        ui_info = idp_desc["service"]["idp"]["ui_info"]
+        assert ui_info["display_name"] == expected_ui_info["display_name"]
+        assert ui_info["description"] == expected_ui_info["description"]
+        assert ui_info["logo"] == expected_ui_info["logo"]
+

tests/satosa/metadata_creation/test_description.py

@@ -33,6 +33,14 @@ def test_to_dict(self):
         assert ui_info["display_name"] == [{"text": "my company", "lang": "en"}]
         assert ui_info["logo"] == [{"text": "logo.jpg", "width": 80, "height": 80, "lang": "en"}]
 
+    def test_to_dict_for_logo_without_lang(self):
+        desc = UIInfoDesc()
+        desc.add_logo("logo.jpg", 80, 80, None)
+
+        serialized = desc.to_dict()
+        ui_info = serialized["service"]["idp"]["ui_info"]
+        assert ui_info["logo"] == [{"text": "logo.jpg", "width": 80, "height": 80}]
+
     def test_to_dict_with_empty(self):
         desc = UIInfoDesc()
         assert desc.to_dict() == {}
@@ -69,13 +77,10 @@ def test_to_dict(self):
         contact_desc.sur_name = "Tester"
         contact_desc.add_email_address("[email protected]")
 
-        logo_data = "test data".encode("utf-8")
-
         ui_desc = UIInfoDesc()
         ui_desc.add_description("test", "en")
         ui_desc.add_display_name("my company", "en")
-        with patch("builtins.open", mock_open(read_data=logo_data)):
-            ui_desc.add_logo("logo.jpg", 80, 80, "en")
+        ui_desc.add_logo("http://example.com/logo.jpg", 80, 80, "en")
 
         desc = MetadataDescription("my_entity")
         desc.organization = org_desc