Package org.keycloak.protocol.oid4vc.issuance.mappers

Class OID4VCMapper

java.lang.Object

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

All Implemented Interfaces:

OID4VCEnvironmentProviderFactory, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

Direct Known Subclasses:

OID4VCContextMapper, OID4VCGeneratedIdMapper, OID4VCIssuedAtTimeClaimMapper, OID4VCStaticClaimMapper, OID4VCSubjectIdMapper, OID4VCTargetRoleMapper, OID4VCTypeMapper, OID4VCUserAttributeMapper

public abstract class OID4VCMapper
extends Object
implements ProtocolMapper, OID4VCEnvironmentProviderFactory

Base class for OID4VC Mappers, to provide common configuration and functionality for all of them

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLAIM_NAME
protected String	format
protected ProtocolMapperModel	mapperModel
static final String	USER_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor	Description
OID4VCMapper()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
protected List<String>	getAttributePrefix()
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
protected abstract List<ProviderConfigProperty>	getIndividualConfigProperties()
List<String>	getMetadataAttributePath()	must return ordered list of attribute-names as they are added into the credential.
String	getProtocol()
boolean	includeInMetadata()	some specific claims should not be added into the metadata.
void	init(Config.Scope scope)	Only called once when the factory is first created.
void	postInit(KeycloakSessionFactory keycloakSessionFactory)	Called after all provider factories have been initialized
abstract void	setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)	Set the claims to credential, like f.e.
abstract void	setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)	Set the claims to the credential subject.
OID4VCMapper	setMapperModel(ProtocolMapperModel mapperModel, String format)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getHelpText

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

isSupported

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getDisplayType, getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

create, dependsOn, getConfigMetadata, getId, order

Field Details

CLAIM_NAME

public static final String CLAIM_NAME

See Also:

• Constant Field Values

USER_ATTRIBUTE_KEY

public static final String USER_ATTRIBUTE_KEY

See Also:

• Constant Field Values

mapperModel

protected ProtocolMapperModel mapperModel

format

protected String format

Constructor Details

OID4VCMapper

public OID4VCMapper()

Method Details

getIndividualConfigProperties

protected abstract List<ProviderConfigProperty> getIndividualConfigProperties()

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

setMapperModel

public OID4VCMapper setMapperModel(ProtocolMapperModel mapperModel,
 String format)

includeInMetadata

public boolean includeInMetadata()

some specific claims should not be added into the metadata. Examples are jti, sub, iss etc. Since we have the possibility to add these credentials with specific claims we should also be able to exclude these specific attributes from the metadata

getMetadataAttributePath

public List<String> getMetadataAttributePath()

must return ordered list of attribute-names as they are added into the credential. This is required for the metadata endpoint to add the appropriate path-attributes into the claim's description.

Returns:

the attribute path that is being mapped into the credential

getAttributePrefix

protected List<String> getAttributePrefix()

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface ProtocolMapper

init

public void init(Config.Scope scope)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<ProtocolMapper>

postInit

public void postInit(KeycloakSessionFactory keycloakSessionFactory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<ProtocolMapper>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<ProtocolMapper>

setClaimsForCredential

public abstract void setClaimsForCredential(VerifiableCredential verifiableCredential,
 UserSessionModel userSessionModel)

Set the claims to credential, like f.e. the context

setClaimsForSubject

public abstract void setClaimsForSubject(Map<String,Object> claims,
 UserSessionModel userSessionModel)

Set the claims to the credential subject.