io.github.kilmajster.keycloak.UsernamePasswordAttributeForm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keycloak-username-password-attribute-authenticator Show documentation
Default Keycloak login form with additional user attribute validation️
There is a newer version: 0.3.0
Show newest version
package io.github.kilmajster.keycloak;

import io.github.kilmajster.keycloak.utils.UserAttributeLabelGenerator;
import org.jboss.resteasy.specimpl.MultivaluedMapImpl;
import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.AuthenticationFlowError;
import org.keycloak.authentication.Authenticator;
import org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator;
import org.keycloak.authentication.authenticators.browser.UsernamePasswordForm;
import org.keycloak.events.Details;
import org.keycloak.events.Errors;
import org.keycloak.models.ModelDuplicateException;
import org.keycloak.models.UserModel;
import org.keycloak.models.utils.KeycloakModelUtils;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.managers.AuthenticationManager;
import org.keycloak.services.messages.Messages;
import org.keycloak.services.validation.Validation;

import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;

import static io.github.kilmajster.keycloak.UsernamePasswordAttributeFormConfiguration.*;

public class UsernamePasswordAttributeForm extends UsernamePasswordForm implements Authenticator {

    protected static ServicesLogger log = ServicesLogger.LOGGER;

    @Override
    public void authenticate(AuthenticationFlowContext context) {
        MultivaluedMap formData = new MultivaluedMapImpl();
        String loginHint = context.getAuthenticationSession().getClientNote("login_hint");
        String rememberMeUsername = AuthenticationManager.getRememberMeUsername(context.getRealm(), context.getHttpRequest().getHttpHeaders());
        if (loginHint != null || rememberMeUsername != null) {
            if (loginHint != null) {
                formData.add("username", loginHint);
            } else {
                formData.add("username", rememberMeUsername);
                formData.add("rememberMe", "on");
            }
        }

        configureUserAttributeLabel(context);

        Response challengeResponse = this.challenge(context, formData);
        context.challenge(challengeResponse);
    }

    private void configureUserAttributeLabel(AuthenticationFlowContext context) {
        final String userAttributeLabel = configPropertyOf(context, USER_ATTRIBUTE_LABEL);
        if (userAttributeLabel != null) {
            context.form().setAttribute(USER_ATTRIBUTE_LABEL, userAttributeLabel);
        } else {
            final String userAttributeName = configPropertyOf(context, USER_ATTRIBUTE);
            if (userAttributeName != null && !userAttributeName.isEmpty()) {
                context.form().setAttribute(USER_ATTRIBUTE_LABEL,
                        isGeneratePropertyLabelEnabled(context)
                                ? UserAttributeLabelGenerator.from(userAttributeName)
                                : userAttributeName);
            } else {
                log.warn("Configuration of keycloak-user-attribute-authenticator is incomplete! " +
                        "At least user_attribute property needs to be set!");
            }
        }
    }

    @Override
    protected boolean validateForm(AuthenticationFlowContext context, MultivaluedMap formData) {
        context.clearUser();
        UserModel user = getUser(context, formData);
        return user != null
                && validatePassword(context, user, formData) && validateUser(context, user, formData)
                && validateUserAttribute(context, user, formData);
    }

    private boolean validateUserAttribute(AuthenticationFlowContext context, UserModel user, MultivaluedMap formData) {
        final String providedAttribute = formData.getFirst(USER_ATTRIBUTE);
        if (providedAttribute == null || providedAttribute.isEmpty()) {
            return invalidUserAttributeHandler(context, user, true);
        }

        if (isProvidedAttributeValid(context, user, providedAttribute)) {
            return true;
        } else {
            return invalidUserAttributeHandler(context, user, false);
        }
    }

    private boolean isProvidedAttributeValid(AuthenticationFlowContext context, UserModel user, String providedUserAttribute) {
        String userAttributeName = context.getAuthenticatorConfig().getConfig().get(USER_ATTRIBUTE);
        return user.getAttributeStream(userAttributeName)
                .anyMatch(attr -> attr.equals(providedUserAttribute));
    }

    // Set up AuthenticationFlowContext error.
    private boolean invalidUserAttributeHandler(AuthenticationFlowContext context, UserModel user, boolean isAttributeEmpty) {
        context.getEvent().user(user);
        context.getEvent().error(Errors.INVALID_USER_CREDENTIALS);
        Response challengeResponse = challenge(context, getDefaultChallengeMessage(context), USER_ATTRIBUTE);

        if (isAttributeEmpty) {
            context.forceChallenge(challengeResponse);
        } else {
            context.failureChallenge(AuthenticationFlowError.INVALID_CREDENTIALS, challengeResponse);
        }

        context.clearUser();

        return false;
    }


    private UserModel getUser(AuthenticationFlowContext context, MultivaluedMap formData) {
        String username = formData.getFirst(AuthenticationManager.FORM_USERNAME);
        if (username == null) {
            context.getEvent().error(Errors.USER_NOT_FOUND);
            Response challengeResponse = challenge(context, getDefaultChallengeMessage(context), Validation.FIELD_USERNAME);
            context.failureChallenge(AuthenticationFlowError.INVALID_USER, challengeResponse);
            return null;
        }

        // remove leading and trailing whitespace
        username = username.trim();

        context.getEvent().detail(Details.USERNAME, username);
        context.getAuthenticationSession().setAuthNote(AbstractUsernameFormAuthenticator.ATTEMPTED_USERNAME, username);

        UserModel user = null;
        try {
            user = KeycloakModelUtils.findUserByNameOrEmail(context.getSession(), context.getRealm(), username);
        } catch (ModelDuplicateException mde) {
            ServicesLogger.LOGGER.modelDuplicateException(mde);

            // Could happen during federation import
            if (mde.getDuplicateFieldName() != null && mde.getDuplicateFieldName().equals(UserModel.EMAIL)) {
                setDuplicateUserChallenge(context, Errors.EMAIL_IN_USE, Messages.EMAIL_EXISTS, AuthenticationFlowError.INVALID_USER);
            } else {
                setDuplicateUserChallenge(context, Errors.USERNAME_IN_USE, Messages.USERNAME_EXISTS, AuthenticationFlowError.INVALID_USER);
            }
            return user;
        }

        testInvalidUser(context, user);
        return user;
    }

    private boolean validateUser(AuthenticationFlowContext context, UserModel user, MultivaluedMap inputData) {
        if (!enabledUser(context, user)) {
            return false;
        }
        String rememberMe = inputData.getFirst("rememberMe");
        boolean remember = rememberMe != null && rememberMe.equalsIgnoreCase("on");
        if (remember) {
            context.getAuthenticationSession().setAuthNote(Details.REMEMBER_ME, "true");
            context.getEvent().detail(Details.REMEMBER_ME, "true");
        } else {
            context.getAuthenticationSession().removeAuthNote(Details.REMEMBER_ME);
        }
        context.setUser(user);
        return true;
    }
}