required actions storage/display

2015-06-16 22:48:39 -04:00
1 parent 3b78fa2d5d
commit dddc5181e7
@@ -17,6 +17,7 @@ import org.keycloak.jose.jws.JWSBuilder;
 import org.keycloak.login.LoginFormsProvider;
 import org.keycloak.models.ClientModel;
 import org.keycloak.models.ClientSessionModel;
+import org.keycloak.models.RequiredActionProviderModel;
 import org.keycloak.models.UserConsentModel;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.ProtocolMapperModel;
@@ -483,8 +484,9 @@ public class AuthenticationManager {
        };

        // see if any required actions need triggering, i.e. an expired password
-        for (ProviderFactory factory : session.getKeycloakSessionFactory().getProviderFactories(RequiredActionProvider.class)) {
-            RequiredActionProvider provider = ((RequiredActionFactory)factory).create(session);
+        for (RequiredActionProviderModel model : realm.getRequiredActionProviders()) {
+            if (!model.isEnabled()) continue;
+            RequiredActionProvider provider = session.getProvider(RequiredActionProvider.class, model.getProviderId());
            provider.evaluateTriggers(context);
        }

@@ -495,7 +497,8 @@ public class AuthenticationManager {

        Set<String> requiredActions = user.getRequiredActions();
        for (String action : requiredActions) {
-            RequiredActionProvider actionProvider = session.getProvider(RequiredActionProvider.class, action);
+            RequiredActionProviderModel model = realm.getRequiredActionProviderByAlias(action);
+            RequiredActionProvider actionProvider = session.getProvider(RequiredActionProvider.class, model.getProviderId());
            Response challenge = actionProvider.invokeRequiredAction(context);
            if (challenge != null) {
                return challenge;
@@ -17,6 +17,7 @@ import org.keycloak.models.UserFederationProviderModel;
 import org.keycloak.models.UserModel;
 import org.keycloak.models.UserSessionProvider;
 import org.keycloak.models.utils.DefaultAuthenticationFlows;
+import org.keycloak.models.utils.DefaultRequiredActions;
 import org.keycloak.models.utils.KeycloakModelUtils;
 import org.keycloak.models.utils.RepresentationToModel;
 import org.keycloak.representations.idm.ClientRepresentation;
@@ -88,6 +89,7 @@ public class RealmManager {
        setupBrokerService(realm);
        setupAdminConsole(realm);
        setupAuthenticationFlows(realm);
+        setupRequiredActions(realm);

        return realm;
    }
@@ -96,6 +98,10 @@ public class RealmManager {
        if (realm.getAuthenticationFlows().size() == 0) DefaultAuthenticationFlows.addFlows(realm);
    }

+    protected void setupRequiredActions(RealmModel realm) {
+        if (realm.getRequiredActionProviders().size() == 0) DefaultRequiredActions.addActions(realm);
+    }
+
    protected void setupAdminConsole(RealmModel realm) {
        ClientModel adminConsole = realm.getClientByClientId(Constants.ADMIN_CONSOLE_CLIENT_ID);
        if (adminConsole == null) adminConsole = new ClientManager(this).createClient(realm, Constants.ADMIN_CONSOLE_CLIENT_ID);
@@ -261,6 +267,7 @@ public class RealmManager {
        RepresentationToModel.importRealm(session, rep, realm);

        setupAuthenticationFlows(realm);
+        setupRequiredActions(realm);

        // Refresh periodic sync tasks for configured federationProviders
        List<UserFederationProviderModel> federationProviders = realm.getUserFederationProviders();
@@ -6,13 +6,18 @@ import org.jboss.resteasy.spi.NotFoundException;
 import org.keycloak.authentication.Authenticator;
 import org.keycloak.authentication.AuthenticatorFactory;
 import org.keycloak.authentication.AuthenticatorUtil;
+import org.keycloak.authentication.RequiredActionFactory;
+import org.keycloak.authentication.RequiredActionProvider;
 import org.keycloak.models.AuthenticationExecutionModel;
 import org.keycloak.models.AuthenticationFlowModel;
 import org.keycloak.models.AuthenticatorModel;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.RealmModel;
+import org.keycloak.models.RequiredActionProviderModel;
+import org.keycloak.provider.ProviderFactory;

 import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
 import javax.ws.rs.GET;
 import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
@@ -20,8 +25,10 @@ import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;

 import static javax.ws.rs.core.Response.Status.NOT_FOUND;

@@ -176,4 +183,118 @@ public class AuthenticationManagementResource {
            realm.updateAuthenticatorExecution(model);
        }
    }
+
+    public static class RequiredActionProviderRepresentation {
+        private String alias;
+        private String name;
+        private boolean enabled;
+        private boolean defaultAction;
+        private Map<String, String> config = new HashMap<String, String>();
+
+        public String getAlias() {
+            return alias;
+        }
+
+        public void setAlias(String alias) {
+            this.alias = alias;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public boolean isEnabled() {
+            return enabled;
+        }
+
+        public void setEnabled(boolean enabled) {
+            this.enabled = enabled;
+        }
+
+        public boolean isDefaultAction() {
+            return defaultAction;
+        }
+
+        public void setDefaultAction(boolean defaultAction) {
+            this.defaultAction = defaultAction;
+        }
+
+        public Map<String, String> getConfig() {
+            return config;
+        }
+
+        public void setConfig(Map<String, String> config) {
+            this.config = config;
+        }
+    }
+
+
+    @Path("required-actions")
+    @GET
+    @Produces(MediaType.APPLICATION_JSON)
+    public List<RequiredActionProviderRepresentation> getRequiredActions() {
+        List<RequiredActionProviderRepresentation> list = new LinkedList<>();
+        for (RequiredActionProviderModel model : realm.getRequiredActionProviders()) {
+            RequiredActionProviderRepresentation rep = toRepresentation(model);
+            list.add(rep);
+        }
+        return list;
+    }
+
+    public static RequiredActionProviderRepresentation toRepresentation(RequiredActionProviderModel model) {
+        RequiredActionProviderRepresentation rep = new RequiredActionProviderRepresentation();
+        rep.setAlias(model.getAlias());
+        rep.setName(model.getName());
+        rep.setDefaultAction(model.isDefaultAction());
+        rep.setEnabled(model.isEnabled());
+        rep.setConfig(model.getConfig());
+        return rep;
+    }
+
+    @Path("required-actions/{alias}")
+    @GET
+    @Produces(MediaType.APPLICATION_JSON)
+    public RequiredActionProviderRepresentation getRequiredAction(@PathParam("alias") String alias) {
+        RequiredActionProviderModel model = realm.getRequiredActionProviderByAlias(alias);
+        if (model == null) {
+            throw new NotFoundException("Failed to find required action: " + alias);
+        }
+        return toRepresentation(model);
+    }
+
+
+    @Path("required-actions/{alias}")
+    @PUT
+    @Consumes(MediaType.APPLICATION_JSON)
+    public void updateRequiredAction(@PathParam("alias") String alias, RequiredActionProviderRepresentation rep) {
+        RequiredActionProviderModel model = realm.getRequiredActionProviderByAlias(alias);
+        if (model == null) {
+            throw new NotFoundException("Failed to find required action: " + alias);
+        }
+        RequiredActionProviderModel update = new RequiredActionProviderModel();
+        update.setId(update.getId());
+        update.setName(rep.getName());
+        update.setAlias(rep.getAlias());
+        update.setProviderId(model.getProviderId());
+        update.setDefaultAction(rep.isDefaultAction());
+        update.setEnabled(rep.isEnabled());
+        update.setConfig(rep.getConfig());
+        realm.updateRequiredActionProvider(update);
+    }
+
+    @Path("required-actions/{alias}")
+    @DELETE
+    public void updateRequiredAction(@PathParam("alias") String alias) {
+        RequiredActionProviderModel model = realm.getRequiredActionProviderByAlias(alias);
+        if (model == null) {
+            throw new NotFoundException("Failed to find required action: " + alias);
+        }
+        realm.removeRequiredActionProvider(model);
+    }
+
+
 }
@@ -565,18 +565,4 @@ public class RealmAdminResource {
        return new IdentityProvidersResource(realm, session, this.auth, adminEvent);
    }

-    @Path("required-actions")
-    @GET
-    @Produces(MediaType.APPLICATION_JSON)
-    public List<Map<String, String>> getRequiredActions() {
-        List<Map<String, String>> list = new LinkedList<>();
-        for (ProviderFactory factory : session.getKeycloakSessionFactory().getProviderFactories(RequiredActionProvider.class)) {
-            RequiredActionFactory actionFactory = (RequiredActionFactory)factory;
-            Map<String, String> data = new HashMap<>();
-            data.put("id", actionFactory.getId());
-            data.put("text", actionFactory.getDisplayText());
-            list.add(data);
-        }
-        return list;
-    }
 }