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

Skip to content

Allow to expose WellKnown provider via ServerMetadataResource (#46292) #46294

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

Open
thomasdarimont wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −12
Open

Allow to expose WellKnown provider via ServerMetadataResource (#46292) #46294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions services/src/main/java/org/keycloak/protocol/oauth2/OAuth2WellKnownProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,9 @@ public class OAuth2WellKnownProviderFactory extends OIDCWellKnownProviderFactory
public String getId() {
return PROVIDER_ID;
}

@Override
public boolean isAvailableViaServerMetadata() {
return true;
}
}
7 changes: 6 additions & 1 deletion .../main/java/org/keycloak/protocol/oid4vc/issuance/JWTVCIssuerWellKnownProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,9 @@ public void close() {
public String getId() {
return PROVIDER_ID;
}
}

@Override
public boolean isAvailableViaServerMetadata() {
return true;
}
}
5 changes: 5 additions & 0 deletions ...main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,9 @@ public void close() {
public String getId() {
return PROVIDER_ID;
}

@Override
public boolean isAvailableViaServerMetadata() {
return true;
}
}
17 changes: 6 additions & 11 deletions services/src/main/java/org/keycloak/services/resources/ServerMetadataResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,12 @@
import jakarta.ws.rs.ext.Provider;

import org.keycloak.models.KeycloakSession;
import org.keycloak.protocol.oauth2.OAuth2WellKnownProviderFactory;
import org.keycloak.protocol.oid4vc.issuance.JWTVCIssuerWellKnownProviderFactory;
import org.keycloak.protocol.oid4vc.issuance.OID4VCIssuerWellKnownProviderFactory;
import org.keycloak.services.cors.Cors;
import org.keycloak.wellknown.WellKnownProvider;
import org.keycloak.wellknown.WellKnownProviderFactory;

import org.jboss.logging.Logger;

import static org.keycloak.utils.MediaType.APPLICATION_JWT;


@Provider
@Path("/.well-known")
Expand All @@ -59,7 +56,7 @@ public Response getOAuth2AuthorizationServerWellKnownVersionPreflight(final @Pat

@GET
@Path("{provider}/realms/{realm}")
@Produces({MediaType.APPLICATION_JSON, APPLICATION_JWT})
@Produces({MediaType.APPLICATION_JSON, org.keycloak.utils.MediaType.APPLICATION_JWT})
public Response getOAuth2AuthorizationServerWellKnown(final @PathParam("provider") String providerName,
final @PathParam("realm") String name) {
if (!isValidProvider(providerName)) throw new NotFoundException();
Expand All @@ -71,10 +68,8 @@ public static UriBuilder wellKnownOAuthProviderUrl(UriBuilder builder) {
}

private boolean isValidProvider(String providerName) {
// you can add codes here considering the current status of the implementation (preview, experimental).
if (OAuth2WellKnownProviderFactory.PROVIDER_ID.equals(providerName)) return true;
if (OID4VCIssuerWellKnownProviderFactory.PROVIDER_ID.equals(providerName)) return true;
if (JWTVCIssuerWellKnownProviderFactory.PROVIDER_ID.equals(providerName)) return true;
return false;
WellKnownProviderFactory providerFactory = (WellKnownProviderFactory)session.getKeycloakSessionFactory().getProviderFactory(WellKnownProvider.class, providerName);
if (providerFactory == null) return false;
return providerFactory.isAvailableViaServerMetadata();
}
}
12 changes: 12 additions & 0 deletions services/src/main/java/org/keycloak/wellknown/WellKnownProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,16 @@ default String getAlias() {
default int getPriority() {
return 1;
}

/**
* Controls if the {@link WellKnownProvider} is available via server metadata endpoint.
* If this method returns true, then the provider will be available under {@code /.well-known/<alias>}.
*
* Default implementation returns false.
*
* @return
*/
default boolean isAvailableViaServerMetadata() {
return false;
}
}
Loading