Secure a Micronaut application with an OCI Identity Domain using idtoken authentication
Learn how to create a Micronaut application and secure it with an OCI (Oracle Cloud Infrastructure) Identity Domain.
On this guide
In this section
Getting Started
In this guide, we will create a Micronaut application written in Java.
What you will need
To complete this guide, you will need the following:
-
Some time on your hands
-
A decent text editor or IDE (e.g. IntelliJ IDEA)
-
JDK 21 or greater installed with
JAVA_HOMEconfigured appropriately -
An Oracle Cloud account (create a free trial account at signup.oraclecloud.com)
Solution
We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.
-
Download and unzip the source
Oracle Cloud Identity Domain
To provide authentication, sign in to your Oracle Cloud account and create an Identity Domain.
Copy the domain URL from the Identity Domain page. Obtain the client ID and client secret from the Integrated applications / OAuth Configuration section.
Define the following environment variables:
export OAUTH_CLIENT_ID=XXXXXXXXXX
export OAUTH_CLIENT_SECRET=YYYYYYYYYY
export OAUTH_ISSUER=https://idcs-xxx.identity.oraclecloud.com/OAuth 2.0 Authorization Code Flow
We want to use an Authorization Code grant type flow, which is described in the following diagram:
Writing the Application
Create an application using the Micronaut Command Line Interface or with Micronaut Launch.
mn create-app example.micronaut.micronautguide --build=maven --lang=java|
Note
|
If you don’t specify the --build argument, Gradle with the Kotlin DSL is used as the build tool. If you don’t specify the --lang argument, Java is used as the language.If you don’t specify the --test argument, JUnit is used for Java and Kotlin, and Spock is used for Groovy.
|
The previous command creates a Micronaut application with the default package example.micronaut in a directory named micronautguide.
Views
To use the Thymeleaf Java template engine to render views in a Micronaut application, add the following dependency on your classpath.
<dependency>
<groupId>io.micronaut.views</groupId>
<artifactId>micronaut-views-thymeleaf</artifactId>
<scope>compile</scope>
</dependency>OAuth 2.0
To use OAuth 2.0 integration, add the following dependency:
<dependency>
<groupId>io.micronaut.security</groupId>
<artifactId>micronaut-security-oauth2</artifactId>
<scope>compile</scope>
</dependency>Also add Micronaut JWT support dependencies:
<dependency>
<groupId>io.micronaut.security</groupId>
<artifactId>micronaut-security-jwt</artifactId>
<scope>compile</scope>
</dependency>OAuth 2.0 Configuration
Add the following OAuth 2.0 configuration:
OpenID Auto Configuration
Upon application startup, the Micronaut application visits the OpenID discovery endpoint
to configure your application. If you set micronaut.security.oauth2.clients.oci.openid.issuer to https://idcs-xxx.identity.oraclecloud.com/, Micronaut visits https://idcs-xxx.identity.oraclecloud.com/.well-known/openid-configuration on startup.
Scopes Configuration
If you want to consider the Identity Domain User groups as your application roles, you can request the get_groups scope:
micronaut.security.token.roles-name=groups
micronaut.security.oauth2.clients.oci.scopes[0]=openid
micronaut.security.oauth2.clients.oci.scopes[1]=profile
micronaut.security.oauth2.clients.oci.scopes[2]=email
micronaut.security.oauth2.clients.oci.scopes[3]=get_groupsWhen you’re using an OpenID Connect flow, often there’s a need for the application to get user groups. In OCI IAM, you can request groups as part of the ID token or get an access token that’s eligible to fetch user groups. When you request scope=get_groups in a request to the authorization endpoint, OCI IAM returns the user groups as part of the ID token, which increases the size of the ID token. An alternative is to use scope=groups, which allows the returned access token to get user groups from the userinfo endpoints. So, scope=get_groups saves an API call but increases the ID token size.
You can create a bean replacement for a bean of type RolesFinder, to consider the user groups as roles:
Home
Create a controller to handle the requests to /. You will display the email of the authenticated person if any. Annotate the controller endpoint with @View since we will use a Thymeleaf template.
Create a Thymeleaf template:
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Home</title>
</head>
<body>
<h1>Micronaut - OCI Identity Domain example</h1>
<h2 th:if="${security}">username: <span th:text="${security.name}"></span></h2>
<h2 th:unless="${security}">username: Anonymous</h2>
<nav>
<ul>
<li th:unless="${security}"><a href="/oauth/login/oci">Enter</a></li>
<li th:if="${security}"><a href="/oauth/logout">Logout</a></li>
</ul>
</nav>
</body>
</html>Also, note that we return an empty model in the controller. However, we are accessing security in the thymeleaf template.
-
The SecurityViewModelProcessor injects into the model a
securitymap with the authenticated user. See User in a view documentation.
Running the Application
To run the application, use the ./mvnw mn:run command, which starts the application on port 8080.
Generate a Micronaut Application Native Executable with GraalVM
We will use GraalVM, an advanced JDK with ahead-of-time Native Image compilation, to generate a native executable of this Micronaut application.
Compiling Micronaut applications ahead of time with GraalVM significantly improves startup time and reduces the memory footprint of JVM-based applications.
|
Note
|
Only Java and Kotlin projects support using GraalVM’s native-image tool. Groovy relies heavily on reflection, which is only partially supported by GraalVM.
|
GraalVM Installation
sdk install java 25.0.2-graalFor installation on Windows, or for a manual installation on Linux or Mac, see the GraalVM Getting Started documentation.
The previous command installs Oracle GraalVM, which is free to use in production and free to redistribute, at no cost, under the GraalVM Free Terms and Conditions.
Alternatively, you can use the GraalVM Community Edition:
sdk install java 25.0.2-graalceNative Executable Generation
To generate a native executable using Maven, run:
./mvnw package -Dpackaging=native-imageThe native executable is created in the target directory and can be run with target/micronautguide.
It is possible to customize the name of the native executable or pass additional build arguments using the Maven plugin for GraalVM Native Image building. Declare the plugin as follows:
After you execute the native executable, navigate to localhost:8080 and authenticate with OCI Identity Domains.
Cleanup
Once you are done with this guide, delete the Oracle Cloud resources created (Identity Domains, Users) to avoid incurring unnecessary charges.
Next steps
Read Micronaut OAuth 2.0 documentation to learn more.
Help with the Micronaut Framework
The Micronaut Foundation sponsored the creation of this Guide. A variety of consulting and support services are available.
License
|
Note
|
All guides are released with an Apache License 2.0 for the code and a Creative Commons Attribution 4.0 license for the writing and media (images). |