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

Class OID4VCIssuedAtTimeClaimMapper

java.lang.Object

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

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCIssuedAtTimeClaimMapper

All Implemented Interfaces:

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

public class OID4VCIssuedAtTimeClaimMapper
extends OID4VCMapper

Map issuance date to the credential, under the default claim name "iat"

subjectProperty can be used to change the claim name.

Source of the information can either be computed, or read from the VerifiableCredential object bearing other claims. Default is the value in the verifiable credential.

We will use the java.time.temporal.ChronoUnit enum values to help flatten down the time.

NOTE: For SD-JWT credentials, this mapper has no effect on `iat` and `exp` claims, which are always sourced from the normalized issuance and expiration date values computed by the Issuer Endpoint.

Author:

Francis Pouatcha

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAPPER_ID
static final String	TRUNCATE_TO_TIME_UNIT_KEY
static final String	VALUE_SOURCE

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
OID4VCIssuedAtTimeClaimMapper()

Method Summary

Modifier and Type	Method	Description
ProtocolMapper	create(KeycloakSession session)
protected Set<String>	getAllowedReservedClaims()	Returns the reserved, issuer-controlled claims this mapper is allowed to write.
String	getDisplayType()
String	getHelpText()
String	getId()
protected List<ProviderConfigProperty>	getIndividualConfigProperties()
boolean	includeInMetadata()	this claim is not added by default to the metadata
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
boolean	supportsCredentialFormat(String credentialFormat)	Some mappers target format-specific container fields instead of subject/data-element claims.

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

close, getAttributePrefix, getClaimLookupPath, getClaimLookupPath, getClaimName, getClaimName, getConfigProperties, getDisplayCategory, getMapperName, getMetadataAttributePath, getMetadataAttributePath, getProtocol, init, passesMappingGuards, postInit, prefixMetadataAttributePath, resolveClaimName, setClaimWithMetadataPrefix, setMapperModel, validate, validateAgainstSensitiveMappings, validateConfig, 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

MAPPER_ID

public static final String MAPPER_ID

See Also:

• Constant Field Values

TRUNCATE_TO_TIME_UNIT_KEY

public static final String TRUNCATE_TO_TIME_UNIT_KEY

See Also:

• Constant Field Values

VALUE_SOURCE

public static final String VALUE_SOURCE

See Also:

• Constant Field Values

Constructor Details

OID4VCIssuedAtTimeClaimMapper

public OID4VCIssuedAtTimeClaimMapper()

Method Details

getIndividualConfigProperties

protected List<ProviderConfigProperty> getIndividualConfigProperties()

Specified by:

getIndividualConfigProperties in class OID4VCMapper

includeInMetadata

public boolean includeInMetadata()

this claim is not added by default to the metadata

Overrides:

includeInMetadata in class OID4VCMapper

supportsCredentialFormat

public boolean supportsCredentialFormat(String credentialFormat)

Description copied from class: OID4VCMapper

Some mappers target format-specific container fields instead of subject/data-element claims. Callers use this hook for both metadata and issuance so unsupported mappers are not advertised or applied for a credential format.

Overrides:

supportsCredentialFormat in class OID4VCMapper

getAllowedReservedClaims

protected Set<String> getAllowedReservedClaims()

Description copied from class: OID4VCMapper

Returns the reserved, issuer-controlled claims this mapper is allowed to write. A mapper may only target a reserved claim listed here; every other reserved claim is rejected. Mappers are denied all reserved claims by default; subclasses that legitimately write a specific issuer-controlled claim (e.g. the generated-id mapper writing 'jti') override this to allow just that claim.

Overrides:

getAllowedReservedClaims in class OID4VCMapper

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

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

create

public ProtocolMapper create(KeycloakSession session)

getId

public String getId()