Package org.keycloak.authentication.authenticators.client

Class ClientIdAndSecretAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator

org.keycloak.authentication.authenticators.client.ClientIdAndSecretAuthenticator

All Implemented Interfaces:

org.keycloak.authentication.ClientAuthenticator, org.keycloak.authentication.ClientAuthenticatorFactory, org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.provider.ConfiguredPerClientProvider, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.ClientAuthenticator>

public class ClientIdAndSecretAuthenticator
extends AbstractClientAuthenticator

Validates client based on "client_id" and "client_secret" sent either in request parameters or in "Authorization: Basic" header . See org.keycloak.adapters.authentication.ClientIdAndSecretAuthenticator for the adapter

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from class org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator

logger

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
ClientIdAndSecretAuthenticator()

Method Summary

Modifier and Type	Method	Description
void	authenticateClient(org.keycloak.authentication.ClientAuthenticationFlowContext context)
Map<String,Object>	getAdapterConfiguration(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
List<org.keycloak.provider.ProviderConfigProperty>	getConfigPropertiesPerClient()
String	getDisplayType()
String	getHelpText()
String	getId()
String	getProtocolAuthenticatorMethod(org.keycloak.representations.idm.ClientRepresentation client)
Set<String>	getProtocolAuthenticatorMethods(String loginProtocol)
org.keycloak.models.AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
boolean	isConfigurable()
void	setClientAuthenticationMethod(org.keycloak.representations.idm.ClientRepresentation client, String protocolAuthMethod)
boolean	supportsSecret()

Methods inherited from class org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator

close, create, create, getReferenceCategory, init, isUserSetupAllowed, postInit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getOptionalReferenceCategories

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

ClientIdAndSecretAuthenticator

public ClientIdAndSecretAuthenticator()

Method Details

authenticateClient

public void authenticateClient(org.keycloak.authentication.ClientAuthenticationFlowContext context)

getDisplayType

public String getDisplayType()

isConfigurable

public boolean isConfigurable()

getRequirementChoices

public org.keycloak.models.AuthenticationExecutionModel.Requirement[] getRequirementChoices()

getHelpText

public String getHelpText()

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

getConfigPropertiesPerClient

public List<org.keycloak.provider.ProviderConfigProperty> getConfigPropertiesPerClient()

getAdapterConfiguration

public Map<String,Object> getAdapterConfiguration(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.ClientModel client)

getId

public String getId()

getProtocolAuthenticatorMethods

public Set<String> getProtocolAuthenticatorMethods(String loginProtocol)

getProtocolAuthenticatorMethod

public String getProtocolAuthenticatorMethod(org.keycloak.representations.idm.ClientRepresentation client)

setClientAuthenticationMethod

public void setClientAuthenticationMethod(org.keycloak.representations.idm.ClientRepresentation client,
 String protocolAuthMethod)

supportsSecret

public boolean supportsSecret()