Client Authenticator configurable per client

Closes #42044

Signed-off-by: Giuseppe Graziano <g.graziano94@gmail.com>
This commit is contained in:
Giuseppe Graziano
2025-09-11 13:02:09 +02:00
committed by Marek Posolda
parent 26597c2d9a
commit fd7f5351ad
6 changed files with 55 additions and 13 deletions

View File

@@ -28,6 +28,7 @@ public class ComponentTypeRepresentation {
protected String id;
protected String helpText;
protected List<ConfigPropertyRepresentation> properties;
protected List<ConfigPropertyRepresentation> clientProperties;
protected Map<String, Object> metadata = new HashMap<>();
@@ -56,6 +57,14 @@ public class ComponentTypeRepresentation {
this.properties = properties;
}
public List<ConfigPropertyRepresentation> getClientProperties() {
return clientProperties;
}
public void setClientProperties(List<ConfigPropertyRepresentation> clientProperties) {
this.clientProperties = clientProperties;
}
/**
* Extra information about the component
* that might come from annotations or interfaces that the component implements.

View File

@@ -34,6 +34,7 @@ import { FormFields } from "../ClientDetails";
import { ClientSecret } from "./ClientSecret";
import { SignedJWT } from "./SignedJWT";
import { X509 } from "./X509";
import { convertAttributeNameToForm } from "../../util";
type AccessToken = {
registrationAccessToken: string;
@@ -80,7 +81,7 @@ export const Credentials = ({ client, save, refresh }: CredentialsProps) => {
() =>
componentTypes?.["org.keycloak.authentication.ClientAuthenticator"]?.find(
(p) => p.id === clientAuthenticatorType,
)?.properties,
)?.clientProperties,
[clientAuthenticatorType, componentTypes],
);
@@ -186,7 +187,9 @@ export const Credentials = ({ client, save, refresh }: CredentialsProps) => {
<Form>
<DynamicComponents
properties={providerProperties}
convertToName={(name) => `attributes.${name}`}
convertToName={(name) =>
convertAttributeNameToForm(`attributes.${name}`)
}
/>
</Form>
)}

View File

@@ -7,5 +7,6 @@ export default interface ComponentTypeRepresentation {
id: string;
helpText: string;
properties: ConfigPropertyRepresentation[];
clientProperties: ConfigPropertyRepresentation[];
metadata: { [index: string]: any };
}

View File

@@ -18,10 +18,9 @@
package org.keycloak.authentication;
import org.keycloak.models.ClientModel;
import org.keycloak.provider.ProviderConfigProperty;
import org.keycloak.provider.ConfiguredPerClientProvider;
import org.keycloak.provider.ProviderFactory;
import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -34,7 +33,7 @@ import java.util.Set;
*
* @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
*/
public interface ClientAuthenticatorFactory extends ProviderFactory<ClientAuthenticator>, ConfigurableAuthenticatorFactory {
public interface ClientAuthenticatorFactory extends ProviderFactory<ClientAuthenticator>, ConfigurableAuthenticatorFactory, ConfiguredPerClientProvider {
ClientAuthenticator create();
/**
@@ -45,14 +44,6 @@ public interface ClientAuthenticatorFactory extends ProviderFactory<ClientAuthen
@Override
boolean isConfigurable();
/**
* List of config properties for this client implementation. Those will be shown in admin console in clients credentials tab and can be configured per client.
* Applicable only if "isConfigurablePerClient" is true
*
* @return
*/
List<ProviderConfigProperty> getConfigPropertiesPerClient();
/**
* Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client. Some implementations
* may return just template and user needs to edit the values according to his environment (For example fill the location of keystore file)

View File

@@ -0,0 +1,33 @@
/*
* Copyright 2025 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.provider;
import java.util.List;
/**
* @author <a href="mailto:ggrazian@redhat.com">Giuseppe Graziano</a>
*/
public interface ConfiguredPerClientProvider extends ConfiguredProvider {
/**
* List of config properties for this client implementation. Those will be shown in admin console in clients credentials tab and can be configured per client.
*
* @return
*/
List<ProviderConfigProperty> getConfigPropertiesPerClient();
}

View File

@@ -21,6 +21,7 @@ import org.eclipse.microprofile.openapi.annotations.Operation;
import org.eclipse.microprofile.openapi.annotations.extensions.Extension;
import org.eclipse.microprofile.openapi.annotations.tags.Tag;
import org.jboss.resteasy.reactive.NoCache;
import org.keycloak.provider.ConfiguredPerClientProvider;
import org.keycloak.broker.provider.IdentityProvider;
import org.keycloak.broker.provider.IdentityProviderFactory;
import org.keycloak.broker.social.SocialIdentityProvider;
@@ -184,6 +185,10 @@ public class ServerInfoAdminResource {
if (pi instanceof ComponentFactory) {
rep.setMetadata(((ComponentFactory)pi).getTypeMetadata());
}
if (pi instanceof ConfiguredPerClientProvider) {
List<ProviderConfigProperty> configClientProperties = ((ConfiguredPerClientProvider) pi).getConfigPropertiesPerClient();
rep.setClientProperties(ModelToRepresentation.toRepresentation(configClientProperties));
}
List<ComponentTypeRepresentation> reps = info.getComponentTypes().get(spi.getProviderClass().getName());
if (reps == null) {
reps = new LinkedList<>();