8000 Apply client-attributes condition when a client is created by cipherprofessor · Pull Request #55038 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,18 @@
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.utils.MapperTypeSerializer;
import org.keycloak.representations.idm.ClientPolicyConditionConfigurationRepresentation;
import org.keycloak.representations.idm.ClientRepresentation;
import org.keycloak.services.clientpolicy.ClientPolicyContext;
import org.keycloak.services.clientpolicy.ClientPolicyException;
import org.keycloak.services.clientpolicy.ClientPolicyVote;
import org.keycloak.services.clientpolicy.context.ClientCRUDContext;
import org.keycloak.services.clientpolicy.context.ClientModelContext;
import org.keycloak.services.clientpolicy.context.PreAuthorizationRequestContext;

import org.jboss.logging.Logger;

import static org.keycloak.services.clientpolicy.ClientPolicyEvent.PRE_AUTHORIZATION_REQUEST;
import static org.keycloak.services.clientpolicy.ClientPolicyEvent.REGISTER;

/**
* @author <a href="mailto:yoshiyuki.tabata.jy@hitachi.com">Yoshiyuki Tabata</a>
Expand Down Expand Up @@ -75,9 +78,15 @@ public ClientPolicyVote applyPolicy(ClientPolicyContext context) throws ClientPo
ClientModel client = session.getContext().getRealm().getClientByClientId(parc.getClientId());
if (isAttributesMatched(client)) return ClientPolicyVote.YES;
return ClientPolicyVote.NO;
} else if (context.getEvent() == REGISTER && context instanceof ClientCRUDContext clientCRUDContext) {
// The client does not exist yet, so the attributes of the proposed client are the only ones available
if (isProposedAttributesMatched(clientCRUDContext)) return ClientPolicyVote.YES;
return ClientPolicyVote.NO;
} else if (context instanceof ClientModelContext clientModelContext) {
ClientModel client = clientModelContext.getClient();
if (isAttributesMatched(client)) return ClientPolicyVote.YES;
// In case that there is an attempt to update the client to the matching attributes, condition should be also evaluated to success
if (context instanceof ClientCRUDContext clientCRUDContext && isProposedAttributesMatched(clientCRUDContext)) return ClientPolicyVote.YES;
return ClientPolicyVote.NO;
} else {
return ClientPolicyVote.ABSTAIN;
Expand All @@ -86,12 +95,21 @@ public ClientPolicyVote applyPolicy(ClientPolicyContext context) throws ClientPo

private boolean isAttributesMatched(ClientModel client) {
if (client == null) return false;
return isAttributesMatched(client.getAttributes());
}

private boolean isProposedAttributesMatched(ClientCRUDContext context) {
ClientRepresentation clientRep = context.getProposedClientRepresentation();
if (clientRep == null) return false;
return isAttributesMatched(clientRep.getAttributes());
}

private boolean isAttributesMatched(Map<String, String> clientAttributes) {
if (clientAttributes == null) return false;

Map<String, List<String>> attributesForMatching = getAttributesForMatching();
if (attributesForMatching == null) return false;

Map<String, String> clientAttributes = client.getAttributes();

if (logger.isTraceEnabled()) {
clientAttributes.forEach((i, j) -> logger.tracev("client attribute assigned = {0}: {1}", i, j));
attributesForMatching.forEach((i, j) -> logger.tracev("client attribute for matching = {0}: {1}", i, j));
Expand All @@ -113,7 +131,7 @@ private boolean isAttributesMatched(ClientModel client) {
return false;
}
String value = entry.getValue().get(0);
return clientAttributes.containsKey(key) && clientAttributes.get(key).equals(value);
return value.equals(clientAttributes.get(key));
});
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
package org.keycloak.tests.client.policies;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.keycloak.common.util.MultivaluedHashMap;
import org.keycloak.protocol.oidc.OIDCLoginProtocol;
import org.keycloak.protocol.saml.SamlProtocol;
import org.keycloak.representations.idm.ClientRepresentation;
import org.keycloak.services.clientpolicy.ClientPolicyException;
import org.keycloak.services.clientpolicy.condition.AnyClientConditionFactory;
import org.keycloak.services.clientpolicy.condition.ClientAccessTypeCondition;
import org.keycloak.services.clientpolicy.condition.ClientAccessTypeConditionFactory;
import org.keycloak.services.clientpolicy.condition.ClientAttributesCondition;
import org.keycloak.services.clientpolicy.condition.ClientAttributesConditionFactory;
import org.keycloak.services.clientpolicy.condition.ClientProtocolCondition;
import org.keycloak.services.clientpolicy.condition.ClientProtocolConditionFactory;
import org.keycloak.services.clientpolicy.executor.FullScopeDisabledExecutorFactory;
Expand All @@ -22,6 +27,7 @@

import static org.keycloak.tests.utils.ClientPoliciesUtil.createAnyClientConditionConfig;
import static org.keycloak.tests.utils.ClientPoliciesUtil.createClientAccessTypeConditionConfig;
import static org.keycloak.tests.utils.ClientPoliciesUtil.createClientAttributesConditionConfig;
import static org.keycloak.tests.utils.ClientPoliciesUtil.createClientProtocolConditionConfig;
import static org.keycloak.tests.utils.ClientPoliciesUtil.createFullScopeDisabledExecutorConfig;
import static org.keycloak.tests.utils.ClientPoliciesUtil.createRejectisResourceOwnerPasswordCredentialsGrantExecutorConfig;
Expand Down Expand Up @@ -154,6 +160,61 @@ public void testClientAccessTypeConditionClientCRUD() throws Exception {
assertFalse(foundRep.isPublicClient());
}

@Test
public void testClientAttributesConditionClientCRUD() throws Exception {
// Setup policy: condition = client attribute "policy-group" is "restricted", executor = reject resource owner password credentials grant
RejectResourceOwnerPasswordCredentialsGrantExecutor.Configuration rejectResourceOwnerConfig =
createRejectisResourceOwnerPasswordCredentialsGrantExecutorConfig(false);
MultivaluedHashMap<String, String> attributes = new MultivaluedHashMap<>();
attributes.putSingle("policy-group", "restricted");
ClientAttributesCondition.Configuration attributesConditionConfig = createClientAttributesConditionConfig(attributes);
setupPolicy(realm, RejectResourceOwnerPasswordCredentialsGrantExecutorFactory.PROVIDER_ID, rejectResourceOwnerConfig,
ClientAttributesConditionFactory.PROVIDER_ID, attributesConditionConfig);

// Attempt to create a client with the attribute and directAccessGrants enabled. Should fail because condition matches.
try {
createClientByAdmin(realm, "restricted-client", OIDCLoginProtocol.LOGIN_PROTOCOL, clientRep -> {
clientRep.setAttributes(new HashMap<>(Map.of("policy-group", "restricted")));
clientRep.setDirectAccessGrantsEnabled(true);
});
fail();
} catch (ClientPolicyException cpe) {
assertEquals("Invalid client metadata: resource owner password credentials grant enabled", cpe.getErrorDetail());
}

// Create a client with another value of the attribute and directAccessGrants enabled. Should succeed because condition does not match.
String clientUUID = createClientByAdmin(realm, "other-client", OIDCLoginProtocol.LOGIN_PROTOCOL, clientRep -> {
clientRep.setAttributes(new HashMap<>(Map.of("policy-group", "other")));
clientRep.setDirectAccessGrantsEnabled(true);
});

// Attempt to update the client to the matching value of the attribute while keeping directAccessGrants enabled.
// Should fail because updating TO the 8000 matching attribute must also trigger the condition.
try {
updateClientByAdmin(realm, clientUUID, clientRep -> {
clientRep.getAttributes().put("policy-group", "restricted");
clientRep.setDirectAccessGrantsEnabled(true);
});
fail();
} catch (ClientPolicyException cpe) {
assertEquals("Invalid client metadata: resource owner password credentials grant enabled", cpe.getErrorDetail());
}

// Verify the attribute is unchanged (update was rolled back)
ClientRepresentation foundRep = realm.admin().clients().get(clientUUID).toRepresentation();
assertEquals("other", foundRep.getAttributes().get("policy-group"));

// Update the client to the matching value of the attribute WITHOUT directAccessGrants. Should succeed.
updateClientByAdmin(realm, clientUUID, clientRep -> {
clientRep.getAttributes().put("policy-group", "restricted");
clientRep.setDirectAccessGrantsEnabled(false);
});

// Verify the attribute is now set
foundRep = realm.admin().clients().get(clientUUID).toRepresentation();
assertEquals("restricted", foundRep.getAttributes().get("policy-group"));
}

@Test
public void testFullScopeDisabledExecutorClientCRUD() throws Exception {
// Setup policy: any client condition + FullScopeDisabled executor (validate mode, not auto-configure)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,8 @@ public void testClientAttributesCondition() throws Exception {
}

try {
failLoginByNotFollowingPKCE(clientAlphaId);
// The condition matches when the client is created, so the executor already configured PKCE on it
failLoginByNotFollowingPKCEWithoutClientPolicyValidation(clientAlphaId);
successfulLoginAndLogoutWithPKCE(clientAlphaId, clientSecret, TEST_USER_NAME, TEST_USER_PASSWORD);
} catch (Exception e) {
fail();
Expand Down
Loading
0