NoSuchMethodError on ValidationContext.getHttpRequest()

Getting advice
1

I have implemented a custom form action, deployed, chosen as a custom step in Registration, and attempted to go through the register flow with this as the first step.

I built this by referencing/copying how other Keycloak form actions like RegistrationPassword do it. However, I am getting a NoSuchMethodError on ValidationContext.getHttpRequest().

Specific code:

@Override
    public void validate(ValidationContext context) {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();

Full code:

package com.github.thomasdarimont.keycloak.registration;

import lombok.extern.jbosslog.JBossLog;
import org.keycloak.Config;
import org.keycloak.authentication.FormAction;
import org.keycloak.authentication.FormActionFactory;
import org.keycloak.authentication.FormContext;
import org.keycloak.authentication.ValidationContext;
import org.keycloak.events.Details;
import org.keycloak.events.Errors;
import org.keycloak.forms.login.LoginFormsProvider;
import org.keycloak.models.AuthenticationExecutionModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.models.utils.FormMessage;
import org.keycloak.provider.ProviderConfigProperty;

import javax.ws.rs.core.MultivaluedMap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@JBossLog
public class DuplicatePhoneDobRegister implements FormAction, FormActionFactory {
    private static final String PROVIDER_ID = "duplicate-phone-dob-registration";
    private static final String DATE_OF_BIRTH = "dateOfBirth";
    private static final String PHONE_NUMBER = "phoneNumber";

    private static final String DATE_OF_BIRTH_REQUIRED_MESSAGE = "dateOfBirthRequired";
    private static final String PHONE_NUMBER_REQUIRED_MESSAGE = "phoneNumberRequired";

    @Override
    public String getHelpText() {
        return "Registration step to check for duplicate users by phone number and date of birth.";
    }

    @Override
    public List<ProviderConfigProperty> getConfigProperties() {
        return null;
    }

    @Override
    public void validate(ValidationContext context) {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        log.info("formData: " + formData.toString());

        context.getEvent().detail(Details.REGISTER_METHOD, "form");

        // validate user input
        KeycloakSession session = context.getSession();
        RealmModel realm = session.getContext().getRealm();

        log.info("contain DOB? " + formData.containsKey(DATE_OF_BIRTH));
        if (!formData.containsKey(DATE_OF_BIRTH)) {
            context.error(Errors.INVALID_REGISTRATION);
            formData.remove(DATE_OF_BIRTH);

            List<FormMessage> errors = List.of(new FormMessage(DATE_OF_BIRTH, DATE_OF_BIRTH_REQUIRED_MESSAGE));
            context.validationError(formData, errors);
            return;
        }

        if (!formData.containsKey(PHONE_NUMBER)) {
            context.error(Errors.INVALID_REGISTRATION);
            formData.remove(PHONE_NUMBER);

            List<FormMessage> errors = List.of(new FormMessage(DATE_OF_BIRTH, PHONE_NUMBER_REQUIRED_MESSAGE));
            context.validationError(formData, errors);
            return;
        }

        Map<String, String> params = new HashMap<>();
        params.put(DATE_OF_BIRTH, formData.getFirst(DATE_OF_BIRTH));
        params.put(PHONE_NUMBER, formData.getFirst(PHONE_NUMBER));
        boolean otherUserExists = session.users().searchForUserStream(realm, params).findAny().isPresent();

        log.info("otherUserExists: " + otherUserExists);
        if (otherUserExists) {
            List<FormMessage> errors = List.of(new FormMessage(FormMessage.GLOBAL, "Your account couldn't be " +
                "created. If you've already created an account, please log in or reset your password."));
            context.validationError(formData, errors);
            return;
        }

        context.success();
    }

    @Override
    public void success(FormContext context) {
        // handle successful form submission
        log.info("Custom Duplicate Phone DOB Register Form Action success!");
    }

    @Override
    public void buildPage(FormContext context, LoginFormsProvider form) {
        // render user input form
    }

    @Override
    public boolean requiresUser() {
        return false;
    }

    @Override
    public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user) {
        return true;
    }

    @Override
    public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) {
        // add required actions if required
    }

    @Override
    public boolean isUserSetupAllowed() {
        return false;
    }

    @Override
    public void close() {
        // NOOP
    }

    @Override
    public String getDisplayType() {
        return "Duplicate Phone DOB Check";
    }

    @Override
    public String getReferenceCategory() {
        return null;
    }

    @Override
    public boolean isConfigurable() {
        return false;
    }

    private static AuthenticationExecutionModel.Requirement[] REQUIREMENT_CHOICES = {
        AuthenticationExecutionModel.Requirement.REQUIRED,
        AuthenticationExecutionModel.Requirement.DISABLED
    };

    @Override
    public AuthenticationExecutionModel.Requirement[] getRequirementChoices() {
        return REQUIREMENT_CHOICES;
    }

    @Override
    public FormAction create(KeycloakSession session) {
        return this;
    }

    @Override
    public void init(Config.Scope config) {
        // NOOP
    }

    @Override
    public void postInit(KeycloakSessionFactory factory) {
        // NOOP
    }

    @Override
    public String getId() {
        return PROVIDER_ID;
    }
}

Any help would be appreciated.

2 Likes
2

Same error here, any help?

1 Like
3

Not sure, but this might have something to do with the recent change in the Keycloak codebase from returning org.jboss.resteasy.spi.HttpRequest (pre v21) to returning a org.keycloak.http.HttpRequest (v21+). Make sure you’re both compiling against and running the same version of Keycloak to avoid this kind of error.

New javadoc for that method:
https://www.keycloak.org/docs-api/21.0.1/javadocs/org/keycloak/authentication/FormContext.html#getHttpRequest()

2 Likes
4

Yes that worked! Did not realize the newest version changed this.

@tbattisti I changed the Keycloak version build target from my 20.0.3 to 21.0.1, rebuild, and deployed. Now it works.

2 Likes