Chapter 2. Protect a service application by using OpenID Connect (OIDC) Bearer token authentication Use the Quarkus OpenID Connect (OIDC) extension to secure a Jakarta REST application with Bearer token authentication. The bearer tokens are issued by OIDC and OAuth 2.0 compliant authorization servers, such as Keycloak . For more information about OIDC Bearer token authentication, see the Quarkus OpenID Connect (OIDC) Bearer token authentication guide. If you want to protect web applications by using OIDC Authorization Code Flow authentication, see the OpenID Connect authorization code flow mechanism for protecting web applications guide. 2.1. Prerequisites To complete this guide, you need: Roughly 15 minutes An IDE JDK 17+ installed with JAVA_HOME configured appropriately Apache Maven 3.9.6 A working container runtime (Docker or Podman ) Optionally the Quarkus CLI if you want to use it Optionally Mandrel or GraalVM installed and configured appropriately if you want to build a native executable (or Docker if you use a native container build) The jq command-line processor tool 2.2. Architecture This example shows how you can build a simple microservice that offers two endpoints: /api/users/me /api/admin These endpoints are protected and can only be accessed if a client sends a bearer token along with the request, which must be valid (for example, signature, expiration, and audience) and trusted by the microservice. A Keycloak server issues the bearer token and represents the subject for which the token was issued. Because it is an OAuth 2.0 authorization server, the token also references the client acting on the user's behalf. Any user with a valid token can access the /api/users/me endpoint. As a response, it returns a JSON document with user details obtained from the information in the token. The /api/admin endpoint is protected with RBAC (Role-Based Access Control), which only users with the admin role can access. At this endpoint, the @RolesAllowed annotation is used to enforce the access constraint declaratively. 2.3. Solution Follow the instructions in the sections and create the application step by step. You can also go straight to the completed example. You can clone the Git repository by running the command git clone https://github.com/quarkusio/quarkus-quickstarts.git -b 3.8 , or you can download an archive . The solution is located in the security-openid-connect-quickstart directory . 2.4. Create the Maven project You can either create a new Maven project with the oidc extension or you can add the extension to an existing Maven project. Complete one of the following commands: To create a new Maven project, use the following command: Using the Quarkus CLI: quarkus create app org.acme:security-openid-connect-quickstart \ --extension='oidc,resteasy-reactive-jackson' \ --no-code cd security-openid-connect-quickstart To create a Gradle project, add the --gradle or --gradle-kotlin-dsl option. For more information about how to install and use the Quarkus CLI, see the Quarkus CLI guide. Using Maven: mvn io.quarkus.platform:quarkus-maven-plugin:3.8.5:create \ -DprojectGroupId=org.acme \ -DprojectArtifactId=security-openid-connect-quickstart \ -Dextensions='oidc,resteasy-reactive-jackson' \ -DnoCode cd security-openid-connect-quickstart To create a Gradle project, add the -DbuildTool=gradle or -DbuildTool=gradle-kotlin-dsl option. For Windows users: If using cmd, (don't use backward slash \ and put everything on the same line) If using Powershell, wrap -D parameters in double quotes e.g. "-DprojectArtifactId=security-openid-connect-quickstart" If you already have your Quarkus project configured, you can add the oidc extension to your project by running the following command in your project base directory: Using the Quarkus CLI: quarkus extension add oidc Using Maven: ./mvnw quarkus:add-extension -Dextensions='oidc' Using Gradle: ./gradlew addExtension --extensions='oidc' This will add the following to your build file: Using Maven: <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-oidc</artifactId> </dependency> Using Gradle: implementation("io.quarkus:quarkus-oidc") 2.5. Write the application Implement the /api/users/me endpoint as shown in the following example, which is a regular Jakarta REST resource: package org.acme.security.openid.connect; import jakarta.annotation.security.RolesAllowed; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import org.jboss.resteasy.reactive.NoCache; import io.quarkus.security.identity.SecurityIdentity; @Path("/api/users") public class UsersResource { @Inject SecurityIdentity securityIdentity; @GET @Path("/me") @RolesAllowed("user") @NoCache public User me() { return new User(securityIdentity); } public static class User { private final String userName; User(SecurityIdentity securityIdentity) { this.userName = securityIdentity.getPrincipal().getName(); } public String getUserName() { return userName; } } } Implement the /api/admin endpoint as shown in the following example: package org.acme.security.openid.connect; import jakarta.annotation.security.RolesAllowed; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; import jakarta.ws.rs.core.MediaType; @Path("/api/admin") public class AdminResource { @GET @RolesAllowed("admin") @Produces(MediaType.TEXT_PLAIN) public String admin() { return "granted"; } } Note The main difference in this example is that the @RolesAllowed annotation is used to verify that only users granted the admin role can access the endpoint. Injection of the SecurityIdentity is supported in both @RequestScoped and @ApplicationScoped contexts. 2.6. Configure the application Configure the Quarkus OpenID Connect (OIDC) extension by setting the following configuration properties in the src/main/resources/application.properties file. %prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus quarkus.oidc.client-id=backend-service quarkus.oidc.credentials.secret=secret # Tell Dev Services for Keycloak to import the realm file # This property is not effective when running the application in JVM or native modes quarkus.keycloak.devservices.realm-path=quarkus-realm.json Where: %prod.quarkus.oidc.auth-server-url sets the base URL of the OpenID Connect (OIDC) server. The %prod. profile prefix ensures that Dev Services for Keycloak launches a container when you run the application in development (dev) mode. For more information, see the Run the application in dev mode section. quarkus.oidc.client-id sets a client id that identifies the application. quarkus.oidc.credentials.secret sets the client secret, which is used by the client_secret_basic authentication method. For more information, see the Quarkus OpenID Connect (OIDC) configuration properties guide. 2.7. Start and configure the Keycloak server Put the realm configuration file on the classpath ( target/classes directory) so that it gets imported automatically when running in dev mode. You do not need to do this if you have already built a complete solution , in which case, this realm file is added to the classpath during the build. Note Do not start the Keycloak server when you run the application in dev mode; Dev Services for Keycloak will start a container. For more information, see the Run the application in dev mode section. To start a Keycloak server, you can use Docker to run the following command: docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev Where the keycloak.version is set to version 24.0.0 or later. You can access your Keycloak server at localhost:8180 . To access the Keycloak Administration console, log in as the admin user by using the following login credentials: Username: admin Password: admin Import the realm configuration file from the upstream community repository to create a new realm. For more information, see the Keycloak documentation about creating and configuring a new realm . 2.8. Run the application in dev mode To run the application in dev mode, run the following commands: Using the Quarkus CLI: quarkus dev Using Maven: ./mvnw quarkus:dev Using Gradle: ./gradlew --console=plain quarkusDev Dev Services for Keycloak will start a Keycloak container and import a quarkus-realm.json . Open a Dev UI , which you can find at /q/dev-ui . Then, in an OpenID Connect card, click the Keycloak provider link . When prompted to log in to a Single Page Application provided by OpenID Connect Dev UI , do the following steps: Log in as alice (password: alice ), who has a user role. Accessing /api/admin returns a 403 status code. Accessing /api/users/me returns a 200 status code. Log out and log in again as admin (password: admin ), who has both admin and user roles. Accessing /api/admin returns a 200 status code. Accessing /api/users/me returns a 200 status code. 2.9. Run the Application in JVM mode When you are done with dev mode, you can run the application as a standard Java application. Compile the application: Using the Quarkus CLI: quarkus build Using Maven: ./mvnw install Using Gradle: ./gradlew build Run the application: java -jar target/quarkus-app/quarkus-run.jar 2.10. Run the application in native mode You can compile this same demo as-is into native mode without any modifications. This implies that you no longer need to install a JVM on your production environment. The runtime technology is included in the produced binary and optimized to run with minimal resources required. Compilation takes a bit longer, so this step is disabled by default. Build your application again by enabling the native profile: Using the Quarkus CLI: quarkus build --native Using Maven: ./mvnw install -Dnative Using Gradle: ./gradlew build -Dquarkus.package.type=native After waiting a little while, you run the following binary directly: ./target/security-openid-connect-quickstart-1.0.0-SNAPSHOT-runner 2.11. Test the application For information about testing your application in dev mode, see the preceding Run the application in dev mode section. You can test the application launched in JVM or native modes with curl . Because the application uses Bearer token authentication, you must first obtain an access token from the Keycloak server to access the application resources: export access_token=USD(\ curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \ --user backend-service:secret \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'username=alice&password=alice&grant_type=password' | jq --raw-output '.access_token' \ ) The preceding example obtains an access token for the user alice . Any user can access the http://localhost:8080/api/users/me endpoint, which returns a JSON payload with details about the user. curl -v -X GET \ http://localhost:8080/api/users/me \ -H "Authorization: Bearer "USDaccess_token Only users with the admin role can access the http://localhost:8080/api/admin endpoint. If you try to access this endpoint with the previously-issued access token, you get a 403 response from the server. curl -v -X GET \ http://localhost:8080/api/admin \ -H "Authorization: Bearer "USDaccess_token To access the admin endpoint, obtain a token for the admin user: export access_token=USD(\ curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \ --user backend-service:secret \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'username=admin&password=admin&grant_type=password' | jq --raw-output '.access_token' \ ) For information about writing integration tests that depend on Dev Services for Keycloak , see the Dev Services for Keycloak section of the "OpenID Connect (OIDC) Bearer token authentication" guide. 2.12. References OIDC configuration properties OpenID Connect (OIDC) Bearer token authentication Keycloak Documentation OpenID Connect JSON Web Token OpenID Connect and OAuth2 Client and Filters Reference Guide Dev Services for Keycloak Sign and encrypt JWT tokens with SmallRye JWT Build Combining authentication mechanisms Quarkus Security overview

Commands:
quarkus create app org.acme:security-openid-connect-quickstart --extension='oidc,resteasy-reactive-jackson' --no-code cd security-openid-connect-quickstart
mvn io.quarkus.platform:quarkus-maven-plugin:3.8.5:create -DprojectGroupId=org.acme -DprojectArtifactId=security-openid-connect-quickstart -Dextensions='oidc,resteasy-reactive-jackson' -DnoCode cd security-openid-connect-quickstart
quarkus extension add oidc
./mvnw quarkus:add-extension -Dextensions='oidc'
./gradlew addExtension --extensions='oidc'
<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-oidc</artifactId> </dependency>
implementation("io.quarkus:quarkus-oidc")
package org.acme.security.openid.connect; import jakarta.annotation.security.RolesAllowed; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import org.jboss.resteasy.reactive.NoCache; import io.quarkus.security.identity.SecurityIdentity; @Path("/api/users") public class UsersResource { @Inject SecurityIdentity securityIdentity; @GET @Path("/me") @RolesAllowed("user") @NoCache public User me() { return new User(securityIdentity); } public static class User { private final String userName; User(SecurityIdentity securityIdentity) { this.userName = securityIdentity.getPrincipal().getName(); } public String getUserName() { return userName; } } }
package org.acme.security.openid.connect; import jakarta.annotation.security.RolesAllowed; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; import jakarta.ws.rs.core.MediaType; @Path("/api/admin") public class AdminResource { @GET @RolesAllowed("admin") @Produces(MediaType.TEXT_PLAIN) public String admin() { return "granted"; } }
%prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus quarkus.oidc.client-id=backend-service quarkus.oidc.credentials.secret=secret Tell Dev Services for Keycloak to import the realm file This property is not effective when running the application in JVM or native modes quarkus.keycloak.devservices.realm-path=quarkus-realm.json
docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
quarkus dev
./mvnw quarkus:dev
./gradlew --console=plain quarkusDev
quarkus build
./mvnw install
./gradlew build
java -jar target/quarkus-app/quarkus-run.jar
quarkus build --native
./mvnw install -Dnative
./gradlew build -Dquarkus.package.type=native
./target/security-openid-connect-quickstart-1.0.0-SNAPSHOT-runner
export access_token=USD( curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token --user backend-service:secret -H 'content-type: application/x-www-form-urlencoded' -d 'username=alice&password=alice&grant_type=password' | jq --raw-output '.access_token' )
curl -v -X GET http://localhost:8080/api/users/me -H "Authorization: Bearer "USDaccess_token
curl -v -X GET http://localhost:8080/api/admin -H "Authorization: Bearer "USDaccess_token
export access_token=USD( curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token --user backend-service:secret -H 'content-type: application/x-www-form-urlencoded' -d 'username=admin&password=admin&grant_type=password' | jq --raw-output '.access_token' )