Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Exchange Enum type of Format for String #30875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mposolda merged 2 commits into from
Jul 11, 2024
Merged

Exchange Enum type of Format for String #30875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a9be2e
Exchange Enum type of Format for String
Captain-P-Goldfish Jun 27, 2024
840e861
Merge branch 'main' into vcformat-to-string
Captain-P-Goldfish Jul 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions services/src/main/java/org/keycloak/protocol/oid4vc/OID4VCLoginProtocolFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public Map<String, ProtocolMapperModel> getBuiltinMappers() {
return builtins;
}

private void addServiceFromComponent(Map<Format, VerifiableCredentialsSigningService> signingServices, KeycloakSession keycloakSession, ComponentModel componentModel) {
private void addServiceFromComponent(Map<String, VerifiableCredentialsSigningService> signingServices, KeycloakSession keycloakSession, ComponentModel componentModel) {
ProviderFactory<VerifiableCredentialsSigningService> factory = keycloakSession
.getKeycloakSessionFactory()
.getProviderFactory(VerifiableCredentialsSigningService.class, componentModel.getProviderId());
Expand All @@ -114,7 +114,7 @@ private void addServiceFromComponent(Map<Format, VerifiableCredentialsSigningSer
@Override
public Object createProtocolEndpoint(KeycloakSession keycloakSession, EventBuilder event) {

Map<Format, VerifiableCredentialsSigningService> signingServices = new EnumMap<>(Format.class);
Map<String, VerifiableCredentialsSigningService> signingServices = new HashMap<>();
RealmModel realm = keycloakSession.getContext().getRealm();
realm.getComponentsStream(realm.getId(), VerifiableCredentialsSigningService.class.getName())
.forEach(cm -> addServiceFromComponent(signingServices, keycloakSession, cm));
Expand Down Expand Up @@ -170,4 +170,4 @@ public String getId() {
return PROTOCOL_ID;
}

}
}
18 changes: 11 additions & 7 deletions services/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
import java.util.Objects;
import java.util.Optional;

import static org.keycloak.protocol.oid4vc.model.Format.JWT_VC;
import static org.keycloak.protocol.oid4vc.model.Format.LDP_VC;
import static org.keycloak.protocol.oid4vc.model.Format.SD_JWT_VC;

/**
* Provides the (REST-)endpoints required for the OID4VCI protocol.
* <p>
Expand All @@ -115,13 +119,13 @@ public class OID4VCIssuerEndpoint {
// lifespan of the preAuthorizedCodes in seconds
private final int preAuthorizedCodeLifeSpan;

private final Map<Format, VerifiableCredentialsSigningService> signingServices;
private final Map<String, VerifiableCredentialsSigningService> signingServices;

private final boolean isIgnoreScopeCheck;

public OID4VCIssuerEndpoint(KeycloakSession session,
String issuerDid,
Map<Format, VerifiableCredentialsSigningService> signingServices,
Map<String, VerifiableCredentialsSigningService> signingServices,
AppAuthManager.BearerTokenAuthenticator authenticator,
ObjectMapper objectMapper, TimeProvider timeProvider, int preAuthorizedCodeLifeSpan) {
this.session = session;
Expand All @@ -136,7 +140,7 @@ public OID4VCIssuerEndpoint(KeycloakSession session,

public OID4VCIssuerEndpoint(KeycloakSession session,
String issuerDid,
Map<Format, VerifiableCredentialsSigningService> signingServices,
Map<String, VerifiableCredentialsSigningService> signingServices,
AppAuthManager.BearerTokenAuthenticator authenticator,
ObjectMapper objectMapper, TimeProvider timeProvider, int preAuthorizedCodeLifeSpan,
boolean isIgnoreScopeCheck) {
Expand Down Expand Up @@ -168,7 +172,7 @@ public Response getCredentialOfferURI(@QueryParam("credential_configuration_id")
throw new BadRequestException(getErrorResponse(ErrorType.INVALID_CREDENTIAL_REQUEST));
}
SupportedCredentialConfiguration supportedCredentialConfiguration = credentialsMap.get(vcId);
Format format = supportedCredentialConfiguration.getFormat();
String format = supportedCredentialConfiguration.getFormat();

// check that the user is allowed to get such credential
if (getClientsOfType(supportedCredentialConfiguration.getScope(), format).isEmpty()) {
Expand Down Expand Up @@ -303,7 +307,7 @@ public Response requestCredential(
checkScope(credentialRequestVO);
}

Format requestedFormat = credentialRequestVO.getFormat();
String requestedFormat = credentialRequestVO.getFormat();
String requestedCredential = credentialRequestVO.getCredentialIdentifier();

SupportedCredentialConfiguration supportedCredentialConfiguration = Optional
Expand Down Expand Up @@ -372,7 +376,7 @@ private AuthenticationManager.AuthResult getAuthResult(WebApplicationException e
* @param format format of the credential to be created
* @return the signed credential
*/
private Object getCredential(UserSessionModel userSessionModel, String vcType, Format format) {
private Object getCredential(UserSessionModel userSessionModel, String vcType, String format) {

List<OID4VCClient> clients = getClientsOfType(vcType, format);

Expand Down Expand Up @@ -424,7 +428,7 @@ private Response getErrorResponse(ErrorType errorType) {
}

// Return all {@link OID4VCClient}s that support the given type and format
private List<OID4VCClient> getClientsOfType(String vcType, Format format) {
private List<OID4VCClient> getClientsOfType(String vcType, String format) {
LOGGER.debugf("Retrieve all clients of type %s, supporting format %s", vcType, format.toString());

if (Optional.ofNullable(vcType).filter(type -> !type.isEmpty()).isEmpty()) {
Expand Down
4 changes: 2 additions & 2 deletions ...es/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public Object getConfig() {
public static Map<String, SupportedCredentialConfiguration> getSupportedCredentials(KeycloakSession keycloakSession) {

RealmModel realm = keycloakSession.getContext().getRealm();
List<Format> supportedFormats = realm.getComponentsStream(realm.getId(), VerifiableCredentialsSigningService.class.getName())
List<String> supportedFormats = realm.getComponentsStream(realm.getId(), VerifiableCredentialsSigningService.class.getName())
.map(cm ->
keycloakSession
.getKeycloakSessionFactory()
Expand Down Expand Up @@ -115,4 +115,4 @@ public static String getIssuer(KeycloakContext context) {
public static String getCredentialsEndpoint(KeycloakContext context) {
return getIssuer(context) + "/protocol/" + OID4VCLoginProtocolFactory.PROTOCOL_ID + "/" + OID4VCIssuerEndpoint.CREDENTIAL_PATH;
}
}
}
6 changes: 3 additions & 3 deletions .../java/org/keycloak/protocol/oid4vc/issuance/signing/JwtSigningServiceProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
*/
public class JwtSigningServiceProviderFactory implements VCSigningServiceProviderFactory {

public static final Format SUPPORTED_FORMAT = Format.JWT_VC;
public static final String SUPPORTED_FORMAT = Format.JWT_VC;
private static final String HELP_TEXT = "Issues JWT-VCs following the specification of https://identity.foundation/jwt-vc-presentation-profile/.";

@Override
Expand Down Expand Up @@ -83,7 +83,7 @@ public void validateSpecificConfiguration(KeycloakSession session, RealmModel re
}

@Override
public Format supportedFormat() {
public String supportedFormat() {
return SUPPORTED_FORMAT;
}
}
}
6 changes: 3 additions & 3 deletions ...n/java/org/keycloak/protocol/oid4vc/issuance/signing/LDSigningServiceProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* @author <a href="https://github.com/wistefan">Stefan Wiedemann</a>
*/
public class LDSigningServiceProviderFactory implements VCSigningServiceProviderFactory {
public static final Format SUPPORTED_FORMAT = Format.LDP_VC;
public static final String SUPPORTED_FORMAT = Format.LDP_VC;
private static final String HELP_TEXT = "Issues Verifiable Credentials in the W3C Data Model, using Linked-Data Proofs. See https://www.w3.org/TR/vc-data-model/";

private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
Expand Down Expand Up @@ -77,8 +77,8 @@ public void validateSpecificConfiguration(KeycloakSession session, RealmModel re
}

@Override
public Format supportedFormat() {
public String supportedFormat() {
return SUPPORTED_FORMAT;
}

}
}
6 changes: 3 additions & 3 deletions ...ava/org/keycloak/protocol/oid4vc/issuance/signing/SdJwtSigningServiceProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
*/
public class SdJwtSigningServiceProviderFactory implements VCSigningServiceProviderFactory {

public static final Format SUPPORTED_FORMAT = Format.SD_JWT_VC;
public static final String SUPPORTED_FORMAT = Format.SD_JWT_VC;
private static final String HELP_TEXT = "Issues SD-JWT-VCs following the specification of https://drafts.oauth.net/oauth-sd-jwt-vc/draft-ietf-oauth-sd-jwt-vc.html.";

@Override
Expand Down Expand Up @@ -97,7 +97,7 @@ public void validateSpecificConfiguration(KeycloakSession session, RealmModel re
}

@Override
public Format supportedFormat() {
public String supportedFormat() {
return SUPPORTED_FORMAT;
}
}
}
4 changes: 2 additions & 2 deletions ...n/java/org/keycloak/protocol/oid4vc/issuance/signing/VCSigningServiceProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,5 @@ default boolean isSupported(Config.Scope config) {
*
* @return the format
*/
Format supportedFormat();
}
String supportedFormat();
}
8 changes: 4 additions & 4 deletions services/src/main/java/org/keycloak/protocol/oid4vc/model/CredentialRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@
@JsonInclude(JsonInclude.Include.NON_NULL)
public class CredentialRequest {

private Format format;
private String format;

@JsonProperty("credential_identifier")
private String credentialIdentifier;

private Proof proof;

public Format getFormat() {
public String getFormat() {
return format;
}

public CredentialRequest setFormat(Format format) {
public CredentialRequest setFormat(String format) {
this.format = format;
return this;
}
Expand All @@ -62,4 +62,4 @@ public CredentialRequest setProof(Proof proof) {
this.proof = proof;
return this;
}
}
}
49 changes: 5 additions & 44 deletions services/src/main/java/org/keycloak/protocol/oid4vc/model/Format.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,65 +17,26 @@

package org.keycloak.protocol.oid4vc.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
* Enum of supported credential formats
*
* @author <a href="https://github.com/wistefan">Stefan Wiedemann</a>
*/
public enum Format {
public class Format {

/**
* LD-Credentials {@see https://www.w3.org/TR/vc-data-model/}
*/
LDP_VC("ldp_vc"),
public static final String LDP_VC = "ldp_vc";

/**
* JWT-Credentials {@see https://identity.foundation/jwt-vc-presentation-profile/}
*/
JWT_VC("jwt_vc"),
public static final String JWT_VC = "jwt_vc";

/**
* SD-JWT-Credentials {@see https://drafts.oauth.net/oauth-sd-jwt-vc/draft-ietf-oauth-sd-jwt-vc.html}
*/
SD_JWT_VC("vc+sd-jwt");

private String value;

Format(String value) {
this.value = value;
}

/**
* Convert a String into String, as specified in the
* <a href="https://download.oracle.com/otndocs/jcp/jaxrs-2_0-fr-eval-spec/index.html">See JAX RS 2.0 Specification, section 3.2, p. 12</a>
*/
public static Format fromString(String s) {
for (Format b : Format.values()) {
// using Objects.toString() to be safe if value type non-object type
// because types like 'int' etc. will be auto-boxed
if (java.util.Objects.toString(b.value).equals(s)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected string value '" + s + "'");
}

@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
public static final String SD_JWT_VC = "vc+sd-jwt";

@JsonCreator
public static Format fromValue(String value) {
for (Format b : Format.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
}
8 changes: 4 additions & 4 deletions ...es/src/main/java/org/keycloak/protocol/oid4vc/model/SupportedCredentialConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public class SupportedCredentialConfiguration {
private String id;

@JsonProperty(FORMAT_KEY)
private Format format;
private String format;

@JsonProperty(SCOPE_KEY)
private String scope;
Expand All @@ -85,11 +85,11 @@ public class SupportedCredentialConfiguration {
@JsonProperty(CLAIMS_KEY)
private Claims claims;

public Format getFormat() {
public String getFormat() {
return format;
}

public SupportedCredentialConfiguration setFormat(Format format) {
public SupportedCredentialConfiguration setFormat(String format) {
this.format = format;
return this;
}
Expand Down Expand Up @@ -205,7 +205,7 @@ public Map<String, String> toDotNotation() {
public static SupportedCredentialConfiguration fromDotNotation(String credentialId, Map<String, String> dotNotated) {

SupportedCredentialConfiguration supportedCredentialConfiguration = new SupportedCredentialConfiguration().setId(credentialId);
Optional.ofNullable(dotNotated.get(credentialId + DOT_SEPARATOR + FORMAT_KEY)).map(Format::fromString).ifPresent(supportedCredentialConfiguration::setFormat);
Optional.ofNullable(dotNotated.get(credentialId + DOT_SEPARATOR + FORMAT_KEY)).ifPresent(supportedCredentialConfiguration::setFormat);
Optional.ofNullable(dotNotated.get(credentialId + DOT_SEPARATOR + VERIFIABLE_CREDENTIAL_TYPE_KEY)).ifPresent(supportedCredentialConfiguration::setVct);
Optional.ofNullable(dotNotated.get(credentialId + DOT_SEPARATOR + SCOPE_KEY)).ifPresent(supportedCredentialConfiguration::setScope);
Optional.ofNullable(dotNotated.get(credentialId + DOT_SEPARATOR + CRYPTOGRAPHIC_BINDING_METHODS_SUPPORTED_KEY))
Expand Down