Skip to content

Fix CIBA bypassing brute force protection (#49791) #49903

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

Open
jimmychakkalakal wants to merge 1 commit into
base: release/26.4
Choose a base branch
from
+188 −3
Open

Fix CIBA bypassing brute force protection (#49791) #49903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions ...a/org/keycloak/protocol/oidc/grants/ciba/endpoints/BackchannelAuthenticationEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.jboss.logging.Logger;
import org.jboss.resteasy.reactive.NoCache;
import org.keycloak.events.Details;
import org.keycloak.http.HttpRequest;
import org.keycloak.OAuth2Constants;
import org.keycloak.OAuthErrorException;
import org.keycloak.authentication.authenticators.util.AuthenticatorUtils;
import org.keycloak.events.Details;
import org.keycloak.events.EventBuilder;
import org.keycloak.events.EventType;
import org.keycloak.models.CibaConfig;
Expand All @@ -44,6 +45,7 @@
import org.keycloak.representations.idm.OAuth2ErrorRepresentation;
import org.keycloak.services.ErrorResponseException;
import org.keycloak.services.clientpolicy.ClientPolicyException;
import org.keycloak.services.managers.BruteForceProtector;
import org.keycloak.util.JsonSerialization;

import jakarta.ws.rs.Consumes;
Expand Down Expand Up @@ -289,8 +291,15 @@ private UserModel resolveUser(BackchannelAuthenticationEndpointRequest endpointR
"invalid user hint", Response.Status.BAD_REQUEST);
}

if (user == null || !user.isEnabled())
throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid user", Response.Status.BAD_REQUEST);
BruteForceProtector protector = session.getProvider(BruteForceProtector.class);
boolean isInvalidUser = (user == null || !user.isEnabled());
if (!isInvalidUser && AuthenticatorUtils.getDisabledByBruteForceEventError(protector, session, realm, user) != null) {
isInvalidUser = true;
}

if (isInvalidUser) {
throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_user", Response.Status.BAD_REQUEST);
}

return user;
}
Expand Down
176 changes: 176 additions & 0 deletions ...tegration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/CIBATest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2520,6 +2520,182 @@ public void testBackchannelAuthenticationFlowWithInvalidScope() throws Exception
}
}

@Test
public void testBackchannelAuthnReqWithBruteForceProtectedUser() throws Exception {
ClientResource clientResource = null;
ClientRepresentation clientRep = null;
RealmRepresentation realmRep = null;
RealmRepresentation backupRealm = null;
Boolean originalDirectAccessGrantsEnabled = null;
try {
final String username = "nutzername-gelb";

clientResource = ApiUtil.findClientByClientId(adminClient.realm(TEST_REALM_NAME), TEST_CLIENT_NAME);
clientRep = clientResource.toRepresentation();

// Enable direct access grants for password grant to work
originalDirectAccessGrantsEnabled = clientRep.isDirectAccessGrantsEnabled();
clientRep.setDirectAccessGrantsEnabled(true);
clientResource.update(clientRep);

prepareCIBASettings(clientResource, clientRep);
oauth.scope(OAuth2Constants.OFFLINE_ACCESS);
oauth.client(TEST_CLIENT_NAME, TEST_CLIENT_PASSWORD);

// Enable brute force protection on realm
realmRep = adminClient.realm(TEST_REALM_NAME).toRepresentation();
backupRealm = new RealmRepresentation();
backupRealm.setBruteForceProtected(realmRep.isBruteForceProtected());
backupRealm.setFailureFactor(realmRep.getFailureFactor());
backupRealm.setMaxDeltaTimeSeconds(realmRep.getMaxDeltaTimeSeconds());

realmRep.setBruteForceProtected(true);
realmRep.setFailureFactor(2);
realmRep.setMaxDeltaTimeSeconds(60);
adminClient.realm(TEST_REALM_NAME).update(realmRep);

List<UserRepresentation> users = adminClient.realm(TEST_REALM_NAME).users().search(username);
assertThat(users.size(), is(1));
UserRepresentation user = users.get(0);

// Trigger brute force lockout with failed login attempts
for (int i = 0; i < 3; i++) {
oauth.client(TEST_CLIENT_NAME, TEST_CLIENT_PASSWORD);
oauth.passwordGrantRequest(username, "wrongpassword").send();
}

// Verify user is actually locked by checking brute force status
Map<String, Object> userAttackInfo = adminClient.realm(TEST_REALM_NAME).attackDetection().bruteForceUserStatus(user.getId());
assertThat((Boolean) userAttackInfo.get("disabled"), is(true));
// numFailures should be at least failureFactor (2), 3rd attempt after lock may not increment counter
assertThat((Integer) userAttackInfo.get("numFailures"), is(equalTo(2)));

// Verify user is temporarily disabled due to brute force
// Backchannel Authentication Request should fail
AuthenticationRequestAcknowledgement response = oauth.ciba().backchannelAuthenticationRequest(username).send();
assertThat(response.getStatusCode(), is(equalTo(400)));
assertThat(response.getError(), is(OAuthErrorException.INVALID_REQUEST));
assertThat(response.getErrorDescription(), is("invalid_user"));

// Clear brute force lockout
adminClient.realm(TEST_REALM_NAME).attackDetection().clearBruteForceForUser(user.getId());

// Verify CIBA works after clearing lockout
response = oauth.ciba().backchannelAuthenticationRequest(username).send();
assertThat(response.getStatusCode(), is(equalTo(200)));
assertThat(response.getAuthReqId(), notNullValue());
} finally {
revertCIBASettings(clientResource, clientRep);
// Restore direct access grants setting
if (clientResource != null && clientRep != null && originalDirectAccessGrantsEnabled != null) {
clientRep.setDirectAccessGrantsEnabled(originalDirectAccessGrantsEnabled);
clientResource.update(clientRep);
}
// Restore realm brute force settings
if (realmRep != null && backupRealm != null) {
realmRep.setBruteForceProtected(backupRealm.isBruteForceProtected());
realmRep.setFailureFactor(backupRealm.getFailureFactor());
realmRep.setMaxDeltaTimeSeconds(backupRealm.getMaxDeltaTimeSeconds());
adminClient.realm(TEST_REALM_NAME).update(realmRep);
}
}
}

@Test
public void testBackchannelAuthnReqWithPermanentlyLockedUser() throws Exception {
ClientResource clientResource = null;
ClientRepresentation clientRep = null;
RealmRepresentation realmRep = null;
RealmRepresentation backupRealm = null;
Boolean originalDirectAccessGrantsEnabled = null;
try {
final String username = "nutzername-schwarz";

clientResource = ApiUtil.findClientByClientId(adminClient.realm(TEST_REALM_NAME), TEST_CLIENT_NAME);
clientRep = clientResource.toRepresentation();

// Enable direct access grants for password grant to work
originalDirectAccessGrantsEnabled = clientRep.isDirectAccessGrantsEnabled();
clientRep.setDirectAccessGrantsEnabled(true);
clientResource.update(clientRep);

prepareCIBASettings(clientResource, clientRep);
oauth.scope(OAuth2Constants.OFFLINE_ACCESS);
oauth.client(TEST_CLIENT_NAME, TEST_CLIENT_PASSWORD);

realmRep = adminClient.realm(TEST_REALM_NAME).toRepresentation();
backupRealm = new RealmRepresentation();
backupRealm.setBruteForceProtected(realmRep.isBruteForceProtected());
backupRealm.setFailureFactor(realmRep.getFailureFactor());
backupRealm.setMaxDeltaTimeSeconds(realmRep.getMaxDeltaTimeSeconds());
backupRealm.setPermanentLockout(realmRep.isPermanentLockout());
backupRealm.setMaxTemporaryLockouts(realmRep.getMaxTemporaryLockouts());

realmRep.setBruteForceProtected(true);
realmRep.setFailureFactor(2);
realmRep.setMaxDeltaTimeSeconds(60);
realmRep.setPermanentLockout(true);
// Enable permanent lockout brute force protection on realm
realmRep.setMaxTemporaryLockouts(0);
adminClient.realm(TEST_REALM_NAME).update(realmRep);

List<UserRepresentation> users = adminClient.realm(TEST_REALM_NAME).users().search(username);
assertThat(users.size(), is(1));
UserRepresentation user = users.get(0);

// Trigger permanent brute force lockout with failed login attempts
for (int i = 0; i < 3; i++) {
oauth.client(TEST_CLIENT_NAME, TEST_CLIENT_PASSWORD);
oauth.passwordGrantRequest(username, "wrongpassword").send();
}

// Verify user is actually locked by checking brute force status
Map<String, Object> userAttackInfo = adminClient.realm(TEST_REALM_NAME).attackDetection().bruteForceUserStatus(user.getId());
assertThat((Boolean) userAttackInfo.get("disabled"), is(true));
// numFailures should be at least failureFactor (2), 3rd attempt after lock may not increment counter
assertThat((Integer) userAttackInfo.get("numFailures"), is(equalTo(2)));

// Verify user is permanently locked
AuthenticationRequestAcknowledgement response = oauth.ciba().backchannelAuthenticationRequest(username).send();
assertThat(response.getStatusCode(), is(equalTo(400)));
assertThat(response.getError(), is(OAuthErrorException.INVALID_REQUEST));
assertThat(response.getErrorDescription(), is("invalid_user"));

// Clear brute force lockout and re-enable user (permanent lockout disables the account)
adminClient.realm(TEST_REALM_NAME).attackDetection().clearBruteForceForUser(user.getId());
user.setEnabled(true);
adminClient.realm(TEST_REALM_NAME).users().get(user.getId()).update(user);

// Verify CIBA works after clearing permanent lockout and re-enabling user
response = oauth.ciba().backchannelAuthenticationRequest(username).send();
assertThat(response.getStatusCode(), is(equalTo(200)));
assertThat(response.getAuthReqId(), notNullValue());
} finally {
revertCIBASettings(clientResource, clientRep);
// Restore direct access grants setting
if (clientResource != null && clientRep != null && originalDirectAccessGrantsEnabled != null) {
clientRep.setDirectAccessGrantsEnabled(originalDirectAccessGrantsEnabled);
clientResource.update(clientRep);
}
// Re-enable user if permanently locked (permanent lockout disables the account)
List<UserRepresentation> users = adminClient.realm(TEST_REALM_NAME).users().search("nutzername-gelb");
if (!users.isEmpty()) {
UserRepresentation userToRestore = users.get(0);
userToRestore.setEnabled(true);
adminClient.realm(TEST_REALM_NAME).users().get(userToRestore.getId()).update(userToRestore);
}
// Restore realm brute force settings
if (realmRep != null && backupRealm != null) {
realmRep.setBruteForceProtected(backupRealm.isBruteForceProtected());
realmRep.setFailureFactor(backupRealm.getFailureFactor());
realmRep.setMaxDeltaTimeSeconds(backupRealm.getMaxDeltaTimeSeconds());
realmRep.setPermanentLockout(backupRealm.isPermanentLockout());
realmRep.setMaxTemporaryLockouts(backupRealm.getMaxTemporaryLockouts());
adminClient.realm(TEST_REALM_NAME).update(realmRep);
}
}
}

private void testBackchannelAuthenticationFlowNotRegisterSigAlgInAdvanceWithSignedAuthentication(String clientName, boolean useRequestUri, String requestedSigAlg, String sigAlg, int statusCode, String errorDescription) throws Exception {
String clientId = createClientDynamically(clientName, (OIDCClientRepresentation clientRep) -> {
List<String> grantTypes = Optional.ofNullable(clientRep.getGrantTypes()).orElse(new ArrayList<>());
Expand Down
Loading