Skip to content

fix(broker): Allows cross session email validation (#52604) #52626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmartinc merged 2 commits into from
Oct 8, 2026
Merged

fix(broker): Allows cross session email validation (#52604) #52626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06079c6
fix(broker): Allows cross session email validation (#52604)
olivierboudet Sep 10, 2026
467756b
fix priority
olivierboudet Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion ...ycloak/authentication/authenticators/broker/IdpDetectExistingBrokerUserAuthenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.keycloak.broker.provider.BrokeredIdentityContext;
import org.keycloak.events.Details;
import org.keycloak.events.Errors;
import org.keycloak.models.IdentityProviderModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
Expand All @@ -33,6 +34,8 @@

import org.jboss.logging.Logger;

import static org.keycloak.authentication.actiontoken.idpverifyemail.IdpVerifyAccountLinkActionTokenHandler.runIfUserVerified;

public class IdpDetectExistingBrokerUserAuthenticator extends IdpCreateUserIfUniqueAuthenticator {

private static final Logger logger = Logger.getLogger(IdpDetectExistingBrokerUserAuthenticator.class);
Expand Down Expand Up @@ -73,10 +76,22 @@ protected void authenticateImpl(AuthenticationFlowContext context, SerializedBro
logger.debugf("Duplication detected. There is already existing user with %s '%s' .",
duplication.getDuplicateAttributeName(), duplication.getDuplicateAttributeValue());

UserModel user = context.getSession().users().getUserById(realm, duplication.getExistingUserId());
IdentityProviderModel broker = brokerContext.getIdpConfig();

runIfUserVerified(context.getSession(), user, broker, brokerContext.getId(),
() -> {
context.setUser(user);
context.getAuthenticationSession().setAuthNote(
IdpEmailVerificationAuthenticator.VERIFY_ACCOUNT_IDP_USERNAME,
brokerContext.getUsername()
);
});

// Set duplicated user, so next authenticators can deal with it
context.getAuthenticationSession().setAuthNote(EXISTING_USER_INFO, duplication.serialize());

context.success();

}
}

Expand Down
110 changes: 104 additions & 6 deletions ...src/test/java/org/keycloak/tests/broker/KcOidcFirstBrokerLoginDetectExistingUserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,39 @@
package org.keycloak.tests.broker;

import java.io.IOException;
import java.util.Map;

import jakarta.mail.MessagingException;
import jakarta.mail.internet.MimeMessage;
import jakarta.ws.rs.core.Response;

import org.keycloak.admin.client.resource.AuthenticationManagementResource;
import org.keycloak.admin.client.resource.IdentityProviderResource;
import org.keycloak.admin.client.resource.RealmResource;
import org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticatorFactory;
import org.keycloak.authentication.authenticators.broker.IdpDetectExistingBrokerUserAuthenticatorFactory;
import org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticatorFactory;
import org.keycloak.models.AuthenticationExecutionModel;
import org.keycloak.models.IdentityProviderModel;
import org.keycloak.models.IdentityProviderSyncMode;
import org.keycloak.representations.idm.AuthenticationExecutionInfoRepresentation;
import org.keycloak.representations.idm.AuthenticationExecutionRepresentation;
import org.keycloak.representations.idm.AuthenticationFlowRepresentation;
import org.keycloak.representations.idm.IdentityProviderRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
import org.keycloak.testframework.mail.MailServer;
import org.keycloak.testframework.mail.annotations.InjectMailServer;
import org.keycloak.testframework.realm.AuthenticationExecutionBuilder;
import org.keycloak.testframework.realm.ManagedRealm;
import org.keycloak.testframework.realm.UserBuilder;
import org.keycloak.testframework.ui.annotations.InjectPage;
import org.keycloak.testframework.ui.annotations.InjectWebDriver;
import org.keycloak.testframework.ui.page.ErrorPage;
import org.keycloak.testframework.ui.page.ProceedPage;
import org.keycloak.testframework.ui.webdriver.ManagedWebDriver;
import org.keycloak.testframework.util.ApiUtil;
import org.keycloak.tests.utils.MailUtils;
import org.keycloak.testsuite.util.AccountHelper;

import org.junit.jupiter.api.BeforeEach;
Expand All @@ -34,25 +47,39 @@
@KeycloakIntegrationTest
public class KcOidcFirstBrokerLoginDetectExistingUserTest extends AbstractKcOidcBrokerTest {

private static final String DETECT_EXISTING_FLOW_ALIAS = "detectExistingUserFlow";

@InjectPage
ErrorPage errorPage;

// Injecting the mail server also configures the SMTP settings of the realms created for the test,
// so Keycloak can send the account linking emails to it.
@InjectMailServer
MailServer mail;

// The account linking email may be confirmed from a different browser/session than the one that
// started the first-broker-login flow.
@InjectWebDriver(ref = "driver2")
ManagedWebDriver secondDriver;

@InjectPage(webDriverRef = "driver2")
ProceedPage secondBrowserProceedPage;

@BeforeEach
void setupDetectExistingUserFlow() {
RealmResource consumer = consumerRealm.admin();
AuthenticationManagementResource authMgmtResource = consumer.flows();

String detectExistingFlowAlias = "detectExistingUserFlow";
AuthenticationFlowRepresentation flow = new AuthenticationFlowRepresentation();
flow.setAlias(detectExistingFlowAlias);
flow.setDescription(detectExistingFlowAlias);
flow.setAlias(DETECT_EXISTING_FLOW_ALIAS);
flow.setDescription(DETECT_EXISTING_FLOW_ALIAS);
flow.setProviderId("basic-flow");
flow.setTopLevel(true);
flow.setBuiltIn(false);
authMgmtResource.createFlow(flow);

AuthenticationFlowRepresentation created = authMgmtResource.getFlows().stream()
.filter(v -> detectExistingFlowAlias.equals(v.getAlias()))
.filter(v -> DETECT_EXISTING_FLOW_ALIAS.equals(v.getAlias()))
.findFirst()
.orElse(null);
assertNotNull(created, "The authentication flow must exist");
Expand All @@ -63,12 +90,12 @@ void setupDetectExistingUserFlow() {

IdentityProviderResource identityConsumerResource = consumer.identityProviders().get(IDP_OIDC_ALIAS);
IdentityProviderRepresentation identityProviderRepresentation = consumer.identityProviders().findAll().get(0);
identityProviderRepresentation.setFirstBrokerLoginFlowAlias(detectExistingFlowAlias);
identityProviderRepresentation.setFirstBrokerLoginFlowAlias(DETECT_EXISTING_FLOW_ALIAS);
identityProviderRepresentation.getConfig().put(IdentityProviderModel.SYNC_MODE, IdentityProviderSyncMode.FORCE.toString());
identityConsumerResource.update(identityProviderRepresentation);

assertEquals(2, authMgmtResource.getFlows().stream()
.filter(v -> detectExistingFlowAlias.equals(v.getAlias()))
.filter(v -> DETECT_EXISTING_FLOW_ALIAS.equals(v.getAlias()))
.findFirst()
.orElseThrow()
.getAuthenticationExecutions()
Expand Down Expand Up @@ -161,4 +188,75 @@ public void loginWhenUserExistsOnConsumer() {
assertEquals(firstname, userRepresentation.getFirstName(), "Firstname is not correct");
assertEquals(lastname, userRepresentation.getLastName(), "Lastname is not correct");
}


@Test
public void testLinkAccountByEmailVerificationDifferentBrowser() throws IOException, MessagingException {
AuthenticationManagementResource authMgmtResource = consumerRealm.admin().flows();
addEmailVerificationExecution(authMgmtResource);

consumerRealm.updateWithCleanup(realm -> realm.verifyEmail(true));

// don't trust the email from the IdP, so the email verification required action is enforced
consumerRealm.updateIdentityProvider(IDP_OIDC_ALIAS, rep -> rep.setTrustEmail(false));

// to avoid update profile required action
UserRepresentation brokerUser = providerRealm.admin().users().search(getUserLogin()).get(0);
brokerUser.setFirstName("f");
brokerUser.setLastName("l");
providerRealm.admin().users().get(brokerUser.getId()).update(brokerUser);
// creates a user in the consumer realm to link the account
brokerUser.setId(null);
try (Response response = consumerRealm.admin().users().create(brokerUser)) {
String consumerUserId = ApiUtil.getCreatedId(response);
consumerRealm.cleanup().add(realm -> realm.users().get(consumerUserId).remove());
}

// link the account
oauth.openLoginForm();
logInWithBroker();
loginPage.fillLogin(getUserLogin(), getUserPassword());
loginPage.submit();

// the existing consumer user is detected and, as its email is verified, an email with instructions
// to link the account is sent
assertTrue(mail.waitForIncomingEmail(1), "An email with instructions to link the account was expected");
MimeMessage lastReceivedMessage = mail.getLastReceivedMessage();
assertNotNull(lastReceivedMessage);
assertEquals(getUserEmail(), MailUtils.getRecipient(lastReceivedMessage));
MailUtils.EmailBody body = MailUtils.getBody(lastReceivedMessage);
assertTrue(body.getText().contains("Someone wants to link your"),
"The email should contain the account linking instructions");
String verificationUrl = MailUtils.getPasswordResetEmailLink(body);

// confirm the email using a different browser
secondDriver.open(verificationUrl.trim());
secondBrowserProceedPage.assertCurrent();
secondBrowserProceedPage.clickProceedLink();

// clear cookies to start a fresh browser instance and try to log in again
webDriver.cookies().deleteAll();
oauth.openLoginForm();
logInWithBroker();
loginPage.fillPassword(getUserPassword());
loginPage.submit();
assertTrue(oauth.parseLoginResponse().isSuccess(), "Broker login should complete successfully");
}

private void addEmailVerificationExecution(AuthenticationManagementResource authMgmtResource) {
authMgmtResource.addExecution(DETECT_EXISTING_FLOW_ALIAS,
Comment thread
olivierboudet marked this conversation as resolved.
Resolved
Map.of("provider", IdpEmailVerificationAuthenticatorFactory.PROVIDER_ID));

AuthenticationExecutionInfoRepresentation addedExecution = authMgmtResource.getExecutions(DETECT_EXISTING_FLOW_ALIAS).stream()
.filter(execution -> IdpEmailVerificationAuthenticatorFactory.PROVIDER_ID.equals(execution.getProviderId()))
.findFirst()
.orElseThrow();

addedExecution.setRequirement(AuthenticationExecutionModel.Requirement.REQUIRED.name());
addedExecution.setPriority(15);
authMgmtResource.updateExecutions(DETECT_EXISTING_FLOW_ALIAS, addedExecution);

// revert the flow change once the test is done
consumerRealm.cleanup().add(realm -> realm.flows().removeExecution(addedExecution.getId()));
}
}
Loading