A Keycloak extension that supports the functionality of the Keycloak Admin REST API in GraphQL.
After a couple of years working on a project that was heavily dependent on the Keycloak REST API, I decided to create something "better". I found theREST API difficult to work with due to its adherence to RESTful principles with strict separation between resources. This made it difficult to, for example, retrieve all information about the users in a realm (e.g. the standard user information, attributes, groups, roles, etc.) without multiple REST invocations and in-memory "joins". In addition, the REST API provided only very coarse-grained control over what information was returned for some resources by specifying whether a "brief" or "full" representation was to be returned.
I had already become interested GraphQL and was building a GraphQL API as part of this project. It seemed clear that I could address the problems mentioned above by providing a GraphQL API for Keycloak.
- Replicate the functionality of the Keycloak Admin REST API in GraphQL.
- Make it easier for consumers of the API to specify the shape of the data the want to retrieve.
- Support ordering and filtering on queries.
- Support performant "joining" of certain entities, e.g. users + roles + groups.
- Support write (GraphQL mutation) operations.
- Support real-time updates/notifications using GraphQL subscriptions.
I am not accepting pull requests at this time. Please feel free to post questions/comments in Discussions.
- Currently built against Keycloak 26.0.2 although I will probably increment this as I go. Eventually, there will be tagged releases to support some number of recent Keycloak versions.
- Initially I'm concentrating on the following types: Realm, Client, User, Group, Role and getting the queries on those types right without regard to performance improvements.
- Only read operations (GraphQL queries) are supported. Mutations are not yet supported.
- A sample Subscription service is included that allows the caller to register for Keycloak Events and Admin Events. See below for implementation details.
- The GraphQL types rely heavily on some of the existing REST code, most notably the *Resource classes in the org.keycloak.admin.client.resource package and the *Representation classes in the org.keycloak.representations.idm package. The *Resource classes include filtering based on role-based access control so this seems the safest route for now. GraphQL *Type classes mostly just delegate to those classes and sometimes to the related *Model classes in the org.keycloak.models package. For certain optimizations, I'll probably break away from using these classes and write my own SQL queries. This will be done on a case-by-case basis.
- Built and tested against Keycloak 26.0.1. Once we do actual releases, a compatibility table will be provided.
Keycloak imposes role-based access controls on its resources. When a GraphQL query returns a collection, any items in that collection to which the caller does not have access are removed from the collection. If the caller does not have access to the collection itself, a Page with an empty items array is returned. For queries returning single results, a null is returned when the caller does not have access.
There is no way to determine whether a null result is due to access control or the item not being found. In other words, errors are not raised in either case. This is intentional for security reasons. For example, if we raised different errors for access control and existence on user entities, a caller could determine whether a user existed by name (AccessDenied vs NoSuchUser error).
Certain fields (especially in Realm), return Maps of varying complexity. These will most likely be wrapped in specific GraphQL types at some point.
A not-so-robust subscriptions implementation is included for Keycloak events and adminEvents. The back-end sits on top of a Keycloak EventListenerProvider that hooks Keycloak events and admin events. Since Keycloak already includes some Vert.x support, I decided to use Vert.x's reactive programming support (vertx-rx-java3) and GraphQL support (vertex-web-graphql) which also includes support for Websockets. The class SubscriptionServer is a Vert.x Verticle that starts an HTTP server on port 8081 (soon to be configurable) that supports Websockets and GraphQL subscriptions using the Apollo graphql-ws protocol.
I'm not convinced that this is the best way to go about this. I would have preferred to support Websockets on the same Keycloak HTTP(S) port on which we support standard GraphQL traffic. However, I couldn't figure out how to integrate a Websocket server. Any advice in that area would be appreciated. I suspect that one or more Quarkus extensions would be helpful here, but I was not successful in integrating Quarkus extensions into my Keycloak extension.
A sample client (SubsscriptionClient) that demonstrates one way to do subscriptions on the client side. The client first authenticates with Keycloak to obtain and access token which is then passed in the Authorization header. I've taken the simple approach of making the client responsible for refreshing the access token when it expires and then re-issuing the subscription. This is as opposed to having the server side determine whether the access token is expired when the subscription event is fired and then refreshing it. I'm looking for feedback on this approach.
To activate the event listener to support the event and adminEvent subscriptions, some Keycloak configuration is required:
- Log in to the Keycloak Admin console
- Navigate to Realm Settings
- Click on the Events tab
- In the Event Listeners field, add
multicast-event-listener.
Run mvn clean package. The resulting JAR file will be located in ./graphql/target/net.brianlevine.keycloak-graphql.jar.
Run mvn test
Use one of the methods described here.
The tests programmatically instantiate a Keycloak test container. To debug into the Keycloak test container (as opposed to debugging the tests themselves):
- Run
DEBUG_PORT=nnnn mvn test. During startup, you'll see messages indicating that the container is starting in DEBUG mode. The container will wait until you've attached your debugger to proceed. - Attach your debugger to the Keycloak server on the port you chose. You'll need to do this twice. The first time, the attach succeeds, but then exits after a few seconds. Attach your debugger again to actually attach to the Keycloak process and begin debugging. (See dasniko/testcontainers-keycloak#117 and keycloak/keycloak#12679 (reply in thread))
Run docker compose up
in the root directory.
The docker-compose.yml file is configured to run the correct version of Keycloak and mount the JAR file on the /opt/keycloak/providers directory.
Copy the JAR file to the <KEYCLOAK_DIR>/providers directory. Re-start Keycloak.
A couple of tools are provided as development aids. You'll need to create a 'graphql-tools' realm role and assign this role to users to whom you want to grant access. You'll also need to create a 'keycloak-graphql' client. The easiest way to do this is to import the client using the keycloak-graphql-client.json file in the root directory of this project.
The GraphiQL tool is included in this extension. To access GraphiQL, point your browser at http://localhost:8080/realms/your-realm-name/graphql/graphiql.
To view the Keycloak GraphQL schema, point your browser at http://localhost:8080/realms/your-realm-name/graphql/schema. Click the Download... button to download the schema.
GraphiQL is probably the best way to test out your queries. If you want to test your queries from the command-line, a shell script is provide at ./scripts/graphql_test.sh.
Run graphql_test.sh username password realm_name full_path_to_file_containing_graphql_query.json.
You'll need to have the 'curl' and 'jq' commands installed.
Note: All queries except 'currentUser' must be enclosed in a realm field. You can indicate a specific realm by adding
the id or name. Providing no arguments indicates the current realm (i.e., the realm against which you authenticated).
The ordering of items in paged queries is determined by the underlying Keycloak REST code. Specifying explicit ordering and filtering will eventually be supported for all queries that return collections.
query {
realm {
users {
items {
id
username
firstName
lastName
attributes
roles {
items {
name
clientRole
}
}
groups {
items {
name
path
}
}
}
}
}
}query {
currentUser {
id
username
email
firstName
lastName
roles {
items {
name
clientRole
}
}
}
}This demonstrates how paging works. You can define the start point (default is 0) and pagesize (default is 100) using the 'start' and 'limit' arguments. The collection is returned in the 'items' field which is where you define which fields you want returned. This will return all realms to which the caller has view access.
query {
realms(start:0, limit:10) {
totalItems
totalPages
items {
id
name
}
}
}query {
realm {
users(start:0, limit:5) {
items {
username
firstName
lastName
}
}
}
}