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

Class OID4VCTargetRoleMapper

java.lang.Object

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

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCTargetRoleMapper

All Implemented Interfaces:

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

public class OID4VCTargetRoleMapper
extends OID4VCMapper

Adds the users roles to the credential subject

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_CONFIG_KEY
static final String	DEFAULT_CLAIM_NAME
static final String	MAPPER_ID

Fields inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

CLAIM_NAME, format, MAPPER_MISSING_MDOC_NAMESPACE_ERROR, MAPPER_RESERVED_CLAIM_ERROR, mapperModel, MDOC_NAMESPACE, USER_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor	Description
OID4VCTargetRoleMapper()
OID4VCTargetRoleMapper(KeycloakSession keycloakSession)

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String name)
ProtocolMapper	create(KeycloakSession session)
protected List<String>	getClaimLookupPath()	Returns the raw claim lookup path in the intermediate map populated by OID4VCMapper.setClaim(Map, UserSessionModel).
String	getDisplayType()
String	getHelpText()
String	getId()
protected List<ProviderConfigProperty>	getIndividualConfigProperties()
List<String>	getMetadataAttributePath()	Returns the externally visible claim path used in credential metadata and authorization_details validation.
protected String	resolveClaimName(ProtocolMapperModel mapperModel)	Resolves the effective claim name written by this mapper, based on the given configuration.
void	setClaim(Map<String,Object> claims, UserSessionModel userSessionModel)	Set the claims to the credential subject.
void	setClaim(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)	Set the claims to credential, like f.e. the context
void	validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)	Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

Methods inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

close, getAllowedReservedClaims, getAttributePrefix, getClaimLookupPath, getClaimName, getClaimName, getConfigProperties, getDisplayCategory, getMapperName, getMetadataAttributePath, getProtocol, includeInMetadata, init, passesMappingGuards, postInit, prefixMetadataAttributePath, setClaimWithMetadataPrefix, setMapperModel, supportsCredentialFormat, validate, validateAgainstSensitiveMappings, validateMdocNamespace

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

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

isSupported

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getEffectiveModel, getPriority

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

DEFAULT_CLAIM_NAME

public static final String DEFAULT_CLAIM_NAME

See Also:

• Constant Field Values

CLIENT_CONFIG_KEY

public static final String CLIENT_CONFIG_KEY

See Also:

• Constant Field Values

MAPPER_ID

public static final String MAPPER_ID

See Also:

• Constant Field Values

Constructor Details

OID4VCTargetRoleMapper

public OID4VCTargetRoleMapper()

OID4VCTargetRoleMapper

public OID4VCTargetRoleMapper(KeycloakSession keycloakSession)

Method Details

getIndividualConfigProperties

protected List<ProviderConfigProperty> getIndividualConfigProperties()

Specified by:

getIndividualConfigProperties in class OID4VCMapper

resolveClaimName

protected String resolveClaimName(ProtocolMapperModel mapperModel)

Description copied from class: OID4VCMapper

Resolves the effective claim name written by this mapper, based on the given configuration. Subclasses override this when they derive the claim name with a fallback (e.g. user attribute or a default claim name).

Overrides:

resolveClaimName in class OID4VCMapper

getMetadataAttributePath

public List<String> getMetadataAttributePath()

Description copied from class: OID4VCMapper

Returns the externally visible claim path used in credential metadata and authorization_details validation. JSON credentials use their normal credentialSubject/top-level paths; mDoc prepends the configured namespace because OID4VCI mDoc paths address namespace -> data element -> optional nested value.

Overrides:

getMetadataAttributePath in class OID4VCMapper

getClaimLookupPath

protected List<String> getClaimLookupPath()

Description copied from class: OID4VCMapper

Returns the raw claim lookup path in the intermediate map populated by OID4VCMapper.setClaim(Map, UserSessionModel). This is intentionally separate from OID4VCMapper.getMetadataAttributePath(): mDoc metadata paths add a namespace that is not present in the raw mapper output, and simple mappers may write a dotted claim name as one literal key.

Overrides:

getClaimLookupPath in class OID4VCMapper

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

create

public static ProtocolMapperModel create(String name)

create

public ProtocolMapper create(KeycloakSession session)

validateConfig

public void validateConfig(KeycloakSession session,
 RealmModel realm,
 ProtocolMapperContainerModel client,
 ProtocolMapperModel mapperModel)
                    throws ProtocolMapperConfigException

Description copied from interface: ProtocolMapper

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

Specified by:

validateConfig in interface ProtocolMapper

Overrides:

validateConfig in class OID4VCMapper

client - client or clientTemplate

Throws:

ProtocolMapperConfigException - if configuration provided in mapperModel is not valid

getId

public String getId()

setClaim

public void setClaim(VerifiableCredential verifiableCredential,
 UserSessionModel userSessionModel)

Description copied from class: OID4VCMapper

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

Specified by:

setClaim in class OID4VCMapper

setClaim

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

Description copied from class: OID4VCMapper

Set the claims to the credential subject.

Specified by:

setClaim in class OID4VCMapper