feat(UI): Simple PoC for UI-integration

see OSS-9

Author: hypery2k

docker-compose.yml

@@ -46,10 +46,11 @@ services:
       KEYCLOAK_ADMIN: 'admin'
       KEYCLOAK_ADMIN_PASSWORD: 'admin'
       KC_AUD_GLOBAL_MASTER_ACCESS: 'true'
+      KC_FEATURES: "authorization,declarative-ui,step-up-authentication,token-exchange,web-authn"
 
   maildev:
     container_name: maildev
     image: djfarrelly/maildev:1.0.0-rc2
     ports:
       - '8081:80'
-      - '25'
+      - '25'

spi/src/main/java/net/cst/keycloak/admin/AdminUiPage.java

@@ -0,0 +1,72 @@
+package net.cst.keycloak.admin;
+
+import lombok.extern.slf4j.Slf4j;
+import org.keycloak.Config;
+import org.keycloak.component.ComponentModel;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigurationBuilder;
+import org.keycloak.services.ui.extend.UiPageProvider;
+import org.keycloak.services.ui.extend.UiPageProviderFactory;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+
+/**
+ * Implements UiPageProvider so it will be a master detail view in the admin ui of TODO items
+ */
+@Slf4j
+public class AdminUiPage implements UiPageProvider, UiPageProviderFactory<ComponentModel> {
+
+    @Override
+    public void init(Config.Scope config) {
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+    }
+
+    @Override
+    public void close() {
+    }
+
+    @Override
+    public String getId() {
+        return "auditing";
+    }
+
+    @Override
+    public String getHelpText() {
+        return "Here you view audit events from Keycloak";
+    }
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        return ProviderConfigurationBuilder.create()
+                .property()
+                .name("name")
+                .label("Name")
+                .helpText("Short name of the task")
+                .type(ProviderConfigProperty.STRING_TYPE)
+                .add().property()
+                .name("description")
+                .label("Description")
+                .helpText("Description of what needs to be done")
+                .type(ProviderConfigProperty.TEXT_TYPE)
+                .add().property()
+                .name("prio")
+                .label("Priority")
+                .type(ProviderConfigProperty.LIST_TYPE)
+                .options("critical", "high priority", "neutral", "low priority", "unknown")
+                .add().build();
+    }
+
+    @Override
+    public Map<String, Object> getTypeMetadata() {
+        Map<String, Object> metaData = new HashMap<>();
+        metaData.put("displayFields", List.of("name", "prio"));
+        return metaData;
+    }
+}

spi/src/main/java/net/cst/keycloak/resources/AuditedResourcesProviderFactory.java

@@ -2,6 +2,7 @@
 
 import lombok.extern.slf4j.Slf4j;
 import net.cst.keycloak.events.logging.LoginEventListenerProviderFactory;
+import net.cst.keycloak.utils.RuntimeHelper;
 import org.keycloak.Config;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.KeycloakSessionFactory;
@@ -27,7 +28,7 @@ public String getId() {
     @Override
     public void init(Config.Scope scope) {
         log.info("Initializing Keycloak Auditor REST extension (Version {}).",
-                LoginEventListenerProviderFactory.class.getPackage().getImplementationVersion());
+                RuntimeHelper.getVersion());
     }
 
     @Override

spi/src/main/java/net/cst/keycloak/user/AccountUiPage.java

@@ -0,0 +1,71 @@
+package net.cst.keycloak.user;
+
+import org.keycloak.Config;
+import org.keycloak.component.ComponentModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RealmModel;
+import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigurationBuilder;
+import org.keycloak.services.ui.extend.UiTabProvider;
+import org.keycloak.services.ui.extend.UiTabProviderFactory;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class AccountUiPage implements UiTabProvider, UiTabProviderFactory<ComponentModel> {
+
+    private KeycloakSession session;
+
+    @Override
+    public String getId() {
+        return "Auditing";
+    }
+
+    @Override
+    public String getHelpText() {
+        return "Show auditing information";
+    }
+
+    @Override
+    public void init(Config.Scope config) {
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+    }
+
+    @Override
+    public void close() {
+    }
+
+    @Override
+    public void onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) {
+        realm.setAttribute("logo", model.get("logo"));
+    }
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        final ProviderConfigurationBuilder builder = ProviderConfigurationBuilder.create();
+        builder.property()
+                .name("logo")
+                .label("Set a logo")
+                .helpText("This logo will be shown on the account ui")
+                .type(ProviderConfigProperty.STRING_TYPE)
+                .add();
+        return builder.build();
+    }
+
+    @Override
+    public String getPath() {
+        return "/:realm/realm-settings/:tab?";
+    }
+
+    @Override
+    public Map<String, String> getParams() {
+        Map<String, String> params = new HashMap<>();
+        params.put("tab", "attributes");
+        return params;
+    }
+}

spi/src/main/resources/META-INF/services/org.keycloak.services.ui.extend.UiPageProviderFactory

@@ -0,0 +1 @@
+net.cst.keycloak.admin.AdminUiPage

spi/src/main/resources/META-INF/services/org.keycloak.services.ui.extend.UiTabProviderFactory

@@ -0,0 +1 @@
+net.cst.keycloak.user.AccountUiPage

spi/src/test/java/net/cst/keycloak/admin/AdminUiPageTest.java

@@ -0,0 +1,33 @@
+package net.cst.keycloak.admin;
+
+import net.cst.keycloak.utils.EndpointTest;
+import org.junit.jupiter.api.Test;
+import org.keycloak.Config;
+import org.keycloak.component.ComponentModel;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RealmModel;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.mockito.Mockito.mock;
+
+class AdminUiPageTest extends EndpointTest {
+
+    private ComponentModel componentModel = mock(ComponentModel.class);
+    private RealmModel masterRealm = mock(RealmModel.class);
+    private Config.Scope config = mock(Config.Scope.class);
+    private KeycloakSessionFactory sessionFactory = mock(KeycloakSessionFactory.class);
+
+    @Test
+    void shouldInit() {
+        AdminUiPage page = new AdminUiPage();
+        page.onCreate(session, masterRealm, componentModel);
+        page.init(config);
+        page.postInit(sessionFactory);
+        page.close();
+        assertNotNull(page.getConfigProperties());
+        assertNotNull(page.getId());
+        assertNotNull(page.getHelpText());
+        assertNotNull(page.getTypeMetadata());
+    }
+
+}

spi/src/test/java/net/cst/keycloak/user/AccountUiPageTest.java

@@ -0,0 +1,32 @@
+package net.cst.keycloak.user;
+
+import net.cst.keycloak.utils.EndpointTest;
+import org.junit.jupiter.api.Test;
+import org.keycloak.Config;
+import org.keycloak.component.ComponentModel;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RealmModel;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.mockito.Mockito.mock;
+
+class AccountUiPageTest extends EndpointTest {
+
+    private ComponentModel componentModel = mock(ComponentModel.class);
+    private RealmModel masterRealm = mock(RealmModel.class);
+    private Config.Scope config = mock(Config.Scope.class);
+    private KeycloakSessionFactory sessionFactory = mock(KeycloakSessionFactory.class);
+
+    @Test
+    void shouldInit() {
+        AccountUiPage page = new AccountUiPage();
+        page.onCreate(session, masterRealm, componentModel);
+        page.init(config);
+        page.postInit(sessionFactory);
+        assertNotNull(page.getConfigProperties());
+        assertNotNull(page.getId());
+        assertNotNull(page.getHelpText());
+        assertNotNull(page.getPath());
+    }
+
+}