Completes the support for the mdui:UIInfo element

Adds:

- keywords
- information_url
- privacy_statement_url

Author: skanct

src/satosa/backends/oauth.py

@@ -319,6 +319,14 @@ def get_metadata_desc_for_oauth_backend(entity_id, config):
                 ui_description.add_display_name(name[0], name[1])
             for logo in ui_info.get("logo", []):
                 ui_description.add_logo(logo["image"], logo["width"], logo["height"], logo["lang"])
+            for keywords in ui_info.get("keywords", []):
+                ui_description.add_keywords(keywords.get("text", []), keywords.get("lang"))
+            for information_url in ui_info.get("information_url", []):
+                ui_description.add_information_url(information_url.get("text"), information_url.get("lang"))
+            for privacy_statement_url in ui_info.get("privacy_statement_url", []):
+                ui_description.add_information_url(
+                    privacy_statement_url.get("text"), privacy_statement_url.get("lang")
+                )
 
             description.ui_info = ui_description
 

src/satosa/backends/saml2.py

@@ -623,6 +623,14 @@ def get_metadata_desc(self):
                     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.get("lang"))
+                for keywords in ui_info.get("keywords", []):
+                    ui_info_desc.add_keywords(keywords.get("text", []), keywords.get("lang"))
+                for information_url in ui_info.get("information_url", []):
+                    ui_info_desc.add_information_url(information_url.get("text"), information_url.get("lang"))
+                for privacy_statement_url in ui_info.get("privacy_statement_url", []):
+                    ui_info_desc.add_privacy_statement_url(
+                        privacy_statement_url.get("text"), privacy_statement_url.get("lang")
+                    )
                 description.ui_info = ui_info_desc
 
             entity_descriptions.append(description)

src/satosa/metadata_creation/description.py

@@ -52,6 +52,9 @@ def __init__(self):
         self._description = []
         self._display_name = []
         self._logos = []
+        self._keywords = []
+        self._information_url = []
+        self._privacy_statement_url = []
 
     def add_description(self, text, lang):
         """
@@ -96,6 +99,52 @@ def add_logo(self, text, width, height, lang=None):
             logo_entry["lang"] = lang
         self._logos.append(logo_entry)
 
+    def add_keywords(self, text, lang):
+        """
+        Binds keywords to the given language
+        :type text: List
+        :type lang: str
+
+        :param text: List of keywords
+        :param lang: language
+        """
+
+        if text:
+            self._keywords.append(
+                {
+                    "text": [_keyword.replace(" ", "+") for _keyword in text],
+                    "lang": lang if lang else "en",
+                }
+            )
+
+    def add_information_url(self, text, lang):
+        """
+        Binds information_url to the given language
+        :type text: str
+        :type lang: str
+
+        :param text: Information URL
+        :param lang: language
+        """
+
+        if text:
+            self._information_url.append({"text": text, "lang": lang if lang else "en"})
+
+    def add_privacy_statement_url(self, text, lang):
+        """
+        Binds privacy_statement_url to the given language
+        :type text: str
+        :type lang: str
+
+        :param text: Privacy statement URL
+        :param lang: language
+        """
+
+        if text:
+            self._privacy_statement_url.append(
+                {"text": text, "lang": lang if lang else "en"}
+            )
+
     def to_dict(self):
         """
         Returns a dictionary representation of the UIInfoDesc object.
@@ -110,6 +159,12 @@ def to_dict(self):
             ui_info["display_name"] = self._display_name
         if self._logos:
             ui_info["logo"] = self._logos
+        if self._keywords:
+            ui_info["keywords"] = self._keywords
+        if self._information_url:
+            ui_info["information_url"] = self._information_url
+        if self._privacy_statement_url:
+            ui_info["privacy_statement_url"] = self._privacy_statement_url
         return {"service": {"idp": {"ui_info": ui_info}}} if ui_info else {}
 
 
@@ -227,9 +282,9 @@ def to_dict(self):
         if self._organization:
             description.update(self._organization.to_dict())
         if self._contact_person:
-            description['contact_person'] = []
+            description["contact_person"] = []
             for person in self._contact_person:
-                description['contact_person'].append(person.to_dict())
+                description["contact_person"].append(person.to_dict())
         if self._ui_info:
             description.update(self._ui_info.to_dict())
         return description

tests/satosa/metadata_creation/test_description.py

@@ -24,12 +24,18 @@ def test_to_dict(self):
         desc.add_description("test", "en")
         desc.add_display_name("my company", "en")
         desc.add_logo("logo.jpg", 80, 80, "en")
+        desc.add_keywords(["kw1", "kw2"], "en")
+        desc.add_information_url("https://test", "en")
+        desc.add_privacy_statement_url("https://test", "en")
 
         serialized = desc.to_dict()
         ui_info = serialized["service"]["idp"]["ui_info"]
         assert ui_info["description"] == [{"text": "test", "lang": "en"}]
         assert ui_info["display_name"] == [{"text": "my company", "lang": "en"}]
         assert ui_info["logo"] == [{"text": "logo.jpg", "width": 80, "height": 80, "lang": "en"}]
+        assert ui_info["keywords"] == [{"text": ["kw1", "kw2"], "lang": "en"}]
+        assert ui_info["information_url"] == [{"text": "https://test", "lang": "en"}]
+        assert ui_info["privacy_statement_url"] == [{"text": "https://test", "lang": "en"}]
 
     def test_to_dict_for_logo_without_lang(self):
         desc = UIInfoDesc()