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