Package org.keycloak.protocol.oid4vc

Class OID4VCLoginProtocolFactory

java.lang.Object

org.keycloak.protocol.oid4vc.OID4VCLoginProtocolFactory

All Implemented Interfaces:

LoginProtocolFactory, OID4VCEnvironmentProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<LoginProtocol>

public class OID4VCLoginProtocolFactory
extends Object
implements LoginProtocolFactory, OID4VCEnvironmentProviderFactory

Factory for creating all OID4VC related endpoints and the default mappers.

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTOCOL_ID

Constructor Summary

Constructors

Constructor	Description
OID4VCLoginProtocolFactory()

Method Summary

Modifier and Type	Method	Description
void	addClientScopeDefaults(ClientScopeRepresentation clientScope)	Add default values to ClientScopeRepresentations that refer to the specific login-protocol
void	close()	This is called when the server shuts down.
LoginProtocol	create(KeycloakSession session)
void	createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients)	Called when new realm is created
Object	createProtocolEndpoint(KeycloakSession keycloakSession, EventBuilder event)
Map<String,ProtocolMapperModel>	getBuiltinMappers()	List of built in protocol mappers that can be used to apply to clients.
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isValidClientScope(KeycloakSession session, ClientModel client, ClientScopeModel clientScope)	Test if the clientScope is valid for particular client.
int	order()	defines the option-order in the admin-ui
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	setupClientDefaults(ClientRepresentation rep, ClientModel newClient)	Setup default values for new clients.
void	validateClientScope(KeycloakSession session, ClientScopeRepresentation clientScope)	Invoked during client-scope creation or update to add additional validation hooks specific to target protocol.
void	validateClientScopeAssignment(KeycloakSession session, ClientScopeModel clientScope, boolean defaultScope, RealmModel realm)	Validates whether a client scope can be assigned as Default or Optional to a client or realm.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.protocol.oid4vc.OID4VCEnvironmentProviderFactory

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata

Field Details

PROTOCOL_ID

public static final String PROTOCOL_ID

See Also:

• Constant Field Values

Constructor Details

OID4VCLoginProtocolFactory

public OID4VCLoginProtocolFactory()

Method Details

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<LoginProtocol>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<LoginProtocol>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<LoginProtocol>

getBuiltinMappers

public Map<String,ProtocolMapperModel> getBuiltinMappers()

Description copied from interface: LoginProtocolFactory

List of built in protocol mappers that can be used to apply to clients.

Specified by:

getBuiltinMappers in interface LoginProtocolFactory

Returns:

createProtocolEndpoint

public Object createProtocolEndpoint(KeycloakSession keycloakSession,
 EventBuilder event)

Specified by:

createProtocolEndpoint in interface LoginProtocolFactory

createDefaultClientScopes

public void createDefaultClientScopes(RealmModel newRealm,
 boolean addScopesToExistingClients)

Description copied from interface: LoginProtocolFactory

Called when new realm is created

Specified by:

createDefaultClientScopes in interface LoginProtocolFactory

addScopesToExistingClients - If true, then existing realm clients will be updated (created realm default scopes will be added to them)

setupClientDefaults

public void setupClientDefaults(ClientRepresentation rep,
 ClientModel newClient)

Description copied from interface: LoginProtocolFactory

Setup default values for new clients. This expects that the representation has already set up the client

Specified by:

setupClientDefaults in interface LoginProtocolFactory

addClientScopeDefaults

public void addClientScopeDefaults(ClientScopeRepresentation clientScope)

Description copied from interface: LoginProtocolFactory

Add default values to ClientScopeRepresentations that refer to the specific login-protocol

Specified by:

addClientScopeDefaults in interface LoginProtocolFactory

validateClientScope

public void validateClientScope(KeycloakSession session,
 ClientScopeRepresentation clientScope)
                         throws ErrorResponseException

Description copied from interface: LoginProtocolFactory

Invoked during client-scope creation or update to add additional validation hooks specific to target protocol. May throw errorResponseException in case

Specified by:

validateClientScope in interface LoginProtocolFactory

Parameters:

session - Keycloak session

clientScope - client scope to create or update

Throws:

ErrorResponseException

isValidClientScope

public boolean isValidClientScope(KeycloakSession session,
 ClientModel client,
 ClientScopeModel clientScope)

Description copied from interface: LoginProtocolFactory

Test if the clientScope is valid for particular client. Usually called during protocol requests

Specified by:

isValidClientScope in interface LoginProtocolFactory

create

public LoginProtocol create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<LoginProtocol>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<LoginProtocol>

order

public int order()

defines the option-order in the admin-ui

Specified by:

order in interface ProviderFactory<LoginProtocol>

validateClientScopeAssignment

public void validateClientScopeAssignment(KeycloakSession session,
 ClientScopeModel clientScope,
 boolean defaultScope,
 RealmModel realm)

Description copied from interface: LoginProtocolFactory

Validates whether a client scope can be assigned as Default or Optional to a client or realm. This method is called before assigning a client scope to ensure protocol-specific restrictions are enforced.

Specified by:

validateClientScopeAssignment in interface LoginProtocolFactory

Parameters:

session - the Keycloak session

clientScope - the client scope to be assigned

defaultScope - true if assigning as Default scope, false if Optional

realm - the realm where the assignment is happening