org.keycloak.adapters.authentication

Class JWTClientCredentialsProvider

java.lang.Object

org.keycloak.adapters.authentication.JWTClientCredentialsProvider

All Implemented Interfaces:

ClientCredentialsProvider

public class JWTClientCredentialsProvider
extends Object
implements ClientCredentialsProvider

Client authentication based on JWT signed by client private key . See specs for more details.

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_ID

Constructor Summary

Constructors

Constructor and Description
JWTClientCredentialsProvider()

Method Summary

Modifier and Type	Method and Description
protected JsonWebToken	createRequestToken(String clientId, String realmInfoUrl)
String	createSignedRequestToken(String clientId, String realmInfoUrl)
String	getId() Return the ID of the provider.
void	init(KeycloakDeployment deployment, Object config) Called by adapter during deployment of your application.
void	setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formParams) Called every time adapter needs to perform backchannel request
void	setPrivateKey(PrivateKey privateKey)
void	setTokenTimeout(int tokenTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

JWTClientCredentialsProvider

public JWTClientCredentialsProvider()

Method Detail

getId

public String getId()

Description copied from interface: ClientCredentialsProvider

Return the ID of the provider. Use this ID in the keycloak.json configuration as the subelement of the "credentials" element For example if your provider has ID "kerberos-keytab" , use the configuration like this in keycloak.json "credentials": { "kerberos-keytab": { "keytab": "/tmp/foo" } }

Specified by:

getId in interface ClientCredentialsProvider

Returns:

setPrivateKey

public void setPrivateKey(PrivateKey privateKey)

setTokenTimeout

public void setTokenTimeout(int tokenTimeout)

init

public void init(KeycloakDeployment deployment,
                 Object config)

Description copied from interface: ClientCredentialsProvider

Called by adapter during deployment of your application. You can for example read configuration and init your authenticator here

Specified by:

init in interface ClientCredentialsProvider

Parameters:

deployment - the adapter configuration

config - the configuration of your provider read from keycloak.json . For the kerberos-keytab example above, it will return map with the single key "keytab" with value "/tmp/foo"

setClientCredentials

public void setClientCredentials(KeycloakDeployment deployment,
                                 Map<String,String> requestHeaders,
                                 Map<String,String> formParams)

Description copied from interface: ClientCredentialsProvider

Called every time adapter needs to perform backchannel request

Specified by:

setClientCredentials in interface ClientCredentialsProvider

Parameters:

deployment - Fully resolved deployment

requestHeaders - You should put any HTTP request headers you want to use for authentication of client. These headers will be attached to the HTTP request sent to Keycloak server

formParams - You should put any request parameters you want to use for authentication of client. These parameters will be attached to the HTTP request sent to Keycloak server

createSignedRequestToken

public String createSignedRequestToken(String clientId,
                                       String realmInfoUrl)

createRequestToken

protected JsonWebToken createRequestToken(String clientId,
                                          String realmInfoUrl)