b90797
From 857713c5a9c8e0b62c06dd92e69c09eeb34b2e99 Mon Sep 17 00:00:00 2001
b90797
From: Anuja More <amore@redhat.com>
b90797
Date: Mon, 23 May 2022 12:26:34 +0530
b90797
Subject: [PATCH] Add end to end integration tests for external IdP
b90797
b90797
Added tests for HBAC and SUDO rule and other
b90797
test scenarios.
b90797
b90797
Related : https://pagure.io/freeipa/issue/8805
b90797
Related: https://pagure.io/freeipa/issue/8803
b90797
Related: https://pagure.io/freeipa/issue/8804
b90797
b90797
Signed-off-by: Anuja More <amore@redhat.com>
b90797
Reviewed-By: Florence Blanc-Renaud <flo@redhat.com>
b90797
Reviewed-By: Florence Blanc-Renaud <flo@redhat.com>
b90797
---
b90797
 ipatests/test_integration/test_idp.py | 260 ++++++++++++++++++++++----
b90797
 1 file changed, 226 insertions(+), 34 deletions(-)
b90797
b90797
diff --git a/ipatests/test_integration/test_idp.py b/ipatests/test_integration/test_idp.py
b90797
index 8f9e92e6a..2ffe6a208 100644
b90797
--- a/ipatests/test_integration/test_idp.py
b90797
+++ b/ipatests/test_integration/test_idp.py
b90797
@@ -1,6 +1,8 @@
b90797
 from __future__ import absolute_import
b90797
 
b90797
 import time
b90797
+import pytest
b90797
+import re
b90797
 
b90797
 import textwrap
b90797
 from ipaplatform.paths import paths
b90797
@@ -22,12 +24,12 @@ driver.get(verification_uri)
b90797
 try:
b90797
     element = WebDriverWait(driver, 90).until(
b90797
         EC.presence_of_element_located((By.ID, "username")))
b90797
-    driver.find_element_by_id("username").send_keys("testuser1")
b90797
-    driver.find_element_by_id("password").send_keys("{passwd}")
b90797
-    driver.find_element_by_id("kc-login").click()
b90797
+    driver.find_element(By.ID, "username").send_keys("testuser1")
b90797
+    driver.find_element(By.ID, "password").send_keys("{passwd}")
b90797
+    driver.find_element(By.ID, "kc-login").click()
b90797
     element = WebDriverWait(driver, 90).until(
b90797
         EC.presence_of_element_located((By.ID, "kc-login")))
b90797
-    driver.find_element_by_id("kc-login").click()
b90797
+    driver.find_element(By.ID, "kc-login").click()
b90797
     assert "Device Login Successful" in driver.page_source
b90797
 finally:
b90797
     now = datetime.now().strftime("%M-%S")
b90797
@@ -39,18 +41,12 @@ finally:
b90797
 def add_user_code(host, verification_uri):
b90797
     contents = user_code_script.format(uri=verification_uri,
b90797
                                        passwd=host.config.admin_password)
b90797
-    host.put_file_contents("/tmp/add_user_code.py", contents)
b90797
-    tasks.run_repeatedly(
b90797
-        host, ['python3', '/tmp/add_user_code.py'])
b90797
-
b90797
-
b90797
-def get_verification_uri(host, since, keycloak_server_name):
b90797
-    command = textwrap.dedent("""
b90797
-    journalctl -u ipa-otpd\\* --since="%s" | grep "user_code:" | awk '{ print substr($7,2,9) }'""" % since)  # noqa: E501
b90797
-    user_code = host.run_command(command).stdout_text.rstrip("\r\n")
b90797
-    uri = ("https://{0}:8443/auth/realms/master/device?user_code={1}".format(
b90797
-        keycloak_server_name, user_code))
b90797
-    return uri
b90797
+    try:
b90797
+        host.put_file_contents("/tmp/add_user_code.py", contents)
b90797
+        tasks.run_repeatedly(
b90797
+            host, ['python3', '/tmp/add_user_code.py'])
b90797
+    finally:
b90797
+        host.run_command(["rm", "-f", "/tmp/add_user_code.py"])
b90797
 
b90797
 
b90797
 def kinit_idp(host, user, keycloak_server):
b90797
@@ -58,11 +54,14 @@ def kinit_idp(host, user, keycloak_server):
b90797
     tasks.kdestroy_all(host)
b90797
     # create armor for FAST
b90797
     host.run_command(["kinit", "-n", "-c", ARMOR])
b90797
-    since = time.strftime('%Y-%m-%d %H:%M:%S')
b90797
     cmd = ["kinit", "-T", ARMOR, user]
b90797
+
b90797
     with host.spawn_expect(cmd, default_timeout=100) as e:
b90797
-        e.expect('Authenticate at .+: ')
b90797
-        uri = get_verification_uri(host, since, keycloak_server.hostname)
b90797
+        e.expect('Authenticate at (.+) and press ENTER.:')
b90797
+        prompt = e.get_last_output()
b90797
+        uri = re.search(r'Authenticate at (.*?) and press ENTER.:', prompt
b90797
+                        ).group(1)
b90797
+        time.sleep(15)
b90797
         if uri:
b90797
             add_user_code(keycloak_server, uri)
b90797
         e.sendline('\n')
b90797
@@ -74,21 +73,27 @@ def kinit_idp(host, user, keycloak_server):
b90797
 
b90797
 class TestIDPKeycloak(IntegrationTest):
b90797
 
b90797
-    num_replicas = 1
b90797
+    num_replicas = 2
b90797
     topology = 'line'
b90797
 
b90797
     @classmethod
b90797
     def install(cls, mh):
b90797
-        tasks.install_master(cls.master, setup_dns=True)
b90797
-        tasks.install_client(cls.master, cls.replicas[0])
b90797
-        content = cls.master.get_file_contents(paths.IPA_DEFAULT_CONF,
b90797
-                                               encoding='utf-8')
b90797
-        new_content = content + "\noidc_child_debug_level = 10"
b90797
-        cls.master.put_file_contents(paths.IPA_DEFAULT_CONF, new_content)
b90797
+        cls.client = cls.replicas[0]
b90797
+        cls.replica = cls.replicas[1]
b90797
+        tasks.install_master(cls.master)
b90797
+        tasks.install_client(cls.master, cls.replicas[0],
b90797
+                             extra_args=["--mkhomedir"])
b90797
+        tasks.install_replica(cls.master, cls.replicas[1])
b90797
+        for host in [cls.master, cls.replicas[0], cls.replicas[1]]:
b90797
+            content = host.get_file_contents(paths.IPA_DEFAULT_CONF,
b90797
+                                             encoding='utf-8')
b90797
+            new_content = content + "\noidc_child_debug_level = 10"
b90797
+            host.put_file_contents(paths.IPA_DEFAULT_CONF, new_content)
b90797
         with tasks.remote_sssd_config(cls.master) as sssd_config:
b90797
             sssd_config.edit_domain(
b90797
                 cls.master.domain, 'krb5_auth_timeout', 1100)
b90797
         tasks.clear_sssd_cache(cls.master)
b90797
+        tasks.clear_sssd_cache(cls.replicas[0])
b90797
         tasks.kinit_admin(cls.master)
b90797
         cls.master.run_command(["ipa", "config-mod", "--user-auth-type=idp",
b90797
                                 "--user-auth-type=password"])
b90797
@@ -97,20 +102,207 @@ class TestIDPKeycloak(IntegrationTest):
b90797
         cls.replicas[0].run_command(xvfb)
b90797
 
b90797
     def test_auth_keycloak_idp(self):
b90797
-        keycloak_srv = self.replicas[0]
b90797
-        create_quarkus.setup_keycloakserver(keycloak_srv)
b90797
+        """
b90797
+        Test case to check that OAuth 2.0 Device
b90797
+        Authorization Grant is working as
b90797
+        expected for user configured with external idp.
b90797
+        """
b90797
+        create_quarkus.setup_keycloakserver(self.client)
b90797
         time.sleep(60)
b90797
-        create_quarkus.setup_keycloak_client(keycloak_srv)
b90797
+        create_quarkus.setup_keycloak_client(self.client)
b90797
         tasks.kinit_admin(self.master)
b90797
-        cmd = ["ipa", "idp-add", "keycloak", "--provider=keycloak",
b90797
+        cmd = ["ipa", "idp-add", "keycloakidp", "--provider=keycloak",
b90797
                "--client-id=ipa_oidc_client", "--org=master",
b90797
-               "--base-url={0}:8443/auth".format(keycloak_srv.hostname)]
b90797
+               "--base-url={0}:8443/auth".format(self.client.hostname)]
b90797
         self.master.run_command(cmd, stdin_text="{0}\n{0}".format(
b90797
-            keycloak_srv.config.admin_password))
b90797
+            self.client.config.admin_password))
b90797
         tasks.user_add(self.master, 'keycloakuser',
b90797
                        extra_args=["--user-auth-type=idp",
b90797
                                    "--idp-user-id=testuser1@ipa.test",
b90797
-                                   "--idp=keycloak"]
b90797
+                                   "--idp=keycloakidp"]
b90797
                        )
b90797
+        list_user = self.master.run_command(
b90797
+            ["ipa", "user-find", "--idp-user-id=testuser1@ipa.test"]
b90797
+        )
b90797
+        assert "keycloakuser" in list_user.stdout_text
b90797
+        list_by_idp = self.master.run_command(["ipa", "user-find",
b90797
+                                               "--idp=keycloakidp"]
b90797
+                                              )
b90797
+        assert "keycloakuser" in list_by_idp.stdout_text
b90797
+        list_by_user = self.master.run_command(
b90797
+            ["ipa", "user-find", "--idp-user-id=testuser1@ipa.test", "--all"]
b90797
+        )
b90797
+        assert "keycloakidp" in list_by_user.stdout_text
b90797
+        tasks.clear_sssd_cache(self.master)
b90797
+        kinit_idp(self.master, 'keycloakuser', keycloak_server=self.client)
b90797
+
b90797
+    @pytest.fixture
b90797
+    def hbac_setup_teardown(self):
b90797
+        # allow sshd only on given host
b90797
+        tasks.kinit_admin(self.master)
b90797
+        self.master.run_command(["ipa", "hbacrule-disable", "allow_all"])
b90797
+        self.master.run_command(["ipa", "hbacrule-add", "rule1"])
b90797
+        self.master.run_command(["ipa", "hbacrule-add-user", "rule1",
b90797
+                                 "--users=keycloakuser"]
b90797
+                                )
b90797
+        self.master.run_command(["ipa", "hbacrule-add-host", "rule1",
b90797
+                                 "--hosts", self.replica.hostname])
b90797
+        self.master.run_command(["ipa", "hbacrule-add-service", "rule1",
b90797
+                                 "--hbacsvcs=sshd"]
b90797
+                                )
b90797
+        tasks.clear_sssd_cache(self.master)
b90797
+        tasks.clear_sssd_cache(self.replica)
b90797
+        yield
b90797
+
b90797
+        # cleanup
b90797
+        tasks.kinit_admin(self.master)
b90797
+        self.master.run_command(["ipa", "hbacrule-enable", "allow_all"])
b90797
+        self.master.run_command(["ipa", "hbacrule-del", "rule1"])
b90797
+
b90797
+    def test_auth_hbac(self, hbac_setup_teardown):
b90797
+        """
b90797
+        Test case to check that hbacrule is working as
b90797
+        expected for user configured with external idp.
b90797
+        """
b90797
+        kinit_idp(self.master, 'keycloakuser', keycloak_server=self.client)
b90797
+        ssh_cmd = "ssh -q -K -l keycloakuser {0} whoami"
b90797
+        valid_ssh = self.master.run_command(
b90797
+            ssh_cmd.format(self.replica.hostname))
b90797
+        assert "keycloakuser" in valid_ssh.stdout_text
b90797
+        negative_ssh = self.master.run_command(
b90797
+            ssh_cmd.format(self.master.hostname), raiseonerr=False
b90797
+        )
b90797
+        assert negative_ssh.returncode == 255
b90797
+
b90797
+    def test_auth_sudo_idp(self):
b90797
+        """
b90797
+        Test case to check that sudorule is working as
b90797
+        expected for user configured with external idp.
b90797
+        """
b90797
+        tasks.kdestroy_all(self.master)
b90797
+        tasks.kinit_admin(self.master)
b90797
+        #  rule: keycloakuser are allowed to execute yum on
b90797
+        #  the client machine as root.
b90797
+        cmdlist = [
b90797
+            ["ipa", "sudocmd-add", "/usr/bin/yum"],
b90797
+            ["ipa", "sudorule-add", "sudorule"],
b90797
+            ['ipa', 'sudorule-add-user', '--users=keycloakuser',
b90797
+             'sudorule'],
b90797
+            ['ipa', 'sudorule-add-host', '--hosts',
b90797
+             self.client.hostname, 'sudorule'],
b90797
+            ['ipa', 'sudorule-add-runasuser',
b90797
+             '--users=root', 'sudorule'],
b90797
+            ['ipa', 'sudorule-add-allow-command',
b90797
+             '--sudocmds=/usr/bin/yum', 'sudorule'],
b90797
+            ['ipa', 'sudorule-show', 'sudorule', '--all'],
b90797
+            ['ipa', 'sudorule-add-option',
b90797
+             'sudorule', '--sudooption', "!authenticate"]
b90797
+        ]
b90797
+        for cmd in cmdlist:
b90797
+            self.master.run_command(cmd)
b90797
+        tasks.clear_sssd_cache(self.master)
b90797
+        tasks.clear_sssd_cache(self.client)
b90797
+        try:
b90797
+            cmd = 'sudo -ll -U keycloakuser'
b90797
+            test = self.client.run_command(cmd).stdout_text
b90797
+            assert "User keycloakuser may run the following commands" in test
b90797
+            assert "/usr/bin/yum" in test
b90797
+            kinit_idp(self.client, 'keycloakuser', self.client)
b90797
+            test_sudo = 'su -c "sudo yum list wget" keycloakuser'
b90797
+            self.client.run_command(test_sudo)
b90797
+            list_fail = self.master.run_command(cmd).stdout_text
b90797
+            assert "User keycloakuser is not allowed to run sudo" in list_fail
b90797
+        finally:
b90797
+            tasks.kinit_admin(self.master)
b90797
+            self.master.run_command(['ipa', 'sudorule-del', 'sudorule'])
b90797
+            self.master.run_command(["ipa", "sudocmd-del", "/usr/bin/yum"])
b90797
+
b90797
+    def test_auth_replica(self):
b90797
+        """
b90797
+        Test case to check that OAuth 2.0 Device
b90797
+        Authorization is working as expected on replica.
b90797
+        """
b90797
+        tasks.clear_sssd_cache(self.master)
b90797
+        tasks.clear_sssd_cache(self.replica)
b90797
+        tasks.kinit_admin(self.replica)
b90797
+        list_user = self.master.run_command(
b90797
+            ["ipa", "user-find", "--idp-user-id=testuser1@ipa.test"]
b90797
+        )
b90797
+        assert "keycloakuser" in list_user.stdout_text
b90797
+        list_by_idp = self.replica.run_command(["ipa", "user-find",
b90797
+                                                "--idp=keycloakidp"]
b90797
+                                               )
b90797
+        assert "keycloakuser" in list_by_idp.stdout_text
b90797
+        list_by_user = self.replica.run_command(
b90797
+            ["ipa", "user-find", "--idp-user-id=testuser1@ipa.test", "--all"]
b90797
+        )
b90797
+        assert "keycloakidp" in list_by_user.stdout_text
b90797
+        kinit_idp(self.replica, 'keycloakuser', keycloak_server=self.client)
b90797
+
b90797
+    def test_idp_with_services(self):
b90797
+        """
b90797
+        Test case to check that services can be configured
b90797
+        auth indicator as idp.
b90797
+        """
b90797
         tasks.clear_sssd_cache(self.master)
b90797
-        kinit_idp(self.master, 'keycloakuser', keycloak_srv)
b90797
+        tasks.kinit_admin(self.master)
b90797
+        domain = self.master.domain.name.upper()
b90797
+        services = [
b90797
+            "DNS/{0}@{1}".format(self.master.hostname, domain),
b90797
+            "HTTP/{0}@{1}".format(self.client.hostname, domain),
b90797
+            "dogtag/{0}@{1}".format(self.master.hostname, domain),
b90797
+            "ipa-dnskeysyncd/{0}@{1}".format(self.master.hostname, domain)
b90797
+        ]
b90797
+        try:
b90797
+            for service in services:
b90797
+                test = self.master.run_command(["ipa", "service-mod", service,
b90797
+                                                "--auth-ind=idp"]
b90797
+                                               )
b90797
+                assert "Authentication Indicators: idp" in test.stdout_text
b90797
+        finally:
b90797
+            for service in services:
b90797
+                self.master.run_command(["ipa", "service-mod", service,
b90797
+                                         "--auth-ind="])
b90797
+
b90797
+    def test_idp_backup_restore(self):
b90797
+        """
b90797
+        Test case to check that after restore data is retrieved
b90797
+        with related idp configuration.
b90797
+        """
b90797
+        tasks.kinit_admin(self.master)
b90797
+        user = "backupuser"
b90797
+        cmd = ["ipa", "idp-add", "testidp", "--provider=keycloak",
b90797
+               "--client-id=ipa_oidc_client", "--org=master",
b90797
+               "--base-url={0}:8443/auth".format(self.client.hostname)]
b90797
+        self.master.run_command(cmd, stdin_text="{0}\n{0}".format(
b90797
+            self.client.config.admin_password))
b90797
+
b90797
+        tasks.user_add(self.master, user,
b90797
+                       extra_args=["--user-auth-type=idp",
b90797
+                                   "--idp-user-id=testuser1@ipa.test",
b90797
+                                   "--idp=testidp"]
b90797
+                       )
b90797
+
b90797
+        backup_path = tasks.get_backup_dir(self.master)
b90797
+        # change data after backup
b90797
+        self.master.run_command(['ipa', 'user-del', user])
b90797
+        self.master.run_command(['ipa', 'idp-del', 'testidp'])
b90797
+        dirman_password = self.master.config.dirman_password
b90797
+        self.master.run_command(['ipa-restore', backup_path],
b90797
+                                stdin_text=dirman_password + '\nyes')
b90797
+        try:
b90797
+            list_user = self.master.run_command(
b90797
+                ['ipa', 'user-show', 'backupuser', '--all']
b90797
+            ).stdout_text
b90797
+            assert "External IdP configuration: testidp" in list_user
b90797
+            assert "User authentication types: idp" in list_user
b90797
+            assert ("External IdP user identifier: "
b90797
+                    "testuser1@ipa.test") in list_user
b90797
+            list_idp = self.master.run_command(['ipa', 'idp-find', 'testidp'])
b90797
+            assert "testidp" in list_idp.stdout_text
b90797
+            kinit_idp(self.master, user, self.client)
b90797
+        finally:
b90797
+            tasks.kdestroy_all(self.master)
b90797
+            tasks.kinit_admin(self.master)
b90797
+            self.master.run_command(["rm", "-rf", backup_path])
b90797
+            self.master.run_command(["ipa", "idp-del", "testidp"])
b90797
-- 
b90797
2.36.1
b90797