Package org.keycloak.protocol.oid4vc.model

Class SupportedCredentialConfiguration

java.lang.Object

org.keycloak.protocol.oid4vc.model.SupportedCredentialConfiguration

public class SupportedCredentialConfiguration
extends Object

A supported credential, as used in the Credentials Issuer Metadata in OID4VCI

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREDENTIAL_BUILD_CONFIG_KEY
static final String	DOC_TYPE_KEY
static final String	VERIFIABLE_CREDENTIAL_TYPE_KEY

Constructor Summary

Constructors

Constructor	Description
SupportedCredentialConfiguration()

Method Summary

Modifier and Type	Method	Description
CredentialConfigId	deriveConfigId()
VerifiableCredentialType	deriveType()	Return the format-specific credential type identifier.
boolean	equals(Object o)
CredentialBuildConfig	getCredentialBuildConfig()
CredentialDefinition	getCredentialDefinition()
CredentialMetadata	getCredentialMetadata()
List<Object>	getCredentialSigningAlgValuesSupported()
List<String>	getCryptographicBindingMethodsSupported()
String	getDocType()
String	getFormat()
String	getId()
ProofTypesSupported	getProofTypesSupported()
String	getScope()
String	getVct()
int	hashCode()
static SupportedCredentialConfiguration	parse(KeycloakSession keycloakSession, CredentialScopeModel credentialScope, List<String> globalSupportedSigningAlgorithms)
SupportedCredentialConfiguration	setCredentialBuildConfig(CredentialBuildConfig credentialBuildConfig)
SupportedCredentialConfiguration	setCredentialDefinition(CredentialDefinition credentialDefinition)
SupportedCredentialConfiguration	setCredentialMetadata(CredentialMetadata credentialMetadata)
SupportedCredentialConfiguration	setCredentialSigningAlgValuesSupported(List<Object> credentialSigningAlgValuesSupported)
SupportedCredentialConfiguration	setCryptographicBindingMethodsSupported(List<String> cryptographicBindingMethodsSupported)
SupportedCredentialConfiguration	setDocType(String docType)
SupportedCredentialConfiguration	setFormat(String format)
SupportedCredentialConfiguration	setId(String id)
SupportedCredentialConfiguration	setProofTypesSupported(ProofTypesSupported proofTypesSupported)
SupportedCredentialConfiguration	setScope(String scope)
SupportedCredentialConfiguration	setVct(String vct)

Methods inherited from class java.lang.Object

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

Field Details

VERIFIABLE_CREDENTIAL_TYPE_KEY

public static final String VERIFIABLE_CREDENTIAL_TYPE_KEY

See Also:

• Constant Field Values

DOC_TYPE_KEY

public static final String DOC_TYPE_KEY

See Also:

• Constant Field Values

CREDENTIAL_BUILD_CONFIG_KEY

public static final String CREDENTIAL_BUILD_CONFIG_KEY

See Also:

• Constant Field Values

Constructor Details

SupportedCredentialConfiguration

public SupportedCredentialConfiguration()

Method Details

parse

public static SupportedCredentialConfiguration parse(KeycloakSession keycloakSession,
 CredentialScopeModel credentialScope,
 List<String> globalSupportedSigningAlgorithms)

Parameters:

credentialScope - The scope that holds the credentials configuration

globalSupportedSigningAlgorithms - added as a parameter to avoid reading the global config from the session for each credential

Returns:

the credentials configuration that was entered into the ClientScope

deriveType

public VerifiableCredentialType deriveType()

Return the format-specific credential type identifier. For SD-JWT VC it is emitted as "vct"; for mDoc it is emitted as "doctype".

For jwt_vc and ldp_vc, we will be inferring from the "credential_definition" See: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-request-3

Returns:

deriveConfigId

public CredentialConfigId deriveConfigId()

getFormat

public String getFormat()

setFormat

public SupportedCredentialConfiguration setFormat(String format)

getDocType

public String getDocType()

setDocType

public SupportedCredentialConfiguration setDocType(String docType)

getScope

public String getScope()

setScope

public SupportedCredentialConfiguration setScope(String scope)

getCryptographicBindingMethodsSupported

public List<String> getCryptographicBindingMethodsSupported()

setCryptographicBindingMethodsSupported

public SupportedCredentialConfiguration setCryptographicBindingMethodsSupported(List<String> cryptographicBindingMethodsSupported)

getId

public String getId()

setId

public SupportedCredentialConfiguration setId(String id)

getCredentialSigningAlgValuesSupported

public List<Object> getCredentialSigningAlgValuesSupported()

setCredentialSigningAlgValuesSupported

public SupportedCredentialConfiguration setCredentialSigningAlgValuesSupported(List<Object> credentialSigningAlgValuesSupported)

getVct

public String getVct()

setVct

public SupportedCredentialConfiguration setVct(String vct)

getCredentialDefinition

public CredentialDefinition getCredentialDefinition()

setCredentialDefinition

public SupportedCredentialConfiguration setCredentialDefinition(CredentialDefinition credentialDefinition)

getProofTypesSupported

public ProofTypesSupported getProofTypesSupported()

setProofTypesSupported

public SupportedCredentialConfiguration setProofTypesSupported(ProofTypesSupported proofTypesSupported)

getCredentialMetadata

public CredentialMetadata getCredentialMetadata()

setCredentialMetadata

public SupportedCredentialConfiguration setCredentialMetadata(CredentialMetadata credentialMetadata)

getCredentialBuildConfig

public CredentialBuildConfig getCredentialBuildConfig()

setCredentialBuildConfig

public SupportedCredentialConfiguration setCredentialBuildConfig(CredentialBuildConfig credentialBuildConfig)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object