[OID4VCI] Approaching Credential Scope based API design

[Captain-P-Goldfish]

Description

Governikus reference implementation of scope-based credentials: https://gitlab.opencode.de/governikus/eudi-wallet-pid-provider-governikus-kg

Description

This issue is the idea of a bird-perspective for the code-design for building credentials for OpenID4VCI. It describes a simple code-snippet that should represent how the underlying API-interfaces can be designed in order to create a smooth reusable and adjustable API to build claims of arbitrary types.

UserModel userModel = getAuthenticatedUser(keycloakSession);
ClientScope clientScope = getClientScope(credentialRequest);
Map<String, Object> claims = getClaims(clientScope, userModel);
CredentialBuilder credentialBuilder = keycloakSession.getProvider(CredentialBuilder.class,
                                                                  credentialRequest.getFormat());
CredentialBody credentialBody = credentialBuilder.buildCredentialBody(claims);
CredentialSigner credentialSigner = keycloakSession.getProvider(CredentialSigner.class,
                                                                credentialRequest.getFormat());
String signedCredential = credentialSigner.sign(credentialBody, clientScope);

This is not a strict code example but it shall give an idea about how the approach could be used if it is ready.

Discussion

#32777

Issues

• [OID4VCI] Migrate Verifiable Credential Definitions from Client Attributes to Realm Level Attributes #32773
• [OID4VCI] Create a CredentialBuilderProvider interface #32951
• [OID4VCI] Create CredentialSignerProvider interface #32953
• [OID4VCI] Simplify SD-JWT API usage #32955
• [OID4VCI] Make signature-algorithm selectable #32958
• [OID4VCI] (DiscoveryEndpoint) Find supported formats by implemented providers #32959
• [OID4VCI] (DiscoveryEndpoint) Find available signature algorithms by provided realm-keys #32960
• [OID4VCI] Add oid4vci scope #32963
• (optional) [OID4VCI] Limit Client capabilities to OpenID Connect or OpenID4VCI #32967

removed from the list of tasks

• [OID4VCI] Extend AbstractOIDCProtocolMapper for credentials #32957

Motivation

No response