pluggable required actions backend

keycloak · Jun 10, 2015 · 3dd282e · 3dd282e
1 parent 95349e6
commit 3dd282e
Show file tree

Hide file tree

Showing 11 changed files with 482 additions and 42 deletions.
diff --git a/services/src/main/java/org/keycloak/authentication/RequiredActionFactory.java b/services/src/main/java/org/keycloak/authentication/RequiredActionFactory.java
@@ -0,0 +1,10 @@
+package org.keycloak.authentication;
+
+import org.keycloak.provider.ProviderFactory;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public interface RequiredActionFactory extends ProviderFactory<RequiredActionProvider> {
+}
diff --git a/services/src/main/java/org/keycloak/authentication/RequiredActionProvider.java b/services/src/main/java/org/keycloak/authentication/RequiredActionProvider.java
@@ -9,6 +9,7 @@
  * @version $Revision: 1 $
  */
 public interface RequiredActionProvider extends Provider {
+    void evaluateTriggers(RequiredActionContext context);
     Response invokeRequiredAction(RequiredActionContext context);
-    Object jaxrsService();
+    Object jaxrsService(RequiredActionContext context);
 }
diff --git a/services/src/main/java/org/keycloak/authentication/RequiredActionSpi.java b/services/src/main/java/org/keycloak/authentication/RequiredActionSpi.java
@@ -0,0 +1,32 @@
+package org.keycloak.authentication;
+
+import org.keycloak.provider.Provider;
+import org.keycloak.provider.ProviderFactory;
+import org.keycloak.provider.Spi;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public class RequiredActionSpi implements Spi {
+
+    @Override
+    public boolean isInternal() {
+        return false;
+    }
+
+    @Override
+    public String getName() {
+        return "required-action";
+    }
+
+    @Override
+    public Class<? extends Provider> getProviderClass() {
+        return RequiredActionProvider.class;
+    }
+
+    @Override
+    public Class<? extends ProviderFactory> getProviderFactoryClass() {
+        return RequiredActionFactory.class;
+    }
+
+}
diff --git a/services/src/main/java/org/keycloak/authentication/actions/UpdatePassword.java b/services/src/main/java/org/keycloak/authentication/actions/UpdatePassword.java
@@ -0,0 +1,93 @@
+package org.keycloak.authentication.actions;
+
+import org.jboss.logging.Logger;
+import org.keycloak.Config;
+import org.keycloak.authentication.RequiredActionContext;
+import org.keycloak.authentication.RequiredActionFactory;
+import org.keycloak.authentication.RequiredActionProvider;
+import org.keycloak.login.LoginFormsProvider;
+import org.keycloak.models.ClientSessionModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.UserCredentialModel;
+import org.keycloak.models.UserCredentialValueModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.services.managers.ClientSessionCode;
+import org.keycloak.util.Time;
+
+import javax.ws.rs.core.Response;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class UpdatePassword implements RequiredActionProvider, RequiredActionFactory {
+    protected static Logger logger = Logger.getLogger(UpdatePassword.class);
+    @Override
+    public void evaluateTriggers(RequiredActionContext context) {
+        int daysToExpirePassword = context.getRealm().getPasswordPolicy().getDaysToExpirePassword();
+        if(daysToExpirePassword != -1) {
+            for (UserCredentialValueModel entity : context.getUser().getCredentialsDirectly()) {
+                if (entity.getType().equals(UserCredentialModel.PASSWORD)) {
+
+                    if(entity.getCreatedDate() == null) {
+                        context.getUser().addRequiredAction(UserModel.RequiredAction.UPDATE_PASSWORD);
+                        logger.debug("User is required to update password");
+                    } else {
+                        long timeElapsed = Time.toMillis(Time.currentTime()) - entity.getCreatedDate();
+                        long timeToExpire = TimeUnit.DAYS.toMillis(daysToExpirePassword);
+
+                        if(timeElapsed > timeToExpire) {
+                            context.getUser().addRequiredAction(UserModel.RequiredAction.UPDATE_PASSWORD);
+                            logger.debug("User is required to update password");
+                        }
+                    }
+                    break;
+                }
+            }
+        }
+    }
+
+    @Override
+    public Response invokeRequiredAction(RequiredActionContext context) {
+        ClientSessionCode accessCode = new ClientSessionCode(context.getRealm(), context.getClientSession());
+        accessCode.setAction(ClientSessionModel.Action.UPDATE_PASSWORD.name());
+
+        LoginFormsProvider loginFormsProvider = context.getSession().getProvider(LoginFormsProvider.class).setClientSessionCode(accessCode.getCode())
+                .setUser(context.getUser());
+        return loginFormsProvider.createResponse(UserModel.RequiredAction.UPDATE_PASSWORD);
+    }
+
+    @Override
+    public Object jaxrsService(RequiredActionContext context) {
+        // this is handled by LoginActionsService at the moment
+        return null;
+    }
+
+
+    @Override
+    public void close() {
+
+    }
+
+    @Override
+    public RequiredActionProvider create(KeycloakSession session) {
+        return this;
+    }
+
+    @Override
+    public void init(Config.Scope config) {
+
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+
+    }
+
+    @Override
+    public String getId() {
+        return UserModel.RequiredAction.UPDATE_PASSWORD.name();
+    }
+}
diff --git a/services/src/main/java/org/keycloak/authentication/actions/UpdateProfile.java b/services/src/main/java/org/keycloak/authentication/actions/UpdateProfile.java
@@ -0,0 +1,75 @@
+package org.keycloak.authentication.actions;
+
+import org.jboss.logging.Logger;
+import org.keycloak.Config;
+import org.keycloak.authentication.RequiredActionContext;
+import org.keycloak.authentication.RequiredActionFactory;
+import org.keycloak.authentication.RequiredActionProvider;
+import org.keycloak.login.LoginFormsProvider;
+import org.keycloak.models.ClientSessionModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RequiredCredentialModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.representations.idm.CredentialRepresentation;
+import org.keycloak.services.managers.ClientSessionCode;
+
+import javax.ws.rs.core.Response;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class UpdateProfile implements RequiredActionProvider, RequiredActionFactory {
+    protected static Logger logger = Logger.getLogger(UpdateProfile.class);
+    @Override
+    public void evaluateTriggers(RequiredActionContext context) {
+        if (context.getRealm().isVerifyEmail() && !context.getUser().isEmailVerified()) {
+            context.getUser().addRequiredAction(UserModel.RequiredAction.VERIFY_EMAIL);
+            logger.debug("User is required to verify email");
+        }
+    }
+
+    @Override
+    public Response invokeRequiredAction(RequiredActionContext context) {
+        ClientSessionCode accessCode = new ClientSessionCode(context.getRealm(), context.getClientSession());
+        accessCode.setAction(ClientSessionModel.Action.UPDATE_PROFILE.name());
+
+        LoginFormsProvider loginFormsProvider = context.getSession().getProvider(LoginFormsProvider.class).setClientSessionCode(accessCode.getCode())
+                .setUser(context.getUser());
+        return loginFormsProvider.createResponse(UserModel.RequiredAction.UPDATE_PROFILE);
+    }
+
+    @Override
+    public Object jaxrsService(RequiredActionContext context) {
+        // this is handled by LoginActionsService at the moment
+        // todo should be refactored to contain it here
+        return null;
+    }
+
+
+    @Override
+    public void close() {
+
+    }
+
+    @Override
+    public RequiredActionProvider create(KeycloakSession session) {
+        return this;
+    }
+
+    @Override
+    public void init(Config.Scope config) {
+
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+
+    }
+
+    @Override
+    public String getId() {
+        return UserModel.RequiredAction.UPDATE_PROFILE.name();
+    }
+}
diff --git a/services/src/main/java/org/keycloak/authentication/actions/UpdateTotp.java b/services/src/main/java/org/keycloak/authentication/actions/UpdateTotp.java
@@ -0,0 +1,84 @@
+package org.keycloak.authentication.actions;
+
+import org.jboss.logging.Logger;
+import org.keycloak.Config;
+import org.keycloak.authentication.RequiredActionContext;
+import org.keycloak.authentication.RequiredActionFactory;
+import org.keycloak.authentication.RequiredActionProvider;
+import org.keycloak.login.LoginFormsProvider;
+import org.keycloak.models.ClientSessionModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RequiredCredentialModel;
+import org.keycloak.models.UserCredentialModel;
+import org.keycloak.models.UserCredentialValueModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.representations.idm.CredentialRepresentation;
+import org.keycloak.services.managers.ClientSessionCode;
+import org.keycloak.util.Time;
+
+import javax.ws.rs.core.Response;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class UpdateTotp implements RequiredActionProvider, RequiredActionFactory {
+    protected static Logger logger = Logger.getLogger(UpdateTotp.class);
+    @Override
+    public void evaluateTriggers(RequiredActionContext context) {
+        // I don't think we need this check here.  AuthenticationProcessor should be setting the required action
+        // if OTP changes from required from optional or disabled
+        for (RequiredCredentialModel c : context.getRealm().getRequiredCredentials()) {
+            if (c.getType().equals(CredentialRepresentation.TOTP) && !context.getUser().isTotp()) {
+                context.getUser().addRequiredAction(UserModel.RequiredAction.CONFIGURE_TOTP);
+                logger.debug("User is required to configure totp");
+            }
+        }
+    }
+
+    @Override
+    public Response invokeRequiredAction(RequiredActionContext context) {
+        ClientSessionCode accessCode = new ClientSessionCode(context.getRealm(), context.getClientSession());
+        accessCode.setAction(ClientSessionModel.Action.CONFIGURE_TOTP.name());
+
+        LoginFormsProvider loginFormsProvider = context.getSession().getProvider(LoginFormsProvider.class).setClientSessionCode(accessCode.getCode())
+                .setUser(context.getUser());
+        return loginFormsProvider.createResponse(UserModel.RequiredAction.CONFIGURE_TOTP);
+    }
+
+    @Override
+    public Object jaxrsService(RequiredActionContext context) {
+        // this is handled by LoginActionsService at the moment
+        // todo should be refactored to contain it here
+        return null;
+    }
+
+
+    @Override
+    public void close() {
+
+    }
+
+    @Override
+    public RequiredActionProvider create(KeycloakSession session) {
+        return this;
+    }
+
+    @Override
+    public void init(Config.Scope config) {
+
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+
+    }
+
+    @Override
+    public String getId() {
+        return UserModel.RequiredAction.CONFIGURE_TOTP.name();
+    }
+
+}